cu29-logstream 1.2.1

Bounded semantic log streaming protocol and FEC for Copper
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
//! Packed transport framing. No version or schema is sent in packet headers;
//! sender and receiver must be built for the matching application.

use crate::{Error, RecordKind, Result};
use alloc::vec::Vec;

const PACKET_MAGIC: [u8; 4] = *b"CULS";
/// Maximum packet header length, used to bound storage and the shared FEC symbol size.
/// RaptorQ uses 51 bytes; RLC uses 32 for source packets and 36 for repair packets.
pub const PACKET_HEADER_LEN: usize = 51;
const COMMON_HEADER_LEN: usize = 28;
const RLC_SOURCE_HEADER_LEN: usize = 32;
const RLC_REPAIR_HEADER_LEN: usize = 36;

const fn packet_header_len(scheme: FecScheme, kind: FecSymbolKind) -> usize {
    match (scheme, kind) {
        (FecScheme::RaptorQ, _) => PACKET_HEADER_LEN,
        (_, FecSymbolKind::Source) => RLC_SOURCE_HEADER_LEN,
        (_, FecSymbolKind::Repair) => RLC_REPAIR_HEADER_LEN,
    }
}

/// Independently scheduled transport lanes.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum Lane {
    Control = 0,
    ReplayCritical = 1,
    LargeObject = 2,
    StructuredLog = 3,
    Visualization = 4,
}

impl TryFrom<u8> for Lane {
    type Error = Error;

    fn try_from(value: u8) -> Result<Self> {
        match value {
            0 => Ok(Self::Control),
            1 => Ok(Self::ReplayCritical),
            2 => Ok(Self::LargeObject),
            3 => Ok(Self::StructuredLog),
            4 => Ok(Self::Visualization),
            _ => Err(Error::UnknownLane(value)),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum FecScheme {
    RlcGf2 = 0,
    RlcGf256 = 1,
    RaptorQ = 2,
}

impl TryFrom<u8> for FecScheme {
    type Error = Error;

    fn try_from(value: u8) -> Result<Self> {
        match value {
            0 => Ok(Self::RlcGf2),
            1 => Ok(Self::RlcGf256),
            2 => Ok(Self::RaptorQ),
            _ => Err(Error::UnknownFecScheme(value)),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum FecSymbolKind {
    Source = 0,
    Repair = 1,
}

impl TryFrom<u8> for FecSymbolKind {
    type Error = Error;

    fn try_from(value: u8) -> Result<Self> {
        match value {
            0 => Ok(Self::Source),
            1 => Ok(Self::Repair),
            _ => Err(Error::UnknownSymbolKind(value)),
        }
    }
}

/// Fixed-endian metadata repeated on every independently reorderable symbol.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct WireHeader {
    pub lane: Lane,
    pub record_kind: RecordKind,
    pub fec_scheme: FecScheme,
    pub symbol_kind: FecSymbolKind,
    pub session_id: [u8; 16],
    pub sender_id: u32,
    /// RaptorQ object identity. Not transmitted for RLC; decoded as zero.
    pub object_id: u64,
    /// RaptorQ OTI (12 bytes), RLC source ID (first 4), or RLC repair ID (first 8).
    /// RaptorQ's reserved byte at index 5 must be zero; it is omitted on the wire
    /// and restored locally when decoding.
    /// Unused RLC bytes are not transmitted and decode as zero.
    pub fec_metadata: [u8; 12],
    /// RaptorQ payload ID. Not transmitted for RLC; decoded as zero.
    pub fragment_count: u32,
}

/// Owned packet for callers that retain or edit payloads.
/// Receiver parsing uses [`WirePacketRef`] to borrow the datagram instead.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct WirePacket {
    pub header: WireHeader,
    pub payload: Vec<u8>,
}

impl WirePacket {
    pub fn encode(&self) -> Result<Vec<u8>> {
        let mut bytes = alloc::vec![0; packet_header_len(self.header.fec_scheme, self.header.symbol_kind) + self.payload.len()];
        let encoded = encode_packet_into(self.header, &self.payload, &mut bytes)?;
        debug_assert_eq!(encoded, bytes.len());
        Ok(bytes)
    }

    pub fn decode(bytes: &[u8]) -> Result<Self> {
        let packet = WirePacketRef::decode(bytes)?;
        Ok(Self {
            header: packet.header,
            payload: packet.payload.to_vec(),
        })
    }
}

/// Structurally validated packet view borrowing the transport's receive buffer.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct WirePacketRef<'a> {
    pub header: WireHeader,
    pub payload: &'a [u8],
}

impl<'a> WirePacketRef<'a> {
    /// Decodes exactly one complete packet supplied by the carrier.
    /// The carrier must verify packet integrity before calling this parser.
    /// This validates header structure only; FEC cannot correct corrupted symbols.
    /// The payload occupies the remaining packet extent after the header.
    pub fn decode(bytes: &'a [u8]) -> Result<Self> {
        if bytes.len() < COMMON_HEADER_LEN {
            return Err(Error::TruncatedPacket);
        }
        if bytes[..4] != PACKET_MAGIC {
            return Err(Error::InvalidMagic);
        }
        let fec_scheme = FecScheme::try_from(bytes[6])?;
        let symbol_kind = FecSymbolKind::try_from(bytes[7])?;
        let header_len = packet_header_len(fec_scheme, symbol_kind);
        if bytes.len() < header_len {
            return Err(Error::TruncatedPacket);
        }
        let mut session_id = [0_u8; 16];
        session_id.copy_from_slice(&bytes[8..24]);
        let mut fec_metadata = [0_u8; 12];
        let (object_id, fragment_count) = match fec_scheme {
            FecScheme::RaptorQ => {
                fec_metadata[..5].copy_from_slice(&bytes[36..41]);
                fec_metadata[6..].copy_from_slice(&bytes[41..47]);
                (
                    u64::from_be_bytes(bytes[28..36].try_into().unwrap()),
                    u32::from_be_bytes(bytes[47..51].try_into().unwrap()),
                )
            }
            FecScheme::RlcGf2 | FecScheme::RlcGf256 => {
                let metadata_len = header_len - COMMON_HEADER_LEN;
                fec_metadata[..metadata_len].copy_from_slice(&bytes[COMMON_HEADER_LEN..header_len]);
                (0, 0)
            }
        };

        Ok(Self {
            header: WireHeader {
                lane: Lane::try_from(bytes[4])?,
                record_kind: RecordKind::try_from(bytes[5])?,
                fec_scheme,
                symbol_kind,
                session_id,
                sender_id: u32::from_be_bytes(bytes[24..28].try_into().unwrap()),
                object_id,
                fec_metadata,
                fragment_count,
            },
            payload: &bytes[header_len..],
        })
    }
}

/// Encodes one packet into caller-owned storage and returns its exact length.
pub fn encode_packet_into(header: WireHeader, payload: &[u8], output: &mut [u8]) -> Result<usize> {
    if header.fec_scheme == FecScheme::RaptorQ && header.fec_metadata[5] != 0 {
        return Err(Error::InvalidFecMetadata(
            "RaptorQ OTI reserved byte is nonzero",
        ));
    }
    let header_len = packet_header_len(header.fec_scheme, header.symbol_kind);
    let needed = header_len
        .checked_add(payload.len())
        .ok_or(Error::InvalidConfig("packet length overflow"))?;
    if output.len() < needed {
        return Err(Error::BufferTooSmall {
            needed,
            available: output.len(),
        });
    }

    let bytes = &mut output[..needed];
    bytes.fill(0);
    bytes[..4].copy_from_slice(&PACKET_MAGIC);
    bytes[4] = header.lane as u8;
    bytes[5] = header.record_kind as u8;
    bytes[6] = header.fec_scheme as u8;
    bytes[7] = header.symbol_kind as u8;
    bytes[8..24].copy_from_slice(&header.session_id);
    bytes[24..28].copy_from_slice(&header.sender_id.to_be_bytes());
    match header.fec_scheme {
        FecScheme::RaptorQ => {
            bytes[28..36].copy_from_slice(&header.object_id.to_be_bytes());
            bytes[36..41].copy_from_slice(&header.fec_metadata[..5]);
            bytes[41..47].copy_from_slice(&header.fec_metadata[6..]);
            bytes[47..51].copy_from_slice(&header.fragment_count.to_be_bytes());
        }
        FecScheme::RlcGf2 | FecScheme::RlcGf256 => {
            bytes[COMMON_HEADER_LEN..header_len]
                .copy_from_slice(&header.fec_metadata[..header_len - COMMON_HEADER_LEN]);
        }
    }
    bytes[header_len..].copy_from_slice(payload);
    Ok(needed)
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::vec;

    fn fixture() -> WirePacket {
        WirePacket {
            header: WireHeader {
                lane: Lane::LargeObject,
                record_kind: RecordKind::KeyFrame,
                fec_scheme: FecScheme::RaptorQ,
                symbol_kind: FecSymbolKind::Source,
                session_id: [0x11; 16],
                sender_id: 0x2233_4455,
                object_id: 0x0102_0304_0506_0708,
                fec_metadata: [0, 0, 0, 0, 3, 0, 0, 8, 1, 0, 1, 1],
                fragment_count: 1,
            },
            payload: vec![0, 0, 0, 0, 1, 2, 3, 0, 0, 0, 0, 0],
        }
    }

    #[test]
    fn fixed_header_has_a_stable_golden_prefix() {
        let encoded = fixture().encode().unwrap();
        assert_eq!(&encoded[..8], &[b'C', b'U', b'L', b'S', 2, 2, 2, 0]);
        assert_eq!(encoded.len(), 51 + fixture().payload.len());
        assert_eq!(&encoded[8..24], &[0x11; 16]);
        assert_eq!(&encoded[24..28], &0x2233_4455_u32.to_be_bytes());
        assert_eq!(&encoded[28..36], &0x0102_0304_0506_0708_u64.to_be_bytes());
        assert_eq!(&encoded[36..47], &[0, 0, 0, 0, 3, 0, 8, 1, 0, 1, 1]);
        assert_eq!(&encoded[47..51], &1_u32.to_be_bytes());
        assert_eq!(&encoded[51..], fixture().payload);
        assert_eq!(WirePacket::decode(&encoded).unwrap(), fixture());
    }

    #[test]
    fn raptorq_oti_preserves_every_nonreserved_byte() {
        for kind in [FecSymbolKind::Source, FecSymbolKind::Repair] {
            let mut packet = fixture();
            packet.header.symbol_kind = kind;
            packet.header.fec_metadata = [1, 2, 3, 4, 5, 0, 6, 7, 8, 9, 10, 11];
            packet.header.fragment_count = 0x1234_5678;
            let encoded = packet.encode().unwrap();
            assert_eq!(&encoded[36..47], &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]);
            assert_eq!(&encoded[47..51], &[0x12, 0x34, 0x56, 0x78]);
            assert_eq!(WirePacket::decode(&encoded).unwrap(), packet);
        }
    }

    #[test]
    fn raptorq_oti_rejects_nonzero_reserved_byte_before_encoding() {
        for kind in [FecSymbolKind::Source, FecSymbolKind::Repair] {
            let mut packet = fixture();
            packet.header.symbol_kind = kind;
            for reserved in 1..=u8::MAX {
                packet.header.fec_metadata[5] = reserved;
                let expected = Error::InvalidFecMetadata("RaptorQ OTI reserved byte is nonzero");
                let mut storage = [0xaa; 128];
                assert_eq!(
                    encode_packet_into(packet.header, &packet.payload, &mut storage),
                    Err(expected.clone())
                );
                assert_eq!(storage, [0xaa; 128]);
                assert_eq!(packet.encode(), Err(expected));
            }
        }
    }

    fn rlc_fixture(scheme: FecScheme, kind: FecSymbolKind) -> WirePacket {
        let mut packet = fixture();
        packet.header.lane = Lane::ReplayCritical;
        packet.header.record_kind = RecordKind::CopperList;
        packet.header.fec_scheme = scheme;
        packet.header.symbol_kind = kind;
        packet.header.object_id = 0;
        packet.header.fragment_count = 0;
        packet.header.fec_metadata = [0; 12];
        let id_len = match kind {
            FecSymbolKind::Source => 4,
            FecSymbolKind::Repair => 8,
        };
        packet.header.fec_metadata[..id_len].copy_from_slice(&[1, 2, 3, 4, 5, 6, 7, 8][..id_len]);
        packet
    }

    #[test]
    fn rlc_headers_carry_only_the_active_fec_id() {
        for scheme in [FecScheme::RlcGf2, FecScheme::RlcGf256] {
            for (kind, header_len, id_len) in [
                (FecSymbolKind::Source, 32, 4),
                (FecSymbolKind::Repair, 36, 8),
            ] {
                let packet = rlc_fixture(scheme, kind);
                let encoded = packet.encode().unwrap();
                assert_eq!(encoded.len(), header_len + packet.payload.len());
                assert_eq!(
                    &encoded[..8],
                    &[
                        b'C',
                        b'U',
                        b'L',
                        b'S',
                        1,
                        RecordKind::CopperList as u8,
                        scheme as u8,
                        kind as u8
                    ]
                );
                assert_eq!(&encoded[8..24], &[0x11; 16]);
                assert_eq!(&encoded[24..28], &0x2233_4455_u32.to_be_bytes());
                assert_eq!(
                    &encoded[28..28 + id_len],
                    &packet.header.fec_metadata[..id_len]
                );
                assert_eq!(header_len, 28 + id_len);
                assert_eq!(&encoded[header_len..], packet.payload);
                assert_eq!(WirePacket::decode(&encoded).unwrap(), packet);

                let mut exact_storage = vec![0; encoded.len()];
                assert_eq!(
                    encode_packet_into(packet.header, &packet.payload, &mut exact_storage).unwrap(),
                    encoded.len()
                );
                assert_eq!(exact_storage, encoded);
                let available = encoded.len() - 1;
                assert_eq!(
                    encode_packet_into(
                        packet.header,
                        &packet.payload,
                        &mut exact_storage[..available]
                    ),
                    Err(Error::BufferTooSmall {
                        needed: encoded.len(),
                        available
                    })
                );
            }
        }
    }

    #[test]
    fn all_header_layouts_reject_truncated_headers_and_invalid_tags() {
        for scheme in [FecScheme::RlcGf2, FecScheme::RlcGf256, FecScheme::RaptorQ] {
            for kind in [FecSymbolKind::Source, FecSymbolKind::Repair] {
                let mut packet = if scheme == FecScheme::RaptorQ {
                    fixture()
                } else {
                    rlc_fixture(scheme, kind)
                };
                packet.header.symbol_kind = kind;
                for payload in [vec![], vec![0x5a; 64]] {
                    packet.payload = payload;
                    let encoded = packet.encode().unwrap();
                    assert_eq!(WirePacket::decode(&encoded).unwrap(), packet);
                    let header_len = packet_header_len(scheme, kind);
                    for end in 0..header_len {
                        assert_eq!(
                            WirePacketRef::decode(&encoded[..end]),
                            Err(Error::TruncatedPacket)
                        );
                    }
                    for (offset, expected) in [
                        (0, Error::InvalidMagic),
                        (4, Error::UnknownLane(255)),
                        (5, Error::UnknownRecordKind(255)),
                        (6, Error::UnknownFecScheme(255)),
                        (7, Error::UnknownSymbolKind(255)),
                    ] {
                        let mut invalid = encoded.clone();
                        invalid[offset] = 255;
                        assert_eq!(WirePacketRef::decode(&invalid), Err(expected));
                    }
                }
            }
        }
    }

    #[test]
    fn packet_extent_defines_payload_length_for_every_layout() {
        for scheme in [FecScheme::RlcGf2, FecScheme::RlcGf256, FecScheme::RaptorQ] {
            for kind in [FecSymbolKind::Source, FecSymbolKind::Repair] {
                let mut packet = if scheme == FecScheme::RaptorQ {
                    fixture()
                } else {
                    rlc_fixture(scheme, kind)
                };
                packet.header.symbol_kind = kind;
                let header_len = packet_header_len(scheme, kind);
                for payload_len in [0, 1, crate::DEFAULT_MAX_SYMBOL_SIZE, u16::MAX as usize + 1] {
                    packet.payload = vec![0x5a; payload_len];
                    let needed = header_len + payload_len;
                    let mut storage = vec![0xaa; needed + 1];
                    assert_eq!(
                        encode_packet_into(packet.header, &packet.payload, &mut storage).unwrap(),
                        needed
                    );
                    assert_eq!(storage[needed], 0xaa);
                    let decoded = WirePacketRef::decode(&storage[..needed]).unwrap();
                    assert_eq!(decoded.header, packet.header);
                    assert_eq!(decoded.payload, packet.payload);
                    assert_eq!(decoded.payload.as_ptr(), storage[header_len..].as_ptr());
                    // Complete packet boundaries and integrity belong to the carrier.
                    let extended = WirePacketRef::decode(&storage).unwrap();
                    assert_eq!(extended.payload.len(), payload_len + 1);
                    assert_eq!(extended.payload[payload_len], 0xaa);
                    for end in [header_len, header_len + payload_len / 2, needed] {
                        assert_eq!(
                            WirePacketRef::decode(&storage[..end]).unwrap().payload,
                            &packet.payload[..end - header_len]
                        );
                    }
                    assert_eq!(
                        encode_packet_into(
                            packet.header,
                            &packet.payload,
                            &mut storage[..needed - 1]
                        ),
                        Err(Error::BufferTooSmall {
                            needed,
                            available: needed - 1,
                        })
                    );
                }
            }
        }
    }

    #[test]
    fn caller_owned_encoding_matches_allocating_encoding() {
        let packet = fixture();
        let expected = packet.encode().unwrap();
        let mut storage = [0xaa; 128];
        let encoded = encode_packet_into(packet.header, &packet.payload, &mut storage).unwrap();

        assert_eq!(&storage[..encoded], expected);
        assert!(storage[encoded..].iter().all(|byte| *byte == 0xaa));
    }
}