twizzler_abi/lib.rs
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
//! This library provides a common interface for applications that want to talk to the Twizzler
//! kernel, and defines that interface for both applications and the kernel to follow. It's made of
//! several parts:
//! 1. The Runtime -- see [runtime].
//! 2. System Calls -- see [syscall] and [arch::syscall].
//! 3. Other Application-Kernel ABI definitions (e.g. pager queue entries).
//!
//! # Should I use these APIs?
//! All of these interfaces are potentially unstable and should not be used directly by most
//! programs.
#![cfg_attr(not(feature = "std"), no_std)]
#![feature(naked_functions)]
#![feature(core_intrinsics)]
#![feature(int_roundings)]
#![feature(thread_local)]
#![feature(auto_traits)]
#![feature(negative_impls)]
#![allow(internal_features)]
#![feature(rustc_attrs)]
#![feature(linkage)]
#![feature(test)]
#![feature(c_variadic)]
pub mod arch;
#[allow(unused_extern_crates)]
extern crate alloc as rustc_alloc;
pub mod aux;
pub mod device;
pub mod klog;
pub mod kso;
pub mod marker;
pub mod meta;
pub mod object;
pub mod pager;
#[cfg(feature = "runtime")]
pub mod runtime;
pub mod security;
pub mod slot;
pub mod syscall;
pub mod thread;
pub mod upcall;
#[inline]
unsafe fn internal_abort() -> ! {
cfg_if::cfg_if! {
if #[cfg(feature = "runtime")] {
runtime::OUR_RUNTIME.abort();
} else {
core::intrinsics::abort();
}
}
}
fn print_err(err: &str) {
syscall::sys_kernel_console_write(err.as_bytes(), syscall::KernelConsoleWriteFlags::empty());
}
#[allow(dead_code)]
/// during runtime init, we need to call functions that might fail, but if they do so, we should
/// just abort. the standard unwrap() function for option will call panic, but we can't use that, as
/// the runtime init stuff runs before the panic runtime is ready.
fn internal_unwrap<T>(t: Option<T>, msg: &str) -> T {
if let Some(t) = t {
t
} else {
print_err(msg);
unsafe {
internal_abort();
}
}
}
#[allow(dead_code)]
/// during runtime init, we need to call functions that might fail, but if they do so, we should
/// just abort. the standard unwrap() function for result will call panic, but we can't use that, as
/// the runtime init stuff runs before the panic runtime is ready.
fn internal_unwrap_result<T, E>(t: Result<T, E>, msg: &str) -> T {
if let Ok(t) = t {
t
} else {
print_err(msg);
unsafe {
internal_abort();
}
}
}
#[cfg(test)]
extern crate test;
#[cfg(test)]
mod tester {
use crate::print_err;
#[bench]
fn test_bench(bench: &mut test::Bencher) {
bench.iter(|| {
for i in 0..10000 {
core::hint::black_box(i);
}
});
}
}