2 * AcessOS Microkernel Version
8 #define NULL ((void*)0)
9 #define PACKED __attribute__ ((packed))
10 #define offsetof(st, m) ((Uint)((char *)&((st *)(0))->m - (char *)0 ))
23 typedef Sint64 tTimestamp;
25 // --- Helper Macros ---
30 #define CONCAT(x,y) x ## y
31 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
33 #define EXPAND_STR(x) STR(x)
35 #define VER2(major,minor) ((((major)&0xFF)<<8)|((minor)&0xFF))
41 * \name Per-Process Configuration Settings
56 #define CFGINT(id) (*Threads_GetCfgPtr(id))
57 #define CFGPTR(id) (*(void**)Threads_GetCfgPtr(id))
63 // --- Memory Flags --
67 * \todo Move to mm_virt.h
69 #define MM_PFLAG_RO 0x01 // Writes disallowed
70 #define MM_PFLAG_EXEC 0x02 // Allow execution
71 #define MM_PFLAG_NOPAGE 0x04 // Prevent from being paged out
72 #define MM_PFLAG_COW 0x08 // Copy-On-Write
73 #define MM_PFLAG_KERNEL 0x10 // Kernel-Only (Ring0)
77 // --- Interface Flags & Macros
81 typedef void (*tThreadFunction)(void*);
83 // === Kernel Export Macros ===
85 * \name Kernel Function
88 typedef struct sKernelSymbol {
92 #define EXPORT(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_name}
93 #define EXPORTV(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)&_name}
94 #define EXPORTAS(_sym,_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_sym}
101 extern int IRQ_AddHandler(int Num, void (*Callback)(int));
104 extern void Log_KernelPanic(char *Ident, char *Message, ...);
105 extern void Log_Panic(char *Ident, char *Message, ...);
106 extern void Log_Error(char *Ident, char *Message, ...);
107 extern void Log_Warning(char *Ident, char *Message, ...);
108 extern void Log_Notice(char *Ident, char *Message, ...);
109 extern void Log_Log(char *Ident, char *Message, ...);
110 extern void Log_Debug(char *Ident, char *Message, ...);
114 * \name Debugging and Errors
117 extern void Debug_KernelPanic(void); //!< Initiate a kernel panic
118 extern void Panic(char *Msg, ...); //!< Print a panic message (initiates a kernel panic)
119 extern void Warning(char *Msg, ...); //!< Print a warning message
120 extern void LogF(char *Fmt, ...); //!< Print a log message without a trailing newline
121 extern void Log(char *Fmt, ...); //!< Print a log message
122 extern void Debug(char *Fmt, ...); //!< Print a debug message (doesn't go to KTerm)
123 extern void LogV(char *Fmt, va_list Args); //!< va_list Log message
124 extern void Debug_Enter(char *FuncName, char *ArgTypes, ...);
125 extern void Debug_Log(char *FuncName, char *Fmt, ...);
126 extern void Debug_Leave(char *FuncName, char RetType, ...);
127 extern void Debug_HexDump(char *Header, void *Data, Uint Length);
128 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
130 # define ENTER(_types...) Debug_Enter((char*)__func__, _types)
131 # define LOG(_fmt...) Debug_Log((char*)__func__, _fmt)
132 # define LEAVE(_t...) Debug_Leave((char*)__func__, _t)
133 # define LEAVE_RET(_t,_v...) do{LEAVE(_t,_v);return _v;}while(0)
134 # define LEAVE_RET0() do{LEAVE('-');return;}while(0)
139 # define LEAVE_RET(_t,_v...) return (_v)
140 # define LEAVE_RET0() return
143 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
145 # define ASSERT(expr)
153 * \name I/O Memory Access
156 extern void outb(Uint16 Port, Uint8 Data);
157 extern void outw(Uint16 Port, Uint16 Data);
158 extern void outd(Uint16 Port, Uint32 Data);
159 extern void outq(Uint16 Port, Uint64 Data);
160 extern Uint8 inb(Uint16 Port);
161 extern Uint16 inw(Uint16 Port);
162 extern Uint32 ind(Uint16 Port);
163 extern Uint64 inq(Uint16 Port);
168 // --- Memory Management ---
170 * \name Memory Management
172 * \todo Move to mm_virt.h
175 * \brief Allocate a physical page at \a VAddr
176 * \param VAddr Virtual Address to allocate at
177 * \return Physical address allocated
179 extern tPAddr MM_Allocate(tVAddr VAddr);
181 * \brief Deallocate a page
182 * \param VAddr Virtual address to unmap
184 extern void MM_Deallocate(tVAddr VAddr);
186 * \brief Map a physical page at \a PAddr to \a VAddr
187 * \param VAddr Target virtual address
188 * \param PAddr Physical address to map
189 * \return Boolean Success
191 extern int MM_Map(tVAddr VAddr, tPAddr PAddr);
193 * \brief Get the physical address of \a Addr
194 * \param Addr Address of the page to get the physical address of
195 * \return Physical page mapped at \a Addr
197 extern tPAddr MM_GetPhysAddr(tVAddr Addr);
199 * \brief Set the access flags on a page
200 * \param VAddr Virtual address of the page
201 * \param Flags New flags value
202 * \param Mask Flags to set
204 extern void MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
206 * \brief Get the flags on a flag
207 * \param VAddr Virtual address of page
208 * \return Flags value of the page
210 extern Uint MM_GetFlags(tVAddr VAddr);
212 * \brief Checks is a memory range is user accessable
213 * \param VAddr Base address to check
214 * \return 1 if the memory is all user-accessable, 0 otherwise
216 #define MM_IsUser(VAddr) (!(MM_GetFlags((VAddr))&MM_PFLAG_KERNEL))
218 * \brief Temporarily map a page into the address space
219 * \param PAddr Physical addres to map
220 * \return Virtual address of page in memory
221 * \note There is only a limited ammount of slots avaliable
223 extern tVAddr MM_MapTemp(tPAddr PAddr);
225 * \brief Free a temporarily mapped page
226 * \param VAddr Allocate virtual addres of page
228 extern void MM_FreeTemp(tVAddr VAddr);
230 * \brief Map a physcal address range into the virtual address space
231 * \param PAddr Physical address to map in
232 * \param Number Number of pages to map
234 extern tVAddr MM_MapHWPages(tPAddr PAddr, Uint Number);
236 * \brief Allocates DMA physical memory
237 * \param Pages Number of pages required
238 * \param MaxBits Maximum number of bits the physical address can have
239 * \param PhysAddr Pointer to the location to place the physical address allocated
240 * \return Virtual address allocate
242 extern tVAddr MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
244 * \brief Unmaps an allocated hardware range
245 * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
246 * \param Number Number of pages to free
248 extern void MM_UnmapHWPages(tVAddr VAddr, Uint Number);
250 * \brief Allocate a single physical page
251 * \return Physical address allocated
253 extern tPAddr MM_AllocPhys(void);
255 * \brief Allocate a contiguous range of physical pages
256 * \param Pages Number of pages to allocate
257 * \return First physical address allocated
259 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
261 * \brief Reference a physical page
262 * \param PAddr Page to mark as referenced
264 extern void MM_RefPhys(tPAddr PAddr);
266 * \brief Dereference a physical page
267 * \param PAddr Page to dereference
269 extern void MM_DerefPhys(tPAddr PAddr);
274 // --- Memory Manipulation ---
276 * \name Memory Manipulation
279 extern int memcmp(const void *m1, const void *m2, size_t count);
280 extern void *memcpy(void *dest, const void *src, size_t count);
281 extern void *memcpyd(void *dest, const void *src, size_t count);
282 extern void *memset(void *dest, int val, size_t count);
283 extern void *memsetd(void *dest, Uint32 val, size_t count);
288 * \name Memory Validation
291 extern int CheckString(char *String);
292 extern int CheckMem(void *Mem, int Num);
297 // --- Endianness ---
299 * \name Endianness Swapping
302 extern Uint16 LittleEndian16(Uint16 Val);
303 extern Uint16 BigEndian16(Uint16 Val);
304 extern Uint32 LittleEndian32(Uint32 Val);
305 extern Uint32 BigEndian32(Uint32 Val);
315 extern int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
316 extern int sprintf(char *__s, const char *__format, ...);
317 extern Uint strlen(const char *Str);
318 extern char *strcpy(char *__dest, const char *__src);
319 extern char *strncpy(char *__dest, const char *__src, size_t max);
320 extern int strcmp(const char *__str1, const char *__str2);
321 extern int strncmp(const char *Str1, const char *Str2, size_t num);
322 extern int strucmp(const char *Str1, const char *Str2);
323 extern char *strdup(const char *Str);
324 extern char **str_split(const char *__str, char __ch);
325 extern int strpos(const char *Str, char Ch);
326 extern int strpos8(const char *str, Uint32 search);
327 extern void itoa(char *buf, Uint num, int base, int minLength, char pad);
328 extern int atoi(const char *string);
329 extern int ReadUTF8(Uint8 *str, Uint32 *Val);
330 extern int WriteUTF8(Uint8 *str, Uint32 Val);
331 extern int ModUtil_SetIdent(char *Dest, char *Value);
332 extern int ModUtil_LookupString(char **Array, char *Needle);
333 extern Uint8 ByteSum(void *Ptr, int Size);
338 extern Uint rand(void);
339 extern int CallWithArgArray(void *Function, int NArgs, Uint *Args);
346 extern void *malloc(size_t size);
347 extern void *calloc(size_t num, size_t size);
348 extern void *realloc(void *ptr, size_t size);
349 extern void free(void *Ptr);
350 extern int IsHeap(void *Ptr);
360 extern int Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
361 extern int Module_LoadFile(char *Path, char *ArgStr);
368 * \name Time and Timing
372 * \brief Create a timestamp from a time
374 extern Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
376 * \brief Gets the current timestamp (miliseconds since Midnight 1st January 1970)
378 extern Sint64 now(void);
380 * \brief Timer callback function
382 typedef void (tTimerCallback)(void *);
384 * \brief Creates a one-shot timer
385 * \param Delta Period of the timer
386 * \param Callback Function to call each time
387 * \param Argument Argument to pass to the callback
389 extern int Time_CreateTimer(int Delta, tTimerCallback *Callback, void *Argument);
391 * \brief Removed an active timer
393 extern void Time_RemoveTimer(int ID);
394 extern void Time_Delay(int Delay);
401 * \name Threads and Processes
404 extern int Proc_SpawnWorker(void);
405 extern int Proc_Spawn(char *Path);
406 extern void Threads_Exit(int TID, int Status);
407 extern void Threads_Yield(void);
408 extern void Threads_Sleep(void);
409 extern void Threads_WakeTID(tTID Thread);
410 extern tPID Threads_GetPID(void);
411 extern tTID Threads_GetTID(void);
412 extern tUID Threads_GetUID(void);
413 extern tGID Threads_GetGID(void);
414 extern int SpawnTask(tThreadFunction Function, void *Arg);
415 extern Uint *Threads_GetCfgPtr(int Id);
416 extern int Threads_SetName(char *NewName);
421 // --- Simple Math ---
422 extern int DivUp(int num, int dem);
424 #include <binary_ext.h>