ukernel-sys 0.1.0

System interface types for µKernel — a Rust microkernel with hypervisor and real-time scheduling. Defines kernel operations, submission ring layout, and subsystem registration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! System interface types for µKernel.
//!
//! This crate defines the ABI between userspace domains and the µKernel
//! microkernel. It contains:
//!
//! - [`KernelOp`] — the ~30 primitive kernel operations
//! - [`SubmitEntry`] / [`CompleteEntry`] — submission ring entry types
//! - [`SubmitRing`] — shared-memory ring buffer layout
//! - [`SubsystemId`] — hashed subsystem identity for loadable domain types
//!
//! # Architecture
//!
//! ```text
//! Application (Rust std or no_std)
//!     ↓
//! libposix.a (queues KernelOps into ring)
//!     ↓ SYS_SUBMIT
//! µKernel (processes ring, capability checks)
//! ```
//!
//! This crate defines the types at the `↓` boundary. It is `no_std` and
//! has zero dependencies.
//!
//! # Usage
//!
//! Most applications don't use this crate directly — they use Rust `std`
//! (via the `x86_64-americankernel-ukernel` target) or `libposix`. This
//! crate is for:
//!
//! - Building custom domain runtimes
//! - Writing kernel-level drivers or subsystems
//! - Understanding the µKernel syscall interface
//!
//! # Links
//!
//! - [µKernel](https://americankernel.com) — product information
//! - [Vinci Consulting](https://vinciconsulting.com) — engineering services

#![no_std]
#![forbid(unsafe_code)]

pub mod kernel_op;
pub mod submit_ring;
pub mod subsystem;

pub use kernel_op::KernelOp;
pub use submit_ring::{CompleteEntry, SubmitEntry, SubmitRing, RING_SIZE, RING_VADDR};
pub use subsystem::SubsystemId;