从值传递的struct值读取字段时的数据争用

时间:2017-02-03 22:41:45

标签: go race-condition

为什么golang竞赛检测器会抱怨以下代码:

package main

import (
    "fmt"
    "sync"
)

type Counter struct {
    value int
    mtx     *sync.Mutex
}

func NewCounter() *Counter {
    return &Counter {0, &sync.Mutex{}}
}

func (c *Counter) inc() {
    c.mtx.Lock()
    c.value++
    c.mtx.Unlock()
}

func (c Counter) get() int {
    c.mtx.Lock()
    res := c.value
    c.mtx.Unlock()
    return res
}

func main() {
    var wg sync.WaitGroup
    counter := NewCounter()
    max := 100
    wg.Add(max)

    // consumer
    go func() {
        for i := 0; i < max ; i++ {
            value := counter.get()
            fmt.Printf("counter value = %d\n", value)
            wg.Done()
        }
    }()
    // producer
    go func() {
        for i := 0; i < max ; i++ {
            counter.inc()
        }
    }()

    wg.Wait()
}

当我使用-race运行上面的代码时,我收到以下警告:

==================
WARNING: DATA RACE
Read at 0x00c0420042b0 by goroutine 6:
  main.main.func1()
      main.go:39 +0x72

Previous write at 0x00c0420042b0 by goroutine 7:
  main.(*Counter).inc()
      main.go:19 +0x8b
  main.main.func2()
      main.go:47 +0x50

Goroutine 6 (running) created at:
  main.main()
      main.go:43 +0x167

Goroutine 7 (running) created at:
  main.main()
      main.go:49 +0x192
==================

如果我将func (c Counter) get() int更改为func (c *Counter) get() int,那么一切正常。事实证明get()函数的接收器类型应该是指针。我很困惑为什么会这样。我知道“-copylocks”但在这种情况下mtx是一个指针,而不是值。如果我将'mtx'更改为值并使用vet -copylocks运行程序,我会收到此警告:

  

main.go:23:按值获取通行证:main.Counter包含sync.Mutex`

这是有道理的。

注意:这个问题不是关于如何实现线程安全计数器

link to playground code

2 个答案:

答案 0 :(得分:4)

比赛是因为get()方法的值接收器。为了调用get()方法,必须将结构的副本传递给方法表达式。没有语法糖的方法调用如下:

value := Counter.get(*counter)

复制结构需要读取value字段,该字段在方法可以获取锁定之前发生,这就是在方法调用行上而不是在方法中报告竞争的原因。

这就是为什么将接收器更改为指针接收器将解决问题。此外,由于所有接收器都需要指针,mtx可以保留为sync.Mutex值,因此不需要初始化。

答案 1 :(得分:1)

正如@JimB指出的那样,在get()方法的情况下,在这种情况下传递副本 首先读取字段值然后复制,没有任何锁定,因为 同一变量在inc()中发生变异,检测到种族。

为了进一步说明这一点,您还可以更改字段value的类型 一个指针,即value *int,在这种情况下你不应再看到现在的种族 只复制指针而不是基础值。那说,做出意图 更清楚的是,将get()接收器类型更改为指针更清晰。

这是一个很好的维基 - https://github.com/golang/go/wiki/CodeReviewComments#receiver-type

关于方法的简短评论: https://golang.org/ref/spec#Method_values