Gitiles
Code Review Sign In
LeafOS / LeafOS-Project / android_packages_modules_adb / refs/heads/leaf-4.0
commitf8a7480bc3500502d5f12c8fd6d1aecc394a604f[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Thu Jun 13 23:22:42 2024 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Thu Jun 13 23:22:42 2024 +0000
tree26234dcd6ca28740f502a43852b50f6cdd7bf867
parent2a750ff4d609f0869802f2e6b194ecdedc131c49 [diff]
parentb5c96a3dcebbf3db1232636a3cdc46a4429a6dfb [diff]
Snap for 11967491 from b5c96a3dcebbf3db1232636a3cdc46a4429a6dfb to 24Q3-release

Change-Id: Ib793640f60a0da1eca9b334841ccf3d9f851d058
tree: 26234dcd6ca28740f502a43852b50f6cdd7bf867
  1. apex/
  2. client/
  3. coverage/
  4. crypto/
  5. daemon/
  6. docs/
  7. fastdeploy/
  8. fdevent/
  9. libs/
  10. pairing_auth/
  11. pairing_connection/
  12. proto/
  13. sysdeps/
  14. test_device_apks/
  15. test_utils/
  16. tls/
  17. tools/
  18. .clang-format
  19. adb.bash
  20. adb.cpp
  21. adb.h
  22. adb_auth.h
  23. adb_integration_test_adb.xml
  24. adb_integration_test_device.xml
  25. adb_io.cpp
  26. adb_io.h
  27. adb_io_test.cpp
  28. adb_listeners.cpp
  29. adb_listeners.h
  30. adb_listeners_test.cpp
  31. adb_mdns.cpp
  32. adb_mdns.h
  33. adb_trace.cpp
  34. adb_trace.h
  35. adb_unique_fd.cpp
  36. adb_unique_fd.h
  37. adb_utils.cpp
  38. adb_utils.h
  39. adb_utils_test.cpp
  40. adb_wifi.h
  41. adbd_test.map
  42. adbd_test.xml
  43. Android.bp
  44. benchmark_device.py
  45. bugreport_test.cpp
  46. compression_utils.h
  47. file_sync_protocol.h
  48. mdns_test.cpp
  49. MODULE_LICENSE_APACHE2
  50. NOTICE
  51. OVERVIEW.TXT
  52. OWNERS
  53. PREUPLOAD.cfg
  54. protocol.txt
  55. README.md
  56. run-device-tests.sh
  57. security_log_tags.h
  58. services.cpp
  59. services.h
  60. SERVICES.TXT
  61. shell_protocol.h
  62. shell_service_protocol.cpp
  63. shell_service_protocol_test.cpp
  64. SOCKET-ACTIVATION.txt
  65. socket.h
  66. socket_spec.cpp
  67. socket_spec.h
  68. socket_spec_test.cpp
  69. socket_test.cpp
  70. sockets.cpp
  71. sockets.dia
  72. SYNC.TXT
  73. sysdeps.h
  74. sysdeps_test.cpp
  75. sysdeps_unix.cpp
  76. sysdeps_win32.cpp
  77. sysdeps_win32_test.cpp
  78. test_adb.py
  79. test_device.py
  80. TEST_MAPPING
  81. trace.sh
  82. transfer_id.h
  83. transport.cpp
  84. transport.h
  85. transport_benchmark.cpp
  86. transport_fd.cpp
  87. transport_test.cpp
  88. types.cpp
  89. types.h
  90. types_test.cpp
README.md

ADB Internals

If you are new to adb source code, you should start by reading OVERVIEW.TXT which describes the three components of adb pipeline.

This document is here to boost what can be achieved within a "window of naive interest". You will not find function or class documentation here but rather the "big picture" which should allow you to build a mental map to help navigate the code.

Three components of adb pipeline

As outlined in the overview, this codebase generates three components (Client, Server (a.k.a Host), and Daemon (a.k.a adbd)). The central part is the Server which runs on the Host computer. On one side the Server exposes a "Smart Socket" to Clients such as adb or DDMLIB. On the other side, the Server continuously monitors for connecting Daemons (as USB devices or TCP emulator). Communication with a device is done with a Transport.

+----------+              +------------------------+
|   ADB    +----------+   |      ADB SERVER        |                   +----------+
|  CLIENT  |          |   |                        |              (USB)|   ADBD   |
+----------+          |   |                     Transport+-------------+ (DEVICE) |
                      |   |                        |                   +----------+
+-----------          |   |                        |
|   ADB    |          v   +                        |                   +----------+
|  CLIENT  +--------->SmartSocket                  |              (USB)|   ADBD   |
+----------+          ^   | (TCP/IP)            Transport+-------------+ (DEVICE) |
                      |   |                        |                   +----------+
+----------+          |   |                        |
|  DDMLIB  |          |   |                     Transport+--+          +----------+
|  CLIENT  +----------+   |                        |        |  (TCP/IP)|   ADBD   |
+----------+              +------------------------+        +----------|(EMULATOR)|
                                                                       +----------+

The Client and the Server are contained in the same executable and both run on the Host machine. Code sections specific to the Host is enclosed within ADB_HOST guard. adbd runs on the Android Device. Daemon specific code is enclosed in !ADB_HOST but also sometimes with-in __ANDROID__ guard.

"SMART SOCKET" and TRANSPORT

A smart socket is a simple TCP socket with a smart protocol built on top of it. This is what Clients connect onto from the Host side. The Client must always initiate communication via a human readable request but the response format varies. The smart protocol is documented in SERVICES.TXT.

On the other side, the Server communicates with a device via a Transport. adb initially targeted devices connecting over USB, which is restricted to a fixed number of data streams. Therefore, adb multiplexes multiple byte streams over a single pipe via Transport. When devices connecting over other mechanisms (e.g. emulators over TCP) were introduced, the existing transport protocol was maintained.

THREADING MODEL and FDEVENT system

At the heart of both the Server and Daemon is a main thread running an fdevent loop, which is a platform-independent abstraction over poll/epoll/WSAPoll monitoring file descriptors events. Requests and services are usually served from the main thread but some service requests result in new threads being spawned.

To allow for operations to run on the Main thread, fdevent features a RunQueue combined with an interrupt fd to force polling to return.

+------------+    +-------------------------^
|  RUNQUEUE  |    |                         |
+------------+    |  POLLING (Main thread)  |
| Function<> |    |                         |
+------------+    |                         |
| Function<> |    ^-^-------^-------^------^^
+------------+      |       |       |       |
|    ...     |      |       |       |       |
+------------+      |       |       |       |
|            |      |       |       |       |
|============|      |       |       |       |
|Interrupt fd+------+  +----+  +----+  +----+
+------------+         fd      Socket  Pipe

ASOCKET, APACKET, and AMESSAGE

The asocket, apacket, and amessage constructs exist only to wrap data while it transits on a Transport. An asocket handles a stream of apackets. An apacket consists in a amessage header featuring a command (A_SYNC, A_OPEN, A_CLSE, A_WRTE, A_OKAY, ...) followed by a payload (find more documentation in protocol.txt. There is no A_READ command because an asocket is unidirectional. To model a bi-directional stream, asocket have a peer which go in the opposite direction.

An asocket features a buffer where the elemental unit is an apacket. If traffic is inbound, the buffer stores the apacket until it is consumed. If the traffic is oubound, the buffer stores apackets until they are sent down the wire (with A_WRTE commands).

+---------------------ASocket------------------------+
 |                                                   |
 | +----------------APacket Queue------------------+ |
 | |                                               | |
 | |            APacket     APacket     APacket    | |
 | |          +--------+  +--------+  +--------+   | |
 | |          |AMessage|  |AMessage|  |AMessage|   | |
 | |          +--------+  +--------+  +--------+   | |
 | |          |        |  |        |  |        |   | |
 | |  .....   |        |  |        |  |        |   | |
 | |          |  Data  |  |  Data  |  |  Data  |   | |
 | |          |        |  |        |  |        |   | |
 | |          |        |  |        |  |        |   | |
 | |          +--------+  +--------+  +--------+   | |
 | |                                               | |
 | +-----------------------------------------------+ |
 +---------------------------------------------------+

This system allows to multiplex data streams on an unique byte stream. Without entering too much into details, the amessage fields arg1 and arg2 are used alike in the TCP protocol where local and remote ports identify an unique stream. Note that unlike TCP which feature an "unacknowledged-send window", an apacket is sent only after the previous one has been confirmed to be received.

The two types of asocket (Remote and Local) differentiate between outbound and inbound traffic.

adbd <-> APPPLICATION communication

This pipeline is detailed in daemon/jdwp_service.cpp with ASCII drawings! The JDWP extension implemented by Dalvik/ART are documented in:

  • platform/dalvik/+/main/docs/debugmon.html
  • platform/dalvik/+/main/docs/debugger.html

Sync protocol

To transfer files and directories, ADB places a smart-socket in SYNC mode and then issues SYNC commands. The SYNC protocol is documented in SYNC.TXT.

Benchmark sample run for Pixel 8,USB

$ ./benchmark_device.py
sink 100MiB: 10 runs: median 27.00 MiB/s, mean 26.39 MiB/s, stddev: 1.11 MiB/s
source 100MiB: 10 runs: median 36.97 MiB/s, mean 37.05 MiB/s, stddev: 0.46 MiB/s
push 100MiB: 10 runs: median 331.96 MiB/s, mean 329.81 MiB/s, stddev: 14.67 MiB/s
pull 100MiB: 10 runs: median 34.55 MiB/s, mean 33.57 MiB/s, stddev: 2.54 MiB/s