std::atomic

来自cppreference.com
< cpp‎ | atomic
 
 
 
 
定义于头文件 <atomic>
template< class T >
struct atomic;
(1) (C++11 起)
template< class T >
struct atomic<T*>;
(2) (C++11 起)
定义于头文件 <memory>
template<class T>
struct atomic<std::shared_ptr<T>>;
(3) (C++20 起)
template<class T>
struct atomic<std::weak_ptr<T>>;
(4) (C++20 起)

每个 std::atomic 模板的实例化和全特化定义一个原子类型。若一个线程写入原子对象,同时另一线程从它读取,则行为良好定义(数据竞争的细节见内存模型)。

另外,对原子对象的访问可以建立线程间同步,并按 std::memory_order 所对非原子内存访问定序。

std::atomic 既不可复制亦不可移动。

目录

[编辑] 特化

[编辑] 初等模板

初等 std::atomic 模板可以任何可平凡复制 (TriviallyCopyable) 类型 T 实例化:

struct Counters { int a; int b; }; // 用户定义可平凡复制类型
std::atomic<Counters> cnt;         // 用户定义类型的特化

std::atomic<bool> 使用初等模板。它保证是标准布局结构体。

[编辑] 部分特化

标准库为下列类型提供 std::atomic 模板的特化,它们拥有初等模板所不拥有的额外属性:

2) 对所有指针类型的部分特化 std::atomic<T*> 。这些特化拥有标准布局、平凡默认构造函数和平凡析构函数。除了为所有原子类型提供的操作,这些特化额外支持适合指针类型的原子算术运算,例如 fetch_addfetch_sub

3-4) 为 std::shared_ptrstd::weak_ptr 提供部分特化 std::atomic<std::shared_ptr<T>>std::atomic<std::weak_ptr<T>>

细节见 std::atomic<std::shared_ptr>std::atomic<std::weak_ptr>

(C++20 起)

[编辑] 对整数类型的特化

以下列整数类型之一实例化时, std::atomic 提供适合于整数类型的额外原子操作,例如 fetch_addfetch_subfetch_andfetch_orfetch_xor

  • 字符类型 charchar16_tchar32_twchar_t
  • 标准有符号整数类型: signed charshortintlonglong long
  • 标准无符号整数类型: unsigned charunsigned shortunsigned intunsigned longunsigned long long
  • 任何头文件 <cstdint> 中的 typedef 所需的额外整数类型。

另外,结果的 std::atomic<Integral> 特化拥有标准布局、平凡默认构造函数和平凡析构函数。定义有符号整数算术为使用补码;无未定义结果。

对浮点类型的特化

以浮点类型 floatdoublelong double 之一实例化时, std::atomic 提供适合于浮点类型的额外原子操作,例如 fetch_addfetch_sub

另外,结果的 std::atomic<Floating> 特化拥有标准布局、平凡默认构造函数和平凡析构函数。

无操作导致未定义行为,即使结果不能以浮点类型表示。有效的浮点环境可能不同于调用方线程的浮点环境。

(C++20 起)

[编辑] 类型别名

bool 和所有上面列出的整数类型提供如下类型别名:

类型别名 定义
std::atomic_bool std::atomic<bool>
std::atomic_char std::atomic<char>
std::atomic_schar std::atomic<signed char>
std::atomic_uchar std::atomic<unsigned char>
std::atomic_short std::atomic<short>
std::atomic_ushort std::atomic<unsigned short>
std::atomic_int std::atomic<int>
std::atomic_uint std::atomic<unsigned int>
std::atomic_long std::atomic<long>
std::atomic_ulong std::atomic<unsigned long>
std::atomic_llong std::atomic<long long>
std::atomic_ullong std::atomic<unsigned long long>
std::atomic_char16_t std::atomic<char16_t>
std::atomic_char32_t std::atomic<char32_t>
std::atomic_wchar_t std::atomic<wchar_t>
std::atomic_int8_t std::atomic<std::int8_t>
std::atomic_uint8_t std::atomic<std::uint8_t>
std::atomic_int16_t std::atomic<std::int16_t>
std::atomic_uint16_t std::atomic<std::uint16_t>
std::atomic_int32_t std::atomic<std::int32_t>
std::atomic_uint32_t std::atomic<std::uint32_t>
std::atomic_int64_t std::atomic<std::int64_t>
std::atomic_uint64_t std::atomic<std::uint64_t>
std::atomic_int_least8_t std::atomic<std::int_least8_t>
std::atomic_uint_least8_t std::atomic<std::uint_least8_t>
std::atomic_int_least16_t std::atomic<std::int_least16_t>
std::atomic_uint_least16_t std::atomic<std::uint_least16_t>
std::atomic_int_least32_t std::atomic<std::int_least32_t>
std::atomic_uint_least32_t std::atomic<std::uint_least32_t>
std::atomic_int_least64_t std::atomic<std::int_least64_t>
std::atomic_uint_least64_t std::atomic<std::uint_least64_t>
std::atomic_int_fast8_t std::atomic<std::int_fast8_t>
std::atomic_uint_fast8_t std::atomic<std::uint_fast8_t>
std::atomic_int_fast16_t std::atomic<std::int_fast16_t>
std::atomic_uint_fast16_t std::atomic<std::uint_fast16_t>
std::atomic_int_fast32_t std::atomic<std::int_fast32_t>
std::atomic_uint_fast32_t std::atomic<std::uint_fast32_t>
std::atomic_int_fast64_t std::atomic<std::int_fast64_t>
std::atomic_uint_fast64_t std::atomic<std::uint_fast64_t>
std::atomic_intptr_t std::atomic<std::intptr_t>
std::atomic_uintptr_t std::atomic<std::uintptr_t>
std::atomic_size_t std::atomic<std::size_t>
std::atomic_ptrdiff_t std::atomic<std::ptrdiff_t>
std::atomic_intmax_t std::atomic<std::intmax_t>
std::atomic_uintmax_t std::atomic<std::uintmax_t>

注意: std::atomic_intN_tstd::atomic_uintN_tstd::atomic_intptr_tatomic_uintptr_t 分别若且唯若定义了 std::intN_tstd::uintN_tstd::intptr_tstd::uintptr_t 才有定义。

[编辑] 成员类型

成员类型 定义
value_type 见下方
difference_type value_type (仅对 atomic<Integral> 和 atomic<Floating> (C++20 起) 特化)
std::ptrdiff_t (仅对 atomic<T*> 特化)

对于每个 std::atomic<X> (无论是否特化), std::atomic<X>::value_typeX

difference_type 不在初等 atomic 模板中,或不在对 std::shared_ptrstd::weak_ptr 的部分特化中定义。

[编辑] 成员函数

构造原子对象
(公开成员函数) [编辑]
存储值于原子对象
(公开成员函数) [编辑]
检查原子对象是否免锁
(公开成员函数) [编辑]
原子地以非原子对象替换原子对象的值
(公开成员函数) [编辑]
原子地获得原子对象的值
(公开成员函数) [编辑]
从原子对象加载值
(公开成员函数) [编辑]
原子地替换原子对象的值并获得它先前持有的值
(公开成员函数) [编辑]
原子地比较原子对象与非原子参数的值,若相等则进行交换,若不相等则进行加载
(公开成员函数) [编辑]

常量

[静态] (C++17)
指示该类型是否始终免锁
(公开静态成员常量) [编辑]

[编辑] 特化成员函数

原子地将参数加到存储于原子对象的值,并返回先前保有的值
(公开成员函数) [编辑]
原子地从存储于原子对象的值减去参数,并获得先前保有的值
(公开成员函数) [编辑]
原子地进行参数和原子对象的值的逐位与,并获得先前保有的值
(公开成员函数) [编辑]
原子地进行参数和原子对象的值的逐位或,并获得先前保有的值
(公开成员函数) [编辑]
原子地进行参数和原子对象的值的逐位异或,并获得先前保有的值
(公开成员函数) [编辑]
令原子值增加或减少一
(公开成员函数) [编辑]
加、减,或与原子值进行逐位与、或、异或
(公开成员函数) [编辑]

[编辑] 注意

存在等价于 std::atomic 所有成员函数的非成员函数模板。这些非成员函数可以额外对非 std::atomic 特化的类型重载,但不能保证原子性。标准库中仅有的这种类型是 std::shared_ptr<T>

[编辑] 缺陷报告

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

DR 应用于 出版时的行为 正确行为
LWG 2441 C++11 添加了(可选)定宽整数类型的特化
P0558R1 C++11 实质上重写了规定以解决数个问题

[编辑] 参阅

免锁的布尔原子类型
(类) [编辑]

[编辑] 引用

  • C++11 standard (ISO/IEC 14882:2011):
  • 29.5 Atomic types [atomics.types.generic]