Example for sync.WaitGroup correct?

by

Yes, this example is correct. It is important that the wg.Add() happens before the go statement to prevent race conditions. The following would also be correct:

func main() {
    var wg sync.WaitGroup
    wg.Add(1)
    go dosomething(200, &wg)
    wg.Add(1)
    go dosomething(400, &wg)
    wg.Add(1)
    go dosomething(150, &wg)
    wg.Add(1)
    go dosomething(600, &wg)

    wg.Wait()
    fmt.Println("Done")
}

However, it is rather pointless to call wg.Add over and over again when you already know how many times it will be called.

Waitgroups panic if the counter falls below zero. The counter starts at zero, each Done() is a -1 and each Add() depends on the parameter. So, to ensure that the counter never drops below and avoid panics, you need the Add() to be guaranteed to come before the Done().

In Go, such guarantees are given by the memory model.

The memory model states that all statements in a single goroutine appear to be executed in the same order as they are written. It is possible that they won’t actually be in that order, but the outcome will be as if it was. It is also guaranteed that a goroutine doesn’t run until after the go statement that calls it. Since the Add() occurs before the go statement and the go statement occurs before the Done(), we know the Add() occurs before the Done().

If you were to have the go statement come before the Add(), the program may operate correctly. However, it would be a race condition because it would not be guaranteed.

More Related Contents:

  1. Sudden Increase in the number of goroutines after upgrade [closed]
  2. No output from goroutine
  3. How to stop a goroutine
  4. cancel a blocking operation in Go
  5. Is it safe to read a function pointer concurrently without a lock?
  6. How to broadcast message using channel
  7. Can I concurrently write different slice elements
  8. Close multiple goroutine if an error occurs in one in go
  9. Prevent the main() function from terminating before goroutines finish in Golang
  10. How to wait for all goroutines to finish without using time.Sleep?
  11. Why Golang cannot generate json from struct with front lowercase character?
  12. Multiple goroutines listening on one channel
  13. Goroutine does not execute if time.Sleep included
  14. Max number of goroutines
  15. How to collect values from N goroutines executed in a specific order?
  16. Pre-processor directive in Go like in C [duplicate]
  17. Convert map values to plain strings without brackets? [closed]
  18. Collect values in order, each containing a map
  19. Pass method argument to function
  20. How to list installed go packages
  21. Go template.ExecuteTemplate include html
  22. Accessing local packages within a go module (go 1.11)
  23. Go template name
  24. Strange type definition syntax in Golang (name, then type, then string literal)
  25. time.Since() with months and years
  26. How to pad a number with zeros when printing?
  27. Pass slice as function argument, and modify the original slice
  28. How to import local packages without gopath
  29. Difference between any/interface{} as constraint vs. type of argument?
  30. Slice chunking in Go

Leave a Comment