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