btrace(AKA RheaTrace) is a high performance Android trace tool which is based on Systrace

andrid studio fox classpath 'com.android.tools.build:gradle:3.0.1' distributionUrl=https://services.gradle.org/distributions/gradle-4.1-bin.zip

:app:javaPreCompileDebug UP-TO-DATE
:app:compileDebugJavaWithJavac UP-TO-DATE
:app:compileDebugNdk NO-SOURCE
:app:compileDebugSources UP-TO-DATE
:app:mergeDebugShaders UP-TO-DATE
:app:compileDebugShaders UP-TO-DATE
:app:generateDebugAssets UP-TO-DATE
:app:mergeDebugAssets UP-TO-DATE
:app:extractTryWithResourcesSupportJarDebug UP-TO-DATE
:app:transformClassesWithStackFramesFixerForDebug UP-TO-DATE
:app:transformClassesWithDesugarForDebug UP-TO-DATE
:app:transformClassesWithRheaTraceForDebug FAILED
:app:mergeDebugJniLibFolders UP-TO-DATE
:app:transformNativeLibsWithMergeJniLibsForDebug UP-TO-DATE
:app:processDebugJavaRes NO-SOURCE
:app:transformResourcesWithMergeJavaResForDebug UP-TO-DATE
:app:validateSigningDebug

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:transformClassesWithRheaTraceForDebug'.
> Can't find merged manifest!

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.

* Get more help at https://help.gradle.org

BUILD FAILED in 0s

不支持低版本插件？

I have git cloned btrace and open it using Android Studio, Gradle 6.7.1. Then Gradle project sync failed with this message:

A problem occurred configuring project ':app'. Could not create task ':app:minifyReleaseWithProguard'. Cannot query the value of this provider because it has no value available.

What should I do to sync btrace with Gradle files successfully?

python rheatrace.py -a rhea.sample.android -t 5 -o ./output/mynewtrace.html sched freq idle am wm gfx view binder_driver hal dalvik camera input
2022-03-07 11:06:20,896 - rhea_trace - main_impl - WARNING: - app 'rhea.sample.android' is not installed, please check your inputs.

如图 正常-v可以用 但是第二天命令就不行了 是什么原因呢？ 环境：Mac m1 Python 2.7.18 (default, Oct 2 2021, 04:20:38)

mmb@mmbdeMac-mini rheatrace % python rheatrace.py -v Current version is 1.0.1. mmb@mmbdeMac-mini rheatrace % python rheatrace.py -a rhea.sample.android -t 5 -o ./output/mynewtrace.html sched freq Can't find systrace in environment path

如下systrace 也是正常使用 python systrace.py --time=10 -o mynewtrace.html gfx

Terminal print Error:

(TimeoutThread-2-for-MainThread) Exception on WriteFile(192.168.3.239:5555, /d/tracing/events/android_fs/enable, 1, retries=3, timeout=30), attempt 2 of 4: AdbShellCommandFailedError("(device: 192.168.3.239:5555) shell command run via adb failed on the device:\n command: echo -n 1 > /d/tracing/events/android_fs/enable\n exit status: 1\n output:\n - /system/bin/sh: can't create /d/tracing/events/android_fs/enable: No such file or directory\n",)

增加只转译 atrace 的命令。 python rheatrace.py --only-decode-atrace -a rhea.sample.android 最后会生成可使用 perfetto 解析的 atrace-standard 文件。

之前的 rheatrace 脚本只支持带有 systrace 的基础上才能进行转换。

在一些程序中，会有一些代码在try cath逻辑中抛出异常，这是很常见的写法，比如由一个观察者统一处理异常，如下图： In some programs, there will be some code throwing exceptions in the try cath logic. This is a very common way of writing. For example, an observer handles exceptions uniformly, as shown in the following figure:

private fun methodB(flag: Boolean): Boolean {
        val start = System.currentTimeMillis()
        try {
            var tmp: Long = 0
            for (i in 0 until 200 * 1000 * 1000) {
                tmp += i
            }
            throw Exception()
        } catch (e: Exception) {
            e.printStackTrace()
            if (flag) {
                var tmp: Long = 0
                var i = 0
                while (i < 200 * 1000 * 1000) {
                    tmp += i
                    i++
                }
                methodC()
                Log.i(
                    TAG, String.format(
                        "methodB throw duration %s",
                        System.currentTimeMillis() - start
                    )
                )
                return false
            }
        }
        Log.i(
            TAG, String.format(
                "methodB duration %s",
                System.currentTimeMillis() - start
            )
        )
        return true
    }

这会造成重复的对方法结束点插桩： This will cause repeated instrumentation of the end point of the method:

这样TraceView无法判断哪一个End事件为方法的结束点，造成方法识别错误： In this way, TraceView cannot determine which End event is the end point of the method, resulting in a method identification error: 通过一个简单的算法可以解决这样的问题，保证保留的End事件是最后一个End事件，方法的Trace数据完整性是符合预期的： A simple algorithm can solve this problem, to ensure that the retained End event is the last End event, and the integrity of the trace data of the method is in line with expectations:

我的Demo程序是这样的，大家可以参考实验，在onWindowFocusChanged中（真正开发的时候可不能在主线程这么搞事情哟😄）执行了一个耗时方法，嵌套了两次方法B执行： My demo program is like this. You can refer to the experiment. In onWindowFocusChanged (you can't do this in the main thread when you are really developing 😄), a time-consuming method is executed, and the execution of method B is nested twice:

override fun onWindowFocusChanged(hasFocus: Boolean) {
        DemoMethods.methodA()
        super.onWindowFocusChanged(hasFocus)
    }

package rhea.sample.android.app

import android.util.Log
import java.lang.Exception

object DemoMethods {
    private const val TAG = "DemoMethods"
    fun methodA() {
        val start = System.currentTimeMillis()
        var tmp: Long = 0
        for (i in 0 until 200 * 1000 * 1000) {
            tmp += i
        }
        methodB(false)
        methodB(true)
        var tmp2: Long = 0
        for (i in 0 until 200 * 1000 * 1000) {
            tmp2 += i
        }
        Log.i(
            TAG, String.format(
                "methodA duration %s",
                System.currentTimeMillis() - start
            )
        )
    }

    private fun methodB(flag: Boolean): Boolean {
        val start = System.currentTimeMillis()
        try {
            var tmp: Long = 0
            for (i in 0 until 200 * 1000 * 1000) {
                tmp += i
            }
            throw Exception()
        } catch (e: Exception) {
            e.printStackTrace()
            if (flag) {
                var tmp: Long = 0
                var i = 0
                while (i < 200 * 1000 * 1000) {
                    tmp += i
                    i++
                }
                methodC()
                Log.i(
                    TAG, String.format(
                        "methodB throw duration %s",
                        System.currentTimeMillis() - start
                    )
                )
                return false
            }
        }
        Log.i(
            TAG, String.format(
                "methodB duration %s",
                System.currentTimeMillis() - start
            )
        )
        return true
    }

    private fun methodC() {
        val start = System.currentTimeMillis()
        var tmp: Long = 0
        for (i in 0 until 200 * 1000 * 1000) {
            tmp += i
        }
        Log.i(
            TAG, String.format(
                "methodC duration %s",
                System.currentTimeMillis() - start
            )
        )
    }
}

 /**
     * the method would be injected in the enter of app methods.
     *
     * @param methodId method id.
     */
    public static void i(String methodId) {
        RheaTrace.t(methodId);
    }

    /**
     * the method would be injected in the exits of app methods.
     *
     * @param methodId method id.
     */
    public static void o(String methodId) {
        RheaTrace.t(methodId);
    }

static void t(String methodId) {
        if (!isMainProcess) {
            return;
        }
        if (mainThreadOnly) {
            if (Thread.currentThread() == sMainThread) {
                Trace.beginSection(methodId);
            }
        } else {
            Trace.beginSection(methodId);
        }
    }

写了一点关于 Windows 和 BTrace 的踩坑日记，希望可以帮助大家少走一些弯路。

1. 运行 rheatrace.py 报错: IOError: [Errno 22] invalid mode ('a') or filename:

错误原因: Windows 中文件名不能含有 : 等特殊字符

在 rhea_logger.py 文件中

fh = logging.FileHandler(r'{0}/_log_{1}.log'.format(output_dir, time.strftime("%Y-%m-%d-%H:%M:%S", time.localtime()), encoding='utf-8'))

修改为

fh = logging.FileHandler(r'{0}/_log_{1}.log'.format(output_dir, str(int(time.time())), encoding='utf-8'))

2. 运行 rheatrace.py 过程中, 调用 systrace 报错: subprocess.Popen WindowsError: [Error 2]

报错原因: Windows 安装 Python 2.7 之后的可执行文件名为 python.exe 而不是 python2.7.exe

在 systrace_capturer.py 文件中

cmd = ["python2.7", systrace_path]

修改为

cmd = ["python", systrace_path]

P.S: 如果你有Python 3 可以将 Python 2.7 的可执行文件改名为 python2.exe 然后将以上命令修改为

cmd = ["python2", systrace_path]

3. 运行过程中提示 Unfortunately, start trace failed 或者 failed to write rhea-atrace.gz file completely

报错原因: 无法创建文件和文件夹 (无权限)

在 app 目录下的 **AndroidManifest.xml`` 中声明以下权限:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />

然后通过权限请求库例如 XXPermissions 进行动态申请:

XXPermissions.with(this)
    .permission(Manifest.permission.MANAGE_EXTERNAL_STORAGE)
    .request(new OnPermissionCallback() {
        @Override
        public void onGranted(@NonNull List<String> permissions, boolean all) {
            
        }
    });

重新打开软件后 Toast 消失, 运行 rheatrace.py 无错误提示

4. 运行 rheatrace.py 过程中, 调用 gzip 报错: subprocess.Popen WindowsError: [Error 2]

报错原因: Windows 下没有 gzip 程序

在 Gzip for Windows 网页 下载 gzip 并添加到 PATH 环境变量后重新打开命令行运行 rheatrace.py 即可

经调试，实际报错信息如下：

Traceback (most recent call last):
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/systrace.py", line 48, in <module>
    from systrace import run_systrace
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/systrace/systrace/run_systrace.py", line 42, in <module>
    from systrace import systrace_runner
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/systrace/systrace/systrace_runner.py", line 16, in <module>
    from systrace.tracing_agents import battor_trace_agent
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/systrace/systrace/tracing_agents/battor_trace_agent.py", line 10, in <module>
    from battor import battor_wrapper
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/common/battor/battor/battor_wrapper.py", line 24, in <module>
    from serial.tools import list_ports
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/third_party/pyserial/serial/tools/list_ports.py", line 29, in <module>
    from serial.tools.list_ports_posix import *
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/third_party/pyserial/serial/tools/list_ports_posix.py", line 50, in <module>
    from serial.tools.list_ports_osx import comports
  File "/Users/apple/Library/Android/sdk/platform-tools/systrace/catapult/third_party/pyserial/serial/tools/list_ports_osx.py", line 31, in <module>
    kIOMasterPortDefault = ctypes.c_void_p.in_dll(iokit, "kIOMasterPortDefault")
ValueError: dlsym(RTLD_DEFAULT, kIOMasterPortDefault): symbol not found

2022-10-20 11:24:31.519 2729-2773/rhea.sample.android E/BehaviorCollectManager: Fail to acquire dataAnalyzerService... 2022-10-20 11:24:31.640 2729-2729/rhea.sample.android E/rhea:atrace: failed to create directory /storage/emulated/0/rhea-trace/rhea.sample.android 2022-10-20 11:24:31.652 2729-2900/rhea.sample.android E/AwareLog: AtomicFileUtils: readFileLines file not exist: android.util.AtomicFile@4a40ad0 2022-10-20 11:24:31.844 2729-2902/rhea.sample.android E/.sample.androi: open file error