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