std::atomic_fetch_add, std::atomic_fetch_add_explicit

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

原子操作库

类

atomic (C++11)

atomic_ref (C++20)

函数

atomic_storeatomic_store_explicit (C++11)(C++11)

atomic_loadatomic_load_explicit (C++11)(C++11)

atomic_exchangeatomic_exchange_explicit (C++11)(C++11)

atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)

atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)

atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)

atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)

atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)

atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11)

atomic_is_lock_free (C++11)

atomic_waitatomic_wait_explicit (C++20)(C++20)

atomic_notify_one (C++20)

atomic_notify_all (C++20)

原子标志

atomic_flag (C++11)

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)

atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)

atomic_flag_testatomic_flag_test_explicit (C++20)(C++20)

atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20)

atomic_flag_notify_one (C++20)

atomic_flag_notify_all (C++20)

初始化

atomic_init (C++11)(C++20 中弃用)

ATOMIC_VAR_INIT (C++11)(C++20 中弃用)

ATOMIC_FLAG_INIT (C++11)(C++20 中弃用)

内存顺序

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

定义于头文件 <atomic>
	(1)
template< class T > T atomic_fetch_add( std::atomic<T>* obj,                     typename std::atomic<T>::difference_type arg ) noexcept;
template< class T > T atomic_fetch_add( volatile std::atomic<T>* obj,                     typename std::atomic<T>::difference_type arg ) noexcept;
		(2)
template< class T > T atomic_fetch_add_explicit( std::atomic<T>* obj,                              typename std::atomic<T>::difference_type arg,                              std::memory_order order ) noexcept;
template< class T > T atomic_fetch_add_explicit( volatile std::atomic<T>* obj,                              typename std::atomic<T>::difference_type arg,                              std::memory_order order ) noexcept;

进行原子加法。

原子地加 arg 到 obj 所指向的值，并返回 obj 先前保有的值。如同执行下列内容一般进行运算：

1) obj->fetch_add(arg)

2) obj->fetch_add(arg, order)

参数

obj	-	指向要修改的原子对象的指针
arg	-	要加到存储于原子对象的值的值
order	-	此操作所用的内存同步顺序：容许所有值。

返回值

*obj 的修改顺序中，立即前趋此函数效应的值。

可能的实现

template< class T > T atomic_fetch_add( std::atomic<T>* obj, typename std::atomic<T>::difference_type arg ) { return obj->fetch_add(arg); }

示例

单写者/多读者锁能用 fetch_add 制作。注意此过分简化的实现不是免锁的。

运行此代码

#include <string>
#include <thread>
#include <vector>
#include <iostream>
#include <atomic>
#include <chrono>
 
// cnt 的含义：
// 10 ：无活跃读者或写者
// 1...9 ：有 9...1 个读者活跃。写者被阻塞
// 0 ： fetch_sub 和 fetch_add 间的临时值在读者锁中
// -1 ：有活跃写者。读者被阻塞。
const int N = 10; // 允许九个共时读者
std::atomic<int> cnt = ATOMIC_VAR_INIT(N);
 
std::vector<int> data;
 
void reader(int id)
{
    for(;;)
    {
        // 锁定
        while(std::atomic_fetch_sub(&cnt, 1) <= 0)
            std::atomic_fetch_add(&cnt, 1);
        // 读取
        if(!data.empty())
            std::cout << (  "reader " + std::to_string(id)
                          + " sees " + std::to_string(*data.rbegin()) + '\n');
        if(data.size() == 100)
            break;
        // 解锁
        std::atomic_fetch_add(&cnt, 1);
        // 暂停
        std::this_thread::sleep_for(std::chrono::milliseconds(1));
    }
}
 
void writer()
{
    for(int n = 0; n < 100; ++n)
    {
        // 锁定
        while(std::atomic_fetch_sub(&cnt, N+1) != N)
            std::atomic_fetch_add(&cnt, N+1);
        // 写入
        data.push_back(n);
        std::cout << "writer pushed back " << n << '\n';
        // 解锁
        std::atomic_fetch_add(&cnt, N+1);
        // 暂停
        std::this_thread::sleep_for(std::chrono::milliseconds(1));
    }
}
 
int main()
{
    std::vector<std::thread> v;
    for (int n = 0; n < N; ++n) {
        v.emplace_back(reader, n);
    }
    v.emplace_back(writer);
    for (auto& t : v) {
        t.join();
    }
}

输出：

writer pushed back 0
reader 8 sees 0
reader 3 sees 0
reader 1 sees 0
<...>
reader 2 sees 99
reader 6 sees 99
reader 1 sees 99

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

DR	应用于	出版时的行为	正确行为
P0558R1	C++11	曾要求准确类型匹配，因为从多个参数推导 T	仅从 atomic 参数推导 T

参阅

fetch_add	原子地将参数加到存储于原子对象的值，并返回先前保有的值 (std::atomic<T> 的公开成员函数)
atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)	从原子对象减去非原子值，并获得原子对象的先前值 (函数模板)