Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1586fab authored by Peter Kalauskas's avatar Peter Kalauskas
Browse files

Fix crash in jank monitor debug overlay 

Fix CalledFromWrongThreadException crash which occurred when
InteractionJankMonitor is used for multiple Views that run on different
threads.

Also, create a new trace track so usage of the debug overlay is more
apparent when viewing a trace. Traces that use the debug overlay should
not be used for performance analysis.

Test: Enable debug overlay, open QS, then tap gear icon to open
      Settings. Make sure system does not crash
Bug: 279472146
Change-Id: I68ba670dfd6c4c055c10ede357b10a37a9e83cb7
parent 9e6c6ca8

core/java/com/android/internal/jank/FrameTracker.java

+1 −1
Original line number Diff line number Diff line
@@ -275,7 +275,7 @@ public class FrameTracker extends SurfaceControl.OnJankDataListener 
        }

    }



    @VisibleForTesting

    @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)

    public Handler getHandler() {

        return mHandler;

    }

core/java/com/android/internal/jank/InteractionJankMonitor.java

+4 −2
Original line number Diff line number Diff line
@@ -772,11 +772,12 @@ public class InteractionJankMonitor { 
        return true;

    }



    @UiThread

    private void putTracker(@CujType int cuj, @NonNull FrameTracker tracker) {

        synchronized (mLock) {

            mRunningTrackers.put(cuj, tracker);

            if (mDebugOverlay != null) {

                mDebugOverlay.onTrackerAdded(cuj, tracker.getViewRoot());

                mDebugOverlay.onTrackerAdded(cuj, tracker);

            }

            if (DEBUG) {

                Log.d(TAG, "Added tracker for " + getNameOfCuj(cuj)
@@ -791,6 +792,7 @@ public class InteractionJankMonitor { 
        }

    }



    @UiThread

    private void removeTracker(@CujType int cuj, int reason) {

        synchronized (mLock) {

            mRunningTrackers.remove(cuj);
@@ -818,7 +820,7 @@ public class InteractionJankMonitor { 
                SETTINGS_DEBUG_OVERLAY_ENABLED_KEY,

                DEFAULT_DEBUG_OVERLAY_ENABLED);

        if (debugOverlayEnabled && mDebugOverlay == null) {

            mDebugOverlay = new InteractionMonitorDebugOverlay(mDebugBgColor, mDebugYOffset);

            mDebugOverlay = new InteractionMonitorDebugOverlay(mLock, mDebugBgColor, mDebugYOffset);

        } else if (!debugOverlayEnabled && mDebugOverlay != null) {

            mDebugOverlay.dispose();

            mDebugOverlay = null;

core/java/com/android/internal/jank/InteractionMonitorDebugOverlay.java

+71 −41
Original line number Diff line number Diff line
@@ -19,25 +19,30 @@ package com.android.internal.jank; 
import static com.android.internal.jank.FrameTracker.REASON_END_NORMAL;



import android.annotation.ColorInt;

import android.annotation.UiThread;

import android.app.ActivityThread;

import android.content.Context;

import android.graphics.Color;

import android.graphics.Paint;

import android.graphics.RecordingCanvas;

import android.graphics.Rect;

import android.os.Handler;

import android.os.Trace;

import android.util.SparseArray;

import android.util.SparseIntArray;

import android.view.WindowCallbacks;



import com.android.internal.annotations.GuardedBy;

import com.android.internal.jank.FrameTracker.Reasons;

import com.android.internal.jank.InteractionJankMonitor.CujType;



/**

 * An overlay that uses WindowCallbacks to draw the names of all running CUJs to the window

 * associated with one of the CUJs being tracked. There's no guarantee which window it will

 * draw to. NOTE: sometimes the CUJ names will remain displayed on the screen longer than they

 * are actually running.

 * draw to. Traces that use the debug overlay should not be used for performance analysis.

 * <p>

 * To enable the overlay, run the following: <code>adb shell device_config put

 * interaction_jank_monitor debug_overlay_enabled true</code>

 * <p>

 * CUJ names will be drawn as follows:

 * <ul>
@@ -45,12 +50,16 @@ import com.android.internal.jank.InteractionJankMonitor.CujType; 
 * <li> Grey text indicates the CUJ ended normally and is no longer running

 * <li> Red text with a strikethrough indicates the CUJ was canceled or ended abnormally

 * </ul>

 * @hide

 */

class InteractionMonitorDebugOverlay implements WindowCallbacks {

    private static final int REASON_STILL_RUNNING = -1000;

    private final Object mLock;

    // Sparse array where the key in the CUJ and the value is the session status, or null if

    // it's currently running

    @GuardedBy("mLock")

    private final SparseIntArray mRunningCujs = new SparseIntArray();

    private Handler mHandler = null;

    private FrameTracker.ViewRootWrapper mViewRoot = null;

    private final Paint mDebugPaint;

    private final Paint.FontMetrics mDebugFontMetrics;
@@ -59,8 +68,10 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 
    private final int mBgColor;

    private final double mYOffset;

    private final String mPackageName;

    private static final String TRACK_NAME = "InteractionJankMonitor";



    InteractionMonitorDebugOverlay(@ColorInt int bgColor, double yOffset) {

    InteractionMonitorDebugOverlay(Object lock, @ColorInt int bgColor, double yOffset) {

        mLock = lock;

        mBgColor = bgColor;

        mYOffset = yOffset;

        mDebugPaint = new Paint();
@@ -70,18 +81,30 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 
        mPackageName = context.getPackageName();

    }



    @UiThread

    void dispose() {

        if (mViewRoot != null) {

            mViewRoot.removeWindowCallbacks(this);

        if (mViewRoot != null && mHandler != null) {

            mHandler.runWithScissors(() ->  mViewRoot.removeWindowCallbacks(this),

                    InteractionJankMonitor.EXECUTOR_TASK_TIMEOUT);

            forceRedraw();

        }

        mHandler = null;

        mViewRoot = null;

        Trace.asyncTraceForTrackEnd(Trace.TRACE_TAG_APP, TRACK_NAME, 0);

    }



    private boolean attachViewRootIfNeeded(FrameTracker.ViewRootWrapper viewRoot) {

    @UiThread

    private boolean attachViewRootIfNeeded(FrameTracker tracker) {

        FrameTracker.ViewRootWrapper viewRoot = tracker.getViewRoot();

        if (mViewRoot == null && viewRoot != null) {

            // Add a trace marker so we can identify traces that were captured while the debug

            // overlay was enabled. Traces that use the debug overlay should NOT be used for

            // performance analysis.

            Trace.asyncTraceForTrackBegin(Trace.TRACE_TAG_APP, TRACK_NAME, "DEBUG_OVERLAY_DRAW", 0);

            mHandler = tracker.getHandler();

            mViewRoot = viewRoot;

            viewRoot.addWindowCallbacks(this);

            mHandler.runWithScissors(() -> viewRoot.addWindowCallbacks(this),

                    InteractionJankMonitor.EXECUTOR_TASK_TIMEOUT);

            forceRedraw();

            return true;

        }
@@ -115,15 +138,20 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 
        }

    }



    @UiThread

    private void forceRedraw() {

        if (mViewRoot != null) {

        if (mViewRoot != null && mHandler != null) {

            mHandler.runWithScissors(() -> {

                mViewRoot.requestInvalidateRootRenderNode();

                mViewRoot.getView().invalidate();

            }, InteractionJankMonitor.EXECUTOR_TASK_TIMEOUT);

        }

    }



    @UiThread

    void onTrackerRemoved(@CujType int removedCuj, @Reasons int reason,

                          SparseArray<FrameTracker> runningTrackers) {

        synchronized (mLock) {

            mRunningCujs.put(removedCuj, reason);

            // If REASON_STILL_RUNNING is not in mRunningCujs, then all CUJs have ended

            if (mRunningCujs.indexOfValue(REASON_STILL_RUNNING) < 0) {
@@ -145,7 +173,7 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 
                if (needsNewViewRoot) {

                    dispose();

                    for (int i = 0; i < runningTrackers.size(); i++) {

                    if (attachViewRootIfNeeded(runningTrackers.valueAt(i).getViewRoot())) {

                        if (attachViewRootIfNeeded(runningTrackers.valueAt(i))) {

                            break;

                        }

                    }
@@ -154,14 +182,18 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 
                }

            }

        }

    }



    void onTrackerAdded(@CujType int addedCuj, FrameTracker.ViewRootWrapper viewRoot) {

    @UiThread

    void onTrackerAdded(@CujType int addedCuj, FrameTracker tracker) {

        synchronized (mLock) {

            // Use REASON_STILL_RUNNING (not technically one of the '@Reasons') to indicate the CUJ

            // is still running

            mRunningCujs.put(addedCuj, REASON_STILL_RUNNING);

        attachViewRootIfNeeded(viewRoot);

            attachViewRootIfNeeded(tracker);

            forceRedraw();

        }

    }



    @Override

    public void onWindowSizeIsChanging(Rect newBounds, boolean fullscreen,
@@ -188,7 +220,6 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 


    @Override

    public void onPostDraw(RecordingCanvas canvas) {

        Trace.beginSection("InteractionJankMonitor#drawDebug");

        final int padding = dipToPx(5);

        final int h = canvas.getHeight();

        final int w = canvas.getWidth();
@@ -235,6 +266,5 @@ class InteractionMonitorDebugOverlay implements WindowCallbacks { 
            canvas.translate(0, cujNameTextHeight);

            canvas.drawText(cujName, 0, 0, mDebugPaint);

        }

        Trace.endSection();

    }

}