Go append 扩容机制

在《切片传递的隐藏危机》一文中,小菜刀有简单地提及到切片扩容的问题。在读者讨论群中,有人举了以下例子,想得到一个合理的回答。

package main

func main() {
    s := []int{1,2}
    s = append(s, 3,4,5)
    println(cap(s))
}

// output: 6

为什么结果不是5,不是8,而是6呢?由于小菜刀在该文中关于扩容的描述不够准确,让读者产生了疑惑。因此本文想借此机会细致分析一下append函数及其背后的扩容机制。

我们知道,append是一种用户在使用时,并不需要引入相关包而可直接调用的函数。它是内置函数,其定义位于源码包 builtinbuiltin.go

// The append built-in function appends elements to the end of a slice. If
// it has sufficient capacity, the destination is resliced to accommodate the
// new elements. If it does not, a new underlying array will be allocated.
// Append returns the updated slice. It is therefore necessary to store the
// result of append, often in the variable holding the slice itself:
//  slice = append(slice, elem1, elem2)
//  slice = append(slice, anotherSlice...)
// As a special case, it is legal to append a string to a byte slice, like this:
//  slice = append([]byte("hello "), "world"...)
func append(slice []Type, elems ...Type) []Type

append 会追加一个或多个数据至 slice 中,这些数据会存储至 slice 的底层数组。其中,数组长度是固定的,如果数组的剩余空间足以容纳追加的数据,则可以正常地将数据存入该数组。一旦追加数据后总长度超过原数组长度,原数组就无法满足存储追加数据的要求。此时会怎么处理呢?

同时我们发现,该文件中仅仅定义了函数签名,并没有包含函数实现的任何代码。这里我们不免好奇,append究竟是如何实现的呢?

编译过程

为了回答上述问题,我们不妨从编译入手。Go编译可分为四个阶段:词法与语法分析、类型检查与抽象语法树(AST)转换、中间代码生成和生成最后的机器码。

我们主要需要关注的是编译期第二和第三阶段的代码,分别是位于src/cmd/compile/internal/gc/typecheck.go下的类型检查逻辑

func typecheck1(n *Node, top int) (res *Node) {
    ...
    switch n.Op {
    case OAPPEND:
    ...
}

位于src/cmd/compile/internal/gc/walk.go下的抽象语法树转换逻辑

func walkexpr(n *Node, init *Nodes) *Node {
    ...
    case OAPPEND:
            // x = append(...)
            r := n.Right
            if r.Type.Elem().NotInHeap() {
                yyerror("%v can't be allocated in Go; it is incomplete (or unallocatable)", r.Type.Elem())
            }
            switch {
            case isAppendOfMake(r):
                // x = append(y, make([]T, y)...)
                r = extendslice(r, init)
            case r.IsDDD():
                r = appendslice(r, init) // also works for append(slice, string).
            default:
                r = walkappend(r, init, n)
            }
    ...
}  

和位于src/cmd/compile/internal/gc/ssa.go下的中间代码生成逻辑

// append converts an OAPPEND node to SSA.
// If inplace is false, it converts the OAPPEND expression n to an ssa.Value,
// adds it to s, and returns the Value.
// If inplace is true, it writes the result of the OAPPEND expression n
// back to the slice being appended to, and returns nil.
// inplace MUST be set to false if the slice can be SSA'd.
func (s *state) append(n *Node, inplace bool) *ssa.Value {
    ...
}

其中,中间代码生成阶段的state.append方法,是我们重点关注的地方。入参 inplace 代表返回值是否覆盖原变量。如果为false,展开逻辑如下(注意:以下代码只是为了方便理解的伪代码,并不是 state.append 中实际的代码)。同时,小菜刀注意到如果写成 append(s, e1, e2, e3) 不带接收者的形式,并不能通过编译,所以暂未明白它的场景在哪。

    // If inplace is false, process as expression "append(s, e1, e2, e3)": 
   ptr, len, cap := s
     newlen := len + 3
     if newlen > cap {
         ptr, len, cap = growslice(s, newlen)
         newlen = len + 3 // recalculate to avoid a spill
     }
     // with write barriers, if needed:
     *(ptr+len) = e1
     *(ptr+len+1) = e2
     *(ptr+len+2) = e3
     return makeslice(ptr, newlen, cap)

如果是true,例如 slice = append(slice, 1, 2, 3) 语句,那么返回值会覆盖原变量。展开方式逻辑如下

    // If inplace is true, process as statement "s = append(s, e1, e2, e3)":
    
     a := &s
     ptr, len, cap := s
     newlen := len + 3
     if uint(newlen) > uint(cap) {
        newptr, len, newcap = growslice(ptr, len, cap, newlen)
        vardef(a)       // if necessary, advise liveness we are writing a new a
        *a.cap = newcap // write before ptr to avoid a spill
        *a.ptr = newptr // with write barrier
     }
     newlen = len + 3 // recalculate to avoid a spill
     *a.len = newlen
     // with write barriers, if needed:
     *(ptr+len) = e1
     *(ptr+len+1) = e2
     *(ptr+len+2) = e3

不管 inpalce 是否为true,我们均会获取切片的数组指针、大小和容量,如果在追加元素后,切片新的大小大于原始容量,就会调用 runtime.growslice 对切片进行扩容,并将新的元素依次加入切片。

因此,通过append向元素类型为 int 的切片(已包含元素 1,2,3)追加元素 1, slice=append(slice,1)可分为两种情况。

1.png

情况1,切片的底层数组还有可容纳追加元素的空间。

2.png

情况2,切片的底层数组已无可容纳追加元素的空间,需调用扩容函数,进行扩容。

扩容函数

前面我们提到,追加操作时,当切片底层数组的剩余空间不足以容纳追加的元素,就会调用 growslice,其调用的入参 cap 为追加元素后切片的总长度。

growslice 的代码较长,我们可以根据逻辑分为三个部分。

  1. 初步确定切片容量
func growslice(et *_type, old slice, cap int) slice {
  ...
  newcap := old.cap
    doublecap := newcap + newcap
    if cap > doublecap {
        newcap = cap
    } else {
        if old.len < 1024 {
            newcap = doublecap
        } else {
            // Check 0 < newcap to detect overflow
            // and prevent an infinite loop.
            for 0 < newcap && newcap < cap {
                newcap += newcap / 4
            }
            // Set newcap to the requested cap when
            // the newcap calculation overflowed.
            if newcap <= 0 {
                newcap = cap
            }
        }
    }
  ...
}  

在该环节中,如果需要的容量 cap 超过原切片容量的两倍 doublecap,会直接使用需要的容量作为新容量newcap。否则,当原切片长度小于1024时,新切片的容量会直接翻倍。而当原切片的容量大于等于1024时,会反复地增加25%,直到新容量超过所需要的容量。

  1. 计算容量所需内存大小
    var overflow bool   var lenmem, newlenmem, capmem uintptr   switch {    case et.size == 1:      lenmem = uintptr(old.len)       newlenmem = uintptr(cap)        capmem = roundupsize(uintptr(newcap))       overflow = uintptr(newcap) > maxAlloc       newcap = int(capmem)    case et.size == sys.PtrSize:        lenmem = uintptr(old.len) * sys.PtrSize     newlenmem = uintptr(cap) * sys.PtrSize      capmem = roundupsize(uintptr(newcap) * sys.PtrSize)     overflow = uintptr(newcap) > maxAlloc/sys.PtrSize       newcap = int(capmem / sys.PtrSize)  case isPowerOfTwo(et.size):     var shift uintptr       if sys.PtrSize == 8 {           // Mask shift for better code generation.           shift = uintptr(sys.Ctz64(uint64(et.size))) & 63        } else {            shift = uintptr(sys.Ctz32(uint32(et.size))) & 31        }       lenmem = uintptr(old.len) << shift      newlenmem = uintptr(cap) << shift       capmem = roundupsize(uintptr(newcap) << shift)      overflow = uintptr(newcap) > (maxAlloc >> shift)        newcap = int(capmem >> shift)   default:        lenmem = uintptr(old.len) * et.size     newlenmem = uintptr(cap) * et.size      capmem, overflow = math.MulUintptr(et.size, uintptr(newcap))        capmem = roundupsize(capmem)        newcap = int(capmem / et.size)  }

在该环节,通过判断切片元素的字节大小是否为1,系统指针大小(32位为4,64位为8)或2的倍数,进入相应所需内存大小的计算逻辑。

这里需要注意的是 roundupsize 函数,它根据输入期望大小 size ,返回 mallocgc 实际将分配的内存块的大小。

func roundupsize(size uintptr) uintptr {    if size < _MaxSmallSize {       if size <= smallSizeMax-8 {         return uintptr(class_to_size[size_to_class8[divRoundUp(size, smallSizeDiv)]])       } else {            return uintptr(class_to_size[size_to_class128[divRoundUp(size-smallSizeMax, largeSizeDiv)]])        }   }    // Go的内存管理虚拟地址页大小为 8k(_PageSize)  // 当size的大小即将溢出时,就不采用向上取整的做法,直接用当前期望size值。   if size+_PageSize < size {      return size }   return alignUp(size, _PageSize)}

根据内存分配中的大小对象原则,如果期望分配内存非大对象 ( <_MaxSmallSize ),即小于32k,则需要根据 divRoundUp 函数将待申请的内存向上取整,取整时会使用 class_to_size 以及 size_to_class8size_to_class128 数组。这些数组方便于内存分配器进行分配,以提高分配效率并减少内存碎片。

// _NumSizeClasses = 67 代表67种特定大小的对象类型var class_to_size = [_NumSizeClasses]uint16{0, 8, 16, 32, 48, 64, 80, 96, 112,...}

当期望分配内存为大对象时,会通过 alignUp 将该 size 的大小向上取值为虚拟页大小(_PageSize)的倍数。

  1. 内存分配
    if overflow || capmem > maxAlloc {      panic(errorString("growslice: cap out of range"))   }   var p unsafe.Pointer    if et.ptrdata == 0 {        p = mallocgc(capmem, nil, false)        memclrNoHeapPointers(add(p, newlenmem), capmem-newlenmem)   } else {        p = mallocgc(capmem, et, true)      if lenmem > 0 && writeBarrier.enabled {         bulkBarrierPreWriteSrcOnly(uintptr(p), uintptr(old.array), lenmem-et.size+et.ptrdata)       }   }   memmove(p, old.array, lenmem)   return slice{p, old.len, newcap}

如果在第二个环节中,造成了溢出或者期望分配的内存超过最大分配限制,会引起 panic

mallocgc 分配一个大小为前面计算得到的 capmem 对象。如果是小对象,则直接从当前G所在P的缓存空闲列表中分配;如果是大对象,则从堆上进行分配。同时,如果切片中的元素不是指针类型,那么会调用 memclrNoHeapPointers将超出切片当前长度的位置清空;如果是元素是指针类型,且原有切片元素个数不为0 并可以打开写屏障时,需要调用 bulkBarrierPreWriteSrcOnly 将旧切片指针标记隐藏,在新切片中保存为nil指针。

在最后使用memmove将原数组内存中的内容拷贝到新申请的内存中,并将新的内存指向指针p 和旧的长度值,新的容量值赋值给新的 slice 并返回。

注意,在 growslice 完成后,只是把旧有数据拷贝到了新的内存中去,且计算得到新的 slice 容量大小,并没有完成最终追加数据的操作。如果 slice 当前 len =3cap=3slice=append(slice,1),那它完成的工作如下图所示。

3.png

growslice之后,此时新的slice已经拷贝了旧的slice数据,并且其底层数组有充足的剩余空间追加数据。后续只需拷贝追加数据至剩余空间,并修改 len 值即可,这一部分就不再深究了。

总结

这里回到文章开头中的例子

package mainfunc main() {   s := []int{1,2} s = append(s, 3,4,5)    println(cap(s))}

由于初始 s 的容量是2,现需要追加3个元素,所以通过 append 一定会触发扩容,并调用 growslice 函数,此时他的入参 cap 大小为2+3=5。通过翻倍原有容量得到 doublecap = 2+2,doublecap 小于 cap 值,所以在第一阶段计算出的期望容量值 newcap=5。在第二阶段中,元素类型大小 intsys.PtrSize 相等,通过 roundupsize 向上取整内存的大小到 capmem = 48 字节,所以新切片的容量newcap 为 48 / 8 = 6 ,成功解释!

在切片 append 操作时,如果底层数组已无可容纳追加元素的空间,则需扩容。扩容并不是在原有底层数组的基础上增加内存空间,而是新分配一块内存空间作为切片的底层数组,并将原有数据和追加数据拷贝至新的内存空间中。

在扩容的容量确定上,相对比较复杂,它与CPU位数、元素大小、是否包含指针、追加个数等都有关系。当我们看完扩容源码逻辑后,发现去纠结它的扩容确切值并没什么必要。

在实际使用中,如果能够确定切片的容量范围,比较合适的做法是:切片初始化时就分配足够的容量空间,在append追加操作时,就不用再考虑扩容带来的性能损耗问题。

func BenchmarkAppendFixCap(b *testing.B) {  for i := 0; i < b.N; i++ {      a := make([]int, 0, 1000)       for i := 0; i < 1000; i++ {         a = append(a, i)        }   }}func BenchmarkAppend(b *testing.B) {  for i := 0; i < b.N; i++ {      a := make([]int, 0)     for i := 0; i < 1000; i++ {         a = append(a, i)        }   }}

它们的压测结果如下,孰优孰劣,一目了然。

 $ go test -bench=. -benchmem

BenchmarkAppendFixCap-8          1953373               617 ns/op               0 B/op          0 allocs/op
BenchmarkAppend-8                 426882              2832 ns/op           16376 B/op         11 allocs/op

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

推荐阅读更多精彩内容