Skip to content

Latest commit

 

History

History
153 lines (114 loc) · 7.23 KB

launder.md

File metadata and controls

153 lines (114 loc) · 7.23 KB
Raw

launder

  • new[meta header]
  • function template[meta id-type]
  • std[meta namespace]
  • cpp17[meta cpp]
namespace std {
  template <class T>
    constexpr T* launder(T* p) noexcept; // C++17

  template<class T>
    [[nodiscard]] constexpr T* launder(T* p) noexcept; // C++20
}

概要

placement new構文を使用して、参照型やconstメンバ変数を含む構造体/クラスのオブジェクトを再構築するケースで、オブジェクト生存期間(lifetime)に基づいた最適化の抑止をコンパイラに伝える関数。 適切にstd::launder()を用いることで、ポインタ値の直接利用が未定義動作となってしまう文脈において、参照型やconstメンバ変数への安全なアクセスが可能となる。

要件

  • ポインタの引数pは、メモリ内の1バイトのアドレス A を表す。
  • オブジェクト X は、アドレス A にある。
  • オブジェクト X は、生存期間(lifetime)内にある。
  • オブジェクト X の型が T に類似(similar)している。言い換えると、オブジェクト X の型と T それぞれで、全てのレベルのcv修飾を除去した型が等しい。（例: const int * const *とint**は類似した型）
  • 結果を通して到達可能であるであろう記憶域のすべてのバイトはpを通して到達可能である。

注：「到達可能」について、ストレージの1バイトは、オブジェクトYがYによって占有されているストレージ内にある場合はオブジェクトYを指すポインタ値、Yが配列要素の場合は直接囲む配列オブジェクトを介して到達可能である。

戻り値

オブジェクト X を指す T* 型の値。

備考

この関数の呼び出しは、その引数の値がコア定数式で使用される場合はいつでもコア定数式で使用されることがある。また、T が関数型 ないし （cv修飾された）void の場合、プログラムは不適格である。

一般に、オブジェクトの存続期間が終了した後、そのオブジェクトが占有していたストレージが再利用または解放される前に元のオブジェクトが占有していた記憶域に新規オブジェクトが登録された場合（placement new構文を使った際）、元のオブジェクトを指すポインタ、元のオブジェクトを指す参照または元のオブジェクトの名前は自動的に新しいオブジェクトを参照する。新しいオブジェクトの有効期間が開始されると、次の場合に新しいオブジェクトを操作できる。それ以外の場合は未定義動作を引き起こす。

  • 新しいオブジェクト用の記憶域は、元のオブジェクトが占めていた記憶域を正確にオーバーレイする。
  • 新しいオブジェクトは元のオブジェクトと同じ型である（最上位の cv 修飾子は無視される）。
  • 元のオブジェクトの型がconst修飾ではなく、クラス型の場合は、型がconst修飾または参照型の非静的メンバ変数を含まない。
  • 元のオブジェクトも新しいオブジェクトも、潜在的に重複するサブオブジェクト(potentially-overlapping subobject)ではない。

注：サブオブジェクトとは、あるオブジェクトに含まれている非staticメンバ変数、 基底クラス及び基底クラスのサブオブジェクト、または配列要素、のそれぞれのオブジェクトのことである。

注：潜在的に重複するサブオブジェクト(potentially-overlapping subobject)とは、基底クラスのサブオブジェクト、または no_unique_address 属性(C++20)で宣言された非静的メンバ変数のいずれかである。

注：基底クラスのサブオブジェクトについて、以下の例ではクラスDerived2のオブジェクトは、クラスDerivedのサブオブジェクト（b及びBase）を持ち、そのサブオブジェクトはクラスBaseのサブオブジェクト（a, b, c）を持つ。

struct Base {
  int a, b, c;
};

struct Derived : Base {
  int b;
};

struct Derived2 : Derived {
  int c;
};

以下は、新しいオブジェクトを操作できる場合の例である。

struct C {
  int i;
  void f();
  const C& operator=( const C& );
};

const C& C::operator=( const C& other) {
  if ( this != &other ) {
    this->~C();                 // *this の生存期間(lifetime)の終了
    new (this) C(other);        // C型の新しいオブジェクトの生成
    f();                        // well-defined
  }
  return *this;
}

C c1;
C c2;
c1 = c2;                        // well-defined
c1.f();                         // well-defined; c1はC型の新しいオブジェクトを参照しています

上記の条件が満たされない場合でも、ポインタ値に対してstd::launder関数を通すことによって、新しいオブジェクトを指すアドレスとして安全に扱えるようになる。

つまり、placement new使用時は、std::launderを使用することによって未定義動作を避けることができる。

例

#include <new>

int main()
{
  struct X { const int n; };
  X *p = new X{3};
  const int a = p->n;
  new (p) X{5};                       // X::nがconstであるため、pは新しいオブジェクトを指さない
  const int b = p->n;                 // 未定義動作
  const int c = std::launder(p)->n;   // OK
}
  • launder[color ff0000]

出力

メンバのサブオブジェクトについて、次に示した。サブオブジェクトに参照メンバまたはconstサブオブジェクトが含まれる場合、元のサブオブジェクトの名前を使用して新しいオブジェクトにアクセスするためには、std::launderを使用する。

struct X { const int n; };
union U { X x; float f; };
void tong() {
  U u = {{ 1 }};
  u.f = 5.f;                            // OK, u の新しいサブオブジェクトを生成
  X *p = new (&u.x) X {2};              // OK, u の新しいサブオブジェクトを生成
  assert(p->n == 2);                    // OK
  assert(*std::launder(&u.x.n) == 2);   // OK
  assert(u.x.n == 2);                   // 未定義動作, u.xは 新しいサブオブジェクトを指定しない
}
  • launder[color ff0000]

バージョン

言語

  • C++17

処理系

  • Clang: 6.0.0 [mark verified]
  • GCC: 7.1.0 [mark verified]
  • ICC: ??
  • Visual C++: 2017 update 7 [mark verified]

関連項目

参照