close

std::atomic_fetch_sub, std::atomic_fetch_sub_explicit

来自cppreference.com
 
C++
 
并发支持库
线程
(C++11)
(C++20)
(C++17)(C++17)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
(C++11)
协作式取消
互斥
(C++11)
(C++11)
(C++17)
通用锁管理
(C++11)
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
条件变量
(C++11)
(C++11)
(C++11)
(C++11)
信号量
(C++20)(C++20)
闩与屏障
(C++20)
(C++20)
未来体
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
安全回收
(C++26)
(C++26)
(C++26)
风险指针
(C++26)
(C++26)
(C++26)
原子类型
(C++11)
(C++20)
(C++11)
原子类型的初始化
(C++11)(C++20 弃用)
(C++11)(C++20 弃用)
(C++11)
内存定序
(C++11)
(C++11)(C++26 弃用)
(C++11)
(C++11)
原子操作的自由函数
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++26)(C++26)
(C++26)(C++26)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
原子标志的自由函数
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
 
在标头 <atomic> 定义 
template< class T >
T atomic_fetch_sub( std::atomic<T>* obj,
                    typename std::atomic<T>::difference_type arg ) noexcept;
(1) (C++11 起) 
template< class T >
T atomic_fetch_sub( volatile std::atomic<T>* obj,
                    typename std::atomic<T>::difference_type arg ) noexcept;
(2) (C++11 起) 
template< class T >
T atomic_fetch_sub_explicit( std::atomic<T>* obj, 
                             typename std::atomic<T>::difference_type arg, 
                             std::memory_order order ) noexcept;
(3) (C++11 起) 
template< class T >
T atomic_fetch_sub_explicit( volatile std::atomic<T>* obj,
                             typename std::atomic<T>::difference_type arg, 
                             std::memory_order order ) noexcept;
(4) (C++11 起)

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

1,2) obj->fetch_sub(arg)
3,4) obj->fetch_sub(arg, order)

如果 std::atomic<T> 没有 fetch_sub 成员（此成员仅对 bool 以外的整数、浮点(C++20 起)和指针类型提供），那么程序非良构。

参数

obj - 指向要修改的原子对象的指针
arg - 要从存储于原子对象的值减去的值
order - 内存同步定序

返回值

*obj 的修改顺序中，紧接此函数生效之前的值。

示例

多个线程可用 std::atomic_fetch_sub 同时处理有下标的容器。

运行此代码
#include <atomic>
#include <iostream>
#include <numeric>
#include <string>
#include <thread>
#include <vector>

const int N = 50;
std::atomic<int> cnt;
std::vector<int> data(N);

void reader(int id) 
{
    for (;;)
    {
        int idx = atomic_fetch_sub_explicit(&cnt, 1, std::memory_order_relaxed);
        if (idx >= 0)
            std::cout << "读者 " << std::to_string(id) << " 已处理第 "
                      << std::to_string(data[idx]) << " 项\n";
        else
        {
            std::cout << "读者 " << std::to_string(id) << " 已完成\n";
            break;
        }
    }
}

int main()
{
    std::iota(data.begin(), data.end(), 1);
    cnt = data.size() - 1;
    
    std::vector<std::thread> v;
    for (int n = 0; n < 5; ++n)
        v.emplace_back(reader, n);
    for (auto& t : v)
        t.join();
}

输出： 

读者 2 已处理第 50 项
读者 1 已处理第 44 项
读者 4 已处理第 46 项
<....>
读者 0 已完成
读者 4 已完成
读者 3 已完成

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
P0558R1 C++11 要求准确类型匹配，因为会从多个参数推导 T 只会从 obj 推导 T

参阅

 原子地从存储于原子对象的值减去实参，并获得先前保有的值
(std::atomic<T> 的公开成员函数) [编辑]
(C++11)(C++11)
 将非原子值加到原子对象上，并获得原子对象的先前值
(函数模板) [编辑]
atomic_fetch_sub, atomic_fetch_sub_explicit 的 C 文档