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