Update ART Serivces APIs.
The changes are based on the early feedback in ag/18672526.
Bug: 225827974
Test: atest ArtServiceTests
Ignore-AOSP-First: ART Services
Change-Id: I31d757ff4a2db20d86252f966486eb2b55416912
diff --git a/libartservice/service/java/com/android/server/art/ArtManagerLocal.java b/libartservice/service/java/com/android/server/art/ArtManagerLocal.java
index 8d79b58..33393c6 100644
--- a/libartservice/service/java/com/android/server/art/ArtManagerLocal.java
+++ b/libartservice/service/java/com/android/server/art/ArtManagerLocal.java
@@ -18,6 +18,8 @@
import static com.android.server.art.PrimaryDexUtils.DetailedPrimaryDexInfo;
import static com.android.server.art.PrimaryDexUtils.PrimaryDexInfo;
+import static com.android.server.art.model.ArtFlags.DeleteFlags;
+import static com.android.server.art.model.ArtFlags.GetStatusFlags;
import static com.android.server.art.model.OptimizationStatus.DexFileOptimizationStatus;
import android.annotation.NonNull;
@@ -29,9 +31,8 @@
import com.android.internal.annotations.VisibleForTesting;
import com.android.server.art.IArtd;
-import com.android.server.art.model.DeleteOptions;
+import com.android.server.art.model.ArtFlags;
import com.android.server.art.model.DeleteResult;
-import com.android.server.art.model.GetStatusOptions;
import com.android.server.art.model.OptimizationStatus;
import com.android.server.art.wrapper.AndroidPackageApi;
import com.android.server.art.wrapper.PackageDataSnapshot;
@@ -93,14 +94,16 @@
/**
* Deletes optimized artifacts of a package.
*
- * @throws IllegalArgumentException if the package is not found or the options are illegal
+ * @throws IllegalArgumentException if the package is not found or the flags are illegal
* @throws IllegalStateException if an internal error occurs
*
* @hide
*/
+ @NonNull
public DeleteResult deleteOptimizedArtifacts(@NonNull PackageDataSnapshot snapshot,
- @NonNull String packageName, @NonNull DeleteOptions options) {
- if (!options.isForPrimaryDex() && !options.isForSecondaryDex()) {
+ @NonNull String packageName, @DeleteFlags int flags) {
+ if ((flags & ArtFlags.FLAG_FOR_PRIMARY_DEX) == 0
+ && (flags & ArtFlags.FLAG_FOR_SECONDARY_DEX) == 0) {
throw new IllegalArgumentException("Nothing to delete");
}
@@ -110,7 +113,7 @@
try {
long freedBytes = 0;
- if (options.isForPrimaryDex()) {
+ if ((flags & ArtFlags.FLAG_FOR_PRIMARY_DEX) != 0) {
boolean isInDalvikCache = Utils.isInDalvikCache(pkgState);
for (PrimaryDexInfo dexInfo : PrimaryDexUtils.getDexInfo(pkg)) {
if (!dexInfo.hasCode()) {
@@ -123,7 +126,7 @@
}
}
- if (options.isForSecondaryDex()) {
+ if ((flags & ArtFlags.FLAG_FOR_SECONDARY_DEX) != 0) {
// TODO(jiakaiz): Implement this.
throw new UnsupportedOperationException(
"Deleting artifacts of secondary dex'es is not implemented yet");
@@ -136,17 +139,31 @@
}
/**
+ * Same as above, but with default flags.
+ *
+ * @see #deleteOptimizedArtifacts(PackageDataSnapshot, String, int)
+ *
+ * @hide
+ */
+ @NonNull
+ public DeleteResult deleteOptimizedArtifacts(
+ @NonNull PackageDataSnapshot snapshot, @NonNull String packageName) {
+ return deleteOptimizedArtifacts(snapshot, packageName, ArtFlags.defaultDeleteFlags());
+ }
+
+ /**
* Returns the optimization status of a package.
*
- * @throws IllegalArgumentException if the package is not found or the options are illegal
+ * @throws IllegalArgumentException if the package is not found or the flags are illegal
* @throws IllegalStateException if an internal error occurs
*
* @hide
*/
@NonNull
public OptimizationStatus getOptimizationStatus(@NonNull PackageDataSnapshot snapshot,
- @NonNull String packageName, @NonNull GetStatusOptions options) {
- if (!options.isForPrimaryDex() && !options.isForSecondaryDex()) {
+ @NonNull String packageName, @GetStatusFlags int flags) {
+ if ((flags & ArtFlags.FLAG_FOR_PRIMARY_DEX) == 0
+ && (flags & ArtFlags.FLAG_FOR_SECONDARY_DEX) == 0) {
throw new IllegalArgumentException("Nothing to check");
}
@@ -156,7 +173,7 @@
try {
List<DexFileOptimizationStatus> statuses = new ArrayList<>();
- if (options.isForPrimaryDex()) {
+ if ((flags & ArtFlags.FLAG_FOR_PRIMARY_DEX) != 0) {
for (DetailedPrimaryDexInfo dexInfo :
PrimaryDexUtils.getDetailedDexInfo(pkgState, pkg)) {
if (!dexInfo.hasCode()) {
@@ -173,7 +190,7 @@
}
}
- if (options.isForSecondaryDex()) {
+ if ((flags & ArtFlags.FLAG_FOR_SECONDARY_DEX) != 0) {
// TODO(jiakaiz): Implement this.
throw new UnsupportedOperationException(
"Getting optimization status of secondary dex'es is not implemented yet");
@@ -185,6 +202,19 @@
}
}
+ /**
+ * Same as above, but with default flags.
+ *
+ * @see #getOptimizationStatus(PackageDataSnapshot, String, int)
+ *
+ * @hide
+ */
+ @NonNull
+ public OptimizationStatus getOptimizationStatus(
+ @NonNull PackageDataSnapshot snapshot, @NonNull String packageName) {
+ return getOptimizationStatus(snapshot, packageName, ArtFlags.defaultGetStatusFlags());
+ }
+
private PackageState getPackageStateOrThrow(
@NonNull PackageDataSnapshot snapshot, @NonNull String packageName) {
PackageState pkgState = mInjector.getPackageManagerLocal().getPackageState(
diff --git a/libartservice/service/java/com/android/server/art/ArtShellCommand.java b/libartservice/service/java/com/android/server/art/ArtShellCommand.java
index ba01ed5..a094d6f 100644
--- a/libartservice/service/java/com/android/server/art/ArtShellCommand.java
+++ b/libartservice/service/java/com/android/server/art/ArtShellCommand.java
@@ -22,9 +22,8 @@
import android.os.Process;
import com.android.modules.utils.BasicShellCommandHandler;
-import com.android.server.art.model.DeleteOptions;
+import com.android.server.art.model.ArtFlags;
import com.android.server.art.model.DeleteResult;
-import com.android.server.art.model.GetStatusOptions;
import com.android.server.art.model.OptimizationStatus;
import com.android.server.art.wrapper.PackageDataSnapshot;
import com.android.server.art.wrapper.PackageManagerLocal;
@@ -56,12 +55,12 @@
switch (cmd) {
case "delete-optimized-artifacts":
DeleteResult result = mArtManagerLocal.deleteOptimizedArtifacts(
- snapshot, getNextArgRequired(), new DeleteOptions.Builder().build());
+ snapshot, getNextArgRequired(), ArtFlags.defaultDeleteFlags());
pw.printf("Freed %d bytes\n", result.getFreedBytes());
return 0;
case "get-optimization-status":
OptimizationStatus optimizationStatus = mArtManagerLocal.getOptimizationStatus(
- snapshot, getNextArgRequired(), new GetStatusOptions.Builder().build());
+ snapshot, getNextArgRequired(), ArtFlags.defaultGetStatusFlags());
for (DexFileOptimizationStatus status :
optimizationStatus.getDexFileOptimizationStatuses()) {
pw.printf("dexFile = %s, instructionSet = %s, compilerFilter = %s, "
diff --git a/libartservice/service/java/com/android/server/art/model/ArtFlags.java b/libartservice/service/java/com/android/server/art/model/ArtFlags.java
new file mode 100644
index 0000000..c53f3e3
--- /dev/null
+++ b/libartservice/service/java/com/android/server/art/model/ArtFlags.java
@@ -0,0 +1,78 @@
+/*
+ * 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.model;
+
+import android.annotation.IntDef;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/** @hide */
+public class ArtFlags {
+ /** Whether the operation is applied for primary dex'es. */
+ public static final int FLAG_FOR_PRIMARY_DEX = 1 << 0;
+ /** Whether the operation is applied for secondary dex'es. */
+ public static final int FLAG_FOR_SECONDARY_DEX = 1 << 1;
+
+ /**
+ * Flags for {@link ArtManagerLocal#deleteOptimizedArtifacts(PackageDataSnapshot, String, int)}.
+ *
+ * @hide
+ */
+ // clang-format off
+ @IntDef(flag = true, prefix = "FLAG_", value = {
+ FLAG_FOR_PRIMARY_DEX,
+ FLAG_FOR_SECONDARY_DEX,
+ })
+ // clang-format on
+ @Retention(RetentionPolicy.SOURCE)
+ public @interface DeleteFlags {}
+
+ /**
+ * Default flags that are used when
+ * {@link ArtManagerLocal#deleteOptimizedArtifacts(PackageDataSnapshot, String)} is called.
+ * Value: {@link #FLAG_FOR_PRIMARY_DEX}.
+ */
+ public static @DeleteFlags int defaultDeleteFlags() {
+ return FLAG_FOR_PRIMARY_DEX;
+ }
+
+ /**
+ * Flags for {@link ArtManagerLocal#getOptimizationStatus(PackageDataSnapshot, String, int)}.
+ *
+ * @hide
+ */
+ // clang-format off
+ @IntDef(flag = true, prefix = "FLAG_", value = {
+ FLAG_FOR_PRIMARY_DEX,
+ FLAG_FOR_SECONDARY_DEX,
+ })
+ // clang-format on
+ @Retention(RetentionPolicy.SOURCE)
+ public @interface GetStatusFlags {}
+
+ /**
+ * Default flags that are used when
+ * {@link ArtManagerLocal#getOptimizationStatus(PackageDataSnapshot, String)} is called.
+ * Value: {@link #FLAG_FOR_PRIMARY_DEX}.
+ */
+ public static @GetStatusFlags int defaultGetStatusFlags() {
+ return FLAG_FOR_PRIMARY_DEX;
+ }
+
+ private ArtFlags() {}
+}
diff --git a/libartservice/service/java/com/android/server/art/model/DeleteOptions.java b/libartservice/service/java/com/android/server/art/model/DeleteOptions.java
deleted file mode 100644
index ba3ff03..0000000
--- a/libartservice/service/java/com/android/server/art/model/DeleteOptions.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
- * 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.model;
-
-/** @hide */
-public class DeleteOptions {
- public static final class Builder {
- private DeleteOptions mDeleteOptions = new DeleteOptions();
-
- /** Whether to delete optimized artifacts for primary dex'es. Default: true. */
- public Builder setForPrimaryDex(boolean value) {
- mDeleteOptions.mIsForPrimaryDex = value;
- return this;
- }
-
- /** Whether to delete optimized artifacts for secondary dex'es. Default: false. */
- public Builder setForSecondaryDex(boolean value) {
- mDeleteOptions.mIsForSecondaryDex = value;
- return this;
- }
-
- /** Returns the built object. */
- public DeleteOptions build() {
- return mDeleteOptions;
- }
- }
-
- private boolean mIsForPrimaryDex = true;
- private boolean mIsForSecondaryDex = false;
-
- private DeleteOptions() {}
-
- /** Whether to delete optimized artifacts for primary dex'es. */
- public boolean isForPrimaryDex() {
- return mIsForPrimaryDex;
- }
-
- /** Whether to delete optimized artifacts for secondary dex'es. */
- public boolean isForSecondaryDex() {
- return mIsForSecondaryDex;
- }
-}
diff --git a/libartservice/service/java/com/android/server/art/model/GetStatusOptions.java b/libartservice/service/java/com/android/server/art/model/GetStatusOptions.java
deleted file mode 100644
index 22b0131..0000000
--- a/libartservice/service/java/com/android/server/art/model/GetStatusOptions.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
- * 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.model;
-
-/** @hide */
-public class GetStatusOptions {
- public static final class Builder {
- private GetStatusOptions mGetStatusOptions = new GetStatusOptions();
-
- /** Whether to get optimization status of primary dex'es. Default: true. */
- public Builder setForPrimaryDex(boolean value) {
- mGetStatusOptions.mIsForPrimaryDex = value;
- return this;
- }
-
- /** Whether to get optimization status of secondary dex'es. Default: false. */
- public Builder setForSecondaryDex(boolean value) {
- mGetStatusOptions.mIsForSecondaryDex = value;
- return this;
- }
-
- /** Returns the built object. */
- public GetStatusOptions build() {
- return mGetStatusOptions;
- }
- }
-
- private boolean mIsForPrimaryDex = true;
- private boolean mIsForSecondaryDex = false;
-
- private GetStatusOptions() {}
-
- /** Whether to get optimization status of primary dex'es. */
- public boolean isForPrimaryDex() {
- return mIsForPrimaryDex;
- }
-
- /** Whether to get optimization status of secondary dex'es. */
- public boolean isForSecondaryDex() {
- return mIsForSecondaryDex;
- }
-}
diff --git a/libartservice/service/javatests/com/android/server/art/ArtManagerLocalTest.java b/libartservice/service/javatests/com/android/server/art/ArtManagerLocalTest.java
index bbfa5f9..572ab06 100644
--- a/libartservice/service/javatests/com/android/server/art/ArtManagerLocalTest.java
+++ b/libartservice/service/javatests/com/android/server/art/ArtManagerLocalTest.java
@@ -34,9 +34,7 @@
import androidx.test.filters.SmallTest;
-import com.android.server.art.model.DeleteOptions;
import com.android.server.art.model.DeleteResult;
-import com.android.server.art.model.GetStatusOptions;
import com.android.server.art.model.OptimizationStatus;
import com.android.server.art.wrapper.AndroidPackageApi;
import com.android.server.art.wrapper.PackageDataSnapshot;
@@ -97,7 +95,7 @@
when(mArtd.deleteArtifacts(any())).thenReturn(1l);
DeleteResult result = mArtManagerLocal.deleteOptimizedArtifacts(
- mock(PackageDataSnapshot.class), PKG_NAME, new DeleteOptions.Builder().build());
+ mock(PackageDataSnapshot.class), PKG_NAME);
assertThat(result.getFreedBytes()).isEqualTo(4);
verify(mArtd).deleteArtifacts(argThat(artifactsPath
@@ -123,16 +121,14 @@
public void testDeleteOptimizedArtifactsPackageNotFound() throws Exception {
when(mPackageManagerLocal.getPackageState(any(), anyInt(), eq(PKG_NAME))).thenReturn(null);
- mArtManagerLocal.deleteOptimizedArtifacts(
- mock(PackageDataSnapshot.class), PKG_NAME, new DeleteOptions.Builder().build());
+ mArtManagerLocal.deleteOptimizedArtifacts(mock(PackageDataSnapshot.class), PKG_NAME);
}
@Test(expected = IllegalStateException.class)
public void testDeleteOptimizedArtifactsNoPackage() throws Exception {
when(mPkgState.getAndroidPackage()).thenReturn(null);
- mArtManagerLocal.deleteOptimizedArtifacts(
- mock(PackageDataSnapshot.class), PKG_NAME, new DeleteOptions.Builder().build());
+ mArtManagerLocal.deleteOptimizedArtifacts(mock(PackageDataSnapshot.class), PKG_NAME);
}
@Test
@@ -147,8 +143,8 @@
createGetOptimizationStatusResult(
"extract", "compilation-reason-3", "location-debug-string-3"));
- OptimizationStatus result = mArtManagerLocal.getOptimizationStatus(
- mock(PackageDataSnapshot.class), PKG_NAME, new GetStatusOptions.Builder().build());
+ OptimizationStatus result =
+ mArtManagerLocal.getOptimizationStatus(mock(PackageDataSnapshot.class), PKG_NAME);
List<DexFileOptimizationStatus> statuses = result.getDexFileOptimizationStatuses();
assertThat(statuses.size()).isEqualTo(4);
@@ -182,16 +178,14 @@
public void testGetOptimizationStatusPackageNotFound() throws Exception {
when(mPackageManagerLocal.getPackageState(any(), anyInt(), eq(PKG_NAME))).thenReturn(null);
- mArtManagerLocal.getOptimizationStatus(
- mock(PackageDataSnapshot.class), PKG_NAME, new GetStatusOptions.Builder().build());
+ mArtManagerLocal.getOptimizationStatus(mock(PackageDataSnapshot.class), PKG_NAME);
}
@Test(expected = IllegalStateException.class)
public void testGetOptimizationStatusNoPackage() throws Exception {
when(mPkgState.getAndroidPackage()).thenReturn(null);
- mArtManagerLocal.getOptimizationStatus(
- mock(PackageDataSnapshot.class), PKG_NAME, new GetStatusOptions.Builder().build());
+ mArtManagerLocal.getOptimizationStatus(mock(PackageDataSnapshot.class), PKG_NAME);
}
private AndroidPackageApi createPackage() {