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 void System_Init(char *ArgString);
102 extern int IRQ_AddHandler(int Num, void (*Callback)(int));
106 * \name Debugging and Errors
109 extern void Panic(char *Msg, ...);
110 extern void Warning(char *Msg, ...);
111 extern void Log(char *Fmt, ...);
112 extern void LogV(char *Fmt, va_list Args);
113 extern void LogF(char *Fmt, ...);
114 extern void Debug_Enter(char *FuncName, char *ArgTypes, ...);
115 extern void Debug_Log(char *FuncName, char *Fmt, ...);
116 extern void Debug_Leave(char *FuncName, char RetType, ...);
117 extern void Debug_HexDump(char *Header, void *Data, Uint Length);
118 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
120 # define ENTER(_types...) Debug_Enter((char*)__func__, _types)
121 # define LOG(_fmt...) Debug_Log((char*)__func__, _fmt)
122 # define LEAVE(_t...) Debug_Leave((char*)__func__, _t)
123 # define LEAVE_RET(_t,_v...) do{LEAVE(_t,_v);return _v;}while(0)
124 # define LEAVE_RET0() do{LEAVE('-');return;}while(0)
129 # define LEAVE_RET(_t,_v...) return (_v)
130 # define LEAVE_RET0() return
133 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
135 # define ASSERT(expr)
143 * \name I/O Memory Access
146 extern void outb(Uint16 Port, Uint8 Data);
147 extern void outw(Uint16 Port, Uint16 Data);
148 extern void outd(Uint16 Port, Uint32 Data);
149 extern void outq(Uint16 Port, Uint64 Data);
150 extern Uint8 inb(Uint16 Port);
151 extern Uint16 inw(Uint16 Port);
152 extern Uint32 ind(Uint16 Port);
153 extern Uint64 inq(Uint16 Port);
158 // --- Memory Management ---
160 * \name Memory Management
162 * \todo Move to mm_virt.h
165 * \brief Allocate a physical page at \a VAddr
166 * \param VAddr Virtual Address to allocate at
167 * \return Physical address allocated
169 extern tPAddr MM_Allocate(tVAddr VAddr);
171 * \brief Deallocate a page
172 * \param VAddr Virtual address to unmap
174 extern void MM_Deallocate(tVAddr VAddr);
176 * \brief Map a physical page at \a PAddr to \a VAddr
177 * \param VAddr Target virtual address
178 * \param PAddr Physical address to map
179 * \return Boolean Success
181 extern int MM_Map(tVAddr VAddr, tPAddr PAddr);
183 * \brief Get the physical address of \a Addr
184 * \param Addr Address of the page to get the physical address of
185 * \return Physical page mapped at \a Addr
187 extern tPAddr MM_GetPhysAddr(tVAddr Addr);
189 * \brief Checks is a memory range is user accessable
190 * \param VAddr Base address to check
191 * \return 1 if the memory is all user-accessable, 0 otherwise
193 extern int MM_IsUser(tVAddr VAddr);
195 * \brief Set the access flags on a page
196 * \param VAddr Virtual address of the page
197 * \param Flags New flags value
198 * \param Mask Flags to set
200 extern void MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
202 * \brief Temporarily map a page into the address space
203 * \param PAddr Physical addres to map
204 * \return Virtual address of page in memory
205 * \note There is only a limited ammount of slots avaliable
207 extern tVAddr MM_MapTemp(tPAddr PAddr);
209 * \brief Free a temporarily mapped page
210 * \param VAddr Allocate virtual addres of page
212 extern void MM_FreeTemp(tVAddr VAddr);
214 * \brief Map a physcal address range into the virtual address space
215 * \param PAddr Physical address to map in
216 * \param Number Number of pages to map
218 extern tVAddr MM_MapHWPage(tPAddr PAddr, Uint Number);
220 * \brief Allocates DMA physical memory
221 * \param Pages Number of pages required
222 * \param MaxBits Maximum number of bits the physical address can have
223 * \param PhysAddr Pointer to the location to place the physical address allocated
224 * \return Virtual address allocate
226 extern tVAddr MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
228 * \brief Unmaps an allocated hardware range
229 * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
230 * \param Number Number of pages to free
232 extern void MM_UnmapHWPage(tVAddr VAddr, Uint Number);
234 * \brief Allocate a single physical page
235 * \return Physical address allocated
237 extern tPAddr MM_AllocPhys();
239 * \brief Allocate a contiguous range of physical pages
240 * \param Pages Number of pages to allocate
241 * \return First physical address allocated
243 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
245 * \brief Reference a physical page
246 * \param PAddr Page to mark as referenced
248 extern void MM_RefPhys(tPAddr PAddr);
250 * \brief Dereference a physical page
251 * \param PAddr Page to dereference
253 extern void MM_DerefPhys(tPAddr PAddr);
258 // --- Memory Manipulation ---
260 * \name Memory Manipulation
263 extern int memcmp(const void *m1, const void *m2, size_t count);
264 extern void *memcpy(void *dest, const void *src, size_t count);
265 extern void *memcpyd(void *dest, const void *src, size_t count);
266 extern void *memset(void *dest, int val, size_t count);
267 extern void *memsetd(void *dest, Uint32 val, size_t count);
272 * \name Memory Validation
275 extern int CheckString(char *String);
276 extern int CheckMem(void *Mem, int Num);
281 // --- Endianness ---
283 * \name Endianness Swapping
286 extern Uint16 LittleEndian16(Uint16 Val);
287 extern Uint16 BigEndian16(Uint16 Val);
288 extern Uint32 LittleEndian32(Uint32 Val);
289 extern Uint32 BigEndian32(Uint32 Val);
299 extern int sprintf(char *__s, const char *__format, ...);
300 extern Uint strlen(const char *Str);
301 extern char *strcpy(char *__dest, const char *__src);
302 extern int strcmp(const char *__str1, const char *__str2);
303 extern int strncmp(const char *Str1, const char *Str2, size_t num);
304 extern int strucmp(const char *Str1, const char *Str2);
305 extern char *strdup(const char *Str);
306 extern int strpos(const char *Str, char Ch);
307 extern int strpos8(const char *str, Uint32 search);
308 extern void itoa(char *buf, Uint num, int base, int minLength, char pad);
309 extern int atoi(const char *string);
310 extern int ReadUTF8(Uint8 *str, Uint32 *Val);
311 extern int WriteUTF8(Uint8 *str, Uint32 Val);
312 extern int ModUtil_SetIdent(char *Dest, char *Value);
313 extern int ModUtil_LookupString(char **Array, char *Needle);
314 extern Uint8 ByteSum(void *Ptr, int Size);
326 extern void *malloc(size_t size);
327 extern void *calloc(size_t num, size_t size);
328 extern void *realloc(void *ptr, size_t size);
329 extern void free(void *Ptr);
330 extern int IsHeap(void *Ptr);
340 extern int Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
341 extern int Module_LoadFile(char *Path, char *ArgStr);
348 * \name Time and Timing
352 * \brief Create a timestamp from a time
354 extern Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
356 extern int Time_CreateTimer(int Delta, void *Callback, void *Argument);
357 extern void Time_RemoveTimer(int ID);
358 extern void Time_Delay(int Delay);
365 * \name Threads and Processes
368 extern int Proc_SpawnWorker();
369 extern int Proc_Spawn(char *Path);
370 extern void Threads_Exit();
371 extern void Threads_Yield();
372 extern void Threads_Sleep();
373 extern tPID Threads_GetPID();
374 extern tTID Threads_GetTID();
375 extern tUID Threads_GetUID();
376 extern tGID Threads_GetGID();
377 extern int SpawnTask(tThreadFunction Function, void *Arg);
378 extern Uint *Threads_GetCfgPtr(int Id);
383 // --- Simple Math ---
384 extern int DivUp(int num, int dem);
386 #include <binary_ext.h>