Android使用PGO优化native库运行速度

Profile-guided optimization (PGO)，配置文件引导的优化，基于插桩或采样从程序运行时生成配置文件，使编译器对内联和代码布局做优化，可以获得免费的性能提升。在安卓中使用的教程较少，实际操作时会遇到一些问题，在这里记录一下使用插桩的方式。

1. 使用-fprofile-generate编译和链接经过插桩的动态库

添加编译参数

android {
    ...

    defaultConfig {
        ...
        
        externalNativeBuild {
            cmake {
                cppFlags '-std=c++11 -fprofile-generate'
            }
        }
    }
}

2. 运行具有代表性的流程，收集配置文件

安卓中生成配置文件需在最后手动调用__llvm_profile_write_file方法，在C++中需要添加extern "C"，否则链接时会找不到此方法

extern "C" {
extern int __llvm_profile_write_file(void);
}

加载动态库前需设置环境变量 LLVM_PROFILE_FILE指定配置文件生成位置

static {
    try {
        Os.setenv("LLVM_PROFILE_FILE", "/path/to/%m.profraw", true);
    } catch (ErrnoException e) {
        e.printStackTrace();
    }
    System.loadLibrary("native-lib");
}

LLVM_PROFILE_FILE可以使用下面的修饰符来设置配置文件路径

• %p 进程ID
• %h hostname
• %m 唯一的配置文件名称

如果出现以下错误

java.lang.UnsatisfiedLinkError: dlopen failed: cannot locate symbol "__start___llvm_prf_vnds" referenced by "... .so"

需要改链接程序为lld或者gold，ndk r22开始已经默认使用lld，也可以升级ndk到r22

android {
   ...
   
   ndkVersion '22.1.7171670'
}

3. 使用llvm-profdata合并转换配置文件

如果有多个配置文件，用下面的命令合并和转换

$NDK/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-profdata \
    merge --output=pgo_profile.profdata \
    <list-of-profraw-files>

即使只有一个配置文件也需要用此命令转换格式

4.使用配置文件编译

android {
    ...

    defaultConfig {
        ...
        
        externalNativeBuild {
            cmake {
                cppFlags '-std=c++11 -fprofile-use=/path/to/<>.profdata'
            }
        }
    }
}

代码更改后也可以使用这个配置文件，如果无法继续使用，编译器会生成 -Wprofile-instr-out-of-date警告

参考

1. Profile guided optimization for native Android applications

2. 使用配置文件引导的优化 (PGO)

3. How to compile with Profile Guided Optimization (PGO)