delve基础用法及在vscode中的使用

一. 关于delve

delve 是go语言的调试器，delve的目标是为go提供一个简洁、功能齐全的debug工具，delve易于调用和使用。

二. 安装

为了能够编译delve，需要安装Go 1.10或更高版本
安装好go后，直接go get即可安装，更多安装教程见：https://github.com/go-delve/delve/tree/master/Documentation/installation
go get github.com/go-delve/delve/cmd/dlv
安装好后，在终端执行dlv或者dlv help 会看到dlv的帮助信息，则说明安装成功
dlv常用命令

• dlv help # 显示dlv帮助信息
• dlv version # 显示dlv版本信息
• dlv attach # 连接到正在运行的go进程并开始调试
• dlv connect # 连接到调试服务器，用于远程调试，需要远程有二进制文件和源码及dlv工具
• dlv core
• dlv dap
• dlv debug # 默认在当前目录中编译并开始调试go main 包，或者指定模块路径
• dlv exec # 执行已经编译好的二进制文件，并开始调试
• dlv run # 不推荐使用，用debug代替
• dlv test # 编译测试二进制文件，并开始调试，即调试测试文件
• dlv trace # 编译并开始追踪程序
  debug 和 exec是比较常用的命令

三. 入门手册

delve的目标是成为一个简洁而强大的工具。但如果你不习惯在编译语言中使用源码调试，则可能令人困惑。本文档将提供开始调试go程序所需的全部信息。

调试入门程序

调试例子程序如下
├── go.mod
├── go.sum
├── main.go
├── test
└── utils
├── util.go
└── util_test.go
调试程序主要有三个文件，main.go、util.go、util_test.go，内容如下，比较简单，go包管理工具使用的是go module，模块名为test

module test

go 1.14

// main.go
package main
import (
    "fmt"
    "test/utils"
)
func main() {
    for i := 0; i < 10; i++ {
        fmt.Println(i)
    }
    fmt.Println(utils.Add(100, 2300))
}

// utils/util.go
package utils
func Add(a, b int) int {
    return a + b
}

// utils/utils_test.go
package utils
import "testing"
func TestAdd(t *testing.T) {
    if Add(100, 200) != 300 {
        t.Error("100 + 200 != 300")
    }
}

调试main 包

$ dlv debug # 开始调试main包
Type 'help' for list of commands.
(dlv) b main.main # 在main.main 方法上打断点
Breakpoint 1 set at 0x10d0fd8 for main.main() ./main.go:8
(dlv) bp # 打印当前断点
Breakpoint runtime-fatal-throw at 0x1038420 for runtime.fatalthrow() /usr/local/go/src/runtime/panic.go:1162 (0)
Breakpoint unrecovered-panic at 0x10384a0 for runtime.fatalpanic() /usr/local/go/src/runtime/panic.go:1189 (0)
    print runtime.curg._panic.arg
Breakpoint 1 at 0x10d0fd8 for main.main() ./main.go:8 (0)
(dlv) c # 继续执行，直到下一个断点停止
> main.main() ./main.go:8 (hits goroutine(1):1 total:1) (PC: 0x10d0fd8)
     3: import (
     4:     "fmt"
     5:     "test/utils"
     6: )
     7:
=>   8: func main() {
     9:     for i := 0; i < 10; i++ {
    10:         fmt.Println(i)
    11:     }
    12:     fmt.Println(utils.Add(100, 2300))
    13: }
(dlv) b main.go:12 # 在main.go 文件中的12行打一个断点
Breakpoint 2 set at 0x10d10b8 for main.main() ./main.go:12
(dlv) n # 下一步，遇到函数不进入
> main.main() ./main.go:9 (PC: 0x10d0fef)
     4:     "fmt"
     5:     "test/utils"
     6: )
     7:
     8: func main() {
=>   9:     for i := 0; i < 10; i++ {
    10:         fmt.Println(i)
    11:     }
    12:     fmt.Println(utils.Add(100, 2300))
    13: }
(dlv) s # 单步执行程序，遇到函数进入
> main.main() ./main.go:10 (PC: 0x10d1007)
     5:     "test/utils"
     6: )
     7:
     8: func main() {
     9:     for i := 0; i < 10; i++ {
=>  10:         fmt.Println(i)
    11:     }
    12:     fmt.Println(utils.Add(100, 2300))
    13: }
(dlv) c
0
1
2
3
4
5
6
7
8
9
> main.main() ./main.go:12 (hits goroutine(1):1 total:1) (PC: 0x10d10b8)
     7:
     8: func main() {
     9:     for i := 0; i < 10; i++ {
    10:         fmt.Println(i)
    11:     }
=>  12:     fmt.Println(utils.Add(100, 2300))
    13: }
(dlv) c
2400
Process 53433 has exited with status 0
(dlv)

调试测试包

$ dlv test test/utils # 开始调试utils下的测试包
Type 'help' for list of commands.
(dlv) bp # 打印出当前的端点
Breakpoint runtime-fatal-throw at 0x103c3a0 for runtime.fatalthrow() /usr/local/go/src/runtime/panic.go:1162 (0)
Breakpoint unrecovered-panic at 0x103c420 for runtime.fatalpanic() /usr/local/go/src/runtime/panic.go:1189 (0)
    print runtime.curg._panic.arg
(dlv) funcs test.Test*
(dlv) b TestAdd # 在TestAdd方法上打一个端点
Breakpoint 1 set at 0x1166273 for test/utils.TestAdd() ./utils/util_test.go:5
(dlv) bp
Breakpoint runtime-fatal-throw at 0x103c3a0 for runtime.fatalthrow() /usr/local/go/src/runtime/panic.go:1162 (0)
Breakpoint unrecovered-panic at 0x103c420 for runtime.fatalpanic() /usr/local/go/src/runtime/panic.go:1189 (0)
    print runtime.curg._panic.arg
Breakpoint 1 at 0x1166273 for test/utils.TestAdd() ./utils/util_test.go:5 (0)
(dlv) c # continue 继续执行
> test/utils.TestAdd() ./utils/util_test.go:5 (hits goroutine(4):1 total:1) (PC: 0x1166273)
     1: package utils
     2:
     3: import "testing"
     4:
=>   5: func TestAdd(t *testing.T) {
     6:     if Add(100, 200) != 300 {
     7:         t.Error("100 + 200 != 300")
     8:     }
     9: }
(dlv) c
PASS
Process 52711 has exited with status 0
(dlv)

用法详解

用法详解见wiki：https://github.com/go-delve/delve/tree/master/Documentation/cli，没有写详细的内容，后续会不定时补充

运行命令

• continue # 运行到断点或程序结束，简写 c
• next # 跳到下一个源码行，简写 n
• rebuild # 重新编译目标文件并执行，如果可执行文件不是通过dlv编译的就不起作用
• restart # 重启程序
• step # 单步执行程序，遇到函数进入，简写 s
• step-instruction # 单cpu指令执行，简写 si
• step-out # 跳出当前函数，简写 so

操作断点

• break # 打断点，简写 b
• breakpoints # 查看断点列表，简写 bp
• clear # 删除断点
• clearall # 删除所有断点
• condition # 设置断点条件
• on # 在命中断点时执行
• trace # 设置追踪点

查看程序变量和内存

• args # 打印函数变量
• locals # 打印局部变量
• print # 打印变量的值，如print a
• regs # 打印cpu 寄存器内容
• set # 设置变量的值，如 set a = 100
• vars # 打印包变量
• whatis # 查看变量类型，如 whatis a，输出 int

列出和选择线程或协程

• goroutines # 查看所有协程
• goroutines # 选择指定协程，如 goroutines 1
• threads # 列出所有线程
• thread # 选择指定线程，如 thread 2208678

查看调用堆栈并选择帧

其他命令

• funcs # 列出函数列表
• exit # 退出程序
• help # 帮助信息
• list # 显示源代码
• sources # 打印源码文件列表
• types # 打印类型列表

vscode 中配置使用dlv调试go程序

在vscode debug 的设置中配置launch.json文件

image.png

mode 设置为debug时，program的内容${fileDirname}即可，mode 设置为exec时，program的值为二进制文件的路径，通过设置mode的值，即可调试源码和二进制程序（也需要有源码）。mode模式为auto时，测试了下，vscode 并不能通过program的内容来判断是debug还是exec

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            // https://github.com/golang/vscode-go/blob/master/docs/debugging.md
            "name": "Launch",
            "type": "go",
            "request": "launch", // launch attach
            "mode": "exec", // launch: auto debug remote test exec, attach: local, remote
            // "program": "${fileDirname}",
            "program": "/xxx/mod/test/test",
            "env": {},
            "args": []
        }
    ]
}

远程调试

远程调试时，需要在远程也有源码、二进制包和dlv工具
在远端执行dlv命令
dlv debug --headless --listen=:8989 --api-version=2 --accept-multiclient #用degbug方式启动远程应用程序
dlv exec --headless --listen=:8989 ./test --api-version=2 --accept-multiclient # exec执行当前目录下的test二进制文件
--listen：指定调试端口
--api-version：指定api版本，默认是1
--accept-multiclient：接受多个client调试
在vscode中线下好源码，和远端的源码结构一致。launch.json配置如下：

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch",
            "type": "go",
            "request": "attach",
            "mode": "remote",
            "remotePath": "/xxx/mod/test",
            "host": "xxx",
            "port": 8989,
        }
    ]
}

在vscode中打好断点后，就可以进行远程调试了