libadb 0.7.0

Low-level ADB protocol library for direct TCP and USB communication
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
use core::sync::atomic::{AtomicBool, Ordering};

use bytes::BytesMut;
use embedded_io_async::{Read, Write};

use super::error::{Error, ProtocolError};
use super::protocol::command::Command;
use super::protocol::constant::MAX_PAYLOAD;
use super::protocol::Packet;
use super::protocol::{Checksum, MESSAGE_SIZE};

/// Floor on how much to ask the transport for. A request smaller than
/// this is padded up to it, so a header-sized read does not split a
/// packet that would have arrived in one go.
pub(crate) const MIN_READ: usize = 4096;

#[cfg(test)]
pub(crate) use tests::ZEROED;

/// Grows `buf` by `want` bytes and hands out that tail to be read into,
/// cutting the buffer back to whatever was committed when dropped — so
/// a failed or cancelled read leaves no placeholder bytes behind.
pub(crate) struct Staged<'a> {
    buf: &'a mut BytesMut,
    keep: usize,
}

impl<'a> Staged<'a> {
    pub(crate) fn new(buf: &'a mut BytesMut, want: usize) -> Self {
        let keep = buf.len();
        buf.resize(keep + want, 0);
        #[cfg(test)]
        tests::ZEROED.with(|zeroed| zeroed.set(zeroed.get() + want));
        Self { buf, keep }
    }

    pub(crate) fn spare(&mut self) -> &mut [u8] {
        &mut self.buf[self.keep..]
    }

    pub(crate) fn commit(&mut self, n: usize) {
        self.keep += n;
    }

    /// Everything committed so far: what was there before, and what has
    /// been read in since.
    pub(crate) fn committed(&self) -> &[u8] {
        &self.buf[..self.keep]
    }

    /// Whether to read into the same stretch again: the first packet is
    /// still short, and all it lacks fits in what is left. Staging anew
    /// for each read would zero the rest of a large packet every time,
    /// and over TLS a read brings only one 16 KiB record.
    pub(crate) fn wants_more(&mut self) -> bool {
        let missing = Packet::missing(self.committed());
        missing != 0 && missing <= self.spare().len()
    }
}

impl Drop for Staged<'_> {
    fn drop(&mut self) {
        self.buf.truncate(self.keep);
    }
}

/// Tracks whether a packet was left half-written.
///
/// A packet goes out as a header write followed by a payload write. Drop
/// the future in between — a cancelled `write_channel`, a `select!` that
/// lost the race — and the device is left waiting for a payload it will
/// take from whatever we send next. Nothing on this side can put the
/// framing back, so the flag is one-way: once raised, every operation on
/// the connection fails with [`Error::Desynchronized`].
pub(crate) struct DesyncFlag(AtomicBool);

impl DesyncFlag {
    pub(crate) const fn new() -> Self {
        Self(AtomicBool::new(false))
    }

    /// Fail if a packet was already abandoned mid-write.
    pub(crate) fn check<E>(&self) -> Result<(), Error<E>> {
        if self.0.load(Ordering::Relaxed) {
            return Err(Error::Desynchronized);
        }
        Ok(())
    }

    fn arm(&self) -> ArmedWrite<'_> {
        ArmedWrite(Some(self))
    }
}

/// Raises its flag if dropped before the packet is fully written.
struct ArmedWrite<'a>(Option<&'a DesyncFlag>);

impl ArmedWrite<'_> {
    fn disarm(mut self) {
        self.0 = None;
    }
}

impl Drop for ArmedWrite<'_> {
    fn drop(&mut self) {
        if let Some(flag) = self.0 {
            flag.0.store(true, Ordering::Relaxed);
        }
    }
}

pub(crate) async fn write_all<T: Write>(t: &mut T, buf: &[u8]) -> Result<(), Error<T::Error>> {
    let mut pos = 0;
    while pos < buf.len() {
        match t.write(&buf[pos..]).await {
            Ok(0) => return Err(Error::UnexpectedEof),
            Ok(n) => pos += n,
            Err(e) => return Err(Error::Io(e)),
        }
    }
    Ok(())
}

/// Send a packet as a header write followed by a payload write.
///
/// The split is required, not cosmetic: adbd reads the 24-byte header
/// with an exact-size read, so on USB a single transfer carrying both
/// overflows its endpoint and knocks the device off the bus.
pub(crate) async fn send_pkt<T: Write>(
    t: &mut T,
    desync: &DesyncFlag,
    pkt: &Packet,
    checksum: Checksum,
) -> Result<(), Error<T::Error>> {
    send_raw(
        t,
        desync,
        pkt.command,
        pkt.arg0,
        pkt.arg1,
        &pkt.data,
        checksum,
    )
    .await
}

/// Rejects any packet whose announced payload exceeds `max_payload`.
pub(crate) async fn recv_pkt<T: Read>(
    t: &mut T,
    buf: &mut BytesMut,
    max_payload: u32,
) -> Result<Packet, Error<T::Error>> {
    loop {
        if let Some(pkt) = Packet::decode(buf, max_payload)? {
            return Ok(pkt);
        }
        let want = Packet::missing(buf).max(MIN_READ);
        let mut staged = Staged::new(buf, want);
        loop {
            match t.read(staged.spare()).await {
                Ok(0) => return Err(Error::UnexpectedEof),
                Ok(n) => staged.commit(n),
                Err(e) => return Err(Error::Io(e)),
            }
            if !staged.wants_more() {
                break;
            }
        }
    }
}

fn encode_header(
    command: Command,
    arg0: u32,
    arg1: u32,
    payload: &[u8],
    checksum: Checksum,
) -> Result<[u8; MESSAGE_SIZE], ProtocolError> {
    if payload.len() > MAX_PAYLOAD as usize {
        return Err(ProtocolError::PayloadTooLarge);
    }
    let cmd_u32: u32 = command.into();
    let data_length = payload.len() as u32;
    let data_check = checksum.of(payload);
    let magic = command.magic();
    let mut h = [0u8; MESSAGE_SIZE];
    h[0..4].copy_from_slice(&cmd_u32.to_le_bytes());
    h[4..8].copy_from_slice(&arg0.to_le_bytes());
    h[8..12].copy_from_slice(&arg1.to_le_bytes());
    h[12..16].copy_from_slice(&data_length.to_le_bytes());
    h[16..20].copy_from_slice(&data_check.to_le_bytes());
    h[20..24].copy_from_slice(&magic.to_le_bytes());
    Ok(h)
}

pub(crate) async fn send_raw<T: Write>(
    t: &mut T,
    desync: &DesyncFlag,
    command: Command,
    arg0: u32,
    arg1: u32,
    payload: &[u8],
    checksum: Checksum,
) -> Result<(), Error<T::Error>> {
    desync.check()?;
    let header = encode_header(command, arg0, arg1, payload, checksum)?;
    let armed = desync.arm();
    write_all(t, &header).await?;
    if !payload.is_empty() {
        write_all(t, payload).await?;
    }
    // A transport that buffers, as TLS does, may still hold part of the
    // packet, and only the flush puts all of it on the wire; the rest
    // have nothing to flush. So it stays inside the armed stretch.
    t.flush().await.map_err(Error::Io)?;
    armed.disarm();
    Ok(())
}

pub(crate) async fn send_okay_to<T: Write>(
    transport: &mut T,
    desync: &DesyncFlag,
    delayed_ack: bool,
    local_id: u32,
    remote_id: u32,
    wrte_len: usize,
    checksum: Checksum,
) -> Result<(), Error<T::Error>> {
    let ack = (wrte_len as u32).to_le_bytes();
    let payload: &[u8] = if delayed_ack { &ack } else { &[] };
    send_raw(
        transport,
        desync,
        Command::Ready,
        local_id,
        remote_id,
        payload,
        checksum,
    )
    .await
}

#[cfg(test)]
mod tests {
    extern crate std;

    use super::*;
    use crate::base::protocol::command::Command;
    use crate::base::protocol::Checksum;
    use core::future::Future;
    use core::pin::pin;
    use core::task::{Context, Poll, Waker};
    use std::vec::Vec;

    std::thread_local! {
        /// Bytes `Staged::new` has zeroed on this thread, for the tests
        /// that pin how often a packet is staged.
        pub(crate) static ZEROED: core::cell::Cell<usize> = const { core::cell::Cell::new(0) };
    }

    #[derive(Debug)]
    struct MockErr;

    impl embedded_io::Error for MockErr {
        fn kind(&self) -> embedded_io::ErrorKind {
            embedded_io::ErrorKind::Other
        }
    }

    /// Hands out queued bytes, filling as much of the caller's buffer as
    /// it can, and counts how many times it was asked.
    struct Feeder {
        queued: Vec<u8>,
        reads: usize,
        /// Cap on what a single read hands back; 0 means "no cap".
        drip: usize,
    }

    impl Feeder {
        fn new(bytes: Vec<u8>) -> Self {
            Self {
                queued: bytes,
                reads: 0,
                drip: 0,
            }
        }

        fn dripping(bytes: Vec<u8>, drip: usize) -> Self {
            Self {
                queued: bytes,
                reads: 0,
                drip,
            }
        }
    }

    impl embedded_io::ErrorType for Feeder {
        type Error = MockErr;
    }

    impl Read for Feeder {
        async fn read(&mut self, buf: &mut [u8]) -> Result<usize, MockErr> {
            self.reads += 1;
            let cap = if self.drip == 0 { buf.len() } else { self.drip };
            let n = self.queued.len().min(buf.len()).min(cap);
            buf[..n].copy_from_slice(&self.queued[..n]);
            self.queued.drain(..n);
            Ok(n)
        }
    }

    /// Never produces anything, so a read on it parks forever.
    struct Parked;

    impl embedded_io::ErrorType for Parked {
        type Error = MockErr;
    }

    impl Read for Parked {
        async fn read(&mut self, _buf: &mut [u8]) -> Result<usize, MockErr> {
            core::future::pending().await
        }
    }

    fn block_on<F: Future>(fut: F) -> F::Output {
        let mut fut = pin!(fut);
        let mut cx = Context::from_waker(Waker::noop());
        match fut.as_mut().poll(&mut cx) {
            Poll::Ready(v) => v,
            Poll::Pending => panic!("mock transports never park"),
        }
    }

    fn wire_packet(payload_len: usize) -> Vec<u8> {
        let payload = std::vec![0xAB; payload_len];
        let pkt = Packet::new(Command::Write, 1, 2, payload);
        let mut buf = BytesMut::new();
        pkt.encode(&mut buf, Checksum::Compute).unwrap();
        buf.to_vec()
    }

    /// Records the size of every `write` it is handed.
    #[derive(Default)]
    struct WriteLog {
        writes: Vec<usize>,
    }

    impl embedded_io::ErrorType for WriteLog {
        type Error = MockErr;
    }

    impl Write for WriteLog {
        async fn write(&mut self, buf: &[u8]) -> Result<usize, MockErr> {
            self.writes.push(buf.len());
            Ok(buf.len())
        }

        async fn flush(&mut self) -> Result<(), MockErr> {
            Ok(())
        }
    }

    #[test]
    fn a_large_packet_is_zeroed_once_however_it_arrives() {
        // Over TLS a read brings one 16 KiB record. The packet is staged,
        // and so zeroed, once however many reads fill it; staging afresh
        // for each would memset some 33 MiB for one 1 MiB WRTE. The slack
        // is the MIN_READ that the first, header-sized read is padded to.
        let wire = wire_packet(1 << 20);
        let mut t = Feeder::dripping(wire.clone(), 16 * 1024);
        let mut buf = BytesMut::new();
        ZEROED.with(|zeroed| zeroed.set(0));

        let pkt = block_on(recv_pkt(&mut t, &mut buf, MAX_PAYLOAD)).unwrap();

        assert_eq!(pkt.data.len(), 1 << 20);
        let zeroed = ZEROED.with(|zeroed| zeroed.get());
        assert!(
            zeroed <= wire.len() + MIN_READ,
            "zeroed {zeroed} bytes for a {}-byte packet",
            wire.len()
        );
    }

    #[test]
    fn a_packet_is_written_as_header_then_payload() {
        // adbd reads the 24-byte header with an exact-size read, so on
        // USB a single transfer carrying header + payload overflows its
        // endpoint and drops the device off the bus.
        let mut t = WriteLog::default();
        let pkt = Packet::new(Command::Connect, 1, 2, &b"host::features=shell_v2\0"[..]);

        block_on(send_pkt(
            &mut t,
            &DesyncFlag::new(),
            &pkt,
            Checksum::Compute,
        ))
        .unwrap();

        assert_eq!(
            t.writes,
            std::vec![MESSAGE_SIZE, 24],
            "header and payload must go out as separate writes",
        );
    }

    #[test]
    fn an_empty_packet_is_a_single_header_write() {
        let mut t = WriteLog::default();
        let pkt = Packet::close(1, 2);

        block_on(send_pkt(
            &mut t,
            &DesyncFlag::new(),
            &pkt,
            Checksum::Compute,
        ))
        .unwrap();

        assert_eq!(t.writes, std::vec![MESSAGE_SIZE]);
    }

    #[test]
    fn future_does_not_carry_a_scratch_buffer() {
        let mut t = Feeder::new(Vec::new());
        let mut buf = BytesMut::new();
        let fut = recv_pkt(&mut t, &mut buf, MAX_PAYLOAD);
        let size = core::mem::size_of_val(&fut);
        assert!(
            size < 512,
            "recv_pkt future is {size} B — a scratch array that big lands in \
             every caller's future, which is what embedded tasks pay for",
        );
    }

    #[test]
    fn a_large_packet_does_not_take_one_read_per_scratch_worth() {
        let wire = wire_packet(64 * 1024);
        let mut t = Feeder::new(wire.clone());
        let mut buf = BytesMut::new();

        let pkt = block_on(recv_pkt(&mut t, &mut buf, MAX_PAYLOAD)).unwrap();

        assert_eq!(pkt.data.len(), 64 * 1024);
        assert!(
            t.reads <= 4,
            "took {} reads for one packet: the payload length is known from \
             the header, so it should be requested in one go",
            t.reads,
        );
    }

    #[test]
    fn a_cancelled_read_leaves_no_scratch_bytes_behind() {
        let mut t = Parked;
        let mut buf = BytesMut::from(&b"\x57\x52\x54\x45"[..]);
        let before = buf.clone();

        {
            let mut fut = pin!(recv_pkt(&mut t, &mut buf, MAX_PAYLOAD));
            let mut cx = Context::from_waker(Waker::noop());
            assert!(matches!(fut.as_mut().poll(&mut cx), Poll::Pending));
        }

        assert_eq!(
            buf, before,
            "a dropped read must not leave placeholder bytes in the buffer",
        );
    }

    #[test]
    fn a_packet_split_across_reads_is_reassembled() {
        // 7 bytes at a time, so the header itself spans four reads.
        let mut t = Feeder::dripping(wire_packet(100), 7);
        let mut buf = BytesMut::new();

        let pkt = block_on(recv_pkt(&mut t, &mut buf, MAX_PAYLOAD)).unwrap();

        assert_eq!(pkt.data.len(), 100);
        assert_eq!(&pkt.data[..], &[0xAB; 100][..]);
        assert!(buf.is_empty(), "nothing should be left over");
    }

    #[test]
    fn bytes_beyond_the_packet_stay_buffered() {
        let mut wire = wire_packet(8);
        let trailing = wire_packet(4);
        wire.extend_from_slice(&trailing);

        let mut t = Feeder::new(wire);
        let mut buf = BytesMut::new();

        let first = block_on(recv_pkt(&mut t, &mut buf, MAX_PAYLOAD)).unwrap();
        assert_eq!(first.data.len(), 8);

        let second = block_on(recv_pkt(&mut t, &mut buf, MAX_PAYLOAD)).unwrap();
        assert_eq!(second.data.len(), 4, "the second packet must survive");
    }
}