golang进程如何打印goroutine stack信息

直接说,非常遗憾的是,没有类似pstack/jstack的工具可以使用。

目前只有两者可行常用的方案,但是都有缺陷:

  1. 直接给进程发送:SIGQUIT或者SIGABRT信号
    缺点是这会导致待访问进程退出。
  2. 修改程序代码,增加信号处理机制
    例如注册SIGUSR1信号处理函数,每回当接到该信号时,打印所有goroutine栈。缺点是需要修改用户代码。
  3. 补充一下,这是最近刚了解的,工具 Delve
    这是go语言官方推荐的golang调试工具,用来代替gdb,因为:"Delve能够更好地理解golang"。当然这个工具可以很好的打印出所有的goroutine栈,满足我们的需求。
    参考资料:https://golang.org/doc/gdb

下面介绍这两种方法:

方法1:使用SIGQUIT或者SIGABRT信号

使用如下测试代码:

package main

import (
    "fmt"
    "time"
    "os"
    "os/signal"
    "runtime"
    "syscall"
)

func myroutine(routineid string) {
    fmt.Println("Entry routine:", routineid)
    time.Sleep(1000 * time.Second)
    fmt.Println("Exit  routine:", routineid)
}

func main() {
    fmt.Println("Entry routine: main")

    // Launch goroutine 1
    go myroutine("myroutine1")

    // Launch goroutine 2
    go func(routineid string) {
        fmt.Println("Entry routine:", routineid)
        time.Sleep(1000 * time.Second)
        fmt.Println("Entry routine:", routineid)
    }("myroutine2")

    // wait main routine
    fmt.Scanln()
    fmt.Println("Exit  routine: main")
}

运行进程:

$ go build main.go
$ ./main
Entry routine: main
Entry routine: myroutine1
Entry routine: myroutine2

在另一个终端发送信号SIGQUIT :

$ kill -SIGQUIT <pid>

回去看前一个终端的输出:

$ ./main
Entry routine: main
Entry routine: myroutine1
Entry routine: myroutine2
SIGQUIT: quit
PC=0x4641de m=0 sigcode=0

goroutine 1 [syscall]:
syscall.Syscall(0x0, 0x0, 0xc42006e170, 0x1, 0xc420000180, 0xc420086080, 0x0)
        /usr/local/go/src/syscall/asm_linux_amd64.s:18 +0x5 fp=0xc420049a18 sp=0xc420049a10 pc=0x4641b5
syscall.read(0x0, 0xc42006e170, 0x1, 0x4, 0xc420086001, 0x0, 0x0)
        /usr/local/go/src/syscall/zsyscall_linux_amd64.go:749 +0x5f fp=0xc420049a78 sp=0xc420049a18 pc=0x463c9f
syscall.Read(0x0, 0xc42006e170, 0x1, 0x4, 0x0, 0x0, 0x0)
        /usr/local/go/src/syscall/syscall_unix.go:162 +0x49 fp=0xc420049ac0 sp=0xc420049a78 pc=0x4637b9
internal/poll.(*FD).Read(0xc42007a000, 0xc42006e170, 0x1, 0x4, 0x0, 0x0, 0x0)
        /usr/local/go/src/internal/poll/fd_unix.go:153 +0x118 fp=0xc420049b10 sp=0xc420049ac0 pc=0x465918
os.(*File).read(0xc420078000, 0xc42006e170, 0x1, 0x4, 0xc420049c18, 0x40d639, 0x7ff1982c26c8)
        /usr/local/go/src/os/file_unix.go:226 +0x4e fp=0xc420049b58 sp=0xc420049b10 pc=0x466d0e
os.(*File).Read(0xc420078000, 0xc42006e170, 0x1, 0x4, 0x7ff1982c26c8, 0xc420049c50, 0x446fad)
        /usr/local/go/src/os/file.go:107 +0x6a fp=0xc420049bc8 sp=0xc420049b58 pc=0x4660fa
io.ReadAtLeast(0x4d09a0, 0xc420078000, 0xc42006e170, 0x1, 0x4, 0x1, 0x447293, 0x4b82c0, 0x16460)
        /usr/local/go/src/io/io.go:309 +0x86 fp=0xc420049c28 sp=0xc420049bc8 pc=0x462d06
io.ReadFull(0x4d09a0, 0xc420078000, 0xc42006e170, 0x1, 0x4, 0x0, 0x21, 0x2)
        /usr/local/go/src/io/io.go:327 +0x58 fp=0xc420049c80 sp=0xc420049c28 pc=0x462e78
fmt.(*readRune).readByte(0xc42006e150, 0x2, 0x40b1ad, 0x5389e0)
        /usr/local/go/src/fmt/scan.go:321 +0x65 fp=0xc420049cd0 sp=0xc420049c80 pc=0x489095
fmt.(*readRune).ReadRune(0xc42006e150, 0x28, 0xc42006e150, 0x0, 0xc420000180)
        /usr/local/go/src/fmt/scan.go:337 +0xb4 fp=0xc420049d40 sp=0xc420049cd0 pc=0x4891e4
fmt.(*ss).ReadRune(0xc42008e000, 0xc420049dd0, 0xc420049dd8, 0x424cb9, 0x8)
        /usr/local/go/src/fmt/scan.go:189 +0x7f fp=0xc420049d98 sp=0xc420049d40 pc=0x488a4f
fmt.(*ss).getRune(0xc42008e000, 0x4c5908)
        /usr/local/go/src/fmt/scan.go:211 +0x2f fp=0xc420049de8 sp=0xc420049d98 pc=0x488b9f
fmt.(*ss).doScan(0xc42008e000, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0)
        /usr/local/go/src/fmt/scan.go:1046 +0xdb fp=0xc420049e28 sp=0xc420049de8 pc=0x48d22b
fmt.Fscanln(0x4d09a0, 0xc420078000, 0x0, 0x0, 0x0, 0xc420049f38, 0x10, 0x48db1b)
        /usr/local/go/src/fmt/scan.go:132 +0xcb fp=0xc420049ed8 sp=0xc420049e28 pc=0x48889b
fmt.Scanln(0x0, 0x0, 0x0, 0xa, 0x0, 0x0)
        /usr/local/go/src/fmt/scan.go:70 +0x57 fp=0xc420049f28 sp=0xc420049ed8 pc=0x488797
main.main()
        /home/<username>/test/go/src/test/main.go:28 +0xd0 fp=0xc420049f88 sp=0xc420049f28 pc=0x48db30
runtime.main()
        /usr/local/go/src/runtime/proc.go:198 +0x212 fp=0xc420049fe0 sp=0xc420049f88 pc=0x427a12
runtime.goexit()
        /usr/local/go/src/runtime/asm_amd64.s:2361 +0x1 fp=0xc420049fe8 sp=0xc420049fe0 pc=0x44ee41

goroutine 18 [sleep]:
time.Sleep(0xe8d4a51000)
        /usr/local/go/src/runtime/time.go:102 +0x166
main.myroutine(0x4bf425, 0xa)
        /home/<username>/test/go/src/test/main.go:10 +0xd1
created by main.main
        /home/<username>/test/go/src/test/main.go:18 +0x8e

goroutine 19 [sleep]:
time.Sleep(0xe8d4a51000)
        /usr/local/go/src/runtime/time.go:102 +0x166
main.main.func1(0x4bf42f, 0xa)
        /home/<username>/test/go/src/test/main.go:23 +0xd1
created by main.main
        /home/<username>/test/go/src/test/main.go:21 +0xbb

rax    0x0
rbx    0x0
rcx    0x4641e0
rdx    0x1
rdi    0x0
rsi    0xc42006e170
rbp    0xc420049a68
rsp    0xc420049a10
r8     0x0
r9     0x0
r10    0x0
r11    0x202
r12    0x0
r13    0xf3
r14    0x33
r15    0x80
rip    0x4641de
rflags 0x202
cs     0x33
fs     0x0
gs     0x0
$ 

从屏幕输出我们看到三个goroutine的stack全部被打出来了(好像goroutine号不连续呢),也包括当前寄存器的值。
只是遗憾的是,当前进程退出了。

方法2:修改用户代码,使用自定义的信号(例如SIGUSR1)处理

代码例子:

package main

import (
    "fmt"
    "time"
    "os"
    "os/signal"
    "runtime"
    "syscall"
)

func myroutine(routineid string) {
    fmt.Println("Entry routine:", routineid)
    time.Sleep(1000 * time.Second)
    fmt.Println("Exit  routine:", routineid)
}

func main() {
    fmt.Println("Entry routine: main")

    // Register signal handler
    setupSignalHandler()

    // Launch goroutine 1
    go myroutine("myroutine1")

    // Launch goroutine 2
    go func(routineid string) {
        fmt.Println("Entry routine:", routineid)
        time.Sleep(1000 * time.Second)
        fmt.Println("Entry routine:", routineid)
    }("myroutine2")

    // wait main routine
    fmt.Scanln()
    fmt.Println("Exit  routine: main")
}

func setupSignalHandler() {
    c := make(chan os.Signal, 1)
    signal.Notify(c, syscall.SIGUSR1)
    go func() {
        for range c {
            dumpStacks()
        }
    }()
}

func dumpStacks() {
    buf := make([]byte, 1024)

    for {
        n := runtime.Stack(buf, true)
        if n < len(buf) {
            buf = buf[:n]
            break;
        }
        buf = make([]byte, 2*len(buf))
    }

    fmt.Printf("=== BEGIN goroutine stack dump ===\n")
    fmt.Printf("%s", buf)
    fmt.Printf("=== END   goroutine stack dump ===\n")
}

和前面步骤一样,编译运行,然后打开另一个终端,发送kill -SIGUSR1 <pid>,我们同样能看到在前一个终端会输出所有goroutine的stack信息;但是此时进程并不会退出,还能继续运行。

不知道golang为什么不提供这样的工具,难道他们认为需要打所有goroutine的时候都是进程快挂了吗,这时候选择让进程退出是必然的选择吗?

Linux上常用的工具例如pstack对于go进程根本不管用,pstack能打印出操作系统级别的thread信息,但是goroutine并没有和thread有对应关系,特别是GOMAXPROCS=1时,pstack只打印出一个线程的stack信息,没有任何goroutine的stack信息。

附一份参考文档:http://colobu.com/2016/12/21/how-to-dump-goroutine-stack-traces/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容