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 trap;
22
23pub use bottle::{
24    BottleError, BottleStatus, CreateOptions, CreateResult, DARWIN_7ZZ_URL, DEFAULT_7ZZ_PATH,
25    ENV_7ZZ, GUEST_7ZZ_REL, GUEST_LIBCXX_REL, GUEST_LIBCXX_TARGET, GUEST_PATH_DIRS, InstallPackage,
26    InstallReport, PathError, ToolError, active_root, bottle_root, create as create_bottle,
27    create_with as create_bottle_with, destroy as destroy_bottle, discover_7zz,
28    ensure as ensure_bottle, ensure_libcxx_symlink, guest_path_to_host, has_libcxx_symlink,
29    install_package, package_host_path, resolve_guest_program, set_bottle_root,
30    status as bottle_status, translate_path, translate_path_with_root,
31};
32pub use process::{ProcessState, reset_run};
33
34pub use entry::{EntryError, call_guest, call_guest_args, jump_to_guest, jump_to_guest_args};
35pub use mem::{
36    AddressSpace, DARWIN_ARM64_PAGE_SIZE, GuestMemory, GuestPageSize, HostPageSize, MapError,
37    MapRequest, MappedRegion, PageError, PageLayout, VM_PROT_EXECUTE, VM_PROT_READ, VM_PROT_WRITE,
38    map_stack, mprotect_darwin, mprotect_rw, register_borrowed, registry_clear, registry_install,
39    registry_take,
40};
41pub use regs::ThreadRegs;
42pub use stack::{StackError, bootstrap_stack};
43pub use syscall::{
44    BsdSyscall, SyscallArgs, SyscallResult, known_syscalls, lookup as lookup_syscall, name_of,
45};
46pub use tls::{
47    GUEST_TLS_MAGIC, enter_host_tls, install_main_guest_tls, leave_host_tls, prepare_host_meta,
48};
49#[cfg(all(target_arch = "aarch64", target_os = "linux"))]
50pub use trap::kh_trampoline_dispatch;
51pub use trap::{
52    PSTATE_C, TrapConfig, TrapError, TrapEvent, TrapOutcome, clear_expect_code,
53    clear_trace_on_exit, finish_with_exit_code, hypercall_entry_addr, install_trap_handlers,
54    patch_svc_to_brk, set_expect_code, set_trace_on_exit, take_trace_events,
55};
56// `kh_hypercall_entry` is a `global_asm!` symbol; address via `hypercall_entry_addr`.