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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

/*
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 crate::{new_error, Result};
/// Context structures used to allow the user to call one or more guest
/// functions on the same Hyperlight sandbox instance, all from within the
/// same state and mutual exclusion context.
pub mod call_ctx;
/// Functionality to dispatch a call from the host to the guest
pub(crate) mod guest_dispatch;
/// Functionality to check for errors after a guest call
pub(crate) mod guest_err;
/// Definitions and functionality to enable guest-to-host function calling,
/// also called "host functions"
///
/// This module includes functionality to do the following
///
/// - Define several prototypes for what a host function must look like,
///   including the number of arguments (arity) they can have, supported argument
///   types, and supported return types
/// - Registering host functions to be callable by the guest
/// - Dynamically dispatching a call from the guest to the appropriate
///   host function
pub mod host_functions;
/// Definitions and functionality for supported parameter types
pub(crate) mod param_type;
/// Definitions and functionality for supported return types
pub mod ret_type;

use std::sync::{Arc, Mutex};

/// Re-export for `ParameterValue` enum
pub use hyperlight_common::flatbuffer_wrappers::function_types::ParameterValue;
/// Re-export for `ReturnType` enum
pub use hyperlight_common::flatbuffer_wrappers::function_types::ReturnType;
/// Re-export for `ReturnType` enum
pub use hyperlight_common::flatbuffer_wrappers::function_types::ReturnValue;
pub use param_type::SupportedParameterType;
pub use ret_type::SupportedReturnType;
use tracing::{instrument, Span};

type HLFunc = Arc<Mutex<Box<dyn FnMut(Vec<ParameterValue>) -> Result<ReturnValue> + Send>>>;

/// Generic HyperlightFunction
#[derive(Clone)]
pub struct HyperlightFunction(HLFunc);

impl HyperlightFunction {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    pub(crate) fn new<F>(f: F) -> Self
    where
        F: FnMut(Vec<ParameterValue>) -> Result<ReturnValue> + Send + 'static,
    {
        Self(Arc::new(Mutex::new(Box::new(f))))
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    pub(crate) fn call(&self, args: Vec<ParameterValue>) -> Result<ReturnValue> {
        let mut f = self
            .0
            .try_lock()
            .map_err(|e| new_error!("Error locking at {}:{}: {}", file!(), line!(), e))?;
        f(args)
    }
}

/// Re-export for `HostFunction0` trait
pub use host_functions::HostFunction0;
/// Re-export for `HostFunction1` trait
pub use host_functions::HostFunction1;
/// Re-export for `HostFunction10` trait
pub use host_functions::HostFunction10;
/// Re-export for `HostFunction2` trait
pub use host_functions::HostFunction2;
/// Re-export for `HostFunction3` trait
pub use host_functions::HostFunction3;
/// Re-export for `HostFunction4` trait
pub use host_functions::HostFunction4;
/// Re-export for `HostFunction5` trait
pub use host_functions::HostFunction5;
/// Re-export for `HostFunction6` trait
pub use host_functions::HostFunction6;
/// Re-export for `HostFunction7` trait
pub use host_functions::HostFunction7;
/// Re-export for `HostFunction8` trait
pub use host_functions::HostFunction8;
/// Re-export for `HostFunction9` trait
pub use host_functions::HostFunction9;