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