std::basic_stacktrace

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

診斷庫

異常處理 異常 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 斷言 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 類模板表示整個堆疊跟蹤或其給定部分的快照。它滿足 AllocatorAwareContainer、SequenceContainer 和 ReversibleContainer 的要求，但只支援移動、賦值、交換以及針對 const 限定序列容器的操作，並且比較函式的語義與容器所需的不同。

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

3) 使用 多型分配器 的 basic_stacktrace 的便捷類型別名。

當前執行執行緒中當前求值 \(\small{ {x}_{0} }\)x₀ 的**呼叫序列**是一個求值序列 \(\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 中。

**堆疊跟蹤**是呼叫序列的近似表示，由堆疊跟蹤條目組成。

**堆疊跟蹤條目**表示堆疊跟蹤中的一個求值。在 C++ 標準庫中，它由 std::stacktrace_entry 表示。

模板引數

Allocator

-

用於獲取/釋放記憶體以及在該記憶體中構造/銷燬元素的分配器。該型別必須滿足 Allocator 的要求。如果 Allocator::value_type 不是 std::stacktrace_entry，則程式格式錯誤。

成員型別

成員型別	定義
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 (public member function)
(解構函式)	銷燬 basic_stacktrace (public member function)
operator=	賦值給 basic_stacktrace (public member function)
current [靜態]	獲取當前堆疊跟蹤或其給定部分 (public static member function)
get_allocator	返回關聯的分配器 (public member function)
迭代器
begincbegin	返回指向起始的迭代器 (public member function)
endcend	返回指向末尾的迭代器 (public member function)
rbegincrbegin	返回指向起始的逆向迭代器 (public member function)
rendcrend	返回指向末尾的逆向迭代器 (public member function)
容量
empty	檢查 basic_stacktrace 是否為空 (public member function)
size	返回堆疊跟蹤條目的數量 (public member function)
max_size	返回堆疊跟蹤條目可能的最大數量 (public member function)
元素訪問
operator[]	訪問指定的堆疊跟蹤條目 (public member function)
at	訪問指定的堆疊跟蹤條目，並進行邊界檢查 (public member function)
修改器
swap	交換內容 (public member function)

非成員函式

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_stacktrace 的流輸出 (函式模板)

輔助類

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

注意

提供自定義分配器支援是為了在熱路徑或嵌入式環境中使用 basic_stacktrace。使用者可以在堆疊上或其他適當的位置分配 stacktrace_entry 物件。

std::basic_stacktrace 所擁有的 std::stacktrace_entry 物件序列是不可變的，並且要麼為空，要麼表示整個堆疊跟蹤的連續區間。

當 std::basic_stacktrace 不可用時，可以使用 boost::stacktrace::basic_stacktrace（在 Boost.Stacktrace 中可用）。

特性測試宏	值	標準	特性
__cpp_lib_stacktrace	202011L	(C++23)	堆疊跟蹤庫
__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)

棧追蹤中一次求值的表示 (類)