chriskaliX / Golang-Diary

This repository is for recording my golang learning. It's very important !!!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Golang-Diary

This repository is for recording my golang learning. It's very important !!! Reference. PS: The book was bought, and it's fantastic, the Diary is just the part of this

写了一段时间的 go, 原理\设计等方面的缺失必须要引起重视! 计划为在 2 个月内完成所有部分的阅读(源码级)

Start from: 2021-12-29 23:35 Update: 2022-02-12 22:28

初步的过了一遍,有些地方概念还有一些模糊,会在后面的时间内慢慢补全

第一部分:预备知识

第二部分: 基础知识

第三章: 数据结构

3.1 数组

3.1.1 概述

通常从元素类型和元素个数来定义一个数组。跟文章中略微有些更新,在 cmd/compile/internal/types.NewArray 如下:

// NewArray returns a new fixed-length array Type.
func NewArray(elem *Type, bound int64) *Type {
    if bound < 0 {
        base.Fatalf("NewArray: invalid bound %v", bound)
    }
    t := newType(TARRAY)
    t.extra = &Array{Elem: elem, Bound: bound}
    // chriskali: 设置类型是否分配在 GC 堆栈上
    // 官方文档: https://github.com/golang/go/blob/master/src/runtime/HACKING.md
    // 通常有全局变量,或者由 sysAlloc\persistentalloc\fixalloc分配的 或者其他手动管理的
    SetNotInHeap(elem.NotInHeap())
    // chriskali: 泛型相关
    // there is a typeparam somewhere in the type (generic function or type)
    if elem.HasTParam() {
        t.SetHasTParam(true)
    }
    // chriskali: 也是泛型相关
    // 引入的 commit: https://github.com/golang/go/commit/a7a17f0ca86d252dc1ef20b5852c352ade5f8610#diff-32ea261f6c80677968cc1fbf0a8edd91a86c3d2d9f5313cb8ac3cc901654cdf1
    // 是否能够隐式转换
    // typeIsShape: represents a set of closely related types, for generics
    if elem.HasShape() {
        t.SetHasShape(true)
    }
    return t
}

能看到相比之前的,go 1.18 beta 开始着手于泛型相关。看来 2022 年可以见到带有泛型的 go 1.18 了

3.1.2 初始化

初始化的方式有两种,一种固定长度,一种推导。推导在编译时候就会被转换成为固定长度

arr1 := [3]int{1, 2, 3}
arr2 := [...]int{1, 2, 3}
上限推导

这部分的源码和书中的略有不同,在 cmd/compile/internal/typecheck/expr.go#tcCompLit

// 	n.Left = tcCompLit(n.Left)
func tcCompLit(n *ir.CompLitExpr) (res ir.Node) {
    ...
	// Need to handle [...]T arrays specially.
	if array, ok := n.Ntype.(*ir.ArrayType); ok && array.Elem != nil && array.Len == nil {
		array.Elem = typecheckNtype(array.Elem)
		elemType := array.Elem.Type()
		if elemType == nil {
			n.SetType(nil)
			return n
		}
		length := typecheckarraylit(elemType, -1, n.List, "array literal")
		n.SetOp(ir.OARRAYLIT)
		n.SetType(types.NewArray(elemType, length))
		n.Ntype = nil
		return n
	}
    ...
	switch t.Kind() {
    ...
	case types.TARRAY:
		typecheckarraylit(t.Elem(), t.NumElem(), n.List, "array literal")
		n.SetOp(ir.OARRAYLIT)
		n.Ntype = nil
    ...
	}

	return n
}

可以看到关键函数为 typecheckarraylit 中对 length 的推导,继续跟进,源码如下:

// typecheckarraylit type-checks a sequence of slice/array literal elements.
func typecheckarraylit(elemType *types.Type, bound int64, elts []ir.Node, ctx string) int64 {
	// If there are key/value pairs, create a map to keep seen
	// keys so we can check for duplicate indices.
	var indices map[int64]bool
	for _, elt := range elts {
		if elt.Op() == ir.OKEY {
			indices = make(map[int64]bool)
			break
		}
	}

	var key, length int64
	for i, elt := range elts {
		ir.SetPos(elt)
		r := elts[i]
		var kv *ir.KeyExpr
        // 如果 elt 是 key/value 类型
        // ir.OKEY => Key:Value (key:value in struct/array/map literal)
		if elt.Op() == ir.OKEY {
			elt := elt.(*ir.KeyExpr)
			elt.Key = Expr(elt.Key)
			key = IndexConst(elt.Key)
			if key < 0 {
				if !elt.Key.Diag() {
					if key == -2 {
						base.Errorf("index too large")
					} else {
						base.Errorf("index must be non-negative integer constant")
					}
					elt.Key.SetDiag(true)
				}
				key = -(1 << 30) // stay negative for a while
			}
			kv = elt
			r = elt.Value
		}

		r = pushtype(r, elemType)
		r = Expr(r)
		r = AssignConv(r, elemType, ctx)
		if kv != nil {
			kv.Value = r
		} else {
			elts[i] = r
		}

		if key >= 0 {
			if indices != nil {
				if indices[key] {
					base.Errorf("duplicate index in %s: %d", ctx, key)
				} else {
					indices[key] = true
				}
			}

			if bound >= 0 && key >= bound {
				base.Errorf("array index %d out of bounds [0:%d]", key, bound)
				bound = -1
			}
		}

		key++
		if key > length {
			length = key
		}
	}

	return length
}

这一部分涉及到 golang 相关的编译处理(暂时还不会),CompLitExprir 相关的在 cmd/compile/internal/ir 下。通过遍历传递进来的 ir.Node 来遍历元素(中间对 key/value 形式做了别的判断, 暂时还没看) 来进行数量上的计算,最后返回 length

可见两种写法在运行时是一样的,在编译阶段通过对 [...]T{...} 形式的推导,来完成 length 的计算

语句转换

先只看 ARRAY 相关的部分

func anylit(n ir.Node, var_ ir.Node, init *ir.Nodes) {
    ...
	case ir.OSTRUCTLIT, ir.OARRAYLIT:
		n := n.(*ir.CompLitExpr)
		if !t.IsStruct() && !t.IsArray() {
			base.Fatalf("anylit: not struct/array")
		}
        // chriskali
        // 关键点,判断长度是否大于 4
		if isSimpleName(var_) && len(n.List) > 4 {
			// lay out static data
			vstat := readonlystaticname(t)

			ctxt := inInitFunction
			if n.Op() == ir.OARRAYLIT {
				ctxt = inNonInitFunction
			}
			fixedlit(ctxt, initKindStatic, n, vstat, init)

			// copy static to var
			appendWalkStmt(init, ir.NewAssignStmt(base.Pos, var_, vstat))

			// add expressions to automatic
			fixedlit(inInitFunction, initKindDynamic, n, var_, init)
			break
		}

		var components int64
		if n.Op() == ir.OARRAYLIT {
			components = t.NumElem()
		} else {
			components = int64(t.NumFields())
		}
		// initialization of an array or struct with unspecified components (missing fields or arrays)
		if isSimpleName(var_) || int64(len(n.List)) < components {
			appendWalkStmt(init, ir.NewAssignStmt(base.Pos, var_, nil))
		}

		fixedlit(inInitFunction, initKindLocalCode, n, var_, init)
    ...
	}
}

可以看到判断的临界点为元素个数是否大于 4。跟进 fixedlit 函数,主要看对 Kind 的处理

func fixedlit(ctxt initContext, kind initKind, n *ir.CompLitExpr, var_ ir.Node, init *ir.Nodes) {
	isBlank := var_ == ir.BlankNode
	var splitnode func(ir.Node) (a ir.Node, value ir.Node)
	...
	for _, r := range n.List {
		a, value := splitnode(r)
		...
		// build list of assignments: var[index] = expr
		ir.SetPos(a)
		as := ir.NewAssignStmt(base.Pos, a, value)
		as = typecheck.Stmt(as).(*ir.AssignStmt)
		switch kind {
		case initKindStatic:
			genAsStatic(as)
		// 当 len 小于等于 4 时,Kind 为 initKindLocalCode
		case initKindDynamic, initKindLocalCode:
			a = orderStmtInPlace(as, map[string][]*ir.Name{})
			a = walkStmt(a)
			init.Append(a)
		default:
			base.Fatalf("fixedlit: bad kind %d", kind)
		}
	}
}

len 小于等于 4 的时候,关键函数为 orderStmtInPlace,我们看一下对他的定义

// orderStmtInPlace orders the side effects of the single statement *np
// and replaces it with the resulting statement list.
// The result of orderStmtInPlace MUST be assigned back to n, e.g.
// 	n.Left = orderStmtInPlace(n.Left)
// free is a map that can be used to obtain temporary variables by type.
func orderStmtInPlace(n ir.Node, free map[string][]*ir.Name) ir.Node {
	var order orderState
	order.free = free
	mark := order.markTemp()
	order.stmt(n)
	order.cleanTemp(mark)
	return ir.NewBlockStmt(src.NoXPos, order.out)
}

看 desc 的大致含义为,将字段进行排序并替换为 resulting statement list ,看了作者的解释,大致为:

var arr [3]int
arr[0] = 1
arr[1] = 2
arr[2] = 3

len 大于 4 的时候,会先调用 readonlystaticname 获取一个 staticname,在静态存储区(kindinitKindStatic) 初始化,然后将 staticname append 到这个数组中,最后和第一种情况一样,进行展开,copy 一下作者的伪代码

var arr [5]int
statictmp_0[0] = 1
statictmp_0[1] = 2
statictmp_0[2] = 3
statictmp_0[3] = 4
statictmp_0[4] = 5
arr = statictmp_0

3.1.3 访问和赋值

checks 代码函数为 tcIndex

func tcIndex(n *ir.IndexExpr) ir.Node {
	n.X = Expr(n.X)
	n.X = DefaultLit(n.X, nil)
	n.X = implicitstar(n.X)
	l := n.X
	n.Index = Expr(n.Index)
	r := n.Index
	t := l.Type()
	if t == nil || r.Type() == nil {
		n.SetType(nil)
		return n
	}
	switch t.Kind() {
	...
	case types.TSTRING, types.TARRAY, types.TSLICE:
		n.Index = indexlit(n.Index)
		if t.IsString() {
			n.SetType(types.ByteType)
		} else {
			n.SetType(t.Elem())
		}
		why := "string"
		if t.IsArray() {
			why = "array"
		} else if t.IsSlice() {
			why = "slice"
		}

		// 必须为正整数
		if n.Index.Type() != nil && !n.Index.Type().IsInteger() {
			base.Errorf("non-integer %s index %v", why, n.Index)
			return n
		}

		if !n.Bounded() && ir.IsConst(n.Index, constant.Int) {
			x := n.Index.Val()
			// 判断是否 negative
			if constant.Sign(x) < 0 {
				base.Errorf("invalid %s index %v (index must be non-negative)", why, n.Index)
			// 越界 check
			} else if t.IsArray() && constant.Compare(x, token.GEQ, constant.MakeInt64(t.NumElem())) {
				base.Errorf("invalid array index %v (out of bounds for %d-element array)", n.Index, t.NumElem())
			// same
			} else if ir.IsConst(n.X, constant.String) && constant.Compare(x, token.GEQ, constant.MakeInt64(int64(len(ir.StringVal(n.X))))) {
				base.Errorf("invalid string index %v (out of bounds for %d-byte string)", n.Index, len(ir.StringVal(n.X)))
			// overflow 检查
			} else if ir.ConstOverflow(x, types.Types[types.TINT]) {
				base.Errorf("invalid %s index %v (index too large)", why, n.Index)
			}
		}
		...
	return n
}

以上是在编译期间的对数组的 check。在生成中间代码期间,还会插入运行时方法runtime.panicIndex 调用防止发生越界错误。这里我跳过了 ssa 的部分,先不看到那么深...

3.2 切片

相比数组,切片更为常用

创建部分的代码和书中的代码基本一样,只是和数组一样多了泛型相关判断

func NewSlice(elem *Type) *Type {
	if t := elem.cache.slice; t != nil {
		if t.Elem() != elem {
			base.Fatalf("elem mismatch")
		}
		if elem.HasTParam() != t.HasTParam() || elem.HasShape() != t.HasShape() {
			base.Fatalf("Incorrect HasTParam/HasShape flag for cached slice type")
		}
		return t
	}

	t := newType(TSLICE)
	// extra 字段来附加类型,帮助运行时的动态获取
	t.extra = Slice{Elem: elem}
	elem.cache.slice = t
	if elem.HasTParam() {
		t.SetHasTParam(true)
	}
	if elem.HasShape() {
		t.SetHasShape(true)
	}
	return t
}
3.2.1 数据结构
// SliceHeader is the runtime representation of a slice.
// It cannot be used safely or portably and its representation may
// change in a later release.
// Moreover, the Data field is not sufficient to guarantee the data
// it references will not be garbage collected, so programs must keep
// a separate, correctly typed pointer to the underlying data.
type SliceHeader struct {
	Data uintptr
	Len  int
	Cap  int
}

熟悉的 LenCapData 即指向一片连续的内存,这和后面 runtime 中数组的操作有关

3.2.2 初始化

三种方式

arr[0:3] or slice[0:3]
slice := []int{1, 2, 3}
slice := make([]int, 10)

使用下标

在作者展示的 SSA 代码中,能看到接收了几个参数,初始化一个 array,将 ptr 指向到 array,然后赋值 caplen

字面量

在编译期间,展开为

var vstat [3]int
vstat[0] = 1
vstat[1] = 2
vstat[2] = 3
var vauto *[3]int = new([3]int)
*vauto = vstat
slice := vauto[:]

关键字

运行时参与,关键函数 typecheck1

func typecheck1(n ir.Node, top int) ir.Node {
	...
	switch n.Op() {
	...
	case ir.OMAKE:
	n := n.(*ir.CallExpr)
	return tcMake(n)
	...
	}
}

跟进

func tcMake(n *ir.CallExpr) ir.Node {
	args := n.Args
	if len(args) == 0 {
		base.Errorf("missing argument to make")
		n.SetType(nil)
		return n
	}
	// 取第一个参数
	n.Args = nil
	l := args[0]
	l = typecheck(l, ctxType)
	t := l.Type()
	if t == nil {
		n.SetType(nil)
		return n
	}
	i := 1
	var nn ir.Node
	switch t.Kind() {
		...
		case types.TSLICE:
		// 检查是否传递 len
		if i >= len(args) {
			base.Errorf("missing len argument to make(%v)", t)
			n.SetType(nil)
			return n
		}

		l = args[i]
		i++
		l = Expr(l)
		var r ir.Node
		if i < len(args) {
			r = args[i]
			i++
			r = Expr(r)
		}
		// 类型判断
		if l.Type() == nil || (r != nil && r.Type() == nil) {
			n.SetType(nil)
			return n
		}
		if !checkmake(t, "len", &l) || r != nil && !checkmake(t, "cap", &r) {
			n.SetType(nil)
			return n
		}
		// cap 必须 >= len
		if ir.IsConst(l, constant.Int) && r != nil && ir.IsConst(r, constant.Int) && constant.Compare(l.Val(), token.GTR, r.Val()) {
			base.Errorf("len larger than cap in make(%v)", t)
			n.SetType(nil)
			return n
		}
		nn = ir.NewMakeExpr(n.Pos(), ir.OMAKESLICE, l, r)
	}
}

判断以及校验,创建切片的 runtime 函数为

func makeslice(et *_type, len, cap int) unsafe.Pointer {
	mem, overflow := math.MulUintptr(et.size, uintptr(cap))
	if overflow || mem > maxAlloc || len < 0 || len > cap {
		// NOTE: Produce a 'len out of range' error instead of a
		// 'cap out of range' error when someone does make([]T, bignumber).
		// 'cap out of range' is true too, but since the cap is only being
		// supplied implicitly, saying len is clearer.
		// See golang.org/issue/4085.
		mem, overflow := math.MulUintptr(et.size, uintptr(len))
		if overflow || mem > maxAlloc || len < 0 {
			panicmakeslicelen()
		}
		panicmakeslicecap()
	}

	return mallocgc(mem, et, true)
}
3.2.3 访问元素
3.2.4 追加扩容

两种情况处理,是否需要将 slice 赋值给原来的 slice。对于赋给原有变量的做了优化,不用担心拷贝发生的性能影响。

追加元素

这一部分代码和之前的不一样

func growslice(et *_type, old slice, cap int) slice {
	...
	newcap := old.cap
	doublecap := newcap + newcap
	// chriskali
	// 点1:如果大于当前容量的两倍,则直接扩容到期望值
	if cap > doublecap {
		newcap = cap
	// 当在2倍以内时
	} else {
		// 和文章中不一样,threshold 变成 256 了
		const threshold = 256
		// 点2:当小于 256 的时候,翻倍
		if old.cap < threshold {
			newcap = doublecap
		} else {
			// Check 0 < newcap to detect overflow
			// and prevent an infinite loop.
			// 点3:循环 25% 的增加,直到大于期望的值
			for 0 < newcap && newcap < cap {
				// Transition from growing 2x for small slices
				// to growing 1.25x for large slices. This formula
				// gives a smooth-ish transition between the two.
				newcap += (newcap + 3*threshold) / 4
			}
			// Set newcap to the requested cap when
			// the newcap calculation overflowed.
			if newcap <= 0 {
				newcap = cap
			}
		}
	}

	var overflow bool
	var lenmem, newlenmem, capmem uintptr
	// Specialize for common values of et.size.
	// For 1 we don't need any division/multiplication.
	// For sys.PtrSize, compiler will optimize division/multiplication into a shift by a constant.
	// For powers of 2, use a variable shift.
	// 点4:1、8、2的倍数做内存对齐。roundupsize 函数
	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 == goarch.PtrSize:
		lenmem = uintptr(old.len) * goarch.PtrSize
		newlenmem = uintptr(cap) * goarch.PtrSize
		capmem = roundupsize(uintptr(newcap) * goarch.PtrSize)
		overflow = uintptr(newcap) > maxAlloc/goarch.PtrSize
		newcap = int(capmem / goarch.PtrSize)
	case isPowerOfTwo(et.size):
		var shift uintptr
		if goarch.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:
		...
	}
	...
}
3.2.5 拷贝切片

简单来说 runtime.memmove 整个拷贝,新建 SliceHeaderData ptr 指向到新建的内存。整段拷贝依然会消耗比较大的资源

3.3 哈希表

核心**:若关键字为 k,则其值存放在 f(k) 的存储位置上。由此,不需比较便可直接取得所查记录。在 golang 中,重点关注 runtime/map.go 下的实现

3.3.1 设计原理

非常重要的数据结构之一。关键词:数据结构,哈希函数,冲突解决方法。建立一个合理的均匀分布 key 以及 冲突的处理 十分关键

哈希函数

补充一下

  • 直接定址法
  • 数字分析法
  • 平方取中法
  • 折叠法
  • 随机数法
  • 除留余数法

冲突解决

将无限映射到有限,一定会有冲突的问题。目前提到的冲突并不是哈希完全相等,而是部分,例如前几个字节相同

常见的处理冲突的方式有:1. 开放寻址法 2. 拉链法 (百度的一个 3. 桶定址法)

  • 开放寻址法(Reference)

    核心**为:依次探测和比较数组中的元素以判断目标键值对是否存在于哈希表中。当写入数据的时候,如果发生了冲突,就会将键值对写入到下一个索引不为空的位置 这一块跟语言无关,所以直接看哈希表-Reference-1,更加直接一点。 增量的

    • Linear Probing: 逐个弹出额存放地址的表,直到查找到一个空单元,把散列地址存放在该空单元
    • Quadratic Probing: 平方探测
    • Double hashing: 用另外一个 hash function 来做二次随机
  • 拉链法

    拉链法的实现一般为数组 + 链表的形式。由于其平均查找时间短,存储节点的内存都是动态申请,节省内存空间。也是实现的最常见的方式。这个会在别的仓库里重新过一遍

    有一个比较重要的概念 - 装载因子,装载因子越大,填入的数据越多,空间利用率就越高,但是发生 hash 冲突的的概率越大。在拉链法中,装载因子为

    装载因子 := 元素数量 / 桶数量

    在 golang 中装载因子固定的为 6.5,即每个 bucket 平均存储的 kv 超过 6.5 个的时候,就会进行扩容

3.3.2 数据结构
// A header for a Go map.
type hmap struct {
	count     int // 元素个数
	flags     uint8	// 状态位
	B         uint8  // log_2 of # of buckets (can hold up to loadFactor * 2^B items),通过 B 值来计算
	noverflow uint16 // 溢出桶的大致数量
	hash0     uint32 // hash seed

	buckets    unsafe.Pointer // array of 2^B Buckets. may be nil if count==0.
	oldbuckets unsafe.Pointer // 发生扩容,old buckets 指向老 buckets,长度为新的 1/2
	nevacuate  uintptr        // progress counter for evacuation (buckets less than this have been evacuated)

	extra *mapextra // 优化 GC 扫描而设定的
}

type mapextra struct {
	// If both key and elem do not contain pointers and are inline, then we mark bucket
	// type as containing no pointers. This avoids scanning such maps.
	// However, bmap.overflow is a pointer. In order to keep overflow buckets
	// alive, we store pointers to all overflow buckets in hmap.extra.overflow and hmap.extra.oldoverflow.
	// overflow and oldoverflow are only used if key and elem do not contain pointers.
	// overflow contains overflow buckets for hmap.buckets.
	// oldoverflow contains overflow buckets for hmap.oldbuckets.
	// The indirection allows to store a pointer to the slice in hiter.
	overflow    *[]*bmap
	oldoverflow *[]*bmap

	// nextOverflow holds a pointer to a free overflow bucket.
	nextOverflow *bmap
}

// A bucket for a Go map.
type bmap struct {
	// tophash generally contains the top byte of the hash value
	// for each key in this bucket. If tophash[0] < minTopHash,
	// tophash[0] is a bucket evacuation state instead.
	tophash [bucketCnt]uint8
	// Followed by bucketCnt keys and then bucketCnt elems.
	// NOTE: packing all the keys together and then all the elems together makes the
	// code a bit more complicated than alternating key/elem/key/elem/... but it allows
	// us to eliminate padding which would be needed for, e.g., map[int64]int8.
	// Followed by an overflow pointer.
}

作者博客里的图非常好,帮助我们理解

map-1

另外附上一个博客里的图片

map-2

首先 hmap 指向一个 bucket array ,每个 bucket (即 bmap) 存储至多 8 个键值对。在 hmap 中的 extra 字段存储为溢出桶

下面是关键的常量信息

const (
	// Maximum number of key/elem pairs a bucket can hold.
	bucketCntBits = 3
	bucketCnt     = 1 << bucketCntBits

	// 装载因子为 6.5
	loadFactorNum = 13
	loadFactorDen = 2

	// Maximum key or elem size to keep inline (instead of mallocing per element).
	// Must fit in a uint8.
	// Fast versions cannot handle big elems - the cutoff size for
	// fast versions in cmd/compile/internal/gc/walk.go must be at most this elem.
	maxKeySize  = 128
	maxElemSize = 128

	// data offset should be the size of the bmap struct, but needs to be
	// aligned correctly. For amd64p32 this means 64-bit alignment
	// even though pointers are 32 bit.
	dataOffset = unsafe.Offsetof(struct {
		b bmap
		v int64
	}{}.v)

	emptyRest      = 0 // this cell is empty, and there are no more non-empty cells at higher indexes or overflows.
	emptyOne       = 1 // this cell is empty
	evacuatedX     = 2 // key/elem is valid.  Entry has been evacuated to first half of larger table.
	evacuatedY     = 3 // same as above, but evacuated to second half of larger table.
	evacuatedEmpty = 4 // cell is empty, bucket is evacuated.
	minTopHash     = 5 // minimum tophash for a normal filled cell.

	// flags
	iterator     = 1 // there may be an iterator using buckets
	oldIterator  = 2 // there may be an iterator using oldbuckets
	hashWriting  = 4 // a goroutine is writing to the map
	sameSizeGrow = 8 // the current map growth is to a new map of the same size

	// sentinel bucket ID for iterator checks
	noCheck = 1<<(8*goarch.PtrSize) - 1
)

map-3

为什么是 6.5 呢,在 runtime.map 中找到一个注释,他们做了一下解释和 benchmark

// Picking loadFactor: too large and we have lots of overflow
// buckets, too small and we waste a lot of space. I wrote
// a simple program to check some stats for different loads:
// (64-bit, 8 byte keys and elems)
//  loadFactor    %overflow  bytes/entry     hitprobe    missprobe
//        4.00         2.13        20.77         3.00         4.00
//        4.50         4.05        17.30         3.25         4.50
//        5.00         6.85        14.77         3.50         5.00
//        5.50        10.55        12.94         3.75         5.50
//        6.00        15.27        11.67         4.00         6.00
//        6.50        20.90        10.79         4.25         6.50
//        7.00        27.14        10.15         4.50         7.00
//        7.50        34.03         9.73         4.75         7.50
//        8.00        41.10         9.40         5.00         8.00
//
// %overflow   = percentage of buckets which have an overflow bucket
// bytes/entry = overhead bytes used per key/elem pair
// hitprobe    = # of entries to check when looking up a present key
// missprobe   = # of entries to check when looking up an absent key
//
// Keep in mind this data is for maximally loaded tables, i.e. just
// before the table grows. Typical tables will be somewhat less loaded.

补充:这里在幼麟的视频里面说的很好,我更新记录记录几个关键字:

  1. 是否大于 1024,小于先尝试翻倍扩容,大于则 1.25 倍,重复直到...
  2. 当小于 1024 的时候和扩容前 * 2 的相比,如果大于则取赋值的 Cap
  3. 内存申请的时候对齐,8,16,32,48,例如当原先 cap 为 2,扩容之后为 5,5*8=40,则取大值 48
3.3.3 初始化

字面量

创建的过程和 slice 基本相同

运行时

当我们用 make(map[k]v) 或者 make(map[k]v, hint),且 hint 小于等于 8 的时候,会分配到 heap

// makemap_small implements Go map creation for make(map[k]v) and
// make(map[k]v, hint) when hint is known to be at most bucketCnt
// at compile time and the map needs to be allocated on the heap.
func makemap_small() *hmap {
	h := new(hmap)
	h.hash0 = fastrand()
	return h
}

当 hint 比 8 大的时候,调用函数 makemap

func makemap(t *maptype, hint int, h *hmap) *hmap {
	// 判断是否溢出
	mem, overflow := math.MulUintptr(uintptr(hint), t.bucket.size)
	if overflow || mem > maxAlloc {
		hint = 0
	}

	// initialize Hmap
	if h == nil {
		h = new(hmap)
	}
	h.hash0 = fastrand()

	// Find the size parameter B which will hold the requested # of elements.
	// For hint < 0 overLoadFactor returns false since hint < bucketCnt.
	// 根据传入的 hint 算出最小的 B 值
	B := uint8(0)
	for overLoadFactor(hint, B) {
		B++
	}
	h.B = B

	// allocate initial hash table
	// if B == 0, the buckets field is allocated lazily later (in mapassign)
	// If hint is large zeroing this memory could take a while.
	if h.B != 0 {
		var nextOverflow *bmap
		// 根据 B 值创建桶
		h.buckets, nextOverflow = makeBucketArray(t, h.B, nil)
		if nextOverflow != nil {
			h.extra = new(mapextra)
			h.extra.nextOverflow = nextOverflow
		}
	}

	return h
}
读写操作

访问

写入

扩容

扩容有两种情况,第一种就是上面提到的装载因子超过了 6.5 第二种即为使用了太多溢出桶,为等量扩容

func hashGrow(t *maptype, h *hmap) {
	// If we've hit the load factor, get bigger.
	// Otherwise, there are too many overflow buckets,
	// so keep the same number of buckets and "grow" laterally.
	bigger := uint8(1)
	if !overLoadFactor(h.count+1, h.B) {
		bigger = 0
		h.flags |= sameSizeGrow
	}
	// 将原先的 buckets 转移到 oldbuckets
	oldbuckets := h.buckets
	// 创建新的 buckets 和 溢出桶
	newbuckets, nextOverflow := makeBucketArray(t, h.B+bigger, nil)

	flags := h.flags &^ (iterator | oldIterator)
	if h.flags&iterator != 0 {
		flags |= oldIterator
	}
	// commit the grow (atomic wrt gc)
	h.B += bigger
	h.flags = flags
	h.oldbuckets = oldbuckets
	h.buckets = newbuckets
	h.nevacuate = 0
	h.noverflow = 0

	if h.extra != nil && h.extra.overflow != nil {
		// Promote current overflow buckets to the old generation.
		if h.extra.oldoverflow != nil {
			throw("oldoverflow is not nil")
		}
		h.extra.oldoverflow = h.extra.overflow
		h.extra.overflow = nil
	}
	if nextOverflow != nil {
		if h.extra == nil {
			h.extra = new(mapextra)
		}
		h.extra.nextOverflow = nextOverflow
	}

	// the actual copying of the hash table data is done incrementally
	// by growWork() and evacuate().
}

...

删除

第四章 语言基础

4.1 函数调用

Go 中的参数传递, 无论是传递基本类型、结构体还是指针,都会对传递的参数进行拷贝

4.2 接口

4.2.1 概述

分类

iface(runtime.iface) - eface(runtime.eface)

指针和接口

两种形式,对接口的实现

// 结构体初始化
func (c  Cat) Quack{}
// 指针初始化
func (c *Cat) Quack{}

首先记住一个结论

结构体实现 结构体指针实现
结构体初始化变量 P F
结构体指针初始化变量 P P
4.2.2 数据结构

上面提到了有两种分类, 其中 runtime.iface 表示的是包含方法的接口, runtime.eface 表示的是不包含任何方法的 interface{} 类型

type eface struct {
	typ, val unsafe.Pointer
}

type iface struct {
	tab  *itab
	data unsafe.Pointer
}

和书中略微不同的是, eface 的这部分 typ 也已经变成了 unsafe.Pointer, (猜测可能是因为泛型?)

我们看一下 itab 的定义

type itab struct {
	inter *interfacetype
	_type *_type
	hash  uint32 // copy of _type.hash. Used for type switches.
	_     [4]byte
	fun   [1]uintptr // variable sized. fun[0]==0 means _type does not implement inter.
}

fun 这个是动态派发和虚函数表,虚函数表好像在 C++ 里面看过这个,但是忘记了

4.2.3 类型转换

按照书中说的,go tool compile -S test.go 一下看汇编

package main

// go tool compile -N -S test.go

type Duck interface {
	Quack()
}

type Cat struct {
	Name string
}

//go:noinline
func (c *Cat) Quack() {
	println(c.Name + " meow")
}

func main() {
	var c Duck = &Cat{Name: "draven"}
	c.Quack()
}
4.2.4 类型断言
4.2.5 动态派发

第五章 常用关键字

5.1 for & for range

for range 的形式最终也会优化成 for 循环

5.1.1 现象

容易出错的地方

func main() {
	arr := []int{1, 2, 3}
	newArr := []*int{}
	for _, v := range arr {
		newArr = append(newArr, &v) // should be &arr[i]
	}
	for _, v := range newArr {
		fmt.Println(*v)
	}
}

// result: 3 3 3
// reason: 而遇到这种同时遍历索引和元素的 range 循环时,Go 语言会额外创建一个新的 v2 变量存储切片中的元素,循环中使用的这个变量 v2 会在每一次迭代被重新赋值而覆盖,赋值时也会触发拷贝
// 会优化, 直接调用 runtime.memclrNoHeapPointers 或者 runtime.memclrHasPointers 清除目标数组内存空间中的全部数据
for i := range test {
	test[i] = 0
}

5.2 select

5.3 defer

5.3.1 现象

关键词:顺序、传递参数预计算

顺序:FILO

预计算:代码 demo

func main() {
	startedAt := time.Now()
	defer fmt.Println(time.Since(startedAt))

	time.Sleep(time.Second)
}

// result 0s

在调用 defer 的时候就已经完成了计算。函数调用是传值的,所以运行到 defer 关键字的时候已经拷贝了当前的参数,解决方法就是匿名函数

这个倒是挺有意思的,之前被问到过

func main() {
	startedAt := time.Now()
	defer func() { fmt.Println(time.Since(startedAt)) }()

	time.Sleep(time.Second)
}

同样值传递,但是拷贝的是函数指针,在退出前进行运算

5.3.2 数据结构

直接找到源码内带注释的

// A _defer holds an entry on the list of deferred calls.
// If you add a field here, add code to clear it in freedefer and deferProcStack
// This struct must match the code in cmd/compile/internal/ssagen/ssa.go:deferstruct
// and cmd/compile/internal/ssagen/ssa.go:(*state).call.
// Some defers will be allocated on the stack and some on the heap.
// All defers are logically part of the stack, so write barriers to
// initialize them are not required. All defers must be manually scanned,
// and for heap defers, marked.
type _defer struct {
	started bool
	heap    bool
	// openDefer indicates that this _defer is for a frame with open-coded
	// defers. We have only one defer record for the entire frame (which may
	// currently have 0, 1, or more defers active).
	openDefer bool
	sp        uintptr // sp at time of defer
	pc        uintptr // pc at time of defer
	fn        func()  // can be nil for open-coded defers
	_panic    *_panic // panic that is running defer
	link      *_defer // next defer on G; can point to either heap or stack!

	// If openDefer is true, the fields below record values about the stack
	// frame and associated function that has the open-coded defer(s). sp
	// above will be the sp for the frame, and pc will be address of the
	// deferreturn call in the function.
	fd   unsafe.Pointer // funcdata for the function associated with the frame
	varp uintptr        // value of varp for the stack frame
	// framepc is the current pc associated with the stack frame. Together,
	// with sp above (which is the sp associated with the stack frame),
	// framepc/sp can be used as pc/sp pair to continue a stack trace via
	// gentraceback().
	framepc uintptr
}

_defer 是延迟调用表当中的一个元素,最终都会通过 link 串联起来。在 link 的注释中也能看到,可以在堆 或者 栈上分配

5.3.3 执行机制

关键词:根据开放编码 open-coded

func (s *state) stmt(n ir.Node) {
	switch n.Op() {
	...
	case ir.ODEFER:
		n := n.(*ir.GoDeferStmt)
		if base.Debug.Defer > 0 {
			var defertype string
			if s.hasOpenDefers {
				defertype = "open-coded"
			} else if n.Esc() == ir.EscNever {
				defertype = "stack-allocated"
			} else {
				defertype = "heap-allocated"
			}
			base.WarnfAt(n.Pos(), "%s defer", defertype)
		}
		// 判断开放编码
		if s.hasOpenDefers {
			s.openDeferRecord(n.Call.(*ir.CallExpr))
		} else {
			d := callDefer // 堆
			if n.Esc() == ir.EscNever {
				d = callDeferStack // 栈
			}
			s.callResult(n.Call.(*ir.CallExpr), d)
		}
	}
5.3.4 堆上分配
5.3.5 栈上分配
5.3.6 开放编码

unfinished https://draveness.me/golang/docs/part2-foundation/ch05-keyword/golang-defer/

然而开放编码作为一种优化 defer 关键字的方法,它不是在所有的场景下都会开启的,开放编码只会在满足以下的条件时启用:

函数的 defer 数量少于或者等于 8 个; 函数的 defer 关键字不能在循环中执行; 函数的 return 语句与 defer 语句的乘积小于或者等于 15 个;

5.4 panic & recover

5.4.1 现象
  • panic 只会触发当前 Goroutine 的 defer;
  • recover 只有在 defer 中调用才会生效;
  • panic 允许在 defer 中嵌套多次调用;

一个一个理解,首先第一个,code demo

func main() {
	defer println("in main")
	go func() {
		defer println("in goroutine")
		panic("")
	}()

	time.Sleep(1 * time.Second)
}

只输出 in goroutine 。在之前的结构体里,看 link 的注释,可以看到 next defer on G;,是每一个 Goroutine 维护一个 _defer 链表,所以只触发当前的

第二个太简单跳过

第三个代码范例

func main() {
	defer fmt.Println("in main")
	defer func() {
		defer func() {
			panic("panic again and again")
		}()
		panic("panic again")
	}()
	panic("panic once")
}

defer 中的 panic 都会依次打印。panic 不会影响 defer 的正常运行,所以一般来说用 defer 更为安全

....

5.5 make & new

  • make 的作用是初始化内置的数据结构,也就是我们在前面提到的切片、哈希表和 Channel
  • new 的作用是根据传入的类型分配一片内存空间并返回指向这片内存空间的指针

第三部分:运行时

第六章 并发编程

6.1 上下文 Context

作用:跨 Goroutine 之间同步请求数据、取消信号、处理截止时间

6.2 同步原语与锁

从 Mutex 开始,其结构为

type Mutex struct {
	state int32 // 判断锁的状态,具体看过了,但是不展开
	sema uint32 // 信号量, 锁的队列
}

在正常状态下,一个 goroutine 会先自旋尝试获取锁,如果若干次后不行,则通过信号量排队等待。队列是 FIFO 的,且每次队列会和自旋获取的一起竞争,则有大概率获取不到。在获取不到的时候,重新进入队列的第一个(而不是最后一个)。当等待时间大于 1ms 之后,锁开始变成饥饿模式

饥饿状态模式,优先给队列头部。当等待时间小于 1ms 或者 队列结束了,则切换回正常模式。

正常情况下有较高吞吐量,不需要频繁挂起 goroutine。

FastPath/SlowPath

6.5 调度器

迫不及待, 先看一下调度器相关, 经典老八股文。文章很经典, 可以根据自己需求去看, 我只记录笔记

首先是进程和线程,一个进程可以对应多个线程,这里说的是系统级别的。线程之间的通信是基于共享内存。但是线程的创建和销毁都需要消耗大约 1us 左右的时间,但是 Go 调度器对 Goroutine 的上下文切换为 0.2us 左右,减少了 80% 的开销

模型大度为

Goroutine

Thread

Process

由于提到了线程级别的切换的损耗相对于 Goroutine 来说更大,所以 Go 使用与 CPU 数量相等的 Thread,来减少切换带来的损耗。在每个 Thread 上面,通过 Golang 的调度器来做 Goroutine 的切换。

文中提到了 Golang 的调度器的演进机制,这里我们只看目前最新的,即抢占式调度器 - 基于信号的抢占式调度器(从 go 1.14 开始);再稍微看一下 非均匀存储访问调度器 · 提案

6.5.1 设计原理

相关文档

基于协作的抢占式调度
  1. 编译器会在调用函数前插入 runtime.morestack;
  2. Go 语言运行时会在垃圾回收暂停程序、系统监控发现 Goroutine 运行超过 10ms 时发出抢占请求 StackPreempt;
  3. 当发生函数调用时,可能会执行编译器插入的 runtime.morestack,它调用的 runtime.newstack 会检查 Goroutine 的 stackguard0 字段是否为 StackPreempt;
  4. 如果 stackguard0 是 StackPreempt,就会触发抢占让出当前线程;

原理即为在 compile 的时候插入,在 GC 等对运行超过 10ms 的情况发出抢占请求,当发生调用的时候,调用编译插入的 runtime.morestack 来判断是否可以抢占,如果可以就让出当前线程

这种的入口点只有在函数抢占的时候会触发抢占,所以还是需要协作的。看来问题也比较明显,就是当一个 Goroutine 不涉及到函数调度的时候,它不会主动让出当前线程。在简书上找到的一个案例如下:

package main

import (
    "runtime"
    "time"
)

func main() {
    runtime.GOMAXPROCS(1)
    go func() {
        for {
        }
    }()

    time.Sleep(time.Millisecond)
    println("OK")
}

由于匿名函数先占用了协程, 且不涉及到函数调度,导致永远不会跑到 OK

优势

直接摘抄了,插在函数调用前面的好处是不需要保存寄存器状态,对于 GC 来说根节点也能知道所有的安全点

Up to and including Go 1.10, Go has used cooperative preemption with safe-points only at function calls (and even then, not if the function is small or gets inlined). This means that Go can only switch between concurrently-executing goroutines at specific points. The main advantage of this is that the compiler can ensure useful invariants at these safe-points. In particular, the compiler ensures that all local garbage collection roots are known at all safe-points, which is critical to precise garbage collection. It can also ensure that no registers are live at safe-points, which means the Go runtime can switch goroutines without having to save and restore a large register set.

问题

  1. 推迟 STW 操作
  2. 推迟调度
  3. 推迟栈扫描
  4. 特殊情况下会造成程序暂停

这些问题在协作式抢占中后来也有不同程度的优化。在后续的 1.14 版本中,提交了非协作式的抢占调度

基于信号的抢占式调度
  1. 程序启动时,在 runtime.sighandler 中注册 SIGURG 信号的处理函数 runtime.doSigPreempt;
  2. 在触发垃圾回收的栈扫描时会调用 runtime.suspendG 挂起 Goroutine,该函数会执行下面的逻辑:
    • 将 _Grunning 状态的 Goroutine 标记成可以被抢占,即将 preemptStop 设置成 true;
    • 调用 runtime.preemptM 触发抢占;
  3. runtime.preemptM 会调用 runtime.signalM 向线程发送信号 SIGURG;
  4. 操作系统会中断正在运行的线程并执行预先注册的信号处理函数 runtime.doSigPreempt;
  5. runtime.doSigPreempt 函数会处理抢占信号,获取当前的 SP 和 PC 寄存器并调用 runtime.sigctxt.pushCall;
  6. runtime.sigctxt.pushCall 会修改寄存器并在程序回到用户态时执行 runtime.asyncPreempt;
  7. 汇编指令 runtime.asyncPreempt 会调用运行时函数 runtime.asyncPreempt2;
  8. runtime.asyncPreempt2 会调用 runtime.preemptPark;
  9. runtime.preemptPark 会修改当前 Goroutine 的状态到 _Gpreempted 并调用 runtime.schedule 让当前函数陷入休眠并让出线程,调度器会选择其它的 Goroutine 继续执行;

简单来说在程序启动的时候,通过 runtime.sighandler 注册了 SIGURG 信号,在 GC 的栈扫描的时候,挂起 goroutine,向 M 发送信号(M 在下面会说),然后然当前 goroutine 休眠执行其他的 G

6.5.2 数据结构

首先 GMP 模型。 G 代表 Goroutine M 代表操作系统的线程 P 为处理器,运行在线程上的本地调度器

G

在 runtime2.go 中我们能看到 type g struct 这一块比较复杂,感觉暂时不需要特地展开学习。有些地方我看了文章觉得比较有意思

  1. Goroutine 的状态,包括 _Grunnable, 没有执行代码,没有栈的所有权,存储在运行队列中。这个之前在 pprof 代码的时候看到 findrunnable 的占比很高,有印象
  2. Goroutine 状态在运行期间在 _Grunning_Grunnable等待中(系统调用结束等,包括 _Gwaiting、_Gsyscall 和 _Gpreempted 几个状态) 来回切换
M

M 操作系统线程,最大的时候是 10000。最大只会有 GOMAXPROCS 个线程,默认和 CPU 数量相同。对这里有一个问题,在 docker 下也能获取到正确值吗?

由此找到另外一个博客 作为参考。在 线程数量大于 CPU 数量的时候,会造成线程的切换造成不必要的损失

对应的结构体是 type m struct

P

P 当中比较重要的是: 反向存储的线程维护着线程与处理器之间的关系,而 runqhead、runqtail 和 runq 三个字段表示处理器持有的运行队列,其中存储着待执行的 Goroutine 列表,runnext 中是线程下一个需要执行的 Goroutine。

6.5.3 调度器启动
6.5.4 创建 Goroutine
6.5.5 调度循环
  1. 为了保证公平,有一定记录从全局队列中查找 goroutine
  2. 从本地队列中查找待执行的 goroutine
  3. 从 findrunnable 中进行查找

循环为

schedule->execute->gogo->goexit0->schedule

execute 做好准备工作

func execute(gp *g, inheritTime bool) {
	_g_ := getg()

	// Assign gp.m before entering _Grunning so running Gs have an
	// M.
	_g_.m.curg = gp
	gp.m = _g_.m
	casgstatus(gp, _Grunnable, _Grunning)
	gp.waitsince = 0
	gp.preempt = false
	gp.stackguard0 = gp.stack.lo + _StackGuard
	if !inheritTime {
		_g_.m.p.ptr().schedtick++
	}

	// Check whether the profiler needs to be turned on or off.
	hz := sched.profilehz
	if _g_.m.profilehz != hz {
		setThreadCPUProfiler(hz)
	}

	if trace.enabled {
		// GoSysExit has to happen when we have a P, but before GoStart.
		// So we emit it here.
		if gp.syscallsp != 0 && gp.sysblocktraced {
			traceGoSysExit(gp.sysexitticks)
		}
		traceGoStart()
	}

	gogo(&gp.sched)
}
6.5.6 触发调度
  • 主动挂起
  • 系统调用
  • 协作式调度
  • 系统监控
6.5.7 线程管理

生命周期:

运行时通过 runtime.startm 来执行处理器 P,如果没能从闲置列表中获取到 M,就会创建新的线程

通过调用 clone 来创建新的系统线程。

使用系统调用 clone 创建的线程会在线程主动调用 exit、或者传入的函数 runtime.mstart 返回会主动退出,runtime.mstart 会执行调用 runtime.newm 时传入的匿名函数 fn,到这里也就完成了从线程创建到销毁的整个闭环。

线程的创建到销毁

第七章 内存管

7.1 内存分配器
7.2 垃圾收集器

可达性分析

GC, 三色标记。默认开始全为白色。能追踪到的 root 节点全部标记为灰色,如果检测完毕并且存活,标记为黑色,基于黑色的节点全部标记为灰色。重复直到没有灰色的,再将白色内存回收。 强三色不变式:禁止黑 -> 白 弱三色不变式:允许黑->白,但需要有灰色->白色

建立上述不等式,通常需要建立读写屏障: 强三色不变式:插入写屏障(在关联黑白的时候,将其中一方标记为灰色) 弱三色不变式:删除写屏障(关注灰白,将白色标记为灰色)

读屏障,确保用户程序不会访问到已经存在副本的陈旧对象。(在复制式中)

回收: 并行回收:同步问题 主体并发回收:用户程序和 GC 的竞争问题 主体并发增量回收:还是有 STW,通知到所有线程

有几个 GC 的阶段,开始的时候给所有 p 一个 gcBgMarkWorker 协程,先 STW 通知开始标记(开启写屏障,允许 GC 标志工作),然后再 STW 终止 Mark 阶段(关闭写屏障,关闭 GC 标志工作)进入清扫阶段,进入 GCOFF 阶段,之前的标记为黑色,之后的标记为白色

分代回收, 引用计数

7.3 栈内存管理

OTHERS

unsafe/uintptr

https://www.youtube.com/watch?v=a_9oLmeFvwk

unsafe.Pointer

Like void *, to help out the performance.

PROJECTS

ETCD(RAFT)

video

Golang-Upgrade

release of go 1.18 is coming with generic & very useful functions. Some of the source code we learned from 1.18 beta is generic considered.

其他

  1. 在看 iLogtail 的时候发现了 ZeroCopy 这个写法很有意思, 先 mark 一下。拿 bytes to string 这个举例子, 直接修改了其 Header...(time update)

  2. Be careful with interface{}. 在 golang 中入参为 interface 的大部分都包含了 reflect 等操作, 比如我们常见的 Binary.Read, json.Marshal 等, 需要十分小心, 性能可能会在不经意间 10X 的减少

About

This repository is for recording my golang learning. It's very important !!!


Languages

Language:Go 100.0%