]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_serialize/src/serialize.rs
0ecddf8c52f2a7b76e0e602c8164bc93cac54994
[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     #[inline]
214     fn read_tuple_arg<T, F>(&mut self, f: F) -> T
215     where
216         F: FnOnce(&mut Self) -> T,
217     {
218         f(self)
219     }
220
221     // Specialized types:
222     fn read_option<T, F>(&mut self, mut f: F) -> T
223     where
224         F: FnMut(&mut Self, bool) -> T,
225     {
226         self.read_enum_variant(move |this, idx| match idx {
227             0 => f(this, false),
228             1 => f(this, true),
229             _ => panic!("read_option: expected 0 for None or 1 for Some"),
230         })
231     }
232
233     fn read_seq<T, F>(&mut self, f: F) -> T
234     where
235         F: FnOnce(&mut Self, usize) -> T,
236     {
237         let len = self.read_usize();
238         f(self, len)
239     }
240
241     #[inline]
242     fn read_seq_elt<T, F>(&mut self, f: F) -> T
243     where
244         F: FnOnce(&mut Self) -> T,
245     {
246         f(self)
247     }
248
249     fn read_map<T, F>(&mut self, f: F) -> T
250     where
251         F: FnOnce(&mut Self, usize) -> T,
252     {
253         let len = self.read_usize();
254         f(self, len)
255     }
256
257     #[inline]
258     fn read_map_elt_key<T, F>(&mut self, f: F) -> T
259     where
260         F: FnOnce(&mut Self) -> T,
261     {
262         f(self)
263     }
264
265     #[inline]
266     fn read_map_elt_val<T, F>(&mut self, f: F) -> T
267     where
268         F: FnOnce(&mut Self) -> T,
269     {
270         f(self)
271     }
272 }
273
274 /// Trait for types that can be serialized
275 ///
276 /// This can be implemented using the `Encodable`, `TyEncodable` and
277 /// `MetadataEncodable` macros.
278 ///
279 /// * `Encodable` should be used in crates that don't depend on
280 ///   `rustc_middle`.
281 /// * `MetadataEncodable` is used in `rustc_metadata` for types that contain
282 ///   `rustc_metadata::rmeta::Lazy`.
283 /// * `TyEncodable` should be used for types that are only serialized in crate
284 ///   metadata or the incremental cache. This is most types in `rustc_middle`.
285 pub trait Encodable<S: Encoder> {
286     fn encode(&self, s: &mut S) -> Result<(), S::Error>;
287 }
288
289 /// Trait for types that can be deserialized
290 ///
291 /// This can be implemented using the `Decodable`, `TyDecodable` and
292 /// `MetadataDecodable` macros.
293 ///
294 /// * `Decodable` should be used in crates that don't depend on
295 ///   `rustc_middle`.
296 /// * `MetadataDecodable` is used in `rustc_metadata` for types that contain
297 ///   `rustc_metadata::rmeta::Lazy`.
298 /// * `TyDecodable` should be used for types that are only serialized in crate
299 ///   metadata or the incremental cache. This is most types in `rustc_middle`.
300 pub trait Decodable<D: Decoder>: Sized {
301     fn decode(d: &mut D) -> Self;
302 }
303
304 macro_rules! direct_serialize_impls {
305     ($($ty:ident $emit_method:ident $read_method:ident),*) => {
306         $(
307             impl<S: Encoder> Encodable<S> for $ty {
308                 fn encode(&self, s: &mut S) -> Result<(), S::Error> {
309                     s.$emit_method(*self)
310                 }
311             }
312
313             impl<D: Decoder> Decodable<D> for $ty {
314                 fn decode(d: &mut D) -> $ty {
315                     d.$read_method()
316                 }
317             }
318         )*
319     }
320 }
321
322 direct_serialize_impls! {
323     usize emit_usize read_usize,
324     u8 emit_u8 read_u8,
325     u16 emit_u16 read_u16,
326     u32 emit_u32 read_u32,
327     u64 emit_u64 read_u64,
328     u128 emit_u128 read_u128,
329     isize emit_isize read_isize,
330     i8 emit_i8 read_i8,
331     i16 emit_i16 read_i16,
332     i32 emit_i32 read_i32,
333     i64 emit_i64 read_i64,
334     i128 emit_i128 read_i128,
335     f32 emit_f32 read_f32,
336     f64 emit_f64 read_f64,
337     bool emit_bool read_bool,
338     char emit_char read_char
339 }
340
341 impl<S: Encoder> Encodable<S> for ! {
342     fn encode(&self, _s: &mut S) -> Result<(), S::Error> {
343         unreachable!()
344     }
345 }
346
347 impl<D: Decoder> Decodable<D> for ! {
348     fn decode(_d: &mut D) -> ! {
349         unreachable!()
350     }
351 }
352
353 impl<S: Encoder> Encodable<S> for ::std::num::NonZeroU32 {
354     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
355         s.emit_u32(self.get())
356     }
357 }
358
359 impl<D: Decoder> Decodable<D> for ::std::num::NonZeroU32 {
360     fn decode(d: &mut D) -> Self {
361         ::std::num::NonZeroU32::new(d.read_u32()).unwrap()
362     }
363 }
364
365 impl<S: Encoder> Encodable<S> for str {
366     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
367         s.emit_str(self)
368     }
369 }
370
371 impl<S: Encoder> Encodable<S> for &str {
372     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
373         s.emit_str(self)
374     }
375 }
376
377 impl<S: Encoder> Encodable<S> for String {
378     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
379         s.emit_str(&self[..])
380     }
381 }
382
383 impl<D: Decoder> Decodable<D> for String {
384     fn decode(d: &mut D) -> String {
385         d.read_str().into_owned()
386     }
387 }
388
389 impl<S: Encoder> Encodable<S> for () {
390     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
391         s.emit_unit()
392     }
393 }
394
395 impl<D: Decoder> Decodable<D> for () {
396     fn decode(d: &mut D) -> () {
397         d.read_unit()
398     }
399 }
400
401 impl<S: Encoder, T> Encodable<S> for PhantomData<T> {
402     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
403         s.emit_unit()
404     }
405 }
406
407 impl<D: Decoder, T> Decodable<D> for PhantomData<T> {
408     fn decode(d: &mut D) -> PhantomData<T> {
409         d.read_unit();
410         PhantomData
411     }
412 }
413
414 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Box<[T]> {
415     fn decode(d: &mut D) -> Box<[T]> {
416         let v: Vec<T> = Decodable::decode(d);
417         v.into_boxed_slice()
418     }
419 }
420
421 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Rc<T> {
422     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
423         (**self).encode(s)
424     }
425 }
426
427 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Rc<T> {
428     fn decode(d: &mut D) -> Rc<T> {
429         Rc::new(Decodable::decode(d))
430     }
431 }
432
433 impl<S: Encoder, T: Encodable<S>> Encodable<S> for [T] {
434     default fn encode(&self, s: &mut S) -> Result<(), S::Error> {
435         s.emit_seq(self.len(), |s| {
436             for (i, e) in self.iter().enumerate() {
437                 s.emit_seq_elt(i, |s| e.encode(s))?
438             }
439             Ok(())
440         })
441     }
442 }
443
444 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Vec<T> {
445     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
446         let slice: &[T] = self;
447         slice.encode(s)
448     }
449 }
450
451 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Vec<T> {
452     default fn decode(d: &mut D) -> Vec<T> {
453         d.read_seq(|d, len| {
454             // SAFETY: we set the capacity in advance, only write elements, and
455             // only set the length at the end once the writing has succeeded.
456             let mut vec = Vec::with_capacity(len);
457             unsafe {
458                 let ptr: *mut T = vec.as_mut_ptr();
459                 for i in 0..len {
460                     std::ptr::write(
461                         ptr.offset(i as isize),
462                         d.read_seq_elt(|d| Decodable::decode(d)),
463                     );
464                 }
465                 vec.set_len(len);
466             }
467             vec
468         })
469     }
470 }
471
472 impl<S: Encoder, T: Encodable<S>, const N: usize> Encodable<S> for [T; N] {
473     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
474         let slice: &[T] = self;
475         slice.encode(s)
476     }
477 }
478
479 impl<D: Decoder, const N: usize> Decodable<D> for [u8; N] {
480     fn decode(d: &mut D) -> [u8; N] {
481         d.read_seq(|d, len| {
482             assert!(len == N);
483             let mut v = [0u8; N];
484             for i in 0..len {
485                 v[i] = d.read_seq_elt(|d| Decodable::decode(d));
486             }
487             v
488         })
489     }
490 }
491
492 impl<'a, S: Encoder, T: Encodable<S>> Encodable<S> for Cow<'a, [T]>
493 where
494     [T]: ToOwned<Owned = Vec<T>>,
495 {
496     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
497         let slice: &[T] = self;
498         slice.encode(s)
499     }
500 }
501
502 impl<D: Decoder, T: Decodable<D> + ToOwned> Decodable<D> for Cow<'static, [T]>
503 where
504     [T]: ToOwned<Owned = Vec<T>>,
505 {
506     fn decode(d: &mut D) -> Cow<'static, [T]> {
507         let v: Vec<T> = Decodable::decode(d);
508         Cow::Owned(v)
509     }
510 }
511
512 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Option<T> {
513     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
514         s.emit_option(|s| match *self {
515             None => s.emit_option_none(),
516             Some(ref v) => s.emit_option_some(|s| v.encode(s)),
517         })
518     }
519 }
520
521 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Option<T> {
522     fn decode(d: &mut D) -> Option<T> {
523         d.read_option(|d, b| if b { Some(Decodable::decode(d)) } else { None })
524     }
525 }
526
527 impl<S: Encoder, T1: Encodable<S>, T2: Encodable<S>> Encodable<S> for Result<T1, T2> {
528     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
529         s.emit_enum(|s| match *self {
530             Ok(ref v) => {
531                 s.emit_enum_variant("Ok", 0, 1, |s| s.emit_enum_variant_arg(true, |s| v.encode(s)))
532             }
533             Err(ref v) => {
534                 s.emit_enum_variant("Err", 1, 1, |s| s.emit_enum_variant_arg(true, |s| v.encode(s)))
535             }
536         })
537     }
538 }
539
540 impl<D: Decoder, T1: Decodable<D>, T2: Decodable<D>> Decodable<D> for Result<T1, T2> {
541     fn decode(d: &mut D) -> Result<T1, T2> {
542         d.read_enum_variant(|d, disr| match disr {
543             0 => Ok(T1::decode(d)),
544             1 => Err(T2::decode(d)),
545             _ => panic!("Encountered invalid discriminant while decoding `Result`."),
546         })
547     }
548 }
549
550 macro_rules! peel {
551     ($name:ident, $($other:ident,)*) => (tuple! { $($other,)* })
552 }
553
554 /// Evaluates to the number of tokens passed to it.
555 ///
556 /// Logarithmic counting: every one or two recursive expansions, the number of
557 /// tokens to count is divided by two, instead of being reduced by one.
558 /// Therefore, the recursion depth is the binary logarithm of the number of
559 /// tokens to count, and the expanded tree is likewise very small.
560 macro_rules! count {
561     ()                     => (0usize);
562     ($one:tt)              => (1usize);
563     ($($pairs:tt $_p:tt)*) => (count!($($pairs)*) << 1usize);
564     ($odd:tt $($rest:tt)*) => (count!($($rest)*) | 1usize);
565 }
566
567 macro_rules! tuple {
568     () => ();
569     ( $($name:ident,)+ ) => (
570         impl<D: Decoder, $($name: Decodable<D>),+> Decodable<D> for ($($name,)+) {
571             #[allow(non_snake_case)]
572             fn decode(d: &mut D) -> ($($name,)+) {
573                 ($(d.read_tuple_arg(|d| -> $name {
574                     Decodable::decode(d)
575                 }),)+)
576             }
577         }
578         impl<S: Encoder, $($name: Encodable<S>),+> Encodable<S> for ($($name,)+) {
579             #[allow(non_snake_case)]
580             fn encode(&self, s: &mut S) -> Result<(), S::Error> {
581                 let ($(ref $name,)+) = *self;
582                 let len: usize = count!($($name)+);
583                 s.emit_tuple(len, |s| {
584                     let mut i = 0;
585                     $(s.emit_tuple_arg({ i+=1; i-1 }, |s| $name.encode(s))?;)+
586                     Ok(())
587                 })
588             }
589         }
590         peel! { $($name,)+ }
591     )
592 }
593
594 tuple! { T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, }
595
596 impl<S: Encoder> Encodable<S> for path::Path {
597     fn encode(&self, e: &mut S) -> Result<(), S::Error> {
598         self.to_str().unwrap().encode(e)
599     }
600 }
601
602 impl<S: Encoder> Encodable<S> for path::PathBuf {
603     fn encode(&self, e: &mut S) -> Result<(), S::Error> {
604         path::Path::encode(self, e)
605     }
606 }
607
608 impl<D: Decoder> Decodable<D> for path::PathBuf {
609     fn decode(d: &mut D) -> path::PathBuf {
610         let bytes: String = Decodable::decode(d);
611         path::PathBuf::from(bytes)
612     }
613 }
614
615 impl<S: Encoder, T: Encodable<S> + Copy> Encodable<S> for Cell<T> {
616     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
617         self.get().encode(s)
618     }
619 }
620
621 impl<D: Decoder, T: Decodable<D> + Copy> Decodable<D> for Cell<T> {
622     fn decode(d: &mut D) -> Cell<T> {
623         Cell::new(Decodable::decode(d))
624     }
625 }
626
627 // FIXME: #15036
628 // Should use `try_borrow`, returning an
629 // `encoder.error("attempting to Encode borrowed RefCell")`
630 // from `encode` when `try_borrow` returns `None`.
631
632 impl<S: Encoder, T: Encodable<S>> Encodable<S> for RefCell<T> {
633     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
634         self.borrow().encode(s)
635     }
636 }
637
638 impl<D: Decoder, T: Decodable<D>> Decodable<D> for RefCell<T> {
639     fn decode(d: &mut D) -> RefCell<T> {
640         RefCell::new(Decodable::decode(d))
641     }
642 }
643
644 impl<S: Encoder, T: Encodable<S>> Encodable<S> for Arc<T> {
645     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
646         (**self).encode(s)
647     }
648 }
649
650 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Arc<T> {
651     fn decode(d: &mut D) -> Arc<T> {
652         Arc::new(Decodable::decode(d))
653     }
654 }
655
656 impl<S: Encoder, T: ?Sized + Encodable<S>> Encodable<S> for Box<T> {
657     fn encode(&self, s: &mut S) -> Result<(), S::Error> {
658         (**self).encode(s)
659     }
660 }
661 impl<D: Decoder, T: Decodable<D>> Decodable<D> for Box<T> {
662     fn decode(d: &mut D) -> Box<T> {
663         Box::new(Decodable::decode(d))
664     }
665 }