std::atomic_fetch_sub, std::atomic_fetch_sub_explicit

Определено в заголовке `<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)

Выполняет атомное вычитание. Атомарно вычитает arg из значения, на которое указывает obj, и возвращает значение obj, которое было ранее. Операция выполняется так, как если бы выполнялось следующее:

1,2) obj->fetch_sub(arg)

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

Если у std::atomic<T> нет члена fetch_sub (этот член предоставляется только для целочисленных, чисел с плавающей точкой(с C++20) и указателей типов, кроме bool), программа некорректна.

Параметры

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 << "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 < 5; ++n)
        v.emplace_back(reader, n);
    for (auto& t : v)
        t.join();
}

Вывод:

reader 2 processed item 50
reader 1 processed item 44
reader 4 processed item 46
<....>
reader 0 done
reader 4 done
reader 3 done

Отчеты об ошибках

Следующие отчеты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR	Применено к	Поведение, как опубликовано	Правильное поведение
P0558R1	C++11	требовалось точное соответствие типов, потому что `T` выводилось из нескольких аргументов	`T` выводится только из `obj`

См. также

fetch_sub	атомарно вычитает аргумент из значения, хранящегося в атомном объекте, и получает ранее хранимое значение (публичный член-функция `std::atomic<T>`)
atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)	добавляет неатомное значение к атомному объекту и получает предыдущее значение атома (шаблон функции)
C документация для `atomic_fetch_sub, atomic_fetch_sub_explicit`

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/atomic/atomic_fetch_sub