一文读懂go中semaphore(信号量)源码

运行时信号量机制 semaphore

前言

最近在看源码，发现好多地方用到了这个semaphore。

本文是在go version go1.13.15 darwin/amd64上进行的

作用是什么

下面是官方的描述

// semaphore implementation exposed to go.
// intended use is provide a sleep and wakeup
// primitive that can be used in the contended case
// of other synchronization primitives.
// thus it targets the same goal as linux's futex,
// but it has much simpler semantics.
//
// that is, don't think of these as semaphores.
// think of them as a way to implement sleep and wakeup
// such that every sleep is paired with a single wakeup,
// even if, due to races, the wakeup happens before the sleep.

// 具体的用法是提供 sleep 和 wakeup 原语
// 以使其能够在其它同步原语中的竞争情况下使用
// 因此这里的 semaphore 和 linux 中的 futex 目标是一致的
// 只不过语义上更简单一些
//
// 也就是说，不要认为这些是信号量
// 把这里的东西看作 sleep 和 wakeup 实现的一种方式
// 每一个 sleep 都会和一个 wakeup 配对
// 即使在发生 race 时，wakeup 在 sleep 之前时也是如此 

上面提到了和futex作用一样，关于futex

futex（快速用户区互斥的简称）是一个在linux上实现锁定和构建高级抽象锁如信号量和posix互斥的基本工具

futex 由一块能够被多个进程共享的内存空间（一个对齐后的整型变量）组成；这个整型变量的值能够通过汇编语言调用cpu提供的原子操作指令来增加或减少，并且一个进程可以等待直到那个值变成正数。futex 的操作几乎全部在用户空间完成；只有当操作结果不一致从而需要仲裁时，才需要进入操作系统内核空间执行。这种机制允许使用 futex 的锁定原语有非常高的执行效率：由于绝大多数的操作并不需要在多个进程之间进行仲裁，所以绝大多数操作都可以在应用程序空间执行，而不需要使用（相对高代价的）内核系统调用。

go中的semaphore作用和futex目标一样，提供sleep和wakeup原语，使其能够在其它同步原语中的竞争情况下使用。当一个goroutine需要休眠时，将其进行集中存放，当需要wakeup时，再将其取出，重新放入调度器中。

例如在读写锁的实现中，读锁和写锁之前的相互阻塞唤醒，就是通过sleep和wakeup实现，当有读锁存在的时候，新加入的写锁通过semaphore阻塞自己，当前面的读锁完成，在通过semaphore唤醒被阻塞的写锁。

写锁

// 获取互斥锁
// 阻塞等待所有读操作结束（如果有的话）
func (rw *rwmutex) lock() {
	...
	// 原子的修改readercount的值，直接将readercount减去rwmutexmaxreaders
	// 说明，有写锁进来了，这在上面的读锁中也有体现
	r := atomic.addint32(&rw.readercount, -rwmutexmaxreaders) + rwmutexmaxreaders
	// 当r不为0说明，当前写锁之前有读锁的存在
	// 修改下readerwait，也就是当前写锁需要等待的读锁的个数 
	if r != 0 && atomic.addint32(&rw.readerwait, r) != 0 {
		// 阻塞当前写锁
		runtime_semacquiremutex(&rw.writersem, false, 0)
	}
	...
}

通过runtime_semacquiremutex对当前写锁进行sleep

读锁释放

// 减少读操作计数，即readercount--
// 唤醒等待写操作的协程（如果有的话）
func (rw *rwmutex) runlock() {
	...
	// 首先通过atomic的原子性使readercount-1
	// 1.若readercount大于0, 证明当前还有读锁, 直接结束本次操作
	// 2.若readercount小于0, 证明已经没有读锁, 但是还有因为读锁被阻塞的写锁存在
	if r := atomic.addint32(&rw.readercount, -1); r < 0 {
		// 尝试唤醒被阻塞的写锁
		rw.runlockslow(r)
	}
	...
}

func (rw *rwmutex) runlockslow(r int32) {
	...
	// readerwait--操作，如果readerwait--操作之后的值为0，说明，写锁之前，已经没有读锁了
	// 通过writersem信号量，唤醒队列中第一个阻塞的写锁
	if atomic.addint32(&rw.readerwait, -1) == 0 {
		// 唤醒一个写锁
		runtime_semrelease(&rw.writersem, false, 1)
	}
}

写锁处理完之后，调用runtime_semrelease来唤醒sleep的写锁

几个主要的方法

在go/src/sync/runtime.go中，定义了这几个方法

// semacquire等待*s > 0，然后原子递减它。
// 它是一个简单的睡眠原语，用于同步
// library and不应该直接使用。
func runtime_semacquire(s *uint32)

// semacquiremutex类似于semacquire,用来阻塞互斥的对象
// 如果lifo为true，waiter将会被插入到队列的头部
// skipframes是跟踪过程中要省略的帧数，从这里开始计算
// runtime_semacquiremutex's caller.
func runtime_semacquiremutex(s *uint32, lifo bool, skipframes int)

// semrelease会自动增加*s并通知一个被semacquire阻塞的等待的goroutine
// 它是一个简单的唤醒原语，用于同步
// library and不应该直接使用。
// 如果handoff为true, 传递信号到队列头部的waiter
// skipframes是跟踪过程中要省略的帧数，从这里开始计算
// runtime_semrelease's caller.
func runtime_semrelease(s *uint32, handoff bool, skipframes int)

具体的实现是在go/src/runtime/sema.go中

//go:linkname sync_runtime_semacquire sync.runtime_semacquire
func sync_runtime_semacquire(addr *uint32) {
	semacquire1(addr, false, semablockprofile, 0)
}

//go:linkname sync_runtime_semrelease sync.runtime_semrelease
func sync_runtime_semrelease(addr *uint32, handoff bool, skipframes int) {
	semrelease1(addr, handoff, skipframes)
}

//go:linkname sync_runtime_semacquiremutex sync.runtime_semacquiremutex
func sync_runtime_semacquiremutex(addr *uint32, lifo bool, skipframes int) {
	semacquire1(addr, lifo, semablockprofile|semamutexprofile, skipframes)
}

如何实现

sudog 缓存

semaphore的实现使用到了sudog，我们先来看下

sudog 是运行时用来存放处于阻塞状态的goroutine的一个上层抽象，是用来实现用户态信号量的主要机制之一。 例如当一个goroutine因为等待channel的数据需要进行阻塞时，sudog会将goroutine及其用于等待数据的位置进行记录， 并进而串联成一个等待队列，或二叉平衡树。

// sudogs are allocated from a special pool. use acquiresudog and
// releasesudog to allocate and free them.
type sudog struct {
	// 以下字段受hchan保护
	g *g

	// isselect 表示 g 正在参与一个 select, so
	// 因此 g.selectdone 必须以 cas 的方式来获取wake-up race.
	isselect bool
	next  *sudog
	prev  *sudog
	elem  unsafe.pointer // 数据元素（可能指向栈）

	// 以下字段不会并发访问。
	// 对于通道，waitlink只被g访问。
	// 对于信号量，所有字段(包括上面的字段)
	// 只有当持有一个semroot锁时才被访问。
	acquiretime int64
	releasetime int64
	ticket  uint32
	parent  *sudog //semaroot 二叉树
	waitlink *sudog // g.waiting 列表或 semaroot
	waittail *sudog // semaroot
	c   *hchan // channel
}

sudog的获取和归还，遵循以下策略：

1、获取，首先从per-p缓存获取，对于per-p缓存，如果per-p缓存为空，则从全局池抓取一半，然后取出per-p缓存中的最后一个；

2、归还，归还到per-p缓存，如果per-p缓存满了，就把per-p缓存的一半归还到全局缓存中，然后归还sudog到per-p缓存中。

acquiresudog

1、如果per-p缓存的内容没达到长度的一般，则会从全局额缓存中抓取一半；

2、然后返回把per-p缓存中最后一个sudog返回，并且置空；

// go/src/runtime/proc.go
//go:nosplit
func acquiresudog() *sudog {
	// delicate dance: 信号量的实现调用acquiresudog，然后acquiresudog调用new(sudog)
	// new调用malloc, malloc调用垃圾收集器，垃圾收集器在stoptheworld调用信号量
	// 通过在new(sudog)周围执行acquirem/releasem来打破循环
	// acquirem/releasem在new(sudog)期间增加m.locks，防止垃圾收集器被调用。

	// 获取当前 g 所在的 m
	mp := acquirem()
	// 获取p的指针
	pp := mp.p.ptr()
	if len(pp.sudogcache) == 0 {
		lock(&sched.sudoglock)
		// 首先，尝试从*缓存获取一批数据。
		for len(pp.sudogcache) < cap(pp.sudogcache)/2 && sched.sudogcache != nil {
			s := sched.sudogcache
			sched.sudogcache = s.next
			s.next = nil
			pp.sudogcache = append(pp.sudogcache, s)
		}
		unlock(&sched.sudoglock)
		// 如果*缓存中没有，新分配
		if len(pp.sudogcache) == 0 {
			pp.sudogcache = append(pp.sudogcache, new(sudog))
		}
	}
	// 取缓存中最后一个
	n := len(pp.sudogcache)
	s := pp.sudogcache[n-1]
	pp.sudogcache[n-1] = nil
	// 将刚取出的在缓存中移除
	pp.sudogcache = pp.sudogcache[:n-1]
	if s.elem != nil {
		throw("acquiresudog: found s.elem != nil in cache")
	}
	releasem(mp)
	return s
}

releasesudog

1、如果per-p缓存满了，就归还per-p缓存一般的内容到全局缓存；

2、然后将回收的sudog放到per-p缓存中。

// go/src/runtime/proc.go
//go:nosplit
func releasesudog(s *sudog) {
	if s.elem != nil {
		throw("runtime: sudog with non-nil elem")
	}
	if s.isselect {
		throw("runtime: sudog with non-false isselect")
	}
	if s.next != nil {
		throw("runtime: sudog with non-nil next")
	}
	if s.prev != nil {
		throw("runtime: sudog with non-nil prev")
	}
	if s.waitlink != nil {
		throw("runtime: sudog with non-nil waitlink")
	}
	if s.c != nil {
		throw("runtime: sudog with non-nil c")
	}
	gp := getg()
	if gp.param != nil {
		throw("runtime: releasesudog with non-nil gp.param")
	}
	// 避免重新安排到另一个p
	mp := acquirem() // avoid rescheduling to another p
	pp := mp.p.ptr()
	// 如果缓存满了
	if len(pp.sudogcache) == cap(pp.sudogcache) {
		// 将本地高速缓存的一半传输到*高速缓存
		var first, last *sudog
		for len(pp.sudogcache) > cap(pp.sudogcache)/2 {
			n := len(pp.sudogcache)
			p := pp.sudogcache[n-1]
			pp.sudogcache[n-1] = nil
			pp.sudogcache = pp.sudogcache[:n-1]
			if first == nil {
				first = p
			} else {
				last.next = p
			}
			last = p
		}
		lock(&sched.sudoglock)
		last.next = sched.sudogcache
		sched.sudogcache = first
		unlock(&sched.sudoglock)
	}
	// 归还sudog到`per-p`缓存中
	pp.sudogcache = append(pp.sudogcache, s)
	releasem(mp)
}

semaphore

// go/src/runtime/sema.go
// 用于sync.mutex的异步信号量。

// semaroot拥有一个具有不同地址（s.elem）的sudog平衡树。
// 每个sudog都可以依次（通过s.waitlink）指向一个列表，在相同地址上等待的其他sudog。
// 对具有相同地址的sudog内部列表进行的操作全部为o（1）。顶层semaroot列表的扫描为o（log n），
// 其中，n是阻止goroutines的不同地址的数量，通过他们散列到给定的semaroot。
type semaroot struct {
	lock mutex
	// waiters的平衡树的根节点
	treap *sudog
	// waiters的数量，读取的时候无所
	nwait uint32
}

// prime to not correlate with any user patterns.
const semtabsize = 251

var semtable [semtabsize]struct {
	root semaroot
	pad [cpu.cachelinepadsize - unsafe.sizeof(semaroot{})]byte
}

poll_runtime_semacquire/sync_runtime_semacquiremutex

// go/src/runtime/sema.go
//go:linkname poll_runtime_semacquire internal/poll.runtime_semacquire
func poll_runtime_semacquire(addr *uint32) {
	semacquire1(addr, false, semablockprofile, 0)
}
//go:linkname sync_runtime_semacquiremutex sync.runtime_semacquiremutex
func sync_runtime_semacquiremutex(addr *uint32, lifo bool, skipframes int) {
	semacquire1(addr, lifo, semablockprofile|semamutexprofile, skipframes)
}


func semacquire1(addr *uint32, lifo bool, profile semaprofileflags, skipframes int) {
	// 判断这个goroutine，是否是m上正在运行的那个
	gp := getg()
	if gp != gp.m.curg {
		throw("semacquire not on the g stack")
	}

	// *addr -= 1
	if cansemacquire(addr) {
		return
	}

	// 增加等待计数
	// 再试一次 cansemacquire 如果成功则直接返回
	// 将自己作为等待者入队
	// 休眠
	// (等待器描述符由出队信号产生出队行为)

	// 获取一个sudog
	s := acquiresudog()
	root := semroot(addr)
	t0 := int64(0)
	s.releasetime = 0
	s.acquiretime = 0
	s.ticket = 0
	if profile&semablockprofile != 0 && blockprofilerate > 0 {
		t0 = cputicks()
		s.releasetime = -1
	}
	if profile&semamutexprofile != 0 && mutexprofilerate > 0 {
		if t0 == 0 {
			t0 = cputicks()
		}
		s.acquiretime = t0
	}
	for {
		lock(&root.lock)
		// 添加我们自己到nwait来禁用semrelease中的"easy case"
		atomic.xadd(&root.nwait, 1)
		// 检查cansemacquire避免错过唤醒
		if cansemacquire(addr) {
			atomic.xadd(&root.nwait, -1)
			unlock(&root.lock)
			break
		}
		// 任何在 cansemacquire 之后的 semrelease 都知道我们在等待（因为设置了 nwait），因此休眠

		// 队列将s添加到semaroot中被阻止的goroutine中
		root.queue(addr, s, lifo)
		// 将当前goroutine置于等待状态并解锁锁。
		// 通过调用goready（gp），可以使goroutine再次可运行。
		goparkunlock(&root.lock, waitreasonsemacquire, traceevgoblocksync, 4+skipframes)
		if s.ticket != 0 || cansemacquire(addr) {
			break
		}
	}
	if s.releasetime > 0 {
		blockevent(s.releasetime-t0, 3+skipframes)
	}

	// 归还sudog
	releasesudog(s)
}

func cansemacquire(addr *uint32) bool {
	for {
		v := atomic.load(addr)
		if v == 0 {
			return false
		}
		if atomic.cas(addr, v, v-1) {
			return true
		}
	}
}

sync_runtime_semrelease

// go/src/runtime/sema.go
//go:linkname sync_runtime_semrelease sync.runtime_semrelease
func sync_runtime_semrelease(addr *uint32, handoff bool, skipframes int) {
	semrelease1(addr, handoff, skipframes)
}

func semrelease1(addr *uint32, handoff bool, skipframes int) {
	root := semroot(addr)
	atomic.xadd(addr, 1)

	// easy case:没有等待者
	// 这个检查必须发生在xadd之后，以避免错过唤醒
	if atomic.load(&root.nwait) == 0 {
		return
	}

	// harder case: 找到等待者，并且唤醒
	lock(&root.lock)
	if atomic.load(&root.nwait) == 0 {
		// 该计数已被另一个goroutine占用，
		// 因此无需唤醒其他goroutine。
		unlock(&root.lock)
		return
	}

	// 搜索一个等待着然后将其唤醒
	s, t0 := root.dequeue(addr)
	if s != nil {
		atomic.xadd(&root.nwait, -1)
	}
	unlock(&root.lock)
	if s != nil { // 可能会很慢，因此先解锁
		acquiretime := s.acquiretime
		if acquiretime != 0 {
			mutexevent(t0-acquiretime, 3+skipframes)
		}
		if s.ticket != 0 {
			throw("corrupted semaphore ticket")
		}
		if handoff && cansemacquire(addr) {
			s.ticket = 1
		}
		// goready(s.g, 5) 
		// 标记 runnable，等待被重新调度
		readywithtime(s, 5+skipframes)
	}
}

摘自"同步原语"的一段总结

这一对 semacquire 和 semrelease 理解上可能不太直观。 首先，我们必须意识到这两个函数一定是在两个不同的 m（线程）上得到执行，否则不会出现并发，我们不妨设为 m1 和 m2。 当 m1 上的 g1 执行到 semacquire1 时，如果快速路径成功，则说明 g1 抢到锁，能够继续执行。但一旦失败且在慢速路径下 依然抢不到锁，则会进入 goparkunlock，将当前的 g1 放到等待队列中，进而让 m1 切换并执行其他 g。 当 m2 上的 g2 开始调用 semrelease1 时，只是单纯的将等待队列的 g1 重新放到调度队列中，而当 g1 重新被调度时（假设运气好又在 m1 上被调度），代码仍然会从 goparkunlock 之后开始执行，并再次尝试竞争信号量，如果成功，则会归还 sudog。

参考

【同步原语】
【go并发编程实战--信号量的使用方法和其实现原理】
【semaphore】
【进程同步之信号量机制（pv操作）及三个经典同步问题】https://blog.csdn.net/speedme/article/details/17597373

到此这篇关于go中semaphore(信号量)源码解读的文章就介绍到这了,更多相关go中semaphore源码内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！