为什么 ThreadSanitizer 会报告这个无锁示例的竞争？

Question

我已将其归结为一个简单的独立示例。主线程将 1000 个项目入队，工作线程尝试同时出队。 ThreadSanitizer 抱怨其中一个元素的读取和写入之间存在竞争，即使有一个获取-释放内存屏障序列保护它们。

#include <atomic>
#include <thread>
#include <cassert>

struct FakeQueue
{
    int items[1000];
    std::atomic<int> m_enqueueIndex;
    int m_dequeueIndex;

    FakeQueue() : m_enqueueIndex(0), m_dequeueIndex(0) { }

    void enqueue(int x)
    {
        auto tail = m_enqueueIndex.load(std::memory_order_relaxed);
        items[tail] = x;              // <- element written
        m_enqueueIndex.store(tail + 1, std::memory_order_release);
    }

    bool try_dequeue(int& x)
    {
        auto tail = m_enqueueIndex.load(std::memory_order_acquire);
        assert(tail >= m_dequeueIndex);
        if (tail == m_dequeueIndex)
            return false;
        x = items[m_dequeueIndex];    // <- element read -- tsan says race!
        ++m_dequeueIndex;
        return true;
    }
};


FakeQueue q;

int main()
{
    std::thread th([&]() {
        int x;
        for (int i = 0; i != 1000; ++i)
            q.try_dequeue(x);
    });

    for (int i = 0; i != 1000; ++i)
        q.enqueue(i);

    th.join();
}

ThreadSanitizer 输出：

==================
WARNING: ThreadSanitizer: data race (pid=17220)
  Read of size 4 at 0x0000006051c0 by thread T1:
    #0 FakeQueue::try_dequeue(int&) /home/cameron/projects/concurrentqueue/tests/tsan/issue49.cpp:26 (issue49+0x000000402bcd)
    #1 main::{lambda()#1}::operator()() const <null> (issue49+0x000000401132)
    #2 _M_invoke<> /usr/include/c++/5.3.1/functional:1531 (issue49+0x0000004025e3)
    #3 operator() /usr/include/c++/5.3.1/functional:1520 (issue49+0x0000004024ed)
    #4 _M_run /usr/include/c++/5.3.1/thread:115 (issue49+0x00000040244d)
    #5 <null> <null> (libstdc++.so.6+0x0000000b8f2f)

  Previous write of size 4 at 0x0000006051c0 by main thread:
    #0 FakeQueue::enqueue(int) /home/cameron/projects/concurrentqueue/tests/tsan/issue49.cpp:16 (issue49+0x000000402a90)
    #1 main /home/cameron/projects/concurrentqueue/tests/tsan/issue49.cpp:44 (issue49+0x000000401187)

  Location is global 'q' of size 4008 at 0x0000006051c0 (issue49+0x0000006051c0)

  Thread T1 (tid=17222, running) created by main thread at:
    #0 pthread_create <null> (libtsan.so.0+0x000000027a67)
    #1 std::thread::_M_start_thread(std::shared_ptr<std::thread::_Impl_base>, void (*)()) <null> (libstdc++.so.6+0x0000000b9072)
    #2 main /home/cameron/projects/concurrentqueue/tests/tsan/issue49.cpp:41 (issue49+0x000000401168)

SUMMARY: ThreadSanitizer: data race /home/cameron/projects/concurrentqueue/tests/tsan/issue49.cpp:26 FakeQueue::try_dequeue(int&)
==================
ThreadSanitizer: reported 1 warnings

命令行：

g++ -std=c++11 -O0 -g -fsanitize=thread issue49.cpp -o issue49 -pthread

g++版本：5.3.1

谁能解释一下为什么 tsan 认为这是一场数据竞赛？

更新

这似乎是误报。为了安抚 ThreadSanitizer，我添加了注释（参见 here for the supported ones and here for an example). Note that detecting whether tsan is enabled in GCC via a macro has only recently been added，所以我现在必须手动将 -D__SANITIZE_THREAD__ 传递给 g++。

#if defined(__SANITIZE_THREAD__)
#define TSAN_ENABLED
#elif defined(__has_feature)
#if __has_feature(thread_sanitizer)
#define TSAN_ENABLED
#endif
#endif

#ifdef TSAN_ENABLED
#define TSAN_ANNOTATE_HAPPENS_BEFORE(addr) \
    AnnotateHappensBefore(__FILE__, __LINE__, (void*)(addr))
#define TSAN_ANNOTATE_HAPPENS_AFTER(addr) \
    AnnotateHappensAfter(__FILE__, __LINE__, (void*)(addr))
extern "C" void AnnotateHappensBefore(const char* f, int l, void* addr);
extern "C" void AnnotateHappensAfter(const char* f, int l, void* addr);
#else
#define TSAN_ANNOTATE_HAPPENS_BEFORE(addr)
#define TSAN_ANNOTATE_HAPPENS_AFTER(addr)
#endif

struct FakeQueue
{
    int items[1000];
    std::atomic<int> m_enqueueIndex;
    int m_dequeueIndex;

    FakeQueue() : m_enqueueIndex(0), m_dequeueIndex(0) { }

    void enqueue(int x)
    {
        auto tail = m_enqueueIndex.load(std::memory_order_relaxed);
        items[tail] = x;
        TSAN_ANNOTATE_HAPPENS_BEFORE(&items[tail]);
        m_enqueueIndex.store(tail + 1, std::memory_order_release);
    }

    bool try_dequeue(int& x)
    {
        auto tail = m_enqueueIndex.load(std::memory_order_acquire);
        assert(tail >= m_dequeueIndex);
        if (tail == m_dequeueIndex)
            return false;
        TSAN_ANNOTATE_HAPPENS_AFTER(&items[m_dequeueIndex]);
        x = items[m_dequeueIndex];
        ++m_dequeueIndex;
        return true;
    }
};

// main() is as before

现在 ThreadSanitizer 在运行时很开心。

Answer 1

ThreadSanitizer不擅长计数，无法理解写入项目总是发生在读取之前。

ThreadSanitizer 可以发现 m_enqueueIndex 的存储发生在加载之前，但它不理解 items[m_dequeueIndex] 的存储必须发生在 tail > m_dequeueIndex 加载之前。

Answer 2

这看起来像 https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78158。反汇编 GCC 生成的二进制文件表明它没有检测 O0 上的原子操作。作为解决方法，您可以使用带有 -O1/-O2 的 GCC 构建代码，或者为自己获取一个新的 Clang 构建并将其用于运行 ThreadSanitizer（这是推荐的方法，因为 TSan 正在开发为Clang 的一部分，仅向后移植到 GCC）。

上面的评论无效：TSan 可以很容易地理解代码中原子之间的发生前关系（可以通过运行在 Clang 中的 TSan 下使用上述复制器来检查）。

我也不建议使用 AnnotateHappensBefore()/AnnotateHappensAfter()，原因有二：

在大多数情况下你不需要它们；它们表示代码正在做一些非常复杂的事情（在这种情况下，您可能需要仔细检查您是否做对了）；
如果你在你的无锁代码中犯了一个错误，用注解喷它可能会掩盖那个错误，这样 TSan 就不会注意到它。

为什么 ThreadSanitizer 会报告这个无锁示例的竞争？

Why does ThreadSanitizer report a race with this lock-free example?

race-condition

memory-barriers

c++11

thread-sanitizer