blob: cbba7e1318ce38ee482f12f2a4ce90380689afc2 [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
Garfield Tane84e6f92019-08-29 17:28:41 -070020#include "CancelationOptions.h"
21#include "Entry.h"
22#include "InjectionState.h"
23#include "InputDispatcherConfiguration.h"
24#include "InputDispatcherInterface.h"
25#include "InputDispatcherPolicyInterface.h"
26#include "InputState.h"
27#include "InputTarget.h"
Prabir Pradhan5a57cff2019-10-31 18:40:33 -070028#include "InputThread.h"
Garfield Tane84e6f92019-08-29 17:28:41 -070029#include "Monitor.h"
30#include "TouchState.h"
31#include "TouchedWindow.h"
32
Michael Wrightd02c5b62014-02-10 15:10:22 -080033#include <input/Input.h>
Robert Carr3720ed02018-08-08 16:08:27 -070034#include <input/InputApplication.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080035#include <input/InputTransport.h>
Robert Carr3720ed02018-08-08 16:08:27 -070036#include <input/InputWindow.h>
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -050037#include <input/LatencyStatistics.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070038#include <limits.h>
39#include <stddef.h>
Michael Wright3dd60e22019-03-27 22:06:44 +000040#include <ui/Region.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070041#include <unistd.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080042#include <utils/BitSet.h>
Garfield Tan0fc2fa72019-08-29 17:22:15 -070043#include <utils/Looper.h>
44#include <utils/RefBase.h>
45#include <utils/Timers.h>
46#include <utils/threads.h>
47#include <condition_variable>
Garfield Tane84e6f92019-08-29 17:28:41 -070048#include <deque>
Garfield Tan0fc2fa72019-08-29 17:22:15 -070049#include <optional>
Robert Carr5c8a0262018-10-03 16:30:44 -070050#include <unordered_map>
Michael Wrightd02c5b62014-02-10 15:10:22 -080051
Garfield Tane84e6f92019-08-29 17:28:41 -070052#include <InputListener.h>
53#include <InputReporterInterface.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080054
Garfield Tane84e6f92019-08-29 17:28:41 -070055namespace android::inputdispatcher {
Michael Wrightd02c5b62014-02-10 15:10:22 -080056
Garfield Tane84e6f92019-08-29 17:28:41 -070057class Connection;
Michael Wrightd02c5b62014-02-10 15:10:22 -080058
Gang Wang342c9272020-01-13 13:15:04 -050059class HmacKeyManager {
60public:
61 HmacKeyManager();
62 std::array<uint8_t, 32> sign(const VerifiedInputEvent& event) const;
63
64private:
65 std::array<uint8_t, 32> sign(const std::vector<uint8_t>& data) const;
66 const std::array<uint8_t, 128> mHmacKey;
67};
68
Michael Wrightd02c5b62014-02-10 15:10:22 -080069/* Dispatches events to input targets. Some functions of the input dispatcher, such as
70 * identifying input targets, are controlled by a separate policy object.
71 *
72 * IMPORTANT INVARIANT:
73 * Because the policy can potentially block or cause re-entrance into the input dispatcher,
74 * the input dispatcher never calls into the policy while holding its internal locks.
75 * The implementation is also carefully designed to recover from scenarios such as an
76 * input channel becoming unregistered while identifying input targets or processing timeouts.
77 *
78 * Methods marked 'Locked' must be called with the lock acquired.
79 *
80 * Methods marked 'LockedInterruptible' must be called with the lock acquired but
81 * may during the course of their execution release the lock, call into the policy, and
82 * then reacquire the lock. The caller is responsible for recovering gracefully.
83 *
84 * A 'LockedInterruptible' method may called a 'Locked' method, but NOT vice-versa.
85 */
Garfield Tane84e6f92019-08-29 17:28:41 -070086class InputDispatcher : public android::InputDispatcherInterface {
Michael Wrightd02c5b62014-02-10 15:10:22 -080087protected:
88 virtual ~InputDispatcher();
89
90public:
91 explicit InputDispatcher(const sp<InputDispatcherPolicyInterface>& policy);
92
Michael Wright3dd60e22019-03-27 22:06:44 +000093 virtual void dump(std::string& dump) override;
94 virtual void monitor() override;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -080095 virtual bool waitForIdle() override;
Prabir Pradhan3608aad2019-10-02 17:08:26 -070096 virtual status_t start() override;
97 virtual status_t stop() override;
Michael Wrightd02c5b62014-02-10 15:10:22 -080098
Michael Wright3dd60e22019-03-27 22:06:44 +000099 virtual void notifyConfigurationChanged(const NotifyConfigurationChangedArgs* args) override;
100 virtual void notifyKey(const NotifyKeyArgs* args) override;
101 virtual void notifyMotion(const NotifyMotionArgs* args) override;
102 virtual void notifySwitch(const NotifySwitchArgs* args) override;
103 virtual void notifyDeviceReset(const NotifyDeviceResetArgs* args) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800104
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700105 virtual int32_t injectInputEvent(const InputEvent* event, int32_t injectorPid,
106 int32_t injectorUid, int32_t syncMode, int32_t timeoutMillis,
107 uint32_t policyFlags) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800108
Siarhei Vishniakou54d3e182020-01-15 17:38:38 -0800109 virtual std::unique_ptr<VerifiedInputEvent> verifyInputEvent(const InputEvent& event) override;
110
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700111 virtual void setInputWindows(
Arthur Hung72d8dc32020-03-28 00:48:39 +0000112 const std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>>&
113 handlesPerDisplay) override;
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700114 virtual void setFocusedApplication(
115 int32_t displayId, const sp<InputApplicationHandle>& inputApplicationHandle) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000116 virtual void setFocusedDisplay(int32_t displayId) override;
117 virtual void setInputDispatchMode(bool enabled, bool frozen) override;
118 virtual void setInputFilterEnabled(bool enabled) override;
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800119 virtual void setInTouchMode(bool inTouchMode) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800120
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700121 virtual bool transferTouchFocus(const sp<IBinder>& fromToken,
122 const sp<IBinder>& toToken) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800123
Siarhei Vishniakou7c34b232019-10-11 19:08:48 -0700124 virtual status_t registerInputChannel(const sp<InputChannel>& inputChannel) override;
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700125 virtual status_t registerInputMonitor(const sp<InputChannel>& inputChannel, int32_t displayId,
126 bool isGestureMonitor) override;
Michael Wright3dd60e22019-03-27 22:06:44 +0000127 virtual status_t unregisterInputChannel(const sp<InputChannel>& inputChannel) override;
128 virtual status_t pilferPointers(const sp<IBinder>& token) override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800129
130private:
Siarhei Vishniakou0fb1a0e2019-10-22 11:23:36 -0700131 enum class DropReason {
132 NOT_DROPPED,
133 POLICY,
134 APP_SWITCH,
135 DISABLED,
136 BLOCKED,
137 STALE,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800138 };
139
Prabir Pradhan5a57cff2019-10-31 18:40:33 -0700140 std::unique_ptr<InputThread> mThread;
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700141
Michael Wrightd02c5b62014-02-10 15:10:22 -0800142 sp<InputDispatcherPolicyInterface> mPolicy;
Garfield Tane84e6f92019-08-29 17:28:41 -0700143 android::InputDispatcherConfiguration mConfig;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800144
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800145 std::mutex mLock;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800146
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800147 std::condition_variable mDispatcherIsAlive;
Siarhei Vishniakou2bfa9052019-11-21 18:10:54 -0800148 std::condition_variable mDispatcherEnteredIdle;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800149
150 sp<Looper> mLooper;
151
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800152 EventEntry* mPendingEvent GUARDED_BY(mLock);
Siarhei Vishniakou44a2aed2019-07-29 08:59:52 -0700153 std::deque<EventEntry*> mInboundQueue GUARDED_BY(mLock);
154 std::deque<EventEntry*> mRecentQueue GUARDED_BY(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700155 std::deque<std::unique_ptr<CommandEntry>> mCommandQueue GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800156
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800157 DropReason mLastDropReason GUARDED_BY(mLock);
Michael Wright3a981722015-06-10 15:26:13 +0100158
Garfield Tan1c7bc862020-01-28 13:24:04 -0800159 const IdGenerator mIdGenerator;
160
Prabir Pradhan3608aad2019-10-02 17:08:26 -0700161 // With each iteration, InputDispatcher nominally processes one queued event,
162 // a timeout, or a response from an input consumer.
163 // This method should only be called on the input dispatcher's own thread.
164 void dispatchOnce();
165
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800166 void dispatchOnceInnerLocked(nsecs_t* nextWakeupTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800167
168 // Enqueues an inbound event. Returns true if mLooper->wake() should be called.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800169 bool enqueueInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800170
171 // Cleans up input state when dropping an inbound event.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700172 void dropInboundEventLocked(const EventEntry& entry, DropReason dropReason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800173
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100174 // Enqueues a focus event.
175 void enqueueFocusEventLocked(const InputWindowHandle& window, bool hasFocus) REQUIRES(mLock);
176
Michael Wrightd02c5b62014-02-10 15:10:22 -0800177 // Adds an event to a queue of recent events for debugging purposes.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800178 void addRecentEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800179
180 // App switch latency optimization.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800181 bool mAppSwitchSawKeyDown GUARDED_BY(mLock);
182 nsecs_t mAppSwitchDueTime GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800183
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700184 bool isAppSwitchKeyEvent(const KeyEntry& keyEntry);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800185 bool isAppSwitchPendingLocked() REQUIRES(mLock);
186 void resetPendingAppSwitchLocked(bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800187
Michael Wrightd02c5b62014-02-10 15:10:22 -0800188 // Blocked event latency optimization. Drops old events when the user intends
189 // to transfer focus to a new application.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800190 EventEntry* mNextUnblockedEvent GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800191
Tiger Huang85b8c5e2019-01-17 18:34:54 +0800192 sp<InputWindowHandle> findTouchedWindowAtLocked(int32_t displayId, int32_t x, int32_t y,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700193 bool addOutsideTargets = false,
194 bool addPortalWindows = false) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800195
196 // All registered connections mapped by channel file descriptor.
Siarhei Vishniakou146ecfd2019-07-29 16:04:31 -0700197 std::unordered_map<int, sp<Connection>> mConnectionsByFd GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800198
Robert Carr5c8a0262018-10-03 16:30:44 -0700199 struct IBinderHash {
200 std::size_t operator()(const sp<IBinder>& b) const {
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700201 return std::hash<IBinder*>{}(b.get());
Robert Carr5c8a0262018-10-03 16:30:44 -0700202 }
203 };
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800204 std::unordered_map<sp<IBinder>, sp<InputChannel>, IBinderHash> mInputChannelsByToken
205 GUARDED_BY(mLock);
Robert Carr5c8a0262018-10-03 16:30:44 -0700206
Michael Wright3dd60e22019-03-27 22:06:44 +0000207 // Finds the display ID of the gesture monitor identified by the provided token.
208 std::optional<int32_t> findGestureMonitorDisplayByTokenLocked(const sp<IBinder>& token)
209 REQUIRES(mLock);
210
Siarhei Vishniakoud0d71b62019-10-14 14:50:45 -0700211 sp<Connection> getConnectionLocked(const sp<IBinder>& inputConnectionToken) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800212
Arthur Hung2fbf37f2018-09-13 18:16:41 +0800213 // Input channels that will receive a copy of all input events sent to the provided display.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700214 std::unordered_map<int32_t, std::vector<Monitor>> mGlobalMonitorsByDisplay GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800215
Michael Wright3dd60e22019-03-27 22:06:44 +0000216 // Input channels that will receive pointer events that start within the corresponding display.
217 // These are a bit special when compared to global monitors since they'll cause gesture streams
218 // to continue even when there isn't a touched window,and have the ability to steal the rest of
219 // the pointer stream in order to claim it for a system gesture.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700220 std::unordered_map<int32_t, std::vector<Monitor>> mGestureMonitorsByDisplay GUARDED_BY(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000221
Gang Wange9087892020-01-07 12:17:14 -0500222 HmacKeyManager mHmacKeyManager;
223
Michael Wrightd02c5b62014-02-10 15:10:22 -0800224 // Event injection and synchronization.
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800225 std::condition_variable mInjectionResultAvailable;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800226 bool hasInjectionPermission(int32_t injectorPid, int32_t injectorUid);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800227 void setInjectionResult(EventEntry* entry, int32_t injectionResult);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800228
Siarhei Vishniakou443ad902019-03-06 17:25:41 -0800229 std::condition_variable mInjectionSyncFinished;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800230 void incrementPendingForegroundDispatches(EventEntry* entry);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800231 void decrementPendingForegroundDispatches(EventEntry* entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800232
233 // Key repeat tracking.
234 struct KeyRepeatState {
235 KeyEntry* lastKeyEntry; // or null if no repeat
236 nsecs_t nextRepeatTime;
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800237 } mKeyRepeatState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800238
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800239 void resetKeyRepeatLocked() REQUIRES(mLock);
240 KeyEntry* synthesizeKeyRepeatLocked(nsecs_t currentTime) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800241
Michael Wright78f24442014-08-06 15:55:28 -0700242 // Key replacement tracking
243 struct KeyReplacement {
244 int32_t keyCode;
245 int32_t deviceId;
246 bool operator==(const KeyReplacement& rhs) const {
247 return keyCode == rhs.keyCode && deviceId == rhs.deviceId;
248 }
249 bool operator<(const KeyReplacement& rhs) const {
250 return keyCode != rhs.keyCode ? keyCode < rhs.keyCode : deviceId < rhs.deviceId;
251 }
252 };
253 // Maps the key code replaced, device id tuple to the key code it was replaced with
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800254 KeyedVector<KeyReplacement, int32_t> mReplacedKeys GUARDED_BY(mLock);
Siarhei Vishniakou61fafdd2018-04-13 11:00:58 -0500255 // Process certain Meta + Key combinations
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700256 void accelerateMetaShortcuts(const int32_t deviceId, const int32_t action, int32_t& keyCode,
257 int32_t& metaState);
Michael Wright78f24442014-08-06 15:55:28 -0700258
Michael Wrightd02c5b62014-02-10 15:10:22 -0800259 // Deferred command processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800260 bool haveCommandsLocked() const REQUIRES(mLock);
261 bool runCommandsLockedInterruptible() REQUIRES(mLock);
Siarhei Vishniakoue7c94b92019-07-29 09:17:54 -0700262 void postCommandLocked(std::unique_ptr<CommandEntry> commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800263
264 // Input filter processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800265 bool shouldSendKeyToInputFilterLocked(const NotifyKeyArgs* args) REQUIRES(mLock);
266 bool shouldSendMotionToInputFilterLocked(const NotifyMotionArgs* args) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800267
268 // Inbound event processing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800269 void drainInboundQueueLocked() REQUIRES(mLock);
270 void releasePendingEventLocked() REQUIRES(mLock);
271 void releaseInboundEventLocked(EventEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800272
273 // Dispatch state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800274 bool mDispatchEnabled GUARDED_BY(mLock);
275 bool mDispatchFrozen GUARDED_BY(mLock);
276 bool mInputFilterEnabled GUARDED_BY(mLock);
Siarhei Vishniakouf3bc1aa2019-11-25 13:48:53 -0800277 bool mInTouchMode GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800278
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800279 std::unordered_map<int32_t, std::vector<sp<InputWindowHandle>>> mWindowHandlesByDisplay
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800280 GUARDED_BY(mLock);
Arthur Hung72d8dc32020-03-28 00:48:39 +0000281 void setInputWindowsLocked(const std::vector<sp<InputWindowHandle>>& inputWindowHandles,
282 int32_t displayId) REQUIRES(mLock);
Arthur Hungb92218b2018-08-14 12:00:21 +0800283 // Get window handles by display, return an empty vector if not found.
Arthur Hung7c3ae9c2019-03-11 11:23:03 +0800284 std::vector<sp<InputWindowHandle>> getWindowHandlesLocked(int32_t displayId) const
285 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800286 sp<InputWindowHandle> getWindowHandleLocked(const sp<IBinder>& windowHandleToken) const
287 REQUIRES(mLock);
288 sp<InputChannel> getInputChannelLocked(const sp<IBinder>& windowToken) const REQUIRES(mLock);
289 bool hasWindowHandleLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800290
Siarhei Vishniakoub3ad35c2019-04-05 10:50:52 -0700291 /*
292 * Validate and update InputWindowHandles for a given display.
293 */
294 void updateWindowHandlesForDisplayLocked(
295 const std::vector<sp<InputWindowHandle>>& inputWindowHandles, int32_t displayId)
296 REQUIRES(mLock);
297
Michael Wrightd02c5b62014-02-10 15:10:22 -0800298 // Focus tracking for keys, trackball, etc.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800299 std::unordered_map<int32_t, sp<InputWindowHandle>> mFocusedWindowHandlesByDisplay
300 GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800301
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800302 KeyedVector<int32_t, TouchState> mTouchStatesByDisplay GUARDED_BY(mLock);
303 TouchState mTempTouchState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800304
Tiger Huang721e26f2018-07-24 22:26:19 +0800305 // Focused applications.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800306 std::unordered_map<int32_t, sp<InputApplicationHandle>> mFocusedApplicationHandlesByDisplay
307 GUARDED_BY(mLock);
Tiger Huang721e26f2018-07-24 22:26:19 +0800308
309 // Top focused display.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800310 int32_t mFocusedDisplayId GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800311
312 // Dispatcher state at time of last ANR.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800313 std::string mLastANRState GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800314
315 // Dispatch inbound events.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700316 bool dispatchConfigurationChangedLocked(nsecs_t currentTime, ConfigurationChangedEntry* entry)
317 REQUIRES(mLock);
318 bool dispatchDeviceResetLocked(nsecs_t currentTime, DeviceResetEntry* entry) REQUIRES(mLock);
319 bool dispatchKeyLocked(nsecs_t currentTime, KeyEntry* entry, DropReason* dropReason,
320 nsecs_t* nextWakeupTime) REQUIRES(mLock);
321 bool dispatchMotionLocked(nsecs_t currentTime, MotionEntry* entry, DropReason* dropReason,
322 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100323 void dispatchFocusLocked(nsecs_t currentTime, FocusEntry* entry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800324 void dispatchEventLocked(nsecs_t currentTime, EventEntry* entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700325 const std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800326
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700327 void logOutboundKeyDetails(const char* prefix, const KeyEntry& entry);
328 void logOutboundMotionDetails(const char* prefix, const MotionEntry& entry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800329
330 // Keeping track of ANR timeouts.
331 enum InputTargetWaitCause {
332 INPUT_TARGET_WAIT_CAUSE_NONE,
333 INPUT_TARGET_WAIT_CAUSE_SYSTEM_NOT_READY,
334 INPUT_TARGET_WAIT_CAUSE_APPLICATION_NOT_READY,
335 };
336
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800337 InputTargetWaitCause mInputTargetWaitCause GUARDED_BY(mLock);
338 nsecs_t mInputTargetWaitStartTime GUARDED_BY(mLock);
339 nsecs_t mInputTargetWaitTimeoutTime GUARDED_BY(mLock);
340 bool mInputTargetWaitTimeoutExpired GUARDED_BY(mLock);
341 sp<IBinder> mInputTargetWaitApplicationToken GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800342
343 // Contains the last window which received a hover event.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800344 sp<InputWindowHandle> mLastHoverWindowHandle GUARDED_BY(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800345
346 // Finding targets for input events.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700347 int32_t handleTargetsNotReadyLocked(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700348 const sp<InputApplicationHandle>& applicationHandle,
349 const sp<InputWindowHandle>& windowHandle,
350 nsecs_t* nextWakeupTime, const char* reason)
351 REQUIRES(mLock);
Robert Carr803535b2018-08-02 16:38:15 -0700352
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800353 void removeWindowByTokenLocked(const sp<IBinder>& token) REQUIRES(mLock);
Robert Carr803535b2018-08-02 16:38:15 -0700354
Michael Wrightd02c5b62014-02-10 15:10:22 -0800355 void resumeAfterTargetsNotReadyTimeoutLocked(nsecs_t newTimeout,
Siarhei Vishniakoud0d71b62019-10-14 14:50:45 -0700356 const sp<IBinder>& inputConnectionToken)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700357 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800358 nsecs_t getTimeSpentWaitingForApplicationLocked(nsecs_t currentTime) REQUIRES(mLock);
359 void resetANRTimeoutsLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800360
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700361 int32_t getTargetDisplayId(const EventEntry& entry);
362 int32_t findFocusedWindowTargetsLocked(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700363 std::vector<InputTarget>& inputTargets,
364 nsecs_t* nextWakeupTime) REQUIRES(mLock);
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700365 int32_t findTouchedWindowTargetsLocked(nsecs_t currentTime, const MotionEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700366 std::vector<InputTarget>& inputTargets,
367 nsecs_t* nextWakeupTime,
368 bool* outConflictingPointerActions) REQUIRES(mLock);
369 std::vector<TouchedMonitor> findTouchedGestureMonitorsLocked(
370 int32_t displayId, const std::vector<sp<InputWindowHandle>>& portalWindows)
371 REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000372 void addGestureMonitors(const std::vector<Monitor>& monitors,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700373 std::vector<TouchedMonitor>& outTouchedMonitors, float xOffset = 0,
374 float yOffset = 0);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800375
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700376 void addWindowTargetLocked(const sp<InputWindowHandle>& windowHandle, int32_t targetFlags,
377 BitSet32 pointerIds, std::vector<InputTarget>& inputTargets)
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800378 REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000379 void addMonitoringTargetLocked(const Monitor& monitor, float xOffset, float yOffset,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700380 std::vector<InputTarget>& inputTargets) REQUIRES(mLock);
381 void addGlobalMonitoringTargetsLocked(std::vector<InputTarget>& inputTargets, int32_t displayId,
382 float xOffset = 0, float yOffset = 0) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800383
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700384 void pokeUserActivityLocked(const EventEntry& eventEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800385 bool checkInjectionPermission(const sp<InputWindowHandle>& windowHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700386 const InjectionState* injectionState);
387 bool isWindowObscuredAtPointLocked(const sp<InputWindowHandle>& windowHandle, int32_t x,
388 int32_t y) const REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800389 bool isWindowObscuredLocked(const sp<InputWindowHandle>& windowHandle) const REQUIRES(mLock);
390 std::string getApplicationWindowLabel(const sp<InputApplicationHandle>& applicationHandle,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700391 const sp<InputWindowHandle>& windowHandle);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800392
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -0800393 std::string checkWindowReadyForMoreInputLocked(nsecs_t currentTime,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700394 const sp<InputWindowHandle>& windowHandle,
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700395 const EventEntry& eventEntry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700396 const char* targetType) REQUIRES(mLock);
Jeff Brownffb49772014-10-10 19:01:34 -0700397
Michael Wrightd02c5b62014-02-10 15:10:22 -0800398 // Manage the dispatch cycle for a single connection.
399 // These methods are deliberately not Interruptible because doing all of the work
400 // with the mutex held makes it easier to ensure that connection invariants are maintained.
401 // If needed, the methods post commands to run later once the critical bits are done.
402 void prepareDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800403 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700404 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800405 void enqueueDispatchEntriesLocked(nsecs_t currentTime, const sp<Connection>& connection,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800406 EventEntry* eventEntry, const InputTarget& inputTarget)
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700407 REQUIRES(mLock);
408 void enqueueDispatchEntryLocked(const sp<Connection>& connection, EventEntry* eventEntry,
Siarhei Vishniakou5d6b6612020-01-08 16:03:04 -0800409 const InputTarget& inputTarget, int32_t dispatchMode)
chaviw8c9cf542019-03-25 13:02:48 -0700410 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800411 void startDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection)
412 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800413 void finishDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700414 uint32_t seq, bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800415 void abortBrokenDispatchCycleLocked(nsecs_t currentTime, const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700416 bool notify) REQUIRES(mLock);
Siarhei Vishniakou13bda6c2019-07-29 08:34:33 -0700417 void drainDispatchQueue(std::deque<DispatchEntry*>& queue);
Siarhei Vishniakou62683e82019-03-06 17:59:56 -0800418 void releaseDispatchEntry(DispatchEntry* dispatchEntry);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800419 static int handleReceiveCallback(int fd, int events, void* data);
chaviw8c9cf542019-03-25 13:02:48 -0700420 // The action sent should only be of type AMOTION_EVENT_*
chaviwfd6d3512019-03-25 13:23:49 -0700421 void dispatchPointerDownOutsideFocus(uint32_t source, int32_t action,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700422 const sp<IBinder>& newToken) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800423
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700424 void synthesizeCancelationEventsForAllConnectionsLocked(const CancelationOptions& options)
425 REQUIRES(mLock);
426 void synthesizeCancelationEventsForMonitorsLocked(const CancelationOptions& options)
427 REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800428 void synthesizeCancelationEventsForMonitorsLocked(
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700429 const CancelationOptions& options,
Michael Wright3dd60e22019-03-27 22:06:44 +0000430 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800431 void synthesizeCancelationEventsForInputChannelLocked(const sp<InputChannel>& channel,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700432 const CancelationOptions& options)
433 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800434 void synthesizeCancelationEventsForConnectionLocked(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700435 const CancelationOptions& options)
436 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800437
Svet Ganov5d3bc372020-01-26 23:11:07 -0800438 void synthesizePointerDownEventsForConnectionLocked(const sp<Connection>& connection)
439 REQUIRES(mLock);
440
Michael Wrightd02c5b62014-02-10 15:10:22 -0800441 // Splitting motion events across windows.
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700442 MotionEntry* splitMotionEvent(const MotionEntry& originalMotionEntry, BitSet32 pointerIds);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800443
444 // Reset and drop everything the dispatcher is doing.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800445 void resetAndDropEverythingLocked(const char* reason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800446
447 // Dump state.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800448 void dumpDispatchStateLocked(std::string& dump) REQUIRES(mLock);
Michael Wright3dd60e22019-03-27 22:06:44 +0000449 void dumpMonitors(std::string& dump, const std::vector<Monitor>& monitors);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800450 void logDispatchStateLocked() REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800451
452 // Registration.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800453 void removeMonitorChannelLocked(const sp<InputChannel>& inputChannel) REQUIRES(mLock);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700454 void removeMonitorChannelLocked(
455 const sp<InputChannel>& inputChannel,
456 std::unordered_map<int32_t, std::vector<Monitor>>& monitorsByDisplay) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800457 status_t unregisterInputChannelLocked(const sp<InputChannel>& inputChannel, bool notify)
458 REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800459
460 // Interesting events that we might like to log or tell the framework about.
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700461 void onDispatchCycleFinishedLocked(nsecs_t currentTime, const sp<Connection>& connection,
462 uint32_t seq, bool handled) REQUIRES(mLock);
463 void onDispatchCycleBrokenLocked(nsecs_t currentTime, const sp<Connection>& connection)
464 REQUIRES(mLock);
chaviw0c06c6e2019-01-09 13:27:07 -0800465 void onFocusChangedLocked(const sp<InputWindowHandle>& oldFocus,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700466 const sp<InputWindowHandle>& newFocus) REQUIRES(mLock);
467 void onANRLocked(nsecs_t currentTime, const sp<InputApplicationHandle>& applicationHandle,
468 const sp<InputWindowHandle>& windowHandle, nsecs_t eventTime,
469 nsecs_t waitStartTime, const char* reason) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800470
471 // Outbound policy interactions.
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800472 void doNotifyConfigurationChangedLockedInterruptible(CommandEntry* commandEntry)
473 REQUIRES(mLock);
474 void doNotifyInputChannelBrokenLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
475 void doNotifyFocusChangedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
476 void doNotifyANRLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
477 void doInterceptKeyBeforeDispatchingLockedInterruptible(CommandEntry* commandEntry)
478 REQUIRES(mLock);
479 void doDispatchCycleFinishedLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800480 bool afterKeyEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700481 DispatchEntry* dispatchEntry, KeyEntry* keyEntry,
482 bool handled) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800483 bool afterMotionEventLockedInterruptible(const sp<Connection>& connection,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700484 DispatchEntry* dispatchEntry, MotionEntry* motionEntry,
485 bool handled) REQUIRES(mLock);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800486 void doPokeUserActivityLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Siarhei Vishniakou9757f782019-10-29 12:53:08 -0700487 KeyEvent createKeyEvent(const KeyEntry& entry);
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700488 void doOnPointerDownOutsideFocusLockedInterruptible(CommandEntry* commandEntry) REQUIRES(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800489
490 // Statistics gathering.
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -0500491 static constexpr std::chrono::duration TOUCH_STATS_REPORT_PERIOD = 5min;
492 LatencyStatistics mTouchStatistics{TOUCH_STATS_REPORT_PERIOD};
493
494 void reportTouchEventForStatistics(const MotionEntry& entry);
Siarhei Vishniakoud2770042019-10-29 11:08:14 -0700495 void updateDispatchStatistics(nsecs_t currentTime, const EventEntry& entry,
Garfield Tan0fc2fa72019-08-29 17:22:15 -0700496 int32_t injectionResult, nsecs_t timeSpentWaitingForApplication);
Siarhei Vishniakou61291d42019-02-11 18:13:20 -0800497 void traceInboundQueueLengthLocked() REQUIRES(mLock);
498 void traceOutboundQueueLength(const sp<Connection>& connection);
499 void traceWaitQueueLength(const sp<Connection>& connection);
Prabir Pradhanf93562f2018-11-29 12:13:37 -0800500
Prabir Pradhan79a4f0c2019-01-09 11:24:01 -0800501 sp<InputReporterInterface> mReporter;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800502};
503
Garfield Tane84e6f92019-08-29 17:28:41 -0700504} // namespace android::inputdispatcher
Michael Wrightd02c5b62014-02-10 15:10:22 -0800505
506#endif // _UI_INPUT_DISPATCHER_H