std::atomic_fetch_sub, std::atomic_fetch_sub_explicit

< cpp‎ | atomic
 
C++
 
原子操作库
类
(C++11)
(C++20)
函数
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)(C++11)
(C++11)(C++11)
atomic_fetch_subatomic_fetch_sub_explicit
(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++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
初始化
(C++11)(C++20 中弃用)
(C++11)(C++20 中弃用)
(C++11)(C++20 中弃用)
内存顺序
(C++11)
(C++11)
(C++11)
(C++11)
 
定义于头文件 <atomic>
(1)
template< class T >

T atomic_fetch_sub( std::atomic<T>* obj,

                    typename std::atomic<T>::difference_type arg ) noexcept;
template< class T >

T atomic_fetch_sub( volatile std::atomic<T>* obj,

                    typename std::atomic<T>::difference_type arg ) noexcept;
(2)
template< class T >

T atomic_fetch_sub_explicit( std::atomic<T>* obj,
                             typename std::atomic<T>::difference_type arg,

                             std::memory_order order ) noexcept;
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;

进行原子减法。

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

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

参数

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

返回值

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

可能的实现

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

示例

多个线程可用 fetch_sub 同时处理有下标的容器

运行此代码
#include <string>
#include <thread>
#include <vector>
#include <iostream>
#include <atomic>
#include <numeric>
 
const int N = 10000;
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 << "reader " << std::to_string(id) << " processed item "
                      << std::to_string(data[idx]) << '\n';
        } else {
            std::cout << "reader " << std::to_string(id) << " done\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 < 10; ++n) {
        v.emplace_back(reader, n);
    }
    for (auto& t : v) {
        t.join();
    }
}

输出： 

reader 2 processed item 10000
reader 6 processed item 9994
reader 4 processed item 9996
reader 6 processed item 9992
<....>
reader 0 done
reader 5 done
reader 3 done
reader 9 done

缺陷报告

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

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

参阅

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