VsCode + gdb + gdbserver远程调试C++程序

一、引言在windows中我们可以通过visual studio远程调试windows程序在linux下我们也可以通过gdb和gdbserver远程调试linux程序。但传统的gdb gdbserver远程调试有个问题是不够直观工程师必须学习gdb命令且只能在命令行中调试。所幸的是由于这几年技术的发展VsCode已经可以支持远程调试的功能了用户可以在window上的VsCode中边看代码边远程调试linux下的程序包括服务器程序、嵌入式arm板子上的程序、甚至是linux内核等先给大家演示下最终效果吧下面讲述搭建该环境的方法阅读这篇文章前推荐先看一下博主的另一篇文章《Vscode编译调试C程序》可以对Vscode的用法有更深的理解二、linux端安装软件和设置我所用的linux端是Ubuntu。在里面执行如下命令安装软件sudo apt-get install openssh-server sudo apt-get install gdb sudo apt-get install gdbserver在Ubuntu中随便找个位置新建目录作为本例所用的测试项目根目录mkdir Test1A cd Test1A touch main.cpp在main.cpp中输入如下代码#include stdio.h int main() { int a 1; printf(hello world\n); getchar(); return 0; }然后编译得到“main”这个可执行文件g main.cpp -o main -g注意编译时得加-g选项不然没法用gdb调试。编译后项目结构如下然后我们启动gdbserver执行命令gdbserver 192.168.0.109:2000 /mnt/hgfs/vmware/Test1A/main上述命令中的192.168.0.109是linux端的ip2000是gdbserver的监听端口得要先执行lsof -i:2000命令查看该端口有没有被占用/mnt/hgfs/vmware/Test1A/main是要被调试的可执行文件的绝对路径进行上述操作后效果如下三、Vscode设置我们在windows上打开Vscode在里面安装如下插件C/CC/C Extension PackRemote - SSHRemote DevelopmentC/C和C/C Extension Pack需要在远程Linux上安装按下F1选择Remote-SSH:Connect to Host... - Add New SSH Host...按照“ssh linux用户名linux端ip”的格式输进去选择一个ssh配置文件按下Connect按钮输入linux端的密码左下角出现绿色的SSH:ip的字样表示通过ssh连接打开文件夹 - 选择我们刚刚在ubuntu中新建的项目目录点“确定”按钮再次输入linux密码我们可以在Vscode中看到刚刚在ubuntu上编写的代码和项目文件了。选中C/C扩展“在SSH:XXX中安装”。C/C Extension Pack扩展同理然后重启Vscode和Ubuntu中的gdbserver一定得要重启否则接下来的步骤会报错重新执行上述远程连接流程。按下F5选择C(GDB/LLDB) - g -生成和调试活动文件可以看到生成了launch.json和tasks.json两个文件Vscode自动编译了可执行文件并且可以远程调试了。四、手动编译并远程调试在实际公司的项目中可能有上百个cpp文件用Vscode编译经常出现各种问题。所以一般我们不用tasks.json来编译而是手动编译下面演示手动编译并远程调试的流程。Ubuntu中执行命令g main.cpp -o main -g在Vscode中修改tasks.json让它不要自动编译{ tasks: [ { } ], version: 2.0.0 }修改launch.json。其实只要修改program(调试入口文件的地址)、cwd程序启动调试的目录、miDebuggerPath调试器的路径、新增miDebuggerServerAddressgdbserver的ip和端口就可以了。{ // 使用 IntelliSense 了解相关属性。 // 悬停以查看现有属性的描述。 // 欲了解更多信息请访问: https://go.microsoft.com/fwlink/?linkid830387 version: 0.2.0, configurations: [ { name: g - 生成和调试活动文件, type: cppdbg, request: launch, program: /mnt/hgfs/vmware/Test1A/main, args: [], stopAtEntry: false, cwd: /mnt/hgfs/vmware/Test1A, environment: [], externalConsole: false, MIMode: gdb, setupCommands: [ { description: 为 gdb 启用整齐打印, text: -enable-pretty-printing, ignoreFailures: true }, { description: 将反汇编风格设置为 Intel, text: -gdb-set disassembly-flavor intel, ignoreFailures: true } ], preLaunchTask: C/C: g 生成活动文件, miDebuggerPath: /usr/bin/gdb, miDebuggerServerAddress:192.168.0.109:2000 } ] }重启gdbserver然后Vscode重新执行F5这时可能会弹出一个提示框点击“仍要调试”就可以远程调试了。如果按下F5没有反应那可能是因为没有权限在可执行文件所在目录执行chmod 777 ./ -R即可。五、其它问题1.如果调试C代码时无法查看STL容器可以参考文章《VScode调试C代码时无法查看STL容器(string、vector等》。2.如果远程修改C代码提示没有权限无法写入则可以参考《VsCode远程连接后写入文件失败Failed to save XXXUnable to write file ‘vscode-remote://ssh-remoteXXX’》。3.如果是要通过vscode远程调试嵌入式arm linux的程序可以参考《VsCode gdb gdbserver远程调试arm嵌入式linux C/C程序》。4.设置远程免密登录可以参考《vscode 配置服务器远程连接-不需要每次输密码噢》。5.VsCode报错“Could not establish connection to XXX”可以参考《VsCode远程ssh连接失败Could not establish connection to XXX》。6.无法远程调试可以参考《VsCode无法远程调试》。7.设置VsCode搜索时排除文件文件列表中隐藏文件可以参考《设置VsCode搜索时排除文件文件列表中隐藏文件》。