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