Kernel/include/common.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 enum eConfigTypes {
  14         CFGT_NULL,
  15         CFGT_INT,
  16         CFGT_HEAPSTR,
  17         CFGT_PTR
  18 };
  19 enum eConfigs {
  20         CFG_VFS_CWD,
  21         CFG_VFS_MAXFILES,
  22         NUM_CFG_ENTRIES
  23 };
  24 #define CFGINT(id)      (*Threads_GetCfgPtr(id))
  25 #define CFGPTR(id)      (*(void**)Threads_GetCfgPtr(id))
  26
  27 // === CONSTANTS ===
  28 // --- Memory Flags --
  29 #define MM_PFLAG_RO             0x01    // Writes disallowed
  30 #define MM_PFLAG_EXEC   0x02    // Allow execution
  31 #define MM_PFLAG_NOPAGE 0x04    // Prevent from being paged out
  32 #define MM_PFLAG_COW    0x08    // Copy-On-Write
  33 #define MM_PFLAG_KERNEL 0x10    // Kernel-Only (Ring0)
  34
  35 // === Kernel Export Macros ===
  36 typedef struct sKernelSymbol {
  37         char    *Name;
  38         unsigned int    Value;
  39 } tKernelSymbol;
  40 #define EXPORT(_name)   tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_name}
  41 #define EXPORTAS(_sym,_name)    tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_sym}
  42
  43 // === FUNCTIONS ===
  44 // --- Core ---
  45 extern void     System_Init(char *ArgString);
  46 extern int      IRQ_AddHandler(int Num, void (*Callback)(int));
  47 // --- Debug ---
  48 extern void     Panic(char *Msg, ...);
  49 extern void     Warning(char *Msg, ...);
  50 extern void     Log(char *Fmt, ...);
  51 extern void     LogV(char *Fmt, va_list Args);
  52 extern void     LogF(char *Fmt, ...);
  53 extern void     Debug_Enter(char *FuncName, char *ArgTypes, ...);
  54 extern void     Debug_Log(char *FuncName, char *Fmt, ...);
  55 extern void     Debug_Leave(char *FuncName, char RetType, ...);
  56 extern void     Debug_HexDump(char *Header, void *Data, Uint Length);
  57 #if DEBUG
  58 # define ENTER(_types...)       Debug_Enter((char*)__func__, _types)
  59 # define LOG(_fmt...)   Debug_Log((char*)__func__, _fmt)
  60 # define LEAVE(_t...)   Debug_Leave((char*)__func__, _t)
  61 #else
  62 # define ENTER(...)
  63 # define LOG(...)
  64 # define LEAVE(...)
  65 #endif
  66 // --- IO ---
  67 extern void     outb(Uint16 Port, Uint8 Data);
  68 extern void     outw(Uint16 Port, Uint16 Data);
  69 extern void     outd(Uint16 Port, Uint32 Data);
  70 extern void     outq(Uint16 Port, Uint64 Data);
  71 extern Uint8    inb(Uint16 Port);
  72 extern Uint16   inw(Uint16 Port);
  73 extern Uint32   ind(Uint16 Port);
  74 extern Uint64   inq(Uint16 Port);
  75 // --- Memory ---
  76 extern tPAddr   MM_Allocate(Uint VAddr);
  77 extern void     MM_Deallocate(Uint VAddr);      //!< Deallocate a page
  78 extern int      MM_Map(Uint VAddr, tPAddr PAddr);       //!< Map a page
  79 extern tPAddr   MM_GetPhysAddr(Uint VAddr);     //!< Get the physical address of a page
  80 extern int      MM_IsUser(Uint VAddr, int Length);      //!< Checks if a memory address is valid user memory
  81 extern void     MM_SetFlags(Uint VAddr, Uint Flags, Uint Mask);
  82 extern Uint     MM_MapTemp(tPAddr PAddr);
  83 extern void     MM_FreeTemp(Uint PAddr);
  84 extern Uint     MM_MapHWPage(tPAddr PAddr, Uint Number);
  85 extern void     MM_UnmapHWPage(Uint VAddr, Uint Number);
  86 extern tPAddr   MM_AllocPhys();
  87 extern void     MM_RefPhys(tPAddr Addr);
  88 extern void     MM_DerefPhys(tPAddr Addr);
  89 extern int      memcmp(const void *m1, const void *m2, Uint count);
  90 extern void *memcpy(void *dest, const void *src, Uint count);
  91 extern void *memcpyd(void *dest, const void *src, Uint count);
  92 extern void *memset(void *dest, int val, Uint count);
  93 extern void *memsetd(void *dest, Uint val, Uint count);
  94 extern Uint16   LittleEndian16(Uint16 Val);
  95 extern Uint16   BigEndian16(Uint16 Val);
  96 extern Uint32   LittleEndian32(Uint32 Val);
  97 extern Uint32   BigEndian32(Uint32 Val);
  98 // --- Strings ---
  99 extern Uint     strlen(const char *Str);
 100 extern char     *strcpy(char *__dest, const char *__src);
 101 extern int      strcmp(const char *__str1, const char *__str2);
 102 extern int      strncmp(const char *Str1, const char *Str2, size_t num);
 103 extern int      strucmp(const char *Str1, const char *Str2);
 104 extern char     *strdup(const char *__str);
 105 extern int      strpos(const char *Str, char Ch);
 106 extern int      strpos8(const char *str, Uint32 search);
 107 extern void     itoa(char *buf, Uint num, int base, int minLength, char pad);
 108 extern int      ReadUTF8(Uint8 *str, Uint32 *Val);
 109 extern int      WriteUTF8(Uint8 *str, Uint32 Val);
 110 extern Uint     rand();
 111 // --- Heap ---
 112 extern void *malloc(size_t size);
 113 extern void *calloc(size_t num, size_t size);
 114 extern void     *realloc(void *ptr, size_t size);
 115 extern void free(void *Ptr);
 116 extern int      IsHeap(void *Ptr);
 117 // --- Modules ---
 118 extern int      Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
 119 extern int      Module_LoadFile(char *Path, char *ArgStr);
 120 // --- Timing ---
 121 extern Sint64   timestamp(int sec, int mins, int hrs, int day, int month, int year);
 122 extern Sint64   now();
 123 extern int      Time_CreateTimer(int Delta, void *Callback, void *Argument);
 124 extern void     Time_RemoveTimer(int ID);
 125 extern void     Time_Delay(int Delay);
 126 // --- Threads ---
 127 extern  int     Proc_SpawnWorker();
 128 extern  int     Proc_Spawn(char *Path);
 129 extern void     Threads_Exit();
 130 extern void     Threads_Yield();
 131 extern void     Threads_Sleep();
 132 extern int      Threads_GetUID();
 133 extern int      Threads_GetGID();
 134 extern int      SpawnTask(tThreadFunction Function, void *Arg);
 135 extern Uint     *Threads_GetCfgPtr(int Id);
 136 // --- Simple Math ---
 137 extern int      DivUp(int num, int dem);
 138
 139 #include <binary_ext.h>
 140 #include <vfs_ext.h>
 141
 142 #endif