2 * AcessOS Microkernel Version
8 #define NULL ((void*)0)
9 #define PACKED __attribute__((packed))
10 #define UNUSED(x) UNUSED_##x __attribute__((unused))
11 #define offsetof(st, m) ((Uint)((char *)&((st *)(0))->m - (char *)0 ))
23 typedef Sint64 tTimestamp;
24 typedef struct sShortSpinlock tShortSpinlock;
25 typedef struct sMutex tMutex;
28 tShortSpinlock Protector; //!< Protector for the lock strucure
29 struct sThread *volatile Owner; //!< Owner of the lock (set upon getting the lock)
30 struct sThread *Waiting; //!< Waiting threads
31 struct sThread *LastWaiting; //!< Waiting threads
34 // --- Helper Macros ---
39 #define CONCAT(x,y) x ## y
40 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
42 #define EXPAND_STR(x) STR(x)
44 #define VER2(major,minor) ((((major)&0xFF)<<8)|((minor)&0xFF))
50 * \name Per-Process Configuration Settings
65 #define CFGINT(id) (*Threads_GetCfgPtr(id))
66 #define CFGPTR(id) (*(void**)Threads_GetCfgPtr(id))
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, (Uint)_name}
102 #define EXPORTV(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)&_name}
103 #define EXPORTAS(_sym,_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_sym}
110 extern int IRQ_AddHandler(int Num, void (*Callback)(int));
113 extern void Log_KernelPanic(char *Ident, char *Message, ...);
114 extern void Log_Panic(char *Ident, char *Message, ...);
115 extern void Log_Error(char *Ident, char *Message, ...);
116 extern void Log_Warning(char *Ident, char *Message, ...);
117 extern void Log_Notice(char *Ident, char *Message, ...);
118 extern void Log_Log(char *Ident, char *Message, ...);
119 extern void Log_Debug(char *Ident, char *Message, ...);
123 * \name Debugging and Errors
126 extern void Debug_KernelPanic(void); //!< Initiate a kernel panic
127 extern void Panic(char *Msg, ...); //!< Print a panic message (initiates a kernel panic)
128 extern void Warning(char *Msg, ...); //!< Print a warning message
129 extern void LogF(char *Fmt, ...); //!< Print a log message without a trailing newline
130 extern void Log(char *Fmt, ...); //!< Print a log message
131 extern void Debug(char *Fmt, ...); //!< Print a debug message (doesn't go to KTerm)
132 extern void LogV(char *Fmt, va_list Args); //!< va_list Log message
133 extern void Debug_Enter(char *FuncName, char *ArgTypes, ...);
134 extern void Debug_Log(char *FuncName, char *Fmt, ...);
135 extern void Debug_Leave(char *FuncName, char RetType, ...);
136 extern void Debug_HexDump(char *Header, void *Data, Uint Length);
137 #define UNIMPLEMENTED() Warning("'%s' unimplemented", __func__)
139 # define ENTER(_types...) Debug_Enter((char*)__func__, _types)
140 # define LOG(_fmt...) Debug_Log((char*)__func__, _fmt)
141 # define LEAVE(_t...) Debug_Leave((char*)__func__, _t)
142 # define LEAVE_RET(_t,_v...) do{LEAVE(_t,_v);return _v;}while(0)
143 # define LEAVE_RET0() do{LEAVE('-');return;}while(0)
148 # define LEAVE_RET(_t,_v...) return (_v)
149 # define LEAVE_RET0() return
152 # define ASSERT(expr) do{if(!(expr))Panic("%s: Assertion '"#expr"' failed",(char*)__func__);}while(0)
154 # define ASSERT(expr)
162 * \name I/O Memory Access
165 extern void outb(Uint16 Port, Uint8 Data);
166 extern void outw(Uint16 Port, Uint16 Data);
167 extern void outd(Uint16 Port, Uint32 Data);
168 extern void outq(Uint16 Port, Uint64 Data);
169 extern Uint8 inb(Uint16 Port);
170 extern Uint16 inw(Uint16 Port);
171 extern Uint32 ind(Uint16 Port);
172 extern Uint64 inq(Uint16 Port);
177 // --- Memory Management ---
179 * \name Memory Management
181 * \todo Move to mm_virt.h
184 * \brief Allocate a physical page at \a VAddr
185 * \param VAddr Virtual Address to allocate at
186 * \return Physical address allocated
188 extern tPAddr MM_Allocate(tVAddr VAddr);
190 * \brief Deallocate a page
191 * \param VAddr Virtual address to unmap
193 extern void MM_Deallocate(tVAddr VAddr);
195 * \brief Map a physical page at \a PAddr to \a VAddr
196 * \param VAddr Target virtual address
197 * \param PAddr Physical address to map
198 * \return Boolean Success
200 extern int MM_Map(tVAddr VAddr, tPAddr PAddr);
202 * \brief Get the physical address of \a Addr
203 * \param Addr Address of the page to get the physical address of
204 * \return Physical page mapped at \a Addr
206 extern tPAddr MM_GetPhysAddr(tVAddr Addr);
208 * \brief Set the access flags on a page
209 * \param VAddr Virtual address of the page
210 * \param Flags New flags value
211 * \param Mask Flags to set
213 extern void MM_SetFlags(tVAddr VAddr, Uint Flags, Uint Mask);
215 * \brief Get the flags on a flag
216 * \param VAddr Virtual address of page
217 * \return Flags value of the page
219 extern Uint MM_GetFlags(tVAddr VAddr);
221 * \brief Checks is a memory range is user accessable
222 * \param VAddr Base address to check
223 * \return 1 if the memory is all user-accessable, 0 otherwise
225 #define MM_IsUser(VAddr) (!(MM_GetFlags((VAddr))&MM_PFLAG_KERNEL))
227 * \brief Temporarily map a page into the address space
228 * \param PAddr Physical addres to map
229 * \return Virtual address of page in memory
230 * \note There is only a limited ammount of slots avaliable
232 extern tVAddr MM_MapTemp(tPAddr PAddr);
234 * \brief Free a temporarily mapped page
235 * \param VAddr Allocate virtual addres of page
237 extern void MM_FreeTemp(tVAddr VAddr);
239 * \brief Map a physcal address range into the virtual address space
240 * \param PAddr Physical address to map in
241 * \param Number Number of pages to map
243 extern tVAddr MM_MapHWPages(tPAddr PAddr, Uint Number);
245 * \brief Allocates DMA physical memory
246 * \param Pages Number of pages required
247 * \param MaxBits Maximum number of bits the physical address can have
248 * \param PhysAddr Pointer to the location to place the physical address allocated
249 * \return Virtual address allocate
251 extern tVAddr MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
253 * \brief Unmaps an allocated hardware range
254 * \param VAddr Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
255 * \param Number Number of pages to free
257 extern void MM_UnmapHWPages(tVAddr VAddr, Uint Number);
259 * \brief Allocate a single physical page
260 * \return Physical address allocated
262 extern tPAddr MM_AllocPhys(void);
264 * \brief Allocate a contiguous range of physical pages
265 * \param Pages Number of pages to allocate
266 * \return First physical address allocated
268 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
270 * \brief Reference a physical page
271 * \param PAddr Page to mark as referenced
273 extern void MM_RefPhys(tPAddr PAddr);
275 * \brief Dereference a physical page
276 * \param PAddr Page to dereference
278 extern void MM_DerefPhys(tPAddr PAddr);
283 // --- Memory Manipulation ---
285 * \name Memory Manipulation
288 extern int memcmp(const void *m1, const void *m2, size_t count);
289 extern void *memcpy(void *dest, const void *src, size_t count);
290 extern void *memcpyd(void *dest, const void *src, size_t count);
291 extern void *memset(void *dest, int val, size_t count);
292 extern void *memsetd(void *dest, Uint32 val, size_t count);
297 * \name Memory Validation
300 extern int CheckString(char *String);
301 extern int CheckMem(void *Mem, int Num);
306 // --- Endianness ---
308 * \name Endianness Swapping
311 extern Uint16 LittleEndian16(Uint16 Val);
312 extern Uint16 BigEndian16(Uint16 Val);
313 extern Uint32 LittleEndian32(Uint32 Val);
314 extern Uint32 BigEndian32(Uint32 Val);
324 extern int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
325 extern int sprintf(char *__s, const char *__format, ...);
326 extern Uint strlen(const char *Str);
327 extern char *strcpy(char *__dest, const char *__src);
328 extern char *strncpy(char *__dest, const char *__src, size_t max);
329 extern int strcmp(const char *__str1, const char *__str2);
330 extern int strncmp(const char *Str1, const char *Str2, size_t num);
331 extern int strucmp(const char *Str1, const char *Str2);
332 extern char *strdup(const char *Str);
333 extern char **str_split(const char *__str, char __ch);
334 extern int strpos(const char *Str, char Ch);
335 extern int strpos8(const char *str, Uint32 search);
336 extern void itoa(char *buf, Uint num, int base, int minLength, char pad);
337 extern int atoi(const char *string);
338 extern int ReadUTF8(Uint8 *str, Uint32 *Val);
339 extern int WriteUTF8(Uint8 *str, Uint32 Val);
340 extern int ModUtil_SetIdent(char *Dest, char *Value);
341 extern int ModUtil_LookupString(char **Array, char *Needle);
342 extern Uint8 ByteSum(void *Ptr, int Size);
347 extern Uint rand(void);
348 extern int CallWithArgArray(void *Function, int NArgs, Uint *Args);
358 extern int Module_LoadMem(void *Buffer, Uint Length, char *ArgStr);
359 extern int Module_LoadFile(char *Path, char *ArgStr);
366 * \name Time and Timing
370 * \brief Create a timestamp from a time
372 extern Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
374 * \brief Gets the current timestamp (miliseconds since Midnight 1st January 1970)
376 extern Sint64 now(void);
378 * \brief Timer callback function
380 typedef void (tTimerCallback)(void *);
382 * \brief Creates a one-shot timer
383 * \param Delta Period of the timer
384 * \param Callback Function to call each time
385 * \param Argument Argument to pass to the callback
387 extern int Time_CreateTimer(int Delta, tTimerCallback *Callback, void *Argument);
389 * \brief Removed an active timer
391 extern void Time_RemoveTimer(int ID);
392 extern void Time_Delay(int Delay);
399 * \name Threads and Processes
402 extern int Proc_SpawnWorker(void);
403 extern int Proc_Spawn(char *Path);
404 extern void Threads_Exit(int TID, int Status);
405 extern void Threads_Yield(void);
406 extern void Threads_Sleep(void);
407 extern int Threads_WakeTID(tTID Thread);
408 extern tPID Threads_GetPID(void);
409 extern tTID Threads_GetTID(void);
410 extern tUID Threads_GetUID(void);
411 extern tGID Threads_GetGID(void);
412 extern int SpawnTask(tThreadFunction Function, void *Arg);
413 extern Uint *Threads_GetCfgPtr(int Id);
414 extern int Threads_SetName(char *NewName);
415 extern void Mutex_Acquire(tMutex *Mutex);
416 extern void Mutex_Release(tMutex *Mutex);
417 extern int Mutex_IsLocked(tMutex *Mutex);
422 // --- Simple Math ---
423 extern int DivUp(int num, int dem);
425 #include <binary_ext.h>