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