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

Commit a0f9d366 authored by Hongming Jin's avatar Hongming Jin
Browse files

Add features to allow filtering logging based 

on interfaces.

Bug: 157601519
Test: adb shell cmd accessibility start-trace -t IAccessibilityServiceConnection IAccessibilityServiceClient IAccessibilityManager
      adb shell cmd accessibility stop-trace
Change-Id: Iab5ec5ae3d77c893a646cf1ae106ff5fa50d9281
parent 8d6af97d

core/java/android/accessibilityservice/AccessibilityTrace.java

0 → 100644
+216 −0
Original line number Diff line number Diff line 
/**

 * Copyright (C) 2021 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.accessibilityservice;



import java.util.AbstractMap;

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import java.util.Set;



/**

 * Interface to log accessibility trace.

 *

 * @hide

 */

public interface AccessibilityTrace {

    String NAME_ACCESSIBILITY_SERVICE_CONNECTION = "IAccessibilityServiceConnection";

    String NAME_ACCESSIBILITY_SERVICE_CLIENT = "IAccessibilityServiceClient";

    String NAME_ACCESSIBILITY_MANAGER = "IAccessibilityManager";

    String NAME_ACCESSIBILITY_MANAGER_CLIENT = "IAccessibilityManagerClient";

    String NAME_ACCESSIBILITY_INTERACTION_CONNECTION = "IAccessibilityInteractionConnection";

    String NAME_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK =

            "IAccessibilityInteractionConnectionCallback";

    String NAME_REMOTE_MAGNIFICATION_ANIMATION_CALLBACK = "IRemoteMagnificationAnimationCallback";

    String NAME_WINDOW_MAGNIFICATION_CONNECTION = "IWindowMagnificationConnection";

    String NAME_WINDOW_MAGNIFICATION_CONNECTION_CALLBACK = "IWindowMagnificationConnectionCallback";

    String NAME_WINDOW_MANAGER_INTERNAL = "WindowManagerInternal";

    String NAME_WINDOWS_FOR_ACCESSIBILITY_CALLBACK = "WindowsForAccessibilityCallback";

    String NAME_MAGNIFICATION_CALLBACK = "MagnificationCallbacks";

    String NAME_INPUT_FILTER = "InputFilter";

    String NAME_GESTURE = "Gesture";

    String NAME_ACCESSIBILITY_SERVICE = "AccessibilityService";

    String NAME_PACKAGE_BROADCAST_RECEIVER = "PMBroadcastReceiver";

    String NAME_USER_BROADCAST_RECEIVER = "UserBroadcastReceiver";

    String NAME_FINGERPRINT = "FingerprintGesture";

    String NAME_ACCESSIBILITY_INTERACTION_CLIENT = "AccessibilityInteractionClient";



    String NAME_ALL_LOGGINGS = "AllLoggings";

    String NAME_NONE = "None";



    long FLAGS_ACCESSIBILITY_SERVICE_CONNECTION = 0x0000000000000001L;

    long FLAGS_ACCESSIBILITY_SERVICE_CLIENT = 0x0000000000000002L;

    long FLAGS_ACCESSIBILITY_MANAGER = 0x0000000000000004L;

    long FLAGS_ACCESSIBILITY_MANAGER_CLIENT = 0x0000000000000008L;

    long FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION = 0x0000000000000010L;

    long FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK = 0x0000000000000020L;

    long FLAGS_REMOTE_MAGNIFICATION_ANIMATION_CALLBACK = 0x0000000000000040L;

    long FLAGS_WINDOW_MAGNIFICATION_CONNECTION = 0x0000000000000080L;

    long FLAGS_WINDOW_MAGNIFICATION_CONNECTION_CALLBACK = 0x0000000000000100L;

    long FLAGS_WINDOW_MANAGER_INTERNAL = 0x0000000000000200L;

    long FLAGS_WINDOWS_FOR_ACCESSIBILITY_CALLBACK = 0x0000000000000400L;

    long FLAGS_MAGNIFICATION_CALLBACK = 0x0000000000000800L;

    long FLAGS_INPUT_FILTER = 0x0000000000001000L;

    long FLAGS_GESTURE = 0x0000000000002000L;

    long FLAGS_ACCESSIBILITY_SERVICE = 0x0000000000004000L;

    long FLAGS_PACKAGE_BROADCAST_RECEIVER = 0x0000000000008000L;

    long FLAGS_USER_BROADCAST_RECEIVER = 0x0000000000010000L;

    long FLAGS_FINGERPRINT = 0x0000000000020000L;

    long FLAGS_ACCESSIBILITY_INTERACTION_CLIENT = 0x0000000000040000L;



    long FLAGS_LOGGING_NONE = 0x0000000000000000L;

    long FLAGS_LOGGING_ALL = 0xFFFFFFFFFFFFFFFFL;



    long FLAGS_ACCESSIBILITY_MANAGER_CLIENT_STATES = FLAGS_ACCESSIBILITY_INTERACTION_CLIENT

            | FLAGS_ACCESSIBILITY_SERVICE

            | FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION

            | FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK;



    Map<String, Long> sNamesToFlags = Map.ofEntries(

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_SERVICE_CONNECTION, FLAGS_ACCESSIBILITY_SERVICE_CONNECTION),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_SERVICE_CLIENT, FLAGS_ACCESSIBILITY_SERVICE_CLIENT),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_MANAGER, FLAGS_ACCESSIBILITY_MANAGER),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_MANAGER_CLIENT, FLAGS_ACCESSIBILITY_MANAGER_CLIENT),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_INTERACTION_CONNECTION,

                    FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK,

                    FLAGS_ACCESSIBILITY_INTERACTION_CONNECTION_CALLBACK),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_REMOTE_MAGNIFICATION_ANIMATION_CALLBACK,

                    FLAGS_REMOTE_MAGNIFICATION_ANIMATION_CALLBACK),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_WINDOW_MAGNIFICATION_CONNECTION, FLAGS_WINDOW_MAGNIFICATION_CONNECTION),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_WINDOW_MAGNIFICATION_CONNECTION_CALLBACK,

                    FLAGS_WINDOW_MAGNIFICATION_CONNECTION_CALLBACK),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_WINDOW_MANAGER_INTERNAL, FLAGS_WINDOW_MANAGER_INTERNAL),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_WINDOWS_FOR_ACCESSIBILITY_CALLBACK,

                    FLAGS_WINDOWS_FOR_ACCESSIBILITY_CALLBACK),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_MAGNIFICATION_CALLBACK, FLAGS_MAGNIFICATION_CALLBACK),

            new AbstractMap.SimpleEntry<String, Long>(NAME_INPUT_FILTER, FLAGS_INPUT_FILTER),

            new AbstractMap.SimpleEntry<String, Long>(NAME_GESTURE, FLAGS_GESTURE),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_SERVICE, FLAGS_ACCESSIBILITY_SERVICE),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_PACKAGE_BROADCAST_RECEIVER, FLAGS_PACKAGE_BROADCAST_RECEIVER),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_USER_BROADCAST_RECEIVER, FLAGS_USER_BROADCAST_RECEIVER),

            new AbstractMap.SimpleEntry<String, Long>(NAME_FINGERPRINT, FLAGS_FINGERPRINT),

            new AbstractMap.SimpleEntry<String, Long>(

                    NAME_ACCESSIBILITY_INTERACTION_CLIENT, FLAGS_ACCESSIBILITY_INTERACTION_CLIENT),

            new AbstractMap.SimpleEntry<String, Long>(NAME_NONE, FLAGS_LOGGING_NONE),

            new AbstractMap.SimpleEntry<String, Long>(NAME_ALL_LOGGINGS, FLAGS_LOGGING_ALL));



    /**

     * Get the flags of the logging types by the given names.

     * The names list contains logging type names in lower case.

     */

    static long getLoggingFlagsFromNames(List<String> names) {

        long types = FLAGS_LOGGING_NONE;

        for (String name : names) {

            long flag = sNamesToFlags.get(name);

            types |= flag;

        }

        return types;

    }



    /**

     * Get the list of the names of logging types by the given flags.

     */

    static List<String> getNamesOfLoggingTypes(long flags) {

        List<String> list = new ArrayList<String>();



        for (Map.Entry<String, Long> entry : sNamesToFlags.entrySet()) {

            if ((entry.getValue() & flags) != FLAGS_LOGGING_NONE) {

                list.add(entry.getKey());

            }

        }



        return list;

    }



    /**

     * Whether the trace is enabled for any logging type.

     */

    boolean isA11yTracingEnabled();



    /**

     * Whether the trace is enabled for any of the given logging type.

     */

    boolean isA11yTracingEnabledForTypes(long typeIdFlags);



    /**

     * Get trace state to be sent to AccessibilityManager.

     */

    int getTraceStateForAccessibilityManagerClientState();



    /**

     * Start tracing for the given logging types.

     */

    void startTrace(long flagss);



    /**

     * Stop tracing.

     */

    void stopTrace();



    /**

     * Log one trace entry.

     * @param where A string to identify this log entry, which can be used to search through the

     *        tracing file.

     * @param loggingFlags Flags to identify which logging types this entry belongs to. This

     *        can be used to filter the log entries when generating tracing file.

     */

    void logTrace(String where, long loggingFlags);



    /**

     * Log one trace entry.

     * @param where A string to identify this log entry, which can be used to filter/search

     *        through the tracing file.

     * @param loggingFlags Flags to identify which logging types this entry belongs to. This

     *        can be used to filter the log entries when generating tracing file.

     * @param callingParams The parameters for the method to be logged.

     */

    void logTrace(String where, long loggingFlags, String callingParams);



    /**

     * Log one trace entry. Accessibility services using AccessibilityInteractionClient to

     * make screen content related requests use this API to log entry when receive callback.

     * @param timestamp The timestamp when a callback is received.

     * @param where A string to identify this log entry, which can be used to filter/search

     *        through the tracing file.

     * @param loggingFlags Flags to identify which logging types this entry belongs to. This

     *        can be used to filter the log entries when generating tracing file.

     * @param callingParams The parameters for the callback.

     * @param processId The process id of the calling component.

     * @param threadId The threadId of the calling component.

     * @param callingUid The calling uid of the callback.

     * @param callStack The call stack of the callback.

     * @param ignoreStackElements ignore these call stack element

     */

    void logTrace(long timestamp, String where, long loggingFlags, String callingParams,

            int processId, long threadId, int callingUid, StackTraceElement[] callStack,

            Set<String> ignoreStackElements);

}

core/java/android/accessibilityservice/IAccessibilityServiceConnection.aidl

+2 −2
Original line number Diff line number Diff line
@@ -118,6 +118,6 @@ interface IAccessibilityServiceConnection { 


    void setFocusAppearance(int strokeWidth, int color);



    oneway void logTrace(long timestamp, String where, String callingParams, int processId,

        long threadId, int callingUid, in Bundle serializedCallingStackInBundle);

    oneway void logTrace(long timestamp, String where, long loggingTypes, String callingParams,

        int processId, long threadId, int callingUid, in Bundle serializedCallingStackInBundle);

}

core/java/android/view/accessibility/AccessibilityInteractionClient.java

+145 −57

File changed.

Preview size limit exceeded, changes collapsed.

core/java/android/view/accessibility/AccessibilityManager.java

+53 −12
Original line number Diff line number Diff line
@@ -111,7 +111,13 @@ public final class AccessibilityManager { 
    public static final int STATE_FLAG_REQUEST_MULTI_FINGER_GESTURES = 0x00000010;



    /** @hide */

    public static final int STATE_FLAG_ACCESSIBILITY_TRACING_ENABLED = 0x00000020;

    public static final int STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_ENABLED = 0x00000100;

    /** @hide */

    public static final int STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_CB_ENABLED = 0x00000200;

    /** @hide */

    public static final int STATE_FLAG_TRACE_A11Y_INTERACTION_CLIENT_ENABLED = 0x00000400;

    /** @hide */

    public static final int STATE_FLAG_TRACE_A11Y_SERVICE_ENABLED = 0x00000800;



    /** @hide */

    public static final int DALTONIZER_DISABLED = -1;
@@ -235,8 +241,8 @@ public final class AccessibilityManager { 
    @UnsupportedAppUsage(trackingBug = 123768939L)

    boolean mIsHighTextContrastEnabled;



    // Whether accessibility tracing is enabled or not

    boolean mIsAccessibilityTracingEnabled = false;

    // accessibility tracing state

    int mAccessibilityTracingState = 0;



    AccessibilityPolicy mAccessibilityPolicy;
@@ -1010,13 +1016,50 @@ public final class AccessibilityManager { 
    }



    /**

     * Gets accessibility tracing enabled state.

     * Gets accessibility interaction connection tracing enabled state.

     *

     * @hide

     */

    public boolean isA11yInteractionConnectionTraceEnabled() {

        synchronized (mLock) {

            return ((mAccessibilityTracingState

                    & STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_ENABLED) != 0);

        }

    }



    /**

     * Gets accessibility interaction connection callback tracing enabled state.

     *

     * @hide

     */

    public boolean isA11yInteractionConnectionCBTraceEnabled() {

        synchronized (mLock) {

            return ((mAccessibilityTracingState

                    & STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_CB_ENABLED) != 0);

        }

    }



    /**

     * Gets accessibility interaction client tracing enabled state.

     *

     * @hide

     */

    public boolean isA11yInteractionClientTraceEnabled() {

        synchronized (mLock) {

            return ((mAccessibilityTracingState

                    & STATE_FLAG_TRACE_A11Y_INTERACTION_CLIENT_ENABLED) != 0);

        }

    }



    /**

     * Gets accessibility service tracing enabled state.

     *

     * @hide

     */

    public boolean isAccessibilityTracingEnabled() {

    public boolean isA11yServiceTraceEnabled() {

        synchronized (mLock) {

            return mIsAccessibilityTracingEnabled;

            return ((mAccessibilityTracingState

                    & STATE_FLAG_TRACE_A11Y_SERVICE_ENABLED) != 0);

        }

    }
@@ -1214,8 +1257,6 @@ public final class AccessibilityManager { 
                (stateFlags & STATE_FLAG_TOUCH_EXPLORATION_ENABLED) != 0;

        final boolean highTextContrastEnabled =

                (stateFlags & STATE_FLAG_HIGH_TEXT_CONTRAST_ENABLED) != 0;

        final boolean accessibilityTracingEnabled =

                (stateFlags & STATE_FLAG_ACCESSIBILITY_TRACING_ENABLED) != 0;



        final boolean wasEnabled = isEnabled();

        final boolean wasTouchExplorationEnabled = mIsTouchExplorationEnabled;
@@ -1238,7 +1279,7 @@ public final class AccessibilityManager { 
            notifyHighTextContrastStateChanged();

        }



        updateAccessibilityTracingState(accessibilityTracingEnabled);

        updateAccessibilityTracingState(stateFlags);

    }



    /**
@@ -1696,11 +1737,11 @@ public final class AccessibilityManager { 
    }



    /**

     * Update mIsAccessibilityTracingEnabled.

     * Update mAccessibilityTracingState.

     */

    private void updateAccessibilityTracingState(boolean enabled) {

    private void updateAccessibilityTracingState(int stateFlag) {

        synchronized (mLock) {

            mIsAccessibilityTracingEnabled = enabled;

            mAccessibilityTracingState = stateFlag;

        }

    }

core/proto/android/server/accessibilitytrace.proto

+9 −9
Original line number Diff line number Diff line
@@ -46,17 +46,17 @@ message AccessibilityTraceProto { 
    /* required: elapsed realtime in nanos since boot of when this entry was logged */

    optional fixed64 elapsed_realtime_nanos = 1;

    optional string calendar_time = 2;



    optional string process_name = 3;

    optional string thread_id_name = 4;

    repeated string logging_type = 3;

    optional string process_name = 4;

    optional string thread_id_name = 5;



    /* where the trace originated */

    optional string where = 5;

    optional string where = 6;



    optional string calling_pkg = 6;

    optional string calling_params = 7;

    optional string calling_stacks = 8;

    optional string calling_pkg = 7;

    optional string calling_params = 8;

    optional string calling_stacks = 9;



    optional AccessibilityDumpProto accessibility_service = 9;

    optional com.android.server.wm.WindowManagerServiceDumpProto window_manager_service = 10;

    optional AccessibilityDumpProto accessibility_service = 10;

    optional com.android.server.wm.WindowManagerServiceDumpProto window_manager_service = 11;

}