等等，怎么使用 SetMemoryLimit?

Go 1.19中终于实现了SetMemoryLimit的功能。Go的GC并不像Java那样提供了很多的参数可以调整，目前也就有GOGC这么一个参数，所以能增加一个可以调整GC的参数确实让人兴奋。

一直关注Go性能同学一定知道，最近几年有两个调整Go GC的hack方式:

ballast: 压舱石技术。使用一个"虚假"的内存占用，让Go运行时难以达到触发GC的阈值，来实现减少GC的次数，从而提高性能。如果你的程序的内存占用基本都会在某个阈值之下的话，这个技术非常有效，毕竟，Go很大的一部分性能消耗都是在GC上。这是twitch.tv的工程师提供的一种技术。
GOGC tuner: 通过自动调整GOGC，来动态的调整GC的target,用来在内存足够的时候调整GOGC来减少GC的次数，这也是一个非常有趣有效的技术，在uber公司的实践中行之有效。这是uber工程师提供的一项技术，Uber的工程师并没有把它开源出来，不过曹大根据文章的原理实现了一个cch123/gogctuner。

现在， Go 1.19 提供了SetMemoryLimit的功能，通过这个方法，可以替换ballast的方案，部分替换GOGC Tuner的方案。

谈起这个功能的历史，可以追溯到2017年12月的#23044，它提议增加一个方法，可以指定最小的目标堆大小。这个issue大家讨论的热火朝天，结果就是2019年twitch.tv的工程师实现了ballast,从工程的角度验证了GC是可以优化，而且在实践中也有效。

2021年Go team的工程师 Michael Knyszek 发起一个提案#44309,包括设计文档user configurable memory target。这个提案的跟踪issue最终归于#48409。

本来，这个提案预期在Go 1.18中实现，不过因为提案迟迟没有批准，所以最终会在Go 1.19中实现。

在撰写本文的时候，Go 1.19还在开发之中，不过这个提案的功能已经实现，剩下的是一些文档和bug修复的工作了，所以我们可以使用gotip来测试。

这个提案的实现原来就是要实现(替换)ballast的功能，所以一旦Go 1.19发布， ballast的方案就可以废弃了。没想到今年突然Uber的工程师来了一个自动调整GOGC的方案,所以当前方案还不能完全代替GOGC tuner, 毕竟GOGC Tuner可以更灵活的调整GC的target,而SetMemoryLimit在设定的MemoryLimit之下，还是会频繁的进行GC, 如果加上GOGC=off的话，只能等待达到MemoryLimit才能GC,和GOGC Tuner的方式还有有所不同的,所以并不能完全替代GOGC tuner。

详细的 GC调优指导的官方文档还没有完成，大家也可以关注一下，看看官方的建议。

This page is currently a work-in-progress and is expected to be complete by the time of the Go 1.19 release. See this tracking issue for more details.

即使官方文档还没有完成，依照提案的内容，我们还是可以早点了解这个提案的功能以及带给我们的收益。

下面通过四个场景，观察一下此功能对GC的影响:

SetMemoryLimit + GOGC=off + MemoryLimit足够大
SetMemoryLimit + GOGC=off + MemoryLimit不足够大
SetMemoryLimit + GOGC=100 + MemoryLimit足够大
SetMemoryLimit + GOGC=100 + MemoryLimit不足够大

基本例子

本文通过Debian的benchmarks game中的btree例子演示这四个场景。

因为这个例子会频繁生成生成二叉树，正适合内存分配和回收的场景。

package main
import (
	"flag"
	"fmt"
	"sync"
	"time"
)
type node struct {
	next *next
}
type next struct {
	left, right node
}
func create(d int) node {
	if d == 1 {
		return node{&next{node{}, node{}}}
	}
	return node{&next{create(d - 1), create(d - 1)}}
}
func (p node) check() int {
	sum := 1
	current := p.next
	for current != nil {
		sum += current.right.check() + 1
		current = current.left.next
	}
	return sum
}
var (
	depth = flag.Int("depth", 10, "depth")
)
func main() {
	flag.Parse()
	start := time.Now()
	const MinDepth = 4
	const NoTasks = 4
	maxDepth := *depth
	longLivedTree := create(maxDepth)
	stretchTreeCheck := ""
	wg := new(sync.WaitGroup)
	wg.Add(1)
	go func() {
		stretchDepth := maxDepth + 1
		stretchTreeCheck = fmt.Sprintf("stretch tree of depth %d\t check: %d",
			stretchDepth, create(stretchDepth).check())
		wg.Done()
	}()
	results := make([]string, (maxDepth-MinDepth)/2+1)
	for i := range results {
		depth := 2*i + MinDepth
		n := (1 << (maxDepth - depth + MinDepth)) / NoTasks
		tasks := make([]int, NoTasks)
		wg.Add(NoTasks)
		// 执行NoTasks个goroutine, 每个goroutine执行n个深度为depth的tree的check
		// 一共是n*NoTasks个tree,每个tree的深度是depth
		for t := range tasks {
			go func(t int) {
				check := 0
				for i := n; i > 0; i-- {
					check += create(depth).check()
				}
				tasks[t] = check
				wg.Done()
			}(t)
		}
		wg.Wait()
		check := 0 // 总检查次数
		for _, v := range tasks {
			check += v
		}
		results[i] = fmt.Sprintf("%d\t trees of depth %d\t check: %d",
			n*NoTasks, depth, check)
	}
	fmt.Println(stretchTreeCheck)
	for _, s := range results {
		fmt.Println(s)
	}
	fmt.Printf("long lived tree of depth %d\t check: %d\n",
		maxDepth, longLivedTree.check())
	fmt.Printf("took %.02f s", float64(time.Since(start).Milliseconds())/1000)
}