Fix guest tracing filter (#977)

* [trace-guest] Update guest library trace levels and remove explicit parent

- To make the codebase more readable, remove the `parent` argument from
  the `#[instrument]` attribute.

Signed-off-by: Doru Blânzeanu <dblnz@pm.me>

* [trace-guest] Add trace filtering based on max_log_level

- The `max_log_level` argument provided to the guest function is
  now used to filter traces also

Signed-off-by: Doru Blânzeanu <dblnz@pm.me>

* [trace-guest] Define a common log level filter to be used for tracing and logging

- Adds a `GuestLogFilter` enum that is used as an intermediary type
  between the `u64` used as a register to call the guest entrypoint and
  the `log::LogFilter` or `tracing_core::LogFilter`.
- Adds unit tests for the `GuestLogFilter`.

Signed-off-by: Doru Blânzeanu <dblnz@pm.me>

* [host] Simplify `get_max_log_level_filter` function

- Add more comments and tests to verify the new logic works as expected

Signed-off-by: Doru Blânzeanu <dblnz@pm.me>

---------

Signed-off-by: Doru Blânzeanu <dblnz@pm.me>

Author: dblnz

Cargo.lock

@@ -22,6 +22,7 @@ tracing = { version = "0.1.44", optional = true }
 arbitrary = {version = "1.4.2", optional = true, features = ["derive"]}
 spin = "0.10.0"
 thiserror = { version = "2.0.18", default-features = false }
+tracing-core = { version = "0.1.36", default-features = false }
 
 [features]
 default = ["tracing"]

src/hyperlight_common/Cargo.toml

@@ -30,6 +30,9 @@ mod flatbuffers;
 // cbindgen:ignore
 pub mod layout;
 
+// cbindgen:ignore
+pub mod log_level;
+
 /// cbindgen:ignore
 pub mod mem;
 

src/hyperlight_common/src/lib.rs

@@ -0,0 +1,184 @@
+/*
+Copyright 2025  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.
+*/
+
+/// This type is a unified definition of log level filters between the guest and host.
+///
+/// This is needed because currently the guest uses both the `log` and `tracing` crates,
+/// and needs each type of `LevelFilter` from both crates.
+///
+/// To avoid as much as possible the amount of conversions between the two types, we define a
+/// single type that can be converted to both `log::LevelFilter` and `tracing_core::LevelFilter`.
+/// NOTE: This also takes care of the fact that the `tracing` and `log` enum types for the log
+/// levels are not guaranteed to have the same discriminants, so we can't just cast between them.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum GuestLogFilter {
+    Off,
+    Error,
+    Warn,
+    Info,
+    Debug,
+    Trace,
+}
+
+impl From<GuestLogFilter> for tracing_core::LevelFilter {
+    fn from(filter: GuestLogFilter) -> Self {
+        match filter {
+            GuestLogFilter::Off => tracing_core::LevelFilter::OFF,
+            GuestLogFilter::Error => tracing_core::LevelFilter::ERROR,
+            GuestLogFilter::Warn => tracing_core::LevelFilter::WARN,
+            GuestLogFilter::Info => tracing_core::LevelFilter::INFO,
+            GuestLogFilter::Debug => tracing_core::LevelFilter::DEBUG,
+            GuestLogFilter::Trace => tracing_core::LevelFilter::TRACE,
+        }
+    }
+}
+
+impl From<GuestLogFilter> for log::LevelFilter {
+    fn from(filter: GuestLogFilter) -> Self {
+        match filter {
+            GuestLogFilter::Off => log::LevelFilter::Off,
+            GuestLogFilter::Error => log::LevelFilter::Error,
+            GuestLogFilter::Warn => log::LevelFilter::Warn,
+            GuestLogFilter::Info => log::LevelFilter::Info,
+            GuestLogFilter::Debug => log::LevelFilter::Debug,
+            GuestLogFilter::Trace => log::LevelFilter::Trace,
+        }
+    }
+}
+
+/// Used by the host to convert a [`tracing_core::LevelFilter`] to the intermediary [`GuestLogFilter`]
+/// filter that is later converted to `u64` and passed to the guest via the C API.
+impl From<tracing_core::LevelFilter> for GuestLogFilter {
+    fn from(value: tracing_core::LevelFilter) -> Self {
+        match value {
+            tracing_core::LevelFilter::OFF => Self::Off,
+            tracing_core::LevelFilter::ERROR => Self::Error,
+            tracing_core::LevelFilter::WARN => Self::Warn,
+            tracing_core::LevelFilter::INFO => Self::Info,
+            tracing_core::LevelFilter::DEBUG => Self::Debug,
+            tracing_core::LevelFilter::TRACE => Self::Trace,
+        }
+    }
+}
+
+/// Used by the guest to convert a `u64` value passed from the host via the C API to the
+/// intermediary [`GuestLogFilter`] filter that is later converted to both
+/// `tracing_core::LevelFilter` and `log::LevelFilter`.
+impl TryFrom<u64> for GuestLogFilter {
+    type Error = ();
+
+    fn try_from(value: u64) -> Result<Self, <GuestLogFilter as TryFrom<u64>>::Error> {
+        match value {
+            0 => Ok(Self::Off),
+            1 => Ok(Self::Error),
+            2 => Ok(Self::Warn),
+            3 => Ok(Self::Info),
+            4 => Ok(Self::Debug),
+            5 => Ok(Self::Trace),
+            _ => Err(()),
+        }
+    }
+}
+
+/// Used by the host to convert the [`GuestLogFilter`] to a `u64` that is passed to the guest via
+/// the C API.
+impl From<GuestLogFilter> for u64 {
+    fn from(value: GuestLogFilter) -> Self {
+        match value {
+            GuestLogFilter::Off => 0,
+            GuestLogFilter::Error => 1,
+            GuestLogFilter::Warn => 2,
+            GuestLogFilter::Info => 3,
+            GuestLogFilter::Debug => 4,
+            GuestLogFilter::Trace => 5,
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::GuestLogFilter;
+
+    #[test]
+    fn guest_log_filter_u64_roundtrip() {
+        let variants = [
+            GuestLogFilter::Off,
+            GuestLogFilter::Error,
+            GuestLogFilter::Warn,
+            GuestLogFilter::Info,
+            GuestLogFilter::Debug,
+            GuestLogFilter::Trace,
+        ];
+
+        for variant in variants {
+            let as_u64: u64 = variant.into();
+            let back =
+                GuestLogFilter::try_from(as_u64).expect("conversion from u64 should succeed");
+            assert_eq!(variant, back);
+        }
+    }
+
+    #[test]
+    fn guest_log_filter_tracing_roundtrip() {
+        let variants = [
+            GuestLogFilter::Off,
+            GuestLogFilter::Error,
+            GuestLogFilter::Warn,
+            GuestLogFilter::Info,
+            GuestLogFilter::Debug,
+            GuestLogFilter::Trace,
+        ];
+
+        for variant in variants {
+            let tracing_filter: tracing_core::LevelFilter = variant.into();
+            let back: GuestLogFilter = tracing_filter.into();
+            assert_eq!(variant, back);
+        }
+    }
+
+    #[test]
+    fn guest_log_filter_log_conversion() {
+        let variants = [
+            GuestLogFilter::Off,
+            GuestLogFilter::Error,
+            GuestLogFilter::Warn,
+            GuestLogFilter::Info,
+            GuestLogFilter::Debug,
+            GuestLogFilter::Trace,
+        ];
+
+        let log_variants = [
+            log::LevelFilter::Off,
+            log::LevelFilter::Error,
+            log::LevelFilter::Warn,
+            log::LevelFilter::Info,
+            log::LevelFilter::Debug,
+            log::LevelFilter::Trace,
+        ];
+
+        for (variant, log_variant) in variants.into_iter().zip(log_variants) {
+            let log_filter = log::LevelFilter::from(variant);
+            assert_eq!(log_filter, log_variant);
+        }
+    }
+
+    #[test]
+    fn guest_log_filter_try_from_u64_rejects_invalid() {
+        // Any value outside the defined range [0, 5] should be rejected.
+        assert!(GuestLogFilter::try_from(u64::MAX).is_err());
+        assert!(GuestLogFilter::try_from(6).is_err());
+    }
+}

src/hyperlight_common/src/log_level.rs

@@ -65,6 +65,7 @@ impl GuestHandle {
     ///
     /// When calling `call_host_function<T>`, this function is called
     /// internally to get the return value.
+    #[instrument(skip_all, level = "Trace")]
     pub fn get_host_return_value<T: TryFrom<ReturnValue>>(&self) -> Result<T> {
         let inner = self
             .try_pop_shared_input_data_into::<FunctionCallResult>()
@@ -106,6 +107,7 @@ impl GuestHandle {
     ///
     /// Note: The function return value must be obtained by calling
     /// `get_host_return_value`.
+    #[instrument(skip_all, level = "Trace")]
     pub fn call_host_function_without_returning_result(
         &self,
         function_name: &str,
@@ -139,7 +141,7 @@ impl GuestHandle {
     /// sends it to the host, and then retrieves the return value.
     ///
     /// The return value is deserialized into the specified type `T`.
-    #[instrument(skip_all, level = "Trace")]
+    #[instrument(skip_all, level = "Info")]
     pub fn call_host_function<T: TryFrom<ReturnValue>>(
         &self,
         function_name: &str,

src/hyperlight_guest/src/guest_handle/host_comm.rs

@@ -20,14 +20,14 @@ use core::any::type_name;
 use core::slice::from_raw_parts_mut;
 
 use hyperlight_common::flatbuffer_wrappers::guest_error::ErrorCode;
-use tracing::{Span, instrument};
+use tracing::instrument;
 
 use super::handle::GuestHandle;
 use crate::error::{HyperlightGuestError, Result};
 
 impl GuestHandle {
     /// Pops the top element from the shared input data buffer and returns it as a T
-    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
+    #[instrument(skip_all, level = "Trace")]
     pub fn try_pop_shared_input_data_into<T>(&self) -> Result<T>
     where
         T: for<'a> TryFrom<&'a [u8]>,

src/hyperlight_guest/src/guest_handle/io.rs

@@ -22,11 +22,11 @@ use hyperlight_common::flatbuffer_wrappers::function_call::{FunctionCall, Functi
 use hyperlight_common::flatbuffer_wrappers::function_types::{FunctionCallResult, ParameterType};
 use hyperlight_common::flatbuffer_wrappers::guest_error::{ErrorCode, GuestError};
 use hyperlight_guest::error::{HyperlightGuestError, Result};
-use tracing::{Span, instrument};
+use tracing::instrument;
 
 use crate::{GUEST_HANDLE, REGISTERED_GUEST_FUNCTIONS};
 
-#[instrument(skip_all, parent = Span::current(), level= "Trace")]
+#[instrument(skip_all, level = "Info")]
 pub(crate) fn call_guest_function(function_call: FunctionCall) -> Result<Vec<u8>> {
     // Validate this is a Guest Function Call
     if function_call.function_call_type() != FunctionCallType::Guest {

src/hyperlight_guest_bin/src/guest_function/call.rs

@@ -24,11 +24,11 @@ use crate::GUEST_HANDLE;
 // this is private on purpose so that `log` can only be called though the `log!` macros.
 struct GuestLogger {}
 
-pub(crate) fn init_logger(level: LevelFilter) {
+pub(crate) fn init_logger(filter: LevelFilter) {
     // if this `expect` fails we have no way to recover anyway, so we actually prefer a panic here
     // below temporary guest logger is promoted to static by the compiler.
     log::set_logger(&GuestLogger {}).expect("unable to setup guest logger");
-    log::set_max_level(level);
+    log::set_max_level(filter);
 }
 
 impl log::Log for GuestLogger {

src/hyperlight_guest_bin/src/guest_logger.rs

@@ -25,12 +25,12 @@ use buddy_system_allocator::LockedHeap;
 use guest_function::register::GuestFunctionRegister;
 use guest_logger::init_logger;
 use hyperlight_common::flatbuffer_wrappers::guest_error::ErrorCode;
+use hyperlight_common::log_level::GuestLogFilter;
 use hyperlight_common::mem::HyperlightPEB;
 #[cfg(feature = "mem_profile")]
 use hyperlight_common::outb::OutBAction;
 use hyperlight_guest::exit::write_abort;
 use hyperlight_guest::guest_handle::handle::GuestHandle;
-use log::LevelFilter;
 
 // === Modules ===
 #[cfg_attr(target_arch = "x86_64", path = "arch/amd64/mod.rs")]
@@ -215,15 +215,17 @@ pub(crate) extern "C" fn generic_init(
     }
 
     // set up the logger
-    let max_log_level = LevelFilter::iter()
-        .nth(max_log_level as usize)
-        .expect("Invalid log level");
-    init_logger(max_log_level);
+    let guest_log_level_filter =
+        GuestLogFilter::try_from(max_log_level).expect("Invalid log level");
+    init_logger(guest_log_level_filter.into());
 
     // It is important that all the tracing events are produced after the tracing is initialized.
     #[cfg(feature = "trace_guest")]
-    if max_log_level != LevelFilter::Off {
-        hyperlight_guest_tracing::init_guest_tracing(guest_start_tsc);
+    if guest_log_level_filter != GuestLogFilter::Off {
+        hyperlight_guest_tracing::init_guest_tracing(
+            guest_start_tsc,
+            guest_log_level_filter.into(),
+        );
     }
 
     // Open a span to partly capture the initialization of the guest.

src/hyperlight_guest_bin/src/lib.rs

@@ -48,6 +48,7 @@ mod trace {
     use alloc::sync::{Arc, Weak};
 
     use spin::Mutex;
+    use tracing_core::LevelFilter;
 
     use crate::state::GuestState;
     use crate::subscriber::GuestSubscriber;
@@ -61,12 +62,12 @@ mod trace {
     static GUEST_STATE: spin::Once<Weak<Mutex<GuestState>>> = spin::Once::new();
 
     /// Initialize the guest tracing subscriber as global default.
-    pub fn init_guest_tracing(guest_start_tsc: u64) {
+    pub fn init_guest_tracing(guest_start_tsc: u64, max_log_level: LevelFilter) {
         // Set as global default if not already set.
         if tracing_core::dispatcher::has_been_set() {
             return;
         }
-        let sub = GuestSubscriber::new(guest_start_tsc);
+        let sub = GuestSubscriber::new(guest_start_tsc, max_log_level);
         let state = sub.state();
         // Store state Weak<GuestState> to use later at runtime
         GUEST_STATE.call_once(|| Arc::downgrade(state));