基本紹介

WaitGroup は、タスクスケジューリングのために go によって使用される同時実行プリミティブです. 解決したいのは、同時実行待機の問題です:

ゴルーチンのグループが完了するのを待っているチェックポイント (チェックポイント) にゴルーチン A がある場合、これらのゴルーチンがすべて完了していない場合、ゴルーチン A はチェックポイントでブロックされ、すべてのゴルーチンが完了するまで実行を続けることができます。

WaitGroup がない場合、コルーチン A が他のコルーチンが実行されるまで待機した直後に実行したい場合、他のコルーチンが実行されるかどうかを継続的にポーリングすることしかできません。

適時性が悪い : ポーリング間隔が長いほど適時性が悪い

無駄な空回りトレーニング、システムリソースの浪費

WaitGroup を使用すると、コルーチン A は他のコルーチンが実行されるまでのみブロックし、その後コルーチン A に通知します

JavaのCountDownLatchなど、他の言語でも同様のツールが提供されています

使用する

待機グループには 3 つの方法があります。

func (wg *WaitGroup) Add(delta int)
func (wg *WaitGroup) Done()
func (wg *WaitGroup) Wait()
复制代码

追加: カウント値をインクリメントします

完了: カウント値を減らす

Wait: このメソッドを呼び出すゴルーチンは、WaitGroup カウントが 0 になるまでブロックします。

ソースコード分析

type WaitGroup struct {
   // 避免复制
   noCopy noCopy

   // 64位环境下，高32位是计数值，低32位记录waiter的数量
   state1 uint64
   // 用于信号量
   state2 uint32
}
复制代码

追加

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)
   }
}
复制代码

ステートの上位 32 ビットにはカウント値が格納されるため、パラメータ delta を 32 ビット左にシフトしてステートに追加するのが正しい方法です。

加算後に v が 0 より大きい場合、または加算後に v が 0 に等しくてもウェイターが存在しない場合は、直接戻ります。
- v が 0 より大きい: これは、Done を呼び出す最後のコルーチンではないことを意味します。自分でウェイターを解放して、直接戻る必要はありません。
- v は 0 ですが、ウェイターはありません: ウェイターが存在しないため、ウェイターを解放して直接戻る必要はありません。

それ以外の場合、v は 0 に等しく、w は 0 より大きい:
- あなたが最後に Done を呼び出し、まだウェイターがいる場合は、すべてのウェイターを起こします

終わり

Done は内部的に Add を呼び出しますが、パラメーターには -1 が渡されます。これは、カウント値を減らすことを意味します。

func (wg *WaitGroup) Done() {
   wg.Add(-1)
}
复制代码

待って

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の場合、現時点でブロックする必要はなく、そのまま復帰する

それ以外の場合は、ウェイターの数を 1 増やします。追加が成功した場合は、セマフォで自分自身をブロックします。

被唤醒时，如果statep不为0，表示该waitgroup是否在wait返回前被重用了，panic

注意事项

通过源码分析可以看出，Waitgroup有以下使用注意事项：

计数器的值必须大于等于0：
1. 一开始调用Add时，不能传负数
2. 调用Done的次数不能过多，导致超过了 WaitGroup 的计数值
3. 因此使用 WaitGroup 的正确姿势是，预先确定好 WaitGroup 的计数值，然后调用相同次数的 Done 完成相应的任务

要保证在期望的Add调用完成后，再调用Wait，否则Wait发现计数值为0时不会阻塞
1. 最好在一个协程中，按顺序先调Add，再调Wait

需要重用时，需要在前一组调用Wait结束后，再开始新一轮的使用
1. WaitGroup 是可以重用的。只要 WaitGroup 的计值恢复到零值的状态，那么它就可以被看作是新创建的 WaitGroup，被重复使用，而不能在前一组没使用完的情况下又使用

Go sync.WaitGroup の深い理解

基本紹介

使用する

ソースコード分析

追加

終わり

待って

注意事项

おすすめ