blob: b4d1079839bac1268b0b0881123d18f4c2d88d08 [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;
Vishnu Naire798b472020-07-23 13:52:21 -0700129 virtual void setFocusedWindow(const FocusRequest&) override;
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500130 virtual status_t registerInputMonitor(const std::shared_ptr<InputChannel>& inputChannel,
131 int32_t displayId, bool isGestureMonitor) override;
132 virtual status_t unregisterInputChannel(const InputChannel& inputChannel) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000133 virtual status_t pilferPointers(const sp<IBinder>& token) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800134
135private:
Siarhei Vishniakou0fb1a0e2019-10-22 11:23:36 -0700136 enum class DropReason {
137 NOT_DROPPED,
138 POLICY,
139 APP_SWITCH,
140 DISABLED,
141 BLOCKED,
142 STALE,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800143 };
144
Prabir Pradhan5a57cff2019-10-31 18:40:33 -0700145 std::unique_ptr<InputThread> mThread;
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700146
Michael Wrightd02c5b62014-02-10 15:10:22 -0800147 sp<InputDispatcherPolicyInterface> mPolicy;
Garfield Tane84e6f92019-08-29 17:28:41 -0700148 android::InputDispatcherConfiguration mConfig;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800149
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800150 std::mutex mLock;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800151
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800152 std::condition_variable mDispatcherIsAlive;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -0800153 std::condition_variable mDispatcherEnteredIdle;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800154
155 sp<Looper> mLooper;
156
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800157 EventEntry* mPendingEvent GUARDED_BY(mLock);
Siarhei Vishniakou44a2aed2019-07-29 08:59:52 -0700158 std::deque<EventEntry*> mInboundQueue GUARDED_BY(mLock);
159 std::deque<EventEntry*> mRecentQueue GUARDED_BY(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700160 std::deque<std::unique_ptr<CommandEntry>> mCommandQueue GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800161
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800162 DropReason mLastDropReason GUARDED_BY(mLock);
Michael Wright3a981722015-06-10 15:26:13 +0100163
Garfield Tan1c7bc862020-01-28 13:24:04 -0800164 const IdGenerator mIdGenerator;
165
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700166 // With each iteration, InputDispatcher nominally processes one queued event,
167 // a timeout, or a response from an input consumer.
168 // This method should only be called on the input dispatcher's own thread.
169 void dispatchOnce();
170
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800171 void dispatchOnceInnerLocked(nsecs_t* nextWakeupTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800172
173 // Enqueues an inbound event. Returns true if mLooper->wake() should be called.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800174 bool enqueueInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800175
176 // Cleans up input state when dropping an inbound event.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700177 void dropInboundEventLocked(const EventEntry& entry, DropReason dropReason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800178
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100179 // Enqueues a focus event.
180 void enqueueFocusEventLocked(const InputWindowHandle& window, bool hasFocus) REQUIRES(mLock);
181
Michael Wrightd02c5b62014-02-10 15:10:22 -0800182 // Adds an event to a queue of recent events for debugging purposes.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800183 void addRecentEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800184
185 // App switch latency optimization.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800186 bool mAppSwitchSawKeyDown GUARDED_BY(mLock);
187 nsecs_t mAppSwitchDueTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800188
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700189 bool isAppSwitchKeyEvent(const KeyEntry& keyEntry);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800190 bool isAppSwitchPendingLocked() REQUIRES(mLock);
191 void resetPendingAppSwitchLocked(bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800192
Michael Wrightd02c5b62014-02-10 15:10:22 -0800193 // Blocked event latency optimization. Drops old events when the user intends
194 // to transfer focus to a new application.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800195 EventEntry* mNextUnblockedEvent GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800196
Tiger Huang85b8c5e2019-01-17 18:34:54 +0800197 sp<InputWindowHandle> findTouchedWindowAtLocked(int32_t displayId, int32_t x, int32_t y,
Siarhei Vishniakou1ea3cf12020-03-24 19:50:03 -0700198 TouchState* touchState,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700199 bool addOutsideTargets = false,
200 bool addPortalWindows = false) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800201
202 // All registered connections mapped by channel file descriptor.
Siarhei Vishniakou146ecfd2019-07-29 16:04:31 -0700203 std::unordered_map<int, sp<Connection>> mConnectionsByFd GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800204
Siarhei Vishniakouffaa2b12020-05-26 21:43:02 -0700205 sp<Connection> getConnectionLocked(const sp<IBinder>& inputConnectionToken) const
206 REQUIRES(mLock);
207
208 void removeConnectionLocked(const sp<Connection>& connection) REQUIRES(mLock);
209
Robert Carr5c8a0262018-10-03 16:30:44 -0700210 struct IBinderHash {
211 std::size_t operator()(const sp<IBinder>& b) const {
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700212 return std::hash<IBinder*>{}(b.get());
Robert Carr5c8a0262018-10-03 16:30:44 -0700213 }
214 };
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500215 std::unordered_map<sp<IBinder>, std::shared_ptr<InputChannel>, IBinderHash>
216 mInputChannelsByToken GUARDED_BY(mLock);
Robert Carr5c8a0262018-10-03 16:30:44 -0700217
Michael Wright3dd60e22019-03-27 22:06:44 +0000218 // Finds the display ID of the gesture monitor identified by the provided token.
219 std::optional<int32_t> findGestureMonitorDisplayByTokenLocked(const sp<IBinder>& token)
220 REQUIRES(mLock);
221
Arthur Hung2fbf37f2018-09-13 18:16:41 +0800222 // Input channels that will receive a copy of all input events sent to the provided display.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700223 std::unordered_map<int32_t, std::vector<Monitor>> mGlobalMonitorsByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800224
Michael Wright3dd60e22019-03-27 22:06:44 +0000225 // Input channels that will receive pointer events that start within the corresponding display.
226 // These are a bit special when compared to global monitors since they'll cause gesture streams
227 // to continue even when there isn't a touched window,and have the ability to steal the rest of
228 // the pointer stream in order to claim it for a system gesture.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700229 std::unordered_map<int32_t, std::vector<Monitor>> mGestureMonitorsByDisplay GUARDED_BY(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000230
Edgar Arriaga3d61bc12020-04-16 18:46:48 -0700231 const HmacKeyManager mHmacKeyManager;
232 const std::array<uint8_t, 32> getSignature(const MotionEntry& motionEntry,
233 const DispatchEntry& dispatchEntry) const;
234 const std::array<uint8_t, 32> getSignature(const KeyEntry& keyEntry,
235 const DispatchEntry& dispatchEntry) const;
Gang Wange9087892020-01-07 12:17:14 -0500236
Michael Wrightd02c5b62014-02-10 15:10:22 -0800237 // Event injection and synchronization.
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800238 std::condition_variable mInjectionResultAvailable;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800239 bool hasInjectionPermission(int32_t injectorPid, int32_t injectorUid);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800240 void setInjectionResult(EventEntry* entry, int32_t injectionResult);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800241
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800242 std::condition_variable mInjectionSyncFinished;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800243 void incrementPendingForegroundDispatches(EventEntry* entry);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800244 void decrementPendingForegroundDispatches(EventEntry* entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800245
246 // Key repeat tracking.
247 struct KeyRepeatState {
248 KeyEntry* lastKeyEntry; // or null if no repeat
249 nsecs_t nextRepeatTime;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800250 } mKeyRepeatState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800251
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800252 void resetKeyRepeatLocked() REQUIRES(mLock);
253 KeyEntry* synthesizeKeyRepeatLocked(nsecs_t currentTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800254
Michael Wright78f24442014-08-06 15:55:28 -0700255 // Key replacement tracking
256 struct KeyReplacement {
257 int32_t keyCode;
258 int32_t deviceId;
259 bool operator==(const KeyReplacement& rhs) const {
260 return keyCode == rhs.keyCode && deviceId == rhs.deviceId;
261 }
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700262 };
263 struct KeyReplacementHash {
264 size_t operator()(const KeyReplacement& key) const {
265 return std::hash<int32_t>()(key.keyCode) ^ (std::hash<int32_t>()(key.deviceId) << 1);
Michael Wright78f24442014-08-06 15:55:28 -0700266 }
267 };
268 // Maps the key code replaced, device id tuple to the key code it was replaced with
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700269 std::unordered_map<KeyReplacement, int32_t, KeyReplacementHash> mReplacedKeys GUARDED_BY(mLock);
Siarhei Vishniakou61fafdd2018-04-13 11:00:58 -0500270 // Process certain Meta + Key combinations
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700271 void accelerateMetaShortcuts(const int32_t deviceId, const int32_t action, int32_t& keyCode,
272 int32_t& metaState);
Michael Wright78f24442014-08-06 15:55:28 -0700273
Michael Wrightd02c5b62014-02-10 15:10:22 -0800274 // Deferred command processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800275 bool haveCommandsLocked() const REQUIRES(mLock);
276 bool runCommandsLockedInterruptible() REQUIRES(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700277 void postCommandLocked(std::unique_ptr<CommandEntry> commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800278
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700279 nsecs_t processAnrsLocked() REQUIRES(mLock);
280 nsecs_t getDispatchingTimeoutLocked(const sp<IBinder>& token) REQUIRES(mLock);
281
Michael Wrightd02c5b62014-02-10 15:10:22 -0800282 // Input filter processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800283 bool shouldSendKeyToInputFilterLocked(const NotifyKeyArgs* args) REQUIRES(mLock);
284 bool shouldSendMotionToInputFilterLocked(const NotifyMotionArgs* args) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800285
286 // Inbound event processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800287 void drainInboundQueueLocked() REQUIRES(mLock);
288 void releasePendingEventLocked() REQUIRES(mLock);
289 void releaseInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800290
291 // Dispatch state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800292 bool mDispatchEnabled GUARDED_BY(mLock);
293 bool mDispatchFrozen GUARDED_BY(mLock);
294 bool mInputFilterEnabled GUARDED_BY(mLock);
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800295 bool mInTouchMode GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800296
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800297 std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>> mWindowHandlesByDisplay
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800298 GUARDED_BY(mLock);
Arthur Hung72d8dc32020-03-28 00:48:39 +0000299 void setInputWindowsLocked(const std::vector<sp<InputWindowHandle>>& inputWindowHandles,
300 int32_t displayId) REQUIRES(mLock);
Arthur Hungb92218b2018-08-14 12:00:21 +0800301 // Get window handles by display, return an empty vector if not found.
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800302 std::vector<sp<InputWindowHandle>> getWindowHandlesLocked(int32_t displayId) const
303 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800304 sp<InputWindowHandle> getWindowHandleLocked(const sp<IBinder>& windowHandleToken) const
305 REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500306 std::shared_ptr<InputChannel> getInputChannelLocked(const sp<IBinder>& windowToken) const
307 REQUIRES(mLock);
Mady Mellor017bcd12020-06-23 19:12:00 +0000308 bool hasWindowHandleLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800309
Siarhei Vishniakoub3ad35c2019-04-05 10:50:52 -0700310 /*
311 * Validate and update InputWindowHandles for a given display.
312 */
313 void updateWindowHandlesForDisplayLocked(
314 const std::vector<sp<InputWindowHandle>>& inputWindowHandles, int32_t displayId)
315 REQUIRES(mLock);
316
Michael Wrightd02c5b62014-02-10 15:10:22 -0800317 // Focus tracking for keys, trackball, etc.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800318 std::unordered_map<int32_t, sp<InputWindowHandle>> mFocusedWindowHandlesByDisplay
319 GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800320
Siarhei Vishniakoubde3d9e2020-03-24 19:05:54 -0700321 std::unordered_map<int32_t, TouchState> mTouchStatesByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800322
Tiger Huang721e26f2018-07-24 22:26:19 +0800323 // Focused applications.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800324 std::unordered_map<int32_t, sp<InputApplicationHandle>> mFocusedApplicationHandlesByDisplay
325 GUARDED_BY(mLock);
Tiger Huang721e26f2018-07-24 22:26:19 +0800326
327 // Top focused display.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800328 int32_t mFocusedDisplayId GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800329
330 // Dispatcher state at time of last ANR.
Siarhei Vishniakoub1a16272020-05-06 16:09:19 -0700331 std::string mLastAnrState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800332
Siarhei Vishniakou887b7d92020-06-18 00:43:02 +0000333 // The connection tokens of the channels that the user last interacted, for debugging
334 std::unordered_set<sp<IBinder>, IBinderHash> mInteractionConnectionTokens GUARDED_BY(mLock);
335 void updateInteractionTokensLocked(const EventEntry& entry,
336 const std::vector<InputTarget>& targets) REQUIRES(mLock);
337
Michael Wrightd02c5b62014-02-10 15:10:22 -0800338 // Dispatch inbound events.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700339 bool dispatchConfigurationChangedLocked(nsecs_t currentTime, ConfigurationChangedEntry* entry)
340 REQUIRES(mLock);
341 bool dispatchDeviceResetLocked(nsecs_t currentTime, DeviceResetEntry* entry) REQUIRES(mLock);
342 bool dispatchKeyLocked(nsecs_t currentTime, KeyEntry* entry, DropReason* dropReason,
343 nsecs_t* nextWakeupTime) REQUIRES(mLock);
344 bool dispatchMotionLocked(nsecs_t currentTime, MotionEntry* entry, DropReason* dropReason,
345 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100346 void dispatchFocusLocked(nsecs_t currentTime, FocusEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800347 void dispatchEventLocked(nsecs_t currentTime, EventEntry* entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700348 const std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800349
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700350 void logOutboundKeyDetails(const char* prefix, const KeyEntry& entry);
351 void logOutboundMotionDetails(const char* prefix, const MotionEntry& entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800352
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700353 /**
354 * This field is set if there is no focused window, and we have an event that requires
355 * a focused window to be dispatched (for example, a KeyEvent).
356 * When this happens, we will wait until *mNoFocusedWindowTimeoutTime before
357 * dropping the event and raising an ANR for that application.
358 * This is useful if an application is slow to add a focused window.
359 */
360 std::optional<nsecs_t> mNoFocusedWindowTimeoutTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800361
Siarhei Vishniakoude1bc4a2020-05-26 22:39:43 -0700362 bool shouldPruneInboundQueueLocked(const MotionEntry& motionEntry) REQUIRES(mLock);
363
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700364 /**
365 * Time to stop waiting for the events to be processed while trying to dispatch a key.
366 * When this time expires, we just send the pending key event to the currently focused window,
367 * without waiting on other events to be processed first.
368 */
369 std::optional<nsecs_t> mKeyIsWaitingForEventsTimeout GUARDED_BY(mLock);
370 bool shouldWaitToSendKeyLocked(nsecs_t currentTime, const char* focusedWindowName)
371 REQUIRES(mLock);
372
373 /**
374 * The focused application at the time when no focused window was present.
375 * Used to raise an ANR when we have no focused window.
376 */
377 sp<InputApplicationHandle> mAwaitedFocusedApplication GUARDED_BY(mLock);
378
379 // Optimization: AnrTracker is used to quickly find which connection is due for a timeout next.
380 // AnrTracker must be kept in-sync with all responsive connection.waitQueues.
381 // If a connection is not responsive, then the entries should not be added to the AnrTracker.
382 // Once a connection becomes unresponsive, its entries are removed from AnrTracker to
383 // prevent unneeded wakeups.
384 AnrTracker mAnrTracker GUARDED_BY(mLock);
385 void extendAnrTimeoutsLocked(const sp<InputApplicationHandle>& application,
Siarhei Vishniakouc1ae5562020-06-30 14:22:57 -0500386 const sp<IBinder>& connectionToken,
387 std::chrono::nanoseconds timeoutExtension) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700388
Michael Wrightd02c5b62014-02-10 15:10:22 -0800389 // Contains the last window which received a hover event.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800390 sp<InputWindowHandle> mLastHoverWindowHandle GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800391
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700392 void cancelEventsForAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800393 nsecs_t getTimeSpentWaitingForApplicationLocked(nsecs_t currentTime) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700394 // If a focused application changes, we should stop counting down the "no focused window" time,
395 // because we will have no way of knowing when the previous application actually added a window.
396 // This also means that we will miss cases like pulling down notification shade when the
397 // focused application does not have a focused window (no ANR will be raised if notification
398 // shade is pulled down while we are counting down the timeout).
399 void resetNoFocusedWindowTimeoutLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800400
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700401 int32_t getTargetDisplayId(const EventEntry& entry);
402 int32_t findFocusedWindowTargetsLocked(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700403 std::vector<InputTarget>& inputTargets,
404 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700405 int32_t findTouchedWindowTargetsLocked(nsecs_t currentTime, const MotionEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700406 std::vector<InputTarget>& inputTargets,
407 nsecs_t* nextWakeupTime,
408 bool* outConflictingPointerActions) REQUIRES(mLock);
409 std::vector<TouchedMonitor> findTouchedGestureMonitorsLocked(
Siarhei Vishniakoue0fb6bd2020-04-13 11:40:37 -0700410 int32_t displayId, const std::vector<sp<InputWindowHandle>>& portalWindows) const
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700411 REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700412 std::vector<TouchedMonitor> selectResponsiveMonitorsLocked(
413 const std::vector<TouchedMonitor>& gestureMonitors) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800414
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700415 void addWindowTargetLocked(const sp<InputWindowHandle>& windowHandle, int32_t targetFlags,
416 BitSet32 pointerIds, std::vector<InputTarget>& inputTargets)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800417 REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000418 void addMonitoringTargetLocked(const Monitor& monitor, float xOffset, float yOffset,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700419 std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
420 void addGlobalMonitoringTargetsLocked(std::vector<InputTarget>& inputTargets, int32_t displayId,
421 float xOffset = 0, float yOffset = 0) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800422
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700423 void pokeUserActivityLocked(const EventEntry& eventEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800424 bool checkInjectionPermission(const sp<InputWindowHandle>& windowHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700425 const InjectionState* injectionState);
426 bool isWindowObscuredAtPointLocked(const sp<InputWindowHandle>& windowHandle, int32_t x,
427 int32_t y) const REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800428 bool isWindowObscuredLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
429 std::string getApplicationWindowLabel(const sp<InputApplicationHandle>& applicationHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700430 const sp<InputWindowHandle>& windowHandle);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800431
Michael Wrightd02c5b62014-02-10 15:10:22 -0800432 // Manage the dispatch cycle for a single connection.
433 // These methods are deliberately not Interruptible because doing all of the work
434 // with the mutex held makes it easier to ensure that connection invariants are maintained.
435 // If needed, the methods post commands to run later once the critical bits are done.
436 void prepareDispatchCycleLocked(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);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800439 void enqueueDispatchEntriesLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800440 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700441 REQUIRES(mLock);
442 void enqueueDispatchEntryLocked(const sp<Connection>& connection, EventEntry* eventEntry,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800443 const InputTarget& inputTarget, int32_t dispatchMode)
chaviw8c9cf542019-03-25 13:02:48 -0700444 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800445 void startDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection)
446 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800447 void finishDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700448 uint32_t seq, bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800449 void abortBrokenDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700450 bool notify) REQUIRES(mLock);
Siarhei Vishniakou13bda6c2019-07-29 08:34:33 -0700451 void drainDispatchQueue(std::deque<DispatchEntry*>& queue);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800452 void releaseDispatchEntry(DispatchEntry* dispatchEntry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800453 static int handleReceiveCallback(int fd, int events, void* data);
chaviw8c9cf542019-03-25 13:02:48 -0700454 // The action sent should only be of type AMOTION_EVENT_*
chaviwfd6d3512019-03-25 13:23:49 -0700455 void dispatchPointerDownOutsideFocus(uint32_t source, int32_t action,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700456 const sp<IBinder>& newToken) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800457
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700458 void synthesizeCancelationEventsForAllConnectionsLocked(const CancelationOptions& options)
459 REQUIRES(mLock);
460 void synthesizeCancelationEventsForMonitorsLocked(const CancelationOptions& options)
461 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800462 void synthesizeCancelationEventsForMonitorsLocked(
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700463 const CancelationOptions& options,
Michael Wright3dd60e22019-03-27 22:06:44 +0000464 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500465 void synthesizeCancelationEventsForInputChannelLocked(
466 const std::shared_ptr<InputChannel>& channel, const CancelationOptions& options)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700467 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800468 void synthesizeCancelationEventsForConnectionLocked(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700469 const CancelationOptions& options)
470 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800471
Svet Ganov5d3bc372020-01-26 23:11:07 -0800472 void synthesizePointerDownEventsForConnectionLocked(const sp<Connection>& connection)
473 REQUIRES(mLock);
474
Michael Wrightd02c5b62014-02-10 15:10:22 -0800475 // Splitting motion events across windows.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700476 MotionEntry* splitMotionEvent(const MotionEntry& originalMotionEntry, BitSet32 pointerIds);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800477
478 // Reset and drop everything the dispatcher is doing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800479 void resetAndDropEverythingLocked(const char* reason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800480
481 // Dump state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800482 void dumpDispatchStateLocked(std::string& dump) REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000483 void dumpMonitors(std::string& dump, const std::vector<Monitor>& monitors);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800484 void logDispatchStateLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800485
486 // Registration.
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500487 void removeMonitorChannelLocked(const InputChannel& inputChannel) REQUIRES(mLock);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700488 void removeMonitorChannelLocked(
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500489 const InputChannel& inputChannel,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700490 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakouce5ab082020-07-09 17:03:21 -0500491 status_t unregisterInputChannelLocked(const InputChannel& inputChannel, bool notify)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800492 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800493
494 // Interesting events that we might like to log or tell the framework about.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700495 void onDispatchCycleFinishedLocked(nsecs_t currentTime, const sp<Connection>& connection,
496 uint32_t seq, bool handled) REQUIRES(mLock);
497 void onDispatchCycleBrokenLocked(nsecs_t currentTime, const sp<Connection>& connection)
498 REQUIRES(mLock);
chaviw0c06c6e2019-01-09 13:27:07 -0800499 void onFocusChangedLocked(const sp<InputWindowHandle>& oldFocus,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700500 const sp<InputWindowHandle>& newFocus) REQUIRES(mLock);
Siarhei Vishniakoue4623042020-03-25 16:16:40 -0700501 void onAnrLocked(const sp<Connection>& connection) REQUIRES(mLock);
502 void onAnrLocked(const sp<InputApplicationHandle>& application) REQUIRES(mLock);
503 void updateLastAnrStateLocked(const sp<InputWindowHandle>& window, const std::string& reason)
504 REQUIRES(mLock);
505 void updateLastAnrStateLocked(const sp<InputApplicationHandle>& application,
506 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