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