最終更新日時(UTC): 2024年09月03日 06時17分49秒
Akira Takahashi が更新

履歴 編集

function template
<memory>

# std::atomic_store(C++11)(C++20で非推奨)(C++26で削除)

    namespace std {
      template <class T>
      void atomic_store(shared_ptr<T>* p, shared_ptr<T> r);
    }

この関数は、C++20から非推奨となり、C++26で削除された。アトミックアクセスの対象としている`shared_ptr`を`shared_ptr`に対する`atomic`特殊化で置き換えることで同等の機能を使用できる。

## 概要

`shared_ptr`オブジェクトに、アトミックに値を書き込む。

## 要件

`p != nullptr`であること。

## 効果

    atomic_store_explicit(p, r, memory_order_seq_cst)

## 戻り値

なし

## 例外

投げない

## 非推奨・削除の詳細

この関数はフリー関数であるため、この関数によってアトミックにアクセスする対象となる`shared_ptr`オブジェクトそのものはどこかに配置されている非アトミックオブジェクトである。そのため、アトミックアクセスしたい文脈の外側から通常のアクセスが可能であり、もし別のスレッドからそのようなアクセスが行われているとこの関数を用いていてもデータ競合を引き起こし未定義動作を引き起こす。

すなわち、アトミックにアクセスしたい`shared_ptr`オブジェクトに対する全てのアクセスをプログラマがきちんと管理しなければこの関数の使用は安全ではなく、それはかなり困難であったためこの関数は危険な利用がデフォルトとなっていた。

そのため、この関数（とそのファミリ）は非推奨とされ、代わりに`shared_ptr`に対する`atomic`特殊化が追加された。`shared_ptr`に対する`atomic`特殊化を利用すれば、アトミックにアクセスする対象となる`shared_ptr`オブジェクトそのものをアトミックオブジェクトとすることができるため、どこからアクセスしたとしても全てのアクセスは自動的にアトミックアクセスとなり、前述の問題は回避できる。

この関数から`shared_ptr`に対する`atomic`特殊化に移行する場合は、元のコードでアトミックアクセス対象となっていた`shared_ptr`オブジェクトの型を`std::atomic<std::shared_ptr>`に変更することで移行でき、その場合は`atomic`のために用意されているフリー関数が代わりに使用される（宣言されているヘッダが異なるため、`<atomic>`ヘッダのインクルードが必要となるかもしれない）。

## 例

    #include <iostream>
    #include <memory>

    int main()
    {
      std::shared_ptr<int> p;

      // pにxをアトミックに書き込む
      std::shared_ptr<int> x(new int(3));
      std::atomic_store(&p, x);

      // pが指すshared_ptrオブジェクトを、アトミックに読み込む
      std::shared_ptr<int> result = std::atomic_load(&p);
      std::cout << *result << std::endl;
    }

### 出力

    3

## バージョン

### 言語

- C++11

### 処理系

- Clang: 3.3 ✅
- GCC: 5.0 ✅
- ICC: ??
- Visual C++: 2012 ✅, 2013 ✅

## 参照

- `atomic_store() - <atomic>`
- N2674 Shared_ptr atomic access, revision 1
- C++0x Shared_ptr atomic access - Faith and Brave - C++で遊ぼう
- P0718R2 Revising `atomic_shared_ptr` for C++20
- P2869R4 Remove Deprecated `shared_ptr` Atomic Access APIs from C++26