/*
 * Copyright (C) 2013 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 static android.app.ActivityThread.DEBUG_CONFIGURATION;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.content.pm.ActivityInfo;
import android.content.res.ApkAssets;
import android.content.res.AssetManager;
import android.content.res.CompatResources;
import android.content.res.CompatibilityInfo;
import android.content.res.Configuration;
import android.content.res.Resources;
import android.content.res.ResourcesImpl;
import android.content.res.ResourcesKey;
import android.hardware.display.DisplayManagerGlobal;
import android.os.IBinder;
import android.os.Trace;
import android.util.ArrayMap;
import android.util.DisplayMetrics;
import android.util.Log;
import android.util.LruCache;
import android.util.Pair;
import android.util.Slog;
import android.view.Display;
import android.view.DisplayAdjustments;

import com.android.internal.annotations.VisibleForTesting;
import com.android.internal.util.ArrayUtils;
import com.android.internal.util.IndentingPrintWriter;

import java.io.IOException;
import java.io.PrintWriter;
import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Objects;
import java.util.WeakHashMap;
import java.util.function.Predicate;

@hide
/** @hide */
public class ResourcesManager { static final String TAG = "ResourcesManager"; private static final boolean DEBUG = false; private static ResourcesManager sResourcesManager;
Predicate that returns true if a WeakReference is gc'ed.
/** * Predicate that returns true if a WeakReference is gc'ed. */
private static final Predicate<WeakReference<Resources>> sEmptyReferencePredicate = weakRef -> weakRef == null || weakRef.get() == null;
The global compatibility settings.
/** * The global compatibility settings. */
private CompatibilityInfo mResCompatibilityInfo;
The global configuration upon which all Resources are based. Multi-window Resources apply their overrides to this configuration.
/** * The global configuration upon which all Resources are based. Multi-window Resources * apply their overrides to this configuration. */
private final Configuration mResConfiguration = new Configuration();
A mapping of ResourceImpls and their configurations. These are heavy weight objects which should be reused as much as possible.
/** * A mapping of ResourceImpls and their configurations. These are heavy weight objects * which should be reused as much as possible. */
private final ArrayMap<ResourcesKey, WeakReference<ResourcesImpl>> mResourceImpls = new ArrayMap<>();
A list of Resource references that can be reused.
/** * A list of Resource references that can be reused. */
private final ArrayList<WeakReference<Resources>> mResourceReferences = new ArrayList<>(); private static class ApkKey { public final String path; public final boolean sharedLib; public final boolean overlay; ApkKey(String path, boolean sharedLib, boolean overlay) { this.path = path; this.sharedLib = sharedLib; this.overlay = overlay; } @Override public int hashCode() { int result = 1; result = 31 * result + this.path.hashCode(); result = 31 * result + Boolean.hashCode(this.sharedLib); result = 31 * result + Boolean.hashCode(this.overlay); return result; } @Override public boolean equals(Object obj) { if (!(obj instanceof ApkKey)) { return false; } ApkKey other = (ApkKey) obj; return this.path.equals(other.path) && this.sharedLib == other.sharedLib && this.overlay == other.overlay; } } private static final boolean ENABLE_APK_ASSETS_CACHE = false;
The ApkAssets we are caching and intend to hold strong references to.
/** * The ApkAssets we are caching and intend to hold strong references to. */
private final LruCache<ApkKey, ApkAssets> mLoadedApkAssets = (ENABLE_APK_ASSETS_CACHE) ? new LruCache<>(3) : null;
The ApkAssets that are being referenced in the wild that we can reuse, even if they aren't in our LRU cache. Bonus resources :)
/** * The ApkAssets that are being referenced in the wild that we can reuse, even if they aren't * in our LRU cache. Bonus resources :) */
private final ArrayMap<ApkKey, WeakReference<ApkAssets>> mCachedApkAssets = new ArrayMap<>();
Resources and base configuration override associated with an Activity.
/** * Resources and base configuration override associated with an Activity. */
private static class ActivityResources { public final Configuration overrideConfig = new Configuration(); public final ArrayList<WeakReference<Resources>> activityResources = new ArrayList<>(); }
Each Activity may has a base override configuration that is applied to each Resources object, which in turn may have their own override configuration specified.
/** * Each Activity may has a base override configuration that is applied to each Resources object, * which in turn may have their own override configuration specified. */
private final WeakHashMap<IBinder, ActivityResources> mActivityResourceReferences = new WeakHashMap<>();
A cache of DisplayId, DisplayAdjustments to Display.
/** * A cache of DisplayId, DisplayAdjustments to Display. */
private final ArrayMap<Pair<Integer, DisplayAdjustments>, WeakReference<Display>> mAdjustedDisplays = new ArrayMap<>(); public static ResourcesManager getInstance() { synchronized (ResourcesManager.class) { if (sResourcesManager == null) { sResourcesManager = new ResourcesManager(); } return sResourcesManager; } }
Invalidate and destroy any resources that reference content under the given filesystem path. Typically used when unmounting a storage device to try as hard as possible to release any open FDs.
/** * Invalidate and destroy any resources that reference content under the * given filesystem path. Typically used when unmounting a storage device to * try as hard as possible to release any open FDs. */
public void invalidatePath(String path) { synchronized (this) { int count = 0; for (int i = 0; i < mResourceImpls.size();) { final ResourcesKey key = mResourceImpls.keyAt(i); if (key.isPathReferenced(path)) { cleanupResourceImpl(key); count++; } else { i++; } } Log.i(TAG, "Invalidated " + count + " asset managers that referenced " + path); } } public Configuration getConfiguration() { synchronized (this) { return mResConfiguration; } } DisplayMetrics getDisplayMetrics() { return getDisplayMetrics(Display.DEFAULT_DISPLAY, DisplayAdjustments.DEFAULT_DISPLAY_ADJUSTMENTS); }
Protected so that tests can override and returns something a fixed value.
/** * Protected so that tests can override and returns something a fixed value. */
@VisibleForTesting protected @NonNull DisplayMetrics getDisplayMetrics(int displayId, DisplayAdjustments da) { DisplayMetrics dm = new DisplayMetrics(); final Display display = getAdjustedDisplay(displayId, da); if (display != null) { display.getMetrics(dm); } else { dm.setToDefaults(); } return dm; } private static void applyNonDefaultDisplayMetricsToConfiguration( @NonNull DisplayMetrics dm, @NonNull Configuration config) { config.touchscreen = Configuration.TOUCHSCREEN_NOTOUCH; config.densityDpi = dm.densityDpi; config.screenWidthDp = (int) (dm.widthPixels / dm.density); config.screenHeightDp = (int) (dm.heightPixels / dm.density); int sl = Configuration.resetScreenLayout(config.screenLayout); if (dm.widthPixels > dm.heightPixels) { config.orientation = Configuration.ORIENTATION_LANDSCAPE; config.screenLayout = Configuration.reduceScreenLayout(sl, config.screenWidthDp, config.screenHeightDp); } else { config.orientation = Configuration.ORIENTATION_PORTRAIT; config.screenLayout = Configuration.reduceScreenLayout(sl, config.screenHeightDp, config.screenWidthDp); } config.smallestScreenWidthDp = config.screenWidthDp; // assume screen does not rotate config.compatScreenWidthDp = config.screenWidthDp; config.compatScreenHeightDp = config.screenHeightDp; config.compatSmallestScreenWidthDp = config.smallestScreenWidthDp; } public boolean applyCompatConfigurationLocked(int displayDensity, @NonNull Configuration compatConfiguration) { if (mResCompatibilityInfo != null && !mResCompatibilityInfo.supportsScreen()) { mResCompatibilityInfo.applyToConfiguration(displayDensity, compatConfiguration); return true; } return false; }
Returns an adjusted Display object based on the inputs or null if display isn't available. This method is only used within ResourcesManager to calculate display metrics based on a set DisplayAdjustments. All other usages should instead call getAdjustedDisplay(int, Resources).
Params:
  • displayId – display Id.
  • displayAdjustments – display adjustments.
/** * Returns an adjusted {@link Display} object based on the inputs or null if display isn't * available. This method is only used within {@link ResourcesManager} to calculate display * metrics based on a set {@link DisplayAdjustments}. All other usages should instead call * {@link ResourcesManager#getAdjustedDisplay(int, Resources)}. * * @param displayId display Id. * @param displayAdjustments display adjustments. */
private Display getAdjustedDisplay(final int displayId, @Nullable DisplayAdjustments displayAdjustments) { final DisplayAdjustments displayAdjustmentsCopy = (displayAdjustments != null) ? new DisplayAdjustments(displayAdjustments) : new DisplayAdjustments(); final Pair<Integer, DisplayAdjustments> key = Pair.create(displayId, displayAdjustmentsCopy); synchronized (this) { WeakReference<Display> wd = mAdjustedDisplays.get(key); if (wd != null) { final Display display = wd.get(); if (display != null) { return display; } } final DisplayManagerGlobal dm = DisplayManagerGlobal.getInstance(); if (dm == null) { // may be null early in system startup return null; } final Display display = dm.getCompatibleDisplay(displayId, key.second); if (display != null) { mAdjustedDisplays.put(key, new WeakReference<>(display)); } return display; } }
Returns an adjusted Display object based on the inputs or null if display isn't available.
Params:
  • displayId – display Id.
  • resources – The Resources backing the display adjustments.
/** * Returns an adjusted {@link Display} object based on the inputs or null if display isn't * available. * * @param displayId display Id. * @param resources The {@link Resources} backing the display adjustments. */
public Display getAdjustedDisplay(final int displayId, Resources resources) { synchronized (this) { final DisplayManagerGlobal dm = DisplayManagerGlobal.getInstance(); if (dm == null) { // may be null early in system startup return null; } return dm.getCompatibleDisplay(displayId, resources); } } private void cleanupResourceImpl(ResourcesKey removedKey) { // Remove resource key to resource impl mapping and flush cache final ResourcesImpl res = mResourceImpls.remove(removedKey).get(); if (res != null) { res.flushLayoutCache(); } } private static String overlayPathToIdmapPath(String path) { return "/data/resource-cache/" + path.substring(1).replace('/', '@') + "@idmap"; } private @NonNull ApkAssets loadApkAssets(String path, boolean sharedLib, boolean overlay) throws IOException { final ApkKey newKey = new ApkKey(path, sharedLib, overlay); ApkAssets apkAssets = null; if (mLoadedApkAssets != null) { apkAssets = mLoadedApkAssets.get(newKey); if (apkAssets != null) { return apkAssets; } } // Optimistically check if this ApkAssets exists somewhere else. final WeakReference<ApkAssets> apkAssetsRef = mCachedApkAssets.get(newKey); if (apkAssetsRef != null) { apkAssets = apkAssetsRef.get(); if (apkAssets != null) { if (mLoadedApkAssets != null) { mLoadedApkAssets.put(newKey, apkAssets); } return apkAssets; } else { // Clean up the reference. mCachedApkAssets.remove(newKey); } } // We must load this from disk. if (overlay) { apkAssets = ApkAssets.loadOverlayFromPath(overlayPathToIdmapPath(path), false /*system*/); } else { apkAssets = ApkAssets.loadFromPath(path, false /*system*/, sharedLib); } if (mLoadedApkAssets != null) { mLoadedApkAssets.put(newKey, apkAssets); } mCachedApkAssets.put(newKey, new WeakReference<>(apkAssets)); return apkAssets; }
Creates an AssetManager from the paths within the ResourcesKey. This can be overridden in tests so as to avoid creating a real AssetManager with real APK paths.
Params:
  • key – The key containing the resource paths to add to the AssetManager.
Returns:a new AssetManager.
/** * Creates an AssetManager from the paths within the ResourcesKey. * * This can be overridden in tests so as to avoid creating a real AssetManager with * real APK paths. * @param key The key containing the resource paths to add to the AssetManager. * @return a new AssetManager. */
@VisibleForTesting protected @Nullable AssetManager createAssetManager(@NonNull final ResourcesKey key) { final AssetManager.Builder builder = new AssetManager.Builder(); // resDir can be null if the 'android' package is creating a new Resources object. // This is fine, since each AssetManager automatically loads the 'android' package // already. if (key.mResDir != null) { try { builder.addApkAssets(loadApkAssets(key.mResDir, false /*sharedLib*/, false /*overlay*/)); } catch (IOException e) { Log.e(TAG, "failed to add asset path " + key.mResDir); return null; } } if (key.mSplitResDirs != null) { for (final String splitResDir : key.mSplitResDirs) { try { builder.addApkAssets(loadApkAssets(splitResDir, false /*sharedLib*/, false /*overlay*/)); } catch (IOException e) { Log.e(TAG, "failed to add split asset path " + splitResDir); return null; } } } if (key.mOverlayDirs != null) { for (final String idmapPath : key.mOverlayDirs) { try { builder.addApkAssets(loadApkAssets(idmapPath, false /*sharedLib*/, true /*overlay*/)); } catch (IOException e) { Log.w(TAG, "failed to add overlay path " + idmapPath); // continue. } } } if (key.mLibDirs != null) { for (final String libDir : key.mLibDirs) { if (libDir.endsWith(".apk")) { // Avoid opening files we know do not have resources, // like code-only .jar files. try { builder.addApkAssets(loadApkAssets(libDir, true /*sharedLib*/, false /*overlay*/)); } catch (IOException e) { Log.w(TAG, "Asset path '" + libDir + "' does not exist or contains no resources."); // continue. } } } } return builder.build(); } private static <T> int countLiveReferences(Collection<WeakReference<T>> collection) { int count = 0; for (WeakReference<T> ref : collection) { final T value = ref != null ? ref.get() : null; if (value != null) { count++; } } return count; }
@hide
/** * @hide */
public void dump(String prefix, PrintWriter printWriter) { synchronized (this) { IndentingPrintWriter pw = new IndentingPrintWriter(printWriter, " "); for (int i = 0; i < prefix.length() / 2; i++) { pw.increaseIndent(); } pw.println("ResourcesManager:"); pw.increaseIndent(); if (mLoadedApkAssets != null) { pw.print("cached apks: total="); pw.print(mLoadedApkAssets.size()); pw.print(" created="); pw.print(mLoadedApkAssets.createCount()); pw.print(" evicted="); pw.print(mLoadedApkAssets.evictionCount()); pw.print(" hit="); pw.print(mLoadedApkAssets.hitCount()); pw.print(" miss="); pw.print(mLoadedApkAssets.missCount()); pw.print(" max="); pw.print(mLoadedApkAssets.maxSize()); } else { pw.print("cached apks: 0 [cache disabled]"); } pw.println(); pw.print("total apks: "); pw.println(countLiveReferences(mCachedApkAssets.values())); pw.print("resources: "); int references = countLiveReferences(mResourceReferences); for (ActivityResources activityResources : mActivityResourceReferences.values()) { references += countLiveReferences(activityResources.activityResources); } pw.println(references); pw.print("resource impls: "); pw.println(countLiveReferences(mResourceImpls.values())); } } private Configuration generateConfig(@NonNull ResourcesKey key, @NonNull DisplayMetrics dm) { Configuration config; final boolean isDefaultDisplay = (key.mDisplayId == Display.DEFAULT_DISPLAY); final boolean hasOverrideConfig = key.hasOverrideConfiguration(); if (!isDefaultDisplay || hasOverrideConfig) { config = new Configuration(getConfiguration()); if (!isDefaultDisplay) { applyNonDefaultDisplayMetricsToConfiguration(dm, config); } if (hasOverrideConfig) { config.updateFrom(key.mOverrideConfiguration); if (DEBUG) Slog.v(TAG, "Applied overrideConfig=" + key.mOverrideConfiguration); } } else { config = getConfiguration(); } return config; } private @Nullable ResourcesImpl createResourcesImpl(@NonNull ResourcesKey key) { final DisplayAdjustments daj = new DisplayAdjustments(key.mOverrideConfiguration); daj.setCompatibilityInfo(key.mCompatInfo); final AssetManager assets = createAssetManager(key); if (assets == null) { return null; } final DisplayMetrics dm = getDisplayMetrics(key.mDisplayId, daj); final Configuration config = generateConfig(key, dm); final ResourcesImpl impl = new ResourcesImpl(assets, dm, config, daj); if (DEBUG) { Slog.d(TAG, "- creating impl=" + impl + " with key: " + key); } return impl; }
Finds a cached ResourcesImpl object that matches the given ResourcesKey.
Params:
  • key – The key to match.
Returns:a ResourcesImpl if the key matches a cache entry, null otherwise.
/** * Finds a cached ResourcesImpl object that matches the given ResourcesKey. * * @param key The key to match. * @return a ResourcesImpl if the key matches a cache entry, null otherwise. */
private @Nullable ResourcesImpl findResourcesImplForKeyLocked(@NonNull ResourcesKey key) { WeakReference<ResourcesImpl> weakImplRef = mResourceImpls.get(key); ResourcesImpl impl = weakImplRef != null ? weakImplRef.get() : null; if (impl != null && impl.getAssets().isUpToDate()) { return impl; } return null; }
Finds a cached ResourcesImpl object that matches the given ResourcesKey, or creates a new one and caches it for future use.
Params:
  • key – The key to match.
Returns:a ResourcesImpl object matching the key.
/** * Finds a cached ResourcesImpl object that matches the given ResourcesKey, or * creates a new one and caches it for future use. * @param key The key to match. * @return a ResourcesImpl object matching the key. */
private @Nullable ResourcesImpl findOrCreateResourcesImplForKeyLocked( @NonNull ResourcesKey key) { ResourcesImpl impl = findResourcesImplForKeyLocked(key); if (impl == null) { impl = createResourcesImpl(key); if (impl != null) { mResourceImpls.put(key, new WeakReference<>(impl)); } } return impl; }
Find the ResourcesKey that this ResourcesImpl object is associated with.
Returns:the ResourcesKey or null if none was found.
/** * Find the ResourcesKey that this ResourcesImpl object is associated with. * @return the ResourcesKey or null if none was found. */
private @Nullable ResourcesKey findKeyForResourceImplLocked( @NonNull ResourcesImpl resourceImpl) { final int refCount = mResourceImpls.size(); for (int i = 0; i < refCount; i++) { WeakReference<ResourcesImpl> weakImplRef = mResourceImpls.valueAt(i); ResourcesImpl impl = weakImplRef != null ? weakImplRef.get() : null; if (impl != null && resourceImpl == impl) { return mResourceImpls.keyAt(i); } } return null; }
Check if activity resources have same override config as the provided on.
Params:
  • activityToken – The Activity that resources should be associated with.
  • overrideConfig – The override configuration to be checked for equality with.
Returns:true if activity resources override config matches the provided one or they are both null, false otherwise.
/** * Check if activity resources have same override config as the provided on. * @param activityToken The Activity that resources should be associated with. * @param overrideConfig The override configuration to be checked for equality with. * @return true if activity resources override config matches the provided one or they are both * null, false otherwise. */
boolean isSameResourcesOverrideConfig(@Nullable IBinder activityToken, @Nullable Configuration overrideConfig) { synchronized (this) { final ActivityResources activityResources = activityToken != null ? mActivityResourceReferences.get(activityToken) : null; if (activityResources == null) { return overrideConfig == null; } else { // The two configurations must either be equal or publicly equivalent to be // considered the same. return Objects.equals(activityResources.overrideConfig, overrideConfig) || (overrideConfig != null && activityResources.overrideConfig != null && 0 == overrideConfig.diffPublicOnly( activityResources.overrideConfig)); } } } private ActivityResources getOrCreateActivityResourcesStructLocked( @NonNull IBinder activityToken) { ActivityResources activityResources = mActivityResourceReferences.get(activityToken); if (activityResources == null) { activityResources = new ActivityResources(); mActivityResourceReferences.put(activityToken, activityResources); } return activityResources; }
Gets an existing Resources object tied to this Activity, or creates one if it doesn't exist or the class loader is different.
/** * Gets an existing Resources object tied to this Activity, or creates one if it doesn't exist * or the class loader is different. */
private @NonNull Resources getOrCreateResourcesForActivityLocked(@NonNull IBinder activityToken, @NonNull ClassLoader classLoader, @NonNull ResourcesImpl impl, @NonNull CompatibilityInfo compatInfo) { final ActivityResources activityResources = getOrCreateActivityResourcesStructLocked( activityToken); final int refCount = activityResources.activityResources.size(); for (int i = 0; i < refCount; i++) { WeakReference<Resources> weakResourceRef = activityResources.activityResources.get(i); Resources resources = weakResourceRef.get(); if (resources != null && Objects.equals(resources.getClassLoader(), classLoader) && resources.getImpl() == impl) { if (DEBUG) { Slog.d(TAG, "- using existing ref=" + resources); } return resources; } } Resources resources = compatInfo.needsCompatResources() ? new CompatResources(classLoader) : new Resources(classLoader); resources.setImpl(impl); activityResources.activityResources.add(new WeakReference<>(resources)); if (DEBUG) { Slog.d(TAG, "- creating new ref=" + resources); Slog.d(TAG, "- setting ref=" + resources + " with impl=" + impl); } return resources; }
Gets an existing Resources object if the class loader and ResourcesImpl are the same, otherwise creates a new Resources object.
/** * Gets an existing Resources object if the class loader and ResourcesImpl are the same, * otherwise creates a new Resources object. */
private @NonNull Resources getOrCreateResourcesLocked(@NonNull ClassLoader classLoader, @NonNull ResourcesImpl impl, @NonNull CompatibilityInfo compatInfo) { // Find an existing Resources that has this ResourcesImpl set. final int refCount = mResourceReferences.size(); for (int i = 0; i < refCount; i++) { WeakReference<Resources> weakResourceRef = mResourceReferences.get(i); Resources resources = weakResourceRef.get(); if (resources != null && Objects.equals(resources.getClassLoader(), classLoader) && resources.getImpl() == impl) { if (DEBUG) { Slog.d(TAG, "- using existing ref=" + resources); } return resources; } } // Create a new Resources reference and use the existing ResourcesImpl object. Resources resources = compatInfo.needsCompatResources() ? new CompatResources(classLoader) : new Resources(classLoader); resources.setImpl(impl); mResourceReferences.add(new WeakReference<>(resources)); if (DEBUG) { Slog.d(TAG, "- creating new ref=" + resources); Slog.d(TAG, "- setting ref=" + resources + " with impl=" + impl); } return resources; }
Creates base resources for an Activity. Calls to getResources(IBinder, String, String[], String[], String[], int, Configuration, CompatibilityInfo, ClassLoader) with the same activityToken will have their override configurations merged with the one specified here.
Params:
  • activityToken – Represents an Activity.
  • resDir – The base resource path. Can be null (only framework resources will be loaded).
  • splitResDirs – An array of split resource paths. Can be null.
  • overlayDirs – An array of overlay paths. Can be null.
  • libDirs – An array of resource library paths. Can be null.
  • displayId – The ID of the display for which to create the resources.
  • overrideConfig – The configuration to apply on top of the base configuration. Can be null. This provides the base override for this Activity.
  • compatInfo – The compatibility settings to use. Cannot be null. A default to use is CompatibilityInfo.DEFAULT_COMPATIBILITY_INFO.
  • classLoader – The class loader to use when inflating Resources. If null, the ClassLoader.getSystemClassLoader() is used.
Returns:a Resources object from which to access resources.
/** * Creates base resources for an Activity. Calls to * {@link #getResources(IBinder, String, String[], String[], String[], int, Configuration, * CompatibilityInfo, ClassLoader)} with the same activityToken will have their override * configurations merged with the one specified here. * * @param activityToken Represents an Activity. * @param resDir The base resource path. Can be null (only framework resources will be loaded). * @param splitResDirs An array of split resource paths. Can be null. * @param overlayDirs An array of overlay paths. Can be null. * @param libDirs An array of resource library paths. Can be null. * @param displayId The ID of the display for which to create the resources. * @param overrideConfig The configuration to apply on top of the base configuration. Can be * null. This provides the base override for this Activity. * @param compatInfo The compatibility settings to use. Cannot be null. A default to use is * {@link CompatibilityInfo#DEFAULT_COMPATIBILITY_INFO}. * @param classLoader The class loader to use when inflating Resources. If null, the * {@link ClassLoader#getSystemClassLoader()} is used. * @return a Resources object from which to access resources. */
public @Nullable Resources createBaseActivityResources(@NonNull IBinder activityToken, @Nullable String resDir, @Nullable String[] splitResDirs, @Nullable String[] overlayDirs, @Nullable String[] libDirs, int displayId, @Nullable Configuration overrideConfig, @NonNull CompatibilityInfo compatInfo, @Nullable ClassLoader classLoader) { try { Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, "ResourcesManager#createBaseActivityResources"); final ResourcesKey key = new ResourcesKey( resDir, splitResDirs, overlayDirs, libDirs, displayId, overrideConfig != null ? new Configuration(overrideConfig) : null, // Copy compatInfo); classLoader = classLoader != null ? classLoader : ClassLoader.getSystemClassLoader(); if (DEBUG) { Slog.d(TAG, "createBaseActivityResources activity=" + activityToken + " with key=" + key); } synchronized (this) { // Force the creation of an ActivityResourcesStruct. getOrCreateActivityResourcesStructLocked(activityToken); } // Update any existing Activity Resources references. updateResourcesForActivity(activityToken, overrideConfig, displayId, false /* movedToDifferentDisplay */); // Now request an actual Resources object. return getOrCreateResources(activityToken, key, classLoader); } finally { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); } }
Gets an existing Resources object set with a ResourcesImpl object matching the given key, or creates one if it doesn't exist.
Params:
  • activityToken – The Activity this Resources object should be associated with.
  • key – The key describing the parameters of the ResourcesImpl object.
  • classLoader – The classloader to use for the Resources object. If null, ClassLoader.getSystemClassLoader() is used.
Returns:A Resources object that gets updated when applyConfigurationToResourcesLocked(Configuration, CompatibilityInfo) is called.
/** * Gets an existing Resources object set with a ResourcesImpl object matching the given key, * or creates one if it doesn't exist. * * @param activityToken The Activity this Resources object should be associated with. * @param key The key describing the parameters of the ResourcesImpl object. * @param classLoader The classloader to use for the Resources object. * If null, {@link ClassLoader#getSystemClassLoader()} is used. * @return A Resources object that gets updated when * {@link #applyConfigurationToResourcesLocked(Configuration, CompatibilityInfo)} * is called. */
private @Nullable Resources getOrCreateResources(@Nullable IBinder activityToken, @NonNull ResourcesKey key, @NonNull ClassLoader classLoader) { synchronized (this) { if (DEBUG) { Throwable here = new Throwable(); here.fillInStackTrace(); Slog.w(TAG, "!! Get resources for activity=" + activityToken + " key=" + key, here); } if (activityToken != null) { final ActivityResources activityResources = getOrCreateActivityResourcesStructLocked(activityToken); // Clean up any dead references so they don't pile up. ArrayUtils.unstableRemoveIf(activityResources.activityResources, sEmptyReferencePredicate); // Rebase the key's override config on top of the Activity's base override. if (key.hasOverrideConfiguration() && !activityResources.overrideConfig.equals(Configuration.EMPTY)) { final Configuration temp = new Configuration(activityResources.overrideConfig); temp.updateFrom(key.mOverrideConfiguration); key.mOverrideConfiguration.setTo(temp); } ResourcesImpl resourcesImpl = findResourcesImplForKeyLocked(key); if (resourcesImpl != null) { if (DEBUG) { Slog.d(TAG, "- using existing impl=" + resourcesImpl); } return getOrCreateResourcesForActivityLocked(activityToken, classLoader, resourcesImpl, key.mCompatInfo); } // We will create the ResourcesImpl object outside of holding this lock. } else { // Clean up any dead references so they don't pile up. ArrayUtils.unstableRemoveIf(mResourceReferences, sEmptyReferencePredicate); // Not tied to an Activity, find a shared Resources that has the right ResourcesImpl ResourcesImpl resourcesImpl = findResourcesImplForKeyLocked(key); if (resourcesImpl != null) { if (DEBUG) { Slog.d(TAG, "- using existing impl=" + resourcesImpl); } return getOrCreateResourcesLocked(classLoader, resourcesImpl, key.mCompatInfo); } // We will create the ResourcesImpl object outside of holding this lock. } // If we're here, we didn't find a suitable ResourcesImpl to use, so create one now. ResourcesImpl resourcesImpl = createResourcesImpl(key); if (resourcesImpl == null) { return null; } // Add this ResourcesImpl to the cache. mResourceImpls.put(key, new WeakReference<>(resourcesImpl)); final Resources resources; if (activityToken != null) { resources = getOrCreateResourcesForActivityLocked(activityToken, classLoader, resourcesImpl, key.mCompatInfo); } else { resources = getOrCreateResourcesLocked(classLoader, resourcesImpl, key.mCompatInfo); } return resources; } }
Gets or creates a new Resources object associated with the IBinder token. References returned by this method live as long as the Activity, meaning they can be cached and used by the Activity even after a configuration change. If any other parameter is changed (resDir, splitResDirs, overrideConfig) for a given Activity, the same Resources object is updated and handed back to the caller. However, changing the class loader will result in a new Resources object.

If activityToken is null, a cached Resources object will be returned if it matches the input parameters. Otherwise a new Resources object that satisfies these parameters is returned.
Params:
  • activityToken – Represents an Activity. If null, global resources are assumed.
  • resDir – The base resource path. Can be null (only framework resources will be loaded).
  • splitResDirs – An array of split resource paths. Can be null.
  • overlayDirs – An array of overlay paths. Can be null.
  • libDirs – An array of resource library paths. Can be null.
  • displayId – The ID of the display for which to create the resources.
  • overrideConfig – The configuration to apply on top of the base configuration. Can be null. Mostly used with Activities that are in multi-window which may override width and height properties from the base config.
  • compatInfo – The compatibility settings to use. Cannot be null. A default to use is CompatibilityInfo.DEFAULT_COMPATIBILITY_INFO.
  • classLoader – The class loader to use when inflating Resources. If null, the ClassLoader.getSystemClassLoader() is used.
Returns:a Resources object from which to access resources.
/** * Gets or creates a new Resources object associated with the IBinder token. References returned * by this method live as long as the Activity, meaning they can be cached and used by the * Activity even after a configuration change. If any other parameter is changed * (resDir, splitResDirs, overrideConfig) for a given Activity, the same Resources object * is updated and handed back to the caller. However, changing the class loader will result in a * new Resources object. * <p/> * If activityToken is null, a cached Resources object will be returned if it matches the * input parameters. Otherwise a new Resources object that satisfies these parameters is * returned. * * @param activityToken Represents an Activity. If null, global resources are assumed. * @param resDir The base resource path. Can be null (only framework resources will be loaded). * @param splitResDirs An array of split resource paths. Can be null. * @param overlayDirs An array of overlay paths. Can be null. * @param libDirs An array of resource library paths. Can be null. * @param displayId The ID of the display for which to create the resources. * @param overrideConfig The configuration to apply on top of the base configuration. Can be * null. Mostly used with Activities that are in multi-window which may override width and * height properties from the base config. * @param compatInfo The compatibility settings to use. Cannot be null. A default to use is * {@link CompatibilityInfo#DEFAULT_COMPATIBILITY_INFO}. * @param classLoader The class loader to use when inflating Resources. If null, the * {@link ClassLoader#getSystemClassLoader()} is used. * @return a Resources object from which to access resources. */
public @Nullable Resources getResources(@Nullable IBinder activityToken, @Nullable String resDir, @Nullable String[] splitResDirs, @Nullable String[] overlayDirs, @Nullable String[] libDirs, int displayId, @Nullable Configuration overrideConfig, @NonNull CompatibilityInfo compatInfo, @Nullable ClassLoader classLoader) { try { Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, "ResourcesManager#getResources"); final ResourcesKey key = new ResourcesKey( resDir, splitResDirs, overlayDirs, libDirs, displayId, overrideConfig != null ? new Configuration(overrideConfig) : null, // Copy compatInfo); classLoader = classLoader != null ? classLoader : ClassLoader.getSystemClassLoader(); return getOrCreateResources(activityToken, key, classLoader); } finally { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); } }
Updates an Activity's Resources object with overrideConfig. The Resources object that was previously returned by getResources(IBinder, String, String[], String[], String[], int, Configuration, CompatibilityInfo, ClassLoader) is still valid and will have the updated configuration.
Params:
  • activityToken – The Activity token.
  • overrideConfig – The configuration override to update.
  • displayId – Id of the display where activity currently resides.
  • movedToDifferentDisplay – Indicates if the activity was moved to different display.
/** * Updates an Activity's Resources object with overrideConfig. The Resources object * that was previously returned by * {@link #getResources(IBinder, String, String[], String[], String[], int, Configuration, * CompatibilityInfo, ClassLoader)} is * still valid and will have the updated configuration. * @param activityToken The Activity token. * @param overrideConfig The configuration override to update. * @param displayId Id of the display where activity currently resides. * @param movedToDifferentDisplay Indicates if the activity was moved to different display. */
public void updateResourcesForActivity(@NonNull IBinder activityToken, @Nullable Configuration overrideConfig, int displayId, boolean movedToDifferentDisplay) { try { Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, "ResourcesManager#updateResourcesForActivity"); synchronized (this) { final ActivityResources activityResources = getOrCreateActivityResourcesStructLocked(activityToken); if (Objects.equals(activityResources.overrideConfig, overrideConfig) && !movedToDifferentDisplay) { // They are the same and no change of display id, no work to do. return; } // Grab a copy of the old configuration so we can create the delta's of each // Resources object associated with this Activity. final Configuration oldConfig = new Configuration(activityResources.overrideConfig); // Update the Activity's base override. if (overrideConfig != null) { activityResources.overrideConfig.setTo(overrideConfig); } else { activityResources.overrideConfig.unset(); } if (DEBUG) { Throwable here = new Throwable(); here.fillInStackTrace(); Slog.d(TAG, "updating resources override for activity=" + activityToken + " from oldConfig=" + Configuration.resourceQualifierString(oldConfig) + " to newConfig=" + Configuration.resourceQualifierString( activityResources.overrideConfig) + " displayId=" + displayId, here); } final boolean activityHasOverrideConfig = !activityResources.overrideConfig.equals(Configuration.EMPTY); // Rebase each Resources associated with this Activity. final int refCount = activityResources.activityResources.size(); for (int i = 0; i < refCount; i++) { WeakReference<Resources> weakResRef = activityResources.activityResources.get( i); Resources resources = weakResRef.get(); if (resources == null) { continue; } // Extract the ResourcesKey that was last used to create the Resources for this // activity. final ResourcesKey oldKey = findKeyForResourceImplLocked(resources.getImpl()); if (oldKey == null) { Slog.e(TAG, "can't find ResourcesKey for resources impl=" + resources.getImpl()); continue; } // Build the new override configuration for this ResourcesKey. final Configuration rebasedOverrideConfig = new Configuration(); if (overrideConfig != null) { rebasedOverrideConfig.setTo(overrideConfig); } if (activityHasOverrideConfig && oldKey.hasOverrideConfiguration()) { // Generate a delta between the old base Activity override configuration and // the actual final override configuration that was used to figure out the // real delta this Resources object wanted. Configuration overrideOverrideConfig = Configuration.generateDelta( oldConfig, oldKey.mOverrideConfiguration); rebasedOverrideConfig.updateFrom(overrideOverrideConfig); } // Create the new ResourcesKey with the rebased override config. final ResourcesKey newKey = new ResourcesKey(oldKey.mResDir, oldKey.mSplitResDirs, oldKey.mOverlayDirs, oldKey.mLibDirs, displayId, rebasedOverrideConfig, oldKey.mCompatInfo); if (DEBUG) { Slog.d(TAG, "rebasing ref=" + resources + " from oldKey=" + oldKey + " to newKey=" + newKey + ", displayId=" + displayId); } ResourcesImpl resourcesImpl = findResourcesImplForKeyLocked(newKey); if (resourcesImpl == null) { resourcesImpl = createResourcesImpl(newKey); if (resourcesImpl != null) { mResourceImpls.put(newKey, new WeakReference<>(resourcesImpl)); } } if (resourcesImpl != null && resourcesImpl != resources.getImpl()) { // Set the ResourcesImpl, updating it for all users of this Resources // object. resources.setImpl(resourcesImpl); } } } } finally { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); } } public final boolean applyConfigurationToResourcesLocked(@NonNull Configuration config, @Nullable CompatibilityInfo compat) { try { Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, "ResourcesManager#applyConfigurationToResourcesLocked"); if (!mResConfiguration.isOtherSeqNewer(config) && compat == null) { if (DEBUG || DEBUG_CONFIGURATION) Slog.v(TAG, "Skipping new config: curSeq=" + mResConfiguration.seq + ", newSeq=" + config.seq); return false; } int changes = mResConfiguration.updateFrom(config); // Things might have changed in display manager, so clear the cached displays. mAdjustedDisplays.clear(); DisplayMetrics defaultDisplayMetrics = getDisplayMetrics(); if (compat != null && (mResCompatibilityInfo == null || !mResCompatibilityInfo.equals(compat))) { mResCompatibilityInfo = compat; changes |= ActivityInfo.CONFIG_SCREEN_LAYOUT | ActivityInfo.CONFIG_SCREEN_SIZE | ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE; } Resources.updateSystemConfiguration(config, defaultDisplayMetrics, compat); ApplicationPackageManager.configurationChanged(); //Slog.i(TAG, "Configuration changed in " + currentPackageName()); Configuration tmpConfig = null; for (int i = mResourceImpls.size() - 1; i >= 0; i--) { ResourcesKey key = mResourceImpls.keyAt(i); WeakReference<ResourcesImpl> weakImplRef = mResourceImpls.valueAt(i); ResourcesImpl r = weakImplRef != null ? weakImplRef.get() : null; if (r != null) { if (DEBUG || DEBUG_CONFIGURATION) Slog.v(TAG, "Changing resources " + r + " config to: " + config); int displayId = key.mDisplayId; boolean isDefaultDisplay = (displayId == Display.DEFAULT_DISPLAY); DisplayMetrics dm = defaultDisplayMetrics; final boolean hasOverrideConfiguration = key.hasOverrideConfiguration(); if (!isDefaultDisplay || hasOverrideConfiguration) { if (tmpConfig == null) { tmpConfig = new Configuration(); } tmpConfig.setTo(config); // Get new DisplayMetrics based on the DisplayAdjustments given // to the ResourcesImpl. Update a copy if the CompatibilityInfo // changed, because the ResourcesImpl object will handle the // update internally. DisplayAdjustments daj = r.getDisplayAdjustments(); if (compat != null) { daj = new DisplayAdjustments(daj); daj.setCompatibilityInfo(compat); } dm = getDisplayMetrics(displayId, daj); if (!isDefaultDisplay) { applyNonDefaultDisplayMetricsToConfiguration(dm, tmpConfig); } if (hasOverrideConfiguration) { tmpConfig.updateFrom(key.mOverrideConfiguration); } r.updateConfiguration(tmpConfig, dm, compat); } else { r.updateConfiguration(config, dm, compat); } //Slog.i(TAG, "Updated app resources " + v.getKey() // + " " + r + ": " + r.getConfiguration()); } else { //Slog.i(TAG, "Removing old resources " + v.getKey()); mResourceImpls.removeAt(i); } } return changes != 0; } finally { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); } }
Appends the library asset path to any ResourcesImpl object that contains the main assetPath.
Params:
  • assetPath – The main asset path for which to add the library asset path.
  • libAsset – The library asset path to add.
/** * Appends the library asset path to any ResourcesImpl object that contains the main * assetPath. * @param assetPath The main asset path for which to add the library asset path. * @param libAsset The library asset path to add. */
public void appendLibAssetForMainAssetPath(String assetPath, String libAsset) { synchronized (this) { // Record which ResourcesImpl need updating // (and what ResourcesKey they should update to). final ArrayMap<ResourcesImpl, ResourcesKey> updatedResourceKeys = new ArrayMap<>(); final int implCount = mResourceImpls.size(); for (int i = 0; i < implCount; i++) { final ResourcesKey key = mResourceImpls.keyAt(i); final WeakReference<ResourcesImpl> weakImplRef = mResourceImpls.valueAt(i); final ResourcesImpl impl = weakImplRef != null ? weakImplRef.get() : null; if (impl != null && Objects.equals(key.mResDir, assetPath)) { if (!ArrayUtils.contains(key.mLibDirs, libAsset)) { final int newLibAssetCount = 1 + (key.mLibDirs != null ? key.mLibDirs.length : 0); final String[] newLibAssets = new String[newLibAssetCount]; if (key.mLibDirs != null) { System.arraycopy(key.mLibDirs, 0, newLibAssets, 0, key.mLibDirs.length); } newLibAssets[newLibAssetCount - 1] = libAsset; updatedResourceKeys.put(impl, new ResourcesKey( key.mResDir, key.mSplitResDirs, key.mOverlayDirs, newLibAssets, key.mDisplayId, key.mOverrideConfiguration, key.mCompatInfo)); } } } redirectResourcesToNewImplLocked(updatedResourceKeys); } } // TODO(adamlesinski): Make this accept more than just overlay directories. final void applyNewResourceDirsLocked(@NonNull final String baseCodePath, @Nullable final String[] newResourceDirs) { try { Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, "ResourcesManager#applyNewResourceDirsLocked"); final ArrayMap<ResourcesImpl, ResourcesKey> updatedResourceKeys = new ArrayMap<>(); final int implCount = mResourceImpls.size(); for (int i = 0; i < implCount; i++) { final ResourcesKey key = mResourceImpls.keyAt(i); final WeakReference<ResourcesImpl> weakImplRef = mResourceImpls.valueAt(i); final ResourcesImpl impl = weakImplRef != null ? weakImplRef.get() : null; if (impl != null && (key.mResDir == null || key.mResDir.equals(baseCodePath))) { updatedResourceKeys.put(impl, new ResourcesKey( key.mResDir, key.mSplitResDirs, newResourceDirs, key.mLibDirs, key.mDisplayId, key.mOverrideConfiguration, key.mCompatInfo)); } } redirectResourcesToNewImplLocked(updatedResourceKeys); } finally { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); } } private void redirectResourcesToNewImplLocked( @NonNull final ArrayMap<ResourcesImpl, ResourcesKey> updatedResourceKeys) { // Bail early if there is no work to do. if (updatedResourceKeys.isEmpty()) { return; } // Update any references to ResourcesImpl that require reloading. final int resourcesCount = mResourceReferences.size(); for (int i = 0; i < resourcesCount; i++) { final WeakReference<Resources> ref = mResourceReferences.get(i); final Resources r = ref != null ? ref.get() : null; if (r != null) { final ResourcesKey key = updatedResourceKeys.get(r.getImpl()); if (key != null) { final ResourcesImpl impl = findOrCreateResourcesImplForKeyLocked(key); if (impl == null) { throw new Resources.NotFoundException("failed to redirect ResourcesImpl"); } r.setImpl(impl); } } } // Update any references to ResourcesImpl that require reloading for each Activity. for (ActivityResources activityResources : mActivityResourceReferences.values()) { final int resCount = activityResources.activityResources.size(); for (int i = 0; i < resCount; i++) { final WeakReference<Resources> ref = activityResources.activityResources.get(i); final Resources r = ref != null ? ref.get() : null; if (r != null) { final ResourcesKey key = updatedResourceKeys.get(r.getImpl()); if (key != null) { final ResourcesImpl impl = findOrCreateResourcesImplForKeyLocked(key); if (impl == null) { throw new Resources.NotFoundException( "failed to redirect ResourcesImpl"); } r.setImpl(impl); } } } } } }