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