6.53 Встроенные функции для атомарных операций с учётом модели памяти

Следующие встроенные функции приблизительно соответствуют требованиям модели памяти C++11. Все они идентифицируются префиксом ‘__atomic’, и большинство из них перегружены для работы с несколькими типами.

Эти функции предназначены для замены устаревших встроенных функций ‘__sync’. Основное отличие заключается в том, что порядок памяти, который запрашивается, является параметром функций. Новый код всегда должен использовать встроенные функции ‘__atomic’ вместо встроенных функций ‘__sync’.

Обратите внимание, что встроенные функции ‘__atomic’ предполагают, что программы будут соответствовать модели памяти C++11. В частности, они предполагают, что программы не содержат гонок данных. Подробные требования см. в стандарте C++11.

Встроенные функции ‘__atomic’ могут использоваться с любым целочисленным скалярным или указательским типом длиной 1, 2, 4 или 8 байт. 16-байтовые целочисленные типы также разрешены, если ‘__int128’ (см. __int128) поддерживается архитектурой.

Четыре неарифметические функции (load, store, exchange и compare_exchange) также имеют общую версию. Эта общая версия работает с любым типом данных. Она использует встроенную функцию без блокировок, если размер конкретного типа данных позволяет это; в противном случае внешний вызов остается для решения во время выполнения. Этот внешний вызов имеет тот же формат с добавлением параметра ‘size_t’, вставленного в качестве первого параметра, указывающего размер объекта, на который указывает указатель. Все объекты должны иметь одинаковый размер.

Существует 6 различных порядков памяти, которые можно указать. Они соответствуют порядкам памяти C++11 с одинаковыми именами, см. стандарт C++11 или википедию GCC по атомарной синхронизации для подробных определений. Отдельные целевые платформы могут также поддерживать дополнительные порядки памяти для использования на конкретных архитектурах. Подробности см. в документации по целевой платформе.

Атомарная операция может как ограничивать перемещение кода, так и отображаться на аппаратные инструкции для синхронизации между потоками (например, барьер). В какой степени это происходит, контролируется порядками памяти, которые перечислены здесь приблизительно в порядке возрастания силы. Описание каждого порядка памяти предназначено лишь для приблизительного иллюстрации эффектов и не является спецификацией; см. модель памяти C++11 для точного определения семантики.

__ATOMIC_RELAXED

Не предполагает ограничений порядка между потоками.

__ATOMIC_CONSUME

В настоящее время реализуется с использованием более сильного __ATOMIC_ACQUIRE порядка из-за недостатка в семантике C++11 для memory_order_consume.

__ATOMIC_ACQUIRE

Создаёт ограничение «происходит-раньше» между потоками от оператора записи (или более сильного) семантики к этому оператору чтения. Может предотвратить перемещение кода перед операцией.

__ATOMIC_RELEASE

Создаёт ограничение «происходит-раньше» между потоками для операторов чтения с семантикой «приобретение» (или более сильного) семантики, которые читают из этой операции записи с семантикой «выпуск». Может предотвратить опускание кода после операции.

__ATOMIC_ACQ_REL

Объединяет эффекты как __ATOMIC_ACQUIRE, так и __ATOMIC_RELEASE.

__ATOMIC_SEQ_CST

Обеспечивает полную упорядоченность со всеми другими __ATOMIC_SEQ_CST операциями.

Обратите внимание, что в модели памяти C++11, барьеры (например, ‘__atomic_thread_fence’) действуют в сочетании с другими атомарными операциями на конкретных участках памяти (например, атомарными чтениями); операции на конкретных участках памяти не обязательно влияют на другие операции таким же образом.

Архитектуры целевых платформ рекомендуются предоставлять собственные шаблоны для каждой из атомарных встроенных функций. Если целевая платформа не задана, используется исходный набор атомарных встроенных функций ‘__sync’ без учёта модели памяти, а также все необходимые барьеры синхронизации для достижения правильного поведения. Выполнение в этом случае подчиняется тем же ограничениям, что и эти встроенные функции.

Если нет шаблона или механизма для предоставления последовательности инструкций без блокировок, вызов производится во внешнюю процедуру с теми же параметрами для решения во время выполнения.

При реализации шаблонов для этих встроенных функций параметр порядка памяти можно игнорировать, если шаблон реализует наименее строгий __ATOMIC_SEQ_CST порядок памяти. Любой из других порядков памяти выполняется правильно с этим порядком памяти, но они могут не выполняться так эффективно, как с более подходящей реализацией требований к ослаблению.

Обратите внимание, что стандарт C++11 допускает определение параметра порядка памяти во время выполнения вместо времени компиляции. Эти встроенные функции отображают любое значение времени выполнения на __ATOMIC_SEQ_CST вместо вызова библиотеки времени выполнения или вставки инструкции switch. Это соответствует стандарту, безопасно и является простейшим подходом на данный момент.

Параметр порядка памяти — это целое число со знаком, но только младшие 16 бит зарезервированы для порядка памяти. Остальная часть целого числа со знаком зарезервирована для использования целевой платформой и должна быть равна 0. Использование предопределённых атомарных значений гарантирует правильное использование.

Встроенная функция: type __atomic_load_n (type *ptr, int memorder)

Эта встроенная функция реализует атомарную операцию чтения. Она возвращает содержимое *ptr.

Допустимые варианты порядка памяти — __ATOMIC_RELAXED, __ATOMIC_SEQ_CST, __ATOMIC_ACQUIRE, и __ATOMIC_CONSUME.

Встроенная функция: void __atomic_load (type *ptr, type *ret, int memorder)

Это общая версия атомарного чтения. Она возвращает содержимое *ptr в *ret.

Встроенная функция: void __atomic_store_n (type *ptr, type val, int memorder)

Эта встроенная функция реализует атомарную операцию записи. Она записывает val в *ptr.

Допустимые варианты порядка памяти — __ATOMIC_RELAXED, __ATOMIC_SEQ_CST, и __ATOMIC_RELEASE.

Встроенная функция: void __atomic_store (type *ptr, type *val, int memorder)

Это общая версия атомарной записи. Она сохраняет значение *val в *ptr.

Встроенная функция: type __atomic_exchange_n (type *ptr, type val, int memorder)

Эта встроенная функция реализует атомарную операцию обмена. Она записывает val в *ptr, и возвращает предыдущее содержимое *ptr.

Допустимые варианты порядка памяти — __ATOMIC_RELAXED, __ATOMIC_SEQ_CST, __ATOMIC_ACQUIRE, __ATOMIC_RELEASE, и __ATOMIC_ACQ_REL.

Встроенная функция: void __atomic_exchange (type *ptr, type *val, type *ret, int memorder)

Это общая версия атомарного обмена. Она сохраняет содержимое *val в *ptr. Исходное значение *ptr копируется в *ret.

Встроенная функция: bool __atomic_compare_exchange_n (type *ptr, type *expected, type desired, bool weak, int success_memorder, int failure_memorder)

Эта встроенная функция реализует атомарную операцию сравнения и обмена. Сравнивает содержимое *ptr с содержимым *expected. Если равны, операция — чтение-модификация-запись, которая записывает desired в *ptr. Если они не равны, операция — чтение, и текущее содержимое *ptr записывается в *expected. weak — true для слабого compare_exchange, который может ложно завершиться, и false для сильного варианта, который никогда не ложно завершается. Многие целевые платформы предлагают только сильный вариант и игнорируют параметр. В случае сомнений используйте сильный вариант.

Если desired записано в *ptr, возвращается true и память затрагивается в соответствии с порядком памяти, указанным в success_memorder. Нет ограничений на порядок памяти, который можно использовать здесь.

В противном случае возвращается false и память затрагивается в соответствии с failure_memorder. Этот порядок памяти не может быть __ATOMIC_RELEASE ни __ATOMIC_ACQ_REL. Он также не может быть более сильным, чем указанный в success_memorder.

Встроенная функция: bool __atomic_compare_exchange (type *ptr, type *expected, type *desired, bool weak, int success_memorder, int failure_memorder)

Эта встроенная функция реализует общую версию __atomic_compare_exchange. Функция практически идентична __atomic_compare_exchange_n, за исключением того, что желаемое значение также является указателем.

Встроенная функция: type __atomic_add_fetch (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_sub_fetch (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_and_fetch (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_xor_fetch (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_or_fetch (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_nand_fetch (type *ptr, type val, int memorder)

Эти встроенные функции выполняют операцию, указанную в имени, и возвращают результат операции. Операции с указательнымы аргументами выполняются так, как если бы операнды были типа uintptr_t. То есть они не масштабируются размером типа, на который указывает указатель.

{ *ptr op= val; return *ptr; }

Объект, на который указывает первый аргумент, должен быть целочисленного или указательского типа. Он не должен быть булевым типом. Все порядки памяти допустимы.

Встроенная функция: type __atomic_fetch_add (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_fetch_sub (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_fetch_and (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_fetch_xor (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_fetch_or (type *ptr, type val, int memorder)

Встроенная функция: type __atomic_fetch_nand (type *ptr, type val, int memorder)

Эти встроенные функции выполняют операцию, предложенную именем, и возвращают значение, которое ранее находилось в *ptr. Операции с указателями-аргументами выполняются так, как будто операнды были типа uintptr_t. То есть они не масштабируются размером типа, на который указывает указатель.

{ tmp = *ptr; *ptr op= val; return tmp; }

Применяются те же ограничения к аргументам, что и для соответствующих __atomic_op_fetch встроенных функций. Все порядки памяти допустимы.

Встроенная функция: bool __atomic_test_and_set (void *ptr, int memorder)

Эта встроенная функция выполняет атомную операцию проверки и установки для байта по адресу *ptr. Байт устанавливается в некоторое определённое реализацией ненулевое значение “установки”, а возвращаемое значение равно true, если и только если предыдущее содержимое было “установлено”. Она должна использоваться только для операндов типа bool или char. Для других типов может быть установлена только часть значения.

Все порядки памяти допустимы.

Встроенная функция: void __atomic_clear (bool *ptr, int memorder)

Эта встроенная функция выполняет атомную операцию очистки для *ptr. После операции, *ptr содержит 0. Она должна использоваться только для операндов типа bool или char, и в сочетании с __atomic_test_and_set. Для других типов она может очистить только частично. Если тип не bool, предпочтительно использовать __atomic_store.

Допустимые варианты порядка памяти __ATOMIC_RELAXED, __ATOMIC_SEQ_CST, и __ATOMIC_RELEASE.

Встроенная функция: void __atomic_thread_fence (int memorder)

Эта встроенная функция действует как барьер синхронизации между потоками на основе заданного порядка памяти.

Все порядки памяти допустимы.

Встроенная функция: void __atomic_signal_fence (int memorder)

Эта встроенная функция действует как барьер синхронизации между потоком и обработчиками сигналов в рамках того же потока.

Все порядки памяти допустимы.

Встроенная функция: bool __atomic_always_lock_free (size_t size, void *ptr)

Эта встроенная функция возвращает true, если объекты размером size байт всегда генерируют атомарные инструкции без блокировок для целевой архитектуры. size должен быть константой времени компиляции, и результат также должен быть константой времени компиляции.

ptr — необязательный указатель на объект, который может быть использован для определения выравнивания. Значение 0 означает, что должно использоваться типичное выравнивание. Компилятор также может проигнорировать этот параметр.

if (__atomic_always_lock_free (sizeof (long long), 0))

Встроенная функция: bool __atomic_is_lock_free (size_t size, void *ptr)

Эта встроенная функция возвращает true, если объекты размером size байт всегда генерируют атомарные инструкции без блокировок для целевой архитектуры. Если известно, что встроенная функция не является безблокировочной, вызывается функция времени выполнения с именем __atomic_is_lock_free.

ptr — необязательный указатель на объект, который может быть использован для определения выравнивания. Значение 0 означает, что должно использоваться типичное выравнивание. Компилятор также может проигнорировать этот параметр.

Далее: Встроенные функции для переполнения целых чисел, Предыдущее: __sync Встроенные функции, Вверх: Расширения C [Содержание][Индекс]