2 * AcessOS Microkernel Version
9 * \brief Acess2 Kernel API Core
17 # define HALT_CPU() for(;;);
21 #define PACKED __attribute__((packed))
22 //! Mark a function as not returning
23 #define NORETURN __attribute__((noreturn))
24 //! Mark a function that its return value should be used
25 #define WARN_UNUSED_RET __attribute__((warn_unused_result))
26 //! Mark a function (or variable) as deprecated
27 #define DEPRECATED __attribute__((deprecated))
28 //! Mark a parameter as unused
29 #define UNUSED(x) UNUSED_##x __attribute__((unused))
31 #define ALIGN(x) __attribute__((aligned(x)))
34 * \name Boolean constants
47 typedef Uint32 tPID; //!< Process ID type
48 typedef Uint32 tPGID; //!< Process Group ID type
49 typedef Uint32 tTID; //!< Thread ID Type
50 typedef Uint32 tUID; //!< User ID Type
51 typedef Uint32 tGID; //!< Group ID Type
52 typedef Sint64 tTimestamp; //!< Timestamp (miliseconds since 00:00 1 Jan 1970)
53 typedef Sint64 tTime; //!< Same again
54 typedef struct sShortSpinlock tShortSpinlock; //!< Opaque (kinda) spinlock
55 typedef Uint64 off_t; //!< VFS Offset
56 typedef struct { char _[PAGE_SIZE];} tPage; // Representation of a page for pointer arithmatic
58 // --- Helper Macros ---
63 #define CONCAT(x,y) x ## y
64 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
66 #define EXPAND_STR(x) STR(x)
68 extern char __buildnum[];
69 #define BUILD_NUM ((int)(Uint)&__buildnum)
70 extern const char gsGitHash[];
71 extern const char gsBuildInfo[];
73 #define VER2(major,minor) ((((major)&0xFF)<<8)|((minor)&0xFF))
78 //! \brief Error number
79 #define errno (*Threads_GetErrno())
82 // --- Memory Flags --
86 * \todo Move to mm_virt.h
88 #define MM_PFLAG_RO 0x01 //!< Writes disallowed
89 #define MM_PFLAG_EXEC 0x02 //!< Allow execution
90 #define MM_PFLAG_NOPAGE 0x04 //!< Prevent from being paged out
91 #define MM_PFLAG_COW 0x08 //!< Copy-On-Write
92 #define MM_PFLAG_KERNEL 0x10 //!< Kernel-Only (Ring0)
96 // --- Interface Flags & Macros
98 * \name Flags for Proc_Clone
101 //! Clone the entire process
102 #define CLONE_VM 0x10
103 //! Don't copy user pages
104 #define CLONE_NOUSER 0x20
105 //! Inherit the parent's PGID
106 #define CLONE_PGID 0x40
113 * \brief Thread root function
115 * Function pointer prototype of a thread entrypoint. When it
116 * returns, Threads_Exit is called
118 typedef void (*tThreadFunction)(void*);
120 // === Kernel Export Macros ===
122 * \name Kernel exports
125 //! Kernel symbol definition
126 typedef struct sKernelSymbol {
127 const char *Name; //!< Symbolic name
128 tVAddr Value; //!< Value of the symbol
130 //! Export a pointer symbol (function/array)
131 #define EXPORT(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)_name}
132 //! Export a variable
133 #define EXPORTV(_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)&_name}
134 //! Export a symbol under another name
135 #define EXPORTAS(_sym,_name) tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (tVAddr)_sym}
143 * \name IRQ hander registration
146 //! Register a callback for when an IRQ is raised
147 extern int IRQ_AddHandler(int Num, void (*Callback)(int, void*), void *Ptr);
148 //! Remove a previously registered IRQ handler
149 extern void IRQ_RemHandler(int Handle);
154 #include "logdebug.h"
158 #define inb(a) (Log_Panic("Arch", STR(ARCHDIR)" does not support in* (%s:%i)", __FILE__, __LINE__),0)
159 #define inw(a) inb(a)
160 #define ind(a) inb(a)
161 #define inq(a) inb(a)
162 #define outb(a,b) (Log_Panic("Arch", STR(ARCHDIR)" does not support out* (%s:%i)", __FILE__, __LINE__),(void)(b))
163 #define outw(a,b) outb(a,b)
164 #define outd(a,b) outb(a,b)
165 #define outq(a,b) outb(a,b)
168 * \name I/O Memory Access
171 extern void outb(Uint16 Port, Uint8 Data);
172 extern void outw(Uint16 Port, Uint16 Data);
173 extern void outd(Uint16 Port, Uint32 Data);
174 extern void outq(Uint16 Port, Uint64 Data);
175 extern Uint8 inb(Uint16 Port);
176 extern Uint16 inw(Uint16 Port);
177 extern Uint32 ind(Uint16 Port);
178 extern Uint64 inq(Uint16 Port);
183 // --- Memory Management ---
185 * \name Memory Management
187 * \todo Move to mm_virt.h
190 * \brief Allocate a physical page at \a VAddr
191 * \param VAddr Virtual Address to allocate at
192 * \return Physical address allocated
194 extern tPAddr MM_Allocate(volatile void *VAddr) __attribute__ ((warn_unused_result));
196 * \breif Allocate a zeroed COW page to \a VAddr
197 * \param VAddr Virtual address to allocate at
198 * \return Physical address allocated (don't cache)
200 extern void MM_AllocateZero(volatile void *VAddr);
202 * \brief Deallocate a page
203 * \param VAddr Virtual address to unmap
205 extern void MM_Deallocate(volatile void *VAddr);
207 * \brief Map a physical page at \a PAddr to \a VAddr
208 * \param VAddr Target virtual address
209 * \param PAddr Physical address to map
210 * \return Boolean Success
212 extern int MM_Map(volatile void * VAddr, tPAddr PAddr);
214 * \brief Get the physical address of \a Addr
215 * \param Addr Address of the page to get the physical address of
216 * \return Physical page mapped at \a Addr
218 extern tPAddr MM_GetPhysAddr(volatile const void *Addr);
220 * \brief Set the access flags on a page
221 * \param VAddr Virtual address of the page
222 * \param Flags New flags value
223 * \param Mask Flags to set
225 extern void MM_SetFlags(volatile void *VAddr, Uint Flags, Uint Mask);
227 * \brief Get the flags on a flag
228 * \param VAddr Virtual address of page
229 * \return Flags value of the page
231 extern Uint MM_GetFlags(volatile const void *VAddr);
233 * \brief Checks is a memory range is user accessable
234 * \param VAddr Base address to check
235 * \return 1 if the memory is all user-accessable, 0 otherwise
237 #define MM_IsUser(VAddr) (!(MM_GetFlags((const void*)(VAddr))&MM_PFLAG_KERNEL))
239 * \brief Temporarily map a page into the address space
240 * \param PAddr Physical addres to map
241 * \return Virtual address of page in memory
242 * \note There is only a limited ammount of slots avaliable
244 extern void *MM_MapTemp(tPAddr PAddr);
246 * \brief Free a temporarily mapped page
247 * \param Ptr Pointer to page base
249 extern void MM_FreeTemp(void *Ptr);
251 * \brief Map a physcal address range into the virtual address space
252 * \param PAddr Physical address to map in
253 * \param Number Number of pages to map
255 extern void *MM_MapHWPages(tPAddr PAddr, Uint Number);
257 * \brief Allocates DMA physical memory
258 * \param Pages Number of pages required
259 * \param MaxBits Maximum number of bits the physical address can have
260 * \param PhysAddr Pointer to the location to place the physical address allocated
261 * \return Virtual address allocate
263 extern void *MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
265 * \brief Unmaps an allocated hardware range
266 * \param VAddr Virtual address allocate by ::MM_MapHWPages or ::MM_AllocDMA
267 * \param Number Number of pages to free
269 extern void MM_UnmapHWPages(volatile void *VAddr, Uint Number);
271 * \brief Allocate a single physical page
272 * \return Physical address allocated
274 extern tPAddr MM_AllocPhys(void);
276 * \brief Allocate a contiguous range of physical pages
277 * \param Pages Number of pages to allocate
278 * \param MaxBits Maximum number of address bits allowed
279 * \return First physical address allocated
281 extern tPAddr MM_AllocPhysRange(int Pages, int MaxBits);
283 * \brief Reference a physical page
284 * \param PAddr Page to mark as referenced
286 extern void MM_RefPhys(tPAddr PAddr);
288 * \brief Dereference a physical page
289 * \param PAddr Page to dereference
291 extern void MM_DerefPhys(tPAddr PAddr);
293 * \brief Get the number of times a page has been referenced
294 * \param PAddr Address to check
295 * \return Reference count for the page
297 extern int MM_GetRefCount(tPAddr PAddr);
299 * \brief Set the node associated with a page
300 * \param PAddr Physical address of page
301 * \param Node Node pointer (tVFS_Node)
302 * \return Boolean failure
304 * \retval 1 Page not allocated
306 extern int MM_SetPageNode(tPAddr PAddr, void *Node);
308 * \brief Get the node associated with a page
309 * \param PAddr Physical address of page
310 * \param Node Node pointer (tVFS_Node) destination
311 * \return Boolean failure
313 * \retval 1 Page not allocated
315 extern int MM_GetPageNode(tPAddr PAddr, void **Node);
320 // --- Memory Manipulation ---
322 * \name Memory Manipulation
325 extern int memcmp(const void *m1, const void *m2, size_t count);
326 extern void *memcpy(void *dest, const void *src, size_t count);
327 extern void *memcpyd(void *dest, const void *src, size_t count);
328 extern void *memmove(void *dest, const void *src, size_t len);
329 extern void *memset(void *dest, int val, size_t count);
330 extern void *memsetd(void *dest, Uint32 val, size_t count);
335 * \name Memory Validation
338 extern int CheckString(const char *String);
339 extern int CheckMem(const void *Mem, int Num);
344 // --- Endianness ---
346 * \name Endianness Swapping
349 #ifdef __BIG_ENDIAN__
350 #define LittleEndian16(_val) SwapEndian16(_val)
351 #define LittleEndian32(_val) SwapEndian32(_val)
352 #define LittleEndian64(_val) SwapEndian32(_val)
353 #define BigEndian16(_val) (_val)
354 #define BigEndian32(_val) (_val)
355 #define BigEndian64(_val) (_val)
357 #define LittleEndian16(_val) (_val)
358 #define LittleEndian32(_val) (_val)
359 #define LittleEndian64(_val) (_val)
360 #define BigEndian16(_val) SwapEndian16(_val)
361 #define BigEndian32(_val) SwapEndian32(_val)
362 #define BigEndian64(_val) SwapEndian64(_val)
364 extern Uint16 SwapEndian16(Uint16 Val);
365 extern Uint32 SwapEndian32(Uint32 Val);
366 extern Uint64 SwapEndian64(Uint64 Val);
372 #include <acess_string.h>
377 * \brief Get a random number
378 * \return Random number
379 * \note Current implementation is a linear congruency
381 extern int rand(void);
383 * \brief Call a function with a variable number of arguments
384 * \param Function Function address
385 * \param NArgs Number of entries in \a Args
386 * \param Args Array of arguments
387 * \return Integer from called Function
389 extern int CallWithArgArray(void *Function, int NArgs, Uint *Args);
394 * \brief Magic heap allocation function
396 extern void *alloca(size_t Size);
403 extern int Module_LoadMem(void *Buffer, Uint Length, const char *ArgStr);
404 extern int Module_LoadFile(const char *Path, const char *ArgStr);
411 * \name Time and Timing
415 * \brief Create a timestamp from a time
416 * \note Days/Months are zero-based (e.g. December is 11, and has a day range of 0-30)
418 extern tTime timestamp(int sec, int mins, int hrs, int day, int month, int year);
420 * \brief Extract the date/time from a timestamp
421 * \note Days/Months are zero-based (e.g. December is 11, and has a day range of 0-30)
423 extern void format_date(tTime TS, int *year, int *month, int *day, int *hrs, int *mins, int *sec, int *ms);
425 * \brief Gets the current timestamp (miliseconds since Midnight 1st January 1970)
427 extern Sint64 now(void);
434 * \name Threads and Processes
437 extern struct sThread *Proc_SpawnWorker(void (*Fcn)(void*), void *Data);
438 extern int Proc_Spawn(const char *Path);
439 extern int Proc_SysSpawn(const char *Binary, const char **ArgV, const char **EnvP, int nFD, int *FDs);
440 extern int Proc_Execve(const char *File, const char **ArgV, const char **EnvP, int DataSize);
441 extern void Threads_Exit(int TID, int Status);
442 extern void Threads_Yield(void);
443 extern void Threads_Sleep(void);
444 extern int Threads_WakeTID(tTID Thread);
445 extern tPGID Threads_GetPGID(void);
446 extern tPID Threads_GetPID(void);
447 extern tTID Threads_GetTID(void);
448 extern tUID Threads_GetUID(void);
449 extern tGID Threads_GetGID(void);
450 extern int SpawnTask(tThreadFunction Function, void *Arg);
451 extern int *Threads_GetErrno(void);
452 extern int Threads_SetName(const char *NewName);
457 // --- Simple Math ---
458 //! Divide and round up
459 extern int DivUp(int num, int dem);
460 //! Divide and Modulo 64-bit unsigned integer
461 extern Uint64 DivMod64U(Uint64 Num, Uint64 Den, Uint64 *Rem);
463 static inline int MIN(int a, int b) { return a < b ? a : b; }
464 static inline int MAX(int a, int b) { return a > b ? a : b; }
466 #include <binary_ext.h>