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