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
use std::io::{self, ErrorKind, Read, Seek, SeekFrom, Take, Write};
use std::{cmp, fmt};
use brotli::BrotliState;
use brotli::writer::StandardAlloc;
use crate::layers::traits::{
InnerWriterTrait, InnerWriterType, LayerReader, LayerTruncatedReader, LayerWriter,
};
use crate::{EMPTY_TAIL_OPTS_SERIALIZATION, Error, MLADeserialize, MLASerialize, Opts};
use crate::errors::ConfigError;
use super::strip_head_tail::StripHeadTailReader;
use super::traits::InnerReaderTrait;
pub const COMPRESSION_LAYER_MAGIC: &[u8; 8] = b"COMLAAAA";
// ---------- Config ----------
/// A bigger value means a better compression ratio, less indexes to save (in
/// memory), but also a slower random access. In the worst case, an access may
/// implies decompressing a whole block to obtain just the last byte.
///
/// According to benchmarking on compression of representative data, 4MB seems
/// to be a good choice
const UNCOMPRESSED_DATA_SIZE: u32 = 4 * 1024 * 1024;
/// A bigger value means a better compression ratio, but a slower compression
///
/// According to benchmarking on compression of representative data, level 5
/// seems to be a good choice
pub const DEFAULT_COMPRESSION_LEVEL: u32 = 5;
/// Default value which seems advised by brotli libraries
const BROTLI_LOG_WINDOW: u32 = 22;
pub struct CompressionConfig {
compression_level: u32,
}
impl std::default::Default for CompressionConfig {
fn default() -> Self {
CompressionConfig {
compression_level: DEFAULT_COMPRESSION_LEVEL,
}
}
}
impl CompressionConfig {
/// Set the compression level
/// compression level (0-11); bigger values cause denser, but slower compression
pub(crate) fn set_compression_level(
&mut self,
compression_level: u32,
) -> Result<&mut Self, ConfigError> {
if compression_level > 11 {
Err(ConfigError::CompressionLevelOutOfRange)
} else {
self.compression_level = compression_level;
Ok(self)
}
}
}
// ---------- Reader ----------
/// See `CompressionLayerWriter` for more information
enum CompressionLayerReaderState<R: Read> {
/// Ready contains the real inner destination
Ready(R),
/// How many uncompressed bytes have already been read for the current
/// block
InData {
read: u32,
uncompressed_size: u32,
/// Use a Box to avoid a too big enum
/// Use a `Take` to instantiate the `Decompressor` only on the current block's compressed bytes
decompressor: Box<brotli::Decompressor<Take<R>>>,
},
/// Empty is a placeholder to allow state replacement
Empty,
}
impl<R: Read> fmt::Debug for CompressionLayerReaderState<R> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
CompressionLayerReaderState::Ready(_inner) => write!(f, "Ready"),
CompressionLayerReaderState::InData { .. } => write!(f, "InData"),
CompressionLayerReaderState::Empty => write!(f, "Empty"),
}
}
}
#[derive(Debug)]
struct SizesInfo {
/// Ordered list of chunk compressed size; only set at init
compressed_sizes: Vec<u32>,
/// Last block uncompressed size
last_block_size: u32,
}
impl<W: Write> MLASerialize<W> for SizesInfo {
fn serialize(&self, dest: &mut W) -> Result<u64, Error> {
let mut serialization_length = self.compressed_sizes.serialize(dest)?;
serialization_length = serialization_length
.checked_add(self.last_block_size.serialize(dest)?)
.ok_or(Error::SerializationError)?;
Ok(serialization_length)
}
}
impl<R: Read> MLADeserialize<R> for SizesInfo {
fn deserialize(src: &mut R) -> Result<Self, Error> {
let compressed_sizes = MLADeserialize::deserialize(src)?;
let last_block_size = MLADeserialize::deserialize(src)?;
Ok(Self {
compressed_sizes,
last_block_size,
})
}
}
impl SizesInfo {
/// Get the uncompressed block size of block `block_num`
fn uncompressed_block_size_at(&self, block_num: usize) -> Result<u32, Error> {
if block_num
< self
.compressed_sizes
.len()
.checked_sub(1)
.ok_or(Error::DeserializationError)?
{
Ok(UNCOMPRESSED_DATA_SIZE)
} else {
Ok(self.last_block_size)
}
}
/// Get the compressed block at position `uncompressed_pos`
fn compressed_block_size_at(&self, uncompressed_pos: u64) -> Result<u32, Error> {
let block_num = uncompressed_pos
.checked_div(u64::from(UNCOMPRESSED_DATA_SIZE))
.ok_or(Error::DeserializationError)?;
self.compressed_sizes
.get(usize::try_from(block_num).or(Err(Error::DeserializationError))?)
.copied()
.ok_or(Error::DeserializationError)
}
/// Maximum uncompressed available position
fn max_uncompressed_pos(&self) -> Result<u64, Error> {
u64::try_from(self.compressed_sizes.len())
.or(Err(Error::DeserializationError))?
.checked_sub(1)
.ok_or(Error::DeserializationError)?
.checked_mul(u64::from(UNCOMPRESSED_DATA_SIZE))
.ok_or(Error::DeserializationError)?
.checked_add(u64::from(self.last_block_size))
.ok_or(Error::DeserializationError)
}
}
pub struct CompressionLayerReader<'a, R: 'a + Read> {
state: CompressionLayerReaderState<Box<dyn 'a + LayerReader<'a, R>>>,
sizes_info: Option<SizesInfo>,
/// Position in the under-layer (uncompressed stream)
// /!\ Due to the decompressor having a block size of the compressed size,
// any read on it may forward the inner layer to the beginning of the next
// block
//
// [compressed block][compressed block]
// ^ ^
// | The inner layer is here
// We're actually here
//
// Additionally, the `brotli` implementation may consume more or less bytes
// than presumed. For instance, the compression may dump n bytes, while the
// decompressor is able to recover the decompressed part with only n -
// epsilon bytes.
//
// As a result, `underlayer_pos` and `inner` position
// corrected with `sizes_info` may seems unsync; `underlayer_pos` is the one
// to trust.
underlayer_pos: u64,
}
impl<R: Read> CompressionLayerReaderState<R> {
fn into_inner(self) -> R {
match self {
CompressionLayerReaderState::Ready(inner) => inner,
CompressionLayerReaderState::InData { decompressor, .. } => {
decompressor.into_inner().into_inner()
}
// `panic!` explicitly called to avoid propagating an error which
// must never happens (ie, calling `into_inner` in an inconsistent
// internal state)
CompressionLayerReaderState::Empty => {
panic!("[Reader] Empty type to inner is impossible")
}
}
}
}
impl<'a, R: 'a + InnerReaderTrait> CompressionLayerReader<'a, R> {
fn new_skip_header(mut inner: Box<dyn 'a + LayerReader<'a, R>>) -> Result<Self, Error> {
let underlayer_pos = inner.stream_position()?;
let inner_len_incl_head_tail = inner.seek(SeekFrom::End(0))?;
inner.seek(SeekFrom::Start(underlayer_pos))?;
let inner = Box::new(StripHeadTailReader::new(
inner,
underlayer_pos,
0,
inner_len_incl_head_tail,
0,
)?);
Ok(Self {
state: CompressionLayerReaderState::Ready(inner),
sizes_info: None,
underlayer_pos: 0,
})
}
pub fn new_skip_magic(mut inner: Box<dyn 'a + LayerReader<'a, R>>) -> Result<Self, Error> {
let _ = Opts::from_reader(&mut inner)?; // No option handled at the moment
Self::new_skip_header(inner)
}
/// Returns whether `uncompressed_pos` is in the data stream
/// If no index is used, always return `true`
fn pos_in_stream(&self, uncompressed_pos: u64) -> Result<bool, Error> {
Ok(match &self.sizes_info {
Some(sizes_info) => {
let pos_max = sizes_info.max_uncompressed_pos()?;
uncompressed_pos < pos_max
}
None => true,
})
}
/// Instantiate a new decompressor at position `uncompressed_pos`
/// `uncompressed_pos` must be a compressed block's starting position
fn new_decompressor_at<S: InnerReaderTrait>(
&self,
inner: S,
uncompressed_pos: u64,
) -> Result<brotli::Decompressor<Take<S>>, Error> {
// Ensure it's a starting position
if !uncompressed_pos.is_multiple_of(u64::from(UNCOMPRESSED_DATA_SIZE)) {
return Err(Error::BadAPIArgument(
"[new_decompressor_at] not a starting position".to_string(),
));
}
// Check we are still in the stream
if !self.pos_in_stream(uncompressed_pos)? {
// No more in the compressed stream -> nothing to read
return Err(Error::EndOfStream);
}
match &self.sizes_info {
Some(sizes_info) => {
// Use index for faster decompression
let compressed_block_size =
usize::try_from(sizes_info.compressed_block_size_at(uncompressed_pos)?)
.or(Err(Error::DeserializationError))?;
Ok(brotli::Decompressor::new(
// Make the Decompressor work only on the compressed block's bytes, no more
inner.take(compressed_block_size as u64),
compressed_block_size,
))
}
None => Err(Error::MissingMetadata),
}
}
// TODO add regression test
/// Get the uncompressed block size at position `uncompressed_pos`
/// `uncompressed_pos` must be a compressed block's starting position
fn uncompressed_block_size_at(&self, uncompressed_pos: u64) -> Result<u32, Error> {
// Ensure it's a starting position
if !uncompressed_pos.is_multiple_of(u64::from(UNCOMPRESSED_DATA_SIZE)) {
return Err(Error::BadAPIArgument(
"[uncompressed_block_size_at] not a starting position".to_string(),
));
}
// Check we are still in the stream
if !self
.pos_in_stream(uncompressed_pos)
.or(Err(Error::DeserializationError))?
{
// No more in the compressed stream -> nothing to read
return Err(Error::EndOfStream);
}
match &self.sizes_info {
Some(sizes_info) => {
// Use index for faster decompression
// Get the uncompressed block size
let block_num = uncompressed_pos
.checked_div(u64::from(UNCOMPRESSED_DATA_SIZE))
.ok_or(Error::DeserializationError)?;
Ok(sizes_info.uncompressed_block_size_at(
usize::try_from(block_num).or(Err(Error::DeserializationError))?,
)?)
}
None => Err(Error::MissingMetadata),
}
}
// TODO add regression test
/// Resynchronize the inner layer with `uncompressed_pos` (ie., seek inner with expected position)
/// `uncompressed_pos` must be a compressed block's starting position
fn sync_inner_with_uncompressed_pos<S: InnerReaderTrait>(
&self,
inner: &mut S,
uncompressed_pos: u64,
) -> Result<(), Error> {
// Ensure it's a starting position
if !uncompressed_pos.is_multiple_of(u64::from(UNCOMPRESSED_DATA_SIZE)) {
return Err(Error::BadAPIArgument(
"[sync_inner_with_uncompressed_pos] not a starting position".to_string(),
));
}
// Check we are still in the stream
if !self
.pos_in_stream(uncompressed_pos)
.or(Err(Error::DeserializationError))?
{
// No more in the compressed stream -> nothing to read
return Err(Error::EndOfStream);
}
// Find the right block
let block_num = uncompressed_pos
.checked_div(u64::from(UNCOMPRESSED_DATA_SIZE))
.ok_or(Error::DeserializationError)?;
match &self.sizes_info {
Some(SizesInfo {
compressed_sizes, ..
}) => {
// Move the underlayer at the start of the block
let start_position = compressed_sizes
.iter()
.take(
usize::try_from(block_num)
.expect("Failed to convert block number to usize"),
)
.map(|size| u64::from(*size))
.sum();
inner.seek(SeekFrom::Start(start_position))?;
}
None => {
return Err(Error::MissingMetadata);
}
}
Ok(())
}
}
impl<'a, R: 'a + InnerReaderTrait> LayerReader<'a, R> for CompressionLayerReader<'a, R> {
fn into_raw(self: Box<Self>) -> R {
self.state.into_inner().into_raw()
}
fn initialize(&mut self) -> Result<(), Error> {
match &mut self.state {
CompressionLayerReaderState::Ready(inner) => {
// Read the footer: [SizesInfo][SizesInfo length as 8 bytes]
let pos = inner.seek(SeekFrom::End(-8))?;
let len = u64::deserialize(inner)?;
// Read SizesInfo
inner.seek(SeekFrom::Start(
pos.checked_sub(len).ok_or(Error::DeserializationError)?,
))?;
self.sizes_info = Some(MLADeserialize::deserialize(&mut inner.take(len))?);
Ok(())
}
_ => {
// At init, should not be in this state
Err(Error::WrongReaderState(
"[Compression Layer]: on initialization, must be in Ready state".to_string(),
))
}
}
}
}
impl<'a, R: 'a + InnerReaderTrait> Read for CompressionLayerReader<'a, R> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
if !self
.pos_in_stream(self.underlayer_pos)
.or(Err(Error::DeserializationError))?
{
// No more in the compressed stream -> nothing to read
return Ok(0);
}
// Use this mem::replace trick to be able to get back the compressor
// inner and freely move from CompressionLayerReaderState to others
let old_state = std::mem::replace(&mut self.state, CompressionLayerReaderState::Empty);
match old_state {
CompressionLayerReaderState::Ready(mut inner) => {
self.sync_inner_with_uncompressed_pos(&mut inner, self.underlayer_pos)?;
let decompressor = Box::new(self.new_decompressor_at(inner, self.underlayer_pos)?);
let uncompressed_size = self.uncompressed_block_size_at(self.underlayer_pos)?;
self.state = CompressionLayerReaderState::InData {
read: 0,
uncompressed_size,
decompressor,
};
self.read(buf)
}
CompressionLayerReaderState::InData {
read,
uncompressed_size,
mut decompressor,
} => {
if read > uncompressed_size {
return Err(Error::WrongReaderState(
"[Compression Layer] Too much data read".to_string(),
)
.into());
}
if read == uncompressed_size {
self.state =
CompressionLayerReaderState::Ready(decompressor.into_inner().into_inner());
// Start a new block, fill it with new values!
return self.read(buf);
}
let size = std::cmp::min(
usize::try_from(
uncompressed_size
.checked_sub(read)
.ok_or(Error::DeserializationError)?,
)
.or(Err(Error::DeserializationError))?,
buf.len(),
);
let read_add = decompressor.read(&mut buf[..size])?;
self.underlayer_pos = self
.underlayer_pos
.checked_add(u64::try_from(read_add).or(Err(Error::DeserializationError))?)
.ok_or(Error::DeserializationError)?;
self.state = CompressionLayerReaderState::InData {
read: read
.checked_add(u32::try_from(read_add).or(Err(Error::DeserializationError))?)
.ok_or(Error::DeserializationError)?,
uncompressed_size,
decompressor,
};
Ok(read_add)
}
CompressionLayerReaderState::Empty => Err(Error::WrongReaderState(
"[Compression Layer] Should never happens, unless an error already occurs before"
.to_string(),
)
.into()),
}
}
}
impl<R: InnerReaderTrait> Seek for CompressionLayerReader<'_, R> {
/// Seek to the position `pos` in the uncompressed stream
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
// Seeking may instantiate a decompressor, and therefore position the
// inner layer at the end of the asked position's compressed block
match &self.sizes_info {
Some(_sizes_info) => {
match pos {
SeekFrom::Start(pos) => {
// Find the right block
let inside_block = pos
.checked_rem(u64::from(UNCOMPRESSED_DATA_SIZE))
.ok_or(io::Error::from(ErrorKind::InvalidInput))?;
let rounded_pos = pos
.checked_sub(inside_block)
.ok_or(io::Error::from(ErrorKind::InvalidInput))?;
// Move the underlayer at the start of the block
let old_state =
std::mem::replace(&mut self.state, CompressionLayerReaderState::Empty);
let mut inner = old_state.into_inner();
self.sync_inner_with_uncompressed_pos(&mut inner, rounded_pos)?;
// New decompressor at the start of the block
let mut decompressor = self.new_decompressor_at(inner, rounded_pos)?;
let uncompressed_size = self.uncompressed_block_size_at(rounded_pos)?;
// Move forward inside the block to reach the expected position
io::copy(&mut (&mut decompressor).take(inside_block), &mut io::sink())?;
self.state = CompressionLayerReaderState::InData {
read: u32::try_from(inside_block)
.expect("Failed to convert inside block to u32"),
uncompressed_size,
decompressor: Box::new(decompressor),
};
self.underlayer_pos = pos;
Ok(pos)
}
SeekFrom::Current(pos) => {
// Get the position and do nothing
if pos == 0 {
Ok(self.underlayer_pos)
} else {
let underlayer_pos_i64 =
i64::try_from(self.underlayer_pos).map_err(|_| {
Error::Other(
"Overflow converting current position to i64".into(),
)
})?;
let new_pos_i64 =
underlayer_pos_i64.checked_add(pos).ok_or_else(|| {
Error::Other(
"Overflow when adding offset to current position".into(),
)
})?;
let new_pos = u64::try_from(new_pos_i64).map_err(|_| {
Error::Other("Negative position after seek is not allowed".into())
})?;
self.seek(SeekFrom::Start(new_pos))
}
// TODO: Possible optimization:
// - if pos is positive and inside the current block,
// just advance the decompressor
}
SeekFrom::End(pos) => {
if pos > 0 {
// Seeking past the end is unsupported
return Err(Error::EndOfStream.into());
}
let end_pos = self
.sizes_info
.as_ref()
.unwrap()
.max_uncompressed_pos()
.or(Err(io::Error::from(ErrorKind::InvalidInput)))?;
let distance_from_end_u64 = u64::try_from(
pos.checked_neg()
.ok_or(io::Error::from(ErrorKind::InvalidInput))?,
)
.map_err(|_| Error::Other("Invalid negative seek offset".into()))?;
let target_pos =
end_pos.checked_sub(distance_from_end_u64).ok_or_else(|| {
Error::Other("Seek offset goes before start of stream".into())
})?;
self.seek(SeekFrom::Start(target_pos))
}
}
}
None => Err(Error::MissingMetadata.into()),
}
}
}
// ---------- Writer ----------
/// Wrap a Writer with counting of written bytes
struct WriterWithCount<W: Write> {
inner: W,
pos: u32,
}
impl<W: Write> WriterWithCount<W> {
fn new(inner: W) -> Self {
Self { inner, pos: 0 }
}
fn into_inner(self) -> W {
self.inner
}
}
impl<W: Write> Write for WriterWithCount<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let written = self.inner.write(buf)?;
self.pos = self
.pos
.checked_add(
u32::try_from(written)
.map_err(|_| io::Error::other("Failed to convert written data size to u32"))?,
)
.ok_or_else(|| io::Error::other("Overflow in WriterWithCount"))?;
Ok(written)
}
fn flush(&mut self) -> io::Result<()> {
self.inner.flush()
}
}
enum CompressionLayerWriterState<W: Write> {
/// Ready contains the real inner destination
Ready(W),
/// How many uncompressed bytes have already been written for the current
/// block
// Use a Box to avoid a too big enum
InData(u32, Box<brotli::CompressorWriter<WriterWithCount<W>>>),
/// Empty is a placeholder to allow state replacement
Empty,
}
/// Compression layer is made of independent `CompressedBlock`, ending by an index for seekable accesses
/// `[CompressedBlock][CompressedBlock]`...`[CompressedBlock][Index]`
///
/// Compression is made of nested independent compressed block of a fixed
/// uncompressed size
///
/// Pro:
/// * no need to store the compressed size
/// * compression can be streamed (storing the compressed size before the
/// compressed block leads to either seekable stream, which is not an option
/// here, or full-memory compression before actual write, which add limits to
/// the memory footprint)
///
/// Cons:
/// * if the index is lost, a slow decompression with a block size of 1 is
/// needed to found the `CompressedBlock` boundaries
pub struct CompressionLayerWriter<'a, W: 'a + InnerWriterTrait> {
state: CompressionLayerWriterState<InnerWriterType<'a, W>>,
/// Ordered list of compressed size of block of `UNCOMPRESSED_DATA_SIZE`
/// bytes
//
/// Thus, accessing the `n`th byte in the sublayer, is accessing the `n %
/// C`th uncompressed byte in the chunk beginning at `sum(compressed_sizes[:n
/// / C])`, with `C = UNCOMPRESSED_DATA_SIZE`
compressed_sizes: Vec<u32>,
// From config
compression_level: u32,
}
impl<'a, W: 'a + InnerWriterTrait> CompressionLayerWriter<'a, W> {
pub fn new(
mut inner: InnerWriterType<'a, W>,
config: &CompressionConfig,
) -> Result<CompressionLayerWriter<'a, W>, Error> {
inner.write_all(COMPRESSION_LAYER_MAGIC)?;
let _ = Opts.dump(&mut inner)?;
Ok(Self::new_skip_header(inner, config))
}
fn new_skip_header(
inner: InnerWriterType<'a, W>,
config: &CompressionConfig,
) -> CompressionLayerWriter<'a, W> {
Self {
state: CompressionLayerWriterState::Ready(inner),
compressed_sizes: Vec::new(),
compression_level: config.compression_level,
}
}
}
impl<'a, W: 'a + InnerWriterTrait> LayerWriter<'a, W> for CompressionLayerWriter<'a, W> {
fn finalize(mut self: Box<Self>) -> Result<W, Error> {
// Use this mem::replace trick to be able to get back the compressor
// inner and freely move from CompressionLayerWriterState to others
let old_state = std::mem::replace(&mut self.state, CompressionLayerWriterState::Empty);
let mut last_block_size = 0;
let mut inner = match old_state {
CompressionLayerWriterState::Ready(inner) => inner,
CompressionLayerWriterState::InData(written, compress) => {
let inner_count = compress.into_inner();
self.compressed_sizes.push(inner_count.pos);
last_block_size = written;
inner_count.into_inner()
}
CompressionLayerWriterState::Empty => {
// Should never happens, except if an error already occurs before
return Err(Error::WrongReaderState("[Compression Layer] bad state in finalization, an error may already occurs before".to_string()));
}
};
inner.write_all(EMPTY_TAIL_OPTS_SERIALIZATION)?; // No option for the moment
// Footer:
// [SizesInfo][SizesInfo length]
// `std::mem::replace` used to perform zero-copy serialization of `self.compressed_sizes`
// The values is restored just after the operation (non-thread safe, but
// in a multi-thread env, we will already required a lock for the
// writing)
let compressed_sizes = std::mem::take(&mut self.compressed_sizes);
let sinfo = SizesInfo {
compressed_sizes,
last_block_size,
};
let written_bytes = sinfo.serialize(&mut inner)?;
written_bytes.serialize(&mut inner)?;
self.compressed_sizes = sinfo.compressed_sizes;
// Recursive call
inner.finalize()
}
}
impl<'a, W: 'a + InnerWriterTrait> Write for CompressionLayerWriter<'a, W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
// Use this mem::replace trick to be able to get back the compressor
// inner and freely move from CompressionLayerWriterState to others
let old_state = std::mem::replace(&mut self.state, CompressionLayerWriterState::Empty);
match old_state {
CompressionLayerWriterState::Ready(inner) => {
let inner_count = WriterWithCount::new(inner);
let mut compress = brotli::CompressorWriter::new(
inner_count,
0,
self.compression_level,
BROTLI_LOG_WINDOW,
);
let size = std::cmp::min(UNCOMPRESSED_DATA_SIZE as usize, buf.len());
let written = compress.write(&buf[..size])?;
self.state = CompressionLayerWriterState::InData(u32::try_from(written).expect("Failed to convert written data size to u32"), Box::new(compress));
Ok(written)
}
CompressionLayerWriterState::InData(written, mut compress) => {
if written > UNCOMPRESSED_DATA_SIZE {
return Err(Error::WrongReaderState(
"[Compression Layer] Too much written".to_string(),
).into());
}
if written == UNCOMPRESSED_DATA_SIZE {
let inner_count = compress.into_inner();
self.compressed_sizes.push(inner_count.pos);
self.state = CompressionLayerWriterState::Ready(inner_count.into_inner());
// Start a new block, fill it with new values!
return self.write(buf);
}
let remaining_writable = usize::try_from(UNCOMPRESSED_DATA_SIZE.checked_sub(written).ok_or_else(|| io::Error::other("invalid written"))?).map_err(|_| io::Error::other("Invalid remaining_writable"))?;
let size = std::cmp::min(remaining_writable, buf.len());
let written_add = compress.write(&buf[..size])?;
let new_written = u32::try_from(written_add).map_err(|_| io::Error::other("Failed to convert added written data size to u32"))?.checked_add(written).ok_or_else(|| io::Error::other("Failed to add written"))?;
self.state =
CompressionLayerWriterState::InData(new_written, compress);
Ok(written_add)
}
CompressionLayerWriterState::Empty => {
Err(Error::WrongReaderState("[Compression Layer] On write, should never happens, unless an error already occurs before".to_string()).into())
}
}
}
fn flush(&mut self) -> io::Result<()> {
match &mut self.state {
CompressionLayerWriterState::Ready(inner) => inner.flush(),
CompressionLayerWriterState::InData(_written, compress) => compress.flush(),
CompressionLayerWriterState::Empty => {
// Should never happens, except if an error already occurs before
Err(Error::WrongReaderState("[Compression Layer] On flush, should never happens, unless an error already occurs before".to_string()).into())
}
}
}
}
// ---------- Truncated Reader ----------
/// Internal state for the `CompressionLayerTruncatedReader`
pub struct CompressionLayerTruncatedReader<'a, R: 'a + Read> {
/// While decompressing, one doesn't know in advance the number of compressed bytes
/// As a result, the following is done:
/// 1. read from the source inside a buffer
/// 2. decompress the data from the buffer
/// - if there is still data to decompress, go to 1.
/// - if this is the end of the stream, continue to 3.
/// 3. the decompressor may have read too many bytes, ie. `[end of stream n-1][start of stream n]`
/// ` ^ ^
/// ` `input_offset` last read position
/// 4. rewind, using the cache, to `input_offset`
///
/// A cache must be used, as the source is `Read` but not `Seek`.
/// `input_offset` is guaranted to be in the cache because it must be in the decompressor working buffer,
/// and the working buffer is contained in the cache (in the worst case, it is the whole cache)
///
/// Cache management:
/// ```ascii
/// cache_filled_offset
/// v
/// cache: [................ ]
/// ^
/// read_offset
/// ```
/// Data read from the source, not yet used
cache: Vec<u8>,
/// Bytes valid in the cache: [0..`cache_filled_offset`[ (0 -> no valid data)
cache_filled_len: usize,
/// Next offset to read from the cache
/// Invariant:
/// - `read_offset <= cache_filled_offset`
read_offset: usize,
/// Internal decompressor state
brotli_state: Box<BrotliState<StandardAlloc, StandardAlloc, StandardAlloc>>,
/// Number of bytes decompressed and returned for the current stream
uncompressed_read: u32,
/// Inner layer (data source)
inner: BrotliStreamReader<Box<dyn 'a + LayerTruncatedReader<'a, R>>>,
/// Flag telling if we should decompress byte by byte
byte_by_byte_decompression: bool,
}
impl<'a, R: 'a + Read> CompressionLayerTruncatedReader<'a, R> {
fn new_skip_header(inner: Box<dyn 'a + LayerTruncatedReader<'a, R>>) -> Self {
Self {
cache: vec![0u8; TRUNCATED_READER_BUFFER_INITIAL_SIZE],
read_offset: 0,
cache_filled_len: 0,
brotli_state: Box::new(BrotliState::new(
StandardAlloc::default(),
StandardAlloc::default(),
StandardAlloc::default(),
)),
uncompressed_read: 0,
inner: BrotliStreamReader::new(inner),
byte_by_byte_decompression: false,
}
}
pub fn new_skip_magic(
mut inner: Box<dyn 'a + LayerTruncatedReader<'a, R>>,
) -> Result<Self, Error> {
let _ = Opts::from_reader(&mut inner)?; // No option handled at the moment
Ok(Self::new_skip_header(inner))
}
fn truncated_reader_decompress_stream(
&mut self,
mut args: TruncatedReaderDecompressStreamParams,
buf: &mut [u8],
) -> io::Result<usize> {
match brotli::BrotliDecompressStream(
&mut args.available_in,
&mut args.input_offset,
&self.cache[self.read_offset..self.cache_filled_len],
&mut args.available_out,
&mut args.output_offset,
buf,
&mut args.written,
&mut self.brotli_state,
) {
brotli::BrotliResult::ResultSuccess => {
// End of stream reached
// Seek in the cache to the actual start of the new block
// input_offset \in [0; cache_filled_offset - read_offset[
self.read_offset = self
.read_offset
.checked_add(args.input_offset)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
// Reset others
*self.brotli_state = BrotliState::new(
StandardAlloc::default(),
StandardAlloc::default(),
StandardAlloc::default(),
);
self.uncompressed_read = 0;
let remaining_cached = self
.cache_filled_len
.checked_sub(self.read_offset)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
self.inner.new_brotli_stream(remaining_cached)?;
if args.output_offset == 0 {
return self.read(buf);
}
Ok(args.output_offset)
}
brotli::BrotliResult::NeedsMoreInput => {
// Bytes may have been read and produced
self.read_offset = self
.read_offset
.checked_add(args.input_offset)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
let output_offset_u32 = u32::try_from(args.output_offset)
.map_err(|_| io::Error::from(io::ErrorKind::InvalidInput))?;
self.uncompressed_read = self
.uncompressed_read
.checked_add(output_offset_u32)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
if args.output_offset == 0 {
// (NeedsMoreInput && output_offset == 0) means we can't produce output without more input
//
// if cache is full
if self.read_offset == 0 && self.cache_filled_len == self.cache.len() {
let new_cache_len = self
.cache
.len()
.checked_add(1)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
self.cache.resize(new_cache_len, 0);
} else {
// move cache content at offset zero to make room for other input
self.cache
.copy_within(self.read_offset..self.cache_filled_len, 0);
self.cache_filled_len = self
.cache_filled_len
.checked_sub(self.read_offset)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
self.read_offset = 0;
if self.byte_by_byte_decompression {
// Revert to one byte cache length if it was previously increased
if self.cache.len() != 1 {
self.cache.resize(1, 0);
}
}
}
let read = self.inner.read(&mut self.cache[self.cache_filled_len..])?;
if read == 0 {
// No more data from inner and the cache has been fully read
// -> return either an error or Ok(0)
if self.uncompressed_read > 0 {
// Inside a stream and no more data available
return Err(io::Error::new(
io::ErrorKind::UnexpectedEof,
"No more data from the inner layer",
));
}
// No more data available but not in a stream
return Ok(0);
}
self.cache_filled_len = self
.cache_filled_len
.checked_add(read)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
return self.read(buf);
}
Ok(args.output_offset)
}
brotli::BrotliResult::NeedsMoreOutput => {
// Bytes may have been read and produced
self.read_offset = self
.read_offset
.checked_add(args.input_offset)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
let output_offset_u32 = u32::try_from(args.output_offset)
.map_err(|_| io::Error::from(io::ErrorKind::InvalidInput))?;
self.uncompressed_read = self
.uncompressed_read
.checked_add(output_offset_u32)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
Ok(args.output_offset)
}
brotli::BrotliResult::ResultFailure => {
if self.byte_by_byte_decompression {
// byte by byte reading fails: we cannot recover anymore data
Err(io::Error::new(
io::ErrorKind::InvalidData,
"Invalid data while decompressing",
))
} else {
// we retry with a cache size of 1 because BrotliDecompressStream
// may hold unreturned decompressed data in its internal state otherwise
self.byte_by_byte_decompression = true;
self.cache.resize(1, 0);
self.cache_filled_len = 0;
self.read_offset = 0;
*self.brotli_state = BrotliState::new(
StandardAlloc::default(),
StandardAlloc::default(),
StandardAlloc::default(),
);
let number_of_already_decompressed_bytes = self.uncompressed_read;
self.uncompressed_read = 0;
// rewind to brotli stream start
self.inner.rewind_to_stream_start();
// skip over bytes that were already decompressed before the rewind
// by reading and discarding them into a sink, so they aren't returned again
io::copy(
&mut self.take(u64::from(number_of_already_decompressed_bytes)),
&mut io::sink(),
)?;
self.read(buf)
}
}
}
}
}
impl<'a, R: 'a + Read> LayerTruncatedReader<'a, R> for CompressionLayerTruncatedReader<'a, R> {}
const TRUNCATED_READER_BUFFER_INITIAL_SIZE: usize = 4096;
impl<'a, R: 'a + Read> Read for CompressionLayerTruncatedReader<'a, R> {
/// This `read` may end by failing.
/// Even in the best configuration, when the inner layer is not broken, the
/// decompression will fail if attempting to read not-compressed data such as
/// `CompressionLayerReader` footer.
/// This is OK right now because the only usage is `TruncatedArchiveReader::convert_to_archive`
/// which stops reading when `EndOfArchiveData` is encountered.
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
if self.uncompressed_read > UNCOMPRESSED_DATA_SIZE {
return Err(Error::WrongReaderState(
"[Compress FailSafe Layer] Too much data read".to_string(),
)
.into());
}
if buf.is_empty() {
return Ok(0);
}
// Number of bytes available in the source
let available_in = self
.cache_filled_len
.checked_sub(self.read_offset)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
// IN: Offset in the source
// OUT: Offset in the source after the decompression pass
let input_offset = 0;
// Available space in the output
let available_out = buf.len();
// IN: Offset in the output
// OUT: number of bytes written in the output
let output_offset = 0;
// OUT: total number of byte written for the current stream (cumulative)
let written = 0;
let params = TruncatedReaderDecompressStreamParams {
available_in,
input_offset,
available_out,
output_offset,
written,
};
self.truncated_reader_decompress_stream(params, buf)
}
}
struct TruncatedReaderDecompressStreamParams {
available_in: usize,
input_offset: usize,
available_out: usize,
output_offset: usize,
written: usize,
}
/// This is a reader for the inner content with a cache.
/// The inner content is meant to be a succession of brotli streams.
/// This reader caches the current stream, giving possibility to rewind at its stat.
struct BrotliStreamReader<R> {
cache: Vec<u8>,
inner: R,
number_of_bytes_read: usize,
}
impl<R> BrotliStreamReader<R> {
const fn new(inner: R) -> Self {
Self {
cache: Vec::new(),
inner,
number_of_bytes_read: 0,
}
}
/// Drop the previous brotli stream from the cache, move cached part of the
/// new brotli stream to start of cache and get ready to read and cache the rest
fn new_brotli_stream(&mut self, offset_from_current_pos: usize) -> Result<(), Error> {
let cache_len = self.cache.len();
// Take the cached new brotli stream and move it to the start of the cache
self.cache
.copy_within(offset_from_current_pos..cache_len, 0);
// discard the rest of the cache
let new_cache_len = cache_len
.checked_sub(offset_from_current_pos)
.ok_or(Error::DeserializationError)?;
self.cache.truncate(new_cache_len);
self.number_of_bytes_read = new_cache_len;
Ok(())
}
/// Rewind at start of cached data
const fn rewind_to_stream_start(&mut self) {
self.number_of_bytes_read = 0;
}
}
impl<R: Read> Read for BrotliStreamReader<R> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
if self.number_of_bytes_read < self.cache.len() {
// we previously got rewound: read from cache
let remaining_in_cache = self
.cache
.len()
.checked_sub(self.number_of_bytes_read)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
let copy_len = cmp::min(remaining_in_cache, buf.len());
let cache_copy_end_offset = self
.number_of_bytes_read
.checked_add(copy_len)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
buf[0..copy_len]
.copy_from_slice(&self.cache[self.number_of_bytes_read..cache_copy_end_offset]);
self.number_of_bytes_read = self
.number_of_bytes_read
.checked_add(copy_len)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
Ok(copy_len)
} else {
// we are reading uncached data: read it and cache it
let nread = self.inner.read(buf)?;
self.cache.extend_from_slice(&buf[..nread]);
self.number_of_bytes_read = self
.number_of_bytes_read
.checked_add(nread)
.ok_or_else(|| io::Error::from(ErrorKind::InvalidInput))?;
Ok(nread)
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::config::ArchiveWriterConfig;
use crate::layers::raw::{RawLayerReader, RawLayerTruncatedReader, RawLayerWriter};
use brotli::writer::StandardAlloc;
use rand::SeedableRng;
use rand::distributions::{Alphanumeric, Distribution, Standard};
use std::io::{Cursor, Read, Write};
use std::time::Instant;
// Use few UNCOMPRESSED_DATA_SIZE to force few blocks, and
// UNCOMPRESSED_DATA_SIZE / 2 to add a non complete one
static SIZE: usize = (UNCOMPRESSED_DATA_SIZE * 2 + UNCOMPRESSED_DATA_SIZE / 2) as usize;
// Return a vector of data of size SIZE
fn get_data() -> Vec<u8> {
// Use only alphanumeric charset to allow for compression
let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(0);
let data: Vec<u8> = Alphanumeric.sample_iter(&mut rng).take(SIZE).collect();
assert_eq!(data.len(), SIZE);
data
}
// Return a vector of uncompressable data (ie. purely random) of size SIZE
fn get_uncompressable_data() -> Vec<u8> {
// Use only alphanumeric charset to allow for compression
let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(0);
let data: Vec<u8> = Standard.sample_iter(&mut rng).take(SIZE).collect();
assert_eq!(data.len(), SIZE);
data
}
#[test]
fn compress_layer_writer() {
// Test with one "CompressedBlock"
let file = Vec::new();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&CompressionConfig::default(),
));
let mut fake_data = vec![1, 2, 3, 4];
let fake_data2 = vec![5, 6, 7, 8];
comp.write_all(fake_data.as_slice()).unwrap();
comp.write_all(fake_data2.as_slice()).unwrap();
let file = comp.finalize().unwrap();
let mut src = Cursor::new(file.as_slice());
let mut reader = brotli::Decompressor::new(&mut src, 0);
let mut buf = Vec::new();
reader.read_to_end(&mut buf).unwrap();
println!("{buf:?}");
fake_data.extend(fake_data2);
assert_eq!(fake_data, buf);
}
#[test]
fn compress_layer_several() {
// Test with several CompressedBlock - ensure that having only
// compressed blocks without header is enough to be able to distinguish
// them at decompression, knowing the uncompressed block size
let data = get_data();
let bytes = data.as_slice();
let file = Vec::new();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&CompressionConfig::default(),
));
let now = Instant::now();
comp.write_all(bytes).unwrap();
println!(
"Compression: {} us for {} bytes",
now.elapsed().as_micros(),
bytes.len()
);
let file = comp.finalize().unwrap();
println!("{}", file.len());
let mut src = Cursor::new(file.as_slice());
// Highlight the use of BrotliDecompressStream
let now = Instant::now();
let mut buf = vec![0; UNCOMPRESSED_DATA_SIZE as usize];
// A similar result can be obtained by using a buffer_size of 1, as demonstrated below
//
// Using a Decompressor with a bigger buffer size lead to an over read of the inner source:
// let mut reader = brotli::Decompressor::new(&mut src, 4096);
// reader.read_exact(&mut buf).expect("First buffer");
//
// reader.__0.__0.input_offset -> current offset in the underlying buffer
// reader.__0.__0: DecompressorCustomIo
// src.position() - buffer_size + input_offset -> actual last byte read
//
// But this information is not exposed by the API
let mut brotli_state = BrotliState::new(
StandardAlloc::default(),
StandardAlloc::default(),
StandardAlloc::default(),
);
// at this point the decompressor simply needs an input and output buffer and the ability to track
// the available data left in each buffer
let mut available_in = file.len();
let mut input_offset = 0;
let mut available_out = buf.len();
let mut output_offset = 0;
let mut written = 0;
if let brotli::BrotliResult::ResultSuccess = brotli::BrotliDecompressStream(
&mut available_in,
&mut input_offset,
src.get_ref(),
&mut available_out,
&mut output_offset,
&mut buf,
&mut written,
&mut brotli_state,
) {
} else {
panic!()
}
// Ensure the decompression is correct
assert_eq!(written, buf.len());
assert_eq!(buf.len(), UNCOMPRESSED_DATA_SIZE as usize);
assert_eq!(buf.as_slice(), &bytes[..(UNCOMPRESSED_DATA_SIZE as usize)]);
// Use the `input_offset` information to seek to the beginning of the next compressed block
src.set_position(input_offset as u64);
// Use a Decompressor with a buffer size of 1, as a replacement of the above optimization (must be compatible)
let mut reader = brotli::Decompressor::new(&mut src, 1);
let mut buf2 = vec![0; UNCOMPRESSED_DATA_SIZE as usize];
reader.read_exact(&mut buf2).expect("Second buffer");
assert_eq!(buf2.len(), UNCOMPRESSED_DATA_SIZE as usize);
assert_eq!(
buf2.as_slice(),
&bytes[(UNCOMPRESSED_DATA_SIZE as usize)..((UNCOMPRESSED_DATA_SIZE * 2) as usize)]
);
let mut reader = brotli::Decompressor::new(&mut src, 1);
let mut buf3 = vec![0; SIZE - buf.len() - buf2.len()];
reader.read_exact(&mut buf3).expect("Last buffer");
assert_eq!(buf.len() + buf2.len() + buf3.len(), SIZE);
assert_eq!(
buf3.as_slice(),
&bytes[(buf.len() + buf2.len())..(buf.len() + buf2.len() + buf3.len())]
);
println!(
"Decompression: {} us for {} bytes",
now.elapsed().as_micros(),
buf.len() + buf2.len() + buf3.len()
);
println!("Buf sizes {} {} {}", buf.len(), buf2.len(), buf3.len());
}
#[test]
fn compress_layer() {
// Compress then decompress with dedicated Layer structs
for data in [get_data(), get_uncompressable_data()] {
let bytes = data.as_slice();
let file = Vec::new();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&CompressionConfig::default(),
));
let now = Instant::now();
comp.write_all(bytes).unwrap();
let file = comp.finalize().unwrap();
let buf = Cursor::new(file.as_slice());
let mut decomp = Box::new(
CompressionLayerReader::new_skip_header(Box::new(RawLayerReader::new(buf)))
.unwrap(),
);
decomp.initialize().unwrap();
let mut buf = Vec::new();
decomp.read_to_end(&mut buf).unwrap();
println!(
"Compression / Decompression: {} us for {} bytes ({} compressed)",
now.elapsed().as_micros(),
bytes.len(),
file.len()
);
assert_eq!(buf.len(), bytes.len());
assert_eq!(buf.as_slice(), bytes);
}
}
#[test]
fn compress_truncated_layer() {
// Compress then decompress with Fail-Safe Layer structs
for data in [get_data(), get_uncompressable_data()] {
let bytes = data.as_slice();
let file = Vec::new();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&CompressionConfig::default(),
));
let now = Instant::now();
comp.write_all(bytes).unwrap();
let file = comp.finalize().unwrap();
let mut decomp = Box::new(CompressionLayerTruncatedReader::new_skip_header(Box::new(
RawLayerTruncatedReader::new(file.as_slice()),
)));
let mut buf = Vec::new();
// This must ends with an error, when we start reading the footer (invalid for decompression)
decomp.read_to_end(&mut buf).unwrap_err();
println!(
"Compression / Decompression (fail-safe): {} us for {} bytes ({} compressed)",
now.elapsed().as_micros(),
bytes.len(),
file.len()
);
assert_eq!(buf.len(), bytes.len());
assert_eq!(buf.as_slice(), bytes);
}
}
#[test]
fn compress_truncated_truncated() {
// Compress then decompress with Fail-Safe Layer structs, while truncating the intermediate buffer
for data in [get_data(), get_uncompressable_data()] {
let bytes = data.as_slice();
let file = Vec::new();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&CompressionConfig::default(),
));
let now = Instant::now();
comp.write_all(bytes).unwrap();
let file = comp.finalize().unwrap();
// Truncate at the middle
let stop = file.len() / 2;
let mut decomp = Box::new(CompressionLayerTruncatedReader::new_skip_header(Box::new(
RawLayerTruncatedReader::new(&file[..stop]),
)));
let mut buf = Vec::new();
// This is expected to ends with an error
decomp.read_to_end(&mut buf).unwrap_err();
println!(
"Compression / Decompression (fail-safe): {} us for {} bytes ({} compressed, {} keeped)",
now.elapsed().as_micros(),
bytes.len(),
file.len(),
buf.len(),
);
// Ensure the obtained bytes are correct
assert_eq!(buf.as_slice(), &bytes[..buf.len()]);
// We hope still having enough data (keeping half of the compressed
// stream should give us at least a third of the uncompressed stream)
assert!(buf.len() >= bytes.len() / 3);
}
}
#[test]
fn seek_with_footer() {
for data in [get_data(), get_uncompressable_data()] {
let bytes = data.as_slice();
let file = Vec::new();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&CompressionConfig::default(),
));
comp.write_all(bytes).unwrap();
let file = comp.finalize().unwrap();
let buf = Cursor::new(file.as_slice());
let mut decomp = Box::new(
CompressionLayerReader::new_skip_header(Box::new(RawLayerReader::new(buf)))
.unwrap(),
);
decomp.initialize().unwrap();
// Seek in the first block
let pos = decomp.seek(SeekFrom::Start(5)).unwrap();
assert_eq!(pos, 5);
let mut buf = [0u8; 5];
decomp.read_exact(&mut buf).unwrap();
assert_eq!(&buf, &bytes[5..10]);
// Seek in the second block
let pos = decomp
.seek(SeekFrom::Start((UNCOMPRESSED_DATA_SIZE + 4).into()))
.unwrap();
assert_eq!(pos, u64::from(UNCOMPRESSED_DATA_SIZE) + 4);
let mut buf = [0u8; 5];
decomp.read_exact(&mut buf).unwrap();
assert_eq!(
&buf,
&bytes[usize::try_from(pos).expect("Failed to convert position to usize")
..usize::try_from(pos + 5).expect("Failed to convert position to usize")]
);
// Seek relatively (same block)
let pos = decomp.seek(SeekFrom::Current(2)).unwrap();
assert_eq!(pos, u64::from(UNCOMPRESSED_DATA_SIZE) + 4 + 5 + 2);
let mut buf = [0u8; 5];
decomp.read_exact(&mut buf).unwrap();
assert_eq!(
&buf,
&bytes[usize::try_from(pos).expect("Failed to convert position to usize")
..usize::try_from(pos + 5).expect("Failed to convert position to usize")]
);
// Seek relatively (next block)
let pos = decomp
.seek(SeekFrom::Current(UNCOMPRESSED_DATA_SIZE.into()))
.unwrap();
assert_eq!(pos, u64::from(UNCOMPRESSED_DATA_SIZE * 2) + 4 + 5 + 2 + 5);
let mut buf = [0u8; 5];
decomp.read_exact(&mut buf).unwrap();
assert_eq!(
&buf,
&bytes[usize::try_from(pos).expect("Failed to convert position to usize")
..usize::try_from(pos + 5).expect("Failed to convert position to usize")]
);
// Seek relatively (backward)
let pos = decomp.seek(SeekFrom::Current(-5)).unwrap();
assert_eq!(pos, u64::from(UNCOMPRESSED_DATA_SIZE * 2) + 4 + 5 + 2 + 5);
let mut buf = [0u8; 5];
decomp.read_exact(&mut buf).unwrap();
assert_eq!(
&buf,
&bytes[usize::try_from(pos).expect("Failed to convert position to usize")
..usize::try_from(pos + 5).expect("Failed to convert position to usize")]
);
// Seek from end
let pos = decomp.seek(SeekFrom::End(-5)).unwrap();
assert_eq!(pos, (SIZE - 5) as u64);
let mut buf = [0u8; 5];
decomp.read_exact(&mut buf).unwrap();
assert_eq!(
&buf,
&bytes[usize::try_from(pos).expect("Failed to convert position to usize")
..usize::try_from(pos + 5).expect("Failed to convert position to usize")]
);
}
}
#[test]
fn sizes_info() {
let sizes_info = SizesInfo {
compressed_sizes: vec![1, 2, 5],
last_block_size: 42,
};
assert_eq!(
sizes_info.uncompressed_block_size_at(1).unwrap(),
UNCOMPRESSED_DATA_SIZE
);
assert_eq!(sizes_info.uncompressed_block_size_at(3).unwrap(), 42);
assert_eq!(
sizes_info.max_uncompressed_pos().unwrap(),
u64::from(UNCOMPRESSED_DATA_SIZE.checked_mul(2).unwrap())
.checked_add(42)
.unwrap()
);
assert_eq!(
sizes_info
.compressed_block_size_at(u64::from(UNCOMPRESSED_DATA_SIZE).checked_add(1).unwrap())
.unwrap(),
2
);
}
#[test]
fn compress_config() {
// Check the compression level is indeed use
let data = get_data();
let bytes = data.as_slice();
let file = Vec::new();
let config = ArchiveWriterConfig::without_encryption_without_signature()
.unwrap()
.with_compression_level(0)
.unwrap();
let mut comp = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(file)),
&config.compression.unwrap(),
));
comp.write_all(bytes).unwrap();
let entry2 = Vec::new();
let config2 = ArchiveWriterConfig::without_encryption_without_signature()
.unwrap()
.with_compression_level(5)
.unwrap();
let mut comp2 = Box::new(CompressionLayerWriter::new_skip_header(
Box::new(RawLayerWriter::new(entry2)),
&config2.compression.unwrap(),
));
comp2.write_all(bytes).unwrap();
// entry2 must be better compressed than file
let file = comp.finalize().unwrap();
let entry2 = comp2.finalize().unwrap();
assert!(file.len() > entry2.len());
// Check content
let buf = Cursor::new(file.as_slice());
let mut buf_out = Vec::new();
let mut decomp = Box::new(
CompressionLayerReader::new_skip_header(Box::new(RawLayerReader::new(buf))).unwrap(),
);
decomp.initialize().unwrap();
decomp.read_to_end(&mut buf_out).unwrap();
let buf2 = Cursor::new(entry2.as_slice());
let mut buf_2_out = Vec::new();
let mut decomp = Box::new(
CompressionLayerReader::new_skip_header(Box::new(RawLayerReader::new(buf2))).unwrap(),
);
decomp.initialize().unwrap();
decomp.read_to_end(&mut buf_2_out).unwrap();
assert_eq!(buf_out, buf_2_out);
}
}