2 * AcessOS Microkernel Version
9 * \brief Acess2 Kernel API Core
13 #define NULL ((void*)0)
15 #define PACKED __attribute__((packed))
16 //! Mark a function as not returning
17 #define NORETURN __attribute__((noreturn))
18 //! Mark a parameter as unused
19 #define UNUSED(x) UNUSED_##x __attribute__((unused))
20 //! Get the offset of a member in a structure
21 #define offsetof(st, m) ((Uint)((char *)&((st *)(0))->m - (char *)0 ))
24 * \name Boolean constants
38 typedef Uint32 tPID; //!< Process ID type
39 typedef Uint32 tTID; //!< Thread ID Type
40 typedef Uint32 tUID; //!< User ID Type
41 typedef Uint32 tGID; //!< Group ID Type
42 typedef Sint64 tTimestamp; //!< Timestamp (miliseconds since 00:00 1 Jan 1970)
43 typedef Sint64 tTime; //!< Same again
44 typedef struct sShortSpinlock tShortSpinlock; //!< Opaque (kinda) spinlock
45 typedef int bool; //!< Boolean type
47 // --- Helper Macros ---
52 #define CONCAT(x,y) x ## y
53 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
55 #define EXPAND_STR(x) STR(x)
57 extern char __buildnum[];
58 #define BUILD_NUM ((int)(Uint)&__buildnum)
59 extern const char gsGitHash[];
61 #define VER2(major,minor) ((((major)&0xFF)<<8)|((minor)&0xFF))
66 //! \brief Error number
67 #define errno (*Threads_GetErrno())
70 // --- Memory Flags --
74 * \todo Move to mm_virt.h
76 #define MM_PFLAG_RO 0x01 // Writes disallowed
77 #define MM_PFLAG_EXEC 0x02 // Allow execution
78 #define MM_PFLAG_NOPAGE 0x04 // Prevent from being paged out
79 #define MM_PFLAG_COW 0x08 // Copy-On-Write
80 #define MM_PFLAG_KERNEL 0x10 // Kernel-Only (Ring0)
84 // --- Interface Flags & Macros
86 * \name Flags for Proc_Clone
89 //! Clone the entire process
91 //! Don't copy user pages
92 #define CLONE_NOUSER 0x20
99 * \brief Thread root function
101 * Function pointer prototype of a thread entrypoint. When it
102 * returns, Threads_Exit is called
104 typedef void (*tThreadFunction)(void*);
106 // === Kernel Export Macros ===
108 * \name Kernel exports
111 //! Kernel symbol definition
112 typedef struct sKernelSymbol {
113 const char *Name; //!< Symbolic name
114 tVAddr Value; //!< Value of the symbol
116 //! Export a pointer symbol (function/array)
117 #define EXPORT(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)_name}
118 //! Export a variable
119 #define EXPORTV(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)&_name}
120 //! Export a symbol under another name
121 #define EXPORTAS(_sym,_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)_sym}
129 * \name IRQ hander registration
132 extern int IRQ_AddHandler(int Num, void (*Callback)(int, void*), void *Ptr);
133 extern void IRQ_RemHandler(int Handle);
140 * \name Logging to kernel ring buffer
143 extern void Log_KernelPanic(const char *Ident, const char *Message, ...);
144 extern void Log_Panic(const char *Ident, const char *Message, ...);
145 extern void Log_Error(const char *Ident, const char *Message, ...);
146 extern void Log_Warning(const char *Ident, const char *Message, ...);
147 extern void Log_Notice(const char *Ident, const char *Message, ...);
148 extern void Log_Log(const char *Ident, const char *Message, ...);
149 extern void Log_Debug(const char *Ident, const char *Message, ...);
156 * \name Debugging and Errors
159 extern void Debug_KernelPanic(void); //!< Initiate a kernel panic
160 extern void Panic(const char *Msg, ...); //!< Print a panic message (initiates a kernel panic)
161 extern void Warning(const char *Msg, ...); //!< Print a warning message
162 extern void LogF(const char *Fmt, ...); //!< Print a log message without a trailing newline
163 extern void Log(const char *Fmt, ...); //!< Print a log message
164 extern void Debug(const char *Fmt, ...); //!< Print a debug message (doesn't go to KTerm)
165 extern void LogV(const char *Fmt, va_list Args); //!< va_list Log message
166 extern void Debug_Enter(const char *FuncName, const char *ArgTypes, ...);
167 extern void Debug_Log(const char *FuncName, const char *Fmt, ...);
168 extern void Debug_Leave(const char *FuncName, char RetType, ...);
169 extern void Debug_HexDump(const char *Header, const void *Data, Uint Length);
170 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
172 # define ENTER(_types...) Debug_Enter((char*)__func__, _types)
173 # define LOG(_fmt...) Debug_Log((char*)__func__, _fmt)
174 # define LEAVE(_t...) Debug_Leave((char*)__func__, _t)
175 # define LEAVE_RET(_t,_v...) do{LEAVE(_t,_v);return _v;}while(0)
176 # define LEAVE_RET0() do{LEAVE('-');return;}while(0)
181 # define LEAVE_RET(_t,_v...) return (_v)
182 # define LEAVE_RET0() return
185 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
187 # define ASSERT(expr)
195 #define inb(a) (Log_Panic("Arch", STR(ARCHDIR)" does not support in*/out* (%s:%i)", __FILE__, __LINE__),0)
196 #define inw(a) inb(a)
197 #define ind(a) inb(a)
198 #define inq(a) inb(a)
199 #define outb(a,b) inb(a)
200 #define outw(a,b) inb(a)
201 #define outd(a,b) inb(a)
202 #define outq(a,b) inb(a)
205 * \name I/O Memory Access
208 extern void outb(Uint16 Port, Uint8 Data);
209 extern void outw(Uint16 Port, Uint16 Data);
210 extern void outd(Uint16 Port, Uint32 Data);
211 extern void outq(Uint16 Port, Uint64 Data);
212 extern Uint8 inb(Uint16 Port);
213 extern Uint16 inw(Uint16 Port);
214 extern Uint32 ind(Uint16 Port);
215 extern Uint64 inq(Uint16 Port);
220 // --- Memory Management ---
222 * \name Memory Management
224 * \todo Move to mm_virt.h
227 * \brief Allocate a physical page at \a VAddr
228 * \param VAddr Virtual Address to allocate at
229 * \return Physical address allocated
231 extern tPAddr MM_Allocate(tVAddr VAddr) __attribute__ ((warn_unused_result));
233 * \brief Deallocate a page
234 * \param VAddr Virtual address to unmap
236 extern void MM_Deallocate(tVAddr VAddr);
238 * \brief Map a physical page at \a PAddr to \a VAddr
239 * \param VAddr Target virtual address
240 * \param PAddr Physical address to map
241 * \return Boolean Success
243 extern int MM_Map(tVAddr VAddr, tPAddr PAddr);
245 * \brief Get the physical address of \a Addr
246 * \param Addr Address of the page to get the physical address of
247 * \return Physical page mapped at \a Addr
249 extern tPAddr MM_GetPhysAddr(tVAddr Addr);
251 * \brief Set the access flags on a page
252 * \param VAddr Virtual address of the page
253 * \param Flags New flags value
254 * \param Mask Flags to set
256 extern void MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
258 * \brief Get the flags on a flag
259 * \param VAddr Virtual address of page
260 * \return Flags value of the page
262 extern Uint MM_GetFlags(tVAddr VAddr);
264 * \brief Checks is a memory range is user accessable
265 * \param VAddr Base address to check
266 * \return 1 if the memory is all user-accessable, 0 otherwise
268 #define MM_IsUser(VAddr) (!(MM_GetFlags((VAddr))&MM_PFLAG_KERNEL))
270 * \brief Temporarily map a page into the address space
271 * \param PAddr Physical addres to map
272 * \return Virtual address of page in memory
273 * \note There is only a limited ammount of slots avaliable
275 extern tVAddr MM_MapTemp(tPAddr PAddr);
277 * \brief Free a temporarily mapped page
278 * \param VAddr Allocate virtual addres of page
280 extern void MM_FreeTemp(tVAddr VAddr);
282 * \brief Map a physcal address range into the virtual address space
283 * \param PAddr Physical address to map in
284 * \param Number Number of pages to map
286 extern tVAddr MM_MapHWPages(tPAddr PAddr, Uint Number);
288 * \brief Allocates DMA physical memory
289 * \param Pages Number of pages required
290 * \param MaxBits Maximum number of bits the physical address can have
291 * \param PhysAddr Pointer to the location to place the physical address allocated
292 * \return Virtual address allocate
294 extern tVAddr MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
296 * \brief Unmaps an allocated hardware range
297 * \param VAddr Virtual address allocate by ::MM_MapHWPages or ::MM_AllocDMA
298 * \param Number Number of pages to free
300 extern void MM_UnmapHWPages(tVAddr VAddr, Uint Number);
302 * \brief Allocate a single physical page
303 * \return Physical address allocated
305 extern tPAddr MM_AllocPhys(void);
307 * \brief Allocate a contiguous range of physical pages
308 * \param Pages Number of pages to allocate
309 * \param MaxBits Maximum number of address bits allowed
310 * \return First physical address allocated
312 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
314 * \brief Reference a physical page
315 * \param PAddr Page to mark as referenced
317 extern void MM_RefPhys(tPAddr PAddr);
319 * \brief Dereference a physical page
320 * \param PAddr Page to dereference
322 extern void MM_DerefPhys(tPAddr PAddr);
324 * \brief Get the number of times a page has been referenced
325 * \param PAddr Address to check
326 * \return Reference count for the page
328 extern int MM_GetRefCount(tPAddr PAddr);
330 * \brief Set the node associated with a page
331 * \param PAddr Physical address of page
332 * \param Node Node pointer (tVFS_Node)
333 * \return Boolean failure
335 * \retval 1 Page not allocated
337 extern int MM_SetPageNode(tPAddr PAddr, void *Node);
339 * \brief Get the node associated with a page
340 * \param PAddr Physical address of page
341 * \param Node Node pointer (tVFS_Node) destination
342 * \return Boolean failure
344 * \retval 1 Page not allocated
346 extern int MM_GetPageNode(tPAddr PAddr, void **Node);
351 // --- Memory Manipulation ---
353 * \name Memory Manipulation
356 extern int memcmp(const void *m1, const void *m2, size_t count);
357 extern void *memcpy(void *dest, const void *src, size_t count);
358 extern void *memcpyd(void *dest, const void *src, size_t count);
359 extern void *memmove(void *dest, const void *src, size_t len);
360 extern void *memset(void *dest, int val, size_t count);
361 extern void *memsetd(void *dest, Uint32 val, size_t count);
366 * \name Memory Validation
369 extern int CheckString(const char *String);
370 extern int CheckMem(const void *Mem, int Num);
375 // --- Endianness ---
377 * \name Endianness Swapping
380 #ifdef __BIG_ENDIAN__
381 #define LittleEndian16(_val) SwapEndian16(_val)
382 #define LittleEndian32(_val) SwapEndian32(_val)
383 #define BigEndian16(_val) (_val)
384 #define BigEndian32(_val) (_val)
386 #define LittleEndian16(_val) (_val)
387 #define LittleEndian32(_val) (_val)
388 #define BigEndian16(_val) SwapEndian16(_val)
389 #define BigEndian32(_val) SwapEndian32(_val)
391 extern Uint16 SwapEndian16(Uint16 Val);
392 extern Uint32 SwapEndian32(Uint32 Val);
402 extern int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
403 extern int sprintf(char *__s, const char *__format, ...);
404 extern size_t strlen(const char *Str);
405 extern char *strcpy(char *__dest, const char *__src);
406 extern char *strncpy(char *__dest, const char *__src, size_t max);
407 extern char *strcat(char *__dest, const char *__src);
408 extern char *strncat(char *__dest, const char *__src, size_t n);
409 extern int strcmp(const char *__str1, const char *__str2);
410 extern int strncmp(const char *Str1, const char *Str2, size_t num);
411 extern int strucmp(const char *Str1, const char *Str2);
412 // strdup macro is defined in heap.h
413 extern char *_strdup(const char *File, int Line, const char *Str);
414 extern char **str_split(const char *__str, char __ch);
415 extern char *strchr(const char *__s, int __c);
416 extern int strpos(const char *Str, char Ch);
417 extern int strpos8(const char *str, Uint32 search);
418 extern void itoa(char *buf, Uint64 num, int base, int minLength, char pad);
419 extern int atoi(const char *string);
420 extern int ReadUTF8(const Uint8 *str, Uint32 *Val);
421 extern int WriteUTF8(Uint8 *str, Uint32 Val);
422 extern int ModUtil_SetIdent(char *Dest, const char *Value);
423 extern int ModUtil_LookupString(const char **Array, const char *Needle);
425 extern Uint8 ByteSum(const void *Ptr, int Size);
426 extern int UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString);
432 * \brief Get a random number
433 * \return Random number
434 * \note Current implementation is a linear congruency
436 extern int rand(void);
438 * \brief Call a function with a variable number of arguments
439 * \param Function Function address
440 * \param NArgs Number of entries in \a Args
441 * \param Args Array of arguments
442 * \return Integer from called Function
444 extern int CallWithArgArray(void *Function, int NArgs, Uint *Args);
449 * \brief Magic heap allocation function
451 extern void *alloca(size_t Size);
458 extern int Module_LoadMem(void *Buffer, Uint Length, const char *ArgStr);
459 extern int Module_LoadFile(const char *Path, const char *ArgStr);
466 * \name Time and Timing
470 * \brief Create a timestamp from a time
472 extern Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
474 * \brief Gets the current timestamp (miliseconds since Midnight 1st January 1970)
476 extern Sint64 now(void);
478 * \brief Timer callback function
480 typedef void (tTimerCallback)(void *);
482 * \brief Creates a one-shot timer
483 * \param Delta Period of the timer
484 * \param Callback Function to call each time
485 * \param Argument Argument to pass to the callback
487 extern int Time_CreateTimer(int Delta, tTimerCallback *Callback, void *Argument);
489 * \brief Removed an active timer
491 extern void Time_RemoveTimer(int ID);
493 * \brief Wait for a period of milliseconds
495 extern void Time_Delay(int Delay);
502 * \name Threads and Processes
505 extern int Proc_SpawnWorker(void (*Fcn)(void*), void *Data);
506 extern int Proc_Spawn(const char *Path);
507 extern int Proc_SysSpawn(const char *Binary, const char **ArgV, const char **EnvP, int nFD, int *FDs);
508 extern int Proc_Execve(const char *File, const char **ArgV, const char **EnvP, int DataSize);
509 extern void Threads_Exit(int TID, int Status);
510 extern void Threads_Yield(void);
511 extern void Threads_Sleep(void);
512 extern int Threads_WakeTID(tTID Thread);
513 extern tPID Threads_GetPID(void);
514 extern tTID Threads_GetTID(void);
515 extern tUID Threads_GetUID(void);
516 extern tGID Threads_GetGID(void);
517 extern int SpawnTask(tThreadFunction Function, void *Arg);
518 extern int *Threads_GetErrno(void);
519 extern int Threads_SetName(const char *NewName);
524 // --- Simple Math ---
525 //! Divide and round up
526 extern int DivUp(int num, int dem);
527 //! Divide and Modulo 64-bit unsigned integer
528 extern Uint64 DivMod64U(Uint64 Num, Uint64 Den, Uint64 *Rem);
530 static inline int MIN(int a, int b) { return a < b ? a : b; }
531 static inline int MAX(int a, int b) { return a > b ? a : b; }
533 #include <binary_ext.h>