]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_serialize/src/serialize.rs
660de8346a5bc910e3aab1cda108fae67d19fb24
[rust.git] / compiler / rustc_serialize / src / serialize.rs
1 //! Support code for encoding and decoding types.
2
3 /*
4 Core encoding and decoding interfaces.
5 */
6
7 use std::borrow::Cow;
8 use std::cell::{Cell, RefCell};
9 use std::marker::PhantomData;
10 use std::path;
11 use std::rc::Rc;
12 use std::sync::Arc;
13
14 pub trait Encoder {
15     type Error;
16
17     // Primitive types:
18     fn emit_unit(&mut self) -> Result<(), Self::Error>;
19     fn emit_usize(&mut self, v: usize) -> Result<(), Self::Error>;
20     fn emit_u128(&mut self, v: u128) -> Result<(), Self::Error>;
21     fn emit_u64(&mut self, v: u64) -> Result<(), Self::Error>;
22     fn emit_u32(&mut self, v: u32) -> Result<(), Self::Error>;
23     fn emit_u16(&mut self, v: u16) -> Result<(), Self::Error>;
24     fn emit_u8(&mut self, v: u8) -> Result<(), Self::Error>;
25     fn emit_isize(&mut self, v: isize) -> Result<(), Self::Error>;
26     fn emit_i128(&mut self, v: i128) -> Result<(), Self::Error>;
27     fn emit_i64(&mut self, v: i64) -> Result<(), Self::Error>;
28     fn emit_i32(&mut self, v: i32) -> Result<(), Self::Error>;
29     fn emit_i16(&mut self, v: i16) -> Result<(), Self::Error>;
30     fn emit_i8(&mut self, v: i8) -> Result<(), Self::Error>;
31     fn emit_bool(&mut self, v: bool) -> Result<(), Self::Error>;
32     fn emit_f64(&mut self, v: f64) -> Result<(), Self::Error>;
33     fn emit_f32(&mut self, v: f32) -> Result<(), Self::Error>;
34     fn emit_char(&mut self, v: char) -> Result<(), Self::Error>;
35     fn emit_str(&mut self, v: &str) -> Result<(), Self::Error>;
36     fn emit_raw_bytes(&mut self, s: &[u8]) -> Result<(), Self::Error>;
37
38     // Compound types:
39     #[inline]
40     fn emit_enum<F>(&mut self, f: F) -> Result<(), Self::Error>
41     where
42         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
43     {
44         f(self)
45     }
46
47     fn emit_enum_variant<F>(
48         &mut self,
49         _v_name: &str,
50         v_id: usize,
51         _len: usize,
52         f: F,
53     ) -> Result<(), Self::Error>
54     where
55         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
56     {
57         self.emit_usize(v_id)?;
58         f(self)
59     }
60
61     // We put the field index in a const generic to allow the emit_usize to be
62     // compiled into a more efficient form. In practice, the variant index is
63     // known at compile-time, and that knowledge allows much more efficient
64     // codegen than we'd otherwise get. LLVM isn't always able to make the
65     // optimization that would otherwise be necessary here, likely due to the
66     // multiple levels of inlining and const-prop that are needed.
67     #[inline]
68     fn emit_fieldless_enum_variant<const ID: usize>(
69         &mut self,
70         _v_name: &str,
71     ) -> Result<(), Self::Error> {
72         self.emit_usize(ID)
73     }
74
75     #[inline]
76     fn emit_enum_variant_arg<F>(&mut self, _first: bool, f: F) -> Result<(), Self::Error>
77     where
78         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
79     {
80         f(self)
81     }
82
83     #[inline]
84     fn emit_struct<F>(&mut self, _no_fields: bool, f: F) -> Result<(), Self::Error>
85     where
86         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
87     {
88         f(self)
89     }
90
91     #[inline]
92     fn emit_struct_field<F>(&mut self, _f_name: &str, _first: bool, f: F) -> Result<(), Self::Error>
93     where
94         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
95     {
96         f(self)
97     }
98
99     #[inline]
100     fn emit_tuple<F>(&mut self, _len: usize, f: F) -> Result<(), Self::Error>
101     where
102         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
103     {
104         f(self)
105     }
106
107     #[inline]
108     fn emit_tuple_arg<F>(&mut self, _idx: usize, f: F) -> Result<(), Self::Error>
109     where
110         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
111     {
112         f(self)
113     }
114
115     // Specialized types:
116     fn emit_option<F>(&mut self, f: F) -> Result<(), Self::Error>
117     where
118         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
119     {
120         self.emit_enum(f)
121     }
122
123     #[inline]
124     fn emit_option_none(&mut self) -> Result<(), Self::Error> {
125         self.emit_enum_variant("None", 0, 0, |_| Ok(()))
126     }
127
128     fn emit_option_some<F>(&mut self, f: F) -> Result<(), Self::Error>
129     where
130         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
131     {
132         self.emit_enum_variant("Some", 1, 1, f)
133     }
134
135     fn emit_seq<F>(&mut self, len: usize, f: F) -> Result<(), Self::Error>
136     where
137         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
138     {
139         self.emit_usize(len)?;
140         f(self)
141     }
142
143     #[inline]
144     fn emit_seq_elt<F>(&mut self, _idx: usize, f: F) -> Result<(), Self::Error>
145     where
146         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
147     {
148         f(self)
149     }
150
151     fn emit_map<F>(&mut self, len: usize, f: F) -> Result<(), Self::Error>
152     where
153         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
154     {
155         self.emit_usize(len)?;
156         f(self)
157     }
158
159     #[inline]
160     fn emit_map_elt_key<F>(&mut self, _idx: usize, f: F) -> Result<(), Self::Error>
161     where
162         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
163     {
164         f(self)
165     }
166
167     #[inline]
168     fn emit_map_elt_val<F>(&mut self, f: F) -> Result<(), Self::Error>
169     where
170         F: FnOnce(&mut Self) -> Result<(), Self::Error>,
171     {
172         f(self)
173     }
174 }
175
176 // Note: all the methods in this trait are infallible, which may be surprising.
177 // They used to be fallible (i.e. return a `Result`) but many of the impls just
178 // panicked when something went wrong, and for the cases that didn't the
179 // top-level invocation would also just panic on failure. Switching to
180 // infallibility made things faster and lots of code a little simpler and more
181 // concise.
182 pub trait Decoder {
183     // Primitive types:
184     fn read_unit(&mut self) -> ();
185     fn read_usize(&mut self) -> usize;
186     fn read_u128(&mut self) -> u128;
187     fn read_u64(&mut self) -> u64;
188     fn read_u32(&mut self) -> u32;
189     fn read_u16(&mut self) -> u16;
190     fn read_u8(&mut self) -> u8;
191     fn read_isize(&mut self) -> isize;
192     fn read_i128(&mut self) -> i128;
193     fn read_i64(&mut self) -> i64;
194     fn read_i32(&mut self) -> i32;
195     fn read_i16(&mut self) -> i16;
196     fn read_i8(&mut self) -> i8;
197     fn read_bool(&mut self) -> bool;
198     fn read_f64(&mut self) -> f64;
199     fn read_f32(&mut self) -> f32;
200     fn read_char(&mut self) -> char;
201     fn read_str(&mut self) -> Cow<'_, str>;
202     fn read_raw_bytes_into(&mut self, s: &mut [u8]);
203
204     #[inline]
205     fn read_enum_variant<T, F>(&mut self, mut f: F) -> T
206     where
207         F: FnMut(&mut Self, usize) -> T,
208     {
209         let disr = self.read_usize();
210         f(self, disr)
211     }
212
213     // Specialized types:
214     fn read_option<T, F>(&mut self, mut f: F) -> T
215     where
216         F: FnMut(&mut Self, bool) -> T,
217     {
218         self.read_enum_variant(move |this, idx| match idx {
219             0 => f(this, false),
220             1 => f(this, true),
221             _ => panic!("read_option: expected 0 for None or 1 for Some"),
222         })
223     }
224
225     fn read_seq<T, F>(&mut self, f: F) -> T
226     where
227         F: FnOnce(&mut Self, usize) -> T,
228     {
229         let len = self.read_usize();
230         f(self, len)
231     }
232
233     #[inline]
234     fn read_seq_elt<T, F>(&mut self, f: F) -> T
235     where
236         F: FnOnce(&mut Self) -> T,
237     {
238         f(self)
239     }
240
241     fn read_map<T, F>(&mut self, f: F) -> T
242     where
243         F: FnOnce(&mut Self, usize) -> T,
244     {
245         let len = self.read_usize();
246         f(self, len)
247     }
248
249     #[inline]
250     fn read_map_elt_key<T, F>(&mut self, f: F) -> T
251     where
252         F: FnOnce(&mut Self) -> T,
253     {
254         f(self)
255     }
256
257     #[inline]
258     fn read_map_elt_val<T, F>(&mut self, f: F) -> T
259     where
260         F: FnOnce(&mut Self) -> T,
261     {
262         f(self)
263     }
264 }
265
266 /// Trait for types that can be serialized
267 ///
268 /// This can be implemented using the `Encodable`, `TyEncodable` and
269 /// `MetadataEncodable` macros.
270 ///
271 /// * `Encodable` should be used in crates that don't depend on
272 ///   `rustc_middle`.
273 /// * `MetadataEncodable` is used in `rustc_metadata` for types that contain
274 ///   `rustc_metadata::rmeta::Lazy`.
275 /// * `TyEncodable` should be used for types that are only serialized in crate
276 ///   metadata or the incremental cache. This is most types in `rustc_middle`.
277 pub trait Encodable<S: Encoder> {
278     fn encode(&self, s: &mut S) -> Result<(), S::Error>;
279 }
280
281 /// Trait for types that can be deserialized
282 ///
283 /// This can be implemented using the `Decodable`, `TyDecodable` and
284 /// `MetadataDecodable` macros.
285 ///
286 /// * `Decodable` should be used in crates that don't depend on
287 ///   `rustc_middle`.
288 /// * `MetadataDecodable` is used in `rustc_metadata` for types that contain
289 ///   `rustc_metadata::rmeta::Lazy`.
290 /// * `TyDecodable` should be used for types that are only serialized in crate
291 ///   metadata or the incremental cache. This is most types in `rustc_middle`.
292 pub trait Decodable<D: Decoder>: Sized {
293     fn decode(d: &mut D) -> Self;
294 }
295
296 macro_rules! direct_serialize_impls {
297     ($($ty:ident $emit_method:ident $read_method:ident),*) => {
298         $(
299             impl<S: Encoder> Encodable<S> for $ty {
300                 fn encode(&self, s: &mut S) -> Result<(), S::Error> {
301                     s.$emit_method(*self)
302                 }
303             }
304
305             impl<D: Decoder> Decodable<D> for $ty {
306                 fn decode(d: &mut D) -> $ty {
307                     d.$read_method()
308                 }
309             }
310         )*
311     }
312 }
313
314 direct_serialize_impls! {
315     usize emit_usize read_usize,
316     u8 emit_u8 read_u8,
317     u16 emit_u16 read_u16,
318     u32 emit_u32 read_u32,
319     u64 emit_u64 read_u64,
320     u128 emit_u128 read_u128,
321     isize emit_isize read_isize,
322     i8 emit_i8 read_i8,
323     i16 emit_i16 read_i16,
324     i32 emit_i32 read_i32,
325     i64 emit_i64 read_i64,
326     i128 emit_i128 read_i128,
327     f32 emit_f32 read_f32,
328     f64 emit_f64 read_f64,
329     bool emit_bool read_bool,
330     char emit_char read_char
331 }
332
333 impl<S: Encoder> Encodable<S> for ! {
334     fn encode(&self, _s: &mut S) -> Result<(), S::Error> {
335         unreachable!()
336     }
337 }
338
339 impl<D: Decoder> Decodable<D> for ! {
340     fn decode(_d: &mut D) -> ! {
341         unreachable!()
342     }
343 }
344
345 impl<S: Encoder> Encodable<S> for ::std::num::NonZeroU32 {
346     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
347         s.emit_u32(self.get())
348     }
349 }
350
351 impl<D: Decoder> Decodable<D> for ::std::num::NonZeroU32 {
352     fn decode(d: &mut D) -> Self {
353         ::std::num::NonZeroU32::new(d.read_u32()).unwrap()
354     }
355 }
356
357 impl<S: Encoder> Encodable<S> for str {
358     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
359         s.emit_str(self)
360     }
361 }
362
363 impl<S: Encoder> Encodable<S> for &str {
364     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
365         s.emit_str(self)
366     }
367 }
368
369 impl<S: Encoder> Encodable<S> for String {
370     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
371         s.emit_str(&self[..])
372     }
373 }
374
375 impl<D: Decoder> Decodable<D> for String {
376     fn decode(d: &mut D) -> String {
377         d.read_str().into_owned()
378     }
379 }
380
381 impl<S: Encoder> Encodable<S> for () {
382     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
383         s.emit_unit()
384     }
385 }
386
387 impl<D: Decoder> Decodable<D> for () {
388     fn decode(d: &mut D) -> () {
389         d.read_unit()
390     }
391 }
392
393 impl<S: Encoder, T> Encodable<S> for PhantomData<T> {
394     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
395         s.emit_unit()
396     }
397 }
398
399 impl<D: Decoder, T> Decodable<D> for PhantomData<T> {
400     fn decode(d: &mut D) -> PhantomData<T> {
401         d.read_unit();
402         PhantomData
403     }
404 }
405
406 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Box<[T]> {
407     fn decode(d: &mut D) -> Box<[T]> {
408         let v: Vec<T> = Decodable::decode(d);
409         v.into_boxed_slice()
410     }
411 }
412
413 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Rc<T> {
414     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
415         (**self).encode(s)
416     }
417 }
418
419 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Rc<T> {
420     fn decode(d: &mut D) -> Rc<T> {
421         Rc::new(Decodable::decode(d))
422     }
423 }
424
425 impl<S: Encoder, T: Encodable<S>> Encodable<S> for [T] {
426     default fn encode(&self, s: &mut S) -> Result<(), S::Error> {
427         s.emit_seq(self.len(), |s| {
428             for (i, e) in self.iter().enumerate() {
429                 s.emit_seq_elt(i, |s| e.encode(s))?
430             }
431             Ok(())
432         })
433     }
434 }
435
436 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Vec<T> {
437     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
438         let slice: &[T] = self;
439         slice.encode(s)
440     }
441 }
442
443 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Vec<T> {
444     default fn decode(d: &mut D) -> Vec<T> {
445         d.read_seq(|d, len| {
446             // SAFETY: we set the capacity in advance, only write elements, and
447             // only set the length at the end once the writing has succeeded.
448             let mut vec = Vec::with_capacity(len);
449             unsafe {
450                 let ptr: *mut T = vec.as_mut_ptr();
451                 for i in 0..len {
452                     std::ptr::write(
453                         ptr.offset(i as isize),
454                         d.read_seq_elt(|d| Decodable::decode(d)),
455                     );
456                 }
457                 vec.set_len(len);
458             }
459             vec
460         })
461     }
462 }
463
464 impl<S: Encoder, T: Encodable<S>, const N: usize> Encodable<S> for [T; N] {
465     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
466         let slice: &[T] = self;
467         slice.encode(s)
468     }
469 }
470
471 impl<D: Decoder, const N: usize> Decodable<D> for [u8; N] {
472     fn decode(d: &mut D) -> [u8; N] {
473         d.read_seq(|d, len| {
474             assert!(len == N);
475             let mut v = [0u8; N];
476             for i in 0..len {
477                 v[i] = d.read_seq_elt(|d| Decodable::decode(d));
478             }
479             v
480         })
481     }
482 }
483
484 impl<'a, S: Encoder, T: Encodable<S>> Encodable<S> for Cow<'a, [T]>
485 where
486     [T]: ToOwned<Owned = Vec<T>>,
487 {
488     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
489         let slice: &[T] = self;
490         slice.encode(s)
491     }
492 }
493
494 impl<D: Decoder, T: Decodable<D> + ToOwned> Decodable<D> for Cow<'static, [T]>
495 where
496     [T]: ToOwned<Owned = Vec<T>>,
497 {
498     fn decode(d: &mut D) -> Cow<'static, [T]> {
499         let v: Vec<T> = Decodable::decode(d);
500         Cow::Owned(v)
501     }
502 }
503
504 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Option<T> {
505     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
506         s.emit_option(|s| match *self {
507             None => s.emit_option_none(),
508             Some(ref v) => s.emit_option_some(|s| v.encode(s)),
509         })
510     }
511 }
512
513 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Option<T> {
514     fn decode(d: &mut D) -> Option<T> {
515         d.read_option(|d, b| if b { Some(Decodable::decode(d)) } else { None })
516     }
517 }
518
519 impl<S: Encoder, T1: Encodable<S>, T2: Encodable<S>> Encodable<S> for Result<T1, T2> {
520     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
521         s.emit_enum(|s| match *self {
522             Ok(ref v) => {
523                 s.emit_enum_variant("Ok", 0, 1, |s| s.emit_enum_variant_arg(true, |s| v.encode(s)))
524             }
525             Err(ref v) => {
526                 s.emit_enum_variant("Err", 1, 1, |s| s.emit_enum_variant_arg(true, |s| v.encode(s)))
527             }
528         })
529     }
530 }
531
532 impl<D: Decoder, T1: Decodable<D>, T2: Decodable<D>> Decodable<D> for Result<T1, T2> {
533     fn decode(d: &mut D) -> Result<T1, T2> {
534         d.read_enum_variant(|d, disr| match disr {
535             0 => Ok(T1::decode(d)),
536             1 => Err(T2::decode(d)),
537             _ => panic!("Encountered invalid discriminant while decoding `Result`."),
538         })
539     }
540 }
541
542 macro_rules! peel {
543     ($name:ident, $($other:ident,)*) => (tuple! { $($other,)* })
544 }
545
546 /// Evaluates to the number of tokens passed to it.
547 ///
548 /// Logarithmic counting: every one or two recursive expansions, the number of
549 /// tokens to count is divided by two, instead of being reduced by one.
550 /// Therefore, the recursion depth is the binary logarithm of the number of
551 /// tokens to count, and the expanded tree is likewise very small.
552 macro_rules! count {
553     ()                     => (0usize);
554     ($one:tt)              => (1usize);
555     ($($pairs:tt $_p:tt)*) => (count!($($pairs)*) << 1usize);
556     ($odd:tt $($rest:tt)*) => (count!($($rest)*) | 1usize);
557 }
558
559 macro_rules! tuple {
560     () => ();
561     ( $($name:ident,)+ ) => (
562         impl<D: Decoder, $($name: Decodable<D>),+> Decodable<D> for ($($name,)+) {
563             fn decode(d: &mut D) -> ($($name,)+) {
564                 ($({ let element: $name = Decodable::decode(d); element },)+)
565             }
566         }
567         impl<S: Encoder, $($name: Encodable<S>),+> Encodable<S> for ($($name,)+) {
568             #[allow(non_snake_case)]
569             fn encode(&self, s: &mut S) -> Result<(), S::Error> {
570                 let ($(ref $name,)+) = *self;
571                 let len: usize = count!($($name)+);
572                 s.emit_tuple(len, |s| {
573                     let mut i = 0;
574                     $(s.emit_tuple_arg({ i+=1; i-1 }, |s| $name.encode(s))?;)+
575                     Ok(())
576                 })
577             }
578         }
579         peel! { $($name,)+ }
580     )
581 }
582
583 tuple! { T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, }
584
585 impl<S: Encoder> Encodable<S> for path::Path {
586     fn encode(&self, e: &mut S) -> Result<(), S::Error> {
587         self.to_str().unwrap().encode(e)
588     }
589 }
590
591 impl<S: Encoder> Encodable<S> for path::PathBuf {
592     fn encode(&self, e: &mut S) -> Result<(), S::Error> {
593         path::Path::encode(self, e)
594     }
595 }
596
597 impl<D: Decoder> Decodable<D> for path::PathBuf {
598     fn decode(d: &mut D) -> path::PathBuf {
599         let bytes: String = Decodable::decode(d);
600         path::PathBuf::from(bytes)
601     }
602 }
603
604 impl<S: Encoder, T: Encodable<S> + Copy> Encodable<S> for Cell<T> {
605     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
606         self.get().encode(s)
607     }
608 }
609
610 impl<D: Decoder, T: Decodable<D> + Copy> Decodable<D> for Cell<T> {
611     fn decode(d: &mut D) -> Cell<T> {
612         Cell::new(Decodable::decode(d))
613     }
614 }
615
616 // FIXME: #15036
617 // Should use `try_borrow`, returning an
618 // `encoder.error("attempting to Encode borrowed RefCell")`
619 // from `encode` when `try_borrow` returns `None`.
620
621 impl<S: Encoder, T: Encodable<S>> Encodable<S> for RefCell<T> {
622     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
623         self.borrow().encode(s)
624     }
625 }
626
627 impl<D: Decoder, T: Decodable<D>> Decodable<D> for RefCell<T> {
628     fn decode(d: &mut D) -> RefCell<T> {
629         RefCell::new(Decodable::decode(d))
630     }
631 }
632
633 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Arc<T> {
634     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
635         (**self).encode(s)
636     }
637 }
638
639 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Arc<T> {
640     fn decode(d: &mut D) -> Arc<T> {
641         Arc::new(Decodable::decode(d))
642     }
643 }
644
645 impl<S: Encoder, T: ?Sized + Encodable<S>> Encodable<S> for Box<T> {
646     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
647         (**self).encode(s)
648     }
649 }
650 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Box<T> {
651     fn decode(d: &mut D) -> Box<T> {
652         Box::new(Decodable::decode(d))
653     }
654 }