Skip to content

Commit 97cd58a

Browse files
committed
docs: update crashdump docs to signal support for both debug and release builds
Signed-off-by: Doru Blânzeanu <[email protected]>
1 parent 55292df commit 97cd58a

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/how-to-debug-a-hyperlight-guest.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,10 +207,14 @@ involved in the gdb debugging of a Hyperlight guest running inside a **KVM** or
207207
When a guest crashes because of an unknown VmExit or unhandled exception, the vCPU state is dumped to an `ELF` core dump file.
208208
This can be used to inspect the state of the guest at the time of the crash.
209209
210-
To make Hyperlight dump the state of the vCPU (general purpose registers, registers) to an `ELF` core dump file, set the feature `crashdump` and run a debug build.
211-
This will result in a dump file being created in the temporary directory.
210+
To make Hyperlight dump the state of the vCPU (general purpose registers, registers) to an `ELF` core dump file, enable the `crashdump`
211+
feature and run.
212+
The feature enables the creation of core dump files for both debug and release builds of Hyperlight hosts.
213+
By default, Hyperlight places the core dumps in the temporary directory (platform specific).
214+
To change this, use the `HYPERLIGHT_CORE_DUMP_DIR` environment variable to specify a directory.
212215
The name and location of the dump file will be printed to the console and logged as an error message.
213216
217+
**NOTE**: If the directory provided by `HYPERLIGHT_CORE_DUMP_DIR` does not exist, Hyperlight places the file in the temporary directory.
214218
**NOTE**: By enabling the `crashdump` feature, you instruct Hyperlight to create core dump files for all sandboxes when an unhandled crash occurs.
215219
To selectively disable this feature for a specific sandbox, you can set the `guest_core_dump` field to `false` in the `SandboxConfiguration`.
216220
```rust

0 commit comments

Comments
 (0)