/* * Copyright (C) 2022 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.android.server.art.model; import android.annotation.NonNull; import android.annotation.SystemApi; import com.android.internal.annotations.Immutable; import com.google.auto.value.AutoValue; import java.util.List; /** * Describes the dexopt status of a package. * * @hide */ @SystemApi(client = SystemApi.Client.SYSTEM_SERVER) @Immutable @AutoValue public abstract class DexoptStatus { /** @hide */ protected DexoptStatus() {} /** @hide */ public static @NonNull DexoptStatus create( @NonNull List dexContainerFileDexoptStatuses) { return new AutoValue_DexoptStatus(dexContainerFileDexoptStatuses); } /** * The statuses of the dex container file dexopts. Note that there can be multiple entries * for the same dex container file, but for different ABIs. */ @NonNull public abstract List getDexContainerFileDexoptStatuses(); /** * Describes the dexopt status of a dex container file. * * @hide */ @SystemApi(client = SystemApi.Client.SYSTEM_SERVER) @Immutable @AutoValue public abstract static class DexContainerFileDexoptStatus { /** @hide */ protected DexContainerFileDexoptStatus() {} /** @hide */ public static @NonNull DexContainerFileDexoptStatus create(@NonNull String dexContainerFile, boolean isPrimaryDex, boolean isPrimaryAbi, @NonNull String abi, @NonNull String compilerFilter, @NonNull String compilationReason, @NonNull String locationDebugString) { return new AutoValue_DexoptStatus_DexContainerFileDexoptStatus(dexContainerFile, isPrimaryDex, isPrimaryAbi, abi, compilerFilter, compilationReason, locationDebugString); } /** The absolute path to the dex container file. */ public abstract @NonNull String getDexContainerFile(); /** * If true, the dex container file is a primary dex (the base APK or a split APK). * Otherwise, it's a secondary dex (a APK or a JAR that the package sideloaded into its data * directory). */ public abstract boolean isPrimaryDex(); /** * If true, the dexopt is for the primary ABI of the package (the ABI that the * application is launched with). Otherwise, the dexopt is for an ABI that other * applications might be launched with when using this application's code. */ public abstract boolean isPrimaryAbi(); /** * Returns the ABI that the dexopt is for. Possible values are documented at * https://developer.android.com/ndk/guides/abis#sa. */ public abstract @NonNull String getAbi(); /** * A human-readable string that describes the compiler filter. * * Possible values are: * */ public abstract @NonNull String getCompilerFilter(); /** * A string that describes the compilation reason. * * Possible values are: * * * Note that this value can differ from the requested compilation reason passed to {@link * DexoptParams.Builder}. Specifically, if the requested reason is for app install (e.g., * "install"), and a DM file is passed to {@code dex2oat}, a "-dm" suffix will be appended * to the actual reason (e.g., "install-dm"). Other compilation reasons remain unchanged * even if a DM file is passed to {@code dex2oat}. * * Also note that the "-dm" suffix does not imply anything in the DM file being used * by {@code dex2oat}. The compilation reason can still be "install-dm" even if {@code * dex2oat} left all contents of the DM file unused or an empty DM file is passed to * {@code dex2oat}. */ public abstract @NonNull String getCompilationReason(); /** * A human-readable string that describes the location of the dexopt artifacts. * * Note that this string is for debugging purposes only. There is no stability guarantees * for the format of the string. DO NOT use it programmatically. */ public abstract @NonNull String getLocationDebugString(); } }