blob: e452ca29a0b891f6e1bddec6d799e67be893721f [file] [log] [blame]
Michael Wrightd02c5b62014-02-10 15:10:22 -08001/*
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
Siarhei Vishniakoue4623042020-03-25 16:16:40 -070020#include "AnrTracker.h"
Garfield Tane84e6f92019-08-29 17:28:41 -070021#include "CancelationOptions.h"
22#include "Entry.h"
23#include "InjectionState.h"
24#include "InputDispatcherConfiguration.h"
25#include "InputDispatcherInterface.h"
26#include "InputDispatcherPolicyInterface.h"
27#include "InputState.h"
28#include "InputTarget.h"
Prabir Pradhan5a57cff2019-10-31 18:40:33 -070029#include "InputThread.h"
Garfield Tane84e6f92019-08-29 17:28:41 -070030#include "Monitor.h"
31#include "TouchState.h"
32#include "TouchedWindow.h"
33
chaviw09c8d2d2020-08-24 15:48:26 -070034#include <attestation/HmacKeyManager.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080035#include <input/Input.h>
Robert Carr3720ed02018-08-08 16:08:27 -070036#include <input/InputApplication.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080037#include <input/InputTransport.h>
Robert Carr3720ed02018-08-08 16:08:27 -070038#include <input/InputWindow.h>
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -050039#include <input/LatencyStatistics.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070040#include <limits.h>
41#include <stddef.h>
Michael Wright3dd60e22019-03-27 22:06:44 +000042#include <ui/Region.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070043#include <unistd.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080044#include <utils/BitSet.h>
Garfield Tan0fc2fa72019-08-29 17:22:15 -070045#include <utils/Looper.h>
46#include <utils/RefBase.h>
47#include <utils/Timers.h>
48#include <utils/threads.h>
49#include <condition_variable>
Garfield Tane84e6f92019-08-29 17:28:41 -070050#include <deque>
Garfield Tan0fc2fa72019-08-29 17:22:15 -070051#include <optional>
Robert Carr5c8a0262018-10-03 16:30:44 -070052#include <unordered_map>
Siarhei Vishniakou887b7d92020-06-18 00:43:02 +000053#include <unordered_set>
Michael Wrightd02c5b62014-02-10 15:10:22 -080054
Garfield Tane84e6f92019-08-29 17:28:41 -070055#include <InputListener.h>
56#include <InputReporterInterface.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080057
Garfield Tane84e6f92019-08-29 17:28:41 -070058namespace android::inputdispatcher {
Michael Wrightd02c5b62014-02-10 15:10:22 -080059
Garfield Tane84e6f92019-08-29 17:28:41 -070060class Connection;
Michael Wrightd02c5b62014-02-10 15:10:22 -080061
62/* Dispatches events to input targets. Some functions of the input dispatcher, such as
63 * identifying input targets, are controlled by a separate policy object.
64 *
65 * IMPORTANT INVARIANT:
66 * Because the policy can potentially block or cause re-entrance into the input dispatcher,
67 * the input dispatcher never calls into the policy while holding its internal locks.
68 * The implementation is also carefully designed to recover from scenarios such as an
69 * input channel becoming unregistered while identifying input targets or processing timeouts.
70 *
71 * Methods marked 'Locked' must be called with the lock acquired.
72 *
73 * Methods marked 'LockedInterruptible' must be called with the lock acquired but
74 * may during the course of their execution release the lock, call into the policy, and
75 * then reacquire the lock. The caller is responsible for recovering gracefully.
76 *
77 * A 'LockedInterruptible' method may called a 'Locked' method, but NOT vice-versa.
78 */
Garfield Tane84e6f92019-08-29 17:28:41 -070079class InputDispatcher : public android::InputDispatcherInterface {
Michael Wrightd02c5b62014-02-10 15:10:22 -080080protected:
81 virtual ~InputDispatcher();
82
83public:
84 explicit InputDispatcher(const sp<InputDispatcherPolicyInterface>& policy);
85
Michael Wright3dd60e22019-03-27 22:06:44 +000086 virtual void dump(std::string& dump) override;
87 virtual void monitor() override;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -080088 virtual bool waitForIdle() override;
Prabir Pradhan3608aad2019-10-02 17:08:26 -070089 virtual status_t start() override;
90 virtual status_t stop() override;
Michael Wrightd02c5b62014-02-10 15:10:22 -080091
Michael Wright3dd60e22019-03-27 22:06:44 +000092 virtual void notifyConfigurationChanged(const NotifyConfigurationChangedArgs* args) override;
93 virtual void notifyKey(const NotifyKeyArgs* args) override;
94 virtual void notifyMotion(const NotifyMotionArgs* args) override;
95 virtual void notifySwitch(const NotifySwitchArgs* args) override;
96 virtual void notifyDeviceReset(const NotifyDeviceResetArgs* args) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -080097
Garfield Tan0fc2fa72019-08-29 17:22:15 -070098 virtual int32_t injectInputEvent(const InputEvent* event, int32_t injectorPid,
Siarhei Vishniakou097c3db2020-05-06 14:18:38 -070099 int32_t injectorUid, int32_t syncMode,
100 std::chrono::milliseconds timeout,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700101 uint32_t policyFlags) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800102
Siarhei Vishniakou54d3e182020-01-15 17:38:38 -0800103 virtual std::unique_ptr<VerifiedInputEvent> verifyInputEvent(const InputEvent& event) override;
104
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700105 virtual void setInputWindows(
Arthur Hung72d8dc32020-03-28 00:48:39 +0000106 const std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>>&
107 handlesPerDisplay) override;
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700108 virtual void setFocusedApplication(
Chris Yea209fde2020-07-22 13:54:51 -0700109 int32_t displayId,
110 const std::shared_ptr<InputApplicationHandle>& inputApplicationHandle) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000111 virtual void setFocusedDisplay(int32_t displayId) override;
112 virtual void setInputDispatchMode(bool enabled, bool frozen) override;
113 virtual void setInputFilterEnabled(bool enabled) override;
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800114 virtual void setInTouchMode(bool inTouchMode) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800115
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700116 virtual bool transferTouchFocus(const sp<IBinder>& fromToken,
117 const sp<IBinder>& toToken) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800118
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500119 virtual status_t registerInputChannel(
120 const std::shared_ptr<InputChannel>& inputChannel) override;
Vishnu Naire798b472020-07-23 13:52:21 -0700121 virtual void setFocusedWindow(const FocusRequest&) override;
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500122 virtual status_t registerInputMonitor(const std::shared_ptr<InputChannel>& inputChannel,
123 int32_t displayId, bool isGestureMonitor) override;
124 virtual status_t unregisterInputChannel(const InputChannel& inputChannel) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000125 virtual status_t pilferPointers(const sp<IBinder>& token) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800126
chaviw09c8d2d2020-08-24 15:48:26 -0700127 std::array<uint8_t, 32> sign(const VerifiedInputEvent& event) const;
128
Michael Wrightd02c5b62014-02-10 15:10:22 -0800129private:
Siarhei Vishniakou0fb1a0e2019-10-22 11:23:36 -0700130 enum class DropReason {
131 NOT_DROPPED,
132 POLICY,
133 APP_SWITCH,
134 DISABLED,
135 BLOCKED,
136 STALE,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800137 };
138
Prabir Pradhan5a57cff2019-10-31 18:40:33 -0700139 std::unique_ptr<InputThread> mThread;
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700140
Michael Wrightd02c5b62014-02-10 15:10:22 -0800141 sp<InputDispatcherPolicyInterface> mPolicy;
Garfield Tane84e6f92019-08-29 17:28:41 -0700142 android::InputDispatcherConfiguration mConfig;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800143
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800144 std::mutex mLock;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800145
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800146 std::condition_variable mDispatcherIsAlive;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -0800147 std::condition_variable mDispatcherEnteredIdle;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800148
149 sp<Looper> mLooper;
150
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800151 EventEntry* mPendingEvent GUARDED_BY(mLock);
Siarhei Vishniakou44a2aed2019-07-29 08:59:52 -0700152 std::deque<EventEntry*> mInboundQueue GUARDED_BY(mLock);
153 std::deque<EventEntry*> mRecentQueue GUARDED_BY(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700154 std::deque<std::unique_ptr<CommandEntry>> mCommandQueue GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800155
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800156 DropReason mLastDropReason GUARDED_BY(mLock);
Michael Wright3a981722015-06-10 15:26:13 +0100157
Garfield Tan1c7bc862020-01-28 13:24:04 -0800158 const IdGenerator mIdGenerator;
159
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700160 // With each iteration, InputDispatcher nominally processes one queued event,
161 // a timeout, or a response from an input consumer.
162 // This method should only be called on the input dispatcher's own thread.
163 void dispatchOnce();
164
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800165 void dispatchOnceInnerLocked(nsecs_t* nextWakeupTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800166
167 // Enqueues an inbound event. Returns true if mLooper->wake() should be called.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800168 bool enqueueInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800169
170 // Cleans up input state when dropping an inbound event.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700171 void dropInboundEventLocked(const EventEntry& entry, DropReason dropReason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800172
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100173 // Enqueues a focus event.
Vishnu Nair7d3d00d2020-08-03 11:20:42 -0700174 void enqueueFocusEventLocked(const InputWindowHandle& window, bool hasFocus,
175 std::string_view reason) REQUIRES(mLock);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100176
Michael Wrightd02c5b62014-02-10 15:10:22 -0800177 // Adds an event to a queue of recent events for debugging purposes.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800178 void addRecentEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800179
180 // App switch latency optimization.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800181 bool mAppSwitchSawKeyDown GUARDED_BY(mLock);
182 nsecs_t mAppSwitchDueTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800183
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700184 bool isAppSwitchKeyEvent(const KeyEntry& keyEntry);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800185 bool isAppSwitchPendingLocked() REQUIRES(mLock);
186 void resetPendingAppSwitchLocked(bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800187
Michael Wrightd02c5b62014-02-10 15:10:22 -0800188 // Blocked event latency optimization. Drops old events when the user intends
189 // to transfer focus to a new application.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800190 EventEntry* mNextUnblockedEvent GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800191
Tiger Huang85b8c5e2019-01-17 18:34:54 +0800192 sp<InputWindowHandle> findTouchedWindowAtLocked(int32_t displayId, int32_t x, int32_t y,
Siarhei Vishniakou1ea3cf12020-03-24 19:50:03 -0700193 TouchState* touchState,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700194 bool addOutsideTargets = false,
195 bool addPortalWindows = false) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800196
197 // All registered connections mapped by channel file descriptor.
Siarhei Vishniakou146ecfd2019-07-29 16:04:31 -0700198 std::unordered_map<int, sp<Connection>> mConnectionsByFd GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800199
Siarhei Vishniakouffaa2b12020-05-26 21:43:02 -0700200 sp<Connection> getConnectionLocked(const sp<IBinder>& inputConnectionToken) const
201 REQUIRES(mLock);
202
203 void removeConnectionLocked(const sp<Connection>& connection) REQUIRES(mLock);
204
Robert Carr5c8a0262018-10-03 16:30:44 -0700205 struct IBinderHash {
206 std::size_t operator()(const sp<IBinder>& b) const {
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700207 return std::hash<IBinder*>{}(b.get());
Robert Carr5c8a0262018-10-03 16:30:44 -0700208 }
209 };
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500210 std::unordered_map<sp<IBinder>, std::shared_ptr<InputChannel>, IBinderHash>
211 mInputChannelsByToken GUARDED_BY(mLock);
Robert Carr5c8a0262018-10-03 16:30:44 -0700212
Michael Wright3dd60e22019-03-27 22:06:44 +0000213 // Finds the display ID of the gesture monitor identified by the provided token.
214 std::optional<int32_t> findGestureMonitorDisplayByTokenLocked(const sp<IBinder>& token)
215 REQUIRES(mLock);
216
Arthur Hung2fbf37f2018-09-13 18:16:41 +0800217 // Input channels that will receive a copy of all input events sent to the provided display.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700218 std::unordered_map<int32_t, std::vector<Monitor>> mGlobalMonitorsByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800219
Michael Wright3dd60e22019-03-27 22:06:44 +0000220 // Input channels that will receive pointer events that start within the corresponding display.
221 // These are a bit special when compared to global monitors since they'll cause gesture streams
222 // to continue even when there isn't a touched window,and have the ability to steal the rest of
223 // the pointer stream in order to claim it for a system gesture.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700224 std::unordered_map<int32_t, std::vector<Monitor>> mGestureMonitorsByDisplay GUARDED_BY(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000225
Edgar Arriaga3d61bc12020-04-16 18:46:48 -0700226 const HmacKeyManager mHmacKeyManager;
227 const std::array<uint8_t, 32> getSignature(const MotionEntry& motionEntry,
228 const DispatchEntry& dispatchEntry) const;
229 const std::array<uint8_t, 32> getSignature(const KeyEntry& keyEntry,
230 const DispatchEntry& dispatchEntry) const;
Gang Wange9087892020-01-07 12:17:14 -0500231
Michael Wrightd02c5b62014-02-10 15:10:22 -0800232 // Event injection and synchronization.
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800233 std::condition_variable mInjectionResultAvailable;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800234 bool hasInjectionPermission(int32_t injectorPid, int32_t injectorUid);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800235 void setInjectionResult(EventEntry* entry, int32_t injectionResult);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800236
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800237 std::condition_variable mInjectionSyncFinished;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800238 void incrementPendingForegroundDispatches(EventEntry* entry);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800239 void decrementPendingForegroundDispatches(EventEntry* entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800240
241 // Key repeat tracking.
242 struct KeyRepeatState {
243 KeyEntry* lastKeyEntry; // or null if no repeat
244 nsecs_t nextRepeatTime;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800245 } mKeyRepeatState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800246
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800247 void resetKeyRepeatLocked() REQUIRES(mLock);
248 KeyEntry* synthesizeKeyRepeatLocked(nsecs_t currentTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800249
Michael Wright78f24442014-08-06 15:55:28 -0700250 // Key replacement tracking
251 struct KeyReplacement {
252 int32_t keyCode;
253 int32_t deviceId;
254 bool operator==(const KeyReplacement& rhs) const {
255 return keyCode == rhs.keyCode && deviceId == rhs.deviceId;
256 }
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700257 };
258 struct KeyReplacementHash {
259 size_t operator()(const KeyReplacement& key) const {
260 return std::hash<int32_t>()(key.keyCode) ^ (std::hash<int32_t>()(key.deviceId) << 1);
Michael Wright78f24442014-08-06 15:55:28 -0700261 }
262 };
263 // Maps the key code replaced, device id tuple to the key code it was replaced with
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700264 std::unordered_map<KeyReplacement, int32_t, KeyReplacementHash> mReplacedKeys GUARDED_BY(mLock);
Siarhei Vishniakou61fafdd2018-04-13 11:00:58 -0500265 // Process certain Meta + Key combinations
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700266 void accelerateMetaShortcuts(const int32_t deviceId, const int32_t action, int32_t& keyCode,
267 int32_t& metaState);
Michael Wright78f24442014-08-06 15:55:28 -0700268
Michael Wrightd02c5b62014-02-10 15:10:22 -0800269 // Deferred command processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800270 bool haveCommandsLocked() const REQUIRES(mLock);
271 bool runCommandsLockedInterruptible() REQUIRES(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700272 void postCommandLocked(std::unique_ptr<CommandEntry> commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800273
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700274 nsecs_t processAnrsLocked() REQUIRES(mLock);
Siarhei Vishniakou70622952020-07-30 11:17:23 -0500275 std::chrono::nanoseconds getDispatchingTimeoutLocked(const sp<IBinder>& token) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700276
Michael Wrightd02c5b62014-02-10 15:10:22 -0800277 // Input filter processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800278 bool shouldSendKeyToInputFilterLocked(const NotifyKeyArgs* args) REQUIRES(mLock);
279 bool shouldSendMotionToInputFilterLocked(const NotifyMotionArgs* args) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800280
281 // Inbound event processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800282 void drainInboundQueueLocked() REQUIRES(mLock);
283 void releasePendingEventLocked() REQUIRES(mLock);
284 void releaseInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800285
286 // Dispatch state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800287 bool mDispatchEnabled GUARDED_BY(mLock);
288 bool mDispatchFrozen GUARDED_BY(mLock);
289 bool mInputFilterEnabled GUARDED_BY(mLock);
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800290 bool mInTouchMode GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800291
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800292 std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>> mWindowHandlesByDisplay
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800293 GUARDED_BY(mLock);
Arthur Hung72d8dc32020-03-28 00:48:39 +0000294 void setInputWindowsLocked(const std::vector<sp<InputWindowHandle>>& inputWindowHandles,
295 int32_t displayId) REQUIRES(mLock);
Arthur Hungb92218b2018-08-14 12:00:21 +0800296 // Get window handles by display, return an empty vector if not found.
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800297 std::vector<sp<InputWindowHandle>> getWindowHandlesLocked(int32_t displayId) const
298 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800299 sp<InputWindowHandle> getWindowHandleLocked(const sp<IBinder>& windowHandleToken) const
300 REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500301 std::shared_ptr<InputChannel> getInputChannelLocked(const sp<IBinder>& windowToken) const
302 REQUIRES(mLock);
Mady Mellor017bcd12020-06-23 19:12:00 +0000303 bool hasWindowHandleLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
Siarhei Vishniakoua2862a02020-07-20 16:36:46 -0500304 bool hasResponsiveConnectionLocked(InputWindowHandle& windowHandle) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800305
Siarhei Vishniakoub3ad35c2019-04-05 10:50:52 -0700306 /*
307 * Validate and update InputWindowHandles for a given display.
308 */
309 void updateWindowHandlesForDisplayLocked(
310 const std::vector<sp<InputWindowHandle>>& inputWindowHandles, int32_t displayId)
311 REQUIRES(mLock);
312
Michael Wrightd02c5b62014-02-10 15:10:22 -0800313 // Focus tracking for keys, trackball, etc.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800314 std::unordered_map<int32_t, sp<InputWindowHandle>> mFocusedWindowHandlesByDisplay
315 GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800316
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700317 std::unordered_map<int32_t, TouchState> mTouchStatesByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800318
Tiger Huang721e26f2018-07-24 22:26:19 +0800319 // Focused applications.
Chris Yea209fde2020-07-22 13:54:51 -0700320 std::unordered_map<int32_t, std::shared_ptr<InputApplicationHandle>>
321 mFocusedApplicationHandlesByDisplay GUARDED_BY(mLock);
Tiger Huang721e26f2018-07-24 22:26:19 +0800322
323 // Top focused display.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800324 int32_t mFocusedDisplayId GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800325
326 // Dispatcher state at time of last ANR.
Siarhei Vishniakoub1a16272020-05-06 16:09:19 -0700327 std::string mLastAnrState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800328
Siarhei Vishniakou887b7d92020-06-18 00:43:02 +0000329 // The connection tokens of the channels that the user last interacted, for debugging
330 std::unordered_set<sp<IBinder>, IBinderHash> mInteractionConnectionTokens GUARDED_BY(mLock);
331 void updateInteractionTokensLocked(const EventEntry& entry,
332 const std::vector<InputTarget>& targets) REQUIRES(mLock);
333
Michael Wrightd02c5b62014-02-10 15:10:22 -0800334 // Dispatch inbound events.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700335 bool dispatchConfigurationChangedLocked(nsecs_t currentTime, ConfigurationChangedEntry* entry)
336 REQUIRES(mLock);
337 bool dispatchDeviceResetLocked(nsecs_t currentTime, DeviceResetEntry* entry) REQUIRES(mLock);
338 bool dispatchKeyLocked(nsecs_t currentTime, KeyEntry* entry, DropReason* dropReason,
339 nsecs_t* nextWakeupTime) REQUIRES(mLock);
340 bool dispatchMotionLocked(nsecs_t currentTime, MotionEntry* entry, DropReason* dropReason,
341 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100342 void dispatchFocusLocked(nsecs_t currentTime, FocusEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800343 void dispatchEventLocked(nsecs_t currentTime, EventEntry* entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700344 const std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800345
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700346 void logOutboundKeyDetails(const char* prefix, const KeyEntry& entry);
347 void logOutboundMotionDetails(const char* prefix, const MotionEntry& entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800348
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700349 /**
350 * This field is set if there is no focused window, and we have an event that requires
351 * a focused window to be dispatched (for example, a KeyEvent).
352 * When this happens, we will wait until *mNoFocusedWindowTimeoutTime before
353 * dropping the event and raising an ANR for that application.
354 * This is useful if an application is slow to add a focused window.
355 */
356 std::optional<nsecs_t> mNoFocusedWindowTimeoutTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800357
Siarhei Vishniakoude1bc4a2020-05-26 22:39:43 -0700358 bool shouldPruneInboundQueueLocked(const MotionEntry& motionEntry) REQUIRES(mLock);
359
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700360 /**
361 * Time to stop waiting for the events to be processed while trying to dispatch a key.
362 * When this time expires, we just send the pending key event to the currently focused window,
363 * without waiting on other events to be processed first.
364 */
365 std::optional<nsecs_t> mKeyIsWaitingForEventsTimeout GUARDED_BY(mLock);
366 bool shouldWaitToSendKeyLocked(nsecs_t currentTime, const char* focusedWindowName)
367 REQUIRES(mLock);
368
369 /**
370 * The focused application at the time when no focused window was present.
371 * Used to raise an ANR when we have no focused window.
372 */
Chris Yea209fde2020-07-22 13:54:51 -0700373 std::shared_ptr<InputApplicationHandle> mAwaitedFocusedApplication GUARDED_BY(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700374
375 // Optimization: AnrTracker is used to quickly find which connection is due for a timeout next.
376 // AnrTracker must be kept in-sync with all responsive connection.waitQueues.
377 // If a connection is not responsive, then the entries should not be added to the AnrTracker.
378 // Once a connection becomes unresponsive, its entries are removed from AnrTracker to
379 // prevent unneeded wakeups.
380 AnrTracker mAnrTracker GUARDED_BY(mLock);
Chris Yea209fde2020-07-22 13:54:51 -0700381 void extendAnrTimeoutsLocked(const std::shared_ptr<InputApplicationHandle>& application,
Siarhei Vishniakouc1ae5562020-06-30 14:22:57 -0500382 const sp<IBinder>& connectionToken,
383 std::chrono::nanoseconds timeoutExtension) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700384
Michael Wrightd02c5b62014-02-10 15:10:22 -0800385 // Contains the last window which received a hover event.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800386 sp<InputWindowHandle> mLastHoverWindowHandle GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800387
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700388 void cancelEventsForAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800389 nsecs_t getTimeSpentWaitingForApplicationLocked(nsecs_t currentTime) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700390 // If a focused application changes, we should stop counting down the "no focused window" time,
391 // because we will have no way of knowing when the previous application actually added a window.
392 // This also means that we will miss cases like pulling down notification shade when the
393 // focused application does not have a focused window (no ANR will be raised if notification
394 // shade is pulled down while we are counting down the timeout).
395 void resetNoFocusedWindowTimeoutLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800396
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700397 int32_t getTargetDisplayId(const EventEntry& entry);
398 int32_t findFocusedWindowTargetsLocked(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700399 std::vector<InputTarget>& inputTargets,
400 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700401 int32_t findTouchedWindowTargetsLocked(nsecs_t currentTime, const MotionEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700402 std::vector<InputTarget>& inputTargets,
403 nsecs_t* nextWakeupTime,
404 bool* outConflictingPointerActions) REQUIRES(mLock);
405 std::vector<TouchedMonitor> findTouchedGestureMonitorsLocked(
Siarhei Vishniakoue0fb6bd2020-04-13 11:40:37 -0700406 int32_t displayId, const std::vector<sp<InputWindowHandle>>& portalWindows) const
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700407 REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700408 std::vector<TouchedMonitor> selectResponsiveMonitorsLocked(
409 const std::vector<TouchedMonitor>& gestureMonitors) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800410
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700411 void addWindowTargetLocked(const sp<InputWindowHandle>& windowHandle, int32_t targetFlags,
412 BitSet32 pointerIds, std::vector<InputTarget>& inputTargets)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800413 REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000414 void addMonitoringTargetLocked(const Monitor& monitor, float xOffset, float yOffset,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700415 std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
416 void addGlobalMonitoringTargetsLocked(std::vector<InputTarget>& inputTargets, int32_t displayId,
417 float xOffset = 0, float yOffset = 0) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800418
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700419 void pokeUserActivityLocked(const EventEntry& eventEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800420 bool checkInjectionPermission(const sp<InputWindowHandle>& windowHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700421 const InjectionState* injectionState);
422 bool isWindowObscuredAtPointLocked(const sp<InputWindowHandle>& windowHandle, int32_t x,
423 int32_t y) const REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800424 bool isWindowObscuredLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
Chris Yea209fde2020-07-22 13:54:51 -0700425 std::string getApplicationWindowLabel(
426 const std::shared_ptr<InputApplicationHandle>& applicationHandle,
427 const sp<InputWindowHandle>& windowHandle);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800428
Michael Wrightd02c5b62014-02-10 15:10:22 -0800429 // Manage the dispatch cycle for a single connection.
430 // These methods are deliberately not Interruptible because doing all of the work
431 // with the mutex held makes it easier to ensure that connection invariants are maintained.
432 // If needed, the methods post commands to run later once the critical bits are done.
433 void prepareDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800434 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700435 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800436 void enqueueDispatchEntriesLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800437 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700438 REQUIRES(mLock);
439 void enqueueDispatchEntryLocked(const sp<Connection>& connection, EventEntry* eventEntry,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800440 const InputTarget& inputTarget, int32_t dispatchMode)
chaviw8c9cf542019-03-25 13:02:48 -0700441 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800442 void startDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection)
443 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800444 void finishDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700445 uint32_t seq, bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800446 void abortBrokenDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700447 bool notify) REQUIRES(mLock);
Siarhei Vishniakou13bda6c2019-07-29 08:34:33 -0700448 void drainDispatchQueue(std::deque<DispatchEntry*>& queue);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800449 void releaseDispatchEntry(DispatchEntry* dispatchEntry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800450 static int handleReceiveCallback(int fd, int events, void* data);
chaviw8c9cf542019-03-25 13:02:48 -0700451 // The action sent should only be of type AMOTION_EVENT_*
chaviwfd6d3512019-03-25 13:23:49 -0700452 void dispatchPointerDownOutsideFocus(uint32_t source, int32_t action,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700453 const sp<IBinder>& newToken) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800454
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700455 void synthesizeCancelationEventsForAllConnectionsLocked(const CancelationOptions& options)
456 REQUIRES(mLock);
457 void synthesizeCancelationEventsForMonitorsLocked(const CancelationOptions& options)
458 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800459 void synthesizeCancelationEventsForMonitorsLocked(
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700460 const CancelationOptions& options,
Michael Wright3dd60e22019-03-27 22:06:44 +0000461 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500462 void synthesizeCancelationEventsForInputChannelLocked(
463 const std::shared_ptr<InputChannel>& channel, const CancelationOptions& options)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700464 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800465 void synthesizeCancelationEventsForConnectionLocked(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700466 const CancelationOptions& options)
467 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800468
Svet Ganov5d3bc372020-01-26 23:11:07 -0800469 void synthesizePointerDownEventsForConnectionLocked(const sp<Connection>& connection)
470 REQUIRES(mLock);
471
Michael Wrightd02c5b62014-02-10 15:10:22 -0800472 // Splitting motion events across windows.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700473 MotionEntry* splitMotionEvent(const MotionEntry& originalMotionEntry, BitSet32 pointerIds);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800474
475 // Reset and drop everything the dispatcher is doing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800476 void resetAndDropEverythingLocked(const char* reason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800477
478 // Dump state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800479 void dumpDispatchStateLocked(std::string& dump) REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000480 void dumpMonitors(std::string& dump, const std::vector<Monitor>& monitors);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800481 void logDispatchStateLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800482
483 // Registration.
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500484 void removeMonitorChannelLocked(const InputChannel& inputChannel) REQUIRES(mLock);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700485 void removeMonitorChannelLocked(
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500486 const InputChannel& inputChannel,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700487 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500488 status_t unregisterInputChannelLocked(const InputChannel& inputChannel, bool notify)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800489 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800490
491 // Interesting events that we might like to log or tell the framework about.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700492 void onDispatchCycleFinishedLocked(nsecs_t currentTime, const sp<Connection>& connection,
493 uint32_t seq, bool handled) REQUIRES(mLock);
494 void onDispatchCycleBrokenLocked(nsecs_t currentTime, const sp<Connection>& connection)
495 REQUIRES(mLock);
chaviw0c06c6e2019-01-09 13:27:07 -0800496 void onFocusChangedLocked(const sp<InputWindowHandle>& oldFocus,
Vishnu Nair7d3d00d2020-08-03 11:20:42 -0700497 const sp<InputWindowHandle>& newFocus, int32_t displayId,
498 std::string_view reason) REQUIRES(mLock);
499 void notifyFocusChangedLocked(const sp<InputWindowHandle>& oldFocus,
500 const sp<InputWindowHandle>& newFocus) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700501 void onAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
Chris Yea209fde2020-07-22 13:54:51 -0700502 void onAnrLocked(const std::shared_ptr<InputApplicationHandle>& application) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700503 void updateLastAnrStateLocked(const sp<InputWindowHandle>& window, const std::string& reason)
504 REQUIRES(mLock);
Chris Yea209fde2020-07-22 13:54:51 -0700505 void updateLastAnrStateLocked(const std::shared_ptr<InputApplicationHandle>& application,
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700506 const std::string& reason) REQUIRES(mLock);
507 void updateLastAnrStateLocked(const std::string& windowLabel, const std::string& reason)
508 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800509
510 // Outbound policy interactions.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800511 void doNotifyConfigurationChangedLockedInterruptible(CommandEntry* commandEntry)
512 REQUIRES(mLock);
513 void doNotifyInputChannelBrokenLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
514 void doNotifyFocusChangedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakoub1a16272020-05-06 16:09:19 -0700515 void doNotifyAnrLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800516 void doInterceptKeyBeforeDispatchingLockedInterruptible(CommandEntry* commandEntry)
517 REQUIRES(mLock);
518 void doDispatchCycleFinishedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800519 bool afterKeyEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700520 DispatchEntry* dispatchEntry, KeyEntry* keyEntry,
521 bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800522 bool afterMotionEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700523 DispatchEntry* dispatchEntry, MotionEntry* motionEntry,
524 bool handled) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800525 void doPokeUserActivityLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou9757f782019-10-29 12:53:08 -0700526 KeyEvent createKeyEvent(const KeyEntry& entry);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700527 void doOnPointerDownOutsideFocusLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800528
529 // Statistics gathering.
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -0500530 static constexpr std::chrono::duration TOUCH_STATS_REPORT_PERIOD = 5min;
531 LatencyStatistics mTouchStatistics{TOUCH_STATS_REPORT_PERIOD};
532
533 void reportTouchEventForStatistics(const MotionEntry& entry);
Siarhei Vishniakou7f0a4392020-03-24 20:49:09 -0700534 void reportDispatchStatistics(std::chrono::nanoseconds eventDuration,
535 const Connection& connection, bool handled);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800536 void traceInboundQueueLengthLocked() REQUIRES(mLock);
537 void traceOutboundQueueLength(const sp<Connection>& connection);
538 void traceWaitQueueLength(const sp<Connection>& connection);
Prabir Pradhanf93562f2018-11-29 12:13:37 -0800539
Prabir Pradhan79a4f0c2019-01-09 11:24:01 -0800540 sp<InputReporterInterface> mReporter;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800541};
542
Garfield Tane84e6f92019-08-29 17:28:41 -0700543} // namespace android::inputdispatcher
Michael Wrightd02c5b62014-02-10 15:10:22 -0800544
545#endif // _UI_INPUT_DISPATCHER_H