Add UpdateEngine.allocateSpace (16d4554a) · Commits · e / os / android_frameworks_base

api/system-current.txt

+7 −0

Original line number	Diff line number	Diff line
		@@ -6082,6 +6082,7 @@ 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);
		@@ -6094,6 +6095,11 @@ 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 DOWNLOAD_PAYLOAD_VERIFICATION_ERROR = 12; // 0xc
		@@ -6102,6 +6108,7 @@ package android.os {
		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

core/java/android/os/UpdateEngine.java

+104 −0

Original line number	Diff line number	Diff line
		@@ -140,6 +140,14 @@ 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;
		}

		/**
		@@ -419,4 +427,100 @@ public class UpdateEngine {
		throw e.rethrowFromSystemServer();
		}
		}

		/**
		* Return value of {@link #allocateSpace.}
		*/
		public static final class AllocateSpaceResult {
		private 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>
		*/
		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();
		}
		}
		}