Crate hyperlight_host

This crate contains an SDK that is used to execute specially-

Re-exports

pub use error::HyperlightError;

pub use sandbox::is_hypervisor_present;

pub use sandbox::uninitialized::GuestBinary;

pub use sandbox::MultiUseSandbox;

pub use sandbox::SandboxRunOptions;

pub use sandbox::UninitializedSandbox;

pub use crate::func::call_ctx::MultiUseGuestCallContext;

Modules

error

Dealing with errors, including errors across VM boundaries

func

Wrappers for host and guest functions.

hypervisor

Wrappers for hypervisor implementations

mem

Functionality to establish and manage an individual sandbox’s memory.

metrics

Metric definitions and helpers

sandbox

The main sandbox implementations. Do not use this module directly in code outside this file. Types from this module needed for public consumption are re-exported below.

sandbox_state

traits and other functionality for dealing with defining sandbox states and moving between them

Macros

and

Shorthand for chaining SeccompConditions with the and operator in a SeccompRule. The rule will take the Allow action if all the conditions are true.

debug

Same as log::debug!, but will additionally print to stdout if the print_debug feature is enabled

log_then_return

Logs an error then returns with it, more or less equivalent to the bail! macro in anyhow but for HyperlightError instead of anyhow::Error

new_error

Creates a HyperlightError::Error from a string literal or format string

or

Shorthand for chaining SeccompRules with the or operator in a SeccompFilter.

Type Aliases

Result

The universal Result type used throughout the Hyperlight codebase.