Goroutineでのdeadlockについて

Question

以下のコードではすべてが出力されたあとにdeadlockのエラーが出ます。

package main

import (
	"sync"

	"github.com/k0kubun/pp"
)

func main() {
	wg := sync.WaitGroup{}
	sig := make(chan bool)
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(i int) {
			pp.Println(i)
			if i == 3 {
				sig <- true
			}　else {
			        sig <- false
                        }
			wg.Done()
		}(i)
	}

	switch {
	case result <-sig:
                if result == true{
		       pp.Print("True")
                } else {
                      pp.Print("False")
                }
	default:
		
	}

	wg.Wait()
	close(sig)
	pp.Print("All Done")
}

出力は以下の通りです。

9
1
5
0
2
3
"False"8
6
4
7
fatal error: all goroutines are asleep - deadlock!

しかし、以下のケースではうまくいきます。

package main

import (
	"sync"

	"github.com/k0kubun/pp"
)

func main() {
	wg := sync.WaitGroup{}
	sig := make(chan bool)
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(i int) {
			pp.Println(i)
			wg.Done()
		}(i)
	}

	wg.Wait()
	pp.Print("All Done")
}

• どのような違いがあって
• なぜそうなるのか

をご指導していただきたいです。
よろしくお願いたします

追加

以下のコードではすべてが出力されたあとにdeadlockのエラーが出ます。

package main

import (
	"sync"

	"github.com/k0kubun/pp"
)

func main() {
	wg := sync.WaitGroup{}
	sig := make(chan bool)
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(i int) {
			pp.Println(i)
			if i == 3 {
				sig <- true
			}　else {
			        sig <- false
                        }
			wg.Done()
		}(i)
	}

　　　　　for {
	    switch {
	    case <-sig:
		    pp.Print("True")
	    default:
		    pp.Print("False")
	    }
        }

	wg.Wait()
	close(sig)
	pp.Print("All Done")
}

Comments

[nobonobo]

i==3の時にsigにfalseとtrueの二回書き込むのは意図通りなのですか？

[nobonobo]

あとsigから読んだ値がtrueかfalseかにかかわらずTrueを表示しているのも意図通りですか？違いますか？

[退会済みユーザー]

すみません、一つ目の指摘についてはelseを忘れていました。二つ目は今から修正しますが、なぜかシンタックスエラーができるので、困っています。

Answer 1

前者のコードはfunc mainとforループで起動される10個のgoroutine、つまり11個のgoroutineが走ります。

キューに長さを持たないchanを「unbuffered chan」と呼びますが、以下の特徴があります。

• 書き込みを行うgoroutineと読み出しを行うgoroutineが必要。
• 読み待ちと書き待ちが同時に待ち状態になった時に通信が成立する。

つまりデッドロックになる事例は
for分最初に起動したgoroutineが書き込み待ちになった状態で
mainのgoroutineがselect文に到達した時は
通信が成立してfalse値を受け取ることができますが、
以後はsigチャンネルを読もうとするgoroutineがいません。
なのでその他のgoroutineは全て書き込み待ちのままになります。

それで唯一待ちになっていなかった
mainのgoroutineがwg.Wait()により待ちにはいると、
全てのgoroutineが待ちに入ったことになり、
これをgoのランタイムが検出するとこの件のような
「all goroutines are asleep - deadlock!」panicを出します。
（なぜわざわざこういうことをするのかはよく考えてみましょう。）

後者のコードはmain以外に待ちに入るコードがないので起動した10個のgoroutineは順当に完走してwg.Wait()コールはちゃんと帰ってきます。

前者のコードを完走するように修正するには、
11個書いたら11個読みだす処理があればOKです。
（ちなみに前者のコードはi==3のときだけsigに2回書いてる）

参考

package main

import (
	"fmt"
	"sync"
)

func main() {
	wg := sync.WaitGroup{}
	sig := make(chan bool)
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(i int) {
			fmt.Println(i)
			if i == 3 {
				sig <- true
			}
			sig <- false
			wg.Done()
		}(i)
	}

	for i := 0; i < 11; i++ {
		switch {
		case <-sig:
			fmt.Println("True")
		default:
			fmt.Println("False")
		}
	}

	wg.Wait()
	close(sig)
	fmt.Println("All Done")
}

質問の修正後の追記:

変更は以下の2箇所

• 「起動したgoroutine群が完走したらsigをクローズする処理」をgoroutineで動かしておく。
• 無限ループから抜ける処理をいれる。

https://play.golang.org/p/SBuJsGJ417m

package main

import (
	"fmt"
	"sync"
)

func main() {
	wg := sync.WaitGroup{}
	sig := make(chan bool)
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(i int) {
			fmt.Println(i)
			if i == 3 {
				sig <- true
			} else {
				sig <- false
			}
			wg.Done()
		}(i)
	}
	
	go func() {
		wg.Wait()
		close(sig)
	}()

	for {
		v, ok := <-sig
		if !ok {
			break
		}
		if v {
			fmt.Println("True")
		} else {
			fmt.Println("False")
		}
	}

	fmt.Println("All Done")
}

Comments

[退会済みユーザー]

詳細にありがとうございます。

たとえばfor文を無限ループにしたい場合、

```
for {
switch {
case <- sig:
// ...
default:
　　　// ...
}
}
```
で、どのようにしたらうまく`break`を10個目の`sig`に挟めるでしょうか？

[nobonobo]

無限ループにする場合、終了を伝えたら抜ける処理が必要です。
最も一般的な方法は終わりたいタイミングでclose(sig)して、
無限ループ内でsigが閉じたかどうかの判定を含めるのが良いでしょう。

[nobonobo]

「v,ok := <-sig」とすると受け取った値はvに、!okであれば閉じられたことがわかります。

[退会済みユーザー]

追加に書きました。

無限for文の中身は

```
case v, ok := <- sig:
if !ok { break}
// ....
default:
// ...
```

といったような感じでしょうか？

[nobonobo]

はい。ただ、defaultはない方がいいですね（出力待ちではない状態でselectにくるとスルーしてしまいます）

Answer 2

参考情報

for {
    v, ok := <-sig
    if !ok {
        break
    }
    ...
}

上記は以下と等価です。

for v := range sig {
    ...
}