当前位置:   article > 正文

Baseline Profile 安装时优化在西瓜视频的实践

androidstudio benchmark module

动手点关注

ec8b02da7be4da546d76a577712f8dbc.gif

干货不迷路

背景

在Android上,Java/Kotlin代码会编译为DEX字节码,在运行期由虚拟机解释执行。但是,字节码解释执行的速度比较慢。所以,通常虚拟机会在解释模式基础上做一些必要的优化。

在Android 5,Google采用的策略是在应用安装期间对APP的全量DEX进行AOT优化。AOT优化(Ahead of time),就是在APP运行前就把DEX字节码编译成本地机器码。虽然运行效率相比DEX解释执行有了大幅提高,但由于是全量AOT,就会导致用户需要等待较长的时间才能打开应用,对于磁盘空间的占用也急剧增大。

于是,为了避免过早的资源占用,从Android 7开始便不再进行全量AOT,而是JIT+AOT的混合编译模式。JIT(Just in time),就是即时优化,也就是在APP运行过程中,实时地把DEX字节码编译成本地机器码。具体方式是,在APP运行时分析运行过的热代码,然后在设备空闲时触发AOT,在下次运行前预编译热代码,提升后续APP运行效率。

但是热代码代码收集需要比较长周期,在APP升级覆盖安装之后,原有的预编译的热代码失效,需要再走一遍运行时分析、空闲时AOT的流程。在单周迭代的研发模式下问题尤为明显。

因此,从Android 9 开始,Google推出了Cloud Profiles技术。它的原理是,在部分先安装APK的用户手机上,Google Play Store收集到热点代码,然后上传到云端并聚合。这样,对于后面安装的用户,Play Store会下发热点代码配置进行预编译,这些用户就不需要进行运行时分析,大大提前了优化时机。不过,这个收集聚合下发过程需要几天时间,大部分用户还是没法享受到这个优化。

最终,在2022年Google推出了 Baseline Profiles (https://developer.android.com/topic/performance/baselineprofiles/overview?hl=zh-cn)技术。它允许开发者内置自己定义的热点代码配置文件。在APP安装期间,系统提前预编译热点代码,大幅提升APP运行效率。

35523f60645d1a2ac57e9221a8f6570d.png

不过,Google官方的Baseline Profiles存在以下局限性:

  • Baseline Profile 需要使用 AGP 7 及以上的版本,公司内各大APP的版本都还比较低,短期内并不可用

  • 安装时优化依赖Google Play,国内无法使用

为此,我们开发了一套定制化的Baseline Profiles优化方案,可以适用于全版本AGP。同时通过与国内主流厂商合作,推进支持了安装时优化生效。

方案探索与实现

我们先来看一下官方Baseline Profile安装时优化的流程:

88917218bea787091cb9a196572d086a.png

这里面主要包含3个步骤:

  1. 热点方法收集,通过本地运行设备或者人工配置,得到可读格式的基准配置文本文件(baseline-prof.txt)

  2. 编译期处理,将基准配置文本文件转换成二进制文件,打包至apk内(baseline.prof和baseline.profm),另外Google Play服务端还会将云端profile与baseline.prof聚合处理。

  3. 安装时,系统会解析apk内的baseline.prof二进制文件,根据版本号,做一些转换后,提前预编译指定的热点代码为机器码。

热点方法收集

官方文档(https://developer.android.com/topic/performance/baselineprofiles/create-baselineprofile)提到使用Jetpack Macrobenchmark库(https://developer.android.com/macrobenchmark) 和 BaselineProfileRule自动收集热点方法。通过在Android Studio中引入Benchmark module,需要编写相应的Rule触发打包、测试等流程。

从下面源码可以看到,最终是通过profman命令可以收集到app运行过程中的热点方法。

  1. private fun profmanGetProfileRules(apkPath: String, pathOptions: List<String>): String {
  2.     // When compiling with CompilationMode.SpeedProfile, ART stores the profile in one of
  3.     // 2 locations. The `ref` profile path, or the `current` path.
  4.     // The `current` path is eventually merged  into the `ref` path after background dexopt.
  5.     val profiles = pathOptions.mapNotNull { currentPath ->
  6.         Log.d(TAG, "Using profile location: $currentPath")
  7.         val profile = Shell.executeScriptCaptureStdout(
  8.             "profman --dump-classes-and-methods --profile-file=$currentPath --apk=$apkPath"
  9.         )
  10.         profile.ifBlank { null }
  11.     }
  12.     ...
  13.     return builder.toString()
  14. }

所以,我们可以绕过Macrobenchmark库,直接使用profman命令,减少自动化接入成本。具体命令如下:

  1. adb shell profman --dump-classes-and-methods \
  2. --profile-file=/data/misc/profiles/cur/0/com.ss.android.article.video/primary.prof \
  3. --apk=/data/app/com.ss.android.article.video-Ctzj32dufeuXB8KOhAqdGg==/base.apk \
  4. > baseline-prof.txt

生成的baseline-prof.txt文件内容如下:

  1. PLcom/bytedance/apm/perf/b/f;->a(Lcom/bytedance/apm/perf/b/f;)Ljava/lang/String;
  2. PLcom/bytedance/bdp/bdpbase/ipc/n$a;->a()Lcom/bytedance/bdp/bdpbase/ipc/n;
  3. HSPLorg/android/spdy/SoInstallMgrSdk;->initSo(Ljava/lang/String;I)Z
  4. HSPLorg/android/spdy/SpdyAgent;->InvlidCharJudge([B[B)V
  5. Lanet/channel/e/a$b;
  6. Lcom/bytedance/alliance/services/impl/c;
  7. ...

这些规则采用两种形式,分别指明方法和类。方法的规则如下所示:

[FLAGS][CLASS_DESCRIPTOR]->[METHOD_SIGNATURE]

FLAGS表示 HSP 中的一个或多个字符,用于指示相应方法在启动类型方面应标记为 HotStartup 还是 Post Startup

  • 带有 H 标记表示相应方法是一种“热”方法,这意味着相应方法在应用的整个生命周期内会被调用多次。

  • 带有 S 标记表示相应方法在启动时被调用。

  • 带有 P 标记表示相应方法是与启动无关的热方法。

类的规则,则是直接指明类签名即可:

[CLASS_DESCRIPTOR]

不过这里是可读的文本格式,后续还需要进一步转为二进制才可以被系统识别。

另外,release包导出的是混淆后的符号,需要根据mapping文件再做一次反混淆才能使用。

编译期处理

在得到base.apk的基准配置文本文件(baseline-prof.txt)之后还不够,一些库里面

(比如androidx的库里https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:recyclerview/recyclerview/src/main/baseline-prof.txt)

也会自带baseline-prof.txt文件。所以,我们还需要把这些子library内附带的baseline-prof.txt取出来,与base.apk的配置一起合并成完整的基准配置文本文件。

接下来,我们需要把完整的配置文件转换成baseline.prof二进制文件。具体是由AGP 7.x内的 CompileArtProfileTask.kt 实现的 :

  1. /**
  2.  * Task that transforms a human readable art profile into a binary form version that can be shipped
  3.  * inside an APK or a Bundle.
  4.  */
  5. abstract class CompileArtProfileTask: NonIncrementalTask() {
  6. ...
  7.     abstract class CompileArtProfileWorkAction:
  8.             ProfileAwareWorkAction<CompileArtProfileWorkAction.Parameters>() {
  9.         override fun run() {
  10.             val diagnostics = Diagnostics {
  11.                     error -> throw RuntimeException("Error parsing baseline-prof.txt : $error")
  12.             }
  13.             val humanReadableProfile = HumanReadableProfile(
  14.                 parameters.mergedArtProfile.get().asFile,
  15.                 diagnostics
  16.             ) ?: throw RuntimeException(
  17.                 "Merged ${SdkConstants.FN_ART_PROFILE} cannot be parsed successfully."
  18.             )
  19.             val supplier = DexFileNameSupplier()
  20.             val artProfile = ArtProfile(
  21.                     humanReadableProfile,
  22.                     if (parameters.obfuscationMappingFile.isPresent) {
  23.                         ObfuscationMap(parameters.obfuscationMappingFile.get().asFile)
  24.                     } else {
  25.                         ObfuscationMap.Empty
  26.                     },
  27.                     //need to rename dex files with sequential numbers the same way [DexIncrementalRenameManager] does
  28.                     parameters.dexFolders.asFileTree.files.sortedWith(DexFileComparator()).map {
  29.                         DexFile(it.inputStream(), supplier.get())
  30.                     }
  31.             )
  32.             // the P compiler is always used, the server side will transcode if necessary.
  33.             parameters.binaryArtProfileOutputFile.get().asFile.outputStream().use {
  34.                 artProfile.save(it, ArtProfileSerializer.V0_1_0_P)
  35.             }
  36.             // create the metadata.
  37.             parameters.binaryArtProfileMetadataOutputFile.get().asFile.outputStream().use {
  38.                 artProfile.save(it, ArtProfileSerializer.METADATA_0_0_2)
  39.             }
  40.         }
  41.     }

这里的核心逻辑就是做了以下3件事:

  1. 读取baseline-prof.txt基准配置文本文件,下文用HumanReadableProfile表示

  2. 将HumanReadableProfile、proguard mapping文件、dex文件作为输入传给ArtProfile

  3. 由ArtProfile生成特定版本格式的baseline.prof二进制文件

ArtProfile类是在profgen子工程内实现的,其中有两个关键的方法:

  • 构造方法:读取HumanReadableProfile、proguard mapping文件、dex文件作为参数,构造ArtProfile实例

  • save()方法:输出指定版本格式的baseline.prof二进制文件

参考链接:

https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:profgen/profgen/src/main/kotlin/com/android/tools/profgen/

至此,我们可以基于profgen开发一个gradle plugin,在编译构建流程中插入一个自定义task,将baseline-prof.txt转换成baseline.prof,并内置到apk的asset目录。

7e2805c037079bd753185f680686c520.png

核心代码如下:

  1. val packageAndroidTask =
  2.     variant.variantScope.taskContainer.packageAndroidTask?.get()
  3. packageAndroidTask?.doFirst {
  4.     var dexFiles = collectDexFiles(variant.packageApplication.dexFolders)
  5.     dexFiles = dexFiles.sortedWith(DexFileComparator()) 
  6.     //基准配置文件的内存表示
  7.     var hrp = HumanReadableProfile("baseline-prof.txt")
  8.     var obfFile: File? = getObfFile(variant, proguardTask)
  9.     val apk = Apk(dexFiles, "")
  10.     val obf =
  11.         if (obfFile != null) ObfuscationMap(obfFile) else ObfuscationMap.Empty
  12.     val profile = ArtProfile(hrp!!, obf, apk)
  13.     val dexoptDir = File(variant.mergedAssets.first(), profDir)
  14.     if (!dexoptDir.exists()) {
  15.         dexoptDir.mkdirs()
  16.     }
  17.     val outFile = File(dexoptDir, "baseline.prof")
  18.     val metaFile = File(dexoptDir, "baseline.profm")
  19.     profile.save(outFile.outputStream(), ArtProfileSerializer.V0_1_0_P)
  20.     profile.save(metaFile.outputStream(), ArtProfileSerializer.METADATA_0_0_2)
  21.   }

自定义task主要包含以下几个步骤:

  1. 解压apk获取dex列表,按照一定规则排序(跟Android的打包规则有关,dex文件名和crc等信息需要和prof二进制文件内的对应上)

  2. 通过ObfuscationMap将baseline-prof.txt文件中的符号转换成混淆后的符号

  3. 通过ArtProfile按照一定格式转换成baseline.prof与baseline.profm二进制文件

其中有两个文件:

  • baseline.prof:包含热点方法id、类id信息的二进制编码文件

  • baseline.profm:用于高版本转码的二进制扩展文件

关于baseline.prof的格式,我们从ArtProfileSerializer.kt的注释可以看到不同Android版本有不同的格式。Android 12 开始需要另外转码才能兼容,详见可以看这个issue:

参考链接:https://issuetracker.google.com/issues/234353689

安装期处理

在生成带有baseline.prof二进制文件的APK之后,再来看一下系统在安装apk时如何处理这个baseline.prof文件(基于Android 13源码分析)。本地测试通过adb install-multiple release.apk release.dm命令执行安装,然后通过Android系统包管理子系统进行安装时优化。

Android系统包管理框架分为3层:

  1. 应用层:应用通过getPackageManager获取PMS的实例,用于应用的安装,卸载,更新等操作

  2. PMS服务层:拥有系统权限,解析并记录应用的基本信息(应用名称,数据存放路径、关系管理等),最终通过binder系统层的installd系统服务进行通讯

  3. Installd系统服务层:拥有root权限,完成最终的apk安装、dex优化

7edf11fa7fa744337f12e148fc12a4e4.png

其中处理baseline.prof二进制文件并最终指导编译生成odex的主要路径如下:

  1. InstallPackageHelper.java#installPackagesLI
  2.     InstallPackageHelper.java#executePostCommitSteps
  3.         ArtManagerService.java#prepareAppProfiles
  4.             Installer.java#prepareAppProfile
  5.                 InstalldNativeService.cpp#prepareAppProfile
  6.                     dexopt.cpp#prepare_app_profile
  7.                         ProfileAssistant.cpp#ProcessProfilesInternal
  8.         PackageDexOptimizer.java#performDexOpt
  9.             PackageDexOptimizer.java#performDexOptLI
  10.                PackageDexOptimizer.java#dexOptPath
  11.                    InstalldNativeService.cpp#dexopt
  12.                        dexopt.cpp#dexopt
  13.                            dex2oat.cc

在入口installPackagesLI函数中,经过prepare、scan、Reconcile、Commit 四个阶段后最终调用executePostCommitSteps完成apk安装、prof文件写入、dexopt优化:

  1. private void installPackagesLI(List<InstallRequest> requests) {
  2.          //阶段1:prepare
  3.          prepareResult = preparePackageLI(request.mArgs, request.mInstallResult);
  4.          //阶段2:scan
  5.          final ScanResult result = scanPackageTracedLI(
  6.                             prepareResult.mPackageToScan, prepareResult.mParseFlags,
  7.                             prepareResult.mScanFlags, System.currentTimeMillis(),
  8.                             request.mArgs.mUser, request.mArgs.mAbiOverride);
  9.          //阶段3:Reconcile
  10.          reconciledPackages = ReconcilePackageUtils.reconcilePackages(
  11.                             reconcileRequest, mSharedLibraries,
  12.                             mPm.mSettings.getKeySetManagerService(), mPm.mSettings);
  13.          //阶段4:Commit并安装
  14.          commitRequest = new CommitRequest(reconciledPackages,
  15.                             mPm.mUserManager.getUserIds()); 
  16.          executePostCommitSteps(commitRequest);            
  17.     }

executePostCommitSteps中,主要完成prof文件写入与dex优化:

  1. private void executePostCommitSteps(CommitRequest commitRequest) {
  2.         for (ReconciledPackage reconciledPkg : commitRequest.mReconciledPackages.values()) {
  3.             final AndroidPackage pkg = reconciledPkg.mPkgSetting.getPkg();
  4.             final String packageName = pkg.getPackageName();
  5.             final String codePath = pkg.getPath();
  6.  
  7.              //步骤1:prof文件写入
  8.             // Prepare the application profiles for the new code paths.
  9.             // This needs to be done before invoking dexopt so that any install-time profile
  10.             // can be used for optimizations.
  11.             mArtManagerService.prepareAppProfiles(pkg,
  12.                     mPm.resolveUserIds(reconciledPkg.mInstallArgs.mUser.getIdentifier()),
  13.                     /* updateReferenceProfileContent= */ true);
  14.              //步骤2:dex优化,在开启baseline profile优化之后compilation-reason=install-dm
  15.             final int compilationReason =
  16.                     mDexManager.getCompilationReasonForInstallScenario(
  17.                             reconciledPkg.mInstallArgs.mInstallScenario);
  18.             DexoptOptions dexoptOptions =
  19.                     new DexoptOptions(packageName, compilationReason, dexoptFlags);
  20.             if (performDexopt) {
  21.                 // Compile the layout resources.
  22.                 if (SystemProperties.getBoolean(PRECOMPILE_LAYOUTS, false)) {
  23.                     mViewCompiler.compileLayouts(pkg);
  24.                 }
  25.                 ScanResult result = reconciledPkg.mScanResult;
  26.                 mPackageDexOptimizer.performDexOpt(pkg, realPkgSetting,
  27.                         null /* instructionSets */,
  28.                         mPm.getOrCreateCompilerPackageStats(pkg),
  29.                         mDexManager.getPackageUseInfoOrDefault(packageName),
  30.                         dexoptOptions);
  31.             }
  32.             // Notify BackgroundDexOptService that the package has been changed.
  33.             // If this is an update of a package which used to fail to compile,
  34.             // BackgroundDexOptService will remove it from its denylist.
  35.             BackgroundDexOptService.getService().notifyPackageChanged(packageName);
  36.             notifyPackageChangeObserversOnUpdate(reconciledPkg);
  37.         }
  38.         PackageManagerServiceUtils.waitForNativeBinariesExtractionForIncremental(
  39.                 incrementalStorages);
  40.     }

prof文件写入

先来看下prof文件写入流程,主要流程如下图所示:

3756be5aaef52f728338f4c9acbb7c8b.png

其入口在ArtManagerService.java``#``prepareAppProfiles

  1. /**
  2.      * Prepare the application profiles.
  3.      *   - create the current primary profile to save time at app startup time.
  4.      *   - copy the profiles from the associated dex metadata file to the reference profile.
  5.      */
  6.     public void prepareAppProfiles(
  7.             AndroidPackage pkg, @UserIdInt int user,
  8.             boolean updateReferenceProfileContent) {
  9.         try {
  10.             ArrayMap<String, String> codePathsProfileNames = getPackageProfileNames(pkg);
  11.             for (int i = codePathsProfileNames.size() - 1; i >= 0; i--) {
  12.                 String codePath = codePathsProfileNames.keyAt(i);
  13.                 String profileName = codePathsProfileNames.valueAt(i);
  14.                 String dexMetadataPath = null;
  15.                 // Passing the dex metadata file to the prepare method will update the reference
  16.                 // profile content. As such, we look for the dex metadata file only if we need to
  17.                 // perform an update.
  18.                 if (updateReferenceProfileContent) {
  19.                     File dexMetadata = DexMetadataHelper.findDexMetadataForFile(new File(codePath));
  20.                     dexMetadataPath = dexMetadata == null ? null : dexMetadata.getAbsolutePath();
  21.                 }
  22.                 synchronized (mInstaller) {
  23.                     boolean result = mInstaller.prepareAppProfile(pkg.getPackageName(), user, appId,
  24.                             profileName, codePath, dexMetadataPath);
  25.                 }
  26.             }
  27.         } catch (InstallerException e) {
  28.         }
  29.     }

其中dexMetadata是后缀为.dm的压缩文件,内部包含primary.prof、primary.profm文件,apk的baseline.prof、baseline.profm会在安装阶段转为成dm文件。

mInstaller.prepareAppProfile最终会调用到dexopt.cpp#prepare_app_profile中,通过fork一个子进程执行profman二进制程序,将dm文件、reference_profile文件(位于设备上固定路径,存储汇总的热点方法)、apk文件作为参数输入:

  1. //frameworks/native/cmds/installd/dexopt.cpp
  2. bool prepare_app_profile(const std::string& package_name,
  3.                          userid_t user_id,
  4.                          appid_t app_id,
  5.                          const std::string& profile_name,
  6.                          const std::string& code_path,
  7.                          const std::optional<std::string>& dex_metadata) {
  8.     // We have a dex metdata. Merge the profile into the reference profile.
  9.     unique_fd ref_profile_fd =
  10.             open_reference_profile(multiuser_get_uid(user_id, app_id), package_name, profile_name,
  11.                                    /*read_write*/ true/*is_secondary_dex*/ false);
  12.     unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
  13.             open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
  14.     unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
  15.     RunProfman args;
  16.     args.SetupCopyAndUpdate(dex_metadata_fd,
  17.                             ref_profile_fd,
  18.                             apk_fd,
  19.                             code_path);
  20.     pid_t pid = fork();
  21.     if (pid == 0) {
  22.         args.Exec();
  23.     }
  24.     return true;
  25. }
  26.     void SetupCopyAndUpdate(const unique_fd& profile_fd,
  27.                             const unique_fd& reference_profile_fd,
  28.                             const unique_fd& apk_fd,
  29.                             const std::string& dex_location) {
  30.         SetupArgs(...);
  31.     }
  32.     void SetupArgs(const std::vector<T>& profile_fds,
  33.                    const unique_fd& reference_profile_fd,
  34.                    const std::vector<U>& apk_fds,
  35.                    const std::vector<std::string>& dex_locations,
  36.                    bool copy_and_update,
  37.                    bool for_snapshot,
  38.                    bool for_boot_image) {
  39.         const char* profman_bin = select_execution_binary("/profman");
  40.         if (reference_profile_fd != -1) {
  41.             AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
  42.         }
  43.         for (const T& fd : profile_fds) {
  44.             AddArg("--profile-file-fd=" + std::to_string(fd.get()));
  45.         }
  46.         for (const U& fd : apk_fds) {
  47.             AddArg("--apk-fd=" + std::to_string(fd.get()));
  48.         }
  49.         for (const std::string& dex_location : dex_locations) {
  50.             AddArg("--dex-location=" + dex_location);
  51.         }
  52.         ...
  53. }

实际上,就是执行了下面的profman命令:

  1. ./profman --reference-profile-file-fd=9 \
  2. --profile-file-fd=10 --apk-fd=11 \
  3. --dex-location=/data/app/com.ss.android.article.video-4-JZaMrtO7n_kFe4kbhBBA==/base.apk \
  4. --copy-and-update-profile-key

reference-profile-file-fd指向/data/misc/profile/ref/$package/primary.prof文件,记录当前apk版本的热点方法,最终baseline.prof保存的热点方法信息需要写入到reference-profile文件。

profman二进制程序的代码如下:

  1. class ProfMan final {
  2.  public:
  3.   void ParseArgs(int argc, char **argv) {
  4.     MemMap::Init();
  5.     for (int i = 0; i < argc; ++i) {
  6.       if (StartsWith(option, "--profile-file=")) {
  7.         profile_files_.push_back(std::string(option.substr(strlen("--profile-file="))));
  8.       } else if (StartsWith(option, "--profile-file-fd=")) {
  9.         ParseFdForCollection(raw_option, "--profile-file-fd=", &profile_files_fd_);
  10.       } else if (StartsWith(option, "--dex-location=")) {
  11.         dex_locations_.push_back(std::string(option.substr(strlen("--dex-location="))));
  12.       } else if (StartsWith(option, "--apk-fd=")) {
  13.         ParseFdForCollection(raw_option, "--apk-fd=", &apks_fd_);
  14.       } else if (StartsWith(option, "--apk=")) {
  15.         apk_files_.push_back(std::string(option.substr(strlen("--apk="))));
  16.       } 
  17.       ...
  18.   }
  19.  
  20.  static int profman(int argc, char** argv) {
  21.   ProfMan profman;
  22.   // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
  23.   profman.ParseArgs(argc, argv);
  24.   // Initialize MemMap for ZipArchive::OpenFromFd.
  25.   MemMap::Init(); 
  26.   ...
  27.    // Process profile information and assess if we need to do a profile guided compilation.
  28.   // This operation involves I/O.
  29.   return profman.ProcessProfiles();
  30.   }

可以看到最后一行调用到profman的ProcessProfiles方法,它里面调用了ProfileAssistant.cpp#ProcessProfilesInternal[https://cs.android.com/android/platform/superproject/+/master:art/profman/profile_assistant.cc;l=30?q=ProcessProfilesInternal],核心代码如下:

  1. ProfmanResult::ProcessingResult ProfileAssistant::ProcessProfilesInternal(
  2.     const std::vector<ScopedFlock>& profile_files,
  3.     const ScopedFlock& reference_profile_file,
  4.     const ProfileCompilationInfo::ProfileLoadFilterFn& filter_fn,
  5.     const Options& options) {
  6.   ProfileCompilationInfo info(options.IsBootImageMerge());
  7.   //步骤1:Load the reference profile.
  8.   if (!info.Load(reference_profile_file->Fd(), true, filter_fn)) {
  9.     return ProfmanResult::kErrorBadProfiles;
  10.   }
  11.    // Store the current state of the reference profile before merging with the current profiles.
  12.    uint32_t number_of_methods = info.GetNumberOfMethods();
  13.    uint32_t number_of_classes = info.GetNumberOfResolvedClasses();
  14.   //步骤2:Merge all current profiles.
  15.   for (size_t i = 0; i < profile_files.size(); i++) {
  16.     ProfileCompilationInfo cur_info(options.IsBootImageMerge());
  17.     if (!cur_info.Load(profile_files[i]->Fd(), /*merge_classes=*/ true, filter_fn)) {
  18.       return ProfmanResult::kErrorBadProfiles;
  19.     }
  20.     if (!info.MergeWith(cur_info)) {
  21.       return ProfmanResult::kErrorBadProfiles;
  22.     }
  23.   }
  24.   // 如果新增方法/类没有达到阈值,则跳过
  25.  if (((info.GetNumberOfMethods() - number_of_methods) < min_change_in_methods_for_compilation) 
  26.      && ((info.GetNumberOfResolvedClasses() - number_of_classes) < min_change_in_classes_for_compilation)) {
  27.       return kSkipCompilation;
  28.    }
  29.   ...
  30.     //步骤3:We were successful in merging all profile information. Update the reference profile.
  31.   ...
  32.   if (!info.Save(reference_profile_file->Fd())) {
  33.     return ProfmanResult::kErrorIO;
  34.   }  
  35.   return options.IsForceMerge() ? ProfmanResult::kSuccess : ProfmanResult::kCompile;
  36. }

这里首先通过ProfileCompilationInfo的load方法,读取reference_profile二进制文件序列化加载到内存。再调用MergeWith方法将cur_profile二进制文件(也就是apk内的baseline.prof)合并到reference_profile文件中,最后调用Save方法保存。

再来看下ProfileCompilationInfo的类结构,可以发现与前面编译期处理提到的ArtProfile序列化格式是一致的。

参考链接:https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:profgen/profgen/src/main/kotlin/com/android/tools/profgen/ArtProfileSerializer.kt

  1. //art/libprofile/profile/profile_compilation_info.h
  2. /**
  3.  * Profile information in a format suitable to be queried by the compiler and
  4.  * performing profile guided compilation.
  5.  * It is a serialize-friendly format based on information collected by the
  6.  * interpreter (ProfileInfo).
  7.  * Currently it stores only the hot compiled methods.
  8.  */
  9. class ProfileCompilationInfo {
  10.  public:
  11.   static const uint8_t kProfileMagic[];
  12.   static const uint8_t kProfileVersion[];
  13.   static const uint8_t kProfileVersionForBootImage[];
  14.   static const char kDexMetadataProfileEntry[];
  15.   static constexpr size_t kProfileVersionSize = 4;
  16.   static constexpr uint8_t kIndividualInlineCacheSize = 5;
  17.   ...
  18.  }

dex优化

分析完prof二进制文件处理流程之后,接着再来看dex优化部分。主要流程如下图所示:

72c487b5b633bedcc5d3580eb609a32b.png

dex优化的入口函数PackageDexOptimizer.java#performDexOptLI,跟踪代码可以发现最终是通过调用dex2oat二进制程序:

  1. //dexopt.cpp
  2. int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
  3.         int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
  4.         const char* volume_uuid, const char* class_loader_context, const char* se_info,
  5.         bool downgrade, int target_sdk_version, const char* profile_name,
  6.         const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg,
  7.         /* out */ bool* completed) {
  8.     ...    
  9.     RunDex2Oat runner(dex2oat_bin, execv_helper.get());
  10.     runner.Initialize(...);
  11.     bool cancelled = false;
  12.     pid_t pid = dexopt_status_->check_cancellation_and_fork(&cancelled);
  13.     if (cancelled) {
  14.         *completed = false;
  15.         return 0;
  16.     }
  17.     if (pid == 0) {
  18.         //设置schedpolicy,设置为后台线程
  19.         SetDex2OatScheduling(boot_complete);
  20.         //执行dex2oat命令
  21.         runner.Exec(DexoptReturnCodes::kDex2oatExec);
  22.     } else {
  23.         //父进程等待dex2oat子进程执行完,超时时间9.5分钟.
  24.         int res = wait_child_with_timeout(pid, kLongTimeoutMs);
  25.         if (res == 0) {
  26.             LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
  27.         } else {
  28.             //dex2oat执行失败
  29.         }
  30.     }
  31.     // dex2oat ran successfully, so profile is safe to keep.
  32.     reference_profile.DisableCleanup();
  33.     return 0;
  34. }

实际上是执行了如下命令:

  1. /apex/com.android.runtime/bin/dex2oat \
  2. --input-vdex-fd=-1 --output-vdex-fd=11 \
  3. --resolve-startup-const-strings=true \
  4. --max-image-block-size=524288 --compiler-filter=speed-profile --profile-file-fd=14 \
  5. --classpath-dir=/data/app/com.ss.android.article.video-4-JZaMrtO7n_kFe4kbhBBA== \
  6. --class-loader-context=PCL[]{PCL[/system/framework/org.apache.http.legacy.jar]} \
  7. --generate-mini-debug-info --compact-dex-level=none --dm-fd=15 \
  8. --compilation-reason=install-dm

常规安装时不会带上dm-fd和install-dm参数,所以不会触发baseline profile相关优化。

dex2oat用于将dex字节码编译成本地机器码,相关的编译流程如下代码:

  1. static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
  2.   TimingLogger timings("compiler"falsefalse);
  3.   // 解析参数
  4.   dex2oat->ParseArgs(argc, argv);
  5.   art::MemMap::Init(); 
  6.   // 加载profile热点方法文件
  7.   if (dex2oat->HasProfileInput()) {
  8.     if (!dex2oat->LoadProfile()) {
  9.       return dex2oat::ReturnCode::kOther;
  10.     }
  11.   }
  12.   //打开输入文件
  13.   dex2oat->OpenFile();
  14.   //准备de2oat环境,包括启动runtime、加载boot class path
  15.   dex2oat::ReturnCode setup_code = dex2oat->Setup();
  16.    //检查profile热点方法是否被加载到内存,并做crc校验
  17.   if (dex2oat->DoProfileGuidedOptimizations()) { 
  18.     //校验profile_compilation_info_中dex的crc与apk中dex的crc是否一致
  19.     dex2oat->VerifyProfileData();
  20.   }
  21.   ...  
  22.   //正式开始编译
  23.   dex2oat::ReturnCode result = DoCompilation(*dex2oat);
  24.   ...  
  25.   return result;
  26. }

这个流程包含:

  • 解析命令行传入的参数

  • 调用LoadProfile()加载profile热点方法文件,保存到profile_compilation_info_成员变量中

  • 准备dex2oat环境,包括启动unstarted runtime、加载boot class path

  • profile相关校验,主要检查profile_compilation_info_中的dex的crc与apk中dex的crc是否一致,方法数是否一致

  • 调用DoCompilation正式开始编译

LoadProfile方法加载profile热点方法文件如下代码:

  1. bool LoadProfile() {
  2.     //初始化profile热点方法的内存对象:profile_compilation_info_
  3.     profile_compilation_info_.reset(new ProfileCompilationInfo());
  4.     //读取reference profile文件列表
  5.     // Dex2oat only uses the reference profile and that is not updated concurrently by the app or
  6.     // other processes. So we don't need to lock (as we have to do in profman or when writing the
  7.     // profile info).
  8.     std::vector<std::unique_ptr<File>> profile_files;
  9.     if (!profile_file_fds_.empty()) {
  10.       for (int fd : profile_file_fds_) {
  11.         profile_files.push_back(std::make_unique<File>(DupCloexec(fd)));
  12.       }
  13.     } 
  14.     ...
  15.     //依次加载到profile_compilation_info_中
  16.     for (const std::unique_ptr<File>& profile_file : profile_files) {
  17.       if (!profile_compilation_info_->Load(profile_file->Fd())) {
  18.         return false;
  19.       }
  20.     }
  21.     return true;
  22.   }

LoadProfile方法,将之前生成的profile文件加载到内存,保存到profile_compilation_info_变量中。

接着调用Compile方法完成odex文件的编译生成,如下代码:

  1. // Set up and create the compiler driver and then invoke it to compile all the dex files.
  2.   jobject Compile() REQUIRES(!Locks::mutator_lock_) {
  3.     ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
  4.     
  5.     TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
  6.     ...
  7.     compiler_options_->profile_compilation_info_ = profile_compilation_info_.get();
  8.     driver_.reset(new CompilerDriver(compiler_options_.get(),
  9.                                      verification_results_.get(),
  10.                                      compiler_kind_,
  11.                                      thread_count_,
  12.                                      swap_fd_));
  13.     driver_->PrepareDexFilesForOatFile(timings_);
  14.     return CompileDexFiles(dex_files);
  15.   }

profile_compilation_info_作为参数传给了CompilerDriver,在之后的编译过程中将用来判断是否编译某个方法和机器码重排。

CompilerDriver::Compile方法开始编译dex字节码,代码如下:

  1. void CompilerDriver::Compile(jobject class_loader,
  2.                              const std::vector<const DexFile*>& dex_files,
  3.                              TimingLogger* timings) {
  4.   for (const DexFile* dex_file : dex_files) {
  5.     CompileDexFile(this,class_loader,*dex_file,dex_files,
  6.                    "Compile Dex File Quick",CompileMethodQuick);
  7.   }
  8. }
  9. static void CompileMethodQuick(...) {
  10.   auto quick_fn = [profile_index](...) {
  11.     CompiledMethod* compiled_method = nullptr;
  12.     if ((access_flags & kAccNative) != 0) {
  13.         //jni方法编译...
  14.     } else if ((access_flags & kAccAbstract) != 0) {
  15.       // Abstract methods don't have code.
  16.     } else if (annotations::MethodIsNeverCompile(dex_file,
  17.                                                  dex_file.GetClassDef(class_def_idx),
  18.                                                  method_idx)) {
  19.       // Method is annotated with @NeverCompile and should not be compiled.
  20.     } else {
  21.       const CompilerOptions& compiler_options = driver->GetCompilerOptions();
  22.       const VerificationResults* results = driver->GetVerificationResults();
  23.       MethodReference method_ref(&dex_file, method_idx);
  24.       // Don't compile class initializers unless kEverything.
  25.       bool compile = (compiler_options.GetCompilerFilter() == CompilerFilter::kEverything) ||
  26.          ((access_flags & kAccConstructor) == 0) || ((access_flags & kAccStatic) == 0);
  27.       // Check if it's an uncompilable method found by the verifier.
  28.       compile = compile && !results->IsUncompilableMethod(method_ref);
  29.       // Check if we should compile based on the profile.
  30.       compile = compile && ShouldCompileBasedOnProfile(compiler_options, profile_index, method_ref);
  31.       if (compile) {
  32.         compiled_method = driver->GetCompiler()->Compile(...);
  33.       }
  34.     }
  35.     return compiled_method;
  36.   };
  37.   CompileMethodHarness(self,driver,code_item,access_flags,
  38.                        invoke_type,class_def_idx,class_loader,
  39.                        dex_file,dex_cache,quick_fn);
  40. }

在CompileMethodQuick方法中可以看到针对不同的方法(jni方法、虚方法、构造函数等)有不同的处理方式,常规方法会通过ShouldCompileBasedOnProfile来判断某个method是否需要被编译。

具体判断条件如下:

  1. // Checks whether profile guided compilation is enabled and if the method should be compiled
  2. // according to the profile file.
  3. static bool ShouldCompileBasedOnProfile(const CompilerOptions& compiler_options,
  4.                                         ProfileCompilationInfo::ProfileIndexType profile_index,
  5.                                         MethodReference method_ref) {
  6.   if (profile_index == ProfileCompilationInfo::MaxProfileIndex()) {
  7.     // No profile for this dex file. Check if we're actually compiling based on a profile.
  8.     if (!CompilerFilter::DependsOnProfile(compiler_options.GetCompilerFilter())) {
  9.       return true;
  10.     }
  11.     // Profile-based compilation without profile for this dex file. Do not compile the method.
  12.     return false;
  13.   } else {
  14.     const ProfileCompilationInfo* profile_compilation_info =
  15.         compiler_options.GetProfileCompilationInfo();
  16.     // Compile only hot methods, it is the profile saver's job to decide
  17.     // what startup methods to mark as hot.
  18.     bool result = profile_compilation_info->IsHotMethod(profile_index, method_ref.index);
  19.    if (kDebugProfileGuidedCompilation) {
  20.       LOG(INFO) << "[ProfileGuidedCompilation] "
  21.           << (result ? "Compiled" : "Skipped") << " method:" << method_ref.PrettyMethod(true);
  22.     }
  23.     return result;
  24.   }
  25. }

可以看到是依据profile_compilation_info_是否命中hotmethod来判断。我们把编译日志打开,可以看到具体哪些方法被编译,哪些方法被跳过,如下图所示,这与我们配置的profile是一致的。

c5d267d36aa8cd4e2a3d20ac1d358f07.png

机器码生成的实现在CodeGenerator类中,代码如下,具体细节将不再展开。

  1. //art/compiler/optimizing/code_generator.cc
  2. void CodeGenerator::Compile(CodeAllocator* allocator) {
  3.   InitializeCodeGenerationData();
  4.   HGraphVisitor* instruction_visitor = GetInstructionVisitor();
  5.   GetStackMapStream()->BeginMethod(...);
  6.   size_t frame_start = GetAssembler()->CodeSize();
  7.   GenerateFrameEntry();
  8.   if (disasm_info_ != nullptr) {
  9.     disasm_info_->SetFrameEntryInterval(frame_start, GetAssembler()->CodeSize());
  10.   }
  11.   for (size_t e = block_order_->size(); current_block_index_ < e; ++current_block_index_) {
  12.     HBasicBlock* block = (*block_order_)[current_block_index_];
  13.     Bind(block);
  14.     MaybeRecordNativeDebugInfo(/* instruction= */ nullptr, block->GetDexPc());
  15.     for (HInstructionIterator it(block->GetInstructions()); !it.Done(); it.Advance()) {
  16.       HInstruction* current = it.Current();
  17.       DisassemblyScope disassembly_scope(current, *this);
  18.       current->Accept(instruction_visitor);
  19.     }
  20.   }
  21.   GenerateSlowPaths();
  22.   if (graph_->HasTryCatch()) {
  23.     RecordCatchBlockInfo();
  24.   }
  25.   // Finalize instructions in assember;
  26.   Finalize(allocator);
  27.   GetStackMapStream()->EndMethod(GetAssembler()->CodeSize());
  28. }

另外,profile_compilation_info_也会影响机器码重排,我们知道系统在通过IO加载文件的时候,一般都是按页维度来加载的(一般等于4KB),热点代码重排在一起,可以减少IO读取的次数,从而提升性能。

odex文件的机器码布局部分由OatWriter类实现,声明代码如下:

  1. class OatWriter {
  2.  public:
  3.   OatWriter(const CompilerOptions& compiler_options,
  4.             const VerificationResults* verification_results,
  5.             TimingLogger* timings,
  6.             ProfileCompilationInfo* info,
  7.             CompactDexLevel compact_dex_level);
  8.   ...          
  9.   // Profile info used to generate new layout of files.
  10.   ProfileCompilationInfo* profile_compilation_info_;
  11.   // Compact dex level that is generated.
  12.   CompactDexLevel compact_dex_level_;
  13.   using OrderedMethodList = std::vector<OrderedMethodData>;
  14.   ...

从中可以看到profile_compilation_info_会被OatWriter类用到,用于生成odex机器码的布局。

具体代码如下:

  1. // Visit every compiled method in order to determine its order within the OAT file.
  2. // Methods from the same class do not need to be adjacent in the OAT code.
  3. class OatWriter::LayoutCodeMethodVisitor final : public OatDexMethodVisitor {
  4.  public:
  5.   LayoutCodeMethodVisitor(OatWriter* writer, size_t offset)
  6.       : OatDexMethodVisitor(writer, offset),
  7.         profile_index_(ProfileCompilationInfo::MaxProfileIndex()),
  8.         profile_index_dex_file_(nullptr) {
  9.   }
  10.   bool StartClass(const DexFile* dex_file, size_t class_def_index) final {
  11.     // Update the cached `profile_index_` if needed. This happens only once per dex file
  12.     // because we visit all classes in a dex file together, so mark that as `UNLIKELY`.
  13.     if (UNLIKELY(dex_file != profile_index_dex_file_)) {
  14.       if (writer_->profile_compilation_info_ != nullptr) {
  15.         profile_index_ = writer_->profile_compilation_info_->FindDexFile(*dex_file);
  16.       }
  17.       profile_index_dex_file_ = dex_file;
  18.     }
  19.     return OatDexMethodVisitor::StartClass(dex_file, class_def_index);
  20.   }
  21.   bool VisitMethod(size_t class_def_method_index, const ClassAccessor::Method& method){
  22.     OatClass* oat_class = &writer_->oat_classes_[oat_class_index_];
  23.     CompiledMethod* compiled_method = oat_class->GetCompiledMethod(class_def_method_index);
  24.     if (HasCompiledCode(compiled_method)) {
  25.       // Determine the `hotness_bits`, used to determine relative order
  26.       // for OAT code layout when determining binning.
  27.       uint32_t method_index = method.GetIndex();
  28.       MethodReference method_ref(dex_file_, method_index);
  29.       uint32_t hotness_bits = 0u;
  30.       if (profile_index_ != ProfileCompilationInfo::MaxProfileIndex()) {
  31.         ProfileCompilationInfo* pci = writer_->profile_compilation_info_;
  32.         // Note: Bin-to-bin order does not matter. If the kernel does or does not read-ahead
  33.         // any memory, it only goes into the buffer cache and does not grow the PSS until the
  34.         // first time that memory is referenced in the process.
  35.         hotness_bits =
  36.             (pci->IsHotMethod(profile_index_, method_index) ? kHotBit : 0u) |
  37.             (pci->IsStartupMethod(profile_index_, method_index) ? kStartupBit : 0u) 
  38.         }
  39.       }
  40.       OrderedMethodData method_data = {hotness_bits,oat_class,compiled_method,method_ref,...};
  41.       ordered_methods_.push_back(method_data);
  42.     }
  43.     return true;
  44.   }

在LayoutCodeMethodVisitor类中,根据profile_compilation_info_指定的热点方法的FLAG,判断是否打开hotness_bits标志位。热点方法会一起被重排在odex文件靠前的位置。

小结一下,在系统安装app阶段,会读取apk中baselineprofile文件,经过porfman根据当前系统版本做一定转换并序列化到本地的reference_profile路径下,再通过dexoat编译热点方法为本地机器码并通过代码重排提升性能。

厂商合作

Baseline Profile安装时优化需要Google Play支持,但国内手机由于没有Google Play,无法在安装期做实现优化效果。为此,我们协同抖音与小米、华为等主流厂商建立了合作,共同推进Baseline Profile安装时优化在国内环境的落地。具体的合作方式是:

  • 我们通过编译期改造,提供带Baseline Profile的APK给到厂商验证联调。

  • 厂商具体的优化策略会综合考量安装时长、dex2oat消耗资源情况而定,比如先用默认策略安装apk,再后台异步执行Baseline Profile编译。

  • 最后通过Google提供的初步显示所用时间 (TTID) 来验证优化效果(TTID指标用于测量应用生成第一帧所用的时间,包括进程初始化、activity 创建以及显示第一帧。)

参考链接

https://developer.android.com/topic/performance/vitals/launch-time?hl=zh-cn

在与厂商联调的过程中,我们解决了各种问题,其中包括有一个资源压缩方式错误。具体错误信息如下:

  1. java.io.FileNotFoundException: 
  2. This file can not be opened as a file descriptor; it is probably compressed

原来安卓系统要求apk内的baseline.prof二进制是不压缩格式的。我们可以用unzip -v来检验文件是否未被压缩,Defl标志表示压缩,Stored标志表示未压缩。

797a2c8711fc085069fdc612602662da.png

我们可以在打包流程中指定其为STORED格式,即不压缩。

  1. private void writeNoCompress(@NonNull JarEntry entry, @NonNull InputStream from) throws IOException {
  2.     byte[] bytes = new byte[from.available()];
  3.     from.read(bytes);
  4.     entry.setMethod(JarEntry.STORED);
  5.     entry.setSize(bytes.length);
  6.     CRC32 crc32 = new CRC32();
  7.     crc32.update(bytes,0,bytes.length);
  8.     entry.setCrc(crc32.getValue());
  9.     setEntryAttributes(entry);
  10.     jarOutputStream.putNextEntry(entry);
  11.     jarOutputStream.write(bytes, 0, bytes.length);
  12.     jarOutputStream.closeEntry();
  13. }

改完之后我们再检查一下文件是否被压缩。

05633f689951d39431d15fc777880597.png

baseline.prof二进制是不压缩对包体积影响比较小,因为这个文件大部分都是int类型的methodid。经测试,7万+热点方法文件,生成baseline.prof二进制文件62KB,压缩率只有0.1%;如果通过通配符配置,压缩率在5%左右。

一般应用商店下载安装包时在网络传输过程中做了(压缩)https://zh.wikipedia.org/wiki/HTTP%E5%8E%8B%E7%BC%A9处理,这种情况不压缩处理基本不影响包大小,同时不压缩处理也能避免解压缩带来的耗时。

优化效果

在自测中,我们可以通过下面的方式通过install-multiple命令安装APK。

  1. # Unzip the Release APK first
  2. unzip release.apk
  3. # Create a ZIP archive
  4. cp assets/dexopt/baseline.prof primary.prof
  5. cp assets/dexopt/baseline.profm primary.profm
  6. # Create an archive
  7. zip -r release.dm primary.prof primary.profm
  8. # Install APK + Profile together
  9. adb install-multiple release.apk release.dm

在厂商测试中通过下面的命令测试冷启动耗时

  1. PACKAGE_NAME=com.ss.android.article.video
  2. adb shell am start-activity -W -n $PACKAGE_NAME/.SplashActivity | grep "TotalTime"
冷启动Activity耗时比较未优化已优化优化率
荣耀Android11950ms884ms6.9%
小米Android13821ms720ms12.3%

可以看到,在开启Baseline Profile优化之后,首装冷启动(TTID)耗时减少约10%左右,为新用户的启动速度体验带来了极大的提升。

参考文章

团队介绍

我们是字节跳动西瓜视频客户端团队,专注于西瓜视频 App 的开发和基础技术建设,在客户端架构、性能、稳定性、编译构建、研发工具等方向都有投入。如果你也想一起攻克技术难题,迎接更大的技术挑战,欢迎点击阅读原文,或者投递简历到xiaolin.gan@bytedance.com。

最 Nice 的工作氛围和成长机会,福利与机遇多多,在北上杭三地均有职位,欢迎加入西瓜视频客户端团队 !

ce8ae9b2f565442f4f554099425978d3.png 点击「阅读原文」一键投递!

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/小小林熬夜学编程/article/detail/150244
推荐阅读