OtaDexoptService.java revision 3b4359a06c482095338080fa908a67441ad23a2b
1/* 2 * Copyright (C) 2016 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 static com.android.server.pm.InstructionSets.getAppDexInstructionSets; 20import static com.android.server.pm.InstructionSets.getDexCodeInstructionSets; 21import static com.android.server.pm.PackageManagerServiceCompilerMapping.getCompilerFilterForReason; 22 23import android.annotation.Nullable; 24import android.content.Context; 25import android.content.pm.IOtaDexopt; 26import android.content.pm.PackageParser; 27import android.os.Environment; 28import android.os.RemoteException; 29import android.os.ResultReceiver; 30import android.os.ServiceManager; 31import android.os.storage.StorageManager; 32import android.text.TextUtils; 33import android.util.Log; 34import android.util.Slog; 35 36import com.android.internal.logging.MetricsLogger; 37import com.android.server.pm.Installer.InstallerException; 38 39import java.io.File; 40import java.io.FileDescriptor; 41import java.util.ArrayList; 42import java.util.Arrays; 43import java.util.Collection; 44import java.util.List; 45import java.util.concurrent.TimeUnit; 46 47/** 48 * A service for A/B OTA dexopting. 49 * 50 * {@hide} 51 */ 52public class OtaDexoptService extends IOtaDexopt.Stub { 53 private final static String TAG = "OTADexopt"; 54 private final static boolean DEBUG_DEXOPT = true; 55 56 // The synthetic library dependencies denoting "no checks." 57 private final static String[] NO_LIBRARIES = new String[] { "&" }; 58 59 // The amount of "available" (free - low threshold) space necessary at the start of an OTA to 60 // not bulk-delete unused apps' odex files. 61 private final static long BULK_DELETE_THRESHOLD = 1024 * 1024 * 1024; // 1GB. 62 63 private final Context mContext; 64 private final PackageManagerService mPackageManagerService; 65 66 // TODO: Evaluate the need for WeakReferences here. 67 68 /** 69 * The list of dexopt invocations for all work. 70 */ 71 private List<String> mDexoptCommands; 72 73 private int completeSize; 74 75 // MetricsLogger properties. 76 77 // Space before and after. 78 private long availableSpaceBefore; 79 private long availableSpaceAfterBulkDelete; 80 private long availableSpaceAfterDexopt; 81 82 // Packages. 83 private int importantPackageCount; 84 private int otherPackageCount; 85 86 // Number of dexopt commands. This may be different from the count of packages. 87 private int dexoptCommandCountTotal; 88 private int dexoptCommandCountExecuted; 89 90 // For spent time. 91 private long otaDexoptTimeStart; 92 93 94 public OtaDexoptService(Context context, PackageManagerService packageManagerService) { 95 this.mContext = context; 96 this.mPackageManagerService = packageManagerService; 97 } 98 99 public static OtaDexoptService main(Context context, 100 PackageManagerService packageManagerService) { 101 OtaDexoptService ota = new OtaDexoptService(context, packageManagerService); 102 ServiceManager.addService("otadexopt", ota); 103 104 // Now it's time to check whether we need to move any A/B artifacts. 105 ota.moveAbArtifacts(packageManagerService.mInstaller); 106 107 return ota; 108 } 109 110 @Override 111 public void onShellCommand(FileDescriptor in, FileDescriptor out, FileDescriptor err, 112 String[] args, ResultReceiver resultReceiver) throws RemoteException { 113 (new OtaDexoptShellCommand(this)).exec( 114 this, in, out, err, args, resultReceiver); 115 } 116 117 @Override 118 public synchronized void prepare() throws RemoteException { 119 if (mDexoptCommands != null) { 120 throw new IllegalStateException("already called prepare()"); 121 } 122 final List<PackageParser.Package> important; 123 final List<PackageParser.Package> others; 124 synchronized (mPackageManagerService.mPackages) { 125 // Important: the packages we need to run with ab-ota compiler-reason. 126 important = PackageManagerServiceUtils.getPackagesForDexopt( 127 mPackageManagerService.mPackages.values(), mPackageManagerService); 128 // Others: we should optimize this with the (first-)boot compiler-reason. 129 others = new ArrayList<>(mPackageManagerService.mPackages.values()); 130 others.removeAll(important); 131 132 // Pre-size the array list by over-allocating by a factor of 1.5. 133 mDexoptCommands = new ArrayList<>(3 * mPackageManagerService.mPackages.size() / 2); 134 } 135 136 for (PackageParser.Package p : important) { 137 // Make sure that core apps are optimized according to their own "reason". 138 // If the core apps are not preopted in the B OTA, and REASON_AB_OTA is not speed 139 // (by default is speed-profile) they will be interepreted/JITed. This in itself is 140 // not a problem as we will end up doing profile guided compilation. However, some 141 // core apps may be loaded by system server which doesn't JIT and we need to make 142 // sure we are not interpreting all their code in that process. 143 int compilationReason = p.coreApp 144 ? PackageManagerService.REASON_CORE_APP 145 : PackageManagerService.REASON_AB_OTA; 146 mDexoptCommands.addAll(generatePackageDexopts(p, compilationReason)); 147 } 148 for (PackageParser.Package p : others) { 149 // We assume here that there are no core apps left. 150 if (p.coreApp) { 151 throw new IllegalStateException("Found a core app that's not important"); 152 } 153 mDexoptCommands.addAll( 154 generatePackageDexopts(p, PackageManagerService.REASON_FIRST_BOOT)); 155 } 156 completeSize = mDexoptCommands.size(); 157 158 long spaceAvailable = getAvailableSpace(); 159 if (spaceAvailable < BULK_DELETE_THRESHOLD) { 160 Log.i(TAG, "Low on space, deleting oat files in an attempt to free up space: " 161 + PackageManagerServiceUtils.packagesToString(others)); 162 for (PackageParser.Package pkg : others) { 163 deleteOatArtifactsOfPackage(pkg); 164 } 165 } 166 long spaceAvailableNow = getAvailableSpace(); 167 168 prepareMetricsLogging(important.size(), others.size(), spaceAvailable, spaceAvailableNow); 169 } 170 171 @Override 172 public synchronized void cleanup() throws RemoteException { 173 if (DEBUG_DEXOPT) { 174 Log.i(TAG, "Cleaning up OTA Dexopt state."); 175 } 176 mDexoptCommands = null; 177 availableSpaceAfterDexopt = getAvailableSpace(); 178 179 performMetricsLogging(); 180 } 181 182 @Override 183 public synchronized boolean isDone() throws RemoteException { 184 if (mDexoptCommands == null) { 185 throw new IllegalStateException("done() called before prepare()"); 186 } 187 188 return mDexoptCommands.isEmpty(); 189 } 190 191 @Override 192 public synchronized float getProgress() throws RemoteException { 193 // Approximate the progress by the amount of already completed commands. 194 if (completeSize == 0) { 195 return 1f; 196 } 197 int commandsLeft = mDexoptCommands.size(); 198 return (completeSize - commandsLeft) / ((float)completeSize); 199 } 200 201 @Override 202 public synchronized String nextDexoptCommand() throws RemoteException { 203 if (mDexoptCommands == null) { 204 throw new IllegalStateException("dexoptNextPackage() called before prepare()"); 205 } 206 207 if (mDexoptCommands.isEmpty()) { 208 return "(all done)"; 209 } 210 211 String next = mDexoptCommands.remove(0); 212 213 if (getAvailableSpace() > 0) { 214 dexoptCommandCountExecuted++; 215 216 Log.d(TAG, "Next command: " + next); 217 return next; 218 } else { 219 if (DEBUG_DEXOPT) { 220 Log.w(TAG, "Not enough space for OTA dexopt, stopping with " 221 + (mDexoptCommands.size() + 1) + " commands left."); 222 } 223 mDexoptCommands.clear(); 224 return "(no free space)"; 225 } 226 } 227 228 private long getMainLowSpaceThreshold() { 229 File dataDir = Environment.getDataDirectory(); 230 @SuppressWarnings("deprecation") 231 long lowThreshold = StorageManager.from(mContext).getStorageLowBytes(dataDir); 232 if (lowThreshold == 0) { 233 throw new IllegalStateException("Invalid low memory threshold"); 234 } 235 return lowThreshold; 236 } 237 238 /** 239 * Returns the difference of free space to the low-storage-space threshold. Positive values 240 * indicate free bytes. 241 */ 242 private long getAvailableSpace() { 243 // TODO: If apps are not installed in the internal /data partition, we should compare 244 // against that storage's free capacity. 245 long lowThreshold = getMainLowSpaceThreshold(); 246 247 File dataDir = Environment.getDataDirectory(); 248 long usableSpace = dataDir.getUsableSpace(); 249 250 return usableSpace - lowThreshold; 251 } 252 253 private static String getOatDir(PackageParser.Package pkg) { 254 if (!pkg.canHaveOatDir()) { 255 return null; 256 } 257 File codePath = new File(pkg.codePath); 258 if (codePath.isDirectory()) { 259 return PackageDexOptimizer.getOatDir(codePath).getAbsolutePath(); 260 } 261 return null; 262 } 263 264 private void deleteOatArtifactsOfPackage(PackageParser.Package pkg) { 265 String[] instructionSets = getAppDexInstructionSets(pkg.applicationInfo); 266 for (String codePath : pkg.getAllCodePaths()) { 267 for (String isa : instructionSets) { 268 try { 269 mPackageManagerService.mInstaller.deleteOdex(codePath, isa, getOatDir(pkg)); 270 } catch (InstallerException e) { 271 Log.e(TAG, "Failed deleting oat files for " + codePath, e); 272 } 273 } 274 } 275 } 276 277 /** 278 * Generate all dexopt commands for the given package. 279 */ 280 private synchronized List<String> generatePackageDexopts(PackageParser.Package pkg, 281 int compilationReason) { 282 // Intercept and collect dexopt requests 283 final List<String> commands = new ArrayList<String>(); 284 final Installer collectingInstaller = new Installer(mContext, true) { 285 @Override 286 public void dexopt(String apkPath, int uid, @Nullable String pkgName, 287 String instructionSet, int dexoptNeeded, @Nullable String outputPath, 288 int dexFlags, String compilerFilter, @Nullable String volumeUuid, 289 @Nullable String sharedLibraries) throws InstallerException { 290 commands.add(buildCommand("dexopt", 291 apkPath, 292 uid, 293 pkgName, 294 instructionSet, 295 dexoptNeeded, 296 outputPath, 297 dexFlags, 298 compilerFilter, 299 volumeUuid, 300 sharedLibraries)); 301 } 302 }; 303 304 // Use the package manager install and install lock here for the OTA dex optimizer. 305 PackageDexOptimizer optimizer = new OTADexoptPackageDexOptimizer( 306 collectingInstaller, mPackageManagerService.mInstallLock, mContext); 307 308 String[] libraryDependencies = pkg.usesLibraryFiles; 309 if (pkg.isSystemApp()) { 310 // For system apps, we want to avoid classpaths checks. 311 libraryDependencies = NO_LIBRARIES; 312 } 313 314 optimizer.performDexOpt(pkg, libraryDependencies, 315 null /* ISAs */, false /* checkProfiles */, 316 getCompilerFilterForReason(compilationReason), 317 null /* CompilerStats.PackageStats */, 318 mPackageManagerService.getDexManager().isUsedByOtherApps(pkg.packageName), 319 true /* bootComplete */); 320 321 return commands; 322 } 323 324 @Override 325 public synchronized void dexoptNextPackage() throws RemoteException { 326 throw new UnsupportedOperationException(); 327 } 328 329 private void moveAbArtifacts(Installer installer) { 330 if (mDexoptCommands != null) { 331 throw new IllegalStateException("Should not be ota-dexopting when trying to move."); 332 } 333 334 if (!mPackageManagerService.isUpgrade()) { 335 Slog.d(TAG, "No upgrade, skipping A/B artifacts check."); 336 return; 337 } 338 339 // Look into all packages. 340 Collection<PackageParser.Package> pkgs = mPackageManagerService.getPackages(); 341 int packagePaths = 0; 342 int pathsSuccessful = 0; 343 for (PackageParser.Package pkg : pkgs) { 344 if (pkg == null) { 345 continue; 346 } 347 348 // Does the package have code? If not, there won't be any artifacts. 349 if (!PackageDexOptimizer.canOptimizePackage(pkg)) { 350 continue; 351 } 352 if (pkg.codePath == null) { 353 Slog.w(TAG, "Package " + pkg + " can be optimized but has null codePath"); 354 continue; 355 } 356 357 // If the path is in /system or /vendor, ignore. It will have been ota-dexopted into 358 // /data/ota and moved into the dalvik-cache already. 359 if (pkg.codePath.startsWith("/system") || pkg.codePath.startsWith("/vendor")) { 360 continue; 361 } 362 363 final String[] instructionSets = getAppDexInstructionSets(pkg.applicationInfo); 364 final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly(); 365 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 366 for (String dexCodeInstructionSet : dexCodeInstructionSets) { 367 for (String path : paths) { 368 String oatDir = PackageDexOptimizer.getOatDir(new File(pkg.codePath)). 369 getAbsolutePath(); 370 371 // TODO: Check first whether there is an artifact, to save the roundtrip time. 372 373 packagePaths++; 374 try { 375 installer.moveAb(path, dexCodeInstructionSet, oatDir); 376 pathsSuccessful++; 377 } catch (InstallerException e) { 378 } 379 } 380 } 381 } 382 Slog.i(TAG, "Moved " + pathsSuccessful + "/" + packagePaths); 383 } 384 385 /** 386 * Initialize logging fields. 387 */ 388 private void prepareMetricsLogging(int important, int others, long spaceBegin, long spaceBulk) { 389 availableSpaceBefore = spaceBegin; 390 availableSpaceAfterBulkDelete = spaceBulk; 391 availableSpaceAfterDexopt = 0; 392 393 importantPackageCount = important; 394 otherPackageCount = others; 395 396 dexoptCommandCountTotal = mDexoptCommands.size(); 397 dexoptCommandCountExecuted = 0; 398 399 otaDexoptTimeStart = System.nanoTime(); 400 } 401 402 private static int inMegabytes(long value) { 403 long in_mega_bytes = value / (1024 * 1024); 404 if (in_mega_bytes > Integer.MAX_VALUE) { 405 Log.w(TAG, "Recording " + in_mega_bytes + "MB of free space, overflowing range"); 406 return Integer.MAX_VALUE; 407 } 408 return (int)in_mega_bytes; 409 } 410 411 private void performMetricsLogging() { 412 long finalTime = System.nanoTime(); 413 414 MetricsLogger.histogram(mContext, "ota_dexopt_available_space_before_mb", 415 inMegabytes(availableSpaceBefore)); 416 MetricsLogger.histogram(mContext, "ota_dexopt_available_space_after_bulk_delete_mb", 417 inMegabytes(availableSpaceAfterBulkDelete)); 418 MetricsLogger.histogram(mContext, "ota_dexopt_available_space_after_dexopt_mb", 419 inMegabytes(availableSpaceAfterDexopt)); 420 421 MetricsLogger.histogram(mContext, "ota_dexopt_num_important_packages", 422 importantPackageCount); 423 MetricsLogger.histogram(mContext, "ota_dexopt_num_other_packages", otherPackageCount); 424 425 MetricsLogger.histogram(mContext, "ota_dexopt_num_commands", dexoptCommandCountTotal); 426 MetricsLogger.histogram(mContext, "ota_dexopt_num_commands_executed", 427 dexoptCommandCountExecuted); 428 429 final int elapsedTimeSeconds = 430 (int) TimeUnit.NANOSECONDS.toSeconds(finalTime - otaDexoptTimeStart); 431 MetricsLogger.histogram(mContext, "ota_dexopt_time_s", elapsedTimeSeconds); 432 } 433 434 private static class OTADexoptPackageDexOptimizer extends 435 PackageDexOptimizer.ForcedUpdatePackageDexOptimizer { 436 public OTADexoptPackageDexOptimizer(Installer installer, Object installLock, 437 Context context) { 438 super(installer, installLock, context, "*otadexopt*"); 439 } 440 } 441 442 /** 443 * Cook up argument list in the format that {@code installd} expects. 444 */ 445 private static String buildCommand(Object... args) { 446 final StringBuilder builder = new StringBuilder(); 447 for (Object arg : args) { 448 String escaped; 449 if (arg == null) { 450 escaped = ""; 451 } else { 452 escaped = String.valueOf(arg); 453 } 454 if (escaped.indexOf('\0') != -1 || escaped.indexOf(' ') != -1 || "!".equals(escaped)) { 455 throw new IllegalArgumentException( 456 "Invalid argument while executing " + Arrays.toString(args)); 457 } 458 if (TextUtils.isEmpty(escaped)) { 459 escaped = "!"; 460 } 461 builder.append(' ').append(escaped); 462 } 463 return builder.toString(); 464 } 465} 466