PackageDexOptimizer.java revision 0f6250823612b2a43784bef12f833ac850bf2e2f
1/* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License 15 */ 16 17package com.android.server.pm; 18 19import android.annotation.Nullable; 20import android.content.Context; 21import android.content.pm.ApplicationInfo; 22import android.content.pm.PackageParser; 23import android.os.Environment; 24import android.os.PowerManager; 25import android.os.UserHandle; 26import android.os.WorkSource; 27import android.util.Log; 28import android.util.Slog; 29 30import com.android.internal.os.InstallerConnection.InstallerException; 31import com.android.internal.util.IndentingPrintWriter; 32 33import java.io.File; 34import java.io.IOException; 35import java.util.List; 36 37import dalvik.system.DexFile; 38 39import static com.android.server.pm.Installer.DEXOPT_BOOTCOMPLETE; 40import static com.android.server.pm.Installer.DEXOPT_DEBUGGABLE; 41import static com.android.server.pm.Installer.DEXOPT_PROFILE_GUIDED; 42import static com.android.server.pm.Installer.DEXOPT_PUBLIC; 43import static com.android.server.pm.Installer.DEXOPT_SAFEMODE; 44import static com.android.server.pm.InstructionSets.getAppDexInstructionSets; 45import static com.android.server.pm.InstructionSets.getDexCodeInstructionSets; 46import static com.android.server.pm.PackageManagerServiceCompilerMapping.getNonProfileGuidedCompilerFilter; 47 48/** 49 * Helper class for running dexopt command on packages. 50 */ 51class PackageDexOptimizer { 52 private static final String TAG = "PackageManager.DexOptimizer"; 53 static final String OAT_DIR_NAME = "oat"; 54 // TODO b/19550105 Remove error codes and use exceptions 55 static final int DEX_OPT_SKIPPED = 0; 56 static final int DEX_OPT_PERFORMED = 1; 57 static final int DEX_OPT_FAILED = -1; 58 59 private final Installer mInstaller; 60 private final Object mInstallLock; 61 62 private final PowerManager.WakeLock mDexoptWakeLock; 63 private volatile boolean mSystemReady; 64 65 PackageDexOptimizer(Installer installer, Object installLock, Context context, 66 String wakeLockTag) { 67 this.mInstaller = installer; 68 this.mInstallLock = installLock; 69 70 PowerManager powerManager = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 71 mDexoptWakeLock = powerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, wakeLockTag); 72 } 73 74 protected PackageDexOptimizer(PackageDexOptimizer from) { 75 this.mInstaller = from.mInstaller; 76 this.mInstallLock = from.mInstallLock; 77 this.mDexoptWakeLock = from.mDexoptWakeLock; 78 this.mSystemReady = from.mSystemReady; 79 } 80 81 static boolean canOptimizePackage(PackageParser.Package pkg) { 82 return (pkg.applicationInfo.flags & ApplicationInfo.FLAG_HAS_CODE) != 0; 83 } 84 85 /** 86 * Performs dexopt on all code paths and libraries of the specified package for specified 87 * instruction sets. 88 * 89 * <p>Calls to {@link com.android.server.pm.Installer#dexopt} on {@link #mInstaller} are 90 * synchronized on {@link #mInstallLock}. 91 */ 92 int performDexOpt(PackageParser.Package pkg, String[] sharedLibraries, 93 String[] instructionSets, boolean checkProfiles, String targetCompilationFilter, 94 CompilerStats.PackageStats packageStats) { 95 synchronized (mInstallLock) { 96 final boolean useLock = mSystemReady; 97 if (useLock) { 98 mDexoptWakeLock.setWorkSource(new WorkSource(pkg.applicationInfo.uid)); 99 mDexoptWakeLock.acquire(); 100 } 101 try { 102 return performDexOptLI(pkg, sharedLibraries, instructionSets, checkProfiles, 103 targetCompilationFilter, packageStats); 104 } finally { 105 if (useLock) { 106 mDexoptWakeLock.release(); 107 } 108 } 109 } 110 } 111 112 /** 113 * Adjust the given dexopt-needed value. Can be overridden to influence the decision to 114 * optimize or not (and in what way). 115 */ 116 protected int adjustDexoptNeeded(int dexoptNeeded) { 117 return dexoptNeeded; 118 } 119 120 /** 121 * Adjust the given dexopt flags that will be passed to the installer. 122 */ 123 protected int adjustDexoptFlags(int dexoptFlags) { 124 return dexoptFlags; 125 } 126 127 /** 128 * Dumps the dexopt state of the given package {@code pkg} to the given {@code PrintWriter}. 129 */ 130 void dumpDexoptState(IndentingPrintWriter pw, PackageParser.Package pkg) { 131 final String[] instructionSets = getAppDexInstructionSets(pkg.applicationInfo); 132 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 133 134 final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly(); 135 136 for (String instructionSet : dexCodeInstructionSets) { 137 pw.println("Instruction Set: " + instructionSet); 138 pw.increaseIndent(); 139 for (String path : paths) { 140 String status = null; 141 try { 142 status = DexFile.getDexFileStatus(path, instructionSet); 143 } catch (IOException ioe) { 144 status = "[Exception]: " + ioe.getMessage(); 145 } 146 pw.println("path: " + path); 147 pw.println("status: " + status); 148 } 149 pw.decreaseIndent(); 150 } 151 } 152 153 private int performDexOptLI(PackageParser.Package pkg, String[] sharedLibraries, 154 String[] targetInstructionSets, boolean checkProfiles, String targetCompilerFilter, 155 CompilerStats.PackageStats packageStats) { 156 final String[] instructionSets = targetInstructionSets != null ? 157 targetInstructionSets : getAppDexInstructionSets(pkg.applicationInfo); 158 159 if (!canOptimizePackage(pkg)) { 160 return DEX_OPT_SKIPPED; 161 } 162 163 final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly(); 164 final int sharedGid = UserHandle.getSharedAppGid(pkg.applicationInfo.uid); 165 166 boolean isProfileGuidedFilter = DexFile.isProfileGuidedCompilerFilter(targetCompilerFilter); 167 // If any part of the app is used by other apps, we cannot use profile-guided 168 // compilation. 169 if (isProfileGuidedFilter && isUsedByOtherApps(pkg)) { 170 checkProfiles = false; 171 172 targetCompilerFilter = getNonProfileGuidedCompilerFilter(targetCompilerFilter); 173 if (DexFile.isProfileGuidedCompilerFilter(targetCompilerFilter)) { 174 throw new IllegalStateException(targetCompilerFilter); 175 } 176 isProfileGuidedFilter = false; 177 } 178 179 // Disable profile guided compilation for vmSafeMode. 180 final boolean vmSafeMode = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_VM_SAFE_MODE) 181 != 0; 182 final boolean debuggable = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) 183 != 0; 184 if (vmSafeMode) { 185 targetCompilerFilter = getNonProfileGuidedCompilerFilter(targetCompilerFilter); 186 isProfileGuidedFilter = false; 187 } 188 189 // If we're asked to take profile updates into account, check now. 190 boolean newProfile = false; 191 if (checkProfiles && isProfileGuidedFilter) { 192 // Merge profiles, see if we need to do anything. 193 try { 194 newProfile = mInstaller.mergeProfiles(sharedGid, pkg.packageName); 195 } catch (InstallerException e) { 196 Slog.w(TAG, "Failed to merge profiles", e); 197 } 198 } 199 200 boolean performedDexOpt = false; 201 boolean successfulDexOpt = true; 202 203 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 204 for (String dexCodeInstructionSet : dexCodeInstructionSets) { 205 for (String path : paths) { 206 int dexoptNeeded; 207 try { 208 dexoptNeeded = DexFile.getDexOptNeeded(path, 209 dexCodeInstructionSet, targetCompilerFilter, newProfile); 210 } catch (IOException ioe) { 211 Slog.w(TAG, "IOException reading apk: " + path, ioe); 212 return DEX_OPT_FAILED; 213 } 214 dexoptNeeded = adjustDexoptNeeded(dexoptNeeded); 215 if (PackageManagerService.DEBUG_DEXOPT) { 216 Log.i(TAG, "DexoptNeeded for " + path + "@" + targetCompilerFilter + " is " + 217 dexoptNeeded); 218 } 219 220 final String dexoptType; 221 String oatDir = null; 222 boolean isOdexLocation = (dexoptNeeded < 0); 223 switch (Math.abs(dexoptNeeded)) { 224 case DexFile.NO_DEXOPT_NEEDED: 225 continue; 226 case DexFile.DEX2OAT_FROM_SCRATCH: 227 case DexFile.DEX2OAT_FOR_BOOT_IMAGE: 228 case DexFile.DEX2OAT_FOR_FILTER: 229 case DexFile.DEX2OAT_FOR_RELOCATION: 230 dexoptType = "dex2oat"; 231 oatDir = createOatDirIfSupported(pkg, dexCodeInstructionSet); 232 break; 233 case DexFile.PATCHOAT_FOR_RELOCATION: 234 dexoptType = "patchoat"; 235 break; 236 default: 237 throw new IllegalStateException("Invalid dexopt:" + dexoptNeeded); 238 } 239 240 String sharedLibrariesPath = null; 241 if (sharedLibraries != null && sharedLibraries.length != 0) { 242 StringBuilder sb = new StringBuilder(); 243 for (String lib : sharedLibraries) { 244 if (sb.length() != 0) { 245 sb.append(":"); 246 } 247 sb.append(lib); 248 } 249 sharedLibrariesPath = sb.toString(); 250 } 251 Log.i(TAG, "Running dexopt (" + dexoptType + ") on: " + path + " pkg=" 252 + pkg.applicationInfo.packageName + " isa=" + dexCodeInstructionSet 253 + " vmSafeMode=" + vmSafeMode + " debuggable=" + debuggable 254 + " target-filter=" + targetCompilerFilter + " oatDir=" + oatDir 255 + " sharedLibraries=" + sharedLibrariesPath); 256 // Profile guide compiled oat files should not be public. 257 final boolean isPublic = !pkg.isForwardLocked() && !isProfileGuidedFilter; 258 final int profileFlag = isProfileGuidedFilter ? DEXOPT_PROFILE_GUIDED : 0; 259 final int dexFlags = adjustDexoptFlags( 260 ( isPublic ? DEXOPT_PUBLIC : 0) 261 | (vmSafeMode ? DEXOPT_SAFEMODE : 0) 262 | (debuggable ? DEXOPT_DEBUGGABLE : 0) 263 | profileFlag 264 | DEXOPT_BOOTCOMPLETE); 265 266 try { 267 long startTime = System.currentTimeMillis(); 268 269 mInstaller.dexopt(path, sharedGid, pkg.packageName, dexCodeInstructionSet, 270 dexoptNeeded, oatDir, dexFlags, targetCompilerFilter, pkg.volumeUuid, 271 sharedLibrariesPath); 272 performedDexOpt = true; 273 274 if (packageStats != null) { 275 long endTime = System.currentTimeMillis(); 276 packageStats.setCompileTime(path, (int)(endTime - startTime)); 277 } 278 } catch (InstallerException e) { 279 Slog.w(TAG, "Failed to dexopt", e); 280 successfulDexOpt = false; 281 } 282 } 283 } 284 285 if (successfulDexOpt) { 286 // If we've gotten here, we're sure that no error occurred. We've either 287 // dex-opted one or more paths or instruction sets or we've skipped 288 // all of them because they are up to date. In both cases this package 289 // doesn't need dexopt any longer. 290 return performedDexOpt ? DEX_OPT_PERFORMED : DEX_OPT_SKIPPED; 291 } else { 292 return DEX_OPT_FAILED; 293 } 294 } 295 296 /** 297 * Creates oat dir for the specified package. In certain cases oat directory 298 * <strong>cannot</strong> be created: 299 * <ul> 300 * <li>{@code pkg} is a system app, which is not updated.</li> 301 * <li>Package location is not a directory, i.e. monolithic install.</li> 302 * </ul> 303 * 304 * @return Absolute path to the oat directory or null, if oat directory 305 * cannot be created. 306 */ 307 @Nullable 308 private String createOatDirIfSupported(PackageParser.Package pkg, String dexInstructionSet) { 309 if (!pkg.canHaveOatDir()) { 310 return null; 311 } 312 File codePath = new File(pkg.codePath); 313 if (codePath.isDirectory()) { 314 File oatDir = getOatDir(codePath); 315 try { 316 mInstaller.createOatDir(oatDir.getAbsolutePath(), dexInstructionSet); 317 } catch (InstallerException e) { 318 Slog.w(TAG, "Failed to create oat dir", e); 319 return null; 320 } 321 return oatDir.getAbsolutePath(); 322 } 323 return null; 324 } 325 326 static File getOatDir(File codePath) { 327 return new File(codePath, OAT_DIR_NAME); 328 } 329 330 void systemReady() { 331 mSystemReady = true; 332 } 333 334 /** 335 * Returns true if the profiling data collected for the given app indicate 336 * that the apps's APK has been loaded by another app. 337 * Note that this returns false for all forward-locked apps and apps without 338 * any collected profiling data. 339 */ 340 public static boolean isUsedByOtherApps(PackageParser.Package pkg) { 341 if (pkg.isForwardLocked()) { 342 // Skip the check for forward locked packages since they don't share their code. 343 return false; 344 } 345 346 for (String apkPath : pkg.getAllCodePathsExcludingResourceOnly()) { 347 try { 348 apkPath = PackageManagerServiceUtils.realpath(new File(apkPath)); 349 } catch (IOException e) { 350 // Log an error but continue without it. 351 Slog.w(TAG, "Failed to get canonical path", e); 352 continue; 353 } 354 String useMarker = apkPath.replace('/', '@'); 355 final int[] currentUserIds = UserManagerService.getInstance().getUserIds(); 356 for (int i = 0; i < currentUserIds.length; i++) { 357 File profileDir = 358 Environment.getDataProfilesDeForeignDexDirectory(currentUserIds[i]); 359 File foreignUseMark = new File(profileDir, useMarker); 360 if (foreignUseMark.exists()) { 361 return true; 362 } 363 } 364 } 365 return false; 366 } 367 368 /** 369 * A specialized PackageDexOptimizer that overrides already-installed checks, forcing a 370 * dexopt path. 371 */ 372 public static class ForcedUpdatePackageDexOptimizer extends PackageDexOptimizer { 373 374 public ForcedUpdatePackageDexOptimizer(Installer installer, Object installLock, 375 Context context, String wakeLockTag) { 376 super(installer, installLock, context, wakeLockTag); 377 } 378 379 public ForcedUpdatePackageDexOptimizer(PackageDexOptimizer from) { 380 super(from); 381 } 382 383 @Override 384 protected int adjustDexoptNeeded(int dexoptNeeded) { 385 // Ensure compilation, no matter the current state. 386 // TODO: The return value is wrong when patchoat is needed. 387 return DexFile.DEX2OAT_FROM_SCRATCH; 388 } 389 } 390} 391