OtaDexoptService.java revision 07b6eabe79261267ecd7114790e96e1f6828672a
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.ShellCallback; 32import android.os.storage.StorageManager; 33import android.text.TextUtils; 34import android.util.Log; 35import android.util.Slog; 36 37import com.android.internal.logging.MetricsLogger; 38import com.android.server.pm.Installer.InstallerException; 39 40import java.io.File; 41import java.io.FileDescriptor; 42import java.util.ArrayList; 43import java.util.Arrays; 44import java.util.Collection; 45import java.util.List; 46import java.util.concurrent.TimeUnit; 47 48/** 49 * A service for A/B OTA dexopting. 50 * 51 * {@hide} 52 */ 53public class OtaDexoptService extends IOtaDexopt.Stub { 54 private final static String TAG = "OTADexopt"; 55 private final static boolean DEBUG_DEXOPT = true; 56 57 // The synthetic library dependencies denoting "no checks." 58 private final static String[] NO_LIBRARIES = new String[] { "&" }; 59 60 // The amount of "available" (free - low threshold) space necessary at the start of an OTA to 61 // not bulk-delete unused apps' odex files. 62 private final static long BULK_DELETE_THRESHOLD = 1024 * 1024 * 1024; // 1GB. 63 64 private final Context mContext; 65 private final PackageManagerService mPackageManagerService; 66 67 // TODO: Evaluate the need for WeakReferences here. 68 69 /** 70 * The list of dexopt invocations for all work. 71 */ 72 private List<String> mDexoptCommands; 73 74 private int completeSize; 75 76 // MetricsLogger properties. 77 78 // Space before and after. 79 private long availableSpaceBefore; 80 private long availableSpaceAfterBulkDelete; 81 private long availableSpaceAfterDexopt; 82 83 // Packages. 84 private int importantPackageCount; 85 private int otherPackageCount; 86 87 // Number of dexopt commands. This may be different from the count of packages. 88 private int dexoptCommandCountTotal; 89 private int dexoptCommandCountExecuted; 90 91 // For spent time. 92 private long otaDexoptTimeStart; 93 94 95 public OtaDexoptService(Context context, PackageManagerService packageManagerService) { 96 this.mContext = context; 97 this.mPackageManagerService = packageManagerService; 98 99 // Now it's time to check whether we need to move any A/B artifacts. 100 moveAbArtifacts(packageManagerService.mInstaller); 101 } 102 103 public static OtaDexoptService main(Context context, 104 PackageManagerService packageManagerService) { 105 OtaDexoptService ota = new OtaDexoptService(context, packageManagerService); 106 ServiceManager.addService("otadexopt", ota); 107 108 return ota; 109 } 110 111 @Override 112 public void onShellCommand(FileDescriptor in, FileDescriptor out, FileDescriptor err, 113 String[] args, ShellCallback callback, ResultReceiver resultReceiver) { 114 (new OtaDexoptShellCommand(this)).exec( 115 this, in, out, err, args, callback, resultReceiver); 116 } 117 118 @Override 119 public synchronized void prepare() throws RemoteException { 120 if (mDexoptCommands != null) { 121 throw new IllegalStateException("already called prepare()"); 122 } 123 final List<PackageParser.Package> important; 124 final List<PackageParser.Package> others; 125 synchronized (mPackageManagerService.mPackages) { 126 // Important: the packages we need to run with ab-ota compiler-reason. 127 important = PackageManagerServiceUtils.getPackagesForDexopt( 128 mPackageManagerService.mPackages.values(), mPackageManagerService); 129 // Others: we should optimize this with the (first-)boot compiler-reason. 130 others = new ArrayList<>(mPackageManagerService.mPackages.values()); 131 others.removeAll(important); 132 133 // Pre-size the array list by over-allocating by a factor of 1.5. 134 mDexoptCommands = new ArrayList<>(3 * mPackageManagerService.mPackages.size() / 2); 135 } 136 137 for (PackageParser.Package p : important) { 138 // Make sure that core apps are optimized according to their own "reason". 139 // If the core apps are not preopted in the B OTA, and REASON_AB_OTA is not speed 140 // (by default is speed-profile) they will be interepreted/JITed. This in itself is 141 // not a problem as we will end up doing profile guided compilation. However, some 142 // core apps may be loaded by system server which doesn't JIT and we need to make 143 // sure we don't interpret-only 144 int compilationReason = p.coreApp 145 ? PackageManagerService.REASON_CORE_APP 146 : PackageManagerService.REASON_AB_OTA; 147 mDexoptCommands.addAll(generatePackageDexopts(p, compilationReason)); 148 } 149 for (PackageParser.Package p : others) { 150 // We assume here that there are no core apps left. 151 if (p.coreApp) { 152 throw new IllegalStateException("Found a core app that's not important"); 153 } 154 mDexoptCommands.addAll( 155 generatePackageDexopts(p, PackageManagerService.REASON_FIRST_BOOT)); 156 } 157 completeSize = mDexoptCommands.size(); 158 159 long spaceAvailable = getAvailableSpace(); 160 if (spaceAvailable < BULK_DELETE_THRESHOLD) { 161 Log.i(TAG, "Low on space, deleting oat files in an attempt to free up space: " 162 + PackageManagerServiceUtils.packagesToString(others)); 163 for (PackageParser.Package pkg : others) { 164 deleteOatArtifactsOfPackage(pkg); 165 } 166 } 167 long spaceAvailableNow = getAvailableSpace(); 168 169 prepareMetricsLogging(important.size(), others.size(), spaceAvailable, spaceAvailableNow); 170 } 171 172 @Override 173 public synchronized void cleanup() throws RemoteException { 174 if (DEBUG_DEXOPT) { 175 Log.i(TAG, "Cleaning up OTA Dexopt state."); 176 } 177 mDexoptCommands = null; 178 availableSpaceAfterDexopt = getAvailableSpace(); 179 180 performMetricsLogging(); 181 } 182 183 @Override 184 public synchronized boolean isDone() throws RemoteException { 185 if (mDexoptCommands == null) { 186 throw new IllegalStateException("done() called before prepare()"); 187 } 188 189 return mDexoptCommands.isEmpty(); 190 } 191 192 @Override 193 public synchronized float getProgress() throws RemoteException { 194 // Approximate the progress by the amount of already completed commands. 195 if (completeSize == 0) { 196 return 1f; 197 } 198 int commandsLeft = mDexoptCommands.size(); 199 return (completeSize - commandsLeft) / ((float)completeSize); 200 } 201 202 @Override 203 public synchronized String nextDexoptCommand() throws RemoteException { 204 if (mDexoptCommands == null) { 205 throw new IllegalStateException("dexoptNextPackage() called before prepare()"); 206 } 207 208 if (mDexoptCommands.isEmpty()) { 209 return "(all done)"; 210 } 211 212 String next = mDexoptCommands.remove(0); 213 214 if (getAvailableSpace() > 0) { 215 dexoptCommandCountExecuted++; 216 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 320 return commands; 321 } 322 323 @Override 324 public synchronized void dexoptNextPackage() throws RemoteException { 325 throw new UnsupportedOperationException(); 326 } 327 328 private void moveAbArtifacts(Installer installer) { 329 if (mDexoptCommands != null) { 330 throw new IllegalStateException("Should not be ota-dexopting when trying to move."); 331 } 332 333 // Look into all packages. 334 Collection<PackageParser.Package> pkgs = mPackageManagerService.getPackages(); 335 for (PackageParser.Package pkg : pkgs) { 336 if (pkg == null) { 337 continue; 338 } 339 340 // Does the package have code? If not, there won't be any artifacts. 341 if (!PackageDexOptimizer.canOptimizePackage(pkg)) { 342 continue; 343 } 344 if (pkg.codePath == null) { 345 Slog.w(TAG, "Package " + pkg + " can be optimized but has null codePath"); 346 continue; 347 } 348 349 // If the path is in /system or /vendor, ignore. It will have been ota-dexopted into 350 // /data/ota and moved into the dalvik-cache already. 351 if (pkg.codePath.startsWith("/system") || pkg.codePath.startsWith("/vendor")) { 352 continue; 353 } 354 355 final String[] instructionSets = getAppDexInstructionSets(pkg.applicationInfo); 356 final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly(); 357 final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets); 358 for (String dexCodeInstructionSet : dexCodeInstructionSets) { 359 for (String path : paths) { 360 String oatDir = PackageDexOptimizer.getOatDir(new File(pkg.codePath)). 361 getAbsolutePath(); 362 363 // TODO: Check first whether there is an artifact, to save the roundtrip time. 364 365 try { 366 installer.moveAb(path, dexCodeInstructionSet, oatDir); 367 } catch (InstallerException e) { 368 } 369 } 370 } 371 } 372 } 373 374 /** 375 * Initialize logging fields. 376 */ 377 private void prepareMetricsLogging(int important, int others, long spaceBegin, long spaceBulk) { 378 availableSpaceBefore = spaceBegin; 379 availableSpaceAfterBulkDelete = spaceBulk; 380 availableSpaceAfterDexopt = 0; 381 382 importantPackageCount = important; 383 otherPackageCount = others; 384 385 dexoptCommandCountTotal = mDexoptCommands.size(); 386 dexoptCommandCountExecuted = 0; 387 388 otaDexoptTimeStart = System.nanoTime(); 389 } 390 391 private static int inMegabytes(long value) { 392 long in_mega_bytes = value / (1024 * 1024); 393 if (in_mega_bytes > Integer.MAX_VALUE) { 394 Log.w(TAG, "Recording " + in_mega_bytes + "MB of free space, overflowing range"); 395 return Integer.MAX_VALUE; 396 } 397 return (int)in_mega_bytes; 398 } 399 400 private void performMetricsLogging() { 401 long finalTime = System.nanoTime(); 402 403 MetricsLogger.histogram(mContext, "ota_dexopt_available_space_before_mb", 404 inMegabytes(availableSpaceBefore)); 405 MetricsLogger.histogram(mContext, "ota_dexopt_available_space_after_bulk_delete_mb", 406 inMegabytes(availableSpaceAfterBulkDelete)); 407 MetricsLogger.histogram(mContext, "ota_dexopt_available_space_after_dexopt_mb", 408 inMegabytes(availableSpaceAfterDexopt)); 409 410 MetricsLogger.histogram(mContext, "ota_dexopt_num_important_packages", 411 importantPackageCount); 412 MetricsLogger.histogram(mContext, "ota_dexopt_num_other_packages", otherPackageCount); 413 414 MetricsLogger.histogram(mContext, "ota_dexopt_num_commands", dexoptCommandCountTotal); 415 MetricsLogger.histogram(mContext, "ota_dexopt_num_commands_executed", 416 dexoptCommandCountExecuted); 417 418 final int elapsedTimeSeconds = 419 (int) TimeUnit.NANOSECONDS.toSeconds(finalTime - otaDexoptTimeStart); 420 MetricsLogger.histogram(mContext, "ota_dexopt_time_s", elapsedTimeSeconds); 421 } 422 423 private static class OTADexoptPackageDexOptimizer extends 424 PackageDexOptimizer.ForcedUpdatePackageDexOptimizer { 425 public OTADexoptPackageDexOptimizer(Installer installer, Object installLock, 426 Context context) { 427 super(installer, installLock, context, "*otadexopt*"); 428 } 429 } 430 431 /** 432 * Cook up argument list in the format that {@code installd} expects. 433 */ 434 private static String buildCommand(Object... args) { 435 final StringBuilder builder = new StringBuilder(); 436 for (Object arg : args) { 437 String escaped; 438 if (arg == null) { 439 escaped = ""; 440 } else { 441 escaped = String.valueOf(arg); 442 } 443 if (escaped.indexOf('\0') != -1 || escaped.indexOf(' ') != -1 || "!".equals(escaped)) { 444 throw new IllegalArgumentException( 445 "Invalid argument while executing " + Arrays.toString(args)); 446 } 447 if (TextUtils.isEmpty(escaped)) { 448 escaped = "!"; 449 } 450 builder.append(' ').append(escaped); 451 } 452 return builder.toString(); 453 } 454} 455