Skip to main content

kh_runtime/
lib.rs

1//! Native ARM64 execution context, guest memory layout, and trap hooks.
2//!
3//! Dependency rule: this crate must not depend on `kh-loader` or `kh-cli`.
4//!
5//! `unsafe` is denied by workspace lints and only allowed in tightly scoped
6//! modules (`cpu`, `host`, `host_slot`, `mem/*`, `trap`, `entry`, `thread`,
7//! `tls`, and `bottle::read_c_string`).
8
9pub mod bottle;
10pub mod cpu;
11pub mod entry;
12pub mod host;
13pub mod host_slot;
14pub mod mem;
15pub mod process;
16pub mod regs;
17pub mod stack;
18pub mod syscall;
19pub mod thread;
20pub mod tls;
21pub mod tls_verify;
22pub mod trap;
23
24pub use bottle::{
25    BottleError, BottleStatus, CreateOptions, CreateResult, DARWIN_7ZZ_URL, DARWIN_CURL_URL,
26    DEFAULT_7ZZ_PATH, ENV_7ZZ, ENV_CURL, GUEST_7ZZ_REL, GUEST_CURL_REL, GUEST_LIBCXX_REL,
27    GUEST_LIBCXX_TARGET, GUEST_PATH_DIRS, InstallPackage, InstallReport, PathError, ToolError,
28    active_root, bottle_root, create as create_bottle, create_with as create_bottle_with,
29    destroy as destroy_bottle, discover_7zz, discover_curl, ensure as ensure_bottle,
30    ensure_libcxx_symlink, guest_path_to_host, has_libcxx_symlink, install_package,
31    package_host_path, resolve_guest_program, set_bottle_root, status as bottle_status,
32    translate_path, translate_path_with_root,
33};
34pub use process::{ProcessState, reset_run};
35
36pub use entry::{EntryError, call_guest, call_guest_args, jump_to_guest, jump_to_guest_args};
37pub use mem::{
38    AddressSpace, DARWIN_ARM64_PAGE_SIZE, GuestMemory, GuestPageSize, HostPageSize, MapError,
39    MapRequest, MappedRegion, PageError, PageLayout, VM_PROT_EXECUTE, VM_PROT_READ, VM_PROT_WRITE,
40    map_stack, mprotect_darwin, mprotect_rw, register_borrowed, registry_clear, registry_install,
41    registry_take,
42};
43pub use regs::ThreadRegs;
44pub use stack::{StackError, bootstrap_stack};
45pub use syscall::{
46    BsdSyscall, SyscallArgs, SyscallResult, known_syscalls, lookup as lookup_syscall, name_of,
47};
48pub use tls::{
49    GUEST_TLS_MAGIC, enter_host_tls, install_main_guest_tls, leave_host_tls, prepare_host_meta,
50};
51#[cfg(all(target_arch = "aarch64", target_os = "linux"))]
52pub use trap::kh_trampoline_dispatch;
53pub use trap::{
54    PSTATE_C, TrapConfig, TrapError, TrapEvent, TrapOutcome, clear_expect_code,
55    clear_trace_on_exit, finish_with_exit_code, hypercall_entry_addr, install_trap_handlers,
56    patch_svc_to_brk, set_expect_code, set_trace_on_exit, take_trace_events,
57};
58// `kh_hypercall_entry` is a `global_asm!` symbol; address via `hypercall_entry_addr`.