| /* |
| * Copyright (C) 2019 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.gsi; |
| |
| import android.gsi.GsiInstallParams; |
| import android.gsi.GsiProgress; |
| import android.os.ParcelFileDescriptor; |
| |
| /** {@hide} */ |
| interface IGsiService { |
| /* Status codes for GsiProgress.status */ |
| const int STATUS_NO_OPERATION = 0; |
| const int STATUS_WORKING = 1; |
| const int STATUS_COMPLETE = 2; |
| |
| /* Install succeeded. */ |
| const int INSTALL_OK = 0; |
| /* Install failed with a generic system error. */ |
| const int INSTALL_ERROR_GENERIC = 1; |
| /* Install failed because there was no free space. */ |
| const int INSTALL_ERROR_NO_SPACE = 2; |
| /** |
| * Install failed because the file system was too fragmented or did not |
| * have enough additional free space. |
| */ |
| const int INSTALL_ERROR_FILE_SYSTEM_CLUTTERED = 3; |
| |
| /** |
| * Starts a GSI installation. Use beginGsiInstall() to target external |
| * media. |
| * |
| * If wipeUserData is true, a clean userdata image is always created to the |
| * desired size. |
| * |
| * If wipeUserData is false, a userdata image is only created if one does |
| * not already exist. If the size is zero, a default size of 8GiB is used. |
| * If there is an existing image smaller than the desired size, it is |
| * resized automatically. |
| * |
| * @param gsiSize The size of the on-disk GSI image. |
| * @param userdataSize The desired size of the userdata partition. |
| * @param wipeUserdata True to wipe destination userdata. |
| * @return 0 on success, an error code on failure. |
| */ |
| int startGsiInstall(long gsiSize, long userdataSize, boolean wipeUserdata); |
| |
| /** |
| * Write bytes from a stream to the on-disk GSI. |
| * |
| * @param stream Stream descriptor. |
| * @param bytes Number of bytes that can be read from stream. |
| * @return true on success, false otherwise. |
| */ |
| boolean commitGsiChunkFromStream(in ParcelFileDescriptor stream, long bytes); |
| |
| /** |
| * Query the progress of the current asynchronous install operation. This |
| * can be called while another operation is in progress. |
| */ |
| GsiProgress getInstallProgress(); |
| |
| /** |
| * Write bytes from memory to the on-disk GSI. |
| * |
| * @param bytes Byte array. |
| * @return true on success, false otherwise. |
| */ |
| boolean commitGsiChunkFromMemory(in byte[] bytes); |
| |
| /** |
| * Complete a GSI installation and mark it as bootable. The caller is |
| * responsible for rebooting the device as soon as possible. |
| * |
| * @param oneShot If true, the GSI will boot once and then disable itself. |
| * It can still be re-enabled again later with setGsiBootable. |
| * @return INSTALL_* error code. |
| */ |
| int setGsiBootable(boolean oneShot); |
| |
| /** |
| * @return True if Gsi is enabled |
| */ |
| boolean isGsiEnabled(); |
| |
| /** |
| * Cancel an in-progress GSI install. |
| */ |
| boolean cancelGsiInstall(); |
| |
| /** |
| * Return if a GSI installation is currently in-progress. |
| */ |
| boolean isGsiInstallInProgress(); |
| |
| /** |
| * Remove a GSI install. This will completely remove and reclaim space used |
| * by the GSI and its userdata. If currently running a GSI, space will be |
| * reclaimed on the reboot. |
| * |
| * @return true on success, false otherwise. |
| */ |
| boolean removeGsiInstall(); |
| |
| /** |
| * Disables a GSI install. The image and userdata will be retained, but can |
| * be re-enabled at any time with setGsiBootable. |
| */ |
| boolean disableGsiInstall(); |
| |
| /** |
| * Return the size of the userdata partition for an installed GSI. If there |
| * is no image, 0 is returned. On error, -1 is returned. |
| */ |
| long getUserdataImageSize(); |
| |
| /** |
| * Returns true if the gsi is currently running, false otherwise. |
| */ |
| boolean isGsiRunning(); |
| |
| /** |
| * Returns true if a gsi is installed. |
| */ |
| boolean isGsiInstalled(); |
| |
| /* No GSI is installed. */ |
| const int BOOT_STATUS_NOT_INSTALLED = 0; |
| /* GSI is installed, but booting is disabled. */ |
| const int BOOT_STATUS_DISABLED = 1; |
| /* GSI is installed, but will only boot once. */ |
| const int BOOT_STATUS_SINGLE_BOOT = 2; |
| /* GSI is installed and bootable. */ |
| const int BOOT_STATUS_ENABLED = 3; |
| /* GSI will be wiped next boot. */ |
| const int BOOT_STATUS_WILL_WIPE = 4; |
| |
| /** |
| * Returns the boot status of a GSI. See the BOOT_STATUS constants in IGsiService. |
| * |
| * GSI_STATE_NOT_INSTALLED will be returned if no GSI installation has been |
| * fully completed. Any other value indicates a GSI is installed. If a GSI |
| * currently running, DISABLED or SINGLE_BOOT can still be returned. |
| */ |
| int getGsiBootStatus(); |
| |
| /** |
| * If a GSI is installed, returns the directory where the installed images |
| * are located. Otherwise, returns an empty string. |
| */ |
| @utf8InCpp String getInstalledGsiImageDir(); |
| |
| /** |
| * Begin a GSI installation. |
| * |
| * This is a replacement for startGsiInstall, in order to supply additional |
| * options. |
| * |
| * @return 0 on success, an error code on failure. |
| */ |
| int beginGsiInstall(in GsiInstallParams params); |
| |
| /** |
| * Wipe the userdata of an existing GSI install. This will not work if the |
| * GSI is currently running. The userdata image will not be removed, but the |
| * first block will be zeroed ensuring that the next GSI boot formats /data. |
| * |
| * @return 0 on success, an error code on failure. |
| */ |
| int wipeGsiUserdata(); |
| } |