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