Merge changes from topics "vab_allocate", "vab_wait"

am: d0c62b9dab

Change-Id: I001d22b54f22f0fd8a4943e72b3294b59bdf92ee
This commit is contained in:
Yifan Hong
2020-01-08 10:43:17 -08:00
committed by android-build-merger
3 changed files with 181 additions and 1 deletions

View File

@@ -6121,11 +6121,13 @@ package android.os {
public class UpdateEngine {
ctor public UpdateEngine();
method @NonNull public android.os.UpdateEngine.AllocateSpaceResult allocateSpace(@NonNull String, @NonNull String[]);
method public void applyPayload(String, long, long, String[]);
method public void applyPayload(@NonNull android.os.ParcelFileDescriptor, long, long, @NonNull String[]);
method public boolean bind(android.os.UpdateEngineCallback, android.os.Handler);
method public boolean bind(android.os.UpdateEngineCallback);
method public void cancel();
method public int cleanupAppliedPayload();
method public void resetStatus();
method public void resume();
method public void suspend();
@@ -6133,14 +6135,21 @@ package android.os {
method public boolean verifyPayloadMetadata(String);
}
public static final class UpdateEngine.AllocateSpaceResult {
method public int errorCode();
method public long freeSpaceRequired();
}
public static final class UpdateEngine.ErrorCodeConstants {
ctor public UpdateEngine.ErrorCodeConstants();
field public static final int DEVICE_CORRUPTED = 61; // 0x3d
field public static final int DOWNLOAD_PAYLOAD_VERIFICATION_ERROR = 12; // 0xc
field public static final int DOWNLOAD_TRANSFER_ERROR = 9; // 0x9
field public static final int ERROR = 1; // 0x1
field public static final int FILESYSTEM_COPIER_ERROR = 4; // 0x4
field public static final int INSTALL_DEVICE_OPEN_ERROR = 7; // 0x7
field public static final int KERNEL_DEVICE_OPEN_ERROR = 8; // 0x8
field public static final int NOT_ENOUGH_SPACE = 60; // 0x3c
field public static final int PAYLOAD_HASH_MISMATCH_ERROR = 10; // 0xa
field public static final int PAYLOAD_MISMATCHED_TYPE_ERROR = 6; // 0x6
field public static final int PAYLOAD_SIZE_MISMATCH_ERROR = 11; // 0xb

View File

@@ -16,6 +16,7 @@
package android.os;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.os.IUpdateEngine;
@@ -140,8 +141,43 @@ public class UpdateEngine {
* {@code SWITCH_SLOT_ON_REBOOT=0}. See {@link #applyPayload}.
*/
public static final int UPDATED_BUT_NOT_ACTIVE = 52;
/**
* Error code: there is not enough space on the device to apply the update. User should
* be prompted to free up space and re-try the update.
*
* <p>See {@link UpdateEngine#allocateSpace}.
*/
public static final int NOT_ENOUGH_SPACE = 60;
/**
* Error code: the device is corrupted and no further updates may be applied.
*
* <p>See {@link UpdateEngine#cleanupAppliedPayload}.
*/
public static final int DEVICE_CORRUPTED = 61;
}
/** @hide */
@IntDef(value = {
ErrorCodeConstants.SUCCESS,
ErrorCodeConstants.ERROR,
ErrorCodeConstants.FILESYSTEM_COPIER_ERROR,
ErrorCodeConstants.POST_INSTALL_RUNNER_ERROR,
ErrorCodeConstants.PAYLOAD_MISMATCHED_TYPE_ERROR,
ErrorCodeConstants.INSTALL_DEVICE_OPEN_ERROR,
ErrorCodeConstants.KERNEL_DEVICE_OPEN_ERROR,
ErrorCodeConstants.DOWNLOAD_TRANSFER_ERROR,
ErrorCodeConstants.PAYLOAD_HASH_MISMATCH_ERROR,
ErrorCodeConstants.PAYLOAD_SIZE_MISMATCH_ERROR,
ErrorCodeConstants.DOWNLOAD_PAYLOAD_VERIFICATION_ERROR,
ErrorCodeConstants.PAYLOAD_TIMESTAMP_ERROR,
ErrorCodeConstants.UPDATED_BUT_NOT_ACTIVE,
ErrorCodeConstants.NOT_ENOUGH_SPACE,
ErrorCodeConstants.DEVICE_CORRUPTED,
})
public @interface ErrorCode {}
/**
* Status codes for update engine. Values must agree with the ones in
* {@code system/update_engine/client_library/include/update_engine/update_status.h}.
@@ -419,4 +455,138 @@ public class UpdateEngine {
throw e.rethrowFromSystemServer();
}
}
/**
* Return value of {@link #allocateSpace.}
*/
public static final class AllocateSpaceResult {
private @ErrorCode int mErrorCode = ErrorCodeConstants.SUCCESS;
private long mFreeSpaceRequired = 0;
private AllocateSpaceResult() {}
/**
* Error code.
*
* @return The following error codes:
* <ul>
* <li>{@link ErrorCodeConstants#SUCCESS} if space has been allocated
* successfully.</li>
* <li>{@link ErrorCodeConstants#NOT_ENOUGH_SPACE} if insufficient
* space.</li>
* <li>Other {@link ErrorCodeConstants} for other errors.</li>
* </ul>
*/
@ErrorCode
public int errorCode() {
return mErrorCode;
}
/**
* Estimated total space that needs to be available on the userdata partition to apply the
* payload (in bytes).
*
* <p>
* Note that in practice, more space needs to be made available before applying the payload
* to keep the device working.
*
* @return The following values:
* <ul>
* <li>zero if {@link #errorCode} returns {@link ErrorCodeConstants#SUCCESS}</li>
* <li>non-zero if {@link #errorCode} returns {@link ErrorCodeConstants#NOT_ENOUGH_SPACE}.
* Value is the estimated total space required on userdata partition.</li>
* </ul>
* @throws IllegalStateException if {@link #errorCode} is not one of the above.
*
*/
public long freeSpaceRequired() {
if (mErrorCode == ErrorCodeConstants.SUCCESS) {
return 0;
}
if (mErrorCode == ErrorCodeConstants.NOT_ENOUGH_SPACE) {
return mFreeSpaceRequired;
}
throw new IllegalStateException(String.format(
"freeSpaceRequired() is not available when error code is %d", mErrorCode));
}
}
/**
* Initialize partitions for a payload associated with the given payload
* metadata {@code payloadMetadataFilename} by preallocating required space.
*
* <p>This function should be called after payload has been verified after
* {@link #verifyPayloadMetadata}. This function does not verify whether
* the given payload is applicable or not.
*
* <p>Implementation of {@code allocateSpace} uses
* {@code headerKeyValuePairs} to determine whether space has been allocated
* for a different or same payload previously. If space has been allocated
* for a different payload before, space will be reallocated for the given
* payload. If space has been allocated for the same payload, no actions to
* storage devices are taken.
*
* <p>This function is synchronous and may take a non-trivial amount of
* time. Callers should call this function in a background thread.
*
* @param payloadMetadataFilename See {@link #verifyPayloadMetadata}.
* @param headerKeyValuePairs See {@link #applyPayload}.
* @return See {@link AllocateSpaceResult}.
*/
@NonNull
public AllocateSpaceResult allocateSpace(
@NonNull String payloadMetadataFilename,
@NonNull String[] headerKeyValuePairs) {
AllocateSpaceResult result = new AllocateSpaceResult();
try {
result.mFreeSpaceRequired = mUpdateEngine.allocateSpaceForPayload(
payloadMetadataFilename,
headerKeyValuePairs);
result.mErrorCode = result.mFreeSpaceRequired == 0
? ErrorCodeConstants.SUCCESS
: ErrorCodeConstants.NOT_ENOUGH_SPACE;
return result;
} catch (ServiceSpecificException e) {
result.mErrorCode = e.errorCode;
result.mFreeSpaceRequired = 0;
return result;
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Cleanup files used by the previous update and free up space after the
* device has been booted successfully into the new build.
*
* <p>In particular, this function waits until delta files for snapshots for
* Virtual A/B update are merged to OS partitions, then delete these delta
* files.
*
* <p>This function is synchronous and may take a non-trivial amount of
* time. Callers should call this function in a background thread.
*
* <p>This function does not delete payload binaries downloaded for a
* non-streaming OTA update.
*
* @return One of the following:
* <ul>
* <li>{@link ErrorCodeConstants#SUCCESS} if execution is successful.</li>
* <li>{@link ErrorCodeConstants#ERROR} if a transient error has occurred.
* The device should be able to recover after a reboot. The function should
* be retried after the reboot.</li>
* <li>{@link ErrorCodeConstants#DEVICE_CORRUPTED} if a permanent error is
* encountered. Device is corrupted, and future updates must not be applied.
* The device cannot recover without flashing and factory resets.
* </ul>
*
* @throws ServiceSpecificException if other transient errors has occurred.
* A reboot may or may not help resolving the issue.
*/
@ErrorCode
public int cleanupAppliedPayload() {
try {
return mUpdateEngine.cleanupSuccessfulUpdate();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}

View File

@@ -44,5 +44,6 @@ public abstract class UpdateEngineCallback {
* unsuccessfully. The value of {@code errorCode} will be one of the
* values from {@link UpdateEngine.ErrorCodeConstants}.
*/
public abstract void onPayloadApplicationComplete(int errorCode);
public abstract void onPayloadApplicationComplete(
@UpdateEngine.ErrorCode int errorCode);
}