中級

sync: negative WaitGroup counter パニックの原因と直し方

sync.WaitGroupのDone()はAdd()で加算した回数より多く呼ぶとカウンタが負になり、実行時にパニックします。goroutineの数とAddで加算する数が一致していないと発生します。

エラーメッセージの読み方

panic: sync: negative WaitGroup counter

panic

パニック — 実行時に回復不能な状態になったことを示します。deferとrecoverで捕まえない限り、そのままプロセスが終了します

sync: negative WaitGroup counter

詳細メッセージ — どの値が問題だったか

このエラーが出る典型パターン

 1  package main
 2  
 3  import "sync"
 4  
 5  func main() {
 6  	var wg sync.WaitGroup
 7  	wg.Add(1)
 8  	wg.Done()
 9  	wg.Done()
         ^
10  }

 1  package main
 2  
 3  import "sync"
 4  
 5  func main() {
 6  	var wg sync.WaitGroup
 7  	wg.Add(2)
 8  	wg.Done()
 9  	wg.Done()
10  	wg.Done()
         ^
11  }

 1  package main
 2  
 3  import "sync"
 4  
 5  func main() {
 6  	var wg sync.WaitGroup
 7  	wg.Add(3)
 8  	wg.Done()
 9  	wg.Done()
10  	wg.Done()
11  	wg.Done()
         ^
12  }

 1  package main
 2  
 3  import "sync"
 4  
 5  func main() {
 6  	var wg sync.WaitGroup
 7  	wg.Add(1)
 8  	wg.Done()
 9  	wg.Done()
         ^
10  }

 1  package main
 2  
 3  import "sync"
 4  
 5  func main() {
 6  	var wg sync.WaitGroup
 7  	wg.Add(2)
 8  	wg.Done()
 9  	wg.Done()
10  	wg.Done()
         ^
11  }

よくある誤解

「Doneは呼びすぎても、カウンタが0で止まってくれるはず」という思い込みは誤りです。WaitGroupは呼び出し回数の対応を厳密にチェックしており、Addの回数を超えるDoneはその場でパニックを起こします。

まとめ

sync: negative WaitGroup counter パニックの原因と直し方は中級でつまずきやすい項目です。上の5パターンを実際に手で直すと、エラーメッセージのどこを読めばよいかが掴めます。

演習をはじめる

関連するエラー

• close of closed channel パニックの原因と直し方一度closeしたチャネルをもう一度closeしようとすると、実行時にパニックが発生します。
• interface conversion panic の原因と直し方型アサーション v.(T) は、vの実際の型がTでない場合に実行時パニックを起こします。