2 * AcessOS Microkernel Version
8 #define NULL ((void*)0)
9 #define PACKED __attribute__ ((packed))
21 typedef Sint64 tTimestamp;
23 // --- Helper Macros ---
28 #define CONCAT(x,y) x ## y
29 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
31 #define EXPAND_STR(x) STR(x)
33 #define VER2(major,minor) ((((major)&0xFF)<<8)|((minor)&0xFF))
39 * \name Per-Process Configuration Settings
54 #define CFGINT(id) (*Threads_GetCfgPtr(id))
55 #define CFGPTR(id) (*(void**)Threads_GetCfgPtr(id))
61 // --- Memory Flags --
65 * \todo Move to mm_virt.h
67 #define MM_PFLAG_RO 0x01 // Writes disallowed
68 #define MM_PFLAG_EXEC 0x02 // Allow execution
69 #define MM_PFLAG_NOPAGE 0x04 // Prevent from being paged out
70 #define MM_PFLAG_COW 0x08 // Copy-On-Write
71 #define MM_PFLAG_KERNEL 0x10 // Kernel-Only (Ring0)
75 // --- Interface Flags & Macros
79 typedef void (*tThreadFunction)(void*);
81 // === Kernel Export Macros ===
83 * \name Kernel Function
86 typedef struct sKernelSymbol {
90 #define EXPORT(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_name}
91 #define EXPORTV(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)&_name}
92 #define EXPORTAS(_sym,_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_sym}
99 extern int IRQ_AddHandler(int Num, void (*Callback)(int));
102 extern void Log_KernelPanic(char *Ident, char *Message, ...);
103 extern void Log_Panic(char *Ident, char *Message, ...);
104 extern void Log_Error(char *Ident, char *Message, ...);
105 extern void Log_Warning(char *Ident, char *Message, ...);
106 extern void Log_Notice(char *Ident, char *Message, ...);
107 extern void Log_Log(char *Ident, char *Message, ...);
108 extern void Log_Debug(char *Ident, char *Message, ...);
112 * \name Debugging and Errors
115 extern void Debug_KernelPanic(); //!< Initiate a kernel panic
116 extern void Panic(char *Msg, ...); //!< Print a panic message (initiates a kernel panic)
117 extern void Warning(char *Msg, ...); //!< Print a warning message
118 extern void LogF(char *Fmt, ...); //!< Print a log message without a trailing newline
119 extern void Log(char *Fmt, ...); //!< Print a log message
120 extern void LogV(char *Fmt, va_list Args); //!< va_list Log message
121 extern void Debug_Enter(char *FuncName, char *ArgTypes, ...);
122 extern void Debug_Log(char *FuncName, char *Fmt, ...);
123 extern void Debug_Leave(char *FuncName, char RetType, ...);
124 extern void Debug_HexDump(char *Header, void *Data, Uint Length);
125 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
127 # define ENTER(_types...) Debug_Enter((char*)__func__, _types)
128 # define LOG(_fmt...) Debug_Log((char*)__func__, _fmt)
129 # define LEAVE(_t...) Debug_Leave((char*)__func__, _t)
130 # define LEAVE_RET(_t,_v...) do{LEAVE(_t,_v);return _v;}while(0)
131 # define LEAVE_RET0() do{LEAVE('-');return;}while(0)
136 # define LEAVE_RET(_t,_v...) return (_v)
137 # define LEAVE_RET0() return
140 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
142 # define ASSERT(expr)
150 * \name I/O Memory Access
153 extern void outb(Uint16 Port, Uint8 Data);
154 extern void outw(Uint16 Port, Uint16 Data);
155 extern void outd(Uint16 Port, Uint32 Data);
156 extern void outq(Uint16 Port, Uint64 Data);
157 extern Uint8 inb(Uint16 Port);
158 extern Uint16 inw(Uint16 Port);
159 extern Uint32 ind(Uint16 Port);
160 extern Uint64 inq(Uint16 Port);
165 // --- Memory Management ---
167 * \name Memory Management
169 * \todo Move to mm_virt.h
172 * \brief Allocate a physical page at \a VAddr
173 * \param VAddr Virtual Address to allocate at
174 * \return Physical address allocated
176 extern tPAddr MM_Allocate(tVAddr VAddr);
178 * \brief Deallocate a page
179 * \param VAddr Virtual address to unmap
181 extern void MM_Deallocate(tVAddr VAddr);
183 * \brief Map a physical page at \a PAddr to \a VAddr
184 * \param VAddr Target virtual address
185 * \param PAddr Physical address to map
186 * \return Boolean Success
188 extern int MM_Map(tVAddr VAddr, tPAddr PAddr);
190 * \brief Get the physical address of \a Addr
191 * \param Addr Address of the page to get the physical address of
192 * \return Physical page mapped at \a Addr
194 extern tPAddr MM_GetPhysAddr(tVAddr Addr);
196 * \brief Set the access flags on a page
197 * \param VAddr Virtual address of the page
198 * \param Flags New flags value
199 * \param Mask Flags to set
201 extern void MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
203 * \brief Get the flags on a flag
204 * \param VAddr Virtual address of page
205 * \return Flags value of the page
207 extern Uint MM_GetFlags(tVAddr VAddr);
209 * \brief Checks is a memory range is user accessable
210 * \param VAddr Base address to check
211 * \return 1 if the memory is all user-accessable, 0 otherwise
213 #define MM_IsUser(VAddr) (!(MM_GetFlags((VAddr))&MM_PFLAG_KERNEL))
215 * \brief Temporarily map a page into the address space
216 * \param PAddr Physical addres to map
217 * \return Virtual address of page in memory
218 * \note There is only a limited ammount of slots avaliable
220 extern tVAddr MM_MapTemp(tPAddr PAddr);
222 * \brief Free a temporarily mapped page
223 * \param VAddr Allocate virtual addres of page
225 extern void MM_FreeTemp(tVAddr VAddr);
227 * \brief Map a physcal address range into the virtual address space
228 * \param PAddr Physical address to map in
229 * \param Number Number of pages to map
231 extern tVAddr MM_MapHWPages(tPAddr PAddr, Uint Number);
233 * \brief Allocates DMA physical memory
234 * \param Pages Number of pages required
235 * \param MaxBits Maximum number of bits the physical address can have
236 * \param PhysAddr Pointer to the location to place the physical address allocated
237 * \return Virtual address allocate
239 extern tVAddr MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
241 * \brief Unmaps an allocated hardware range
242 * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
243 * \param Number Number of pages to free
245 extern void MM_UnmapHWPages(tVAddr VAddr, Uint Number);
247 * \brief Allocate a single physical page
248 * \return Physical address allocated
250 extern tPAddr MM_AllocPhys();
252 * \brief Allocate a contiguous range of physical pages
253 * \param Pages Number of pages to allocate
254 * \return First physical address allocated
256 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
258 * \brief Reference a physical page
259 * \param PAddr Page to mark as referenced
261 extern void MM_RefPhys(tPAddr PAddr);
263 * \brief Dereference a physical page
264 * \param PAddr Page to dereference
266 extern void MM_DerefPhys(tPAddr PAddr);
271 // --- Memory Manipulation ---
273 * \name Memory Manipulation
276 extern int memcmp(const void *m1, const void *m2, size_t count);
277 extern void *memcpy(void *dest, const void *src, size_t count);
278 extern void *memcpyd(void *dest, const void *src, size_t count);
279 extern void *memset(void *dest, int val, size_t count);
280 extern void *memsetd(void *dest, Uint32 val, size_t count);
285 * \name Memory Validation
288 extern int CheckString(char *String);
289 extern int CheckMem(void *Mem, int Num);
294 // --- Endianness ---
296 * \name Endianness Swapping
299 extern Uint16 LittleEndian16(Uint16 Val);
300 extern Uint16 BigEndian16(Uint16 Val);
301 extern Uint32 LittleEndian32(Uint32 Val);
302 extern Uint32 BigEndian32(Uint32 Val);
312 extern int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
313 extern int sprintf(char *__s, const char *__format, ...);
314 extern Uint strlen(const char *Str);
315 extern char *strcpy(char *__dest, const char *__src);
316 extern char *strncpy(char *__dest, const char *__src, size_t max);
317 extern int strcmp(const char *__str1, const char *__str2);
318 extern int strncmp(const char *Str1, const char *Str2, size_t num);
319 extern int strucmp(const char *Str1, const char *Str2);
320 extern char *strdup(const char *Str);
321 extern char **str_split(const char *__str, char __ch);
322 extern int strpos(const char *Str, char Ch);
323 extern int strpos8(const char *str, Uint32 search);
324 extern void itoa(char *buf, Uint num, int base, int minLength, char pad);
325 extern int atoi(const char *string);
326 extern int ReadUTF8(Uint8 *str, Uint32 *Val);
327 extern int WriteUTF8(Uint8 *str, Uint32 Val);
328 extern int ModUtil_SetIdent(char *Dest, char *Value);
329 extern int ModUtil_LookupString(char **Array, char *Needle);
330 extern Uint8 ByteSum(void *Ptr, int Size);
336 extern int CallWithArgArray(void *Function, int NArgs, Uint *Args);
343 extern void *malloc(size_t size);
344 extern void *calloc(size_t num, size_t size);
345 extern void *realloc(void *ptr, size_t size);
346 extern void free(void *Ptr);
347 extern int IsHeap(void *Ptr);
357 extern int Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
358 extern int Module_LoadFile(char *Path, char *ArgStr);
365 * \name Time and Timing
369 * \brief Create a timestamp from a time
371 extern Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
373 extern int Time_CreateTimer(int Delta, void *Callback, void *Argument);
374 extern void Time_RemoveTimer(int ID);
375 extern void Time_Delay(int Delay);
382 * \name Threads and Processes
385 extern int Proc_SpawnWorker();
386 extern int Proc_Spawn(char *Path);
387 extern void Threads_Exit();
388 extern void Threads_Yield();
389 extern void Threads_Sleep();
390 extern void Threads_WakeTID(tTID Thread);
391 extern tPID Threads_GetPID();
392 extern tTID Threads_GetTID();
393 extern tUID Threads_GetUID();
394 extern tGID Threads_GetGID();
395 extern int SpawnTask(tThreadFunction Function, void *Arg);
396 extern Uint *Threads_GetCfgPtr(int Id);
397 extern int Threads_SetName(char *NewName);
402 // --- Simple Math ---
403 extern int DivUp(int num, int dem);
405 #include <binary_ext.h>