命名空间
变体
操作

std::basic_stacktrace

来自 cppreference.cn
< cpp‎ | 工具
 
C++
 
诊断库
 
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 的便捷类型别名。

当前执行线程中当前求值 x0 的**调用序列**是一个求值序列 (x0, ..., xn)，使得对于 i≥0，xi 位于函数调用 xi+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) [编辑]
 赋值给 basic_stacktrace
(public member function) [编辑]
[静态]
 获取当前堆栈跟踪或其给定部分
(public static member function) [编辑]
 返回关联的分配器
(public member function) [编辑]
迭代器
 返回指向起始的迭代器
(public member function) [编辑]
 返回指向末尾的迭代器
(public member function) [编辑]
 返回指向起始的逆向迭代器
(public member function) [编辑]
 返回指向末尾的逆向迭代器
(public member function) [编辑]
容量
 检查 basic_stacktrace 是否为空
(public member function) [编辑]
 返回堆栈跟踪条目的数量
(public member function) [编辑]
 返回堆栈跟踪条目可能的最大数量
(public member function) [编辑]
元素访问
 访问指定的堆栈跟踪条目
(public member function) [编辑]
 访问指定的堆栈跟踪条目，并进行边界检查
(public member function) [编辑]
修改器
 交换内容
(public member function) [编辑]

[编辑] 非成员函数

(C++23)
 比较两个 basic_stacktrace 值的大小和内容
(函数模板)
(C++23)
 特化 std::swap 算法
(函数模板) [编辑]
(C++23)
 返回描述 basic_stacktrace 的字符串
(函数模板) [编辑]
(C++23)
 执行 basic_stacktrace 的流输出
(函数模板) [编辑]

[编辑] 辅助类

(C++23)
 对 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

[编辑] 另请参阅

(C++23)
 栈追踪中一次求值的表示
(类) [编辑]
取自“https://cppreference.cn/mwiki/index.php?title=cpp/utility/basic_stacktrace&oldid=168072”