为1900个JNI函数添加日志

Android Native库的调试一直是个复杂的事，通常调试方法有输出日志和使用ADT等插件方法，前者较简单，TouchVG就使用日志输出方式来调试定位：

1. 在CPP文件中 #include "mglog.h"，在要调试的函数中调用 LOGD("your message %d", someint);
2. 在 Eclipse 中设置 LogCat 过滤串: tag:dalvikvm|AndroidRuntime|vgjni|touchvg|vgstack|libc

最近遇到一些libc崩溃问题，需要在C++代码中定位。首先需要定位JNI入口函数，而SWIG生成touchvg_java_wrap.cpp有4万行代码、1900多个JNI函数，不可能一个个去加日志。

当然写脚本自动干这事了，这里是Python脚本内容。

#!/usr/bin/env python
# addlog.py: Add logging entry for each JNI function
# author: Zhang Yungui <github.com/rhcad>
# Usage:
# 1. Call `python addlog.py` in jni/build.sh
# 2. Then type `./build.sh -swig` to re-generate touchvg_java_wrap.cpp

import os, re

file = os.path.abspath('touchvg_java_wrap.cpp')
text = open(file).read()
blks = []
prog = re.compile(r'SWIGEXPORT (void|j).*{')
funp = re.compile(r'Java_.*\(')

funcstr = '''#include <android/log.h>
struct TmpLogFunc {
    const char* name;
    TmpLogFunc(const char* name) : name(name) {
        __android_log_print(ANDROID_LOG_VERBOSE,"vgstack","%s enter",name);
    }
    ~TmpLogFunc() {
        __android_log_print(ANDROID_LOG_VERBOSE,"vgstack","%s exit",name);
    }
};'''

text = text.replace('struct TmpJOBJ {',  funcstr + '\nstruct TmpJOBJ {')

while True:
    match = prog.search(text)
    if match:
        pos = match.end() + 1
        mfn = funp.search(text)
        name = text[mfn.start():mfn.end()-1]
        blks.append(text[:pos])
        blks.append(r'  TmpLogFunc logf("' + name + '\");\n')
        text = text[pos:]
    else:
        blks.append(text)
        break

text = ''.join(blks)
open(file, 'w').write(text)

在编写脚本的过程中，复习了正则表达式、字符串和列表的相互转换方法。自动添加日志后，立即定位到崩溃的JNI函数。然后逐级添加LOGD语句找到崩溃原因：在一个扩展模块中，对象在一个函数内释放后，在外部函数继续使用–野指针！