android/apex/IApexService.aidl

/*
 * Copyright (C) 2018 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 android.apex;

import android.apex.ApexInfo;
import android.apex.ApexInfoList;
import android.apex.ApexSessionInfo;
import android.apex.ApexSessionParams;
import android.apex.CompressedApexInfoList;

interface IApexService {
   void submitStagedSession(in ApexSessionParams params, out ApexInfoList packages);
   void markStagedSessionReady(int session_id);
   void markStagedSessionSuccessful(int session_id);

   ApexSessionInfo[] getSessions();
   ApexSessionInfo getStagedSessionInfo(int session_id);
   ApexInfo[] getActivePackages();
   ApexInfo[] getAllPackages();

   void abortStagedSession(int session_id);
   void revertActiveSessions();

   /**
    * Copies the CE apex data directory for the given user to the backup
    * location.
    */
   void snapshotCeData(int user_id, int rollback_id, in @utf8InCpp String apex_name);

   /**
    * Restores the snapshot of the CE apex data directory for the given user and
    * apex. Note the snapshot will be deleted after restoration succeeded.
    */
   void restoreCeData(int user_id, int rollback_id, in @utf8InCpp String apex_name);

   /**
    * Deletes device-encrypted snapshots for the given rollback id.
    */
   void destroyDeSnapshots(int rollback_id);

   /**
    * Deletes credential-encrypted snapshots for the given user, for the given rollback id.
    */
   void destroyCeSnapshots(int user_id, int rollback_id);

   /**
    * Deletes all credential-encrypted snapshots for the given user, except for
    * those listed in retain_rollback_ids.
    */
   void destroyCeSnapshotsNotSpecified(int user_id, in int[] retain_rollback_ids);

   void unstagePackages(in @utf8InCpp List<String> active_package_paths);

   /**
    * Returns the active package corresponding to |package_name| and null
    * if none exists.
    */
   ApexInfo getActivePackage(in @utf8InCpp String package_name);

   /**
    * Not meant for use outside of testing. The call will not be
    * functional on user builds.
    */
   void activatePackage(in @utf8InCpp String package_path);
   /**
    * Not meant for use outside of testing. The call will not be
    * functional on user builds.
    */
   void deactivatePackage(in @utf8InCpp String package_path);
   /**
    * Not meant for use outside of testing. The call will not be
    * functional on user builds.
    */
   void preinstallPackages(in @utf8InCpp List<String> package_tmp_paths);
   /**
    * Not meant for use outside of testing. The call will not be
    * functional on user builds.
    */
   void postinstallPackages(in @utf8InCpp List<String> package_tmp_paths);
   /**
    * Not meant for use outside of testing. The call will not be
    * functional on user builds.
    */
   void stagePackages(in @utf8InCpp List<String> package_tmp_paths);
   /**
    * Not meant for use outside of testing. The call will not be
    * functional on user builds.
    */
   void resumeRevertIfNeeded();
   /**
    * Forces apexd to remount all active packages.
    *
    * This call is mostly useful for speeding up development of APEXes.
    * Instead of going through a full APEX installation that requires a reboot,
    * developers can incorporate this method in much faster `adb sync` based
    * workflow:
    *
    * 1. adb shell stop
    * 2. adb sync
    * 3. adb shell cmd -w apexservice remountPackages
    * 4. adb shell start
    *
    * Note, that for an APEX package will be successfully remounted only if
    * there are no alive processes holding a reference to it.
    *
    * Not meant for use outside of testing. This call will not be functional
    * on user builds. Only root is allowed to call this method.
    */
   void remountPackages();
   /**
    * Forces apexd to recollect pre-installed data from the given |paths|.
    *
    * Not meant for use outside of testing. This call will not be functional
    * on user builds. Only root is allowed to call this method.
    */
   void recollectPreinstalledData(in @utf8InCpp List<String> paths);
   /**
    * Forces apexd to recollect data apex from the given |path|.
    *
    * Not meant for use outside of testing. This call will not be functional
    * on user builds. Only root is allowed to call this method.
    */
   void recollectDataApex(in @utf8InCpp String path, in@utf8InCpp String decompression_dir);

   /**
    * Informs apexd that the boot has completed.
    */
   void markBootCompleted();

   /**
   * Assuming the provided compressed APEX will be installed on next boot,
   * calculate how much space will be required for decompression
   */
   long calculateSizeForCompressedApex(in CompressedApexInfoList compressed_apex_info_list);

   /**
   * Reserve space on /data partition for compressed APEX decompression. Returns error if
   * reservation fails. If empty list is passed, then reserved space is deallocated.
   */
   void reserveSpaceForCompressedApex(in CompressedApexInfoList compressed_apex_info_list);

   /**
    * Performs a non-staged install of the given APEX.
    * Note: don't confuse this to preInstall and postInstall binder calls which are only used to
    * test corresponding features of APEX packages.
    */
   ApexInfo installAndActivatePackage(in @utf8InCpp String packagePath);
}