std::basic_stacktrace

 

C++

編譯器支援

獨立式與託管式

語言

標準函式庫

標準函式庫標頭檔

具名要求

特性測試巨集 (C++20)

語言支援函式庫

概念函式庫 (C++20)

診斷函式庫

記憶體管理函式庫

元編程函式庫 (C++11)

通用公用程式函式庫

容器函式庫

疊代器函式庫

Ranges 函式庫 (C++20)

演算法函式庫

字串函式庫

文本處理函式庫

數值函式庫

日期與時間函式庫

輸入/輸出函式庫

檔案系統函式庫 (C++17)

並行支援函式庫 (C++11)

執行控制函式庫 (C++26)

技術規範

符號索引

外部函式庫

 

診斷函式庫

異常處理 exception uncaught_exceptionuncaught_exceptions (C++20 前)  (C++17) exception_ptr (C++11) make_exception_ptr (C++11) current_exception (C++11) rethrow_exception (C++11) nested_exception (C++11) throw_with_nested (C++11) rethrow_if_nested (C++11) 異常處理失敗 terminate terminate_handler get_terminate (C++11) set_terminate bad_exception unexpected (至 C++17* 止已棄用) unexpected_handler (至 C++17* 止已棄用) get_unexpected (至 C++17* 止已棄用) set_unexpected (至 C++17* 止已棄用) 錯誤編號 錯誤代碼 errno 斷言 (Assertions) assert

異常類別 logic_error invalid_argument domain_error length_error out_of_range runtime_error range_error overflow_error underflow_error tx_exception (TM TS) 系統錯誤 error_category (C++11) generic_category (C++11) system_category (C++11) error_condition (C++11) errc (C++11) error_code (C++11) system_error (C++11) 堆疊追蹤 stacktrace_entry (C++23) basic_stacktrace (C++23) 除錯支援 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26)

 

std::basic_stacktrace

成員函式

basic_stacktrace::basic_stacktrace

basic_stacktrace::~basic_stacktrace

basic_stacktrace::operator=

basic_stacktrace::current

basic_stacktrace::get_allocator

迭代器

basic_stacktrace::beginbasic_stacktrace::cbegin

basic_stacktrace::endbasic_stacktrace::cend

basic_stacktrace::rbeginbasic_stacktrace::crbegin

basic_stacktrace::rendbasic_stacktrace::crend

容量

basic_stacktrace::empty

basic_stacktrace::size

basic_stacktrace::max_size

元素存取

basic_stacktrace::operator[]

basic_stacktrace::at

修改器

basic_stacktrace::swap

非成員函式

operator== operator<=>

swap(std::basic_stacktrace)

to_string(std::basic_stacktrace)

operator<<

輔助類別

hash<std::basic_stacktrace>

formatter<std::basic_stacktrace>

 

定義於標頭檔 <stacktrace>
template< class Allocator > class basic_stacktrace;	(1)	(自 C++23 起)
using stacktrace =     std::basic_stacktrace<std::allocator<std::stacktrace_entry>>;	(2)	(自 C++23 起)
namespace pmr { using stacktrace =     std::basic_stacktrace<std::pmr::polymorphic_allocator<std::stacktrace_entry>>; }	(3)	(自 C++23 起)

1) `basic_stacktrace` 類別模板代表整個堆疊追蹤（stacktrace）或其特定部分的快照。它滿足 AllocatorAwareContainer、SequenceContainer 和 ReversibleContainer 的要求，唯獨僅支援移動、賦值、交換以及針對 const 限定序列容器的操作，且其比較函式的語意與容器要求不同。

2) 使用預設 std::allocator 的 `basic_stacktrace` 便捷型別別名。

3) 使用 多型配置器（polymorphic allocator） 的 `basic_stacktrace` 便捷型別別名。

目前執行緒中當前評估 \(\small{ {x}_{0} }\)x₀ 的呼叫序列（invocation sequence）是一個評估序列 \(\small{ ({x}_{0}, \dots, {x}_{n})}\)(x₀, ..., x_n)，使得對於 \(\small{i \ge 0}\)i≥0，\(\small{ {x}_{i} }\)x_i 位於函式呼叫 \(\small{ {x}_{i+1} }\)x_i+1 之內。

堆疊追蹤（stacktrace）是呼叫序列的近似表示，由堆疊追蹤條目（stacktrace entries）組成。

堆疊追蹤條目（stacktrace entry）代表堆疊追蹤中的一個評估。它由 C++ 標準函式庫中的 std::stacktrace_entry 表示。

模板參數

配置器 (Allocator)

-

用於獲取/釋放記憶體以及在該記憶體中建構/解構元素的配置器。該型別必須符合 Allocator 的要求。若 Allocator::value_type 不是 std::stacktrace_entry，則程式格式錯誤（ill-formed）。

成員型別

成員型別	定義
value_type	std::stacktrace_entry
const_reference	const value_type&
reference	value_type&
const_iterator	實作定義的 const LegacyRandomAccessIterator 型別，模擬 random_access_iterator
iterator	const_iterator
reverse_iterator	std::reverse_iterator<iterator>
reverse_const_iterator	std::reverse_iterator<const_iterator>
difference_type	實作定義的有號整數型別
size_type	實作定義的無號整數型別
allocator_type	配置器 (Allocator)

成員函式

(建構子)	建立一個新的 basic_stacktrace (公開成員函式)
(解構函式)	解構 basic_stacktrace (公開成員函式)
operator=	賦值給 basic_stacktrace (公開成員函式)
current [靜態]	獲取當前堆疊追蹤或其特定部分 (公開靜態成員函式)
get_allocator	回傳關聯的配置器 (公開成員函式)
迭代器
begincbegin	回傳指向起點的反覆器 (公開成員函式)
endcend	回傳指向終點的反覆器 (公開成員函式)
rbegincrbegin	回傳指向起點的反向反覆器 (公開成員函式)
rendcrend	回傳指向終點的反向反覆器 (公開成員函式)
容量
empty	檢查 basic_stacktrace 是否為空 (公開成員函式)
size	返回堆疊追蹤條目的數量 (公開成員函式)
max_size	返回堆疊追蹤條目的最大可能數量 (公開成員函式)
元素存取
operator[]	存取指定的堆疊追蹤條目 (公開成員函式)
at	存取指定且具有邊界檢查的堆疊追蹤條目 (公開成員函式)
修改器
swap	交換內容 (公開成員函式)

非成員函式

operator==operator<=> (C++23)	比較兩個 basic_stacktrace 的大小與內容 (函式模板)
std::swap(std::basic_stacktrace) (C++23)	特化 std::swap 演算法 (函式模板)
to_string (C++23)	返回包含 basic_stacktrace 描述的字串 (函式模板)
operator<< (C++23)	執行 basic_stracktrace 的串流輸出 (函式模板)

輔助類別

std::hash<std::basic_stacktrace> (C++23)	std::basic_stacktrace 的雜湊支援 (類別模板特化)
std::formatter<std::basic_stacktrace> (C++23)	basic_stacktrace 的格式化支援 (類別模板特化)

附註

提供自訂配置器支援，以便在熱路徑（hot path）或嵌入式環境中使用 basic_stacktrace。使用者可在適當的情況下，將 stacktrace_entry 物件配置於堆疊（stack）或其他地方。

由 std::basic_stacktrace 所擁有的 std::stacktrace_entry 物件序列是不可變的，且其內容或是為空，或是表示整個堆疊追蹤的一個連續區間。

若 std::basic_stacktrace 不可用，可改用 boost::stacktrace::basic_stacktrace（可於 Boost.Stacktrace 取得）。

功能測試巨集	數值	標準	功能
__cpp_lib_stacktrace	202011L	(C++23)	Stacktrace 函式庫
__cpp_lib_formatters	202302L	(C++23)	格式化 std::thread::id 與 std::stacktrace

範例

使用 Compiler Explorer 獲得的輸出：msvc 與 gcc。

執行此程式碼

#include <iostream>
#include <stacktrace>
 
int nested_func(int c)
{
    std::cout << std::stacktrace::current() << '\n';
    return c + 1;
}
 
int func(int b)
{
    return nested_func(b + 1);
}
 
int main()
{
    std::cout << func(777);
}

可能輸出

// msvc output (the lines ending with '⤶' arrows are split to fit the width):
0> C:\Users\ContainerAdministrator\AppData\Local\Temp\compiler-explorer-compiler20221122-⤶
31624-2ja1sf.8ytzw\example.cpp(6): output_s!nested_func+0x1F
1> C:\Users\ContainerAdministrator\AppData\Local\Temp\compiler-explorer-compiler20221122-⤶
31624-2ja1sf.8ytzw\example.cpp(12): output_s!func+0x15
2> C:\Users\ContainerAdministrator\AppData\Local\Temp\compiler-explorer-compiler20221122-⤶
31624-2ja1sf.8ytzw\example.cpp(15): output_s!main+0xE
3> D:\a\_work\1\s\src\vctools\crt\vcstartup\src\startup\exe_common.inl(288): output_s!⤶
__scrt_common_main_seh+0x10C
4> KERNEL32!BaseThreadInitThunk+0x14
5> ntdll!RtlUserThreadStart+0x21
779
 
gcc output:
   0# nested_func(int) at /app/example.cpp:7
   1# func(int) at /app/example.cpp:13
   2#      at /app/example.cpp:18
   3#      at :0
   4#      at :0
   5# 
 
779

參見

stacktrace_entry (C++23)

堆疊追蹤中求值結果的表示 (類別)