2 * AcessOS Microkernel Version
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 ))
23 typedef Sint64 tTimestamp;
25 typedef struct sShortSpinlock tShortSpinlock;
27 // --- Helper Macros ---
32 #define CONCAT(x,y) x ## y
33 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
35 #define EXPAND_STR(x) STR(x)
37 extern char __buildnum[];
38 #define BUILD_NUM ((int)(Uint)&__buildnum)
39 extern const char gsGitHash[];
41 #define VER2(major,minor) ((((major)&0xFF)<<8)|((minor)&0xFF))
47 * \name Per-Thread Configuration Settings
63 #define CFGINT(id) (*Threads_GetCfgPtr(id))
64 #define CFGPTR(id) (*(void**)Threads_GetCfgPtr(id))
66 #define errno (CFGINT(CFG_ERRNO))
72 // --- Memory Flags --
76 * \todo Move to mm_virt.h
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)
86 // --- Interface Flags & Macros
90 typedef void (*tThreadFunction)(void*);
92 // === Kernel Export Macros ===
94 * \name Kernel Function
97 typedef struct sKernelSymbol {
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}
110 extern int IRQ_AddHandler(int Num, void (*Callback)(int, void*), void *Ptr);
111 extern void IRQ_RemHandler(int Handle);
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, ...);
124 * \name Debugging and Errors
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__)
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)
149 # define LEAVE_RET(_t,_v...) return (_v)
150 # define LEAVE_RET0() return
153 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
155 # define ASSERT(expr)
163 * \name I/O Memory Access
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);
178 // --- Memory Management ---
180 * \name Memory Management
182 * \todo Move to mm_virt.h
185 * \brief Allocate a physical page at \a VAddr
186 * \param VAddr Virtual Address to allocate at
187 * \return Physical address allocated
189 extern tPAddr MM_Allocate(tVAddr VAddr) __attribute__ ((warn_unused_result));
191 * \brief Deallocate a page
192 * \param VAddr Virtual address to unmap
194 extern void MM_Deallocate(tVAddr VAddr);
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
201 extern int MM_Map(tVAddr VAddr, tPAddr PAddr);
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
207 extern tPAddr MM_GetPhysAddr(tVAddr Addr);
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
214 extern void MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
216 * \brief Get the flags on a flag
217 * \param VAddr Virtual address of page
218 * \return Flags value of the page
220 extern Uint MM_GetFlags(tVAddr VAddr);
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
226 #define MM_IsUser(VAddr) (!(MM_GetFlags((VAddr))&MM_PFLAG_KERNEL))
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
233 extern tVAddr MM_MapTemp(tPAddr PAddr);
235 * \brief Free a temporarily mapped page
236 * \param VAddr Allocate virtual addres of page
238 extern void MM_FreeTemp(tVAddr VAddr);
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
244 extern tVAddr MM_MapHWPages(tPAddr PAddr, Uint Number);
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
252 extern tVAddr MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
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
258 extern void MM_UnmapHWPages(tVAddr VAddr, Uint Number);
260 * \brief Allocate a single physical page
261 * \return Physical address allocated
263 extern tPAddr MM_AllocPhys(void);
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
270 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
272 * \brief Reference a physical page
273 * \param PAddr Page to mark as referenced
275 extern void MM_RefPhys(tPAddr PAddr);
277 * \brief Dereference a physical page
278 * \param PAddr Page to dereference
280 extern void MM_DerefPhys(tPAddr PAddr);
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
286 extern int MM_GetRefCount(tPAddr PAddr);
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
293 * \retval 1 Page not allocated
295 extern int MM_SetPageNode(tPAddr PAddr, void *Node);
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
302 * \retval 1 Page not allocated
304 extern int MM_GetPageNode(tPAddr PAddr, void **Node);
309 // --- Memory Manipulation ---
311 * \name Memory Manipulation
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);
323 * \name Memory Validation
326 extern int CheckString(const char *String);
327 extern int CheckMem(const void *Mem, int Num);
332 // --- Endianness ---
334 * \name Endianness Swapping
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)
343 #define LittleEndian16(_val) (_val)
344 #define LittleEndian32(_val) (_val)
345 #define BigEndian16(_val) SwapEndian16(_val)
346 #define BigEndian32(_val) SwapEndian32(_val)
348 extern Uint16 SwapEndian16(Uint16 Val);
349 extern Uint32 SwapEndian32(Uint32 Val);
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);
382 extern Uint8 ByteSum(const void *Ptr, int Size);
383 extern int UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString);
388 extern int rand(void);
389 extern int CallWithArgArray(void *Function, int NArgs, Uint *Args);
399 extern int Module_LoadMem(void *Buffer, Uint Length, const char *ArgStr);
400 extern int Module_LoadFile(const char *Path, const char *ArgStr);
407 * \name Time and Timing
411 * \brief Create a timestamp from a time
413 extern Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
415 * \brief Gets the current timestamp (miliseconds since Midnight 1st January 1970)
417 extern Sint64 now(void);
419 * \brief Timer callback function
421 typedef void (tTimerCallback)(void *);
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
428 extern int Time_CreateTimer(int Delta, tTimerCallback *Callback, void *Argument);
430 * \brief Removed an active timer
432 extern void Time_RemoveTimer(int ID);
434 * \brief Wait for a period of milliseconds
436 extern void Time_Delay(int Delay);
443 * \name Threads and Processes
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);
463 // --- Simple Math ---
464 extern int DivUp(int num, int dem);
465 extern Uint64 DivMod64U(Uint64 Num, Uint64 Den, Uint64 *Rem);
467 #include <binary_ext.h>