Merge changes from topic "add-caching-platformcompat"
* changes: Cache binder calls in CompatChanges Add property-invalidated cache
This commit is contained in:
428
core/java/android/app/PropertyInvalidatedCache.java
Normal file
428
core/java/android/app/PropertyInvalidatedCache.java
Normal file
@@ -0,0 +1,428 @@
|
|||||||
|
/*
|
||||||
|
* 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.app;
|
||||||
|
import android.annotation.NonNull;
|
||||||
|
import android.os.SystemProperties;
|
||||||
|
import android.util.Log;
|
||||||
|
|
||||||
|
import com.android.internal.annotations.GuardedBy;
|
||||||
|
|
||||||
|
import java.util.LinkedHashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Random;
|
||||||
|
import java.util.concurrent.atomic.AtomicLong;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* LRU cache that's invalidated when an opaque value in a property changes. Self-synchronizing,
|
||||||
|
* but doesn't hold a lock across data fetches on query misses.
|
||||||
|
*
|
||||||
|
* The intended use case is caching frequently-read, seldom-changed information normally
|
||||||
|
* retrieved across interprocess communication. Imagine that you've written a user birthday
|
||||||
|
* information daemon called "birthdayd" that exposes an {@code IUserBirthdayService} interface
|
||||||
|
* over binder. That binder interface looks something like this:
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* parcelable Birthday {
|
||||||
|
* int month;
|
||||||
|
* int day;
|
||||||
|
* }
|
||||||
|
* interface IUserBirthdayService {
|
||||||
|
* Birthday getUserBirthday(int userId);
|
||||||
|
* }
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* Suppose the service implementation itself looks like this...
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* public class UserBirthdayServiceImpl implements IUserBirthdayService {
|
||||||
|
* private final HashMap<Integer, Birthday> mUidToBirthday;
|
||||||
|
* @Override
|
||||||
|
* public synchronized Birthday getUserBirthday(int userId) {
|
||||||
|
* return mUidToBirthday.get(userId);
|
||||||
|
* }
|
||||||
|
* private synchronized void updateBirthdays(Map<Integer, Birthday> uidToBirthday) {
|
||||||
|
* mUidToBirthday.clear();
|
||||||
|
* mUidToBirthday.putAll(uidToBirthday);
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* ... and we have a client in frameworks (loaded into every app process) that looks
|
||||||
|
* like this:
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* public class ActivityThread {
|
||||||
|
* ...
|
||||||
|
* public Birthday getUserBirthday(int userId) {
|
||||||
|
* return GetService("birthdayd").getUserBirthday(userId);
|
||||||
|
* }
|
||||||
|
* ...
|
||||||
|
* }
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* With this code, every time an app calls {@code getUserBirthday(uid)}, we make a binder call
|
||||||
|
* to the birthdayd process and consult its database of birthdays. If we query user birthdays
|
||||||
|
* frequently, we do a lot of work that we don't have to do, since user birthdays
|
||||||
|
* change infrequently.
|
||||||
|
*
|
||||||
|
* PropertyInvalidatedCache is part of a pattern for optimizing this kind of
|
||||||
|
* information-querying code. Using {@code PropertyInvalidatedCache}, you'd write the client
|
||||||
|
* this way:
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* public class ActivityThread {
|
||||||
|
* ...
|
||||||
|
* private static final int BDAY_CACHE_MAX = 8; // Maximum birthdays to cache
|
||||||
|
* private static final String BDAY_CACHE_KEY = "cache_key.birthdayd";
|
||||||
|
* private final PropertyInvalidatedCache<Integer, Birthday> mBirthdayCache = new
|
||||||
|
* PropertyInvalidatedCache<Integer, Birthday>(BDAY_CACHE_MAX, BDAY_CACHE_KEY) {
|
||||||
|
* @Override
|
||||||
|
* protected Birthday recompute(Integer userId) {
|
||||||
|
* return GetService("birthdayd").getUserBirthday(userId);
|
||||||
|
* }
|
||||||
|
* };
|
||||||
|
* public void disableUserBirthdayCache() {
|
||||||
|
* mBirthdayCache.disableLocal();
|
||||||
|
* }
|
||||||
|
* public void invalidateUserBirthdayCache() {
|
||||||
|
* mBirthdayCache.invalidateCache();
|
||||||
|
* }
|
||||||
|
* public Birthday getUserBirthday(int userId) {
|
||||||
|
* return mBirthdayCache.query(userId);
|
||||||
|
* }
|
||||||
|
* ...
|
||||||
|
* }
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* With this cache, clients perform a binder call to birthdayd if asking for a user's birthday
|
||||||
|
* for the first time; on subsequent queries, we return the already-known Birthday object.
|
||||||
|
*
|
||||||
|
* User birthdays do occasionally change, so we have to modify the server to invalidate this
|
||||||
|
* cache when necessary. That invalidation code looks like this:
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* public class UserBirthdayServiceImpl {
|
||||||
|
* ...
|
||||||
|
* public UserBirthdayServiceImpl() {
|
||||||
|
* ...
|
||||||
|
* ActivityThread.currentActivityThread().disableUserBirthdayCache();
|
||||||
|
* ActivityThread.currentActivityThread().invalidateUserBirthdayCache();
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* private synchronized void updateBirthdays(Map<Integer, Birthday> uidToBirthday) {
|
||||||
|
* mUidToBirthday.clear();
|
||||||
|
* mUidToBirthday.putAll(uidToBirthday);
|
||||||
|
* ActivityThread.currentActivityThread().invalidateUserBirthdayCache();
|
||||||
|
* }
|
||||||
|
* ...
|
||||||
|
* }
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* The call to {@code PropertyInvalidatedCache.invalidateCache()} guarantees that all clients
|
||||||
|
* will re-fetch birthdays from binder during consequent calls to
|
||||||
|
* {@code ActivityThread.getUserBirthday()}. Because the invalidate call happens with the lock
|
||||||
|
* held, we maintain consistency between different client views of the birthday state. The use
|
||||||
|
* of PropertyInvalidatedCache in this idiomatic way introduces no new race conditions.
|
||||||
|
*
|
||||||
|
* PropertyInvalidatedCache has a few other features for doing things like incremental
|
||||||
|
* enhancement of cached values and invalidation of multiple caches (that all share the same
|
||||||
|
* property key) at once.
|
||||||
|
*
|
||||||
|
* {@code BDAY_CACHE_KEY} is the name of a property that we set to an opaque unique value each
|
||||||
|
* time we update the cache. SELinux configuration must allow everyone to read this property
|
||||||
|
* and it must allow any process that needs to invalidate the cache (here, birthdayd) to write
|
||||||
|
* the property. (These properties conventionally begin with the "cache_key." prefix.)
|
||||||
|
*
|
||||||
|
* The {@code UserBirthdayServiceImpl} constructor calls {@code disableUserBirthdayCache()} so
|
||||||
|
* that calls to {@code getUserBirthday} from inside birthdayd don't go through the cache. In
|
||||||
|
* this local case, there's no IPC, so use of the cache is (depending on exact
|
||||||
|
* circumstance) unnecessary.
|
||||||
|
*
|
||||||
|
* @param <Query> The class used to index cache entries: must be hashable and comparable
|
||||||
|
* @param <Result> The class holding cache entries; use a boxed primitive if possible
|
||||||
|
*
|
||||||
|
* {@hide}
|
||||||
|
*/
|
||||||
|
public abstract class PropertyInvalidatedCache<Query, Result> {
|
||||||
|
private static final long NONCE_UNSET = 0;
|
||||||
|
private static final long NONCE_DISABLED = -1;
|
||||||
|
|
||||||
|
private static final String TAG = "PropertyInvalidatedCache";
|
||||||
|
private static final boolean DEBUG = false;
|
||||||
|
private static final boolean ENABLE = true;
|
||||||
|
|
||||||
|
private final Object mLock = new Object();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Name of the property that holds the unique value that we use to invalidate the cache.
|
||||||
|
*/
|
||||||
|
private final String mPropertyName;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle to the {@code mPropertyName} property, transitioning to non-{@code null} once the
|
||||||
|
* property exists on the system.
|
||||||
|
*/
|
||||||
|
private volatile SystemProperties.Handle mPropertyHandle;
|
||||||
|
|
||||||
|
@GuardedBy("mLock")
|
||||||
|
private final LinkedHashMap<Query, Result> mCache;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The last value of the {@code mPropertyHandle} that we observed.
|
||||||
|
*/
|
||||||
|
@GuardedBy("mLock")
|
||||||
|
private long mLastSeenNonce = NONCE_UNSET;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether we've disabled the cache in this process.
|
||||||
|
*/
|
||||||
|
private boolean mDisabled = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make a new property invalidated cache.
|
||||||
|
*
|
||||||
|
* @param maxEntries Maximum number of entries to cache; LRU discard
|
||||||
|
* @param propertyName Name of the system property holding the cache invalidation nonce
|
||||||
|
*/
|
||||||
|
public PropertyInvalidatedCache(int maxEntries, @NonNull String propertyName) {
|
||||||
|
mPropertyName = propertyName;
|
||||||
|
mCache = new LinkedHashMap<Query, Result>(
|
||||||
|
2 /* start small */,
|
||||||
|
0.75f /* default load factor */,
|
||||||
|
true /* LRU access order */) {
|
||||||
|
@Override
|
||||||
|
protected boolean removeEldestEntry(Map.Entry eldest) {
|
||||||
|
return size() > maxEntries;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Forget all cached values.
|
||||||
|
*/
|
||||||
|
public final void clear() {
|
||||||
|
synchronized (mLock) {
|
||||||
|
mCache.clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch a result from scratch in case it's not in the cache at all. Called unlocked: may
|
||||||
|
* block. If this function returns null, the result of the cache query is null. There is no
|
||||||
|
* "negative cache" in the query: we don't cache null results at all.
|
||||||
|
*/
|
||||||
|
protected abstract Result recompute(Query query);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make result up-to-date on a cache hit. Called unlocked;
|
||||||
|
* may block.
|
||||||
|
*
|
||||||
|
* Return either 1) oldResult itself (the same object, by reference equality), in which
|
||||||
|
* case we just return oldResult as the result of the cache query, 2) a new object, which
|
||||||
|
* replaces oldResult in the cache and which we return as the result of the cache query
|
||||||
|
* after performing another property read to make sure that the result hasn't changed in
|
||||||
|
* the meantime (if the nonce has changed in the meantime, we drop the cache and try the
|
||||||
|
* whole query again), or 3) null, which causes the old value to be removed from the cache
|
||||||
|
* and null to be returned as the result of the cache query.
|
||||||
|
*/
|
||||||
|
protected Result refresh(Result oldResult, Query query) {
|
||||||
|
return oldResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
private long getCurrentNonce() {
|
||||||
|
SystemProperties.Handle handle = mPropertyHandle;
|
||||||
|
if (handle == null) {
|
||||||
|
handle = SystemProperties.find(mPropertyName);
|
||||||
|
if (handle == null) {
|
||||||
|
return NONCE_UNSET;
|
||||||
|
}
|
||||||
|
mPropertyHandle = handle;
|
||||||
|
}
|
||||||
|
return handle.getLong(NONCE_UNSET);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disable the use of this cache in this process.
|
||||||
|
*/
|
||||||
|
public final void disableLocal() {
|
||||||
|
synchronized (mLock) {
|
||||||
|
mDisabled = true;
|
||||||
|
mCache.clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return whether the cache is disabled in this process.
|
||||||
|
*/
|
||||||
|
public final boolean isDisabledLocal() {
|
||||||
|
return mDisabled;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a value from the cache or recompute it.
|
||||||
|
*/
|
||||||
|
public Result query(Query query) {
|
||||||
|
// Let access to mDisabled race: it's atomic anyway.
|
||||||
|
long currentNonce = (ENABLE && !mDisabled) ? getCurrentNonce() : NONCE_DISABLED;
|
||||||
|
for (;;) {
|
||||||
|
if (currentNonce == NONCE_DISABLED || currentNonce == NONCE_UNSET) {
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG,
|
||||||
|
String.format("cache %s for %s",
|
||||||
|
currentNonce == NONCE_DISABLED ? "disabled" : "unset",
|
||||||
|
query));
|
||||||
|
}
|
||||||
|
return recompute(query);
|
||||||
|
}
|
||||||
|
final Result cachedResult;
|
||||||
|
synchronized (mLock) {
|
||||||
|
if (currentNonce == mLastSeenNonce) {
|
||||||
|
cachedResult = mCache.get(query);
|
||||||
|
} else {
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG,
|
||||||
|
String.format("clearing cache because nonce changed [%s] -> [%s]",
|
||||||
|
mLastSeenNonce, currentNonce));
|
||||||
|
}
|
||||||
|
mCache.clear();
|
||||||
|
mLastSeenNonce = currentNonce;
|
||||||
|
cachedResult = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Cache hit --- but we're not quite done yet. A value in the cache might need to
|
||||||
|
// be augmented in a "refresh" operation. The refresh operation can combine the
|
||||||
|
// old and the new nonce values. In order to make sure the new parts of the value
|
||||||
|
// are consistent with the old, possibly-reused parts, we check the property value
|
||||||
|
// again after the refresh and do the whole fetch again if the property invalidated
|
||||||
|
// us while we were refreshing.
|
||||||
|
if (cachedResult != null) {
|
||||||
|
final Result refreshedResult = refresh(cachedResult, query);
|
||||||
|
if (refreshedResult != cachedResult) {
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG, "cache refresh for " + query);
|
||||||
|
}
|
||||||
|
final long afterRefreshNonce = getCurrentNonce();
|
||||||
|
if (currentNonce != afterRefreshNonce) {
|
||||||
|
currentNonce = afterRefreshNonce;
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG, "restarting query because nonce changed in refresh");
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
synchronized (mLock) {
|
||||||
|
if (currentNonce != mLastSeenNonce) {
|
||||||
|
// Do nothing: cache is already out of date. Just return the value
|
||||||
|
// we already have: there's no guarantee that the contents of mCache
|
||||||
|
// won't become invalid as soon as we return.
|
||||||
|
} else if (refreshedResult == null) {
|
||||||
|
mCache.remove(query);
|
||||||
|
} else {
|
||||||
|
mCache.put(query, refreshedResult);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return refreshedResult;
|
||||||
|
}
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG, "cache hit for " + query);
|
||||||
|
}
|
||||||
|
return cachedResult;
|
||||||
|
}
|
||||||
|
// Cache miss: make the value from scratch.
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG, "cache miss for " + query);
|
||||||
|
}
|
||||||
|
final Result result = recompute(query);
|
||||||
|
synchronized (mLock) {
|
||||||
|
// If someone else invalidated the cache while we did the recomputation, don't
|
||||||
|
// update the cache with a potentially stale result.
|
||||||
|
if (mLastSeenNonce == currentNonce && result != null) {
|
||||||
|
mCache.put(query, result);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inner class avoids initialization in processes that don't do any invalidation
|
||||||
|
private static final class NoPreloadHolder {
|
||||||
|
private static final AtomicLong sNextNonce = new AtomicLong((new Random()).nextLong());
|
||||||
|
public static long next() {
|
||||||
|
return sNextNonce.getAndIncrement();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Non-static convenience version of disableSystemWide() for situations in which only a
|
||||||
|
* single PropertyInvalidatedCache is keyed on a particular property value.
|
||||||
|
*
|
||||||
|
* When multiple caches share a single property value, using an instance method on one of
|
||||||
|
* the cache objects to invalidate all of the cache objects becomes confusing and you should
|
||||||
|
* just use the static version of this function.
|
||||||
|
*/
|
||||||
|
public final void disableSystemWide() {
|
||||||
|
disableSystemWide(mPropertyName);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disable all caches system-wide that are keyed on {@var name}. This
|
||||||
|
* function is synchronous: caches are invalidated and disabled upon return.
|
||||||
|
*
|
||||||
|
* @param name Name of the cache-key property to invalidate
|
||||||
|
*/
|
||||||
|
public static void disableSystemWide(@NonNull String name) {
|
||||||
|
SystemProperties.set(name, Long.toString(NONCE_DISABLED));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Non-static convenience version of invalidateCache() for situations in which only a single
|
||||||
|
* PropertyInvalidatedCache is keyed on a particular property value.
|
||||||
|
*/
|
||||||
|
public final void invalidateCache() {
|
||||||
|
invalidateCache(mPropertyName);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invalidate PropertyInvalidatedCache caches in all processes that are keyed on
|
||||||
|
* {@var name}. This function is synchronous: caches are invalidated upon return.
|
||||||
|
*
|
||||||
|
* @param name Name of the cache-key property to invalidate
|
||||||
|
*/
|
||||||
|
public static void invalidateCache(@NonNull String name) {
|
||||||
|
// There's no race here: we don't require that values strictly increase, but instead
|
||||||
|
// only that each is unique in a single runtime-restart session.
|
||||||
|
final long nonce = SystemProperties.getLong(name, NONCE_UNSET);
|
||||||
|
if (nonce == NONCE_DISABLED) {
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG, "refusing to invalidate disabled cache: " + name);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
long newValue;
|
||||||
|
do {
|
||||||
|
newValue = NoPreloadHolder.next();
|
||||||
|
} while (newValue == NONCE_UNSET || newValue == NONCE_DISABLED);
|
||||||
|
final String newValueString = Long.toString(newValue);
|
||||||
|
if (DEBUG) {
|
||||||
|
Log.d(TAG,
|
||||||
|
String.format("invalidating cache [%s]: [%s] -> [%s]",
|
||||||
|
name,
|
||||||
|
nonce,
|
||||||
|
newValueString));
|
||||||
|
}
|
||||||
|
SystemProperties.set(name, newValueString);
|
||||||
|
}
|
||||||
|
}
|
||||||
86
core/java/android/app/compat/ChangeIdStateCache.java
Normal file
86
core/java/android/app/compat/ChangeIdStateCache.java
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2020 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.app.compat;
|
||||||
|
|
||||||
|
import android.app.PropertyInvalidatedCache;
|
||||||
|
import android.content.Context;
|
||||||
|
import android.os.Binder;
|
||||||
|
import android.os.RemoteException;
|
||||||
|
import android.os.ServiceManager;
|
||||||
|
|
||||||
|
import com.android.internal.compat.IPlatformCompat;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles caching of calls to {@link com.android.internal.compat.IPlatformCompat}
|
||||||
|
* @hide
|
||||||
|
*/
|
||||||
|
public final class ChangeIdStateCache
|
||||||
|
extends PropertyInvalidatedCache<ChangeIdStateQuery, Boolean> {
|
||||||
|
private static final String CACHE_KEY = "cache_key.is_compat_change_enabled";
|
||||||
|
private static final int MAX_ENTRIES = 20;
|
||||||
|
private static boolean sDisabled = false;
|
||||||
|
|
||||||
|
/** @hide */
|
||||||
|
public ChangeIdStateCache() {
|
||||||
|
super(MAX_ENTRIES, CACHE_KEY);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disable cache.
|
||||||
|
*
|
||||||
|
* <p>Should only be used in unit tests.
|
||||||
|
* @hide
|
||||||
|
*/
|
||||||
|
public static void disable() {
|
||||||
|
sDisabled = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invalidate the cache.
|
||||||
|
*
|
||||||
|
* <p>Can only be called by the system server process.
|
||||||
|
* @hide
|
||||||
|
*/
|
||||||
|
public static void invalidate() {
|
||||||
|
if (!sDisabled) {
|
||||||
|
PropertyInvalidatedCache.invalidateCache(CACHE_KEY);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected Boolean recompute(ChangeIdStateQuery query) {
|
||||||
|
IPlatformCompat platformCompat = IPlatformCompat.Stub.asInterface(
|
||||||
|
ServiceManager.getService(Context.PLATFORM_COMPAT_SERVICE));
|
||||||
|
final long token = Binder.clearCallingIdentity();
|
||||||
|
try {
|
||||||
|
if (query.type == ChangeIdStateQuery.QUERY_BY_PACKAGE_NAME) {
|
||||||
|
return platformCompat.isChangeEnabledByPackageName(query.changeId,
|
||||||
|
query.packageName,
|
||||||
|
query.userId);
|
||||||
|
} else if (query.type == ChangeIdStateQuery.QUERY_BY_UID) {
|
||||||
|
return platformCompat.isChangeEnabledByUid(query.changeId, query.uid);
|
||||||
|
} else {
|
||||||
|
throw new IllegalArgumentException("Invalid query type: " + query.type);
|
||||||
|
}
|
||||||
|
} catch (RemoteException e) {
|
||||||
|
e.rethrowFromSystemServer();
|
||||||
|
} finally {
|
||||||
|
Binder.restoreCallingIdentity(token);
|
||||||
|
}
|
||||||
|
throw new IllegalStateException("Could not recompute value!");
|
||||||
|
}
|
||||||
|
}
|
||||||
87
core/java/android/app/compat/ChangeIdStateQuery.java
Normal file
87
core/java/android/app/compat/ChangeIdStateQuery.java
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2020 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.app.compat;
|
||||||
|
|
||||||
|
import android.annotation.IntDef;
|
||||||
|
import android.annotation.NonNull;
|
||||||
|
|
||||||
|
import java.lang.annotation.Retention;
|
||||||
|
import java.lang.annotation.RetentionPolicy;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A key type for caching calls to {@link com.android.internal.compat.IPlatformCompat}
|
||||||
|
*
|
||||||
|
* <p>For {@link com.android.internal.compat.IPlatformCompat#isChangeEnabledByPackageName}
|
||||||
|
* and {@link com.android.internal.compat.IPlatformCompat#isChangeEnabledByUid}
|
||||||
|
*
|
||||||
|
* @hide
|
||||||
|
*/
|
||||||
|
final class ChangeIdStateQuery {
|
||||||
|
|
||||||
|
static final int QUERY_BY_PACKAGE_NAME = 0;
|
||||||
|
static final int QUERY_BY_UID = 1;
|
||||||
|
@IntDef({QUERY_BY_PACKAGE_NAME, QUERY_BY_UID})
|
||||||
|
@Retention(RetentionPolicy.SOURCE)
|
||||||
|
@interface QueryType {}
|
||||||
|
|
||||||
|
public @QueryType int type;
|
||||||
|
public long changeId;
|
||||||
|
public String packageName;
|
||||||
|
public int uid;
|
||||||
|
public int userId;
|
||||||
|
|
||||||
|
private ChangeIdStateQuery(@QueryType int type, long changeId, String packageName,
|
||||||
|
int uid, int userId) {
|
||||||
|
this.type = type;
|
||||||
|
this.changeId = changeId;
|
||||||
|
this.packageName = packageName;
|
||||||
|
this.uid = uid;
|
||||||
|
this.userId = userId;
|
||||||
|
}
|
||||||
|
|
||||||
|
static ChangeIdStateQuery byPackageName(long changeId, @NonNull String packageName,
|
||||||
|
int userId) {
|
||||||
|
return new ChangeIdStateQuery(QUERY_BY_PACKAGE_NAME, changeId, packageName, 0, userId);
|
||||||
|
}
|
||||||
|
|
||||||
|
static ChangeIdStateQuery byUid(long changeId, int uid) {
|
||||||
|
return new ChangeIdStateQuery(QUERY_BY_UID, changeId, null, uid, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object other) {
|
||||||
|
if (this == other) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if ((other == null) || !(other instanceof ChangeIdStateQuery)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
final ChangeIdStateQuery that = (ChangeIdStateQuery) other;
|
||||||
|
return this.type == that.type
|
||||||
|
&& this.changeId == that.changeId
|
||||||
|
&& Objects.equals(this.packageName, that.packageName)
|
||||||
|
&& this.uid == that.uid
|
||||||
|
&& this.userId == that.userId;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
return Objects.hash(type, changeId, packageName, uid, userId);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -19,14 +19,8 @@ package android.app.compat;
|
|||||||
import android.annotation.NonNull;
|
import android.annotation.NonNull;
|
||||||
import android.annotation.SystemApi;
|
import android.annotation.SystemApi;
|
||||||
import android.compat.Compatibility;
|
import android.compat.Compatibility;
|
||||||
import android.content.Context;
|
|
||||||
import android.os.Binder;
|
|
||||||
import android.os.RemoteException;
|
|
||||||
import android.os.ServiceManager;
|
|
||||||
import android.os.UserHandle;
|
import android.os.UserHandle;
|
||||||
|
|
||||||
import com.android.internal.compat.IPlatformCompat;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* CompatChanges APIs - to be used by platform code only (including mainline
|
* CompatChanges APIs - to be used by platform code only (including mainline
|
||||||
* modules).
|
* modules).
|
||||||
@@ -35,6 +29,7 @@ import com.android.internal.compat.IPlatformCompat;
|
|||||||
*/
|
*/
|
||||||
@SystemApi
|
@SystemApi
|
||||||
public final class CompatChanges {
|
public final class CompatChanges {
|
||||||
|
private static final ChangeIdStateCache QUERY_CACHE = new ChangeIdStateCache();
|
||||||
private CompatChanges() {}
|
private CompatChanges() {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -69,17 +64,8 @@ public final class CompatChanges {
|
|||||||
*/
|
*/
|
||||||
public static boolean isChangeEnabled(long changeId, @NonNull String packageName,
|
public static boolean isChangeEnabled(long changeId, @NonNull String packageName,
|
||||||
@NonNull UserHandle user) {
|
@NonNull UserHandle user) {
|
||||||
IPlatformCompat platformCompat = IPlatformCompat.Stub.asInterface(
|
return QUERY_CACHE.query(ChangeIdStateQuery.byPackageName(changeId, packageName,
|
||||||
ServiceManager.getService(Context.PLATFORM_COMPAT_SERVICE));
|
user.getIdentifier()));
|
||||||
final long token = Binder.clearCallingIdentity();
|
|
||||||
try {
|
|
||||||
return platformCompat.isChangeEnabledByPackageName(changeId, packageName,
|
|
||||||
user.getIdentifier());
|
|
||||||
} catch (RemoteException e) {
|
|
||||||
throw e.rethrowFromSystemServer();
|
|
||||||
} finally {
|
|
||||||
Binder.restoreCallingIdentity(token);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -101,15 +87,7 @@ public final class CompatChanges {
|
|||||||
* @return {@code true} if the change is enabled for the current app.
|
* @return {@code true} if the change is enabled for the current app.
|
||||||
*/
|
*/
|
||||||
public static boolean isChangeEnabled(long changeId, int uid) {
|
public static boolean isChangeEnabled(long changeId, int uid) {
|
||||||
IPlatformCompat platformCompat = IPlatformCompat.Stub.asInterface(
|
return QUERY_CACHE.query(ChangeIdStateQuery.byUid(changeId, uid));
|
||||||
ServiceManager.getService(Context.PLATFORM_COMPAT_SERVICE));
|
|
||||||
final long token = Binder.clearCallingIdentity();
|
|
||||||
try {
|
|
||||||
return platformCompat.isChangeEnabledByUid(changeId, uid);
|
|
||||||
} catch (RemoteException e) {
|
|
||||||
throw e.rethrowFromSystemServer();
|
|
||||||
} finally {
|
|
||||||
Binder.restoreCallingIdentity(token);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,168 @@
|
|||||||
|
/*
|
||||||
|
* 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.os;
|
||||||
|
|
||||||
|
import android.app.PropertyInvalidatedCache;
|
||||||
|
import android.test.suitebuilder.annotation.SmallTest;
|
||||||
|
|
||||||
|
import junit.framework.TestCase;
|
||||||
|
|
||||||
|
public class PropertyInvalidatedCacheTest extends TestCase {
|
||||||
|
private static final String KEY = "sys.testkey";
|
||||||
|
private static final String UNSET_KEY = "Aiw7woh6ie4toh7W";
|
||||||
|
|
||||||
|
private static class TestCache extends PropertyInvalidatedCache<Integer, String> {
|
||||||
|
TestCache() {
|
||||||
|
this(KEY);
|
||||||
|
}
|
||||||
|
|
||||||
|
TestCache(String key) {
|
||||||
|
super(4, key);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected String recompute(Integer qv) {
|
||||||
|
mRecomputeCount += 1;
|
||||||
|
return "foo" + qv.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
int getRecomputeCount() {
|
||||||
|
return mRecomputeCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
private int mRecomputeCount = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void setUp() {
|
||||||
|
SystemProperties.set(KEY, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testCacheRecompute() throws Exception {
|
||||||
|
TestCache cache = new TestCache();
|
||||||
|
cache.invalidateCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(1, cache.getRecomputeCount());
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(1, cache.getRecomputeCount());
|
||||||
|
assertEquals("foo6", cache.query(6));
|
||||||
|
assertEquals(2, cache.getRecomputeCount());
|
||||||
|
cache.invalidateCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(3, cache.getRecomputeCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testCacheInitialState() throws Exception {
|
||||||
|
TestCache cache = new TestCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(2, cache.getRecomputeCount());
|
||||||
|
cache.invalidateCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(3, cache.getRecomputeCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testCachePropertyUnset() throws Exception {
|
||||||
|
TestCache cache = new TestCache(UNSET_KEY);
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(2, cache.getRecomputeCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testCacheDisableState() throws Exception {
|
||||||
|
TestCache cache = new TestCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(2, cache.getRecomputeCount());
|
||||||
|
cache.invalidateCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(3, cache.getRecomputeCount());
|
||||||
|
cache.disableSystemWide();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(5, cache.getRecomputeCount());
|
||||||
|
cache.invalidateCache(); // Should not reenable
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(7, cache.getRecomputeCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testRefreshSameObject() throws Exception {
|
||||||
|
int[] refreshCount = new int[1];
|
||||||
|
TestCache cache = new TestCache() {
|
||||||
|
@Override
|
||||||
|
protected String refresh(String oldResult, Integer query) {
|
||||||
|
refreshCount[0] += 1;
|
||||||
|
return oldResult;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
cache.invalidateCache();
|
||||||
|
String result1 = cache.query(5);
|
||||||
|
assertEquals("foo5", result1);
|
||||||
|
String result2 = cache.query(5);
|
||||||
|
assertSame(result1, result2);
|
||||||
|
assertEquals(1, cache.getRecomputeCount());
|
||||||
|
assertEquals(1, refreshCount[0]);
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(2, refreshCount[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testRefreshInvalidateRace() throws Exception {
|
||||||
|
int[] refreshCount = new int[1];
|
||||||
|
TestCache cache = new TestCache() {
|
||||||
|
@Override
|
||||||
|
protected String refresh(String oldResult, Integer query) {
|
||||||
|
refreshCount[0] += 1;
|
||||||
|
invalidateCache();
|
||||||
|
return new String(oldResult);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
cache.invalidateCache();
|
||||||
|
String result1 = cache.query(5);
|
||||||
|
assertEquals("foo5", result1);
|
||||||
|
String result2 = cache.query(5);
|
||||||
|
assertEquals(result1, result2);
|
||||||
|
assertNotSame(result1, result2);
|
||||||
|
assertEquals(2, cache.getRecomputeCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
@SmallTest
|
||||||
|
public void testLocalProcessDisable() throws Exception {
|
||||||
|
TestCache cache = new TestCache();
|
||||||
|
cache.invalidateCache();
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(1, cache.getRecomputeCount());
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(1, cache.getRecomputeCount());
|
||||||
|
assertEquals(cache.isDisabledLocal(), false);
|
||||||
|
cache.disableLocal();
|
||||||
|
assertEquals(cache.isDisabledLocal(), true);
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals("foo5", cache.query(5));
|
||||||
|
assertEquals(3, cache.getRecomputeCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -16,6 +16,7 @@
|
|||||||
|
|
||||||
package com.android.server.compat;
|
package com.android.server.compat;
|
||||||
|
|
||||||
|
import android.app.compat.ChangeIdStateCache;
|
||||||
import android.compat.Compatibility.ChangeConfig;
|
import android.compat.Compatibility.ChangeConfig;
|
||||||
import android.content.Context;
|
import android.content.Context;
|
||||||
import android.content.pm.ApplicationInfo;
|
import android.content.pm.ApplicationInfo;
|
||||||
@@ -78,6 +79,7 @@ final class CompatConfig {
|
|||||||
void addChange(CompatChange change) {
|
void addChange(CompatChange change) {
|
||||||
synchronized (mChanges) {
|
synchronized (mChanges) {
|
||||||
mChanges.put(change.getId(), change);
|
mChanges.put(change.getId(), change);
|
||||||
|
invalidateCache();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -170,6 +172,7 @@ final class CompatConfig {
|
|||||||
addChange(c);
|
addChange(c);
|
||||||
}
|
}
|
||||||
c.addPackageOverride(packageName, enabled);
|
c.addPackageOverride(packageName, enabled);
|
||||||
|
invalidateCache();
|
||||||
}
|
}
|
||||||
return alreadyKnown;
|
return alreadyKnown;
|
||||||
}
|
}
|
||||||
@@ -226,6 +229,7 @@ final class CompatConfig {
|
|||||||
// Should never occur, since validator is in the same process.
|
// Should never occur, since validator is in the same process.
|
||||||
throw new RuntimeException("Unable to call override validator!", e);
|
throw new RuntimeException("Unable to call override validator!", e);
|
||||||
}
|
}
|
||||||
|
invalidateCache();
|
||||||
}
|
}
|
||||||
return overrideExists;
|
return overrideExists;
|
||||||
}
|
}
|
||||||
@@ -248,6 +252,7 @@ final class CompatConfig {
|
|||||||
addOverride(changeId, packageName, false);
|
addOverride(changeId, packageName, false);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
invalidateCache();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -277,6 +282,7 @@ final class CompatConfig {
|
|||||||
throw new RuntimeException("Unable to call override validator!", e);
|
throw new RuntimeException("Unable to call override validator!", e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
invalidateCache();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -396,4 +402,8 @@ final class CompatConfig {
|
|||||||
IOverrideValidator getOverrideValidator() {
|
IOverrideValidator getOverrideValidator() {
|
||||||
return mOverrideValidator;
|
return mOverrideValidator;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private void invalidateCache() {
|
||||||
|
ChangeIdStateCache.invalidate();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ import static org.mockito.Mockito.mock;
|
|||||||
import static org.mockito.Mockito.when;
|
import static org.mockito.Mockito.when;
|
||||||
import static org.testng.Assert.assertThrows;
|
import static org.testng.Assert.assertThrows;
|
||||||
|
|
||||||
|
import android.app.compat.ChangeIdStateCache;
|
||||||
import android.content.Context;
|
import android.content.Context;
|
||||||
import android.content.pm.ApplicationInfo;
|
import android.content.pm.ApplicationInfo;
|
||||||
import android.content.pm.PackageManager;
|
import android.content.pm.PackageManager;
|
||||||
@@ -74,6 +75,7 @@ public class CompatConfigTest {
|
|||||||
// Assume userdebug/eng non-final build
|
// Assume userdebug/eng non-final build
|
||||||
when(mBuildClassifier.isDebuggableBuild()).thenReturn(true);
|
when(mBuildClassifier.isDebuggableBuild()).thenReturn(true);
|
||||||
when(mBuildClassifier.isFinalBuild()).thenReturn(false);
|
when(mBuildClassifier.isFinalBuild()).thenReturn(false);
|
||||||
|
ChangeIdStateCache.disable();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
|||||||
@@ -57,6 +57,7 @@ public class PlatformCompatTest {
|
|||||||
@Before
|
@Before
|
||||||
public void setUp() throws Exception {
|
public void setUp() throws Exception {
|
||||||
MockitoAnnotations.initMocks(this);
|
MockitoAnnotations.initMocks(this);
|
||||||
|
android.app.compat.ChangeIdStateCache.disable();
|
||||||
when(mContext.getPackageManager()).thenReturn(mPackageManager);
|
when(mContext.getPackageManager()).thenReturn(mPackageManager);
|
||||||
when(mPackageManager.getPackageUid(eq(PACKAGE_NAME), eq(0))).thenThrow(
|
when(mPackageManager.getPackageUid(eq(PACKAGE_NAME), eq(0))).thenThrow(
|
||||||
new PackageManager.NameNotFoundException());
|
new PackageManager.NameNotFoundException());
|
||||||
|
|||||||
Reference in New Issue
Block a user