twizzler_abi/
lib.rs

1//! This library provides a common interface for applications that want to talk to the Twizzler
2//! kernel, and defines that interface for both applications and the kernel to follow. It's made of
3//! several parts:
4//!   1. System Calls -- see [syscall] and [arch::syscall].
5//!   2. Other Application-Kernel ABI definitions (e.g. pager queue entries).
6//!
7//! # Should I use these APIs?
8//! All of these interfaces are potentially unstable and should not be used directly by most
9//! programs.
10
11#![no_std]
12#![feature(naked_functions)]
13#![feature(core_intrinsics)]
14#![feature(int_roundings)]
15#![feature(thread_local)]
16#![feature(auto_traits)]
17#![feature(negative_impls)]
18#![allow(internal_features)]
19#![feature(rustc_attrs)]
20#![feature(linkage)]
21#![feature(test)]
22#![feature(c_variadic)]
23
24use syscall::KernelConsoleSource;
25pub mod arch;
26
27#[allow(unused_extern_crates)]
28extern crate alloc as rustc_alloc;
29
30pub mod aux;
31pub mod device;
32pub mod klog;
33pub mod kso;
34pub mod marker;
35pub mod meta;
36pub mod object;
37pub mod pager;
38pub mod security;
39pub mod simple_mutex;
40pub mod slot;
41pub mod syscall;
42pub mod thread;
43pub mod trace;
44pub mod upcall;
45
46#[inline]
47unsafe fn internal_abort() -> ! {
48    core::intrinsics::abort();
49}
50
51pub fn print_err(err: &str) {
52    syscall::sys_kernel_console_write(
53        KernelConsoleSource::Console,
54        err.as_bytes(),
55        syscall::KernelConsoleWriteFlags::empty(),
56    );
57}
58
59#[allow(dead_code)]
60/// during runtime init, we need to call functions that might fail, but if they do so, we should
61/// just abort. the standard unwrap() function for option will call panic, but we can't use that, as
62/// the runtime init stuff runs before the panic runtime is ready.
63fn internal_unwrap<T>(t: Option<T>, msg: &str) -> T {
64    if let Some(t) = t {
65        t
66    } else {
67        print_err(msg);
68        unsafe {
69            internal_abort();
70        }
71    }
72}
73
74#[allow(dead_code)]
75/// during runtime init, we need to call functions that might fail, but if they do so, we should
76/// just abort. the standard unwrap() function for result will call panic, but we can't use that, as
77/// the runtime init stuff runs before the panic runtime is ready.
78fn internal_unwrap_result<T, E>(t: Result<T, E>, msg: &str) -> T {
79    if let Ok(t) = t {
80        t
81    } else {
82        print_err(msg);
83        unsafe {
84            internal_abort();
85        }
86    }
87}
88
89#[cfg(test)]
90extern crate test;
91
92#[cfg(test)]
93mod tester {
94    #[bench]
95    fn test_bench(bench: &mut test::Bencher) {
96        bench.iter(|| {
97            for i in 0..10000 {
98                core::hint::black_box(i);
99            }
100        });
101    }
102}
twizzler_abi/lib.rs

twizzler_abi/
lib.rs
