找出程序的调用堆栈 trace 可以知道是谁调用了这个接口,也能快速学习程序的调用流程,非常实用。但需要注意的是,不能在正式代码中使用,只能用于调试,这个非常耗资源也会造成 log 泛滥。
下面就介绍如何在 Android Java/C++/C 程序当中打印出程序调用 trace,如果需要在其他环境中使用的话 C++/C 部分需要移植 corkscrew 库。
Java
非常简单,创建一个 Throwable
对象,就可以得到当前的 stack trace。下面例子是打出调用 foobar()
函数的 trace:
private void foobar() {
Throwable t = new Throwable();
Log.d(TAG, "stack trace is ", t);
}
C++
也比较简单,使用 utils/Callstack
类即可。头文件位于 frameworks/native/include/utils/CallStack.h
,一般无需修改 Android.mk 可直接使用。下面例子是打出调用 Foo::bar()
函数的 trace:
#include <utils/CallStack.h>
void Foo::bar() {
// CallStack::CallStack(const char* logtag, int32_t ignoreDepth, int32_t maxDepth)
CallStack *t = new CallStack("Trace", 1, 30);
delete t;
}
C
稍微麻烦一点,需要直接调用 corkscrew/backtrace
。其实 C++ 里的 utils/Callstack
也是使用 corkscrew/backtrace
,只是进行了封装更易于使用。我们参照 CallStack.cpp
里面代码即可。下面例子是打出调用 foobar()
函数的 trace:
NOTE: C 不能直接调用 C++ 代码,除非在 C++ 类中添加相应的 C wrapper,或者通过 dlsym 动态载入。
#include <corkscrew/backtrace.h>
void dumpStackTrace(const char* logtag, int32_t ignoreDepth, int32_t maxDepth) const {
static const int MAX_DEPTH = 31;
static const int MAX_BACKTRACE_LINE_LENGTH = 800;
if (maxDepth > MAX_DEPTH) {
maxDepth = MAX_DEPTH;
}
backtrace_frame_t mStack[MAX_DEPTH];
ssize_t count = unwind_backtrace(mStack, ignoreDepth + 1, maxDepth);
if (count <= 0) {
LOGE("Can not get stack trace");
return;
}
backtrace_symbol_t symbols[count];
get_backtrace_symbols(mStack, count, symbols);
for (size_t i = 0; i < count; i++) {
char line[MAX_BACKTRACE_LINE_LENGTH];
format_backtrace_line(i, &mStack[i], &symbols[i],
line, MAX_BACKTRACE_LINE_LENGTH);
ALOG(LOG_DEBUG, logtag, "%s%s",
"",
line);
}
free_backtrace_symbols(symbols, count);
}
void foobar() {
dumpStackTrace("Trace", 1, 30);
}
头文件位于 system/core/include/corkscrew/backtrace.h
,在 Android.mk 中还需要加入:
LOCAL_SHARED_LIBRARIES += libcorkscrew