排他制御

複数の goroutine を扱うようになると、「起動した goroutine が全て終わるのを待ちたい」「複数の goroutine が同じ変数を同時に読み書きするのを防ぎたい」といった同期の処理が必要になります。Go は標準の sync パッケージで、それぞれに対応する WaitGroup(複数 goroutine の完了待ち合わせ)と Mutex(相互排他ロック)を提供しています。

1. sync.WaitGroup

sync.WaitGroup は、複数の goroutine を1つのグループとしてまとめ、そのグループ全体の完了を待つための仕組みです。「起動した goroutine のうち、どれが終わったか」を個別に追う必要はなく、「グループ全体が終わるまで待つ」という書き方ができます。ここで言う「グループ」は、同じ sync.WaitGroup の変数を共有している goroutine の集まりを指します。異なる sync.WaitGroup の変数を使えば、それぞれ独立した別のグループとして扱われます。

内部的には、待つ goroutine の数をカウンタで管理しています。goroutine を起動する前にカウンタを増やし、各 goroutine が終わったときにカウンタを減らして、カウンタが 0 になるまで main を待たせる、というシンプルな流れで完了待ちを実現します。

sync.WaitGroup の書き方は以下のとおりです。

var wg sync.WaitGroup

wg.Add(1)             // 待つ goroutine の数を1つ増やす
go func() {
    defer wg.Done()   // goroutine 完了時にカウンタを1減らす
    // 何らかの処理
}()
wg.Wait()             // カウンタが 0 になるまで待つ

wg.Add(N) で待つ数を先に増やし、goroutine 内で defer wg.Done() を書くのが定番パターンです。wg.Wait() は全ての Done() が呼ばれてカウンタが 0 になるまでブロックします。

次のコードは、3つの goroutine を並行に起動し、全ての完了を sync.WaitGroup で待つ例です。main.go を以下の内容に書き換えて保存し、go run main.go で実行します。

package main

import (
    "fmt"
    "sync"
    "time"
)

func main() {
    var wg sync.WaitGroup

    for i := 1; i <= 3; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            time.Sleep(500 * time.Millisecond)
            fmt.Println("goroutine", i, "完了")
        }()
    }

    wg.Wait()
    fmt.Println("すべての goroutine が完了しました")
}

以下のような実行結果が表示されます(完了の順序は実行ごとに変わる場合があります)。

goroutine 3 完了
goroutine 1 完了
goroutine 2 完了
すべての goroutine が完了しました

3つの goroutine がそれぞれ 500ms 待って完了メッセージを出し、wg.Wait() によって全ての完了を待ってから main の最後の行が出力されました。

コードを解説します。

wg.Add(1)
go func() {
    defer wg.Done()
    time.Sleep(500 * time.Millisecond)
    fmt.Println("goroutine", i, "完了")
}()

goroutine を起動するたびに wg.Add(1) でカウンタを1増やし、goroutine の中では defer wg.Done() で終了時に確実にカウンタを1減らします。

wg.Wait()
fmt.Println("すべての goroutine が完了しました")

wg.Wait() はカウンタが 0 になるまで、つまり全ての goroutine が Done() を呼び終えるまでブロックします。全 goroutine の完了を待ってから、次の行の「すべての goroutine が完了しました」が出力されます。

2. sync.Mutex

複数の goroutine が同じ変数を同時に読み書きすると、値が壊れることがあります。以下のコードは 10 個の goroutine から共有変数 count をインクリメントしていますが、結果は必ずしも 10 になりません。

var count int
for i := 0; i < 10; i++ {
    go func() {
        count++   // 複数 goroutine が同時にアクセスして値が壊れる
    }()
}

これをデータ競合と呼びます。基本方針は channel でやり取りすることですが、状態を持つ struct のフィールドを守る場面などでは、channel よりも直接ロックを取る方が自然な場合があります。

sync.Mutex は、「同時に1つの goroutine だけがロックを取得できる」ことを保証する仕組みです。共有変数を読み書きする前にロックを取得し、読み書きが終わったら解放するようにすると、まだロックを取得できていない他の goroutine はその間待たされます。この順番待ちによって、複数の goroutine が同じ変数を同時に読み書きしてしまうことを防げます。この「一度に1つだけ」を保証する仕組みを 相互排他ロック(Mutual Exclusion Lock) と呼び、Mutex の名前もこれに由来します。

sync.Mutex の Lock() でロックを取得し、Unlock() で解放します。ロック中は他の goroutine が同じ mutex の Lock() でブロックされます。書き方は以下のとおりです。defer で必ず解放するのが慣用パターンです。

var mu sync.Mutex

mu.Lock()
defer mu.Unlock()   // 関数を抜けるときに必ず解放する
// 排他制御が必要な処理

次のコードは、1000個の goroutine が同じカウンタを 1 ずつ増やす例です。sync.Mutex で count を守っているため、最終的に正しく 1000 が得られます。完了待ちには先ほど学んだ sync.WaitGroup を使います。

package main

import (
    "fmt"
    "sync"
)

type SafeCounter struct {
    mu    sync.Mutex
    count int
}

func (c *SafeCounter) Inc() {
    c.mu.Lock()
    defer c.mu.Unlock()
    c.count++
}

func main() {
    c := &SafeCounter{}

    var wg sync.WaitGroup
    for i := 0; i < 1000; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            c.Inc()
        }()
    }
    wg.Wait()

    fmt.Println(c.count)
}

以下のような実行結果が表示されます。

1000

1000個の goroutine がそれぞれ 1 増やし、mutex によって競合を防いだ結果、最終的に正しく 1000 になりました。

コードを解説します。

type SafeCounter struct {
    mu    sync.Mutex
    count int
}

func (c *SafeCounter) Inc() {
    c.mu.Lock()
    defer c.mu.Unlock()
    c.count++
}

SafeCounter は sync.Mutex を内部に持ち、Inc の中で Lock() してから count++ します。Lock() を呼ぶとロックを取得し、他の goroutine は同じ mutex の Lock() でブロックされます。defer c.mu.Unlock() で必ず解放するのが慣用パターンです。

var wg sync.WaitGroup
for i := 0; i < 1000; i++ {
    wg.Add(1)
    go func() {
        defer wg.Done()
        c.Inc()
    }()
}
wg.Wait()

1000個の goroutine を起動し、sync.WaitGroup で全てが終わるのを待ちます。もし mutex を使わずに c.count++ を書くと、1000 に満たない値が返ることがあります(データ競合)。go run -race main.go で実行すると、Go に組み込まれたレース検出器がデータ競合を報告してくれます。