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