理解 goroutines 同步

Question

我正在尝试理解 golang channels 和 synchronization。 当我使用race detector 运行我的程序时，它会导致竞争检测。

我的程序：

func main() {
    ch := make(chan int)
    done := make(chan struct{})
    wg := sync.WaitGroup{}

    go func() {
        defer close(ch)
        defer close(done)
        wg.Wait()
        done <- struct{}{}
    }()

    for i := 0; i < 5; i++ {
        x := i
        wg.Add(1)
        go func() {
            defer wg.Done()
            fmt.Println("Value: ", x)
            ch <- x
        }()
    }
    
loop:
    for {
        select {
        case i := <-ch:
            fmt.Println("Value: ", i)
        case <- done:
            break loop
        }
    }
}

种族检测报告：

==================
WARNING: DATA RACE
Write at 0x00c000020148 by goroutine 7:
  internal/race.Write()
      /home/linuxbrew/.linuxbrew/Cellar/go/1.16.5/libexec/src/internal/race/race.go:41 +0x125
  sync.(*WaitGroup).Wait()
      /home/linuxbrew/.linuxbrew/Cellar/go/1.16.5/libexec/src/sync/waitgroup.go:128 +0x126
  main.main.func1()
      /home/reddy/code/github.com/awesomeProject/prod.go:106 +0xc4

Previous read at 0x00c000020148 by main goroutine:
  internal/race.Read()
      /home/linuxbrew/.linuxbrew/Cellar/go/1.16.5/libexec/src/internal/race/race.go:37 +0x206
  sync.(*WaitGroup).Add()
      /home/linuxbrew/.linuxbrew/Cellar/go/1.16.5/libexec/src/sync/waitgroup.go:71 +0x219
  main.main()
      /home/reddy/code/github.com/awesomeProject/prod.go:112 +0x124

Goroutine 7 (running) created at:
  main.main()
      /home/reddy/code/github.com/awesomeProject/prod.go:103 +0x104
==================

我无法弄清楚这里出了什么问题。

我的分析：

1. wg.Add(1) 正在递增计数器
2. wg.Done() 在减少计数器的 goroutine 结束时调用
3. ch <- x 这应该是一个阻塞调用，因为它是非缓冲通道
4. 循环应该迭代直到完成通道有一些消息当waitgroup计数器变为零时发生，即所有5个goroutine都发布了消息
5. 一旦计数器归零，wg goroutine 将恢复并调用 done，一旦消息在主循环中被消耗，它会中断循环并正常退出。

Answer 1

程序在对wg.Add 的调用和对wg.Wait 的调用之间存在竞争。这些调用可以以任何顺序发生。在调用wg.Add 之前调用wg.Wait 时，调用wg.Wait 不会等待任何goroutine。

通过将调用移至wg.Add 在启动调用wg.Wait 的goroutine 进行修复。此更改确保对 wg.Add 的调用发生在对 wg.Wait 的调用之前。

for i := 0; i < 5; i++ {
    x := i
    wg.Add(1)
    go func() {
        defer wg.Done()
        fmt.Println("Value: ", x)
        ch <- x
    }()
}

go func() {
    defer close(ch)
    defer close(done)
    wg.Wait()
    done <- struct{}{}
}()

WaitGroup 类型有代码在竞争检测器下运行时检查此错误（modeled read、modeled write）。

当 ch 关闭时，通过在主 goroutine 中中断循环来简化代码。不需要done 频道。

ch := make(chan int)
wg := sync.WaitGroup{}

for i := 0; i < 5; i++ {
    x := i
    wg.Add(1)
    go func() {
        defer wg.Done()
        fmt.Println("Value: ", x)
        ch <- x
    }()
}

go func() {
    wg.Wait()
    close(ch)
}()

for i := range ch {
    fmt.Println("Value: ", i)
}