[trace-guest] remove unwind_guest feature

- This feature is not used separate from the mem_profile
- All the unwind logic is now gated by mem_profile

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

Author: dblnz

Justfile

@@ -234,7 +234,7 @@ check:
     {{ cargo-cmd }} check -p hyperlight-host --features crashdump  {{ target-triple-flag }}
     {{ cargo-cmd }} check -p hyperlight-host --features print_debug  {{ target-triple-flag }}
     {{ cargo-cmd }} check -p hyperlight-host --features gdb  {{ target-triple-flag }}
-    {{ cargo-cmd }} check -p hyperlight-host --features trace_guest,unwind_guest,mem_profile  {{ target-triple-flag }}
+    {{ cargo-cmd }} check -p hyperlight-host --features trace_guest,mem_profile  {{ target-triple-flag }}
 
 fmt-check:
     cargo +nightly fmt --all -- --check

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

@@ -94,12 +94,11 @@ Once the container or the exe is running, the trace output can be viewed in the
 
 ## 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.
+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` and `mem_profile` features. This section explains how to build, run, and inspect guest traces.
 
 The following features are available for guest tracing:
 - `trace_guest`: Enables tracing for guest code, capturing function calls and execution time.
-- `unwind_guest`: Enables stack unwinding for guest code, allowing you to capture stack traces.
-- `mem_profile`: Enables memory profiling for guest code, capturing memory allocations and usage.
+- `mem_profile`: Enables memory profiling for guest code with stack uwinding, capturing memory allocations and usage.
 
 ### Building a Guest with Tracing Support
 
@@ -140,7 +139,7 @@ This command will list the stack frames and tracing information captured during
 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.
+You can use the `mem_profile` additional feature by enabling them during the build and run steps.
 
 > **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.
 

src/hyperlight_common/Cargo.toml

@@ -26,7 +26,6 @@ spin = "0.10.0"
 default = ["tracing"]
 fuzzing = ["dep:arbitrary"]
 trace_guest = []
-unwind_guest = []
 mem_profile = []
 std = []
 

src/hyperlight_common/src/outb.rs

@@ -99,7 +99,7 @@ pub enum OutBAction {
     CallFunction = 101,
     Abort = 102,
     DebugPrint = 103,
-    #[cfg(feature = "unwind_guest")]
+    #[cfg(feature = "mem_profile")]
     TraceRecordStack = 104,
     #[cfg(feature = "mem_profile")]
     TraceMemoryAlloc = 105,
@@ -117,7 +117,7 @@ impl TryFrom<u16> for OutBAction {
             101 => Ok(OutBAction::CallFunction),
             102 => Ok(OutBAction::Abort),
             103 => Ok(OutBAction::DebugPrint),
-            #[cfg(feature = "unwind_guest")]
+            #[cfg(feature = "mem_profile")]
             104 => Ok(OutBAction::TraceRecordStack),
             #[cfg(feature = "mem_profile")]
             105 => Ok(OutBAction::TraceMemoryAlloc),

src/hyperlight_guest_bin/Cargo.toml

@@ -18,7 +18,7 @@ default = ["libc", "printf"]
 libc = [] # compile musl libc
 printf = [ "libc" ] # compile printf
 trace_guest = ["hyperlight-common/trace_guest", "hyperlight-guest/trace_guest", "hyperlight-guest-tracing/trace"]
-mem_profile = ["hyperlight-common/unwind_guest","hyperlight-common/mem_profile"]
+mem_profile = ["hyperlight-common/mem_profile"]
 
 [dependencies]
 hyperlight-guest = { workspace = true, default-features = false }

src/hyperlight_host/Cargo.toml

@@ -133,10 +133,7 @@ print_debug = []
 # Dumps the VM state to a file on unexpected errors or crashes. The path of the file will be printed on stdout and logged.
 crashdump = ["dep:chrono"]
 trace_guest = ["hyperlight-common/trace_guest", "hyperlight-guest-tracing/trace"]
-# This feature enables unwinding the guest stack from the host, in
-# order to produce stack traces for debugging or profiling.
-unwind_guest = [ "trace_guest", "dep:framehop", "dep:fallible-iterator", "hyperlight-common/unwind_guest" ]
-mem_profile = [ "unwind_guest", "hyperlight-common/mem_profile" ]
+mem_profile = [ "trace_guest", "dep:framehop", "dep:fallible-iterator", "hyperlight-common/mem_profile" ]
 kvm = ["dep:kvm-bindings", "dep:kvm-ioctls"]
 # This feature is deprecated in favor of mshv3
 mshv2 = ["dep:mshv-bindings2", "dep:mshv-ioctls2"]

src/hyperlight_host/src/hypervisor/hyperv_linux.rs

@@ -1121,7 +1121,7 @@ impl Drop for HypervLinuxDriver {
 #[cfg(test)]
 mod tests {
     use super::*;
-    #[cfg(feature = "unwind_guest")]
+    #[cfg(feature = "mem_profile")]
     use crate::mem::exe::DummyUnwindInfo;
     use crate::mem::memory_region::MemoryRegionVecBuilder;
     use crate::mem::shared_mem::{ExclusiveSharedMemory, SharedMemory};
@@ -1192,7 +1192,7 @@ mod tests {
             },
             #[cfg(feature = "trace_guest")]
             TraceInfo::new(
-                #[cfg(feature = "unwind_guest")]
+                #[cfg(feature = "mem_profile")]
                 Arc::new(DummyUnwindInfo {}),
             )
             .unwrap(),

src/hyperlight_host/src/mem/elf.rs

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 use std::sync::Arc;
 
 #[cfg(target_arch = "aarch64")]
@@ -29,7 +29,7 @@ use goblin::elf64::program_header::PT_LOAD;
 
 use crate::{Result, log_then_return, new_error};
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 struct ResolvedSectionHeader {
     name: String,
     addr: u64,
@@ -40,13 +40,13 @@ struct ResolvedSectionHeader {
 pub(crate) struct ElfInfo {
     payload: Vec<u8>,
     phdrs: ProgramHeaders,
-    #[cfg(feature = "unwind_guest")]
+    #[cfg(feature = "mem_profile")]
     shdrs: Vec<ResolvedSectionHeader>,
     entry: u64,
     relocs: Vec<Reloc>,
 }
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 struct UnwindInfo {
     payload: Vec<u8>,
     load_addr: u64,
@@ -55,7 +55,7 @@ struct UnwindInfo {
     shdrs: Vec<ResolvedSectionHeader>,
 }
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 impl super::exe::UnwindInfo for UnwindInfo {
     fn as_module(&self) -> framehop::Module<Vec<u8>> {
         framehop::Module::new(
@@ -72,7 +72,7 @@ impl super::exe::UnwindInfo for UnwindInfo {
     }
 }
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 impl UnwindInfo {
     fn resolved_section_header(&self, name: &[u8]) -> Option<&ResolvedSectionHeader> {
         self.shdrs
@@ -81,7 +81,7 @@ impl UnwindInfo {
     }
 }
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 impl framehop::ModuleSectionInfo<Vec<u8>> for &UnwindInfo {
     fn base_svma(&self) -> u64 {
         self.base_svma
@@ -122,7 +122,7 @@ impl ElfInfo {
         Ok(ElfInfo {
             payload: bytes.to_vec(),
             phdrs: elf.program_headers,
-            #[cfg(feature = "unwind_guest")]
+            #[cfg(feature = "mem_profile")]
             shdrs: elf
                 .section_headers
                 .iter()
@@ -206,7 +206,7 @@ impl ElfInfo {
             }
         }
         cfg_if::cfg_if! {
-            if #[cfg(feature = "unwind_guest")] {
+            if #[cfg(feature = "mem_profile")] {
                 let va_size = self.get_va_size() as u64;
                 let base_svma = self.get_base_va();
                 Ok(Arc::new(UnwindInfo {

src/hyperlight_host/src/mem/exe.rs

@@ -16,7 +16,7 @@ limitations under the License.
 
 use std::fs::File;
 use std::io::Read;
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 use std::sync::Arc;
 use std::vec::Vec;
 
@@ -39,15 +39,15 @@ pub enum ExeInfo {
 const DEFAULT_ELF_STACK_RESERVE: u64 = 65536;
 const DEFAULT_ELF_HEAP_RESERVE: u64 = 131072;
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 pub(crate) trait UnwindInfo: Send + Sync {
     fn as_module(&self) -> framehop::Module<Vec<u8>>;
     fn hash(&self) -> blake3::Hash;
 }
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 pub(crate) struct DummyUnwindInfo {}
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 impl UnwindInfo for DummyUnwindInfo {
     fn as_module(&self) -> framehop::Module<Vec<u8>> {
         framehop::Module::new("unsupported".to_string(), 0..0, 0, self)
@@ -56,7 +56,7 @@ impl UnwindInfo for DummyUnwindInfo {
         blake3::Hash::from_bytes([0; 32])
     }
 }
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 impl<A> framehop::ModuleSectionInfo<A> for &DummyUnwindInfo {
     fn base_svma(&self) -> u64 {
         0
@@ -69,9 +69,9 @@ impl<A> framehop::ModuleSectionInfo<A> for &DummyUnwindInfo {
     }
 }
 
-#[cfg(feature = "unwind_guest")]
+#[cfg(feature = "mem_profile")]
 pub(crate) type LoadInfo = Arc<dyn UnwindInfo>;
-#[cfg(not(feature = "unwind_guest"))]
+#[cfg(not(feature = "mem_profile"))]
 pub(crate) type LoadInfo = ();
 
 impl ExeInfo {

src/hyperlight_host/src/mem/mgr.rs

@@ -347,7 +347,7 @@ impl SandboxMemoryManager<ExclusiveSharedMemory> {
         }
 
         // The load method returns a LoadInfo which can also be a different type once the
-        // `unwind_guest` feature is enabled.
+        // `mem_profile` feature is enabled.
         #[allow(clippy::let_unit_value)]
         let load_info = exe_info.load(
             load_addr.clone().try_into()?,