前言

Linux x86_64 基于FP栈回溯请参考：Linux x86_64 dump_stack（）函数基于FP栈回溯

回溯（backtrace）是指当前线程中正在活动的函数调用列表。通常情况下，检查程序的回溯信息是通过使用外部调试器（如 gdb）来实现的。然而，有时候从程序内部以编程方式获取回溯信息也是很有用的，例如用于日志记录或诊断目的。

头文件 execinfo.h 声明了三个函数，用于获取和操作当前线程的回溯信息。

NAMEbacktrace, backtrace_symbols, backtrace_symbols_fd - support for application self-debuggingSYNOPSIS#include <execinfo.h>int backtrace(void **buffer, int size);char **backtrace_symbols(void *const *buffer, int size);void backtrace_symbols_fd(void *const *buffer, int size, int fd);

一、demo演示

#include <stdio.h>
#include <execinfo.h>
#include <stdlib.h>#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))void dump_stack(void)
{//定义一个 void 类型的指针数组 array，用于存储返回地址。void *array[16];//使用 backtrace 函数获取当前程序的函数调用栈信息，并将返回地址存储在 array 数组中。//返回实际存储的返回地址数量size。size_t size = backtrace(array, ARRAY_SIZE(array));//使用 backtrace_symbols 函数，将返回地址数组 array 和大小 size 作为参数，获取每个返回地址对应的函数名称，并将函数名称字符串数组的指针存储在 strings 中。char **strings = backtrace_symbols(array, size);size_t i;//打印获取到的函数调用栈帧的数量，即 size。printf("Obtained %zd stack frames.\n", size);//遍历 strings 数组，逐行打印每个函数名称以及相关栈回溯信息。for (i = 0; i < size; i++)printf("%s\n", strings[i]);free(strings);
}void func_c(void)
{dump_stack();	
}void func_b(void)
{func_c();	
}void func_a(void)
{func_b();
}int main()
{func_a();return 0;
}

# gcc backtrace.c
# ./a.out
Obtained 7 stack frames.
./a.out() [0x40067c]
./a.out() [0x400701]
./a.out() [0x40070c]
./a.out() [0x400717]
./a.out() [0x400722]
/lib64/libc.so.6(__libc_start_main+0xf5) [0x7f93f0d3e555]
./a.out() [0x400599]# gcc -rdynamic backtrace.c
# ./a.out
Obtained 7 stack frames.
./a.out(dump_stack+0x1f) [0x4008ec]
./a.out(func_c+0x9) [0x400971]
./a.out(func_b+0x9) [0x40097c]
./a.out(func_a+0x9) [0x400987]
./a.out(main+0x9) [0x400992]
/lib64/libc.so.6(__libc_start_main+0xf5) [0x7fec54d7d555]
./a.out() [0x400809]

要取符号名称。对于使用 GNU 链接器的系统，需要使用 -rdynamic 链接器选项：

-rdynamicPass the flag -export-dynamic to the ELF linker, on targets that support it. This instructs the linker to add all symbols, not only used ones, to the dynamic symboltable. This option is needed for some uses of "dlopen" or to allow obtaining backtraces from within a program.

-rdynamic 是一个编译器选项，它会在支持的目标平台上将 -export-dynamic 标志传递给 ELF 链接器。这指示链接器将所有符号（而不仅仅是被使用的符号）添加到动态符号表中。

这个选项在某些情况下非常有用，特别是在以下两个方面：

（1）dlopen 函数的使用：dlopen 是一个动态链接库加载函数，它允许在程序运行时加载和链接共享库。当使用 dlopen 动态加载共享库时，如果需要从加载的库中调用函数，那么这些函数的符号必须在动态符号表中。通过使用 -rdynamic 选项，可以将所有符号（包括未被程序直接使用的符号）添加到动态符号表中，使得动态加载的库能够正确地解析和调用这些符号。

（2）在程序内部获取回溯信息：回溯（backtrace）是指在程序执行期间获取函数调用栈的信息。当使用像 backtrace 或 backtrace_symbols 这样的函数时，需要访问所有函数的符号信息，而不仅仅是已使用的符号。通过使用 -rdynamic 选项，可以确保所有符号都包含在动态符号表中，从而使得获取回溯信息时能够正确地解析函数名称。

二、函数解析

NAMEbacktrace, backtrace_symbols, backtrace_symbols_fd - support for application self-debuggingSYNOPSIS#include <execinfo.h>int backtrace(void **buffer, int size);char **backtrace_symbols(void *const *buffer, int size);void backtrace_symbols_fd(void *const *buffer, int size, int fd);

2.1 backtrace函数

 int backtrace(void **buffer, int size);

backtrace() 函数返回调用程序的函数调用栈，将其填充到由 buffer 指向的数组中。函数调用栈是指当前程序中正在活动的函数调用序列。buffer 数组中的每个项都是 void* 类型，表示对应堆栈帧的返回地址。

size 参数指定了 buffer 数组中可以存储的地址的最大数量。如果函数调用栈超过了指定的 size，那么将返回与最近的 size 个函数调用相对应的地址；若要获取完整的函数调用栈，请确保 buffer 和 size 足够大。

换句话说，如果函数调用栈超过了给定的 size，则最旧的函数调用将被截断，只有最近的函数调用的地址将存储在 buffer 中。如果需要完整的函数调用栈信息，应提供足够大的 buffer 和 size。

其声明：

/* Store up to SIZE return address of the current program state inARRAY and return the exact number of values stored.  */
extern int backtrace (void **__array, int __size) __nonnull ((1));

backtrace函数的目的是将当前程序状态的返回地址存储在指定大小的数组中，并返回实际存储的返回地址数量。

返回类型：int，表示返回的是一个整数值，即实际存储的返回地址数量
参数：有两个参数
void **__array：指向 void* 类型的指针数组的指针，用于存储返回地址
int __size：表示存储空间的大小，即数组的大小
函数属性：__nonnull ((1)) 表示第一个参数 __array 不能为空指针

backtrace 函数是一个在调试和错误排查过程中常用的函数，它可以用于获取当前程序的函数调用栈信息。

该函数的作用是在运行时获取当前程序的返回地址，并将这些地址存储在指定的数组中。返回地址表示程序执行到当前位置时将要返回的地址，也就是当前函数执行完后将要执行的下一条指令的地址。

通过获取返回地址，并将其存储在数组中，我们可以构建一个表示函数调用栈的数据结构。函数调用栈是一个记录函数调用关系的堆栈结构，每个堆栈帧表示一个函数调用，其中包含函数的返回地址和相关的参数和局部变量等信息。

2.2 backtrace_symbols

char **backtrace_symbols(void *const *buffer, int size);

backtrace_symbols() 函数将由 buffer 返回的地址集合转换为一个字符串数组，用于以符号方式描述这些地址。size 参数指定了 buffer 中地址的数量。每个地址的符号表示包括函数名称（如果可以确定）、函数的十六进制偏移量以及实际的返回地址（以十六进制表示）。backtrace_symbols() 的函数结果是指向字符串指针数组的地址。该数组是由 backtrace_symbols() 动态分配的内存块，需要由调用者使用 free() 函数进行释放。（指针数组指向的字符串本身不需要也不应该被释放。）

使用 backtrace_symbols() 函数，可以将返回的地址转换为可读性更好的字符串形式，以便更方便地理解和分析函数调用栈信息。

需要注意的是，返回的字符串数组是通过 malloc() 动态分配的内存块，因此需要在使用完毕后手动释放，以避免内存泄漏。

其声明：

/* Return names of functions from the backtrace list in ARRAY in a newlymalloc()ed memory block.  */
extern char **backtrace_symbols (void *const *__array, int __size)__THROW __nonnull ((1));

backtrace_symbols函数用于从给定的返回地址数组中获取函数名称，并将这些函数名称以字符串数组的形式返回。

返回类型：char **，表示返回一个指向字符指针的指针，即字符串数组的指针
参数：有两个参数
void *const *__array：指向 void* 类型的指针数组的指针，用于存储返回地址
int __size：表示存储返回地址的数组的大小
函数属性：__THROW 表示函数不会抛出异常，__nonnull ((1)) 表示第一个参数 __array 不能为空指针

backtrace_symbols 函数是一个用于获取函数调用栈信息中函数名称的常用函数。它根据给定的返回地址数组，在新分配的内存块中动态生成一个字符串数组，其中每个字符串表示相应返回地址对应的函数名称。

函数调用栈是一个记录函数调用关系的堆栈结构，其中每个堆栈帧表示一个函数调用，包含函数的返回地址和其他相关信息。backtrace_symbols 函数可以通过返回地址数组来获取函数调用栈中每个函数的名称。