artd/binder/com/android/server/art/ProfilePath.aidl

/*
 * 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;

/**
 * Represents the path to a profile file.
 *
 * @hide
 */
union ProfilePath {
    PrimaryRefProfilePath primaryRefProfilePath;
    PrebuiltProfilePath prebuiltProfilePath;
    PrimaryCurProfilePath primaryCurProfilePath;
    SecondaryRefProfilePath secondaryRefProfilePath;
    SecondaryCurProfilePath secondaryCurProfilePath;
    TmpProfilePath tmpProfilePath;

    /** Represents a profile in the dex metadata file. */
    com.android.server.art.DexMetadataPath dexMetadataPath;

    /** Represents a reference profile. */
    parcelable PrimaryRefProfilePath {
        /** The name of the package. */
        @utf8InCpp String packageName;
        /** The stem of the profile file */
        @utf8InCpp String profileName;
        /**
         * Whether the profile is for Pre-reboot Dexopt. For now, this is `false` for inputs, unless
         * the data structure refers to a temporary profile, as an argument of `mergeProfiles` or
         * `dexopt`, in the Pre-reboot Dexopt mode.
         */
        boolean isPreReboot;
    }

    /**
     * Represents a profile next to a dex file. This is usually a prebuilt profile in the system
     * image, but it can also be a profile that package manager can potentially put along with the
     * APK during installation. The latter one is not officially supported by package manager, but
     * OEMs can customize package manager to support that.
     */
    parcelable PrebuiltProfilePath {
        /** The path to the dex file that the profile is next to. */
        @utf8InCpp String dexPath;
    }

    /** Represents a current profile. */
    parcelable PrimaryCurProfilePath {
        /** The user ID of the user that owns the profile. */
        int userId;
        /** The name of the package. */
        @utf8InCpp String packageName;
        /** The stem of the profile file */
        @utf8InCpp String profileName;
    }

    /** Represents a reference profile of a secondary dex file. */
    parcelable SecondaryRefProfilePath {
        /**
         * The path to the dex file that the profile is next to.
         *
         * Currently, possible paths are in the format of
         * `{/data,/mnt/expand/<volume-uuid>}/{user,user_de}/<user-id>/<package-name>/...`.
         */
        @utf8InCpp String dexPath;
        /**
         * Whether the profile is for Pre-reboot Dexopt. For now, this is `false` for inputs, unless
         * the data structure refers to a temporary profile, as an argument of `mergeProfiles` or
         * `dexopt`, in the Pre-reboot Dexopt mode.
         */
        boolean isPreReboot;
    }

    /** Represents a current profile of a secondary dex file. */
    parcelable SecondaryCurProfilePath {
        /** The path to the dex file that the profile is next to. */
        @utf8InCpp String dexPath;
    }

    /** All types of profile paths that artd can write to. */
    union WritableProfilePath {
        PrimaryRefProfilePath forPrimary;
        SecondaryRefProfilePath forSecondary;
    }

    /** Represents a temporary profile. */
    parcelable TmpProfilePath {
        /** The path that this temporary file will eventually be committed to. */
        WritableProfilePath finalPath;
        /** A unique identifier to distinguish this temporary file from others. Filled by artd. */
        @utf8InCpp String id;
        /** The path to the temporary file. Filled by artd. */
        @utf8InCpp String tmpPath;
    }
}