std::atomic_fetch_add, std::atomic_fetch_add_explicit

Определено в заголовке `<atomic>`
template< class T > T atomic_fetch_add( std::atomic<T>* obj, typename std::atomic<T>::difference_type arg ) noexcept;	(1)	(с C++11)
template< class T > T atomic_fetch_add( volatile std::atomic<T>* obj, typename std::atomic<T>::difference_type arg ) noexcept;	(2)	(с C++11)
template< class T > T atomic_fetch_add_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_add_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_add(arg)

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

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

Параметры

obj	-	указатель на атомный объект для изменения
arg	-	значение, которое нужно добавить к значению, хранящемуся в атомном объекте
order	-	порядок синхронизации памяти

Возвращаемое значение

Значение, непосредственно предшествующее результатам этой функции в порядке модификации *obj.

Пример

Блокировку с одним записывающим и множеством читающих потоков можно реализовать с помощью std::atomic_fetch_add. Обратите внимание, что эта упрощенная реализация не является блокировка-свободной.

#include <atomic>
#include <chrono>
#include <iostream>
#include <string>
#include <thread>
#include <vector>
 
using namespace std::chrono_literals;
 
// meaning of cnt:
//  5: readers and writer are in race. There are no active readers or writers.
//  4...0: there are 1...5 active readers, The writer is blocked.
// -1: writer won the race and readers are blocked.
 
const int N = 5; // four concurrent readers are allowed
std::atomic<int> cnt(N);
 
std::vector<int> data;
 
void reader(int id)
{
    for (;;)
    {
        // lock
        while (std::atomic_fetch_sub(&cnt, 1) <= 0)
            std::atomic_fetch_add(&cnt, 1);
 
        // read
        if (!data.empty())
            std::cout << ("reader " + std::to_string(id) +
                          " sees " + std::to_string(*data.rbegin()) + '\n');
        if (data.size() == 25)
            break;
 
        // unlock
        std::atomic_fetch_add(&cnt, 1);
 
        // pause
        std::this_thread::sleep_for(1ms);
    }
}
 
void writer()
{
    for (int n = 0; n < 25; ++n)
    {
        // lock
        while (std::atomic_fetch_sub(&cnt, N + 1) != N)
            std::atomic_fetch_add(&cnt, N + 1);
 
        // write
        data.push_back(n);
        std::cout << "writer pushed back " << n << '\n';
 
        // unlock
        std::atomic_fetch_add(&cnt, N + 1);
 
        // pause
        std::this_thread::sleep_for(1ms);
    }
}
 
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 2 sees 0
reader 3 sees 0
reader 1 sees 0
<...>
reader 2 sees 24
reader 4 sees 24
reader 1 sees 24

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

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

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

См. также

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

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