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