1 /* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef _UI_INPUT_DISPATCHER_H 18 #define _UI_INPUT_DISPATCHER_H 19 20 #include <input/Input.h> 21 #include <input/InputTransport.h> 22 #include <utils/KeyedVector.h> 23 #include <utils/Vector.h> 24 #include <utils/threads.h> 25 #include <utils/Timers.h> 26 #include <utils/RefBase.h> 27 #include <utils/String8.h> 28 #include <utils/Looper.h> 29 #include <utils/BitSet.h> 30 #include <cutils/atomic.h> 31 32 #include <stddef.h> 33 #include <unistd.h> 34 #include <limits.h> 35 36 #include "InputWindow.h" 37 #include "InputApplication.h" 38 #include "InputListener.h" 39 40 41 namespace android { 42 43 /* 44 * Constants used to report the outcome of input event injection. 45 */ 46 enum { 47 /* (INTERNAL USE ONLY) Specifies that injection is pending and its outcome is unknown. */ 48 INPUT_EVENT_INJECTION_PENDING = -1, 49 50 /* Injection succeeded. */ 51 INPUT_EVENT_INJECTION_SUCCEEDED = 0, 52 53 /* Injection failed because the injector did not have permission to inject 54 * into the application with input focus. */ 55 INPUT_EVENT_INJECTION_PERMISSION_DENIED = 1, 56 57 /* Injection failed because there were no available input targets. */ 58 INPUT_EVENT_INJECTION_FAILED = 2, 59 60 /* Injection failed due to a timeout. */ 61 INPUT_EVENT_INJECTION_TIMED_OUT = 3 62 }; 63 64 /* 65 * Constants used to determine the input event injection synchronization mode. 66 */ 67 enum { 68 /* Injection is asynchronous and is assumed always to be successful. */ 69 INPUT_EVENT_INJECTION_SYNC_NONE = 0, 70 71 /* Waits for previous events to be dispatched so that the input dispatcher can determine 72 * whether input event injection willbe permitted based on the current input focus. 73 * Does not wait for the input event to finish processing. */ 74 INPUT_EVENT_INJECTION_SYNC_WAIT_FOR_RESULT = 1, 75 76 /* Waits for the input event to be completely processed. */ 77 INPUT_EVENT_INJECTION_SYNC_WAIT_FOR_FINISHED = 2, 78 }; 79 80 81 /* 82 * An input target specifies how an input event is to be dispatched to a particular window 83 * including the window's input channel, control flags, a timeout, and an X / Y offset to 84 * be added to input event coordinates to compensate for the absolute position of the 85 * window area. 86 */ 87 struct InputTarget { 88 enum { 89 /* This flag indicates that the event is being delivered to a foreground application. */ 90 FLAG_FOREGROUND = 1 << 0, 91 92 /* This flag indicates that the target of a MotionEvent is partly or wholly 93 * obscured by another visible window above it. The motion event should be 94 * delivered with flag AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED. */ 95 FLAG_WINDOW_IS_OBSCURED = 1 << 1, 96 97 /* This flag indicates that a motion event is being split across multiple windows. */ 98 FLAG_SPLIT = 1 << 2, 99 100 /* This flag indicates that the pointer coordinates dispatched to the application 101 * will be zeroed out to avoid revealing information to an application. This is 102 * used in conjunction with FLAG_DISPATCH_AS_OUTSIDE to prevent apps not sharing 103 * the same UID from watching all touches. */ 104 FLAG_ZERO_COORDS = 1 << 3, 105 106 /* This flag indicates that the event should be sent as is. 107 * Should always be set unless the event is to be transmuted. */ 108 FLAG_DISPATCH_AS_IS = 1 << 8, 109 110 /* This flag indicates that a MotionEvent with AMOTION_EVENT_ACTION_DOWN falls outside 111 * of the area of this target and so should instead be delivered as an 112 * AMOTION_EVENT_ACTION_OUTSIDE to this target. */ 113 FLAG_DISPATCH_AS_OUTSIDE = 1 << 9, 114 115 /* This flag indicates that a hover sequence is starting in the given window. 116 * The event is transmuted into ACTION_HOVER_ENTER. */ 117 FLAG_DISPATCH_AS_HOVER_ENTER = 1 << 10, 118 119 /* This flag indicates that a hover event happened outside of a window which handled 120 * previous hover events, signifying the end of the current hover sequence for that 121 * window. 122 * The event is transmuted into ACTION_HOVER_ENTER. */ 123 FLAG_DISPATCH_AS_HOVER_EXIT = 1 << 11, 124 125 /* This flag indicates that the event should be canceled. 126 * It is used to transmute ACTION_MOVE into ACTION_CANCEL when a touch slips 127 * outside of a window. */ 128 FLAG_DISPATCH_AS_SLIPPERY_EXIT = 1 << 12, 129 130 /* This flag indicates that the event should be dispatched as an initial down. 131 * It is used to transmute ACTION_MOVE into ACTION_DOWN when a touch slips 132 * into a new window. */ 133 FLAG_DISPATCH_AS_SLIPPERY_ENTER = 1 << 13, 134 135 /* Mask for all dispatch modes. */ 136 FLAG_DISPATCH_MASK = FLAG_DISPATCH_AS_IS 137 | FLAG_DISPATCH_AS_OUTSIDE 138 | FLAG_DISPATCH_AS_HOVER_ENTER 139 | FLAG_DISPATCH_AS_HOVER_EXIT 140 | FLAG_DISPATCH_AS_SLIPPERY_EXIT 141 | FLAG_DISPATCH_AS_SLIPPERY_ENTER, 142 }; 143 144 // The input channel to be targeted. 145 sp<InputChannel> inputChannel; 146 147 // Flags for the input target. 148 int32_t flags; 149 150 // The x and y offset to add to a MotionEvent as it is delivered. 151 // (ignored for KeyEvents) 152 float xOffset, yOffset; 153 154 // Scaling factor to apply to MotionEvent as it is delivered. 155 // (ignored for KeyEvents) 156 float scaleFactor; 157 158 // The subset of pointer ids to include in motion events dispatched to this input target 159 // if FLAG_SPLIT is set. 160 BitSet32 pointerIds; 161 }; 162 163 164 /* 165 * Input dispatcher configuration. 166 * 167 * Specifies various options that modify the behavior of the input dispatcher. 168 * The values provided here are merely defaults. The actual values will come from ViewConfiguration 169 * and are passed into the dispatcher during initialization. 170 */ 171 struct InputDispatcherConfiguration { 172 // The key repeat initial timeout. 173 nsecs_t keyRepeatTimeout; 174 175 // The key repeat inter-key delay. 176 nsecs_t keyRepeatDelay; 177 InputDispatcherConfigurationInputDispatcherConfiguration178 InputDispatcherConfiguration() : 179 keyRepeatTimeout(500 * 1000000LL), 180 keyRepeatDelay(50 * 1000000LL) { } 181 }; 182 183 184 /* 185 * Input dispatcher policy interface. 186 * 187 * The input reader policy is used by the input reader to interact with the Window Manager 188 * and other system components. 189 * 190 * The actual implementation is partially supported by callbacks into the DVM 191 * via JNI. This interface is also mocked in the unit tests. 192 */ 193 class InputDispatcherPolicyInterface : public virtual RefBase { 194 protected: InputDispatcherPolicyInterface()195 InputDispatcherPolicyInterface() { } ~InputDispatcherPolicyInterface()196 virtual ~InputDispatcherPolicyInterface() { } 197 198 public: 199 /* Notifies the system that a configuration change has occurred. */ 200 virtual void notifyConfigurationChanged(nsecs_t when) = 0; 201 202 /* Notifies the system that an application is not responding. 203 * Returns a new timeout to continue waiting, or 0 to abort dispatch. */ 204 virtual nsecs_t notifyANR(const sp<InputApplicationHandle>& inputApplicationHandle, 205 const sp<InputWindowHandle>& inputWindowHandle, 206 const String8& reason) = 0; 207 208 /* Notifies the system that an input channel is unrecoverably broken. */ 209 virtual void notifyInputChannelBroken(const sp<InputWindowHandle>& inputWindowHandle) = 0; 210 211 /* Gets the input dispatcher configuration. */ 212 virtual void getDispatcherConfiguration(InputDispatcherConfiguration* outConfig) = 0; 213 214 /* Filters an input event. 215 * Return true to dispatch the event unmodified, false to consume the event. 216 * A filter can also transform and inject events later by passing POLICY_FLAG_FILTERED 217 * to injectInputEvent. 218 */ 219 virtual bool filterInputEvent(const InputEvent* inputEvent, uint32_t policyFlags) = 0; 220 221 /* Intercepts a key event immediately before queueing it. 222 * The policy can use this method as an opportunity to perform power management functions 223 * and early event preprocessing such as updating policy flags. 224 * 225 * This method is expected to set the POLICY_FLAG_PASS_TO_USER policy flag if the event 226 * should be dispatched to applications. 227 */ 228 virtual void interceptKeyBeforeQueueing(const KeyEvent* keyEvent, uint32_t& policyFlags) = 0; 229 230 /* Intercepts a touch, trackball or other motion event before queueing it. 231 * The policy can use this method as an opportunity to perform power management functions 232 * and early event preprocessing such as updating policy flags. 233 * 234 * This method is expected to set the POLICY_FLAG_PASS_TO_USER policy flag if the event 235 * should be dispatched to applications. 236 */ 237 virtual void interceptMotionBeforeQueueing(nsecs_t when, uint32_t& policyFlags) = 0; 238 239 /* Allows the policy a chance to intercept a key before dispatching. */ 240 virtual nsecs_t interceptKeyBeforeDispatching(const sp<InputWindowHandle>& inputWindowHandle, 241 const KeyEvent* keyEvent, uint32_t policyFlags) = 0; 242 243 /* Allows the policy a chance to perform default processing for an unhandled key. 244 * Returns an alternate keycode to redispatch as a fallback, or 0 to give up. */ 245 virtual bool dispatchUnhandledKey(const sp<InputWindowHandle>& inputWindowHandle, 246 const KeyEvent* keyEvent, uint32_t policyFlags, KeyEvent* outFallbackKeyEvent) = 0; 247 248 /* Notifies the policy about switch events. 249 */ 250 virtual void notifySwitch(nsecs_t when, 251 uint32_t switchValues, uint32_t switchMask, uint32_t policyFlags) = 0; 252 253 /* Poke user activity for an event dispatched to a window. */ 254 virtual void pokeUserActivity(nsecs_t eventTime, int32_t eventType) = 0; 255 256 /* Checks whether a given application pid/uid has permission to inject input events 257 * into other applications. 258 * 259 * This method is special in that its implementation promises to be non-reentrant and 260 * is safe to call while holding other locks. (Most other methods make no such guarantees!) 261 */ 262 virtual bool checkInjectEventsPermissionNonReentrant( 263 int32_t injectorPid, int32_t injectorUid) = 0; 264 }; 265 266 267 /* Notifies the system about input events generated by the input reader. 268 * The dispatcher is expected to be mostly asynchronous. */ 269 class InputDispatcherInterface : public virtual RefBase, public InputListenerInterface { 270 protected: InputDispatcherInterface()271 InputDispatcherInterface() { } ~InputDispatcherInterface()272 virtual ~InputDispatcherInterface() { } 273 274 public: 275 /* Dumps the state of the input dispatcher. 276 * 277 * This method may be called on any thread (usually by the input manager). */ 278 virtual void dump(String8& dump) = 0; 279 280 /* Called by the heatbeat to ensures that the dispatcher has not deadlocked. */ 281 virtual void monitor() = 0; 282 283 /* Runs a single iteration of the dispatch loop. 284 * Nominally processes one queued event, a timeout, or a response from an input consumer. 285 * 286 * This method should only be called on the input dispatcher thread. 287 */ 288 virtual void dispatchOnce() = 0; 289 290 /* Injects an input event and optionally waits for sync. 291 * The synchronization mode determines whether the method blocks while waiting for 292 * input injection to proceed. 293 * Returns one of the INPUT_EVENT_INJECTION_XXX constants. 294 * 295 * This method may be called on any thread (usually by the input manager). 296 */ 297 virtual int32_t injectInputEvent(const InputEvent* event, int32_t displayId, 298 int32_t injectorPid, int32_t injectorUid, int32_t syncMode, int32_t timeoutMillis, 299 uint32_t policyFlags) = 0; 300 301 /* Sets the list of input windows. 302 * 303 * This method may be called on any thread (usually by the input manager). 304 */ 305 virtual void setInputWindows(const Vector<sp<InputWindowHandle> >& inputWindowHandles) = 0; 306 307 /* Sets the focused application. 308 * 309 * This method may be called on any thread (usually by the input manager). 310 */ 311 virtual void setFocusedApplication( 312 const sp<InputApplicationHandle>& inputApplicationHandle) = 0; 313 314 /* Sets the input dispatching mode. 315 * 316 * This method may be called on any thread (usually by the input manager). 317 */ 318 virtual void setInputDispatchMode(bool enabled, bool frozen) = 0; 319 320 /* Sets whether input event filtering is enabled. 321 * When enabled, incoming input events are sent to the policy's filterInputEvent 322 * method instead of being dispatched. The filter is expected to use 323 * injectInputEvent to inject the events it would like to have dispatched. 324 * It should include POLICY_FLAG_FILTERED in the policy flags during injection. 325 */ 326 virtual void setInputFilterEnabled(bool enabled) = 0; 327 328 /* Transfers touch focus from the window associated with one channel to the 329 * window associated with the other channel. 330 * 331 * Returns true on success. False if the window did not actually have touch focus. 332 */ 333 virtual bool transferTouchFocus(const sp<InputChannel>& fromChannel, 334 const sp<InputChannel>& toChannel) = 0; 335 336 /* Registers or unregister input channels that may be used as targets for input events. 337 * If monitor is true, the channel will receive a copy of all input events. 338 * 339 * These methods may be called on any thread (usually by the input manager). 340 */ 341 virtual status_t registerInputChannel(const sp<InputChannel>& inputChannel, 342 const sp<InputWindowHandle>& inputWindowHandle, bool monitor) = 0; 343 virtual status_t unregisterInputChannel(const sp<InputChannel>& inputChannel) = 0; 344 }; 345 346 /* Dispatches events to input targets. Some functions of the input dispatcher, such as 347 * identifying input targets, are controlled by a separate policy object. 348 * 349 * IMPORTANT INVARIANT: 350 * Because the policy can potentially block or cause re-entrance into the input dispatcher, 351 * the input dispatcher never calls into the policy while holding its internal locks. 352 * The implementation is also carefully designed to recover from scenarios such as an 353 * input channel becoming unregistered while identifying input targets or processing timeouts. 354 * 355 * Methods marked 'Locked' must be called with the lock acquired. 356 * 357 * Methods marked 'LockedInterruptible' must be called with the lock acquired but 358 * may during the course of their execution release the lock, call into the policy, and 359 * then reacquire the lock. The caller is responsible for recovering gracefully. 360 * 361 * A 'LockedInterruptible' method may called a 'Locked' method, but NOT vice-versa. 362 */ 363 class InputDispatcher : public InputDispatcherInterface { 364 protected: 365 virtual ~InputDispatcher(); 366 367 public: 368 explicit InputDispatcher(const sp<InputDispatcherPolicyInterface>& policy); 369 370 virtual void dump(String8& dump); 371 virtual void monitor(); 372 373 virtual void dispatchOnce(); 374 375 virtual void notifyConfigurationChanged(const NotifyConfigurationChangedArgs* args); 376 virtual void notifyKey(const NotifyKeyArgs* args); 377 virtual void notifyMotion(const NotifyMotionArgs* args); 378 virtual void notifySwitch(const NotifySwitchArgs* args); 379 virtual void notifyDeviceReset(const NotifyDeviceResetArgs* args); 380 381 virtual int32_t injectInputEvent(const InputEvent* event, int32_t displayId, 382 int32_t injectorPid, int32_t injectorUid, int32_t syncMode, int32_t timeoutMillis, 383 uint32_t policyFlags); 384 385 virtual void setInputWindows(const Vector<sp<InputWindowHandle> >& inputWindowHandles); 386 virtual void setFocusedApplication(const sp<InputApplicationHandle>& inputApplicationHandle); 387 virtual void setInputDispatchMode(bool enabled, bool frozen); 388 virtual void setInputFilterEnabled(bool enabled); 389 390 virtual bool transferTouchFocus(const sp<InputChannel>& fromChannel, 391 const sp<InputChannel>& toChannel); 392 393 virtual status_t registerInputChannel(const sp<InputChannel>& inputChannel, 394 const sp<InputWindowHandle>& inputWindowHandle, bool monitor); 395 virtual status_t unregisterInputChannel(const sp<InputChannel>& inputChannel); 396 397 private: 398 template <typename T> 399 struct Link { 400 T* next; 401 T* prev; 402 403 protected: LinkLink404 inline Link() : next(NULL), prev(NULL) { } 405 }; 406 407 struct InjectionState { 408 mutable int32_t refCount; 409 410 int32_t injectorPid; 411 int32_t injectorUid; 412 int32_t injectionResult; // initially INPUT_EVENT_INJECTION_PENDING 413 bool injectionIsAsync; // set to true if injection is not waiting for the result 414 int32_t pendingForegroundDispatches; // the number of foreground dispatches in progress 415 416 InjectionState(int32_t injectorPid, int32_t injectorUid); 417 void release(); 418 419 private: 420 ~InjectionState(); 421 }; 422 423 struct EventEntry : Link<EventEntry> { 424 enum { 425 TYPE_CONFIGURATION_CHANGED, 426 TYPE_DEVICE_RESET, 427 TYPE_KEY, 428 TYPE_MOTION 429 }; 430 431 mutable int32_t refCount; 432 int32_t type; 433 nsecs_t eventTime; 434 uint32_t policyFlags; 435 InjectionState* injectionState; 436 437 bool dispatchInProgress; // initially false, set to true while dispatching 438 isInjectedEventEntry439 inline bool isInjected() const { return injectionState != NULL; } 440 441 void release(); 442 443 virtual void appendDescription(String8& msg) const = 0; 444 445 protected: 446 EventEntry(int32_t type, nsecs_t eventTime, uint32_t policyFlags); 447 virtual ~EventEntry(); 448 void releaseInjectionState(); 449 }; 450 451 struct ConfigurationChangedEntry : EventEntry { 452 ConfigurationChangedEntry(nsecs_t eventTime); 453 virtual void appendDescription(String8& msg) const; 454 455 protected: 456 virtual ~ConfigurationChangedEntry(); 457 }; 458 459 struct DeviceResetEntry : EventEntry { 460 int32_t deviceId; 461 462 DeviceResetEntry(nsecs_t eventTime, int32_t deviceId); 463 virtual void appendDescription(String8& msg) const; 464 465 protected: 466 virtual ~DeviceResetEntry(); 467 }; 468 469 struct KeyEntry : EventEntry { 470 int32_t deviceId; 471 uint32_t source; 472 int32_t action; 473 int32_t flags; 474 int32_t keyCode; 475 int32_t scanCode; 476 int32_t metaState; 477 int32_t repeatCount; 478 nsecs_t downTime; 479 480 bool syntheticRepeat; // set to true for synthetic key repeats 481 482 enum InterceptKeyResult { 483 INTERCEPT_KEY_RESULT_UNKNOWN, 484 INTERCEPT_KEY_RESULT_SKIP, 485 INTERCEPT_KEY_RESULT_CONTINUE, 486 INTERCEPT_KEY_RESULT_TRY_AGAIN_LATER, 487 }; 488 InterceptKeyResult interceptKeyResult; // set based on the interception result 489 nsecs_t interceptKeyWakeupTime; // used with INTERCEPT_KEY_RESULT_TRY_AGAIN_LATER 490 491 KeyEntry(nsecs_t eventTime, 492 int32_t deviceId, uint32_t source, uint32_t policyFlags, int32_t action, 493 int32_t flags, int32_t keyCode, int32_t scanCode, int32_t metaState, 494 int32_t repeatCount, nsecs_t downTime); 495 virtual void appendDescription(String8& msg) const; 496 void recycle(); 497 498 protected: 499 virtual ~KeyEntry(); 500 }; 501 502 struct MotionEntry : EventEntry { 503 nsecs_t eventTime; 504 int32_t deviceId; 505 uint32_t source; 506 int32_t action; 507 int32_t flags; 508 int32_t metaState; 509 int32_t buttonState; 510 int32_t edgeFlags; 511 float xPrecision; 512 float yPrecision; 513 nsecs_t downTime; 514 int32_t displayId; 515 uint32_t pointerCount; 516 PointerProperties pointerProperties[MAX_POINTERS]; 517 PointerCoords pointerCoords[MAX_POINTERS]; 518 519 MotionEntry(nsecs_t eventTime, 520 int32_t deviceId, uint32_t source, uint32_t policyFlags, 521 int32_t action, int32_t flags, 522 int32_t metaState, int32_t buttonState, int32_t edgeFlags, 523 float xPrecision, float yPrecision, 524 nsecs_t downTime, int32_t displayId, uint32_t pointerCount, 525 const PointerProperties* pointerProperties, const PointerCoords* pointerCoords, 526 float xOffset, float yOffset); 527 virtual void appendDescription(String8& msg) const; 528 529 protected: 530 virtual ~MotionEntry(); 531 }; 532 533 // Tracks the progress of dispatching a particular event to a particular connection. 534 struct DispatchEntry : Link<DispatchEntry> { 535 const uint32_t seq; // unique sequence number, never 0 536 537 EventEntry* eventEntry; // the event to dispatch 538 int32_t targetFlags; 539 float xOffset; 540 float yOffset; 541 float scaleFactor; 542 nsecs_t deliveryTime; // time when the event was actually delivered 543 544 // Set to the resolved action and flags when the event is enqueued. 545 int32_t resolvedAction; 546 int32_t resolvedFlags; 547 548 DispatchEntry(EventEntry* eventEntry, 549 int32_t targetFlags, float xOffset, float yOffset, float scaleFactor); 550 ~DispatchEntry(); 551 hasForegroundTargetDispatchEntry552 inline bool hasForegroundTarget() const { 553 return targetFlags & InputTarget::FLAG_FOREGROUND; 554 } 555 isSplitDispatchEntry556 inline bool isSplit() const { 557 return targetFlags & InputTarget::FLAG_SPLIT; 558 } 559 560 private: 561 static volatile int32_t sNextSeqAtomic; 562 563 static uint32_t nextSeq(); 564 }; 565 566 // A command entry captures state and behavior for an action to be performed in the 567 // dispatch loop after the initial processing has taken place. It is essentially 568 // a kind of continuation used to postpone sensitive policy interactions to a point 569 // in the dispatch loop where it is safe to release the lock (generally after finishing 570 // the critical parts of the dispatch cycle). 571 // 572 // The special thing about commands is that they can voluntarily release and reacquire 573 // the dispatcher lock at will. Initially when the command starts running, the 574 // dispatcher lock is held. However, if the command needs to call into the policy to 575 // do some work, it can release the lock, do the work, then reacquire the lock again 576 // before returning. 577 // 578 // This mechanism is a bit clunky but it helps to preserve the invariant that the dispatch 579 // never calls into the policy while holding its lock. 580 // 581 // Commands are implicitly 'LockedInterruptible'. 582 struct CommandEntry; 583 typedef void (InputDispatcher::*Command)(CommandEntry* commandEntry); 584 585 class Connection; 586 struct CommandEntry : Link<CommandEntry> { 587 CommandEntry(Command command); 588 ~CommandEntry(); 589 590 Command command; 591 592 // parameters for the command (usage varies by command) 593 sp<Connection> connection; 594 nsecs_t eventTime; 595 KeyEntry* keyEntry; 596 sp<InputApplicationHandle> inputApplicationHandle; 597 sp<InputWindowHandle> inputWindowHandle; 598 String8 reason; 599 int32_t userActivityEventType; 600 uint32_t seq; 601 bool handled; 602 }; 603 604 // Generic queue implementation. 605 template <typename T> 606 struct Queue { 607 T* head; 608 T* tail; 609 QueueQueue610 inline Queue() : head(NULL), tail(NULL) { 611 } 612 isEmptyQueue613 inline bool isEmpty() const { 614 return !head; 615 } 616 enqueueAtTailQueue617 inline void enqueueAtTail(T* entry) { 618 entry->prev = tail; 619 if (tail) { 620 tail->next = entry; 621 } else { 622 head = entry; 623 } 624 entry->next = NULL; 625 tail = entry; 626 } 627 enqueueAtHeadQueue628 inline void enqueueAtHead(T* entry) { 629 entry->next = head; 630 if (head) { 631 head->prev = entry; 632 } else { 633 tail = entry; 634 } 635 entry->prev = NULL; 636 head = entry; 637 } 638 dequeueQueue639 inline void dequeue(T* entry) { 640 if (entry->prev) { 641 entry->prev->next = entry->next; 642 } else { 643 head = entry->next; 644 } 645 if (entry->next) { 646 entry->next->prev = entry->prev; 647 } else { 648 tail = entry->prev; 649 } 650 } 651 dequeueAtHeadQueue652 inline T* dequeueAtHead() { 653 T* entry = head; 654 head = entry->next; 655 if (head) { 656 head->prev = NULL; 657 } else { 658 tail = NULL; 659 } 660 return entry; 661 } 662 663 uint32_t count() const; 664 }; 665 666 /* Specifies which events are to be canceled and why. */ 667 struct CancelationOptions { 668 enum Mode { 669 CANCEL_ALL_EVENTS = 0, 670 CANCEL_POINTER_EVENTS = 1, 671 CANCEL_NON_POINTER_EVENTS = 2, 672 CANCEL_FALLBACK_EVENTS = 3, 673 }; 674 675 // The criterion to use to determine which events should be canceled. 676 Mode mode; 677 678 // Descriptive reason for the cancelation. 679 const char* reason; 680 681 // The specific keycode of the key event to cancel, or -1 to cancel any key event. 682 int32_t keyCode; 683 684 // The specific device id of events to cancel, or -1 to cancel events from any device. 685 int32_t deviceId; 686 CancelationOptionsCancelationOptions687 CancelationOptions(Mode mode, const char* reason) : 688 mode(mode), reason(reason), keyCode(-1), deviceId(-1) { } 689 }; 690 691 /* Tracks dispatched key and motion event state so that cancelation events can be 692 * synthesized when events are dropped. */ 693 class InputState { 694 public: 695 InputState(); 696 ~InputState(); 697 698 // Returns true if there is no state to be canceled. 699 bool isNeutral() const; 700 701 // Returns true if the specified source is known to have received a hover enter 702 // motion event. 703 bool isHovering(int32_t deviceId, uint32_t source, int32_t displayId) const; 704 705 // Records tracking information for a key event that has just been published. 706 // Returns true if the event should be delivered, false if it is inconsistent 707 // and should be skipped. 708 bool trackKey(const KeyEntry* entry, int32_t action, int32_t flags); 709 710 // Records tracking information for a motion event that has just been published. 711 // Returns true if the event should be delivered, false if it is inconsistent 712 // and should be skipped. 713 bool trackMotion(const MotionEntry* entry, int32_t action, int32_t flags); 714 715 // Synthesizes cancelation events for the current state and resets the tracked state. 716 void synthesizeCancelationEvents(nsecs_t currentTime, 717 Vector<EventEntry*>& outEvents, const CancelationOptions& options); 718 719 // Clears the current state. 720 void clear(); 721 722 // Copies pointer-related parts of the input state to another instance. 723 void copyPointerStateTo(InputState& other) const; 724 725 // Gets the fallback key associated with a keycode. 726 // Returns -1 if none. 727 // Returns AKEYCODE_UNKNOWN if we are only dispatching the unhandled key to the policy. 728 int32_t getFallbackKey(int32_t originalKeyCode); 729 730 // Sets the fallback key for a particular keycode. 731 void setFallbackKey(int32_t originalKeyCode, int32_t fallbackKeyCode); 732 733 // Removes the fallback key for a particular keycode. 734 void removeFallbackKey(int32_t originalKeyCode); 735 getFallbackKeys()736 inline const KeyedVector<int32_t, int32_t>& getFallbackKeys() const { 737 return mFallbackKeys; 738 } 739 740 private: 741 struct KeyMemento { 742 int32_t deviceId; 743 uint32_t source; 744 int32_t keyCode; 745 int32_t scanCode; 746 int32_t metaState; 747 int32_t flags; 748 nsecs_t downTime; 749 uint32_t policyFlags; 750 }; 751 752 struct MotionMemento { 753 int32_t deviceId; 754 uint32_t source; 755 int32_t flags; 756 float xPrecision; 757 float yPrecision; 758 nsecs_t downTime; 759 int32_t displayId; 760 uint32_t pointerCount; 761 PointerProperties pointerProperties[MAX_POINTERS]; 762 PointerCoords pointerCoords[MAX_POINTERS]; 763 bool hovering; 764 uint32_t policyFlags; 765 766 void setPointers(const MotionEntry* entry); 767 }; 768 769 Vector<KeyMemento> mKeyMementos; 770 Vector<MotionMemento> mMotionMementos; 771 KeyedVector<int32_t, int32_t> mFallbackKeys; 772 773 ssize_t findKeyMemento(const KeyEntry* entry) const; 774 ssize_t findMotionMemento(const MotionEntry* entry, bool hovering) const; 775 776 void addKeyMemento(const KeyEntry* entry, int32_t flags); 777 void addMotionMemento(const MotionEntry* entry, int32_t flags, bool hovering); 778 779 static bool shouldCancelKey(const KeyMemento& memento, 780 const CancelationOptions& options); 781 static bool shouldCancelMotion(const MotionMemento& memento, 782 const CancelationOptions& options); 783 }; 784 785 /* Manages the dispatch state associated with a single input channel. */ 786 class Connection : public RefBase { 787 protected: 788 virtual ~Connection(); 789 790 public: 791 enum Status { 792 // Everything is peachy. 793 STATUS_NORMAL, 794 // An unrecoverable communication error has occurred. 795 STATUS_BROKEN, 796 // The input channel has been unregistered. 797 STATUS_ZOMBIE 798 }; 799 800 Status status; 801 sp<InputChannel> inputChannel; // never null 802 sp<InputWindowHandle> inputWindowHandle; // may be null 803 bool monitor; 804 InputPublisher inputPublisher; 805 InputState inputState; 806 807 // True if the socket is full and no further events can be published until 808 // the application consumes some of the input. 809 bool inputPublisherBlocked; 810 811 // Queue of events that need to be published to the connection. 812 Queue<DispatchEntry> outboundQueue; 813 814 // Queue of events that have been published to the connection but that have not 815 // yet received a "finished" response from the application. 816 Queue<DispatchEntry> waitQueue; 817 818 explicit Connection(const sp<InputChannel>& inputChannel, 819 const sp<InputWindowHandle>& inputWindowHandle, bool monitor); 820 getInputChannelName()821 inline const char* getInputChannelName() const { return inputChannel->getName().string(); } 822 823 const char* getWindowName() const; 824 const char* getStatusLabel() const; 825 826 DispatchEntry* findWaitQueueEntry(uint32_t seq); 827 }; 828 829 enum DropReason { 830 DROP_REASON_NOT_DROPPED = 0, 831 DROP_REASON_POLICY = 1, 832 DROP_REASON_APP_SWITCH = 2, 833 DROP_REASON_DISABLED = 3, 834 DROP_REASON_BLOCKED = 4, 835 DROP_REASON_STALE = 5, 836 }; 837 838 sp<InputDispatcherPolicyInterface> mPolicy; 839 InputDispatcherConfiguration mConfig; 840 841 Mutex mLock; 842 843 Condition mDispatcherIsAliveCondition; 844 845 sp<Looper> mLooper; 846 847 EventEntry* mPendingEvent; 848 Queue<EventEntry> mInboundQueue; 849 Queue<EventEntry> mRecentQueue; 850 Queue<CommandEntry> mCommandQueue; 851 852 void dispatchOnceInnerLocked(nsecs_t* nextWakeupTime); 853 854 // Enqueues an inbound event. Returns true if mLooper->wake() should be called. 855 bool enqueueInboundEventLocked(EventEntry* entry); 856 857 // Cleans up input state when dropping an inbound event. 858 void dropInboundEventLocked(EventEntry* entry, DropReason dropReason); 859 860 // Adds an event to a queue of recent events for debugging purposes. 861 void addRecentEventLocked(EventEntry* entry); 862 863 // App switch latency optimization. 864 bool mAppSwitchSawKeyDown; 865 nsecs_t mAppSwitchDueTime; 866 867 static bool isAppSwitchKeyCode(int32_t keyCode); 868 bool isAppSwitchKeyEventLocked(KeyEntry* keyEntry); 869 bool isAppSwitchPendingLocked(); 870 void resetPendingAppSwitchLocked(bool handled); 871 872 // Stale event latency optimization. 873 static bool isStaleEventLocked(nsecs_t currentTime, EventEntry* entry); 874 875 // Blocked event latency optimization. Drops old events when the user intends 876 // to transfer focus to a new application. 877 EventEntry* mNextUnblockedEvent; 878 879 sp<InputWindowHandle> findTouchedWindowAtLocked(int32_t displayId, int32_t x, int32_t y); 880 881 // All registered connections mapped by channel file descriptor. 882 KeyedVector<int, sp<Connection> > mConnectionsByFd; 883 884 ssize_t getConnectionIndexLocked(const sp<InputChannel>& inputChannel); 885 886 // Input channels that will receive a copy of all input events. 887 Vector<sp<InputChannel> > mMonitoringChannels; 888 889 // Event injection and synchronization. 890 Condition mInjectionResultAvailableCondition; 891 bool hasInjectionPermission(int32_t injectorPid, int32_t injectorUid); 892 void setInjectionResultLocked(EventEntry* entry, int32_t injectionResult); 893 894 Condition mInjectionSyncFinishedCondition; 895 void incrementPendingForegroundDispatchesLocked(EventEntry* entry); 896 void decrementPendingForegroundDispatchesLocked(EventEntry* entry); 897 898 // Key repeat tracking. 899 struct KeyRepeatState { 900 KeyEntry* lastKeyEntry; // or null if no repeat 901 nsecs_t nextRepeatTime; 902 } mKeyRepeatState; 903 904 void resetKeyRepeatLocked(); 905 KeyEntry* synthesizeKeyRepeatLocked(nsecs_t currentTime); 906 907 // Key replacement tracking 908 struct KeyReplacement { 909 int32_t keyCode; 910 int32_t deviceId; 911 bool operator==(const KeyReplacement& rhs) const { 912 return keyCode == rhs.keyCode && deviceId == rhs.deviceId; 913 } 914 bool operator<(const KeyReplacement& rhs) const { 915 return keyCode != rhs.keyCode ? keyCode < rhs.keyCode : deviceId < rhs.deviceId; 916 } 917 }; 918 // Maps the key code replaced, device id tuple to the key code it was replaced with 919 KeyedVector<KeyReplacement, int32_t> mReplacedKeys; 920 921 // Deferred command processing. 922 bool haveCommandsLocked() const; 923 bool runCommandsLockedInterruptible(); 924 CommandEntry* postCommandLocked(Command command); 925 926 // Input filter processing. 927 bool shouldSendKeyToInputFilterLocked(const NotifyKeyArgs* args); 928 bool shouldSendMotionToInputFilterLocked(const NotifyMotionArgs* args); 929 930 // Inbound event processing. 931 void drainInboundQueueLocked(); 932 void releasePendingEventLocked(); 933 void releaseInboundEventLocked(EventEntry* entry); 934 935 // Dispatch state. 936 bool mDispatchEnabled; 937 bool mDispatchFrozen; 938 bool mInputFilterEnabled; 939 940 Vector<sp<InputWindowHandle> > mWindowHandles; 941 942 sp<InputWindowHandle> getWindowHandleLocked(const sp<InputChannel>& inputChannel) const; 943 bool hasWindowHandleLocked(const sp<InputWindowHandle>& windowHandle) const; 944 945 // Focus tracking for keys, trackball, etc. 946 sp<InputWindowHandle> mFocusedWindowHandle; 947 948 // Focus tracking for touch. 949 struct TouchedWindow { 950 sp<InputWindowHandle> windowHandle; 951 int32_t targetFlags; 952 BitSet32 pointerIds; // zero unless target flag FLAG_SPLIT is set 953 }; 954 struct TouchState { 955 bool down; 956 bool split; 957 int32_t deviceId; // id of the device that is currently down, others are rejected 958 uint32_t source; // source of the device that is current down, others are rejected 959 int32_t displayId; // id to the display that currently has a touch, others are rejected 960 Vector<TouchedWindow> windows; 961 962 TouchState(); 963 ~TouchState(); 964 void reset(); 965 void copyFrom(const TouchState& other); 966 void addOrUpdateWindow(const sp<InputWindowHandle>& windowHandle, 967 int32_t targetFlags, BitSet32 pointerIds); 968 void removeWindow(const sp<InputWindowHandle>& windowHandle); 969 void filterNonAsIsTouchWindows(); 970 sp<InputWindowHandle> getFirstForegroundWindowHandle() const; 971 bool isSlippery() const; 972 }; 973 974 KeyedVector<int32_t, TouchState> mTouchStatesByDisplay; 975 TouchState mTempTouchState; 976 977 // Focused application. 978 sp<InputApplicationHandle> mFocusedApplicationHandle; 979 980 // Dispatcher state at time of last ANR. 981 String8 mLastANRState; 982 983 // Dispatch inbound events. 984 bool dispatchConfigurationChangedLocked( 985 nsecs_t currentTime, ConfigurationChangedEntry* entry); 986 bool dispatchDeviceResetLocked( 987 nsecs_t currentTime, DeviceResetEntry* entry); 988 bool dispatchKeyLocked( 989 nsecs_t currentTime, KeyEntry* entry, 990 DropReason* dropReason, nsecs_t* nextWakeupTime); 991 bool dispatchMotionLocked( 992 nsecs_t currentTime, MotionEntry* entry, 993 DropReason* dropReason, nsecs_t* nextWakeupTime); 994 void dispatchEventLocked(nsecs_t currentTime, EventEntry* entry, 995 const Vector<InputTarget>& inputTargets); 996 997 void logOutboundKeyDetailsLocked(const char* prefix, const KeyEntry* entry); 998 void logOutboundMotionDetailsLocked(const char* prefix, const MotionEntry* entry); 999 1000 // Keeping track of ANR timeouts. 1001 enum InputTargetWaitCause { 1002 INPUT_TARGET_WAIT_CAUSE_NONE, 1003 INPUT_TARGET_WAIT_CAUSE_SYSTEM_NOT_READY, 1004 INPUT_TARGET_WAIT_CAUSE_APPLICATION_NOT_READY, 1005 }; 1006 1007 InputTargetWaitCause mInputTargetWaitCause; 1008 nsecs_t mInputTargetWaitStartTime; 1009 nsecs_t mInputTargetWaitTimeoutTime; 1010 bool mInputTargetWaitTimeoutExpired; 1011 sp<InputApplicationHandle> mInputTargetWaitApplicationHandle; 1012 1013 // Contains the last window which received a hover event. 1014 sp<InputWindowHandle> mLastHoverWindowHandle; 1015 1016 // Finding targets for input events. 1017 int32_t handleTargetsNotReadyLocked(nsecs_t currentTime, const EventEntry* entry, 1018 const sp<InputApplicationHandle>& applicationHandle, 1019 const sp<InputWindowHandle>& windowHandle, 1020 nsecs_t* nextWakeupTime, const char* reason); 1021 void resumeAfterTargetsNotReadyTimeoutLocked(nsecs_t newTimeout, 1022 const sp<InputChannel>& inputChannel); 1023 nsecs_t getTimeSpentWaitingForApplicationLocked(nsecs_t currentTime); 1024 void resetANRTimeoutsLocked(); 1025 1026 int32_t findFocusedWindowTargetsLocked(nsecs_t currentTime, const EventEntry* entry, 1027 Vector<InputTarget>& inputTargets, nsecs_t* nextWakeupTime); 1028 int32_t findTouchedWindowTargetsLocked(nsecs_t currentTime, const MotionEntry* entry, 1029 Vector<InputTarget>& inputTargets, nsecs_t* nextWakeupTime, 1030 bool* outConflictingPointerActions); 1031 1032 void addWindowTargetLocked(const sp<InputWindowHandle>& windowHandle, 1033 int32_t targetFlags, BitSet32 pointerIds, Vector<InputTarget>& inputTargets); 1034 void addMonitoringTargetsLocked(Vector<InputTarget>& inputTargets); 1035 1036 void pokeUserActivityLocked(const EventEntry* eventEntry); 1037 bool checkInjectionPermission(const sp<InputWindowHandle>& windowHandle, 1038 const InjectionState* injectionState); 1039 bool isWindowObscuredAtPointLocked(const sp<InputWindowHandle>& windowHandle, 1040 int32_t x, int32_t y) const; 1041 String8 getApplicationWindowLabelLocked(const sp<InputApplicationHandle>& applicationHandle, 1042 const sp<InputWindowHandle>& windowHandle); 1043 1044 String8 checkWindowReadyForMoreInputLocked(nsecs_t currentTime, 1045 const sp<InputWindowHandle>& windowHandle, const EventEntry* eventEntry, 1046 const char* targetType); 1047 1048 // Manage the dispatch cycle for a single connection. 1049 // These methods are deliberately not Interruptible because doing all of the work 1050 // with the mutex held makes it easier to ensure that connection invariants are maintained. 1051 // If needed, the methods post commands to run later once the critical bits are done. 1052 void prepareDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection, 1053 EventEntry* eventEntry, const InputTarget* inputTarget); 1054 void enqueueDispatchEntriesLocked(nsecs_t currentTime, const sp<Connection>& connection, 1055 EventEntry* eventEntry, const InputTarget* inputTarget); 1056 void enqueueDispatchEntryLocked(const sp<Connection>& connection, 1057 EventEntry* eventEntry, const InputTarget* inputTarget, int32_t dispatchMode); 1058 void startDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection); 1059 void finishDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection, 1060 uint32_t seq, bool handled); 1061 void abortBrokenDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection, 1062 bool notify); 1063 void drainDispatchQueueLocked(Queue<DispatchEntry>* queue); 1064 void releaseDispatchEntryLocked(DispatchEntry* dispatchEntry); 1065 static int handleReceiveCallback(int fd, int events, void* data); 1066 1067 void synthesizeCancelationEventsForAllConnectionsLocked( 1068 const CancelationOptions& options); 1069 void synthesizeCancelationEventsForInputChannelLocked(const sp<InputChannel>& channel, 1070 const CancelationOptions& options); 1071 void synthesizeCancelationEventsForConnectionLocked(const sp<Connection>& connection, 1072 const CancelationOptions& options); 1073 1074 // Splitting motion events across windows. 1075 MotionEntry* splitMotionEvent(const MotionEntry* originalMotionEntry, BitSet32 pointerIds); 1076 1077 // Reset and drop everything the dispatcher is doing. 1078 void resetAndDropEverythingLocked(const char* reason); 1079 1080 // Dump state. 1081 void dumpDispatchStateLocked(String8& dump); 1082 void logDispatchStateLocked(); 1083 1084 // Registration. 1085 void removeMonitorChannelLocked(const sp<InputChannel>& inputChannel); 1086 status_t unregisterInputChannelLocked(const sp<InputChannel>& inputChannel, bool notify); 1087 1088 // Add or remove a connection to the mActiveConnections vector. 1089 void activateConnectionLocked(Connection* connection); 1090 void deactivateConnectionLocked(Connection* connection); 1091 1092 // Interesting events that we might like to log or tell the framework about. 1093 void onDispatchCycleFinishedLocked( 1094 nsecs_t currentTime, const sp<Connection>& connection, uint32_t seq, bool handled); 1095 void onDispatchCycleBrokenLocked( 1096 nsecs_t currentTime, const sp<Connection>& connection); 1097 void onANRLocked( 1098 nsecs_t currentTime, const sp<InputApplicationHandle>& applicationHandle, 1099 const sp<InputWindowHandle>& windowHandle, 1100 nsecs_t eventTime, nsecs_t waitStartTime, const char* reason); 1101 1102 // Outbound policy interactions. 1103 void doNotifyConfigurationChangedInterruptible(CommandEntry* commandEntry); 1104 void doNotifyInputChannelBrokenLockedInterruptible(CommandEntry* commandEntry); 1105 void doNotifyANRLockedInterruptible(CommandEntry* commandEntry); 1106 void doInterceptKeyBeforeDispatchingLockedInterruptible(CommandEntry* commandEntry); 1107 void doDispatchCycleFinishedLockedInterruptible(CommandEntry* commandEntry); 1108 bool afterKeyEventLockedInterruptible(const sp<Connection>& connection, 1109 DispatchEntry* dispatchEntry, KeyEntry* keyEntry, bool handled); 1110 bool afterMotionEventLockedInterruptible(const sp<Connection>& connection, 1111 DispatchEntry* dispatchEntry, MotionEntry* motionEntry, bool handled); 1112 void doPokeUserActivityLockedInterruptible(CommandEntry* commandEntry); 1113 void initializeKeyEvent(KeyEvent* event, const KeyEntry* entry); 1114 1115 // Statistics gathering. 1116 void updateDispatchStatisticsLocked(nsecs_t currentTime, const EventEntry* entry, 1117 int32_t injectionResult, nsecs_t timeSpentWaitingForApplication); 1118 void traceInboundQueueLengthLocked(); 1119 void traceOutboundQueueLengthLocked(const sp<Connection>& connection); 1120 void traceWaitQueueLengthLocked(const sp<Connection>& connection); 1121 }; 1122 1123 /* Enqueues and dispatches input events, endlessly. */ 1124 class InputDispatcherThread : public Thread { 1125 public: 1126 explicit InputDispatcherThread(const sp<InputDispatcherInterface>& dispatcher); 1127 ~InputDispatcherThread(); 1128 1129 private: 1130 virtual bool threadLoop(); 1131 1132 sp<InputDispatcherInterface> mDispatcher; 1133 }; 1134 1135 } // namespace android 1136 1137 #endif // _UI_INPUT_DISPATCHER_H 1138