blob: 42583bcabe484503d6d58a86ca5457efa61bcfcb [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
Michael Wrightd02c5b62014-02-10 15:10:22 -080034#include <input/Input.h>
Robert Carr3720ed02018-08-08 16:08:27 -070035#include <input/InputApplication.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080036#include <input/InputTransport.h>
Robert Carr3720ed02018-08-08 16:08:27 -070037#include <input/InputWindow.h>
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -050038#include <input/LatencyStatistics.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070039#include <limits.h>
40#include <stddef.h>
Michael Wright3dd60e22019-03-27 22:06:44 +000041#include <ui/Region.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070042#include <unistd.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080043#include <utils/BitSet.h>
Garfield Tan0fc2fa72019-08-29 17:22:15 -070044#include <utils/Looper.h>
45#include <utils/RefBase.h>
46#include <utils/Timers.h>
47#include <utils/threads.h>
48#include <condition_variable>
Garfield Tane84e6f92019-08-29 17:28:41 -070049#include <deque>
Garfield Tan0fc2fa72019-08-29 17:22:15 -070050#include <optional>
Robert Carr5c8a0262018-10-03 16:30:44 -070051#include <unordered_map>
Michael Wrightd02c5b62014-02-10 15:10:22 -080052
Garfield Tane84e6f92019-08-29 17:28:41 -070053#include <InputListener.h>
54#include <InputReporterInterface.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080055
Garfield Tane84e6f92019-08-29 17:28:41 -070056namespace android::inputdispatcher {
Michael Wrightd02c5b62014-02-10 15:10:22 -080057
Garfield Tane84e6f92019-08-29 17:28:41 -070058class Connection;
Michael Wrightd02c5b62014-02-10 15:10:22 -080059
Gang Wang342c9272020-01-13 13:15:04 -050060class HmacKeyManager {
61public:
62 HmacKeyManager();
63 std::array<uint8_t, 32> sign(const VerifiedInputEvent& event) const;
64
65private:
Edgar Arriaga3d61bc12020-04-16 18:46:48 -070066 std::array<uint8_t, 32> sign(const uint8_t* data, size_t size) const;
Gang Wang342c9272020-01-13 13:15:04 -050067 const std::array<uint8_t, 128> mHmacKey;
68};
69
Michael Wrightd02c5b62014-02-10 15:10:22 -080070/* Dispatches events to input targets. Some functions of the input dispatcher, such as
71 * identifying input targets, are controlled by a separate policy object.
72 *
73 * IMPORTANT INVARIANT:
74 * Because the policy can potentially block or cause re-entrance into the input dispatcher,
75 * the input dispatcher never calls into the policy while holding its internal locks.
76 * The implementation is also carefully designed to recover from scenarios such as an
77 * input channel becoming unregistered while identifying input targets or processing timeouts.
78 *
79 * Methods marked 'Locked' must be called with the lock acquired.
80 *
81 * Methods marked 'LockedInterruptible' must be called with the lock acquired but
82 * may during the course of their execution release the lock, call into the policy, and
83 * then reacquire the lock. The caller is responsible for recovering gracefully.
84 *
85 * A 'LockedInterruptible' method may called a 'Locked' method, but NOT vice-versa.
86 */
Garfield Tane84e6f92019-08-29 17:28:41 -070087class InputDispatcher : public android::InputDispatcherInterface {
Michael Wrightd02c5b62014-02-10 15:10:22 -080088protected:
89 virtual ~InputDispatcher();
90
91public:
92 explicit InputDispatcher(const sp<InputDispatcherPolicyInterface>& policy);
93
Michael Wright3dd60e22019-03-27 22:06:44 +000094 virtual void dump(std::string& dump) override;
95 virtual void monitor() override;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -080096 virtual bool waitForIdle() override;
Prabir Pradhan3608aad2019-10-02 17:08:26 -070097 virtual status_t start() override;
98 virtual status_t stop() override;
Michael Wrightd02c5b62014-02-10 15:10:22 -080099
Michael Wright3dd60e22019-03-27 22:06:44 +0000100 virtual void notifyConfigurationChanged(const NotifyConfigurationChangedArgs* args) override;
101 virtual void notifyKey(const NotifyKeyArgs* args) override;
102 virtual void notifyMotion(const NotifyMotionArgs* args) override;
103 virtual void notifySwitch(const NotifySwitchArgs* args) override;
104 virtual void notifyDeviceReset(const NotifyDeviceResetArgs* args) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800105
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700106 virtual int32_t injectInputEvent(const InputEvent* event, int32_t injectorPid,
Siarhei Vishniakou097c3db2020-05-06 14:18:38 -0700107 int32_t injectorUid, int32_t syncMode,
108 std::chrono::milliseconds timeout,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700109 uint32_t policyFlags) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800110
Siarhei Vishniakou54d3e182020-01-15 17:38:38 -0800111 virtual std::unique_ptr<VerifiedInputEvent> verifyInputEvent(const InputEvent& event) override;
112
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700113 virtual void setInputWindows(
Arthur Hung72d8dc32020-03-28 00:48:39 +0000114 const std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>>&
115 handlesPerDisplay) override;
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700116 virtual void setFocusedApplication(
117 int32_t displayId, const sp<InputApplicationHandle>& inputApplicationHandle) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000118 virtual void setFocusedDisplay(int32_t displayId) override;
119 virtual void setInputDispatchMode(bool enabled, bool frozen) override;
120 virtual void setInputFilterEnabled(bool enabled) override;
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800121 virtual void setInTouchMode(bool inTouchMode) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800122
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700123 virtual bool transferTouchFocus(const sp<IBinder>& fromToken,
124 const sp<IBinder>& toToken) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800125
Siarhei Vishniakou7c34b232019-10-11 19:08:48 -0700126 virtual status_t registerInputChannel(const sp<InputChannel>& inputChannel) override;
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700127 virtual status_t registerInputMonitor(const sp<InputChannel>& inputChannel, int32_t displayId,
128 bool isGestureMonitor) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000129 virtual status_t unregisterInputChannel(const sp<InputChannel>& inputChannel) override;
130 virtual status_t pilferPointers(const sp<IBinder>& token) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800131
132private:
Siarhei Vishniakou0fb1a0e2019-10-22 11:23:36 -0700133 enum class DropReason {
134 NOT_DROPPED,
135 POLICY,
136 APP_SWITCH,
137 DISABLED,
138 BLOCKED,
139 STALE,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800140 };
141
Prabir Pradhan5a57cff2019-10-31 18:40:33 -0700142 std::unique_ptr<InputThread> mThread;
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700143
Michael Wrightd02c5b62014-02-10 15:10:22 -0800144 sp<InputDispatcherPolicyInterface> mPolicy;
Garfield Tane84e6f92019-08-29 17:28:41 -0700145 android::InputDispatcherConfiguration mConfig;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800146
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800147 std::mutex mLock;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800148
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800149 std::condition_variable mDispatcherIsAlive;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -0800150 std::condition_variable mDispatcherEnteredIdle;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800151
152 sp<Looper> mLooper;
153
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800154 EventEntry* mPendingEvent GUARDED_BY(mLock);
Siarhei Vishniakou44a2aed2019-07-29 08:59:52 -0700155 std::deque<EventEntry*> mInboundQueue GUARDED_BY(mLock);
156 std::deque<EventEntry*> mRecentQueue GUARDED_BY(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700157 std::deque<std::unique_ptr<CommandEntry>> mCommandQueue GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800158
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800159 DropReason mLastDropReason GUARDED_BY(mLock);
Michael Wright3a981722015-06-10 15:26:13 +0100160
Garfield Tan1c7bc862020-01-28 13:24:04 -0800161 const IdGenerator mIdGenerator;
162
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700163 // With each iteration, InputDispatcher nominally processes one queued event,
164 // a timeout, or a response from an input consumer.
165 // This method should only be called on the input dispatcher's own thread.
166 void dispatchOnce();
167
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800168 void dispatchOnceInnerLocked(nsecs_t* nextWakeupTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800169
170 // Enqueues an inbound event. Returns true if mLooper->wake() should be called.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800171 bool enqueueInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800172
173 // Cleans up input state when dropping an inbound event.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700174 void dropInboundEventLocked(const EventEntry& entry, DropReason dropReason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800175
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100176 // Enqueues a focus event.
177 void enqueueFocusEventLocked(const InputWindowHandle& window, bool hasFocus) REQUIRES(mLock);
178
Michael Wrightd02c5b62014-02-10 15:10:22 -0800179 // Adds an event to a queue of recent events for debugging purposes.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800180 void addRecentEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800181
182 // App switch latency optimization.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800183 bool mAppSwitchSawKeyDown GUARDED_BY(mLock);
184 nsecs_t mAppSwitchDueTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800185
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700186 bool isAppSwitchKeyEvent(const KeyEntry& keyEntry);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800187 bool isAppSwitchPendingLocked() REQUIRES(mLock);
188 void resetPendingAppSwitchLocked(bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800189
Michael Wrightd02c5b62014-02-10 15:10:22 -0800190 // Blocked event latency optimization. Drops old events when the user intends
191 // to transfer focus to a new application.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800192 EventEntry* mNextUnblockedEvent GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800193
Tiger Huang85b8c5e2019-01-17 18:34:54 +0800194 sp<InputWindowHandle> findTouchedWindowAtLocked(int32_t displayId, int32_t x, int32_t y,
Siarhei Vishniakou1ea3cf12020-03-24 19:50:03 -0700195 TouchState* touchState,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700196 bool addOutsideTargets = false,
197 bool addPortalWindows = false) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800198
199 // All registered connections mapped by channel file descriptor.
Siarhei Vishniakou146ecfd2019-07-29 16:04:31 -0700200 std::unordered_map<int, sp<Connection>> mConnectionsByFd GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800201
Siarhei Vishniakouffaa2b12020-05-26 21:43:02 -0700202 sp<Connection> getConnectionLocked(const sp<IBinder>& inputConnectionToken) const
203 REQUIRES(mLock);
204
205 void removeConnectionLocked(const sp<Connection>& connection) REQUIRES(mLock);
206
Robert Carr5c8a0262018-10-03 16:30:44 -0700207 struct IBinderHash {
208 std::size_t operator()(const sp<IBinder>& b) const {
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700209 return std::hash<IBinder*>{}(b.get());
Robert Carr5c8a0262018-10-03 16:30:44 -0700210 }
211 };
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800212 std::unordered_map<sp<IBinder>, sp<InputChannel>, IBinderHash> mInputChannelsByToken
213 GUARDED_BY(mLock);
Robert Carr5c8a0262018-10-03 16:30:44 -0700214
Michael Wright3dd60e22019-03-27 22:06:44 +0000215 // Finds the display ID of the gesture monitor identified by the provided token.
216 std::optional<int32_t> findGestureMonitorDisplayByTokenLocked(const sp<IBinder>& token)
217 REQUIRES(mLock);
218
Arthur Hung2fbf37f2018-09-13 18:16:41 +0800219 // Input channels that will receive a copy of all input events sent to the provided display.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700220 std::unordered_map<int32_t, std::vector<Monitor>> mGlobalMonitorsByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800221
Michael Wright3dd60e22019-03-27 22:06:44 +0000222 // Input channels that will receive pointer events that start within the corresponding display.
223 // These are a bit special when compared to global monitors since they'll cause gesture streams
224 // to continue even when there isn't a touched window,and have the ability to steal the rest of
225 // the pointer stream in order to claim it for a system gesture.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700226 std::unordered_map<int32_t, std::vector<Monitor>> mGestureMonitorsByDisplay GUARDED_BY(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000227
Edgar Arriaga3d61bc12020-04-16 18:46:48 -0700228 const HmacKeyManager mHmacKeyManager;
229 const std::array<uint8_t, 32> getSignature(const MotionEntry& motionEntry,
230 const DispatchEntry& dispatchEntry) const;
231 const std::array<uint8_t, 32> getSignature(const KeyEntry& keyEntry,
232 const DispatchEntry& dispatchEntry) const;
Gang Wange9087892020-01-07 12:17:14 -0500233
Michael Wrightd02c5b62014-02-10 15:10:22 -0800234 // Event injection and synchronization.
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800235 std::condition_variable mInjectionResultAvailable;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800236 bool hasInjectionPermission(int32_t injectorPid, int32_t injectorUid);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800237 void setInjectionResult(EventEntry* entry, int32_t injectionResult);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800238
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800239 std::condition_variable mInjectionSyncFinished;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800240 void incrementPendingForegroundDispatches(EventEntry* entry);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800241 void decrementPendingForegroundDispatches(EventEntry* entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800242
243 // Key repeat tracking.
244 struct KeyRepeatState {
245 KeyEntry* lastKeyEntry; // or null if no repeat
246 nsecs_t nextRepeatTime;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800247 } mKeyRepeatState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800248
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800249 void resetKeyRepeatLocked() REQUIRES(mLock);
250 KeyEntry* synthesizeKeyRepeatLocked(nsecs_t currentTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800251
Michael Wright78f24442014-08-06 15:55:28 -0700252 // Key replacement tracking
253 struct KeyReplacement {
254 int32_t keyCode;
255 int32_t deviceId;
256 bool operator==(const KeyReplacement& rhs) const {
257 return keyCode == rhs.keyCode && deviceId == rhs.deviceId;
258 }
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700259 };
260 struct KeyReplacementHash {
261 size_t operator()(const KeyReplacement& key) const {
262 return std::hash<int32_t>()(key.keyCode) ^ (std::hash<int32_t>()(key.deviceId) << 1);
Michael Wright78f24442014-08-06 15:55:28 -0700263 }
264 };
265 // Maps the key code replaced, device id tuple to the key code it was replaced with
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700266 std::unordered_map<KeyReplacement, int32_t, KeyReplacementHash> mReplacedKeys GUARDED_BY(mLock);
Siarhei Vishniakou61fafdd2018-04-13 11:00:58 -0500267 // Process certain Meta + Key combinations
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700268 void accelerateMetaShortcuts(const int32_t deviceId, const int32_t action, int32_t& keyCode,
269 int32_t& metaState);
Michael Wright78f24442014-08-06 15:55:28 -0700270
Michael Wrightd02c5b62014-02-10 15:10:22 -0800271 // Deferred command processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800272 bool haveCommandsLocked() const REQUIRES(mLock);
273 bool runCommandsLockedInterruptible() REQUIRES(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700274 void postCommandLocked(std::unique_ptr<CommandEntry> commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800275
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700276 nsecs_t processAnrsLocked() REQUIRES(mLock);
277 nsecs_t getDispatchingTimeoutLocked(const sp<IBinder>& token) REQUIRES(mLock);
278
Michael Wrightd02c5b62014-02-10 15:10:22 -0800279 // Input filter processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800280 bool shouldSendKeyToInputFilterLocked(const NotifyKeyArgs* args) REQUIRES(mLock);
281 bool shouldSendMotionToInputFilterLocked(const NotifyMotionArgs* args) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800282
283 // Inbound event processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800284 void drainInboundQueueLocked() REQUIRES(mLock);
285 void releasePendingEventLocked() REQUIRES(mLock);
286 void releaseInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800287
288 // Dispatch state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800289 bool mDispatchEnabled GUARDED_BY(mLock);
290 bool mDispatchFrozen GUARDED_BY(mLock);
291 bool mInputFilterEnabled GUARDED_BY(mLock);
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800292 bool mInTouchMode GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800293
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800294 std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>> mWindowHandlesByDisplay
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800295 GUARDED_BY(mLock);
Arthur Hung72d8dc32020-03-28 00:48:39 +0000296 void setInputWindowsLocked(const std::vector<sp<InputWindowHandle>>& inputWindowHandles,
297 int32_t displayId) REQUIRES(mLock);
Arthur Hungb92218b2018-08-14 12:00:21 +0800298 // Get window handles by display, return an empty vector if not found.
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800299 std::vector<sp<InputWindowHandle>> getWindowHandlesLocked(int32_t displayId) const
300 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800301 sp<InputWindowHandle> getWindowHandleLocked(const sp<IBinder>& windowHandleToken) const
302 REQUIRES(mLock);
303 sp<InputChannel> getInputChannelLocked(const sp<IBinder>& windowToken) const REQUIRES(mLock);
Mady Mellor017bcd12020-06-23 19:12:00 +0000304 bool hasWindowHandleLocked(const sp<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.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800320 std::unordered_map<int32_t, sp<InputApplicationHandle>> mFocusedApplicationHandlesByDisplay
321 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
329 // Dispatch inbound events.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700330 bool dispatchConfigurationChangedLocked(nsecs_t currentTime, ConfigurationChangedEntry* entry)
331 REQUIRES(mLock);
332 bool dispatchDeviceResetLocked(nsecs_t currentTime, DeviceResetEntry* entry) REQUIRES(mLock);
333 bool dispatchKeyLocked(nsecs_t currentTime, KeyEntry* entry, DropReason* dropReason,
334 nsecs_t* nextWakeupTime) REQUIRES(mLock);
335 bool dispatchMotionLocked(nsecs_t currentTime, MotionEntry* entry, DropReason* dropReason,
336 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100337 void dispatchFocusLocked(nsecs_t currentTime, FocusEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800338 void dispatchEventLocked(nsecs_t currentTime, EventEntry* entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700339 const std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800340
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700341 void logOutboundKeyDetails(const char* prefix, const KeyEntry& entry);
342 void logOutboundMotionDetails(const char* prefix, const MotionEntry& entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800343
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700344 /**
345 * This field is set if there is no focused window, and we have an event that requires
346 * a focused window to be dispatched (for example, a KeyEvent).
347 * When this happens, we will wait until *mNoFocusedWindowTimeoutTime before
348 * dropping the event and raising an ANR for that application.
349 * This is useful if an application is slow to add a focused window.
350 */
351 std::optional<nsecs_t> mNoFocusedWindowTimeoutTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800352
Siarhei Vishniakoude1bc4a2020-05-26 22:39:43 -0700353 bool shouldPruneInboundQueueLocked(const MotionEntry& motionEntry) REQUIRES(mLock);
354
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700355 /**
356 * Time to stop waiting for the events to be processed while trying to dispatch a key.
357 * When this time expires, we just send the pending key event to the currently focused window,
358 * without waiting on other events to be processed first.
359 */
360 std::optional<nsecs_t> mKeyIsWaitingForEventsTimeout GUARDED_BY(mLock);
361 bool shouldWaitToSendKeyLocked(nsecs_t currentTime, const char* focusedWindowName)
362 REQUIRES(mLock);
363
364 /**
365 * The focused application at the time when no focused window was present.
366 * Used to raise an ANR when we have no focused window.
367 */
368 sp<InputApplicationHandle> mAwaitedFocusedApplication GUARDED_BY(mLock);
369
370 // Optimization: AnrTracker is used to quickly find which connection is due for a timeout next.
371 // AnrTracker must be kept in-sync with all responsive connection.waitQueues.
372 // If a connection is not responsive, then the entries should not be added to the AnrTracker.
373 // Once a connection becomes unresponsive, its entries are removed from AnrTracker to
374 // prevent unneeded wakeups.
375 AnrTracker mAnrTracker GUARDED_BY(mLock);
376 void extendAnrTimeoutsLocked(const sp<InputApplicationHandle>& application,
Siarhei Vishniakouc1ae5562020-06-30 14:22:57 -0500377 const sp<IBinder>& connectionToken,
378 std::chrono::nanoseconds timeoutExtension) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700379
Michael Wrightd02c5b62014-02-10 15:10:22 -0800380 // Contains the last window which received a hover event.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800381 sp<InputWindowHandle> mLastHoverWindowHandle GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800382
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700383 void cancelEventsForAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800384 nsecs_t getTimeSpentWaitingForApplicationLocked(nsecs_t currentTime) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700385 // If a focused application changes, we should stop counting down the "no focused window" time,
386 // because we will have no way of knowing when the previous application actually added a window.
387 // This also means that we will miss cases like pulling down notification shade when the
388 // focused application does not have a focused window (no ANR will be raised if notification
389 // shade is pulled down while we are counting down the timeout).
390 void resetNoFocusedWindowTimeoutLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800391
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700392 int32_t getTargetDisplayId(const EventEntry& entry);
393 int32_t findFocusedWindowTargetsLocked(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700394 std::vector<InputTarget>& inputTargets,
395 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700396 int32_t findTouchedWindowTargetsLocked(nsecs_t currentTime, const MotionEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700397 std::vector<InputTarget>& inputTargets,
398 nsecs_t* nextWakeupTime,
399 bool* outConflictingPointerActions) REQUIRES(mLock);
400 std::vector<TouchedMonitor> findTouchedGestureMonitorsLocked(
Siarhei Vishniakoue0fb6bd2020-04-13 11:40:37 -0700401 int32_t displayId, const std::vector<sp<InputWindowHandle>>& portalWindows) const
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700402 REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700403 std::vector<TouchedMonitor> selectResponsiveMonitorsLocked(
404 const std::vector<TouchedMonitor>& gestureMonitors) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800405
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700406 void addWindowTargetLocked(const sp<InputWindowHandle>& windowHandle, int32_t targetFlags,
407 BitSet32 pointerIds, std::vector<InputTarget>& inputTargets)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800408 REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000409 void addMonitoringTargetLocked(const Monitor& monitor, float xOffset, float yOffset,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700410 std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
411 void addGlobalMonitoringTargetsLocked(std::vector<InputTarget>& inputTargets, int32_t displayId,
412 float xOffset = 0, float yOffset = 0) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800413
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700414 void pokeUserActivityLocked(const EventEntry& eventEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800415 bool checkInjectionPermission(const sp<InputWindowHandle>& windowHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700416 const InjectionState* injectionState);
417 bool isWindowObscuredAtPointLocked(const sp<InputWindowHandle>& windowHandle, int32_t x,
418 int32_t y) const REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800419 bool isWindowObscuredLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
420 std::string getApplicationWindowLabel(const sp<InputApplicationHandle>& applicationHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700421 const sp<InputWindowHandle>& windowHandle);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800422
Michael Wrightd02c5b62014-02-10 15:10:22 -0800423 // Manage the dispatch cycle for a single connection.
424 // These methods are deliberately not Interruptible because doing all of the work
425 // with the mutex held makes it easier to ensure that connection invariants are maintained.
426 // If needed, the methods post commands to run later once the critical bits are done.
427 void prepareDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800428 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700429 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800430 void enqueueDispatchEntriesLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800431 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700432 REQUIRES(mLock);
433 void enqueueDispatchEntryLocked(const sp<Connection>& connection, EventEntry* eventEntry,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800434 const InputTarget& inputTarget, int32_t dispatchMode)
chaviw8c9cf542019-03-25 13:02:48 -0700435 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800436 void startDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection)
437 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800438 void finishDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700439 uint32_t seq, bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800440 void abortBrokenDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700441 bool notify) REQUIRES(mLock);
Siarhei Vishniakou13bda6c2019-07-29 08:34:33 -0700442 void drainDispatchQueue(std::deque<DispatchEntry*>& queue);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800443 void releaseDispatchEntry(DispatchEntry* dispatchEntry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800444 static int handleReceiveCallback(int fd, int events, void* data);
chaviw8c9cf542019-03-25 13:02:48 -0700445 // The action sent should only be of type AMOTION_EVENT_*
chaviwfd6d3512019-03-25 13:23:49 -0700446 void dispatchPointerDownOutsideFocus(uint32_t source, int32_t action,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700447 const sp<IBinder>& newToken) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800448
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700449 void synthesizeCancelationEventsForAllConnectionsLocked(const CancelationOptions& options)
450 REQUIRES(mLock);
451 void synthesizeCancelationEventsForMonitorsLocked(const CancelationOptions& options)
452 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800453 void synthesizeCancelationEventsForMonitorsLocked(
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700454 const CancelationOptions& options,
Michael Wright3dd60e22019-03-27 22:06:44 +0000455 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800456 void synthesizeCancelationEventsForInputChannelLocked(const sp<InputChannel>& channel,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700457 const CancelationOptions& options)
458 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800459 void synthesizeCancelationEventsForConnectionLocked(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700460 const CancelationOptions& options)
461 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800462
Svet Ganov5d3bc372020-01-26 23:11:07 -0800463 void synthesizePointerDownEventsForConnectionLocked(const sp<Connection>& connection)
464 REQUIRES(mLock);
465
Michael Wrightd02c5b62014-02-10 15:10:22 -0800466 // Splitting motion events across windows.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700467 MotionEntry* splitMotionEvent(const MotionEntry& originalMotionEntry, BitSet32 pointerIds);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800468
469 // Reset and drop everything the dispatcher is doing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800470 void resetAndDropEverythingLocked(const char* reason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800471
472 // Dump state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800473 void dumpDispatchStateLocked(std::string& dump) REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000474 void dumpMonitors(std::string& dump, const std::vector<Monitor>& monitors);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800475 void logDispatchStateLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800476
477 // Registration.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800478 void removeMonitorChannelLocked(const sp<InputChannel>& inputChannel) REQUIRES(mLock);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700479 void removeMonitorChannelLocked(
480 const sp<InputChannel>& inputChannel,
481 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800482 status_t unregisterInputChannelLocked(const sp<InputChannel>& inputChannel, bool notify)
483 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800484
485 // Interesting events that we might like to log or tell the framework about.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700486 void onDispatchCycleFinishedLocked(nsecs_t currentTime, const sp<Connection>& connection,
487 uint32_t seq, bool handled) REQUIRES(mLock);
488 void onDispatchCycleBrokenLocked(nsecs_t currentTime, const sp<Connection>& connection)
489 REQUIRES(mLock);
chaviw0c06c6e2019-01-09 13:27:07 -0800490 void onFocusChangedLocked(const sp<InputWindowHandle>& oldFocus,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700491 const sp<InputWindowHandle>& newFocus) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700492 void onAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
493 void onAnrLocked(const sp<InputApplicationHandle>& application) REQUIRES(mLock);
494 void updateLastAnrStateLocked(const sp<InputWindowHandle>& window, const std::string& reason)
495 REQUIRES(mLock);
496 void updateLastAnrStateLocked(const sp<InputApplicationHandle>& application,
497 const std::string& reason) REQUIRES(mLock);
498 void updateLastAnrStateLocked(const std::string& windowLabel, const std::string& reason)
499 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800500
501 // Outbound policy interactions.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800502 void doNotifyConfigurationChangedLockedInterruptible(CommandEntry* commandEntry)
503 REQUIRES(mLock);
504 void doNotifyInputChannelBrokenLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
505 void doNotifyFocusChangedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakoub1a16272020-05-06 16:09:19 -0700506 void doNotifyAnrLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800507 void doInterceptKeyBeforeDispatchingLockedInterruptible(CommandEntry* commandEntry)
508 REQUIRES(mLock);
509 void doDispatchCycleFinishedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800510 bool afterKeyEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700511 DispatchEntry* dispatchEntry, KeyEntry* keyEntry,
512 bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800513 bool afterMotionEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700514 DispatchEntry* dispatchEntry, MotionEntry* motionEntry,
515 bool handled) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800516 void doPokeUserActivityLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou9757f782019-10-29 12:53:08 -0700517 KeyEvent createKeyEvent(const KeyEntry& entry);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700518 void doOnPointerDownOutsideFocusLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800519
520 // Statistics gathering.
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -0500521 static constexpr std::chrono::duration TOUCH_STATS_REPORT_PERIOD = 5min;
522 LatencyStatistics mTouchStatistics{TOUCH_STATS_REPORT_PERIOD};
523
524 void reportTouchEventForStatistics(const MotionEntry& entry);
Siarhei Vishniakou7f0a4392020-03-24 20:49:09 -0700525 void reportDispatchStatistics(std::chrono::nanoseconds eventDuration,
526 const Connection& connection, bool handled);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800527 void traceInboundQueueLengthLocked() REQUIRES(mLock);
528 void traceOutboundQueueLength(const sp<Connection>& connection);
529 void traceWaitQueueLength(const sp<Connection>& connection);
Prabir Pradhanf93562f2018-11-29 12:13:37 -0800530
Prabir Pradhan79a4f0c2019-01-09 11:24:01 -0800531 sp<InputReporterInterface> mReporter;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800532};
533
Garfield Tane84e6f92019-08-29 17:28:41 -0700534} // namespace android::inputdispatcher
Michael Wrightd02c5b62014-02-10 15:10:22 -0800535
536#endif // _UI_INPUT_DISPATCHER_H