使用C或C ++打印调用堆栈


120

每当调用某个函数时,是否有任何方法可以在C或C ++的运行进程中转储调用堆栈?我想到的是这样的:

void foo()
{
   print_stack_trace();

   // foo's body

   return
}

Where的print_stack_trace工作方式与callerPerl 类似。

或类似这样的东西:

int main (void)
{
    // will print out debug info every time foo() is called
    register_stack_trace_function(foo); 

    // etc...
}

在其中register_stack_trace_function放置某种内部断点,该断点将在每次foo调用时打印堆栈跟踪。

某些标准C库中是否存在类似的内容?

我正在使用GCC在Linux上工作。


背景

我有一个测试运行,该行为基于一些不应影响此行为的命令行开关而有所不同。我的代码有一个伪随机数生成器,我认为根据这些开关,它们会被不同地调用。我希望能够使用每组开关来运行测试,并查看每个随机数生成器的调用方式是否有所不同。


1
@Armen,您熟悉其中任何一个吗?
内森·费尔曼

1
@Nathan:如果您的调试器是gdb,则可以处理这种情况。我无法向您介绍其他人,但我认为gdb并不是只有一个拥有此功能。 旁白:我只是看了我先前的评论。:: gag :: s/easier/either/这是怎么发生的?
dmckee ---前主持人小猫,2010年

2
@dmckee:实际上应该是s/either/easier。我需要对gdb进行的工作是编写一个脚本,该脚本会对该函数造成破坏并打印出堆栈跟踪,然后继续。现在,我开始思考,也许现在该是我学习gdb脚本的时候了。
内森·费尔曼

1
加!要去睡觉了。真正的现在很快……
dmckee ---前主持人小猫

Answers:


79

对于仅适用于Linux的解决方案,您可以使用backtrace(3)来简单地返回一个数组void *(实际上,每个数组都指向相应堆栈帧中的返回地址)。为了将这些转换为有用的东西,有backtrace_symbols(3)

注意backtrace(3)中notes部分

如果不使用特殊的链接器选项,则符号名称可能不可用。对于使用GNU链接器的系统,必须使用-rdynamic链接器选项。请注意,“静态”函数的名称未公开,并且在回溯中将不可用。





glibc不幸的是,在带有的Linux上,backtrace_symbols函数不提供函数名,源文件名和行号。
Maxim Egorushkin

除了使用之外-rdynamic,还要检查您的构建系统没有添加-fvisibility=hidden选项!(因为它将完全放弃的效果-rdynamic
Dima Litvinov

36

提升堆栈跟踪

记录在:https : //www.boost.org/doc/libs/1_66_0/doc/html/stacktrace/getting_started.html#stacktrace.getting_started.how_to_print_current_call_stack

这是我到目前为止看到的最方便的选项,因为它:

  • 可以实际打印出行号。

    但是,它只会调用addr2line,这很丑陋,如果您跟踪的次数过多,可能会很慢。

  • 默认情况下,

  • Boost仅是头文件,因此极有可能无需修改构建系统

boost_stacktrace.cpp

#include <iostream>

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

void my_func_2(void) {
    std::cout << boost::stacktrace::stacktrace() << std::endl;
}

void my_func_1(double f) {
    (void)f;
    my_func_2();
}

void my_func_1(int i) {
    (void)i;
    my_func_2();
}

int main(int argc, char **argv) {
    long long unsigned int n;
    if (argc > 1) {
        n = strtoul(argv[1], NULL, 0);
    } else {
        n = 1;
    }
    for (long long unsigned int i = 0; i < n; ++i) {
        my_func_1(1);   // line 28
        my_func_1(2.0); // line 29
    }
}

不幸的是,这似乎是一个较新的功能,而该软件包libboost-stacktrace-dev在Ubuntu 16.04中仅18.04中不存在:

sudo apt-get install libboost-stacktrace-dev
g++ -fno-pie -ggdb3 -O0 -no-pie -o boost_stacktrace.out -std=c++11 \
  -Wall -Wextra -pedantic-errors boost_stacktrace.cpp -ldl
./boost_stacktrace.out

我们必须-ldl在末尾添加,否则编译将失败。

输出:

 0# boost::stacktrace::basic_stacktrace<std::allocator<boost::stacktrace::frame> >::basic_stacktrace() at /usr/include/boost/stacktrace/stacktrace.hpp:129
 1# my_func_1(int) at /home/ciro/test/boost_stacktrace.cpp:18
 2# main at /home/ciro/test/boost_stacktrace.cpp:29 (discriminator 2)
 3# __libc_start_main in /lib/x86_64-linux-gnu/libc.so.6
 4# _start in ./boost_stacktrace.out

 0# boost::stacktrace::basic_stacktrace<std::allocator<boost::stacktrace::frame> >::basic_stacktrace() at /usr/include/boost/stacktrace/stacktrace.hpp:129
 1# my_func_1(double) at /home/ciro/test/boost_stacktrace.cpp:13
 2# main at /home/ciro/test/boost_stacktrace.cpp:27 (discriminator 2)
 3# __libc_start_main in /lib/x86_64-linux-gnu/libc.so.6
 4# _start in ./boost_stacktrace.out

输出和在类似的下面的“ glibc backtrace”部分中进一步说明。

请注意,由于函数重载而被破坏的my_func_1(int) and my_func_1(float),对我们来说是很好的分解方法。

请注意,第一个int调用关闭了一行(28而不是27,第二个关闭了两行(27而不是29)。在注释建议这是因为正在考虑以下指令地址,即使27变为28,而29跳出循环并变为27。

然后,我们观察到,使用时-O3,输出完全被破坏了:

 0# boost::stacktrace::basic_stacktrace<std::allocator<boost::stacktrace::frame> >::size() const at /usr/include/boost/stacktrace/stacktrace.hpp:215
 1# my_func_1(double) at /home/ciro/test/boost_stacktrace.cpp:12
 2# __libc_start_main in /lib/x86_64-linux-gnu/libc.so.6
 3# _start in ./boost_stacktrace.out

 0# boost::stacktrace::basic_stacktrace<std::allocator<boost::stacktrace::frame> >::size() const at /usr/include/boost/stacktrace/stacktrace.hpp:215
 1# main at /home/ciro/test/boost_stacktrace.cpp:31
 2# __libc_start_main in /lib/x86_64-linux-gnu/libc.so.6
 3# _start in ./boost_stacktrace.out

回溯通常无法通过优化来修复。尾部呼叫优化是一个著名的例子:什么是尾部呼叫优化?

基准测试-O3

time  ./boost_stacktrace.out 1000 >/dev/null

输出:

real    0m43.573s
user    0m30.799s
sys     0m13.665s

因此,正如预期的那样,我们发现这种方法在外部调用时非常慢addr2line,并且只有在进行有限数量的调用时才可行。

每次回溯打印似乎都需要数百毫秒,因此请注意,如果回溯非常频繁地发生,程序性能将受到严重影响。

在Ubuntu 19.10,GCC 9.2.1,Boost 1.67.0上进行了测试。

glibc backtrace

记录在:https : //www.gnu.org/software/libc/manual/html_node/Backtraces.html

main.c

#include <stdio.h>
#include <stdlib.h>

/* Paste this on the file you want to debug. */
#include <stdio.h>
#include <execinfo.h>
void print_trace(void) {
    char **strings;
    size_t i, size;
    enum Constexpr { MAX_SIZE = 1024 };
    void *array[MAX_SIZE];
    size = backtrace(array, MAX_SIZE);
    strings = backtrace_symbols(array, size);
    for (i = 0; i < size; i++)
        printf("%s\n", strings[i]);
    puts("");
    free(strings);
}

void my_func_3(void) {
    print_trace();
}

void my_func_2(void) {
    my_func_3();
}

void my_func_1(void) {
    my_func_3();
}

int main(void) {
    my_func_1(); /* line 33 */
    my_func_2(); /* line 34 */
    return 0;
}

编译:

gcc -fno-pie -ggdb3 -O3 -no-pie -o main.out -rdynamic -std=c99 \
  -Wall -Wextra -pedantic-errors main.c

-rdynamic 是关键的必需选项。

跑:

./main.out

输出:

./main.out(print_trace+0x2d) [0x400a3d]
./main.out(main+0x9) [0x4008f9]
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xf0) [0x7f35a5aad830]
./main.out(_start+0x29) [0x400939]

./main.out(print_trace+0x2d) [0x400a3d]
./main.out(main+0xe) [0x4008fe]
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xf0) [0x7f35a5aad830]
./main.out(_start+0x29) [0x400939]

因此,我们立即看到发生了内联优化,并且某些功能从跟踪中丢失了。

如果我们尝试获取地址:

addr2line -e main.out 0x4008f9 0x4008fe

我们获得:

/home/ciro/main.c:21
/home/ciro/main.c:36

完全关闭了。

如果-O0相反,则./main.out给出正确的完整跟踪:

./main.out(print_trace+0x2e) [0x4009a4]
./main.out(my_func_3+0x9) [0x400a50]
./main.out(my_func_1+0x9) [0x400a68]
./main.out(main+0x9) [0x400a74]
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xf0) [0x7f4711677830]
./main.out(_start+0x29) [0x4008a9]

./main.out(print_trace+0x2e) [0x4009a4]
./main.out(my_func_3+0x9) [0x400a50]
./main.out(my_func_2+0x9) [0x400a5c]
./main.out(main+0xe) [0x400a79]
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xf0) [0x7f4711677830]
./main.out(_start+0x29) [0x4008a9]

然后:

addr2line -e main.out 0x400a74 0x400a79

给出:

/home/cirsan01/test/main.c:34
/home/cirsan01/test/main.c:35

所以线只有一条,TODO为什么呢?但这可能仍然可用。

结论:回溯只能通过完美显示-O0。通过优化,原始回溯将在编译后的代码中进行根本性的修改。

我找不到一种简单的方法来自动对此C ++符号进行脱胶,但是,这里有一些技巧:

在Ubuntu 16.04,GCC 6.4.0,libc 2.23上进行了测试。

glibc backtrace_symbols_fd

该帮助程序比更加方便backtrace_symbols,并产生基本相同的输出:

/* Paste this on the file you want to debug. */
#include <execinfo.h>
#include <stdio.h>
#include <unistd.h>
void print_trace(void) {
    size_t i, size;
    enum Constexpr { MAX_SIZE = 1024 };
    void *array[MAX_SIZE];
    size = backtrace(array, MAX_SIZE);
    backtrace_symbols_fd(array, size, STDOUT_FILENO);
    puts("");
}

在Ubuntu 16.04,GCC 6.4.0,libc 2.23上进行了测试。

backtrace带有C ++的glibc 解散hack 1:-export-dynamic+dladdr

改编自:https : //gist.github.com/fmela/591333/c64f4eb86037bb237862a8283df70cdfc25f01d3

这是一个“ hack”,因为它需要使用来更改ELF -export-dynamic

glibc_ldl.cpp

#include <dlfcn.h>     // for dladdr
#include <cxxabi.h>    // for __cxa_demangle

#include <cstdio>
#include <string>
#include <sstream>
#include <iostream>

// This function produces a stack backtrace with demangled function & method names.
std::string backtrace(int skip = 1)
{
    void *callstack[128];
    const int nMaxFrames = sizeof(callstack) / sizeof(callstack[0]);
    char buf[1024];
    int nFrames = backtrace(callstack, nMaxFrames);
    char **symbols = backtrace_symbols(callstack, nFrames);

    std::ostringstream trace_buf;
    for (int i = skip; i < nFrames; i++) {
        Dl_info info;
        if (dladdr(callstack[i], &info)) {
            char *demangled = NULL;
            int status;
            demangled = abi::__cxa_demangle(info.dli_sname, NULL, 0, &status);
            std::snprintf(
                buf,
                sizeof(buf),
                "%-3d %*p %s + %zd\n",
                i,
                (int)(2 + sizeof(void*) * 2),
                callstack[i],
                status == 0 ? demangled : info.dli_sname,
                (char *)callstack[i] - (char *)info.dli_saddr
            );
            free(demangled);
        } else {
            std::snprintf(buf, sizeof(buf), "%-3d %*p\n",
                i, (int)(2 + sizeof(void*) * 2), callstack[i]);
        }
        trace_buf << buf;
        std::snprintf(buf, sizeof(buf), "%s\n", symbols[i]);
        trace_buf << buf;
    }
    free(symbols);
    if (nFrames == nMaxFrames)
        trace_buf << "[truncated]\n";
    return trace_buf.str();
}

void my_func_2(void) {
    std::cout << backtrace() << std::endl;
}

void my_func_1(double f) {
    (void)f;
    my_func_2();
}

void my_func_1(int i) {
    (void)i;
    my_func_2();
}

int main() {
    my_func_1(1);
    my_func_1(2.0);
}

编译并运行:

g++ -fno-pie -ggdb3 -O0 -no-pie -o glibc_ldl.out -std=c++11 -Wall -Wextra \
  -pedantic-errors -fpic glibc_ldl.cpp -export-dynamic -ldl
./glibc_ldl.out 

输出:

1             0x40130a my_func_2() + 41
./glibc_ldl.out(_Z9my_func_2v+0x29) [0x40130a]
2             0x40139e my_func_1(int) + 16
./glibc_ldl.out(_Z9my_func_1i+0x10) [0x40139e]
3             0x4013b3 main + 18
./glibc_ldl.out(main+0x12) [0x4013b3]
4       0x7f7594552b97 __libc_start_main + 231
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xe7) [0x7f7594552b97]
5             0x400f3a _start + 42
./glibc_ldl.out(_start+0x2a) [0x400f3a]

1             0x40130a my_func_2() + 41
./glibc_ldl.out(_Z9my_func_2v+0x29) [0x40130a]
2             0x40138b my_func_1(double) + 18
./glibc_ldl.out(_Z9my_func_1d+0x12) [0x40138b]
3             0x4013c8 main + 39
./glibc_ldl.out(main+0x27) [0x4013c8]
4       0x7f7594552b97 __libc_start_main + 231
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xe7) [0x7f7594552b97]
5             0x400f3a _start + 42
./glibc_ldl.out(_start+0x2a) [0x400f3a]

在Ubuntu 18.04上测试。

backtrace使用C ++分解hack的glibc 2:解析回溯输出

显示在:https : //panthema.net/2008/0901-stacktrace-demangled/

这是一个hack,因为它需要解析。

TODO将其编译并在此处显示。

libunwind

TODO与glibc backtrace相比有什么优势吗?非常相似的输出也需要修改build命令,但不是glibc的一部分,因此需要额外的软件包安装。

代码改编自:https : //eli.thegreenplace.net/2015/programmatic-access-to-the-call-stack-in-c/

main.c

/* This must be on top. */
#define _XOPEN_SOURCE 700

#include <stdio.h>
#include <stdlib.h>

/* Paste this on the file you want to debug. */
#define UNW_LOCAL_ONLY
#include <libunwind.h>
#include <stdio.h>
void print_trace() {
    char sym[256];
    unw_context_t context;
    unw_cursor_t cursor;
    unw_getcontext(&context);
    unw_init_local(&cursor, &context);
    while (unw_step(&cursor) > 0) {
        unw_word_t offset, pc;
        unw_get_reg(&cursor, UNW_REG_IP, &pc);
        if (pc == 0) {
            break;
        }
        printf("0x%lx:", pc);
        if (unw_get_proc_name(&cursor, sym, sizeof(sym), &offset) == 0) {
            printf(" (%s+0x%lx)\n", sym, offset);
        } else {
            printf(" -- error: unable to obtain symbol name for this frame\n");
        }
    }
    puts("");
}

void my_func_3(void) {
    print_trace();
}

void my_func_2(void) {
    my_func_3();
}

void my_func_1(void) {
    my_func_3();
}

int main(void) {
    my_func_1(); /* line 46 */
    my_func_2(); /* line 47 */
    return 0;
}

编译并运行:

sudo apt-get install libunwind-dev
gcc -fno-pie -ggdb3 -O3 -no-pie -o main.out -std=c99 \
  -Wall -Wextra -pedantic-errors main.c -lunwind

要么#define _XOPEN_SOURCE 700必须在最上面,要么我们必须使用-std=gnu99

跑:

./main.out

输出:

0x4007db: (main+0xb)
0x7f4ff50aa830: (__libc_start_main+0xf0)
0x400819: (_start+0x29)

0x4007e2: (main+0x12)
0x7f4ff50aa830: (__libc_start_main+0xf0)
0x400819: (_start+0x29)

和:

addr2line -e main.out 0x4007db 0x4007e2

给出:

/home/ciro/main.c:34
/home/ciro/main.c:49

-O0

0x4009cf: (my_func_3+0xe)
0x4009e7: (my_func_1+0x9)
0x4009f3: (main+0x9)
0x7f7b84ad7830: (__libc_start_main+0xf0)
0x4007d9: (_start+0x29)

0x4009cf: (my_func_3+0xe)
0x4009db: (my_func_2+0x9)
0x4009f8: (main+0xe)
0x7f7b84ad7830: (__libc_start_main+0xf0)
0x4007d9: (_start+0x29)

和:

addr2line -e main.out 0x4009f3 0x4009f8

给出:

/home/ciro/main.c:47
/home/ciro/main.c:48

在Ubuntu 16.04,GCC 6.4.0,libunwind 1.1上进行了测试。

具有C ++名称分解的libunwind

代码改编自: https//eli.thegreenplace.net/2015/programmatic-access-to-the-call-stack-in-c/

unwind.cpp

#define UNW_LOCAL_ONLY
#include <cxxabi.h>
#include <libunwind.h>
#include <cstdio>
#include <cstdlib>
#include <iostream>

void backtrace() {
  unw_cursor_t cursor;
  unw_context_t context;

  // Initialize cursor to current frame for local unwinding.
  unw_getcontext(&context);
  unw_init_local(&cursor, &context);

  // Unwind frames one by one, going up the frame stack.
  while (unw_step(&cursor) > 0) {
    unw_word_t offset, pc;
    unw_get_reg(&cursor, UNW_REG_IP, &pc);
    if (pc == 0) {
      break;
    }
    std::printf("0x%lx:", pc);

    char sym[256];
    if (unw_get_proc_name(&cursor, sym, sizeof(sym), &offset) == 0) {
      char* nameptr = sym;
      int status;
      char* demangled = abi::__cxa_demangle(sym, nullptr, nullptr, &status);
      if (status == 0) {
        nameptr = demangled;
      }
      std::printf(" (%s+0x%lx)\n", nameptr, offset);
      std::free(demangled);
    } else {
      std::printf(" -- error: unable to obtain symbol name for this frame\n");
    }
  }
}

void my_func_2(void) {
    backtrace();
    std::cout << std::endl; // line 43
}

void my_func_1(double f) {
    (void)f;
    my_func_2();
}

void my_func_1(int i) {
    (void)i;
    my_func_2();
}  // line 54

int main() {
    my_func_1(1);
    my_func_1(2.0);
}

编译并运行:

sudo apt-get install libunwind-dev
g++ -fno-pie -ggdb3 -O0 -no-pie -o unwind.out -std=c++11 \
  -Wall -Wextra -pedantic-errors unwind.cpp -lunwind -pthread
./unwind.out

输出:

0x400c80: (my_func_2()+0x9)
0x400cb7: (my_func_1(int)+0x10)
0x400ccc: (main+0x12)
0x7f4c68926b97: (__libc_start_main+0xe7)
0x400a3a: (_start+0x2a)

0x400c80: (my_func_2()+0x9)
0x400ca4: (my_func_1(double)+0x12)
0x400ce1: (main+0x27)
0x7f4c68926b97: (__libc_start_main+0xe7)
0x400a3a: (_start+0x2a)

然后我们就可以找到的线条my_func_2my_func_1(int)用:

addr2line -e unwind.out 0x400c80 0x400cb7

这使:

/home/ciro/test/unwind.cpp:43
/home/ciro/test/unwind.cpp:54

待办事项:为什么线下只有一条线?

在Ubuntu 18.04,GCC 7.4.0,libunwind 1.2.1上测试。

GDB自动化

我们还可以使用GDB进行此操作,而无需使用以下方法进行重新编译:在GDB中遇到某个断点时,如何执行特定操作?

尽管如果您要打印大量回溯记录,这可能会比其他选项快一些,但是也许我们可以使用达到原始速度compile code,但是我现在懒惰地进行测试:如何在gdb中调用Assembly?

main.cpp

void my_func_2(void) {}

void my_func_1(double f) {
    my_func_2();
}

void my_func_1(int i) {
    my_func_2();
}

int main() {
    my_func_1(1);
    my_func_1(2.0);
}

main.gdb

start
break my_func_2
commands
  silent
  backtrace
  printf "\n"
  continue
end
continue

编译并运行:

g++ -ggdb3 -o main.out main.cpp
gdb -nh -batch -x main.gdb main.out

输出:

Temporary breakpoint 1 at 0x1158: file main.cpp, line 12.

Temporary breakpoint 1, main () at main.cpp:12
12          my_func_1(1);
Breakpoint 2 at 0x555555555129: file main.cpp, line 1.
#0  my_func_2 () at main.cpp:1
#1  0x0000555555555151 in my_func_1 (i=1) at main.cpp:8
#2  0x0000555555555162 in main () at main.cpp:12

#0  my_func_2 () at main.cpp:1
#1  0x000055555555513e in my_func_1 (f=2) at main.cpp:4
#2  0x000055555555516f in main () at main.cpp:13

[Inferior 1 (process 14193) exited normally]

TODO我只想-ex从命令行执行此操作,而不必创建它,main.gdb但是我无法在commands那里进行工作。

在Ubuntu 19.04,GDB 8.2中进行了测试。

Linux内核

如何在Linux内核中打印当前线程堆栈跟踪?

libdwfl

最初是在https://stackoverflow.com/a/60713161/895245上提到的,这可能是最好的方法,但是我必须进行更多基准测试,但是请赞成。

TODO:我试图将那个可以正常工作的答案中的代码最小化为一个函数,但是它存在段错误,请让我知道是否有人可以找到原因。

dwfl.cpp

#include <cassert>
#include <iostream>
#include <memory>
#include <sstream>
#include <string>

#include <cxxabi.h> // __cxa_demangle
#include <elfutils/libdwfl.h> // Dwfl*
#include <execinfo.h> // backtrace
#include <unistd.h> // getpid

// /programming/281818/unmangling-the-result-of-stdtype-infoname
std::string demangle(const char* name) {
    int status = -4;
    std::unique_ptr<char, void(*)(void*)> res {
        abi::__cxa_demangle(name, NULL, NULL, &status),
        std::free
    };
    return (status==0) ? res.get() : name ;
}

std::string debug_info(Dwfl* dwfl, void* ip) {
    std::string function;
    int line = -1;
    char const* file;
    uintptr_t ip2 = reinterpret_cast<uintptr_t>(ip);
    Dwfl_Module* module = dwfl_addrmodule(dwfl, ip2);
    char const* name = dwfl_module_addrname(module, ip2);
    function = name ? demangle(name) : "<unknown>";
    if (Dwfl_Line* dwfl_line = dwfl_module_getsrc(module, ip2)) {
        Dwarf_Addr addr;
        file = dwfl_lineinfo(dwfl_line, &addr, &line, nullptr, nullptr, nullptr);
    }
    std::stringstream ss;
    ss << ip << ' ' << function;
    if (file)
        ss << " at " << file << ':' << line;
    ss << std::endl;
    return ss.str();
}

std::string stacktrace() {
    // Initialize Dwfl.
    Dwfl* dwfl = nullptr;
    {
        Dwfl_Callbacks callbacks = {};
        char* debuginfo_path = nullptr;
        callbacks.find_elf = dwfl_linux_proc_find_elf;
        callbacks.find_debuginfo = dwfl_standard_find_debuginfo;
        callbacks.debuginfo_path = &debuginfo_path;
        dwfl = dwfl_begin(&callbacks);
        assert(dwfl);
        int r;
        r = dwfl_linux_proc_report(dwfl, getpid());
        assert(!r);
        r = dwfl_report_end(dwfl, nullptr, nullptr);
        assert(!r);
        static_cast<void>(r);
    }

    // Loop over stack frames.
    std::stringstream ss;
    {
        void* stack[512];
        int stack_size = ::backtrace(stack, sizeof stack / sizeof *stack);
        for (int i = 0; i < stack_size; ++i) {
            ss << i << ": ";

            // Works.
            ss << debug_info(dwfl, stack[i]);

#if 0
            // TODO intended to do the same as above, but segfaults,
            // so possibly UB In above function that does not blow up by chance?
            void *ip = stack[i];
            std::string function;
            int line = -1;
            char const* file;
            uintptr_t ip2 = reinterpret_cast<uintptr_t>(ip);
            Dwfl_Module* module = dwfl_addrmodule(dwfl, ip2);
            char const* name = dwfl_module_addrname(module, ip2);
            function = name ? demangle(name) : "<unknown>";
            // TODO if I comment out this line it does not blow up anymore.
            if (Dwfl_Line* dwfl_line = dwfl_module_getsrc(module, ip2)) {
              Dwarf_Addr addr;
              file = dwfl_lineinfo(dwfl_line, &addr, &line, nullptr, nullptr, nullptr);
            }
            ss << ip << ' ' << function;
            if (file)
                ss << " at " << file << ':' << line;
            ss << std::endl;
#endif
        }
    }
    dwfl_end(dwfl);
    return ss.str();
}

void my_func_2() {
    std::cout << stacktrace() << std::endl;
    std::cout.flush();
}

void my_func_1(double f) {
    (void)f;
    my_func_2();
}

void my_func_1(int i) {
    (void)i;
    my_func_2();
}

int main(int argc, char **argv) {
    long long unsigned int n;
    if (argc > 1) {
        n = strtoul(argv[1], NULL, 0);
    } else {
        n = 1;
    }
    for (long long unsigned int i = 0; i < n; ++i) {
        my_func_1(1);
        my_func_1(2.0);
    }
}

编译并运行:

sudo apt install libdw-dev
g++ -fno-pie -ggdb3 -O0 -no-pie -o dwfl.out -std=c++11 -Wall -Wextra -pedantic-errors dwfl.cpp -ldw
./dwfl.out

输出:

0: 0x402b74 stacktrace[abi:cxx11]() at /home/ciro/test/dwfl.cpp:65
1: 0x402ce0 my_func_2() at /home/ciro/test/dwfl.cpp:100
2: 0x402d7d my_func_1(int) at /home/ciro/test/dwfl.cpp:112
3: 0x402de0 main at /home/ciro/test/dwfl.cpp:123
4: 0x7f7efabbe1e3 __libc_start_main at ../csu/libc-start.c:342
5: 0x40253e _start at ../csu/libc-start.c:-1

0: 0x402b74 stacktrace[abi:cxx11]() at /home/ciro/test/dwfl.cpp:65
1: 0x402ce0 my_func_2() at /home/ciro/test/dwfl.cpp:100
2: 0x402d66 my_func_1(double) at /home/ciro/test/dwfl.cpp:107
3: 0x402df1 main at /home/ciro/test/dwfl.cpp:121
4: 0x7f7efabbe1e3 __libc_start_main at ../csu/libc-start.c:342
5: 0x40253e _start at ../csu/libc-start.c:-1

基准测试:

g++ -fno-pie -ggdb3 -O3 -no-pie -o dwfl.out -std=c++11 -Wall -Wextra -pedantic-errors dwfl.cpp -ldw
time ./dwfl.out 1000 >/dev/null

输出:

real    0m3.751s
user    0m2.822s
sys     0m0.928s

因此,我们看到此方法比Boost的stacktrace快10倍,因此可能适用于更多用例。

在Ubuntu 19.10 amd64,libdw-dev 0.176-1.1中进行了测试。

也可以看看


1
所有的“ TODO:行之间加一”是因为行号是从下一个表达式的开头开始的。
SS安妮


6

每当调用某个函数时,是否有任何方法可以在C或C ++的运行进程中转储调用堆栈?

您可以使用宏函数代替特定函数中的return语句。

例如,与其使用return,

int foo(...)
{
    if (error happened)
        return -1;

    ... do something ...

    return 0
}

您可以使用宏功能。

#include "c-callstack.h"

int foo(...)
{
    if (error happened)
        NL_RETURN(-1);

    ... do something ...

    NL_RETURN(0);
}

每当函数中发生错误时,您都会看到Java样式的调用堆栈,如下所示。

Error(code:-1) at : so_topless_ranking_server (sample.c:23)
Error(code:-1) at : nanolat_database (sample.c:31)
Error(code:-1) at : nanolat_message_queue (sample.c:39)
Error(code:-1) at : main (sample.c:47)

完整的源代码在这里。

位于https://github.com/Nanolat的c-callstack


6

旧线程的另一个答案。

当我需要做到这一点,我通常只使用system()pstack

所以像这样:

#include <sys/types.h>
#include <unistd.h>
#include <string>
#include <sstream>
#include <cstdlib>

void f()
{
    pid_t myPid = getpid();
    std::string pstackCommand = "pstack ";
    std::stringstream ss;
    ss << myPid;
    pstackCommand += ss.str();
    system(pstackCommand.c_str());
}

void g()
{
   f();
}


void h()
{
   g();
}

int main()
{
   h();
}

这个输出

#0  0x00002aaaab62d61e in waitpid () from /lib64/libc.so.6
#1  0x00002aaaab5bf609 in do_system () from /lib64/libc.so.6
#2  0x0000000000400c3c in f() ()
#3  0x0000000000400cc5 in g() ()
#4  0x0000000000400cd1 in h() ()
#5  0x0000000000400cdd in main ()

这应该适用于Linux,FreeBSD和Solaris。我不认为macOS具有pstack或简单的等价物,但是此线程似乎有另一种选择

如果使用C,则将需要使用C字符串函数。

#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>

void f()
{
    pid_t myPid = getpid();
    /*
      length of command 7 for 'pstack ', 7 for the PID, 1 for nul
    */
    char pstackCommand[7+7+1];
    sprintf(pstackCommand, "pstack %d", (int)myPid);
    system(pstackCommand);
}

根据这篇文章,我已经使用7作为PID中的最大位数。


很好,因为主题确实要求C。不,因为std :: string仅是C ++,所以它需要适应。我将使用C版本更新答案。
保罗·弗洛伊德

5

特定于Linux的TLDR:

  1. backtracein glibc仅在-lunwind链接时才会生成准确的堆栈跟踪(未记录的平台特定功能)。
  2. 要输出函数名称源文件行号,请使用#include <elfutils/libdwfl.h>(此库仅在其头文件中记录)。backtrace_symbols而且backtrace_symbolsd_fd信息最少。

在现代Linux上,您可以使用function获得stacktrace地址backtracebacktrace在流行的平台上生成更准确地址的未记录方法是与-lunwindlibunwind-dev在Ubuntu 18.04上)链接(请参见下面的示例输出)。backtrace使用函数_Unwind_Backtrace,默认情况下函数来自函数,libgcc_s.so.1并且实现是最可移植的。当-lunwind连接它提供了一个更准确的版本_Unwind_Backtrace,但这个库的可移植性(见支持的体系结构libunwind/src)。

不幸的是,大约十年来,伴随函数backtrace_symbolsdbacktrace_symbols_fd函数无法将堆栈跟踪地址解析为具有源文件名和行号的函数名(请参见下面的示例输出)。

但是,还有另一种将地址解析为符号的方法,它会生成最有用的跟踪,包括函数名称源文件行号。该方法是#include <elfutils/libdwfl.h>并与-ldwlibdw-dev在Ubuntu 18.04上)链接。

工作的C ++示例(test.cc):

#include <stdexcept>
#include <iostream>
#include <cassert>
#include <cstdlib>
#include <string>

#include <boost/core/demangle.hpp>

#include <execinfo.h>
#include <elfutils/libdwfl.h>

struct DebugInfoSession {
    Dwfl_Callbacks callbacks = {};
    char* debuginfo_path = nullptr;
    Dwfl* dwfl = nullptr;

    DebugInfoSession() {
        callbacks.find_elf = dwfl_linux_proc_find_elf;
        callbacks.find_debuginfo = dwfl_standard_find_debuginfo;
        callbacks.debuginfo_path = &debuginfo_path;

        dwfl = dwfl_begin(&callbacks);
        assert(dwfl);

        int r;
        r = dwfl_linux_proc_report(dwfl, getpid());
        assert(!r);
        r = dwfl_report_end(dwfl, nullptr, nullptr);
        assert(!r);
        static_cast<void>(r);
    }

    ~DebugInfoSession() {
        dwfl_end(dwfl);
    }

    DebugInfoSession(DebugInfoSession const&) = delete;
    DebugInfoSession& operator=(DebugInfoSession const&) = delete;
};

struct DebugInfo {
    void* ip;
    std::string function;
    char const* file;
    int line;

    DebugInfo(DebugInfoSession const& dis, void* ip)
        : ip(ip)
        , file()
        , line(-1)
    {
        // Get function name.
        uintptr_t ip2 = reinterpret_cast<uintptr_t>(ip);
        Dwfl_Module* module = dwfl_addrmodule(dis.dwfl, ip2);
        char const* name = dwfl_module_addrname(module, ip2);
        function = name ? boost::core::demangle(name) : "<unknown>";

        // Get source filename and line number.
        if(Dwfl_Line* dwfl_line = dwfl_module_getsrc(module, ip2)) {
            Dwarf_Addr addr;
            file = dwfl_lineinfo(dwfl_line, &addr, &line, nullptr, nullptr, nullptr);
        }
    }
};

std::ostream& operator<<(std::ostream& s, DebugInfo const& di) {
    s << di.ip << ' ' << di.function;
    if(di.file)
        s << " at " << di.file << ':' << di.line;
    return s;
}

void terminate_with_stacktrace() {
    void* stack[512];
    int stack_size = ::backtrace(stack, sizeof stack / sizeof *stack);

    // Print the exception info, if any.
    if(auto ex = std::current_exception()) {
        try {
            std::rethrow_exception(ex);
        }
        catch(std::exception& e) {
            std::cerr << "Fatal exception " << boost::core::demangle(typeid(e).name()) << ": " << e.what() << ".\n";
        }
        catch(...) {
            std::cerr << "Fatal unknown exception.\n";
        }
    }

    DebugInfoSession dis;
    std::cerr << "Stacktrace of " << stack_size << " frames:\n";
    for(int i = 0; i < stack_size; ++i) {
        std::cerr << i << ": " << DebugInfo(dis, stack[i]) << '\n';
    }
    std::cerr.flush();

    std::_Exit(EXIT_FAILURE);
}

int main() {
    std::set_terminate(terminate_with_stacktrace);
    throw std::runtime_error("test exception");
}

在具有gcc-8.3的Ubuntu 18.04.4 LTS上编译:

g++ -o test.o -c -m{arch,tune}=native -std=gnu++17 -W{all,extra,error} -g -Og -fstack-protector-all test.cc
g++ -o test -g test.o -ldw -lunwind

输出:

Fatal exception std::runtime_error: test exception.
Stacktrace of 7 frames:
0: 0x55f3837c1a8c terminate_with_stacktrace() at /home/max/src/test/test.cc:76
1: 0x7fbc1c845ae5 <unknown>
2: 0x7fbc1c845b20 std::terminate()
3: 0x7fbc1c845d53 __cxa_throw
4: 0x55f3837c1a43 main at /home/max/src/test/test.cc:103
5: 0x7fbc1c3e3b96 __libc_start_main at ../csu/libc-start.c:310
6: 0x55f3837c17e9 _start

当没有-lunwind链接时,它会产生不太准确的堆栈跟踪:

0: 0x5591dd9d1a4d terminate_with_stacktrace() at /home/max/src/test/test.cc:76
1: 0x7f3c18ad6ae6 <unknown>
2: 0x7f3c18ad6b21 <unknown>
3: 0x7f3c18ad6d54 <unknown>
4: 0x5591dd9d1a04 main at /home/max/src/test/test.cc:103
5: 0x7f3c1845cb97 __libc_start_main at ../csu/libc-start.c:344
6: 0x5591dd9d17aa _start

为了进行比较,backtrace_symbols_fd相同stacktrace的输出提供的信息最少:

/home/max/src/test/debug/gcc/test(+0x192f)[0x5601c5a2092f]
/usr/lib/x86_64-linux-gnu/libstdc++.so.6(+0x92ae5)[0x7f95184f5ae5]
/usr/lib/x86_64-linux-gnu/libstdc++.so.6(_ZSt9terminatev+0x10)[0x7f95184f5b20]
/usr/lib/x86_64-linux-gnu/libstdc++.so.6(__cxa_throw+0x43)[0x7f95184f5d53]
/home/max/src/test/debug/gcc/test(+0x1ae7)[0x5601c5a20ae7]
/lib/x86_64-linux-gnu/libc.so.6(__libc_start_main+0xe6)[0x7f9518093b96]
/home/max/src/test/debug/gcc/test(+0x1849)[0x5601c5a20849]

在生产版本(以及C语言版),你可能想使这个代码额外强大的更换boost::core::demanglestd::stringstd::cout与他们潜在的电话。

您还可以重写__cxa_throw以在引发异常时捕获堆栈跟踪,并在捕获异常时将其打印。到它进入catch块时,堆栈已经解开,因此调用为时已晚backtrace,这就是为什么必须捕获堆栈throw并由函数实现的原因__cxa_throw。请注意,在多线程程序中,__cxa_throw可以由多个线程同时调用,因此,如果它将stacktrace捕获到必须为的全局数组中thread_local


1
好答案!研究也很深入。
SS安妮

@SSAnne很好,谢谢。在-lunwind发布本文时发现了这个问题,我以前libunwind直接使用它来获取stacktrace并打算发布它,但是backtrace-lunwind链接时会为我完成。
Maxim Egorushkin

1
@SSAnne可能是因为库David David Mosberger的原始作者最初专注于IA-64,但随后库得到了更多关注nongnu.org/libunwind/people.htmlgcc不公开API,对吗?
Maxim Egorushkin

3

您可以自己实现此功能:

使用全局(字符串)堆栈,并在每个函数开始时将函数名称和其他值(例如参数)推入该堆栈;在功能退出处再次将其弹出。

编写一个函数,该函数将在调用时打印出堆栈内容,并在要查看调用堆栈的函数中使用它。

这听起来可能需要做很多工作,但却非常有用。


2
我不会那样做。相反,我将创建一个使用基础平台特定的API的包装器(请参见下文)。工作量可能是相同的,但投资应能更快获得回报。
Paul Michalik 2010年

3
@paul:当OP明确指定linux时,您的答案是针对Windows的,但对于出现在此处的Windows专家可能很有用。
slashmais 2010年

是的,我忽略了..嗯,这是问题的最后一句话,所以也许发帖者应该修改他的请求,以在更显着的位置提及他/她的目标平台。
Paul Michalik 2010年

1
这将是一个好主意,除了我的代码库包括几十个文件,其中包含数百个(如果不是几千个)文件,因此这是不可行的。
内森·费尔曼

如果您在每个函数声明之后添加一个sed / perl脚本,将call_registror MY_SUPERSECRETNAME(__FUNCTION__);其推入其构造函数中并弹出其析构函数中,则可能不是这样,否则FUNCTION始终代表当前函数的名称。
2010年

2

当然,下一个问题是:够了吗?

堆栈跟踪的主要缺点在于,为什么要调用精确函数,却没有其他东西,例如其参数值,这对于调试非常有用。

如果您可以访问gcc和gdb,建议您使用 assert来检查特定条件,如果不满足,则产生内存转储。当然,这意味着该过程将停止,但是您将拥有完整的报告,而不仅仅是堆栈跟踪。

如果希望使用一种不太麻烦的方法,则可以始终使用日志记录。那里有非常有效的日志记录工具,例如Pantheios。这又可以使您更准确地了解正在发生的事情。


1
当然,这可能还不够,但是如果我看到函数是用一种配置调用的,而不是用另一种配置调用的,那么这是一个很好的起点。
内森·费尔曼

2

您可以为此使用Poppy。它通常用于在崩溃期间收集堆栈跟踪,但也可以将其输出到正在运行的程序。

现在这是个好地方:它可以输出堆栈上每个函数的实际参数值,甚至可以输出局部变量,循环计数器等。


2

我知道此线程很旧,但我认为它对其他人可能有用。如果使用的是gcc,则可以使用其仪器功能(-finstrument-functions选项)记录任何函数调用(进入和退出)。看看这个以获得更多信息: http //hacktalks.blogspot.fr/2013/08/gcc-instrument-functions.html

例如,您可以将每个调用压入并弹出到堆栈中,而要打印时,只需查看堆栈中的内容即可。

我已经对其进行了测试,它可以完美运行并且非常方便

更新:您还可以找到有关-finstrument函数信息有关仪器选项GCC文档编译选项:https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html


您还应该链接到GCC文档,以防文章出现问题。
HolyBlackCat

谢谢,你是对的。我因此添加了一个更新我的帖子的链接到GCC文档
弗朗索瓦

2

您可以使用Boost库来打印当前的调用堆栈。

#include <boost/stacktrace.hpp>

// ... somewhere inside the `bar(int)` function that is called recursively:
std::cout << boost::stacktrace::stacktrace();

此处的人:https : //www.boost.org/doc/libs/1_65_1/doc/html/stacktrace.html


cannot locate SymEnumSymbolsExW at C:\Windows\SYSTEM32\dbgeng.dll在Win10上遇到错误。
zwcloud


-6

每当调用某个函数时,是否有任何方法可以在C或C ++的运行进程中转储调用堆栈?

没有,尽管可能存在依赖平台的解决方案。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.