cargo-hyperlight 0.1.11

cargo subcommand to build hyperlight guest binaries
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
102
103
104
105
106
107
108
109
110
111
112
113
114

use anyhow::Result;

mod cargo_cmd;
mod cli;
mod command;
mod sysroot;
mod toolchain;

use cargo_cmd::CargoCmd;
use cli::Args;
pub use command::Command;

/// Constructs a new `Command` for launching cargo targeting
/// [hyperlight](https://github.com/hyperlight-dev/hyperlight) guest code.
///
/// The value of the `CARGO` environment variable is used if it is set; otherwise, the
/// default `cargo` from the system PATH is used.
/// If `RUSTUP_TOOLCHAIN` is set in the environment, it is also propagated to the
/// child process to ensure correct functioning of the rustup wrappers.
///
/// The default configuration is:
/// - No arguments to the program
/// - Inherits the current process's environment
/// - Inherits the current process's working directory
///
/// # Errors
///
/// This function will return an error if:
/// - If the `CARGO` environment variable is set but it specifies an invalid path
/// - If the `CARGO` environment variable is not set and the `cargo` program cannot be found in the system PATH
///
/// # Examples
///
/// Basic usage:
///
/// ```rust
/// use cargo_hyperlight::cargo;
///
/// let command = cargo().unwrap();
/// ```
pub fn cargo() -> Result<Command> {
    Command::new()
}

impl Args {
    pub fn sysroot_dir(&self) -> std::path::PathBuf {
        self.target_dir.join("sysroot")
    }

    pub fn triplet_dir(&self) -> std::path::PathBuf {
        self.sysroot_dir()
            .join("lib")
            .join("rustlib")
            .join(&self.target)
    }

    pub fn build_dir(&self) -> std::path::PathBuf {
        self.sysroot_dir().join("target")
    }

    pub fn libs_dir(&self) -> std::path::PathBuf {
        self.triplet_dir().join("lib")
    }

    pub fn includes_dir(&self) -> std::path::PathBuf {
        self.triplet_dir().join("include")
    }

    pub fn crate_dir(&self) -> std::path::PathBuf {
        self.sysroot_dir().join("crate")
    }
}

trait CargoCommandExt {
    fn populate_from_args(&mut self, args: &Args) -> &mut Self;
}

impl CargoCommandExt for std::process::Command {
    fn populate_from_args(&mut self, args: &Args) -> &mut Self {
        self.target(&args.target);
        self.sysroot(args.sysroot_dir());
        self.append_rustflags("--cfg=hyperlight");
        self.append_rustflags("--check-cfg=cfg(hyperlight)");
        self.entrypoint("entrypoint");
        if let Some(clang) = &args.clang {
            self.cc_env(&args.target, clang);
        } else {
            // If we couldn't find clang, use the default from the
            // system path. This will then error if we try to build
            // using cc-rs, but will succeed otherwise.
            self.cc_env(&args.target, "clang");
        }
        if let Some(ar) = &args.ar {
            self.ar_env(&args.target, ar);
        } else {
            // do nothing, let cc-rs find ar itself
        }
        self.append_cflags(&args.target, toolchain::cflags(args));

        self
    }
}

impl Args {
    pub fn prepare_sysroot(&self) -> Result<()> {
        // Build sysroot
        sysroot::build(self)?;

        // Build toolchain
        toolchain::prepare(self)?;

        Ok(())
    }
}