type Mutex struct {
	state int32
	sema  uint32
}

const (
	mutexLocked = 1 << iota // mutex is locked  //值1，轉(zhuǎn)二進(jìn)制后三位為001，表示鎖已被搶
	mutexWoken                                  //值2，轉(zhuǎn)二進(jìn)制后三位為010，告訴即將釋放鎖的g現(xiàn)在已有g(shù)被喚醒
	mutexStarving                               //值4，轉(zhuǎn)二進(jìn)制后三位為100，表示當(dāng)前處在饑餓狀態(tài)
	mutexWaiterShift = iota                     //值3，表示mutex.state右移3位為等待鎖的goroutine數(shù)量
	starvationThresholdNs = 1e6                 //表示mutext切換到饑餓狀態(tài)所需等待時(shí)間的閾值，1ms。
）

type Locker interface {
	Lock()
	Unlock()
}

func (m *Mutex) Lock() {
	// 第一種情況：快上鎖，即此刻無(wú)人來(lái)?yè)屾i
	if atomic.CompareAndSwapInt32(&m.state, 0, mutexLocked) {
		if race.Enabled {  //競(jìng)爭(zhēng)檢測(cè)相關(guān)，不用看
			race.Acquire(unsafe.Pointer(m))
		}
		return
	}
	// 第二種情況：慢上鎖，即此刻有競(jìng)爭(zhēng)對(duì)手
	m.lockSlow()
}

// 注釋里的第一人稱“我”只當(dāng)前g
func (m *Mutex) lockSlow() {
	var waitStartTime int64	// 等待開(kāi)始的時(shí)間
	starving := false		// 我是否饑餓
	awoke := false			// 我是否被喚醒
	iter := 0				// 我的自旋次數(shù)
	old := m.state			// 這個(gè)鎖此時(shí)此刻所有的信息
	for {
		// 如果：鎖已經(jīng)被搶了 或著 正處在饑餓狀態(tài) 或者 允許我自旋 那么進(jìn)行自旋
		if old&(mutexLocked|mutexStarving) == mutexLocked && runtime_canSpin(iter) {
			// 如果：我沒(méi)有處在喚醒態(tài) 并且 當(dāng)前無(wú)g處在喚醒態(tài) 并且
            // 有等待鎖的g 并且CAS嘗試將我置為喚醒態(tài)成功 則進(jìn)行自旋
            // 之所以將我置為喚醒態(tài)是為了明示那些執(zhí)行完畢正在退出的g不用再去喚醒其它g了，因?yàn)橹辉试S存在一個(gè)喚醒的g。
			if !awoke && old&mutexWoken == 0 && old>>mutexWaiterShift != 0 &&
				atomic.CompareAndSwapInt32(&m.state, old, old|mutexWoken) {
				awoke = true
			}
			runtime_doSpin()	// 我自旋一次
			iter++				// 我自旋次數(shù)加1
			old = m.state
			continue
		}
		new := old	// new只是個(gè)中間態(tài)，后面的cas操作將會(huì)判斷是否將這個(gè)中間態(tài)落實(shí)
		// 如果不是處在饑餓模式就立即搶鎖
		if old&mutexStarving == 0 {
			new |= mutexLocked
		}
        // 如果鎖被搶了 或者 處在饑餓模式，那就去排隊(duì)
		if old&(mutexLocked|mutexStarving) != 0 {
			new += 1 << mutexWaiterShift	// 等待鎖的goroutine數(shù)量加1
		}
		// 如果我現(xiàn)在饑渴難耐 而且 鎖也被搶走了，那就立即將鎖置為饑餓模式
		if starving && old&mutexLocked != 0 {
			new |= mutexStarving
		}
		if awoke {
			if new&mutexWoken == 0 {
				throw("sync: inconsistent mutex state")
			}
            // 釋放我的喚醒態(tài)
            // 因?yàn)楹竺嫖乙磽尩芥i要么被阻塞，都不是處在和喚醒態(tài)
			new &^= mutexWoken
		}
        //此處CAS操作嘗試將new這個(gè)中間態(tài)落實(shí)
		if atomic.CompareAndSwapInt32(&m.state, old, new) {
			if old&(mutexLocked|mutexStarving) == 0 {
				break // 搶鎖成功！
			}
			// queueLifo我之前有沒(méi)有排過(guò)隊(duì)
			queueLifo := waitStartTime != 0
			if waitStartTime == 0 {
				waitStartTime = runtime_nanotime()
			}
            //原語(yǔ)：如果我之前排過(guò)隊(duì)，這次就把我放到等待隊(duì)列隊(duì)首，否則把我放到隊(duì)尾，并將我掛起
			runtime_SemacquireMutex(&m.sema, queueLifo, 1) 
            // 剛被喚醒的我先判斷自己是不是饑餓了，如果我等待鎖的時(shí)間小于starvationThresholdNs（1ms），那就不餓
			starving = starving || runtime_nanotime()-waitStartTime > starvationThresholdNs
			old = m.state
			if old&mutexStarving != 0 {
				// 我一覺(jué)醒來(lái)發(fā)覺(jué)鎖正處在饑餓狀態(tài)，蒼天有眼這個(gè)鎖屬于我了，因?yàn)轲囸I狀態(tài)絕對(duì)沒(méi)有人跟我搶鎖
				if old&(mutexLocked|mutexWoken) != 0 || old>>mutexWaiterShift == 0 {
					throw("sync: inconsistent mutex state")
				}
                // delta是一個(gè)中間狀態(tài)，atomic.AddInt32方法將給鎖落實(shí)這個(gè)狀態(tài)
				delta := int32(mutexLocked - 1<<mutexWaiterShift)
				if !starving || old>>mutexWaiterShift == 1 {
                    // 如果現(xiàn)在我不饑餓或者等待鎖的就我一個(gè)，那么就將鎖切換到正常狀態(tài)。
                    // 饑餓模式效率很低，而且一旦有兩個(gè)g把mutex切換為饑餓模式，那就會(huì)死鎖。
					delta -= mutexStarving
				}
                // 原語(yǔ)：給鎖落實(shí)delta的狀態(tài)。
				atomic.AddInt32(&m.state, delta)
                // 我拿到鎖啦
				break
			}
            // 把我的狀態(tài)置為喚醒，我將繼續(xù)去搶鎖
			awoke = true
            // 把我的自旋次數(shù)置0，我又可以自旋搶鎖啦
			iter = 0
		} else {
            // 繼續(xù)去搶鎖
			old = m.state
		}
	}

    // 競(jìng)爭(zhēng)檢測(cè)的代碼，不管
	if race.Enabled {
		race.Acquire(unsafe.Pointer(m))
	}
}

func sync_runtime_canSpin(i int) bool {
	// 可自旋的條件：
    // 1.多核cpu
    // 2.GOMAXPROCS > 1 且 至少有一個(gè)其他的p在運(yùn)行 且 該p的本地runq為空
    // 3.iter小于最大自旋次數(shù)active_spin = 4
	if i >= active_spin || ncpu <= 1 || gomaxprocs <= int32(sched.npidle+sched.nmspinning)+1 {
  	return false
	}
  if p := getg().m.p.ptr(); !runqempty(p) {
		return false
	}
	return true
}

//go:linkname sync_runtime_doSpin sync.runtime_doSpin
//go:nosplit
func sync_runtime_doSpin() {
	procyield(active_spin_cnt)
}

TEXT runtime·procyield(SB),NOSPLIT,$0-0
	MOVL	cycles+0(FP), AX
again:
	PAUSE
	SUBL	$1, AX
	JNZ	again
	RET

//go:linkname sync_runtime_SemacquireMutex sync.runtime_SemacquireMutex
func sync_runtime_SemacquireMutex(addr *uint32, lifo bool, skipframes int) {
	semacquire1(addr, lifo, semaBlockProfile|semaMutexProfile, skipframes)
}

uint32_t
AddUint32 (uint32_t *val, uint32_t delta)
{
  return __atomic_add_fetch (val, delta, __ATOMIC_SEQ_CST);
}

func (m *Mutex) Unlock() {
	if race.Enabled {
		_ = m.state
		race.Release(unsafe.Pointer(m))
	}

	// 如果沒(méi)有g(shù)在等待鎖則立即釋放鎖
	new := atomic.AddInt32(&m.state, -mutexLocked)
	if new != 0 {
		// 如果還有g(shù)在等待鎖，則在鎖釋放后需要做一點(diǎn)收尾工作。
		m.unlockSlow(new)
	}
}

func (m *Mutex) unlockSlow(new int32) {
	if (new+mutexLocked)&mutexLocked == 0 {
		throw("sync: unlock of unlocked mutex")
	}
    // 如果鎖處在正常模式下
	if new&mutexStarving == 0 {
		old := new
		for {
			// 如果鎖正處在正常模式下，同時(shí) 沒(méi)有等待鎖的g 或者 已經(jīng)有g(shù)被喚醒了 或者 鎖已經(jīng)被搶了，就什么也不用做直接返回
			// 如果鎖正處在饑餓模式下，也是什么也不用做直接返回
			if old>>mutexWaiterShift == 0 || old&(mutexLocked|mutexWoken|mutexStarving) != 0 {
				return
			}
			// 給鎖的喚醒標(biāo)志位置1，表示已經(jīng)有g(shù)被喚醒了，Mutex.state后三位010
			new = (old - 1<<mutexWaiterShift) | mutexWoken
			if atomic.CompareAndSwapInt32(&m.state, old, new) {
                // 喚醒鎖的等待隊(duì)列頭部的一個(gè)g
                // 并把g放到p的funq尾部
				runtime_Semrelease(&m.sema, false, 1)
				return
			}
			old = m.state
		}
	} else {
		// 鎖處在饑餓模式下，直接喚醒鎖的等待隊(duì)列頭部的一個(gè)g
		//因?yàn)樵陴囸I模式下沒(méi)人跟剛被喚醒的g搶鎖，所以不用設(shè)置鎖的喚醒標(biāo)志位
		runtime_Semrelease(&m.sema, true, 1)
	}
}

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