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
@@ -204,15 +204,17 @@ involved in the gdb debugging of a Hyperlight guest running inside a **KVM** or
204
204
205
205
## Dumping the guest state to an ELF core dump when an unhandled crash occurs
206
206
207
-
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.
207
+
When a guest crashes because of an unknown VmExit or unhandled exception, the vCPU state is dumped to an `ELF` core dump file.
208
+
This can be used to inspect the state of the guest at the time of the crash.
208
209
209
-
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.
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
212
The name and location of the dump file will be printed to the console and logged as an error message.
211
213
212
214
### Inspecting the core dump
213
215
214
216
After the core dump has been created, to inspect the state of the guest, load the core dump file using `gdb` or `lldb`.
215
-
A `gdb` version later than `15.0` and `lldb` version later than `17` have been used to test this feature.
217
+
**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.**
216
218
217
219
To do this in vscode, the following configuration can be used to add debug configurations:
218
220
@@ -268,7 +270,7 @@ To do this in vscode, the following configuration can be used to add debug confi
268
270
]
269
271
}
270
272
```
271
-
NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
273
+
**NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
272
274
press the `pause` button. This is a known issue with the `CodeLldb` extension [#1245](https://github.com/vadimcn/codelldb/issues/1245).
273
-
The `cppdbg` extension works as expected and stops at the entry point of the program.
275
+
The `cppdbg` extension works as expected and stops at the entry point of the program.**
0 commit comments