Rename cargo feature 'dump_on_crash' to 'crashdump' and alias with debug_assertions

Signed-off-by: Ludvig Liljenberg <[email protected]>

Author: ludfjig

docs/debugging-hyperlight.md

@@ -39,6 +39,6 @@ cargo test --package hyperlight-host --test integration_test --features print_de
 
 ## Dumping the memory configuration, virtual processor register state and memory contents on a crash or unexpected VM Exit
 
-To dump the details of the memory configuration, the virtual processors register state and the contents of the VM memory set the feature `dump_on_crash` and run a debug build. This will result in a dump file being created in the temporary directory. The name and location of the dump file will be printed to the console and logged as an error message.
+To dump the details of the memory configuration, the virtual processors register state and the contents of the VM memory set the feature `crashdump` and run a debug build. This will result in a dump file being created in the temporary directory. The name and location of the dump file will be printed to the console and logged as an error message.
 
 There are no tools at this time to analyze the dump file, but it can be useful for debugging.

src/hyperlight_host/Cargo.toml

@@ -118,9 +118,7 @@ function_call_metrics = []
 executable_heap = []
 # This feature enables printing of debug information to stdout in debug builds
 print_debug = []
-# This feature enables dunping of the VMs details to a file when an unexpected or error exit occurs in a VM in debug mode
-# the name of the file is output to stdout and logged.
-dump_on_crash = ["dep:tempfile"]
+crashdump = ["dep:tempfile"] # Dumps the VM state to a file on unexpected errors or crashes. The path of the file will be printed on stdout and logged. This feature can only be used in debug builds.
 kvm = ["dep:kvm-bindings", "dep:kvm-ioctls"]
 mshv = ["dep:mshv-bindings", "dep:mshv-ioctls"]
 inprocess = []

src/hyperlight_host/build.rs

@@ -94,6 +94,8 @@ fn main() -> Result<()> {
         // inprocess feature is aliased with debug_assertions to make it only available in debug-builds.
         // You should never use #[cfg(feature = "inprocess")] in the codebase. Use #[cfg(inprocess)] instead.
         inprocess: { all(feature = "inprocess", debug_assertions) },
+        // crashdump feature is aliased with debug_assertions to make it only available in debug-builds.
+        crashdump: { all(feature = "crashdump", debug_assertions) },
     }
 
     write_built_file()?;

src/hyperlight_host/src/hypervisor/dump_on_crash.rs renamed to src/hyperlight_host/src/hypervisor/crashdump.rs

@@ -6,8 +6,8 @@ use super::Hypervisor;
 use crate::{new_error, Result};
 
 /// Dump registers + memory regions + raw memory to a tempfile
-#[cfg(feature = "dump_on_crash")]
-pub(crate) fn dump_on_crash_to_tempfile(hv: &dyn Hypervisor) -> Result<()> {
+#[cfg(crashdump)]
+pub(crate) fn crashdump_to_tempfile(hv: &dyn Hypervisor) -> Result<()> {
     let mut temp_file = NamedTempFile::with_prefix("mem")?;
     let hv_details = format!("{:#x?}", hv);
 
@@ -35,7 +35,7 @@ pub(crate) fn dump_on_crash_to_tempfile(hv: &dyn Hypervisor) -> Result<()> {
     let persist_path = temp_file.path().with_extension("dmp");
     temp_file
         .persist(&persist_path)
-        .map_err(|e| new_error!("Failed to persist dump_on_crash file: {:?}", e))?;
+        .map_err(|e| new_error!("Failed to persist crashdump file: {:?}", e))?;
 
     println!("Memory dumped to file: {:?}", persist_path);
     log::error!("Memory dumped to file: {:?}", persist_path);

src/hyperlight_host/src/hypervisor/hyperv_linux.rs

@@ -353,7 +353,7 @@ impl Hypervisor for HypervLinuxDriver {
         self as &mut dyn Hypervisor
     }
 
-    #[cfg(feature = "dump_on_crash")]
+    #[cfg(crashdump)]
     fn get_memory_regions(&self) -> &[MemoryRegion] {
         &self.mem_regions
     }

src/hyperlight_host/src/hypervisor/hyperv_windows.rs

@@ -536,7 +536,7 @@ impl Hypervisor for HypervWindowsDriver {
         self as &mut dyn Hypervisor
     }
 
-    #[cfg(feature = "dump_on_crash")]
+    #[cfg(crashdump)]
     fn get_memory_regions(&self) -> &[MemoryRegion] {
         &self.mem_regions
     }

src/hyperlight_host/src/hypervisor/inprocess.rs

@@ -18,7 +18,7 @@ use std::fmt::Debug;
 use std::os::raw::c_void;
 
 use super::{HyperlightExit, Hypervisor};
-#[cfg(feature = "dump_on_crash")]
+#[cfg(crashdump)]
 use crate::mem::memory_region::MemoryRegion;
 use crate::sandbox::leaked_outb::LeakedOutBWrapper;
 use crate::Result;
@@ -126,7 +126,7 @@ impl<'a> Hypervisor for InprocessDriver<'a> {
         unimplemented!("get_partition_handle should not be needed since we are in in-process mode")
     }
 
-    #[cfg(feature = "dump_on_crash")]
+    #[cfg(crashdump)]
     fn get_memory_regions(&self) -> &[MemoryRegion] {
         unimplemented!("get_memory_regions is not supported since we are in in-process mode")
     }

src/hyperlight_host/src/hypervisor/kvm.rs

@@ -326,7 +326,7 @@ impl Hypervisor for KVMDriver {
         self as &mut dyn Hypervisor
     }
 
-    #[cfg(feature = "dump_on_crash")]
+    #[cfg(crashdump)]
     fn get_memory_regions(&self) -> &[MemoryRegion] {
         &self.mem_regions
     }

src/hyperlight_host/src/hypervisor/mod.rs

@@ -55,8 +55,8 @@ pub(crate) mod windows_hypervisor_platform;
 #[cfg(target_os = "windows")]
 pub(crate) mod wrappers;
 
-#[cfg(feature = "dump_on_crash")]
-pub(crate) mod dump_on_crash;
+#[cfg(crashdump)]
+pub(crate) mod crashdump;
 
 use std::fmt::Debug;
 use std::sync::{Arc, Mutex};
@@ -187,7 +187,7 @@ pub(crate) trait Hypervisor: Debug + Sync + Send {
     #[cfg(target_os = "windows")]
     fn get_partition_handle(&self) -> windows::Win32::System::Hypervisor::WHV_PARTITION_HANDLE;
 
-    #[cfg(feature = "dump_on_crash")]
+    #[cfg(crashdump)]
     fn get_memory_regions(&self) -> &[MemoryRegion];
 }
 
@@ -212,8 +212,8 @@ impl VirtualCPU {
                     hv.handle_io(port, data, rip, instruction_length, outb_handle_fn.clone())?
                 }
                 Ok(HyperlightExit::Mmio(addr)) => {
-                    #[cfg(feature = "dump_on_crash")]
-                    dump_on_crash::dump_on_crash_to_tempfile(hv)?;
+                    #[cfg(crashdump)]
+                    crashdump::crashdump_to_tempfile(hv)?;
 
                     mem_access_fn
                         .clone()
@@ -224,8 +224,8 @@ impl VirtualCPU {
                     log_then_return!("MMIO access address {:#x}", addr);
                 }
                 Ok(HyperlightExit::AccessViolation(addr, tried, region_permission)) => {
-                    #[cfg(feature = "dump_on_crash")]
-                    dump_on_crash::dump_on_crash_to_tempfile(hv)?;
+                    #[cfg(crashdump)]
+                    crashdump::crashdump_to_tempfile(hv)?;
 
                     if region_permission.intersects(MemoryRegionFlags::STACK_GUARD) {
                         return Err(HyperlightError::StackOverflow());
@@ -250,15 +250,15 @@ impl VirtualCPU {
                     log_then_return!(ExecutionCanceledByHost());
                 }
                 Ok(HyperlightExit::Unknown(reason)) => {
-                    #[cfg(feature = "dump_on_crash")]
-                    dump_on_crash::dump_on_crash_to_tempfile(hv)?;
+                    #[cfg(crashdump)]
+                    crashdump::crashdump_to_tempfile(hv)?;
 
                     log_then_return!("Unexpected VM Exit {:?}", reason);
                 }
                 Ok(HyperlightExit::Retry()) => continue,
                 Err(e) => {
-                    #[cfg(feature = "dump_on_crash")]
-                    dump_on_crash::dump_on_crash_to_tempfile(hv)?;
+                    #[cfg(crashdump)]
+                    crashdump::crashdump_to_tempfile(hv)?;
 
                     return Err(e);
                 }