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