namespace std {
  template <class Allocator>
  class basic_stacktrace;

  using stacktrace = basic_stacktrace<allocator<stacktrace_entry>>;

  namespace pmr {
    using stacktrace = basic_stacktrace<polymorphic_allocator<stacktrace_entry>>;
  }
}

概要

basic_stacktraceは、現在位置からその関数がどこで呼び出されたかの履歴を取得するためのクラスである。この機能は、デバッグに役立つ。

プラットフォームごとのデフォルトのアサーション機能は、その失敗時にバグの全体像を説明できないため、問題を特定するために十分な情報を提供しない。このクラスを使用することで、ユーザーはデバッグのために必要十分な情報を任意に取得できる。

このクラスは、アロケータ対応コンテナ、シーケンスコンテナ、逆順コンテナの要件を満たす。ただし、

• const修飾されたコンテナに対して定義されたムーブ、代入、swap、および操作のみがサポートされる
• 比較関数のセマンティクスはコンテナのものと異なる

備考

• このクラスは、仕様としてシグナル安全ではない
  • 元となったBoost.Stacktraceライブラリの実装はシグナルハンドラ中でもスタックトレースを出力できる機能を提供するが、標準の本機能はその機能を提供しない
  • そのような機能は一部のプラットフォームでは実装できないためである
  • ただし、実装がシグナル安全である場合がある
    • GCC (libstdc++) が内部で使用しているlibbacktraceライブラリは、シグナル安全である。ただしlibstdc++の実装仕様としてシグナル安全であるという明記はない

メンバ関数

構築・破棄

アロケータ

イテレータ

領域

要素アクセス

変更

静的メンバ関数

メンバ型

非メンバ関数

値の入れ替え

入出力

文字列への変換

比較演算子

ハッシュサポート

文字列フォーマットサポート

例

基本的な使い方

#include <iostream>
#include <stacktrace>

void g() {
  std::cout << std::stacktrace::current() << std::endl;
}

void f() {
  g();
}

int main() {
  f();
}

出力例 (GCC)

   0#  g() at /app/example.cpp:5
   1#  f() at /app/example.cpp:10
   2# main at /app/example.cpp:14
   3#      at :0
   4# __libc_start_main at :0
   5# _start at :0
   6# 

スタックトレースを出力するアサーションマクロを作る

#include <iostream>
#include <cstdint>
#include <stacktrace>
#include <cstdlib>

void assertion_failed(char const* expr) {
  auto st = std::stacktrace::current(1, 1);
  std::stacktrace_entry info = st[0];
  std::cerr << "Expression '" << expr << "' is false in " << info << std::endl;
  std::abort();
}

#define MY_ASSERT(expr) if (!(expr)) assertion_failed(#expr)

void f(int i) {
  MY_ASSERT(i >= 0);
}

int main() {
  f(-1);
}

出力例 (GCC)

Expression 'i >= 0' is false in f(int) at /app/example.cpp:15

バージョン

言語

• C++23

処理系

• Clang: 18 ❌
• GCC: 12 ✅
• Visual C++: 2022 Update 4 ⭕

備考

• GCCでは、以下のコンパイルオプションを追加で指定する必要がある：
  • 13まで : -lstdc++_libbacktrace
  • 14以降 : -lstdc++exp

参照

• P2693R1 Formatting thread::id and stacktrace
• P2301R1 Add a pmr alias for std::stacktrace