blob: ab481bd4116d399a828a0ea45c2cf6d41a5ed5a2 [file] [log] [blame]
Garfield Tane84e6f92019-08-29 17:28:41 -07001/*
2 * Copyright (C) 2019 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_INPUTDISPATCHER_ENTRY_H
18#define _UI_INPUT_INPUTDISPATCHER_ENTRY_H
19
20#include "InjectionState.h"
21#include "InputTarget.h"
22
23#include <input/Input.h>
24#include <input/InputApplication.h>
25#include <stdint.h>
26#include <utils/Timers.h>
27#include <functional>
28#include <string>
29
30namespace android::inputdispatcher {
31
32struct EventEntry {
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +010033 enum class Type {
34 CONFIGURATION_CHANGED,
35 DEVICE_RESET,
36 FOCUS,
37 KEY,
38 MOTION,
39 };
Siarhei Vishniakou49483272019-10-22 13:13:47 -070040
41 static const char* typeToString(Type type) {
42 switch (type) {
43 case Type::CONFIGURATION_CHANGED:
44 return "CONFIGURATION_CHANGED";
45 case Type::DEVICE_RESET:
46 return "DEVICE_RESET";
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +010047 case Type::FOCUS:
48 return "FOCUS";
Siarhei Vishniakou49483272019-10-22 13:13:47 -070049 case Type::KEY:
50 return "KEY";
51 case Type::MOTION:
52 return "MOTION";
53 }
54 }
Garfield Tane84e6f92019-08-29 17:28:41 -070055
Garfield Tan6a5a14e2020-01-28 13:24:04 -080056 int32_t id;
Garfield Tane84e6f92019-08-29 17:28:41 -070057 mutable int32_t refCount;
Siarhei Vishniakou49483272019-10-22 13:13:47 -070058 Type type;
Garfield Tane84e6f92019-08-29 17:28:41 -070059 nsecs_t eventTime;
60 uint32_t policyFlags;
61 InjectionState* injectionState;
62
63 bool dispatchInProgress; // initially false, set to true while dispatching
64
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -050065 /**
66 * Injected keys are events from an external (probably untrusted) application
67 * and are not related to real hardware state. They come in via
68 * InputDispatcher::injectInputEvent, which sets policy flag POLICY_FLAG_INJECTED.
69 */
Garfield Tane84e6f92019-08-29 17:28:41 -070070 inline bool isInjected() const { return injectionState != nullptr; }
71
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -050072 /**
73 * Synthesized events are either injected events, or events that come
74 * from real hardware, but aren't directly attributable to a specific hardware event.
75 * Key repeat is a synthesized event, because it is related to an actual hardware state
76 * (a key is currently pressed), but the repeat itself is generated by the framework.
77 */
Garfield Tanff1f1bb2020-01-28 13:24:04 -080078 inline bool isSynthesized() const {
79 return isInjected() || IdGenerator::getSource(id) != IdGenerator::Source::INPUT_READER;
80 }
Siarhei Vishniakoude4bf152019-08-16 11:12:52 -050081
Garfield Tane84e6f92019-08-29 17:28:41 -070082 void release();
83
84 virtual void appendDescription(std::string& msg) const = 0;
85
86protected:
Garfield Tan6a5a14e2020-01-28 13:24:04 -080087 EventEntry(int32_t id, Type type, nsecs_t eventTime, uint32_t policyFlags);
Garfield Tane84e6f92019-08-29 17:28:41 -070088 virtual ~EventEntry();
89 void releaseInjectionState();
90};
91
92struct ConfigurationChangedEntry : EventEntry {
Garfield Tan6a5a14e2020-01-28 13:24:04 -080093 explicit ConfigurationChangedEntry(int32_t id, nsecs_t eventTime);
Garfield Tane84e6f92019-08-29 17:28:41 -070094 virtual void appendDescription(std::string& msg) const;
95
96protected:
97 virtual ~ConfigurationChangedEntry();
98};
99
100struct DeviceResetEntry : EventEntry {
101 int32_t deviceId;
102
Garfield Tan6a5a14e2020-01-28 13:24:04 -0800103 DeviceResetEntry(int32_t id, nsecs_t eventTime, int32_t deviceId);
Garfield Tane84e6f92019-08-29 17:28:41 -0700104 virtual void appendDescription(std::string& msg) const;
105
106protected:
107 virtual ~DeviceResetEntry();
108};
109
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100110struct FocusEntry : EventEntry {
111 sp<IBinder> connectionToken;
112 bool hasFocus;
113
Garfield Tan6a5a14e2020-01-28 13:24:04 -0800114 FocusEntry(int32_t id, nsecs_t eventTime, sp<IBinder> connectionToken, bool hasFocus);
Siarhei Vishniakouf1035d42019-09-20 16:32:01 +0100115 virtual void appendDescription(std::string& msg) const;
116
117protected:
118 virtual ~FocusEntry();
119};
120
Garfield Tane84e6f92019-08-29 17:28:41 -0700121struct KeyEntry : EventEntry {
122 int32_t deviceId;
123 uint32_t source;
124 int32_t displayId;
125 int32_t action;
126 int32_t flags;
127 int32_t keyCode;
128 int32_t scanCode;
129 int32_t metaState;
130 int32_t repeatCount;
131 nsecs_t downTime;
132
133 bool syntheticRepeat; // set to true for synthetic key repeats
134
135 enum InterceptKeyResult {
136 INTERCEPT_KEY_RESULT_UNKNOWN,
137 INTERCEPT_KEY_RESULT_SKIP,
138 INTERCEPT_KEY_RESULT_CONTINUE,
139 INTERCEPT_KEY_RESULT_TRY_AGAIN_LATER,
140 };
141 InterceptKeyResult interceptKeyResult; // set based on the interception result
142 nsecs_t interceptKeyWakeupTime; // used with INTERCEPT_KEY_RESULT_TRY_AGAIN_LATER
143
Garfield Tan6a5a14e2020-01-28 13:24:04 -0800144 KeyEntry(int32_t id, nsecs_t eventTime, int32_t deviceId, uint32_t source, int32_t displayId,
145 uint32_t policyFlags, int32_t action, int32_t flags, int32_t keyCode, int32_t scanCode,
146 int32_t metaState, int32_t repeatCount, nsecs_t downTime);
Garfield Tane84e6f92019-08-29 17:28:41 -0700147 virtual void appendDescription(std::string& msg) const;
148 void recycle();
149
150protected:
151 virtual ~KeyEntry();
152};
153
154struct MotionEntry : EventEntry {
155 nsecs_t eventTime;
156 int32_t deviceId;
157 uint32_t source;
158 int32_t displayId;
159 int32_t action;
160 int32_t actionButton;
161 int32_t flags;
162 int32_t metaState;
163 int32_t buttonState;
164 MotionClassification classification;
165 int32_t edgeFlags;
166 float xPrecision;
167 float yPrecision;
168 float xCursorPosition;
169 float yCursorPosition;
170 nsecs_t downTime;
171 uint32_t pointerCount;
172 PointerProperties pointerProperties[MAX_POINTERS];
173 PointerCoords pointerCoords[MAX_POINTERS];
174
Garfield Tan6a5a14e2020-01-28 13:24:04 -0800175 MotionEntry(int32_t id, nsecs_t eventTime, int32_t deviceId, uint32_t source, int32_t displayId,
176 uint32_t policyFlags, int32_t action, int32_t actionButton, int32_t flags,
177 int32_t metaState, int32_t buttonState, MotionClassification classification,
178 int32_t edgeFlags, float xPrecision, float yPrecision, float xCursorPosition,
179 float yCursorPosition, nsecs_t downTime, uint32_t pointerCount,
180 const PointerProperties* pointerProperties, const PointerCoords* pointerCoords,
181 float xOffset, float yOffset);
Garfield Tane84e6f92019-08-29 17:28:41 -0700182 virtual void appendDescription(std::string& msg) const;
183
184protected:
185 virtual ~MotionEntry();
186};
187
188// Tracks the progress of dispatching a particular event to a particular connection.
189struct DispatchEntry {
190 const uint32_t seq; // unique sequence number, never 0
191
192 EventEntry* eventEntry; // the event to dispatch
193 int32_t targetFlags;
194 float xOffset;
195 float yOffset;
196 float globalScaleFactor;
197 float windowXScale = 1.0f;
198 float windowYScale = 1.0f;
199 nsecs_t deliveryTime; // time when the event was actually delivered
200
Garfield Tanff1f1bb2020-01-28 13:24:04 -0800201 // Set to the resolved ID, action and flags when the event is enqueued.
202 int32_t resolvedEventId;
Garfield Tane84e6f92019-08-29 17:28:41 -0700203 int32_t resolvedAction;
204 int32_t resolvedFlags;
205
206 DispatchEntry(EventEntry* eventEntry, int32_t targetFlags, float xOffset, float yOffset,
207 float globalScaleFactor, float windowXScale, float windowYScale);
208 ~DispatchEntry();
209
210 inline bool hasForegroundTarget() const { return targetFlags & InputTarget::FLAG_FOREGROUND; }
211
212 inline bool isSplit() const { return targetFlags & InputTarget::FLAG_SPLIT; }
213
214private:
215 static volatile int32_t sNextSeqAtomic;
216
217 static uint32_t nextSeq();
218};
219
Gang Wange9087892020-01-07 12:17:14 -0500220VerifiedKeyEvent verifiedKeyEventFromKeyEntry(const KeyEntry& entry);
221VerifiedMotionEvent verifiedMotionEventFromMotionEntry(const MotionEntry& entry);
222
Garfield Tane84e6f92019-08-29 17:28:41 -0700223class InputDispatcher;
224// A command entry captures state and behavior for an action to be performed in the
225// dispatch loop after the initial processing has taken place. It is essentially
226// a kind of continuation used to postpone sensitive policy interactions to a point
227// in the dispatch loop where it is safe to release the lock (generally after finishing
228// the critical parts of the dispatch cycle).
229//
230// The special thing about commands is that they can voluntarily release and reacquire
231// the dispatcher lock at will. Initially when the command starts running, the
232// dispatcher lock is held. However, if the command needs to call into the policy to
233// do some work, it can release the lock, do the work, then reacquire the lock again
234// before returning.
235//
236// This mechanism is a bit clunky but it helps to preserve the invariant that the dispatch
237// never calls into the policy while holding its lock.
238//
239// Commands are implicitly 'LockedInterruptible'.
240struct CommandEntry;
241typedef std::function<void(InputDispatcher&, CommandEntry*)> Command;
242
243class Connection;
244struct CommandEntry {
245 explicit CommandEntry(Command command);
246 ~CommandEntry();
247
248 Command command;
249
250 // parameters for the command (usage varies by command)
251 sp<Connection> connection;
252 nsecs_t eventTime;
253 KeyEntry* keyEntry;
254 sp<InputApplicationHandle> inputApplicationHandle;
255 std::string reason;
256 int32_t userActivityEventType;
257 uint32_t seq;
258 bool handled;
259 sp<InputChannel> inputChannel;
260 sp<IBinder> oldToken;
261 sp<IBinder> newToken;
262};
263
264} // namespace android::inputdispatcher
265
266#endif // _UI_INPUT_INPUTDISPATCHER_ENTRY_H