[WIP] Enable guest tracing

Cargo.toml

@@ -10,11 +10,14 @@ members = [
     "src/hyperlight_guest",
     "src/hyperlight_host",
     "src/hyperlight_guest_capi",
+    "src/hyperlight_guest_tracing",
+    "src/hyperlight_guest_tracing_macro",
     "src/hyperlight_testing",
     "fuzz",
     "src/hyperlight_guest_bin",
     "src/hyperlight_component_util",
     "src/hyperlight_component_macro",
+    "src/trace_dump",
 ]
 # Guests have custom linker flags, so we need to exclude them from the workspace
 exclude = [
@@ -39,6 +42,8 @@ hyperlight-host = { path = "src/hyperlight_host", version = "0.7.0", default-fea
 hyperlight-guest = { path = "src/hyperlight_guest", version = "0.7.0", default-features = false }
 hyperlight-guest-bin = { path = "src/hyperlight_guest_bin", version = "0.7.0", default-features = false }
 hyperlight-testing = { path = "src/hyperlight_testing", default-features = false }
+hyperlight-guest-tracing = { path = "src/hyperlight_guest_tracing", default-features = false }
+hyperlight-guest-tracing-macro = { path = "src/hyperlight_guest_tracing_macro", default-features = false }
 hyperlight-component-util = { path = "src/hyperlight_component_util", version = "0.7.0", default-features = false }
 hyperlight-component-macro = { path = "src/hyperlight_component_macro", version = "0.7.0", default-features = false }
 

Justfile

@@ -38,11 +38,11 @@ witguest-wit:
     cargo install --locked wasm-tools
     cd src/tests/rust_guests/witguest && wasm-tools component wit guest.wit -w -o interface.wasm
 
-build-rust-guests target=default-target: (witguest-wit)
-    cd src/tests/rust_guests/callbackguest && cargo build --profile={{ if target == "debug" { "dev" } else { target } }}
-    cd src/tests/rust_guests/simpleguest && cargo build --profile={{ if target == "debug" { "dev" } else { target } }} 
-    cd src/tests/rust_guests/dummyguest && cargo build --profile={{ if target == "debug" { "dev" } else { target } }} 
-    cd src/tests/rust_guests/witguest && cargo build --profile={{ if target == "debug" { "dev" } else { target } }}
+build-rust-guests target=default-target features="": (witguest-wit)
+    cd src/tests/rust_guests/callbackguest && cargo build {{ if features =="" {''} else if features=="no-default-features" {"--no-default-features" } else {"--no-default-features -F " + features } }} --profile={{ if target == "debug" { "dev" } else { target } }}
+    cd src/tests/rust_guests/simpleguest && cargo build {{ if features =="" {''} else if features=="no-default-features" {"--no-default-features" } else {"--no-default-features -F " + features } }} --profile={{ if target == "debug" { "dev" } else { target } }} 
+    cd src/tests/rust_guests/dummyguest && cargo build {{ if features =="" {''} else if features=="no-default-features" {"--no-default-features" } else {"--no-default-features -F " + features } }} --profile={{ if target == "debug" { "dev" } else { target } }} 
+    cd src/tests/rust_guests/witguest && cargo build {{ if features =="" {''} else if features=="no-default-features" {"--no-default-features" } else {"--no-default-features -F " + features } }} --profile={{ if target == "debug" { "dev" } else { target } }}
 
 @move-rust-guests target=default-target:
     cp {{ callbackguest_source }}/{{ target }}/callbackguest* {{ rust_guests_bin_dir }}/{{ target }}/

docs/hyperlight-metrics-logs-and-traces.md

@@ -91,3 +91,72 @@ NOTE: when running this on windows that this is a linux container, so you will n
 ```
 
 Once the container or the exe is running, the trace output can be viewed in the jaeger UI at [http://localhost:16686/search](http://localhost:16686/search).
+
+## Guest Tracing, Unwinding, and Memory Profiling
+
+Hyperlight provides advanced observability features for guest code running inside micro virtual machines. You can enable guest-side tracing, stack unwinding, and memory profiling using the `trace_guest`, `unwind_guest`, and `mem_profile` features. This section explains how to build, run, and inspect guest traces.
+
+### Building a Guest with Tracing Support
+
+To build a guest with tracing enabled, use the following commands:
+
+```bash
+just build-rust-guests debug trace_guest
+just move-rust-guests debug
+```
+
+This will build the guest binaries with the `trace_guest` feature enabled and move them to the appropriate location for use by the host.
+
+### Running a Hyperlight Example with Guest Tracing
+
+Once the guest is built, you can run a Hyperlight example with guest tracing enabled. For example:
+
+```bash
+cargo run --example hello-world --features trace_guest
+```
+
+This will execute the `hello-world` example, loading the guest with tracing enabled. During execution, trace data will be collected and written to a file in the `trace` directory.
+
+### Inspecting Guest Trace Files
+
+To inspect the trace file generated by the guest, use the `trace_dump` crate. You will need the path to the guest symbols and the trace file. Run the following command:
+
+```bash
+cargo run -p trace_dump <path_to_guest_symbols> <trace_file_path> list_frames
+```
+
+Replace `<path_to_guest_symbols>` with the path to the guest binary or symbol file, and `<trace_file_path>` with the path to the trace file in the `trace` directory.
+
+This command will list the stack frames and tracing information captured during guest execution, allowing you to analyze guest behavior, stack traces, and memory usage.
+
+#### Example
+
+```bash
+cargo run -p trace_dump ./src/tests/rust_guests/bin/debug/simpleguest ./trace/<UUID>.trace list_frames
+```
+
+You can use additional features such as `unwind_guest` and `mem_profile` by enabling them during the build and run steps. Refer to the guest and host documentation for more details on these features.
+
+> **Note:** Make sure to follow the build and run steps in order, and ensure that the guest binaries are up to date before running the host example.
+
+## System Prerequisites for `trace_dump`
+
+To build and use the `trace_dump` crate and related guest tracing features, you must have the following system libraries and development tools installed on your system:
+
+- **glib-2.0** development files  
+  - Fedora/RHEL/CentOS:  
+    ```bash
+    sudo dnf install glib2-devel pkgconf-pkg-config
+    ```
+- **cairo** and **cairo-gobject** development files  
+  - Fedora/RHEL/CentOS:  
+    ```bash
+    sudo dnf install cairo-devel cairo-gobject-devel
+    ```
+- **pango** development files  
+  - Fedora/RHEL/CentOS:  
+    ```bash
+    sudo dnf install pango-devel
+    ```
+
+These libraries are required by Rust crates such as `glib-sys`, `cairo-sys-rs`, and `pango-sys`, which are dependencies of the tracing and visualization tools. If you encounter errors about missing `.pc` files (e.g., `glib-2.0.pc`, `cairo.pc`, `pango.pc`), ensure the corresponding `-devel` packages are installed.

src/hyperlight_common/Cargo.toml

@@ -25,11 +25,14 @@ spin = "0.10.0"
 [features]
 default = ["tracing"]
 fuzzing = ["dep:arbitrary"]
+trace_guest = []
+unwind_guest = []
+mem_profile = []
 std = []
 
 [dev-dependencies]
 hyperlight-testing = { workspace = true }
 
 [lib]
 bench = false # see https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options
-doctest = false # reduce noise in test output
+doctest = false # reduce noise in test output

src/hyperlight_common/src/outb.rs

@@ -90,11 +90,23 @@ impl TryFrom<u8> for Exception {
 /// - CallFunction: makes a call to a host function,
 /// - Abort: aborts the execution of the guest,
 /// - DebugPrint: prints a message to the host
+/// - TraceRecordStack: records the stack trace of the guest
+/// - TraceMemoryAlloc: records memory allocation events
+/// - TraceMemoryFree: records memory deallocation events
+/// - TraceRecord: records a trace event in the guest
 pub enum OutBAction {
     Log = 99,
     CallFunction = 101,
     Abort = 102,
     DebugPrint = 103,
+    #[cfg(feature = "unwind_guest")]
+    TraceRecordStack = 104,
+    #[cfg(feature = "mem_profile")]
+    TraceMemoryAlloc = 105,
+    #[cfg(feature = "mem_profile")]
+    TraceMemoryFree = 106,
+    #[cfg(feature = "trace_guest")]
+    TraceRecord = 107,
 }
 
 impl TryFrom<u16> for OutBAction {
@@ -105,6 +117,14 @@ impl TryFrom<u16> for OutBAction {
             101 => Ok(OutBAction::CallFunction),
             102 => Ok(OutBAction::Abort),
             103 => Ok(OutBAction::DebugPrint),
+            #[cfg(feature = "unwind_guest")]
+            104 => Ok(OutBAction::TraceRecordStack),
+            #[cfg(feature = "mem_profile")]
+            105 => Ok(OutBAction::TraceMemoryAlloc),
+            #[cfg(feature = "mem_profile")]
+            106 => Ok(OutBAction::TraceMemoryFree),
+            #[cfg(feature = "trace_guest")]
+            107 => Ok(OutBAction::TraceRecord),
             _ => Err(anyhow::anyhow!("Invalid OutBAction value: {}", val)),
         }
     }

src/hyperlight_guest/Cargo.toml

@@ -15,3 +15,9 @@ Provides only the essential building blocks for interacting with the host enviro
 anyhow = { version = "1.0.98", default-features = false }
 serde_json = { version = "1.0", default-features = false, features = ["alloc"] }
 hyperlight-common = { workspace = true }
+hyperlight-guest-tracing = { workspace = true, optional = true }
+hyperlight-guest-tracing-macro = { workspace = true}
+
+[features]
+default = []
+trace_guest = ["dep:hyperlight-guest-tracing"]

src/hyperlight_guest/src/exit.rs

@@ -21,17 +21,22 @@ use hyperlight_common::outb::OutBAction;
 
 /// Halt the execution of the guest and returns control to the host.
 #[inline(never)]
+#[hyperlight_guest_tracing_macro::trace_function]
 pub fn halt() {
+    // Ensure all tracing data is flushed before halting
+    hyperlight_guest_tracing_macro::flush!();
     unsafe { asm!("hlt", options(nostack)) }
 }
 
 /// Exits the VM with an Abort OUT action and code 0.
 #[unsafe(no_mangle)]
+#[hyperlight_guest_tracing_macro::trace_function]
 pub extern "C" fn abort() -> ! {
     abort_with_code(&[0, 0xFF])
 }
 
 /// Exits the VM with an Abort OUT action and a specific code.
+#[hyperlight_guest_tracing_macro::trace_function]
 pub fn abort_with_code(code: &[u8]) -> ! {
     outb(OutBAction::Abort as u16, code);
     outb(OutBAction::Abort as u16, &[0xFF]); // send abort terminator (if not included in code)
@@ -42,6 +47,7 @@ pub fn abort_with_code(code: &[u8]) -> ! {
 ///
 /// # Safety
 /// This function is unsafe because it dereferences a raw pointer.
+#[hyperlight_guest_tracing_macro::trace_function]
 pub unsafe fn abort_with_code_and_message(code: &[u8], message_ptr: *const c_char) -> ! {
     unsafe {
         // Step 1: Send abort code (typically 1 byte, but `code` allows flexibility)
@@ -62,7 +68,10 @@ pub unsafe fn abort_with_code_and_message(code: &[u8], message_ptr: *const c_cha
 }
 
 /// OUT bytes to the host through multiple exits.
+#[hyperlight_guest_tracing_macro::trace_function]
 pub(crate) fn outb(port: u16, data: &[u8]) {
+    // Ensure all tracing data is flushed before sending OUT bytes
+    hyperlight_guest_tracing_macro::flush!();
     unsafe {
         let mut i = 0;
         while i < data.len() {
@@ -79,6 +88,7 @@ pub(crate) fn outb(port: u16, data: &[u8]) {
 }
 
 /// OUT function for sending a 32-bit value to the host.
+#[hyperlight_guest_tracing_macro::trace_function]
 pub(crate) unsafe fn out32(port: u16, val: u32) {
     unsafe {
         asm!("out dx, eax", in("dx") port, in("eax") val, options(preserves_flags, nomem, nostack));

src/hyperlight_guest/src/guest_handle/host_comm.rs

@@ -35,6 +35,7 @@ use crate::exit::out32;
 
 impl GuestHandle {
     /// Get user memory region as bytes.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn read_n_bytes_from_user_memory(&self, num: u64) -> Result<Vec<u8>> {
         let peb_ptr = self.peb().unwrap();
         let user_memory_region_ptr = unsafe { (*peb_ptr).init_data.ptr as *mut u8 };
@@ -63,6 +64,7 @@ impl GuestHandle {
     ///
     /// When calling `call_host_function<T>`, this function is called
     /// internally to get the return value.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn get_host_return_value<T: TryFrom<ReturnValue>>(&self) -> Result<T> {
         let return_value = self
             .try_pop_shared_input_data_into::<ReturnValue>()
@@ -83,6 +85,7 @@ impl GuestHandle {
     ///
     /// Note: The function return value must be obtained by calling
     /// `get_host_return_value`.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn call_host_function_without_returning_result(
         &self,
         function_name: &str,
@@ -114,6 +117,7 @@ impl GuestHandle {
     /// sends it to the host, and then retrieves the return value.
     ///
     /// The return value is deserialized into the specified type `T`.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn call_host_function<T: TryFrom<ReturnValue>>(
         &self,
         function_name: &str,
@@ -124,6 +128,7 @@ impl GuestHandle {
         self.get_host_return_value::<T>()
     }
 
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn get_host_function_details(&self) -> HostFunctionDetails {
         let peb_ptr = self.peb().unwrap();
         let host_function_details_buffer =
@@ -140,6 +145,7 @@ impl GuestHandle {
     }
 
     /// Write an error to the shared output data buffer.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn write_error(&self, error_code: ErrorCode, message: Option<&str>) {
         let guest_error: GuestError = GuestError::new(
             error_code.clone(),
@@ -155,6 +161,7 @@ impl GuestHandle {
     }
 
     /// Log a message with the specified log level, source, caller, source file, and line number.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn log_message(
         &self,
         log_level: LogLevel,

src/hyperlight_guest/src/guest_handle/io.rs

@@ -27,6 +27,7 @@ use crate::error::{HyperlightGuestError, Result};
 
 impl GuestHandle {
     /// Pops the top element from the shared input data buffer and returns it as a T
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn try_pop_shared_input_data_into<T>(&self) -> Result<T>
     where
         T: for<'a> TryFrom<&'a [u8]>,
@@ -68,6 +69,7 @@ impl GuestHandle {
         let buffer = &idb[last_element_offset_rel as usize..];
 
         // convert the buffer to T
+        hyperlight_guest_tracing_macro::trace!("Start converting buffer");
         let type_t = match T::try_from(buffer) {
             Ok(t) => Ok(t),
             Err(_e) => {
@@ -77,6 +79,7 @@ impl GuestHandle {
                 ));
             }
         };
+        hyperlight_guest_tracing_macro::trace!("Finish converting buffer");
 
         // update the stack pointer to point to the element we just popped of since that is now free
         idb[..8].copy_from_slice(&last_element_offset_rel.to_le_bytes());
@@ -88,6 +91,7 @@ impl GuestHandle {
     }
 
     /// Pushes the given data onto the shared output data buffer.
+    #[hyperlight_guest_tracing_macro::trace_function]
     pub fn push_shared_output_data(&self, data: Vec<u8>) -> Result<()> {
         let peb_ptr = self.peb().unwrap();
         let output_stack_size = unsafe { (*peb_ptr).output_stack.size as usize };
@@ -133,7 +137,9 @@ impl GuestHandle {
         }
 
         // write the actual data
+        hyperlight_guest_tracing_macro::trace!("Start copy of data");
         odb[stack_ptr_rel as usize..stack_ptr_rel as usize + data.len()].copy_from_slice(&data);
+        hyperlight_guest_tracing_macro::trace!("Finish copy of data");
 
         // write the offset to the newly written data, to the top of the stack
         let bytes: [u8; 8] = stack_ptr_rel.to_le_bytes();

src/hyperlight_guest_bin/Cargo.toml

@@ -17,10 +17,14 @@ and third-party code used by our C-API needed to build a native hyperlight-guest
 default = ["libc", "printf"]
 libc = [] # compile musl libc
 printf = [] # compile printf
+trace_guest = ["hyperlight-common/trace_guest", "dep:hyperlight-guest-tracing", "hyperlight-guest/trace_guest"]
+mem_profile = ["hyperlight-common/unwind_guest","hyperlight-common/mem_profile"]
 
 [dependencies]
 hyperlight-guest = { workspace = true, default-features = false }
 hyperlight-common = { workspace = true, default-features = false }
+hyperlight-guest-tracing = { workspace = true, optional = true }
+hyperlight-guest-tracing-macro = { workspace = true }
 buddy_system_allocator = "0.11.0"
 log = { version = "0.4", default-features = false }
 spin = "0.10.0"

src/hyperlight_guest_bin/src/exceptions/gdt.rs

@@ -72,6 +72,7 @@ struct GdtPointer {
 }
 
 /// Load the GDT
+#[hyperlight_guest_tracing_macro::trace_function]
 pub unsafe fn load_gdt() {
     unsafe {
         let gdt_ptr = GdtPointer {

src/hyperlight_guest_bin/src/exceptions/handler.rs

@@ -62,6 +62,7 @@ type handler_t = fn(n: u64, info: *mut ExceptionInfo, ctx: *mut Context, pf_addr
 
 /// Exception handler
 #[unsafe(no_mangle)]
+#[hyperlight_guest_tracing_macro::trace_function]
 pub extern "C" fn hl_exception_handler(
     stack_pointer: u64,
     exception_number: u64,

src/hyperlight_guest_bin/src/exceptions/idt.rs

@@ -71,6 +71,7 @@ impl IdtEntry {
 // Architectures Software Developer's Manual).
 pub(crate) static mut IDT: [IdtEntry; 256] = unsafe { core::mem::zeroed() };
 
+#[hyperlight_guest_tracing_macro::trace_function]
 pub(crate) fn init_idt() {
     set_idt_entry(Exception::DivideByZero as usize, _do_excp0); // Divide by zero
     set_idt_entry(Exception::Debug as usize, _do_excp1); // Debug

src/hyperlight_guest_bin/src/exceptions/idtr.rs

@@ -40,6 +40,7 @@ impl Idtr {
     }
 }
 
+#[hyperlight_guest_tracing_macro::trace_function]
 pub(crate) unsafe fn load_idt() {
     unsafe {
         init_idt();