[trace] remove old tracing functionality

- This steps cleans up codebase for the new way of tracing guests
- The current method involves custom macros and logic that are not
the best for maintainability

Signed-off-by: Doru Blânzeanu <[email protected]>

Author: dblnz

.github/workflows/CargoPublish.yml

@@ -45,7 +45,7 @@ jobs:
             VERSION="${VERSION#refs/heads/release/v}"
             echo "VERSION=$VERSION" >> $GITHUB_ENV
           fi
-          ./dev/verify-version.sh "$VERSION" hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro hyperlight-guest-tracing-macro hyperlight-guest-tracing
+          ./dev/verify-version.sh "$VERSION" hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro hyperlight-guest-tracing
 
       - name: Determine which crates need publishing
         run: |
@@ -74,7 +74,6 @@ jobs:
           needs_publish hyperlight-component-util
           needs_publish hyperlight-component-macro
           needs_publish hyperlight-host
-          needs_publish hyperlight-guest-tracing-macro
           needs_publish hyperlight-guest-tracing
 
       - name: Publish hyperlight-common
@@ -84,13 +83,6 @@ jobs:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }}
         if: env.PUBLISH_HYPERLIGHT_COMMON != 'false'
 
-      - name: Publish hyperlight-guest-tracing-macro
-        continue-on-error: ${{ inputs.dry_run }}
-        run: cargo publish --manifest-path ./src/hyperlight_guest_tracing_macro/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}
-        env:
-          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_PUBLISH_TOKEN }}
-        if: env.PUBLISH_HYPERLIGHT_GUEST_TRACING_MACRO != 'false'
-
       - name: Publish hyperlight-guest-tracing
         continue-on-error: ${{ inputs.dry_run }}
         run: cargo publish --manifest-path ./src/hyperlight_guest_tracing/Cargo.toml ${{ inputs.dry_run && '--dry-run' || '' }}

Cargo.lock

@@ -11,7 +11,6 @@ members = [
     "src/hyperlight_host",
     "src/hyperlight_guest_capi",
     "src/hyperlight_guest_tracing",
-    "src/hyperlight_guest_tracing_macro",
     "src/hyperlight_testing",
     "fuzz",
     "src/hyperlight_guest_bin",
@@ -42,7 +41,6 @@ hyperlight-guest = { path = "src/hyperlight_guest", version = "0.10.0", default-
 hyperlight-guest-bin = { path = "src/hyperlight_guest_bin", version = "0.10.0", default-features = false }
 hyperlight-testing = { path = "src/hyperlight_testing", default-features = false }
 hyperlight-guest-tracing = { path = "src/hyperlight_guest_tracing", version = "0.10.0", default-features = false }
-hyperlight-guest-tracing-macro = { path = "src/hyperlight_guest_tracing_macro", version = "0.10.0", default-features = false }
 hyperlight-component-util = { path = "src/hyperlight_component_util", version = "0.10.0", default-features = false }
 hyperlight-component-macro = { path = "src/hyperlight_component_macro", version = "0.10.0", default-features = false }
 

Cargo.toml

@@ -110,7 +110,7 @@ like-ci config=default-target hypervisor="kvm":
     {{ if os() == "linux" { "just clippy-exhaustive " + config } else { "" } }}
 
     @# Verify MSRV
-    ./dev/verify-msrv.sh hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro hyperlight-guest-tracing-macro hyperlight-guest-tracing
+    ./dev/verify-msrv.sh hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro hyperlight-guest-tracing
 
     @# Build and move Rust guests
     just build-rust-guests {{config}}
@@ -200,22 +200,10 @@ test-rust-crashdump target=default-target features="":
 test-rust-tracing target=default-target features="":
     # Run tests for the tracing guest and macro
     {{ cargo-cmd }} test -p hyperlight-guest-tracing --profile={{ if target == "debug" { "dev" } else { target } }}  {{ target-triple-flag }}
-    {{ cargo-cmd }} test -p hyperlight-guest-tracing-macro --profile={{ if target == "debug" { "dev" } else { target } }}  {{ target-triple-flag }}
 
-    # Prepare the tracing guest for testing
+    # Build the tracing guest to ensure it builds with the tracing feature
     just build-rust-guests {{ target }} trace_guest
     just move-rust-guests {{ target }}
-    # Run hello-world example with tracing enabled to get the trace output
-    # note that trace-dump doesn't run on MUSL target as of now
-    TRACE_OUTPUT="$({{ cargo-cmd }} run --profile={{ if target == "debug" { "dev" } else { target } }} {{ target-triple-flag }} --example hello-world --features {{ if features =="" {"trace_guest"} else { "trace_guest," + features } }})" && \
-        TRACE_FILE="$(echo "$TRACE_OUTPUT" | grep -oE 'Creating trace file at: [^ ]+' | awk -F': ' '{print $2}')" && \
-        TRACE_FILE="$(echo "$TRACE_OUTPUT" | grep -oE 'Creating trace file at: [^ ]+' | awk -F': ' '{print $2}' | sed -E 's|^(trace/[^ ]+\.trace)$|./\1|; s|.*/(trace/[^ ]+\.trace)$|./\1|')" && \
-        echo "$TRACE_OUTPUT" && \
-        if [ -z "$TRACE_FILE" ]; then \
-            echo "Error: Could not extract trace file path from output." >&2 ; \
-            exit 1 ; \
-        fi && \
-        cargo run -p trace_dump ./{{ simpleguest_source }}/{{ target }}/simpleguest "$TRACE_FILE" list_frames
 
     # Rebuild the tracing guests without the tracing feature
     # This is to ensure that the tracing feature does not affect the other tests
@@ -275,7 +263,6 @@ clippy-exhaustive target=default-target: (witguest-wit)
     ./hack/clippy-package-features.sh hyperlight-testing {{ target }} {{ target-triple }}
     ./hack/clippy-package-features.sh hyperlight-component-macro  {{ target }} {{ target-triple }}
     ./hack/clippy-package-features.sh hyperlight-component-util {{ target }} {{ target-triple }}
-    ./hack/clippy-package-features.sh hyperlight-guest-tracing-macro {{ target }}
     ./hack/clippy-package-features.sh hyperlight-guest-tracing {{ target }}
     just clippy-guests {{ target }}
 
@@ -285,7 +272,7 @@ clippy-package package target=default-target: (witguest-wit)
 
 # Verify Minimum Supported Rust Version
 verify-msrv:
-    ./dev/verify-msrv.sh hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro hyperlight-guest-tracing-macro hyperlight-guest-tracing
+    ./dev/verify-msrv.sh hyperlight-common hyperlight-guest hyperlight-guest-bin hyperlight-host hyperlight-component-util hyperlight-component-macro hyperlight-guest-tracing
 
 #####################
 ### RUST EXAMPLES ###

Justfile

@@ -92,14 +92,11 @@ impl TryFrom<u8> for Exception {
 /// - DebugPrint: prints a message to the host
 /// - 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 = "trace_guest")]
-    TraceRecord = 104,
     #[cfg(feature = "mem_profile")]
     TraceMemoryAlloc = 105,
     #[cfg(feature = "mem_profile")]
@@ -114,8 +111,6 @@ impl TryFrom<u16> for OutBAction {
             101 => Ok(OutBAction::CallFunction),
             102 => Ok(OutBAction::Abort),
             103 => Ok(OutBAction::DebugPrint),
-            #[cfg(feature = "trace_guest")]
-            104 => Ok(OutBAction::TraceRecord),
             #[cfg(feature = "mem_profile")]
             105 => Ok(OutBAction::TraceMemoryAlloc),
             #[cfg(feature = "mem_profile")]

src/hyperlight_common/src/outb.rs

@@ -21,22 +21,17 @@ use hyperlight_common::outb::OutBAction;
 
 /// Halt the execution of the guest and returns control to the host.
 #[inline(never)]
-#[hyperlight_guest_tracing::trace_function]
 pub fn halt() {
-    // Ensure all tracing data is flushed before halting
-    hyperlight_guest_tracing::flush!();
     unsafe { asm!("hlt", options(nostack)) }
 }
 
 /// Exits the VM with an Abort OUT action and code 0.
 #[unsafe(no_mangle)]
-#[hyperlight_guest_tracing::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::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)
@@ -47,7 +42,6 @@ pub fn abort_with_code(code: &[u8]) -> ! {
 ///
 /// # Safety
 /// This function is unsafe because it dereferences a raw pointer.
-#[hyperlight_guest_tracing::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)
@@ -76,10 +70,8 @@ pub fn write_abort(code: &[u8]) {
 }
 
 /// OUT bytes to the host through multiple exits.
-#[hyperlight_guest_tracing::trace_function]
 pub(crate) fn outb(port: u16, data: &[u8]) {
     // Ensure all tracing data is flushed before sending OUT bytes
-    hyperlight_guest_tracing::flush!();
     unsafe {
         let mut i = 0;
         while i < data.len() {
@@ -96,7 +88,6 @@ pub(crate) fn outb(port: u16, data: &[u8]) {
 }
 
 /// OUT function for sending a 32-bit value to the host.
-#[hyperlight_guest_tracing::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/exit.rs

@@ -37,7 +37,6 @@ use crate::exit::out32;
 
 impl GuestHandle {
     /// Get user memory region as bytes.
-    #[hyperlight_guest_tracing::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 };
@@ -66,7 +65,6 @@ impl GuestHandle {
     ///
     /// When calling `call_host_function<T>`, this function is called
     /// internally to get the return value.
-    #[hyperlight_guest_tracing::trace_function]
     pub fn get_host_return_value<T: TryFrom<ReturnValue>>(&self) -> Result<T> {
         let inner = self
             .try_pop_shared_input_data_into::<FunctionCallResult>()
@@ -93,7 +91,6 @@ impl GuestHandle {
     ///
     /// Note: The function return value must be obtained by calling
     /// `get_host_return_value`.
-    #[hyperlight_guest_tracing::trace_function]
     pub fn call_host_function_without_returning_result(
         &self,
         function_name: &str,
@@ -127,7 +124,6 @@ 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::trace_function]
     pub fn call_host_function<T: TryFrom<ReturnValue>>(
         &self,
         function_name: &str,
@@ -138,7 +134,6 @@ impl GuestHandle {
         self.get_host_return_value::<T>()
     }
 
-    #[hyperlight_guest_tracing::trace_function]
     pub fn get_host_function_details(&self) -> HostFunctionDetails {
         let peb_ptr = self.peb().unwrap();
         let host_function_details_buffer =
@@ -155,7 +150,6 @@ impl GuestHandle {
     }
 
     /// Log a message with the specified log level, source, caller, source file, and line number.
-    #[hyperlight_guest_tracing::trace_function]
     pub fn log_message(
         &self,
         log_level: LogLevel,

src/hyperlight_guest/src/guest_handle/host_comm.rs

@@ -26,7 +26,6 @@ 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::trace_function]
     pub fn try_pop_shared_input_data_into<T>(&self) -> Result<T>
     where
         T: for<'a> TryFrom<&'a [u8]>,
@@ -68,18 +67,15 @@ impl GuestHandle {
         let buffer = &idb[last_element_offset_rel as usize..];
 
         // convert the buffer to T
-        let type_t = hyperlight_guest_tracing::trace!(
-            "convert buffer",
-            match T::try_from(buffer) {
-                Ok(t) => Ok(t),
-                Err(_e) => {
-                    return Err(HyperlightGuestError::new(
-                        ErrorCode::GuestError,
-                        format!("Unable to convert buffer to {}", type_name::<T>()),
-                    ));
-                }
+        let type_t = match T::try_from(buffer) {
+            Ok(t) => Ok(t),
+            Err(_e) => {
+                return Err(HyperlightGuestError::new(
+                    ErrorCode::GuestError,
+                    format!("Unable to convert buffer to {}", type_name::<T>()),
+                ));
             }
-        );
+        };
 
         // 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());
@@ -91,7 +87,6 @@ impl GuestHandle {
     }
 
     /// Pushes the given data onto the shared output data buffer.
-    #[hyperlight_guest_tracing::trace_function]
     pub fn push_shared_output_data(&self, data: &[u8]) -> Result<()> {
         let peb_ptr = self.peb().unwrap();
         let output_stack_size = unsafe { (*peb_ptr).output_stack.size as usize };
@@ -137,9 +132,7 @@ impl GuestHandle {
         }
 
         // write the actual data
-        hyperlight_guest_tracing::trace!("copy data", {
-            odb[stack_ptr_rel as usize..stack_ptr_rel as usize + data.len()].copy_from_slice(data);
-        });
+        odb[stack_ptr_rel as usize..stack_ptr_rel as usize + data.len()].copy_from_slice(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/src/guest_handle/io.rs

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

src/hyperlight_guest_bin/src/exceptions/gdt.rs

@@ -65,12 +65,6 @@ pub extern "C" fn hl_exception_handler(
     exception_number: u64,
     page_fault_address: u64,
 ) {
-    // When using the `trace_function` macro, it wraps the function body with create_trace_record
-    // call, which generates a warning because of the `abort_with_code_and_message` call which does
-    // not return.
-    // This is manually added to avoid the warning.
-    hyperlight_guest_tracing::trace!("> hl_exception_handler");
-
     let ctx = stack_pointer as *mut Context;
     let exn_info = (stack_pointer + size_of::<Context>() as u64) as *mut ExceptionInfo;
 
@@ -101,7 +95,6 @@ pub extern "C" fn hl_exception_handler(
                 )(exception_number, exn_info, ctx, page_fault_address)
             }
         {
-            hyperlight_guest_tracing::trace!("< hl_exception_handler");
             return;
         }
     }