Facing an Issue with Vscode Debugger on WSL #2009

mailman-2097 · 2022-01-11T08:21:24Z

mailman-2097
Jan 11, 2022

GoLang VS Code Extension
Released on
10/16/2015, 04:20:11
Last updated
12/17/2021, 04:03:11
Identifier
golang.go

code --version
1.63.2
899d46d82c4c95423fb7e10e68eba52050e30ba3
x64

$go version
go version go1.17.5 linux/amd64

$go version -m dlv
dlv: go1.17.5
        path    github.com/go-delve/delve/cmd/dlv
        mod     github.com/go-delve/delve       v1.8.0  h1:uvwPyfr6n2g1S6/bt270lM4fBK76P/3FDCufOsK0CjQ=
        dep     github.com/cilium/ebpf  v0.7.0  h1:1k/q3ATgxSXRdrmPfH8d7YK0GfqVsEKZAX9dQZvs56k=
        dep     github.com/cosiner/argv v0.1.0  h1:BVDiEL32lwHukgJKP87btEPenzrrHUjajs/8yzaqcXg=
        dep     github.com/cpuguy83/go-md2man/v2        v2.0.0  h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM=
        dep     github.com/derekparker/trie     v0.0.0-20200317170641-1fdf38b7b0e9      h1:G765iDCq7bP5opdrPkXk+4V3yfkgV9iGFuheWZ/X/zY=
        dep     github.com/google/go-dap        v0.6.0  h1:Y1RHGUtv3R8y6sXq2dtGRMYrFB2hSqyFVws7jucrzX4=
        dep     github.com/hashicorp/golang-lru v0.5.4  h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc=
        dep     github.com/mattn/go-isatty      v0.0.3  h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI=
        dep     github.com/mattn/go-runewidth   v0.0.3  h1:a+kO+98RDGEfo6asOGMmpodZq4FNtnGP54yps8BzLR4=
        dep     github.com/peterh/liner v1.2.1  h1:O4BlKaq/LWu6VRWmol4ByWfzx6MfXc5Op5HETyIy5yg=
        dep     github.com/russross/blackfriday/v2      v2.0.1  h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
        dep     github.com/shurcooL/sanitized_anchor_name       v1.0.0  h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
        dep     github.com/sirupsen/logrus      v1.6.0  h1:UBcNElsrwanuuMsnGSlYmtmgbb23qDR5dG+6X6Oo89I=
        dep     github.com/spf13/cobra  v1.1.3  h1:xghbfqPkxzxP3C/f3n5DdpAbdKLj4ZE4BWQI362l53M=
        dep     github.com/spf13/pflag  v1.0.5  h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
        dep     go.starlark.net v0.0.0-20200821142938-949cc6f4b097      h1:YiRMXXgG+Pg26t1fjq+iAjaauKWMC9cmGFrtOEuwDDg=
        dep     golang.org/x/arch       v0.0.0-20190927153633-4e8777c89be4      h1:QlVATYS7JBoZMVaf+cNjb90WD/beKVHnIxFKT4QaHVI=
        dep     golang.org/x/sys        v0.0.0-20211019181941-9d821ace8654      h1:id054HUawV2/6IGm2IV8KZQjqtwAOo2CYlOToYqa0d0=
        dep     gopkg.in/yaml.v2        v2.4.0  h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=

$go version -m dlv-dap
dlv-dap: go1.17.5
        path    github.com/go-delve/delve/cmd/dlv
        mod     github.com/go-delve/delve       v1.7.4-0.20211208103735-2f13672765fe    h1:p5qH9Bb0yHA4Fy5L+Rp+4jL2ppKxBvYJWHR6YhFeD7k=
        dep     github.com/cilium/ebpf  v0.7.0  h1:1k/q3ATgxSXRdrmPfH8d7YK0GfqVsEKZAX9dQZvs56k=
        dep     github.com/cosiner/argv v0.1.0  h1:BVDiEL32lwHukgJKP87btEPenzrrHUjajs/8yzaqcXg=
        dep     github.com/cpuguy83/go-md2man/v2        v2.0.0  h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM=
        dep     github.com/derekparker/trie     v0.0.0-20200317170641-1fdf38b7b0e9      h1:G765iDCq7bP5opdrPkXk+4V3yfkgV9iGFuheWZ/X/zY=
        dep     github.com/google/go-dap        v0.6.0  h1:Y1RHGUtv3R8y6sXq2dtGRMYrFB2hSqyFVws7jucrzX4=
        dep     github.com/hashicorp/golang-lru v0.5.4  h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc=
        dep     github.com/mattn/go-isatty      v0.0.3  h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI=
        dep     github.com/mattn/go-runewidth   v0.0.3  h1:a+kO+98RDGEfo6asOGMmpodZq4FNtnGP54yps8BzLR4=
        dep     github.com/peterh/liner v1.2.1  h1:O4BlKaq/LWu6VRWmol4ByWfzx6MfXc5Op5HETyIy5yg=
        dep     github.com/russross/blackfriday/v2      v2.0.1  h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
        dep     github.com/shurcooL/sanitized_anchor_name       v1.0.0  h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
        dep     github.com/sirupsen/logrus      v1.6.0  h1:UBcNElsrwanuuMsnGSlYmtmgbb23qDR5dG+6X6Oo89I=
        dep     github.com/spf13/cobra  v1.1.3  h1:xghbfqPkxzxP3C/f3n5DdpAbdKLj4ZE4BWQI362l53M=
        dep     github.com/spf13/pflag  v1.0.5  h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
        dep     go.starlark.net v0.0.0-20200821142938-949cc6f4b097      h1:YiRMXXgG+Pg26t1fjq+iAjaauKWMC9cmGFrtOEuwDDg=
        dep     golang.org/x/arch       v0.0.0-20190927153633-4e8777c89be4      h1:QlVATYS7JBoZMVaf+cNjb90WD/beKVHnIxFKT4QaHVI=
        dep     golang.org/x/sys        v0.0.0-20211019181941-9d821ace8654      h1:id054HUawV2/6IGm2IV8KZQjqtwAOo2CYlOToYqa0d0=
        dep     gopkg.in/yaml.v2        v2.4.0  h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=

Trace


Starting: /home/$USER/go/bin/dlv-dap dap --check-go-version=false --listen=127.0.0.1:33119 --log=true --log-output=dap --log-dest=3 from /home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3
DAP server listening at: 127.0.0.1:33119
2022-01-11T18:47:35+11:00 debug layer=dap DAP server pid = 26530
2022-01-11T18:47:35+11:00 debug layer=dap DAP connection 1 started
2022-01-11T18:47:35+11:00 debug layer=dap [<- from client]{"seq":1,"type":"request","command":"initialize","arguments":{"clientID":"vscode","clientName":"Visual Studio Code","adapterID":"go","locale":"en-us","linesStartAt1":true,"columnsStartAt1":true,"pathFormat":"path","supportsVariableType":true,"supportsVariablePaging":true,"supportsRunInTerminalRequest":true,"supportsMemoryReferences":true,"supportsProgressReporting":true,"supportsInvalidatedEvent":true}}
2022-01-11T18:47:35+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":1,"success":true,"command":"initialize","body":{"supportsConfigurationDoneRequest":true,"supportsFunctionBreakpoints":true,"supportsConditionalBreakpoints":true,"supportsEvaluateForHovers":true,"supportsSetVariable":true,"supportsExceptionInfoRequest":true,"supportTerminateDebuggee":true,"supportsDelayedStackTraceLoading":true,"supportsLogPoints":true,"supportsDisassembleRequest":true,"supportsClipboardContext":true,"supportsSteppingGranularity":true,"supportsInstructionBreakpoints":true}}
2022-01-11T18:47:35+11:00 debug layer=dap [<- from client]{"seq":2,"type":"request","command":"launch","arguments":{"name":"Launch Package","type":"go","request":"launch","mode":"debug","trace":"verbose","showLog":true,"logOutput":"dap","program":".","stopOnEntry":true,"args":["input.txt","input.txt"],"__configurationTarget":4,"packagePathToGoModPathMap":{"/home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3":"/$WindowsFolderMountedinWSL/Desktop/sourced/base/05 Devspace/gopl.io"},"debugAdapter":"dlv-dap","dlvToolPath":"/home/$USER/go/bin/dlv-dap","env":{},"__buildDir":"/home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3","__sessionId":"f2bac7de-3727-411e-84df-4194d06b977e"}}
2022-01-11T18:47:35+11:00 debug layer=dap parsed launch config: {
	"mode": "debug",
	"program": ".",
	"args": [
		"input.txt",
		"input.txt"
	],
	"stopOnEntry": true,
	"backend": "default",
	"stackTraceDepth": 50
}
2022-01-11T18:47:36+11:00 debug layer=dap building from "/$WindowsFolderMountedinWSL/Desktop/sourced/base/05 Devspace/gopl.io/ch1/dup3": [go build -o /tmp/__debug_bin3695005496 -gcflags all=-N -l .]
2022-01-11T18:47:36+11:00 debug layer=dap launching binary '/tmp/__debug_bin3695005496' with config: {
	"mode": "debug",
	"program": "/$WindowsFolderMountedinWSL/Desktop/sourced/base/05 Devspace/gopl.io/ch1/dup3",
	"args": [
		"input.txt",
		"input.txt"
	],
	"cwd": "/$WindowsFolderMountedinWSL/Desktop/sourced/base/05 Devspace/gopl.io/ch1/dup3",
	"output": "/tmp/__debug_bin3695005496",
	"dlvCwd": "/$WindowsFolderMountedinWSL/Desktop/sourced/base/05 Devspace/gopl.io/ch1/dup3",
	"stopOnEntry": true,
	"backend": "default",
	"stackTraceDepth": 50
}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"event","event":"initialized"}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":2,"success":true,"command":"launch"}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":3,"type":"request","command":"setBreakpoints","arguments":{"source":{"name":"main.go","path":"/home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3/main.go"},"breakpoints":[{"line":21},{"line":29}],"lines":[21,29]}}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":3,"success":true,"command":"setBreakpoints","body":{"breakpoints":[{"verified":false,"message":"could not find file /home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3/main.go","source":{}},{"verified":false,"message":"could not find file /home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3/main.go","source":{}}]}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":4,"type":"request","command":"setFunctionBreakpoints","arguments":{"breakpoints":[]}}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":4,"success":true,"command":"setFunctionBreakpoints","body":{"breakpoints":[]}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":5,"type":"request","command":"setInstructionBreakpoints","arguments":{"breakpoints":[]}}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":5,"success":true,"command":"setInstructionBreakpoints","body":{"breakpoints":[]}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":6,"type":"request","command":"configurationDone","arguments":{}}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"event","event":"stopped","body":{"reason":"entry","threadId":1,"allThreadsStopped":true}}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"event","event":"output","body":{"category":"console","output":"Type 'dlv help' for list of commands.\n","source":{}}}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":6,"success":true,"command":"configurationDone"}
Type 'dlv help' for list of commands.
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":7,"type":"request","command":"threads"}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":7,"success":true,"command":"threads","body":{"threads":[{"id":1,"name":"Dummy"}]}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":8,"type":"request","command":"threads"}
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":8,"success":true,"command":"threads","body":{"threads":[{"id":1,"name":"Dummy"}]}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":9,"type":"request","command":"stackTrace","arguments":{"threadId":1,"levels":1,"format":{}}}
2022-01-11T18:47:36+11:00 debug layer=dap Unable to produce stack trace: unknown goroutine 1
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":9,"success":false,"command":"stackTrace","message":"Unable to produce stack trace","body":{"error":{"id":2004,"format":"Unable to produce stack trace: unknown goroutine 1","showUser":false}}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":10,"type":"request","command":"stackTrace","arguments":{"threadId":1,"levels":20,"format":{}}}
2022-01-11T18:47:36+11:00 debug layer=dap Unable to produce stack trace: unknown goroutine 1
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":10,"success":false,"command":"stackTrace","message":"Unable to produce stack trace","body":{"error":{"id":2004,"format":"Unable to produce stack trace: unknown goroutine 1","showUser":false}}}
2022-01-11T18:47:36+11:00 debug layer=dap [<- from client]{"seq":11,"type":"request","command":"stackTrace","arguments":{"threadId":1,"levels":19,"format":{}}}
2022-01-11T18:47:36+11:00 debug layer=dap Unable to produce stack trace: unknown goroutine 1
2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":11,"success":false,"command":"stackTrace","message":"Unable to produce stack trace","body":{"error":{"id":2004,"format":"Unable to produce stack trace: unknown goroutine 1","showUser":false}}}
2022-01-11T18:47:41+11:00 debug layer=dap [<- from client]{"seq":12,"type":"request","command":"disconnect","arguments":{"terminateDebuggee":true}}
2022-01-11T18:47:41+11:00 debug layer=dap halting
2022-01-11T18:47:41+11:00 debug layer=dap process not running
2022-01-11T18:47:41+11:00 debug layer=dap [-> to client]{"seq":0,"type":"event","event":"output","body":{"category":"console","output":"Detaching and terminating target process\n","source":{}}}
Detaching and terminating target process
2022-01-11T18:47:42+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":12,"success":true,"command":"disconnect"}
2022-01-11T18:47:42+11:00 debug layer=dap [-> to client]{"seq":0,"type":"event","event":"terminated","body":{}}
2022-01-11T18:47:42+11:00 debug layer=dap DAP server stopping...
2022-01-11T18:47:42+11:00 debug layer=dap DAP server stopped
dlv dap (26530) exited with code: 0

#Launch Config
	"launch": {
		"version": "0.2.0",
		"configurations": [
			{
				"name": "Launch Package",
				"type": "go",
				"request": "launch",
				"mode": "auto",
				"trace": "verbose",
				"showLog": true,
				"logOutput": "dap",
				"program": "${fileDirname}",
				"stopOnEntry": true,
				"args": [
					"input.txt",
					"input.txt"
				]
			}
		]
	}

Not sure what to do

hyangah · 2022-01-11T14:03:56Z

hyangah
Jan 11, 2022
Maintainer

Thank you so much for sharing the detailed debug log and all the settings!

The root cause is the difference between the file paths the go compiler sees and the file paths the editor sees.

VS Code resolved ${fileDirname} to the windows folder mounted in wsl, so the extension built the debugged program using the path:
/$WindowsFolderMountedinWSL/Desktop/sourced/base/05 Devspace/gopl.io/ch1/dup3

It's likely the go tool chain also used the same path (not guaranteed though because go tool chain's behavior around symlinks or aliased paths is undefined by nature) when generating the debug information.

The editor however sent breakpoint requests with the file paths that look like:
/home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3/main.go

As a result, the debugger couldn't find the location info of the requested breakpoints and reported the errors:

2022-01-11T18:47:36+11:00 debug layer=dap [-> to client]{"seq":0,"type":"response","request_seq":3,"success":true,
  "command":"setBreakpoints", "body":{"breakpoints":
[{"verified":false,
  "message":"could not find file /home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3/main.go",
   "source":{}},
{"verified":false,
  "message":"could not find file /home/$USER/sourced/base/05 Devspace/gopl.io/ch1/dup3/main.go",
  "source":{}}]}}

The error messages should be shown in the breakpoint viewlet but as discussed in #1840 and #1999, VS Code clears out the error information as soon as the debug session ends, so users often don't have a chance to recognize the issue.
We are trying to work with the VS Code team to improve the UX.

You can consider substitutePath setting to help the debugger handle this path difference using https://github.com/golang/vscode-go/blob/master/docs/debugging.md#debugging-symlink-directories as a workaround.

In general, when working with WSL, VSCode recommends to set up the environment using their WSL extension (https://code.visualstudio.com/docs/remote/wsl). The Go tool chain's behavior around WSL mounted folders or symlinks is not well-defined either and we've observed a few issues like golang/go#49475 so we also recommend the VSCode's best-practice.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Facing an Issue with Vscode Debugger on WSL #2009

{{title}}

Replies: 1 comment

{{title}}

Select a reply

Facing an Issue with Vscode Debugger on WSL #2009

mailman-2097 Jan 11, 2022

Trace

Replies: 1 comment

hyangah Jan 11, 2022 Maintainer

mailman-2097
Jan 11, 2022

hyangah
Jan 11, 2022
Maintainer