]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_serialize/src/opaque.rs
:arrow_up: rust-analyzer
[rust.git] / compiler / rustc_serialize / src / opaque.rs
1 use crate::leb128::{self, max_leb128_len};
2 use crate::serialize::{Decodable, Decoder, Encodable, Encoder};
3 use std::convert::TryInto;
4 use std::fs::File;
5 use std::io::{self, Write};
6 use std::mem::MaybeUninit;
7 use std::path::Path;
8 use std::ptr;
9
10 // -----------------------------------------------------------------------------
11 // Encoder
12 // -----------------------------------------------------------------------------
13
14 pub struct MemEncoder {
15     pub data: Vec<u8>,
16 }
17
18 impl MemEncoder {
19     pub fn new() -> MemEncoder {
20         MemEncoder { data: vec![] }
21     }
22
23     #[inline]
24     pub fn position(&self) -> usize {
25         self.data.len()
26     }
27
28     pub fn finish(self) -> Vec<u8> {
29         self.data
30     }
31 }
32
33 macro_rules! write_leb128 {
34     ($enc:expr, $value:expr, $int_ty:ty, $fun:ident) => {{
35         const MAX_ENCODED_LEN: usize = max_leb128_len!($int_ty);
36         let old_len = $enc.data.len();
37
38         if MAX_ENCODED_LEN > $enc.data.capacity() - old_len {
39             $enc.data.reserve(MAX_ENCODED_LEN);
40         }
41
42         // SAFETY: The above check and `reserve` ensures that there is enough
43         // room to write the encoded value to the vector's internal buffer.
44         unsafe {
45             let buf = &mut *($enc.data.as_mut_ptr().add(old_len)
46                 as *mut [MaybeUninit<u8>; MAX_ENCODED_LEN]);
47             let encoded = leb128::$fun(buf, $value);
48             $enc.data.set_len(old_len + encoded.len());
49         }
50     }};
51 }
52
53 /// A byte that [cannot occur in UTF8 sequences][utf8]. Used to mark the end of a string.
54 /// This way we can skip validation and still be relatively sure that deserialization
55 /// did not desynchronize.
56 ///
57 /// [utf8]: https://en.wikipedia.org/w/index.php?title=UTF-8&oldid=1058865525#Codepage_layout
58 const STR_SENTINEL: u8 = 0xC1;
59
60 impl Encoder for MemEncoder {
61     #[inline]
62     fn emit_usize(&mut self, v: usize) {
63         write_leb128!(self, v, usize, write_usize_leb128)
64     }
65
66     #[inline]
67     fn emit_u128(&mut self, v: u128) {
68         write_leb128!(self, v, u128, write_u128_leb128);
69     }
70
71     #[inline]
72     fn emit_u64(&mut self, v: u64) {
73         write_leb128!(self, v, u64, write_u64_leb128);
74     }
75
76     #[inline]
77     fn emit_u32(&mut self, v: u32) {
78         write_leb128!(self, v, u32, write_u32_leb128);
79     }
80
81     #[inline]
82     fn emit_u16(&mut self, v: u16) {
83         self.data.extend_from_slice(&v.to_le_bytes());
84     }
85
86     #[inline]
87     fn emit_u8(&mut self, v: u8) {
88         self.data.push(v);
89     }
90
91     #[inline]
92     fn emit_isize(&mut self, v: isize) {
93         write_leb128!(self, v, isize, write_isize_leb128)
94     }
95
96     #[inline]
97     fn emit_i128(&mut self, v: i128) {
98         write_leb128!(self, v, i128, write_i128_leb128)
99     }
100
101     #[inline]
102     fn emit_i64(&mut self, v: i64) {
103         write_leb128!(self, v, i64, write_i64_leb128)
104     }
105
106     #[inline]
107     fn emit_i32(&mut self, v: i32) {
108         write_leb128!(self, v, i32, write_i32_leb128)
109     }
110
111     #[inline]
112     fn emit_i16(&mut self, v: i16) {
113         self.data.extend_from_slice(&v.to_le_bytes());
114     }
115
116     #[inline]
117     fn emit_i8(&mut self, v: i8) {
118         self.emit_u8(v as u8);
119     }
120
121     #[inline]
122     fn emit_bool(&mut self, v: bool) {
123         self.emit_u8(if v { 1 } else { 0 });
124     }
125
126     #[inline]
127     fn emit_f64(&mut self, v: f64) {
128         let as_u64: u64 = v.to_bits();
129         self.emit_u64(as_u64);
130     }
131
132     #[inline]
133     fn emit_f32(&mut self, v: f32) {
134         let as_u32: u32 = v.to_bits();
135         self.emit_u32(as_u32);
136     }
137
138     #[inline]
139     fn emit_char(&mut self, v: char) {
140         self.emit_u32(v as u32);
141     }
142
143     #[inline]
144     fn emit_str(&mut self, v: &str) {
145         self.emit_usize(v.len());
146         self.emit_raw_bytes(v.as_bytes());
147         self.emit_u8(STR_SENTINEL);
148     }
149
150     #[inline]
151     fn emit_raw_bytes(&mut self, s: &[u8]) {
152         self.data.extend_from_slice(s);
153     }
154 }
155
156 pub type FileEncodeResult = Result<usize, io::Error>;
157
158 // `FileEncoder` encodes data to file via fixed-size buffer.
159 //
160 // When encoding large amounts of data to a file, using `FileEncoder` may be
161 // preferred over using `MemEncoder` to encode to a `Vec`, and then writing the
162 // `Vec` to file, as the latter uses as much memory as there is encoded data,
163 // while the former uses the fixed amount of memory allocated to the buffer.
164 // `FileEncoder` also has the advantage of not needing to reallocate as data
165 // is appended to it, but the disadvantage of requiring more error handling,
166 // which has some runtime overhead.
167 pub struct FileEncoder {
168     // The input buffer. For adequate performance, we need more control over
169     // buffering than `BufWriter` offers. If `BufWriter` ever offers a raw
170     // buffer access API, we can use it, and remove `buf` and `buffered`.
171     buf: Box<[MaybeUninit<u8>]>,
172     buffered: usize,
173     flushed: usize,
174     file: File,
175     // This is used to implement delayed error handling, as described in the
176     // comment on `trait Encoder`.
177     res: Result<(), io::Error>,
178 }
179
180 impl FileEncoder {
181     pub fn new<P: AsRef<Path>>(path: P) -> io::Result<Self> {
182         const DEFAULT_BUF_SIZE: usize = 8192;
183         FileEncoder::with_capacity(path, DEFAULT_BUF_SIZE)
184     }
185
186     pub fn with_capacity<P: AsRef<Path>>(path: P, capacity: usize) -> io::Result<Self> {
187         // Require capacity at least as large as the largest LEB128 encoding
188         // here, so that we don't have to check or handle this on every write.
189         assert!(capacity >= max_leb128_len());
190
191         // Require capacity small enough such that some capacity checks can be
192         // done using guaranteed non-overflowing add rather than sub, which
193         // shaves an instruction off those code paths (on x86 at least).
194         assert!(capacity <= usize::MAX - max_leb128_len());
195
196         let file = File::create(path)?;
197
198         Ok(FileEncoder {
199             buf: Box::new_uninit_slice(capacity),
200             buffered: 0,
201             flushed: 0,
202             file,
203             res: Ok(()),
204         })
205     }
206
207     #[inline]
208     pub fn position(&self) -> usize {
209         // Tracking position this way instead of having a `self.position` field
210         // means that we don't have to update the position on every write call.
211         self.flushed + self.buffered
212     }
213
214     pub fn flush(&mut self) {
215         // This is basically a copy of `BufWriter::flush`. If `BufWriter` ever
216         // offers a raw buffer access API, we can use it, and remove this.
217
218         /// Helper struct to ensure the buffer is updated after all the writes
219         /// are complete. It tracks the number of written bytes and drains them
220         /// all from the front of the buffer when dropped.
221         struct BufGuard<'a> {
222             buffer: &'a mut [u8],
223             encoder_buffered: &'a mut usize,
224             encoder_flushed: &'a mut usize,
225             flushed: usize,
226         }
227
228         impl<'a> BufGuard<'a> {
229             fn new(
230                 buffer: &'a mut [u8],
231                 encoder_buffered: &'a mut usize,
232                 encoder_flushed: &'a mut usize,
233             ) -> Self {
234                 assert_eq!(buffer.len(), *encoder_buffered);
235                 Self { buffer, encoder_buffered, encoder_flushed, flushed: 0 }
236             }
237
238             /// The unwritten part of the buffer
239             fn remaining(&self) -> &[u8] {
240                 &self.buffer[self.flushed..]
241             }
242
243             /// Flag some bytes as removed from the front of the buffer
244             fn consume(&mut self, amt: usize) {
245                 self.flushed += amt;
246             }
247
248             /// true if all of the bytes have been written
249             fn done(&self) -> bool {
250                 self.flushed >= *self.encoder_buffered
251             }
252         }
253
254         impl Drop for BufGuard<'_> {
255             fn drop(&mut self) {
256                 if self.flushed > 0 {
257                     if self.done() {
258                         *self.encoder_flushed += *self.encoder_buffered;
259                         *self.encoder_buffered = 0;
260                     } else {
261                         self.buffer.copy_within(self.flushed.., 0);
262                         *self.encoder_flushed += self.flushed;
263                         *self.encoder_buffered -= self.flushed;
264                     }
265                 }
266             }
267         }
268
269         // If we've already had an error, do nothing. It'll get reported after
270         // `finish` is called.
271         if self.res.is_err() {
272             return;
273         }
274
275         let mut guard = BufGuard::new(
276             unsafe { MaybeUninit::slice_assume_init_mut(&mut self.buf[..self.buffered]) },
277             &mut self.buffered,
278             &mut self.flushed,
279         );
280
281         while !guard.done() {
282             match self.file.write(guard.remaining()) {
283                 Ok(0) => {
284                     self.res = Err(io::Error::new(
285                         io::ErrorKind::WriteZero,
286                         "failed to write the buffered data",
287                     ));
288                     return;
289                 }
290                 Ok(n) => guard.consume(n),
291                 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {}
292                 Err(e) => {
293                     self.res = Err(e);
294                     return;
295                 }
296             }
297         }
298     }
299
300     pub fn file(&self) -> &File {
301         &self.file
302     }
303
304     #[inline]
305     fn capacity(&self) -> usize {
306         self.buf.len()
307     }
308
309     #[inline]
310     fn write_one(&mut self, value: u8) {
311         // We ensure this during `FileEncoder` construction.
312         debug_assert!(self.capacity() >= 1);
313
314         let mut buffered = self.buffered;
315
316         if std::intrinsics::unlikely(buffered >= self.capacity()) {
317             self.flush();
318             buffered = 0;
319         }
320
321         // SAFETY: The above check and `flush` ensures that there is enough
322         // room to write the input to the buffer.
323         unsafe {
324             *MaybeUninit::slice_as_mut_ptr(&mut self.buf).add(buffered) = value;
325         }
326
327         self.buffered = buffered + 1;
328     }
329
330     #[inline]
331     fn write_all(&mut self, buf: &[u8]) {
332         let capacity = self.capacity();
333         let buf_len = buf.len();
334
335         if std::intrinsics::likely(buf_len <= capacity) {
336             let mut buffered = self.buffered;
337
338             if std::intrinsics::unlikely(buf_len > capacity - buffered) {
339                 self.flush();
340                 buffered = 0;
341             }
342
343             // SAFETY: The above check and `flush` ensures that there is enough
344             // room to write the input to the buffer.
345             unsafe {
346                 let src = buf.as_ptr();
347                 let dst = MaybeUninit::slice_as_mut_ptr(&mut self.buf).add(buffered);
348                 ptr::copy_nonoverlapping(src, dst, buf_len);
349             }
350
351             self.buffered = buffered + buf_len;
352         } else {
353             self.write_all_unbuffered(buf);
354         }
355     }
356
357     fn write_all_unbuffered(&mut self, mut buf: &[u8]) {
358         // If we've already had an error, do nothing. It'll get reported after
359         // `finish` is called.
360         if self.res.is_err() {
361             return;
362         }
363
364         if self.buffered > 0 {
365             self.flush();
366         }
367
368         // This is basically a copy of `Write::write_all` but also updates our
369         // `self.flushed`. It's necessary because `Write::write_all` does not
370         // return the number of bytes written when an error is encountered, and
371         // without that, we cannot accurately update `self.flushed` on error.
372         while !buf.is_empty() {
373             match self.file.write(buf) {
374                 Ok(0) => {
375                     self.res = Err(io::Error::new(
376                         io::ErrorKind::WriteZero,
377                         "failed to write whole buffer",
378                     ));
379                     return;
380                 }
381                 Ok(n) => {
382                     buf = &buf[n..];
383                     self.flushed += n;
384                 }
385                 Err(ref e) if e.kind() == io::ErrorKind::Interrupted => {}
386                 Err(e) => {
387                     self.res = Err(e);
388                     return;
389                 }
390             }
391         }
392     }
393
394     pub fn finish(mut self) -> Result<usize, io::Error> {
395         self.flush();
396
397         let res = std::mem::replace(&mut self.res, Ok(()));
398         res.map(|()| self.position())
399     }
400 }
401
402 impl Drop for FileEncoder {
403     fn drop(&mut self) {
404         // Likely to be a no-op, because `finish` should have been called and
405         // it also flushes. But do it just in case.
406         let _result = self.flush();
407     }
408 }
409
410 macro_rules! file_encoder_write_leb128 {
411     ($enc:expr, $value:expr, $int_ty:ty, $fun:ident) => {{
412         const MAX_ENCODED_LEN: usize = max_leb128_len!($int_ty);
413
414         // We ensure this during `FileEncoder` construction.
415         debug_assert!($enc.capacity() >= MAX_ENCODED_LEN);
416
417         let mut buffered = $enc.buffered;
418
419         // This can't overflow. See assertion in `FileEncoder::with_capacity`.
420         if std::intrinsics::unlikely(buffered + MAX_ENCODED_LEN > $enc.capacity()) {
421             $enc.flush();
422             buffered = 0;
423         }
424
425         // SAFETY: The above check and flush ensures that there is enough
426         // room to write the encoded value to the buffer.
427         let buf = unsafe {
428             &mut *($enc.buf.as_mut_ptr().add(buffered) as *mut [MaybeUninit<u8>; MAX_ENCODED_LEN])
429         };
430
431         let encoded = leb128::$fun(buf, $value);
432         $enc.buffered = buffered + encoded.len();
433     }};
434 }
435
436 impl Encoder for FileEncoder {
437     #[inline]
438     fn emit_usize(&mut self, v: usize) {
439         file_encoder_write_leb128!(self, v, usize, write_usize_leb128)
440     }
441
442     #[inline]
443     fn emit_u128(&mut self, v: u128) {
444         file_encoder_write_leb128!(self, v, u128, write_u128_leb128)
445     }
446
447     #[inline]
448     fn emit_u64(&mut self, v: u64) {
449         file_encoder_write_leb128!(self, v, u64, write_u64_leb128)
450     }
451
452     #[inline]
453     fn emit_u32(&mut self, v: u32) {
454         file_encoder_write_leb128!(self, v, u32, write_u32_leb128)
455     }
456
457     #[inline]
458     fn emit_u16(&mut self, v: u16) {
459         self.write_all(&v.to_le_bytes());
460     }
461
462     #[inline]
463     fn emit_u8(&mut self, v: u8) {
464         self.write_one(v);
465     }
466
467     #[inline]
468     fn emit_isize(&mut self, v: isize) {
469         file_encoder_write_leb128!(self, v, isize, write_isize_leb128)
470     }
471
472     #[inline]
473     fn emit_i128(&mut self, v: i128) {
474         file_encoder_write_leb128!(self, v, i128, write_i128_leb128)
475     }
476
477     #[inline]
478     fn emit_i64(&mut self, v: i64) {
479         file_encoder_write_leb128!(self, v, i64, write_i64_leb128)
480     }
481
482     #[inline]
483     fn emit_i32(&mut self, v: i32) {
484         file_encoder_write_leb128!(self, v, i32, write_i32_leb128)
485     }
486
487     #[inline]
488     fn emit_i16(&mut self, v: i16) {
489         self.write_all(&v.to_le_bytes());
490     }
491
492     #[inline]
493     fn emit_i8(&mut self, v: i8) {
494         self.emit_u8(v as u8);
495     }
496
497     #[inline]
498     fn emit_bool(&mut self, v: bool) {
499         self.emit_u8(if v { 1 } else { 0 });
500     }
501
502     #[inline]
503     fn emit_f64(&mut self, v: f64) {
504         let as_u64: u64 = v.to_bits();
505         self.emit_u64(as_u64);
506     }
507
508     #[inline]
509     fn emit_f32(&mut self, v: f32) {
510         let as_u32: u32 = v.to_bits();
511         self.emit_u32(as_u32);
512     }
513
514     #[inline]
515     fn emit_char(&mut self, v: char) {
516         self.emit_u32(v as u32);
517     }
518
519     #[inline]
520     fn emit_str(&mut self, v: &str) {
521         self.emit_usize(v.len());
522         self.emit_raw_bytes(v.as_bytes());
523         self.emit_u8(STR_SENTINEL);
524     }
525
526     #[inline]
527     fn emit_raw_bytes(&mut self, s: &[u8]) {
528         self.write_all(s);
529     }
530 }
531
532 // -----------------------------------------------------------------------------
533 // Decoder
534 // -----------------------------------------------------------------------------
535
536 pub struct MemDecoder<'a> {
537     pub data: &'a [u8],
538     position: usize,
539 }
540
541 impl<'a> MemDecoder<'a> {
542     #[inline]
543     pub fn new(data: &'a [u8], position: usize) -> MemDecoder<'a> {
544         MemDecoder { data, position }
545     }
546
547     #[inline]
548     pub fn position(&self) -> usize {
549         self.position
550     }
551
552     #[inline]
553     pub fn set_position(&mut self, pos: usize) {
554         self.position = pos
555     }
556
557     #[inline]
558     pub fn advance(&mut self, bytes: usize) {
559         self.position += bytes;
560     }
561 }
562
563 macro_rules! read_leb128 {
564     ($dec:expr, $fun:ident) => {{ leb128::$fun($dec.data, &mut $dec.position) }};
565 }
566
567 impl<'a> Decoder for MemDecoder<'a> {
568     #[inline]
569     fn read_u128(&mut self) -> u128 {
570         read_leb128!(self, read_u128_leb128)
571     }
572
573     #[inline]
574     fn read_u64(&mut self) -> u64 {
575         read_leb128!(self, read_u64_leb128)
576     }
577
578     #[inline]
579     fn read_u32(&mut self) -> u32 {
580         read_leb128!(self, read_u32_leb128)
581     }
582
583     #[inline]
584     fn read_u16(&mut self) -> u16 {
585         let bytes = [self.data[self.position], self.data[self.position + 1]];
586         let value = u16::from_le_bytes(bytes);
587         self.position += 2;
588         value
589     }
590
591     #[inline]
592     fn read_u8(&mut self) -> u8 {
593         let value = self.data[self.position];
594         self.position += 1;
595         value
596     }
597
598     #[inline]
599     fn read_usize(&mut self) -> usize {
600         read_leb128!(self, read_usize_leb128)
601     }
602
603     #[inline]
604     fn read_i128(&mut self) -> i128 {
605         read_leb128!(self, read_i128_leb128)
606     }
607
608     #[inline]
609     fn read_i64(&mut self) -> i64 {
610         read_leb128!(self, read_i64_leb128)
611     }
612
613     #[inline]
614     fn read_i32(&mut self) -> i32 {
615         read_leb128!(self, read_i32_leb128)
616     }
617
618     #[inline]
619     fn read_i16(&mut self) -> i16 {
620         let bytes = [self.data[self.position], self.data[self.position + 1]];
621         let value = i16::from_le_bytes(bytes);
622         self.position += 2;
623         value
624     }
625
626     #[inline]
627     fn read_i8(&mut self) -> i8 {
628         let value = self.data[self.position];
629         self.position += 1;
630         value as i8
631     }
632
633     #[inline]
634     fn read_isize(&mut self) -> isize {
635         read_leb128!(self, read_isize_leb128)
636     }
637
638     #[inline]
639     fn read_bool(&mut self) -> bool {
640         let value = self.read_u8();
641         value != 0
642     }
643
644     #[inline]
645     fn read_f64(&mut self) -> f64 {
646         let bits = self.read_u64();
647         f64::from_bits(bits)
648     }
649
650     #[inline]
651     fn read_f32(&mut self) -> f32 {
652         let bits = self.read_u32();
653         f32::from_bits(bits)
654     }
655
656     #[inline]
657     fn read_char(&mut self) -> char {
658         let bits = self.read_u32();
659         std::char::from_u32(bits).unwrap()
660     }
661
662     #[inline]
663     fn read_str(&mut self) -> &'a str {
664         let len = self.read_usize();
665         let sentinel = self.data[self.position + len];
666         assert!(sentinel == STR_SENTINEL);
667         let s = unsafe {
668             std::str::from_utf8_unchecked(&self.data[self.position..self.position + len])
669         };
670         self.position += len + 1;
671         s
672     }
673
674     #[inline]
675     fn read_raw_bytes(&mut self, bytes: usize) -> &'a [u8] {
676         let start = self.position;
677         self.position += bytes;
678         &self.data[start..self.position]
679     }
680 }
681
682 // Specializations for contiguous byte sequences follow. The default implementations for slices
683 // encode and decode each element individually. This isn't necessary for `u8` slices when using
684 // opaque encoders and decoders, because each `u8` is unchanged by encoding and decoding.
685 // Therefore, we can use more efficient implementations that process the entire sequence at once.
686
687 // Specialize encoding byte slices. This specialization also applies to encoding `Vec<u8>`s, etc.,
688 // since the default implementations call `encode` on their slices internally.
689 impl Encodable<MemEncoder> for [u8] {
690     fn encode(&self, e: &mut MemEncoder) {
691         Encoder::emit_usize(e, self.len());
692         e.emit_raw_bytes(self);
693     }
694 }
695
696 impl Encodable<FileEncoder> for [u8] {
697     fn encode(&self, e: &mut FileEncoder) {
698         Encoder::emit_usize(e, self.len());
699         e.emit_raw_bytes(self);
700     }
701 }
702
703 // Specialize decoding `Vec<u8>`. This specialization also applies to decoding `Box<[u8]>`s, etc.,
704 // since the default implementations call `decode` to produce a `Vec<u8>` internally.
705 impl<'a> Decodable<MemDecoder<'a>> for Vec<u8> {
706     fn decode(d: &mut MemDecoder<'a>) -> Self {
707         let len = Decoder::read_usize(d);
708         d.read_raw_bytes(len).to_owned()
709     }
710 }
711
712 // An integer that will always encode to 8 bytes.
713 pub struct IntEncodedWithFixedSize(pub u64);
714
715 impl IntEncodedWithFixedSize {
716     pub const ENCODED_SIZE: usize = 8;
717 }
718
719 impl Encodable<MemEncoder> for IntEncodedWithFixedSize {
720     #[inline]
721     fn encode(&self, e: &mut MemEncoder) {
722         let _start_pos = e.position();
723         e.emit_raw_bytes(&self.0.to_le_bytes());
724         let _end_pos = e.position();
725         debug_assert_eq!((_end_pos - _start_pos), IntEncodedWithFixedSize::ENCODED_SIZE);
726     }
727 }
728
729 impl Encodable<FileEncoder> for IntEncodedWithFixedSize {
730     #[inline]
731     fn encode(&self, e: &mut FileEncoder) {
732         let _start_pos = e.position();
733         e.emit_raw_bytes(&self.0.to_le_bytes());
734         let _end_pos = e.position();
735         debug_assert_eq!((_end_pos - _start_pos), IntEncodedWithFixedSize::ENCODED_SIZE);
736     }
737 }
738
739 impl<'a> Decodable<MemDecoder<'a>> for IntEncodedWithFixedSize {
740     #[inline]
741     fn decode(decoder: &mut MemDecoder<'a>) -> IntEncodedWithFixedSize {
742         let _start_pos = decoder.position();
743         let bytes = decoder.read_raw_bytes(IntEncodedWithFixedSize::ENCODED_SIZE);
744         let value = u64::from_le_bytes(bytes.try_into().unwrap());
745         let _end_pos = decoder.position();
746         debug_assert_eq!((_end_pos - _start_pos), IntEncodedWithFixedSize::ENCODED_SIZE);
747
748         IntEncodedWithFixedSize(value)
749     }
750 }