Hyperlight 项目使用教程

Hyperlight 项目使用教程

hyperlight Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications. It enables safe execution of untrusted code within micro virtual machines with very low latency and minimal overhead. 项目地址: https://gitcode.com/gh_mirrors/hy/hyperlight

1. 项目目录结构及介绍

Hyperlight 是一个轻量级的虚拟机管理器（VMM），专为内嵌于应用程序中而设计。以下是其目录结构和相关介绍：

• src/hyperlight_host：包含 Hyperlight 的主机库，用于创建和管理虚拟机。
• src/hyperlight_guest：包含 Hyperlight 的客户库，用于简化在虚拟机内运行的客户程序的开发。
• src/hyperlight_guest_capi：为 Hyperlight 客户库提供的 C 兼容包装器。
• src/hyperlight_common：包含由主机和客户共享的功能。
• src/tests/rust_guests：包含用 Rust 编写的三个 Hyperlight 客户程序，旨在作为“客户”在分区中启动。
• src/tests/c_guests：包含用 C 编写的两个 Hyperlight 客户程序。
• 其他目录和文件：包括文档、许可证、贡献指南等。

2. 项目的启动文件介绍

Hyperlight 项目的启动通常涉及创建和使用虚拟机的主机和客户库。以下是启动文件的基本介绍：

主机启动文件示例（Rust）

在 src/hyperlight_host/examples 目录中，可以找到一个名为 main.rs 的示例文件，它展示了如何创建一个未初始化的沙盒，注册主机函数，然后调用客户程序中的函数。

// 示例代码：创建沙盒、注册主机函数、调用客户函数
fn main() -> hyperlight_host::Result<()> {
    // 创建一个未初始化的沙盒
    let mut uninitialized_sandbox = UninitializedSandbox::new(...);

    // 注册一个主机函数
    let host_function = Arc::new(Mutex::new(sleep_5_secs));
    host_function.register(&mut uninitialized_sandbox, "Sleep5Secs")?;

    // 初始化沙盒以调用主机函数
    let mut multi_use_sandbox = uninitialized_sandbox.evolve(Noop::default())?;

    // 调用客户函数
    let message = "Hello, World! I am executing inside of a VM :)\n".to_string();
    let result = multi_use_sandbox.call_guest_function_by_name("PrintOutput", ReturnType::Int, Some(vec![ParameterValue::String(message.clone())]))?;

    assert!(result.is_ok());
    Ok(())
}

客户启动文件示例（Rust）

在 src/tests/rust_guests 目录中，可以找到一个名为 simple_guest.rs 的示例文件，它定义了一个简单的客户程序，该程序注册了一个名为 PrintOutput 的函数。

// 示例代码：客户程序注册函数
#[no_mangle]
pub fn hyperlight_main() {
    let print_output_def = GuestFunctionDefinition::new("PrintOutput".to_string(), vec![ParameterType::String], ReturnType::Int, print_output as i64);
    register_function(print_output_def);
}

fn print_output(function_call: &FunctionCall) -> Result<Vec<u8>, HyperlightGuestError> {
    // 客户程序逻辑
}

3. 项目的配置文件介绍

Hyperlight 项目的配置文件包括 Cargo.toml、.gitignore、editorconfig 等，以下是其中几个重要文件的介绍：

Cargo.toml

这是 Rust 项目的配置文件，它定义了项目的元数据（如名称、版本、作者）、依赖项、构建脚本等信息。

[package]
name = "hyperlight"
version = "0.1.0"
edition = "2021"

[dependencies]
# 项目的依赖项列表

.gitignore

这是一个 Git 配置文件，用于指定在执行 git add、git commit 等命令时应该忽略的文件和目录。

# 忽略的文件和目录列表
target/
*.swp
*.lock

editorconfig

这是一个编辑器配置文件，用于保持代码风格的一致性，例如缩进风格、换行符等。

# 编辑器配置
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf

通过上述介绍，开发者可以更好地理解 Hyperlight 项目的结构和配置，从而更有效地使用该项目。

hyperlight Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications. It enables safe execution of untrusted code within micro virtual machines with very low latency and minimal overhead. 项目地址: https://gitcode.com/gh_mirrors/hy/hyperlight