From a1953c28f4a614192f2c9607b083c590cc405001 Mon Sep 17 00:00:00 2001
From: Lee Shombert <shombert@google.com>
Date: Mon, 14 Mar 2022 13:01:58 -0700
Subject: [PATCH] Formally define allowable IpcDataCache modules

Bug: 219609105

The allowable IpcDataCache modules are formally defined as a
@StringDef.  There is no change to the system APIs.

A future change may subdivide the SYSTEM module into small,
feature-specific modules, such as package manager and user manager.

Test:
 * atest FrameworksCoreTests:IpcDataCacheTest
 * atest CtsOsTestCases:IpcDataCacheTest

Change-Id: I15e358723a36b76c384ccfb70bed63e80d57c4c7
---
 core/java/android/os/IpcDataCache.java | 29 ++++++++++++++++++++++----
 1 file changed, 25 insertions(+), 4 deletions(-)

diff --git a/core/java/android/os/IpcDataCache.java b/core/java/android/os/IpcDataCache.java
index 00734c806b7e9..0efa34cdc47fe 100644
--- a/core/java/android/os/IpcDataCache.java
+++ b/core/java/android/os/IpcDataCache.java
@@ -16,12 +16,12 @@
 
 package android.os;
 
-import android.app.PropertyInvalidatedCache;
-import android.annotation.IntDef;
 import android.annotation.NonNull;
 import android.annotation.Nullable;
+import android.annotation.StringDef;
 import android.annotation.SystemApi;
 import android.annotation.TestApi;
+import android.app.PropertyInvalidatedCache;
 import android.text.TextUtils;
 import android.util.Log;
 
@@ -266,6 +266,25 @@ public class IpcDataCache<Query, Result> extends PropertyInvalidatedCache<Query,
         }
     };
 
+    /**
+     * The list of cache namespaces.  Each namespace corresponds to an sepolicy domain.  A
+     * namespace is owned by a single process, although a single process can have more
+     * than one namespace (system_server, as an example).
+     * @hide
+     */
+    @StringDef(
+        prefix = { "MODULE_"
+        },
+        value = {
+            MODULE_TEST,
+            MODULE_SYSTEM,
+            MODULE_BLUETOOTH,
+            MODULE_TELEPHONY
+        }
+    )
+    @Retention(RetentionPolicy.SOURCE)
+    public @interface IpcDataCacheModule { }
+
     /**
      * The module used for unit tests and cts tests.  It is expected that no process in
      * the system has permissions to write properties with this module.
@@ -304,7 +323,8 @@ public class IpcDataCache<Query, Result> extends PropertyInvalidatedCache<Query,
      */
     @SystemApi(client=SystemApi.Client.MODULE_LIBRARIES)
     @TestApi
-    public IpcDataCache(int maxEntries, @NonNull String module, @NonNull String api,
+    public IpcDataCache(int maxEntries, @NonNull @IpcDataCacheModule String module,
+            @NonNull String api,
             @NonNull String cacheName, @NonNull QueryHandler<Query, Result> computer) {
         super(maxEntries, module, api, cacheName, computer);
     }
@@ -358,7 +378,8 @@ public class IpcDataCache<Query, Result> extends PropertyInvalidatedCache<Query,
      */
     @SystemApi(client=SystemApi.Client.MODULE_LIBRARIES)
     @TestApi
-    public static void invalidateCache(@NonNull String module, @NonNull String api) {
+    public static void invalidateCache(@NonNull @IpcDataCacheModule String module,
+            @NonNull String api) {
         PropertyInvalidatedCache.invalidateCache(module, api);
     }
 }