如何使backtrace()/backtrace_symbols()打印函数名称？

Question

Linux特定的函数backtrace()和backtrace_symbols()允许您生成程序的调用跟踪。但是，对于我的程序，它只打印函数地址，而没有它们的名称。我该如何使它们也打印函数名？我尝试使用-g和-ggdb编译程序。下面的测试用例只会输出这些：

    BACKTRACE ------------
    ./a.out() [0x8048616]
    ./a.out() [0x8048623]
    /lib/libc.so.6(__libc_start_main+0xf3) [0x4a937413]
    ./a.out() [0x8048421]
    ----------------------

我希望前两个项目也显示函数名称，即foo和main

代码:

#include <execinfo.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <stdlib.h>

static void full_write(int fd, const char *buf, size_t len)
{
        while (len > 0) {
                ssize_t ret = write(fd, buf, len);

                if ((ret == -1) && (errno != EINTR))
                        break;

                buf += (size_t) ret;
                len -= (size_t) ret;
        }
}

void print_backtrace(void)
{
        static const char start[] = "BACKTRACE ------------\n";
        static const char end[] = "----------------------\n";

        void *bt[1024];
        int bt_size;
        char **bt_syms;
        int i;

        bt_size = backtrace(bt, 1024);
        bt_syms = backtrace_symbols(bt, bt_size);
        full_write(STDERR_FILENO, start, strlen(start));
        for (i = 1; i < bt_size; i++) {
                size_t len = strlen(bt_syms[i]);
                full_write(STDERR_FILENO, bt_syms[i], len);
                full_write(STDERR_FILENO, "\n", 1);
        }
        full_write(STDERR_FILENO, end, strlen(end));
    free(bt_syms);
}
void foo()
{
    print_backtrace();
}

int main()
{
    foo();
    return 0;
}

- Lyke

---

可能是重复的问题：如何获取更详细的回溯信息。 - Nemo

顺便提一下，函数backtrace_symbols_fd执行与backtrace_symbols()相同的操作，但生成的字符串立即写入文件描述符fd。 - nhnghia

我已经在以下网址详细测试了几种方法：https://dev59.com/Wm865IYBdhLWcg3wR8ah#54365144 - Ciro Santilli OurBigBook.com

由于backtrace()的第二个参数指定了可以存储在由第一个参数指定的缓冲区中的地址的最大数量(man 3 backtrace)，因此在这里使用1024的值过于慷慨。20的值应该足够，当bt_size == 20时打印可能截断的警告是一个好习惯。 - Robert

这个问题发生在golang 1.21版本上。我通过将其降级到1.20.8版本来解决。 - undefined

Answer 1

符号被从动态符号表中获取；您需要使用 -rdynamic 选项给 gcc，这样它会向链接器传递一个标志，以确保所有符号都放在表中。

（请参见GCC手册的链接选项页面，和/或glibc手册的回溯页面。）

- Matthew Slattery

---

然而对于静态符号，这种方法无效。 @Nemo提到的libunwind适用于静态函数。 - Nathan Kidd

在一个CMake项目中，这个选项被错误地设置为ADD_COMPILE_OPTIONS(-rdynamic)。相反，它需要被设置为ADD_LINK_OPTIONS(-rdynamic)或等效的选项才能达到所需的行为。 - Stéphane

对于那些使用cmake的人来说，更好的方法是：SET (CMAKE_ENABLE_EXPORTS TRUE)。这将设置-rdynamic链接器标志。 - Stéphane

Answer 2

使用addr2line命令将可执行代码地址映射到源代码文件名+行号。 使用-f选项还可获取函数名称。

或者，尝试使用libunwind。

- Nemo

---

addr2行很好，因为它在输出中包含文件名和行号，但一旦加载器执行重定位，它就会失败。 - Erwan Legrand

随着ASLR重定位的普及，它们变得比以往任何时候都更常见。 - Erwan Legrand

@ErwanLegrand：在ASLR之前，我认为重定位是可预测的，即使是共享对象中的地址，addr2line也可以可靠地工作。但是，在现代平台上，即使从原理上讲，您也需要知道可重定位对象的实际加载地址才能执行此操作。 - Nemo

我无法确定在ASLR之前它的工作效果如何。现在，它只能用于“常规”可执行文件中的代码，并且对于DSO和PIE中的代码会失败。幸运的是，libunwind似乎适用于所有这些情况。 - Erwan Legrand

我忘记了这个讨论。当时我不知道的Libbacktrace是一个更好的选择。（请参见我的新答案。） - Erwan Legrand

Answer 3

优秀的Libbacktrace由Ian Lance Taylor开发解决了这个问题。它处理堆栈展开并支持普通ELF符号和DWARF调试符号。

Libbacktrace不需要导出所有符号，这将很丑陋，并且ASLR不会破坏它。

最初，Libbacktrace是GCC分发的一部分。现在，可以在Github上找到一个独立的版本：https://github.com/ianlancetaylor/libbacktrace。

- Erwan Legrand

Answer 4

顶部的答案有一个bug 如果ret == -1并且errno是EINTER，则应该再次尝试，但不将ret计为已复制 （不会因为这个问题而注册账户，如果你不喜欢这样就算了）

static void full_write(int fd, const char *buf, size_t len)
{
        while (len > 0) {
                ssize_t ret = write(fd, buf, len);

                if ((ret == -1) {
                        if (errno != EINTR))
                                break;
                        //else
                        continue;
                }
                buf += (size_t) ret;
                len -= (size_t) ret;
        }
}

- Billg

Answer 5

Boost回溯

非常方便，因为它可以为您自动打印：

• 未编译的C++函数名称
• 行号

使用总结：

#define BOOST_STACKTRACE_USE_ADDR2LINE
#include <boost/stacktrace.hpp>

std::cout << boost::stacktrace::stacktrace() << std::endl;

我在此提供了一个最小的可运行示例及许多其他方法：在C或C++中打印调用栈

- Ciro Santilli OurBigBook.com

---

这个问题标记为[c]，而不是[c++]。 - Yakov Galka

Answer 6

这种方式适用于 Linux x86_64 和 aarch64，效果很好

1. 下载并构建 binutils：https://ftp.gnu.org/gnu/binutils
2. 将 addr2line 复制到您的项目中
3. 代码片段

static void backtraceAll(const char* abspath)
{
    int     i, addrsize;
    int     max_frames  = 64;
    char**  symlist     = NULL;
    void*   addrlist[max_frames];
    char    cmdline[256]    = {0};
    char    result[256]     = {0};
    FILE*   fp;

    addrsize = backtrace(addrlist, sizeof(addrlist) / sizeof(void*));
    symlist  = backtrace_symbols (addrlist, addrsize);
    if (symlist != NULL)
    {
        printf ("stack frames %d\n", addrsize);
        for (i = 0; i < addrsize; i++)
        {
            printf ("stack layer %d: %s\n", i, symlist[i]);

            snprintf(cmdline, sizeof(cmdline), "./addr2line -e %s -f %p", abspath, addrlist[i]);
            fp = popen(cmdline, "r");
            if (fp)
            {
                while (fgets(result, sizeof(result), fp))
                {
                    printf("func info: %s", result);
                }
                printf("\n");
            }
            pclose(fp);
        }
    }
    free(symlist);
}

演示：https://www.mediafire.com/view/k1vhndmvm08m596/callername.png
想了解更多，请参考这个链接：https://fatalfeel.blogspot.com/2019/12/backtace-caller-name-in-cc.html

- Jesse Stone