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

Commit fb477b13 authored by Harry Cutts's avatar Harry Cutts
Browse files

InputVerifier: verify button events and states 

Check the following things:

* BUTTON_PRESS and _RELEASE actions have a single, valid action button
* No redundant BUTTON_PRESS or _RELEASE actions (i.e. for buttons that
  are already pressed or released)
* Button state remains consistent throughout the stream, i.e.:
  * Buttons are only added to the state by BUTTON_PRESS (though DOWN
    events can have "pending" buttons on them)
  * Buttons are only removed from the state by BUTTON_RELEASE
  * When a DOWN event has pending buttons in its state, it is
    immediately followed by a BUTTON_PRESS for each one

We could also verify that press and release events for primary,
secondary, and tertiary buttons are accompanied by down and up events.
However, I couldn't find any documentation that states which buttons
should result in down or up events, so I haven't implemented this for
now.

Test: connect a mouse and a touchpad, enable the verifier, play around
      with the buttons, and check that any issues found by the verifier
      appear to be legitimate. (I found b/391298464, and checked that
      the verifier caught a button problem with a partial fix to
      b/372571823.)
Test: atest --host libinput_rust_tests
Test: atest --host frameworks/native/libs/input/tests/InputVerifier_test.cpp
Test: atest --host \
      frameworks/native/services/inputflinger/tests/InputDispatcher_test.cpp
Bug: 372571823
Flag: com.android.input.flags.enable_inbound_event_verification
Change-Id: I59b886bfb632f0f26ee58c40f82f447f5ea59b41
parent bdb3bc4f

include/android/input.h

+2 −0
Original line number Original line Diff line number Diff line
@@ -849,6 +849,7 @@ enum { 
 * Refer to the documentation on the MotionEvent class for descriptions of each button.

 * Refer to the documentation on the MotionEvent class for descriptions of each button.

 */

 */

enum {

enum {

    // LINT.IfChange(AMOTION_EVENT_BUTTON)

    /** primary */

    /** primary */

    AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0,

    AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0,

    /** secondary */

    /** secondary */
@@ -861,6 +862,7 @@ enum { 
    AMOTION_EVENT_BUTTON_FORWARD = 1 << 4,

    AMOTION_EVENT_BUTTON_FORWARD = 1 << 4,

    AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5,

    AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5,

    AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6,

    AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6,

    // LINT.ThenChange(/frameworks/native/libs/input/rust/input.rs)

};

};





/**

/**

include/input/InputVerifier.h

+3 −2
Original line number Original line Diff line number Diff line
@@ -47,9 +47,10 @@ public: 
    InputVerifier(const std::string& name);

    InputVerifier(const std::string& name);





    android::base::Result<void> processMovement(int32_t deviceId, int32_t source, int32_t action,

    android::base::Result<void> processMovement(int32_t deviceId, int32_t source, int32_t action,

                                                uint32_t pointerCount,

                                                int32_t actionButton, uint32_t pointerCount,

                                                const PointerProperties* pointerProperties,

                                                const PointerProperties* pointerProperties,

                                                const PointerCoords* pointerCoords, int32_t flags);

                                                const PointerCoords* pointerCoords, int32_t flags,

                                                int32_t buttonState);





    void resetDevice(int32_t deviceId);

    void resetDevice(int32_t deviceId);

libs/input/Android.bp

+7 −0
Original line number Original line Diff line number Diff line
@@ -91,6 +91,13 @@ rust_bindgen { 
        "--allowlist-var=AMOTION_EVENT_ACTION_POINTER_DOWN",

        "--allowlist-var=AMOTION_EVENT_ACTION_POINTER_DOWN",

        "--allowlist-var=AMOTION_EVENT_ACTION_DOWN",

        "--allowlist-var=AMOTION_EVENT_ACTION_DOWN",

        "--allowlist-var=AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT",

        "--allowlist-var=AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT",

        "--allowlist-var=AMOTION_EVENT_BUTTON_PRIMARY",

        "--allowlist-var=AMOTION_EVENT_BUTTON_SECONDARY",

        "--allowlist-var=AMOTION_EVENT_BUTTON_TERTIARY",

        "--allowlist-var=AMOTION_EVENT_BUTTON_BACK",

        "--allowlist-var=AMOTION_EVENT_BUTTON_FORWARD",

        "--allowlist-var=AMOTION_EVENT_BUTTON_STYLUS_PRIMARY",

        "--allowlist-var=AMOTION_EVENT_BUTTON_STYLUS_SECONDARY",

        "--allowlist-var=MAX_POINTER_ID",

        "--allowlist-var=MAX_POINTER_ID",

        "--allowlist-var=AINPUT_SOURCE_CLASS_NONE",

        "--allowlist-var=AINPUT_SOURCE_CLASS_NONE",

        "--allowlist-var=AINPUT_SOURCE_CLASS_BUTTON",

        "--allowlist-var=AINPUT_SOURCE_CLASS_BUTTON",

libs/input/InputTransport.cpp

+3 −3
Original line number Original line Diff line number Diff line
@@ -651,9 +651,9 @@ status_t InputPublisher::publishMotionEvent( 
    const status_t status = mChannel->sendMessage(&msg);

    const status_t status = mChannel->sendMessage(&msg);





    if (status == OK && verifyEvents()) {

    if (status == OK && verifyEvents()) {

        Result<void> result =

        Result<void> result = mInputVerifier.processMovement(deviceId, source, action, actionButton,

                mInputVerifier.processMovement(deviceId, source, action, pointerCount,

                                                             pointerCount, pointerProperties,

                                               pointerProperties, pointerCoords, flags);

                                                             pointerCoords, flags, buttonState);

        if (!result.ok()) {

        if (!result.ok()) {

            LOG(ERROR) << "Bad stream: " << result.error();

            LOG(ERROR) << "Bad stream: " << result.error();

            return BAD_VALUE;

            return BAD_VALUE;

libs/input/InputVerifier.cpp

+6 −3
Original line number Original line Diff line number Diff line
@@ -34,9 +34,10 @@ InputVerifier::InputVerifier(const std::string& name) 
      : mVerifier(android::input::verifier::create(rust::String::lossy(name))){};

      : mVerifier(android::input::verifier::create(rust::String::lossy(name))){};





Result<void> InputVerifier::processMovement(DeviceId deviceId, int32_t source, int32_t action,

Result<void> InputVerifier::processMovement(DeviceId deviceId, int32_t source, int32_t action,

                                            uint32_t pointerCount,

                                            int32_t actionButton, uint32_t pointerCount,

                                            const PointerProperties* pointerProperties,

                                            const PointerProperties* pointerProperties,

                                            const PointerCoords* pointerCoords, int32_t flags) {

                                            const PointerCoords* pointerCoords, int32_t flags,

                                            int32_t buttonState) {

    std::vector<RustPointerProperties> rpp;

    std::vector<RustPointerProperties> rpp;

    for (size_t i = 0; i < pointerCount; i++) {

    for (size_t i = 0; i < pointerCount; i++) {

        rpp.emplace_back(RustPointerProperties{.id = pointerProperties[i].id});

        rpp.emplace_back(RustPointerProperties{.id = pointerProperties[i].id});
@@ -44,7 +45,9 @@ Result<void> InputVerifier::processMovement(DeviceId deviceId, int32_t source, i 
    rust::Slice<const RustPointerProperties> properties{rpp.data(), rpp.size()};

    rust::Slice<const RustPointerProperties> properties{rpp.data(), rpp.size()};

    rust::String errorMessage =

    rust::String errorMessage =

            android::input::verifier::process_movement(*mVerifier, deviceId, source, action,

            android::input::verifier::process_movement(*mVerifier, deviceId, source, action,

                                                       properties, static_cast<uint32_t>(flags));

                                                       actionButton, properties,

                                                       static_cast<uint32_t>(flags),

                                                       static_cast<uint32_t>(buttonState));

    if (errorMessage.empty()) {

    if (errorMessage.empty()) {

        return {};

        return {};

    } else {

    } else {