go中sync.RWMutex的源码解读

// RWMutex 结构体包含了用于读写互斥锁的各种状态和信号量。在 RWMutex 中，多个 goroutine 可以同时持有读锁，
// 但只有一个 goroutine 可以持有写锁。RWMutex 的实现确保了在写锁等待的情况下，新的读锁无法被获取，
// 从而防止了读锁长时间等待
type RWMutex struct {
    w           Mutex        // 用于写锁的互斥锁
    writerSem   uint32       // 写锁的信号量，用于等待读锁完成
    readerSem   uint32       // 读锁的信号量，用于等待写锁完成
    readerCount atomic.Int32 // 读者持有读者锁的数量
    readerWait  atomic.Int32 // 写者等待读锁的数量
}
// readerCount 
// 当读者加锁时， readerCount  +1 
// 当读者解锁时， readerCount  -1
// 当 readerCount 大于 0 时，表示有读者持有读锁。
// 如果 readerCount 等于 0，则表示当前没有读者持有读锁。
// 当 readerCount 等于 0 时，其他写者可以尝试获取写锁
// 当 readerCount < 0 , 说明有写者在等待， 读者需要等待写者释放写锁
// readerWait（写者等待读锁的数量）：
// 当写者尝试获取写锁，但当前有读者持有读锁时，写者会被阻塞，并且 readerWait 会增加。
// 当读者释放读锁时，如果有写者在等待读锁，readerWait 会减少，并且可能唤醒等待的写者
// readerCount > 0：表示有读者持有读锁。
// readerCount == 0 且 readerWait > 0：表示有写者在等待读锁，阻塞中。
// readerCount == 0 且 readerWait == 0：表示当前没有读者持有读锁，且没有写者在等待读锁。此时其他写者可以尝试获取写锁。
// 这样的设计是为了在写者等待读锁时，不允许新的读者加入，以确保写者获得更公平的机会。

// Happens-before relationships are indicated to the race detector via:
// - Unlock  -> Lock:  readerSem
// - Unlock  -> RLock: readerSem
// - RUnlock -> Lock:  writerSem
//
// happends-before 用于描述时间发生的顺序，在 这里 （代码中的注释）
// Unlock 事件发生之前（happens-before）的 Lock 事件。
// Unlock 事件发生之前（happens-before）的 RLock 事件。
// RUnlock 事件发生之前（happens-before）的 Lock 事件


func (rw *RWMutex) RLock() {
	if race.Enabled {
		_ = rw.w.state
		race.Disable()
	}
	// 它将 readerCount 增加 1。如果结果小于 0，说明有一个写者拿着锁了， 这边需要等着
	if rw.readerCount.Add(1) < 0 {
		// A writer is pending, wait for it.
		// 在读写锁的情况下 执行锁的信号量 
		// 实际得等待操作， 调用底层代码， 等写者释放锁
		runtime_SemacquireRWMutexR(&rw.readerSem, false, 0)
	}
	if race.Enabled {
		race.Enable()
		race.Acquire(unsafe.Pointer(&rw.readerSem))
	}
}

// RUnlock undoes a single RLock call;
// it does not affect other simultaneous readers.
// It is a run-time error if rw is not locked for reading
// on entry to RUnlock.
func (rw *RWMutex) RUnlock() {
	... // 竞态规则逻辑
	// readerCount 用于记录当前持有读锁的读者数量。如果读者计数减为负数，说明存在写者正在等待读锁释放
	if r := rw.readerCount.Add(-1); r < 0 {
		// Outlined slow-path to allow the fast-path to be inlined
		rw.rUnlockSlow(r)
	}
	... // 竞态规则逻辑
}
func (rw *RWMutex) rUnlockSlow(r int32) {
	... // 竞态规则逻辑
	// A writer is pending.
	// 减少读者等待计数。readerWait 记录正在等待读锁释放的读者数量。如果读者等待计数减为零，
	// 说明最后一个读者已经释放了读锁，可以唤醒等待的写者
	if rw.readerWait.Add(-1) == 0 {
		// The last reader unblocks the writer.
		// 释放写者的信号量
		runtime_Semrelease(&rw.writerSem, false, 1)
	}
}

func (rw *RWMutex) Lock() {
	... // 竞态规则逻辑
	// First, resolve competition with other writers.
	// 获取写锁，解决与其他写者的竞争
	rw.w.Lock()
	// Announce to readers there is a pending writer.
	// 将 readerCount 减去 rwmutexMaxReaders，然后再加上 rwmutexMaxReaders，目的是将 readerCount 设置为负数，
	// 表示有一个写者正在等待写锁。这会通过 readerWait 记录下来，并用于通知读者和写者。
	// 这边得  rw.readerCount 是一个负数， 在RLock 中有个判断 rw.readerCount <0 , 
	// 这一段就是实现了写者优先， 不管当前有没有读者拿着读锁， 接下来拿锁的读锁， 统统排我后面，不能影响我（写者）， 等我（写者）处理完了再说
	r := rw.readerCount.Add(-rwmutexMaxReaders) + rwmutexMaxReaders
	// Wait for active readers.
	// 如果有活跃的读者，且将 readerWait 增加 r 后不为零，说明有读者正在等待读锁释放
	if r != 0 && rw.readerWait.Add(r) != 0 {
	// 获取写锁。
	// 它不是马上就能获取写锁，而是可能会被阻塞，需要等待写锁的释放
	// 当写者执行这个操作时，如果当前没有其他写者或读者持有锁，那么它会成功获取写锁，否则它会被阻塞，直到没有其他写者或读者持有锁
		runtime_SemacquireRWMutex(&rw.writerSem, false, 0)
	}
	... // 竞态规则逻辑
}

// arrange for another goroutine to RUnlock (Unlock) it.
func (rw *RWMutex) Unlock() {
	... // 竞态规则逻辑

	// Announce to readers there is no active writer.
	// 将 readerCount 增加 rwmutexMaxReaders，用于通知活跃的读者，写者已经释放了写锁
	// 我（ 写者）处理完了， 把 rw.readerCount 加回来了， 当前写锁写完了， 刚刚我（写者）拿锁以后 申请的读锁们， 可以唤醒了
	r := rw.readerCount.Add(rwmutexMaxReaders)
	... // 竞态规则逻辑
	// Unblock blocked readers, if any.
	// 遍历并逐个释放等待的读者，通过 runtime_Semrelease 信号量操作通知它们。
	for i := 0; i < int(r); i++ {
		runtime_Semrelease(&rw.readerSem, false, 0)
	}
	// Allow other writers to proceed.
	rw.w.Unlock()
	... // 竞态规则逻辑
}