本文將介紹 Go 語言中的 sync.Cond
並行原語,包括 sync.Cond
的基本使用方法、實現原理、使用注意事項以及常見的使用使用場景。能夠更好地理解和應用 Cond 來實現 goroutine 之間的同步。
sync.Cond
是Go語言標準庫中的一個型別,代表條件變數。條件變數是用於多個goroutine之間進行同步和互斥的一種機制。sync.Cond
可以用於等待和通知goroutine,以便它們可以在特定條件下等待或繼續執行。
sync.Cond
的定義如下,提供了Wait
,Singal
,Broadcast
以及NewCond
方法
type Cond struct {
noCopy noCopy
// L is held while observing or changing the condition
L Locker
notify notifyList
checker copyChecker
}
func NewCond(l Locker) *Cond {}
func (c *Cond) Wait() {}
func (c *Cond) Signal() {}
func (c *Cond) Broadcast() {}
NewCond
方法: 提供建立Cond
範例的方法Wait
方法: 使當前執行緒進入阻塞狀態,等待其他協程喚醒Singal
方法: 喚醒一個等待該條件變數的執行緒,如果沒有執行緒在等待,則該方法會立即返回。Broadcast
方法: 喚醒所有等待該條件變數的執行緒,如果沒有執行緒在等待,則該方法會立即返回。當使用sync.Cond
時,通常需要以下幾個步驟:
sync.Cond
物件,關聯這個互斥鎖;Wait
方法等待條件變數被通知;Signal
或Broadcast
方法通知等待的協程。下面是一個簡單的程式碼的範例,展示了大概的程式碼結構:
var (
// 1. 定義一個互斥鎖
mu sync.Mutex
cond *sync.Cond
count int
)
func init() {
// 2.將互斥鎖和sync.Cond進行關聯
cond = sync.NewCond(&mu)
}
go func(){
// 3. 在需要等待的地方,獲取互斥鎖,呼叫Wait方法等待被通知
mu.Lock()
// 這裡會不斷迴圈判斷 是否滿足條件
for !condition() {
cond.Wait() // 等待任務
}
mu.Unlock()
}
go func(){
// 執行業務邏輯
// 4. 滿足條件,此時呼叫Broadcast喚醒處於等待狀態的協程
cond.Broadcast()
}
下面通過描述net/http
中的 connReader
,來展示使用sync.Cond
實現阻塞等待通知的機制。這裡我們不需要理解太多,只需要知道connReader
下面兩個方法:
func (cr *connReader) Read(p []byte) (n int, err error) {}
func (cr *connReader) abortPendingRead() {}
Read
方法則是用於從HTTP
連線中讀取資料,不允許並行存取的。而abortPendingRead
則是用於終止正在讀取的連線。
從abortPendingRead
方法的語意來看,是需要成功終止其他協程進行資料的讀取之後,才能正常返回,也就是此時沒有協程再繼續讀取資料了,才可以返回。
那abortPendingRead
如何得知是否還有協程在讀取資料呢,其實是可以通過定時輪訓connReader
的狀態,從而判斷當前Read方法是否仍在讀取資料。但是定時輪訓效率太低,可能會造成cpu的大量空轉。更好的方式,應該是讓協程進入阻塞狀態,然後等條件滿足了,其他協程再來喚醒當前協程,然後再繼續執行下去。
這個其實就是sync.Cond
設計的用途,當不滿足執行條件時,先進入阻塞狀態,等待條件滿足時,再由其他協程來喚醒,然後再繼續執行下去,能夠提高程式的執行效率。其中Wait
方法便是讓協程進入阻塞狀態,而Singal
和Boardcast
便是喚醒處於阻塞狀態的協程,告知其條件滿足了,可以繼續向下執行了。
回到我們connReader
的例子,我們使用sync.Cond
實現阻塞等待通知的效果。
type connReader struct {
// 是否正在讀取資料
inRead bool
mu sync.Mutex // guards following
cond *sync.Cond
}
func (cr *connReader) abortPendingRead() {
if !cr.inRead{
return
}
//1. 通過一定手段,讓Read方法中斷
cr.mu.Lock()
// 判斷Read方法是否仍然在讀取資料
for cr.inRead {
//2. 此時Read方法仍然在讀取資料, 不滿足條件,等待通知
cr.cond.Wait()
}
cr.mu.Unlock()
}
func (cr *connReader) Read(p []byte) (n int, err error) {
cr.mu.Lock()
cr.inRead = true
// 1. 讀取資料
// 2. abortPendingRead通過某種手段,讓Read方法中斷
cr.inRead = false
cr.mu.Unlock()
// 3. 現在已經滿足abortPendingRead繼續執行下去的條件了,可以喚醒abortPendingRead協程了
cond.Boardcast()
}
這裡abortPendingRead
方法首先判斷是否還在讀取資料,是的話,呼叫Wait
方法進入阻塞狀態,等待條件滿足後繼續執行。
對於Read
方法,因為其不執行並行存取,當其將退出時,說明此時已經沒有協程在讀取資料了,滿足abortPendingRead
繼續執行下去的條件了,此時可以呼叫Boardcast
來喚醒等待條件滿足的協程。之後呼叫abortPendingRead
方法的協程此時能夠接收到通知,便能夠順利被喚醒,從而正確返回。
這裡便展示了一個簡單的,使用sync.Cond
實現阻塞等待通知的例子。
在Sync.Cond
存在一個通知佇列,儲存了所有處於等待狀態的協程。通知佇列定義如下:
type notifyList struct {
wait uint32
notify uint32
lock uintptr // key field of the mutex
head unsafe.Pointer
tail unsafe.Pointer
}
當呼叫Wait
方法時,此時Wait
方法會釋放所持有的鎖,然後將自己放到notifyList
等待佇列中等待。此時會將當前協程加入到等待佇列的尾部,然後進入阻塞狀態。
當呼叫Signal
時,此時會喚醒等待佇列中的第一個協程,其他繼續等待。如果此時沒有處於等待狀態的協程,呼叫Signal
不會有其他作用,直接返回。當呼叫BoradCast
方法時,則會喚醒notfiyList
中所有處於等待狀態的協程。
sync.Cond
的程式碼實現比較簡單,協程的喚醒和阻塞已經由執行時包實現了,sync.Cond
的實現直接呼叫了執行時包提供的API。
Wait
方法首先呼叫runtime_notifyListAd
方法,將自己加入到等待佇列中,然後釋放鎖,等待其他協程的喚醒。
func (c *Cond) Wait() {
// 將自己放到等待佇列中
t := runtime_notifyListAdd(&c.notify)
// 釋放鎖
c.L.Unlock()
// 等待喚醒
runtime_notifyListWait(&c.notify, t)
// 重新獲取鎖
c.L.Lock()
}
Singal
方法呼叫runtime_notifyListNotifyOne
喚醒等待佇列中的一個協程。
func (c *Cond) Signal() {
// 喚醒等待佇列中的一個協程
runtime_notifyListNotifyOne(&c.notify)
}
Broadcast
方法呼叫runtime_notifyListNotifyAll
喚醒所有處於等待狀態的協程。
func (c *Cond) Broadcast() {
// 喚醒等待佇列中所有的協程
runtime_notifyListNotifyAll(&c.notify)
}
如果在呼叫Wait
方法前未加鎖,此時會直接panic
,下面是一個簡單例子的說明:
package main
import (
"fmt"
"sync"
"time"
)
var (
count int
cond *sync.Cond
lk sync.Mutex
)
func main() {
cond = sync.NewCond(&lk)
wg := sync.WaitGroup{}
wg.Add(2)
go func() {
defer wg.Done()
for {
time.Sleep(time.Second)
count++
cond.Broadcast()
}
}()
go func() {
defer wg.Done()
for {
time.Sleep(time.Millisecond * 500)
//cond.L.Lock()
for count%10 != 0 {
cond.Wait()
}
t.Logf("count = %d", count)
//cond.L.Unlock()
}
}()
wg.Wait()
}
上面程式碼中,協程一每隔1s,將count欄位的值自增1,然後喚醒所有處於等待狀態的協程。協程二執行的條件為count的值為10的倍數,此時滿足執行條件,喚醒後將會繼續往下執行。
但是這裡在呼叫sync.Wait
方法前,沒有先獲取鎖,下面是其執行結果,會丟擲 fatal error: sync: unlock of unlocked mutex 錯誤,結果如下:
count = 0
fatal error: sync: unlock of unlocked mutex
因此,在呼叫Wait
方法前,需要先獲取到與sync.Cond
關聯的鎖,否則會直接丟擲異常。
強制呼叫Wait方法前需要先獲取該鎖。這裡的原因在於呼叫Wait
方法如果不加鎖,有可能會出現競態條件。
這裡假設多個協程都處於等待狀態,然後一個協程呼叫了Broadcast喚醒了其中一個或多個協程,此時這些協程都會被喚醒。
如下,假設呼叫Wait
方法前沒有加鎖的話,那麼所有協程都會去呼叫condition
方法去判斷是否滿足條件,然後都通過驗證,執行後續操作。
for !condition() {
c.Wait()
}
c.L.Lock()
// 滿足條件情況下,執行的邏輯
c.L.Unlock()
此時會出現的情況為,本來是需要在滿足condition
方法的前提下,才能執行的操作。現在有可能的效果,為前面一部分協程執行時,還是滿足condition
條件的;但是後面的協程,儘管不滿足condition
條件,還是執行了後續操作,可能導致程式出錯。
正常的用法應該是,在呼叫Wait
方法前便加鎖,只會有一個協程判斷是否滿足condition
條件,然後執行後續操作。這樣子就不會出現即使不滿足條件,也會執行後續操作的情況出現。
c.L.Lock()
for !condition() {
c.Wait()
}
// 滿足條件情況下,執行的邏輯
c.L.Unlock()
呼叫sync.Wait
方法,協程進入阻塞狀態後被喚醒,沒有重新檢查條件變數,此時有可能仍然處於不滿足條件變數的場景下。然後直接執行後續操作,有可能會導致程式出錯。下面舉一個簡單的例子:
package main
import (
"fmt"
"sync"
"time"
)
var (
count int
cond *sync.Cond
lk sync.Mutex
)
func main() {
cond = sync.NewCond(&lk)
wg := sync.WaitGroup{}
wg.Add(3)
go func() {
defer wg.Done()
for {
time.Sleep(time.Second)
cond.L.Lock()
// 將flag 設定為true
flag = true
// 喚醒所有處於等待狀態的協程
cond.Broadcast()
cond.L.Unlock()
}
}()
for i := 0; i < 2; i++ {
go func(i int) {
defer wg.Done()
for {
time.Sleep(time.Millisecond * 500)
cond.L.Lock()
// 不滿足條件,此時進入等待狀態
if !flag {
cond.Wait()
}
// 被喚醒後,此時可能仍然不滿足條件
fmt.Printf("協程 %d flag = %t", i, flag)
flag = false
cond.L.Unlock()
}
}(i)
}
wg.Wait()
}
在這個例子,我們啟動了一個協程,定時將flag
設定為true,相當於每隔一段時間,便滿足執行條件,然後喚醒所有處於等待狀態的協程。
然後又啟動了兩個協程,在滿足條件的前提下,開始執行後續操作,但是這裡協程被喚醒後,沒有重新檢查條件變數,具體看第39行。這裡會出現的場景是,第一個協程被喚醒後,此時執行後續操作,然後將flag
重新設定為false,此時已經不滿足條件了。之後第二個協程喚醒後,獲取到鎖,沒有重新檢查此時是否滿足執行條件,直接向下執行,這個就和我們預期不符,可能會導致程式出錯,程式碼執行效果如下:
協程 1 flag = true
協程 0 flag = false
協程 1 flag = true
協程 0 flag = false
可以看到,此時協程0執行時,flag
的值均為false
,說明此時其實並不符合執行條件,可能會導致程式出錯。因此正確用法應該像下面這樣子,被喚醒後,需要重新檢查條件變數,滿足條件之後才能繼續向下執行。
c.L.Lock()
// 喚醒後,重新檢查條件變數是否滿足條件
for !condition() {
c.Wait()
}
// 滿足條件情況下,執行的邏輯
c.L.Unlock()
本文介紹了 Go 語言中的 sync.Cond 並行原語,它是用於實現 goroutine 之間的同步的重要工具。我們首先學習了 sync.Cond
的基本使用方法,包括建立和使用條件變數、使用Wait
和Signal
/Broadcast
方法等。
在接下來的部分中,我們介紹了 sync.Cond
的實現原理,主要是對等待佇列的使用,從而sync.Cond
有更好的理解,能夠更好得使用它。同時,我們也講述了使用sync.Cond
的注意事項,如呼叫Wait
方法前需要加鎖等。
基於以上內容,本文完成了對 sync.Cond
的介紹,希望能夠幫助大家更好地理解和使用Go語言中的並行原語。