5. atomic_compare_exchange_weak_explicit

最終更新日時(UTC):
が更新

履歴 編集

function template
<memory>

std::atomic_compare_exchange_weak_explicit(C++11)(C++20で非推奨)

namespace std {
  template<class T>
  bool atomic_compare_exchange_weak_explicit(
         shared_ptr<T>* p, shared_ptr<T>* expected, shared_ptr<T> desired,
         memory_order success, memory_order failure);
}

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

概要

メモリオーダーを指定して、弱い比較で、アトミックにshared_ptrオブジェクトを入れ替える。

要件

効果

現在の値pとexpectedが等しければ、*pをdesiredで置き換え、そうでなければ*pを*expectedで置き換える。

等しい場合はsuccessメモリオーダー、そうでなければfailureメモリオーダーに従って、アトミックに値の置き換えが行われる。

戻り値

*pと*expectedが等しければtrue、そうでなければfalseを返す。

例外

投げない

備考

等値比較は、2つのshared_ptrオブジェクトが同じポインタを保持し、リソースを共有していればtrueとなる。

非推奨・削除の詳細

この関数はフリー関数であるため、この関数によってアトミックにアクセスする対象となる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(new int(1));

  std::shared_ptr<int> ps = p;
  std::shared_ptr<int> q(new int(3));
  while (!std::atomic_compare_exchange_weak_explicit(
          &p, &ps, q,
          std::memory_order_acq_rel,
          std::memory_order_relaxed)) {}

  std::shared_ptr<int> result = std::atomic_load(&p);
  std::cout << *result << std::endl;
}

出力

3

バージョン

言語

  • C++11

処理系

参照