WaitGroup

概念

Go標準庫提供了WaitGroup原語, 可以用它來等待一批 Goroutine 結束

底層數據結構

// A WaitGroup must not be copied after first use.
type WaitGroup struct {
 noCopy noCopy
 state1 [3]uint32
}

其中?noCopy?是 golang 源碼中檢測禁止拷貝的技術。如果程序中有 WaitGroup 的賦值行為，使用?go vet?檢查程序時，就會發現有報錯。但需要注意的是，noCopy 不會影響程序正常的編譯和運行。

state1主要是存儲著狀態和信號量，狀態維護了 2 個計數器，一個是請求計數器counter ，另外一個是等待計數器waiter（已調用?WaitGroup.Wait?的 goroutine 的個數）

當數組的首地址是處于一個8字節對齊的位置上時，那么就將這個數組的前8個字節作為64位值使用表示狀態，后4個字節作為32位值表示信號量(semaphore)；同理如果首地址沒有處于8字節對齊的位置上時，那么就將前4個字節作為semaphore，后8個字節作為64位數值。

使用方法

在WaitGroup里主要有3個方法：

WaitGroup.Add()：可以添加或減少請求的goroutine數量，Add(n)?將會導致?counter += n

WaitGroup.Done()：相當于Add(-1)，Done()?將導致?counter -=1，請求計數器counter為0 時通過信號量調用runtime_Semrelease喚醒waiter線程

WaitGroup.Wait()：會將?waiter++，同時通過信號量調用?runtime_Semacquire(semap)阻塞當前 goroutine

func main() {
    var wg sync.WaitGroup
    for i := 1; i <= 5; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            println("hello")
        }()
    }
    wg.Wait()
}

Cond

概念

Go標準庫提供了Cond原語，可以讓 Goroutine 在滿足特定條件時被阻塞和喚醒

底層數據結構

type Cond struct {
    noCopy noCopy
    // L is held while observing or changing the condition
    L Locker
    notify  notifyList
    checker copyChecker
}
type notifyList struct {
    wait   uint32
    notify uint32
    lock   uintptr // key field of the mutex
    head   unsafe.Pointer
    tail   unsafe.Pointer
}

主要有4個字段：

nocopy?： golang 源碼中檢測禁止拷貝的技術。如果程序中有 WaitGroup 的賦值行為，使用?go vet?檢查程序時，就會發現有報錯，但需要注意的是，noCopy 不會影響程序正常的編譯和運行

checker：用于禁止運行期間發生拷貝，雙重檢查(Double check)

L：可以傳入一個讀寫鎖或互斥鎖，當修改條件或者調用Wait方法時需要加鎖

notify：通知鏈表，調用Wait()方法的Goroutine會放到這個鏈表中，從這里獲取需被喚醒的Goroutine列表

使用方法

在Cond里主要有3個方法：

• sync.NewCond(l Locker): 新建一個 sync.Cond 變量，注意該函數需要一個 Locker 作為必填參數，這是因為在?cond.Wait()?中底層會涉及到 Locker 的鎖操作
• Cond.Wait(): 阻塞等待被喚醒，調用Wait函數前需要先加鎖；并且由于Wait函數被喚醒時存在虛假喚醒等情況，導致喚醒后發現，條件依舊不成立，因此需要使用 for 語句來循環地進行等待，直到條件成立為止
• Cond.Signal(): 只喚醒一個最先 Wait 的 goroutine，可以不用加鎖
• Cond.Broadcast(): 喚醒所有Wait的goroutine，可以不用加鎖

package main
import (
    "fmt"
    "sync"
    "sync/atomic"
    "time"
)
var status int64
func main() {
    c := sync.NewCond(&sync.Mutex{})
    for i := 0; i < 10; i++ {
        go listen(c)
    }
    go broadcast(c)
    time.Sleep(1 * time.Second)
}
func broadcast(c *sync.Cond) {
    // 原子操作
    atomic.StoreInt64(&status, 1) 
    c.Broadcast()
}
func listen(c *sync.Cond) {
    c.L.Lock()
    for atomic.LoadInt64(&status) != 1 {
        c.Wait() 
        // Wait 內部會先調用 c.L.Unlock()，來先釋放鎖，如果調用方不先加鎖的話，會報錯
    }
    fmt.Println("listen")
    c.L.Unlock()
}