psicose 0.4.3

no_std heapless reliable link motor: 4-byte frame, ACK/CRC, window N≤8, P2P Node/PeerLink, LinkFace — zero crate dependencies
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
//! Application data is **bytes**. The 4-byte frame is only the envelope.
//!
//! ```text
//! JPEG  File  Flash  Sensor  firmware.bin  [u8]
//!   │     │     │       │         │         │
//!   └─────┴─────┴───────┴─────────┴─────────┘
//!                     │
//!                ByteSource          ← you implement this
//!                     │ 1 byte
//!                     ▼
//!                  PSICOSE           ← never owns the file
//!                     │ Frame
//!                     ▼
//!                ByteTransport
//!                     │
//!                ByteSink            ← you implement this
//!                     │
//!              File  Flash  RAM
//! ```
//!
//! A JPEG, a 4 GB file, and a 4-byte config blob use the same path.
//! PSICOSE does not know the type. It only ever holds the current
//! payload byte (or `N` of them, in a window).

use crate::error::Error;
use crate::rx::{PollOutcome, Receiver};
use crate::timeout::IdleBudget;
use crate::transport::{ByteSink, ByteSource, ByteTransport};
use crate::tx::{Sender, TxPoll};
use crate::window::{WindowedReceiver, WindowedSender};

/// Error from a source-to-sink transfer: either the link or the
/// application reader/writer.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum StreamError<Link, App> {
    /// ACK/NACK/CRC/retry failure on the wire.
    Protocol(Error<Link>),
    /// [`ByteSource`] or [`ByteSink`] failed.
    Application(App),
}

impl<Link: core::fmt::Debug, App: core::fmt::Debug> core::fmt::Display for StreamError<Link, App> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            StreamError::Protocol(e) => write!(f, "protocol: {e}"),
            StreamError::Application(e) => write!(f, "application: {e:?}"),
        }
    }
}

/// The destination slice had no room for the next byte.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SliceFull;

/// Borrowed byte source. The caller owns the buffer; PSICOSE does not.
pub struct SliceSource<'a> {
    rest: &'a [u8],
}

impl<'a> SliceSource<'a> {
    /// Streams `bytes` from the start.
    pub const fn new(bytes: &'a [u8]) -> Self {
        SliceSource { rest: bytes }
    }

    /// Bytes not yet offered to the sender.
    pub const fn remaining(&self) -> usize {
        self.rest.len()
    }
}

impl ByteSource for SliceSource<'_> {
    type Error = core::convert::Infallible;

    fn read_byte(&mut self) -> Result<Option<u8>, Self::Error> {
        match self.rest.split_first() {
            Some((byte, rest)) => {
                self.rest = rest;
                Ok(Some(*byte))
            }
            None => Ok(None),
        }
    }
}

impl<'a> From<&'a [u8]> for SliceSource<'a> {
    fn from(bytes: &'a [u8]) -> Self {
        SliceSource::new(bytes)
    }
}

/// Borrowed byte sink. The caller owns the buffer; PSICOSE does not.
pub struct SliceSink<'a> {
    buf: &'a mut [u8],
    pos: usize,
}

impl<'a> SliceSink<'a> {
    /// Writes into `buf` from index 0.
    pub fn new(buf: &'a mut [u8]) -> Self {
        SliceSink { buf, pos: 0 }
    }

    /// How many bytes were written.
    pub const fn filled(&self) -> usize {
        self.pos
    }

    /// The prefix that was written.
    pub fn written(&self) -> &[u8] {
        &self.buf[..self.pos]
    }
}

impl ByteSink for SliceSink<'_> {
    type Error = SliceFull;

    fn write_byte(&mut self, byte: u8) -> Result<(), Self::Error> {
        if self.pos >= self.buf.len() {
            return Err(SliceFull);
        }
        self.buf[self.pos] = byte;
        self.pos += 1;
        Ok(())
    }
}

impl<'a> From<&'a mut [u8]> for SliceSink<'a> {
    fn from(buf: &'a mut [u8]) -> Self {
        SliceSink::new(buf)
    }
}

/// Drain `src` through a stop-and-wait sender, then FINISH.
///
/// The source can be a file, flash, camera buffer, or [`SliceSource`].
/// Returns how many payload bytes were accepted by the peer.
///
/// This path expects ACKs on the sender's own transport (scripted
/// replies). On a live pair, use [`crate::Pump::send_all`] so RX is
/// polled in the same cooperative step.
///
/// In-flight waits use [`crate::timeout::RetryPolicy`] inside
/// [`Sender::send_byte`](crate::tx::Sender::send_byte) — not an idle budget.
pub fn send_all<T, S>(
    tx: &mut Sender<T>,
    src: &mut S,
) -> Result<u64, StreamError<T::Error, S::Error>>
where
    T: ByteTransport,
    S: ByteSource,
{
    let mut n = 0u64;
    loop {
        let byte = src.read_byte().map_err(StreamError::Application)?;
        match byte {
            Some(byte) => {
                tx.send_byte(byte).map_err(StreamError::Protocol)?;
                n = n.saturating_add(1);
            }
            None => {
                tx.send_finish().map_err(StreamError::Protocol)?;
                return Ok(n);
            }
        }
    }
}

/// Drain `src` through a windowed sender, then FINISH.
pub fn send_all_windowed<T, S, const N: usize>(
    tx: &mut WindowedSender<T, N>,
    src: &mut S,
) -> Result<u64, StreamError<T::Error, S::Error>>
where
    T: ByteTransport,
    S: ByteSource,
{
    send_all_windowed_budgeted(tx, src, IdleBudget::DEFAULT)
}

/// [`send_all_windowed`] with an [`IdleBudget`] on the `WindowFull` spin.
pub fn send_all_windowed_budgeted<T, S, const N: usize>(
    tx: &mut WindowedSender<T, N>,
    src: &mut S,
    mut budget: IdleBudget,
) -> Result<u64, StreamError<T::Error, S::Error>>
where
    T: ByteTransport,
    S: ByteSource,
{
    let mut n = 0u64;
    loop {
        let byte = src.read_byte().map_err(StreamError::Application)?;
        match byte {
            Some(byte) => loop {
                match tx.offer(byte) {
                    Ok(()) => {
                        n = n.saturating_add(1);
                        budget.reset();
                        break;
                    }
                    Err(Error::WindowFull) => match tx.poll().map_err(StreamError::Protocol)? {
                        TxPoll::Acked => budget.reset(),
                        TxPoll::Pending => budget.tick().map_err(StreamError::Protocol)?,
                        TxPoll::Aborted => {
                            return Err(StreamError::Protocol(Error::Aborted));
                        }
                        TxPoll::SessionReady | TxPoll::TransferDone => {
                            budget.tick().map_err(StreamError::Protocol)?;
                        }
                    },
                    Err(e) => return Err(StreamError::Protocol(e)),
                }
            },
            None => break,
        }
    }
    while tx.outstanding() > 0 {
        match tx.poll().map_err(StreamError::Protocol)? {
            TxPoll::Acked => budget.reset(),
            TxPoll::Pending => budget.tick().map_err(StreamError::Protocol)?,
            TxPoll::Aborted => return Err(StreamError::Protocol(Error::Aborted)),
            TxPoll::SessionReady | TxPoll::TransferDone => break,
        }
    }
    tx.send_finish().map_err(StreamError::Protocol)?;
    Ok(n)
}

/// Write every delivered payload byte into `sink` until FINISH.
pub fn recv_all<T, K>(
    rx: &mut Receiver<T>,
    sink: &mut K,
) -> Result<u64, StreamError<T::Error, K::Error>>
where
    T: ByteTransport,
    K: ByteSink,
{
    recv_all_budgeted(rx, sink, IdleBudget::DEFAULT)
}

/// [`recv_all`] with an [`IdleBudget`] so a silent peer cannot hang the loop.
pub fn recv_all_budgeted<T, K>(
    rx: &mut Receiver<T>,
    sink: &mut K,
    budget: IdleBudget,
) -> Result<u64, StreamError<T::Error, K::Error>>
where
    T: ByteTransport,
    K: ByteSink,
{
    drain_recv(|| rx.poll(), sink, budget)
}

/// Windowed counterpart of [`recv_all`].
pub fn recv_all_windowed<T, K, const N: usize>(
    rx: &mut WindowedReceiver<T, N>,
    sink: &mut K,
) -> Result<u64, StreamError<T::Error, K::Error>>
where
    T: ByteTransport,
    K: ByteSink,
{
    recv_all_windowed_budgeted(rx, sink, IdleBudget::DEFAULT)
}

/// [`recv_all_windowed`] with an [`IdleBudget`].
pub fn recv_all_windowed_budgeted<T, K, const N: usize>(
    rx: &mut WindowedReceiver<T, N>,
    sink: &mut K,
    budget: IdleBudget,
) -> Result<u64, StreamError<T::Error, K::Error>>
where
    T: ByteTransport,
    K: ByteSink,
{
    drain_recv(|| rx.poll(), sink, budget)
}

fn drain_recv<E, K, F>(
    mut poll: F,
    sink: &mut K,
    mut budget: IdleBudget,
) -> Result<u64, StreamError<E, K::Error>>
where
    F: FnMut() -> Result<PollOutcome, Error<E>>,
    K: ByteSink,
{
    let mut n = 0u64;
    loop {
        match poll().map_err(StreamError::Protocol)? {
            PollOutcome::Delivered(byte) => {
                sink.write_byte(byte).map_err(StreamError::Application)?;
                n = n.saturating_add(1);
                budget.reset();
            }
            PollOutcome::TransferFinished => return Ok(n),
            PollOutcome::Aborted => return Err(StreamError::Protocol(Error::Aborted)),
            PollOutcome::Started
            | PollOutcome::DuplicateIgnored
            | PollOutcome::Rejected
            | PollOutcome::CrcRejected => budget.reset(),
            PollOutcome::Pending => budget.tick().map_err(StreamError::Protocol)?,
        }
    }
}

/// Send a borrowed slice. The slice stays with the caller.
pub fn send_bytes<T: ByteTransport>(
    tx: &mut Sender<T>,
    bytes: &[u8],
) -> Result<u64, Error<T::Error>> {
    let mut src = SliceSource::new(bytes);
    match send_all(tx, &mut src) {
        Ok(n) => Ok(n),
        Err(StreamError::Protocol(e)) => Err(e),
        Err(StreamError::Application(never)) => match never {},
    }
}

/// Receive into a borrowed slice until FINISH.
pub fn recv_bytes<'a, T: ByteTransport>(
    rx: &mut Receiver<T>,
    buf: &'a mut [u8],
) -> Result<&'a [u8], StreamError<T::Error, SliceFull>> {
    let mut sink = SliceSink::new(buf);
    recv_all(rx, &mut sink)?;
    let n = sink.filled();
    Ok(&buf[..n])
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::protocol::Frame;
    use crate::test_support::MockTransport;
    use crate::timeout::RetryPolicy;
    use crate::transport::ByteSource;
    use crate::window::{WindowedReceiver, WindowedSender};

    fn ack_run(data_bytes: u8) -> [u8; 36] {
        let data_bytes = core::cmp::min(data_bytes, 8);
        let mut out = [0u8; 36];
        let frames = data_bytes as usize + 1;
        for i in 0..frames {
            let bytes = Frame::ack(i as u8).to_bytes();
            out[i * 4..i * 4 + 4].copy_from_slice(&bytes);
        }
        out
    }

    #[test]
    fn slice_source_is_just_bytes() {
        let jpeg_so_i_like = [0xFF, 0xD8, 0xFF, 0xE0, 0x00, 0x10];
        let mut src = SliceSource::new(&jpeg_so_i_like);
        assert_eq!(src.read_byte(), Ok(Some(0xFF)));
        assert_eq!(src.read_byte(), Ok(Some(0xD8)));
        assert_eq!(src.remaining(), 4);
    }

    #[test]
    fn send_bytes_moves_any_payload_then_finish() {
        let payload = [b'P', b'S', b'I', 0x00];
        let incoming = ack_run(4);
        let mut tx = Sender::with_policy(
            MockTransport::with_incoming(&incoming[..20]),
            RetryPolicy::new(50, 3),
        );
        assert_eq!(send_bytes(&mut tx, &payload), Ok(4));
        assert_eq!(tx.state(), crate::tx::TxState::Finished);
    }

    #[test]
    fn recv_bytes_rebuilds_the_payload() {
        let incoming = crate::test_support::concat3(
            Frame::data(0, 0xFF).to_bytes(),
            Frame::data(1, 0xD8).to_bytes(),
            Frame::finish(2).to_bytes(),
        );
        let mut rx = Receiver::new(MockTransport::with_incoming(&incoming));
        let mut buf = [0u8; 8];
        assert_eq!(recv_bytes(&mut rx, &mut buf), Ok(&[0xFF, 0xD8][..]));
    }

    #[test]
    fn sink_full_is_an_application_error() {
        let incoming = crate::test_support::concat2(
            Frame::data(0, 1).to_bytes(),
            Frame::data(1, 2).to_bytes(),
        );
        let mut rx = Receiver::new(MockTransport::with_incoming(&incoming));
        let mut buf = [0u8; 1];
        assert_eq!(
            recv_bytes(&mut rx, &mut buf),
            Err(StreamError::Application(SliceFull))
        );
    }

    #[test]
    fn send_all_windowed_then_finish() {
        let payload = [0xDE, 0xAD, 0xBE, 0xEF];
        let incoming = ack_run(4);
        let mut tx = WindowedSender::<_, 4>::with_policy(
            MockTransport::with_incoming(&incoming[..20]),
            RetryPolicy::new(50, 3),
        );
        let mut src = SliceSource::new(&payload);
        assert_eq!(send_all_windowed(&mut tx, &mut src), Ok(4));
        assert_eq!(tx.state(), crate::tx::TxState::Finished);
    }

    #[test]
    fn recv_all_windowed_rebuilds_any_blob() {
        let incoming = crate::test_support::concat3(
            Frame::data(0, b'{').to_bytes(),
            Frame::data(1, b'}').to_bytes(),
            Frame::finish(2).to_bytes(),
        );
        let mut rx = WindowedReceiver::<_, 4>::new(MockTransport::with_incoming(&incoming));
        let mut buf = [0u8; 8];
        let mut sink = SliceSink::new(&mut buf);
        assert_eq!(recv_all_windowed(&mut rx, &mut sink), Ok(2));
        assert_eq!(sink.written(), b"{}");
    }

    #[test]
    fn recv_all_budgeted_returns_when_peer_disappears() {
        let mut rx = Receiver::new(MockTransport::with_incoming(&[]));
        let mut buf = [0u8; 4];
        let mut sink = SliceSink::new(&mut buf);
        assert_eq!(
            recv_all_budgeted(&mut rx, &mut sink, IdleBudget::new(8)),
            Err(StreamError::Protocol(Error::IdleBudgetExhausted))
        );
    }
}