Kernel/include/acess.h

   1 /*
   2  * AcessOS Microkernel Version
   3  * acess.h
   4  */
   5 #ifndef _ACESS_H
   6 #define _ACESS_H
   7
   8 #define NULL    ((void*)0)
   9 #define PACKED  __attribute__((packed))
  10 #define UNUSED(x)       UNUSED_##x __attribute__((unused))
  11 #define offsetof(st, m) ((Uint)((char *)&((st *)(0))->m - (char *)0 ))
  12
  13 #include <arch.h>
  14 #include <stdarg.h>
  15 #include "errno.h"
  16
  17 // --- Types ---
  18 typedef  int    tPID;
  19 typedef  int    tTID;
  20 typedef Uint    tUID;
  21 typedef Uint    tGID;
  22 typedef Sint64  tTimestamp;
  23 typedef Sint64  tTime;
  24 typedef struct sShortSpinlock   tShortSpinlock;
  25
  26 // --- Helper Macros ---
  27 /**
  28  * \name Helper Macros
  29  * \{
  30  */
  31 #define CONCAT(x,y) x ## y
  32 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
  33 #define STR(x) #x
  34 #define EXPAND_STR(x) STR(x)
  35
  36 #define VER2(major,minor)       ((((major)&0xFF)<<8)|((minor)&0xFF))
  37 /**
  38  * \}
  39  */
  40
  41 /**
  42  * \name Per-Thread Configuration Settings
  43  * \{
  44  */
  45 enum eConfigTypes {
  46         CFGT_NULL,
  47         CFGT_INT,
  48         CFGT_HEAPSTR,
  49         CFGT_PTR
  50 };
  51 enum eConfigs {
  52         CFG_VFS_CWD,
  53         CFG_VFS_MAXFILES,
  54         CFG_VFS_CHROOT,
  55         CFG_ERRNO,
  56         NUM_CFG_ENTRIES
  57 };
  58 #define CFGINT(id)      (*Threads_GetCfgPtr(id))
  59 #define CFGPTR(id)      (*(void**)Threads_GetCfgPtr(id))
  60
  61 #define errno   (CFGINT(CFG_ERRNO))
  62 /**
  63  * \}
  64  */
  65
  66 // === CONSTANTS ===
  67 // --- Memory Flags --
  68 /**
  69  * \name Memory Flags
  70  * \{
  71  * \todo Move to mm_virt.h
  72  */
  73 #define MM_PFLAG_RO             0x01    // Writes disallowed
  74 #define MM_PFLAG_EXEC   0x02    // Allow execution
  75 #define MM_PFLAG_NOPAGE 0x04    // Prevent from being paged out
  76 #define MM_PFLAG_COW    0x08    // Copy-On-Write
  77 #define MM_PFLAG_KERNEL 0x10    // Kernel-Only (Ring0)
  78 /**
  79  * \}
  80  */
  81 // --- Interface Flags & Macros
  82 #define CLONE_VM        0x10
  83
  84 // === Types ===
  85 typedef void (*tThreadFunction)(void*);
  86
  87 // === Kernel Export Macros ===
  88 /**
  89  * \name Kernel Function
  90  * \{
  91  */
  92 typedef struct sKernelSymbol {
  93         const char      *Name;
  94         tVAddr  Value;
  95 } tKernelSymbol;
  96 #define EXPORT(_name)   tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)_name}
  97 #define EXPORTV(_name)  tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)&_name}
  98 #define EXPORTAS(_sym,_name)    tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)_sym}
  99 /**
 100  * \}
 101  */
 102
 103 // === FUNCTIONS ===
 104 // --- IRQs ---
 105 extern int      IRQ_AddHandler(int Num, void (*Callback)(int));
 106 extern void     IRQ_RemHandler(int Handle);
 107
 108 // --- Logging ---
 109 extern void     Log_KernelPanic(const char *Ident, const char *Message, ...);
 110 extern void     Log_Panic(const char *Ident, const char *Message, ...);
 111 extern void     Log_Error(const char *Ident, const char *Message, ...);
 112 extern void     Log_Warning(const char *Ident, const char *Message, ...);
 113 extern void     Log_Notice(const char *Ident, const char *Message, ...);
 114 extern void     Log_Log(const char *Ident, const char *Message, ...);
 115 extern void     Log_Debug(const char *Ident, const char *Message, ...);
 116
 117 // --- Debug ---
 118 /**
 119  * \name Debugging and Errors
 120  * \{
 121  */
 122 extern void     Debug_KernelPanic(void);        //!< Initiate a kernel panic
 123 extern void     Panic(const char *Msg, ...);    //!< Print a panic message (initiates a kernel panic)
 124 extern void     Warning(const char *Msg, ...);  //!< Print a warning message
 125 extern void     LogF(const char *Fmt, ...);     //!< Print a log message without a trailing newline
 126 extern void     Log(const char *Fmt, ...);      //!< Print a log message
 127 extern void     Debug(const char *Fmt, ...);    //!< Print a debug message (doesn't go to KTerm)
 128 extern void     LogV(const char *Fmt, va_list Args);    //!< va_list Log message
 129 extern void     Debug_Enter(const char *FuncName, const char *ArgTypes, ...);
 130 extern void     Debug_Log(const char *FuncName, const char *Fmt, ...);
 131 extern void     Debug_Leave(const char *FuncName, char RetType, ...);
 132 extern void     Debug_HexDump(const char *Header, const void *Data, Uint Length);
 133 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
 134 #if DEBUG
 135 # define ENTER(_types...)       Debug_Enter((char*)__func__, _types)
 136 # define LOG(_fmt...)   Debug_Log((char*)__func__, _fmt)
 137 # define LEAVE(_t...)   Debug_Leave((char*)__func__, _t)
 138 # define LEAVE_RET(_t,_v...)    do{LEAVE(_t,_v);return _v;}while(0)
 139 # define LEAVE_RET0()   do{LEAVE('-');return;}while(0)
 140 #else
 141 # define ENTER(...)
 142 # define LOG(...)
 143 # define LEAVE(...)
 144 # define LEAVE_RET(_t,_v...)    return (_v)
 145 # define LEAVE_RET0()   return
 146 #endif
 147 #if SANITY
 148 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
 149 #else
 150 # define ASSERT(expr)
 151 #endif
 152 /**
 153  * \}
 154  */
 155
 156 // --- IO ---
 157 /**
 158  * \name I/O Memory Access
 159  * \{
 160  */
 161 extern void     outb(Uint16 Port, Uint8 Data);
 162 extern void     outw(Uint16 Port, Uint16 Data);
 163 extern void     outd(Uint16 Port, Uint32 Data);
 164 extern void     outq(Uint16 Port, Uint64 Data);
 165 extern Uint8    inb(Uint16 Port);
 166 extern Uint16   inw(Uint16 Port);
 167 extern Uint32   ind(Uint16 Port);
 168 extern Uint64   inq(Uint16 Port);
 169 /**
 170  * \}
 171  */
 172
 173 // --- Memory Management ---
 174 /**
 175  * \name Memory Management
 176  * \{
 177  * \todo Move to mm_virt.h
 178  */
 179 /**
 180  * \brief Allocate a physical page at \a VAddr
 181  * \param VAddr Virtual Address to allocate at
 182  * \return Physical address allocated
 183  */
 184 extern tPAddr   MM_Allocate(tVAddr VAddr) __attribute__ ((warn_unused_result));
 185 /**
 186  * \brief Deallocate a page
 187  * \param VAddr Virtual address to unmap
 188  */
 189 extern void     MM_Deallocate(tVAddr VAddr);
 190 /**
 191  * \brief Map a physical page at \a PAddr to \a VAddr
 192  * \param VAddr Target virtual address
 193  * \param PAddr Physical address to map
 194  * \return Boolean Success
 195  */
 196 extern int      MM_Map(tVAddr VAddr, tPAddr PAddr);
 197 /**
 198  * \brief Get the physical address of \a Addr
 199  * \param Addr  Address of the page to get the physical address of
 200  * \return Physical page mapped at \a Addr
 201  */
 202 extern tPAddr   MM_GetPhysAddr(tVAddr Addr);
 203 /**
 204  * \brief Set the access flags on a page
 205  * \param VAddr Virtual address of the page
 206  * \param Flags New flags value
 207  * \param Mask  Flags to set
 208  */
 209 extern void     MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
 210 /**
 211  * \brief Get the flags on a flag
 212  * \param VAddr Virtual address of page
 213  * \return Flags value of the page
 214  */
 215 extern Uint     MM_GetFlags(tVAddr VAddr);
 216 /**
 217  * \brief Checks is a memory range is user accessable
 218  * \param VAddr Base address to check
 219  * \return 1 if the memory is all user-accessable, 0 otherwise
 220  */
 221 #define MM_IsUser(VAddr)        (!(MM_GetFlags((VAddr))&MM_PFLAG_KERNEL))
 222 /**
 223  * \brief Temporarily map a page into the address space
 224  * \param PAddr Physical addres to map
 225  * \return Virtual address of page in memory
 226  * \note There is only a limited ammount of slots avaliable
 227  */
 228 extern tVAddr   MM_MapTemp(tPAddr PAddr);
 229 /**
 230  * \brief Free a temporarily mapped page
 231  * \param VAddr Allocate virtual addres of page
 232  */
 233 extern void     MM_FreeTemp(tVAddr VAddr);
 234 /**
 235  * \brief Map a physcal address range into the virtual address space
 236  * \param PAddr Physical address to map in
 237  * \param Number        Number of pages to map
 238  */
 239 extern tVAddr   MM_MapHWPages(tPAddr PAddr, Uint Number);
 240 /**
 241  * \brief Allocates DMA physical memory
 242  * \param Pages Number of pages required
 243  * \param MaxBits       Maximum number of bits the physical address can have
 244  * \param PhysAddr      Pointer to the location to place the physical address allocated
 245  * \return Virtual address allocate
 246  */
 247 extern tVAddr   MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
 248 /**
 249  * \brief Unmaps an allocated hardware range
 250  * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
 251  * \param Number        Number of pages to free
 252  */
 253 extern void     MM_UnmapHWPages(tVAddr VAddr, Uint Number);
 254 /**
 255  * \brief Allocate a single physical page
 256  * \return Physical address allocated
 257  */
 258 extern tPAddr   MM_AllocPhys(void);
 259 /**
 260  * \brief Allocate a contiguous range of physical pages
 261  * \param Pages Number of pages to allocate
 262  * \param MaxBits       Maximum number of address bits allowed
 263  * \return First physical address allocated
 264  */
 265 extern tPAddr   MM_AllocPhysRange(int Pages, int MaxBits);
 266 /**
 267  * \brief Reference a physical page
 268  * \param PAddr Page to mark as referenced
 269  */
 270 extern void     MM_RefPhys(tPAddr PAddr);
 271 /**
 272  * \brief Dereference a physical page
 273  * \param PAddr Page to dereference
 274  */
 275 extern void     MM_DerefPhys(tPAddr PAddr);
 276 /**
 277  * \brief Get the number of times a page has been referenced
 278  * \param PAddr Address to check
 279  * \return Reference count for the page
 280  */
 281 extern int      MM_GetRefCount(tPAddr PAddr);
 282 /**
 283  * \brief Set the node associated with a page
 284  * \param PAddr Physical address of page
 285  * \param Node  Node pointer (tVFS_Node)
 286  * \return Boolean failure
 287  * \retval 0    Success
 288  * \retval 1    Page not allocated
 289  */
 290 extern int      MM_SetPageNode(tPAddr PAddr, void *Node);
 291 /**
 292  * \brief Get the node associated with a page
 293  * \param PAddr Physical address of page
 294  * \param Node  Node pointer (tVFS_Node) destination
 295  * \return Boolean failure
 296  * \retval 0    Success
 297  * \retval 1    Page not allocated
 298  */
 299 extern int      MM_GetPageNode(tPAddr PAddr, void **Node);
 300 /**
 301  * \}
 302  */
 303
 304 // --- Memory Manipulation ---
 305 /**
 306  * \name Memory Manipulation
 307  * \{
 308  */
 309 extern int      memcmp(const void *m1, const void *m2, size_t count);
 310 extern void *memcpy(void *dest, const void *src, size_t count);
 311 extern void *memcpyd(void *dest, const void *src, size_t count);
 312 extern void *memset(void *dest, int val, size_t count);
 313 extern void *memsetd(void *dest, Uint32 val, size_t count);
 314 /**
 315  * \}
 316  */
 317 /**
 318  * \name Memory Validation
 319  * \{
 320  */
 321 extern int      CheckString(const char *String);
 322 extern int      CheckMem(const void *Mem, int Num);
 323 /**
 324  * \}
 325  */
 326
 327 // --- Endianness ---
 328 /**
 329  * \name Endianness Swapping
 330  * \{
 331  */
 332 #ifdef __BIG_ENDIAN__
 333 #define LittleEndian16(_val)    SwapEndian16(_val)
 334 #define LittleEndian32(_val)    SwapEndian32(_val)
 335 #define BigEndian16(_val)       (_val)
 336 #define BigEndian32(_val)       (_val)
 337 #else
 338 #define LittleEndian16(_val)    (_val)
 339 #define LittleEndian32(_val)    (_val)
 340 #define BigEndian16(_val)       SwapEndian16(_val)
 341 #define BigEndian32(_val)       SwapEndian32(_val)
 342 #endif
 343 extern Uint16   SwapEndian16(Uint16 Val);
 344 extern Uint32   SwapEndian32(Uint32 Val);
 345 /**
 346  * \}
 347  */
 348
 349 // --- Strings ---
 350 /**
 351  * \name Strings
 352  * \{
 353  */
 354 extern int      vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
 355 extern int      sprintf(char *__s, const char *__format, ...);
 356 extern size_t   strlen(const char *Str);
 357 extern char     *strcpy(char *__dest, const char *__src);
 358 extern char     *strncpy(char *__dest, const char *__src, size_t max);
 359 extern char     *strcat(char *__dest, const char *__src);
 360 extern char     *strncat(char *__dest, const char *__src, size_t n);
 361 extern int      strcmp(const char *__str1, const char *__str2);
 362 extern int      strncmp(const char *Str1, const char *Str2, size_t num);
 363 extern int      strucmp(const char *Str1, const char *Str2);
 364 // strdup macro is defined in heap.h
 365 extern char     *_strdup(const char *File, int Line, const char *Str);
 366 extern char     **str_split(const char *__str, char __ch);
 367 extern char     *strchr(const char *__s, int __c);
 368 extern int      strpos(const char *Str, char Ch);
 369 extern int      strpos8(const char *str, Uint32 search);
 370 extern void     itoa(char *buf, Uint64 num, int base, int minLength, char pad);
 371 extern int      atoi(const char *string);
 372 extern int      ReadUTF8(const Uint8 *str, Uint32 *Val);
 373 extern int      WriteUTF8(Uint8 *str, Uint32 Val);
 374 extern int      ModUtil_SetIdent(char *Dest, const char *Value);
 375 extern int      ModUtil_LookupString(const char **Array, const char *Needle);
 376
 377 extern Uint8    ByteSum(const void *Ptr, int Size);
 378 extern int      UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString);
 379 /**
 380  * \}
 381  */
 382
 383 extern int      rand(void);
 384 extern int      CallWithArgArray(void *Function, int NArgs, Uint *Args);
 385
 386 // --- Heap ---
 387 #include <heap.h>
 388
 389 // --- Modules ---
 390 /**
 391  * \name Modules
 392  * \{
 393  */
 394 extern int      Module_LoadMem(void *Buffer, Uint Length, const char *ArgStr);
 395 extern int      Module_LoadFile(const char *Path, const char *ArgStr);
 396 /**
 397  * \}
 398  */
 399
 400 // --- Timing ---
 401 /**
 402  * \name Time and Timing
 403  * \{
 404  */
 405 /**
 406  * \brief Create a timestamp from a time
 407  */
 408 extern Sint64   timestamp(int sec, int mins, int hrs, int day, int month, int year);
 409 /**
 410  * \brief Gets the current timestamp (miliseconds since Midnight 1st January 1970)
 411  */
 412 extern Sint64   now(void);
 413 /**
 414  * \brief Timer callback function
 415  */
 416 typedef void (tTimerCallback)(void *);
 417 /**
 418  * \brief Creates a one-shot timer
 419  * \param Delta Period of the timer
 420  * \param Callback      Function to call each time
 421  * \param Argument      Argument to pass to the callback
 422  */
 423 extern int      Time_CreateTimer(int Delta, tTimerCallback *Callback, void *Argument);
 424 /**
 425  * \brief Removed an active timer
 426  */
 427 extern void     Time_RemoveTimer(int ID);
 428 /**
 429  * \brief Wait for a period of milliseconds
 430  */
 431 extern void     Time_Delay(int Delay);
 432 /**
 433  * \}
 434  */
 435
 436 // --- Threads ---
 437 /**
 438  * \name Threads and Processes
 439  * \{
 440  */
 441 extern int      Proc_SpawnWorker(void);
 442 extern int      Proc_Spawn(const char *Path);
 443 extern void     Threads_Exit(int TID, int Status);
 444 extern void     Threads_Yield(void);
 445 extern void     Threads_Sleep(void);
 446 extern int      Threads_WakeTID(tTID Thread);
 447 extern tPID     Threads_GetPID(void);
 448 extern tTID     Threads_GetTID(void);
 449 extern tUID     Threads_GetUID(void);
 450 extern tGID     Threads_GetGID(void);
 451 extern int      SpawnTask(tThreadFunction Function, void *Arg);
 452 extern Uint     *Threads_GetCfgPtr(int Id);
 453 extern int      Threads_SetName(const char *NewName);
 454 /**
 455  * \}
 456  */
 457
 458 // --- Simple Math ---
 459 extern int      DivUp(int num, int dem);
 460
 461 #include <binary_ext.h>
 462 #include <vfs_ext.h>
 463 #include <mutex.h>
 464
 465 #endif