compiler/rustc_metadata/src/rmeta/table.rs

   1 use crate::rmeta::*;
   2
   3 use rustc_data_structures::fingerprint::Fingerprint;
   4 use rustc_hir::def::{CtorKind, CtorOf};
   5 use rustc_index::vec::Idx;
   6 use rustc_middle::ty::ParameterizedOverTcx;
   7 use rustc_serialize::opaque::FileEncoder;
   8 use rustc_serialize::Encoder as _;
   9 use rustc_span::hygiene::MacroKind;
  10 use std::convert::TryInto;
  11 use std::marker::PhantomData;
  12 use std::num::NonZeroUsize;
  13
  14 /// Helper trait, for encoding to, and decoding from, a fixed number of bytes.
  15 /// Used mainly for Lazy positions and lengths.
  16 /// Unchecked invariant: `Self::default()` should encode as `[0; BYTE_LEN]`,
  17 /// but this has no impact on safety.
  18 pub(super) trait FixedSizeEncoding: Default {
  19     /// This should be `[u8; BYTE_LEN]`;
  20     type ByteArray;
  21
  22     fn from_bytes(b: &Self::ByteArray) -> Self;
  23     fn write_to_bytes(self, b: &mut Self::ByteArray);
  24 }
  25
  26 impl FixedSizeEncoding for u32 {
  27     type ByteArray = [u8; 4];
  28
  29     #[inline]
  30     fn from_bytes(b: &[u8; 4]) -> Self {
  31         Self::from_le_bytes(*b)
  32     }
  33
  34     #[inline]
  35     fn write_to_bytes(self, b: &mut [u8; 4]) {
  36         *b = self.to_le_bytes();
  37     }
  38 }
  39
  40 macro_rules! fixed_size_enum {
  41     ($ty:ty { $(($($pat:tt)*))* }) => {
  42         impl FixedSizeEncoding for Option<$ty> {
  43             type ByteArray = [u8;1];
  44
  45             #[inline]
  46             fn from_bytes(b: &[u8;1]) -> Self {
  47                 use $ty::*;
  48                 if b[0] == 0 {
  49                     return None;
  50                 }
  51                 match b[0] - 1 {
  52                     $(${index()} => Some($($pat)*),)*
  53                     _ => panic!("Unexpected ImplPolarity code: {:?}", b[0]),
  54                 }
  55             }
  56
  57             #[inline]
  58             fn write_to_bytes(self, b: &mut [u8;1]) {
  59                 use $ty::*;
  60                 b[0] = match self {
  61                     None => 0,
  62                     $(Some($($pat)*) => 1 + ${index()},)*
  63                 }
  64             }
  65         }
  66     }
  67 }
  68
  69 fixed_size_enum! {
  70     DefKind {
  71         ( Mod                                      )
  72         ( Struct                                   )
  73         ( Union                                    )
  74         ( Enum                                     )
  75         ( Variant                                  )
  76         ( Trait                                    )
  77         ( TyAlias                                  )
  78         ( ForeignTy                                )
  79         ( TraitAlias                               )
  80         ( AssocTy                                  )
  81         ( TyParam                                  )
  82         ( Fn                                       )
  83         ( Const                                    )
  84         ( ConstParam                               )
  85         ( AssocFn                                  )
  86         ( AssocConst                               )
  87         ( ExternCrate                              )
  88         ( Use                                      )
  89         ( ForeignMod                               )
  90         ( AnonConst                                )
  91         ( InlineConst                              )
  92         ( OpaqueTy                                 )
  93         ( Field                                    )
  94         ( LifetimeParam                            )
  95         ( GlobalAsm                                )
  96         ( Impl                                     )
  97         ( Closure                                  )
  98         ( Generator                                )
  99         ( Static(ast::Mutability::Not)             )
 100         ( Static(ast::Mutability::Mut)             )
 101         ( Ctor(CtorOf::Struct, CtorKind::Fn)       )
 102         ( Ctor(CtorOf::Struct, CtorKind::Const)    )
 103         ( Ctor(CtorOf::Struct, CtorKind::Fictive)  )
 104         ( Ctor(CtorOf::Variant, CtorKind::Fn)      )
 105         ( Ctor(CtorOf::Variant, CtorKind::Const)   )
 106         ( Ctor(CtorOf::Variant, CtorKind::Fictive) )
 107         ( Macro(MacroKind::Bang)                   )
 108         ( Macro(MacroKind::Attr)                   )
 109         ( Macro(MacroKind::Derive)                 )
 110     }
 111 }
 112
 113 fixed_size_enum! {
 114     ty::ImplPolarity {
 115         ( Positive    )
 116         ( Negative    )
 117         ( Reservation )
 118     }
 119 }
 120
 121 fixed_size_enum! {
 122     hir::Constness {
 123         ( NotConst )
 124         ( Const    )
 125     }
 126 }
 127
 128 fixed_size_enum! {
 129     hir::Defaultness {
 130         ( Final                        )
 131         ( Default { has_value: false } )
 132         ( Default { has_value: true }  )
 133     }
 134 }
 135
 136 fixed_size_enum! {
 137     hir::IsAsync {
 138         ( NotAsync )
 139         ( Async    )
 140     }
 141 }
 142
 143 // We directly encode `DefPathHash` because a `LazyValue` would incur a 25% cost.
 144 impl FixedSizeEncoding for Option<DefPathHash> {
 145     type ByteArray = [u8; 16];
 146
 147     #[inline]
 148     fn from_bytes(b: &[u8; 16]) -> Self {
 149         Some(DefPathHash(Fingerprint::from_le_bytes(*b)))
 150     }
 151
 152     #[inline]
 153     fn write_to_bytes(self, b: &mut [u8; 16]) {
 154         let Some(DefPathHash(fingerprint)) = self else {
 155             panic!("Trying to encode absent DefPathHash.")
 156         };
 157         *b = fingerprint.to_le_bytes();
 158     }
 159 }
 160
 161 // We directly encode RawDefId because using a `LazyValue` would incur a 50% overhead in the worst case.
 162 impl FixedSizeEncoding for Option<RawDefId> {
 163     type ByteArray = [u8; 8];
 164
 165     #[inline]
 166     fn from_bytes(b: &[u8; 8]) -> Self {
 167         let krate = u32::from_le_bytes(b[0..4].try_into().unwrap());
 168         let index = u32::from_le_bytes(b[4..8].try_into().unwrap());
 169         if krate == 0 {
 170             return None;
 171         }
 172         Some(RawDefId { krate: krate - 1, index })
 173     }
 174
 175     #[inline]
 176     fn write_to_bytes(self, b: &mut [u8; 8]) {
 177         match self {
 178             None => *b = [0; 8],
 179             Some(RawDefId { krate, index }) => {
 180                 // CrateNum is less than `CrateNum::MAX_AS_U32`.
 181                 debug_assert!(krate < u32::MAX);
 182                 b[0..4].copy_from_slice(&(1 + krate).to_le_bytes());
 183                 b[4..8].copy_from_slice(&index.to_le_bytes());
 184             }
 185         }
 186     }
 187 }
 188
 189 impl FixedSizeEncoding for Option<()> {
 190     type ByteArray = [u8; 1];
 191
 192     #[inline]
 193     fn from_bytes(b: &[u8; 1]) -> Self {
 194         (b[0] != 0).then(|| ())
 195     }
 196
 197     #[inline]
 198     fn write_to_bytes(self, b: &mut [u8; 1]) {
 199         b[0] = self.is_some() as u8
 200     }
 201 }
 202
 203 // NOTE(eddyb) there could be an impl for `usize`, which would enable a more
 204 // generic `LazyValue<T>` impl, but in the general case we might not need / want
 205 // to fit every `usize` in `u32`.
 206 impl<T> FixedSizeEncoding for Option<LazyValue<T>> {
 207     type ByteArray = [u8; 4];
 208
 209     #[inline]
 210     fn from_bytes(b: &[u8; 4]) -> Self {
 211         let position = NonZeroUsize::new(u32::from_bytes(b) as usize)?;
 212         Some(LazyValue::from_position(position))
 213     }
 214
 215     #[inline]
 216     fn write_to_bytes(self, b: &mut [u8; 4]) {
 217         let position = self.map_or(0, |lazy| lazy.position.get());
 218         let position: u32 = position.try_into().unwrap();
 219         position.write_to_bytes(b)
 220     }
 221 }
 222
 223 impl<T> FixedSizeEncoding for Option<LazyArray<T>> {
 224     type ByteArray = [u8; 8];
 225
 226     #[inline]
 227     fn from_bytes(b: &[u8; 8]) -> Self {
 228         let ([ref position_bytes, ref meta_bytes],[])= b.as_chunks::<4>() else { panic!() };
 229         let position = NonZeroUsize::new(u32::from_bytes(position_bytes) as usize)?;
 230         let len = u32::from_bytes(meta_bytes) as usize;
 231         Some(LazyArray::from_position_and_num_elems(position, len))
 232     }
 233
 234     #[inline]
 235     fn write_to_bytes(self, b: &mut [u8; 8]) {
 236         let ([ref mut position_bytes, ref mut meta_bytes],[])= b.as_chunks_mut::<4>() else { panic!() };
 237
 238         let position = self.map_or(0, |lazy| lazy.position.get());
 239         let position: u32 = position.try_into().unwrap();
 240         position.write_to_bytes(position_bytes);
 241
 242         let len = self.map_or(0, |lazy| lazy.num_elems);
 243         let len: u32 = len.try_into().unwrap();
 244         len.write_to_bytes(meta_bytes);
 245     }
 246 }
 247
 248 /// Helper for constructing a table's serialization (also see `Table`).
 249 pub(super) struct TableBuilder<I: Idx, T>
 250 where
 251     Option<T>: FixedSizeEncoding,
 252 {
 253     blocks: IndexVec<I, <Option<T> as FixedSizeEncoding>::ByteArray>,
 254     _marker: PhantomData<T>,
 255 }
 256
 257 impl<I: Idx, T> Default for TableBuilder<I, T>
 258 where
 259     Option<T>: FixedSizeEncoding,
 260 {
 261     fn default() -> Self {
 262         TableBuilder { blocks: Default::default(), _marker: PhantomData }
 263     }
 264 }
 265
 266 impl<I: Idx, T> TableBuilder<I, T>
 267 where
 268     Option<T>: FixedSizeEncoding,
 269 {
 270     pub(crate) fn set<const N: usize>(&mut self, i: I, value: T)
 271     where
 272         Option<T>: FixedSizeEncoding<ByteArray = [u8; N]>,
 273     {
 274         // FIXME(eddyb) investigate more compact encodings for sparse tables.
 275         // On the PR @michaelwoerister mentioned:
 276         // > Space requirements could perhaps be optimized by using the HAMT `popcnt`
 277         // > trick (i.e. divide things into buckets of 32 or 64 items and then
 278         // > store bit-masks of which item in each bucket is actually serialized).
 279         self.blocks.ensure_contains_elem(i, || [0; N]);
 280         Some(value).write_to_bytes(&mut self.blocks[i]);
 281     }
 282
 283     pub(crate) fn encode<const N: usize>(&self, buf: &mut FileEncoder) -> LazyTable<I, T>
 284     where
 285         Option<T>: FixedSizeEncoding<ByteArray = [u8; N]>,
 286     {
 287         let pos = buf.position();
 288         for block in &self.blocks {
 289             buf.emit_raw_bytes(block);
 290         }
 291         let num_bytes = self.blocks.len() * N;
 292         LazyTable::from_position_and_encoded_size(
 293             NonZeroUsize::new(pos as usize).unwrap(),
 294             num_bytes,
 295         )
 296     }
 297 }
 298
 299 impl<I: Idx, T: ParameterizedOverTcx> LazyTable<I, T>
 300 where
 301     Option<T>: FixedSizeEncoding,
 302 {
 303     /// Given the metadata, extract out the value at a particular index (if any).
 304     #[inline(never)]
 305     pub(super) fn get<'a, 'tcx, M: Metadata<'a, 'tcx>, const N: usize>(
 306         &self,
 307         metadata: M,
 308         i: I,
 309     ) -> Option<T::Value<'tcx>>
 310     where
 311         Option<T::Value<'tcx>>: FixedSizeEncoding<ByteArray = [u8; N]>,
 312     {
 313         debug!("LazyTable::lookup: index={:?} len={:?}", i, self.encoded_size);
 314
 315         let start = self.position.get();
 316         let bytes = &metadata.blob()[start..start + self.encoded_size];
 317         let (bytes, []) = bytes.as_chunks::<N>() else { panic!() };
 318         let bytes = bytes.get(i.index())?;
 319         FixedSizeEncoding::from_bytes(bytes)
 320     }
 321
 322     /// Size of the table in entries, including possible gaps.
 323     pub(super) fn size<const N: usize>(&self) -> usize
 324     where
 325         for<'tcx> Option<T::Value<'tcx>>: FixedSizeEncoding<ByteArray = [u8; N]>,
 326     {
 327         self.encoded_size / N
 328     }
 329 }