日本免费高清视频-国产福利视频导航-黄色在线播放国产-天天操天天操天天操天天操|www.shdianci.com

學無先后,達者為師

網站首頁 編程語言 正文

Go?sync?WaitGroup使用深入理解_Golang

作者:亞洲第一中鋒_哈 ? 更新時間: 2022-12-01 編程語言

基本介紹

WaitGroup是go用來做任務編排的一個并發原語,它要解決的就是并發 - 等待的問題:

當有一個 goroutine A 在檢查點(checkpoint)等待一組 goroutine 全部完成,如果這些 goroutine 還沒全部完成,goroutine A 就會阻塞在檢查點,直到所有 goroutine 都完成后才能繼續執行

試想如果沒有WaitGroup,想要在協程A等到其他協程執行完成后能立馬執行,只能不斷輪詢其他協程是否執行完畢,這樣的問題是:

  • 及時性差:輪詢間隔越高,及時性越差
  • 無謂的空輪訓,浪費系統資源

而用WaitGroup時,協程A只用阻塞,直到其他協程執行完畢后,再通知協程A

其他語言也提供了類似的工具,例如Java的CountDownLatch

使用

Waitgroup提供了3個方法:

func (wg *WaitGroup) Add(delta int)
func (wg *WaitGroup) Done()
func (wg *WaitGroup) Wait()

Add:增加計數值

Done:減少計數值

Wait:調用這個方法的 goroutine 會一直阻塞,直到 WaitGroup 的計數值變為 0

源碼分析

type WaitGroup struct {
   // 避免復制
   noCopy noCopy
   // 64位環境下,高32位是計數值,低32位記錄waiter的數量
   state1 uint64
   // 用于信號量
   state2 uint32
}

Add

func (wg *WaitGroup) Add(delta int) {
   // 獲取狀態值,信號量
   statep, semap := wg.state()
   // 將參數delta左32位,加到statep中,即給計數值加上delta
   state := atomic.AddUint64(statep, uint64(delta)<<32)
   // 加后的計數值
   v := int32(state >> 32)
   // waiter的數量
   w := uint32(state)
   // 加后不能是負值
   if v < 0 {
      panic( "sync: negative WaitGroup counter" )
   }
   // 有waiter的情況下,當前協程又加了計數值,panic
   // 即有waiter的情況下,不能再給waitgroup增加計數值了
   if w != 0 && delta > 0 && v == int32(delta) {
      panic( "sync: WaitGroup misuse: Add called concurrently with Wait" )
   }
   // 如果加完后v大于0,或者加完后v等于0,但沒有等待者,直接返回
   if v > 0 || w == 0 {
      return
   }
   // 接下來就是v等于0,且w大于0的情況
   // 再次檢查是否有Add和Wait并發調用的情況
   if *statep != state {
      panic( "sync: WaitGroup misuse: Add called concurrently with Wait" )
   }
   // 將計數值和waiter數量清0
   *statep = 0
   // 喚醒所有的waiter
   for ; w != 0; w-- {
      runtime_Semrelease(semap, false, 0)
   }
}
  • 因為state高32位保存計數值,因此需要將參數delta左移32位后加到state上才正確

如果加完后v大于0,或者加完后v等于0,但沒有等待者,直接返回

  • v大于0:表示自己不是最后一個調用Done的協程,不用自己來釋放waiter,直接返回
  • v等于0,但沒有等待者:因為沒有等待者,也就不用釋放等待者,也直接返回

否則就是v等于0,且w大于0的情況:

自己是最后一個調用Done的,且還有等待者,那就喚醒所有等待者

Done

Done內部調用Add,只是參數傳-1,表示減少計數值

func (wg *WaitGroup) Done() {
   wg.Add(-1)
}

Wait

func (wg *WaitGroup) Wait() {
   statep, semap := wg.state()
   for {
      state := atomic.LoadUint64(statep)
      // v:計數值
      v := int32(state >> 32)
      w := uint32(state)
      // 如果計數值為0,自己不需要等到,直接返回
      if v == 0 {
         return
   }
      // 增加waiter計數值
 if atomic.CompareAndSwapUint64(statep, state, state+1) {
         // 自己在信號量上阻塞
         runtime_Semacquire(semap)
         // 檢查Waitgroup是否在wait返回前被重用
         if *statep != 0 {
            panic( "sync: WaitGroup is reused before previous Wait has returned" )
         }
         return
      }
   }
}

如果計數值為0,當前不需要阻塞,直接返回

否則將waiter數量加1,如果添加成功,就把自己阻塞到信號量上

被喚醒時,如果statep不為0,表示該waitgroup是否在wait返回前被重用了,panic

注意事項

通過源碼分析可以看出,Waitgroup有以下使用注意事項:

計數器的值必須大于等于0

一開始調用Add時,不能傳負數

調用Done的次數不能過多,導致超過了 WaitGroup 的計數值

因此使用 WaitGroup 的正確姿勢是,預先確定好 WaitGroup 的計數值,然后調用相同次數的 Done 完成相應的任務

保證在期望的Add調用完成后,再調用Wait,否則Wait發現計數值為0時不會阻塞

最好在一個協程中,按順序先調Add,再調Wait

需要重用時,需要在前一組調用Wait結束后,再開始新一輪的使用

WaitGroup 是可以重用的。只要 WaitGroup 的計值恢復到零值的狀態,那么它就可以被看作是新創建的 WaitGroup,被重復使用,而不能在前一組沒使用完的情況下又使用

原文鏈接:https://juejin.cn/post/7157986303085117470

欄目分類
最近更新