Samuka007/asterinas
1
0
Fork 0
mirror of https://github.com/asterinas/asterinas.git synced 2025-06-20 04:56:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fe7251c4139b5b505505f12850ab2ab72dff0031
asterinas/docs/src/osdk/reference/commands/run.md
Zhang Junyang 56175f63df Re-implement OSDK debugging fixes and other facilities upon the refactor 
This commit bring back the features introduced from d28292c to a52e432:
 - Disable KVM when using GDB;
 - Update docs about the GDB server address;
 - Add `config` option for `CargoArgs` in OSDK;
 - Ensure debug info added when debugging in the release profile.
2024-04-25 09:44:46 +08:00

1.3 KiB
Raw Blame History

cargo osdk run

Overview

cargo osdk run is used to run the kernel with QEMU. The usage is as follows:

cargo osdk run [OPTIONS]

Options

Most options are the same as those of cargo osdk build. Refer to the documentation of cargo osdk build for more details.

Options related with debugging:

  • -G, --enable-gdb: Enable QEMU GDB server for debugging.
  • --vsc: Generate a '.vscode/launch.json' for debugging kernel with Visual Studio Code (only works when QEMU GDB server is enabled, i.e., --enable-gdb). Requires CodeLLDB.
  • --gdb-server-addr <ADDR>: The network address on which the GDB server listens, it can be either a path for the UNIX domain socket or a TCP port on an IP address. [default: .aster-gdb-socket(a local UNIX socket)]

See Debug Command to interact with the GDB server in terminal.

Examples

  • Launch a debug server via QEMU with an unix socket stub, e.g. .debug:
cargo osdk run --enable-gdb --gdb-server-addr .debug
  • Launch a debug server via QEMU with a TCP stub, e.g., localhost:1234:
cargo osdk run --enable-gdb --gdb-server-addr :1234
  • Launch a debug server via QEMU and use VSCode to interact:
cargo osdk run --enable-gdb --vsc --gdb-server-addr :1234