-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtreeframe.rs
More file actions
1121 lines (1056 loc) · 37.5 KB
/
Copy pathtreeframe.rs
File metadata and controls
1121 lines (1056 loc) · 37.5 KB
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! MST/2 TreeFrame wire format — spec 06.
//!
//! Fixed 64-byte header; kinds META(1), OBJECT(2), CHUNK(3), END(254),
//! ERROR(255). Identity encoding is mandatory. The optional `zstd`
//! feature adds strict single-frame compression (window ≤ 8 MiB, exact
//! `raw_len`, no concatenated/skippable/trailing data — spec 06) and
//! `encode_zstd` on the three compressible payloads. END/ERROR are never
//! compressed.
use crate::{
read_u16, read_u32, read_u64, sha256, write_u16, write_u32, write_u64, CodecError, CodecResult,
};
pub const VERSION: u16 = 2;
pub const HEADER_LEN: usize = 64;
pub const KIND_META: u8 = 1;
pub const KIND_OBJECT: u8 = 2;
pub const KIND_CHUNK: u8 = 3;
pub const KIND_END: u8 = 254;
pub const KIND_ERROR: u8 = 255;
pub const FLAG_ZSTD: u8 = 0b0000_0001;
pub const META_MAX_PAGES: usize = 64;
pub const META_MAX_RAW: usize = 1_048_576;
pub const OBJECT_MAX_COUNT: usize = 128;
pub const OBJECT_MAX_LEN: u32 = 262_144;
pub const OBJECT_MAX_RAW: usize = 1_048_576;
pub const CHUNK_MAX_LEN: u32 = 1_048_576;
pub const ERROR_MAX_BYTES: usize = 4096;
/// A parsed frame header (payload digest included).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FrameHeader {
pub kind: u8,
pub flags: u8,
pub wire_len: u32,
pub raw_len: u32,
pub stream_id: u32,
pub sequence: u64,
pub payload_sha256: [u8; 32],
}
/// A fully validated frame.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Frame {
Meta(MetaPayload),
Object(ObjectPayload),
Chunk(ChunkPayload),
End(EndPayload),
Error(ErrorPayload),
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MetaPayload {
/// `(page_id, canonical MTP2 page bytes)`.
pub pages: Vec<([u8; 32], Vec<u8>)>,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ObjectPayload {
/// `(content_id, raw object bytes)` in table order.
pub objects: Vec<([u8; 32], Vec<u8>)>,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ChunkPayload {
pub map_id: [u8; 32],
pub file_content_id: [u8; 32],
pub chunk_index: u64,
pub chunk_bytes: Vec<u8>,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EndPayload {
pub request_item_count: u32,
pub unique_unit_count: u32,
pub logical_bytes: u64,
pub request_body_sha256: [u8; 32],
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ErrorPayload {
pub code: String,
pub retryable: bool,
pub request_id: String,
}
/// Parse and validate one frame (header + payload) from `buf`, returning the
/// frame and the total consumed length. Digest, kind, flags and payload
/// structure are all checked.
pub fn parse_frame(buf: &[u8]) -> CodecResult<(Frame, usize)> {
if buf.len() < HEADER_LEN {
return Err(CodecError::Truncated("frame header"));
}
if &buf[0..4] != b"MST2" {
return Err(CodecError::BadConstant("MST2 magic"));
}
if read_u16(buf, 4)? != VERSION {
return Err(CodecError::BadConstant("frame version"));
}
let kind = buf[6];
let flags = buf[7];
if read_u32(buf, 8)? as usize != HEADER_LEN {
return Err(CodecError::BadConstant("header_len must be 64"));
}
if flags & !FLAG_ZSTD != 0 {
return Err(CodecError::BadConstant("unknown frame flags"));
}
let wire_len = read_u32(buf, 12)?;
let raw_len = read_u32(buf, 16)?;
let stream_id = read_u32(buf, 20)?;
if stream_id == 0 {
return Err(CodecError::BadConstant("stream_id must be non-zero"));
}
let _sequence = read_u64(buf, 24)?;
let mut payload_sha256 = [0u8; 32];
payload_sha256.copy_from_slice(&buf[32..64]);
if matches!(kind, KIND_END | KIND_ERROR) && flags & FLAG_ZSTD != 0 {
return Err(CodecError::BadConstant("END/ERROR must not be compressed"));
}
if flags & FLAG_ZSTD == 0 && wire_len != raw_len {
return Err(CodecError::BadLength(
"identity encoding requires wire_len == raw_len",
));
}
let total = HEADER_LEN + wire_len as usize;
if buf.len() < total {
return Err(CodecError::Truncated("frame payload"));
}
let wire_payload = &buf[HEADER_LEN..total];
// Header digest always covers the on-wire (compressed) payload.
let wire_digest = sha256(&[wire_payload]);
if wire_digest != payload_sha256 {
return Err(CodecError::DigestMismatch("frame payload"));
}
// Recover the canonical raw payload, enforcing the single-frame
// zstd contract when compressed (window ≤ 8 MiB, exact raw_len, no
// concatenated/skippable/trailing data).
let owned_payload: Vec<u8>;
let payload: &[u8] = if flags & FLAG_ZSTD == 0 {
wire_payload
} else {
#[cfg(feature = "zstd")]
{
owned_payload = crate::zstd1::decompress_strict(wire_payload, raw_len as usize)?;
&owned_payload
}
#[cfg(not(feature = "zstd"))]
{
return Err(CodecError::Unsupported(
"zstd frame received by identity-only codec build",
));
}
};
let frame = match kind {
KIND_META => Frame::Meta(decode_meta(payload)?),
KIND_OBJECT => Frame::Object(decode_object(payload)?),
KIND_CHUNK => Frame::Chunk(decode_chunk(payload, raw_len)?),
KIND_END => Frame::End(decode_end(payload)?),
KIND_ERROR => Frame::Error(decode_error(payload)?),
_ => return Err(CodecError::BadConstant("frame kind")),
};
Ok((frame, total))
}
/// Parse a whole HTTP-body byte stream: frames must share one non-zero
/// stream_id, sequences must start at 0 and increase consecutively, exactly
/// one final END (or an ERROR terminator) and nothing after it.
pub fn parse_stream(buf: &[u8]) -> CodecResult<Vec<Frame>> {
let mut frames = Vec::new();
let mut off = 0usize;
let mut stream_id: Option<u32> = None;
let mut expect_seq = 0u64;
let mut terminated = false;
while off < buf.len() {
if terminated {
return Err(CodecError::BadOrdering("bytes after END/ERROR frame"));
}
let (frame, used) = parse_frame(&buf[off..])?;
off += used;
// stream/sequence rules are header-level; re-derive from the raw
// header so this helper does not depend on enum internals.
let sid = read_u32(&buf[off - used..], 20)?;
let seq = read_u64(&buf[off - used..], 24)?;
match stream_id {
None => stream_id = Some(sid),
Some(s) if s != sid => {
return Err(CodecError::BadOrdering("stream_id changed mid-stream"))
}
_ => {}
}
if seq != expect_seq {
return Err(CodecError::BadOrdering(
"sequence must increase consecutively from 0",
));
}
expect_seq += 1;
if matches!(frame, Frame::End(_) | Frame::Error(_)) {
terminated = true;
}
frames.push(frame);
}
if !terminated {
return Err(CodecError::BadOrdering("stream missing END/ERROR frame"));
}
Ok(frames)
}
fn decode_meta(payload: &[u8]) -> CodecResult<MetaPayload> {
if payload.len() > META_MAX_RAW {
return Err(CodecError::BadLength("META raw payload over 1MiB"));
}
if payload.len() < 4 {
return Err(CodecError::Truncated("META header"));
}
let count = read_u16(payload, 0)? as usize;
if !(1..=META_MAX_PAGES).contains(&count) {
return Err(CodecError::BadLength("META count must be 1..64"));
}
if read_u16(payload, 2)? != 0 {
return Err(CodecError::BadConstant("META reserved"));
}
let mut off = 4usize;
let mut pages = Vec::with_capacity(count);
let mut seen: Vec<[u8; 32]> = Vec::with_capacity(count);
for _ in 0..count {
let mut pid = [0u8; 32];
pid.copy_from_slice(
payload
.get(off..off + 32)
.ok_or(CodecError::Truncated("page_id"))?,
);
off += 32;
let page_len = read_u32(payload, off)? as usize;
off += 4;
if page_len > crate::metapage::PAGE_MAX_BYTES {
return Err(CodecError::BadLength("META page over 16KiB"));
}
let page = payload
.get(off..off + page_len)
.ok_or(CodecError::Truncated("META page bytes"))?
.to_vec();
off += page_len;
if crate::metapage::page_id(&page) != pid {
return Err(CodecError::DigestMismatch("META page_id"));
}
if seen.contains(&pid) {
return Err(CodecError::Duplicate("META page_id"));
}
seen.push(pid);
pages.push((pid, page));
}
if off != payload.len() {
return Err(CodecError::BadLength("trailing bytes in META payload"));
}
Ok(MetaPayload { pages })
}
fn decode_object(payload: &[u8]) -> CodecResult<ObjectPayload> {
if payload.len() > OBJECT_MAX_RAW {
return Err(CodecError::BadLength("OBJECT raw payload over 1MiB"));
}
if payload.len() < 4 {
return Err(CodecError::Truncated("OBJECT header"));
}
let count = read_u16(payload, 0)? as usize;
if !(1..=OBJECT_MAX_COUNT).contains(&count) {
return Err(CodecError::BadLength("OBJECT count must be 1..128"));
}
if read_u16(payload, 2)? != 0 {
return Err(CodecError::BadConstant("OBJECT reserved"));
}
let table_len = count * 40usize;
let data = payload
.get(4 + table_len..)
.ok_or(CodecError::Truncated("OBJECT data area"))?;
let mut objects = Vec::with_capacity(count);
let mut seen: Vec<[u8; 32]> = Vec::with_capacity(count);
let mut expect_off = 0u32;
for i in 0..count {
let t = &payload[4 + i * 40..4 + (i + 1) * 40];
let mut cid = [0u8; 32];
cid.copy_from_slice(&t[0..32]);
let object_len = read_u32(t, 32)?;
let data_offset = read_u32(t, 36)?;
if object_len > OBJECT_MAX_LEN {
return Err(CodecError::BadLength("object over 256KiB"));
}
if data_offset != expect_off {
return Err(CodecError::BadOrdering(
"OBJECT offsets must concatenate exactly (no holes or overlaps)",
));
}
expect_off = expect_off
.checked_add(object_len)
.ok_or(CodecError::Overflow("data end"))?;
if seen.contains(&cid) {
return Err(CodecError::Duplicate("content_id"));
}
seen.push(cid);
let start = data_offset as usize;
let end = start + object_len as usize;
let bytes = data
.get(start..end)
.ok_or(CodecError::Truncated("object data"))?;
// Verify the full content digest.
if sha256(&[bytes]) != cid {
return Err(CodecError::DigestMismatch("object content"));
}
objects.push((cid, bytes.to_vec()));
}
if data.len() != expect_off as usize {
return Err(CodecError::BadLength("OBJECT data area length mismatch"));
}
Ok(ObjectPayload { objects })
}
fn decode_chunk(payload: &[u8], raw_len: u32) -> CodecResult<ChunkPayload> {
if payload.len() < 76 {
return Err(CodecError::Truncated("CHUNK header"));
}
if raw_len as usize != payload.len() {
return Err(CodecError::BadLength("CHUNK raw_len mismatch"));
}
let chunk_len = read_u32(payload, 72)?;
if chunk_len as usize != payload.len() - 76 {
return Err(CodecError::BadLength("CHUNK chunk_len mismatch"));
}
if chunk_len > CHUNK_MAX_LEN {
return Err(CodecError::BadLength("chunk over 1MiB"));
}
let mut map_id = [0u8; 32];
map_id.copy_from_slice(&payload[0..32]);
let mut file_content_id = [0u8; 32];
file_content_id.copy_from_slice(&payload[32..64]);
let chunk_index = read_u64(payload, 64)?;
Ok(ChunkPayload {
map_id,
file_content_id,
chunk_index,
chunk_bytes: payload[76..].to_vec(),
})
}
fn decode_end(payload: &[u8]) -> CodecResult<EndPayload> {
if payload.len() != 48 {
return Err(CodecError::BadLength(
"END payload must be exactly 48 bytes",
));
}
let mut h = [0u8; 32];
h.copy_from_slice(&payload[16..48]);
Ok(EndPayload {
request_item_count: read_u32(payload, 0)?,
unique_unit_count: read_u32(payload, 4)?,
logical_bytes: read_u64(payload, 8)?,
request_body_sha256: h,
})
}
fn decode_error(payload: &[u8]) -> CodecResult<ErrorPayload> {
if payload.len() > ERROR_MAX_BYTES {
return Err(CodecError::BadLength("ERROR payload over 4096 bytes"));
}
let s = std::str::from_utf8(payload).map_err(|_| CodecError::BadConstant("ERROR not UTF-8"))?;
parse_error_json(s)
}
/// Strict closed-schema parser for `{code, retryable, request_id}`.
fn parse_error_json(s: &str) -> CodecResult<ErrorPayload> {
let mut fields: [Option<String>; 3] = [None, None, None];
let mut it = JsonScan::new(s);
it.skip_ws();
if !it.take(b'{') {
return Err(CodecError::BadConstant("ERROR json object expected"));
}
it.skip_ws();
if it.take(b'}') {
return Err(CodecError::BadConstant("ERROR json empty object"));
}
loop {
it.skip_ws();
let key = it.string()?;
it.skip_ws();
if !it.take(b':') {
return Err(CodecError::BadConstant("ERROR json colon expected"));
}
it.skip_ws();
let idx = match key.as_str() {
"code" => 0,
"retryable" => 1,
"request_id" => 2,
_ => return Err(CodecError::BadConstant("ERROR json unknown key")),
};
if fields[idx].is_some() {
return Err(CodecError::Duplicate("ERROR json key"));
}
if idx == 1 {
fields[idx] = Some(it.boolean()?.to_string());
} else {
fields[idx] = Some(it.string()?);
}
it.skip_ws();
if it.take(b'}') {
break;
}
if !it.take(b',') {
return Err(CodecError::BadConstant("ERROR json comma expected"));
}
}
it.skip_ws();
if !it.eof() {
return Err(CodecError::BadConstant("ERROR json trailing data"));
}
let code = fields[0]
.take()
.ok_or(CodecError::BadConstant("ERROR code missing"))?;
let retryable_raw = fields[1]
.take()
.ok_or(CodecError::BadConstant("ERROR retryable missing"))?;
let request_id = fields[2]
.take()
.ok_or(CodecError::BadConstant("ERROR request_id missing"))?;
Ok(ErrorPayload {
code,
retryable: retryable_raw == "true",
request_id,
})
}
/// Minimal strict JSON scanner (strings with escapes, booleans, structure
/// punctuation only — enough for the closed ERROR schema).
struct JsonScan<'a> {
b: &'a [u8],
i: usize,
}
impl<'a> JsonScan<'a> {
fn new(s: &'a str) -> Self {
JsonScan {
b: s.as_bytes(),
i: 0,
}
}
fn eof(&self) -> bool {
self.i >= self.b.len()
}
fn skip_ws(&mut self) {
while self.i < self.b.len() && matches!(self.b[self.i], b' ' | b'\t' | b'\n' | b'\r') {
self.i += 1;
}
}
fn take(&mut self, c: u8) -> bool {
if self.i < self.b.len() && self.b[self.i] == c {
self.i += 1;
true
} else {
false
}
}
fn string(&mut self) -> CodecResult<String> {
if !self.take(b'"') {
return Err(CodecError::BadConstant("json string expected"));
}
let mut out = Vec::new();
loop {
let c = *self
.b
.get(self.i)
.ok_or(CodecError::Truncated("json string"))?;
self.i += 1;
match c {
b'"' => break,
b'\\' => {
let e = *self
.b
.get(self.i)
.ok_or(CodecError::Truncated("json escape"))?;
self.i += 1;
match e {
b'"' => out.push(b'"'),
b'\\' => out.push(b'\\'),
b'/' => out.push(b'/'),
b'b' => out.push(0x08),
b'f' => out.push(0x0C),
b'n' => out.push(b'\n'),
b'r' => out.push(b'\r'),
b't' => out.push(b'\t'),
b'u' => {
if self.i + 4 > self.b.len() {
return Err(CodecError::Truncated("json \\u"));
}
let hex = std::str::from_utf8(&self.b[self.i..self.i + 4])
.map_err(|_| CodecError::BadConstant("json \\u"))?;
let cp = u32::from_str_radix(hex, 16)
.map_err(|_| CodecError::BadConstant("json \\u"))?;
self.i += 4;
let ch = char::from_u32(cp)
.ok_or(CodecError::BadConstant("json \\u codepoint"))?;
let mut buf = [0u8; 4];
out.extend_from_slice(ch.encode_utf8(&mut buf).as_bytes());
}
_ => return Err(CodecError::BadConstant("json escape")),
}
}
0x00..=0x1F => {
return Err(CodecError::BadConstant("raw control char in json string"))
}
_ => out.push(c),
}
}
String::from_utf8(out).map_err(|_| CodecError::BadConstant("json string utf8"))
}
fn boolean(&mut self) -> CodecResult<bool> {
if s(&self.b[self.i..]).starts_with("true") {
self.i += 4;
Ok(true)
} else if s(&self.b[self.i..]).starts_with("false") {
self.i += 5;
Ok(false)
} else {
Err(CodecError::BadConstant("json boolean expected"))
}
}
}
fn s(b: &[u8]) -> &str {
std::str::from_utf8(b).unwrap_or("")
}
// ---------------------------------------------------------------- encoding
fn header(
kind: u8,
flags: u8,
wire_len: u32,
raw_len: u32,
stream_id: u32,
sequence: u64,
payload_sha256: [u8; 32],
) -> Vec<u8> {
let mut out = Vec::with_capacity(HEADER_LEN);
out.extend_from_slice(b"MST2");
crate::write_u16(&mut out, VERSION);
out.push(kind);
out.push(flags);
crate::write_u32(&mut out, HEADER_LEN as u32);
crate::write_u32(&mut out, wire_len);
crate::write_u32(&mut out, raw_len);
crate::write_u32(&mut out, stream_id);
crate::write_u64(&mut out, sequence);
out.extend_from_slice(&payload_sha256);
out
}
fn frame_bytes(kind: u8, payload: &[u8], stream_id: u32, sequence: u64) -> Vec<u8> {
let digest = sha256(&[payload]);
let mut out = header(
kind,
0,
payload.len() as u32,
payload.len() as u32,
stream_id,
sequence,
digest,
);
out.extend_from_slice(payload);
out
}
/// Compress `raw_payload` into one zstd frame (flags `FLAG_ZSTD`).
/// The header digest covers the compressed wire payload, per spec 06.
/// Not for END/ERROR frames — callers reject those.
#[cfg(feature = "zstd")]
fn frame_bytes_zstd(
kind: u8,
raw_payload: &[u8],
stream_id: u32,
sequence: u64,
) -> CodecResult<Vec<u8>> {
let wire = crate::zstd1::compress(raw_payload, 3)?;
let digest = sha256(&[&wire]);
let mut out = header(
kind,
FLAG_ZSTD,
wire.len() as u32,
raw_payload.len() as u32,
stream_id,
sequence,
digest,
);
out.extend_from_slice(&wire);
Ok(out)
}
impl MetaPayload {
pub fn encode(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
if self.pages.is_empty() || self.pages.len() > META_MAX_PAGES {
return Err(CodecError::BadLength("META count must be 1..64"));
}
let mut payload = Vec::new();
crate::write_u16(&mut payload, self.pages.len() as u16);
crate::write_u16(&mut payload, 0);
for (pid, page) in &self.pages {
if crate::metapage::page_id(page) != *pid {
return Err(CodecError::DigestMismatch("META page_id"));
}
payload.extend_from_slice(pid);
crate::write_u32(&mut payload, page.len() as u32);
payload.extend_from_slice(page);
}
if payload.len() > META_MAX_RAW {
return Err(CodecError::BadLength("META raw payload over 1MiB"));
}
Ok(frame_bytes(KIND_META, &payload, stream_id, sequence))
}
#[cfg(feature = "zstd")]
pub fn encode_zstd(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
// Run the identity encode for full validation (count, page_id, size).
self.encode(stream_id, sequence)?;
let payload = self.raw_payload()?;
frame_bytes_zstd(KIND_META, &payload, stream_id, sequence)
}
fn raw_payload(&self) -> CodecResult<Vec<u8>> {
let mut payload = Vec::new();
write_u16(&mut payload, self.pages.len() as u16);
write_u16(&mut payload, 0);
for (pid, page) in &self.pages {
payload.extend_from_slice(pid);
write_u32(&mut payload, page.len() as u32);
payload.extend_from_slice(page);
}
Ok(payload)
}
}
impl ObjectPayload {
pub fn encode(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
if self.objects.is_empty() || self.objects.len() > OBJECT_MAX_COUNT {
return Err(CodecError::BadLength("OBJECT count must be 1..128"));
}
let mut payload = Vec::new();
crate::write_u16(&mut payload, self.objects.len() as u16);
crate::write_u16(&mut payload, 0);
let mut off = 0u32;
for (cid, data) in &self.objects {
if sha256(&[data]) != *cid {
return Err(CodecError::DigestMismatch("object content"));
}
if data.len() as u64 > OBJECT_MAX_LEN as u64 {
return Err(CodecError::BadLength("object over 256KiB"));
}
payload.extend_from_slice(cid);
crate::write_u32(&mut payload, data.len() as u32);
crate::write_u32(&mut payload, off);
off = off
.checked_add(data.len() as u32)
.ok_or(CodecError::Overflow("offset"))?;
}
for (_, data) in &self.objects {
payload.extend_from_slice(data);
}
if payload.len() > OBJECT_MAX_RAW {
return Err(CodecError::BadLength("OBJECT raw payload over 1MiB"));
}
Ok(frame_bytes(KIND_OBJECT, &payload, stream_id, sequence))
}
#[cfg(feature = "zstd")]
pub fn encode_zstd(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
// Run the identity encode for full validation (count, digest, size).
self.encode(stream_id, sequence)?;
let payload = self.raw_payload()?;
frame_bytes_zstd(KIND_OBJECT, &payload, stream_id, sequence)
}
fn raw_payload(&self) -> CodecResult<Vec<u8>> {
let mut payload = Vec::new();
write_u16(&mut payload, self.objects.len() as u16);
write_u16(&mut payload, 0);
let mut off = 0u32;
for (cid, data) in &self.objects {
payload.extend_from_slice(cid);
write_u32(&mut payload, data.len() as u32);
write_u32(&mut payload, off);
off = off
.checked_add(data.len() as u32)
.ok_or(CodecError::Overflow("offset"))?;
}
for (_, data) in &self.objects {
payload.extend_from_slice(data);
}
Ok(payload)
}
}
impl ChunkPayload {
pub fn encode(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
if self.chunk_bytes.len() as u64 > CHUNK_MAX_LEN as u64 {
return Err(CodecError::BadLength("chunk over 1MiB"));
}
let mut payload = Vec::with_capacity(76 + self.chunk_bytes.len());
payload.extend_from_slice(&self.map_id);
payload.extend_from_slice(&self.file_content_id);
crate::write_u64(&mut payload, self.chunk_index);
crate::write_u32(&mut payload, self.chunk_bytes.len() as u32);
payload.extend_from_slice(&self.chunk_bytes);
Ok(frame_bytes(KIND_CHUNK, &payload, stream_id, sequence))
}
#[cfg(feature = "zstd")]
pub fn encode_zstd(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
let payload = self.raw_payload();
frame_bytes_zstd(KIND_CHUNK, &payload, stream_id, sequence)
}
fn raw_payload(&self) -> Vec<u8> {
let mut payload = Vec::with_capacity(76 + self.chunk_bytes.len());
payload.extend_from_slice(&self.map_id);
payload.extend_from_slice(&self.file_content_id);
write_u64(&mut payload, self.chunk_index);
write_u32(&mut payload, self.chunk_bytes.len() as u32);
payload.extend_from_slice(&self.chunk_bytes);
payload
}
}
impl EndPayload {
pub fn encode(&self, stream_id: u32, sequence: u64) -> Vec<u8> {
let mut payload = Vec::with_capacity(48);
crate::write_u32(&mut payload, self.request_item_count);
crate::write_u32(&mut payload, self.unique_unit_count);
crate::write_u64(&mut payload, self.logical_bytes);
payload.extend_from_slice(&self.request_body_sha256);
frame_bytes(KIND_END, &payload, stream_id, sequence)
}
}
impl ErrorPayload {
/// Encode with a canonical (compact) JSON body.
pub fn encode(&self, stream_id: u32, sequence: u64) -> CodecResult<Vec<u8>> {
let mut payload = String::new();
payload.push_str("{\"code\":");
payload.push_str(&json_string(&self.code));
payload.push_str(",\"retryable\":");
payload.push_str(if self.retryable { "true" } else { "false" });
payload.push_str(",\"request_id\":");
payload.push_str(&json_string(&self.request_id));
payload.push('}');
if payload.len() > ERROR_MAX_BYTES {
return Err(CodecError::BadLength("ERROR payload over 4096 bytes"));
}
Ok(frame_bytes(
KIND_ERROR,
payload.as_bytes(),
stream_id,
sequence,
))
}
}
fn json_string(v: &str) -> String {
let mut out = String::with_capacity(v.len() + 2);
out.push('"');
for c in v.chars() {
match c {
'"' => out.push_str("\\\""),
'\\' => out.push_str("\\\\"),
'\n' => out.push_str("\\n"),
'\r' => out.push_str("\\r"),
'\t' => out.push_str("\\t"),
c if (c as u32) < 0x20 => out.push_str(&format!("\\u{:04x}", c as u32)),
c => out.push(c),
}
}
out.push('"');
out
}
#[cfg(test)]
mod tests {
use super::*;
use crate::metapage::{page_id, Entry, EntryKind, Page};
fn sid() -> u32 {
42
}
fn sample_page() -> Vec<u8> {
Page::Leaf {
entries: vec![Entry::file(EntryKind::Regular, b"a", 1, [9; 32])],
}
.encode()
.unwrap()
}
#[test]
fn meta_frame_roundtrip() {
let page = sample_page();
let p = MetaPayload {
pages: vec![(page_id(&page), page)],
};
let bytes = p.encode(sid(), 0).unwrap();
let (frame, used) = parse_frame(&bytes).unwrap();
assert_eq!(used, bytes.len());
assert_eq!(frame, Frame::Meta(p));
}
#[test]
fn object_frame_roundtrip_and_digest() {
let d1 = crate::sha256(&[b"hello"]);
let d2 = crate::sha256(&[b""]);
let p = ObjectPayload {
objects: vec![(d1, b"hello".to_vec()), (d2, vec![])],
};
let bytes = p.encode(sid(), 0).unwrap();
let (frame, _) = parse_frame(&bytes).unwrap();
assert_eq!(frame, Frame::Object(p));
}
#[test]
fn object_digest_mismatch_rejected() {
// Frame digest correct for payload, but object content digest wrong.
let mut payload = Vec::new();
crate::write_u16(&mut payload, 1);
crate::write_u16(&mut payload, 0);
payload.extend_from_slice(&[1; 32]);
crate::write_u32(&mut payload, 5); // object_len
crate::write_u32(&mut payload, 0); // offset
payload.extend_from_slice(b"xxxxx"); // not SHA256([1;32]) content
let bytes = frame_bytes(KIND_OBJECT, &payload, sid(), 0);
assert!(matches!(
parse_frame(&bytes),
Err(CodecError::DigestMismatch(_))
));
}
#[test]
fn chunk_frame_roundtrip() {
let p = ChunkPayload {
map_id: [3; 32],
file_content_id: [4; 32],
chunk_index: 7,
chunk_bytes: vec![0xAB; 1000],
};
let bytes = p.encode(sid(), 3).unwrap();
let (frame, _) = parse_frame(&bytes).unwrap();
assert_eq!(frame, Frame::Chunk(p));
}
#[test]
fn end_frame_exact_48() {
let p = EndPayload {
request_item_count: 2,
unique_unit_count: 2,
logical_bytes: 1024,
request_body_sha256: [5; 32],
};
let bytes = p.encode(sid(), 1);
let (frame, _) = parse_frame(&bytes).unwrap();
assert_eq!(frame, Frame::End(p));
// 49 bytes must be rejected.
let mut payload = Vec::new();
crate::write_u32(&mut payload, 2);
crate::write_u32(&mut payload, 2);
crate::write_u64(&mut payload, 1024);
payload.extend_from_slice(&[5; 32]);
payload.push(0);
let bad = frame_bytes(KIND_END, &payload, sid(), 1);
assert!(parse_frame(&bad).is_err());
}
#[test]
fn error_frame_closed_schema() {
let p = ErrorPayload {
code: "SNAPSHOT_NOT_READY".into(),
retryable: true,
request_id: "req-1".into(),
};
let bytes = p.encode(sid(), 0).unwrap();
let (frame, _) = parse_frame(&bytes).unwrap();
assert_eq!(frame, Frame::Error(p));
// Unknown key must be rejected (closed schema).
let bad = b"{\"code\":\"X\",\"retryable\":false,\"request_id\":\"r\",\"extra\":1}";
assert!(parse_error_json(std::str::from_utf8(bad).unwrap()).is_err());
// Missing key must be rejected.
let bad = b"{\"code\":\"X\",\"retryable\":false}";
assert!(parse_error_json(std::str::from_utf8(bad).unwrap()).is_err());
// Duplicate key must be rejected.
let bad = b"{\"code\":\"X\",\"code\":\"Y\",\"retryable\":false,\"request_id\":\"r\"}";
assert!(parse_error_json(std::str::from_utf8(bad).unwrap()).is_err());
}
#[test]
fn stream_rules() {
let page = sample_page();
let page_len = page.len();
let meta = MetaPayload {
pages: vec![(page_id(&page), page)],
};
let end = EndPayload {
request_item_count: 1,
unique_unit_count: 1,
logical_bytes: page_len as u64,
request_body_sha256: [7; 32],
};
let mut stream = meta.encode(sid(), 0).unwrap();
stream.extend_from_slice(&end.encode(sid(), 1));
let frames = parse_stream(&stream).unwrap();
assert_eq!(frames.len(), 2);
// Wrong sequence: rejected.
let mut bad = meta.encode(sid(), 0).unwrap();
bad.extend_from_slice(&end.encode(sid(), 2));
assert!(parse_stream(&bad).is_err());
// Different stream_id: rejected.
let mut bad = meta.encode(sid(), 0).unwrap();
bad.extend_from_slice(&end.encode(43, 1));
assert!(parse_stream(&bad).is_err());
// Missing END: rejected.
let one = meta.encode(sid(), 0).unwrap();
assert!(parse_stream(&one).is_err());
// Bytes after END: rejected.
let mut bad = stream.clone();
bad.extend_from_slice(&end.encode(sid(), 2));
assert!(parse_stream(&bad).is_err());
}
#[test]
fn header_rules() {
let p = EndPayload {
request_item_count: 0,
unique_unit_count: 0,
logical_bytes: 0,
request_body_sha256: [0; 32],
};
let mut bytes = p.encode(sid(), 0);
bytes[7] = FLAG_ZSTD; // END must not be compressed
assert!(parse_frame(&bytes).is_err());
let mut bytes = p.encode(sid(), 0);
bytes[20..24].copy_from_slice(&0u32.to_le_bytes()); // stream_id = 0
assert!(parse_frame(&bytes).is_err());
let mut bytes = p.encode(sid(), 0);
bytes[8..12].copy_from_slice(&128u32.to_le_bytes()); // header_len != 64
assert!(parse_frame(&bytes).is_err());
let mut bytes = p.encode(sid(), 0);
bytes[6] = 9; // unknown kind
assert!(parse_frame(&bytes).is_err());
// Payload digest mismatch.
let mut bytes = p.encode(sid(), 0);
let n = bytes.len();
bytes[n - 1] ^= 1;
assert!(matches!(
parse_frame(&bytes),
Err(CodecError::DigestMismatch(_))
));
}
}
#[cfg(all(test, feature = "zstd"))]
mod zstd_tests {
use super::*;
fn obj(n: u8, rep: usize) -> ObjectPayload {
// Highly compressible payload so zstd clearly shrinks the wire;
// content_id is the real SHA-256 (encode verifies it).
let data = vec![n; rep];
let cid = sha256(&[&data]);
ObjectPayload {
objects: vec![(cid, data)],
}
}
#[test]
fn zstd_roundtrip_through_parse_stream() {
let raw = obj(0xAB, 100_000);
let encoded = raw.encode_zstd(7, 0).unwrap();
assert!(encoded.len() < 100_000, "compressed frame must be smaller");
// flags byte at offset 7 carries ZSTD; identity parse path must not.
assert_eq!(encoded[7] & FLAG_ZSTD, FLAG_ZSTD);
let end = EndPayload {
request_item_count: 1,
unique_unit_count: 1,
logical_bytes: 100_000,
request_body_sha256: [9u8; 32],
}
.encode(7, 1);
let mut stream = encoded;
stream.extend_from_slice(&end);
let frames = parse_stream(&stream).unwrap();
assert_eq!(frames.len(), 2);
match &frames[0] {