PackageDexOptimizer.java revision d479b52d12fc782f18df6b5ae15c19e022f0ec14
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.content.pm.PackageParser.Package; 24import android.os.Environment; 25import android.os.PowerManager; 26import android.os.UserHandle; 27import android.os.WorkSource; 28import android.os.storage.StorageManager; 29import android.util.ArraySet; 30import android.util.Log; 31import android.util.Slog; 32 33import com.android.internal.os.InstallerConnection.InstallerException; 34 35import java.io.File; 36import java.io.IOException; 37import java.util.ArrayList; 38import java.util.List; 39 40import dalvik.system.DexFile; 41 42import static com.android.server.pm.Installer.DEXOPT_BOOTCOMPLETE; 43import static com.android.server.pm.Installer.DEXOPT_DEBUGGABLE; 44import static com.android.server.pm.Installer.DEXOPT_PUBLIC; 45import static com.android.server.pm.Installer.DEXOPT_SAFEMODE; 46import static com.android.server.pm.Installer.DEXOPT_EXTRACTONLY; 47import static com.android.server.pm.InstructionSets.getAppDexInstructionSets; 48import static com.android.server.pm.InstructionSets.getDexCodeInstructionSets; 49 50/** 51 * Helper class for running dexopt command on packages. 52 */ 53class PackageDexOptimizer { 54 private static final String TAG = "PackageManager.DexOptimizer"; 55 static final String OAT_DIR_NAME = "oat"; 56 // TODO b/19550105 Remove error codes and use exceptions 57 static final int DEX_OPT_SKIPPED = 0; 58 static final int DEX_OPT_PERFORMED = 1; 59 static final int DEX_OPT_DEFERRED = 2; 60 static final int DEX_OPT_FAILED = -1; 61 62 private static final boolean DEBUG_DEXOPT = PackageManagerService.DEBUG_DEXOPT; 63 64 private final Installer mInstaller; 65 private final Object mInstallLock; 66 67 private final PowerManager.WakeLock mDexoptWakeLock; 68 private volatile boolean mSystemReady; 69 70 PackageDexOptimizer(Installer installer, Object installLock, Context context, 71 String wakeLockTag) { 72 this.mInstaller = installer; 73 this.mInstallLock = installLock; 74 75 PowerManager powerManager = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 76 mDexoptWakeLock = powerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, wakeLockTag); 77 } 78 79 protected PackageDexOptimizer(PackageDexOptimizer from) { 80 this.mInstaller = from.mInstaller; 81 this.mInstallLock = from.mInstallLock; 82 this.mDexoptWakeLock = from.mDexoptWakeLock; 83 this.mSystemReady = from.mSystemReady; 84 } 85 86 static boolean canOptimizePackage(PackageParser.Package pkg) { 87 return (pkg.applicationInfo.flags & ApplicationInfo.FLAG_HAS_CODE) != 0; 88 } 89 90 /** 91 * Performs dexopt on all code paths and libraries of the specified package for specified 92 * instruction sets. 93 * 94 * <p>Calls to {@link com.android.server.pm.Installer#dexopt} on {@link #mInstaller} are 95 * synchronized on {@link #mInstallLock}. 96 */ 97 int performDexOpt(PackageParser.Package pkg, String[] instructionSets, boolean useProfiles, 98 boolean extractOnly) { 99 synchronized (mInstallLock) { 100 final boolean useLock = mSystemReady; 101 if (useLock) { 102 mDexoptWakeLock.setWorkSource(new WorkSource(pkg.applicationInfo.uid)); 103 mDexoptWakeLock.acquire(); 104 } 105 try { 106 return performDexOptLI(pkg, instructionSets, useProfiles, extractOnly); 107 } finally { 108 if (useLock) { 109 mDexoptWakeLock.release(); 110 } 111 } 112 } 113 } 114 115 /** 116 * Determine whether the package should be skipped for the given instruction set. A return 117 * value of true means the package will be skipped. A return value of false means that the 118 * package will be further investigated, and potentially compiled. 119 */ 120 protected boolean shouldSkipBasedOnISA(PackageParser.Package pkg, String instructionSet) { 121 return pkg.mDexOptPerformed.contains(instructionSet); 122 } 123 124 /** 125 * Adjust the given dexopt-needed value. Can be overridden to influence the decision to 126 * optimize or not (and in what way). 127 */ 128 protected int adjustDexoptNeeded(int dexoptNeeded) { 129 return dexoptNeeded; 130 } 131 132 /** 133 * Adjust the given dexopt flags that will be passed to the installer. 134 */ 135 protected int adjustDexoptFlags(int dexoptFlags) { 136 return dexoptFlags; 137 } 138 139 /** 140 * Update the package status after a successful compilation. 141 */ 142 protected void recordSuccessfulDexopt(PackageParser.Package pkg, String instructionSet) { 143 pkg.mDexOptPerformed.add(instructionSet); 144 } 145 146 private int performDexOptLI(PackageParser.Package pkg, String[] targetInstructionSets, 147 boolean useProfiles, boolean extractOnly) { 148 final String[] instructionSets = targetInstructionSets != null ? 149 targetInstructionSets : getAppDexInstructionSets(pkg.applicationInfo); 150 151 if (!canOptimizePackage(pkg)) { 152 return DEX_OPT_SKIPPED; 153 } 154 155 final boolean vmSafeMode = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_VM_SAFE_MODE) != 0; 156 final boolean debuggable = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0; 157 158 final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly(); 159 boolean performedDexOpt = false; 160 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 161 for (String dexCodeInstructionSet : dexCodeInstructionSets) { 162 if (!useProfiles && shouldSkipBasedOnISA(pkg, dexCodeInstructionSet)) { 163 // Skip only if we do not use profiles since they might trigger a recompilation. 164 continue; 165 } 166 167 for (String path : paths) { 168 if (useProfiles && isUsedByOtherApps(path)) { 169 // We cannot use profile guided compilation if the apk was used by another app. 170 useProfiles = false; 171 } 172 int dexoptNeeded; 173 174 try { 175 dexoptNeeded = DexFile.getDexOptNeeded(path, pkg.packageName, 176 dexCodeInstructionSet, /* defer */false); 177 } catch (IOException ioe) { 178 Slog.w(TAG, "IOException reading apk: " + path, ioe); 179 return DEX_OPT_FAILED; 180 } 181 dexoptNeeded = adjustDexoptNeeded(dexoptNeeded); 182 183 if (dexoptNeeded == DexFile.NO_DEXOPT_NEEDED) { 184 if (useProfiles) { 185 // Profiles may trigger re-compilation. The final decision is taken in 186 // installd. 187 dexoptNeeded = DexFile.DEX2OAT_NEEDED; 188 } else { 189 // No dexopt needed and we don't use profiles. Nothing to do. 190 continue; 191 } 192 } 193 final String dexoptType; 194 String oatDir = null; 195 if (dexoptNeeded == DexFile.DEX2OAT_NEEDED) { 196 dexoptType = "dex2oat"; 197 oatDir = createOatDirIfSupported(pkg, dexCodeInstructionSet); 198 } else if (dexoptNeeded == DexFile.PATCHOAT_NEEDED) { 199 dexoptType = "patchoat"; 200 } else if (dexoptNeeded == DexFile.SELF_PATCHOAT_NEEDED) { 201 dexoptType = "self patchoat"; 202 } else { 203 throw new IllegalStateException("Invalid dexopt needed: " + dexoptNeeded); 204 } 205 206 207 Log.i(TAG, "Running dexopt (" + dexoptType + ") on: " + path + " pkg=" 208 + pkg.applicationInfo.packageName + " isa=" + dexCodeInstructionSet 209 + " vmSafeMode=" + vmSafeMode + " debuggable=" + debuggable 210 + " extractOnly=" + extractOnly + " oatDir = " + oatDir); 211 final int sharedGid = UserHandle.getSharedAppGid(pkg.applicationInfo.uid); 212 // Profile guide compiled oat files should not be public. 213 final boolean isPublic = !pkg.isForwardLocked() && !useProfiles; 214 final int dexFlags = adjustDexoptFlags( 215 ( isPublic ? DEXOPT_PUBLIC : 0) 216 | (vmSafeMode ? DEXOPT_SAFEMODE : 0) 217 | (debuggable ? DEXOPT_DEBUGGABLE : 0) 218 | (extractOnly ? DEXOPT_EXTRACTONLY : 0) 219 | DEXOPT_BOOTCOMPLETE); 220 221 try { 222 mInstaller.dexopt(path, sharedGid, pkg.packageName, dexCodeInstructionSet, 223 dexoptNeeded, oatDir, dexFlags, pkg.volumeUuid, useProfiles); 224 performedDexOpt = true; 225 } catch (InstallerException e) { 226 Slog.w(TAG, "Failed to dexopt", e); 227 } 228 } 229 230 if (!extractOnly) { 231 // At this point we haven't failed dexopt and we haven't deferred dexopt. We must 232 // either have either succeeded dexopt, or have had getDexOptNeeded tell us 233 // it isn't required. We therefore mark that this package doesn't need dexopt unless 234 // it's forced. performedDexOpt will tell us whether we performed dex-opt or skipped 235 // it. 236 recordSuccessfulDexopt(pkg, dexCodeInstructionSet); 237 } 238 } 239 240 // If we've gotten here, we're sure that no error occurred and that we haven't 241 // deferred dex-opt. We've either dex-opted one more paths or instruction sets or 242 // we've skipped all of them because they are up to date. In both cases this 243 // package doesn't need dexopt any longer. 244 return performedDexOpt ? DEX_OPT_PERFORMED : DEX_OPT_SKIPPED; 245 } 246 247 /** 248 * Creates oat dir for the specified package. In certain cases oat directory 249 * <strong>cannot</strong> be created: 250 * <ul> 251 * <li>{@code pkg} is a system app, which is not updated.</li> 252 * <li>Package location is not a directory, i.e. monolithic install.</li> 253 * </ul> 254 * 255 * @return Absolute path to the oat directory or null, if oat directory 256 * cannot be created. 257 */ 258 @Nullable 259 private String createOatDirIfSupported(PackageParser.Package pkg, String dexInstructionSet) { 260 if (!pkg.canHaveOatDir()) { 261 return null; 262 } 263 File codePath = new File(pkg.codePath); 264 if (codePath.isDirectory()) { 265 File oatDir = getOatDir(codePath); 266 try { 267 mInstaller.createOatDir(oatDir.getAbsolutePath(), dexInstructionSet); 268 } catch (InstallerException e) { 269 Slog.w(TAG, "Failed to create oat dir", e); 270 return null; 271 } 272 return oatDir.getAbsolutePath(); 273 } 274 return null; 275 } 276 277 static File getOatDir(File codePath) { 278 return new File(codePath, OAT_DIR_NAME); 279 } 280 281 void systemReady() { 282 mSystemReady = true; 283 } 284 285 private boolean isUsedByOtherApps(String apkPath) { 286 try { 287 apkPath = new File(apkPath).getCanonicalPath(); 288 } catch (IOException e) { 289 // Log an error but continue without it. 290 Slog.w(TAG, "Failed to get canonical path", e); 291 } 292 String useMarker = apkPath.replace('/', '@'); 293 final int[] currentUserIds = UserManagerService.getInstance().getUserIds(); 294 for (int i = 0; i < currentUserIds.length; i++) { 295 File profileDir = Environment.getDataProfilesDeForeignDexDirectory(currentUserIds[i]); 296 File foreignUseMark = new File(profileDir, useMarker); 297 if (foreignUseMark.exists()) { 298 return true; 299 } 300 } 301 return false; 302 } 303 304 /** 305 * A specialized PackageDexOptimizer that overrides already-installed checks, forcing a 306 * dexopt path. 307 */ 308 public static class ForcedUpdatePackageDexOptimizer extends PackageDexOptimizer { 309 310 public ForcedUpdatePackageDexOptimizer(Installer installer, Object installLock, 311 Context context, String wakeLockTag) { 312 super(installer, installLock, context, wakeLockTag); 313 } 314 315 public ForcedUpdatePackageDexOptimizer(PackageDexOptimizer from) { 316 super(from); 317 } 318 319 @Override 320 protected boolean shouldSkipBasedOnISA(Package pkg, String instructionSet) { 321 // Forced compilation, never skip. 322 return false; 323 } 324 325 @Override 326 protected int adjustDexoptNeeded(int dexoptNeeded) { 327 // Ensure compilation, no matter the current state. 328 // TODO: The return value is wrong when patchoat is needed. 329 return DexFile.DEX2OAT_NEEDED; 330 } 331 } 332} 333