std::atomic(C++11)

namespace std {
  template<class T> struct atomic;          // (1) C++11

  template<> struct atomic<integral>;       // (2) C++11
  template<> struct atomic<floating-point>; // (3) C++20
  template<class T> struct atomic<T*>;      // (4) C++11
}

概要

atomicクラステンプレートは、型Tをアトミック操作するためのクラステンプレートである。組み込み型に対する特殊化が提供されており、それぞれに特化した演算が用意されている。

• (1) : プライマリテンプレート。宣言のみ
• (2) : 整数型に対する特殊化
• (3) : (CV修飾されていない) 浮動小数点数型に対する特殊化
  • (C++23) : 拡張浮動小数点数型を含む
• (4) : 任意の型のポインタに対する特殊化

これらのほか、<memory>ヘッダでstd::shared_ptrとstd::weak_ptrに対するatomicクラスの特殊化が定義される。

テンプレートパラメータ制約

• 型Tはコピー構築可能かつコピー代入可能であること
• 以下のいずれかがfalseである場合、プログラムは不適格となる：
  • is_trivially_copyable_v<T>
    • 簡潔に言うと、memcpy()可能な型であること
  • is_copy_constructible_v<T>
  • is_move_constructible_v<T>
  • is_copy_assignable_v<T>
  • is_move_assignable_v<T>
  • C++26: same_as<T, remove_cv_t<T>>
    • CV修飾されたTは許可しない

別名型

特殊化された整数型およびbool型には、それぞれatomic_Tという型の別名が提供される。

浮動小数点数型に対する別名は定義されていない。

また、<cstdint>で定義される整数型に対する以下の別名も提供される。

以下の整数型に対する別名は、整数型に対するatomic型の特殊化だが、その中でも以下の特性を持つものである：

• is_always_lock_freeプロパティがtrueである
• wait/notify操作が最も効率的に行える整数アトミック型

ただし、フリースタンディング環境において、これらの型は定義されない場合がある。

<cstdint>で定義される整数型に対する以下の別名は、元の整数型が定義される場合のみ定義される。

メンバ関数

共通メンバ関数

共通メンバ型

共通メンバ定数

is_always_lock_free == trueの場合、このクラスのオブジェクトをシグナルハンドラー内で使用できる。

atomic<integral>専用メンバ関数

整数型に対する特殊化。

atomic<integral>専用メンバ型

atomic<floating-point>専用メンバ関数

浮動小数点数型に対する特殊化。

atomic<floating-point>専用メンバ型

atomic<T*>専用メンバ関数

ポインタ型に対する特殊化。

atomic<T*>専用メンバ型

例

// スピンロックの実装
// Boost Atomic Library - Usage Example
// http://www.boost.org/doc/libs/1_53_0/doc/html/atomic/usage_examples.html#boost_atomic.usage_examples.example_spinlock

#include <iostream>
#include <atomic>
#include <thread>
#include <mutex>

class spinlock {
private:
  enum LockState {Locked, Unlocked};
  std::atomic<LockState> state_;

public:
  spinlock() : state_(Unlocked) {}

  void lock()
  {
    // 現在の状態をLockedと入れ替える
    while (state_.exchange(Locked, std::memory_order_acquire) == Locked) {
      // busy-wait...アンロックされるまで待機
    }
  }

  void unlock()
  {
    // 値をUnlockedに更新
    state_.store(Unlocked, std::memory_order_release);
  }
};

namespace {
  spinlock lock;
}

template <class T>
void print(const T& x)
{
  std::lock_guard<spinlock> lk(lock);
  std::cout << x << std::endl;
}

void f()
{
  print(1);
}

void g()
{
  print(2);
}

int main()
{
  std::thread t1(f);
  std::thread t2(g);

  t1.join();
  t2.join();
}

出力例

2
1

バージョン

言語

• C++11

処理系

• Clang: 3.2 ✅
• GCC: 4.7.0 ✅
• Visual C++: 2012 ✅, 2013 ✅

備考

• GCC 4.9.2まで、アライメントがおかしくなってセグメンテーションフォルトになるバグがあった。GCC 5.1で修正された。(Bug 65147)

関連項目

• std::shared_ptrとstd::weak_ptrに対するatomicクラスの特殊化

参照

• N2145 C++ Atomic Types and Operations
• N2547 Allow atomics use in signal handlers
• アトミックオブジェクトを含むクラスのコピーとムーブ - Faith and Brave - C++で遊ぼう
• LWG Issue 2441. Exact-width atomic typedefs should be provided
• P0558R1 Resolving atomic<T> named base class inconsistencies
• P0152R1 constexpr atomic<T>::is_always_lock_free
• P0020R6 Floating Point Atomic
• LWG Issue 3045. atomic doesn't have value_type or difference_type
• LWG Issue 3012. atomic is unimplementable for non-is_trivially_copy_constructible T
• Correctly implementing a spinlock in C++
• P1135R6 The C++20 Synchronization Library
  • C++20でのatomic_signed_lock_freeとatomic_unsigned_lock_freeの追加
• P1467R9 Extended floating-point types and standard names
  • C++23で拡張浮動小数点数型もテンプレート引数として指定することが許可された
• P3323R1 cv-qualified types in atomic and atomic_ref
  • C++26でCV修飾されたテンプレートパラメータが明確に禁止された