blob: 019283f1333431c8cd2074a9ec9f88e36298f7d2 [file] [log] [blame]
Prabir Pradhandae52792023-12-15 07:36:40 +00001/*
2 * Copyright 2024 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#define LOG_TAG "InputTracer"
18
19#include "InputTracer.h"
20
21#include <android-base/logging.h>
Prabir Pradhanbf3c8322024-02-23 02:38:36 +000022#include <private/android_filesystem_config.h>
Prabir Pradhandae52792023-12-15 07:36:40 +000023
24namespace android::inputdispatcher::trace::impl {
25
26namespace {
27
Prabir Pradhanbb7a0202024-02-10 02:09:01 +000028// Helper to std::visit with lambdas.
29template <typename... V>
30struct Visitor : V... {
31 using V::operator()...;
32};
33
Prabir Pradhan4c49aad2024-02-08 20:42:35 +000034TracedEvent createTracedEvent(const MotionEntry& e, EventType type) {
Prabir Pradhandae52792023-12-15 07:36:40 +000035 return TracedMotionEvent{e.id,
36 e.eventTime,
37 e.policyFlags,
38 e.deviceId,
39 e.source,
40 e.displayId,
41 e.action,
42 e.actionButton,
43 e.flags,
44 e.metaState,
45 e.buttonState,
46 e.classification,
47 e.edgeFlags,
48 e.xPrecision,
49 e.yPrecision,
50 e.xCursorPosition,
51 e.yCursorPosition,
52 e.downTime,
53 e.pointerProperties,
Prabir Pradhan4c49aad2024-02-08 20:42:35 +000054 e.pointerCoords,
55 type};
Prabir Pradhandae52792023-12-15 07:36:40 +000056}
57
Prabir Pradhan4c49aad2024-02-08 20:42:35 +000058TracedEvent createTracedEvent(const KeyEntry& e, EventType type) {
Prabir Pradhandae52792023-12-15 07:36:40 +000059 return TracedKeyEvent{e.id, e.eventTime, e.policyFlags, e.deviceId, e.source,
60 e.displayId, e.action, e.keyCode, e.scanCode, e.metaState,
Prabir Pradhan4c49aad2024-02-08 20:42:35 +000061 e.downTime, e.flags, e.repeatCount, type};
Prabir Pradhandae52792023-12-15 07:36:40 +000062}
63
Prabir Pradhanc7edaaa2024-03-15 15:31:02 +000064void writeEventToBackend(const TracedEvent& event, const TracedEventMetadata metadata,
Prabir Pradhan8c3b1432024-02-09 23:34:16 +000065 InputTracingBackendInterface& backend) {
Prabir Pradhanc7edaaa2024-03-15 15:31:02 +000066 std::visit(Visitor{[&](const TracedMotionEvent& e) { backend.traceMotionEvent(e, metadata); },
67 [&](const TracedKeyEvent& e) { backend.traceKeyEvent(e, metadata); }},
Prabir Pradhana67623c2024-02-21 06:57:36 +000068 event);
69}
70
Prabir Pradhand6b2b052024-02-21 23:25:15 +000071inline auto getId(const trace::TracedEvent& v) {
72 return std::visit([](const auto& event) { return event.id; }, v);
73}
74
Prabir Pradhanbf3c8322024-02-23 02:38:36 +000075// Helper class to extract relevant information from InputTarget.
76struct InputTargetInfo {
77 gui::Uid uid;
78 bool isSecureWindow;
79};
80
81InputTargetInfo getTargetInfo(const InputTarget& target) {
82 if (target.windowHandle == nullptr) {
83 if (!target.connection->monitor) {
84 LOG(FATAL) << __func__ << ": Window is not set for non-monitor target";
85 }
86 // This is a global monitor, assume its target is the system.
87 return {.uid = gui::Uid{AID_SYSTEM}, .isSecureWindow = false};
88 }
89 return {target.windowHandle->getInfo()->ownerUid,
90 target.windowHandle->getInfo()->layoutParamsFlags.test(gui::WindowInfo::Flag::SECURE)};
91}
92
Prabir Pradhandae52792023-12-15 07:36:40 +000093} // namespace
94
95// --- InputTracer ---
96
97InputTracer::InputTracer(std::unique_ptr<InputTracingBackendInterface> backend)
Prabir Pradhanbb7a0202024-02-10 02:09:01 +000098 : mBackend(std::move(backend)) {}
Prabir Pradhandae52792023-12-15 07:36:40 +000099
100std::unique_ptr<EventTrackerInterface> InputTracer::traceInboundEvent(const EventEntry& entry) {
Prabir Pradhana67623c2024-02-21 06:57:36 +0000101 // This is a newly traced inbound event. Create a new state to track it and its derived events.
102 auto eventState = std::make_shared<EventState>(*this);
Prabir Pradhandae52792023-12-15 07:36:40 +0000103
104 if (entry.type == EventEntry::Type::MOTION) {
105 const auto& motion = static_cast<const MotionEntry&>(entry);
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000106 eventState->events.emplace_back(createTracedEvent(motion, EventType::INBOUND));
Prabir Pradhandae52792023-12-15 07:36:40 +0000107 } else if (entry.type == EventEntry::Type::KEY) {
108 const auto& key = static_cast<const KeyEntry&>(entry);
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000109 eventState->events.emplace_back(createTracedEvent(key, EventType::INBOUND));
Prabir Pradhandae52792023-12-15 07:36:40 +0000110 } else {
111 LOG(FATAL) << "Cannot trace EventEntry of type: " << ftl::enum_string(entry.type);
112 }
113
Prabir Pradhana67623c2024-02-21 06:57:36 +0000114 return std::make_unique<EventTrackerImpl>(std::move(eventState), /*isDerived=*/false);
Prabir Pradhandae52792023-12-15 07:36:40 +0000115}
116
Prabir Pradhand6b2b052024-02-21 23:25:15 +0000117std::unique_ptr<EventTrackerInterface> InputTracer::createTrackerForSyntheticEvent() {
118 // Create a new EventState to track events derived from this tracker.
119 return std::make_unique<EventTrackerImpl>(std::make_shared<EventState>(*this),
120 /*isDerived=*/false);
121}
122
Prabir Pradhandae52792023-12-15 07:36:40 +0000123void InputTracer::dispatchToTargetHint(const EventTrackerInterface& cookie,
124 const InputTarget& target) {
Prabir Pradhan1ea04a32024-02-10 03:02:59 +0000125 auto& eventState = getState(cookie);
Prabir Pradhanbf3c8322024-02-23 02:38:36 +0000126 const InputTargetInfo& targetInfo = getTargetInfo(target);
Prabir Pradhana67623c2024-02-21 06:57:36 +0000127 if (eventState->isEventProcessingComplete) {
Prabir Pradhanbf3c8322024-02-23 02:38:36 +0000128 // Disallow adding new targets after eventProcessingComplete() is called.
129 if (eventState->targets.find(targetInfo.uid) == eventState->targets.end()) {
130 LOG(FATAL) << __func__ << ": Cannot add new target after eventProcessingComplete";
131 }
Prabir Pradhana67623c2024-02-21 06:57:36 +0000132 return;
Prabir Pradhandae52792023-12-15 07:36:40 +0000133 }
Prabir Pradhanb95d4aa2024-03-11 22:48:04 +0000134 if (isDerivedCookie(cookie)) {
Prabir Pradhanbf3c8322024-02-23 02:38:36 +0000135 // Disallow adding new targets from a derived cookie.
136 if (eventState->targets.find(targetInfo.uid) == eventState->targets.end()) {
137 LOG(FATAL) << __func__ << ": Cannot add new target from a derived cookie";
138 }
Prabir Pradhanb95d4aa2024-03-11 22:48:04 +0000139 return;
140 }
Prabir Pradhanbf3c8322024-02-23 02:38:36 +0000141
142 eventState->targets.emplace(targetInfo.uid);
143 eventState->isSecure |= targetInfo.isSecureWindow;
144 // TODO(b/210460522): Set events as sensitive when the IME connection is active.
Prabir Pradhandae52792023-12-15 07:36:40 +0000145}
146
147void InputTracer::eventProcessingComplete(const EventTrackerInterface& cookie) {
Prabir Pradhana67623c2024-02-21 06:57:36 +0000148 if (isDerivedCookie(cookie)) {
149 LOG(FATAL) << "Event processing cannot be set from a derived cookie.";
150 }
Prabir Pradhan1ea04a32024-02-10 03:02:59 +0000151 auto& eventState = getState(cookie);
Prabir Pradhana67623c2024-02-21 06:57:36 +0000152 if (eventState->isEventProcessingComplete) {
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000153 LOG(FATAL) << "Traced event was already logged. "
154 "eventProcessingComplete() was likely called more than once.";
155 }
Prabir Pradhane7701642024-02-22 04:06:53 +0000156 eventState->onEventProcessingComplete();
Prabir Pradhana67623c2024-02-21 06:57:36 +0000157}
158
159std::unique_ptr<EventTrackerInterface> InputTracer::traceDerivedEvent(
160 const EventEntry& entry, const EventTrackerInterface& originalEventCookie) {
161 // This is an event derived from an already-established event. Use the same state to track
162 // this event too.
163 auto eventState = getState(originalEventCookie);
164
165 if (entry.type == EventEntry::Type::MOTION) {
166 const auto& motion = static_cast<const MotionEntry&>(entry);
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000167 eventState->events.emplace_back(createTracedEvent(motion, EventType::SYNTHESIZED));
Prabir Pradhana67623c2024-02-21 06:57:36 +0000168 } else if (entry.type == EventEntry::Type::KEY) {
169 const auto& key = static_cast<const KeyEntry&>(entry);
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000170 eventState->events.emplace_back(createTracedEvent(key, EventType::SYNTHESIZED));
Prabir Pradhana67623c2024-02-21 06:57:36 +0000171 } else {
172 LOG(FATAL) << "Cannot trace EventEntry of type: " << ftl::enum_string(entry.type);
173 }
174
175 if (eventState->isEventProcessingComplete) {
176 // It is possible for a derived event to be dispatched some time after the original event
177 // is dispatched, such as in the case of key fallback events. To account for these cases,
178 // derived events can be traced after the processing is complete for the original event.
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000179 const auto& event = eventState->events.back();
Prabir Pradhanc7edaaa2024-03-15 15:31:02 +0000180 const TracedEventMetadata metadata{.isSecure = eventState->isSecure,
181 .targets = eventState->targets};
182 writeEventToBackend(event, std::move(metadata), *mBackend);
Prabir Pradhana67623c2024-02-21 06:57:36 +0000183 }
184 return std::make_unique<EventTrackerImpl>(std::move(eventState), /*isDerived=*/true);
Prabir Pradhandae52792023-12-15 07:36:40 +0000185}
186
187void InputTracer::traceEventDispatch(const DispatchEntry& dispatchEntry,
Prabir Pradhand6b2b052024-02-21 23:25:15 +0000188 const EventTrackerInterface& cookie) {
189 auto& eventState = getState(cookie);
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000190 const EventEntry& entry = *dispatchEntry.eventEntry;
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000191 const int32_t eventId = entry.id;
Prabir Pradhan560d0d12024-03-07 18:08:27 +0000192 // TODO(b/328618922): Remove resolved key repeats after making repeatCount non-mutable.
193 // The KeyEntry's repeatCount is mutable and can be modified after an event is initially traced,
194 // so we need to find the repeatCount at the time of dispatching to trace it accurately.
195 int32_t resolvedKeyRepeatCount = 0;
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000196 if (entry.type == EventEntry::Type::KEY) {
197 resolvedKeyRepeatCount = static_cast<const KeyEntry&>(entry).repeatCount;
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000198 }
Prabir Pradhanadc59b42023-12-15 05:34:11 +0000199
Prabir Pradhand6b2b052024-02-21 23:25:15 +0000200 auto tracedEventIt =
201 std::find_if(eventState->events.begin(), eventState->events.end(),
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000202 [eventId](const auto& event) { return eventId == getId(event); });
Prabir Pradhand6b2b052024-02-21 23:25:15 +0000203 if (tracedEventIt == eventState->events.end()) {
204 LOG(FATAL)
205 << __func__
206 << ": Failed to find a previously traced event that matches the dispatched event";
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000207 }
Prabir Pradhanadc59b42023-12-15 05:34:11 +0000208
Prabir Pradhanbf3c8322024-02-23 02:38:36 +0000209 if (eventState->targets.count(dispatchEntry.targetUid) == 0) {
210 LOG(FATAL) << __func__ << ": Event is being dispatched to UID that it is not targeting";
211 }
212
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000213 // The vsyncId only has meaning if the event is targeting a window.
214 const int32_t windowId = dispatchEntry.windowId.value_or(0);
215 const int32_t vsyncId = dispatchEntry.windowId.has_value() ? dispatchEntry.vsyncId : 0;
Prabir Pradhanadc59b42023-12-15 05:34:11 +0000216
Prabir Pradhan8c3b1432024-02-09 23:34:16 +0000217 // TODO(b/210460522): Pass HMAC into traceEventDispatch.
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000218 const WindowDispatchArgs windowDispatchArgs{*tracedEventIt,
Prabir Pradhan52ec3ff2024-02-22 03:26:38 +0000219 dispatchEntry.deliveryTime,
220 dispatchEntry.resolvedFlags,
221 dispatchEntry.targetUid,
222 vsyncId,
223 windowId,
224 dispatchEntry.transform,
225 dispatchEntry.rawTransform,
226 /*hmac=*/{},
227 resolvedKeyRepeatCount};
228 if (eventState->isEventProcessingComplete) {
Prabir Pradhanc7edaaa2024-03-15 15:31:02 +0000229 const TracedEventMetadata metadata{.isSecure = eventState->isSecure,
230 .targets = eventState->targets};
231 mBackend->traceWindowDispatch(std::move(windowDispatchArgs), std::move(metadata));
Prabir Pradhan52ec3ff2024-02-22 03:26:38 +0000232 } else {
233 eventState->pendingDispatchArgs.emplace_back(std::move(windowDispatchArgs));
234 }
Prabir Pradhanadc59b42023-12-15 05:34:11 +0000235}
Prabir Pradhandae52792023-12-15 07:36:40 +0000236
Prabir Pradhana67623c2024-02-21 06:57:36 +0000237std::shared_ptr<InputTracer::EventState>& InputTracer::getState(
238 const EventTrackerInterface& cookie) {
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000239 return static_cast<const EventTrackerImpl&>(cookie).mState;
Prabir Pradhandae52792023-12-15 07:36:40 +0000240}
241
Prabir Pradhana67623c2024-02-21 06:57:36 +0000242bool InputTracer::isDerivedCookie(const EventTrackerInterface& cookie) {
243 return static_cast<const EventTrackerImpl&>(cookie).mIsDerived;
244}
Prabir Pradhandae52792023-12-15 07:36:40 +0000245
Prabir Pradhana67623c2024-02-21 06:57:36 +0000246// --- InputTracer::EventState ---
Prabir Pradhandae52792023-12-15 07:36:40 +0000247
Prabir Pradhane7701642024-02-22 04:06:53 +0000248void InputTracer::EventState::onEventProcessingComplete() {
249 // Write all of the events known so far to the trace.
250 for (const auto& event : events) {
Prabir Pradhanc7edaaa2024-03-15 15:31:02 +0000251 const TracedEventMetadata metadata{.isSecure = isSecure, .targets = targets};
252 writeEventToBackend(event, std::move(metadata), *tracer.mBackend);
Prabir Pradhane7701642024-02-22 04:06:53 +0000253 }
Prabir Pradhan52ec3ff2024-02-22 03:26:38 +0000254 // Write all pending dispatch args to the trace.
255 for (const auto& windowDispatchArgs : pendingDispatchArgs) {
Prabir Pradhan4c49aad2024-02-08 20:42:35 +0000256 auto tracedEventIt =
257 std::find_if(events.begin(), events.end(),
258 [id = getId(windowDispatchArgs.eventEntry)](const auto& event) {
259 return id == getId(event);
260 });
261 if (tracedEventIt == events.end()) {
262 LOG(FATAL) << __func__
263 << ": Failed to find a previously traced event that matches the dispatched "
264 "event";
265 }
Prabir Pradhanc7edaaa2024-03-15 15:31:02 +0000266 const TracedEventMetadata metadata{.isSecure = isSecure, .targets = targets};
267 tracer.mBackend->traceWindowDispatch(windowDispatchArgs, std::move(metadata));
Prabir Pradhan52ec3ff2024-02-22 03:26:38 +0000268 }
269 pendingDispatchArgs.clear();
270
Prabir Pradhane7701642024-02-22 04:06:53 +0000271 isEventProcessingComplete = true;
272}
273
Prabir Pradhana67623c2024-02-21 06:57:36 +0000274InputTracer::EventState::~EventState() {
275 if (isEventProcessingComplete) {
Prabir Pradhanbb7a0202024-02-10 02:09:01 +0000276 // This event has already been written to the trace as expected.
277 return;
278 }
Prabir Pradhan1ea04a32024-02-10 03:02:59 +0000279 // The event processing was never marked as complete, so do it now.
Prabir Pradhane7701642024-02-22 04:06:53 +0000280 // We should never end up here in normal operation. However, in tests, it's possible that we
281 // stop and destroy InputDispatcher without waiting for it to finish processing events, at
282 // which point an event (and thus its EventState) may be destroyed before processing finishes.
283 onEventProcessingComplete();
Prabir Pradhandae52792023-12-15 07:36:40 +0000284}
285
286} // namespace android::inputdispatcher::trace::impl