riscv-qemu-debug

介绍如何在window下使用VSCode来debug WSL下的qemu运行的程序。

Prerequirement

  • 安装VScode,https://code.visualstudio.com/

  • 安装Arch Linux WSL。(之所以用Arch是因为可以直接拿到riscv64-linux-gdb,而Microsoft Store里的Debian没有gdb,只能自己编译,而我试过,没有编译成功)

  • 在Arch 里面安装riscv64-linux-gdb

    1
    $ pacman -S riscv64-linux-gnu-gdb
  • 在Arch 里面安装qemu

    1
    $ pacman -S qemu

    或者也可以自己编译源码安装,编译完成后,生成riscv64-softmmu/qemu-system-riscv64

    1
    2
    3
    4
    $ git clone https://github.com/qemu/qemu.git
    $ sudo apt-get install gcc libc6-dev pkg-config bridge-utils uml-utilities zlib1g-dev libglib2.0-dev autoconf automake libtool libsdl1.2-dev
    $ ./configure --target-list=riscv64-softmmu
    $ make

运行qemu

在VSCode下面有个terminal,可以直接在这里敲WSL里面的命令。也或者直接在Arch里面敲命令。启动qemu的debug模式。

1
$ qemu-system-riscv64 xxxxxxxxxxxxxxx -s -S

其中:

-s : 表示打开debug模式,是该命令的缩写。-gdb tcp::1234

-S :表示让CPU停在起始地址

运行之后,会有个gdb server开始监听1234端口,等待连接。

VSCode

安装插件

在扩展里面添加如下插件

1
2
3
4
5
6
C/C++ (必选)
C/C++ Intellisense(可选)
C/C++ Snippets(可选)
Remote-WSL
Remote-SSH
Remote-Containers Embedded Linux Dev(设备树插件) Kconfig(设备树插件依赖)

连接remote

  • 点击左下角,open a remote window

  • 选择Remote-WSL: New Window 或者Remote-WSL:New Window using Distro...

  • 会弹出一个新窗口,左下角会显示WSL:Arch表示连接成功
  • 点击左侧Explorer,选择Open Folder,选择源码所在目录
  • 左侧会显示目录下的文件

配置debug选项

  • 选择:Run -> Add Configuration.. -> C++ (GDB/LDB)

  • 添加如下配置:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    {
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
    {
    "name": "(gdb) Launch",
    "type": "cppdbg",
    "request": "launch",
    "program": "${workspaceFolder}/opensbi-master/build/platform/generic/firmware/fw_jump.elf",
    "args": [],
    "stopAtEntry": true,
    "cwd": "${workspaceFolder}",
    "environment": [],
    "externalConsole": true,
    "MIMode": "gdb",
    "miDebuggerPath": "/usr/sbin/riscv64-linux-gnu-gdb",
    "miDebuggerServerAddress":"192.168.50.125:1234",
    "setupCommands": [
    {
    "description": "Enable pretty-printing for gdb",
    "text": "-enable-pretty-printing",
    "ignoreFailures": true
    }
    ]
    }
    ]
    }

    其中:

    program : 要调试的elf文件

    stopAtEntry : 停在入口地址

    miDebuggerPath : WSL里的gdb的路径

    miDebuggerServerAddress : gdb server的地址,可直接看windows下ipconfig,或者在Arch下ip address 查看。

开始调试

Run -> Start Debugging 就可以开始调试了。或者按F5也行。

这里有个小问题是,开始调试之后不能停在起始地址,只能先设置个断点让他停下来。

GDB

除了使用VSCode进行debug,也可以直接在WSL下面进行GDB调试。

1
2
3
$ riscv64-linux-gnu-gdb
(gdb) file vmlinux
(gdb) target remote :1234

file xx.elf : 导入要调试的elf

add-symbol-file xx.elf : 将elf的符号导入

add-symbol-file xx.elf 0x80200000 : 将elf的符号导入,并指定地址

target remote :1234 : 连接远程gdb server

stepi : 单步执行,每次执行一个指令,会跟踪进入函数

stepi 4 : 单步执行,走4步

tbreak *0x80200000: 在内存0x80200000地址添加一个临时断点

x 0x80200000 : 查看0x80200000地址的值

info registers a3 : 查看寄存器a3的值

print xx : 查看xx变量的值

Reference

1
2
https://mp.weixin.qq.com/s/ByXbn3gM7vai-mPdywn3Dg
https://dzone.com/articles/multiple-binaries-with-gdbeclipse