Go Singleflight导致死锁问题解决分析

Dump 堆栈很重要

线上某个环境发现 S3 上传请求卡住，请求不返回，卡了30分钟，长时间没有发现有效日志。一般来讲，死锁问题还是好排查的，因为现场一般都在。类似于 c 程序，遇到死锁问题都会用 pstack 看一把。golang 死锁排查思路也类似（golang 不适合使用 pstack，因为 golang 调度的是协程，pstack 只能看到线程栈），我们其实是需要知道 S3 程序里 goroutine 的栈状态。golang 遇到这个问题我们有两个办法：

方法一：条件允许的话，gcore 出一个堆栈，这个是最有效的方法，因为是把整个 golang 程序的内存镜像 dump 出来，然后用 dlv 分析；
方法二：如果你提前开启 net/pprof 库的引用，开启了 debug 接口，那么就可以调用 curl 接口，通过 http 接口获取进程的状态信息；

需要注意到，golang 程序和 c 程序还是有点区别，goroutine 非常多，成百上千个 goroutine 是常态，甚至上万个也不稀奇。所以我们一般无法在终端上直接看完所有的栈，一般都是把所有的 goroutine 栈 dump 到文件，然用 vi 打开慢慢分析。

gorouties -t -u

curl xxx/debug/pprof/goroutine

关键思路

成千上万个 goroutine ，直接显示到终端是不合适的，我们 dump 到文件 test.txt，然后分析 test.txt 这个文件。

runtime_notifyListWaitsemaphoresync.(*Cond).WaitAcquire

划重点：

runtime_notifyListWaitsemaphoresync.(*Cond).WaitAcquire

blockingKeyCountLimit.lock

blockingKeyCountLimit 是我们封装针对 key 操作流控的组件。举个例子，如果 limit == 1，key为 "test" 在 g1 上 Acquire 成功，g2 acquire("test") 就会等待，这个可以算是我们优化的一个逻辑。如果 limit == 2，那么就允许两个人加锁到，后面的人都等待。

从代码来看，函数退出一定会释放的，但是偏偏现在锁就卡在这个地方，所以就非常奇怪。我们先找哪个 goroutine 占着这把锁不释放，看看能不能搞清楚怎样导致这里抢不到锁的原因。

通过审查业务代码分析，发现可能的源头函数（这个函数是向后端请求的函数）：

getBytesNolcgetBytesNolcgoroutine 19458

goroutine 19458gihub.com/golang/groupcache/singleflight/singleflight.go:48

singleflight 实现了缓存防击穿的功能

终于找到你

这是一个开源库，singleflight 实现了缓存防击穿的功能。

简单介绍下 singleflight 的功能，这是一个非常有效的工具。在缓存大量失效的场景，如果针对同一个 key ，其实只需要有一个人穿透到后端请求数据，其他人等待他完成，然后取缓存结果即可。这个就是 singleflight 实现的功能。具体实现就是：来了请求之后，把 key 插入到 map 里，后面的请求如果发现同名 key 在 map 里面，那么就等待它完成就好；

c.wg.Wait()goroutine 19458blockingKeyCountLimit

思路整理

伪代码显示如下：

图示显示当前的现状：

现状小结：

blockingKeyCountLimitgoroutine 19458blockingKeyCountLimitgoroutine 19458

当前的疑问就是第一个 key 的任务为啥永远完不成，堆栈也找不到了，去哪里了？

发现蛛丝马迹

我们再仔细审一下 singleflight 的代码：

fn()delete(g.m, key)

完整的推理流程

blockingKeyCountLimitgetBytesNolcsinglelightblockingKeyCountLimitsinglelightgoroutine 19458blockingKeyCountLimitsinglelightblockingKeyCountLimit

实锤：后续基于这个猜想，再去搜索一遍日志，发现确实是有一条 panic 相关的日志。这个时间点后面的请求全部被卡住。

思考总结

一般来讲 c 语言写程序容易出现死锁问题，因为各种异常逻辑可能会导致忘记放锁，从而导致抢一个永远都不可能得到的锁。golang 为了解决这个问题，一般是用 defer 机制来实现，使用姿势如下：

golang 的 defer 机制是一个经过经验沉淀下来的有效功能。我们必须要合理使用。defer 实现原理是和所在函数绑定，保证函数 return 的时候一定能调用到（ panic 退出也能），所以 golang 加锁放锁的有效实践是写在相邻的两行。

其实思考下，singleflight 作为一个通用开源库，其实可以把 delete map key 放到 defer 里，这样就能保证 map 里面的 key 一定是可以被清理的。

还有一点，其实 golang 是不提倡异常-捕捉这样的方式编程，panic 一般不让随便用，如果真是严重的问题，挂掉就挂掉，这个估计还好一些。当然这是要看场景的，还是有一些特殊场景的，毕竟 golang 都已经提供了 panic-recover 这样的一个手段，就说明还是有需求。这个就跟 unsafe 库一样，你只有明确知道自己的行为影响，才去使用这个工具，否则别用。