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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
//! The [Append] wrapper consists of a [Blob] and a write buffer, and provides a logical view over
//! the underlying blob which has a page-oriented structure that provides integrity guarantees. The
//! wrapper also provides read caching managed by a page cache.
//!
//! # Recovery
//!
//! On `sync`, this wrapper will durably write buffered data to the underlying blob in pages. All
//! pages have a [Checksum] at the end. If no CRC record existed before for the page being written,
//! then one of the checksums will be all zero. If a checksum already existed for the page being
//! written, then the write will overwrite only the checksum with the lesser length value. Should
//! this write fail, the previously committed page state can still be recovered.
//!
//! During initialization, the wrapper will back up over any page that is not accompanied by a
//! valid CRC, treating it as the result of an incomplete write that may be invalid.
use super::read::{PageReader, Replay};
use crate::{
buffer::{
paged::{CacheRef, Checksum, CHECKSUM_SIZE},
tip::Buffer,
},
Blob, Error, IoBuf, IoBufMut, IoBufs,
};
use bytes::BufMut;
use commonware_cryptography::Crc32;
use commonware_utils::sync::{AsyncRwLock, AsyncRwLockWriteGuard};
use std::{
num::{NonZeroU16, NonZeroUsize},
sync::Arc,
};
use tracing::warn;
/// Indicates which CRC slot in a page record must not be overwritten.
#[derive(Clone, Copy)]
enum ProtectedCrc {
First,
Second,
}
/// Describes the state of the underlying blob with respect to the buffer.
#[derive(Clone)]
struct BlobState<B: Blob> {
blob: B,
/// The page where the next appended byte will be written to.
current_page: u64,
/// The state of the partial page in the blob. If it was written due to a sync call, then this
/// will contain its CRC record.
partial_page_state: Option<Checksum>,
}
/// A [Blob] wrapper that supports write-cached appending of data, with checksums for data integrity
/// and page cache managed caching.
#[derive(Clone)]
pub struct Append<B: Blob> {
/// The underlying blob being wrapped.
blob_state: Arc<AsyncRwLock<BlobState<B>>>,
/// Unique id assigned to this blob by the page cache.
id: u64,
/// A reference to the page cache that manages read caching for this blob.
cache_ref: CacheRef,
/// The write buffer containing any logical bytes following the last full page boundary in the
/// underlying blob.
buffer: Arc<AsyncRwLock<Buffer>>,
}
/// Returns the capacity with a floor applied to ensure it can hold at least one full page of new
/// data even when caching a nearly-full page of already written data.
fn capacity_with_floor(capacity: usize, page_size: u64) -> usize {
let floor = page_size as usize * 2;
if capacity < floor {
warn!(
floor,
"requested buffer capacity is too low, increasing it to floor"
);
floor
} else {
capacity
}
}
impl<B: Blob> Append<B> {
/// Create a new [Append] wrapper of the provided `blob` that is known to have `blob_size`
/// underlying physical bytes, using the provided `cache_ref` for read caching, and a write
/// buffer with capacity `capacity`. Rewinds the blob if necessary to ensure it only contains
/// checksum-validated data.
pub async fn new(
blob: B,
original_blob_size: u64,
capacity: usize,
cache_ref: CacheRef,
) -> Result<Self, Error> {
let (partial_page_state, pages, invalid_data_found) =
Self::read_last_valid_page(&blob, original_blob_size, cache_ref.page_size()).await?;
if invalid_data_found {
// Invalid data was detected, trim it from the blob.
let new_blob_size = pages * (cache_ref.page_size() + CHECKSUM_SIZE);
warn!(
original_blob_size,
new_blob_size, "truncating blob to remove invalid data"
);
blob.resize(new_blob_size).await?;
blob.sync().await?;
}
let capacity = capacity_with_floor(capacity, cache_ref.page_size());
let (blob_state, partial_data) = match partial_page_state {
Some((partial_page, crc_record)) => (
BlobState {
blob,
current_page: pages - 1,
partial_page_state: Some(crc_record),
},
Some(partial_page),
),
None => (
BlobState {
blob,
current_page: pages,
partial_page_state: None,
},
None,
),
};
let buffer = Buffer::from(
blob_state.current_page * cache_ref.page_size(),
partial_data.unwrap_or_default(),
capacity,
cache_ref.pool().clone(),
);
Ok(Self {
blob_state: Arc::new(AsyncRwLock::new(blob_state)),
id: cache_ref.next_id(),
cache_ref,
buffer: Arc::new(AsyncRwLock::new(buffer)),
})
}
/// Scans backwards from the end of the blob, stopping when it finds a valid page.
///
/// # Returns
///
/// A tuple of `(partial_page, page_count, invalid_data_found)`:
///
/// - `partial_page`: If the last valid page is partial (contains fewer than `page_size` logical
/// bytes), returns `Some((data, crc_record))` containing the logical data and its CRC record.
/// Returns `None` if the last valid page is full or if no valid pages exist.
///
/// - `page_count`: The number of pages in the blob up to and including the last valid page
/// found (whether or not it's partial). Note that it's possible earlier pages may be invalid
/// since this function stops scanning when it finds one valid page.
///
/// - `invalid_data_found`: `true` if there are any bytes in the blob that follow the last valid
/// page. Typically the blob should be resized to eliminate them since their integrity cannot
/// be guaranteed.
async fn read_last_valid_page(
blob: &B,
blob_size: u64,
page_size: u64,
) -> Result<(Option<(IoBuf, Checksum)>, u64, bool), Error> {
let physical_page_size = page_size + CHECKSUM_SIZE;
let partial_bytes = blob_size % physical_page_size;
let mut last_page_end = blob_size - partial_bytes;
// If the last physical page in the blob is truncated, it can't have a valid CRC record and
// must be invalid.
let mut invalid_data_found = partial_bytes != 0;
while last_page_end != 0 {
// Read the last page and parse its CRC record.
let page_start = last_page_end - physical_page_size;
let buf = blob
.read_at(page_start, physical_page_size as usize)
.await?
.coalesce()
.freeze();
match Checksum::validate_page(buf.as_ref()) {
Some(crc_record) => {
// Found a valid page.
let (len, _) = crc_record.get_crc();
let len = len as u64;
if len != page_size {
// The page is partial (logical data doesn't fill the page).
let logical_bytes = buf.slice(..len as usize);
return Ok((
Some((logical_bytes, crc_record)),
last_page_end / physical_page_size,
invalid_data_found,
));
}
// The page is full.
return Ok((None, last_page_end / physical_page_size, invalid_data_found));
}
None => {
// The page is invalid.
last_page_end = page_start;
invalid_data_found = true;
}
}
}
// No valid page exists in the blob.
Ok((None, 0, invalid_data_found))
}
/// Append all bytes in `buf` to the tip of the blob.
pub async fn append(&self, buf: &[u8]) -> Result<(), Error> {
let mut buffer = self.buffer.write().await;
if !buffer.append(buf) {
return Ok(());
}
// Buffer is over capacity, so we need to write data to the blob.
self.flush_internal(buffer, false).await
}
/// Flush all full pages from the buffer to disk, resetting the buffer to contain only the bytes
/// in any final partial page. If `write_partial_page` is true, the partial page will be written
/// to the blob as well along with a CRC record.
///
/// # Serialization
///
/// This method reads `partial_page_state` from `blob_state` under a read lock, then later
/// acquires `blob_state` as a write lock to commit the new state. This is safe because the
/// caller always holds the buffer write lock (`buf_guard`), and all paths into `flush_internal`
/// require that lock, so concurrent flushes are impossible.
async fn flush_internal(
&self,
mut buf_guard: AsyncRwLockWriteGuard<'_, Buffer>,
write_partial_page: bool,
) -> Result<(), Error> {
let buffer = &mut *buf_guard;
// Read the old partial page state before doing the heavy work of preparing physical pages.
// This is safe because partial_page_state is only modified by flush_internal, and we hold
// the buffer write lock which prevents concurrent flushes.
let old_partial_page_state = {
let blob_state = self.blob_state.read().await;
blob_state.partial_page_state.clone()
};
// Prepare the *physical* pages corresponding to the data in the buffer.
// Pass the old partial page state so the CRC record is constructed correctly.
let (mut physical_pages, partial_page_state) = self.to_physical_pages(
&*buffer,
write_partial_page,
old_partial_page_state.as_ref(),
);
// If there's nothing to write, return early.
if physical_pages.is_empty() {
return Ok(());
}
// Split buffered bytes into full logical pages to hand off now, leaving any trailing
// partial page in tip for continued buffering.
let logical_page_size = self.cache_ref.page_size() as usize;
let pages_to_cache = buffer.len() / logical_page_size;
let bytes_to_drain = pages_to_cache * logical_page_size;
// Remember the logical start offset and page bytes for caching of flushed full pages.
let cache_pages = if pages_to_cache > 0 {
Some((buffer.offset, buffer.slice(..bytes_to_drain)))
} else {
None
};
// Drain full pages from the buffered logical data. If the tip is fully drained, detach its
// backing so empty append buffers don't retain pooled storage.
if bytes_to_drain == buffer.len() && bytes_to_drain != 0 {
let _ = buffer
.take()
.expect("take must succeed when flush drains all buffered bytes");
} else if bytes_to_drain != 0 {
buffer.drop_prefix(bytes_to_drain);
buffer.offset += bytes_to_drain as u64;
}
let new_offset = buffer.offset;
// Cache full pages before releasing the tip lock so reads don't observe stale persisted
// bytes during the handoff from tip to cache.
if let Some((cache_offset, pages)) = cache_pages {
let remaining = self.cache_ref.cache(self.id, pages.as_ref(), cache_offset);
assert_eq!(remaining, 0, "cached full-page prefix must be page-aligned");
}
// Acquire a write lock on the blob state so nobody tries to read or modify the blob while
// we're writing to it.
let mut blob_state = self.blob_state.write().await;
// Release the buffer lock to allow for concurrent reads & buffered writes while we write
// the physical pages.
drop(buf_guard);
let physical_page_size = logical_page_size + CHECKSUM_SIZE as usize;
let write_at_offset = blob_state.current_page * physical_page_size as u64;
// Identify protected regions based on the OLD partial page state
let protected_regions = Self::identify_protected_regions(old_partial_page_state.as_ref());
// Update state before writing. This may appear to risk data loss if writes fail,
// but write failures are fatal per this codebase's design - callers must not use
// the blob after any mutable method returns an error.
blob_state.current_page += pages_to_cache as u64;
blob_state.partial_page_state = partial_page_state;
// Make sure the buffer offset and underlying blob agree on the state of the tip.
assert_eq!(
blob_state.current_page * self.cache_ref.page_size(),
new_offset
);
// Write the physical pages to the blob.
// If there are protected regions in the first page, we need to write around them.
if let Some((prefix_len, protected_crc)) = protected_regions {
match protected_crc {
ProtectedCrc::First => {
// Protected CRC is first: [page_size..page_size+6]
// Write 1: New data in first page [prefix_len..page_size]
if prefix_len < logical_page_size {
let _ = physical_pages.split_to(prefix_len);
let first_payload = physical_pages.split_to(logical_page_size - prefix_len);
blob_state
.blob
.write_at(write_at_offset + prefix_len as u64, first_payload)
.await?;
} else {
// Skip the protected first page bytes when they are fully covered.
let _ = physical_pages.split_to(logical_page_size);
}
// Write 2: Second CRC of first page + all remaining pages [page_size+6..end]
if physical_pages.len() > 6 {
let _ = physical_pages.split_to(6);
blob_state
.blob
.write_at(
write_at_offset + (logical_page_size + 6) as u64,
physical_pages,
)
.await?;
}
}
ProtectedCrc::Second => {
// Protected CRC is second: [page_size+6..page_size+12]
// Write 1: New data + first CRC of first page [prefix_len..page_size+6]
let first_crc_end = logical_page_size + 6;
if prefix_len < first_crc_end {
let _ = physical_pages.split_to(prefix_len);
let first_payload = physical_pages.split_to(first_crc_end - prefix_len);
blob_state
.blob
.write_at(write_at_offset + prefix_len as u64, first_payload)
.await?;
} else {
// Skip the fully protected first segment when no bytes from it need update.
let _ = physical_pages.split_to(first_crc_end);
}
// Write 2: All remaining pages (if any) [physical_page_size..end]
let skip = physical_page_size - first_crc_end;
if physical_pages.len() > skip {
let _ = physical_pages.split_to(skip);
blob_state
.blob
.write_at(write_at_offset + physical_page_size as u64, physical_pages)
.await?;
}
}
}
} else {
// No protected regions, write everything in one operation
blob_state
.blob
.write_at(write_at_offset, physical_pages)
.await?;
}
Ok(())
}
/// Returns the logical size of the blob. This accounts for both written and buffered data.
pub async fn size(&self) -> u64 {
let buffer = self.buffer.read().await;
buffer.size()
}
/// Returns the logical size of the blob if it can be observed without waiting.
///
/// This is useful for opportunistic fast paths that should fall back rather than contend with
/// concurrent writers.
pub fn try_size(&self) -> Option<u64> {
let buffer = self.buffer.try_read().ok()?;
Some(buffer.size())
}
/// Read into `buf` if it can be done synchronously (e.g. without I/O), returning `false` otherwise.
///
/// Returns `true` only if all `buf.len()` bytes were satisfied. The caller must have
/// already validated that `offset + buf.len()` is within the blob's logical size.
pub fn try_read_sync(&self, offset: u64, buf: &mut [u8]) -> bool {
self.cache_ref.read_cached(self.id, buf, offset) == buf.len()
}
/// Read exactly `len` immutable bytes starting at `offset`.
pub async fn read_at(&self, offset: u64, len: usize) -> Result<IoBufs, Error> {
// Read into a temporary contiguous buffer and copy back to preserve structure.
// SAFETY: read_into below initializes all `len` bytes.
let mut buf = unsafe { self.cache_ref.pool().alloc_len(len) };
self.read_into(buf.as_mut(), offset).await?;
Ok(buf.into())
}
/// Reads up to `buf.len()` bytes starting at `logical_offset`, but only as many as are
/// available.
///
/// This is useful for reading variable-length prefixes (like varints) where you want to read
/// up to a maximum number of bytes but the actual data might be shorter.
///
/// Returns the buffer (truncated to actual bytes read) and the number of bytes read.
/// Returns an error if no bytes are available at the given offset.
pub async fn read_up_to(
&self,
logical_offset: u64,
len: usize,
bufs: impl Into<IoBufMut> + Send,
) -> Result<(IoBufMut, usize), Error> {
let mut bufs = bufs.into();
if len == 0 {
bufs.truncate(0);
return Ok((bufs, 0));
}
let blob_size = self.size().await;
let available = (blob_size.saturating_sub(logical_offset) as usize).min(len);
if available == 0 {
return Err(Error::BlobInsufficientLength);
}
// SAFETY: read_into below fills all `available` bytes.
unsafe { bufs.set_len(available) };
self.read_into(bufs.as_mut(), logical_offset).await?;
Ok((bufs, available))
}
/// Reads bytes starting at `logical_offset` into `buf`.
///
/// This method allows reading directly into a mutable slice without taking ownership of the
/// buffer or requiring a specific buffer type.
pub async fn read_into(&self, buf: &mut [u8], logical_offset: u64) -> Result<(), Error> {
// Ensure the read doesn't overflow.
let end_offset = logical_offset
.checked_add(buf.len() as u64)
.ok_or(Error::OffsetOverflow)?;
// Acquire a read lock on the buffer.
let buffer = self.buffer.read().await;
// If the data required is beyond the size of the blob, return an error.
if end_offset > buffer.size() {
return Err(Error::BlobInsufficientLength);
}
// Extract any bytes from the buffer that overlap with the requested range.
let remaining = if end_offset <= buffer.offset {
// No overlap with tip.
buf.len()
} else {
// Overlap is always a suffix of requested range.
let overlap_start = buffer.offset.max(logical_offset);
let dst_start = (overlap_start - logical_offset) as usize;
let src_start = (overlap_start - buffer.offset) as usize;
let copied = buf.len() - dst_start;
buf[dst_start..].copy_from_slice(&buffer.as_ref()[src_start..src_start + copied]);
dst_start
};
// Release buffer lock before potential I/O.
drop(buffer);
if remaining == 0 {
return Ok(());
}
// Fast path: try to read *only* from page cache without acquiring blob lock. This allows
// concurrent reads even while a flush is in progress.
let cached = self
.cache_ref
.read_cached(self.id, &mut buf[..remaining], logical_offset);
if cached == remaining {
// All bytes found in cache.
return Ok(());
}
// Slow path: cache miss (partial or full), acquire blob read lock to ensure any in-flight
// write completes before we read from the blob.
let blob_guard = self.blob_state.read().await;
// Read remaining bytes that were not already obtained from the earlier cache read.
let uncached_offset = logical_offset + cached as u64;
let uncached_len = remaining - cached;
self.cache_ref
.read(
&blob_guard.blob,
self.id,
&mut buf[cached..cached + uncached_len],
uncached_offset,
)
.await
}
/// Returns the protected region info for a partial page, if any.
///
/// # Returns
///
/// `None` if there's no existing partial page.
///
/// `Some((prefix_len, protected_crc))` where:
/// - `prefix_len`: bytes `[0..prefix_len]` were already written and can be substituted with
/// zeros (skip writing)
/// - `protected_crc`: which CRC slot must not be overwritten
fn identify_protected_regions(
partial_page_state: Option<&Checksum>,
) -> Option<(usize, ProtectedCrc)> {
let crc_record = partial_page_state?;
let (old_len, _) = crc_record.get_crc();
// The protected CRC is the one with the larger (authoritative) length.
let protected_crc = if crc_record.len1 >= crc_record.len2 {
ProtectedCrc::First
} else {
ProtectedCrc::Second
};
Some((old_len as usize, protected_crc))
}
/// Prepare physical-page writes from buffered logical bytes.
///
/// Each physical page contains one logical page plus CRC record. If the last page is not yet
/// full, it will be included only if `include_partial_page` is true.
///
/// # Arguments
///
/// * `buffer` - The buffer containing logical page data
/// * `include_partial_page` - Whether to include a partial page if one exists
/// * `old_crc_record` - The CRC record from a previously committed partial page, if any.
/// When present, the first page's CRC record will preserve the old CRC in its original slot
/// and place the new CRC in the other slot.
fn to_physical_pages(
&self,
buffer: &Buffer,
include_partial_page: bool,
old_crc_record: Option<&Checksum>,
) -> (IoBufs, Option<Checksum>) {
let logical_page_size = self.cache_ref.page_size() as usize;
let physical_page_size = logical_page_size + CHECKSUM_SIZE as usize;
let pages_to_write = buffer.len() / logical_page_size;
let mut write_buffer = IoBufs::default();
let buffer_data = buffer.as_ref();
if pages_to_write > 0 {
let logical_page_size_u16 =
u16::try_from(logical_page_size).expect("page size must fit in u16 for CRC record");
// Build CRC bytes for full pages once. Full-page payload bytes are appended below as
// slices from tip, so we avoid copying logical payload here.
let mut crcs = self
.cache_ref
.pool()
.alloc(CHECKSUM_SIZE as usize * pages_to_write);
for page in 0..pages_to_write {
let start_read_idx = page * logical_page_size;
let end_read_idx = start_read_idx + logical_page_size;
let logical_page = &buffer_data[start_read_idx..end_read_idx];
let crc = Crc32::checksum(logical_page);
// For the first page, if there's an old partial page CRC, construct the record
// to preserve the old CRC in its original slot.
let crc_record = if let (0, Some(old_crc)) = (page, old_crc_record) {
Self::build_crc_record_preserving_old(logical_page_size_u16, crc, old_crc)
} else {
Checksum::new(logical_page_size_u16, crc)
};
crcs.put_slice(&crc_record.to_bytes());
}
let crc_blob = crcs.freeze();
// Physical full-page layout is [logical_page_bytes, crc_record_bytes].
for page in 0..pages_to_write {
let start_read_idx = page * logical_page_size;
let end_read_idx = start_read_idx + logical_page_size;
write_buffer.append(buffer.slice(start_read_idx..end_read_idx));
let crc_start = page * CHECKSUM_SIZE as usize;
write_buffer.append(crc_blob.slice(crc_start..crc_start + CHECKSUM_SIZE as usize));
}
}
if !include_partial_page {
return (write_buffer, None);
}
let partial_page = &buffer_data[pages_to_write * logical_page_size..];
if partial_page.is_empty() {
// No partial page data to write.
return (write_buffer, None);
}
// If there are no full pages and the partial page length matches what was already
// written, there's nothing new to write.
if pages_to_write == 0 {
if let Some(old_crc) = old_crc_record {
let (old_len, _) = old_crc.get_crc();
if partial_page.len() == old_len as usize {
return (write_buffer, None);
}
}
}
let partial_len = partial_page.len();
let crc = Crc32::checksum(partial_page);
// For partial pages: if this is the first page and there's an old CRC, preserve it.
// Otherwise just use the new CRC in slot 0.
let crc_record = if let (0, Some(old_crc)) = (pages_to_write, old_crc_record) {
Self::build_crc_record_preserving_old(partial_len as u16, crc, old_crc)
} else {
Checksum::new(partial_len as u16, crc)
};
// A persisted partial page still occupies one full physical page:
// [partial logical bytes, zero padding, crc record].
let mut padded = self.cache_ref.pool().alloc(physical_page_size);
padded.put_slice(partial_page);
let zero_count = logical_page_size - partial_len;
if zero_count > 0 {
padded.put_bytes(0, zero_count);
}
padded.put_slice(&crc_record.to_bytes());
write_buffer.append(padded.freeze());
// Return the CRC record that matches what we wrote to disk, so that future flushes
// correctly identify which slot is protected.
(write_buffer, Some(crc_record))
}
/// Build a CRC record that preserves the old CRC in its original slot and places
/// the new CRC in the other slot.
const fn build_crc_record_preserving_old(
new_len: u16,
new_crc: u32,
old_crc: &Checksum,
) -> Checksum {
let (old_len, old_crc_val) = old_crc.get_crc();
// The old CRC is in the slot with the larger length value (first slot wins ties).
if old_crc.len1 >= old_crc.len2 {
// Old CRC is in slot 0, put new CRC in slot 1
Checksum {
len1: old_len,
crc1: old_crc_val,
len2: new_len,
crc2: new_crc,
}
} else {
// Old CRC is in slot 1, put new CRC in slot 0
Checksum {
len1: new_len,
crc1: new_crc,
len2: old_len,
crc2: old_crc_val,
}
}
}
/// Flushes any buffered data, then returns a [Replay] for the underlying blob.
///
/// The returned replay can be used to sequentially read all pages from the blob while ensuring
/// all data passes integrity verification. CRCs are validated but not included in the output.
pub async fn replay(&self, buffer_size: NonZeroUsize) -> Result<Replay<B>, Error> {
let logical_page_size = self.cache_ref.page_size();
let logical_page_size_nz =
NonZeroU16::new(logical_page_size as u16).expect("page_size is non-zero");
// Flush any buffered data (without fsync) so the reader sees all written data.
{
let buf_guard = self.buffer.write().await;
self.flush_internal(buf_guard, true).await?;
}
// Convert buffer size (bytes) to page count
let physical_page_size = logical_page_size + CHECKSUM_SIZE;
let prefetch_pages = buffer_size.get() / physical_page_size as usize;
let prefetch_pages = prefetch_pages.max(1); // At least 1 page
let blob_guard = self.blob_state.read().await;
// Compute both physical and logical blob sizes.
let (physical_blob_size, logical_blob_size) =
blob_guard.partial_page_state.as_ref().map_or_else(
|| {
// All pages are full.
let physical = physical_page_size * blob_guard.current_page;
let logical = logical_page_size * blob_guard.current_page;
(physical, logical)
},
|crc_record| {
// There's a partial page with a checksum.
let (partial_len, _) = crc_record.get_crc();
let partial_len = partial_len as u64;
// Physical: all pages including the partial one (which is padded to full size).
let physical = physical_page_size * (blob_guard.current_page + 1);
// Logical: full pages before this + partial page's actual data length.
let logical = logical_page_size * blob_guard.current_page + partial_len;
(physical, logical)
},
);
let reader = PageReader::new(
blob_guard.blob.clone(),
physical_blob_size,
logical_blob_size,
prefetch_pages,
logical_page_size_nz,
);
Ok(Replay::new(reader))
}
}
impl<B: Blob> Append<B> {
pub async fn sync(&self) -> Result<(), Error> {
// Flush any buffered data, including any partial page. When flush_internal returns,
// write_at has completed and data has been written to the underlying blob.
let buf_guard = self.buffer.write().await;
self.flush_internal(buf_guard, true).await?;
// Sync the underlying blob. We need the blob read lock here since sync() requires access
// to the blob, but only a read lock since we're not modifying blob state.
let blob_state = self.blob_state.read().await;
blob_state.blob.sync().await
}
/// Resize the blob to the provided logical `size`.
///
/// This truncates the blob to contain only `size` logical bytes. The physical blob size will
/// be adjusted to include the necessary CRC records for the remaining pages.
///
/// # Warning
///
/// - Concurrent mutable operations (append, resize) are not supported and will cause data loss.
/// - Concurrent readers which try to read past the new size during the resize may error.
/// - The resize is not guaranteed durable until the next sync.
pub async fn resize(&self, size: u64) -> Result<(), Error> {
let current_size = self.size().await;
// Handle growing by appending zero bytes.
if size > current_size {
let zeros_needed = (size - current_size) as usize;
let mut zeros = self.cache_ref.pool().alloc(zeros_needed);
zeros.put_bytes(0, zeros_needed);
self.append(zeros.as_ref()).await?;
return Ok(());
}
// Implementation note: rewinding the blob across a page boundary potentially results in
// stale data remaining in the page cache. We don't proactively purge the data
// within this function since it would be inaccessible anyway. Instead we ensure it is
// always updated should the blob grow back to the point where we have new data for the same
// page, if any old data hasn't expired naturally by then.
let logical_page_size = self.cache_ref.page_size();
let physical_page_size = logical_page_size + CHECKSUM_SIZE;
// Flush any buffered data first to ensure we have a consistent state on disk.
self.sync().await?;
// Acquire both locks to prevent concurrent operations.
let mut buf_guard = self.buffer.write().await;
let mut blob_guard = self.blob_state.write().await;
// Calculate the physical size needed for the new logical size.
let full_pages = size / logical_page_size;
let partial_bytes = size % logical_page_size;
let new_physical_size = if partial_bytes > 0 {
// We need full_pages + 1 physical pages to hold the partial data.
// The partial page will be padded to full physical page size.
(full_pages + 1) * physical_page_size
} else {
// No partial page needed.
full_pages * physical_page_size
};
// Resize the underlying blob.
blob_guard.blob.resize(new_physical_size).await?;
blob_guard.partial_page_state = None;
// Update blob state and buffer based on the desired logical size. The partial page data is
// read with CRC validation; the validated length may exceed partial_bytes (reflecting the
// old data length), but we only load the prefix we need. The next sync will write the
// correct CRC for the new length.
//
// Note: This updates state before validation completes, which could leave state
// inconsistent if validation fails. This is acceptable because failures from mutable
// methods are fatal - callers must not use the blob after any error.
blob_guard.current_page = full_pages;
buf_guard.offset = full_pages * logical_page_size;
if partial_bytes > 0 {
// There's a partial page. Read its data from disk with CRC validation.
let page_data =
super::get_page_from_blob(&blob_guard.blob, full_pages, logical_page_size).await?;
// Ensure the validated data covers what we need.
if (page_data.len() as u64) < partial_bytes {
return Err(Error::InvalidChecksum);
}
buf_guard.clear();
let over_capacity = buf_guard.append(&page_data.as_ref()[..partial_bytes as usize]);
assert!(!over_capacity);
} else {
// No partial page - all pages are full or blob is empty.
buf_guard.clear();
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{deterministic, BufferPool, BufferPoolConfig, Runner as _, Storage as _};
use commonware_codec::ReadExt;
use commonware_macros::test_traced;
use commonware_utils::{NZUsize, NZU16};
use prometheus_client::registry::Registry;
use std::num::NonZeroU16;
const PAGE_SIZE: NonZeroU16 = NZU16!(103); // janky size to ensure we test page alignment
const BUFFER_SIZE: usize = PAGE_SIZE.get() as usize * 2;
#[test_traced("DEBUG")]
fn test_append_crc_empty() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
// Open a new blob.
let (blob, blob_size) = context.open("test_partition", b"test_blob").await.unwrap();
assert_eq!(blob_size, 0);
// Create a page cache reference.
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
// Create an Append wrapper.
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Verify initial size is 0.
assert_eq!(append.size().await, 0);
// Close & re-open.
append.sync().await.unwrap();
drop(append);
let (blob, blob_size) = context.open("test_partition", b"test_blob").await.unwrap();
assert_eq!(blob_size, 0); // There was no need to write a crc since there was no data.
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 0);
});
}
#[test_traced("DEBUG")]
fn test_append_crc_basic() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
// Open a new blob.
let (blob, blob_size) = context.open("test_partition", b"test_blob").await.unwrap();
assert_eq!(blob_size, 0);
// Create a page cache reference.
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
// Create an Append wrapper.
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Verify initial size is 0.
assert_eq!(append.size().await, 0);
// Append some bytes.
let data = vec![1, 2, 3, 4, 5];
append.append(&data).await.unwrap();
// Verify size reflects appended data.
assert_eq!(append.size().await, 5);
// Append more bytes.
let more_data = vec![6, 7, 8, 9, 10];
append.append(&more_data).await.unwrap();
// Verify size is cumulative.
assert_eq!(append.size().await, 10);
// Read back the first chunk and verify.
let read_buf = append.read_at(0, 5).await.unwrap().coalesce();
assert_eq!(read_buf, &data[..]);
// Read back the second chunk and verify.
let read_buf = append.read_at(5, 5).await.unwrap().coalesce();
assert_eq!(read_buf, &more_data[..]);
// Read all data at once and verify.
let read_buf = append.read_at(0, 10).await.unwrap().coalesce();
assert_eq!(read_buf, &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
// Close and reopen the blob and make sure the data is still there and the trailing
// checksum is written & stripped as expected.
append.sync().await.unwrap();
drop(append);
let (blob, blob_size) = context.open("test_partition", b"test_blob").await.unwrap();
// Physical page = 103 logical + 12 Checksum = 115 bytes (padded partial page)
assert_eq!(blob_size, 115);
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 10); // CRC should be stripped after verification
// Append data that spans a page boundary.
// PAGE_SIZE=103 is the logical page size. We have 10 bytes, so writing
// 100 more bytes (total 110) will cross the page boundary at byte 103.
let spanning_data: Vec<u8> = (11..=110).collect();
append.append(&spanning_data).await.unwrap();
assert_eq!(append.size().await, 110);
// Read back data that spans the page boundary.
let read_buf = append.read_at(10, 100).await.unwrap().coalesce();
assert_eq!(read_buf, &spanning_data[..]);
// Read all 110 bytes at once.
let read_buf = append.read_at(0, 110).await.unwrap().coalesce();
let expected: Vec<u8> = (1..=110).collect();
assert_eq!(read_buf, &expected[..]);
// Drop and re-open and make sure bytes are still there.
append.sync().await.unwrap();
drop(append);
let (blob, blob_size) = context.open("test_partition", b"test_blob").await.unwrap();
// 2 physical pages: 2 * 115 = 230 bytes
assert_eq!(blob_size, 230);
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 110);
// Append data to reach exactly a page boundary.
// Logical page size is 103. We have 110 bytes, next boundary is 206 (103 * 2).
// So we need 96 more bytes.
let boundary_data: Vec<u8> = (111..=206).collect();
assert_eq!(boundary_data.len(), 96);
append.append(&boundary_data).await.unwrap();
assert_eq!(append.size().await, 206);
// Verify we can read it back.
let read_buf = append.read_at(0, 206).await.unwrap().coalesce();
let expected: Vec<u8> = (1..=206).collect();
assert_eq!(read_buf, &expected[..]);
// Drop and re-open at the page boundary.
append.sync().await.unwrap();
drop(append);
let (blob, blob_size) = context.open("test_partition", b"test_blob").await.unwrap();
// Physical size should be exactly 2 pages: 115 * 2 = 230 bytes
assert_eq!(blob_size, 230);
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref)
.await
.unwrap();
assert_eq!(append.size().await, 206);
// Verify data is still readable after reopen.
let read_buf = append.read_at(0, 206).await.unwrap().coalesce();
assert_eq!(read_buf, &expected[..]);
});
}
#[test_traced("DEBUG")]
fn test_sync_releases_tip_pool_slot_after_full_drain() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let mut registry = Registry::default();
let pool = BufferPool::new(
BufferPoolConfig::for_storage()
.with_pool_min_size(PAGE_SIZE.get() as usize)
.with_max_per_class(NZUsize!(2)),
&mut registry,
);
let cache_ref = CacheRef::new(pool.clone(), PAGE_SIZE, NZUsize!(1));
let (blob, blob_size) = context
.open("test_partition", b"release_tip_backing")
.await
.unwrap();
assert_eq!(blob_size, 0);
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref)
.await
.unwrap();
append
.append(&vec![7; PAGE_SIZE.get() as usize])
.await
.unwrap();
// One pooled slot backs the page cache and one backs the mutable tip.
assert!(
matches!(
pool.try_alloc(BUFFER_SIZE),
Err(crate::iobuf::PoolError::Exhausted)
),
"full-page tip should occupy the remaining pooled slot before sync"
);
append.sync().await.unwrap();
// After a full drain, the tip should no longer pin that slot.
assert!(
pool.try_alloc(BUFFER_SIZE).is_ok(),
"sync should release pooled backing when no partial tail remains"
);
});
}
#[test_traced("DEBUG")]
fn test_read_up_to_zero_len_truncates_buffer() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
// Open a new blob.
let (blob, blob_size) = context
.open("test_partition", b"read_up_to_zero_len")
.await
.unwrap();
assert_eq!(blob_size, 0);
// Create a page cache reference.
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
// Create an Append wrapper and write some data.
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref)
.await
.unwrap();
append.append(&[1, 2, 3, 4]).await.unwrap();
// Request a zero-length read with a reused, non-empty buffer.
let stale = vec![9, 8, 7, 6];
let (buf, read) = append.read_up_to(0, 0, stale).await.unwrap();
assert_eq!(read, 0);
assert_eq!(buf.len(), 0, "read_up_to must truncate returned buffer");
assert_eq!(buf.freeze().as_ref(), b"");
});
}
/// Helper to read the CRC record from raw blob bytes at the end of a physical page.
fn read_crc_record_from_page(page_bytes: &[u8]) -> Checksum {
let crc_start = page_bytes.len() - CHECKSUM_SIZE as usize;
Checksum::read(&mut &page_bytes[crc_start..]).unwrap()
}
/// Dummy marker bytes with len=0 so the mangled slot is never authoritative.
/// Format: [len_hi=0, len_lo=0, 0xDE, 0xAD, 0xBE, 0xEF]
const DUMMY_MARKER: [u8; 6] = [0x00, 0x00, 0xDE, 0xAD, 0xBE, 0xEF];
#[test]
fn test_identify_protected_regions_equal_lengths() {
// When lengths are equal, the first CRC should be protected (tie-breaking rule).
let record = Checksum {
len1: 50,
crc1: 0xAAAAAAAA,
len2: 50,
crc2: 0xBBBBBBBB,
};
let result =
Append::<crate::storage::memory::Blob>::identify_protected_regions(Some(&record));
assert!(result.is_some());
let (prefix_len, protected_crc) = result.unwrap();
assert_eq!(prefix_len, 50);
assert!(
matches!(protected_crc, ProtectedCrc::First),
"First CRC should be protected when lengths are equal"
);
}
#[test]
fn test_identify_protected_regions_len1_larger() {
// When len1 > len2, the first CRC should be protected.
let record = Checksum {
len1: 100,
crc1: 0xAAAAAAAA,
len2: 50,
crc2: 0xBBBBBBBB,
};
let result =
Append::<crate::storage::memory::Blob>::identify_protected_regions(Some(&record));
assert!(result.is_some());
let (prefix_len, protected_crc) = result.unwrap();
assert_eq!(prefix_len, 100);
assert!(
matches!(protected_crc, ProtectedCrc::First),
"First CRC should be protected when len1 > len2"
);
}
#[test]
fn test_identify_protected_regions_len2_larger() {
// When len2 > len1, the second CRC should be protected.
let record = Checksum {
len1: 50,
crc1: 0xAAAAAAAA,
len2: 100,
crc2: 0xBBBBBBBB,
};
let result =
Append::<crate::storage::memory::Blob>::identify_protected_regions(Some(&record));
assert!(result.is_some());
let (prefix_len, protected_crc) = result.unwrap();
assert_eq!(prefix_len, 100);
assert!(
matches!(protected_crc, ProtectedCrc::Second),
"Second CRC should be protected when len2 > len1"
);
}
/// Test that `to_physical_pages` emits full pages zero-copy while still materializing the
/// trailing partial page into one padded physical page.
#[test_traced("DEBUG")]
fn test_to_physical_pages_zero_copy_full_pages_and_materialized_partial() {
// Build a tip buffer containing two full logical pages plus a trailing partial
// page, convert it with `to_physical_pages`, then verify:
// - the result is chunked rather than one contiguous buffer for the full-page portion
// - the logical payload bytes for the first two pages are preserved in order
// - the partial page is padded with zeros up to one full logical page
// - all three resulting physical pages validate their CRC records
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
// Open a new blob.
let (blob, blob_size) = context
.open("test_partition", b"to_physical_pages_zero_copy")
.await
.unwrap();
assert_eq!(blob_size, 0);
// Create a page cache reference.
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
// Create an Append wrapper.
let append = Append::new(blob, blob_size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Build logical data with exactly two full pages followed by one trailing partial page.
// This lets us verify that only the partial page is materialized.
let logical_page_size = PAGE_SIZE.get() as usize;
let partial_len = 17usize;
let data: Vec<u8> = (0..(logical_page_size * 2 + partial_len))
.map(|i| (i % 251) as u8)
.collect();
// Seed a tip buffer with the logical bytes exactly as flush_internal would see them.
let mut buffer = Buffer::new(0, data.len(), cache_ref.pool().clone());
let over_capacity = buffer.append(&data);
assert!(!over_capacity);
// Convert buffered logical bytes into physical-page writes.
let (physical_pages, partial_page_state) =
append.to_physical_pages(&buffer, true, None);
// Two full pages should each contribute a logical slice and a CRC slice, and the
// trailing partial page should contribute one materialized padded physical page.
assert_eq!(physical_pages.chunk_count(), 5);
// The returned partial-page CRC state must describe the exact trailing logical length.
let crc_record = partial_page_state.expect("partial page state must be returned");
let (len, _) = crc_record.get_crc();
assert_eq!(len as usize, partial_len);
// Coalesce for easier content inspection. The assembled bytes should still form three
// full physical pages on disk.
let physical_page_size = logical_page_size + CHECKSUM_SIZE as usize;
let coalesced = physical_pages.coalesce();
assert_eq!(coalesced.len(), physical_page_size * 3);
// The first two physical pages must preserve the two full logical pages verbatim.
assert_eq!(
&coalesced.as_ref()[..logical_page_size],
&data[..logical_page_size]
);
assert_eq!(
&coalesced.as_ref()[physical_page_size..physical_page_size + logical_page_size],
&data[logical_page_size..logical_page_size * 2],
);
// The trailing partial page must contain the remaining logical bytes followed by zero
// padding up to one full logical page.
let partial_start = physical_page_size * 2;
assert_eq!(
&coalesced.as_ref()[partial_start..partial_start + partial_len],
&data[logical_page_size * 2..],
);
assert!(coalesced.as_ref()
[partial_start + partial_len..partial_start + logical_page_size]
.iter()
.all(|byte| *byte == 0));
// Each assembled physical page must carry a valid CRC record.
assert!(Checksum::validate_page(&coalesced.as_ref()[..physical_page_size]).is_some());
assert!(Checksum::validate_page(
&coalesced.as_ref()[physical_page_size..physical_page_size * 2]
)
.is_some());
assert!(Checksum::validate_page(
&coalesced.as_ref()[physical_page_size * 2..physical_page_size * 3]
)
.is_some());
});
}
/// Test that slot 1 is NOT overwritten when it's the protected slot.
///
/// Strategy: After extending twice (so slot 1 becomes authoritative with larger len),
/// mangle the non-authoritative slot 0. Then extend again - slot 0 should be overwritten
/// with the new CRC, while slot 1 (protected) should remain untouched.
#[test_traced("DEBUG")]
fn test_crc_slot1_protected() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
let slot0_offset = PAGE_SIZE.get() as u64;
let slot1_offset = PAGE_SIZE.get() as u64 + 6;
// === Step 1: Write 10 bytes → slot 0 authoritative (len=10) ===
let (blob, _) = context.open("test_partition", b"slot1_prot").await.unwrap();
let append = Append::new(blob, 0, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append.append(&(1..=10).collect::<Vec<u8>>()).await.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 2: Extend to 30 bytes → slot 1 authoritative (len=30) ===
let (blob, size) = context.open("test_partition", b"slot1_prot").await.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(11..=30).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// Verify slot 1 is now authoritative
let (blob, size) = context.open("test_partition", b"slot1_prot").await.unwrap();
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert!(
crc.len2 > crc.len1,
"Slot 1 should be authoritative (len2={} > len1={})",
crc.len2,
crc.len1
);
// Capture slot 1 bytes before mangling slot 0
let slot1_before: Vec<u8> = blob
.read_at(slot1_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
// === Step 3: Mangle slot 0 (non-authoritative) ===
blob.write_at(slot0_offset, DUMMY_MARKER.to_vec())
.await
.unwrap();
blob.sync().await.unwrap();
// Verify mangle worked
let slot0_mangled: Vec<u8> = blob
.read_at(slot0_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(slot0_mangled, DUMMY_MARKER, "Mangle failed");
// === Step 4: Extend to 50 bytes → new CRC goes to slot 0, slot 1 protected ===
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(31..=50).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 5: Verify slot 0 was overwritten, slot 1 unchanged ===
let (blob, _) = context.open("test_partition", b"slot1_prot").await.unwrap();
// Slot 0 should have new CRC (not our dummy marker)
let slot0_after: Vec<u8> = blob
.read_at(slot0_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_ne!(
slot0_after, DUMMY_MARKER,
"Slot 0 should have been overwritten with new CRC"
);
// Slot 1 should be UNCHANGED (protected)
let slot1_after: Vec<u8> = blob
.read_at(slot1_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(
slot1_before, slot1_after,
"Slot 1 was modified! Protected region violated."
);
// Verify the new CRC in slot 0 has len=50
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert_eq!(crc.len1, 50, "Slot 0 should have len=50");
});
}
/// Test that slot 0 is NOT overwritten when it's the protected slot.
///
/// Strategy: After extending three times (slot 0 becomes authoritative again with largest len),
/// mangle the non-authoritative slot 1. Then extend again - slot 1 should be overwritten
/// with the new CRC, while slot 0 (protected) should remain untouched.
#[test_traced("DEBUG")]
fn test_crc_slot0_protected() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
let slot0_offset = PAGE_SIZE.get() as u64;
let slot1_offset = PAGE_SIZE.get() as u64 + 6;
// === Step 1: Write 10 bytes → slot 0 authoritative (len=10) ===
let (blob, _) = context.open("test_partition", b"slot0_prot").await.unwrap();
let append = Append::new(blob, 0, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append.append(&(1..=10).collect::<Vec<u8>>()).await.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 2: Extend to 30 bytes → slot 1 authoritative (len=30) ===
let (blob, size) = context.open("test_partition", b"slot0_prot").await.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(11..=30).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 3: Extend to 50 bytes → slot 0 authoritative (len=50) ===
let (blob, size) = context.open("test_partition", b"slot0_prot").await.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(31..=50).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// Verify slot 0 is now authoritative
let (blob, size) = context.open("test_partition", b"slot0_prot").await.unwrap();
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert!(
crc.len1 > crc.len2,
"Slot 0 should be authoritative (len1={} > len2={})",
crc.len1,
crc.len2
);
// Capture slot 0 bytes before mangling slot 1
let slot0_before: Vec<u8> = blob
.read_at(slot0_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
// === Step 4: Mangle slot 1 (non-authoritative) ===
blob.write_at(slot1_offset, DUMMY_MARKER.to_vec())
.await
.unwrap();
blob.sync().await.unwrap();
// Verify mangle worked
let slot1_mangled: Vec<u8> = blob
.read_at(slot1_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(slot1_mangled, DUMMY_MARKER, "Mangle failed");
// === Step 5: Extend to 70 bytes → new CRC goes to slot 1, slot 0 protected ===
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(51..=70).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 6: Verify slot 1 was overwritten, slot 0 unchanged ===
let (blob, _) = context.open("test_partition", b"slot0_prot").await.unwrap();
// Slot 1 should have new CRC (not our dummy marker)
let slot1_after: Vec<u8> = blob
.read_at(slot1_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_ne!(
slot1_after, DUMMY_MARKER,
"Slot 1 should have been overwritten with new CRC"
);
// Slot 0 should be UNCHANGED (protected)
let slot0_after: Vec<u8> = blob
.read_at(slot0_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(
slot0_before, slot0_after,
"Slot 0 was modified! Protected region violated."
);
// Verify the new CRC in slot 1 has len=70
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert_eq!(crc.len2, 70, "Slot 1 should have len=70");
});
}
/// Test that the data prefix is NOT overwritten when extending a partial page.
///
/// Strategy: Write data, then mangle the padding area (between data end and CRC start).
/// After extending, the original data should be unchanged but the mangled padding
/// should be overwritten with new data.
#[test_traced("DEBUG")]
fn test_data_prefix_not_overwritten() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
// === Step 1: Write 20 bytes ===
let (blob, _) = context
.open("test_partition", b"prefix_test")
.await
.unwrap();
let append = Append::new(blob, 0, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
let data1: Vec<u8> = (1..=20).collect();
append.append(&data1).await.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 2: Capture the first 20 bytes and mangle bytes 25-30 (in padding area) ===
let (blob, size) = context
.open("test_partition", b"prefix_test")
.await
.unwrap();
assert_eq!(size, physical_page_size as u64);
let prefix_before: Vec<u8> = blob
.read_at(0, 20)
.await
.unwrap()
.coalesce()
.freeze()
.into();
// Mangle bytes 25-30 (safely in the padding area, after our 20 bytes of data)
blob.write_at(25, DUMMY_MARKER.to_vec()).await.unwrap();
blob.sync().await.unwrap();
// === Step 3: Extend to 40 bytes ===
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(21..=40).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 4: Verify prefix unchanged, mangled area overwritten ===
let (blob, _) = context
.open("test_partition", b"prefix_test")
.await
.unwrap();
// Original 20 bytes should be unchanged
let prefix_after: Vec<u8> = blob
.read_at(0, 20)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(prefix_before, prefix_after, "Data prefix was modified!");
// Bytes at offset 25-30: data (21..=40) starts at offset 20, so offset 25 has value 26
let overwritten: Vec<u8> = blob
.read_at(25, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(
overwritten,
vec![26, 27, 28, 29, 30, 31],
"New data should overwrite padding area"
);
});
}
/// Test CRC slot protection when extending past a page boundary.
///
/// Strategy: Write partial page, mangle slot 0 (non-authoritative after we do first extend),
/// then extend past page boundary. Verify slot 0 gets new full-page CRC while
/// the mangled marker is overwritten, and second page is written correctly.
#[test_traced("DEBUG")]
fn test_crc_slot_protection_across_page_boundary() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
let slot0_offset = PAGE_SIZE.get() as u64;
let slot1_offset = PAGE_SIZE.get() as u64 + 6;
// === Step 1: Write 50 bytes → slot 0 authoritative ===
let (blob, _) = context.open("test_partition", b"boundary").await.unwrap();
let append = Append::new(blob, 0, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append.append(&(1..=50).collect::<Vec<u8>>()).await.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 2: Extend to 80 bytes → slot 1 authoritative ===
let (blob, size) = context.open("test_partition", b"boundary").await.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(51..=80).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// Verify slot 1 is authoritative
let (blob, size) = context.open("test_partition", b"boundary").await.unwrap();
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert!(crc.len2 > crc.len1, "Slot 1 should be authoritative");
// Capture slot 1 before extending past page boundary
let slot1_before: Vec<u8> = blob
.read_at(slot1_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
// Mangle slot 0 (non-authoritative)
blob.write_at(slot0_offset, DUMMY_MARKER.to_vec())
.await
.unwrap();
blob.sync().await.unwrap();
// === Step 3: Extend past page boundary (80 + 40 = 120, PAGE_SIZE=103) ===
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(81..=120).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 4: Verify results ===
let (blob, size) = context.open("test_partition", b"boundary").await.unwrap();
assert_eq!(size, (physical_page_size * 2) as u64, "Should have 2 pages");
// Slot 0 should have been overwritten with full-page CRC (not dummy marker)
let slot0_after: Vec<u8> = blob
.read_at(slot0_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_ne!(
slot0_after, DUMMY_MARKER,
"Slot 0 should have full-page CRC"
);
// Slot 1 should be UNCHANGED (protected during boundary crossing)
let slot1_after: Vec<u8> = blob
.read_at(slot1_offset, 6)
.await
.unwrap()
.coalesce()
.freeze()
.into();
assert_eq!(
slot1_before, slot1_after,
"Slot 1 was modified during page boundary crossing!"
);
// Verify page 0 has correct CRC structure
let page0 = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc0 = read_crc_record_from_page(page0.as_ref());
assert_eq!(
crc0.len1,
PAGE_SIZE.get(),
"Slot 0 should have full page length"
);
// Verify data integrity
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 120);
let all_data: Vec<u8> = append.read_at(0, 120).await.unwrap().coalesce().into();
let expected: Vec<u8> = (1..=120).collect();
assert_eq!(all_data, expected);
});
}
/// Test that corrupting the primary CRC (but not its length) causes fallback to the previous
/// partial page contents.
///
/// Strategy:
/// 1. Write 10 bytes → slot 0 authoritative (len=10, valid crc)
/// 2. Extend to 30 bytes → slot 1 authoritative (len=30, valid crc)
/// 3. Corrupt ONLY the crc2 value in slot 1 (not the length)
/// 4. Re-open and verify we fall back to slot 0's 10 bytes
#[test_traced("DEBUG")]
fn test_crc_fallback_on_corrupted_primary() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
// crc2 is at offset: PAGE_SIZE + 6 (for len2) + 2 (skip len2 bytes) = PAGE_SIZE + 8
let crc2_offset = PAGE_SIZE.get() as u64 + 8;
// === Step 1: Write 10 bytes → slot 0 authoritative (len=10) ===
let (blob, _) = context
.open("test_partition", b"crc_fallback")
.await
.unwrap();
let append = Append::new(blob, 0, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
let data1: Vec<u8> = (1..=10).collect();
append.append(&data1).await.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 2: Extend to 30 bytes → slot 1 authoritative (len=30) ===
let (blob, size) = context
.open("test_partition", b"crc_fallback")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append
.append(&(11..=30).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// Verify slot 1 is now authoritative and data reads correctly
let (blob, size) = context
.open("test_partition", b"crc_fallback")
.await
.unwrap();
assert_eq!(size, physical_page_size as u64);
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert!(
crc.len2 > crc.len1,
"Slot 1 should be authoritative (len2={} > len1={})",
crc.len2,
crc.len1
);
assert_eq!(crc.len2, 30, "Slot 1 should have len=30");
assert_eq!(crc.len1, 10, "Slot 0 should have len=10");
// Verify we can read all 30 bytes before corruption
let append = Append::new(blob.clone(), size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 30);
let all_data: Vec<u8> = append.read_at(0, 30).await.unwrap().coalesce().into();
let expected: Vec<u8> = (1..=30).collect();
assert_eq!(all_data, expected);
drop(append);
// === Step 3: Corrupt ONLY crc2 (not len2) ===
// crc2 is 4 bytes at offset PAGE_SIZE + 8
blob.write_at(crc2_offset, vec![0xDE, 0xAD, 0xBE, 0xEF])
.await
.unwrap();
blob.sync().await.unwrap();
// Verify corruption: len2 should still be 30, but crc2 is now garbage
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert_eq!(crc.len2, 30, "len2 should still be 30 after corruption");
assert_eq!(crc.crc2, 0xDEADBEEF, "crc2 should be our corrupted value");
// === Step 4: Re-open and verify fallback to slot 0's 10 bytes ===
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Should fall back to 10 bytes (slot 0's length)
assert_eq!(
append.size().await,
10,
"Should fall back to slot 0's 10 bytes after primary CRC corruption"
);
// Verify the data is the original 10 bytes
let fallback_data: Vec<u8> = append.read_at(0, 10).await.unwrap().coalesce().into();
assert_eq!(
fallback_data, data1,
"Fallback data should match original 10 bytes"
);
// Reading beyond 10 bytes should fail
let result = append.read_at(0, 11).await;
assert!(result.is_err(), "Reading beyond fallback size should fail");
});
}
/// Test that corrupting a non-last page's primary CRC fails even if fallback is valid.
///
/// Non-last pages must always be full. If the primary CRC is corrupted and the fallback
/// indicates a partial page, validation should fail entirely (not fall back to partial).
///
/// Strategy:
/// 1. Write 10 bytes → slot 0 has len=10 (partial)
/// 2. Extend to full page (103 bytes) → slot 1 has len=103 (full, authoritative)
/// 3. Extend past page boundary (e.g., 110 bytes) → page 0 is now non-last
/// 4. Corrupt the primary CRC of page 0 (slot 1's crc, which has len=103)
/// 5. Re-open and verify that reading from page 0 fails (fallback has len=10, not full)
#[test_traced("DEBUG")]
fn test_non_last_page_rejects_partial_fallback() {
let executor = deterministic::Runner::default();
executor.start(|context: deterministic::Context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
// crc2 for page 0 is at offset: PAGE_SIZE + 8
let page0_crc2_offset = PAGE_SIZE.get() as u64 + 8;
// === Step 1: Write 10 bytes → slot 0 has len=10 ===
let (blob, _) = context
.open("test_partition", b"non_last_page")
.await
.unwrap();
let append = Append::new(blob, 0, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append.append(&(1..=10).collect::<Vec<u8>>()).await.unwrap();
append.sync().await.unwrap();
drop(append);
// === Step 2: Extend to exactly full page (103 bytes) → slot 1 has len=103 ===
let (blob, size) = context
.open("test_partition", b"non_last_page")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Add bytes 11 through 103 (93 more bytes)
append
.append(&(11..=PAGE_SIZE.get() as u8).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// Verify page 0 slot 1 is authoritative with len=103 (full page)
let (blob, size) = context
.open("test_partition", b"non_last_page")
.await
.unwrap();
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert_eq!(crc.len1, 10, "Slot 0 should have len=10");
assert_eq!(
crc.len2,
PAGE_SIZE.get(),
"Slot 1 should have len=103 (full page)"
);
assert!(crc.len2 > crc.len1, "Slot 1 should be authoritative");
// === Step 3: Extend past page boundary (add 10 more bytes for total of 113) ===
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Add bytes 104 through 113 (10 more bytes, now on page 1)
append
.append(&(104..=113).collect::<Vec<u8>>())
.await
.unwrap();
append.sync().await.unwrap();
drop(append);
// Verify we now have 2 pages
let (blob, size) = context
.open("test_partition", b"non_last_page")
.await
.unwrap();
assert_eq!(
size,
(physical_page_size * 2) as u64,
"Should have 2 physical pages"
);
// Verify data is readable before corruption
let append = Append::new(blob.clone(), size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 113);
let all_data: Vec<u8> = append.read_at(0, 113).await.unwrap().coalesce().into();
let expected: Vec<u8> = (1..=113).collect();
assert_eq!(all_data, expected);
drop(append);
// === Step 4: Corrupt page 0's primary CRC (slot 1's crc2) ===
blob.write_at(page0_crc2_offset, vec![0xDE, 0xAD, 0xBE, 0xEF])
.await
.unwrap();
blob.sync().await.unwrap();
// Verify corruption: page 0's slot 1 still has len=103 but bad CRC
let page = blob
.read_at(0, physical_page_size)
.await
.unwrap()
.coalesce();
let crc = read_crc_record_from_page(page.as_ref());
assert_eq!(crc.len2, PAGE_SIZE.get(), "len2 should still be 103");
assert_eq!(crc.crc2, 0xDEADBEEF, "crc2 should be corrupted");
// Slot 0 fallback has len=10 (partial), which is invalid for non-last page
assert_eq!(crc.len1, 10, "Fallback slot 0 has partial length");
// === Step 5: Re-open and try to read from page 0 ===
// The first page's primary CRC is bad, and fallback indicates partial (len=10).
// Since page 0 is not the last page, a partial fallback is invalid.
// Reading from page 0 should fail because the fallback CRC indicates a partial
// page, which is not allowed for non-last pages.
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// The blob still reports 113 bytes because init only validates the last page.
// But reading from page 0 should fail because the CRC fallback is partial.
assert_eq!(append.size().await, 113);
// Try to read from page 0 - this should fail with InvalidChecksum because
// the fallback CRC has len=10 (partial), which is invalid for a non-last page.
let result = append.read_at(0, 10).await;
assert!(
result.is_err(),
"Reading from corrupted non-last page via Append should fail, but got: {:?}",
result
);
drop(append);
// Also verify that reading via Replay fails the same way.
let (blob, size) = context
.open("test_partition", b"non_last_page")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
let mut replay = append.replay(NZUsize!(1024)).await.unwrap();
// Try to fill pages - should fail on CRC validation.
let result = replay.ensure(1).await;
assert!(
result.is_err(),
"Reading from corrupted non-last page via Replay should fail, but got: {:?}",
result
);
});
}
#[test]
fn test_resize_shrink_validates_crc() {
// Verify that shrinking a blob to a partial page validates the CRC, rather than
// blindly reading raw bytes which could silently load corrupted data.
let executor = deterministic::Runner::default();
executor.start(|context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
let (blob, size) = context
.open("test_partition", b"resize_crc_test")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Write data across 3 pages: page 0 (full), page 1 (full), page 2 (partial).
// PAGE_SIZE = 103, so 250 bytes = 103 + 103 + 44.
let data: Vec<u8> = (0..=249).collect();
append.append(&data).await.unwrap();
append.sync().await.unwrap();
assert_eq!(append.size().await, 250);
drop(append);
// Corrupt the CRC record of page 1 (middle page).
let (blob, size) = context
.open("test_partition", b"resize_crc_test")
.await
.unwrap();
assert_eq!(size as usize, physical_page_size * 3);
// Page 1 CRC record is at the end of the second physical page.
let page1_crc_offset = (physical_page_size * 2 - CHECKSUM_SIZE as usize) as u64;
blob.write_at(page1_crc_offset, vec![0xFF; CHECKSUM_SIZE as usize])
.await
.unwrap();
blob.sync().await.unwrap();
// Open the blob - Append::new() validates the LAST page (page 2), which is still valid.
// So it should open successfully with size 250.
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 250);
// Try to shrink to 150 bytes, which ends in page 1 (the corrupted page).
// 150 bytes = page 0 (103 full) + page 1 (47 partial).
// This should fail because page 1's CRC is corrupted.
let result = append.resize(150).await;
assert!(
matches!(result, Err(crate::Error::InvalidChecksum)),
"Expected InvalidChecksum when shrinking to corrupted page, got: {:?}",
result
);
});
}
#[test]
fn test_reopen_partial_tail_append_and_resize() {
let executor = deterministic::Runner::default();
executor.start(|context| async move {
const PAGE_SIZE: NonZeroU16 = NZU16!(64);
const BUFFER_SIZE: usize = 256;
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(4));
let (blob, size) = context
.open("test_partition", b"partial_tail_test")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
// Write some initial data.
append.append(&[1, 2, 3, 4, 5]).await.unwrap();
append.sync().await.unwrap();
assert_eq!(append.size().await, 5);
drop(append);
let (blob, size) = context
.open("test_partition", b"partial_tail_test")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
assert_eq!(append.size().await, 5);
append.append(&[6, 7, 8]).await.unwrap();
append.resize(6).await.unwrap();
append.sync().await.unwrap();
let data: Vec<u8> = append.read_at(0, 6).await.unwrap().coalesce().into();
assert_eq!(data, vec![1, 2, 3, 4, 5, 6]);
});
}
#[test]
fn test_corrupted_crc_len_too_large() {
let executor = deterministic::Runner::default();
executor.start(|context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
let physical_page_size = PAGE_SIZE.get() as usize + CHECKSUM_SIZE as usize;
// Step 1: Create blob with valid data
let (blob, size) = context
.open("test_partition", b"crc_len_test")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append.append(&[0x42; 50]).await.unwrap();
append.sync().await.unwrap();
drop(append);
// Step 2: Corrupt the CRC record to have len > page_size
let (blob, size) = context
.open("test_partition", b"crc_len_test")
.await
.unwrap();
assert_eq!(size as usize, physical_page_size);
// CRC record is at the end of the physical page
let crc_offset = PAGE_SIZE.get() as u64;
// Create a CRC record with len1 = 0xFFFF (65535), which is >> page_size (103)
// Format: [len1_hi, len1_lo, crc1 (4 bytes), len2_hi, len2_lo, crc2 (4 bytes)]
let bad_crc_record: [u8; 12] = [
0xFF, 0xFF, // len1 = 65535 (way too large)
0xDE, 0xAD, 0xBE, 0xEF, // crc1 (garbage)
0x00, 0x00, // len2 = 0
0x00, 0x00, 0x00, 0x00, // crc2 = 0
];
blob.write_at(crc_offset, bad_crc_record.to_vec())
.await
.unwrap();
blob.sync().await.unwrap();
// Step 3: Try to open the blob - should NOT panic, should return error or handle gracefully
let result = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone()).await;
// Either returns InvalidChecksum error OR truncates the corrupted data
// (both are acceptable behaviors - panicking is NOT acceptable)
match result {
Ok(append) => {
// If it opens successfully, the corrupted page should have been truncated
let recovered_size = append.size().await;
assert_eq!(
recovered_size, 0,
"Corrupted page should be truncated, size should be 0"
);
}
Err(e) => {
// Error is also acceptable
assert!(
matches!(e, crate::Error::InvalidChecksum),
"Expected InvalidChecksum error, got: {:?}",
e
);
}
}
});
}
#[test]
fn test_corrupted_crc_both_slots_len_too_large() {
let executor = deterministic::Runner::default();
executor.start(|context| async move {
let cache_ref = CacheRef::from_pooler(&context, PAGE_SIZE, NZUsize!(BUFFER_SIZE));
// Step 1: Create blob with valid data
let (blob, size) = context
.open("test_partition", b"crc_both_bad")
.await
.unwrap();
let append = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone())
.await
.unwrap();
append.append(&[0x42; 50]).await.unwrap();
append.sync().await.unwrap();
drop(append);
// Step 2: Corrupt BOTH CRC slots to have len > page_size
let (blob, size) = context
.open("test_partition", b"crc_both_bad")
.await
.unwrap();
let crc_offset = PAGE_SIZE.get() as u64;
// Both slots have len > page_size
let bad_crc_record: [u8; 12] = [
0x01, 0x00, // len1 = 256 (> 103)
0xDE, 0xAD, 0xBE, 0xEF, // crc1 (garbage)
0x02, 0x00, // len2 = 512 (> 103)
0xCA, 0xFE, 0xBA, 0xBE, // crc2 (garbage)
];
blob.write_at(crc_offset, bad_crc_record.to_vec())
.await
.unwrap();
blob.sync().await.unwrap();
// Step 3: Try to open - should NOT panic
let result = Append::new(blob, size, BUFFER_SIZE, cache_ref.clone()).await;
match result {
Ok(append) => {
// Corrupted page truncated
assert_eq!(append.size().await, 0);
}
Err(e) => {
assert!(
matches!(e, crate::Error::InvalidChecksum),
"Expected InvalidChecksum, got: {:?}",
e
);
}
}
});
}
}