blob: ba7ace0987b752bb6d30c1491fdff2be7918220e [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>
Siarhei Vishniakou887b7d92020-06-18 00:43:02 +000052#include <unordered_set>
Michael Wrightd02c5b62014-02-10 15:10:22 -080053
Garfield Tane84e6f92019-08-29 17:28:41 -070054#include <InputListener.h>
55#include <InputReporterInterface.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080056
Garfield Tane84e6f92019-08-29 17:28:41 -070057namespace android::inputdispatcher {
Michael Wrightd02c5b62014-02-10 15:10:22 -080058
Garfield Tane84e6f92019-08-29 17:28:41 -070059class Connection;
Michael Wrightd02c5b62014-02-10 15:10:22 -080060
Gang Wang342c9272020-01-13 13:15:04 -050061class HmacKeyManager {
62public:
63 HmacKeyManager();
64 std::array<uint8_t, 32> sign(const VerifiedInputEvent& event) const;
65
66private:
Edgar Arriaga3d61bc12020-04-16 18:46:48 -070067 std::array<uint8_t, 32> sign(const uint8_t* data, size_t size) const;
Gang Wang342c9272020-01-13 13:15:04 -050068 const std::array<uint8_t, 128> mHmacKey;
69};
70
Michael Wrightd02c5b62014-02-10 15:10:22 -080071/* Dispatches events to input targets. Some functions of the input dispatcher, such as
72 * identifying input targets, are controlled by a separate policy object.
73 *
74 * IMPORTANT INVARIANT:
75 * Because the policy can potentially block or cause re-entrance into the input dispatcher,
76 * the input dispatcher never calls into the policy while holding its internal locks.
77 * The implementation is also carefully designed to recover from scenarios such as an
78 * input channel becoming unregistered while identifying input targets or processing timeouts.
79 *
80 * Methods marked 'Locked' must be called with the lock acquired.
81 *
82 * Methods marked 'LockedInterruptible' must be called with the lock acquired but
83 * may during the course of their execution release the lock, call into the policy, and
84 * then reacquire the lock. The caller is responsible for recovering gracefully.
85 *
86 * A 'LockedInterruptible' method may called a 'Locked' method, but NOT vice-versa.
87 */
Garfield Tane84e6f92019-08-29 17:28:41 -070088class InputDispatcher : public android::InputDispatcherInterface {
Michael Wrightd02c5b62014-02-10 15:10:22 -080089protected:
90 virtual ~InputDispatcher();
91
92public:
93 explicit InputDispatcher(const sp<InputDispatcherPolicyInterface>& policy);
94
Michael Wright3dd60e22019-03-27 22:06:44 +000095 virtual void dump(std::string& dump) override;
96 virtual void monitor() override;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -080097 virtual bool waitForIdle() override;
Prabir Pradhan3608aad2019-10-02 17:08:26 -070098 virtual status_t start() override;
99 virtual status_t stop() override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800100
Michael Wright3dd60e22019-03-27 22:06:44 +0000101 virtual void notifyConfigurationChanged(const NotifyConfigurationChangedArgs* args) override;
102 virtual void notifyKey(const NotifyKeyArgs* args) override;
103 virtual void notifyMotion(const NotifyMotionArgs* args) override;
104 virtual void notifySwitch(const NotifySwitchArgs* args) override;
105 virtual void notifyDeviceReset(const NotifyDeviceResetArgs* args) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800106
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700107 virtual int32_t injectInputEvent(const InputEvent* event, int32_t injectorPid,
Siarhei Vishniakou097c3db2020-05-06 14:18:38 -0700108 int32_t injectorUid, int32_t syncMode,
109 std::chrono::milliseconds timeout,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700110 uint32_t policyFlags) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800111
Siarhei Vishniakou54d3e182020-01-15 17:38:38 -0800112 virtual std::unique_ptr<VerifiedInputEvent> verifyInputEvent(const InputEvent& event) override;
113
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700114 virtual void setInputWindows(
Arthur Hung72d8dc32020-03-28 00:48:39 +0000115 const std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>>&
116 handlesPerDisplay) override;
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700117 virtual void setFocusedApplication(
118 int32_t displayId, const sp<InputApplicationHandle>& inputApplicationHandle) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000119 virtual void setFocusedDisplay(int32_t displayId) override;
120 virtual void setInputDispatchMode(bool enabled, bool frozen) override;
121 virtual void setInputFilterEnabled(bool enabled) override;
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800122 virtual void setInTouchMode(bool inTouchMode) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800123
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700124 virtual bool transferTouchFocus(const sp<IBinder>& fromToken,
125 const sp<IBinder>& toToken) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800126
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500127 virtual status_t registerInputChannel(
128 const std::shared_ptr<InputChannel>& inputChannel) override;
129 virtual status_t registerInputMonitor(const std::shared_ptr<InputChannel>& inputChannel,
130 int32_t displayId, bool isGestureMonitor) override;
131 virtual status_t unregisterInputChannel(const InputChannel& inputChannel) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000132 virtual status_t pilferPointers(const sp<IBinder>& token) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800133
134private:
Siarhei Vishniakou0fb1a0e2019-10-22 11:23:36 -0700135 enum class DropReason {
136 NOT_DROPPED,
137 POLICY,
138 APP_SWITCH,
139 DISABLED,
140 BLOCKED,
141 STALE,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800142 };
143
Prabir Pradhan5a57cff2019-10-31 18:40:33 -0700144 std::unique_ptr<InputThread> mThread;
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700145
Michael Wrightd02c5b62014-02-10 15:10:22 -0800146 sp<InputDispatcherPolicyInterface> mPolicy;
Garfield Tane84e6f92019-08-29 17:28:41 -0700147 android::InputDispatcherConfiguration mConfig;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800148
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800149 std::mutex mLock;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800150
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800151 std::condition_variable mDispatcherIsAlive;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -0800152 std::condition_variable mDispatcherEnteredIdle;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800153
154 sp<Looper> mLooper;
155
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800156 EventEntry* mPendingEvent GUARDED_BY(mLock);
Siarhei Vishniakou44a2aed2019-07-29 08:59:52 -0700157 std::deque<EventEntry*> mInboundQueue GUARDED_BY(mLock);
158 std::deque<EventEntry*> mRecentQueue GUARDED_BY(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700159 std::deque<std::unique_ptr<CommandEntry>> mCommandQueue GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800160
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800161 DropReason mLastDropReason GUARDED_BY(mLock);
Michael Wright3a981722015-06-10 15:26:13 +0100162
Garfield Tan1c7bc862020-01-28 13:24:04 -0800163 const IdGenerator mIdGenerator;
164
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700165 // With each iteration, InputDispatcher nominally processes one queued event,
166 // a timeout, or a response from an input consumer.
167 // This method should only be called on the input dispatcher's own thread.
168 void dispatchOnce();
169
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800170 void dispatchOnceInnerLocked(nsecs_t* nextWakeupTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800171
172 // Enqueues an inbound event. Returns true if mLooper->wake() should be called.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800173 bool enqueueInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800174
175 // Cleans up input state when dropping an inbound event.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700176 void dropInboundEventLocked(const EventEntry& entry, DropReason dropReason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800177
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100178 // Enqueues a focus event.
179 void enqueueFocusEventLocked(const InputWindowHandle& window, bool hasFocus) REQUIRES(mLock);
180
Michael Wrightd02c5b62014-02-10 15:10:22 -0800181 // Adds an event to a queue of recent events for debugging purposes.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800182 void addRecentEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800183
184 // App switch latency optimization.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800185 bool mAppSwitchSawKeyDown GUARDED_BY(mLock);
186 nsecs_t mAppSwitchDueTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800187
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700188 bool isAppSwitchKeyEvent(const KeyEntry& keyEntry);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800189 bool isAppSwitchPendingLocked() REQUIRES(mLock);
190 void resetPendingAppSwitchLocked(bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800191
Michael Wrightd02c5b62014-02-10 15:10:22 -0800192 // Blocked event latency optimization. Drops old events when the user intends
193 // to transfer focus to a new application.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800194 EventEntry* mNextUnblockedEvent GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800195
Tiger Huang85b8c5e2019-01-17 18:34:54 +0800196 sp<InputWindowHandle> findTouchedWindowAtLocked(int32_t displayId, int32_t x, int32_t y,
Siarhei Vishniakou1ea3cf12020-03-24 19:50:03 -0700197 TouchState* touchState,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700198 bool addOutsideTargets = false,
199 bool addPortalWindows = false) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800200
201 // All registered connections mapped by channel file descriptor.
Siarhei Vishniakou146ecfd2019-07-29 16:04:31 -0700202 std::unordered_map<int, sp<Connection>> mConnectionsByFd GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800203
Siarhei Vishniakouffaa2b12020-05-26 21:43:02 -0700204 sp<Connection> getConnectionLocked(const sp<IBinder>& inputConnectionToken) const
205 REQUIRES(mLock);
206
207 void removeConnectionLocked(const sp<Connection>& connection) REQUIRES(mLock);
208
Robert Carr5c8a0262018-10-03 16:30:44 -0700209 struct IBinderHash {
210 std::size_t operator()(const sp<IBinder>& b) const {
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700211 return std::hash<IBinder*>{}(b.get());
Robert Carr5c8a0262018-10-03 16:30:44 -0700212 }
213 };
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500214 std::unordered_map<sp<IBinder>, std::shared_ptr<InputChannel>, IBinderHash>
215 mInputChannelsByToken GUARDED_BY(mLock);
Robert Carr5c8a0262018-10-03 16:30:44 -0700216
Michael Wright3dd60e22019-03-27 22:06:44 +0000217 // Finds the display ID of the gesture monitor identified by the provided token.
218 std::optional<int32_t> findGestureMonitorDisplayByTokenLocked(const sp<IBinder>& token)
219 REQUIRES(mLock);
220
Arthur Hung2fbf37f2018-09-13 18:16:41 +0800221 // Input channels that will receive a copy of all input events sent to the provided display.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700222 std::unordered_map<int32_t, std::vector<Monitor>> mGlobalMonitorsByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800223
Michael Wright3dd60e22019-03-27 22:06:44 +0000224 // Input channels that will receive pointer events that start within the corresponding display.
225 // These are a bit special when compared to global monitors since they'll cause gesture streams
226 // to continue even when there isn't a touched window,and have the ability to steal the rest of
227 // the pointer stream in order to claim it for a system gesture.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700228 std::unordered_map<int32_t, std::vector<Monitor>> mGestureMonitorsByDisplay GUARDED_BY(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000229
Edgar Arriaga3d61bc12020-04-16 18:46:48 -0700230 const HmacKeyManager mHmacKeyManager;
231 const std::array<uint8_t, 32> getSignature(const MotionEntry& motionEntry,
232 const DispatchEntry& dispatchEntry) const;
233 const std::array<uint8_t, 32> getSignature(const KeyEntry& keyEntry,
234 const DispatchEntry& dispatchEntry) const;
Gang Wange9087892020-01-07 12:17:14 -0500235
Michael Wrightd02c5b62014-02-10 15:10:22 -0800236 // Event injection and synchronization.
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800237 std::condition_variable mInjectionResultAvailable;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800238 bool hasInjectionPermission(int32_t injectorPid, int32_t injectorUid);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800239 void setInjectionResult(EventEntry* entry, int32_t injectionResult);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800240
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800241 std::condition_variable mInjectionSyncFinished;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800242 void incrementPendingForegroundDispatches(EventEntry* entry);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800243 void decrementPendingForegroundDispatches(EventEntry* entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800244
245 // Key repeat tracking.
246 struct KeyRepeatState {
247 KeyEntry* lastKeyEntry; // or null if no repeat
248 nsecs_t nextRepeatTime;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800249 } mKeyRepeatState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800250
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800251 void resetKeyRepeatLocked() REQUIRES(mLock);
252 KeyEntry* synthesizeKeyRepeatLocked(nsecs_t currentTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800253
Michael Wright78f24442014-08-06 15:55:28 -0700254 // Key replacement tracking
255 struct KeyReplacement {
256 int32_t keyCode;
257 int32_t deviceId;
258 bool operator==(const KeyReplacement& rhs) const {
259 return keyCode == rhs.keyCode && deviceId == rhs.deviceId;
260 }
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700261 };
262 struct KeyReplacementHash {
263 size_t operator()(const KeyReplacement& key) const {
264 return std::hash<int32_t>()(key.keyCode) ^ (std::hash<int32_t>()(key.deviceId) << 1);
Michael Wright78f24442014-08-06 15:55:28 -0700265 }
266 };
267 // Maps the key code replaced, device id tuple to the key code it was replaced with
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700268 std::unordered_map<KeyReplacement, int32_t, KeyReplacementHash> mReplacedKeys GUARDED_BY(mLock);
Siarhei Vishniakou61fafdd2018-04-13 11:00:58 -0500269 // Process certain Meta + Key combinations
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700270 void accelerateMetaShortcuts(const int32_t deviceId, const int32_t action, int32_t& keyCode,
271 int32_t& metaState);
Michael Wright78f24442014-08-06 15:55:28 -0700272
Michael Wrightd02c5b62014-02-10 15:10:22 -0800273 // Deferred command processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800274 bool haveCommandsLocked() const REQUIRES(mLock);
275 bool runCommandsLockedInterruptible() REQUIRES(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700276 void postCommandLocked(std::unique_ptr<CommandEntry> commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800277
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700278 nsecs_t processAnrsLocked() REQUIRES(mLock);
279 nsecs_t getDispatchingTimeoutLocked(const sp<IBinder>& token) REQUIRES(mLock);
280
Michael Wrightd02c5b62014-02-10 15:10:22 -0800281 // Input filter processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800282 bool shouldSendKeyToInputFilterLocked(const NotifyKeyArgs* args) REQUIRES(mLock);
283 bool shouldSendMotionToInputFilterLocked(const NotifyMotionArgs* args) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800284
285 // Inbound event processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800286 void drainInboundQueueLocked() REQUIRES(mLock);
287 void releasePendingEventLocked() REQUIRES(mLock);
288 void releaseInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800289
290 // Dispatch state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800291 bool mDispatchEnabled GUARDED_BY(mLock);
292 bool mDispatchFrozen GUARDED_BY(mLock);
293 bool mInputFilterEnabled GUARDED_BY(mLock);
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800294 bool mInTouchMode GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800295
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800296 std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>> mWindowHandlesByDisplay
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800297 GUARDED_BY(mLock);
Arthur Hung72d8dc32020-03-28 00:48:39 +0000298 void setInputWindowsLocked(const std::vector<sp<InputWindowHandle>>& inputWindowHandles,
299 int32_t displayId) REQUIRES(mLock);
Arthur Hungb92218b2018-08-14 12:00:21 +0800300 // Get window handles by display, return an empty vector if not found.
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800301 std::vector<sp<InputWindowHandle>> getWindowHandlesLocked(int32_t displayId) const
302 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800303 sp<InputWindowHandle> getWindowHandleLocked(const sp<IBinder>& windowHandleToken) const
304 REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500305 std::shared_ptr<InputChannel> getInputChannelLocked(const sp<IBinder>& windowToken) const
306 REQUIRES(mLock);
Mady Mellor017bcd12020-06-23 19:12:00 +0000307 bool hasWindowHandleLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800308
Siarhei Vishniakoub3ad35c2019-04-05 10:50:52 -0700309 /*
310 * Validate and update InputWindowHandles for a given display.
311 */
312 void updateWindowHandlesForDisplayLocked(
313 const std::vector<sp<InputWindowHandle>>& inputWindowHandles, int32_t displayId)
314 REQUIRES(mLock);
315
Michael Wrightd02c5b62014-02-10 15:10:22 -0800316 // Focus tracking for keys, trackball, etc.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800317 std::unordered_map<int32_t, sp<InputWindowHandle>> mFocusedWindowHandlesByDisplay
318 GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800319
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700320 std::unordered_map<int32_t, TouchState> mTouchStatesByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800321
Tiger Huang721e26f2018-07-24 22:26:19 +0800322 // Focused applications.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800323 std::unordered_map<int32_t, sp<InputApplicationHandle>> mFocusedApplicationHandlesByDisplay
324 GUARDED_BY(mLock);
Tiger Huang721e26f2018-07-24 22:26:19 +0800325
326 // Top focused display.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800327 int32_t mFocusedDisplayId GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800328
329 // Dispatcher state at time of last ANR.
Siarhei Vishniakoub1a16272020-05-06 16:09:19 -0700330 std::string mLastAnrState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800331
Siarhei Vishniakou887b7d92020-06-18 00:43:02 +0000332 // The connection tokens of the channels that the user last interacted, for debugging
333 std::unordered_set<sp<IBinder>, IBinderHash> mInteractionConnectionTokens GUARDED_BY(mLock);
334 void updateInteractionTokensLocked(const EventEntry& entry,
335 const std::vector<InputTarget>& targets) REQUIRES(mLock);
336
Michael Wrightd02c5b62014-02-10 15:10:22 -0800337 // Dispatch inbound events.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700338 bool dispatchConfigurationChangedLocked(nsecs_t currentTime, ConfigurationChangedEntry* entry)
339 REQUIRES(mLock);
340 bool dispatchDeviceResetLocked(nsecs_t currentTime, DeviceResetEntry* entry) REQUIRES(mLock);
341 bool dispatchKeyLocked(nsecs_t currentTime, KeyEntry* entry, DropReason* dropReason,
342 nsecs_t* nextWakeupTime) REQUIRES(mLock);
343 bool dispatchMotionLocked(nsecs_t currentTime, MotionEntry* entry, DropReason* dropReason,
344 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100345 void dispatchFocusLocked(nsecs_t currentTime, FocusEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800346 void dispatchEventLocked(nsecs_t currentTime, EventEntry* entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700347 const std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800348
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700349 void logOutboundKeyDetails(const char* prefix, const KeyEntry& entry);
350 void logOutboundMotionDetails(const char* prefix, const MotionEntry& entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800351
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700352 /**
353 * This field is set if there is no focused window, and we have an event that requires
354 * a focused window to be dispatched (for example, a KeyEvent).
355 * When this happens, we will wait until *mNoFocusedWindowTimeoutTime before
356 * dropping the event and raising an ANR for that application.
357 * This is useful if an application is slow to add a focused window.
358 */
359 std::optional<nsecs_t> mNoFocusedWindowTimeoutTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800360
Siarhei Vishniakoude1bc4a2020-05-26 22:39:43 -0700361 bool shouldPruneInboundQueueLocked(const MotionEntry& motionEntry) REQUIRES(mLock);
362
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700363 /**
364 * Time to stop waiting for the events to be processed while trying to dispatch a key.
365 * When this time expires, we just send the pending key event to the currently focused window,
366 * without waiting on other events to be processed first.
367 */
368 std::optional<nsecs_t> mKeyIsWaitingForEventsTimeout GUARDED_BY(mLock);
369 bool shouldWaitToSendKeyLocked(nsecs_t currentTime, const char* focusedWindowName)
370 REQUIRES(mLock);
371
372 /**
373 * The focused application at the time when no focused window was present.
374 * Used to raise an ANR when we have no focused window.
375 */
376 sp<InputApplicationHandle> mAwaitedFocusedApplication GUARDED_BY(mLock);
377
378 // Optimization: AnrTracker is used to quickly find which connection is due for a timeout next.
379 // AnrTracker must be kept in-sync with all responsive connection.waitQueues.
380 // If a connection is not responsive, then the entries should not be added to the AnrTracker.
381 // Once a connection becomes unresponsive, its entries are removed from AnrTracker to
382 // prevent unneeded wakeups.
383 AnrTracker mAnrTracker GUARDED_BY(mLock);
384 void extendAnrTimeoutsLocked(const sp<InputApplicationHandle>& application,
Siarhei Vishniakouc1ae5562020-06-30 14:22:57 -0500385 const sp<IBinder>& connectionToken,
386 std::chrono::nanoseconds timeoutExtension) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700387
Michael Wrightd02c5b62014-02-10 15:10:22 -0800388 // Contains the last window which received a hover event.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800389 sp<InputWindowHandle> mLastHoverWindowHandle GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800390
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700391 void cancelEventsForAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800392 nsecs_t getTimeSpentWaitingForApplicationLocked(nsecs_t currentTime) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700393 // If a focused application changes, we should stop counting down the "no focused window" time,
394 // because we will have no way of knowing when the previous application actually added a window.
395 // This also means that we will miss cases like pulling down notification shade when the
396 // focused application does not have a focused window (no ANR will be raised if notification
397 // shade is pulled down while we are counting down the timeout).
398 void resetNoFocusedWindowTimeoutLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800399
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700400 int32_t getTargetDisplayId(const EventEntry& entry);
401 int32_t findFocusedWindowTargetsLocked(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700402 std::vector<InputTarget>& inputTargets,
403 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700404 int32_t findTouchedWindowTargetsLocked(nsecs_t currentTime, const MotionEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700405 std::vector<InputTarget>& inputTargets,
406 nsecs_t* nextWakeupTime,
407 bool* outConflictingPointerActions) REQUIRES(mLock);
408 std::vector<TouchedMonitor> findTouchedGestureMonitorsLocked(
Siarhei Vishniakoue0fb6bd2020-04-13 11:40:37 -0700409 int32_t displayId, const std::vector<sp<InputWindowHandle>>& portalWindows) const
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700410 REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700411 std::vector<TouchedMonitor> selectResponsiveMonitorsLocked(
412 const std::vector<TouchedMonitor>& gestureMonitors) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800413
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700414 void addWindowTargetLocked(const sp<InputWindowHandle>& windowHandle, int32_t targetFlags,
415 BitSet32 pointerIds, std::vector<InputTarget>& inputTargets)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800416 REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000417 void addMonitoringTargetLocked(const Monitor& monitor, float xOffset, float yOffset,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700418 std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
419 void addGlobalMonitoringTargetsLocked(std::vector<InputTarget>& inputTargets, int32_t displayId,
420 float xOffset = 0, float yOffset = 0) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800421
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700422 void pokeUserActivityLocked(const EventEntry& eventEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800423 bool checkInjectionPermission(const sp<InputWindowHandle>& windowHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700424 const InjectionState* injectionState);
425 bool isWindowObscuredAtPointLocked(const sp<InputWindowHandle>& windowHandle, int32_t x,
426 int32_t y) const REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800427 bool isWindowObscuredLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
428 std::string getApplicationWindowLabel(const sp<InputApplicationHandle>& applicationHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700429 const sp<InputWindowHandle>& windowHandle);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800430
Michael Wrightd02c5b62014-02-10 15:10:22 -0800431 // Manage the dispatch cycle for a single connection.
432 // These methods are deliberately not Interruptible because doing all of the work
433 // with the mutex held makes it easier to ensure that connection invariants are maintained.
434 // If needed, the methods post commands to run later once the critical bits are done.
435 void prepareDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800436 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700437 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800438 void enqueueDispatchEntriesLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800439 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700440 REQUIRES(mLock);
441 void enqueueDispatchEntryLocked(const sp<Connection>& connection, EventEntry* eventEntry,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800442 const InputTarget& inputTarget, int32_t dispatchMode)
chaviw8c9cf542019-03-25 13:02:48 -0700443 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800444 void startDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection)
445 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800446 void finishDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700447 uint32_t seq, bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800448 void abortBrokenDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700449 bool notify) REQUIRES(mLock);
Siarhei Vishniakou13bda6c2019-07-29 08:34:33 -0700450 void drainDispatchQueue(std::deque<DispatchEntry*>& queue);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800451 void releaseDispatchEntry(DispatchEntry* dispatchEntry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800452 static int handleReceiveCallback(int fd, int events, void* data);
chaviw8c9cf542019-03-25 13:02:48 -0700453 // The action sent should only be of type AMOTION_EVENT_*
chaviwfd6d3512019-03-25 13:23:49 -0700454 void dispatchPointerDownOutsideFocus(uint32_t source, int32_t action,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700455 const sp<IBinder>& newToken) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800456
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700457 void synthesizeCancelationEventsForAllConnectionsLocked(const CancelationOptions& options)
458 REQUIRES(mLock);
459 void synthesizeCancelationEventsForMonitorsLocked(const CancelationOptions& options)
460 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800461 void synthesizeCancelationEventsForMonitorsLocked(
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700462 const CancelationOptions& options,
Michael Wright3dd60e22019-03-27 22:06:44 +0000463 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500464 void synthesizeCancelationEventsForInputChannelLocked(
465 const std::shared_ptr<InputChannel>& channel, const CancelationOptions& options)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700466 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800467 void synthesizeCancelationEventsForConnectionLocked(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700468 const CancelationOptions& options)
469 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800470
Svet Ganov5d3bc372020-01-26 23:11:07 -0800471 void synthesizePointerDownEventsForConnectionLocked(const sp<Connection>& connection)
472 REQUIRES(mLock);
473
Michael Wrightd02c5b62014-02-10 15:10:22 -0800474 // Splitting motion events across windows.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700475 MotionEntry* splitMotionEvent(const MotionEntry& originalMotionEntry, BitSet32 pointerIds);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800476
477 // Reset and drop everything the dispatcher is doing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800478 void resetAndDropEverythingLocked(const char* reason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800479
480 // Dump state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800481 void dumpDispatchStateLocked(std::string& dump) REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000482 void dumpMonitors(std::string& dump, const std::vector<Monitor>& monitors);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800483 void logDispatchStateLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800484
485 // Registration.
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500486 void removeMonitorChannelLocked(const InputChannel& inputChannel) REQUIRES(mLock);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700487 void removeMonitorChannelLocked(
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500488 const InputChannel& inputChannel,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700489 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500490 status_t unregisterInputChannelLocked(const InputChannel& inputChannel, bool notify)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800491 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800492
493 // Interesting events that we might like to log or tell the framework about.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700494 void onDispatchCycleFinishedLocked(nsecs_t currentTime, const sp<Connection>& connection,
495 uint32_t seq, bool handled) REQUIRES(mLock);
496 void onDispatchCycleBrokenLocked(nsecs_t currentTime, const sp<Connection>& connection)
497 REQUIRES(mLock);
chaviw0c06c6e2019-01-09 13:27:07 -0800498 void onFocusChangedLocked(const sp<InputWindowHandle>& oldFocus,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700499 const sp<InputWindowHandle>& newFocus) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700500 void onAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
501 void onAnrLocked(const sp<InputApplicationHandle>& application) REQUIRES(mLock);
502 void updateLastAnrStateLocked(const sp<InputWindowHandle>& window, const std::string& reason)
503 REQUIRES(mLock);
504 void updateLastAnrStateLocked(const sp<InputApplicationHandle>& application,
505 const std::string& reason) REQUIRES(mLock);
506 void updateLastAnrStateLocked(const std::string& windowLabel, const std::string& reason)
507 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800508
509 // Outbound policy interactions.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800510 void doNotifyConfigurationChangedLockedInterruptible(CommandEntry* commandEntry)
511 REQUIRES(mLock);
512 void doNotifyInputChannelBrokenLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
513 void doNotifyFocusChangedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakoub1a16272020-05-06 16:09:19 -0700514 void doNotifyAnrLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800515 void doInterceptKeyBeforeDispatchingLockedInterruptible(CommandEntry* commandEntry)
516 REQUIRES(mLock);
517 void doDispatchCycleFinishedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800518 bool afterKeyEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700519 DispatchEntry* dispatchEntry, KeyEntry* keyEntry,
520 bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800521 bool afterMotionEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700522 DispatchEntry* dispatchEntry, MotionEntry* motionEntry,
523 bool handled) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800524 void doPokeUserActivityLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou9757f782019-10-29 12:53:08 -0700525 KeyEvent createKeyEvent(const KeyEntry& entry);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700526 void doOnPointerDownOutsideFocusLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800527
528 // Statistics gathering.
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -0500529 static constexpr std::chrono::duration TOUCH_STATS_REPORT_PERIOD = 5min;
530 LatencyStatistics mTouchStatistics{TOUCH_STATS_REPORT_PERIOD};
531
532 void reportTouchEventForStatistics(const MotionEntry& entry);
Siarhei Vishniakou7f0a4392020-03-24 20:49:09 -0700533 void reportDispatchStatistics(std::chrono::nanoseconds eventDuration,
534 const Connection& connection, bool handled);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800535 void traceInboundQueueLengthLocked() REQUIRES(mLock);
536 void traceOutboundQueueLength(const sp<Connection>& connection);
537 void traceWaitQueueLength(const sp<Connection>& connection);
Prabir Pradhanf93562f2018-11-29 12:13:37 -0800538
Prabir Pradhan79a4f0c2019-01-09 11:24:01 -0800539 sp<InputReporterInterface> mReporter;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800540};
541
Garfield Tane84e6f92019-08-29 17:28:41 -0700542} // namespace android::inputdispatcher
Michael Wrightd02c5b62014-02-10 15:10:22 -0800543
544#endif // _UI_INPUT_DISPATCHER_H