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