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