Debug adapter protocol support #574

dsseng · 2021-08-12T13:47:06Z

Current state: an initial implementation of DAP with some types, editor connection. To test DAP client:

Create a debuggee program:

package main

import "fmt"

func main() {
	a := "Hello"
	b := "World"
	fmt.Println(a, b)
	for {
	}
}

#include <stdio.h>

void main() {
	char *a = "Hello";
	char *b = "World";
	printf("%s %s\n", a, b);
	while (1) {
	}
}

go build -gcflags '-N -l' main.go to build binary with readable variables or use :dbg source main.go for Go.
2.1. gcc main.c -o main -O0 -g for C program
3. Start up Delve (chosen as a monolithic DAP+debugger in one binary) on port 7777: dlv dap -l 127.0.0.1:7777
3.1. Or lldb: lldb-vscode -p 7777
Don't care about that, tcp_process transport will find free port and start debug adapter itself.
Run DAP example cargo run --example dap-dlv or dap-lldb
Press enter when you want to continue communicating to debugger.

Editor integration works with Go, C/C++ and Rust programs at the moment. ~~Just enter directory containing main.go/main (build output)/target/debug/rustdebug for Rust and work with it.~~ Now you need to specify target manually, see languages.toml
In editor I currently use example attached as a zip.
godebug.zip

TODO:

Local ``languages.toml` for Node:

[[language]]
name = "javascript"

[language.debugger]
command = "node"
args = [ "/usr/share/code-insiders/resources/app/extensions/ms-vscode.node-debug2/out/src/nodeDebug.js" ]

Adjust path to extension in VSCode (or location where you unpacked the extension manually).

helix-dap/src/client.rs

dsseng · 2021-08-12T19:00:50Z

I think that requests I have already implemented are sufficient to build a starter-level debug integration. Maybe output and other events now handled by client should be passed to application via a channel for usage like showing state in the status line.

Now the main task is to think about the way DAP client is built into the editor, maybe this PR will need to wait for some stuff like vars or stack trace components.

Helix needs a way to specify implementation-specific arguments (mainly for launch and attach): see dlv dap as an example of specific launch options.

archseer · 2021-08-13T01:43:01Z

By the way are you on Matrix? If not, feel free to join the development channel so we can discuss :)

archseer · 2021-08-13T01:46:46Z

Yeah I think we'll end up with something similar to the LSP config

https://github.com/emacs-lsp/dap-mode/blob/8ec7e98986ea46e3c36b7ecbdf9a6562c90c7632/dap-go.el#L52-L73

But there will also be a section to add different run types:

https://github.com/emacs-lsp/dap-mode/blob/8ec7e98986ea46e3c36b7ecbdf9a6562c90c7632/dap-go.el#L93-L150

I imagine we'd end up visualizing these in a picker.

Run
---
> Launch
  Attach

archseer · 2021-08-13T01:49:01Z

Note that delve requires the most config, here's lldb: https://github.com/emacs-lsp/dap-mode/blob/master/dap-lldb.el

I think delve is a good start though, and it's also the one I'll probably end up using the most (besides lldb).

helix-dap/src/client.rs

helix-dap/src/transport.rs

helix-dap/src/client.rs

dsseng · 2021-08-15T09:49:03Z

helix-dap/src/client.rs

+        port_format: &str,
+        id: usize,
+    ) -> Result<Self> {
+        let port = Self::get_port().await.unwrap();


This might have race condition in really rare situation (like lack of ports which might increase the probability):

We acquired ephemeral port from OS

Another process took it

Debug adapter fails to start because port is acquired by other process.

Part of LLDB integration

Only report present features now

I could not get one from codelldb

sudormrfbin

Seems like there's an off-by-one error when calculating cursor position returned from the debug server; hitting next always stops one character after the beginning of a variable. I have still not gone through the code completely, testing out the client first. Some kind of feedback on the current state of the debugger would also be nice (probably in the status line).

(We might want to include gitignored files to the path completion, used by the binary template for example since build directories are usually ignored.)

archseer · 2021-12-05T09:31:55Z

Yeah DAP uses 0-indexing by default, I think there's some missing conversions -- I changed up breakpoint tracking quite a lot over the last few commits.

sudormrfbin · 2021-12-05T07:30:52Z

helix-dap/src/client.rs

+    pub caps: Option<DebuggerCapabilities>,
+    // thread_id -> frames
+    pub stack_frames: HashMap<ThreadId, Vec<StackFrame>>,
+    pub thread_states: HashMap<ThreadId, String>,


Should thread_states map to an enum ? It seems like both the state and reason for the state change is stored here ("running", reason from StoppedEvent, etc).

It could be an enum if we hand an Other variant for it, the specification allows for custom reasons:

reason: 'started' | 'exited' | string;

helix-term/src/commands/dap.rs

sudormrfbin · 2021-12-05T15:48:48Z

helix-term/src/commands/dap.rs

+    if cx.editor.debugger.is_some() {
+        cx.editor
+            .set_error("Debugger is already running".to_string());
+        return;
+    }


editor.set_error(...); return; is becoming a common enough pattern across commands so much that I think it's better to have commands return a Result, similar to typable commands and handle setting the error in a single place. Better off as a separate PR though.

I've been thinking about this but I'm not sure. DAP/LSP commands need error handling, but most built in commands don't. I guess it would be nice for consistency?

Co-authored-by: Gokul Soumya <gokulps15@gmail.com>

helix-term/src/commands/dap.rs

sudormrfbin · 2021-12-07T15:04:32Z

helix-term/src/commands/dap.rs

+    })
+}
+
+pub fn dap_step_in(cx: &mut Context) {


step_in, step_out, next, etc all seem to share most of the code, differing only in the let request = debugger.step_in() part.

Not much we can do here since the future types are all different :/ only thing I can think of is a macro to generate these

dsseng · 2022-01-03T11:46:05Z

What work does it require to get this into master? Probably gdb and docs only, but not sure.
Merging master here caused build failure :(

archseer · 2022-01-03T13:25:37Z

Yeah I was holding back on merging master to avoid more merge commits and do it all at once just before merging the PR (at this point we have too many commits to cleanly rebase but I'd like to keep a clean history).

It's mostly ready for an initial merge, I rewrote all the UI components and was working on a tree style viewer for the variables but I got distracted with some other helix tickets. I'll release 0.6 tomorrow then merge this so that we can work in smaller follow-up PRs.

dsseng · 2022-01-03T13:40:33Z

Well, so no work really required on this now? Then it should be easier: merge this PR, but don't close the issue. Move TODO list there and it's the debug roadmap now!

archseer · 2022-02-14T01:03:01Z

Finally merged this! There's a bunch of work left to do, but it's easier if we don't have to maintain a separate branch.

dsseng · 2022-02-15T16:24:47Z

6 month PR :) Need to integrate gdb and then many other tasks will get unlocked

colemickens · 2022-02-22T21:50:34Z

Is there a reason you went with lldb-vscode instead of vscode-lldb? I ask because the former seems newer and only supported on Darwin?

archseer · 2022-02-23T03:31:56Z

lldb-vscode works fine for me on Linux, it came together with the lldb package on NixOS.

lldb-vscode is an official part of LLVM, and vscode-lldb seems to consist of two layers of wrappers around LLDB (lldb->typescript->python)

colemickens · 2022-02-23T07:49:10Z

It's a bit funny, earlier in the week and earlier in the day, this misnomer repo (github: lanza/lldb-vscode) came up much higher when searching for lldb-vscode than the lldb-vscode in lldb... . Of course after dozens of searches today, it's buried under vague but clear links to the official lldb version.

Anyway, my mistake, lldb-vscode definitely seems easier. Very nice to have rust debugging just work out of box as soon as helix could see lldb! Great feature, thanks @sh7dm !

lukepighetti · 2022-10-09T20:42:08Z

Does anyone have any guides to getting lldb-vscode working on macOS? I'm not finding many resources

AOx0 · 2022-11-02T03:35:02Z

Does anyone have any guides to getting lldb-vscode working on macOS? I'm not finding many resources
~ @lukepighetti

As stated in the wiki:

To simply install the default debugger that will work out of the box you need to:

Install LLVM.

Hence, you just need to install llvm with brew.

brew install llvm@14

LLVM comes with lldb-vscode bundled, but for it to work you have to add the bin folder where it is to the $PATH.

In fact, brew does tell you to add it to the $PATH when the installation ends, in my case for the fish shell, but yours may be zsh or bash, so follow the post-installation instructions it gives you:

llvm@14 is keg-only, which means it was not symlinked into /usr/local,
because this is an alternate version of another formula.

If you need to have llvm@14 first in your PATH, run:
  fish_add_path /usr/local/opt/llvm@14/bin
                                          
For compilers to find llvm@14 you may need to set:
  set -gx LDFLAGS "-L/usr/local/opt/llvm@14/lib"
  set -gx CPPFLAGS "-I/usr/local/opt/llvm@14/include"

dsseng mentioned this pull request Aug 12, 2021

Debugging support with DAP connection #505

Open

66 tasks

archseer reviewed Aug 12, 2021

View reviewed changes

helix-dap/src/client.rs Outdated Show resolved Hide resolved

archseer reviewed Aug 14, 2021

View reviewed changes

helix-dap/src/client.rs Outdated Show resolved Hide resolved

helix-dap/src/client.rs Show resolved Hide resolved

helix-dap/src/transport.rs Outdated Show resolved Hide resolved

dsseng commented Aug 14, 2021

View reviewed changes

helix-dap/src/transport.rs Outdated Show resolved Hide resolved

dsseng commented Aug 14, 2021

View reviewed changes

helix-dap/src/client.rs Outdated Show resolved Hide resolved

dsseng commented Aug 14, 2021

View reviewed changes

helix-dap/src/client.rs Outdated Show resolved Hide resolved

dsseng commented Aug 14, 2021

View reviewed changes

helix-dap/src/client.rs Outdated Show resolved Hide resolved

dsseng commented Aug 15, 2021

View reviewed changes

helix-dap/src/client.rs Outdated Show resolved Hide resolved

helix-dap/src/client.rs Outdated Show resolved Hide resolved

dsseng commented Aug 15, 2021

View reviewed changes

archseer force-pushed the debug branch from 9f033b1 to a7be926 Compare August 16, 2021 05:00

dsseng added 16 commits August 20, 2021 13:43

Add attach command

541f7a0

refactor server message handling

9678df1

refactor response processing

59d6b92

dispatch events in client

d6de540

client: handle events multiple times

c72475b

dap-basic: handle output events

09390be

dap-basic: better output formatting

0777948

dap-basic: parse stop event

b3be6b2

types: capitalize ID in names

cc650c7

Part of LLDB integration

compat: remove seq from Response and Event

c549278

compat: remove missing caps

43c9eba

Only report present features now

compat: add all possible debugger caps

e388079

compat: don't wait for launch and attach response

d4c215b

I could not get one from codelldb

format

809990a

dap: create C example

eb0605c

format

e7f543f

archseer added 2 commits December 3, 2021 13:29

dap: All of these calls don't need &mut

bcf70d8

dap: Add RunInTerminal reverse request, support replying to requests

5545f8e

sudormrfbin reviewed Dec 5, 2021

View reviewed changes

archseer and others added 4 commits December 6, 2021 09:32

Apply suggestions from code review

d5d1a9b

Co-authored-by: Gokul Soumya <gokulps15@gmail.com>

dap: Reply to RunInTerminal

2b4de41

Make thread_picker non-blocking

dc8df7b

clippy lint

bf8437d

sudormrfbin reviewed Dec 7, 2021

View reviewed changes

archseer added 5 commits December 8, 2021 00:22

dap: Fix an off-by-one error when jumping

e98993d

dap: Extract a macro that fetches a debugger or returns

d8351d3

dap: Simplify a few more statements that could use the debugger macro

60c86ef

TODO

dac317e

dap: Improve variables UI

df3b883

Omnikar mentioned this pull request Dec 25, 2021

Workspace runnables #1356

Closed

dsseng force-pushed the debug branch from 83b89c4 to df3b883 Compare January 3, 2022 11:43

kirawi mentioned this pull request Jan 20, 2022

WebAssembly plugins system #122

Closed

archseer merged commit df3b883 into helix-editor:master Feb 14, 2022

MAST1999 mentioned this pull request Oct 11, 2022

Set up debugger for Javascript/Typescript #4214

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debug adapter protocol support #574

Debug adapter protocol support #574

dsseng commented Aug 12, 2021 •

edited

dsseng commented Aug 12, 2021 •

edited

archseer commented Aug 13, 2021

archseer commented Aug 13, 2021

archseer commented Aug 13, 2021

dsseng Aug 15, 2021

sudormrfbin left a comment •

edited

archseer commented Dec 5, 2021

sudormrfbin Dec 5, 2021

archseer Dec 6, 2021

sudormrfbin Dec 5, 2021

archseer Dec 7, 2021

sudormrfbin Dec 7, 2021

archseer Dec 7, 2021

dsseng commented Jan 3, 2022

archseer commented Jan 3, 2022

dsseng commented Jan 3, 2022

archseer commented Feb 14, 2022

dsseng commented Feb 15, 2022

colemickens commented Feb 22, 2022

archseer commented Feb 23, 2022

colemickens commented Feb 23, 2022

lukepighetti commented Oct 9, 2022

AOx0 commented Nov 2, 2022 •

edited

Debug adapter protocol support #574

Debug adapter protocol support #574

Conversation

dsseng commented Aug 12, 2021 • edited

TODO:

dsseng commented Aug 12, 2021 • edited

archseer commented Aug 13, 2021

archseer commented Aug 13, 2021

archseer commented Aug 13, 2021

dsseng Aug 15, 2021

Choose a reason for hiding this comment

sudormrfbin left a comment • edited

Choose a reason for hiding this comment

archseer commented Dec 5, 2021

sudormrfbin Dec 5, 2021

Choose a reason for hiding this comment

archseer Dec 6, 2021

Choose a reason for hiding this comment

sudormrfbin Dec 5, 2021

Choose a reason for hiding this comment

archseer Dec 7, 2021

Choose a reason for hiding this comment

sudormrfbin Dec 7, 2021

Choose a reason for hiding this comment

archseer Dec 7, 2021

Choose a reason for hiding this comment

dsseng commented Jan 3, 2022

archseer commented Jan 3, 2022

dsseng commented Jan 3, 2022

archseer commented Feb 14, 2022

dsseng commented Feb 15, 2022

colemickens commented Feb 22, 2022

archseer commented Feb 23, 2022

colemickens commented Feb 23, 2022

lukepighetti commented Oct 9, 2022

AOx0 commented Nov 2, 2022 • edited

dsseng commented Aug 12, 2021 •

edited

dsseng commented Aug 12, 2021 •

edited

sudormrfbin left a comment •

edited

AOx0 commented Nov 2, 2022 •

edited