开始之前
很多语言的log模块都有一个功能,就是在打log的时候能够追溯调用栈,有的时候对查bug能有点帮助。之前我也想过给我们的log模块加上C++的backtrace的功能,迟迟一直没有做主要是两个原因:一是C++的backtrace在各个平台和编译器上都不太一样,比较冗杂;二是C/C++在编译优化之后,调用行之类的信息和甚至一些函数可能就被优化没了。所以能提供的信息就相当有限。前两天刚好有朋友问有没有提供这个,所以就花了点时间整理了下适配方案。
思路和方案
具体到方案上,不同编译器、不同的平台都有自己的规则,但是也有少数的事实标准。所以还是可以笼统地分几个主流平台处理这个backtrace。我参考了一些gcc文档、boost代码和其他流传的一些库和方法,总结起来有几种方案。有些方法能提取去模块名称(函数在哪个动态库和或哪个二进制之类),但是有些不能。所以为了简化并且统一,我就没输出模块名。另外为了方便对比,我先贴一下测试的函数:
// 普通函数 void func1(int times) { if (times > 0) { func1(times - 1); return; } print_trace(); } // 成员函数 class functor2 { public: void func2(int times) { if (times & 0x01) { func2(times - 1); } else { func1(times - 1); } } }; // 静态成员 class functor3 { public: static void func3(int times) { if (times & 0x01) { func3(times - 1); } else { functor2 f; f.func2(times - 1); } } }; // 操作符 struct functor4 { void operator()(int times) { if (times & 0x01) { (*this)(times - 1); } else { functor3::func3(times - 1); } } }; // 本地函数 static void func5(int times) { if (times & 0x01) { func5(times - 1); } else { functor4 f; f(times - 1); } } // 还是普通函数 void func6(int times) { if (times & 0x01) { func6(times - 1); } else { func5(times - 1); } }
Linux/Unix like环境
backtrace方案
libunwind
最简单的一种方式是使用libunwind。他已经给你封装好了接口,比较简单。基本流程就是unw_getcontext->unw_init_local->枚举每一帧unw_get_proc_name+unw_get_proc_info。简化一下代码大概这样:
unw_context_t unw_ctx; unw_cursor_t unw_cur; unw_proc_info_t unw_proc; unw_getcontext(&unw_ctx); unw_init_local(&unw_cur, &unw_ctx); char func_name_cache[4096]; unw_word_t unw_offset; int frame_id = 0; do { // 提取函数符号名到func_name_cache unw_get_proc_name(&unw_cur, func_name_cache, sizeof(func_name_cache), &unw_offset); // 提取函数信息到unw_proc,unw_proc.start_ip就是函数起始地址 unw_get_proc_info(&unw_cur, &unw_proc); int next_res = unw_step(&unw_cur); if (next_res <= 0) { puts("All frames."); } ++ frame_id; } while(true);
execinfo.h和backtrace
第二种是使用gcc/clang自带的execinfo.h和backtrace功能。代码如下:
void *array[BACKTRACE_MAX_FRAME_NUMBER]; size_t size; char **func_name_cache; size = backtrace (array, BACKTRACE_MAX_FRAME_NUMBER); func_name_cache = backtrace_symbols (array, size); for (size_t i = 0; i < size; i++) { // func_name_cache[i] 里就是模块和函数信息 } free (func_name_cache);
但是这种方法很多环境里并没有这个头文件和接口,比如MinGW和Android里都没有。所以好事得有fallback的候选方案。
unwind.h和_Unwind_Backtrace
第三种是用POSIX的 unwind.h: _Unwind_Backtrace。这个虽然MinGW里有,但是返回的数据是空的。NDK里也有,但是我没看是否可以用,ndk似乎提供了自己的backtrace函数,我没有去尝试,应该和这个差不多。
这种方法只能提取出函数地址,并不能解析符号。boost.stacktrace也是用了这种方法,它用_Unwind_Backtrace地区出符号以后用了addr2line去做符号转换,写法很暴力。所以我认为这是最后的fallback方案了。
使用_Unwind