Merge "[Launcher Jank] Avoid SimpleBroadcastReceiver making binder calls on main thread" into main

This commit is contained in:
Fengjiang Li
2024-06-24 21:00:41 +00:00
committed by Android (Google) Code Review
13 changed files with 106 additions and 49 deletions
@@ -205,6 +205,7 @@ public class QuickstepModelDelegate extends ModelDelegate {
mActive = true;
}
@WorkerThread
@Override
public void workspaceLoadComplete() {
super.workspaceLoadComplete();
@@ -323,6 +324,7 @@ public class QuickstepModelDelegate extends ModelDelegate {
}
}
@WorkerThread
@Override
public void destroy() {
super.destroy();
@@ -111,6 +111,7 @@ public final class WellbeingModel implements SafeCloseable {
mWorkerHandler.post(this::initializeInBackground);
}
@WorkerThread
private void initializeInBackground() {
if (!TextUtils.isEmpty(mWellbeingProviderPkg)) {
mContext.registerReceiver(
@@ -134,8 +135,8 @@ public final class WellbeingModel implements SafeCloseable {
public void close() {
if (!TextUtils.isEmpty(mWellbeingProviderPkg)) {
mWorkerHandler.post(() -> {
mWellbeingAppChangeReceiver.unregisterReceiverSafely(mContext);
mAppAddRemoveReceiver.unregisterReceiverSafely(mContext);
mWellbeingAppChangeReceiver.unregisterReceiverSafelySync(mContext);
mAppAddRemoveReceiver.unregisterReceiverSafelySync(mContext);
mContext.getContentResolver().unregisterContentObserver(mContentObserver);
});
}
@@ -304,7 +304,7 @@ public class TaskbarManager {
.register(NAV_BAR_KIDS_MODE, mOnSettingsChangeListener);
Log.d(TASKBAR_NOT_DESTROYED_TAG, "registering component callbacks from constructor.");
mContext.registerComponentCallbacks(mComponentCallbacks);
mShutdownReceiver.register(mContext, Intent.ACTION_SHUTDOWN);
mShutdownReceiver.registerAsync(mContext, Intent.ACTION_SHUTDOWN);
UI_HELPER_EXECUTOR.execute(() -> {
mSharedState.taskbarSystemActionPendingIntent = PendingIntent.getBroadcast(
mContext,
@@ -582,8 +582,7 @@ public class TaskbarManager {
public void destroy() {
debugWhyTaskbarNotDestroyed("TaskbarManager#destroy()");
removeActivityCallbacksAndListeners();
UI_HELPER_EXECUTOR.execute(
() -> mTaskbarBroadcastReceiver.unregisterReceiverSafely(mContext));
mTaskbarBroadcastReceiver.unregisterReceiverSafelyAsync(mContext);
destroyExistingTaskbar();
removeTaskbarRootViewFromWindow();
if (mUserUnlocked) {
@@ -595,7 +594,7 @@ public class TaskbarManager {
.unregister(NAV_BAR_KIDS_MODE, mOnSettingsChangeListener);
Log.d(TASKBAR_NOT_DESTROYED_TAG, "unregistering component callbacks from destroy().");
mContext.unregisterComponentCallbacks(mComponentCallbacks);
mContext.unregisterReceiver(mShutdownReceiver);
mShutdownReceiver.unregisterReceiverSafelyAsync(mContext);
}
public @Nullable TaskbarActivityContext getCurrentActivityContext() {
@@ -36,6 +36,7 @@ import android.util.SparseIntArray;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.UiThread;
import com.android.launcher3.R;
import com.android.launcher3.util.SimpleBroadcastReceiver;
@@ -101,7 +102,7 @@ public final class OverviewComponentObserver {
mConfigChangesMap.append(fallbackComponent.hashCode(), fallbackInfo.configChanges);
} catch (PackageManager.NameNotFoundException ignored) { /* Impossible */ }
mUserPreferenceChangeReceiver.register(mContext, ACTION_PREFERRED_ACTIVITY_CHANGED);
mUserPreferenceChangeReceiver.registerAsync(mContext, ACTION_PREFERRED_ACTIVITY_CHANGED);
updateOverviewTargets();
}
@@ -114,6 +115,8 @@ public final class OverviewComponentObserver {
mOverviewChangeListener = overviewChangeListener;
}
/** Called on {@link TouchInteractionService#onSystemUiFlagsChanged} */
@UiThread
public void onSystemUiStateChanged() {
if (mDeviceState.isHomeDisabled() != mIsHomeDisabled) {
updateOverviewTargets();
@@ -128,6 +131,7 @@ public final class OverviewComponentObserver {
* Update overview intent and {@link BaseActivityInterface} based off the current launcher home
* component.
*/
@UiThread
private void updateOverviewTargets() {
ComponentName defaultHome = PackageManagerWrapper.getInstance()
.getHomeActivities(new ArrayList<>());
@@ -187,8 +191,9 @@ public final class OverviewComponentObserver {
unregisterOtherHomeAppUpdateReceiver();
mUpdateRegisteredPackage = defaultHome.getPackageName();
mOtherHomeAppUpdateReceiver.registerPkgActions(mContext, mUpdateRegisteredPackage,
ACTION_PACKAGE_ADDED, ACTION_PACKAGE_CHANGED, ACTION_PACKAGE_REMOVED);
mOtherHomeAppUpdateReceiver.registerPkgActionsAsync(
mContext, mUpdateRegisteredPackage, ACTION_PACKAGE_ADDED,
ACTION_PACKAGE_CHANGED, ACTION_PACKAGE_REMOVED);
}
}
mOverviewChangeListener.accept(mIsHomeAndOverviewSame);
@@ -198,13 +203,13 @@ public final class OverviewComponentObserver {
* Clean up any registered receivers.
*/
public void onDestroy() {
mContext.unregisterReceiver(mUserPreferenceChangeReceiver);
mUserPreferenceChangeReceiver.unregisterReceiverSafelyAsync(mContext);
unregisterOtherHomeAppUpdateReceiver();
}
private void unregisterOtherHomeAppUpdateReceiver() {
if (mUpdateRegisteredPackage != null) {
mContext.unregisterReceiver(mOtherHomeAppUpdateReceiver);
mOtherHomeAppUpdateReceiver.unregisterReceiverSafelyAsync(mContext);
mUpdateRegisteredPackage = null;
}
}
@@ -18,8 +18,6 @@ package com.android.quickstep.util;
import static android.content.Intent.ACTION_TIMEZONE_CHANGED;
import static android.content.Intent.ACTION_TIME_CHANGED;
import static com.android.launcher3.util.Executors.UI_HELPER_EXECUTOR;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
@@ -64,9 +62,7 @@ public class AsyncClockEventDelegate extends ClockEventDelegate
private AsyncClockEventDelegate(Context context) {
super(context);
mContext = context;
UI_HELPER_EXECUTOR.execute(() ->
mReceiver.register(mContext, ACTION_TIME_CHANGED, ACTION_TIMEZONE_CHANGED));
mReceiver.registerAsync(mContext, ACTION_TIME_CHANGED, ACTION_TIMEZONE_CHANGED);
}
@Override
@@ -127,6 +123,6 @@ public class AsyncClockEventDelegate extends ClockEventDelegate
public void close() {
mDestroyed = true;
SettingsCache.INSTANCE.get(mContext).unregister(mFormatUri, this);
UI_HELPER_EXECUTOR.execute(() -> mReceiver.unregisterReceiverSafely(mContext));
mReceiver.unregisterReceiverSafelyAsync(mContext);
}
}
@@ -116,13 +116,13 @@ public class LauncherAppState implements SafeCloseable {
SimpleBroadcastReceiver modelChangeReceiver =
new SimpleBroadcastReceiver(mModel::onBroadcastIntent);
modelChangeReceiver.register(mContext, Intent.ACTION_LOCALE_CHANGED,
modelChangeReceiver.registerAsync(mContext, Intent.ACTION_LOCALE_CHANGED,
ACTION_DEVICE_POLICY_RESOURCE_UPDATED);
if (BuildConfig.IS_STUDIO_BUILD) {
mContext.registerReceiver(modelChangeReceiver, new IntentFilter(ACTION_FORCE_ROLOAD),
RECEIVER_EXPORTED);
}
mOnTerminateCallback.add(() -> mContext.unregisterReceiver(modelChangeReceiver));
mOnTerminateCallback.add(() -> modelChangeReceiver.unregisterReceiverSafelyAsync(mContext));
SafeCloseable userChangeListener = UserCache.INSTANCE.get(mContext)
.addUserEventListener(mModel::onUserEvent);
+2 -2
View File
@@ -93,12 +93,12 @@ public class UserCache implements SafeCloseable {
@Override
public void close() {
MODEL_EXECUTOR.execute(() -> mUserChangeReceiver.unregisterReceiverSafely(mContext));
MODEL_EXECUTOR.execute(() -> mUserChangeReceiver.unregisterReceiverSafelySync(mContext));
}
@WorkerThread
private void initAsync() {
mUserChangeReceiver.register(mContext,
mUserChangeReceiver.registerSync(mContext,
Intent.ACTION_MANAGED_PROFILE_AVAILABLE,
Intent.ACTION_MANAGED_PROFILE_UNAVAILABLE,
Intent.ACTION_MANAGED_PROFILE_REMOVED,
@@ -132,11 +132,11 @@ public class DisplayController implements ComponentCallbacks, SafeCloseable {
mWindowContext.registerComponentCallbacks(this);
} else {
mWindowContext = null;
mReceiver.register(mContext, ACTION_CONFIGURATION_CHANGED);
mReceiver.registerAsync(mContext, ACTION_CONFIGURATION_CHANGED);
}
// Initialize navigation mode change listener
mReceiver.registerPkgActions(mContext, TARGET_OVERLAY_PACKAGE, ACTION_OVERLAY_CHANGED);
mReceiver.registerPkgActionsAsync(mContext, TARGET_OVERLAY_PACKAGE, ACTION_OVERLAY_CHANGED);
WindowManagerProxy wmProxy = WindowManagerProxy.INSTANCE.get(context);
Context displayInfoContext = getDisplayInfoContext(display);
@@ -223,6 +223,7 @@ public class DisplayController implements ComponentCallbacks, SafeCloseable {
} else {
// TODO: unregister broadcast receiver
}
mReceiver.unregisterReceiverSafelyAsync(mContext);
}
/**
@@ -25,6 +25,7 @@ class LockedUserState(private val mContext: Context) : SafeCloseable {
val isUserUnlockedAtLauncherStartup: Boolean
var isUserUnlocked: Boolean
private set
private val mUserUnlockedActions: RunnableList = RunnableList()
@VisibleForTesting
@@ -50,22 +51,18 @@ class LockedUserState(private val mContext: Context) : SafeCloseable {
if (isUserUnlocked) {
notifyUserUnlocked()
} else {
mUserUnlockedReceiver.register(mContext, Intent.ACTION_USER_UNLOCKED)
mUserUnlockedReceiver.registerAsync(mContext, Intent.ACTION_USER_UNLOCKED)
}
}
private fun notifyUserUnlocked() {
mUserUnlockedActions.executeAllAndDestroy()
Executors.THREAD_POOL_EXECUTOR.execute {
mUserUnlockedReceiver.unregisterReceiverSafely(mContext)
}
mUserUnlockedReceiver.unregisterReceiverSafelyAsync(mContext)
}
/** Stops the receiver from listening for ACTION_USER_UNLOCK broadcasts. */
override fun close() {
Executors.THREAD_POOL_EXECUTOR.execute {
mUserUnlockedReceiver.unregisterReceiverSafely(mContext)
}
mUserUnlockedReceiver.unregisterReceiverSafelyAsync(mContext)
}
/**
@@ -42,12 +42,12 @@ public class ScreenOnTracker implements SafeCloseable {
// Assume that the screen is on to begin with
mContext = context;
mIsScreenOn = true;
mReceiver.register(context, ACTION_SCREEN_ON, ACTION_SCREEN_OFF, ACTION_USER_PRESENT);
mReceiver.registerAsync(context, ACTION_SCREEN_ON, ACTION_SCREEN_OFF, ACTION_USER_PRESENT);
}
@Override
public void close() {
mReceiver.unregisterReceiverSafely(mContext);
mReceiver.unregisterReceiverSafelyAsync(mContext);
}
private void onReceive(Intent intent) {
@@ -15,14 +15,21 @@
*/
package com.android.launcher3.util;
import static com.android.launcher3.util.Executors.UI_HELPER_EXECUTOR;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.os.Looper;
import android.os.PatternMatcher;
import android.text.TextUtils;
import androidx.annotation.Nullable;
import androidx.annotation.UiThread;
import androidx.annotation.WorkerThread;
import com.android.launcher3.BuildConfig;
import java.util.function.Consumer;
@@ -39,20 +46,62 @@ public class SimpleBroadcastReceiver extends BroadcastReceiver {
mIntentConsumer.accept(intent);
}
/**
* Helper method to register multiple actions
*/
public void register(Context context, String... actions) {
/** Helper method to register multiple actions. Caller should be on main thread. */
@UiThread
public void registerAsync(Context context, String... actions) {
assertOnMainThread();
UI_HELPER_EXECUTOR.execute(() -> registerSync(context, actions));
}
/** Helper method to register multiple actions. Caller should be on main thread. */
@WorkerThread
public void registerSync(Context context, String... actions) {
assertOnBgThread();
context.registerReceiver(this, getFilter(actions));
}
/**
* Helper method to register multiple actions associated with a paction
* Helper method to register multiple actions associated with a action. Caller should be from
* main thread.
*/
public void registerPkgActions(Context context, @Nullable String pkg, String... actions) {
@UiThread
public void registerPkgActionsAsync(Context context, @Nullable String pkg, String... actions) {
assertOnMainThread();
UI_HELPER_EXECUTOR.execute(() -> registerPkgActionsSync(context, pkg, actions));
}
/**
* Helper method to register multiple actions associated with a action. Caller should be from
* bg thread.
*/
@WorkerThread
public void registerPkgActionsSync(Context context, @Nullable String pkg, String... actions) {
assertOnBgThread();
context.registerReceiver(this, getPackageFilter(pkg, actions));
}
/**
* Unregisters the receiver ignoring any errors on bg thread. Caller should be on main thread.
*/
@UiThread
public void unregisterReceiverSafelyAsync(Context context) {
assertOnMainThread();
UI_HELPER_EXECUTOR.execute(() -> unregisterReceiverSafelySync(context));
}
/**
* Unregisters the receiver ignoring any errors on bg thread. Caller should be on bg thread.
*/
@WorkerThread
public void unregisterReceiverSafelySync(Context context) {
assertOnBgThread();
try {
context.unregisterReceiver(this);
} catch (IllegalArgumentException e) {
// It was probably never registered or already unregistered. Ignore.
}
}
/**
* Creates an intent filter to listen for actions with a specific package in the data field.
*/
@@ -73,14 +122,19 @@ public class SimpleBroadcastReceiver extends BroadcastReceiver {
return filter;
}
/**
* Unregisters the receiver ignoring any errors
*/
public void unregisterReceiverSafely(Context context) {
try {
context.unregisterReceiver(this);
} catch (IllegalArgumentException e) {
// It was probably never registered or already unregistered. Ignore.
private static void assertOnBgThread() {
if (BuildConfig.IS_STUDIO_BUILD && isMainThread()) {
throw new IllegalStateException("Should not be called from main thread!");
}
}
private static void assertOnMainThread() {
if (BuildConfig.IS_STUDIO_BUILD && !isMainThread()) {
throw new IllegalStateException("Should not be called from bg thread!");
}
}
private static boolean isMainThread() {
return Thread.currentThread() == Looper.getMainLooper().getThread();
}
}
@@ -198,10 +198,11 @@ public class WallpaperOffsetInterpolator {
public void setWindowToken(IBinder token) {
mWindowToken = token;
if (mWindowToken == null && mRegistered) {
mWallpaperChangeReceiver.unregisterReceiverSafely(mWorkspace.getContext());
mWallpaperChangeReceiver.unregisterReceiverSafelyAsync(mWorkspace.getContext());
mRegistered = false;
} else if (mWindowToken != null && !mRegistered) {
mWallpaperChangeReceiver.register(mWorkspace.getContext(), ACTION_WALLPAPER_CHANGED);
mWallpaperChangeReceiver.registerAsync(
mWorkspace.getContext(), ACTION_WALLPAPER_CHANGED);
onWallpaperChanged();
mRegistered = true;
}
@@ -239,7 +239,8 @@ public abstract class AbstractLauncherUiTest<LAUNCHER_TYPE extends Launcher> {
final CountDownLatch count = new CountDownLatch(2);
final SimpleBroadcastReceiver broadcastReceiver =
new SimpleBroadcastReceiver(i -> count.countDown());
broadcastReceiver.registerPkgActions(mTargetContext, pkg,
// We OK to make binder calls on main thread in test.
broadcastReceiver.registerPkgActionsSync(mTargetContext, pkg,
Intent.ACTION_PACKAGE_RESTARTED, Intent.ACTION_PACKAGE_DATA_CLEARED);
mDevice.executeShellCommand("pm clear " + pkg);