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 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
 107 #if DEBUG
 108 # define ENTER(_types...)       Debug_Enter((char*)__func__, _types)
 109 # define LOG(_fmt...)   Debug_Log((char*)__func__, _fmt)
 110 # define LEAVE(_t...)   Debug_Leave((char*)__func__, _t)
 111 # define LEAVE_RET(_t,_v...)    do{LEAVE(_t,_v);return _v;}while(0)
 112 # define LEAVE_RET0()   do{LEAVE('-');return;}while(0)
 113 #else
 114 # define ENTER(...)
 115 # define LOG(...)
 116 # define LEAVE(...)
 117 # define LEAVE_RET(_t,_v...)    return (_v)
 118 # define LEAVE_RET0()   return
 119 #endif
 120 #if SANITY
 121 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
 122 #else
 123 # define ASSERT(expr)
 124 #endif
 125 /**
 126  * \}
 127  */
 128
 129 // --- IO ---
 130 /**
 131  * \name I/O Memory Access
 132  * \{
 133  */
 134 extern void     outb(Uint16 Port, Uint8 Data);
 135 extern void     outw(Uint16 Port, Uint16 Data);
 136 extern void     outd(Uint16 Port, Uint32 Data);
 137 extern void     outq(Uint16 Port, Uint64 Data);
 138 extern Uint8    inb(Uint16 Port);
 139 extern Uint16   inw(Uint16 Port);
 140 extern Uint32   ind(Uint16 Port);
 141 extern Uint64   inq(Uint16 Port);
 142 /**
 143  * \}
 144  */
 145
 146 // --- Memory Management ---
 147 /**
 148  * \name Memory Management
 149  * \{
 150  * \todo Move to mm_virt.h
 151  */
 152 /**
 153  * \brief Allocate a physical page at \a VAddr
 154  * \param VAddr Virtual Address to allocate at
 155  * \return Physical address allocated
 156  */
 157 extern tPAddr   MM_Allocate(tVAddr VAddr);
 158 /**
 159  * \brief Deallocate a page
 160  * \param VAddr Virtual address to unmap
 161  */
 162 extern void     MM_Deallocate(tVAddr VAddr);
 163 /**
 164  * \brief Map a physical page at \a PAddr to \a VAddr
 165  * \param VAddr Target virtual address
 166  * \param PAddr Physical address to map
 167  * \return Boolean Success
 168  */
 169 extern int      MM_Map(tVAddr VAddr, tPAddr PAddr);
 170 /**
 171  * \brief Get the physical address of \a VAddr
 172  * \param VAddr Address of the page to get the physical address of
 173  * \return Physical page mapped at \a VAddr
 174  */
 175 extern tPAddr   MM_GetPhysAddr(tVAddr VAddr);
 176 /**
 177  * \brief Checks is a memory range is user accessable
 178  * \param VAddr Base address to check
 179  * \return 1 if the memory is all user-accessable, 0 otherwise
 180  */
 181 extern int      MM_IsUser(tVAddr VAddr);
 182 /**
 183  * \brief Set the access flags on a page
 184  * \param VAddr Virtual address of the page
 185  * \param Flags New flags value
 186  * \param Mask  Flags to set
 187  */
 188 extern void     MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
 189 /**
 190  * \brief Temporarily map a page into the address space
 191  * \param PAddr Physical addres to map
 192  * \return Virtual address of page in memory
 193  * \note There is only a limited ammount of slots avaliable
 194  */
 195 extern tVAddr   MM_MapTemp(tPAddr PAddr);
 196 /**
 197  * \brief Free a temporarily mapped page
 198  * \param VAddr Allocate virtual addres of page
 199  */
 200 extern void     MM_FreeTemp(tVAddr VAddr);
 201 /**
 202  * \brief Map a physcal address range into the virtual address space
 203  * \param PAddr Physical address to map in
 204  * \param Number        Number of pages to map
 205  */
 206 extern tVAddr   MM_MapHWPage(tPAddr PAddr, Uint Number);
 207 /**
 208  * \brief Allocates DMA physical memory
 209  * \param Pages Number of pages required
 210  * \param MaxBits       Maximum number of bits the physical address can have
 211  * \param PhysAddr      Pointer to the location to place the physical address allocated
 212  * \return Virtual address allocate
 213  */
 214 extern tVAddr   MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
 215 /**
 216  * \brief Unmaps an allocated hardware range
 217  * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
 218  * \param Number        Number of pages to free
 219  */
 220 extern void     MM_UnmapHWPage(tVAddr VAddr, Uint Number);
 221 /**
 222  * \brief Allocate a single physical page
 223  * \return Physical address allocated
 224  */
 225 extern tPAddr   MM_AllocPhys();
 226 /**
 227  * \brief Allocate a contiguous range of physical pages
 228  * \param Pages Number of pages to allocate
 229  * \return First physical address allocated
 230  */
 231 extern tPAddr   MM_AllocPhysRange(int Pages, int MaxBits);
 232 /**
 233  * \brief Reference a physical page
 234  * \param PAddr Page to mark as referenced
 235  */
 236 extern void     MM_RefPhys(tPAddr PAddr);
 237 /**
 238  * \brief Dereference a physical page
 239  * \param PAddr Page to dereference
 240  */
 241 extern void     MM_DerefPhys(tPAddr PAddr);
 242 /**
 243  * \}
 244  */
 245
 246 // --- Memory Manipulation ---
 247 /**
 248  * \name Memory Manipulation
 249  * \{
 250  */
 251 extern int      memcmp(const void *m1, const void *m2, Uint count);
 252 extern void *memcpy(void *dest, const void *src, Uint count);
 253 extern void *memcpyd(void *dest, const void *src, Uint count);
 254 extern void *memset(void *dest, int val, Uint count);
 255 extern void *memsetd(void *dest, Uint val, Uint count);
 256 /**
 257  * \}
 258  */
 259 /**
 260  * \name Memory Validation
 261  * \{
 262  */
 263 extern int      CheckString(char *String);
 264 extern int      CheckMem(void *Mem, int Num);
 265 /**
 266  * \}
 267  */
 268
 269 // --- Endianness ---
 270 /**
 271  * \name Endianness Swapping
 272  * \{
 273  */
 274 extern Uint16   LittleEndian16(Uint16 Val);
 275 extern Uint16   BigEndian16(Uint16 Val);
 276 extern Uint32   LittleEndian32(Uint32 Val);
 277 extern Uint32   BigEndian32(Uint32 Val);
 278 /**
 279  * \}
 280  */
 281
 282 // --- Strings ---
 283 /**
 284  * \name Strings
 285  * \{
 286  */
 287 extern Uint     strlen(const char *Str);
 288 extern char     *strcpy(char *__dest, const char *__src);
 289 extern int      strcmp(const char *__str1, const char *__str2);
 290 extern int      strncmp(const char *Str1, const char *Str2, size_t num);
 291 extern int      strucmp(const char *Str1, const char *Str2);
 292 extern char     *strdup(const char *Str);
 293 extern int      strpos(const char *Str, char Ch);
 294 extern int      strpos8(const char *str, Uint32 search);
 295 extern void     itoa(char *buf, Uint num, int base, int minLength, char pad);
 296 extern int      ReadUTF8(Uint8 *str, Uint32 *Val);
 297 extern int      WriteUTF8(Uint8 *str, Uint32 Val);
 298 extern int      LookupString(char **Array, char *Needle);
 299 extern Uint8    ByteSum(void *Ptr, int Size);
 300 /**
 301  * \}
 302  */
 303
 304 extern Uint     rand();
 305
 306 // --- Heap ---
 307 /**
 308  * \name Heap
 309  * \{
 310  */
 311 extern void *malloc(size_t size);
 312 extern void *calloc(size_t num, size_t size);
 313 extern void     *realloc(void *ptr, size_t size);
 314 extern void free(void *Ptr);
 315 extern int      IsHeap(void *Ptr);
 316 /**
 317  * \}
 318  */
 319
 320 // --- Modules ---
 321 /**
 322  * \name Modules
 323  * \{
 324  */
 325 extern int      Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
 326 extern int      Module_LoadFile(char *Path, char *ArgStr);
 327 /**
 328  * \}
 329  */
 330
 331 // --- Timing ---
 332 /**
 333  * \name Time and Timing
 334  * \{
 335  */
 336 /**
 337  * \brief Create a timestamp from a time
 338  */
 339 extern Sint64   timestamp(int sec, int mins, int hrs, int day, int month, int year);
 340 extern Sint64   now();
 341 extern int      Time_CreateTimer(int Delta, void *Callback, void *Argument);
 342 extern void     Time_RemoveTimer(int ID);
 343 extern void     Time_Delay(int Delay);
 344 /**
 345  * \}
 346  */
 347
 348 // --- Threads ---
 349 /**
 350  * \name Threads and Processes
 351  * \{
 352  */
 353 extern int      Proc_SpawnWorker();
 354 extern int      Proc_Spawn(char *Path);
 355 extern void     Threads_Exit();
 356 extern void     Threads_Yield();
 357 extern void     Threads_Sleep();
 358 extern int      Threads_GetUID();
 359 extern int      Threads_GetGID();
 360 extern int      SpawnTask(tThreadFunction Function, void *Arg);
 361 extern Uint     *Threads_GetCfgPtr(int Id);
 362 /**
 363  * \}
 364  */
 365
 366 // --- Simple Math ---
 367 extern int      DivUp(int num, int dem);
 368
 369 #include <binary_ext.h>
 370 #include <vfs_ext.h>
 371
 372 #endif