3.2 sync.Once

1. sync.Once 的使用场景

sync.Once 是 Go 标准库提供的使函数只执行一次的实现，常应用于单例模式，例如初始化配置、保持数据库连接等。作用与 init 函数类似，但有区别。

• init 函数是当所在的 package 首次被加载时执行，若迟迟未被使用，则既浪费了内存，又延长了程序加载时间。
• sync.Once 可以在代码的任意位置初始化和调用，因此可以延迟到使用时再执行，并发场景下是线程安全的。

在多数情况下，sync.Once 被用于控制变量的初始化，这个变量的读写满足如下三个条件：

1. 当且仅当第一次访问某个变量时，进行初始化（写）
2. 变量初始化过程中，所有读都被阻塞，直到初始化完成
3. 变量仅初始化一次，初始化完成后驻留在内存里

sync.Once 仅提供了一个方法 Do，参数 f 是对象初始化函数。

func (o *Once) Do(f func())

2. 使用

下例中，使用函数ReadConfig读取配置，配置只需要被读取一次。

若函数被多个协程并发调用，此时使用sync.once可以保证函数只会被执行一次。

var readCfgOnce sync.Once

func ReadConfig() {
	readCfgOnce.Do(func() {
		log.Println("Reading Config...")
	})
}

func mainFunc() {
	var wg sync.WaitGroup
	n := 10

	wg.Add(n)
	for i := 0; i < n; i++ {
		go func() {
			defer wg.Done()
			ReadConfig()
		}()
	}

	wg.Wait()
}
// output
00:39:21 Reading Config...

2.1 标准库中的使用

sync.Once在标准库中被广泛使用，例如在html中：

// html/entity.go
...
var entity map[string]rune
...
var populateMapsOnce sync.Once

func populateMaps() {
	entity = map[string]rune{
		"AElig;":                           '\U000000C6',
		"AMP;":                             '\U00000026',
		"Aacute;":                          '\U000000C1',
        ... 
        // 约2000个字段
    }
}
// html/escape.go
func UnescapeString(s string) string {
	populateMapsOnce.Do(populateMaps)
	i := strings.IndexByte(s, '&')
	...
}

• entity中包含两千多个字段，若在init函数中加载，没有使用时则将浪费内存
• UnescapeString函数是线程安全的，在并发调用时，populateMapsOnce可以保证entity只会被初始化一次

3. 原理

type Once struct {
    done uint32
    m    Mutex
}

func (o *Once) Do(f func()) {
    if atomic.LoadUint32(&o.done) == 0 {
        o.doSlow(f)
    }
}

func (o *Once) doSlow(f func()) {
    o.m.Lock()
    defer o.m.Unlock()
    if o.done == 0 {
        defer atomic.StoreUint32(&o.done, 1)
        f()
    }
}

• done：表示是否已执行，0表示未执行
• m：互斥锁

3.1 done在结构体中的位置

type Once struct {
    // done indicates whether the action has been performed.
    // It is first in the struct because it is used in the hot path.
    // The hot path is inlined at every call site.
    // Placing done first allows more compact instructions on some architectures (amd64/x86),
    // and fewer instructions (to calculate offset) on other architectures.
    done uint32
    m    Mutex
}

done 在热路径中，done 放在第一个字段，能够减少 CPU 指令，也就是说，这样做能够提升性能。

热路径

热路径(hot path)是程序非常频繁执行的一系列指令，sync.Once 绝大部分场景都会访问 done，如果 hot path 编译后的机器码指令更少，更直接，必然是能够提升性能的。

放在第一个字段就能够减少指令？

结构体第一个字段的地址和结构体的指针是相同的

• 如果是第一个字段，直接对结构体的指针解引用即可
• 如果是其他的字段，除了结构体指针外，还需要计算与第一个值的偏移(calculate offset)。在机器码中，偏移量是随指令传递的附加值，CPU 需要做一次偏移值与指针的加法运算，才能获取要访问的值的地址。因为，访问第一个字段的机器代码更紧凑，速度更快。

Reference

1. https://geektutu.com/post/hpg-sync-once.html
2. What does “hot path” mean in the context of sync.Once? - StackOverflow