go 使用 pprof 排查内存泄露

go 是自带gc的语言，会自动管理内存，不用像C/C++那样，需要程序员手动释放内存，不用手动管理内存，就能少掉很多头发

go的GC会自动管理内存，但是这不代表go程序就不会内存泄露了。 go常见产生内存泄露的原因就是goroutine没有结束，简单说就是goroutine 被阻塞了，这样就会导致goroutine引用的内存不被GC回收，也就导致了内存泄露。当然产生内存泄露的原因还有别的，只是暂时我还没有遇到。不管什么原因产生的内存泄露，最终都是因为异常的引用，导致该被回收的内存没有被gc 回收掉

起因

说起go内存泄露分析，还要从年前的一次程序压测说起。我用一个测试程序压测我们游戏的一些数据，大约开了3000个tcp连接到游戏。游戏数据没有问题，但是当测试结束后，发现游戏的Gateway内存占用一直没有下降。本能的让我想起了是不是内存泄露了。马上用pprof分析了一下内存，发现果然是内存泄露了。

因为时公司代码，不方便拿出了分析，大体说一下原因吧

Gateway是一个读写分离的tcp服务，也就是每一个连接都要有两个goroutine，一个读，一个写。

但是当tcp连接断开时，因为时序问题，导致goroutine阻塞了，一直没有结束，就是导致了相关联的内存没有释放。

因为时公司代码，不能随便贴出来，这次就自己写个简单的demo模拟一下吧

因为go 自带的pprof 只能展示文字，不太明显，所有先安装一个可视化插件 graphviz 传送门 linux上可以直接通过 apt 或者 yum 安装就行了。 windows上去网站下一个就好了，我下载 .msi 格式的安装后不能用，重新下了一个压缩包，解压后把 bin 目录配置到环境变量的 path 中就可以使用了

开始

写一个简单的demo 模拟一下内存泄露

 1package main
 2
 3import (
 4	"math/rand"
 5	"net/http"
 6	_ "net/http/pprof"
 7	"sync"
 8)
 9
10func main() {
11	go func() {
12		http.ListenAndServe("0.0.0.0:8090", nil)
13	}()
14
15	c := make(chan struct{})
16	var wg sync.WaitGroup
17	wg.Add(1)
18	for i := 0; i < 10000; i++ {
19		go one(c)
20	}
21	wg.Wait()
22}
23
24func one(c chan struct{}) {
25	var a []int64
26	for i := 0; i < 10000; i++ {
27		a = append(a, rand.Int63())
28	}
29	
30	<-c
31}

程序很简单，在 for 循环中开启 1000 个协程，每个协程中往切片中append 1000个数据。用一个channel模拟协程阻塞，这样就会导致goroutine不会结束。

使用go再带的pprof查看

代码中监听了 8090 端口，在浏览器中输入 http://127.0.0.1:8090/debug/pprof/

下面都有解释，就不用详细介绍了，挑一两个说一下

allocs : 程序运行期间，所有内存分配的样本
heap : 当前活动对象的内存分配采样
guroutine : 当前所有协程的堆栈跟踪

可以看到，当前的程序总共有10005个协程，21次堆内存分配，说明我们的协程是被阻塞的。

使用graphviz查看

在命令行中，在Windows中可以使用 powerShell 输入 go tool pprof -http :8081 http://127.0.0.1:8090/debug/pprof/heap

如果要分析CPU占用，使用

go tool pprof -http :8081 http://127.0.0.1:8090/debug/pprof/profile?seconds=120

会在浏览器中打开

这就是当前 heap 采样图可以在 VIEW 中切换不同的显示方式

图中方块越大便是占用的内存越多，方块中连线越粗表示耗时越多

内存泄露误区

我在排查内存泄露时，当我把goroutine阻塞解决后，通过linux 的 top 命令查看Gateway内存占用时，发现内存没有降下来，一时让我陷入困惑，为啥goroutine 都结束了，为啥内存还不释放呢？直到我在网上找到了这篇文章传送门
这位大神写的golang 相关的文章，是目前我在网上找到的最牛逼的之一，文章不光有深度，而且通俗易懂。

重新验证

修改上面的代码

 1package main
 2
 3import (
 4	"math/rand"
 5	"net/http"
 6	_ "net/http/pprof"
 7	"sync"
 8	"time"
 9)
10
11func main() {
12	go func() {
13		http.ListenAndServe("0.0.0.0:8090", nil)
14	}()
15
16	var wg sync.WaitGroup
17	wg.Add(1)
18	for i := 0; i < 10000; i++ {
19		go one()
20	}
21	wg.Wait()
22}
23
24func one() {
25	var a []int64
26	for i := 0; i < 10000; i++ {
27		a = append(a, rand.Int63())
28	}
29	time.Sleep(time.Second * 1)
30}

现在 go 出来的的函数 one 不再一直阻塞，而是只会阻塞5秒

把程序运行起来看一下

等一段时间后，发现goroutine数量已经下来了，说明阻塞的协程都已经结束了，如图

但是通过任务管理器中，看到程序还是占用着大量的内存

这时点击 heap 查看具体的堆内存情况，拉到最低下，看到一堆参数

参数很多，但是重点关注被框出来的那几个就好了，详细的分析在大神的文章中有分析，在go的库文件中也能找到，里面有详细的注释。路径 src->runtime->mstats.go 文件中有 MemStats 的定义和注释

这些参数的单位都是字节

TotalAlloc : 所有对象分配的总和，整个程序运行期间，只增不减
HeapAlloc : 分配的堆对象的字节数，包括可访问的对象和未被GC回收的不可访问的对象，这个值会动态变化，分配对象时增加，回收对象后减少
HeapIdle : 闲置的span中的字节数，这些span中已经没有对象了（不用了），但是现在还没有还给操作系统，这些span可以重新用来分配heap和stack。HeapIdle 减去 HeapReleased 的值可以当作 “可以返回到操作系统但由运行时保留的内存量”，也就是说，go的runtime可以在不像操作系统申请内存的情况下，也可以分配heap空间，这样可以提高程序性能
HeapInuse : 正在使用的span的字节大小
HeapReleased : 是返还给操作系统的物理内存的字节数

回到我们的测试程序中，当所有的goroutine都结束时，GC会开始回收切片，但是被回收的内存不会直接换给操作系统，而是由go的runtime暂时保管（也就是 HeapIdle 值会变大），接下来如果再次需要分配空间，go的runtime可以不向操作系统申请内存，直接从自己保管的闲置内存中分配，这样可以提高程序性能。至于GO的runtime什么时候把这部分内存还给操作系统，不同的分配策略和不同的系统不太一样，这个有点深，我还没有深入研究这些。不过传送门的文中有介绍 MADV_FREE 有兴趣可以自己学习一下

总结

go 虽然有GC，但是使用不当也会导致内存泄露
不同的操作系统和不用策略，会导致go程序的内存已经被回收了，但是没有及时的归还给操作系统

由于水平有限，文中如有谬处，还请在评论区不吝赐教