hyperlight-host 0.1.0

A lightweight Virtual Machine Manager that can be hosted in an application to safely run untrusted or code within a VM partition with very low latency and overhead.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

/*
Copyright 2024 The Hyperlight Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

use hyperlight_host::func::{ParameterValue, ReturnType, ReturnValue};
use hyperlight_host::sandbox::uninitialized::UninitializedSandbox;
use hyperlight_host::sandbox_state::sandbox::EvolvableSandbox;
use hyperlight_host::sandbox_state::transition::Noop;
use hyperlight_host::{GuestBinary, MultiUseSandbox, Result};
use hyperlight_testing::simple_guest_as_string;
use tracing_chrome::ChromeLayerBuilder;
use tracing_subscriber::prelude::*;

// This example can be run with `cargo run --package hyperlight_host --example chrome-tracing --release`
fn main() -> Result<()> {
    // set up tracer
    let (chrome_layer, _guard) = ChromeLayerBuilder::new().build();
    tracing_subscriber::registry().with(chrome_layer).init();

    let simple_guest_path =
        simple_guest_as_string().expect("Cannot find the guest binary at the expected location.");

    // Create a new sandbox.
    let usandbox =
        UninitializedSandbox::new(GuestBinary::FilePath(simple_guest_path), None, None, None)?;

    // NOTE: if replacing MultiUseSandbox with SingleUseSandbox, the function call will take ~50x longer because the drop
    // happens inside `call_guest_function_by_name` rather than at the end of of this `main` block.

    let mut sbox = usandbox
        .evolve(Noop::<UninitializedSandbox, MultiUseSandbox>::default())
        .unwrap();

    // do the function call
    let current_time = std::time::Instant::now();
    let res = sbox.call_guest_function_by_name(
        "Echo",
        ReturnType::String,
        Some(vec![ParameterValue::String("Hello, World!".to_string())]),
    )?;
    let elapsed = current_time.elapsed();
    println!("Function call finished in {:?}.", elapsed);
    assert!(matches!(res, ReturnValue::String(s) if s == "Hello, World!"));
    Ok(())
}