Android之Systrace

1 简介

https://www.lizenghai.com/archives/26061.html

2 用法

用命令行启动Systrace抓取采样：《Capture a system trace on the command line》

自定义采样的方法：《Define custom events》这个方法确实要仔细看，尤其是采样命令的描述，强调了要使用 -a 参数，之前我忽略了这一点，导致自定义的标签总也显示不出来。

python systrace.py -a com.autonavi.amapauto -b  -o my_systrace_report.html sched freq idle am wm gfx view binder_driver hal dalvik camera input res

【坑】采用Android Device Monitor来抓取Systrace时有一个坑，就是经常出现Java heap error（因为我自动插桩所有函数，导致Systrace标签数量庞大），后来发现原因在于Monitor配置的Java堆最大值太小了，收集trace数据时需要大量的堆（怀疑是做数据合并加工）引发堆空间错误。解决方法如下：

. 找到Monitor脚本所在目录，里面有lib\monitor-x86，例如：C:\Users\liuheng.klh\AppData\Local\Android\Sdk\tools\lib\monitor-x86（或monitor-x86_64）
. 打开monitor.ini 配置文件，修改如下三项空间配置（尽可能大点就行）：
-XX:MaxPermSize=1024m
-Xms2048m
-Xmx4096m

（1）实现自定义标签

在Android 6.0（API 23）中包含trace.h，可以在Native层直接进行引用，获取函数指针进行调用。用 ATRACE_CALL 宏直接在需要插桩的函数入口调用一下即可。关键代码：

 #include <android/trace.h>

 /////////////////////////////////////////////////////////////////////
 // utils.h
 extern void *(*_ATrace_beginSection) (const char* sectionName) __attribute__ ((no_instrument_function));
 extern void *(*_ATrace_endSection) (void) __attribute__ ((no_instrument_function));
 extern bool *(*_ATrace_isEnabled) (void) __attribute__ ((no_instrument_function));

 // SysTrace
 class ScopedTrace {
     const char* _name;
 public:
     static bool _bInit;
     static void init() __attribute__ ((no_instrument_function));

     typedef void *(*fp_ATrace_beginSection) (const char* sectionName);
     typedef void *(*fp_ATrace_endSection) (void);
     typedef bool *(*fp_ATrace_isEnabled) (void);

 public:
     inline ScopedTrace(const char* name) __attribute__ ((no_instrument_function)) {
         if (!_bInit) {
             init();
         }
         _ATrace_beginSection(name) ;

         _name = name;
         //LOGD("_ATrace_beginSection(%s) _ATrace_isEnabled()=%d", name, _ATrace_isEnabled());
     }

     inline ~ScopedTrace() __attribute__ ((no_instrument_function)) {
         _ATrace_endSection();
         //LOGD("_ATrace_endSection(%s) _ATrace_isEnabled()=%d", _name, _ATrace_isEnabled());
     }
 };

 #define ATRACE_NAME(name) ScopedTrace ___tracer(name)
 #define ATRACE_CALL() ATRACE_NAME(__FUNCTION__)

 /////////////////////////////////////////////////////////////////////
 // utils.cpp
 void *(*_ATrace_beginSection) (const char* sectionName) = NULL;
 void *(*_ATrace_endSection) (void) = NULL;
 bool *(*_ATrace_isEnabled) (void) = NULL;

 bool ScopedTrace::_bInit = false;
 void ScopedTrace::init() {
     if (_bInit) {
         return;
     }

     // Retrieve a handle to libandroid.
     void *lib = dlopen("libandroid.so", RTLD_NOW || RTLD_LOCAL);

     // Access the native tracing functions.
     if (lib != NULL) {
         // Use dlsym() to prevent crashes on devices running Android 5.1
         // (API level 22) or lower.
         _ATrace_beginSection = reinterpret_cast<fp_ATrace_beginSection>(
                 dlsym(lib, "ATrace_beginSection"));
         _ATrace_endSection = reinterpret_cast<fp_ATrace_endSection>(
                 dlsym(lib, "ATrace_endSection"));
         _ATrace_isEnabled = reinterpret_cast<fp_ATrace_isEnabled>(
                 dlsym(lib, "ATrace_isEnabled"));
     }

     LOGI("lib=%p, _ATrace_beginSection=%p, _ATrace_endSection=%p, _ATrace_isEnabled=%p, ATrace_isEnabled()=%d",
          lib, _ATrace_beginSection, _ATrace_endSection, _ATrace_isEnabled, _ATrace_isEnabled());

     _bInit = true;
 }

Systrace(Native)

（2）一个巧妙的利用——编译器自动插桩

利用gcc的 “-finstrument-functions” 可以实现自动化插桩。关键代码如下：

 // utils.h
 extern "C" {

 void __cyg_profile_func_enter( void *, void * ) __attribute__ ((no_instrument_function));
 void __cyg_profile_func_exit( void *, void * ) __attribute__ ((no_instrument_function));

 }

 // utils.cpp
 #define DUMP(func, call) LOGI("[KLH]%s: func = %p, called by = %p\n", __FUNCTION__, func, call)

 extern "C" {

 void __cyg_profile_func_enter(void *this_func, void *call_site) {
     //DUMP(this_func, call_site);
     char addr[];
     snprintf(addr, , "%p", this_func);

     ScopedTrace::init();

     if ( != _ATrace_isEnabled && _ATrace_isEnabled()) {
         _ATrace_beginSection(addr);
     }
 }

 void __cyg_profile_func_exit(void *this_func, void *call_site) {
     //DUMP(this_func, call_site);

     if ( != _ATrace_isEnabled && _ATrace_isEnabled()) {
         _ATrace_endSection();
     }
 }

 }

自动插桩实现追踪

这里关键的点是需要extern "C"声明原型。

（3）编写一套Python（其他语言也行）工具来翻译加工自动插桩的函数（运行时）地址为函数名。翻译的方法为：

. 获取进程pid：
adb shell ps | adb shell grep [进程名]
分解字符串第一个即是

. 获取进程maps
adb shell cat /proc/[pid]/maps

. 提取trace.html（Systrace报告）中所有运行时地址列表，准备翻译

. 提取所有so的地址段，以此来确定运行时地址所属so及内部相对地址

. 提取so内部相对地址与符号映射表
readelf -sW libXXX.so

. 根据4、5翻译出运行时地址对应的函数符号，并翻译出函数名
c++filt -n [symbol]

. trace.html中线程名缺失的问题可以进一步补充（如果线程中途退出则可能遗漏）：
adb shell cat /proc/pid/task
[foreach] tid
adb shell cat /proc/pid/task/tid/status
得到Name:字段就是线程名称

3 原理