feat(dap): support dynamically compiled executable #64

bas-ie · 2023-11-18T06:42:17Z

This:

configures dyanmic library paths by default (with the ability to disable)
loads Rust type information in lldb-vscode by default (with the ability to disable)
looks for and uses lldb-dap if present (on newer installations, this will replace lldb-vscode) ... which now that I've rebased, I see you already did!
corrects a bug with source map configuration (I think this was not being set in the final configuration?)
removes newlines that were interfering with rustc_sysroot path (because they came from reading stdout)
fixes a pattern matching issue that seemed to be preventing the commit hash being detected correctly

Sorry for cramming so many little bits and pieces in at once, this is basically just a "fix some of the things that were blockers for me with lldb-vscode". My main use-case was to get Bevy engine debugging working, which this does.

I'm submitting it as a WIP so you can have a quick scan and tell me if you agree with the approach, as I don't write a great deal of Lua and there are probably some wildly non-idiomatic things you can point out! I've tried to follow the overall approach of what was there before though.

I'll look at adding some tests and tidying up tomorrow.

lua/rustaceanvim/dap.lua

mrcjkb · 2023-11-18T16:55:02Z

Thanks. This looks great!
I'll give it a closer look and test drive it on NixOS over the weekend.

bas-ie · 2023-11-18T18:43:57Z

I noticed an issue with sourcemaps crop up too, I haven't got that quite right yet:

Running initCommands:
(lldb) command script import "/home/basie/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/etc/lldb_lookup.py"
(lldb) command script import "/home/basie/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/etc/lldb_lookup.py"
(lldb) type synthetic add -l lldb_lookup.synthetic_lookup -x ".*" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)String$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?str$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?\\[.+\\]$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::ffi::([a-z_]+::)+)OsString$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Vec<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)VecDeque<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Rc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Arc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Cell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Ref<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefMut<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefCell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^core::num::([a-z_]+::)*NonZero.+$" --category Rust
(lldb) type category enable Rust
(lldb) type synthetic add -l lldb_lookup.synthetic_lookup -x ".*" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)String$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?str$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?\\[.+\\]$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::ffi::([a-z_]+::)+)OsString$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Vec<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)VecDeque<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Rc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Arc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Cell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Ref<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefMut<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefCell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^core::num::([a-z_]+::)*NonZero.+$" --category Rust
(lldb) type category enable Rust
source must be be an array of two-element arrays, each containing a source and replacement path string.
Hello, world!

The initCommands look fine, but I'm formatting sourcemaps wrong somehow.

I wonder if I can find an easy-ish way of running the nix tests. Would they run in a VM?

bas-ie · 2023-11-18T20:09:09Z

Oh, I see... I can

sudo nix flake check -L \
  --extra-experimental-features nix-command \
  --extra-experimental-features flakes

and get at least the results of what would happen in GHA.

lua/rustaceanvim/config/internal.lua

lua/rustaceanvim/config/init.lua

lua/rustaceanvim/config/internal.lua

lua/rustaceanvim/dap.lua

lua/rustaceanvim/shell.lua

mrcjkb · 2023-11-18T23:41:26Z

I noticed an issue with sourcemaps crop up too, I haven't got that quite right yet:

Running initCommands:
(lldb) command script import "/home/basie/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/etc/lldb_lookup.py"
(lldb) command script import "/home/basie/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/etc/lldb_lookup.py"
(lldb) type synthetic add -l lldb_lookup.synthetic_lookup -x ".*" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)String$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?str$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?\\[.+\\]$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::ffi::([a-z_]+::)+)OsString$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Vec<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)VecDeque<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Rc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Arc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Cell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Ref<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefMut<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefCell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^core::num::([a-z_]+::)*NonZero.+$" --category Rust
(lldb) type category enable Rust
(lldb) type synthetic add -l lldb_lookup.synthetic_lookup -x ".*" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)String$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?str$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^&(mut )?\\[.+\\]$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::ffi::([a-z_]+::)+)OsString$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Vec<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)VecDeque<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)BTreeMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashMap<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(std::collections::([a-z_]+::)+)HashSet<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Rc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(alloc::([a-z_]+::)+)Arc<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Cell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)Ref<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefMut<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^(core::([a-z_]+::)+)RefCell<.+>$" --category Rust
(lldb) type summary add -F lldb_lookup.summary_lookup  -e -x -h "^core::num::([a-z_]+::)*NonZero.+$" --category Rust
(lldb) type category enable Rust
source must be be an array of two-element arrays, each containing a source and replacement path string.
Hello, world!

The initCommands look fine, but I'm formatting sourcemaps wrong somehow.

I wonder if I can find an easy-ish way of running the nix tests. Would they run in a VM?

🤔 This bit:

source must be be an array of two-element arrays, each containing a source and replacement path string.

... makes me think I may have got the structure of sourceMap wrong. I guess it's supposed to be a list of tuples, not a map. I'll look into this in a separate PR.

lua/rustaceanvim/shell.lua

mrcjkb · 2023-11-19T01:07:59Z

I've just pushed a fix for the sourceMap (see #68).
It seems to work for me. Sorry for causing a merge conflict 😦

mrcjkb · 2023-11-19T01:09:21Z

Oh, I see... I can
sudo nix flake check -L \
  --extra-experimental-features nix-command \
  --extra-experimental-features flakes
and get at least the results of what would happen in GHA.

You can also add those flags to your nix.conf 😄

bas-ie · 2023-11-19T20:43:33Z

Thanks for the tips, will revise in next day or so.

- adds add_dynamic_library_paths - adds load_rust_types

bas-ie · 2023-11-25T22:49:27Z

@mrcjkb Hello! Finally managed to circle back to this. I think I've addressed the outstanding issues. Wonder if it's worth getting it merged to save on conflicts, and I'll address testing in a separate PR? But up to you obviously.

bas-ie · 2023-11-25T22:51:26Z

Oh, and could you enable checks on this PR please? Thx!

bas-ie · 2023-11-25T23:02:09Z

Actually, looking at the current tests I might need a tiny bit of guidance on what to test so I don't end up wasting your time 🙂

mrcjkb · 2023-11-26T10:13:54Z

Awesome 🚀

I don't have time today, but I should be able to look at this tomorrow.
Regarding tests: I still have to figure out how to get integration tests that depend on external tools, like rust-analyzer, working.
So for now, I think the manual tests are fine. I will think about integration tests myself when I have some more capacity for it.

mrcjkb

I just tested this manually with both lldb and codelldb.

With lldb, everything seems to work fine.
With codelldb, I get: Error on launch: Could not parse launch configuration: invalid type: sequence, expected a map

Note: I have force-pushed a rebase to your branch. As the fixes are relatively small, I will see if I have time to fix them myself 😄

lua/rustaceanvim/dap.lua

mrcjkb · 2023-11-27T08:20:34Z

lua/rustaceanvim/dap.lua

+        'DKLD_LIBRARY_PATH=' .. rustc_target_path .. sep .. target_path .. sep .. '$DYLD_LIBRARY_PATH'
+      )
+    else
+      table.insert(


issue: As with init_commands previously, environment will grow indefinitely. We can prevent this in the same way, by using a table with the workspace root as the key.

Shoot, yep ty will fix.

Oh nvm, I see you're on it :) I'll keep looking at the launch.json thing.

mrcjkb · 2023-11-27T09:13:41Z

Merging into another branch where I can implement the fixes for codelldb and environment.

Thanks for the great contribution @richchurcher!

mrcjkb · 2023-11-27T09:35:03Z

Continuing in #72

Co-authored-by: Rich Churcher <rich.churcher@gmail.com>

bas-ie force-pushed the feat/support-dynamic-libs branch from 9edccf1 to 43f32b0 Compare November 18, 2023 06:45

bas-ie commented Nov 18, 2023

View reviewed changes

lua/rustaceanvim/dap.lua Outdated Show resolved Hide resolved

bas-ie force-pushed the feat/support-dynamic-libs branch 2 times, most recently from d7d05db to a58b7c7 Compare November 18, 2023 07:55

mrcjkb requested changes Nov 18, 2023

View reviewed changes

This was referenced Nov 18, 2023

Replace deprecated vim.loop calls with compat.uv. #65

Closed

Extend dap.configurations.rust with discovered configurations, then use that in RustLsp debuggables #66

Closed

mrcjkb reviewed Nov 18, 2023

View reviewed changes

lua/rustaceanvim/shell.lua Show resolved Hide resolved

mrcjkb mentioned this pull request Nov 19, 2023

dap: await source map population before starting debugger #69

Closed

bas-ie force-pushed the feat/support-dynamic-libs branch from 454662d to 599231f Compare November 25, 2023 22:32

feat(dap): support dynamically compiled executable

3107caf

- adds add_dynamic_library_paths - adds load_rust_types

bas-ie force-pushed the feat/support-dynamic-libs branch 2 times, most recently from 1c93809 to 3107caf Compare November 25, 2023 22:44

bas-ie marked this pull request as ready for review November 25, 2023 22:48

mrcjkb enabled auto-merge (squash) November 26, 2023 00:10

bas-ie requested a review from mrcjkb November 26, 2023 01:22

Merge branch 'master' into feat/support-dynamic-libs

28a8887

mrcjkb disabled auto-merge November 27, 2023 07:45

mrcjkb requested changes Nov 27, 2023

View reviewed changes

mrcjkb and others added 2 commits November 27, 2023 10:00

chore(dap): use os.getenv to append environment variables

d579cfc

Merge branch 'master' into feat/support-dynamic-libs

1cbd852

mrcjkb changed the base branch from master to support-dynamic-libs-fixes November 27, 2023 09:11

mrcjkb merged commit 9f27450 into mrcjkb:support-dynamic-libs-fixes Nov 27, 2023
4 of 5 checks passed

mrcjkb added a commit that referenced this pull request Nov 27, 2023

fix(#64): compatibility with both lldb and codelldb

c29f028

mrcjkb added a commit that referenced this pull request Nov 27, 2023

feat(dap): support dynamically compiled executable (#64) (#72)

773110e

Co-authored-by: Rich Churcher <rich.churcher@gmail.com>

bas-ie deleted the feat/support-dynamic-libs branch November 27, 2023 20:38

mrcjkb mentioned this pull request Nov 28, 2023

fix(dap): lldb library paths are strings #74

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(dap): support dynamically compiled executable #64

feat(dap): support dynamically compiled executable #64

bas-ie commented Nov 18, 2023 •

edited

Loading

mrcjkb commented Nov 18, 2023

bas-ie commented Nov 18, 2023

bas-ie commented Nov 18, 2023

mrcjkb commented Nov 18, 2023

mrcjkb commented Nov 19, 2023

mrcjkb commented Nov 19, 2023

bas-ie commented Nov 19, 2023

bas-ie commented Nov 25, 2023

bas-ie commented Nov 25, 2023

bas-ie commented Nov 25, 2023

mrcjkb commented Nov 26, 2023

mrcjkb left a comment

mrcjkb Nov 27, 2023

bas-ie Nov 27, 2023

bas-ie Nov 27, 2023

mrcjkb commented Nov 27, 2023

mrcjkb commented Nov 27, 2023

feat(dap): support dynamically compiled executable #64

feat(dap): support dynamically compiled executable #64

Conversation

bas-ie commented Nov 18, 2023 • edited Loading

mrcjkb commented Nov 18, 2023

bas-ie commented Nov 18, 2023

bas-ie commented Nov 18, 2023

mrcjkb commented Nov 18, 2023

mrcjkb commented Nov 19, 2023

mrcjkb commented Nov 19, 2023

bas-ie commented Nov 19, 2023

bas-ie commented Nov 25, 2023

bas-ie commented Nov 25, 2023

bas-ie commented Nov 25, 2023

mrcjkb commented Nov 26, 2023

mrcjkb left a comment

Choose a reason for hiding this comment

mrcjkb Nov 27, 2023

Choose a reason for hiding this comment

bas-ie Nov 27, 2023

Choose a reason for hiding this comment

bas-ie Nov 27, 2023

Choose a reason for hiding this comment

mrcjkb commented Nov 27, 2023

mrcjkb commented Nov 27, 2023

bas-ie commented Nov 18, 2023 •

edited

Loading