Skip to content

[lldb-dap] Adding defaults to VSCode settings for user level defaults. #137694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 2, 2025
Merged

[lldb-dap] Adding defaults to VSCode settings for user level defaults. #137694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7de424d
[lldb-dap] Adding defaults to VSCode settings for user level defaults.
ashgti Apr 28, 2025
059ea3b
Updating the lldb-dap README about user setting defaults.
ashgti Apr 29, 2025
ef083af
Merge branch 'main' into lldb-dap-settings
ashgti Apr 29, 2025
25e7883
Breaking the 'configuration' into two settings groups for a better pr…
ashgti Apr 29, 2025
90c0cf2
Merge branch 'main' into lldb-dap-settings
ashgti May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 47 additions & 16 deletions lldb/tools/lldb-dap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ The extension requires the `lldb-dap` (formerly `lldb-vscode`) binary.
This binary is not packaged with the VS Code extension.

There are multiple ways to obtain this binary:
* Use the binary provided by your toolchain (for example `xcrun -f lldb-dap` on macOS) or contact your toolchain vendor to include it.
* Download one of the relase packages from the [LLVM release page](https://github.com/llvm/llvm-project/releases/). The `LLVM-19.1.0-{operating_system}.tar.xz` packages contain a prebuilt `lldb-dap` binary.
* Build it from source (see [LLDB's build instructions](https://lldb.llvm.org/resources/build.html)).

- Use the binary provided by your toolchain (for example `xcrun -f lldb-dap` on macOS) or contact your toolchain vendor to include it.
- Download one of the release packages from the [LLVM release page](https://github.com/llvm/llvm-project/releases/). The `LLVM-19.1.0-{operating_system}.tar.xz` packages contain a prebuilt `lldb-dap` binary.
- Build it from source (see [LLDB's build instructions](https://lldb.llvm.org/resources/build.html)).

By default, the VS Code extension will expect to find `lldb-dap` in your `PATH`.
Alternatively, you can explictly specify the location of the `lldb-dap` binary using the `lldb-dap.executable-path` setting.
Alternatively, you can explicitly specify the location of the `lldb-dap` binary using the `lldb-dap.executable-path` setting.

### Usage with other IDEs

Expand Down Expand Up @@ -144,7 +145,7 @@ instead of using the custom command `attachCommands`.
### Connect to a Debug Server on Another Machine

This connects to a debug server running on another machine with hostname
`hostnmame`. Which is debugging the program `/tmp/a.out` and listening on
`hostname`. Which is debugging the program `/tmp/a.out` and listening on
port `5678` of that other machine.

```javascript
Expand All @@ -162,7 +163,6 @@ to send an attach request to a debug server running on a different machine,
instead of custom command `attachCommands`.
The default hostname being used `localhost`.


```javascript
{
"name": "Local Debug Server",
Expand Down Expand Up @@ -212,7 +212,7 @@ specific key/value pairs:
| **customThreadFormat** | string | | Same as `customFrameFormat`, but for threads instead of stack frames.
| **displayExtendedBacktrace** | bool | | Enable language specific extended backtraces.
| **enableAutoVariableSummaries** | bool | | Enable auto generated summaries for variables when no summaries exist for a given type. This feature can cause performance delays in large projects when viewing variables.
| **enableSyntheticChildDebugging** | bool | | If a variable is displayed using a synthetic children, also display the actual contents of the variable at the end under a [raw] entry. This is useful when creating sythetic child plug-ins as it lets you see the actual contents of the variable.
| **enableSyntheticChildDebugging** | bool | | If a variable is displayed using a synthetic children, also display the actual contents of the variable at the end under a [raw] entry. This is useful when creating synthetic child plug-ins as it lets you see the actual contents of the variable.
| **initCommands** | [string] | | LLDB commands executed upon debugger startup prior to creating the LLDB target.
| **preRunCommands** | [string] | | LLDB commands executed just before launching/attaching, after the LLDB target has been created.
| **stopCommands** | [string] | | LLDB commands executed just after each stop.
Expand All @@ -221,8 +221,9 @@ specific key/value pairs:

All commands and command outputs will be sent to the debugger console when they are executed.
Commands can be prefixed with `?` or `!` to modify their behavior:
* Commands prefixed with `?` are quiet on success, i.e. nothing is written to stdout if the command succeeds.
* Prefixing a command with `!` enables error checking: If a command prefixed with `!` fails, subsequent commands will not be run. This is usefule if one of the commands depends on another, as it will stop the chain of commands.

- Commands prefixed with `?` are quiet on success, i.e. nothing is written to stdout if the command succeeds.
- Prefixing a command with `!` enables error checking: If a command prefixed with `!` fails, subsequent commands will not be run. This is useful if one of the commands depends on another, as it will stop the chain of commands.

For JSON configurations of `"type": "launch"`, the JSON configuration can additionally
contain the following key/value pairs:
Expand All @@ -243,10 +244,40 @@ the following `lldb-dap` specific key/value pairs:
| Parameter | Type | Req | |
|-----------------------------------|-------------|:---:|---------|
| **program** | string | | Path to the executable to attach to. This value is optional but can help to resolve breakpoints prior the attaching to the program.
| **pid** | number | | The process id of the process you wish to attach to. If **pid** is omitted, the debugger will attempt to attach to the program by finding a process whose file name matches the file name from **porgram**. Setting this value to `${command:pickMyProcess}` will allow interactive process selection in the IDE.
| **pid** | number | | The process id of the process you wish to attach to. If **pid** is omitted, the debugger will attempt to attach to the program by finding a process whose file name matches the file name from **program**. Setting this value to `${command:pickMyProcess}` will allow interactive process selection in the IDE.
| **waitFor** | boolean | | Wait for the process to launch.
| **attachCommands** | [string] | | LLDB commands that will be executed after **preRunCommands** which take place of the code that normally does the attach. The commands can create a new target and attach or launch it however desired. This allows custom launch and attach configurations. Core files can use `target create --core /path/to/core` to attach to core files.

### Configuring `lldb-dap` defaults

User settings can set the default value for the following supported
`launch.json` configuration keys:

| Parameter | Type | Default |
| --------------------------------- | -------- | :-----: |
| **commandEscapePrefix** | string | ``"`"`` |
| **customFrameFormat** | string | `""` |
| **customThreadFormat** | string | `""` |
| **detachOnError** | boolean | `false` |
| **disableASLR** | boolean | `true` |
| **disableSTDIO** | boolean | `false` |
| **displayExtendedBacktrace** | boolean | `false` |
| **enableAutoVariableSummaries** | boolean | `false` |
| **enableSyntheticChildDebugging** | boolean | `false` |
| **timeout** | number | `30` |
| **targetTriple** | string | `""` |
| **platformName** | string | `""` |
| **initCommands** | [string] | `[]` |
| **preRunCommands** | [string] | `[]` |
| **postRunCommands** | [string] | `[]` |
| **stopCommands** | [string] | `[]` |
| **exitCommands** | [string] | `[]` |
| **terminateCommands** | [string] | `[]` |

To adjust your settings, open the Settings editor via the
`File > Preferences > Settings` menu or press `Ctrl+`, on Windows/Linux and
`Cmd+`, on Mac.

## Debug Console

The Debug Console allows printing variables / expressions and executing lldb commands.
Expand Down Expand Up @@ -294,13 +325,13 @@ Inspect or adjust the behavior of lldb-dap repl evaluation requests. The
supported modes are `variable`, `command` and `auto`.

- `variable` - Variable mode expressions are evaluated in the context of the
current frame.
current frame.
- `command` - Command mode expressions are evaluated as lldb commands, as a
result, values printed by lldb are always stringified representations of the
expression output.
result, values printed by lldb are always stringified representations of the
expression output.
- `auto` - Auto mode will attempt to infer if the expression represents an lldb
command or a variable expression. A heuristic is used to infer if the input
represents a variable or a command.
command or a variable expression. A heuristic is used to infer if the input
represents a variable or a command.

In all three modes, you can use the `commandEscapePrefix` to ensure an expression
is evaluated as a command.
Expand Down Expand Up @@ -330,7 +361,7 @@ For example you can use a launch configuration hook to trigger custom events lik
"program": "exe",
"stopCommands": [
"lldb-dap send-event MyStopEvent",
"lldb-dap send-event MyStopEvent '{\"key\": 321}",
"lldb-dap send-event MyStopEvent '{\"key\": 321}"
]
}
```
Expand Down
Loading
Loading