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