配置 C/C++ 调试

一个 launch.json 文件用于配置 Visual Studio Code 中的 调试器。

Visual Studio Code 会生成一个 launch.json（位于项目中的 .vscode 文件夹下），其中包含几乎所有必需的信息。要开始调试，您需要填写 program 字段，其中包含要调试的可执行文件的路径。这必须为启动和附加（如果您打算在任何时候附加到正在运行的实例）配置指定。

生成的文

配置 VS Code 的调试行为

设置或更改以下选项以控制 VS Code 在调试期间的行为

program（必需）

指定调试器将启动或附加到的可执行文件的完整路径。调试器需要此位置才能加载调试符号。

symbolSearchPath

告诉 Visual Studio Windows 调试器搜索符号 (.pdb) 文件的路径。用分号分隔多个路径。例如："C:\\Symbols;C:\\SymbolDir2"。

requireExactSource

一个可选标志，告诉 Visual Studio Windows 调试器要求当前源代码与 pdb 匹配。

additionalSOLibSearchPath

告诉 GDB 或 LLDB 搜索 .so 文件的路径。用分号分隔多个路径。例如："/Users/user/dir1;/Users/user/dir2"。

externalConsole

仅在启动调试器时使用。对于 attach，此参数不会更改调试器的行为。

• Windows：设置为 true 时，它将生成一个外部控制台。设置为 false 时，它将使用 VS Code 的集成终端。
• Linux：设置为 true 时，它将通知 VS Code 生成一个外部控制台。设置为 false 时，它将使用 VS Code 的集成终端。
• macOS：设置为 true 时，它将通过 lldb-mi 生成一个外部控制台。设置为 false 时，可以在 VS Code 的 debugConsole 中看到输出。由于 lldb-mi 中的限制，集成终端支持不可用。

avoidWindowsConsoleRedirection

为了支持 VS Code 的集成终端与 Windows 上的 gdb，扩展程序将控制台重定向命令添加到调试器的参数中，以使控制台输入和输出显示在集成终端中。将此选项设置为 true 将禁用它。

logging

可选标志，用于确定应将哪些类型的消息记录到调试控制台。

• exceptions：可选标志，用于确定是否应将异常消息记录到调试控制台。默认值为 true。
• moduleLoad：可选标志，用于确定是否应将模块加载事件记录到调试控制台。默认值为 true。
• programOutput：可选标志，用于确定是否应将程序输出记录到调试控制台。默认值为 true。
• engineLogging：可选标志，用于确定是否应将诊断引擎日志记录到调试控制台。默认值为 false。
• trace：可选标志，用于确定是否应将诊断适配器命令跟踪记录到调试控制台。默认值为 false。
• traceResponse：可选标志，用于确定是否应将诊断适配器命令和响应跟踪记录到调试控制台。默认值为 false。

visualizerFile

调试时要使用的 .natvis 文件。有关如何创建 Natvis 文件的信息，请参阅 创建本机对象的自定义视图。

showDisplayString

当指定 visualizerFile 时，showDisplayString 将启用显示字符串。启用此选项会导致调试期间性能下降。

示例

{
  "name": "C++ Launch (Windows)",
  "type": "cppvsdbg",
  "request": "launch",
  "program": "C:\\app1\\Debug\\app1.exe",
  "symbolSearchPath": "C:\\Symbols;C:\\SymbolDir2",
  "externalConsole": true,
  "logging": {
    "moduleLoad": false,
    "trace": true
  },
  "visualizerFile": "${workspaceFolder}/my.natvis",
  "showDisplayString": true
}

配置目标应用程序

以下选项使您能够在启动目标应用程序时修改其状态

args

传递给程序启动时的命令行参数的 JSON 数组。示例 ["arg1", "arg2"]。如果您要转义字符，则需要双重转义它们。例如，["{\\\"arg1\\\": true}"] 将发送 {"arg1": true} 到您的应用程序。

cwd

设置调试器启动的应用程序的工作目录。

environment

要添加到程序环境中的环境变量。示例：[ { "name": "config", "value": "Debug" } ]，而不是 [ { "config": "Debug" } ]。

示例

{
  "name": "C++ Launch",
  "type": "cppdbg",
  "request": "launch",
  "program": "${workspaceFolder}/a.out",
  "args": ["arg1", "arg2"],
  "environment": [{ "name": "config", "value": "Debug" }],
  "cwd": "${workspaceFolder}"
}

自定义 GDB 或 LLDB

您可以通过设置以下选项来更改 GDB 或 LLDB 的行为

MIMode

指示调试器 VS Code 将连接到的调试器。必须设置为 gdb 或 lldb。这是在每个操作系统的基础上预先配置的，可以根据需要进行更改。

miDebuggerPath

调试器（例如 gdb）的路径。仅指定可执行文件时，它将搜索操作系统的 PATH 变量以查找调试器（Linux 和 Windows 上的 GDB、OS X 上的 LLDB）。

miDebuggerArgs

传递给调试器（例如 gdb）的其他参数。

stopAtEntry

如果设置为 true，调试器应在目标的入口点停止（在附加时忽略）。默认值为 false。

stopAtConnect

如果设置为 true，调试器应在连接到目标后停止。如果设置为 false，调试器将在连接后继续。默认值为 false。

setupCommands

要执行的 JSON 命令数组，以设置 GDB 或 LLDB。示例："setupCommands": [ { "text": "target-run", "description": "run target", "ignoreFailures": false }]。

customLaunchSetupCommands

如果提供，它将替换用于启动目标的默认命令，使用其他一些命令。例如，这可以是“-target-attach”，以便附加到目标进程。空命令列表将启动命令替换为空，如果调试器被提供启动选项作为命令行选项，这可能会有用。示例："customLaunchSetupCommands": [ { "text": "target-run", "description": "run target", "ignoreFailures": false }]。

launchCompleteCommand

在调试器完全设置后执行的命令，以使目标进程运行。允许的值是“exec-run”、“exec-continue”、“None”。默认值为“exec-run”。

示例

{
  "name": "C++ Launch",
  "type": "cppdbg",
  "request": "launch",
  "program": "${workspaceFolder}/a.out",
  "stopAtEntry": false,
  "customLaunchSetupCommands": [
    { "text": "target-run", "description": "run target", "ignoreFailures": false }
  ],
  "launchCompleteCommand": "exec-run",
  "linux": {
    "MIMode": "gdb",
    "miDebuggerPath": "/usr/bin/gdb"
  },
  "osx": {
    "MIMode": "lldb"
  },
  "windows": {
    "MIMode": "gdb",
    "miDebuggerPath": "C:\\MinGw\\bin\\gdb.exe"
  }
}

symbolLoadInfo

• loadAll：如果为 true，则将加载所有库的符号，否则将不加载任何 solib 符号。由 ExceptionList 修改。默认值为 true。
• exceptionList：用分号 ; 分隔的文件名列表（允许使用通配符）。修改 LoadAll 的行为。如果 LoadAll 为 true，则不要加载与列表中任何名称匹配的库的符号。否则，只加载与列表中任何名称匹配的库的符号。示例："foo.so;bar.so"

调试转储文件

C/C++ 扩展程序在 Windows 上启用调试转储文件，在 Linux 和 OS X 上启用核心转储文件。

dumpPath

如果您要调试 Windows 转储文件，请在 launch 配置中将其设置为转储文件的路径以开始调试。

coreDumpPath

用于调试指定程序的 core dump 文件的完整路径。在“启动”配置中将此设置为 core dump 文件的路径以开始调试。注意：使用 MinGw 不支持 core dump 调试。

远程调试或使用本地调试服务器调试

miDebuggerServerAddress

调试服务器（例如，gdbserver）的网络地址，用于连接到远程调试（例如：localhost:1234）。

debugServerPath

要启动的调试服务器的完整路径。

debugServerArgs

调试服务器的参数。

serverStarted

在调试服务器输出中查找的服务器启动模式。支持正则表达式。

filterStdout

如果设置为 true，则在 stdout 流中搜索服务器启动模式并将 stdout 记录到调试输出中。默认值为 true。

filterStderr

如果设置为 true，则在 stderr 流中搜索服务器启动模式并将 stderr 记录到调试输出中。默认值为 false。

serverLaunchTimeout

调试器等待 debugServer 启动的时间（以毫秒为单位）。默认值为 10000。

pipeTransport

有关连接到远程进程（例如，调试 Docker 容器中的进程）的信息，请参阅 管道传输 设置文章。

hardwareBreakpoints

如果提供，则显式控制远程目标的硬件断点行为。如果 require 设置为 true，则始终使用硬件断点。默认值为 false。limit 是对可用硬件断点的数量的可选限制，仅在 require 为 true 且 limit 大于 0 时才执行。默认值为 0。例如："hardwareBreakpoints": { require: true, limit: 6 }。

其他属性

processId

默认为 ${command:pickProcess}，它将显示调试器可以附加到的可用进程列表。我们建议您保留此默认值，但可以将此属性显式设置为特定进程 ID，以便调试器附加到该进程。

request

指示配置部分是用于 启动 程序还是 附加 到正在运行的实例。

targetArchitecture

已弃用 此选项不再需要，因为目标体系结构会自动检测。

type

指示正在使用的底层调试器。使用 Visual Studio Windows 调试器时必须为 cppvsdbg，使用 GDB 或 LLDB 时必须为 cppdbg。创建 launch.json 文件时，此选项将自动设置为正确的值。

sourceFileMap

这允许将源代码的编译时路径映射到本地源代码位置。它是一个键/值对对象，将解析第一个匹配字符串的路径。（例如："sourceFileMap": { "/mnt/c": "c:\\" } 将映射调试器返回的任何以 /mnt/c 开头的路径并将其转换为 c:\\。您可以在对象中添加多个映射，但它们将按提供的顺序处理。）

环境变量定义文件

环境变量定义文件是一个简单的文本文件，包含以 environment_variable=value 形式的键值对，其中 # 用于注释。不支持多行值。

cppvsdbg 调试器配置还包含一个 envFile 属性，使您可以轻松地设置变量以进行调试。

例如

project.env 文件:

# project.env

# Example environment with key as 'MYENVRIONMENTPATH' and value as C:\\Users\\USERNAME\\Project
MYENVRIONMENTPATH=C:\\Users\\USERNAME\\Project

# Variables with spaces
SPACED_OUT_PATH="C:\\This Has Spaces\\Project"

符号选项

symbolOptions 元素允许自定义调试器搜索符号的方式。示例

    "symbolOptions": {
        "searchPaths": [
            "C:\\src\\MyOtherProject\\bin\\debug",
            "https://my-companies-symbols-server"
        ],
        "searchMicrosoftSymbolServer": true,
        "cachePath": "%TEMP%\\symcache",
        "moduleFilter": {
            "mode": "loadAllButExcluded",
            "excludedModules": [ "DoNotLookForThisOne*.dll" ]
        }
    }

属性

searchPaths：用于搜索 .pdb 文件的符号服务器 URL（例如：https://msdl.microsoft.com/download/symbols）或目录（例如：/build/symbols）的数组。除了默认位置之外，还会搜索这些目录 - 位于模块旁边以及 pdb 最初放置的路径。

searchMicrosoftSymbolServer：如果为 true，则将 Microsoft 符号服务器（https://msdl.microsoft.com/download/symbols）添加到符号搜索路径。如果未指定，此选项默认为 false。

cachePath"：从符号服务器下载的符号应缓存在其中的目录。如果未指定，调试器将默认为 %TEMP%\SymbolCache..

moduleFilter.mode：此值可以是 "loadAllButExcluded" 或 "loadOnlyIncluded"。在 "loadAllButExcluded" 模式下，调试器会为所有模块加载符号，除非该模块位于“excludedModules”数组中。在 "loadOnlyIncluded" 模式下，调试器不会尝试为任何模块加载符号，除非该模块位于“includedModules”数组中，或者通过“includeSymbolsNextToModules”设置包含在内。

"loadAllButExcluded" 模式的属性

moduleFilter.excludedModules：调试器不应为其加载符号的模块的数组。支持通配符（例如：MyCompany.*.dll）。

"loadOnlyIncluded" 模式的属性

moduleFilter.includedModules：调试器应为其加载符号的模块的数组。支持通配符（例如：MyCompany.*.dll）。

moduleFilter.includeSymbolsNextToModules：如果为 true，则对于任何不在“includedModules”数组中的模块，调试器仍然会在模块本身和启动可执行文件旁边进行检查，但不会检查符号搜索列表中的路径。此选项默认为“true”。