You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to-debug-a-hyperlight-guest.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -205,15 +205,17 @@ involved in the gdb debugging of a Hyperlight guest running inside a **KVM** or
205
205
206
206
## Dumping the guest state to an ELF core dump when an unhandled crash occurs
207
207
208
-
When a guest crashes, the vCPU state is dumped to an `ELF` core dump file. This can be used to inspect the state of the guest at the time of the crash.
208
+
When a guest crashes because of an unknown VmExit or unhandled exception, the vCPU state is dumped to an `ELF` core dump file.
209
+
This can be used to inspect the state of the guest at the time of the crash.
209
210
210
-
To 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. This will result in a dump file being created in the temporary directory.
211
+
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.
212
+
This will result in a dump file being created in the temporary directory.
211
213
The name and location of the dump file will be printed to the console and logged as an error message.
212
214
213
215
### Inspecting the core dump
214
216
215
217
After the core dump has been created, to inspect the state of the guest, load the core dump file using `gdb` or `lldb`.
216
-
A `gdb` version later than `15.0` and `lldb` version later than `17` have been used to test this feature.
218
+
**NOTE: This feature has been tested with version `15.0` of `gdb` and version `17` of `lldb`, earlier versions may not work, it is recommended to use these versions or later.**
217
219
218
220
To do this in vscode, the following configuration can be used to add debug configurations:
219
221
@@ -269,7 +271,7 @@ To do this in vscode, the following configuration can be used to add debug confi
269
271
]
270
272
}
271
273
```
272
-
NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
274
+
**NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
273
275
press the `pause` button. This is a known issue with the `CodeLldb` extension [#1245](https://github.com/vadimcn/codelldb/issues/1245).
274
-
The `cppdbg` extension works as expected and stops at the entry point of the program.
276
+
The `cppdbg` extension works as expected and stops at the entry point of the program.**
0 commit comments