Kernel/include/acess.h

   1 /*
   2  * AcessOS Microkernel Version
   3  * common.h
   4  */
   5 #ifndef _COMMON_H
   6 #define _COMMON_H
   7
   8 #define NULL    ((void*)0)
   9 #define PACKED  __attribute__ ((packed))
  10
  11 #include <stdint.h>
  12 #include <arch.h>
  13 #include <stdarg.h>
  14 #include "errno.h"
  15
  16 // --- Types ---
  17 typedef  int    tPID;
  18 typedef  int    tTID;
  19 typedef Uint    tUID;
  20 typedef Uint    tGID;
  21 typedef Sint64  tTimestamp;
  22
  23 // --- Helper Macros ---
  24 /**
  25  * \name Helper Macros
  26  * \{
  27  */
  28 #define CONCAT(x,y) x ## y
  29 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
  30 #define STR(x) #x
  31 #define EXPAND_STR(x) STR(x)
  32
  33 #define VER2(major,minor)       ((((major)&0xFF)<<8)|((minor)&0xFF))
  34 /**
  35  * \}
  36  */
  37
  38 /**
  39  * \name Per-Process Configuration Settings
  40  * \{
  41  */
  42 enum eConfigTypes {
  43         CFGT_NULL,
  44         CFGT_INT,
  45         CFGT_HEAPSTR,
  46         CFGT_PTR
  47 };
  48 enum eConfigs {
  49         CFG_VFS_CWD,
  50         CFG_VFS_MAXFILES,
  51         CFG_VFS_CHROOT,
  52         NUM_CFG_ENTRIES
  53 };
  54 #define CFGINT(id)      (*Threads_GetCfgPtr(id))
  55 #define CFGPTR(id)      (*(void**)Threads_GetCfgPtr(id))
  56 /**
  57  * \}
  58  */
  59
  60 // === CONSTANTS ===
  61 // --- Memory Flags --
  62 /**
  63  * \name Memory Flags
  64  * \{
  65  * \todo Move to mm_virt.h
  66  */
  67 #define MM_PFLAG_RO             0x01    // Writes disallowed
  68 #define MM_PFLAG_EXEC   0x02    // Allow execution
  69 #define MM_PFLAG_NOPAGE 0x04    // Prevent from being paged out
  70 #define MM_PFLAG_COW    0x08    // Copy-On-Write
  71 #define MM_PFLAG_KERNEL 0x10    // Kernel-Only (Ring0)
  72 /**
  73  * \}
  74  */
  75 // --- Interface Flags & Macros
  76 #define CLONE_VM        0x10
  77
  78 // === Types ===
  79 typedef void (*tThreadFunction)(void*);
  80
  81 // === Kernel Export Macros ===
  82 /**
  83  * \name Kernel Function
  84  * \{
  85  */
  86 typedef struct sKernelSymbol {
  87         char    *Name;
  88         Uint    Value;
  89 } tKernelSymbol;
  90 #define EXPORT(_name)   tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_name}
  91 #define EXPORTV(_name)  tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)&_name}
  92 #define EXPORTAS(_sym,_name)    tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_sym}
  93 /**
  94  * \}
  95  */
  96
  97 // === FUNCTIONS ===
  98 // --- Core ---
  99 extern void     System_Init(char *ArgString);
 100
 101 // --- IRQs ---
 102 extern int      IRQ_AddHandler(int Num, void (*Callback)(int));
 103
 104 // --- Logging ---
 105 extern void     Log_KernelPanic(char *Ident, char *Message, ...);
 106 extern void     Log_Panic(char *Ident, char *Message, ...);
 107 extern void     Log_Error(char *Ident, char *Message, ...);
 108 extern void     Log_Warning(char *Ident, char *Message, ...);
 109 extern void     Log_Notice(char *Ident, char *Message, ...);
 110 extern void     Log_Log(char *Ident, char *Message, ...);
 111 extern void     Log_Debug(char *Ident, char *Message, ...);
 112
 113 // --- Debug ---
 114 /**
 115  * \name Debugging and Errors
 116  * \{
 117  */
 118 extern void     Panic(char *Msg, ...);
 119 extern void     Warning(char *Msg, ...);
 120 extern void     Log(char *Fmt, ...);
 121 extern void     LogV(char *Fmt, va_list Args);
 122 extern void     LogF(char *Fmt, ...);
 123 extern void     Debug_Enter(char *FuncName, char *ArgTypes, ...);
 124 extern void     Debug_Log(char *FuncName, char *Fmt, ...);
 125 extern void     Debug_Leave(char *FuncName, char RetType, ...);
 126 extern void     Debug_HexDump(char *Header, void *Data, Uint Length);
 127 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
 128 #if DEBUG
 129 # define ENTER(_types...)       Debug_Enter((char*)__func__, _types)
 130 # define LOG(_fmt...)   Debug_Log((char*)__func__, _fmt)
 131 # define LEAVE(_t...)   Debug_Leave((char*)__func__, _t)
 132 # define LEAVE_RET(_t,_v...)    do{LEAVE(_t,_v);return _v;}while(0)
 133 # define LEAVE_RET0()   do{LEAVE('-');return;}while(0)
 134 #else
 135 # define ENTER(...)
 136 # define LOG(...)
 137 # define LEAVE(...)
 138 # define LEAVE_RET(_t,_v...)    return (_v)
 139 # define LEAVE_RET0()   return
 140 #endif
 141 #if SANITY
 142 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
 143 #else
 144 # define ASSERT(expr)
 145 #endif
 146 /**
 147  * \}
 148  */
 149
 150 // --- IO ---
 151 /**
 152  * \name I/O Memory Access
 153  * \{
 154  */
 155 extern void     outb(Uint16 Port, Uint8 Data);
 156 extern void     outw(Uint16 Port, Uint16 Data);
 157 extern void     outd(Uint16 Port, Uint32 Data);
 158 extern void     outq(Uint16 Port, Uint64 Data);
 159 extern Uint8    inb(Uint16 Port);
 160 extern Uint16   inw(Uint16 Port);
 161 extern Uint32   ind(Uint16 Port);
 162 extern Uint64   inq(Uint16 Port);
 163 /**
 164  * \}
 165  */
 166
 167 // --- Memory Management ---
 168 /**
 169  * \name Memory Management
 170  * \{
 171  * \todo Move to mm_virt.h
 172  */
 173 /**
 174  * \brief Allocate a physical page at \a VAddr
 175  * \param VAddr Virtual Address to allocate at
 176  * \return Physical address allocated
 177  */
 178 extern tPAddr   MM_Allocate(tVAddr VAddr);
 179 /**
 180  * \brief Deallocate a page
 181  * \param VAddr Virtual address to unmap
 182  */
 183 extern void     MM_Deallocate(tVAddr VAddr);
 184 /**
 185  * \brief Map a physical page at \a PAddr to \a VAddr
 186  * \param VAddr Target virtual address
 187  * \param PAddr Physical address to map
 188  * \return Boolean Success
 189  */
 190 extern int      MM_Map(tVAddr VAddr, tPAddr PAddr);
 191 /**
 192  * \brief Get the physical address of \a Addr
 193  * \param Addr  Address of the page to get the physical address of
 194  * \return Physical page mapped at \a Addr
 195  */
 196 extern tPAddr   MM_GetPhysAddr(tVAddr Addr);
 197 /**
 198  * \brief Checks is a memory range is user accessable
 199  * \param VAddr Base address to check
 200  * \return 1 if the memory is all user-accessable, 0 otherwise
 201  */
 202 extern int      MM_IsUser(tVAddr VAddr);
 203 /**
 204  * \brief Set the access flags on a page
 205  * \param VAddr Virtual address of the page
 206  * \param Flags New flags value
 207  * \param Mask  Flags to set
 208  */
 209 extern void     MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
 210 /**
 211  * \brief Temporarily map a page into the address space
 212  * \param PAddr Physical addres to map
 213  * \return Virtual address of page in memory
 214  * \note There is only a limited ammount of slots avaliable
 215  */
 216 extern tVAddr   MM_MapTemp(tPAddr PAddr);
 217 /**
 218  * \brief Free a temporarily mapped page
 219  * \param VAddr Allocate virtual addres of page
 220  */
 221 extern void     MM_FreeTemp(tVAddr VAddr);
 222 /**
 223  * \brief Map a physcal address range into the virtual address space
 224  * \param PAddr Physical address to map in
 225  * \param Number        Number of pages to map
 226  */
 227 extern tVAddr   MM_MapHWPages(tPAddr PAddr, Uint Number);
 228 /**
 229  * \brief Allocates DMA physical memory
 230  * \param Pages Number of pages required
 231  * \param MaxBits       Maximum number of bits the physical address can have
 232  * \param PhysAddr      Pointer to the location to place the physical address allocated
 233  * \return Virtual address allocate
 234  */
 235 extern tVAddr   MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
 236 /**
 237  * \brief Unmaps an allocated hardware range
 238  * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
 239  * \param Number        Number of pages to free
 240  */
 241 extern void     MM_UnmapHWPages(tVAddr VAddr, Uint Number);
 242 /**
 243  * \brief Allocate a single physical page
 244  * \return Physical address allocated
 245  */
 246 extern tPAddr   MM_AllocPhys();
 247 /**
 248  * \brief Allocate a contiguous range of physical pages
 249  * \param Pages Number of pages to allocate
 250  * \return First physical address allocated
 251  */
 252 extern tPAddr   MM_AllocPhysRange(int Pages, int MaxBits);
 253 /**
 254  * \brief Reference a physical page
 255  * \param PAddr Page to mark as referenced
 256  */
 257 extern void     MM_RefPhys(tPAddr PAddr);
 258 /**
 259  * \brief Dereference a physical page
 260  * \param PAddr Page to dereference
 261  */
 262 extern void     MM_DerefPhys(tPAddr PAddr);
 263 /**
 264  * \}
 265  */
 266
 267 // --- Memory Manipulation ---
 268 /**
 269  * \name Memory Manipulation
 270  * \{
 271  */
 272 extern int      memcmp(const void *m1, const void *m2, size_t count);
 273 extern void *memcpy(void *dest, const void *src, size_t count);
 274 extern void *memcpyd(void *dest, const void *src, size_t count);
 275 extern void *memset(void *dest, int val, size_t count);
 276 extern void *memsetd(void *dest, Uint32 val, size_t count);
 277 /**
 278  * \}
 279  */
 280 /**
 281  * \name Memory Validation
 282  * \{
 283  */
 284 extern int      CheckString(char *String);
 285 extern int      CheckMem(void *Mem, int Num);
 286 /**
 287  * \}
 288  */
 289
 290 // --- Endianness ---
 291 /**
 292  * \name Endianness Swapping
 293  * \{
 294  */
 295 extern Uint16   LittleEndian16(Uint16 Val);
 296 extern Uint16   BigEndian16(Uint16 Val);
 297 extern Uint32   LittleEndian32(Uint32 Val);
 298 extern Uint32   BigEndian32(Uint32 Val);
 299 /**
 300  * \}
 301  */
 302
 303 // --- Strings ---
 304 /**
 305  * \name Strings
 306  * \{
 307  */
 308 extern int      vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
 309 extern int      sprintf(char *__s, const char *__format, ...);
 310 extern Uint     strlen(const char *Str);
 311 extern char     *strcpy(char *__dest, const char *__src);
 312 extern char     *strncpy(char *__dest, const char *__src, size_t max);
 313 extern int      strcmp(const char *__str1, const char *__str2);
 314 extern int      strncmp(const char *Str1, const char *Str2, size_t num);
 315 extern int      strucmp(const char *Str1, const char *Str2);
 316 extern char     *strdup(const char *Str);
 317 extern int      strpos(const char *Str, char Ch);
 318 extern int      strpos8(const char *str, Uint32 search);
 319 extern void     itoa(char *buf, Uint num, int base, int minLength, char pad);
 320 extern int      atoi(const char *string);
 321 extern int      ReadUTF8(Uint8 *str, Uint32 *Val);
 322 extern int      WriteUTF8(Uint8 *str, Uint32 Val);
 323 extern int      ModUtil_SetIdent(char *Dest, char *Value);
 324 extern int      ModUtil_LookupString(char **Array, char *Needle);
 325 extern Uint8    ByteSum(void *Ptr, int Size);
 326 /**
 327  * \}
 328  */
 329
 330 extern Uint     rand();
 331 extern int      CallWithArgArray(void *Function, int NArgs, Uint *Args);
 332
 333 // --- Heap ---
 334 /**
 335  * \name Heap
 336  * \{
 337  */
 338 extern void *malloc(size_t size);
 339 extern void *calloc(size_t num, size_t size);
 340 extern void     *realloc(void *ptr, size_t size);
 341 extern void free(void *Ptr);
 342 extern int      IsHeap(void *Ptr);
 343 /**
 344  * \}
 345  */
 346
 347 // --- Modules ---
 348 /**
 349  * \name Modules
 350  * \{
 351  */
 352 extern int      Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
 353 extern int      Module_LoadFile(char *Path, char *ArgStr);
 354 /**
 355  * \}
 356  */
 357
 358 // --- Timing ---
 359 /**
 360  * \name Time and Timing
 361  * \{
 362  */
 363 /**
 364  * \brief Create a timestamp from a time
 365  */
 366 extern Sint64   timestamp(int sec, int mins, int hrs, int day, int month, int year);
 367 extern Sint64   now();
 368 extern int      Time_CreateTimer(int Delta, void *Callback, void *Argument);
 369 extern void     Time_RemoveTimer(int ID);
 370 extern void     Time_Delay(int Delay);
 371 /**
 372  * \}
 373  */
 374
 375 // --- Threads ---
 376 /**
 377  * \name Threads and Processes
 378  * \{
 379  */
 380 extern int      Proc_SpawnWorker();
 381 extern int      Proc_Spawn(char *Path);
 382 extern void     Threads_Exit();
 383 extern void     Threads_Yield();
 384 extern void     Threads_Sleep();
 385 extern void     Threads_WakeTID(tTID Thread);
 386 extern tPID     Threads_GetPID();
 387 extern tTID     Threads_GetTID();
 388 extern tUID     Threads_GetUID();
 389 extern tGID     Threads_GetGID();
 390 extern int      SpawnTask(tThreadFunction Function, void *Arg);
 391 extern Uint     *Threads_GetCfgPtr(int Id);
 392 extern int      Threads_SetName(char *NewName);
 393 /**
 394  * \}
 395  */
 396
 397 // --- Simple Math ---
 398 extern int      DivUp(int num, int dem);
 399
 400 #include <binary_ext.h>
 401 #include <vfs_ext.h>
 402
 403 #endif