社区首页 >专栏 >源码解读 sync.Map 实现原理

源码解读 sync.Map 实现原理

张凯强

发布于 2020-03-25 13:34:06

98400

代码可运行

文章被收录于专栏：面向人生编程面向人生编程

运行总次数：0

代码可运行

简介

Go 的内建 map 是不支持并发写操作的，原因是 map 写操作不是并发安全的，当你尝试多个 Goroutine 操作同一个 map，会产生报错：fatal error: concurrent map writes。

因此官方另外引入了 sync.Map 来满足并发编程中的应用。

sync.Map 的实现原理可概括为：

•通过 read 和 dirty 两个字段将读写分离，读的数据存在只读字段 read 上，将最新写入的数据则存在 dirty 字段上•读取时会先查询 read，不存在再查询 dirty，写入时则只写入 dirty•读取 read 并不需要加锁，而读或写 dirty 都需要加锁•另外有 misses 字段来统计 read 被穿透的次数（被穿透指需要读 dirty 的情况），超过一定次数则将 dirty 数据同步到 read 上•对于删除数据则直接通过标记来延迟删除

数据结构

sync.Map 的数据结构如下：

type Map struct {    // 加锁作用，保护 dirty 字段    mu Mutex    // 只读的数据，实际数据类型为 readOnly    read atomic.Value    // 最新写入的数据    dirty map[interface{}]*entry    // 计数器，每次需要读 dirty 则 +1    misses int}

其中 readOnly 的数据结构为：

type readOnly struct {    // 内建 map    m  map[interface{}]*entry    amended bool  // 表示 dirty 里存在 read 里没有的 key，通过该字段决定是否加锁读 dirty}

entry 数据结构则用于存储值的指针：

type entry struct {    p unsafe.Pointer  // 等同于 *interface{}}

属性 p 有三种状态：

•p == nil: 键值已经被删除，且 m.dirty == nil•p == expunged: 键值已经被删除，但 m.dirty!=nil 且 m.dirty 不存在该键值（expunged 实际是空接口指针）•除以上情况，则键值对存在，存在于 m.read.m 中，如果 m.dirty!=nil 则也存在于 m.dirty

Map 常用的有以下方法：

•Load：读取指定 key 返回 value•Store：存储（增或改）key-value•Delete：删除指定 key

源码解析

Load

func (m *Map) Load(key interface{}) (value interface{}, ok bool) {    // 首先尝试从 read 中读取 readOnly 对象    read, _ := m.read.Load().(readOnly)    e, ok := read.m[key]
    // 如果不存在则尝试从 dirty 中获取    if !ok && read.amended {        m.mu.Lock()        // 由于上面 read 获取没有加锁，为了安全再检查一次        read, _ = m.read.Load().(readOnly)        e, ok = read.m[key]
        // 确实不存在则从 dirty 获取        if !ok && read.amended {            e, ok = m.dirty[key]            // 调用 miss 的逻辑            m.missLocked()        }        m.mu.Unlock()    }
    if !ok {        return nil, false    }    // 从 entry.p 读取值    return e.load()}
func (m *Map) missLocked() {    m.misses++    if m.misses < len(m.dirty) {        return    }    // 当 miss 积累过多，会将 dirty 存入 read，然后 将 amended = false，且 m.dirty = nil    m.read.Store(readOnly{m: m.dirty})    m.dirty = nil    m.misses = 0}

Store

func (m *Map) Store(key, value interface{}) {    read, _ := m.read.Load().(readOnly)    // 如果 read 里存在，则尝试存到 entry 里    if e, ok := read.m[key]; ok && e.tryStore(&value) {        return    }
    // 如果上一步没执行成功，则要分情况处理    m.mu.Lock()    read, _ = m.read.Load().(readOnly)    // 和 Load 一样，重新从 read 获取一次    if e, ok := read.m[key]; ok {        // 情况 1：read 里存在        if e.unexpungeLocked() {            // 如果 p == expunged，则需要先将 entry 赋值给 dirty（因为 expunged 数据不会留在 dirty）            m.dirty[key] = e        }        // 用值更新 entry        e.storeLocked(&value)    } else if e, ok := m.dirty[key]; ok {        // 情况 2：read 里不存在，但 dirty 里存在，则用值更新 entry        e.storeLocked(&value)    } else {        // 情况 3：read 和 dirty 里都不存在        if !read.amended {            // 如果 amended == false，则调用 dirtyLocked 将 read 拷贝到 dirty（除了被标记删除的数据）            m.dirtyLocked()            // 然后将 amended 改为 true            m.read.Store(readOnly{m: read.m, amended: true})        }        // 将新的键值存入 dirty        m.dirty[key] = newEntry(value)    }    m.mu.Unlock()}
func (e *entry) tryStore(i *interface{}) bool {    for {        p := atomic.LoadPointer(&e.p)        if p == expunged {            return false        }        if atomic.CompareAndSwapPointer(&e.p, p, unsafe.Pointer(i)) {            return true        }    }}
func (e *entry) unexpungeLocked() (wasExpunged bool) {    return atomic.CompareAndSwapPointer(&e.p, expunged, nil)}
func (e *entry) storeLocked(i *interface{}) {    atomic.StorePointer(&e.p, unsafe.Pointer(i))}
func (m *Map) dirtyLocked() {    if m.dirty != nil {        return    }
    read, _ := m.read.Load().(readOnly)    m.dirty = make(map[interface{}]*entry, len(read.m))    for k, e := range read.m {        // 判断 entry 是否被删除，否则就存到 dirty 中        if !e.tryExpungeLocked() {            m.dirty[k] = e        }    }}
func (e *entry) tryExpungeLocked() (isExpunged bool) {    p := atomic.LoadPointer(&e.p)    for p == nil {        // 如果有 p == nil（即键值对被 delete），则会在这个时机被置为 expunged        if atomic.CompareAndSwapPointer(&e.p, nil, expunged) {            return true        }        p = atomic.LoadPointer(&e.p)    }    return p == expunged}

Delete

func (m *Map) Delete(key interface{}) {    m.LoadAndDelete(key)}
// LoadAndDelete 作用等同于 Delete，并且会返回值与是否存在func (m *Map) LoadAndDelete(key interface{}) (value interface{}, loaded bool) {    // 获取逻辑和 Load 类似，read 不存在则查询 dirty    read, _ := m.read.Load().(readOnly)    e, ok := read.m[key]    if !ok && read.amended {        m.mu.Lock()        read, _ = m.read.Load().(readOnly)        e, ok = read.m[key]        if !ok && read.amended {            e, ok = m.dirty[key]            m.missLocked()        }        m.mu.Unlock()    }    // 查询到 entry 后执行删除    if ok {        // 将 entry.p 标记为 nil，数据并没有实际删除        // 真正删除数据并被被置为 expunged，是在 Store 的 tryExpungeLocked 中        return e.delete()    }    return nil, false}