PackageDexOptimizer.java revision da09815e2cd3d3968c66a8d52e620ee07d8204dd
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.FileUtils;
24import android.os.PowerManager;
25import android.os.SystemClock;
26import android.os.UserHandle;
27import android.os.WorkSource;
28import android.util.Log;
29import android.util.Slog;
30
31import com.android.internal.annotations.GuardedBy;
32import com.android.internal.util.IndentingPrintWriter;
33import com.android.server.pm.Installer.InstallerException;
34import com.android.server.pm.dex.DexManager;
35import com.android.server.pm.dex.DexoptOptions;
36import com.android.server.pm.dex.DexoptUtils;
37import com.android.server.pm.dex.PackageDexUsage;
38
39import java.io.File;
40import java.io.IOException;
41import java.util.ArrayList;
42import java.util.Arrays;
43import java.util.List;
44import java.util.Map;
45
46import dalvik.system.DexFile;
47
48import static com.android.server.pm.Installer.DEXOPT_BOOTCOMPLETE;
49import static com.android.server.pm.Installer.DEXOPT_DEBUGGABLE;
50import static com.android.server.pm.Installer.DEXOPT_PROFILE_GUIDED;
51import static com.android.server.pm.Installer.DEXOPT_PUBLIC;
52import static com.android.server.pm.Installer.DEXOPT_SECONDARY_DEX;
53import static com.android.server.pm.Installer.DEXOPT_FORCE;
54import static com.android.server.pm.Installer.DEXOPT_STORAGE_CE;
55import static com.android.server.pm.Installer.DEXOPT_STORAGE_DE;
56import static com.android.server.pm.InstructionSets.getAppDexInstructionSets;
57import static com.android.server.pm.InstructionSets.getDexCodeInstructionSets;
58
59import static com.android.server.pm.PackageManagerService.WATCHDOG_TIMEOUT;
60
61import static dalvik.system.DexFile.getNonProfileGuidedCompilerFilter;
62import static dalvik.system.DexFile.getSafeModeCompilerFilter;
63import static dalvik.system.DexFile.isProfileGuidedCompilerFilter;
64
65/**
66 * Helper class for running dexopt command on packages.
67 */
68public class PackageDexOptimizer {
69    private static final String TAG = "PackageManager.DexOptimizer";
70    static final String OAT_DIR_NAME = "oat";
71    // TODO b/19550105 Remove error codes and use exceptions
72    public static final int DEX_OPT_SKIPPED = 0;
73    public static final int DEX_OPT_PERFORMED = 1;
74    public static final int DEX_OPT_FAILED = -1;
75    // One minute over PM WATCHDOG_TIMEOUT
76    private static final long WAKELOCK_TIMEOUT_MS = WATCHDOG_TIMEOUT + 1000 * 60;
77
78    /** Special library name that skips shared libraries check during compilation. */
79    public static final String SKIP_SHARED_LIBRARY_CHECK = "&";
80
81    @GuardedBy("mInstallLock")
82    private final Installer mInstaller;
83    private final Object mInstallLock;
84
85    @GuardedBy("mInstallLock")
86    private final PowerManager.WakeLock mDexoptWakeLock;
87    private volatile boolean mSystemReady;
88
89    PackageDexOptimizer(Installer installer, Object installLock, Context context,
90            String wakeLockTag) {
91        this.mInstaller = installer;
92        this.mInstallLock = installLock;
93
94        PowerManager powerManager = (PowerManager)context.getSystemService(Context.POWER_SERVICE);
95        mDexoptWakeLock = powerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, wakeLockTag);
96    }
97
98    protected PackageDexOptimizer(PackageDexOptimizer from) {
99        this.mInstaller = from.mInstaller;
100        this.mInstallLock = from.mInstallLock;
101        this.mDexoptWakeLock = from.mDexoptWakeLock;
102        this.mSystemReady = from.mSystemReady;
103    }
104
105    static boolean canOptimizePackage(PackageParser.Package pkg) {
106        return (pkg.applicationInfo.flags & ApplicationInfo.FLAG_HAS_CODE) != 0;
107    }
108
109    /**
110     * Performs dexopt on all code paths and libraries of the specified package for specified
111     * instruction sets.
112     *
113     * <p>Calls to {@link com.android.server.pm.Installer#dexopt} on {@link #mInstaller} are
114     * synchronized on {@link #mInstallLock}.
115     */
116    int performDexOpt(PackageParser.Package pkg, String[] sharedLibraries,
117            String[] instructionSets, CompilerStats.PackageStats packageStats,
118            PackageDexUsage.PackageUseInfo packageUseInfo, DexoptOptions options) {
119        if (!canOptimizePackage(pkg)) {
120            return DEX_OPT_SKIPPED;
121        }
122        synchronized (mInstallLock) {
123            final long acquireTime = acquireWakeLockLI(pkg.applicationInfo.uid);
124            try {
125                return performDexOptLI(pkg, sharedLibraries, instructionSets,
126                        packageStats, packageUseInfo, options);
127            } finally {
128                releaseWakeLockLI(acquireTime);
129            }
130        }
131    }
132
133    /**
134     * Performs dexopt on all code paths of the given package.
135     * It assumes the install lock is held.
136     */
137    @GuardedBy("mInstallLock")
138    private int performDexOptLI(PackageParser.Package pkg, String[] sharedLibraries,
139            String[] targetInstructionSets, CompilerStats.PackageStats packageStats,
140            PackageDexUsage.PackageUseInfo packageUseInfo, DexoptOptions options) {
141        final String[] instructionSets = targetInstructionSets != null ?
142                targetInstructionSets : getAppDexInstructionSets(pkg.applicationInfo);
143        final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets);
144        final List<String> paths = pkg.getAllCodePaths();
145        final int sharedGid = UserHandle.getSharedAppGid(pkg.applicationInfo.uid);
146
147        // Get the class loader context dependencies.
148        // For each code path in the package, this array contains the class loader context that
149        // needs to be passed to dexopt in order to ensure correct optimizations.
150        boolean[] pathsWithCode = new boolean[paths.size()];
151        pathsWithCode[0] = (pkg.applicationInfo.flags & ApplicationInfo.FLAG_HAS_CODE) != 0;
152        for (int i = 1; i < paths.size(); i++) {
153            pathsWithCode[i] = (pkg.splitFlags[i - 1] & ApplicationInfo.FLAG_HAS_CODE) != 0;
154        }
155        String[] classLoaderContexts = DexoptUtils.getClassLoaderContexts(
156                pkg.applicationInfo, sharedLibraries, pathsWithCode);
157
158        // Sanity check that we do not call dexopt with inconsistent data.
159        if (paths.size() != classLoaderContexts.length) {
160            String[] splitCodePaths = pkg.applicationInfo.getSplitCodePaths();
161            throw new IllegalStateException("Inconsistent information "
162                + "between PackageParser.Package and its ApplicationInfo. "
163                + "pkg.getAllCodePaths=" + paths
164                + " pkg.applicationInfo.getBaseCodePath=" + pkg.applicationInfo.getBaseCodePath()
165                + " pkg.applicationInfo.getSplitCodePaths="
166                + (splitCodePaths == null ? "null" : Arrays.toString(splitCodePaths)));
167        }
168
169        int result = DEX_OPT_SKIPPED;
170        for (int i = 0; i < paths.size(); i++) {
171            // Skip paths that have no code.
172            if (!pathsWithCode[i]) {
173                continue;
174            }
175            if (classLoaderContexts[i] == null) {
176                throw new IllegalStateException("Inconsistent information in the "
177                        + "package structure. A split is marked to contain code "
178                        + "but has no dependency listed. Index=" + i + " path=" + paths.get(i));
179            }
180
181            // Append shared libraries with split dependencies for this split.
182            String path = paths.get(i);
183            if (options.getSplitName() != null) {
184                // We are asked to compile only a specific split. Check that the current path is
185                // what we are looking for.
186                if (!options.getSplitName().equals(new File(path).getName())) {
187                    continue;
188                }
189            }
190
191            final boolean isUsedByOtherApps = options.isDexoptAsSharedLibrary()
192                    || packageUseInfo.isUsedByOtherApps(path);
193            final String compilerFilter = getRealCompilerFilter(pkg.applicationInfo,
194                options.getCompilerFilter(), isUsedByOtherApps);
195            final boolean profileUpdated = options.isCheckForProfileUpdates() &&
196                isProfileUpdated(pkg, sharedGid, compilerFilter);
197
198            // Get the dexopt flags after getRealCompilerFilter to make sure we get the correct
199            // flags.
200            final int dexoptFlags = getDexFlags(pkg, compilerFilter, options.isBootComplete());
201
202            for (String dexCodeIsa : dexCodeInstructionSets) {
203                int newResult = dexOptPath(pkg, path, dexCodeIsa, compilerFilter,
204                        profileUpdated, classLoaderContexts[i], dexoptFlags, sharedGid,
205                        packageStats, options.isDowngrade());
206                // The end result is:
207                //  - FAILED if any path failed,
208                //  - PERFORMED if at least one path needed compilation,
209                //  - SKIPPED when all paths are up to date
210                if ((result != DEX_OPT_FAILED) && (newResult != DEX_OPT_SKIPPED)) {
211                    result = newResult;
212                }
213            }
214        }
215        return result;
216    }
217
218    /**
219     * Performs dexopt on the {@code path} belonging to the package {@code pkg}.
220     *
221     * @return
222     *      DEX_OPT_FAILED if there was any exception during dexopt
223     *      DEX_OPT_PERFORMED if dexopt was performed successfully on the given path.
224     *      DEX_OPT_SKIPPED if the path does not need to be deopt-ed.
225     */
226    @GuardedBy("mInstallLock")
227    private int dexOptPath(PackageParser.Package pkg, String path, String isa,
228            String compilerFilter, boolean profileUpdated, String sharedLibrariesPath,
229            int dexoptFlags, int uid, CompilerStats.PackageStats packageStats, boolean downgrade) {
230        int dexoptNeeded = getDexoptNeeded(path, isa, compilerFilter, profileUpdated, downgrade);
231        if (Math.abs(dexoptNeeded) == DexFile.NO_DEXOPT_NEEDED) {
232            return DEX_OPT_SKIPPED;
233        }
234
235        // TODO(calin): there's no need to try to create the oat dir over and over again,
236        //              especially since it involve an extra installd call. We should create
237        //              if (if supported) on the fly during the dexopt call.
238        String oatDir = createOatDirIfSupported(pkg, isa);
239
240        Log.i(TAG, "Running dexopt (dexoptNeeded=" + dexoptNeeded + ") on: " + path
241                + " pkg=" + pkg.applicationInfo.packageName + " isa=" + isa
242                + " dexoptFlags=" + printDexoptFlags(dexoptFlags)
243                + " target-filter=" + compilerFilter + " oatDir=" + oatDir
244                + " sharedLibraries=" + sharedLibrariesPath);
245
246        try {
247            long startTime = System.currentTimeMillis();
248
249            // TODO: Consider adding 2 different APIs for primary and secondary dexopt.
250            // installd only uses downgrade flag for secondary dex files and ignores it for
251            // primary dex files.
252            mInstaller.dexopt(path, uid, pkg.packageName, isa, dexoptNeeded, oatDir, dexoptFlags,
253                    compilerFilter, pkg.volumeUuid, sharedLibrariesPath, pkg.applicationInfo.seInfo,
254                    false /* downgrade*/);
255
256            if (packageStats != null) {
257                long endTime = System.currentTimeMillis();
258                packageStats.setCompileTime(path, (int)(endTime - startTime));
259            }
260            return DEX_OPT_PERFORMED;
261        } catch (InstallerException e) {
262            Slog.w(TAG, "Failed to dexopt", e);
263            return DEX_OPT_FAILED;
264        }
265    }
266
267    /**
268     * Performs dexopt on the secondary dex {@code path} belonging to the app {@code info}.
269     *
270     * @return
271     *      DEX_OPT_FAILED if there was any exception during dexopt
272     *      DEX_OPT_PERFORMED if dexopt was performed successfully on the given path.
273     * NOTE that DEX_OPT_PERFORMED for secondary dex files includes the case when the dex file
274     * didn't need an update. That's because at the moment we don't get more than success/failure
275     * from installd.
276     *
277     * TODO(calin): Consider adding return codes to installd dexopt invocation (rather than
278     * throwing exceptions). Or maybe make a separate call to installd to get DexOptNeeded, though
279     * that seems wasteful.
280     */
281    public int dexOptSecondaryDexPath(ApplicationInfo info, String path,
282            PackageDexUsage.DexUseInfo dexUseInfo, DexoptOptions options) {
283        synchronized (mInstallLock) {
284            final long acquireTime = acquireWakeLockLI(info.uid);
285            try {
286                return dexOptSecondaryDexPathLI(info, path, dexUseInfo, options);
287            } finally {
288                releaseWakeLockLI(acquireTime);
289            }
290        }
291    }
292
293    @GuardedBy("mInstallLock")
294    private long acquireWakeLockLI(final int uid) {
295        // During boot the system doesn't need to instantiate and obtain a wake lock.
296        // PowerManager might not be ready, but that doesn't mean that we can't proceed with
297        // dexopt.
298        if (!mSystemReady) {
299            return -1;
300        }
301        mDexoptWakeLock.setWorkSource(new WorkSource(uid));
302        mDexoptWakeLock.acquire(WAKELOCK_TIMEOUT_MS);
303        return SystemClock.elapsedRealtime();
304    }
305
306    @GuardedBy("mInstallLock")
307    private void releaseWakeLockLI(final long acquireTime) {
308        if (acquireTime < 0) {
309            return;
310        }
311        try {
312            if (mDexoptWakeLock.isHeld()) {
313                mDexoptWakeLock.release();
314            }
315            final long duration = SystemClock.elapsedRealtime() - acquireTime;
316            if (duration >= WAKELOCK_TIMEOUT_MS) {
317                Slog.wtf(TAG, "WakeLock " + mDexoptWakeLock.getTag()
318                        + " time out. Operation took " + duration + " ms. Thread: "
319                        + Thread.currentThread().getName());
320            }
321        } catch (Exception e) {
322            Slog.wtf(TAG, "Error while releasing " + mDexoptWakeLock.getTag() + " lock", e);
323        }
324    }
325
326    @GuardedBy("mInstallLock")
327    private int dexOptSecondaryDexPathLI(ApplicationInfo info, String path,
328            PackageDexUsage.DexUseInfo dexUseInfo, DexoptOptions options) {
329        if (options.isDexoptOnlySharedDex() && !dexUseInfo.isUsedByOtherApps()) {
330            // We are asked to optimize only the dex files used by other apps and this is not
331            // on of them: skip it.
332            return DEX_OPT_SKIPPED;
333        }
334
335        String compilerFilter = getRealCompilerFilter(info, options.getCompilerFilter(),
336                dexUseInfo.isUsedByOtherApps());
337        // Get the dexopt flags after getRealCompilerFilter to make sure we get the correct flags.
338        // Secondary dex files are currently not compiled at boot.
339        int dexoptFlags = getDexFlags(info, compilerFilter, /* bootComplete */ true)
340                | DEXOPT_SECONDARY_DEX;
341        // Check the app storage and add the appropriate flags.
342        if (info.deviceProtectedDataDir != null &&
343                FileUtils.contains(info.deviceProtectedDataDir, path)) {
344            dexoptFlags |= DEXOPT_STORAGE_DE;
345        } else if (info.credentialProtectedDataDir != null &&
346                FileUtils.contains(info.credentialProtectedDataDir, path)) {
347            dexoptFlags |= DEXOPT_STORAGE_CE;
348        } else {
349            Slog.e(TAG, "Could not infer CE/DE storage for package " + info.packageName);
350            return DEX_OPT_FAILED;
351        }
352        Log.d(TAG, "Running dexopt on: " + path
353                + " pkg=" + info.packageName + " isa=" + dexUseInfo.getLoaderIsas()
354                + " dexoptFlags=" + printDexoptFlags(dexoptFlags)
355                + " target-filter=" + compilerFilter);
356
357        String classLoaderContext;
358        if (dexUseInfo.isUnknownClassLoaderContext() ||
359                dexUseInfo.isUnsupportedClassLoaderContext() ||
360                dexUseInfo.isVariableClassLoaderContext()) {
361            // If we have an unknown (not yet set), unsupported (custom class loaders), or a
362            // variable class loader chain, compile without a context and mark the oat file with
363            // SKIP_SHARED_LIBRARY_CHECK. Note that his might lead to a incorrect compilation.
364            // TODO(calin): We should just extract in this case.
365            classLoaderContext = SKIP_SHARED_LIBRARY_CHECK;
366        } else {
367            classLoaderContext = dexUseInfo.getClassLoaderContext();
368        }
369        try {
370            for (String isa : dexUseInfo.getLoaderIsas()) {
371                // Reuse the same dexopt path as for the primary apks. We don't need all the
372                // arguments as some (dexopNeeded and oatDir) will be computed by installd because
373                // system server cannot read untrusted app content.
374                // TODO(calin): maybe add a separate call.
375                mInstaller.dexopt(path, info.uid, info.packageName, isa, /*dexoptNeeded*/ 0,
376                        /*oatDir*/ null, dexoptFlags,
377                        compilerFilter, info.volumeUuid, classLoaderContext, info.seInfoUser,
378                        options.isDowngrade());
379            }
380
381            return DEX_OPT_PERFORMED;
382        } catch (InstallerException e) {
383            Slog.w(TAG, "Failed to dexopt", e);
384            return DEX_OPT_FAILED;
385        }
386    }
387
388    /**
389     * Adjust the given dexopt-needed value. Can be overridden to influence the decision to
390     * optimize or not (and in what way).
391     */
392    protected int adjustDexoptNeeded(int dexoptNeeded) {
393        return dexoptNeeded;
394    }
395
396    /**
397     * Adjust the given dexopt flags that will be passed to the installer.
398     */
399    protected int adjustDexoptFlags(int dexoptFlags) {
400        return dexoptFlags;
401    }
402
403    /**
404     * Dumps the dexopt state of the given package {@code pkg} to the given {@code PrintWriter}.
405     */
406    void dumpDexoptState(IndentingPrintWriter pw, PackageParser.Package pkg,
407            PackageDexUsage.PackageUseInfo useInfo) {
408        final String[] instructionSets = getAppDexInstructionSets(pkg.applicationInfo);
409        final String[] dexCodeInstructionSets = getDexCodeInstructionSets(instructionSets);
410
411        final List<String> paths = pkg.getAllCodePathsExcludingResourceOnly();
412
413        for (String path : paths) {
414            pw.println("path: " + path);
415            pw.increaseIndent();
416
417            for (String isa : dexCodeInstructionSets) {
418                String status = null;
419                try {
420                    status = DexFile.getDexFileStatus(path, isa);
421                } catch (IOException ioe) {
422                     status = "[Exception]: " + ioe.getMessage();
423                }
424                pw.println(isa + ": " + status);
425            }
426
427            if (useInfo.isUsedByOtherApps(path)) {
428                pw.println("used be other apps: " + useInfo.getLoadingPackages(path));
429            }
430
431            Map<String, PackageDexUsage.DexUseInfo> dexUseInfoMap = useInfo.getDexUseInfoMap();
432
433            if (!dexUseInfoMap.isEmpty()) {
434                pw.println("known secondary dex files:");
435                pw.increaseIndent();
436                for (Map.Entry<String, PackageDexUsage.DexUseInfo> e : dexUseInfoMap.entrySet()) {
437                    String dex = e.getKey();
438                    PackageDexUsage.DexUseInfo dexUseInfo = e.getValue();
439                    pw.println(dex);
440                    pw.increaseIndent();
441                    for (String isa : dexUseInfo.getLoaderIsas()) {
442                        String status = null;
443                        try {
444                            status = DexFile.getDexFileStatus(path, isa);
445                        } catch (IOException ioe) {
446                             status = "[Exception]: " + ioe.getMessage();
447                        }
448                        pw.println(isa + ": " + status);
449                    }
450
451                    pw.println("class loader context: " + dexUseInfo.getClassLoaderContext());
452                    if (dexUseInfo.isUsedByOtherApps()) {
453                        pw.println("used be other apps: " + dexUseInfo.getLoadingPackages());
454                    }
455                    pw.decreaseIndent();
456                }
457                pw.decreaseIndent();
458            }
459            pw.decreaseIndent();
460        }
461    }
462
463    /**
464     * Returns the compiler filter that should be used to optimize the package code.
465     * The target filter will be updated if the package code is used by other apps
466     * or if it has the safe mode flag set.
467     */
468    private String getRealCompilerFilter(ApplicationInfo info, String targetCompilerFilter,
469            boolean isUsedByOtherApps) {
470        int flags = info.flags;
471        boolean vmSafeMode = (flags & ApplicationInfo.FLAG_VM_SAFE_MODE) != 0;
472        if (vmSafeMode) {
473            return getSafeModeCompilerFilter(targetCompilerFilter);
474        }
475
476        if (isProfileGuidedCompilerFilter(targetCompilerFilter) && isUsedByOtherApps) {
477            // If the dex files is used by other apps, we cannot use profile-guided compilation.
478            return getNonProfileGuidedCompilerFilter(targetCompilerFilter);
479        }
480
481        return targetCompilerFilter;
482    }
483
484    /**
485     * Computes the dex flags that needs to be pass to installd for the given package and compiler
486     * filter.
487     */
488    private int getDexFlags(PackageParser.Package pkg, String compilerFilter,
489            boolean bootComplete) {
490        return getDexFlags(pkg.applicationInfo, compilerFilter, bootComplete);
491    }
492
493    private int getDexFlags(ApplicationInfo info, String compilerFilter, boolean bootComplete) {
494        int flags = info.flags;
495        boolean debuggable = (flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0;
496        // Profile guide compiled oat files should not be public.
497        boolean isProfileGuidedFilter = isProfileGuidedCompilerFilter(compilerFilter);
498        boolean isPublic = !info.isForwardLocked() && !isProfileGuidedFilter;
499        int profileFlag = isProfileGuidedFilter ? DEXOPT_PROFILE_GUIDED : 0;
500        int dexFlags =
501                (isPublic ? DEXOPT_PUBLIC : 0)
502                | (debuggable ? DEXOPT_DEBUGGABLE : 0)
503                | profileFlag
504                | (bootComplete ? DEXOPT_BOOTCOMPLETE : 0);
505        return adjustDexoptFlags(dexFlags);
506    }
507
508    /**
509     * Assesses if there's a need to perform dexopt on {@code path} for the given
510     * configuration (isa, compiler filter, profile).
511     */
512    private int getDexoptNeeded(String path, String isa, String compilerFilter,
513            boolean newProfile, boolean downgrade) {
514        int dexoptNeeded;
515        try {
516            dexoptNeeded = DexFile.getDexOptNeeded(path, isa, compilerFilter, newProfile,
517                    downgrade);
518        } catch (IOException ioe) {
519            Slog.w(TAG, "IOException reading apk: " + path, ioe);
520            return DEX_OPT_FAILED;
521        }
522        return adjustDexoptNeeded(dexoptNeeded);
523    }
524
525    /**
526     * Checks if there is an update on the profile information of the {@code pkg}.
527     * If the compiler filter is not profile guided the method returns false.
528     *
529     * Note that this is a "destructive" operation with side effects. Under the hood the
530     * current profile and the reference profile will be merged and subsequent calls
531     * may return a different result.
532     */
533    private boolean isProfileUpdated(PackageParser.Package pkg, int uid, String compilerFilter) {
534        // Check if we are allowed to merge and if the compiler filter is profile guided.
535        if (!isProfileGuidedCompilerFilter(compilerFilter)) {
536            return false;
537        }
538        // Merge profiles. It returns whether or not there was an updated in the profile info.
539        try {
540            return mInstaller.mergeProfiles(uid, pkg.packageName);
541        } catch (InstallerException e) {
542            Slog.w(TAG, "Failed to merge profiles", e);
543        }
544        return false;
545    }
546
547    /**
548     * Creates oat dir for the specified package if needed and supported.
549     * In certain cases oat directory
550     * <strong>cannot</strong> be created:
551     * <ul>
552     *      <li>{@code pkg} is a system app, which is not updated.</li>
553     *      <li>Package location is not a directory, i.e. monolithic install.</li>
554     * </ul>
555     *
556     * @return Absolute path to the oat directory or null, if oat directory
557     * cannot be created.
558     */
559    @Nullable
560    private String createOatDirIfSupported(PackageParser.Package pkg, String dexInstructionSet) {
561        if (!pkg.canHaveOatDir()) {
562            return null;
563        }
564        File codePath = new File(pkg.codePath);
565        if (codePath.isDirectory()) {
566            // TODO(calin): why do we create this only if the codePath is a directory? (i.e for
567            //              cluster packages). It seems that the logic for the folder creation is
568            //              split between installd and here.
569            File oatDir = getOatDir(codePath);
570            try {
571                mInstaller.createOatDir(oatDir.getAbsolutePath(), dexInstructionSet);
572            } catch (InstallerException e) {
573                Slog.w(TAG, "Failed to create oat dir", e);
574                return null;
575            }
576            return oatDir.getAbsolutePath();
577        }
578        return null;
579    }
580
581    static File getOatDir(File codePath) {
582        return new File(codePath, OAT_DIR_NAME);
583    }
584
585    void systemReady() {
586        mSystemReady = true;
587    }
588
589    private String printDexoptFlags(int flags) {
590        ArrayList<String> flagsList = new ArrayList<>();
591
592        if ((flags & DEXOPT_BOOTCOMPLETE) == DEXOPT_BOOTCOMPLETE) {
593            flagsList.add("boot_complete");
594        }
595        if ((flags & DEXOPT_DEBUGGABLE) == DEXOPT_DEBUGGABLE) {
596            flagsList.add("debuggable");
597        }
598        if ((flags & DEXOPT_PROFILE_GUIDED) == DEXOPT_PROFILE_GUIDED) {
599            flagsList.add("profile_guided");
600        }
601        if ((flags & DEXOPT_PUBLIC) == DEXOPT_PUBLIC) {
602            flagsList.add("public");
603        }
604        if ((flags & DEXOPT_SECONDARY_DEX) == DEXOPT_SECONDARY_DEX) {
605            flagsList.add("secondary");
606        }
607        if ((flags & DEXOPT_FORCE) == DEXOPT_FORCE) {
608            flagsList.add("force");
609        }
610        if ((flags & DEXOPT_STORAGE_CE) == DEXOPT_STORAGE_CE) {
611            flagsList.add("storage_ce");
612        }
613        if ((flags & DEXOPT_STORAGE_DE) == DEXOPT_STORAGE_DE) {
614            flagsList.add("storage_de");
615        }
616
617        return String.join(",", flagsList);
618    }
619
620    /**
621     * A specialized PackageDexOptimizer that overrides already-installed checks, forcing a
622     * dexopt path.
623     */
624    public static class ForcedUpdatePackageDexOptimizer extends PackageDexOptimizer {
625
626        public ForcedUpdatePackageDexOptimizer(Installer installer, Object installLock,
627                Context context, String wakeLockTag) {
628            super(installer, installLock, context, wakeLockTag);
629        }
630
631        public ForcedUpdatePackageDexOptimizer(PackageDexOptimizer from) {
632            super(from);
633        }
634
635        @Override
636        protected int adjustDexoptNeeded(int dexoptNeeded) {
637            if (dexoptNeeded == DexFile.NO_DEXOPT_NEEDED) {
638                // Ensure compilation by pretending a compiler filter change on the
639                // apk/odex location (the reason for the '-'. A positive value means
640                // the 'oat' location).
641                return -DexFile.DEX2OAT_FOR_FILTER;
642            }
643            return dexoptNeeded;
644        }
645
646        @Override
647        protected int adjustDexoptFlags(int flags) {
648            // Add DEXOPT_FORCE flag to signal installd that it should force compilation
649            // and discard dexoptanalyzer result.
650            return flags | DEXOPT_FORCE;
651        }
652    }
653}
654