Skip to content

Latest commit

 

History

History
172 lines (125 loc) · 8.69 KB

attributes.md

File metadata and controls

172 lines (125 loc) · 8.69 KB
Raw

属性構文

  • cpp11[meta cpp]

概要

属性(attributes)は、ソースコードに対して追加の情報をコンパイラに伝えるための構文である。

属性は[[attr]]のように、属性のリストを二重角カッコで囲んで指定する。C++11時点の標準では、以下の2つの属性を定義する：

  1. [[noreturn]] : 関数が決して返らないことをコンパイラに伝える
  2. [[carries_dependency]] : データの依存性を持たせる or 維持する

仕様

  • 属性はクラス、変数、関数、パラメータ、列挙型、型の別名などあらゆる場所に指定できるが、指定できる場所は属性ごとに異なる。ここでは属性構文をどこに適用できるかは列挙せず、各属性がどこに指定できるかを以下の節で示す。
  • ユーザーは任意の属性を定義できない。属性の定義は、標準およびベンダーが行う。

[[noreturn]]属性

[[noreturn]]は、関数が決して返らないことを示すための属性である。

この属性を指定することで、「関数が返らない」という情報を使用してコンパイラが任意の最適化を行える。また、返らない処理をラップした関数に[[noreturn]]属性を付けることで、「関数が返らないパスが存在する」というコンパイラからの警告を抑制するためにも使用できる：

#include <stdexcept>

[[noreturn]] void report_error()
{
  throw std::runtime_error("error");
}

int f(int x)
{
  if (x > 0) {
    return x;
  }
  report_error();
}

int main()
{
  f(1);
}

このプログラムにおいて、関数f()は条件によってエラーを出力する。関数f()で直接例外を送出するような場合にはコンパイラは警告を出力しないが、例外送出をラップしたreport_error()のような関数を定義して呼び出す場合、コンパイラはその関数が返らないことを認識できない。そのため、report_error()の後ろに決して実行されることのないreturn文を書かない限り、コンパイラは「このパスにreturn文が書かれていない」という警告を出力する。

そのような状況で、例外送出やstd::exit()、std::abort()の呼び出しをラップした関数に[[noreturn]]を付けることで、そのようなコンパイラの警告を抑制できる。

[[noreturn]]属性を付けて宣言した関数がほかの翻訳単位で[[noreturn]]属性を付けずに宣言された場合、プログラムは不適格となる。

[[noreturn]]属性を付けた関数が返った場合、その動作は未定義。

[[carries_dependency]]属性

[[carries_dependency]]は、並行プログラミングのアトミック操作において、値に依存した順序付け memory_orderを、関数をまたいで伝播することを明示するための属性である。

以下は、memory_order_consumeを使用した順序付けの例である：

atomic<T*> x = …;
T* r1 = x.load(memory_order_consume);

// 以下のコードはr1の値に依存しているため、実行順序が保証される
if (r1) {
  T r2 = *r1 + 1;
  T r3 = r2 + 1;
}
  • atomic[link /reference/atomic/atomic.md]
  • x.load[link /reference/atomic/atomic/load.md]
  • memory_order_consume[link /reference/atomic/memory_order.md]

ここでは、r1に関連する操作が全て同一関数内で行われているが、一部の操作が別の関数になっていると、別の関数になった操作に値の依存があるかどうか・依存として扱ってよいのかどうかがコンパイラに判断できない可能性がある。そのような状況で、関数のパラメータおよび戻り値のそれぞれが値の依存性を伝播させることを明示するために[[carries_dependency]]属性を使用する。

関数の戻り値で値の依存性を伝播させる

関数の戻り値に対して値の依存性を持たせる場合、関数に対して[[carries_dependency]]属性を付加する。

atomic<T*> x = …;
[[carries_dependency]] T* f()
{
  return x.load(memory_order_consume);
}

T* r1 = f();
if (r1) {
  T r2 = *r1 + 1;
  T r3 = r2 + 1;
}
  • atomic[link /reference/atomic/atomic.md]
  • x.load[link /reference/atomic/atomic/load.md]
  • memory_order_consume[link /reference/atomic/memory_order.md]

関数のパラメータで値の依存性を伝播させる

関数のパラメータに対して値の依存性を持たせる場合、各パラメータ名のうしろに[[carries_dependency]]属性を付加する。

void f(T* r1 [[carries_dependency]])
{
  T r2 = *r1 + 1;
  T r3 = r2 + 1;
}

void g(T* r1 [[carries_dependency]])
{
  // …
}

atomic<T*> x = …;
T* r1 = x.load(memory_order_consume);

// 関数f()と関数g()の呼び出し、およびその関数内の操作が、
// r1に依存した操作であるとして実行順序が保証される
if (r1)
  f(r1);
else
  g(r1);
  • atomic[link /reference/atomic/atomic.md]
  • x.load[link /reference/atomic/atomic/load.md]
  • memory_order_consume[link /reference/atomic/memory_order.md]

[[carries_dependency]]属性を付けて宣言した関数がほかの翻訳単位で[[carries_dependency]]属性を付けずに宣言された場合、プログラムは不適格となる。

[[carries_dependency]]の反対に、値の依存性を断ち切るkill_dependency()関数も定義されている。

この機能が必要になった背景・経緯

属性構文はこれまで各ベンダーが独自の構文でサポートしていた。GNUでは__attribute__(())、Microsoftでは__declspec()という構文を使用していた。

コンパイラに対してヒントを与える属性構文の必要性が標準C++に認識されたために、統一的な構文を標準で定義することとなった。

C++11で採用されたもの以外で検討された以下の機能は、属性ではなく言語の構文としてサポートされた：

  • アライメントを指定するalign属性
    • アライメントを指定するalignas、アライメントを取得するalignof機能として導入された
  • 変数にスレッドローカルストレージを使用することを指示するthread_local属性
  • これ以上継承しない、これ以上オーバーライドしないことを明示するfinal属性
    • 文脈依存キーワードfinalとして導入された

以下の属性は、C++11時点では採用されていない：

  • 関数が同じ引数に対して同じ戻り値を返すことを明示するpure属性
  • if文やswitch文のcaseに指定する条件式のヒット率が高いことを指示するprobably属性
  • 関数が非推奨であることを指示するdeprecated属性
  • 基底クラスによって関数を隠蔽しないことを明示するnot_hiding属性
  • ポインタの所有者(解放する責任を持つユーザー)であることを明示するowner属性

関連項目

参照