mirror of
https://github.com/xemu-project/xemu-website.git
synced 2024-11-26 21:00:33 +00:00
dos2unix host.md
This commit is contained in:
Matt Borgerson
parent
471b34f125
commit
a363686db0
@ -1,114 +1,114 @@
|
||||
Stepping through xemu's code for development or troubleshooting an issue can be done via the process outlined below. Note that any GDB-based debugger should do, but [VSCode's](https://code.visualstudio.com/docs/cpp/cpp-debug){target=_blank} ease of use and multi-platform capabilities make it a good starter.
|
||||
|
||||
## Setup
|
||||
|
||||
Install [VSCode](https://code.visualstudio.com/download){target=_blank} and the [ms-vscode.cpptools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools){target=_blank} extension.
|
||||
|
||||
=== "Windows"
|
||||
|
||||
Map a drive to the WSL2 root or your projects folder within. The particular path can be found by viewing `\\wsl$` in File Explorer and reviewing the folders (distros) underneath. For example, `net use w: \\wsl$\Ubuntu-20.04`.
|
||||
|
||||
Install [MSYS2](https://www.msys2.org/){target=_blank}, run the `MSYS2 MinGW 64-bit` shell, and install GDB.
|
||||
|
||||
$ pacman -S mingw-w64-x86_64-gdb
|
||||
|
||||
Create a file at `xemu\.vscode\launch.json` with the following contents.
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "(gdb) Launch",
|
||||
"type": "cppdbg",
|
||||
"request": "launch",
|
||||
"program": "${workspaceFolder}\\dist\\xemu.exe",
|
||||
"args": [],
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${workspaceFolder}\\dist",
|
||||
"environment": [],
|
||||
"externalConsole": true,
|
||||
"MIMode": "gdb",
|
||||
"miDebuggerPath": "C:\\msys64\\mingw64\\bin\\gdb.exe",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty-printing for gdb",
|
||||
"text": "-enable-pretty-printing",
|
||||
"ignoreFailures": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
=== "Ubuntu"
|
||||
|
||||
Create a file at `xemu/.vscode/launch.json` with the following contents.
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "(gdb) Launch",
|
||||
"type": "cppdbg",
|
||||
"request": "launch",
|
||||
"program": "${workspaceFolder}/dist/xemu",
|
||||
"args": [],
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${workspaceFolder}/dist",
|
||||
"environment": [],
|
||||
"externalConsole": false,
|
||||
"MIMode": "gdb",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty-printing for gdb",
|
||||
"text": "-enable-pretty-printing",
|
||||
"ignoreFailures": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Build & Run
|
||||
|
||||
Follow the [build](../building-from-source.md) instructions appending `--debug` to the CLI arguments, open the xemu project directory in VSCode via <kbd>File</kbd> → <kbd>Open folder...</kbd>, and press `F5` to start debugging.
|
||||
|
||||
!!! tip "Tip: Arguments"
|
||||
|
||||
Argument key-value pairs must be separated.
|
||||
|
||||
```
|
||||
"args": [
|
||||
"-machine","xbox,avpack=hdtv"
|
||||
]
|
||||
```
|
||||
|
||||
Host and guest debugging can be used simultaneously.
|
||||
|
||||
```
|
||||
"args": [
|
||||
// enable the guest gdb server
|
||||
"-s",
|
||||
|
||||
// start in a paused state
|
||||
"-S"
|
||||
]
|
||||
```
|
||||
|
||||
## Debugging crashes
|
||||
|
||||
### Windows
|
||||
|
||||
#### Getting a core dump
|
||||
|
||||
If xemu is crashing and the reason is not clear, you can create a core dump to provide developers with to investigate. To create a core dump on Windows for crash analysis:
|
||||
|
||||
First, apply the registry edit script found in this Zip file: [xemu_dump_registry_config.zip](https://xemu.app/xemu_dump_registry_config.zip). This registry edit will configure Windows to create a dump whenever xemu crashes.
|
||||
|
||||
Then, download and run the debug build of xemu found at: https://github.com/xemu-project/xemu/releases/latest/download/xemu-win-debug.zip
|
||||
|
||||
The dump will be stored at `%LOCALAPPDATA%\CrashDumps`. You may notice a delay after xemu crashes while this file is saved.
|
||||
Stepping through xemu's code for development or troubleshooting an issue can be done via the process outlined below. Note that any GDB-based debugger should do, but [VSCode's](https://code.visualstudio.com/docs/cpp/cpp-debug){target=_blank} ease of use and multi-platform capabilities make it a good starter.
|
||||
|
||||
## Setup
|
||||
|
||||
Install [VSCode](https://code.visualstudio.com/download){target=_blank} and the [ms-vscode.cpptools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools){target=_blank} extension.
|
||||
|
||||
=== "Windows"
|
||||
|
||||
Map a drive to the WSL2 root or your projects folder within. The particular path can be found by viewing `\\wsl$` in File Explorer and reviewing the folders (distros) underneath. For example, `net use w: \\wsl$\Ubuntu-20.04`.
|
||||
|
||||
Install [MSYS2](https://www.msys2.org/){target=_blank}, run the `MSYS2 MinGW 64-bit` shell, and install GDB.
|
||||
|
||||
$ pacman -S mingw-w64-x86_64-gdb
|
||||
|
||||
Create a file at `xemu\.vscode\launch.json` with the following contents.
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "(gdb) Launch",
|
||||
"type": "cppdbg",
|
||||
"request": "launch",
|
||||
"program": "${workspaceFolder}\\dist\\xemu.exe",
|
||||
"args": [],
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${workspaceFolder}\\dist",
|
||||
"environment": [],
|
||||
"externalConsole": true,
|
||||
"MIMode": "gdb",
|
||||
"miDebuggerPath": "C:\\msys64\\mingw64\\bin\\gdb.exe",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty-printing for gdb",
|
||||
"text": "-enable-pretty-printing",
|
||||
"ignoreFailures": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
=== "Ubuntu"
|
||||
|
||||
Create a file at `xemu/.vscode/launch.json` with the following contents.
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "(gdb) Launch",
|
||||
"type": "cppdbg",
|
||||
"request": "launch",
|
||||
"program": "${workspaceFolder}/dist/xemu",
|
||||
"args": [],
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${workspaceFolder}/dist",
|
||||
"environment": [],
|
||||
"externalConsole": false,
|
||||
"MIMode": "gdb",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty-printing for gdb",
|
||||
"text": "-enable-pretty-printing",
|
||||
"ignoreFailures": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Build & Run
|
||||
|
||||
Follow the [build](../building-from-source.md) instructions appending `--debug` to the CLI arguments, open the xemu project directory in VSCode via <kbd>File</kbd> → <kbd>Open folder...</kbd>, and press `F5` to start debugging.
|
||||
|
||||
!!! tip "Tip: Arguments"
|
||||
|
||||
Argument key-value pairs must be separated.
|
||||
|
||||
```
|
||||
"args": [
|
||||
"-machine","xbox,avpack=hdtv"
|
||||
]
|
||||
```
|
||||
|
||||
Host and guest debugging can be used simultaneously.
|
||||
|
||||
```
|
||||
"args": [
|
||||
// enable the guest gdb server
|
||||
"-s",
|
||||
|
||||
// start in a paused state
|
||||
"-S"
|
||||
]
|
||||
```
|
||||
|
||||
## Debugging crashes
|
||||
|
||||
### Windows
|
||||
|
||||
#### Getting a core dump
|
||||
|
||||
If xemu is crashing and the reason is not clear, you can create a core dump to provide developers with to investigate. To create a core dump on Windows for crash analysis:
|
||||
|
||||
First, apply the registry edit script found in this Zip file: [xemu_dump_registry_config.zip](https://xemu.app/xemu_dump_registry_config.zip). This registry edit will configure Windows to create a dump whenever xemu crashes.
|
||||
|
||||
Then, download and run the debug build of xemu found at: https://github.com/xemu-project/xemu/releases/latest/download/xemu-win-debug.zip
|
||||
|
||||
The dump will be stored at `%LOCALAPPDATA%\CrashDumps`. You may notice a delay after xemu crashes while this file is saved.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user