PackageDexOptimizer.java revision 47c170a7460e8455ffc07981916c400fa980433a
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; 31 32import java.io.File; 33import java.io.IOException; 34import java.util.List; 35 36import dalvik.system.DexFile; 37 38import static com.android.server.pm.Installer.DEXOPT_BOOTCOMPLETE; 39import static com.android.server.pm.Installer.DEXOPT_DEBUGGABLE; 40import static com.android.server.pm.Installer.DEXOPT_PROFILE_GUIDED; 41import static com.android.server.pm.Installer.DEXOPT_PUBLIC; 42import static com.android.server.pm.Installer.DEXOPT_SAFEMODE; 43import static com.android.server.pm.InstructionSets.getAppDexInstructionSets; 44import static com.android.server.pm.InstructionSets.getDexCodeInstructionSets; 45import static com.android.server.pm.PackageManagerServiceCompilerMapping.getNonProfileGuidedCompilerFilter; 46 47/** 48 * Helper class for running dexopt command on packages. 49 */ 50class PackageDexOptimizer { 51 private static final String TAG = "PackageManager.DexOptimizer"; 52 static final String OAT_DIR_NAME = "oat"; 53 // TODO b/19550105 Remove error codes and use exceptions 54 static final int DEX_OPT_SKIPPED = 0; 55 static final int DEX_OPT_PERFORMED = 1; 56 static final int DEX_OPT_DEFERRED = 2; 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[] instructionSets, boolean checkProfiles, 93 String targetCompilationFilter) { 94 synchronized (mInstallLock) { 95 final boolean useLock = mSystemReady; 96 if (useLock) { 97 mDexoptWakeLock.setWorkSource(new WorkSource(pkg.applicationInfo.uid)); 98 mDexoptWakeLock.acquire(); 99 } 100 try { 101 return performDexOptLI(pkg, instructionSets, checkProfiles, 102 targetCompilationFilter); 103 } finally { 104 if (useLock) { 105 mDexoptWakeLock.release(); 106 } 107 } 108 } 109 } 110 111 /** 112 * Adjust the given dexopt-needed value. Can be overridden to influence the decision to 113 * optimize or not (and in what way). 114 */ 115 protected int adjustDexoptNeeded(int dexoptNeeded) { 116 return dexoptNeeded; 117 } 118 119 /** 120 * Adjust the given dexopt flags that will be passed to the installer. 121 */ 122 protected int adjustDexoptFlags(int dexoptFlags) { 123 return dexoptFlags; 124 } 125 126 private int performDexOptLI(PackageParser.Package pkg, String[] targetInstructionSets, 127 boolean checkProfiles, String targetCompilerFilter) { 128 final String[] instructionSets = targetInstructionSets != null ? 129 targetInstructionSets : getAppDexInstructionSets(pkg.applicationInfo); 130 131 if (!canOptimizePackage(pkg)) { 132 return DEX_OPT_SKIPPED; 133 } 134 135 final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly(); 136 final int sharedGid = UserHandle.getSharedAppGid(pkg.applicationInfo.uid); 137 138 boolean isProfileGuidedFilter = DexFile.isProfileGuidedCompilerFilter(targetCompilerFilter); 139 // If any part of the app is used by other apps, we cannot use profile-guided 140 // compilation. 141 // Skip the check for forward locked packages since they don't share their code. 142 if (isProfileGuidedFilter && !pkg.isForwardLocked()) { 143 for (String path : paths) { 144 if (isUsedByOtherApps(path)) { 145 checkProfiles = false; 146 147 targetCompilerFilter = getNonProfileGuidedCompilerFilter(targetCompilerFilter); 148 if (DexFile.isProfileGuidedCompilerFilter(targetCompilerFilter)) { 149 throw new IllegalStateException(targetCompilerFilter); 150 } 151 isProfileGuidedFilter = false; 152 153 break; 154 } 155 } 156 } 157 158 // If we're asked to take profile updates into account, check now. 159 boolean newProfile = false; 160 if (checkProfiles && isProfileGuidedFilter) { 161 // Merge profiles, see if we need to do anything. 162 try { 163 newProfile = mInstaller.mergeProfiles(sharedGid, pkg.packageName); 164 } catch (InstallerException e) { 165 Slog.w(TAG, "Failed to merge profiles", e); 166 } 167 } 168 169 final boolean vmSafeMode = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_VM_SAFE_MODE) != 0; 170 final boolean debuggable = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0; 171 172 boolean performedDexOpt = false; 173 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 174 for (String dexCodeInstructionSet : dexCodeInstructionSets) { 175 for (String path : paths) { 176 int dexoptNeeded; 177 try { 178 dexoptNeeded = DexFile.getDexOptNeeded(path, 179 dexCodeInstructionSet, targetCompilerFilter, newProfile); 180 } catch (IOException ioe) { 181 Slog.w(TAG, "IOException reading apk: " + path, ioe); 182 return DEX_OPT_FAILED; 183 } 184 dexoptNeeded = adjustDexoptNeeded(dexoptNeeded); 185 if (PackageManagerService.DEBUG_DEXOPT) { 186 Log.i(TAG, "DexoptNeeded for " + path + "@" + targetCompilerFilter + " is " + 187 dexoptNeeded); 188 } 189 190 final String dexoptType; 191 String oatDir = null; 192 switch (dexoptNeeded) { 193 case DexFile.NO_DEXOPT_NEEDED: 194 continue; 195 case DexFile.DEX2OAT_NEEDED: 196 dexoptType = "dex2oat"; 197 oatDir = createOatDirIfSupported(pkg, dexCodeInstructionSet); 198 break; 199 case DexFile.PATCHOAT_NEEDED: 200 dexoptType = "patchoat"; 201 break; 202 case DexFile.SELF_PATCHOAT_NEEDED: 203 dexoptType = "self patchoat"; 204 break; 205 default: 206 throw new IllegalStateException("Invalid dexopt:" + dexoptNeeded); 207 } 208 209 Log.i(TAG, "Running dexopt (" + dexoptType + ") on: " + path + " pkg=" 210 + pkg.applicationInfo.packageName + " isa=" + dexCodeInstructionSet 211 + " vmSafeMode=" + vmSafeMode + " debuggable=" + debuggable 212 + " target-filter=" + targetCompilerFilter + " oatDir = " + oatDir); 213 // Profile guide compiled oat files should not be public. 214 final boolean isPublic = !pkg.isForwardLocked() && !isProfileGuidedFilter; 215 final int profileFlag = isProfileGuidedFilter ? DEXOPT_PROFILE_GUIDED : 0; 216 final int dexFlags = adjustDexoptFlags( 217 ( isPublic ? DEXOPT_PUBLIC : 0) 218 | (vmSafeMode ? DEXOPT_SAFEMODE : 0) 219 | (debuggable ? DEXOPT_DEBUGGABLE : 0) 220 | profileFlag 221 | DEXOPT_BOOTCOMPLETE); 222 223 try { 224 mInstaller.dexopt(path, sharedGid, pkg.packageName, dexCodeInstructionSet, 225 dexoptNeeded, oatDir, dexFlags, targetCompilerFilter, pkg.volumeUuid); 226 performedDexOpt = true; 227 } catch (InstallerException e) { 228 Slog.w(TAG, "Failed to dexopt", e); 229 } 230 } 231 } 232 233 // If we've gotten here, we're sure that no error occurred and that we haven't 234 // deferred dex-opt. We've either dex-opted one more paths or instruction sets or 235 // we've skipped all of them because they are up to date. In both cases this 236 // package doesn't need dexopt any longer. 237 return performedDexOpt ? DEX_OPT_PERFORMED : DEX_OPT_SKIPPED; 238 } 239 240 /** 241 * Creates oat dir for the specified package. In certain cases oat directory 242 * <strong>cannot</strong> be created: 243 * <ul> 244 * <li>{@code pkg} is a system app, which is not updated.</li> 245 * <li>Package location is not a directory, i.e. monolithic install.</li> 246 * </ul> 247 * 248 * @return Absolute path to the oat directory or null, if oat directory 249 * cannot be created. 250 */ 251 @Nullable 252 private String createOatDirIfSupported(PackageParser.Package pkg, String dexInstructionSet) { 253 if (!pkg.canHaveOatDir()) { 254 return null; 255 } 256 File codePath = new File(pkg.codePath); 257 if (codePath.isDirectory()) { 258 File oatDir = getOatDir(codePath); 259 try { 260 mInstaller.createOatDir(oatDir.getAbsolutePath(), dexInstructionSet); 261 } catch (InstallerException e) { 262 Slog.w(TAG, "Failed to create oat dir", e); 263 return null; 264 } 265 return oatDir.getAbsolutePath(); 266 } 267 return null; 268 } 269 270 static File getOatDir(File codePath) { 271 return new File(codePath, OAT_DIR_NAME); 272 } 273 274 void systemReady() { 275 mSystemReady = true; 276 } 277 278 private boolean isUsedByOtherApps(String apkPath) { 279 try { 280 apkPath = new File(apkPath).getCanonicalPath(); 281 } catch (IOException e) { 282 // Log an error but continue without it. 283 Slog.w(TAG, "Failed to get canonical path", e); 284 } 285 String useMarker = apkPath.replace('/', '@'); 286 final int[] currentUserIds = UserManagerService.getInstance().getUserIds(); 287 for (int i = 0; i < currentUserIds.length; i++) { 288 File profileDir = Environment.getDataProfilesDeForeignDexDirectory(currentUserIds[i]); 289 File foreignUseMark = new File(profileDir, useMarker); 290 if (foreignUseMark.exists()) { 291 return true; 292 } 293 } 294 return false; 295 } 296 297 /** 298 * A specialized PackageDexOptimizer that overrides already-installed checks, forcing a 299 * dexopt path. 300 */ 301 public static class ForcedUpdatePackageDexOptimizer extends PackageDexOptimizer { 302 303 public ForcedUpdatePackageDexOptimizer(Installer installer, Object installLock, 304 Context context, String wakeLockTag) { 305 super(installer, installLock, context, wakeLockTag); 306 } 307 308 public ForcedUpdatePackageDexOptimizer(PackageDexOptimizer from) { 309 super(from); 310 } 311 312 @Override 313 protected int adjustDexoptNeeded(int dexoptNeeded) { 314 // Ensure compilation, no matter the current state. 315 // TODO: The return value is wrong when patchoat is needed. 316 return DexFile.DEX2OAT_NEEDED; 317 } 318 } 319} 320