PackageDexOptimizer.java revision 9fa025491da8c6493d9286a7d4980105b649406e
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.getFullCompilerFilter; 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 // TODO: Should we only upgrade to the non-profile-guided version? That is, 148 // given verify-profile, should we move to interpret-only? 149 targetCompilerFilter = getFullCompilerFilter(); 150 isProfileGuidedFilter = false; 151 152 break; 153 } 154 } 155 } 156 157 // If we're asked to take profile updates into account, check now. 158 boolean newProfile = false; 159 if (checkProfiles && isProfileGuidedFilter) { 160 // Merge profiles, see if we need to do anything. 161 try { 162 newProfile = mInstaller.mergeProfiles(sharedGid, pkg.packageName); 163 } catch (InstallerException e) { 164 Slog.w(TAG, "Failed to merge profiles", e); 165 } 166 } 167 168 final boolean vmSafeMode = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_VM_SAFE_MODE) != 0; 169 final boolean debuggable = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0; 170 171 boolean performedDexOpt = false; 172 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 173 for (String dexCodeInstructionSet : dexCodeInstructionSets) { 174 for (String path : paths) { 175 int dexoptNeeded; 176 try { 177 dexoptNeeded = DexFile.getDexOptNeeded(path, 178 dexCodeInstructionSet, targetCompilerFilter, newProfile); 179 } catch (IOException ioe) { 180 Slog.w(TAG, "IOException reading apk: " + path, ioe); 181 return DEX_OPT_FAILED; 182 } 183 dexoptNeeded = adjustDexoptNeeded(dexoptNeeded); 184 185 final String dexoptType; 186 String oatDir = null; 187 switch (dexoptNeeded) { 188 case DexFile.NO_DEXOPT_NEEDED: 189 continue; 190 case DexFile.DEX2OAT_NEEDED: 191 dexoptType = "dex2oat"; 192 oatDir = createOatDirIfSupported(pkg, dexCodeInstructionSet); 193 break; 194 case DexFile.PATCHOAT_NEEDED: 195 dexoptType = "patchoat"; 196 break; 197 case DexFile.SELF_PATCHOAT_NEEDED: 198 dexoptType = "self patchoat"; 199 break; 200 default: 201 throw new IllegalStateException("Invalid dexopt:" + dexoptNeeded); 202 } 203 204 Log.i(TAG, "Running dexopt (" + dexoptType + ") on: " + path + " pkg=" 205 + pkg.applicationInfo.packageName + " isa=" + dexCodeInstructionSet 206 + " vmSafeMode=" + vmSafeMode + " debuggable=" + debuggable 207 + " target-filter=" + targetCompilerFilter + " oatDir = " + oatDir); 208 // Profile guide compiled oat files should not be public. 209 final boolean isPublic = !pkg.isForwardLocked() && !isProfileGuidedFilter; 210 final int profileFlag = isProfileGuidedFilter ? DEXOPT_PROFILE_GUIDED : 0; 211 final int dexFlags = adjustDexoptFlags( 212 ( isPublic ? DEXOPT_PUBLIC : 0) 213 | (vmSafeMode ? DEXOPT_SAFEMODE : 0) 214 | (debuggable ? DEXOPT_DEBUGGABLE : 0) 215 | profileFlag 216 | DEXOPT_BOOTCOMPLETE); 217 218 try { 219 mInstaller.dexopt(path, sharedGid, pkg.packageName, dexCodeInstructionSet, 220 dexoptNeeded, oatDir, dexFlags, targetCompilerFilter, pkg.volumeUuid); 221 performedDexOpt = true; 222 } catch (InstallerException e) { 223 Slog.w(TAG, "Failed to dexopt", e); 224 } 225 } 226 } 227 228 // If we've gotten here, we're sure that no error occurred and that we haven't 229 // deferred dex-opt. We've either dex-opted one more paths or instruction sets or 230 // we've skipped all of them because they are up to date. In both cases this 231 // package doesn't need dexopt any longer. 232 return performedDexOpt ? DEX_OPT_PERFORMED : DEX_OPT_SKIPPED; 233 } 234 235 /** 236 * Creates oat dir for the specified package. In certain cases oat directory 237 * <strong>cannot</strong> be created: 238 * <ul> 239 * <li>{@code pkg} is a system app, which is not updated.</li> 240 * <li>Package location is not a directory, i.e. monolithic install.</li> 241 * </ul> 242 * 243 * @return Absolute path to the oat directory or null, if oat directory 244 * cannot be created. 245 */ 246 @Nullable 247 private String createOatDirIfSupported(PackageParser.Package pkg, String dexInstructionSet) { 248 if (!pkg.canHaveOatDir()) { 249 return null; 250 } 251 File codePath = new File(pkg.codePath); 252 if (codePath.isDirectory()) { 253 File oatDir = getOatDir(codePath); 254 try { 255 mInstaller.createOatDir(oatDir.getAbsolutePath(), dexInstructionSet); 256 } catch (InstallerException e) { 257 Slog.w(TAG, "Failed to create oat dir", e); 258 return null; 259 } 260 return oatDir.getAbsolutePath(); 261 } 262 return null; 263 } 264 265 static File getOatDir(File codePath) { 266 return new File(codePath, OAT_DIR_NAME); 267 } 268 269 void systemReady() { 270 mSystemReady = true; 271 } 272 273 private boolean isUsedByOtherApps(String apkPath) { 274 try { 275 apkPath = new File(apkPath).getCanonicalPath(); 276 } catch (IOException e) { 277 // Log an error but continue without it. 278 Slog.w(TAG, "Failed to get canonical path", e); 279 } 280 String useMarker = apkPath.replace('/', '@'); 281 final int[] currentUserIds = UserManagerService.getInstance().getUserIds(); 282 for (int i = 0; i < currentUserIds.length; i++) { 283 File profileDir = Environment.getDataProfilesDeForeignDexDirectory(currentUserIds[i]); 284 File foreignUseMark = new File(profileDir, useMarker); 285 if (foreignUseMark.exists()) { 286 return true; 287 } 288 } 289 return false; 290 } 291 292 /** 293 * A specialized PackageDexOptimizer that overrides already-installed checks, forcing a 294 * dexopt path. 295 */ 296 public static class ForcedUpdatePackageDexOptimizer extends PackageDexOptimizer { 297 298 public ForcedUpdatePackageDexOptimizer(Installer installer, Object installLock, 299 Context context, String wakeLockTag) { 300 super(installer, installLock, context, wakeLockTag); 301 } 302 303 public ForcedUpdatePackageDexOptimizer(PackageDexOptimizer from) { 304 super(from); 305 } 306 307 @Override 308 protected int adjustDexoptNeeded(int dexoptNeeded) { 309 // Ensure compilation, no matter the current state. 310 // TODO: The return value is wrong when patchoat is needed. 311 return DexFile.DEX2OAT_NEEDED; 312 } 313 } 314} 315