std::basic_stacktrace

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

诊断库

异常处理 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++11)(C++17 前) set_unexpected (C++17 前) 错误号 错误号 errno

异常类别 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) 断言 assert 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

std::basic_stacktrace

成员函数

basic_stacktrace::basic_stacktrace (C++23)

basic_stacktrace::~basic_stacktrace (C++23)

basic_stacktrace::operator= (C++23)

basic_stacktrace::current (C++23)

basic_stacktrace::get_allocator (C++23)

迭代器

basic_stacktrace::beginbasic_stacktrace::cbegin (C++23)(C++23)

basic_stacktrace::endbasic_stacktrace::cend (C++23)(C++23)

basic_stacktrace::rbeginbasic_stacktrace::crbegin (C++23)(C++23)

basic_stacktrace::rendbasic_stacktrace::crend (C++23)(C++23)

容量

basic_stacktrace::empty (C++23)

basic_stacktrace::size (C++23)

basic_stacktrace::max_size (C++23)

元素访问

basic_stacktrace::operator[] (C++23)

basic_stacktrace::at (C++23)

修改器

basic_stacktrace::swap (C++23)

非成员函数

operator== operator<=> (C++23)(C++23)

std::swap (C++23)

to_string (C++23)

operator<< (C++23)

辅助类

hash<basic_stacktrace> (C++23)

 

在标头 <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	实现定义的常老式随机访问迭代器 (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_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 对象序列是不可变的，而且要么为空，要么表示整个栈踪的一个连续区间。

boost::stacktrace::basic_stacktrace （于 Boost.Stacktrace 中可用）能在 std::basic_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:
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)

栈踪中求值的表示 (类)