/* * 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 com.android.permissioncontroller.permission.data import android.app.ActivityManager import android.content.ComponentCallbacks2 import android.content.res.Configuration import androidx.annotation.GuardedBy import androidx.annotation.MainThread import com.android.permissioncontroller.PermissionControllerApplication import java.util.concurrent.TimeUnit /** * A generalize data repository, which carries a component callback which trims its data in response * to memory pressure */ abstract class DataRepository : ComponentCallbacks2 { /** * Deadlines for removal based on memory pressure. Live Data objects which have been inactive * for longer than the deadline will be removed. */ private val TIME_THRESHOLD_LAX_NANOS: Long = TimeUnit.NANOSECONDS.convert(5, TimeUnit.MINUTES) private val TIME_THRESHOLD_TIGHT_NANOS: Long = TimeUnit.NANOSECONDS.convert(1, TimeUnit.MINUTES) private val TIME_THRESHOLD_ALL_NANOS: Long = 0 protected val lock = Any() @GuardedBy("lock") protected val data = mutableMapOf() /** * Whether or not this data repository has been registered as a component callback yet */ private var registered = false /** * Whether or not this device is a low-RAM device. */ private var isLowMemoryDevice = PermissionControllerApplication.get().getSystemService( ActivityManager::class.java)?.isLowRamDevice ?: false init { PermissionControllerApplication.get().registerComponentCallbacks(this) } /** * Get a value from this repository, creating it if needed * * @param key The key associated with the desired Value * * @return The cached or newly created Value for the given Key */ operator fun get(key: K): V { synchronized(lock) { return data.getOrPut(key) { newValue(key) } } } /** * Generate a new value type from the given data * * @param key Information about this value object, used to instantiate it * * @return The generated Value */ @MainThread protected abstract fun newValue(key: K): V /** * Remove LiveData objects with no observer based on the severity of the memory pressure. If * this is a low RAM device, eject all caches always, including upon the UI closing. * * @param level The severity of the current memory pressure */ override fun onTrimMemory(level: Int) { if (isLowMemoryDevice) { trimInactiveData(TIME_THRESHOLD_ALL_NANOS) return } trimInactiveData(threshold = when (level) { ComponentCallbacks2.TRIM_MEMORY_BACKGROUND -> TIME_THRESHOLD_LAX_NANOS ComponentCallbacks2.TRIM_MEMORY_MODERATE -> TIME_THRESHOLD_TIGHT_NANOS ComponentCallbacks2.TRIM_MEMORY_COMPLETE -> TIME_THRESHOLD_ALL_NANOS ComponentCallbacks2.TRIM_MEMORY_RUNNING_MODERATE -> TIME_THRESHOLD_LAX_NANOS ComponentCallbacks2.TRIM_MEMORY_RUNNING_LOW -> TIME_THRESHOLD_TIGHT_NANOS ComponentCallbacks2.TRIM_MEMORY_RUNNING_CRITICAL -> TIME_THRESHOLD_ALL_NANOS else -> return }) } override fun onLowMemory() { onTrimMemory(ComponentCallbacks2.TRIM_MEMORY_COMPLETE) } override fun onConfigurationChanged(newConfig: Configuration) { // Do nothing, but required to override by interface } fun invalidateSingle(key: K) { synchronized(lock) { data.remove(key) } } private fun trimInactiveData(threshold: Long) { synchronized(lock) { data.keys.toList().forEach { key -> if (data[key]?.timeInactive?.let { it >= threshold } == true) { data.remove(key) } } } } /** * Interface which describes an object which can track how long it has been inactive, and if * it has any observers. */ interface InactiveTimekeeper { /** * Long value representing the time this object went inactive, which is read only on the * main thread, so does not cause race conditions. */ var timeWentInactive: Long? /** * Calculates the time since this object went inactive. * * @return The time since this object went inactive, or null if it is not inactive */ val timeInactive: Long? get() { val time = timeWentInactive ?: return null return System.nanoTime() - time } } } /** * A DataRepository where all values are contingent on the existence of a package. Supports * invalidating all values tied to a package. Expects key to be a pair or triple, with the package * name as the first value of the key. */ abstract class DataRepositoryForPackage : DataRepository() { /** * Invalidates every value with the packageName in the key. * * @param packageName The package to be invalidated */ fun invalidateAllForPackage(packageName: String) { synchronized(lock) { for (key in data.keys.toSet()) { if (key is Pair<*, *> || key is Triple<*, *, *> && key.first == packageName) { data.remove(key) } } } } } /** * A convenience to retrieve data from a repository with a composite key */ operator fun DataRepository, V>.get( k1: K1, k2: K2 ): V { return get(k1 to k2) } /** * A convenience to retrieve data from a repository with a composite key */ operator fun DataRepository, V>.get( k1: K1, k2: K2, k3: K3 ): V { return get(Triple(k1, k2, k3)) }