Skip to content

Commit f8aff0d

Browse files
committed
dbg: update documentation to specify the mshv debug support
Signed-off-by: Doru Blânzeanu <[email protected]>
1 parent 0b8ded6 commit f8aff0d

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

docs/debugging-hyperlight.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,7 @@ cargo test --package hyperlight-host --test integration_test --features print_de
4242
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.
4343

4444
There are no tools at this time to analyze the dump file, but it can be useful for debugging.
45+
46+
## Debugging guests
47+
48+
For more information on how to debug the Hyperlight guests check the following [link](./how-to-debug-a-hyperlight-guest.md).

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# How to debug a Hyperlight **KVM** guest using gdb
1+
# How to debug a Hyperlight guest using gdb on Linux
22

3-
Hyperlight supports gdb debugging of a **KVM** guest running inside a Hyperlight sandbox.
4-
When Hyperlight is compiled with the `gdb` feature enabled, a Hyperlight KVM sandbox can be configured
3+
Hyperlight supports gdb debugging of a **KVM** or **MSHV** guest running inside a Hyperlight sandbox on Linux.
4+
When Hyperlight is compiled with the `gdb` feature enabled, a Hyperlight sandbox can be configured
55
to start listening for a gdb connection.
66

77
## Supported features
88

9-
The Hyperlight `gdb` feature enables **KVM** guest debugging:
10-
- an entry point breakpoint is automatically set for the guest to stop
9+
The Hyperlight `gdb` feature enables **KVM** and **MSHV** guest debugging to:
10+
- stop at an entry point breakpoint which is automatically set by Hyperlight
1111
- add and remove HW breakpoints (maximum 4 set breakpoints at a time)
1212
- add and remove SW breakpoints
1313
- read and write registers
@@ -18,7 +18,7 @@ The Hyperlight `gdb` feature enables **KVM** guest debugging:
1818
## Expected behavior
1919

2020
Below is a list describing some cases of expected behavior from a gdb debug
21-
session of a guest binary running inside a KVM Hyperlight sandbox.
21+
session of a guest binary running inside a Hyperlight sandbox on Linux.
2222

2323
- when the `gdb` feature is enabled and a SandboxConfiguration is provided a
2424
debug port, the created sandbox will wait for a gdb client to connect on the
@@ -154,7 +154,7 @@ is sent over the communication channel to the hypervisor handler for the sandbox
154154
to resolve.
155155

156156
Below is a sequence diagram that shows the interaction between the entities
157-
involved in the gdb debugging of a Hyperlight guest running inside a KVM sandbox.
157+
involved in the gdb debugging of a Hyperlight guest running inside a **KVM** or **MSHV** sandbox.
158158

159159
```
160160
┌───────────────────────────────────────────────────────────────────────────────────────────────┐

0 commit comments

Comments
 (0)