在 VS Code 中试用

在 Visual Studio Code 中调试 C++

在按照每个目标编译器/平台的配置教程设置了调试环境的基础知识后,你可以在本节中了解更多关于调试 C/C++ 的详细信息。

Visual Studio Code 支持以下 C/C++ 调试器,具体取决于你使用的操作系统:

  • Linux: GDB
  • macOS: LLDB 或 GDB
  • Windows: Visual Studio Windows 调试器或 GDB (使用 Cygwin 或 MinGW)

使用 GDB 进行 Windows 调试

你可以使用 VS Code 调试使用 Cygwin 或 MinGW 创建的 Windows 应用程序。要使用 Cygwin 或 MinGW 调试功能,必须在启动配置 (launch.json) 中手动设置调试器路径。要调试 Cygwin 或 MinGW 应用程序,请添加 miDebuggerPath 属性,并将其值设置为 Cygwin 或 MinGW 环境中相应的 gdb.exe 的位置。

例如:

    "miDebuggerPath": "c:\\mingw\\bin\\gdb.exe"

Windows 上的 Cygwin/MinGW 调试支持附加和启动调试场景。

要了解更多信息,请参阅配置 C/C++ 调试

如果你在 Windows 上使用 GDB 调试,请参阅使用 MinGW64 进行 Windows 调试

条件断点

条件断点使你能够在条件值为 true 时才在特定代码行中断执行。要设置条件断点,请右键单击现有断点并选择 Edit Breakpoint(编辑断点)。这将打开一个小型预览窗口,你可以在其中输入在调试期间触发断点必须为 true 的条件。

A conditional break

在编辑器中,条件断点由一个内部带有黑色等号的断点符号表示。你可以将光标放在条件断点上以显示其条件。

函数断点

函数断点使你能够在函数开头而不是特定代码行中断执行。要设置函数断点,请在运行视图中右键单击断点部分,然后选择添加函数断点并输入要中断执行的函数名称。

表达式求值

VS Code 在多种上下文下支持表达式求值:

  • 你可以在运行视图的监视部分输入表达式,每次命中断点时都会对其进行求值。
  • 你可以在调试控制台中输入表达式,它将只被求值一次。
  • 在断点处停止时,你可以对代码中出现的任何表达式进行求值。

监视部分中的表达式在被调试的应用程序中生效;修改变量值的表达式将在程序执行期间修改该变量。

多线程调试

VS Code 的 C/C++ 扩展能够调试多线程程序。所有线程及其调用堆栈都显示在调用堆栈部分。

Multi-threaded process

内存转储调试

VS Code 的 C/C++ 扩展还能够调试内存转储。要调试内存转储,请打开 launch.json 文件,并在 C++ Launch 配置中添加 coreDumpPath(适用于 GDB 或 LLDB)或 dumpPath(适用于 Visual Studio Windows 调试器)属性,将其值设置为包含内存转储路径的字符串。这甚至适用于在 x64 机器上调试 x86 程序。

附加符号

如果有其他目录可供调试器查找符号文件(例如,Visual Studio Windows 调试器的 .pdb 文件),可以通过添加 additionalSOLibSearchPath(适用于 GDB 或 LLDB)或 symbolSearchPath(适用于 Visual Studio Windows 调试器)来指定。

例如:

    "additionalSOLibSearchPath": "/path/to/symbols;/another/path/to/symbols"

    "symbolSearchPath": "C:\\path\\to\\symbols;C:\\another\\path\\to\\symbols"

查找源文件

如果源文件不在编译位置,则可以更改源文件位置。这通过在 sourceFileMap 部分中添加简单的替换对来实现。此列表中的第一个匹配项将被使用。

例如:

"sourceFileMap": {
    "/build/gcc-4.8-fNUjSI/gcc-4.8-4.8.4/build/i686-linux-gnu/libstdc++-v3/include/i686-linux-gnu": "/usr/include/i686-linux-gnu/c++/4.8",
    "/build/gcc-4.8-fNUjSI/gcc-4.8-4.8.4/build/i686-linux-gnu/libstdc++-v3/include": "/usr/include/c++/4.8"
}

GDB、LLDB 和 LLDB-MI 命令 (GDB/LLDB)

对于 C++ (GDB/LLDB) 调试环境,你可以通过调试控制台使用 -exec 命令直接执行 GDB、LLDB 和 LLDB-MI 命令,但请注意,在调试控制台中直接执行命令未经测试,在某些情况下可能会导致 VS Code 崩溃。

其他调试功能

  • 无条件断点
  • 监视窗口
  • 调用堆栈
  • 单步执行

有关使用 VS Code 调试的更多信息,请参阅这篇关于在 VS Code 中调试的介绍。

有关配置 launch.json 文件以调试 C/C++ 应用程序的其他方法,请参阅配置 C/C++ 调试

Natvis 框架

你可以使用 Natvis 框架在调试器中创建 C++ 对象的自定义视图。你可以阅读原生对象的自定义视图主题,了解有关将 Natvis 与 C/C++ 扩展一起使用的详细信息。

远程调试

有关附加到远程进程(例如调试 Docker 容器中的进程)的信息,请参阅管道传输

调试调试器

如果你遇到扩展的调试问题,而我们无法根据你的问题报告中的信息进行诊断,我们可能会要求你启用日志记录并将日志发送给我们。请参阅启用调试适配器日志记录以了解如何获取 C/C++ 扩展日志。

已知限制

符号和代码导航

所有平台

  • 由于扩展不解析函数体,因此 Peek Definition(速览定义)和 Go to Definition(转到定义)不适用于在函数体内部定义的符号。

调试

Windows

  • Cygwin 和 MinGW 上的 GDB 无法中断正在运行的进程。要在应用程序运行时(未在调试器下停止时)设置断点,或暂停正在调试的应用程序,请在应用程序的终端中按 Ctrl-C
  • Cygwin 上的 GDB 无法打开核心转储。

Linux

  • 你可能会看到错误消息:ptrace: Operation not permitted。这是因为 GDB 需要提升的权限才能附加到进程。可以使用以下解决方案解决此问题:
    1. 使用附加到进程时,在调试会话开始之前需要提供密码。

    2. 要暂时禁用此错误,请使用以下命令:

      echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

    3. 要永久消除此错误,请在 /etc/sysctl.d/ 中添加一个名为 10-ptrace.conf 的文件,并添加以下内容 kernel.yama.ptrace_scope = 0

macOS

  • LLDB
    • 使用 LLDB 调试时,如果在中断模式下关闭终端窗口,调试不会停止。可以通过按停止按钮来停止调试。
    • 当调试停止时,终端窗口不会关闭。
  • GDB
    • 在 macOS 上使用 GDB 需要额外的手动安装步骤。请参阅 README 中的《macOS 上 GDB 的手动安装》
    • 使用 GDB 附加到进程时,被调试的应用程序无法中断。GDB 只会在应用程序未运行时(附加到应用程序之前,或应用程序处于停止状态时)绑定设置的断点。这是由于 GDB 中的一个错误
    • 使用 GDB 调试时无法加载核心转储,因为 GDB 不支持 macOS 中使用的核心转储格式
    • 使用 GDB 附加到进程时,break-all 将终止进程。

后续步骤

继续阅读以了解:

如果你有其他问题或遇到任何问题,请在 GitHub 上提交问题。