blob: ecef15219285af0c2b8c6f803a0cce602a60ef30 [file] [log] [blame]
Josh Gaoc51726c2018-10-11 16:33:05 -07001/*
2 * Copyright (C) 2018 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 TRACE_TAG USB
18
19#include "sysdeps.h"
20
21#include <errno.h>
Josh Gaoa9b62d52020-02-19 13:50:57 -080022#include <inttypes.h>
Josh Gaoc51726c2018-10-11 16:33:05 -070023#include <stdio.h>
24#include <stdlib.h>
25#include <string.h>
26#include <sys/ioctl.h>
27#include <sys/types.h>
28#include <unistd.h>
29
30#include <linux/usb/functionfs.h>
31#include <sys/eventfd.h>
32
Josh Gao86b33be2019-02-26 17:53:52 -080033#include <algorithm>
Josh Gaoc51726c2018-10-11 16:33:05 -070034#include <array>
35#include <future>
36#include <memory>
37#include <mutex>
38#include <optional>
39#include <vector>
40
41#include <asyncio/AsyncIO.h>
42
43#include <android-base/logging.h>
44#include <android-base/macros.h>
45#include <android-base/properties.h>
46#include <android-base/thread_annotations.h>
47
48#include <adbd/usb.h>
49
50#include "adb_unique_fd.h"
51#include "adb_utils.h"
52#include "sysdeps/chrono.h"
53#include "transport.h"
54#include "types.h"
55
56using android::base::StringPrintf;
57
Josh Gaoc0b831b2019-02-13 15:27:28 -080058// We can't find out whether we have support for AIO on ffs endpoints until we submit a read.
59static std::optional<bool> gFfsAioSupported;
60
Josh Gao08ccc732019-04-16 11:20:04 -070061// Not all USB controllers support operations larger than 16k, so don't go above that.
Josh Gaod0feaf92019-04-24 14:28:25 -070062// Also, each submitted operation does an allocation in the kernel of that size, so we want to
63// minimize our queue depth while still maintaining a deep enough queue to keep the USB stack fed.
64static constexpr size_t kUsbReadQueueDepth = 8;
Josh Gao08ccc732019-04-16 11:20:04 -070065static constexpr size_t kUsbReadSize = 4 * PAGE_SIZE;
Josh Gaoc51726c2018-10-11 16:33:05 -070066
Josh Gaod0feaf92019-04-24 14:28:25 -070067static constexpr size_t kUsbWriteQueueDepth = 8;
Josh Gao08ccc732019-04-16 11:20:04 -070068static constexpr size_t kUsbWriteSize = 4 * PAGE_SIZE;
Josh Gaoc51726c2018-10-11 16:33:05 -070069
Dan Albert782036b2019-06-24 14:35:35 -070070static const char* to_string(enum usb_functionfs_event_type type) {
71 switch (type) {
72 case FUNCTIONFS_BIND:
73 return "FUNCTIONFS_BIND";
74 case FUNCTIONFS_UNBIND:
75 return "FUNCTIONFS_UNBIND";
76 case FUNCTIONFS_ENABLE:
77 return "FUNCTIONFS_ENABLE";
78 case FUNCTIONFS_DISABLE:
79 return "FUNCTIONFS_DISABLE";
80 case FUNCTIONFS_SETUP:
81 return "FUNCTIONFS_SETUP";
82 case FUNCTIONFS_SUSPEND:
83 return "FUNCTIONFS_SUSPEND";
84 case FUNCTIONFS_RESUME:
85 return "FUNCTIONFS_RESUME";
86 }
87}
88
Josh Gaoc51726c2018-10-11 16:33:05 -070089enum class TransferDirection : uint64_t {
90 READ = 0,
91 WRITE = 1,
92};
93
94struct TransferId {
95 TransferDirection direction : 1;
96 uint64_t id : 63;
97
98 TransferId() : TransferId(TransferDirection::READ, 0) {}
99
100 private:
101 TransferId(TransferDirection direction, uint64_t id) : direction(direction), id(id) {}
102
103 public:
104 explicit operator uint64_t() const {
105 uint64_t result;
106 static_assert(sizeof(*this) == sizeof(result));
107 memcpy(&result, this, sizeof(*this));
108 return result;
109 }
110
111 static TransferId read(uint64_t id) { return TransferId(TransferDirection::READ, id); }
112 static TransferId write(uint64_t id) { return TransferId(TransferDirection::WRITE, id); }
113
114 static TransferId from_value(uint64_t value) {
115 TransferId result;
116 memcpy(&result, &value, sizeof(value));
117 return result;
118 }
119};
120
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700121template <class Payload>
Josh Gaoc51726c2018-10-11 16:33:05 -0700122struct IoBlock {
Josh Gaob0195742019-03-18 14:11:28 -0700123 bool pending = false;
Evgenii Stepanov9da358d2019-05-15 18:45:01 -0700124 struct iocb control = {};
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700125 Payload payload;
Josh Gaoc51726c2018-10-11 16:33:05 -0700126
127 TransferId id() const { return TransferId::from_value(control.aio_data); }
128};
129
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700130using IoReadBlock = IoBlock<Block>;
131using IoWriteBlock = IoBlock<std::shared_ptr<Block>>;
132
Josh Gaoc51726c2018-10-11 16:33:05 -0700133struct ScopedAioContext {
134 ScopedAioContext() = default;
135 ~ScopedAioContext() { reset(); }
136
137 ScopedAioContext(ScopedAioContext&& move) { reset(move.release()); }
138 ScopedAioContext(const ScopedAioContext& copy) = delete;
139
140 ScopedAioContext& operator=(ScopedAioContext&& move) {
141 reset(move.release());
142 return *this;
143 }
144 ScopedAioContext& operator=(const ScopedAioContext& copy) = delete;
145
146 static ScopedAioContext Create(size_t max_events) {
147 aio_context_t ctx = 0;
148 if (io_setup(max_events, &ctx) != 0) {
149 PLOG(FATAL) << "failed to create aio_context_t";
150 }
151 ScopedAioContext result;
152 result.reset(ctx);
153 return result;
154 }
155
156 aio_context_t release() {
157 aio_context_t result = context_;
158 context_ = 0;
159 return result;
160 }
161
162 void reset(aio_context_t new_context = 0) {
163 if (context_ != 0) {
164 io_destroy(context_);
165 }
166
167 context_ = new_context;
168 }
169
170 aio_context_t get() { return context_; }
171
172 private:
173 aio_context_t context_ = 0;
174};
175
176struct UsbFfsConnection : public Connection {
Dan Albert782036b2019-06-24 14:35:35 -0700177 UsbFfsConnection(unique_fd control, unique_fd read, unique_fd write,
Josh Gaoc51726c2018-10-11 16:33:05 -0700178 std::promise<void> destruction_notifier)
Josh Gao19dc2962019-03-26 18:47:45 -0700179 : worker_started_(false),
180 stopped_(false),
Josh Gaoc51726c2018-10-11 16:33:05 -0700181 destruction_notifier_(std::move(destruction_notifier)),
Dan Albert782036b2019-06-24 14:35:35 -0700182 control_fd_(std::move(control)),
Josh Gaoc51726c2018-10-11 16:33:05 -0700183 read_fd_(std::move(read)),
184 write_fd_(std::move(write)) {
185 LOG(INFO) << "UsbFfsConnection constructed";
Josh Gaoc0b831b2019-02-13 15:27:28 -0800186 worker_event_fd_.reset(eventfd(0, EFD_CLOEXEC));
187 if (worker_event_fd_ == -1) {
188 PLOG(FATAL) << "failed to create eventfd";
189 }
190
Dan Albert782036b2019-06-24 14:35:35 -0700191 monitor_event_fd_.reset(eventfd(0, EFD_CLOEXEC));
192 if (monitor_event_fd_ == -1) {
193 PLOG(FATAL) << "failed to create eventfd";
194 }
195
Josh Gaoc51726c2018-10-11 16:33:05 -0700196 aio_context_ = ScopedAioContext::Create(kUsbReadQueueDepth + kUsbWriteQueueDepth);
197 }
198
199 ~UsbFfsConnection() {
200 LOG(INFO) << "UsbFfsConnection being destroyed";
201 Stop();
202 monitor_thread_.join();
Josh Gaoc0b831b2019-02-13 15:27:28 -0800203
204 // We need to explicitly close our file descriptors before we notify our destruction,
205 // because the thread listening on the future will immediately try to reopen the endpoint.
Josh Gao19dc2962019-03-26 18:47:45 -0700206 aio_context_.reset();
Dan Albert782036b2019-06-24 14:35:35 -0700207 control_fd_.reset();
Josh Gaoc0b831b2019-02-13 15:27:28 -0800208 read_fd_.reset();
209 write_fd_.reset();
210
Josh Gaoc51726c2018-10-11 16:33:05 -0700211 destruction_notifier_.set_value();
212 }
213
214 virtual bool Write(std::unique_ptr<apacket> packet) override final {
215 LOG(DEBUG) << "USB write: " << dump_header(&packet->msg);
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700216 auto header = std::make_shared<Block>(sizeof(packet->msg));
217 memcpy(header->data(), &packet->msg, sizeof(packet->msg));
Josh Gaoc51726c2018-10-11 16:33:05 -0700218
219 std::lock_guard<std::mutex> lock(write_mutex_);
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700220 write_requests_.push_back(
221 CreateWriteBlock(std::move(header), 0, sizeof(packet->msg), next_write_id_++));
Josh Gaoc51726c2018-10-11 16:33:05 -0700222 if (!packet->payload.empty()) {
Josh Gao86b33be2019-02-26 17:53:52 -0800223 // The kernel attempts to allocate a contiguous block of memory for each write,
224 // which can fail if the write is large and the kernel heap is fragmented.
225 // Split large writes into smaller chunks to avoid this.
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700226 auto payload = std::make_shared<Block>(std::move(packet->payload));
Josh Gao86b33be2019-02-26 17:53:52 -0800227 size_t offset = 0;
228 size_t len = payload->size();
229
230 while (len > 0) {
231 size_t write_size = std::min(kUsbWriteSize, len);
232 write_requests_.push_back(
233 CreateWriteBlock(payload, offset, write_size, next_write_id_++));
234 len -= write_size;
235 offset += write_size;
236 }
Josh Gaoc51726c2018-10-11 16:33:05 -0700237 }
238 SubmitWrites();
239 return true;
240 }
241
242 virtual void Start() override final { StartMonitor(); }
243
244 virtual void Stop() override final {
245 if (stopped_.exchange(true)) {
246 return;
247 }
248 stopped_ = true;
249 uint64_t notify = 1;
Josh Gaoc0b831b2019-02-13 15:27:28 -0800250 ssize_t rc = adb_write(worker_event_fd_.get(), &notify, sizeof(notify));
Josh Gaoc51726c2018-10-11 16:33:05 -0700251 if (rc < 0) {
Josh Gaoc0b831b2019-02-13 15:27:28 -0800252 PLOG(FATAL) << "failed to notify worker eventfd to stop UsbFfsConnection";
Josh Gaoc51726c2018-10-11 16:33:05 -0700253 }
254 CHECK_EQ(static_cast<size_t>(rc), sizeof(notify));
Dan Albert782036b2019-06-24 14:35:35 -0700255
256 rc = adb_write(monitor_event_fd_.get(), &notify, sizeof(notify));
257 if (rc < 0) {
258 PLOG(FATAL) << "failed to notify monitor eventfd to stop UsbFfsConnection";
259 }
260
261 CHECK_EQ(static_cast<size_t>(rc), sizeof(notify));
Josh Gaoc51726c2018-10-11 16:33:05 -0700262 }
263
264 private:
265 void StartMonitor() {
266 // This is a bit of a mess.
267 // It's possible for io_submit to end up blocking, if we call it as the endpoint
268 // becomes disabled. Work around this by having a monitor thread to listen for functionfs
269 // lifecycle events. If we notice an error condition (either we've become disabled, or we
270 // were never enabled in the first place), we send interruption signals to the worker thread
271 // until it dies, and then report failure to the transport via HandleError, which will
272 // eventually result in the transport being destroyed, which will result in UsbFfsConnection
273 // being destroyed, which unblocks the open thread and restarts this entire process.
Josh Gaoc51726c2018-10-11 16:33:05 -0700274 static std::once_flag handler_once;
275 std::call_once(handler_once, []() { signal(kInterruptionSignal, [](int) {}); });
276
277 monitor_thread_ = std::thread([this]() {
278 adb_thread_setname("UsbFfs-monitor");
279
Dan Albert782036b2019-06-24 14:35:35 -0700280 bool bound = false;
Josh Gao6933d542019-03-26 13:21:42 -0700281 bool enabled = false;
Josh Gaoc51726c2018-10-11 16:33:05 -0700282 bool running = true;
283 while (running) {
Josh Gaoc0b831b2019-02-13 15:27:28 -0800284 adb_pollfd pfd[2] = {
Dan Albert782036b2019-06-24 14:35:35 -0700285 { .fd = control_fd_.get(), .events = POLLIN, .revents = 0 },
286 { .fd = monitor_event_fd_.get(), .events = POLLIN, .revents = 0 },
Josh Gaoc0b831b2019-02-13 15:27:28 -0800287 };
Josh Gao19dc2962019-03-26 18:47:45 -0700288
Dan Albert782036b2019-06-24 14:35:35 -0700289 // If we don't see our first bind within a second, try again.
290 int timeout_ms = bound ? -1 : 1000;
291
292 int rc = TEMP_FAILURE_RETRY(adb_poll(pfd, 2, timeout_ms));
Josh Gaoc0b831b2019-02-13 15:27:28 -0800293 if (rc == -1) {
294 PLOG(FATAL) << "poll on USB control fd failed";
Dan Albert782036b2019-06-24 14:35:35 -0700295 } else if (rc == 0) {
296 LOG(WARNING) << "timed out while waiting for FUNCTIONFS_BIND, trying again";
297 break;
Josh Gaoc0b831b2019-02-13 15:27:28 -0800298 }
299
300 if (pfd[1].revents) {
Dan Albert782036b2019-06-24 14:35:35 -0700301 // We were told to die.
302 break;
Josh Gaoc51726c2018-10-11 16:33:05 -0700303 }
304
305 struct usb_functionfs_event event;
Dan Albert782036b2019-06-24 14:35:35 -0700306 rc = TEMP_FAILURE_RETRY(adb_read(control_fd_.get(), &event, sizeof(event)));
Josh Gao1f7ae9d2019-05-10 11:37:34 -0700307 if (rc == -1) {
Josh Gaoc51726c2018-10-11 16:33:05 -0700308 PLOG(FATAL) << "failed to read functionfs event";
Josh Gao1f7ae9d2019-05-10 11:37:34 -0700309 } else if (rc == 0) {
310 LOG(WARNING) << "hit EOF on functionfs control fd";
311 break;
312 } else if (rc != sizeof(event)) {
313 LOG(FATAL) << "read functionfs event of unexpected size, expected "
314 << sizeof(event) << ", got " << rc;
Josh Gaoc51726c2018-10-11 16:33:05 -0700315 }
316
317 LOG(INFO) << "USB event: "
Dan Albert782036b2019-06-24 14:35:35 -0700318 << to_string(static_cast<usb_functionfs_event_type>(event.type));
Josh Gaoc51726c2018-10-11 16:33:05 -0700319
320 switch (event.type) {
321 case FUNCTIONFS_BIND:
Dan Albert782036b2019-06-24 14:35:35 -0700322 if (bound) {
323 LOG(WARNING) << "received FUNCTIONFS_BIND while already bound?";
324 running = false;
325 break;
326 }
327
328 if (enabled) {
329 LOG(WARNING) << "received FUNCTIONFS_BIND while already enabled?";
330 running = false;
331 break;
332 }
333
334 bound = true;
Josh Gaoc51726c2018-10-11 16:33:05 -0700335 break;
336
337 case FUNCTIONFS_ENABLE:
Dan Albert782036b2019-06-24 14:35:35 -0700338 if (!bound) {
339 LOG(WARNING) << "received FUNCTIONFS_ENABLE while not bound?";
340 running = false;
341 break;
342 }
343
Josh Gao87afd522019-03-28 11:05:53 -0700344 if (enabled) {
345 LOG(WARNING) << "received FUNCTIONFS_ENABLE while already enabled?";
346 running = false;
Josh Gao94fb36b2019-05-01 16:53:53 -0700347 break;
Josh Gao87afd522019-03-28 11:05:53 -0700348 }
349
350 enabled = true;
Josh Gaoc51726c2018-10-11 16:33:05 -0700351 StartWorker();
352 break;
353
354 case FUNCTIONFS_DISABLE:
Dan Albert782036b2019-06-24 14:35:35 -0700355 if (!bound) {
356 LOG(WARNING) << "received FUNCTIONFS_DISABLE while not bound?";
357 }
358
Josh Gao87afd522019-03-28 11:05:53 -0700359 if (!enabled) {
360 LOG(WARNING) << "received FUNCTIONFS_DISABLE while not enabled?";
361 }
362
363 enabled = false;
Josh Gao6933d542019-03-26 13:21:42 -0700364 running = false;
365 break;
366
367 case FUNCTIONFS_UNBIND:
Josh Gao87afd522019-03-28 11:05:53 -0700368 if (enabled) {
369 LOG(WARNING) << "received FUNCTIONFS_UNBIND while still enabled?";
370 }
Josh Gao6933d542019-03-26 13:21:42 -0700371
Dan Albert782036b2019-06-24 14:35:35 -0700372 if (!bound) {
373 LOG(WARNING) << "received FUNCTIONFS_UNBIND when not bound?";
374 }
375
376 bound = false;
Josh Gaoc51726c2018-10-11 16:33:05 -0700377 running = false;
378 break;
Josh Gao12807c72019-05-15 18:03:29 -0700379
380 case FUNCTIONFS_SETUP: {
Dan Albert782036b2019-06-24 14:35:35 -0700381 LOG(INFO) << "received FUNCTIONFS_SETUP control transfer: bRequestType = "
382 << static_cast<int>(event.u.setup.bRequestType)
383 << ", bRequest = " << static_cast<int>(event.u.setup.bRequest)
384 << ", wValue = " << static_cast<int>(event.u.setup.wValue)
385 << ", wIndex = " << static_cast<int>(event.u.setup.wIndex)
386 << ", wLength = " << static_cast<int>(event.u.setup.wLength);
387
388 if ((event.u.setup.bRequestType & USB_DIR_IN)) {
389 LOG(INFO) << "acking device-to-host control transfer";
390 ssize_t rc = adb_write(control_fd_.get(), "", 0);
391 if (rc != 0) {
392 PLOG(ERROR) << "failed to write empty packet to host";
393 break;
394 }
395 } else {
396 std::string buf;
397 buf.resize(event.u.setup.wLength + 1);
398
399 ssize_t rc = adb_read(control_fd_.get(), buf.data(), buf.size());
400 if (rc != event.u.setup.wLength) {
401 LOG(ERROR)
402 << "read " << rc
403 << " bytes when trying to read control request, expected "
404 << event.u.setup.wLength;
405 }
406
407 LOG(INFO) << "control request contents: " << buf;
408 break;
409 }
Josh Gao12807c72019-05-15 18:03:29 -0700410 }
Josh Gaoc51726c2018-10-11 16:33:05 -0700411 }
412 }
413
Josh Gaoe778b3a2019-02-28 13:29:32 -0800414 StopWorker();
Josh Gao19dc2962019-03-26 18:47:45 -0700415 HandleError("monitor thread finished");
Josh Gaoc51726c2018-10-11 16:33:05 -0700416 });
417 }
418
419 void StartWorker() {
Josh Gao19dc2962019-03-26 18:47:45 -0700420 CHECK(!worker_started_);
421 worker_started_ = true;
Josh Gaoc51726c2018-10-11 16:33:05 -0700422 worker_thread_ = std::thread([this]() {
423 adb_thread_setname("UsbFfs-worker");
424 for (size_t i = 0; i < kUsbReadQueueDepth; ++i) {
425 read_requests_[i] = CreateReadBlock(next_read_id_++);
Josh Gaoc0b831b2019-02-13 15:27:28 -0800426 if (!SubmitRead(&read_requests_[i])) {
427 return;
428 }
Josh Gaoc51726c2018-10-11 16:33:05 -0700429 }
430
431 while (!stopped_) {
432 uint64_t dummy;
Josh Gaoc0b831b2019-02-13 15:27:28 -0800433 ssize_t rc = adb_read(worker_event_fd_.get(), &dummy, sizeof(dummy));
Josh Gaoc51726c2018-10-11 16:33:05 -0700434 if (rc == -1) {
435 PLOG(FATAL) << "failed to read from eventfd";
436 } else if (rc == 0) {
437 LOG(FATAL) << "hit EOF on eventfd";
438 }
439
Josh Gao6933d542019-03-26 13:21:42 -0700440 ReadEvents();
Josh Gaoc51726c2018-10-11 16:33:05 -0700441 }
442 });
443 }
444
Josh Gaoe778b3a2019-02-28 13:29:32 -0800445 void StopWorker() {
Josh Gao19dc2962019-03-26 18:47:45 -0700446 if (!worker_started_) {
447 return;
448 }
449
Josh Gaoe778b3a2019-02-28 13:29:32 -0800450 pthread_t worker_thread_handle = worker_thread_.native_handle();
451 while (true) {
452 int rc = pthread_kill(worker_thread_handle, kInterruptionSignal);
453 if (rc != 0) {
454 LOG(ERROR) << "failed to send interruption signal to worker: " << strerror(rc);
455 break;
456 }
457
458 std::this_thread::sleep_for(100ms);
459
460 rc = pthread_kill(worker_thread_handle, 0);
461 if (rc == 0) {
462 continue;
463 } else if (rc == ESRCH) {
464 break;
465 } else {
466 LOG(ERROR) << "failed to send interruption signal to worker: " << strerror(rc);
467 }
468 }
469
470 worker_thread_.join();
471 }
472
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700473 void PrepareReadBlock(IoReadBlock* block, uint64_t id) {
Josh Gaoc51726c2018-10-11 16:33:05 -0700474 block->pending = false;
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700475 if (block->payload.capacity() >= kUsbReadSize) {
476 block->payload.resize(kUsbReadSize);
477 } else {
478 block->payload = Block(kUsbReadSize);
479 }
Josh Gaoc51726c2018-10-11 16:33:05 -0700480 block->control.aio_data = static_cast<uint64_t>(TransferId::read(id));
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700481 block->control.aio_buf = reinterpret_cast<uintptr_t>(block->payload.data());
482 block->control.aio_nbytes = block->payload.size();
Josh Gaoc51726c2018-10-11 16:33:05 -0700483 }
484
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700485 IoReadBlock CreateReadBlock(uint64_t id) {
486 IoReadBlock block;
Josh Gaoc51726c2018-10-11 16:33:05 -0700487 PrepareReadBlock(&block, id);
488 block.control.aio_rw_flags = 0;
489 block.control.aio_lio_opcode = IOCB_CMD_PREAD;
490 block.control.aio_reqprio = 0;
491 block.control.aio_fildes = read_fd_.get();
492 block.control.aio_offset = 0;
493 block.control.aio_flags = IOCB_FLAG_RESFD;
Josh Gaoc0b831b2019-02-13 15:27:28 -0800494 block.control.aio_resfd = worker_event_fd_.get();
Josh Gaoc51726c2018-10-11 16:33:05 -0700495 return block;
496 }
497
Josh Gao6933d542019-03-26 13:21:42 -0700498 void ReadEvents() {
Josh Gaoc51726c2018-10-11 16:33:05 -0700499 static constexpr size_t kMaxEvents = kUsbReadQueueDepth + kUsbWriteQueueDepth;
500 struct io_event events[kMaxEvents];
501 struct timespec timeout = {.tv_sec = 0, .tv_nsec = 0};
502 int rc = io_getevents(aio_context_.get(), 0, kMaxEvents, events, &timeout);
503 if (rc == -1) {
504 HandleError(StringPrintf("io_getevents failed while reading: %s", strerror(errno)));
505 return;
506 }
507
508 for (int event_idx = 0; event_idx < rc; ++event_idx) {
509 auto& event = events[event_idx];
510 TransferId id = TransferId::from_value(event.data);
511
512 if (event.res < 0) {
513 std::string error =
514 StringPrintf("%s %" PRIu64 " failed with error %s",
515 id.direction == TransferDirection::READ ? "read" : "write",
516 id.id, strerror(-event.res));
517 HandleError(error);
518 return;
519 }
520
521 if (id.direction == TransferDirection::READ) {
Dan Albert2547f742019-06-24 14:35:52 -0700522 HandleRead(id, event.res);
Josh Gaoc51726c2018-10-11 16:33:05 -0700523 } else {
524 HandleWrite(id);
525 }
526 }
527 }
528
Dan Albert2547f742019-06-24 14:35:52 -0700529 void HandleRead(TransferId id, int64_t size) {
Josh Gaoc51726c2018-10-11 16:33:05 -0700530 uint64_t read_idx = id.id % kUsbReadQueueDepth;
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700531 IoReadBlock* block = &read_requests_[read_idx];
Josh Gaoc51726c2018-10-11 16:33:05 -0700532 block->pending = false;
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700533 block->payload.resize(size);
Josh Gaoc51726c2018-10-11 16:33:05 -0700534
535 // Notification for completed reads can be received out of order.
536 if (block->id().id != needed_read_id_) {
537 LOG(VERBOSE) << "read " << block->id().id << " completed while waiting for "
538 << needed_read_id_;
Dan Albert2547f742019-06-24 14:35:52 -0700539 return;
Josh Gaoc51726c2018-10-11 16:33:05 -0700540 }
541
542 for (uint64_t id = needed_read_id_;; ++id) {
543 size_t read_idx = id % kUsbReadQueueDepth;
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700544 IoReadBlock* current_block = &read_requests_[read_idx];
Josh Gaoc51726c2018-10-11 16:33:05 -0700545 if (current_block->pending) {
546 break;
547 }
Dan Albert2547f742019-06-24 14:35:52 -0700548 ProcessRead(current_block);
Josh Gaoc51726c2018-10-11 16:33:05 -0700549 ++needed_read_id_;
550 }
551 }
552
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700553 void ProcessRead(IoReadBlock* block) {
554 if (!block->payload.empty()) {
Josh Gaoc51726c2018-10-11 16:33:05 -0700555 if (!incoming_header_.has_value()) {
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700556 CHECK_EQ(sizeof(amessage), block->payload.size());
557 amessage& msg = incoming_header_.emplace();
558 memcpy(&msg, block->payload.data(), sizeof(msg));
Josh Gaoc51726c2018-10-11 16:33:05 -0700559 LOG(DEBUG) << "USB read:" << dump_header(&msg);
560 incoming_header_ = msg;
561 } else {
562 size_t bytes_left = incoming_header_->data_length - incoming_payload_.size();
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700563 Block payload = std::move(block->payload);
Dan Albert2547f742019-06-24 14:35:52 -0700564 CHECK_LE(payload.size(), bytes_left);
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700565 incoming_payload_.append(std::move(payload));
Josh Gaoc51726c2018-10-11 16:33:05 -0700566 }
567
568 if (incoming_header_->data_length == incoming_payload_.size()) {
569 auto packet = std::make_unique<apacket>();
570 packet->msg = *incoming_header_;
571
572 // TODO: Make apacket contain an IOVector so we don't have to coalesce.
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700573 packet->payload = std::move(incoming_payload_).coalesce();
Josh Gaoc51726c2018-10-11 16:33:05 -0700574 read_callback_(this, std::move(packet));
575
576 incoming_header_.reset();
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700577 // reuse the capacity of the incoming payload while we can.
578 auto free_block = incoming_payload_.clear();
579 if (block->payload.capacity() == 0) {
580 block->payload = std::move(free_block);
581 }
Josh Gaoc51726c2018-10-11 16:33:05 -0700582 }
583 }
584
585 PrepareReadBlock(block, block->id().id + kUsbReadQueueDepth);
586 SubmitRead(block);
587 }
588
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700589 bool SubmitRead(IoReadBlock* block) {
Josh Gaoc51726c2018-10-11 16:33:05 -0700590 block->pending = true;
591 struct iocb* iocb = &block->control;
592 if (io_submit(aio_context_.get(), 1, &iocb) != 1) {
Josh Gaoc0b831b2019-02-13 15:27:28 -0800593 if (errno == EINVAL && !gFfsAioSupported.has_value()) {
594 HandleError("failed to submit first read, AIO on FFS not supported");
595 gFfsAioSupported = false;
596 return false;
597 }
598
Josh Gaoc51726c2018-10-11 16:33:05 -0700599 HandleError(StringPrintf("failed to submit read: %s", strerror(errno)));
Josh Gaoc0b831b2019-02-13 15:27:28 -0800600 return false;
Josh Gaoc51726c2018-10-11 16:33:05 -0700601 }
Josh Gaoc0b831b2019-02-13 15:27:28 -0800602
603 gFfsAioSupported = true;
604 return true;
Josh Gaoc51726c2018-10-11 16:33:05 -0700605 }
606
607 void HandleWrite(TransferId id) {
608 std::lock_guard<std::mutex> lock(write_mutex_);
609 auto it =
610 std::find_if(write_requests_.begin(), write_requests_.end(), [id](const auto& req) {
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700611 return static_cast<uint64_t>(req.id()) == static_cast<uint64_t>(id);
Josh Gaoc51726c2018-10-11 16:33:05 -0700612 });
613 CHECK(it != write_requests_.end());
614
615 write_requests_.erase(it);
616 size_t outstanding_writes = --writes_submitted_;
617 LOG(DEBUG) << "USB write: reaped, down to " << outstanding_writes;
618
619 SubmitWrites();
620 }
621
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700622 IoWriteBlock CreateWriteBlock(std::shared_ptr<Block> payload, size_t offset, size_t len,
623 uint64_t id) {
624 auto block = IoWriteBlock();
625 block.payload = std::move(payload);
626 block.control.aio_data = static_cast<uint64_t>(TransferId::write(id));
627 block.control.aio_rw_flags = 0;
628 block.control.aio_lio_opcode = IOCB_CMD_PWRITE;
629 block.control.aio_reqprio = 0;
630 block.control.aio_fildes = write_fd_.get();
631 block.control.aio_buf = reinterpret_cast<uintptr_t>(block.payload->data() + offset);
632 block.control.aio_nbytes = len;
633 block.control.aio_offset = 0;
634 block.control.aio_flags = IOCB_FLAG_RESFD;
635 block.control.aio_resfd = worker_event_fd_.get();
Josh Gaoc51726c2018-10-11 16:33:05 -0700636 return block;
637 }
638
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700639 IoWriteBlock CreateWriteBlock(Block&& payload, uint64_t id) {
640 size_t len = payload.size();
641 return CreateWriteBlock(std::make_shared<Block>(std::move(payload)), 0, len, id);
Josh Gao86b33be2019-02-26 17:53:52 -0800642 }
643
Josh Gaoc51726c2018-10-11 16:33:05 -0700644 void SubmitWrites() REQUIRES(write_mutex_) {
645 if (writes_submitted_ == kUsbWriteQueueDepth) {
646 return;
647 }
648
649 ssize_t writes_to_submit = std::min(kUsbWriteQueueDepth - writes_submitted_,
650 write_requests_.size() - writes_submitted_);
651 CHECK_GE(writes_to_submit, 0);
652 if (writes_to_submit == 0) {
653 return;
654 }
655
656 struct iocb* iocbs[kUsbWriteQueueDepth];
657 for (int i = 0; i < writes_to_submit; ++i) {
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700658 CHECK(!write_requests_[writes_submitted_ + i].pending);
659 write_requests_[writes_submitted_ + i].pending = true;
660 iocbs[i] = &write_requests_[writes_submitted_ + i].control;
Josh Gaoc51726c2018-10-11 16:33:05 -0700661 LOG(VERBOSE) << "submitting write_request " << static_cast<void*>(iocbs[i]);
662 }
663
Josh Gao63b52ec2019-03-26 13:06:38 -0700664 writes_submitted_ += writes_to_submit;
665
Josh Gaoc51726c2018-10-11 16:33:05 -0700666 int rc = io_submit(aio_context_.get(), writes_to_submit, iocbs);
667 if (rc == -1) {
668 HandleError(StringPrintf("failed to submit write requests: %s", strerror(errno)));
669 return;
670 } else if (rc != writes_to_submit) {
671 LOG(FATAL) << "failed to submit all writes: wanted to submit " << writes_to_submit
672 << ", actually submitted " << rc;
673 }
Josh Gaoc51726c2018-10-11 16:33:05 -0700674 }
675
676 void HandleError(const std::string& error) {
677 std::call_once(error_flag_, [&]() {
678 error_callback_(this, error);
679 if (!stopped_) {
680 Stop();
681 }
682 });
683 }
684
685 std::thread monitor_thread_;
Josh Gao19dc2962019-03-26 18:47:45 -0700686
687 bool worker_started_;
Josh Gaoc51726c2018-10-11 16:33:05 -0700688 std::thread worker_thread_;
689
690 std::atomic<bool> stopped_;
691 std::promise<void> destruction_notifier_;
692 std::once_flag error_flag_;
693
Josh Gaoc0b831b2019-02-13 15:27:28 -0800694 unique_fd worker_event_fd_;
Dan Albert782036b2019-06-24 14:35:35 -0700695 unique_fd monitor_event_fd_;
Josh Gaoc51726c2018-10-11 16:33:05 -0700696
697 ScopedAioContext aio_context_;
Dan Albert782036b2019-06-24 14:35:35 -0700698 unique_fd control_fd_;
Josh Gaoc51726c2018-10-11 16:33:05 -0700699 unique_fd read_fd_;
700 unique_fd write_fd_;
701
702 std::optional<amessage> incoming_header_;
703 IOVector incoming_payload_;
704
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700705 std::array<IoReadBlock, kUsbReadQueueDepth> read_requests_;
Josh Gaoc51726c2018-10-11 16:33:05 -0700706 IOVector read_data_;
707
708 // ID of the next request that we're going to send out.
709 size_t next_read_id_ = 0;
710
711 // ID of the next packet we're waiting for.
712 size_t needed_read_id_ = 0;
713
714 std::mutex write_mutex_;
Yurii Zubrytskyi5dda7f62019-07-12 14:11:54 -0700715 std::deque<IoWriteBlock> write_requests_ GUARDED_BY(write_mutex_);
Josh Gaoc51726c2018-10-11 16:33:05 -0700716 size_t next_write_id_ GUARDED_BY(write_mutex_) = 0;
717 size_t writes_submitted_ GUARDED_BY(write_mutex_) = 0;
Josh Gaoe778b3a2019-02-28 13:29:32 -0800718
719 static constexpr int kInterruptionSignal = SIGUSR1;
Josh Gaoc51726c2018-10-11 16:33:05 -0700720};
721
Josh Gaoc0b831b2019-02-13 15:27:28 -0800722void usb_init_legacy();
723
Josh Gaoc51726c2018-10-11 16:33:05 -0700724static void usb_ffs_open_thread() {
725 adb_thread_setname("usb ffs open");
726
727 while (true) {
Josh Gaoc0b831b2019-02-13 15:27:28 -0800728 if (gFfsAioSupported.has_value() && !gFfsAioSupported.value()) {
729 LOG(INFO) << "failed to use nonblocking ffs, falling back to legacy";
730 return usb_init_legacy();
731 }
732
Dan Albert782036b2019-06-24 14:35:35 -0700733 unique_fd control;
734 unique_fd bulk_out;
735 unique_fd bulk_in;
Josh Gaoc51726c2018-10-11 16:33:05 -0700736 if (!open_functionfs(&control, &bulk_out, &bulk_in)) {
737 std::this_thread::sleep_for(1s);
738 continue;
739 }
740
741 atransport* transport = new atransport();
742 transport->serial = "UsbFfs";
743 std::promise<void> destruction_notifier;
744 std::future<void> future = destruction_notifier.get_future();
745 transport->SetConnection(std::make_unique<UsbFfsConnection>(
Dan Albert782036b2019-06-24 14:35:35 -0700746 std::move(control), std::move(bulk_out), std::move(bulk_in),
Josh Gaoc51726c2018-10-11 16:33:05 -0700747 std::move(destruction_notifier)));
748 register_transport(transport);
749 future.wait();
750 }
751}
752
Josh Gaoc51726c2018-10-11 16:33:05 -0700753void usb_init() {
Josh Gao8038e352019-03-18 16:33:18 -0700754 bool use_nonblocking = android::base::GetBoolProperty(
755 "persist.adb.nonblocking_ffs",
756 android::base::GetBoolProperty("ro.adb.nonblocking_ffs", true));
757
Josh Gao02e94a42019-02-28 07:26:20 +0000758 if (use_nonblocking) {
Josh Gao0d780392019-02-26 22:10:33 +0000759 std::thread(usb_ffs_open_thread).detach();
Josh Gao02e94a42019-02-28 07:26:20 +0000760 } else {
761 usb_init_legacy();
Josh Gaoc51726c2018-10-11 16:33:05 -0700762 }
763}