[host/{build,lib,uninit}] added feature flag to remove logging build details

git2 uses deep C bindings to libgit2 that might not be available on every target, we should allow disabling logging
build details.

Signed-off-by: danbugs <[email protected]>

Author: danbugs

src/hyperlight_host/Cargo.toml

@@ -113,10 +113,10 @@ proc-maps = "0.4.0"
 [build-dependencies]
 anyhow = { version = "1.0.98" }
 cfg_aliases = "0.2.1"
-built = { version = "0.8.0", features = ["chrono", "git2"] }
+built = { version = "0.8.0", optional = true, features = ["chrono", "git2"] }
 
 [features]
-default = ["kvm", "mshv2", "seccomp"]
+default = ["kvm", "mshv2", "seccomp", "build-metadata"]
 seccomp = ["dep:seccompiler"]
 function_call_metrics = []
 executable_heap = []
@@ -130,6 +130,7 @@ inprocess = []
 # This enables easy debug in the guest
 gdb = ["dep:gdbstub", "dep:gdbstub_arch"]
 fuzzing = ["hyperlight-common/fuzzing"]
+build-metadata = ["dep:built"]
 
 [[bench]]
 name = "benchmarks"

src/hyperlight_host/build.rs

@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 use anyhow::Result;
+#[cfg(feature = "build-metadata")]
 use built::write_built_file;
 
 fn main() -> Result<()> {
@@ -106,6 +107,7 @@ fn main() -> Result<()> {
         mshv3: { all(feature = "mshv3", target_os = "linux") },
     }
 
+    #[cfg(feature = "build-metadata")]
     write_built_file()?;
 
     Ok(())

src/hyperlight_host/src/lib.rs

@@ -22,9 +22,10 @@ limitations under the License.
 #![cfg_attr(not(any(test, debug_assertions)), warn(clippy::unwrap_used))]
 #![cfg_attr(any(test, debug_assertions), allow(clippy::disallowed_macros))]
 
+#[cfg(feature = "build-metadata")]
 use std::sync::Once;
 
-use log::info;
+#[cfg(feature = "build-metadata")]
 /// The `built` crate is used to generate a `built.rs` file that contains
 /// information about the build environment. This information is used to
 /// populate the `built_info` module, which is re-exported here.
@@ -149,9 +150,12 @@ macro_rules! debug {
 }
 
 // LOG_ONCE is used to log information about the crate version once
+#[cfg(feature = "build-metadata")]
 static LOG_ONCE: Once = Once::new();
 
+#[cfg(feature = "build-metadata")]
 pub(crate) fn log_build_details() {
+    use log::info;
     LOG_ONCE.call_once(|| {
         info!("Package name: {}", built_info::PKG_NAME);
         info!("Package version: {}", built_info::PKG_VERSION);

src/hyperlight_host/src/sandbox/uninitialized.rs

@@ -30,13 +30,15 @@ use super::mem_mgr::MemMgrWrapper;
 use super::run_options::SandboxRunOptions;
 use super::uninitialized_evolve::evolve_impl_multi_use;
 use crate::func::host_functions::{HostFunction, IntoHostFunction};
+#[cfg(feature = "build-metadata")]
+use crate::log_build_details;
 use crate::mem::exe::ExeInfo;
 use crate::mem::mgr::{SandboxMemoryManager, STACK_COOKIE_LEN};
 use crate::mem::shared_mem::ExclusiveSharedMemory;
 use crate::sandbox::SandboxConfiguration;
 use crate::sandbox_state::sandbox::EvolvableSandbox;
 use crate::sandbox_state::transition::Noop;
-use crate::{log_build_details, log_then_return, new_error, MultiUseSandbox, Result};
+use crate::{log_then_return, new_error, MultiUseSandbox, Result};
 
 /// A preliminary `Sandbox`, not yet ready to execute guest code.
 ///
@@ -129,6 +131,7 @@ impl UninitializedSandbox {
         sandbox_run_options: Option<SandboxRunOptions>,
         host_print_writer: Option<&dyn HostFunction<i32, (String,)>>,
     ) -> Result<Self> {
+        #[cfg(feature = "build-metadata")]
         log_build_details();
 
         // hyperlight is only supported on Windows 11 and Windows Server 2022 and later