go sync.Cond 源码解析

一、什么是Cond?

Cond实现了一个条件变量，它是一个/多个goroutine等待或宣布事件发生的集合点。
每个Cond都有一个相关联的锁定器L(通常是*Mutex或*RWMutex)，当改变条件和调用Wait方法时必须持有该锁。
Cond在第一次使用后不得复制。

二、Cond 结构体

type Cond struct {
	noCopy noCopy

	// L is held while observing or changing the condition
	L Locker

	notify  notifyList
	checker copyChecker
}

noCopy：防止Cond复制

L Locker:锁接口，必须实现Lock、Unlock方法

notify：通告链表

checker：copyChecker保留指向自身的指针来检测对象复制。

三、方法

1. NewCond - 实例化Cond

func NewCond(l Locker) *Cond {
	return &Cond{L: l}
}

2. Wait - 阻塞当前gorotine,并等待Signal/Broadcast方法唤醒，前提是先获得锁(Lock())，然后执行Wait,再释放锁(Unlock)

func (c *Cond) Wait() {
	c.checker.check() //检测Cond是否被复制，如果被复制，则panic
    //将当前goroutine添加到等待队列(Cond.notify)
	t := runtime_notifyListAdd(&c.notify)
	c.L.Unlock()// 解锁；调用Wait前，需要加锁
    
    //进入睡眠，等待被唤醒
	runtime_notifyListWait(&c.notify, t)
	c.L.Lock() // 加锁，调用Wait之后，需要解锁
}

3. Signal - 唤醒一个goroutine(Cond.notify)

func (c *Cond) Signal() {
	c.checker.check() // 检测Cond是否被复制，如果被复制，则panic
    //唤醒一个notify链表里的goroutine
	runtime_notifyListNotifyOne(&c.notify)
}

4.Broadcast - 唤醒所有睡眠中的goroutine(Cond.notify)

func (c *Cond) Broadcast() {
	c.checker.check() //检测Cond是否被复制，如果被复制，则panic
    //唤醒所有goroutine
	runtime_notifyListNotifyAll(&c.notify) 
}

四、noCopy

noCopy可以嵌入到第一次使用后不能复制的结构体中。

type noCopy struct{}

// Lock is a no-op used by -copylocks checker from `go vet`.
func (*noCopy) Lock()   {}
func (*noCopy) Unlock() {}

五、copyChecker

copyChecker保留指向自身的指针来检测对象复制。

type copyChecker uintptr

func (c *copyChecker) check() {
	if uintptr(*c) != uintptr(unsafe.Pointer(c)) &&
		!atomic.CompareAndSwapUintptr((*uintptr)(c), 0, uintptr(unsafe.Pointer(c))) &&
		uintptr(*c) != uintptr(unsafe.Pointer(c)) {
		panic("sync.Cond is copied")
	}
}

六、小结

Cond使用NewCond注入锁，获取Cond指针；

调用Lock加锁，调用Wait使当前goroutine进入睡眠，唤醒后，使用Unlock解锁。

唤醒方式：Signal，Broadcast

进一步阅读:

Cond中的notify,在runtime/sema.go，notifyList对应的方法也在其中，runtime_notifyListAdd、runtime_notifyListWait、runtime_notifyListNotifyOne、runtime_notifyListNotifyAll

sema.go中的代码都有相关注释，稍加思索，便可以明白其中的原理。