Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 1 | /* |
| 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> |
| 22 | #include <stdio.h> |
| 23 | #include <stdlib.h> |
| 24 | #include <string.h> |
| 25 | #include <sys/ioctl.h> |
| 26 | #include <sys/types.h> |
| 27 | #include <unistd.h> |
| 28 | |
| 29 | #include <linux/usb/functionfs.h> |
| 30 | #include <sys/eventfd.h> |
| 31 | |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 32 | #include <algorithm> |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 33 | #include <array> |
| 34 | #include <future> |
| 35 | #include <memory> |
| 36 | #include <mutex> |
| 37 | #include <optional> |
| 38 | #include <vector> |
| 39 | |
| 40 | #include <asyncio/AsyncIO.h> |
| 41 | |
| 42 | #include <android-base/logging.h> |
| 43 | #include <android-base/macros.h> |
| 44 | #include <android-base/properties.h> |
| 45 | #include <android-base/thread_annotations.h> |
| 46 | |
| 47 | #include <adbd/usb.h> |
| 48 | |
| 49 | #include "adb_unique_fd.h" |
| 50 | #include "adb_utils.h" |
| 51 | #include "sysdeps/chrono.h" |
| 52 | #include "transport.h" |
| 53 | #include "types.h" |
| 54 | |
| 55 | using android::base::StringPrintf; |
| 56 | |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 57 | // We can't find out whether we have support for AIO on ffs endpoints until we submit a read. |
| 58 | static std::optional<bool> gFfsAioSupported; |
| 59 | |
Josh Gao | 641c708 | 2019-04-16 11:20:04 -0700 | [diff] [blame] | 60 | // Not all USB controllers support operations larger than 16k, so don't go above that. |
Josh Gao | e6d7361 | 2019-02-28 15:44:05 -0800 | [diff] [blame] | 61 | static constexpr size_t kUsbReadQueueDepth = 32; |
Josh Gao | 641c708 | 2019-04-16 11:20:04 -0700 | [diff] [blame] | 62 | static constexpr size_t kUsbReadSize = 4 * PAGE_SIZE; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 63 | |
Josh Gao | e6d7361 | 2019-02-28 15:44:05 -0800 | [diff] [blame] | 64 | static constexpr size_t kUsbWriteQueueDepth = 32; |
Josh Gao | 641c708 | 2019-04-16 11:20:04 -0700 | [diff] [blame] | 65 | static constexpr size_t kUsbWriteSize = 4 * PAGE_SIZE; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 66 | |
| 67 | static const char* to_string(enum usb_functionfs_event_type type) { |
| 68 | switch (type) { |
| 69 | case FUNCTIONFS_BIND: |
| 70 | return "FUNCTIONFS_BIND"; |
| 71 | case FUNCTIONFS_UNBIND: |
| 72 | return "FUNCTIONFS_UNBIND"; |
| 73 | case FUNCTIONFS_ENABLE: |
| 74 | return "FUNCTIONFS_ENABLE"; |
| 75 | case FUNCTIONFS_DISABLE: |
| 76 | return "FUNCTIONFS_DISABLE"; |
| 77 | case FUNCTIONFS_SETUP: |
| 78 | return "FUNCTIONFS_SETUP"; |
| 79 | case FUNCTIONFS_SUSPEND: |
| 80 | return "FUNCTIONFS_SUSPEND"; |
| 81 | case FUNCTIONFS_RESUME: |
| 82 | return "FUNCTIONFS_RESUME"; |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | enum class TransferDirection : uint64_t { |
| 87 | READ = 0, |
| 88 | WRITE = 1, |
| 89 | }; |
| 90 | |
| 91 | struct TransferId { |
| 92 | TransferDirection direction : 1; |
| 93 | uint64_t id : 63; |
| 94 | |
| 95 | TransferId() : TransferId(TransferDirection::READ, 0) {} |
| 96 | |
| 97 | private: |
| 98 | TransferId(TransferDirection direction, uint64_t id) : direction(direction), id(id) {} |
| 99 | |
| 100 | public: |
| 101 | explicit operator uint64_t() const { |
| 102 | uint64_t result; |
| 103 | static_assert(sizeof(*this) == sizeof(result)); |
| 104 | memcpy(&result, this, sizeof(*this)); |
| 105 | return result; |
| 106 | } |
| 107 | |
| 108 | static TransferId read(uint64_t id) { return TransferId(TransferDirection::READ, id); } |
| 109 | static TransferId write(uint64_t id) { return TransferId(TransferDirection::WRITE, id); } |
| 110 | |
| 111 | static TransferId from_value(uint64_t value) { |
| 112 | TransferId result; |
| 113 | memcpy(&result, &value, sizeof(value)); |
| 114 | return result; |
| 115 | } |
| 116 | }; |
| 117 | |
| 118 | struct IoBlock { |
Josh Gao | 9f60846 | 2019-03-18 14:11:28 -0700 | [diff] [blame] | 119 | bool pending = false; |
Evgenii Stepanov | 6e03b68 | 2019-05-15 18:45:01 -0700 | [diff] [blame] | 120 | struct iocb control = {}; |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 121 | std::shared_ptr<Block> payload; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 122 | |
| 123 | TransferId id() const { return TransferId::from_value(control.aio_data); } |
| 124 | }; |
| 125 | |
| 126 | struct ScopedAioContext { |
| 127 | ScopedAioContext() = default; |
| 128 | ~ScopedAioContext() { reset(); } |
| 129 | |
| 130 | ScopedAioContext(ScopedAioContext&& move) { reset(move.release()); } |
| 131 | ScopedAioContext(const ScopedAioContext& copy) = delete; |
| 132 | |
| 133 | ScopedAioContext& operator=(ScopedAioContext&& move) { |
| 134 | reset(move.release()); |
| 135 | return *this; |
| 136 | } |
| 137 | ScopedAioContext& operator=(const ScopedAioContext& copy) = delete; |
| 138 | |
| 139 | static ScopedAioContext Create(size_t max_events) { |
| 140 | aio_context_t ctx = 0; |
| 141 | if (io_setup(max_events, &ctx) != 0) { |
| 142 | PLOG(FATAL) << "failed to create aio_context_t"; |
| 143 | } |
| 144 | ScopedAioContext result; |
| 145 | result.reset(ctx); |
| 146 | return result; |
| 147 | } |
| 148 | |
| 149 | aio_context_t release() { |
| 150 | aio_context_t result = context_; |
| 151 | context_ = 0; |
| 152 | return result; |
| 153 | } |
| 154 | |
| 155 | void reset(aio_context_t new_context = 0) { |
| 156 | if (context_ != 0) { |
| 157 | io_destroy(context_); |
| 158 | } |
| 159 | |
| 160 | context_ = new_context; |
| 161 | } |
| 162 | |
| 163 | aio_context_t get() { return context_; } |
| 164 | |
| 165 | private: |
| 166 | aio_context_t context_ = 0; |
| 167 | }; |
| 168 | |
| 169 | struct UsbFfsConnection : public Connection { |
| 170 | UsbFfsConnection(unique_fd control, unique_fd read, unique_fd write, |
| 171 | std::promise<void> destruction_notifier) |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 172 | : worker_started_(false), |
| 173 | stopped_(false), |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 174 | destruction_notifier_(std::move(destruction_notifier)), |
| 175 | control_fd_(std::move(control)), |
| 176 | read_fd_(std::move(read)), |
| 177 | write_fd_(std::move(write)) { |
| 178 | LOG(INFO) << "UsbFfsConnection constructed"; |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 179 | worker_event_fd_.reset(eventfd(0, EFD_CLOEXEC)); |
| 180 | if (worker_event_fd_ == -1) { |
| 181 | PLOG(FATAL) << "failed to create eventfd"; |
| 182 | } |
| 183 | |
| 184 | monitor_event_fd_.reset(eventfd(0, EFD_CLOEXEC)); |
| 185 | if (monitor_event_fd_ == -1) { |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 186 | PLOG(FATAL) << "failed to create eventfd"; |
| 187 | } |
| 188 | |
| 189 | aio_context_ = ScopedAioContext::Create(kUsbReadQueueDepth + kUsbWriteQueueDepth); |
| 190 | } |
| 191 | |
| 192 | ~UsbFfsConnection() { |
| 193 | LOG(INFO) << "UsbFfsConnection being destroyed"; |
| 194 | Stop(); |
| 195 | monitor_thread_.join(); |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 196 | |
| 197 | // We need to explicitly close our file descriptors before we notify our destruction, |
| 198 | // because the thread listening on the future will immediately try to reopen the endpoint. |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 199 | aio_context_.reset(); |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 200 | control_fd_.reset(); |
| 201 | read_fd_.reset(); |
| 202 | write_fd_.reset(); |
| 203 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 204 | destruction_notifier_.set_value(); |
| 205 | } |
| 206 | |
| 207 | virtual bool Write(std::unique_ptr<apacket> packet) override final { |
| 208 | LOG(DEBUG) << "USB write: " << dump_header(&packet->msg); |
| 209 | Block header(sizeof(packet->msg)); |
| 210 | memcpy(header.data(), &packet->msg, sizeof(packet->msg)); |
| 211 | |
| 212 | std::lock_guard<std::mutex> lock(write_mutex_); |
| 213 | write_requests_.push_back(CreateWriteBlock(std::move(header), next_write_id_++)); |
| 214 | if (!packet->payload.empty()) { |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 215 | // The kernel attempts to allocate a contiguous block of memory for each write, |
| 216 | // which can fail if the write is large and the kernel heap is fragmented. |
| 217 | // Split large writes into smaller chunks to avoid this. |
| 218 | std::shared_ptr<Block> payload = std::make_shared<Block>(std::move(packet->payload)); |
| 219 | size_t offset = 0; |
| 220 | size_t len = payload->size(); |
| 221 | |
| 222 | while (len > 0) { |
| 223 | size_t write_size = std::min(kUsbWriteSize, len); |
| 224 | write_requests_.push_back( |
| 225 | CreateWriteBlock(payload, offset, write_size, next_write_id_++)); |
| 226 | len -= write_size; |
| 227 | offset += write_size; |
| 228 | } |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 229 | } |
| 230 | SubmitWrites(); |
| 231 | return true; |
| 232 | } |
| 233 | |
| 234 | virtual void Start() override final { StartMonitor(); } |
| 235 | |
| 236 | virtual void Stop() override final { |
| 237 | if (stopped_.exchange(true)) { |
| 238 | return; |
| 239 | } |
| 240 | stopped_ = true; |
| 241 | uint64_t notify = 1; |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 242 | ssize_t rc = adb_write(worker_event_fd_.get(), ¬ify, sizeof(notify)); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 243 | if (rc < 0) { |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 244 | PLOG(FATAL) << "failed to notify worker eventfd to stop UsbFfsConnection"; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 245 | } |
| 246 | CHECK_EQ(static_cast<size_t>(rc), sizeof(notify)); |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 247 | |
| 248 | rc = adb_write(monitor_event_fd_.get(), ¬ify, sizeof(notify)); |
| 249 | if (rc < 0) { |
| 250 | PLOG(FATAL) << "failed to notify monitor eventfd to stop UsbFfsConnection"; |
| 251 | } |
| 252 | |
| 253 | CHECK_EQ(static_cast<size_t>(rc), sizeof(notify)); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 254 | } |
| 255 | |
| 256 | private: |
| 257 | void StartMonitor() { |
| 258 | // This is a bit of a mess. |
| 259 | // It's possible for io_submit to end up blocking, if we call it as the endpoint |
| 260 | // becomes disabled. Work around this by having a monitor thread to listen for functionfs |
| 261 | // lifecycle events. If we notice an error condition (either we've become disabled, or we |
| 262 | // were never enabled in the first place), we send interruption signals to the worker thread |
| 263 | // until it dies, and then report failure to the transport via HandleError, which will |
| 264 | // eventually result in the transport being destroyed, which will result in UsbFfsConnection |
| 265 | // being destroyed, which unblocks the open thread and restarts this entire process. |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 266 | static std::once_flag handler_once; |
| 267 | std::call_once(handler_once, []() { signal(kInterruptionSignal, [](int) {}); }); |
| 268 | |
| 269 | monitor_thread_ = std::thread([this]() { |
| 270 | adb_thread_setname("UsbFfs-monitor"); |
| 271 | |
| 272 | bool bound = false; |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 273 | bool enabled = false; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 274 | bool running = true; |
| 275 | while (running) { |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 276 | adb_pollfd pfd[2] = { |
| 277 | { .fd = control_fd_.get(), .events = POLLIN, .revents = 0 }, |
| 278 | { .fd = monitor_event_fd_.get(), .events = POLLIN, .revents = 0 }, |
| 279 | }; |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 280 | |
| 281 | // If we don't see our first bind within a second, try again. |
| 282 | int timeout_ms = bound ? -1 : 1000; |
| 283 | |
| 284 | int rc = TEMP_FAILURE_RETRY(adb_poll(pfd, 2, timeout_ms)); |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 285 | if (rc == -1) { |
| 286 | PLOG(FATAL) << "poll on USB control fd failed"; |
| 287 | } else if (rc == 0) { |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 288 | LOG(WARNING) << "timed out while waiting for FUNCTIONFS_BIND, trying again"; |
| 289 | break; |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 290 | } |
| 291 | |
| 292 | if (pfd[1].revents) { |
| 293 | // We were told to die. |
| 294 | break; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 295 | } |
| 296 | |
| 297 | struct usb_functionfs_event event; |
Josh Gao | 370dbb0 | 2019-05-10 11:37:34 -0700 | [diff] [blame] | 298 | rc = TEMP_FAILURE_RETRY(adb_read(control_fd_.get(), &event, sizeof(event))); |
| 299 | if (rc == -1) { |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 300 | PLOG(FATAL) << "failed to read functionfs event"; |
Josh Gao | 370dbb0 | 2019-05-10 11:37:34 -0700 | [diff] [blame] | 301 | } else if (rc == 0) { |
| 302 | LOG(WARNING) << "hit EOF on functionfs control fd"; |
| 303 | break; |
| 304 | } else if (rc != sizeof(event)) { |
| 305 | LOG(FATAL) << "read functionfs event of unexpected size, expected " |
| 306 | << sizeof(event) << ", got " << rc; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 307 | } |
| 308 | |
| 309 | LOG(INFO) << "USB event: " |
| 310 | << to_string(static_cast<usb_functionfs_event_type>(event.type)); |
| 311 | |
| 312 | switch (event.type) { |
| 313 | case FUNCTIONFS_BIND: |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 314 | if (bound) { |
| 315 | LOG(WARNING) << "received FUNCTIONFS_BIND while already bound?"; |
| 316 | running = false; |
| 317 | } |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 318 | |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 319 | if (enabled) { |
| 320 | LOG(WARNING) << "received FUNCTIONFS_BIND while already enabled?"; |
| 321 | running = false; |
| 322 | } |
| 323 | |
| 324 | bound = true; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 325 | break; |
| 326 | |
| 327 | case FUNCTIONFS_ENABLE: |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 328 | if (!bound) { |
| 329 | LOG(WARNING) << "received FUNCTIONFS_ENABLE while not bound?"; |
| 330 | running = false; |
| 331 | } |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 332 | |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 333 | if (enabled) { |
| 334 | LOG(WARNING) << "received FUNCTIONFS_ENABLE while already enabled?"; |
| 335 | running = false; |
| 336 | } |
| 337 | |
| 338 | enabled = true; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 339 | StartWorker(); |
| 340 | break; |
| 341 | |
| 342 | case FUNCTIONFS_DISABLE: |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 343 | if (!bound) { |
| 344 | LOG(WARNING) << "received FUNCTIONFS_DISABLE while not bound?"; |
| 345 | } |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 346 | |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 347 | if (!enabled) { |
| 348 | LOG(WARNING) << "received FUNCTIONFS_DISABLE while not enabled?"; |
| 349 | } |
| 350 | |
| 351 | enabled = false; |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 352 | running = false; |
| 353 | break; |
| 354 | |
| 355 | case FUNCTIONFS_UNBIND: |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 356 | if (enabled) { |
| 357 | LOG(WARNING) << "received FUNCTIONFS_UNBIND while still enabled?"; |
| 358 | } |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 359 | |
Josh Gao | e3fa0c8 | 2019-03-28 11:05:53 -0700 | [diff] [blame] | 360 | if (!bound) { |
| 361 | LOG(WARNING) << "received FUNCTIONFS_UNBIND when not bound?"; |
| 362 | } |
| 363 | |
| 364 | bound = false; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 365 | running = false; |
| 366 | break; |
Josh Gao | 7be217e | 2019-05-15 18:03:29 -0700 | [diff] [blame^] | 367 | |
| 368 | case FUNCTIONFS_SETUP: { |
| 369 | LOG(INFO) << "received FUNCTIONFS_SETUP control transfer: bRequestType = " |
| 370 | << static_cast<int>(event.u.setup.bRequestType) |
| 371 | << ", bRequest = " << static_cast<int>(event.u.setup.bRequest) |
| 372 | << ", wValue = " << static_cast<int>(event.u.setup.wValue) |
| 373 | << ", wIndex = " << static_cast<int>(event.u.setup.wIndex) |
| 374 | << ", wLength = " << static_cast<int>(event.u.setup.wLength); |
| 375 | |
| 376 | if ((event.u.setup.bRequestType & USB_DIR_IN)) { |
| 377 | LOG(WARNING) << "received a device-to-host control transfer, ignoring"; |
| 378 | } else { |
| 379 | std::string buf; |
| 380 | buf.resize(event.u.setup.wLength + 1); |
| 381 | |
| 382 | ssize_t rc = adb_read(control_fd_.get(), buf.data(), buf.size()); |
| 383 | if (rc != event.u.setup.wLength) { |
| 384 | LOG(ERROR) |
| 385 | << "read " << rc |
| 386 | << " bytes when trying to read control request, expected " |
| 387 | << event.u.setup.wLength; |
| 388 | } |
| 389 | |
| 390 | LOG(INFO) << "control request contents: " << buf; |
| 391 | break; |
| 392 | } |
| 393 | } |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 394 | } |
| 395 | } |
| 396 | |
Josh Gao | 5f57277 | 2019-02-28 13:29:32 -0800 | [diff] [blame] | 397 | StopWorker(); |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 398 | HandleError("monitor thread finished"); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 399 | }); |
| 400 | } |
| 401 | |
| 402 | void StartWorker() { |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 403 | CHECK(!worker_started_); |
| 404 | worker_started_ = true; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 405 | worker_thread_ = std::thread([this]() { |
| 406 | adb_thread_setname("UsbFfs-worker"); |
| 407 | for (size_t i = 0; i < kUsbReadQueueDepth; ++i) { |
| 408 | read_requests_[i] = CreateReadBlock(next_read_id_++); |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 409 | if (!SubmitRead(&read_requests_[i])) { |
| 410 | return; |
| 411 | } |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 412 | } |
| 413 | |
| 414 | while (!stopped_) { |
| 415 | uint64_t dummy; |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 416 | ssize_t rc = adb_read(worker_event_fd_.get(), &dummy, sizeof(dummy)); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 417 | if (rc == -1) { |
| 418 | PLOG(FATAL) << "failed to read from eventfd"; |
| 419 | } else if (rc == 0) { |
| 420 | LOG(FATAL) << "hit EOF on eventfd"; |
| 421 | } |
| 422 | |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 423 | ReadEvents(); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 424 | } |
| 425 | }); |
| 426 | } |
| 427 | |
Josh Gao | 5f57277 | 2019-02-28 13:29:32 -0800 | [diff] [blame] | 428 | void StopWorker() { |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 429 | if (!worker_started_) { |
| 430 | return; |
| 431 | } |
| 432 | |
Josh Gao | 5f57277 | 2019-02-28 13:29:32 -0800 | [diff] [blame] | 433 | pthread_t worker_thread_handle = worker_thread_.native_handle(); |
| 434 | while (true) { |
| 435 | int rc = pthread_kill(worker_thread_handle, kInterruptionSignal); |
| 436 | if (rc != 0) { |
| 437 | LOG(ERROR) << "failed to send interruption signal to worker: " << strerror(rc); |
| 438 | break; |
| 439 | } |
| 440 | |
| 441 | std::this_thread::sleep_for(100ms); |
| 442 | |
| 443 | rc = pthread_kill(worker_thread_handle, 0); |
| 444 | if (rc == 0) { |
| 445 | continue; |
| 446 | } else if (rc == ESRCH) { |
| 447 | break; |
| 448 | } else { |
| 449 | LOG(ERROR) << "failed to send interruption signal to worker: " << strerror(rc); |
| 450 | } |
| 451 | } |
| 452 | |
| 453 | worker_thread_.join(); |
| 454 | } |
| 455 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 456 | void PrepareReadBlock(IoBlock* block, uint64_t id) { |
| 457 | block->pending = false; |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 458 | block->payload = std::make_shared<Block>(kUsbReadSize); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 459 | block->control.aio_data = static_cast<uint64_t>(TransferId::read(id)); |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 460 | block->control.aio_buf = reinterpret_cast<uintptr_t>(block->payload->data()); |
| 461 | block->control.aio_nbytes = block->payload->size(); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 462 | } |
| 463 | |
| 464 | IoBlock CreateReadBlock(uint64_t id) { |
| 465 | IoBlock block; |
| 466 | PrepareReadBlock(&block, id); |
| 467 | block.control.aio_rw_flags = 0; |
| 468 | block.control.aio_lio_opcode = IOCB_CMD_PREAD; |
| 469 | block.control.aio_reqprio = 0; |
| 470 | block.control.aio_fildes = read_fd_.get(); |
| 471 | block.control.aio_offset = 0; |
| 472 | block.control.aio_flags = IOCB_FLAG_RESFD; |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 473 | block.control.aio_resfd = worker_event_fd_.get(); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 474 | return block; |
| 475 | } |
| 476 | |
Josh Gao | 961496c | 2019-03-26 13:21:42 -0700 | [diff] [blame] | 477 | void ReadEvents() { |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 478 | static constexpr size_t kMaxEvents = kUsbReadQueueDepth + kUsbWriteQueueDepth; |
| 479 | struct io_event events[kMaxEvents]; |
| 480 | struct timespec timeout = {.tv_sec = 0, .tv_nsec = 0}; |
| 481 | int rc = io_getevents(aio_context_.get(), 0, kMaxEvents, events, &timeout); |
| 482 | if (rc == -1) { |
| 483 | HandleError(StringPrintf("io_getevents failed while reading: %s", strerror(errno))); |
| 484 | return; |
| 485 | } |
| 486 | |
| 487 | for (int event_idx = 0; event_idx < rc; ++event_idx) { |
| 488 | auto& event = events[event_idx]; |
| 489 | TransferId id = TransferId::from_value(event.data); |
| 490 | |
| 491 | if (event.res < 0) { |
| 492 | std::string error = |
| 493 | StringPrintf("%s %" PRIu64 " failed with error %s", |
| 494 | id.direction == TransferDirection::READ ? "read" : "write", |
| 495 | id.id, strerror(-event.res)); |
| 496 | HandleError(error); |
| 497 | return; |
| 498 | } |
| 499 | |
| 500 | if (id.direction == TransferDirection::READ) { |
| 501 | HandleRead(id, event.res); |
| 502 | } else { |
| 503 | HandleWrite(id); |
| 504 | } |
| 505 | } |
| 506 | } |
| 507 | |
| 508 | void HandleRead(TransferId id, int64_t size) { |
| 509 | uint64_t read_idx = id.id % kUsbReadQueueDepth; |
| 510 | IoBlock* block = &read_requests_[read_idx]; |
| 511 | block->pending = false; |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 512 | block->payload->resize(size); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 513 | |
| 514 | // Notification for completed reads can be received out of order. |
| 515 | if (block->id().id != needed_read_id_) { |
| 516 | LOG(VERBOSE) << "read " << block->id().id << " completed while waiting for " |
| 517 | << needed_read_id_; |
| 518 | return; |
| 519 | } |
| 520 | |
| 521 | for (uint64_t id = needed_read_id_;; ++id) { |
| 522 | size_t read_idx = id % kUsbReadQueueDepth; |
| 523 | IoBlock* current_block = &read_requests_[read_idx]; |
| 524 | if (current_block->pending) { |
| 525 | break; |
| 526 | } |
| 527 | ProcessRead(current_block); |
| 528 | ++needed_read_id_; |
| 529 | } |
| 530 | } |
| 531 | |
| 532 | void ProcessRead(IoBlock* block) { |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 533 | if (!block->payload->empty()) { |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 534 | if (!incoming_header_.has_value()) { |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 535 | CHECK_EQ(sizeof(amessage), block->payload->size()); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 536 | amessage msg; |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 537 | memcpy(&msg, block->payload->data(), sizeof(amessage)); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 538 | LOG(DEBUG) << "USB read:" << dump_header(&msg); |
| 539 | incoming_header_ = msg; |
| 540 | } else { |
| 541 | size_t bytes_left = incoming_header_->data_length - incoming_payload_.size(); |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 542 | Block payload = std::move(*block->payload); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 543 | CHECK_LE(payload.size(), bytes_left); |
| 544 | incoming_payload_.append(std::make_unique<Block>(std::move(payload))); |
| 545 | } |
| 546 | |
| 547 | if (incoming_header_->data_length == incoming_payload_.size()) { |
| 548 | auto packet = std::make_unique<apacket>(); |
| 549 | packet->msg = *incoming_header_; |
| 550 | |
| 551 | // TODO: Make apacket contain an IOVector so we don't have to coalesce. |
| 552 | packet->payload = incoming_payload_.coalesce(); |
| 553 | read_callback_(this, std::move(packet)); |
| 554 | |
| 555 | incoming_header_.reset(); |
| 556 | incoming_payload_.clear(); |
| 557 | } |
| 558 | } |
| 559 | |
| 560 | PrepareReadBlock(block, block->id().id + kUsbReadQueueDepth); |
| 561 | SubmitRead(block); |
| 562 | } |
| 563 | |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 564 | bool SubmitRead(IoBlock* block) { |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 565 | block->pending = true; |
| 566 | struct iocb* iocb = &block->control; |
| 567 | if (io_submit(aio_context_.get(), 1, &iocb) != 1) { |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 568 | if (errno == EINVAL && !gFfsAioSupported.has_value()) { |
| 569 | HandleError("failed to submit first read, AIO on FFS not supported"); |
| 570 | gFfsAioSupported = false; |
| 571 | return false; |
| 572 | } |
| 573 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 574 | HandleError(StringPrintf("failed to submit read: %s", strerror(errno))); |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 575 | return false; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 576 | } |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 577 | |
| 578 | gFfsAioSupported = true; |
| 579 | return true; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 580 | } |
| 581 | |
| 582 | void HandleWrite(TransferId id) { |
| 583 | std::lock_guard<std::mutex> lock(write_mutex_); |
| 584 | auto it = |
| 585 | std::find_if(write_requests_.begin(), write_requests_.end(), [id](const auto& req) { |
| 586 | return static_cast<uint64_t>(req->id()) == static_cast<uint64_t>(id); |
| 587 | }); |
| 588 | CHECK(it != write_requests_.end()); |
| 589 | |
| 590 | write_requests_.erase(it); |
| 591 | size_t outstanding_writes = --writes_submitted_; |
| 592 | LOG(DEBUG) << "USB write: reaped, down to " << outstanding_writes; |
| 593 | |
| 594 | SubmitWrites(); |
| 595 | } |
| 596 | |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 597 | std::unique_ptr<IoBlock> CreateWriteBlock(std::shared_ptr<Block> payload, size_t offset, |
| 598 | size_t len, uint64_t id) { |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 599 | auto block = std::make_unique<IoBlock>(); |
| 600 | block->payload = std::move(payload); |
| 601 | block->control.aio_data = static_cast<uint64_t>(TransferId::write(id)); |
| 602 | block->control.aio_rw_flags = 0; |
| 603 | block->control.aio_lio_opcode = IOCB_CMD_PWRITE; |
| 604 | block->control.aio_reqprio = 0; |
| 605 | block->control.aio_fildes = write_fd_.get(); |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 606 | block->control.aio_buf = reinterpret_cast<uintptr_t>(block->payload->data() + offset); |
| 607 | block->control.aio_nbytes = len; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 608 | block->control.aio_offset = 0; |
| 609 | block->control.aio_flags = IOCB_FLAG_RESFD; |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 610 | block->control.aio_resfd = worker_event_fd_.get(); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 611 | return block; |
| 612 | } |
| 613 | |
Josh Gao | b9727b0 | 2019-02-26 17:53:52 -0800 | [diff] [blame] | 614 | std::unique_ptr<IoBlock> CreateWriteBlock(Block payload, uint64_t id) { |
| 615 | std::shared_ptr<Block> block = std::make_shared<Block>(std::move(payload)); |
| 616 | size_t len = block->size(); |
| 617 | return CreateWriteBlock(std::move(block), 0, len, id); |
| 618 | } |
| 619 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 620 | void SubmitWrites() REQUIRES(write_mutex_) { |
| 621 | if (writes_submitted_ == kUsbWriteQueueDepth) { |
| 622 | return; |
| 623 | } |
| 624 | |
| 625 | ssize_t writes_to_submit = std::min(kUsbWriteQueueDepth - writes_submitted_, |
| 626 | write_requests_.size() - writes_submitted_); |
| 627 | CHECK_GE(writes_to_submit, 0); |
| 628 | if (writes_to_submit == 0) { |
| 629 | return; |
| 630 | } |
| 631 | |
| 632 | struct iocb* iocbs[kUsbWriteQueueDepth]; |
| 633 | for (int i = 0; i < writes_to_submit; ++i) { |
| 634 | CHECK(!write_requests_[writes_submitted_ + i]->pending); |
| 635 | write_requests_[writes_submitted_ + i]->pending = true; |
| 636 | iocbs[i] = &write_requests_[writes_submitted_ + i]->control; |
| 637 | LOG(VERBOSE) << "submitting write_request " << static_cast<void*>(iocbs[i]); |
| 638 | } |
| 639 | |
Josh Gao | cc14d39 | 2019-03-26 13:06:38 -0700 | [diff] [blame] | 640 | writes_submitted_ += writes_to_submit; |
| 641 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 642 | int rc = io_submit(aio_context_.get(), writes_to_submit, iocbs); |
| 643 | if (rc == -1) { |
| 644 | HandleError(StringPrintf("failed to submit write requests: %s", strerror(errno))); |
| 645 | return; |
| 646 | } else if (rc != writes_to_submit) { |
| 647 | LOG(FATAL) << "failed to submit all writes: wanted to submit " << writes_to_submit |
| 648 | << ", actually submitted " << rc; |
| 649 | } |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 650 | } |
| 651 | |
| 652 | void HandleError(const std::string& error) { |
| 653 | std::call_once(error_flag_, [&]() { |
| 654 | error_callback_(this, error); |
| 655 | if (!stopped_) { |
| 656 | Stop(); |
| 657 | } |
| 658 | }); |
| 659 | } |
| 660 | |
| 661 | std::thread monitor_thread_; |
Josh Gao | dcf3688 | 2019-03-26 18:47:45 -0700 | [diff] [blame] | 662 | |
| 663 | bool worker_started_; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 664 | std::thread worker_thread_; |
| 665 | |
| 666 | std::atomic<bool> stopped_; |
| 667 | std::promise<void> destruction_notifier_; |
| 668 | std::once_flag error_flag_; |
| 669 | |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 670 | unique_fd worker_event_fd_; |
| 671 | unique_fd monitor_event_fd_; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 672 | |
| 673 | ScopedAioContext aio_context_; |
| 674 | unique_fd control_fd_; |
| 675 | unique_fd read_fd_; |
| 676 | unique_fd write_fd_; |
| 677 | |
| 678 | std::optional<amessage> incoming_header_; |
| 679 | IOVector incoming_payload_; |
| 680 | |
| 681 | std::array<IoBlock, kUsbReadQueueDepth> read_requests_; |
| 682 | IOVector read_data_; |
| 683 | |
| 684 | // ID of the next request that we're going to send out. |
| 685 | size_t next_read_id_ = 0; |
| 686 | |
| 687 | // ID of the next packet we're waiting for. |
| 688 | size_t needed_read_id_ = 0; |
| 689 | |
| 690 | std::mutex write_mutex_; |
| 691 | std::deque<std::unique_ptr<IoBlock>> write_requests_ GUARDED_BY(write_mutex_); |
| 692 | size_t next_write_id_ GUARDED_BY(write_mutex_) = 0; |
| 693 | size_t writes_submitted_ GUARDED_BY(write_mutex_) = 0; |
Josh Gao | 5f57277 | 2019-02-28 13:29:32 -0800 | [diff] [blame] | 694 | |
| 695 | static constexpr int kInterruptionSignal = SIGUSR1; |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 696 | }; |
| 697 | |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 698 | void usb_init_legacy(); |
| 699 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 700 | static void usb_ffs_open_thread() { |
| 701 | adb_thread_setname("usb ffs open"); |
| 702 | |
| 703 | while (true) { |
Josh Gao | b8afeea | 2019-02-13 15:27:28 -0800 | [diff] [blame] | 704 | if (gFfsAioSupported.has_value() && !gFfsAioSupported.value()) { |
| 705 | LOG(INFO) << "failed to use nonblocking ffs, falling back to legacy"; |
| 706 | return usb_init_legacy(); |
| 707 | } |
| 708 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 709 | unique_fd control; |
| 710 | unique_fd bulk_out; |
| 711 | unique_fd bulk_in; |
| 712 | if (!open_functionfs(&control, &bulk_out, &bulk_in)) { |
| 713 | std::this_thread::sleep_for(1s); |
| 714 | continue; |
| 715 | } |
| 716 | |
| 717 | atransport* transport = new atransport(); |
| 718 | transport->serial = "UsbFfs"; |
| 719 | std::promise<void> destruction_notifier; |
| 720 | std::future<void> future = destruction_notifier.get_future(); |
| 721 | transport->SetConnection(std::make_unique<UsbFfsConnection>( |
| 722 | std::move(control), std::move(bulk_out), std::move(bulk_in), |
| 723 | std::move(destruction_notifier))); |
| 724 | register_transport(transport); |
| 725 | future.wait(); |
| 726 | } |
| 727 | } |
| 728 | |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 729 | void usb_init() { |
Josh Gao | 99920cb | 2019-03-18 16:33:18 -0700 | [diff] [blame] | 730 | bool use_nonblocking = android::base::GetBoolProperty( |
| 731 | "persist.adb.nonblocking_ffs", |
| 732 | android::base::GetBoolProperty("ro.adb.nonblocking_ffs", true)); |
| 733 | |
Josh Gao | bfd7afc | 2019-02-28 07:26:20 +0000 | [diff] [blame] | 734 | if (use_nonblocking) { |
Josh Gao | a8d018c | 2019-02-26 22:10:33 +0000 | [diff] [blame] | 735 | std::thread(usb_ffs_open_thread).detach(); |
Josh Gao | bfd7afc | 2019-02-28 07:26:20 +0000 | [diff] [blame] | 736 | } else { |
| 737 | usb_init_legacy(); |
Josh Gao | 3a34bc5 | 2018-10-11 16:33:05 -0700 | [diff] [blame] | 738 | } |
| 739 | } |