How can I use the `vsdbg` adapter? #869

arkaragian · 2023-02-21T11:46:22Z

arkaragian
Feb 21, 2023

I am trying to implement a plugin for C# support in neovim. One feature that I would really like to implement would be to be able to
execute a single unit test that contains a breakpoint. I cannot figure how to make this with the netcoredbg project and I was experimenting with https://github.com/OmniSharp/omnisharp-vscode. If you download the release and unzip the file you get access
to the vsdbg executable that seems to have the same interface with the netcoredbg executable. So I made an adapter:

dap.adapters.vsdbg= {
  type = 'executable',
  command = 'vsdbg',
  args = {'--interpreter=vscode', '--engineLogging='..home..'/vsdbg.log'},
}

and in my cs configuration:

dap.configurations.cs = {
    {
        --type = "netcoredbg",
        type = "vsdbg",
        name = "Launch CS Debugger",
        request = "launch",
        program = vim.fn.input('Path to dll: ', vim.fn.getcwd() .. '/bin/', 'file')
        end
    }
}

and tried to execute a test.dll and got the following error:

E5108: Error executing lua ...kar\AppData\Local\nvim-data\plugged\nvim-dap/lua/dap.lua:484: ...ata\Local\nvim-data\plugged\nvim-dap/lua/dap/session.lua:1217: Error running vsdbg: ENOENT: no such file or directory

Bellow are the logs I feel that there must be a mismatch on the sequences or the vscode debuger refuses to speak to non vscode dap clients. Has anyone tried this before?
Command Seq 0:

{
  "type": "request",
  "command": "initialize",
  "seq": 0,
  "arguments": {
    "clientId": "neovim",
    "clientname": "neovim",
    "adapterID": "nvim-dap",
    "pathFormat": "path",
    "columnsStartAt1": true,
    "linesStartAt1": true,
    "supportsRunInTerminalRequest": true,
    "supportsVariableType": true,
    "supportsProgressReporting": true,
    "locale": "en_US"
  }
}

Response Seq 1:

{
  "seq": 1,
  "type": "response",
  "request_seq": 0,
  "success": false,
  "command": "initialize",
  "message": "",
  "body": {
    "supportsConfigurationDoneRequest": true,
    "supportsFunctionBreakpoints": true,
    "supportsConditionalBreakpoints": true,
    "supportsHitConditionalBreakpoints": true,
    "supportsEvaluateForHovers": true,
    "exceptionBreakpointFilters": [
      {
        "filter": "all",
        "label": "All Exceptions",
        "description": "Break when an exception is thrown. ",
        "default": false,
        "supportsCondition": true
      }
    ],
    "supportsSetVariable": true,
    "supportsGotoTargetsRequest": true,
    "supportsModulesRequest": true,
    "additionalModuleColumns": [
      {
        "attributeName": "vsLoadAddress",
        "label": "Load Address",
        "type": "string"
      },
      {
        "attributeName": "vsPreferredLoadAddress",
        "label": "Preferred Load Address",
        "type": "string"
      },
      {
        "attributeName": "vsModuleSize",
        "label": "Module Size",
        "type": "number"
      },
      {
        "attributeName": "vsLoadOrder",
        "label": "Order",
        "type": "number"
      },
      {
        "attributeName": "vsTimestampUTC",
        "label": "Timestamp",
        "type": "unixTimestampUTC"
      },
      {
        "attributeName": "vsIs64Bit",
        "label": "64-bit",
        "type": "boolean"
      }
    ],
    "supportedChecksumAlgorithms": [
      "MD5",
      "SHA1",
      "SHA256"
    ],
    "supportsExceptionOptions": true,
    "supportsValueFormattingOptions": true,
    "supportsExceptionInfoRequest": true,
    "supportTerminateDebuggee": true,
    "supportsSetExpression": true,
    "supportsReadMemoryRequest": true,
    "supportsCancelRequest": true,
    "supportsExceptionFilterOptions": true,
    "supportsExceptionConditions": true,
    "supportsLoadSymbolsRequest": true,
    "supportsModuleSymbolSearchLog": true,
    "supportsDebuggerProperties": true,
    "supportsSetSymbolOptions": true,
    "supportsHitBreakpointIds": true,
    "supportsVsIndividualBreakpointOperations": true,
    "supportsVsBreakpointLanguage": true,
    "supportsSetHitCount": true,
    "supportsVsCustomMessages": true,
    "supportsEvaluationOptions": true,
    "supportsExceptionStackTrace": true,
    "memoryReferencesAreAddresses": true,
    "supportsObjectFavorites": true,
    "supportsObjectId": true,
    "supportsVariableEnumerators": false
  }
}

Command Seq 1:

{
  "type": "request",
  "command": "disconnect",
  "seq": 1,
  "arguments": {
    "terminateDebuggee": true,
    "restart": false
  }
}

Event Seq 2:

{
  "seq": 2,
  "type": "event",
  "event": "output",
  "body": {
    "category": "telemetry",
    "output": "VS/Diagnostics/Debugger/vsdbg/DebugCompleted",
    "data": {
      "VS.Diagnostics.Debugger.vsdbg.OSFamily": "Windows",
      "VS.Diagnostics.Debugger.vsdbg.Version": "unknown",
      "VS.Diagnostics.Debugger.vsdbg.WindowsVersion": "10.0.19044",
      "VS.Diagnostics.Debugger.vsdbg.DebugCompleted.BreakCounter": 0,
      "VS.Diagnostics.Debugger.vsdbg.AdapterId": "unknown"
    }
  }
}

Response Seq 3

{
  "seq": 3,
  "type": "response",
  "request_seq": 1,
  "success": true,
  "command": "disconnect"
}

mfussenegger · 2023-02-22T16:24:19Z

mfussenegger
Feb 22, 2023
Maintainer

Error running vsdbg: ENOENT: no such file or directory

vsdbg is not in your $PATH. You need to add it or specify the absolute path to it.

2 replies

arkaragian Feb 23, 2023
Author

Hello! Thank you for your reply. I have verified that vsdbg is in by path now I just get a vim notification with the message

ERROR Could not initialize debug adapter

The Dap log displays:

[ INFO ] 2023-02-23T23:17:29Z+0200 ] ...ata\Local\nvim-data\plugged\nvim-dap/lua/dap/session.lua:695 ]	"Telemetry"	"VS/Diagnostics/Debugger/vsdbg/DebugCompleted"
[ INFO ] 2023-02-23T23:17:29Z+0200 ] ...ata\Local\nvim-data\plugged\nvim-dap/lua/dap/session.lua:1584 ]	"Session closed due to disconnect"

at this point I don't know if vsdbg refuses to speak to non vscode adapters or if there is a real issue here.

mfussenegger Feb 24, 2023
Maintainer

Is there nothing else in the logs? Can you try changing the log level to trace?

lawrence-laz · 2023-06-18T22:17:09Z

lawrence-laz
Jun 18, 2023

Have you managed to get this running?

0 replies

arkaragian · 2023-06-20T20:12:33Z

arkaragian
Jun 20, 2023
Author

Hello. To be honest I have yet to find time to really have a look into the issue. This question relates to my effort to really adopt neovim for everyday development as a replacement for VSCode or VS on a windows machine. @mfussenegger has been very helpful. But I really need to research this more.

0 replies

pinbraerts · 2023-07-15T19:49:07Z

pinbraerts
Jul 15, 2023

Launched vsdbg.exe with

dap.adapters.cppvsdbg = {
    id = 'cppvsdbg',
    type = 'executable',
    command = 'D:\\vscode\\cppdbg\\extension\\debugAdapters\\vsdbg\\bin\\vsdbg.exe',
    args = {
        '--interpreter=vscode',
    },
    options = { detached = false, },
}
dap.set_log_level 'trace' -- for log output

Also tried to mimic vscode in nvim-dap/lua/dap/session.lua (1647)

    clientId = 'vscode';
    clientname = 'Visual Studio Code';

In all cases vsdbg.exe rejects the handshake with a quote from the license:

You may only use the C/C++ Extension for Visual Studio Code
with Visual Studio Code, Visual Studio or Visual Studio for Mac
software to help you develop and test your applications.

dap.log

[ DEBUG ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:1605 ]	"request"	{
  arguments = {
    clientId = "vscode",
    clientname = "vscode",
    cwd = "C:\\Users\\pinbraerts\\src",
    name = "Launch file",
    program = "main.exe",
    request = "launch",
    stopAtEntry = false,
    type = "cppvsdbg"
  },
  command = "launch",
  seq = 1,
  type = "request"
}
[ DEBUG ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:936 ]	4	{
  arguments = {
    value = "l5mmDzf3TIVR9Mrc4TdFk6Y/jea4WMQHZ9gRvxesbN8="
  },
  command = "handshake",
  seq = 2,
  type = "request"
}
[ WARN ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:994 ]	"No handler for reverse request"	{
  arguments = {
    value = "l5mmDzf3TIVR9Mrc4TdFk6Y/jea4WMQHZ9gRvxesbN8="
  },
  command = "handshake",
  seq = 2,
  type = "request"
}
[ DEBUG ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:936 ]	4	{
  body = {
    category = "console",
    output = "-------------------------------------------------------------------\nYou may only use the C/C++ Extension for Visual Studio Code\nwith Visual Studio Code, Visual Studio or Visual Studio for Mac\nsoftware to help you develop and test your applications.\n-------------------------------------------------------------------\n",
    severity = "ok"
  },
  event = "output",
  seq = 3,
  type = "event"
}

0 replies

tsioryhaja · 2024-01-14T06:04:52Z

tsioryhaja
Jan 14, 2024

The debug adapter actually use that handshake to verify if you are using it with VSCode or not. so you will need to respond to that handshake request if you want it to work.

I don't know for .Net as I'm not really into it but for C/C++, this is how I do it:
First thing, you will need to have VSCode installed with the cpptools extension.
Next, you need to make a node js code to sign the handshake request value. It uses a custom Native Nodejs plugin so we wont easily make a copy of it in another language. This is a exemple of what I use written in typescript:

declare module vsda {
	export class signer {
		sign(arg: string): string;
	}
	export class validator {
		createNewMessage(arg: string): string;
		validate(arg: string): 'ok' | 'error';
	}
}
const vsda_location = '[VSCODE_INSTALL_DIR]\\resources\\app\\node_modules.asar.unpacked\\vsda\\build\\Release\\vsda.node';
const a: typeof vsda = require(vsda_location);
const signer: vsda.signer = new a.signer();
process.argv.forEach((value, index, array) => {
  if (index >= 2) {
    const r = signer.sign(value);
    console.log(r);
  }
});

And next, you will need to make a handler for the handshake request that use the node js code we just made.
I use something like this with "sign.js" being the transpiled version of the typescript code above:

local utils = require('dap.utils')

local rpc = require('dap.rpc')

local function send_payload(client, payload)
  local msg = rpc.msg_with_content_length(vim.json.encode(payload))
  client.write(msg)
end

function RunHandshake(self, request_payload)
  local signResult = io.popen('node C:\\debugadapter\\vsdbgsignature\\sign.js ' .. request_payload.arguments.value)
  if signResult == nil then
    utils.notify('error while signing handshake', vim.log.levels.ERROR)
    return
  end
  local signature = signResult:read("*a")
  signature = string.gsub(signature, '\n', '')
  local response = {
    type = "response",
    seq = 0,
    command = "handshake",
    request_seq = request_payload.seq,
    success = true,
    body = {
      signature = signature
    }
  }
  send_payload(self.client, response)
end

Next for my debug adapter setup I use this:

dap.adapters.cppvsdbg = {
	id='cppvsdbg',
	type='executable',
  command = '[USER_PROFILE_LOCATION]\\.vscode\\extensions\\ms-vscode.cpptools-1.18.5-win32-x64\\debugAdapters\\vsdbg\\bin\\vsdbg.exe',
  args = { "--interpreter=vscode" },
	options = {
    externalTerminal = true,
    -- logging = {
    --   moduleLoad = false,
    --   trace = true
    -- }
	},
  runInTerminal =  true,
  reverse_request_handlers = {
    handshake = RunHandshake,

  },
}

and for the configuration I use this:

dap.configurations.cpp = {
  {
    name = 'Try vsdbg',
    type = "cppvsdbg",
    request = "launch",
    program = function ()
      return vim.fn.input('Path: ', vim.fn.getcwd() .. '\\Debug\\test.exe', 'file')
    end,
    cwd = vim.fn.getcwd(),
    clientID = 'vscode',
    clientName = 'Visual Studio Code',
    externalTerminal = true,
    columnsStartAt1 = true,
    linesStartAt1 = true,
    locale = "en",
    pathFormat = "path",
    externalConsole = true
    -- console = "externalTerminal"
  },
}

and last thing, it's to be discussed but I noticed that the "stackTrace" request actually result in an error. This is I think to be discussed with the owner of the lib what he think should be done but it actually have some difference with the specification of the DAP.

I the specification, in the "stackTrace" arguments, the field "startFrame" is not required and should be used as a 0 by the debug adapter if not specified. But vsdbg actually require you to specify it. So for the moment, I modified a bit my local copy of nvim-dap to set this field to 0. But I don't know if the lib actually want that too.

5 replies

Ryex Jul 7, 2024

I just want to thank you for this very through walk through. I was able to get vsdbg working in neovim and no longer need to go back to vscode to have a working debugger for MSVC compiled programs

lawrence-laz Jul 13, 2024

Has anyone gotten this to work with .NET?

abdurahman-tg Jul 16, 2024

@tsioryhaja Thank you so much for this walkthrough! With this guide, I could get it to work fairly quickly.

I the specification, in the "stackTrace" arguments, the field "startFrame" is not required and should be used as a 0 by the debug adapter if not specified. But vsdbg actually require you to specify it. So for the moment, I modified a bit my local copy of nvim-dap to set this field to 0. But I don't know if the lib actually want that too.

@mfussenegger Do you think this is something that should be in main?

Specifically it's in lua/dap/session.lua line 706:
local err, response = self:request('stackTrace', { startFrame = 0, threadId = stopped.threadId; })

(Notice that startFrame = 0 was added to the original code)

Without this, the vsdbg.exe debugger does not work. If it does not affect anything else, I assume it should be fine adding this? I do understand if not though, because this really is an edge case.

Possibly as a configuration option?

By the way, thank you for all your awesome plugins!

tsioryhaja Aug 4, 2024

Happy I could help.

@lawrence-laz I just tried with a minimal code for C#. I don't know if it will work on a bigger project but to get it work for a .Net core project (still not able to do it for .Net framework project) I did this:

First instead of installing the cpptools plugin you should install the c# plugin and use the vsdbg-ui.exe executable inside it.
It should be something like this depending of the version of the installed plugins:
C:\Users\user_name.vscode\extensions\ms-dotnettools.csharp-2.39.29-win32-x64.debugger\x86_64\vsdbg-ui.exe.

Everything else is the same, you will have to build your project first then for the program field in the configuration, you should use the exe file that was generated.
for my test I used something like this:
program=function () return vim.fn.input('Path: ', vim.fn.getcwd() .. '\\bin\\Debug\\net7.0\\test.exe', 'file') end,
I will test for a ASP.Net core project when I have the time but for a small minimal console program it works.

marcinjahn May 4, 2025

@tsioryhaja I followed your steps (for .NET C#), and it fails on initialization of debugging session.
I have this log:

[DEBUG] 2025-05-04 09:11:40 dap/session.lua:1514	"Spawning debug adapter"	{
  args = { "--interpreter=vscode" },
  command = "/home/mnj/bin/vsdbg-old/vsdbg-ui",
  id = "csvsdbg",
  options = {
    externalTerminal = true,
    logging = {
      moduleLoad = true,
      trace = true
    }
  },
  reverse_request_handlers = {
    handshake = <function 1>
  },
  runInTerminal = true,
  type = "executable"
}
[DEBUG] 2025-05-04 09:11:40 dap/session.lua:1853	"request"	{
  arguments = {
    adapterID = "csvsdbg",
    clientID = "neovim",
    clientName = "neovim",
    columnsStartAt1 = true,
    linesStartAt1 = true,
    locale = "en_US.UTF-8",
    pathFormat = "path",
    supportsProgressReporting = true,
    supportsRunInTerminalRequest = true,
    supportsStartDebuggingRequest = true,
    supportsVariableType = true
  },
  command = "initialize",
  seq = 1,
  type = "request"
}
[DEBUG] 2025-05-04 09:11:40 dap/session.lua:1049	1	{
  body = {
    category = "telemetry",
    data = {
      ["VS.Diagnostics.Debugger.vsdbg.AdapterId"] = "unknown",
      ["VS.Diagnostics.Debugger.vsdbg.Command"] = "initialize",
      ["VS.Diagnostics.Debugger.vsdbg.Distribution.Name"] = "fedora",
      ["VS.Diagnostics.Debugger.vsdbg.Distribution.Version"] = "42",
      ["VS.Diagnostics.Debugger.vsdbg.ErrorCode"] = -2147467259,
      ["VS.Diagnostics.Debugger.vsdbg.OSFamily"] = "Linux",
      ["VS.Diagnostics.Debugger.vsdbg.Version"] = "unknown"
    },
    output = "VS/Diagnostics/Debugger/vsdbg/CommandFailed"
  },
  event = "output",
  seq = 1,
  type = "event"
}

The thing that is a bit odd is:

    clientID = "neovim",
    clientName = "neovim",

In the adapter configuration I copied from your example, you specifically set:

    clientID = 'vscode',
    clientName = 'Visual Studio Code',

but somehow it's not used? Did anything change in dap in the meantime? I tried to "force" the correct values by modifying dap source code, but even with those values set, the initializaton fails all the same.

On the vsdbg side, I tried to use exactly the same version you used in your example (2.39.29), but that did not help.

cagechi · 2024-09-05T06:45:29Z

cagechi
Sep 5, 2024

Excellent!!
It worked both .Net and dotnet-script.
But I see that the standard output is not output to dap console, but to the background terminal.

0 replies

cagechi · 2025-04-15T05:57:34Z

cagechi
Apr 15, 2025

require('dap').defaults.fallback.exception_breakpoints = { "raised" } does not work.
If I call require(“dap”).set_exception_breakpoints() after the session starts, it works.
I tried the following, but it still does not work.

dap.listeners.after.event_initialized["set_exception_breakpoints"] = function() 
  dap.set_exception_breakpoints({"raised", "uncaught"}) 
end

Is there any way to handle this?

2 replies

Inurias May 6, 2025

@cagechi could you please share your C# DAP config? I adapted the above C++ example for C# using the vscode-csharp plugin, but the initialize request fails when starting the debug session, like it does for @marcinjahn

cagechi May 6, 2025

@Inurias

My DAP config is as follows.

-- vsdbg certification
local function send_payload(client, payload)
  local msg = rpc.msg_with_content_length(vim.json.encode(payload))
  client.write(msg)
end

-- See https://github.com/mfussenegger/nvim-dap/discussions/869#discussioncomment-8121995 for contents of file vsdbgsignature
local SIGNJS = CONFIG_PATH:gsub("/", "\\") .. "\\vsdbgsignature.js"

function RunHandshake(self, request_payload)
  local signResult = io.popen("node " .. SIGNJS .. " " .. request_payload.arguments.value)
  if signResult == nil then
    dap_utils.notify('error while signing handshake', vim.log.levels.ERROR)
    return
  end
  local signature = signResult:read("*a")
  signature = string.gsub(signature, '\n', '')
  local response = {
    type = "response",
    seq = 0,
    command = "handshake",
    request_seq = request_payload.seq,
    success = true,
    body = {
      signature = signature
    }
  }
  send_payload(self.client, response)
end

dap.adapters.coreclr = {
  id = 'coreclr',
  type = 'executable',
  command = "vsdbg-ui.exe path", -- Note: Please include the actual path!
  args = {
    "--interpreter=vscode",
    -- "--engineLogging",
    -- "--consoleLogging",
  },
  options = {
    externalTerminal = true,
  },
  runInTerminal = true,
  reverse_request_handlers = {
    handshake = RunHandshake,
  },
}

dap.configurations.cs = {
    type = "coreclr",
    name = "Launch",
    request = "launch",
    program = "dotnet exe path",-- Note: Please include the actual path!
    args = {},
    cwd = vim.fn.getcwd(),
    clientID = 'vscode',
    clientName = 'Visual Studio Code',
    externalTerminal = true,
    columnsStartAt1 = true,
    linesStartAt1 = true,
    locale = "en",
    pathFormat = "path",
    externalConsole = true
}

Uh oh!

How can I use the vsdbg adapter? #869

Uh oh!

Replies: 7 comments · 9 replies

Uh oh!

mfussenegger Feb 22, 2023 Maintainer

Uh oh!

arkaragian Feb 23, 2023 Author

Uh oh!

mfussenegger Feb 24, 2023 Maintainer

Uh oh!

Uh oh!

arkaragian Jun 20, 2023 Author

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

How can I use the `vsdbg` adapter? #869

Replies: 7 comments 9 replies

mfussenegger
Feb 22, 2023
Maintainer

arkaragian Feb 23, 2023
Author

mfussenegger Feb 24, 2023
Maintainer

arkaragian
Jun 20, 2023
Author