std::atomic_ref

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов(C++20)

Библиотека метапрограммирования(C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов(C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения(C++11)

Атомарные операции(C++11)

Библиотека поддержки конкуренции(C++11)

Библиотека файловой системы(C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека атомарных операций

Типы

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)

 

std::atomic_ref

Функции-элементы

atomic_ref::atomic_ref

atomic_ref::operator=

atomic_ref::is_lock_free

atomic_ref::store

atomic_ref::load

atomic_ref::operator T

atomic_ref::exchange

atomic_ref::compare_exchange_strongatomic_ref::compare_exchange_weak

atomic_ref::wait (C++20)

atomic_ref::notify_one (C++20)

atomic_ref::notify_all (C++20)

Константы

atomic_ref::is_always_lock_free

atomic_ref::required_alignment

Специализированные функции-элементы

atomic_ref::fetch_add

atomic_ref::fetch_sub

atomic_ref::fetch_and

atomic_ref::fetch_or

atomic_ref::fetch_xor

atomic_ref::operator++atomic_ref::operator++(int)atomic_ref::operator--atomic_ref::operator--(int)

atomic_ref::operator+=atomic_ref::operator-=atomic_ref::operator&=atomic_ref::operator|=atomic_ref::operator^=

 

Определено в заголовочном файле <atomic>
template<class T > struct atomic_ref;	(1)	(начиная с C++20)
template<class T > struct atomic_ref<T*>;	(2)	(начиная с C++20)

Шаблон класса std::atomic_ref применяет атомарные операции к объекту, на который он ссылается. В течение времени существования объекта std::atomic_ref объект, на который он ссылается, считается атомарным объектом. Если один поток записывает в атомарный объект, а другой поток читает из него, поведение чётко определено (подробности о гонках данных смотрите в модели памяти). Кроме того, доступ к атомарным объектам может установить межпотоковую синхронизацию и упорядочить доступ к неатомарной памяти, как указано в std::memory_order.

Время жизни объекта должно превышать время жизни всех std::atomic_ref, которые ссылаются на объект. Пока любые экземпляры std::atomic_ref, ссылающиеся на объект, существуют, доступ к объекту должен осуществляться исключительно через эти экземпляры std::atomic_ref. Ни на один подобъект объекта, на который ссылается объект std::atomic_ref, не может одновременно ссылаться любой другой объект std::atomic_ref.

Атомарные операции, применяемые к объекту через std::atomic_ref, являются атомарными по отношению к атомарным операциям, применяемым через любые другие std::atomic_ref, ссылающиеся на тот же объект.

std::atomic_ref является CopyConstructible.

Как и для языковых ссылок, константность для std::atomic_ref невелика - можно изменить указуемое значение с помощью объекта conststd::atomic_ref.

Специализации

Основной шаблон

Основной шаблон std::atomic_ref может быть создан с любым TriviallyCopyable типом T (включая bool):

struct Counters {int a;int b;};// определяемый пользователем тип, допускающий// тривиальное копирование alignas(std::atomic_ref<Counters>::required_alignment) Counters counter; std::atomic_ref<Counters> cnt(counter);// специализация для определяемого// пользователем типа

Частичная специализация для типов указателей

Стандартная библиотека предоставляет частичную специализацию шаблона std::atomic_ref для всех типов указателей. В дополнение к операциям, предусмотренным для всех атомарных типов, эти специализации дополнительно поддерживают атомарные арифметические операции, соответствующие типам указателей, например fetch_add, fetch_sub.

Специализации для целочисленных типов

При создании экземпляра с одним из следующих целочисленных типов std::atomic_ref предоставляет дополнительные атомарные операции, соответствующие целочисленным типам, такие как fetch_add, fetch_sub, fetch_and, fetch_or, fetch_xor:

• Символьные типы char, char8_t, char16_t, char32_t и wchar_t;
• Стандартные целочисленные типы со знаком: signedchar, short, int, long и longlong;
• Стандартные целочисленные типы без знака: unsignedchar, unsignedshort, unsignedint, unsignedlong и unsignedlonglong;
• Любые дополнительные целочисленные типы, необходимые для typedef‘ов в заголовке <cstdint>.

Знаковая целочисленная арифметика использует дополнение до двух; нет неопределённых результатов.

Специализации для типов с плавающей запятой

При создании экземпляра с одним из cv-неквалифицированных типов с плавающей запятой (float, double, longdouble и cv-неквалифицированных расширенных типов с плавающей запятой(начиная с C++23)), std::atomic_ref предоставляет дополнительные атомарные операции, соответствующие типам с плавающей запятой, таким как fetch_add и fetch_sub.

Никакие операции не приводят к неопределённому поведению, даже если результат не представляется в виде типа с плавающей запятой. Фактически среда с плавающей запятой может отличаться от среды с плавающей запятой вызывающего потока.

Типы-элементы

Тип элемент	Определение
value_type	смотрите ниже
difference_type	value_type(только для специализаций atomic_ref<Целочисленный тип> и atomic_ref<Тип с плавающей запятой>) std::ptrdiff_t(только для специализаций std::atomic_ref<T*>)

Для каждого std::atomic_ref<X> (является он специализированным или нет), std::atomic_ref<X>::value_type равно X.

difference_type не определён в основном шаблоне atomic_ref.

Функции-элементы

(конструктор)	создаёт объект atomic_ref (public функция-элемент)
operator=	сохраняет значение в объекте, на который ссылается объект atomic_ref (public функция-элемент)
is_lock_free	проверяет, свободен ли от блокировок объект atomic_ref (public функция-элемент)
store	атомарно заменяет значение указанного объекта неатомарным аргументом (public функция-элемент)
load	атомарно получает значение указанного объекта (public функция-элемент)
operator T	загружает значение из указанного объекта (public функция-элемент)
exchange	атомарно заменяет значение указанного объекта и получает значение, которое было ранее (public функция-элемент)
compare_exchange_weakcompare_exchange_strong	атомарно сравнивает значение указанного объекта с неатомарным аргументом и выполняет атомарный обмен, если они равны, или атомарную загрузку, если нет (public функция-элемент)
wait	блокирует поток до тех пор, пока не получит уведомление и не изменится атомарное значение (public функция-элемент)
notify_one	уведомляет хотя бы один поток, ожидающий атомарный объект (public функция-элемент)
notify_all	уведомляет все потоки, заблокированные в ожидании атомарного объекта (public функция-элемент)
Константы
is_always_lock_free [static]	указывает, что тип всегда свободен от блокировок (public static константа-элемент)
required_alignment [static]	указывает необходимое выравнивание объекта, на который будет ссылаться atomic_ref (public static константа-элемент)

Специализированные функции-элементы

fetch_add	атомарно добавляет аргумент к значению, хранящемуся в указанном объекте, и получает значение, сохранённое ранее (public функция-элемент)
fetch_sub	атомарно вычитает аргумент из значения, хранящегося в указанном объекте, и получает значение, сохранённое ранее (public функция-элемент)
fetch_and	атомарно выполняет побитовое И между аргументом и значением указанного объекта и получает значение, сохранённое ранее (public функция-элемент)
fetch_or	атомарно выполняет побитовое ИЛИ между аргументом и значением указанного объекта и получает значение, сохранённое ранее (public функция-элемент)
fetch_xor	атомарно выполняет побитовое исключающее ИЛИ между аргументом и значением указанного объекта и получает значение, сохранённое ранее (public функция-элемент)
operator++operator++(int)operator--operator--(int)	атомарно увеличивает или уменьшает указанный объект на единицу (public функция-элемент)
operator+=operator-=operator&=operator|=operator^=	атомарно складывает, вычитает или выполняет побитовое И, ИЛИ, исключающее ИЛИ с указанным значением (public функция-элемент)

Примечание

Макрос Тестирования функциональности	Значение	Стандарт	Функциональность
__cpp_lib_atomic_ref	201806L	(C++20)	std::atomic_ref

Смотрите также

atomic (C++11)

шаблон класса atomic и его специализации для bool, целочисленных типов и указателей (шаблон класса)