src/librustc_middle/mir/interpret/allocation.rs

   1 //! The virtual memory representation of the MIR interpreter.
   2
   3 use std::borrow::Cow;
   4 use std::convert::TryFrom;
   5 use std::iter;
   6 use std::ops::{Deref, DerefMut, Range};
   7
   8 use rustc_ast::ast::Mutability;
   9 use rustc_data_structures::sorted_map::SortedMap;
  10 use rustc_target::abi::{Align, HasDataLayout, Size};
  11
  12 use super::{
  13     read_target_uint, write_target_uint, AllocId, InterpResult, Pointer, Scalar, ScalarMaybeUninit,
  14     UninitBytesAccess,
  15 };
  16
  17 #[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
  18 #[derive(HashStable)]
  19 pub struct Allocation<Tag = (), Extra = ()> {
  20     /// The actual bytes of the allocation.
  21     /// Note that the bytes of a pointer represent the offset of the pointer.
  22     bytes: Vec<u8>,
  23     /// Maps from byte addresses to extra data for each pointer.
  24     /// Only the first byte of a pointer is inserted into the map; i.e.,
  25     /// every entry in this map applies to `pointer_size` consecutive bytes starting
  26     /// at the given offset.
  27     relocations: Relocations<Tag>,
  28     /// Denotes which part of this allocation is initialized.
  29     init_mask: InitMask,
  30     /// The size of the allocation. Currently, must always equal `bytes.len()`.
  31     pub size: Size,
  32     /// The alignment of the allocation to detect unaligned reads.
  33     /// (`Align` guarantees that this is a power of two.)
  34     pub align: Align,
  35     /// `true` if the allocation is mutable.
  36     /// Also used by codegen to determine if a static should be put into mutable memory,
  37     /// which happens for `static mut` and `static` with interior mutability.
  38     pub mutability: Mutability,
  39     /// Extra state for the machine.
  40     pub extra: Extra,
  41 }
  42
  43 pub trait AllocationExtra<Tag>: ::std::fmt::Debug + Clone {
  44     // There is no constructor in here because the constructor's type depends
  45     // on `MemoryKind`, and making things sufficiently generic leads to painful
  46     // inference failure.
  47
  48     /// Hook for performing extra checks on a memory read access.
  49     ///
  50     /// Takes read-only access to the allocation so we can keep all the memory read
  51     /// operations take `&self`. Use a `RefCell` in `AllocExtra` if you
  52     /// need to mutate.
  53     #[inline(always)]
  54     fn memory_read(
  55         _alloc: &Allocation<Tag, Self>,
  56         _ptr: Pointer<Tag>,
  57         _size: Size,
  58     ) -> InterpResult<'tcx> {
  59         Ok(())
  60     }
  61
  62     /// Hook for performing extra checks on a memory write access.
  63     #[inline(always)]
  64     fn memory_written(
  65         _alloc: &mut Allocation<Tag, Self>,
  66         _ptr: Pointer<Tag>,
  67         _size: Size,
  68     ) -> InterpResult<'tcx> {
  69         Ok(())
  70     }
  71
  72     /// Hook for performing extra checks on a memory deallocation.
  73     /// `size` will be the size of the allocation.
  74     #[inline(always)]
  75     fn memory_deallocated(
  76         _alloc: &mut Allocation<Tag, Self>,
  77         _ptr: Pointer<Tag>,
  78         _size: Size,
  79     ) -> InterpResult<'tcx> {
  80         Ok(())
  81     }
  82 }
  83
  84 // For `Tag = ()` and no extra state, we have a trivial implementation.
  85 impl AllocationExtra<()> for () {}
  86
  87 // The constructors are all without extra; the extra gets added by a machine hook later.
  88 impl<Tag> Allocation<Tag> {
  89     /// Creates a read-only allocation initialized by the given bytes
  90     pub fn from_bytes<'a>(slice: impl Into<Cow<'a, [u8]>>, align: Align) -> Self {
  91         let bytes = slice.into().into_owned();
  92         let size = Size::from_bytes(bytes.len());
  93         Self {
  94             bytes,
  95             relocations: Relocations::new(),
  96             init_mask: InitMask::new(size, true),
  97             size,
  98             align,
  99             mutability: Mutability::Not,
 100             extra: (),
 101         }
 102     }
 103
 104     pub fn from_byte_aligned_bytes<'a>(slice: impl Into<Cow<'a, [u8]>>) -> Self {
 105         Allocation::from_bytes(slice, Align::from_bytes(1).unwrap())
 106     }
 107
 108     pub fn uninit(size: Size, align: Align) -> Self {
 109         Allocation {
 110             bytes: vec![0; size.bytes_usize()],
 111             relocations: Relocations::new(),
 112             init_mask: InitMask::new(size, false),
 113             size,
 114             align,
 115             mutability: Mutability::Mut,
 116             extra: (),
 117         }
 118     }
 119 }
 120
 121 impl Allocation<(), ()> {
 122     /// Add Tag and Extra fields
 123     pub fn with_tags_and_extra<T, E>(
 124         self,
 125         mut tagger: impl FnMut(AllocId) -> T,
 126         extra: E,
 127     ) -> Allocation<T, E> {
 128         Allocation {
 129             bytes: self.bytes,
 130             size: self.size,
 131             relocations: Relocations::from_presorted(
 132                 self.relocations
 133                     .iter()
 134                     // The allocations in the relocations (pointers stored *inside* this allocation)
 135                     // all get the base pointer tag.
 136                     .map(|&(offset, ((), alloc))| {
 137                         let tag = tagger(alloc);
 138                         (offset, (tag, alloc))
 139                     })
 140                     .collect(),
 141             ),
 142             init_mask: self.init_mask,
 143             align: self.align,
 144             mutability: self.mutability,
 145             extra,
 146         }
 147     }
 148 }
 149
 150 /// Raw accessors. Provide access to otherwise private bytes.
 151 impl<Tag, Extra> Allocation<Tag, Extra> {
 152     pub fn len(&self) -> usize {
 153         self.size.bytes_usize()
 154     }
 155
 156     /// Looks at a slice which may describe uninitialized bytes or describe a relocation. This differs
 157     /// from `get_bytes_with_uninit_and_ptr` in that it does no relocation checks (even on the
 158     /// edges) at all. It further ignores `AllocationExtra` callbacks.
 159     /// This must not be used for reads affecting the interpreter execution.
 160     pub fn inspect_with_uninit_and_ptr_outside_interpreter(&self, range: Range<usize>) -> &[u8] {
 161         &self.bytes[range]
 162     }
 163
 164     /// Returns the mask indicating which bytes are initialized.
 165     pub fn init_mask(&self) -> &InitMask {
 166         &self.init_mask
 167     }
 168
 169     /// Returns the relocation list.
 170     pub fn relocations(&self) -> &Relocations<Tag> {
 171         &self.relocations
 172     }
 173 }
 174
 175 /// Byte accessors.
 176 impl<'tcx, Tag: Copy, Extra: AllocationExtra<Tag>> Allocation<Tag, Extra> {
 177     /// Just a small local helper function to avoid a bit of code repetition.
 178     /// Returns the range of this allocation that was meant.
 179     #[inline]
 180     fn check_bounds(&self, offset: Size, size: Size) -> Range<usize> {
 181         let end = offset + size; // This does overflow checking.
 182         let end = usize::try_from(end.bytes()).expect("access too big for this host architecture");
 183         assert!(
 184             end <= self.len(),
 185             "Out-of-bounds access at offset {}, size {} in allocation of size {}",
 186             offset.bytes(),
 187             size.bytes(),
 188             self.len()
 189         );
 190         offset.bytes_usize()..end
 191     }
 192
 193     /// The last argument controls whether we error out when there are uninitialized
 194     /// or pointer bytes. You should never call this, call `get_bytes` or
 195     /// `get_bytes_with_uninit_and_ptr` instead,
 196     ///
 197     /// This function also guarantees that the resulting pointer will remain stable
 198     /// even when new allocations are pushed to the `HashMap`. `copy_repeatedly` relies
 199     /// on that.
 200     ///
 201     /// It is the caller's responsibility to check bounds and alignment beforehand.
 202     fn get_bytes_internal(
 203         &self,
 204         cx: &impl HasDataLayout,
 205         ptr: Pointer<Tag>,
 206         size: Size,
 207         check_init_and_ptr: bool,
 208     ) -> InterpResult<'tcx, &[u8]> {
 209         let range = self.check_bounds(ptr.offset, size);
 210
 211         if check_init_and_ptr {
 212             self.check_init(ptr, size)?;
 213             self.check_relocations(cx, ptr, size)?;
 214         } else {
 215             // We still don't want relocations on the *edges*.
 216             self.check_relocation_edges(cx, ptr, size)?;
 217         }
 218
 219         AllocationExtra::memory_read(self, ptr, size)?;
 220
 221         Ok(&self.bytes[range])
 222     }
 223
 224     /// Checks that these bytes are initialized and not pointer bytes, and then return them
 225     /// as a slice.
 226     ///
 227     /// It is the caller's responsibility to check bounds and alignment beforehand.
 228     /// Most likely, you want to use the `PlaceTy` and `OperandTy`-based methods
 229     /// on `InterpCx` instead.
 230     #[inline]
 231     pub fn get_bytes(
 232         &self,
 233         cx: &impl HasDataLayout,
 234         ptr: Pointer<Tag>,
 235         size: Size,
 236     ) -> InterpResult<'tcx, &[u8]> {
 237         self.get_bytes_internal(cx, ptr, size, true)
 238     }
 239
 240     /// It is the caller's responsibility to handle uninitialized and pointer bytes.
 241     /// However, this still checks that there are no relocations on the *edges*.
 242     ///
 243     /// It is the caller's responsibility to check bounds and alignment beforehand.
 244     #[inline]
 245     pub fn get_bytes_with_uninit_and_ptr(
 246         &self,
 247         cx: &impl HasDataLayout,
 248         ptr: Pointer<Tag>,
 249         size: Size,
 250     ) -> InterpResult<'tcx, &[u8]> {
 251         self.get_bytes_internal(cx, ptr, size, false)
 252     }
 253
 254     /// Just calling this already marks everything as defined and removes relocations,
 255     /// so be sure to actually put data there!
 256     ///
 257     /// It is the caller's responsibility to check bounds and alignment beforehand.
 258     /// Most likely, you want to use the `PlaceTy` and `OperandTy`-based methods
 259     /// on `InterpCx` instead.
 260     pub fn get_bytes_mut(
 261         &mut self,
 262         cx: &impl HasDataLayout,
 263         ptr: Pointer<Tag>,
 264         size: Size,
 265     ) -> InterpResult<'tcx, &mut [u8]> {
 266         let range = self.check_bounds(ptr.offset, size);
 267
 268         self.mark_init(ptr, size, true);
 269         self.clear_relocations(cx, ptr, size)?;
 270
 271         AllocationExtra::memory_written(self, ptr, size)?;
 272
 273         Ok(&mut self.bytes[range])
 274     }
 275 }
 276
 277 /// Reading and writing.
 278 impl<'tcx, Tag: Copy, Extra: AllocationExtra<Tag>> Allocation<Tag, Extra> {
 279     /// Reads bytes until a `0` is encountered. Will error if the end of the allocation is reached
 280     /// before a `0` is found.
 281     ///
 282     /// Most likely, you want to call `Memory::read_c_str` instead of this method.
 283     pub fn read_c_str(
 284         &self,
 285         cx: &impl HasDataLayout,
 286         ptr: Pointer<Tag>,
 287     ) -> InterpResult<'tcx, &[u8]> {
 288         let offset = ptr.offset.bytes_usize();
 289         Ok(match self.bytes[offset..].iter().position(|&c| c == 0) {
 290             Some(size) => {
 291                 let size_with_null = Size::from_bytes(size) + Size::from_bytes(1);
 292                 // Go through `get_bytes` for checks and AllocationExtra hooks.
 293                 // We read the null, so we include it in the request, but we want it removed
 294                 // from the result, so we do subslicing.
 295                 &self.get_bytes(cx, ptr, size_with_null)?[..size]
 296             }
 297             // This includes the case where `offset` is out-of-bounds to begin with.
 298             None => throw_ub!(UnterminatedCString(ptr.erase_tag())),
 299         })
 300     }
 301
 302     /// Validates that `ptr.offset` and `ptr.offset + size` do not point to the middle of a
 303     /// relocation. If `allow_uninit_and_ptr` is `false`, also enforces that the memory in the
 304     /// given range contains neither relocations nor uninitialized bytes.
 305     pub fn check_bytes(
 306         &self,
 307         cx: &impl HasDataLayout,
 308         ptr: Pointer<Tag>,
 309         size: Size,
 310         allow_uninit_and_ptr: bool,
 311     ) -> InterpResult<'tcx> {
 312         // Check bounds and relocations on the edges.
 313         self.get_bytes_with_uninit_and_ptr(cx, ptr, size)?;
 314         // Check uninit and ptr.
 315         if !allow_uninit_and_ptr {
 316             self.check_init(ptr, size)?;
 317             self.check_relocations(cx, ptr, size)?;
 318         }
 319         Ok(())
 320     }
 321
 322     /// Writes `src` to the memory starting at `ptr.offset`.
 323     ///
 324     /// It is the caller's responsibility to check bounds and alignment beforehand.
 325     /// Most likely, you want to call `Memory::write_bytes` instead of this method.
 326     pub fn write_bytes(
 327         &mut self,
 328         cx: &impl HasDataLayout,
 329         ptr: Pointer<Tag>,
 330         src: impl IntoIterator<Item = u8>,
 331     ) -> InterpResult<'tcx> {
 332         let mut src = src.into_iter();
 333         let (lower, upper) = src.size_hint();
 334         let len = upper.expect("can only write bounded iterators");
 335         assert_eq!(lower, len, "can only write iterators with a precise length");
 336         let bytes = self.get_bytes_mut(cx, ptr, Size::from_bytes(len))?;
 337         // `zip` would stop when the first iterator ends; we want to definitely
 338         // cover all of `bytes`.
 339         for dest in bytes {
 340             *dest = src.next().expect("iterator was shorter than it said it would be");
 341         }
 342         src.next().expect_none("iterator was longer than it said it would be");
 343         Ok(())
 344     }
 345
 346     /// Reads a *non-ZST* scalar.
 347     ///
 348     /// ZSTs can't be read for two reasons:
 349     /// * byte-order cannot work with zero-element buffers;
 350     /// * in order to obtain a `Pointer`, we need to check for ZSTness anyway due to integer
 351     ///   pointers being valid for ZSTs.
 352     ///
 353     /// It is the caller's responsibility to check bounds and alignment beforehand.
 354     /// Most likely, you want to call `InterpCx::read_scalar` instead of this method.
 355     pub fn read_scalar(
 356         &self,
 357         cx: &impl HasDataLayout,
 358         ptr: Pointer<Tag>,
 359         size: Size,
 360     ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
 361         // `get_bytes_unchecked` tests relocation edges.
 362         let bytes = self.get_bytes_with_uninit_and_ptr(cx, ptr, size)?;
 363         // Uninit check happens *after* we established that the alignment is correct.
 364         // We must not return `Ok()` for unaligned pointers!
 365         if self.is_init(ptr, size).is_err() {
 366             // This inflates uninitialized bytes to the entire scalar, even if only a few
 367             // bytes are uninitialized.
 368             return Ok(ScalarMaybeUninit::Uninit);
 369         }
 370         // Now we do the actual reading.
 371         let bits = read_target_uint(cx.data_layout().endian, bytes).unwrap();
 372         // See if we got a pointer.
 373         if size != cx.data_layout().pointer_size {
 374             // *Now*, we better make sure that the inside is free of relocations too.
 375             self.check_relocations(cx, ptr, size)?;
 376         } else {
 377             if let Some(&(tag, alloc_id)) = self.relocations.get(&ptr.offset) {
 378                 let ptr = Pointer::new_with_tag(alloc_id, Size::from_bytes(bits), tag);
 379                 return Ok(ScalarMaybeUninit::Scalar(ptr.into()));
 380             }
 381         }
 382         // We don't. Just return the bits.
 383         Ok(ScalarMaybeUninit::Scalar(Scalar::from_uint(bits, size)))
 384     }
 385
 386     /// Reads a pointer-sized scalar.
 387     ///
 388     /// It is the caller's responsibility to check bounds and alignment beforehand.
 389     /// Most likely, you want to call `InterpCx::read_scalar` instead of this method.
 390     pub fn read_ptr_sized(
 391         &self,
 392         cx: &impl HasDataLayout,
 393         ptr: Pointer<Tag>,
 394     ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
 395         self.read_scalar(cx, ptr, cx.data_layout().pointer_size)
 396     }
 397
 398     /// Writes a *non-ZST* scalar.
 399     ///
 400     /// ZSTs can't be read for two reasons:
 401     /// * byte-order cannot work with zero-element buffers;
 402     /// * in order to obtain a `Pointer`, we need to check for ZSTness anyway due to integer
 403     ///   pointers being valid for ZSTs.
 404     ///
 405     /// It is the caller's responsibility to check bounds and alignment beforehand.
 406     /// Most likely, you want to call `InterpCx::write_scalar` instead of this method.
 407     pub fn write_scalar(
 408         &mut self,
 409         cx: &impl HasDataLayout,
 410         ptr: Pointer<Tag>,
 411         val: ScalarMaybeUninit<Tag>,
 412         type_size: Size,
 413     ) -> InterpResult<'tcx> {
 414         let val = match val {
 415             ScalarMaybeUninit::Scalar(scalar) => scalar,
 416             ScalarMaybeUninit::Uninit => {
 417                 self.mark_init(ptr, type_size, false);
 418                 return Ok(());
 419             }
 420         };
 421
 422         let bytes = match val.to_bits_or_ptr(type_size, cx) {
 423             Err(val) => u128::from(val.offset.bytes()),
 424             Ok(data) => data,
 425         };
 426
 427         let endian = cx.data_layout().endian;
 428         let dst = self.get_bytes_mut(cx, ptr, type_size)?;
 429         write_target_uint(endian, dst, bytes).unwrap();
 430
 431         // See if we have to also write a relocation.
 432         if let Scalar::Ptr(val) = val {
 433             self.relocations.insert(ptr.offset, (val.tag, val.alloc_id));
 434         }
 435
 436         Ok(())
 437     }
 438
 439     /// Writes a pointer-sized scalar.
 440     ///
 441     /// It is the caller's responsibility to check bounds and alignment beforehand.
 442     /// Most likely, you want to call `InterpCx::write_scalar` instead of this method.
 443     pub fn write_ptr_sized(
 444         &mut self,
 445         cx: &impl HasDataLayout,
 446         ptr: Pointer<Tag>,
 447         val: ScalarMaybeUninit<Tag>,
 448     ) -> InterpResult<'tcx> {
 449         let ptr_size = cx.data_layout().pointer_size;
 450         self.write_scalar(cx, ptr, val, ptr_size)
 451     }
 452 }
 453
 454 /// Relocations.
 455 impl<'tcx, Tag: Copy, Extra> Allocation<Tag, Extra> {
 456     /// Returns all relocations overlapping with the given pointer-offset pair.
 457     pub fn get_relocations(
 458         &self,
 459         cx: &impl HasDataLayout,
 460         ptr: Pointer<Tag>,
 461         size: Size,
 462     ) -> &[(Size, (Tag, AllocId))] {
 463         // We have to go back `pointer_size - 1` bytes, as that one would still overlap with
 464         // the beginning of this range.
 465         let start = ptr.offset.bytes().saturating_sub(cx.data_layout().pointer_size.bytes() - 1);
 466         let end = ptr.offset + size; // This does overflow checking.
 467         self.relocations.range(Size::from_bytes(start)..end)
 468     }
 469
 470     /// Checks that there are no relocations overlapping with the given range.
 471     #[inline(always)]
 472     fn check_relocations(
 473         &self,
 474         cx: &impl HasDataLayout,
 475         ptr: Pointer<Tag>,
 476         size: Size,
 477     ) -> InterpResult<'tcx> {
 478         if self.get_relocations(cx, ptr, size).is_empty() {
 479             Ok(())
 480         } else {
 481             throw_unsup!(ReadPointerAsBytes)
 482         }
 483     }
 484
 485     /// Removes all relocations inside the given range.
 486     /// If there are relocations overlapping with the edges, they
 487     /// are removed as well *and* the bytes they cover are marked as
 488     /// uninitialized. This is a somewhat odd "spooky action at a distance",
 489     /// but it allows strictly more code to run than if we would just error
 490     /// immediately in that case.
 491     fn clear_relocations(
 492         &mut self,
 493         cx: &impl HasDataLayout,
 494         ptr: Pointer<Tag>,
 495         size: Size,
 496     ) -> InterpResult<'tcx> {
 497         // Find the start and end of the given range and its outermost relocations.
 498         let (first, last) = {
 499             // Find all relocations overlapping the given range.
 500             let relocations = self.get_relocations(cx, ptr, size);
 501             if relocations.is_empty() {
 502                 return Ok(());
 503             }
 504
 505             (
 506                 relocations.first().unwrap().0,
 507                 relocations.last().unwrap().0 + cx.data_layout().pointer_size,
 508             )
 509         };
 510         let start = ptr.offset;
 511         let end = start + size; // `Size` addition
 512
 513         // Mark parts of the outermost relocations as uninitialized if they partially fall outside the
 514         // given range.
 515         if first < start {
 516             self.init_mask.set_range(first, start, false);
 517         }
 518         if last > end {
 519             self.init_mask.set_range(end, last, false);
 520         }
 521
 522         // Forget all the relocations.
 523         self.relocations.remove_range(first..last);
 524
 525         Ok(())
 526     }
 527
 528     /// Errors if there are relocations overlapping with the edges of the
 529     /// given memory range.
 530     #[inline]
 531     fn check_relocation_edges(
 532         &self,
 533         cx: &impl HasDataLayout,
 534         ptr: Pointer<Tag>,
 535         size: Size,
 536     ) -> InterpResult<'tcx> {
 537         self.check_relocations(cx, ptr, Size::ZERO)?;
 538         self.check_relocations(cx, ptr.offset(size, cx)?, Size::ZERO)?;
 539         Ok(())
 540     }
 541 }
 542
 543 /// Uninitialized bytes.
 544 impl<'tcx, Tag: Copy, Extra> Allocation<Tag, Extra> {
 545     /// Checks whether the given range  is entirely initialized.
 546     ///
 547     /// Returns `Ok(())` if it's initialized. Otherwise returns the range of byte
 548     /// indexes of the first contiguous uninitialized access.
 549     fn is_init(&self, ptr: Pointer<Tag>, size: Size) -> Result<(), Range<Size>> {
 550         self.init_mask.is_range_initialized(ptr.offset, ptr.offset + size) // `Size` addition
 551     }
 552
 553     /// Checks that a range of bytes is initialized. If not, returns the `InvalidUninitBytes`
 554     /// error which will report the first range of bytes which is uninitialized.
 555     fn check_init(&self, ptr: Pointer<Tag>, size: Size) -> InterpResult<'tcx> {
 556         self.is_init(ptr, size).or_else(|idx_range| {
 557             throw_ub!(InvalidUninitBytes(Some(Box::new(UninitBytesAccess {
 558                 access_ptr: ptr.erase_tag(),
 559                 access_size: size,
 560                 uninit_ptr: Pointer::new(ptr.alloc_id, idx_range.start),
 561                 uninit_size: idx_range.end - idx_range.start, // `Size` subtraction
 562             }))))
 563         })
 564     }
 565
 566     pub fn mark_init(&mut self, ptr: Pointer<Tag>, size: Size, is_init: bool) {
 567         if size.bytes() == 0 {
 568             return;
 569         }
 570         self.init_mask.set_range(ptr.offset, ptr.offset + size, is_init);
 571     }
 572 }
 573
 574 /// Run-length encoding of the uninit mask.
 575 /// Used to copy parts of a mask multiple times to another allocation.
 576 pub struct InitMaskCompressed {
 577     /// Whether the first range is initialized.
 578     initial: bool,
 579     /// The lengths of ranges that are run-length encoded.
 580     /// The initialization state of the ranges alternate starting with `initial`.
 581     ranges: smallvec::SmallVec<[u64; 1]>,
 582 }
 583
 584 impl InitMaskCompressed {
 585     pub fn no_bytes_init(&self) -> bool {
 586         // The `ranges` are run-length encoded and of alternating initialization state.
 587         // So if `ranges.len() > 1` then the second block is an initialized range.
 588         !self.initial && self.ranges.len() == 1
 589     }
 590 }
 591
 592 /// Transferring the initialization mask to other allocations.
 593 impl<Tag, Extra> Allocation<Tag, Extra> {
 594     /// Creates a run-length encoding of the initialization mask.
 595     pub fn compress_uninit_range(&self, src: Pointer<Tag>, size: Size) -> InitMaskCompressed {
 596         // Since we are copying `size` bytes from `src` to `dest + i * size` (`for i in 0..repeat`),
 597         // a naive initialization mask copying algorithm would repeatedly have to read the initialization mask from
 598         // the source and write it to the destination. Even if we optimized the memory accesses,
 599         // we'd be doing all of this `repeat` times.
 600         // Therefore we precompute a compressed version of the initialization mask of the source value and
 601         // then write it back `repeat` times without computing any more information from the source.
 602
 603         // A precomputed cache for ranges of initialized / uninitialized bits
 604         // 0000010010001110 will become
 605         // `[5, 1, 2, 1, 3, 3, 1]`,
 606         // where each element toggles the state.
 607
 608         let mut ranges = smallvec::SmallVec::<[u64; 1]>::new();
 609         let initial = self.init_mask.get(src.offset);
 610         let mut cur_len = 1;
 611         let mut cur = initial;
 612
 613         for i in 1..size.bytes() {
 614             // FIXME: optimize to bitshift the current uninitialized block's bits and read the top bit.
 615             if self.init_mask.get(src.offset + Size::from_bytes(i)) == cur {
 616                 cur_len += 1;
 617             } else {
 618                 ranges.push(cur_len);
 619                 cur_len = 1;
 620                 cur = !cur;
 621             }
 622         }
 623
 624         ranges.push(cur_len);
 625
 626         InitMaskCompressed { ranges, initial }
 627     }
 628
 629     /// Applies multiple instances of the run-length encoding to the initialization mask.
 630     pub fn mark_compressed_init_range(
 631         &mut self,
 632         defined: &InitMaskCompressed,
 633         dest: Pointer<Tag>,
 634         size: Size,
 635         repeat: u64,
 636     ) {
 637         // An optimization where we can just overwrite an entire range of initialization
 638         // bits if they are going to be uniformly `1` or `0`.
 639         if defined.ranges.len() <= 1 {
 640             self.init_mask.set_range_inbounds(
 641                 dest.offset,
 642                 dest.offset + size * repeat, // `Size` operations
 643                 defined.initial,
 644             );
 645             return;
 646         }
 647
 648         for mut j in 0..repeat {
 649             j *= size.bytes();
 650             j += dest.offset.bytes();
 651             let mut cur = defined.initial;
 652             for range in &defined.ranges {
 653                 let old_j = j;
 654                 j += range;
 655                 self.init_mask.set_range_inbounds(
 656                     Size::from_bytes(old_j),
 657                     Size::from_bytes(j),
 658                     cur,
 659                 );
 660                 cur = !cur;
 661             }
 662         }
 663     }
 664 }
 665
 666 /// Relocations.
 667 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
 668 pub struct Relocations<Tag = (), Id = AllocId>(SortedMap<Size, (Tag, Id)>);
 669
 670 impl<Tag, Id> Relocations<Tag, Id> {
 671     pub fn new() -> Self {
 672         Relocations(SortedMap::new())
 673     }
 674
 675     // The caller must guarantee that the given relocations are already sorted
 676     // by address and contain no duplicates.
 677     pub fn from_presorted(r: Vec<(Size, (Tag, Id))>) -> Self {
 678         Relocations(SortedMap::from_presorted_elements(r))
 679     }
 680 }
 681
 682 impl<Tag> Deref for Relocations<Tag> {
 683     type Target = SortedMap<Size, (Tag, AllocId)>;
 684
 685     fn deref(&self) -> &Self::Target {
 686         &self.0
 687     }
 688 }
 689
 690 impl<Tag> DerefMut for Relocations<Tag> {
 691     fn deref_mut(&mut self) -> &mut Self::Target {
 692         &mut self.0
 693     }
 694 }
 695
 696 /// A partial, owned list of relocations to transfer into another allocation.
 697 pub struct AllocationRelocations<Tag> {
 698     relative_relocations: Vec<(Size, (Tag, AllocId))>,
 699 }
 700
 701 impl<Tag: Copy, Extra> Allocation<Tag, Extra> {
 702     pub fn prepare_relocation_copy(
 703         &self,
 704         cx: &impl HasDataLayout,
 705         src: Pointer<Tag>,
 706         size: Size,
 707         dest: Pointer<Tag>,
 708         length: u64,
 709     ) -> AllocationRelocations<Tag> {
 710         let relocations = self.get_relocations(cx, src, size);
 711         if relocations.is_empty() {
 712             return AllocationRelocations { relative_relocations: Vec::new() };
 713         }
 714
 715         let mut new_relocations = Vec::with_capacity(relocations.len() * (length as usize));
 716
 717         for i in 0..length {
 718             new_relocations.extend(relocations.iter().map(|&(offset, reloc)| {
 719                 // compute offset for current repetition
 720                 let dest_offset = dest.offset + size * i; // `Size` operations
 721                 (
 722                     // shift offsets from source allocation to destination allocation
 723                     (offset + dest_offset) - src.offset, // `Size` operations
 724                     reloc,
 725                 )
 726             }));
 727         }
 728
 729         AllocationRelocations { relative_relocations: new_relocations }
 730     }
 731
 732     /// Applies a relocation copy.
 733     /// The affected range, as defined in the parameters to `prepare_relocation_copy` is expected
 734     /// to be clear of relocations.
 735     pub fn mark_relocation_range(&mut self, relocations: AllocationRelocations<Tag>) {
 736         self.relocations.insert_presorted(relocations.relative_relocations);
 737     }
 738 }
 739
 740 ////////////////////////////////////////////////////////////////////////////////
 741 // Uninitialized byte tracking
 742 ////////////////////////////////////////////////////////////////////////////////
 743
 744 type Block = u64;
 745
 746 /// A bitmask where each bit refers to the byte with the same index. If the bit is `true`, the byte
 747 /// is initialized. If it is `false` the byte is uninitialized.
 748 #[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
 749 #[derive(HashStable)]
 750 pub struct InitMask {
 751     blocks: Vec<Block>,
 752     len: Size,
 753 }
 754
 755 impl InitMask {
 756     pub const BLOCK_SIZE: u64 = 64;
 757
 758     pub fn new(size: Size, state: bool) -> Self {
 759         let mut m = InitMask { blocks: vec![], len: Size::ZERO };
 760         m.grow(size, state);
 761         m
 762     }
 763
 764     /// Checks whether the range `start..end` (end-exclusive) is entirely initialized.
 765     ///
 766     /// Returns `Ok(())` if it's initialized. Otherwise returns a range of byte
 767     /// indexes for the first contiguous span of the uninitialized access.
 768     #[inline]
 769     pub fn is_range_initialized(&self, start: Size, end: Size) -> Result<(), Range<Size>> {
 770         if end > self.len {
 771             return Err(self.len..end);
 772         }
 773
 774         // FIXME(oli-obk): optimize this for allocations larger than a block.
 775         let idx = (start.bytes()..end.bytes()).map(Size::from_bytes).find(|&i| !self.get(i));
 776
 777         match idx {
 778             Some(idx) => {
 779                 let uninit_end = (idx.bytes()..end.bytes())
 780                     .map(Size::from_bytes)
 781                     .find(|&i| self.get(i))
 782                     .unwrap_or(end);
 783                 Err(idx..uninit_end)
 784             }
 785             None => Ok(()),
 786         }
 787     }
 788
 789     pub fn set_range(&mut self, start: Size, end: Size, new_state: bool) {
 790         let len = self.len;
 791         if end > len {
 792             self.grow(end - len, new_state);
 793         }
 794         self.set_range_inbounds(start, end, new_state);
 795     }
 796
 797     pub fn set_range_inbounds(&mut self, start: Size, end: Size, new_state: bool) {
 798         let (blocka, bita) = bit_index(start);
 799         let (blockb, bitb) = bit_index(end);
 800         if blocka == blockb {
 801             // First set all bits except the first `bita`,
 802             // then unset the last `64 - bitb` bits.
 803             let range = if bitb == 0 {
 804                 u64::MAX << bita
 805             } else {
 806                 (u64::MAX << bita) & (u64::MAX >> (64 - bitb))
 807             };
 808             if new_state {
 809                 self.blocks[blocka] |= range;
 810             } else {
 811                 self.blocks[blocka] &= !range;
 812             }
 813             return;
 814         }
 815         // across block boundaries
 816         if new_state {
 817             // Set `bita..64` to `1`.
 818             self.blocks[blocka] |= u64::MAX << bita;
 819             // Set `0..bitb` to `1`.
 820             if bitb != 0 {
 821                 self.blocks[blockb] |= u64::MAX >> (64 - bitb);
 822             }
 823             // Fill in all the other blocks (much faster than one bit at a time).
 824             for block in (blocka + 1)..blockb {
 825                 self.blocks[block] = u64::MAX;
 826             }
 827         } else {
 828             // Set `bita..64` to `0`.
 829             self.blocks[blocka] &= !(u64::MAX << bita);
 830             // Set `0..bitb` to `0`.
 831             if bitb != 0 {
 832                 self.blocks[blockb] &= !(u64::MAX >> (64 - bitb));
 833             }
 834             // Fill in all the other blocks (much faster than one bit at a time).
 835             for block in (blocka + 1)..blockb {
 836                 self.blocks[block] = 0;
 837             }
 838         }
 839     }
 840
 841     #[inline]
 842     pub fn get(&self, i: Size) -> bool {
 843         let (block, bit) = bit_index(i);
 844         (self.blocks[block] & (1 << bit)) != 0
 845     }
 846
 847     #[inline]
 848     pub fn set(&mut self, i: Size, new_state: bool) {
 849         let (block, bit) = bit_index(i);
 850         self.set_bit(block, bit, new_state);
 851     }
 852
 853     #[inline]
 854     fn set_bit(&mut self, block: usize, bit: usize, new_state: bool) {
 855         if new_state {
 856             self.blocks[block] |= 1 << bit;
 857         } else {
 858             self.blocks[block] &= !(1 << bit);
 859         }
 860     }
 861
 862     pub fn grow(&mut self, amount: Size, new_state: bool) {
 863         if amount.bytes() == 0 {
 864             return;
 865         }
 866         let unused_trailing_bits =
 867             u64::try_from(self.blocks.len()).unwrap() * Self::BLOCK_SIZE - self.len.bytes();
 868         if amount.bytes() > unused_trailing_bits {
 869             let additional_blocks = amount.bytes() / Self::BLOCK_SIZE + 1;
 870             self.blocks.extend(
 871                 // FIXME(oli-obk): optimize this by repeating `new_state as Block`.
 872                 iter::repeat(0).take(usize::try_from(additional_blocks).unwrap()),
 873             );
 874         }
 875         let start = self.len;
 876         self.len += amount;
 877         self.set_range_inbounds(start, start + amount, new_state); // `Size` operation
 878     }
 879 }
 880
 881 #[inline]
 882 fn bit_index(bits: Size) -> (usize, usize) {
 883     let bits = bits.bytes();
 884     let a = bits / InitMask::BLOCK_SIZE;
 885     let b = bits % InitMask::BLOCK_SIZE;
 886     (usize::try_from(a).unwrap(), usize::try_from(b).unwrap())
 887 }