src/librustc_mir/interpret/memory.rs

   1 // Copyright 2018 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! The memory subsystem.
  12 //!
  13 //! Generally, we use `Pointer` to denote memory addresses. However, some operations
  14 //! have a "size"-like parameter, and they take `Scalar` for the address because
  15 //! if the size is 0, then the pointer can also be a (properly aligned, non-NULL)
  16 //! integer.  It is crucial that these operations call `check_align` *before*
  17 //! short-circuiting the empty case!
  18
  19 use std::collections::VecDeque;
  20 use std::ptr;
  21 use std::borrow::Cow;
  22
  23 use rustc::ty::{self, Instance, ParamEnv, query::TyCtxtAt};
  24 use rustc::ty::layout::{self, Align, TargetDataLayout, Size, HasDataLayout};
  25 pub use rustc::mir::interpret::{truncate, write_target_uint, read_target_uint};
  26 use rustc_data_structures::fx::{FxHashSet, FxHashMap};
  27
  28 use syntax::ast::Mutability;
  29
  30 use super::{
  31     Pointer, AllocId, Allocation, GlobalId, AllocationExtra, InboundsCheck,
  32     EvalResult, Scalar, EvalErrorKind, AllocType, PointerArithmetic,
  33     Machine, AllocMap, MayLeak, ScalarMaybeUndef, ErrorHandled,
  34 };
  35
  36 #[derive(Debug, PartialEq, Eq, Copy, Clone, Hash)]
  37 pub enum MemoryKind<T> {
  38     /// Error if deallocated except during a stack pop
  39     Stack,
  40     /// Error if ever deallocated
  41     Vtable,
  42     /// Additional memory kinds a machine wishes to distinguish from the builtin ones
  43     Machine(T),
  44 }
  45
  46 impl<T: MayLeak> MayLeak for MemoryKind<T> {
  47     #[inline]
  48     fn may_leak(self) -> bool {
  49         match self {
  50             MemoryKind::Stack => false,
  51             MemoryKind::Vtable => true,
  52             MemoryKind::Machine(k) => k.may_leak()
  53         }
  54     }
  55 }
  56
  57 // `Memory` has to depend on the `Machine` because some of its operations
  58 // (e.g. `get`) call a `Machine` hook.
  59 pub struct Memory<'a, 'mir, 'tcx: 'a + 'mir, M: Machine<'a, 'mir, 'tcx>> {
  60     /// Allocations local to this instance of the miri engine.  The kind
  61     /// helps ensure that the same mechanism is used for allocation and
  62     /// deallocation.  When an allocation is not found here, it is a
  63     /// static and looked up in the `tcx` for read access.  Some machines may
  64     /// have to mutate this map even on a read-only access to a static (because
  65     /// they do pointer provenance tracking and the allocations in `tcx` have
  66     /// the wrong type), so we let the machine override this type.
  67     /// Either way, if the machine allows writing to a static, doing so will
  68     /// create a copy of the static allocation here.
  69     alloc_map: M::MemoryMap,
  70
  71     /// To be able to compare pointers with NULL, and to check alignment for accesses
  72     /// to ZSTs (where pointers may dangle), we keep track of the size even for allocations
  73     /// that do not exist any more.
  74     dead_alloc_map: FxHashMap<AllocId, (Size, Align)>,
  75
  76     /// Lets us implement `HasDataLayout`, which is awfully convenient.
  77     pub(super) tcx: TyCtxtAt<'a, 'tcx, 'tcx>,
  78 }
  79
  80 impl<'a, 'mir, 'tcx, M: Machine<'a, 'mir, 'tcx>> HasDataLayout
  81     for Memory<'a, 'mir, 'tcx, M>
  82 {
  83     #[inline]
  84     fn data_layout(&self) -> &TargetDataLayout {
  85         &self.tcx.data_layout
  86     }
  87 }
  88
  89 // FIXME: Really we shouldn't clone memory, ever. Snapshot machinery should instead
  90 // carefully copy only the reachable parts.
  91 impl<'a, 'mir, 'tcx: 'a + 'mir, M: Machine<'a, 'mir, 'tcx>>
  92     Clone for Memory<'a, 'mir, 'tcx, M>
  93 {
  94     fn clone(&self) -> Self {
  95         Memory {
  96             alloc_map: self.alloc_map.clone(),
  97             dead_alloc_map: self.dead_alloc_map.clone(),
  98             tcx: self.tcx,
  99         }
 100     }
 101 }
 102
 103 impl<'a, 'mir, 'tcx, M: Machine<'a, 'mir, 'tcx>> Memory<'a, 'mir, 'tcx, M> {
 104     pub fn new(tcx: TyCtxtAt<'a, 'tcx, 'tcx>) -> Self {
 105         Memory {
 106             alloc_map: Default::default(),
 107             dead_alloc_map: FxHashMap::default(),
 108             tcx,
 109         }
 110     }
 111
 112     pub fn create_fn_alloc(&mut self, instance: Instance<'tcx>) -> Pointer {
 113         Pointer::from(self.tcx.alloc_map.lock().create_fn_alloc(instance))
 114     }
 115
 116     pub fn allocate_static_bytes(&mut self, bytes: &[u8]) -> Pointer {
 117         Pointer::from(self.tcx.allocate_bytes(bytes))
 118     }
 119
 120     pub fn allocate_with(
 121         &mut self,
 122         alloc: Allocation<M::PointerTag, M::AllocExtra>,
 123         kind: MemoryKind<M::MemoryKinds>,
 124     ) -> EvalResult<'tcx, AllocId> {
 125         let id = self.tcx.alloc_map.lock().reserve();
 126         self.alloc_map.insert(id, (kind, alloc));
 127         Ok(id)
 128     }
 129
 130     pub fn allocate(
 131         &mut self,
 132         size: Size,
 133         align: Align,
 134         kind: MemoryKind<M::MemoryKinds>,
 135     ) -> EvalResult<'tcx, Pointer> {
 136         Ok(Pointer::from(self.allocate_with(Allocation::undef(size, align), kind)?))
 137     }
 138
 139     pub fn reallocate(
 140         &mut self,
 141         ptr: Pointer<M::PointerTag>,
 142         old_size: Size,
 143         old_align: Align,
 144         new_size: Size,
 145         new_align: Align,
 146         kind: MemoryKind<M::MemoryKinds>,
 147     ) -> EvalResult<'tcx, Pointer> {
 148         if ptr.offset.bytes() != 0 {
 149             return err!(ReallocateNonBasePtr);
 150         }
 151
 152         // For simplicities' sake, we implement reallocate as "alloc, copy, dealloc".
 153         // This happens so rarely, the perf advantage is outweighed by the maintenance cost.
 154         let new_ptr = self.allocate(new_size, new_align, kind)?;
 155         self.copy(
 156             ptr.into(),
 157             old_align,
 158             new_ptr.with_default_tag().into(),
 159             new_align,
 160             old_size.min(new_size),
 161             /*nonoverlapping*/ true,
 162         )?;
 163         self.deallocate(ptr, Some((old_size, old_align)), kind)?;
 164
 165         Ok(new_ptr)
 166     }
 167
 168     /// Deallocate a local, or do nothing if that local has been made into a static
 169     pub fn deallocate_local(&mut self, ptr: Pointer<M::PointerTag>) -> EvalResult<'tcx> {
 170         // The allocation might be already removed by static interning.
 171         // This can only really happen in the CTFE instance, not in miri.
 172         if self.alloc_map.contains_key(&ptr.alloc_id) {
 173             self.deallocate(ptr, None, MemoryKind::Stack)
 174         } else {
 175             Ok(())
 176         }
 177     }
 178
 179     pub fn deallocate(
 180         &mut self,
 181         ptr: Pointer<M::PointerTag>,
 182         size_and_align: Option<(Size, Align)>,
 183         kind: MemoryKind<M::MemoryKinds>,
 184     ) -> EvalResult<'tcx> {
 185         trace!("deallocating: {}", ptr.alloc_id);
 186
 187         if ptr.offset.bytes() != 0 {
 188             return err!(DeallocateNonBasePtr);
 189         }
 190
 191         let (alloc_kind, mut alloc) = match self.alloc_map.remove(&ptr.alloc_id) {
 192             Some(alloc) => alloc,
 193             None => {
 194                 // Deallocating static memory -- always an error
 195                 return match self.tcx.alloc_map.lock().get(ptr.alloc_id) {
 196                     Some(AllocType::Function(..)) => err!(DeallocatedWrongMemoryKind(
 197                         "function".to_string(),
 198                         format!("{:?}", kind),
 199                     )),
 200                     Some(AllocType::Static(..)) |
 201                     Some(AllocType::Memory(..)) => err!(DeallocatedWrongMemoryKind(
 202                         "static".to_string(),
 203                         format!("{:?}", kind),
 204                     )),
 205                     None => err!(DoubleFree)
 206                 }
 207             }
 208         };
 209
 210         if alloc_kind != kind {
 211             return err!(DeallocatedWrongMemoryKind(
 212                 format!("{:?}", alloc_kind),
 213                 format!("{:?}", kind),
 214             ));
 215         }
 216         if let Some((size, align)) = size_and_align {
 217             if size.bytes() != alloc.bytes.len() as u64 || align != alloc.align {
 218                 let bytes = Size::from_bytes(alloc.bytes.len() as u64);
 219                 return err!(IncorrectAllocationInformation(size,
 220                                                            bytes,
 221                                                            align,
 222                                                            alloc.align));
 223             }
 224         }
 225
 226         // Let the machine take some extra action
 227         let size = Size::from_bytes(alloc.bytes.len() as u64);
 228         AllocationExtra::memory_deallocated(&mut alloc, ptr, size)?;
 229
 230         // Don't forget to remember size and align of this now-dead allocation
 231         let old = self.dead_alloc_map.insert(
 232             ptr.alloc_id,
 233             (Size::from_bytes(alloc.bytes.len() as u64), alloc.align)
 234         );
 235         if old.is_some() {
 236             bug!("Nothing can be deallocated twice");
 237         }
 238
 239         Ok(())
 240     }
 241
 242     /// Check that the pointer is aligned AND non-NULL. This supports ZSTs in two ways:
 243     /// You can pass a scalar, and a `Pointer` does not have to actually still be allocated.
 244     pub fn check_align(
 245         &self,
 246         ptr: Scalar<M::PointerTag>,
 247         required_align: Align
 248     ) -> EvalResult<'tcx> {
 249         // Check non-NULL/Undef, extract offset
 250         let (offset, alloc_align) = match ptr {
 251             Scalar::Ptr(ptr) => {
 252                 // check this is not NULL -- which we can ensure only if this is in-bounds
 253                 // of some (potentially dead) allocation.
 254                 self.check_bounds_ptr(ptr, InboundsCheck::MaybeDead)?;
 255                 // data required for alignment check
 256                 let (_, align) = self.get_size_and_align(ptr.alloc_id);
 257                 (ptr.offset.bytes(), align)
 258             }
 259             Scalar::Bits { bits, size } => {
 260                 assert_eq!(size as u64, self.pointer_size().bytes());
 261                 assert!(bits < (1u128 << self.pointer_size().bits()));
 262                 // check this is not NULL
 263                 if bits == 0 {
 264                     return err!(InvalidNullPointerUsage);
 265                 }
 266                 // the "base address" is 0 and hence always aligned
 267                 (bits as u64, required_align)
 268             }
 269         };
 270         // Check alignment
 271         if alloc_align.bytes() < required_align.bytes() {
 272             return err!(AlignmentCheckFailed {
 273                 has: alloc_align,
 274                 required: required_align,
 275             });
 276         }
 277         if offset % required_align.bytes() == 0 {
 278             Ok(())
 279         } else {
 280             let has = offset % required_align.bytes();
 281             err!(AlignmentCheckFailed {
 282                 has: Align::from_bytes(has).unwrap(),
 283                 required: required_align,
 284             })
 285         }
 286     }
 287
 288     /// Check if the pointer is "in-bounds". Notice that a pointer pointing at the end
 289     /// of an allocation (i.e., at the first *inaccessible* location) *is* considered
 290     /// in-bounds!  This follows C's/LLVM's rules.  `check` indicates whether we
 291     /// additionally require the pointer to be pointing to a *live* (still allocated)
 292     /// allocation.
 293     /// If you want to check bounds before doing a memory access, better use `check_bounds`.
 294     pub fn check_bounds_ptr(
 295         &self,
 296         ptr: Pointer<M::PointerTag>,
 297         check: InboundsCheck,
 298     ) -> EvalResult<'tcx> {
 299         let allocation_size = match check {
 300             InboundsCheck::Live => {
 301                 let alloc = self.get(ptr.alloc_id)?;
 302                 alloc.bytes.len() as u64
 303             }
 304             InboundsCheck::MaybeDead => {
 305                 self.get_size_and_align(ptr.alloc_id).0.bytes()
 306             }
 307         };
 308         if ptr.offset.bytes() > allocation_size {
 309             return err!(PointerOutOfBounds {
 310                 ptr: ptr.erase_tag(),
 311                 check,
 312                 allocation_size: Size::from_bytes(allocation_size),
 313             });
 314         }
 315         Ok(())
 316     }
 317
 318     /// Check if the memory range beginning at `ptr` and of size `Size` is "in-bounds".
 319     #[inline(always)]
 320     pub fn check_bounds(
 321         &self,
 322         ptr: Pointer<M::PointerTag>,
 323         size: Size,
 324         check: InboundsCheck,
 325     ) -> EvalResult<'tcx> {
 326         // if ptr.offset is in bounds, then so is ptr (because offset checks for overflow)
 327         self.check_bounds_ptr(ptr.offset(size, &*self)?, check)
 328     }
 329 }
 330
 331 /// Allocation accessors
 332 impl<'a, 'mir, 'tcx, M: Machine<'a, 'mir, 'tcx>> Memory<'a, 'mir, 'tcx, M> {
 333     /// Helper function to obtain the global (tcx) allocation for a static.
 334     /// This attempts to return a reference to an existing allocation if
 335     /// one can be found in `tcx`. That, however, is only possible if `tcx` and
 336     /// this machine use the same pointer tag, so it is indirected through
 337     /// `M::static_with_default_tag`.
 338     fn get_static_alloc(
 339         tcx: TyCtxtAt<'a, 'tcx, 'tcx>,
 340         id: AllocId,
 341     ) -> EvalResult<'tcx, Cow<'tcx, Allocation<M::PointerTag, M::AllocExtra>>> {
 342         let alloc = tcx.alloc_map.lock().get(id);
 343         let def_id = match alloc {
 344             Some(AllocType::Memory(mem)) => {
 345                 // We got tcx memory. Let the machine figure out whether and how to
 346                 // turn that into memory with the right pointer tag.
 347                 return Ok(M::adjust_static_allocation(mem))
 348             }
 349             Some(AllocType::Function(..)) => {
 350                 return err!(DerefFunctionPointer)
 351             }
 352             Some(AllocType::Static(did)) => {
 353                 did
 354             }
 355             None =>
 356                 return err!(DanglingPointerDeref),
 357         };
 358         // We got a "lazy" static that has not been computed yet, do some work
 359         trace!("static_alloc: Need to compute {:?}", def_id);
 360         if tcx.is_foreign_item(def_id) {
 361             return M::find_foreign_static(tcx, def_id);
 362         }
 363         let instance = Instance::mono(tcx.tcx, def_id);
 364         let gid = GlobalId {
 365             instance,
 366             promoted: None,
 367         };
 368         // use the raw query here to break validation cycles. Later uses of the static will call the
 369         // full query anyway
 370         tcx.const_eval_raw(ty::ParamEnv::reveal_all().and(gid)).map_err(|err| {
 371             // no need to report anything, the const_eval call takes care of that for statics
 372             assert!(tcx.is_static(def_id).is_some());
 373             match err {
 374                 ErrorHandled::Reported => EvalErrorKind::ReferencedConstant.into(),
 375                 ErrorHandled::TooGeneric => EvalErrorKind::TooGeneric.into(),
 376             }
 377         }).map(|raw_const| {
 378             let allocation = tcx.alloc_map.lock().unwrap_memory(raw_const.alloc_id);
 379             // We got tcx memory. Let the machine figure out whether and how to
 380             // turn that into memory with the right pointer tag.
 381             M::adjust_static_allocation(allocation)
 382         })
 383     }
 384
 385     pub fn get(&self, id: AllocId) -> EvalResult<'tcx, &Allocation<M::PointerTag, M::AllocExtra>> {
 386         // The error type of the inner closure here is somewhat funny.  We have two
 387         // ways of "erroring": An actual error, or because we got a reference from
 388         // `get_static_alloc` that we can actually use directly without inserting anything anywhere.
 389         // So the error type is `EvalResult<'tcx, &Allocation<M::PointerTag>>`.
 390         let a = self.alloc_map.get_or(id, || {
 391             let alloc = Self::get_static_alloc(self.tcx, id).map_err(Err)?;
 392             match alloc {
 393                 Cow::Borrowed(alloc) => {
 394                     // We got a ref, cheaply return that as an "error" so that the
 395                     // map does not get mutated.
 396                     Err(Ok(alloc))
 397                 }
 398                 Cow::Owned(alloc) => {
 399                     // Need to put it into the map and return a ref to that
 400                     let kind = M::STATIC_KIND.expect(
 401                         "I got an owned allocation that I have to copy but the machine does \
 402                             not expect that to happen"
 403                     );
 404                     Ok((MemoryKind::Machine(kind), alloc))
 405                 }
 406             }
 407         });
 408         // Now unpack that funny error type
 409         match a {
 410             Ok(a) => Ok(&a.1),
 411             Err(a) => a
 412         }
 413     }
 414
 415     pub fn get_mut(
 416         &mut self,
 417         id: AllocId,
 418     ) -> EvalResult<'tcx, &mut Allocation<M::PointerTag, M::AllocExtra>> {
 419         let tcx = self.tcx;
 420         let a = self.alloc_map.get_mut_or(id, || {
 421             // Need to make a copy, even if `get_static_alloc` is able
 422             // to give us a cheap reference.
 423             let alloc = Self::get_static_alloc(tcx, id)?;
 424             if alloc.mutability == Mutability::Immutable {
 425                 return err!(ModifiedConstantMemory);
 426             }
 427             let kind = M::STATIC_KIND.expect(
 428                 "An allocation is being mutated but the machine does not expect that to happen"
 429             );
 430             Ok((MemoryKind::Machine(kind), alloc.into_owned()))
 431         });
 432         // Unpack the error type manually because type inference doesn't
 433         // work otherwise (and we cannot help it because `impl Trait`)
 434         match a {
 435             Err(e) => Err(e),
 436             Ok(a) => {
 437                 let a = &mut a.1;
 438                 if a.mutability == Mutability::Immutable {
 439                     return err!(ModifiedConstantMemory);
 440                 }
 441                 Ok(a)
 442             }
 443         }
 444     }
 445
 446     pub fn get_size_and_align(&self, id: AllocId) -> (Size, Align) {
 447         if let Ok(alloc) = self.get(id) {
 448             return (Size::from_bytes(alloc.bytes.len() as u64), alloc.align);
 449         }
 450         // Could also be a fn ptr or extern static
 451         match self.tcx.alloc_map.lock().get(id) {
 452             Some(AllocType::Function(..)) => (Size::ZERO, Align::from_bytes(1).unwrap()),
 453             Some(AllocType::Static(did)) => {
 454                 // The only way `get` couldn't have worked here is if this is an extern static
 455                 assert!(self.tcx.is_foreign_item(did));
 456                 // Use size and align of the type
 457                 let ty = self.tcx.type_of(did);
 458                 let layout = self.tcx.layout_of(ParamEnv::empty().and(ty)).unwrap();
 459                 (layout.size, layout.align.abi)
 460             }
 461             _ => {
 462                 // Must be a deallocated pointer
 463                 *self.dead_alloc_map.get(&id).expect(
 464                     "allocation missing in dead_alloc_map"
 465                 )
 466             }
 467         }
 468     }
 469
 470     pub fn get_fn(&self, ptr: Pointer<M::PointerTag>) -> EvalResult<'tcx, Instance<'tcx>> {
 471         if ptr.offset.bytes() != 0 {
 472             return err!(InvalidFunctionPointer);
 473         }
 474         trace!("reading fn ptr: {}", ptr.alloc_id);
 475         match self.tcx.alloc_map.lock().get(ptr.alloc_id) {
 476             Some(AllocType::Function(instance)) => Ok(instance),
 477             _ => Err(EvalErrorKind::ExecuteMemory.into()),
 478         }
 479     }
 480
 481     pub fn mark_immutable(&mut self, id: AllocId) -> EvalResult<'tcx> {
 482         self.get_mut(id)?.mutability = Mutability::Immutable;
 483         Ok(())
 484     }
 485
 486     /// For debugging, print an allocation and all allocations it points to, recursively.
 487     pub fn dump_alloc(&self, id: AllocId) {
 488         self.dump_allocs(vec![id]);
 489     }
 490
 491     fn dump_alloc_helper<Tag, Extra>(
 492         &self,
 493         allocs_seen: &mut FxHashSet<AllocId>,
 494         allocs_to_print: &mut VecDeque<AllocId>,
 495         mut msg: String,
 496         alloc: &Allocation<Tag, Extra>,
 497         extra: String,
 498     ) {
 499         use std::fmt::Write;
 500
 501         let prefix_len = msg.len();
 502         let mut relocations = vec![];
 503
 504         for i in 0..(alloc.bytes.len() as u64) {
 505             let i = Size::from_bytes(i);
 506             if let Some(&(_, target_id)) = alloc.relocations.get(&i) {
 507                 if allocs_seen.insert(target_id) {
 508                     allocs_to_print.push_back(target_id);
 509                 }
 510                 relocations.push((i, target_id));
 511             }
 512             if alloc.undef_mask.is_range_defined(i, i + Size::from_bytes(1)).is_ok() {
 513                 // this `as usize` is fine, since `i` came from a `usize`
 514                 write!(msg, "{:02x} ", alloc.bytes[i.bytes() as usize]).unwrap();
 515             } else {
 516                 msg.push_str("__ ");
 517             }
 518         }
 519
 520         trace!(
 521             "{}({} bytes, alignment {}){}",
 522             msg,
 523             alloc.bytes.len(),
 524             alloc.align.bytes(),
 525             extra
 526         );
 527
 528         if !relocations.is_empty() {
 529             msg.clear();
 530             write!(msg, "{:1$}", "", prefix_len).unwrap(); // Print spaces.
 531             let mut pos = Size::ZERO;
 532             let relocation_width = (self.pointer_size().bytes() - 1) * 3;
 533             for (i, target_id) in relocations {
 534                 // this `as usize` is fine, since we can't print more chars than `usize::MAX`
 535                 write!(msg, "{:1$}", "", ((i - pos) * 3).bytes() as usize).unwrap();
 536                 let target = format!("({})", target_id);
 537                 // this `as usize` is fine, since we can't print more chars than `usize::MAX`
 538                 write!(msg, "└{0:─^1$}┘ ", target, relocation_width as usize).unwrap();
 539                 pos = i + self.pointer_size();
 540             }
 541             trace!("{}", msg);
 542         }
 543     }
 544
 545     /// For debugging, print a list of allocations and all allocations they point to, recursively.
 546     pub fn dump_allocs(&self, mut allocs: Vec<AllocId>) {
 547         if !log_enabled!(::log::Level::Trace) {
 548             return;
 549         }
 550         allocs.sort();
 551         allocs.dedup();
 552         let mut allocs_to_print = VecDeque::from(allocs);
 553         let mut allocs_seen = FxHashSet::default();
 554
 555         while let Some(id) = allocs_to_print.pop_front() {
 556             let msg = format!("Alloc {:<5} ", format!("{}:", id));
 557
 558             // normal alloc?
 559             match self.alloc_map.get_or(id, || Err(())) {
 560                 Ok((kind, alloc)) => {
 561                     let extra = match kind {
 562                         MemoryKind::Stack => " (stack)".to_owned(),
 563                         MemoryKind::Vtable => " (vtable)".to_owned(),
 564                         MemoryKind::Machine(m) => format!(" ({:?})", m),
 565                     };
 566                     self.dump_alloc_helper(
 567                         &mut allocs_seen, &mut allocs_to_print,
 568                         msg, alloc, extra
 569                     );
 570                 },
 571                 Err(()) => {
 572                     // static alloc?
 573                     match self.tcx.alloc_map.lock().get(id) {
 574                         Some(AllocType::Memory(alloc)) => {
 575                             self.dump_alloc_helper(
 576                                 &mut allocs_seen, &mut allocs_to_print,
 577                                 msg, alloc, " (immutable)".to_owned()
 578                             );
 579                         }
 580                         Some(AllocType::Function(func)) => {
 581                             trace!("{} {}", msg, func);
 582                         }
 583                         Some(AllocType::Static(did)) => {
 584                             trace!("{} {:?}", msg, did);
 585                         }
 586                         None => {
 587                             trace!("{} (deallocated)", msg);
 588                         }
 589                     }
 590                 },
 591             };
 592
 593         }
 594     }
 595
 596     pub fn leak_report(&self) -> usize {
 597         trace!("### LEAK REPORT ###");
 598         let leaks: Vec<_> = self.alloc_map.filter_map_collect(|&id, &(kind, _)| {
 599             if kind.may_leak() { None } else { Some(id) }
 600         });
 601         let n = leaks.len();
 602         self.dump_allocs(leaks);
 603         n
 604     }
 605
 606     /// This is used by [priroda](https://github.com/oli-obk/priroda)
 607     pub fn alloc_map(&self) -> &M::MemoryMap {
 608         &self.alloc_map
 609     }
 610 }
 611
 612 /// Interning (for CTFE)
 613 impl<'a, 'mir, 'tcx, M> Memory<'a, 'mir, 'tcx, M>
 614 where
 615     M: Machine<'a, 'mir, 'tcx, PointerTag=(), AllocExtra=()>,
 616     M::MemoryMap: AllocMap<AllocId, (MemoryKind<M::MemoryKinds>, Allocation)>,
 617 {
 618     /// mark an allocation as static and initialized, either mutable or not
 619     pub fn intern_static(
 620         &mut self,
 621         alloc_id: AllocId,
 622         mutability: Mutability,
 623     ) -> EvalResult<'tcx> {
 624         trace!(
 625             "mark_static_initialized {:?}, mutability: {:?}",
 626             alloc_id,
 627             mutability
 628         );
 629         // remove allocation
 630         let (kind, mut alloc) = self.alloc_map.remove(&alloc_id).unwrap();
 631         match kind {
 632             MemoryKind::Machine(_) => bug!("Static cannot refer to machine memory"),
 633             MemoryKind::Stack | MemoryKind::Vtable => {},
 634         }
 635         // ensure llvm knows not to put this into immutable memory
 636         alloc.mutability = mutability;
 637         let alloc = self.tcx.intern_const_alloc(alloc);
 638         self.tcx.alloc_map.lock().set_id_memory(alloc_id, alloc);
 639         // recurse into inner allocations
 640         for &(_, alloc) in alloc.relocations.values() {
 641             // FIXME: Reusing the mutability here is likely incorrect.  It is originally
 642             // determined via `is_freeze`, and data is considered frozen if there is no
 643             // `UnsafeCell` *immediately* in that data -- however, this search stops
 644             // at references.  So whenever we follow a reference, we should likely
 645             // assume immutability -- and we should make sure that the compiler
 646             // does not permit code that would break this!
 647             if self.alloc_map.contains_key(&alloc) {
 648                 // Not yet interned, so proceed recursively
 649                 self.intern_static(alloc, mutability)?;
 650             } else if self.dead_alloc_map.contains_key(&alloc) {
 651                 // dangling pointer
 652                 return err!(ValidationFailure(
 653                     "encountered dangling pointer in final constant".into(),
 654                 ))
 655             }
 656         }
 657         Ok(())
 658     }
 659 }
 660
 661 /// Reading and writing
 662 impl<'a, 'mir, 'tcx, M: Machine<'a, 'mir, 'tcx>> Memory<'a, 'mir, 'tcx, M> {
 663     pub fn copy(
 664         &mut self,
 665         src: Scalar<M::PointerTag>,
 666         src_align: Align,
 667         dest: Scalar<M::PointerTag>,
 668         dest_align: Align,
 669         size: Size,
 670         nonoverlapping: bool,
 671     ) -> EvalResult<'tcx> {
 672         self.copy_repeatedly(src, src_align, dest, dest_align, size, 1, nonoverlapping)
 673     }
 674
 675     pub fn copy_repeatedly(
 676         &mut self,
 677         src: Scalar<M::PointerTag>,
 678         src_align: Align,
 679         dest: Scalar<M::PointerTag>,
 680         dest_align: Align,
 681         size: Size,
 682         length: u64,
 683         nonoverlapping: bool,
 684     ) -> EvalResult<'tcx> {
 685         if size.bytes() == 0 {
 686             // Nothing to do for ZST, other than checking alignment and non-NULLness.
 687             self.check_align(src, src_align)?;
 688             self.check_align(dest, dest_align)?;
 689             return Ok(());
 690         }
 691         let src = src.to_ptr()?;
 692         let dest = dest.to_ptr()?;
 693
 694         // first copy the relocations to a temporary buffer, because
 695         // `get_bytes_mut` will clear the relocations, which is correct,
 696         // since we don't want to keep any relocations at the target.
 697         // (`get_bytes_with_undef_and_ptr` below checks that there are no
 698         // relocations overlapping the edges; those would not be handled correctly).
 699         let relocations = {
 700             let relocations = self.relocations(src, size)?;
 701             let mut new_relocations = Vec::with_capacity(relocations.len() * (length as usize));
 702             for i in 0..length {
 703                 new_relocations.extend(
 704                     relocations
 705                     .iter()
 706                     .map(|&(offset, reloc)| {
 707                     (offset + dest.offset - src.offset + (i * size * relocations.len() as u64),
 708                      reloc)
 709                     })
 710                 );
 711             }
 712
 713             new_relocations
 714         };
 715
 716         // This also checks alignment, and relocation edges on the src.
 717         let src_bytes = self.get_bytes_with_undef_and_ptr(src, size, src_align)?.as_ptr();
 718         let dest_bytes = self.get_bytes_mut(dest, size * length, dest_align)?.as_mut_ptr();
 719
 720         // SAFE: The above indexing would have panicked if there weren't at least `size` bytes
 721         // behind `src` and `dest`. Also, we use the overlapping-safe `ptr::copy` if `src` and
 722         // `dest` could possibly overlap.
 723         // The pointers above remain valid even if the `HashMap` table is moved around because they
 724         // point into the `Vec` storing the bytes.
 725         unsafe {
 726             assert_eq!(size.bytes() as usize as u64, size.bytes());
 727             if src.alloc_id == dest.alloc_id {
 728                 if nonoverlapping {
 729                     if (src.offset <= dest.offset && src.offset + size > dest.offset) ||
 730                         (dest.offset <= src.offset && dest.offset + size > src.offset)
 731                     {
 732                         return err!(Intrinsic(
 733                             "copy_nonoverlapping called on overlapping ranges".to_string(),
 734                         ));
 735                     }
 736                 }
 737
 738                 for i in 0..length {
 739                     ptr::copy(src_bytes,
 740                               dest_bytes.offset((size.bytes() * i) as isize),
 741                               size.bytes() as usize);
 742                 }
 743             } else {
 744                 for i in 0..length {
 745                     ptr::copy_nonoverlapping(src_bytes,
 746                                              dest_bytes.offset((size.bytes() * i) as isize),
 747                                              size.bytes() as usize);
 748                 }
 749             }
 750         }
 751
 752         // copy definedness to the destination
 753         self.copy_undef_mask(src, dest, size, length)?;
 754         // copy the relocations to the destination
 755         self.get_mut(dest.alloc_id)?.relocations.insert_presorted(relocations);
 756
 757         Ok(())
 758     }
 759
 760     pub fn read_c_str(&self, ptr: Pointer<M::PointerTag>) -> EvalResult<'tcx, &[u8]> {
 761         let alloc = self.get(ptr.alloc_id)?;
 762         assert_eq!(ptr.offset.bytes() as usize as u64, ptr.offset.bytes());
 763         let offset = ptr.offset.bytes() as usize;
 764         match alloc.bytes[offset..].iter().position(|&c| c == 0) {
 765             Some(size) => {
 766                 let p1 = Size::from_bytes((size + 1) as u64);
 767                 self.check_relocations(ptr, p1)?;
 768                 self.check_defined(ptr, p1)?;
 769                 Ok(&alloc.bytes[offset..offset + size])
 770             }
 771             None => err!(UnterminatedCString(ptr.erase_tag())),
 772         }
 773     }
 774
 775     pub fn check_bytes(
 776         &self,
 777         ptr: Scalar<M::PointerTag>,
 778         size: Size,
 779         allow_ptr_and_undef: bool,
 780     ) -> EvalResult<'tcx> {
 781         // Empty accesses don't need to be valid pointers, but they should still be non-NULL
 782         let align = Align::from_bytes(1).unwrap();
 783         if size.bytes() == 0 {
 784             self.check_align(ptr, align)?;
 785             return Ok(());
 786         }
 787         let ptr = ptr.to_ptr()?;
 788         // Check bounds, align and relocations on the edges
 789         self.get_bytes_with_undef_and_ptr(ptr, size, align)?;
 790         // Check undef and ptr
 791         if !allow_ptr_and_undef {
 792             self.check_defined(ptr, size)?;
 793             self.check_relocations(ptr, size)?;
 794         }
 795         Ok(())
 796     }
 797
 798     pub fn read_bytes(&self, ptr: Scalar<M::PointerTag>, size: Size) -> EvalResult<'tcx, &[u8]> {
 799         // Empty accesses don't need to be valid pointers, but they should still be non-NULL
 800         let align = Align::from_bytes(1).unwrap();
 801         if size.bytes() == 0 {
 802             self.check_align(ptr, align)?;
 803             return Ok(&[]);
 804         }
 805         self.get_bytes(ptr.to_ptr()?, size, align)
 806     }
 807
 808     pub fn write_bytes(&mut self, ptr: Scalar<M::PointerTag>, src: &[u8]) -> EvalResult<'tcx> {
 809         // Empty accesses don't need to be valid pointers, but they should still be non-NULL
 810         let align = Align::from_bytes(1).unwrap();
 811         if src.is_empty() {
 812             self.check_align(ptr, align)?;
 813             return Ok(());
 814         }
 815         let bytes = self.get_bytes_mut(ptr.to_ptr()?, Size::from_bytes(src.len() as u64), align)?;
 816         bytes.clone_from_slice(src);
 817         Ok(())
 818     }
 819
 820     pub fn write_repeat(
 821         &mut self,
 822         ptr: Scalar<M::PointerTag>,
 823         val: u8,
 824         count: Size
 825     ) -> EvalResult<'tcx> {
 826         // Empty accesses don't need to be valid pointers, but they should still be non-NULL
 827         let align = Align::from_bytes(1).unwrap();
 828         if count.bytes() == 0 {
 829             self.check_align(ptr, align)?;
 830             return Ok(());
 831         }
 832         let bytes = self.get_bytes_mut(ptr.to_ptr()?, count, align)?;
 833         for b in bytes {
 834             *b = val;
 835         }
 836         Ok(())
 837     }
 838
 839     /// Read a *non-ZST* scalar
 840     pub fn read_scalar(
 841         &self,
 842         ptr: Pointer<M::PointerTag>,
 843         ptr_align: Align,
 844         size: Size
 845     ) -> EvalResult<'tcx, ScalarMaybeUndef<M::PointerTag>> {
 846         // get_bytes_unchecked tests alignment and relocation edges
 847         let bytes = self.get_bytes_with_undef_and_ptr(
 848             ptr, size, ptr_align.min(self.int_align(size))
 849         )?;
 850         // Undef check happens *after* we established that the alignment is correct.
 851         // We must not return Ok() for unaligned pointers!
 852         if self.check_defined(ptr, size).is_err() {
 853             // this inflates undefined bytes to the entire scalar, even if only a few
 854             // bytes are undefined
 855             return Ok(ScalarMaybeUndef::Undef);
 856         }
 857         // Now we do the actual reading
 858         let bits = read_target_uint(self.tcx.data_layout.endian, bytes).unwrap();
 859         // See if we got a pointer
 860         if size != self.pointer_size() {
 861             // *Now* better make sure that the inside also is free of relocations.
 862             self.check_relocations(ptr, size)?;
 863         } else {
 864             let alloc = self.get(ptr.alloc_id)?;
 865             match alloc.relocations.get(&ptr.offset) {
 866                 Some(&(tag, alloc_id)) => {
 867                     let ptr = Pointer::new_with_tag(alloc_id, Size::from_bytes(bits as u64), tag);
 868                     return Ok(ScalarMaybeUndef::Scalar(ptr.into()))
 869                 }
 870                 None => {},
 871             }
 872         }
 873         // We don't. Just return the bits.
 874         Ok(ScalarMaybeUndef::Scalar(Scalar::from_uint(bits, size)))
 875     }
 876
 877     pub fn read_ptr_sized(
 878         &self,
 879         ptr: Pointer<M::PointerTag>,
 880         ptr_align: Align
 881     ) -> EvalResult<'tcx, ScalarMaybeUndef<M::PointerTag>> {
 882         self.read_scalar(ptr, ptr_align, self.pointer_size())
 883     }
 884
 885     /// Write a *non-ZST* scalar
 886     pub fn write_scalar(
 887         &mut self,
 888         ptr: Pointer<M::PointerTag>,
 889         ptr_align: Align,
 890         val: ScalarMaybeUndef<M::PointerTag>,
 891         type_size: Size,
 892     ) -> EvalResult<'tcx> {
 893         let val = match val {
 894             ScalarMaybeUndef::Scalar(scalar) => scalar,
 895             ScalarMaybeUndef::Undef => return self.mark_definedness(ptr, type_size, false),
 896         };
 897
 898         let bytes = match val {
 899             Scalar::Ptr(val) => {
 900                 assert_eq!(type_size, self.pointer_size());
 901                 val.offset.bytes() as u128
 902             }
 903
 904             Scalar::Bits { bits, size } => {
 905                 assert_eq!(size as u64, type_size.bytes());
 906                 debug_assert_eq!(truncate(bits, Size::from_bytes(size.into())), bits,
 907                     "Unexpected value of size {} when writing to memory", size);
 908                 bits
 909             },
 910         };
 911
 912         {
 913             // get_bytes_mut checks alignment
 914             let endian = self.tcx.data_layout.endian;
 915             let dst = self.get_bytes_mut(ptr, type_size, ptr_align)?;
 916             write_target_uint(endian, dst, bytes).unwrap();
 917         }
 918
 919         // See if we have to also write a relocation
 920         match val {
 921             Scalar::Ptr(val) => {
 922                 self.get_mut(ptr.alloc_id)?.relocations.insert(
 923                     ptr.offset,
 924                     (val.tag, val.alloc_id),
 925                 );
 926             }
 927             _ => {}
 928         }
 929
 930         Ok(())
 931     }
 932
 933     pub fn write_ptr_sized(
 934         &mut self,
 935         ptr: Pointer<M::PointerTag>,
 936         ptr_align: Align,
 937         val: ScalarMaybeUndef<M::PointerTag>
 938     ) -> EvalResult<'tcx> {
 939         let ptr_size = self.pointer_size();
 940         self.write_scalar(ptr.into(), ptr_align, val, ptr_size)
 941     }
 942
 943     fn int_align(&self, size: Size) -> Align {
 944         // We assume pointer-sized integers have the same alignment as pointers.
 945         // We also assume signed and unsigned integers of the same size have the same alignment.
 946         let ity = match size.bytes() {
 947             1 => layout::I8,
 948             2 => layout::I16,
 949             4 => layout::I32,
 950             8 => layout::I64,
 951             16 => layout::I128,
 952             _ => bug!("bad integer size: {}", size.bytes()),
 953         };
 954         ity.align(self).abi
 955     }
 956 }
 957
 958 /// Undefined bytes
 959 impl<'a, 'mir, 'tcx, M: Machine<'a, 'mir, 'tcx>> Memory<'a, 'mir, 'tcx, M> {
 960     // FIXME: Add a fast version for the common, nonoverlapping case
 961     fn copy_undef_mask(
 962         &mut self,
 963         src: Pointer<M::PointerTag>,
 964         dest: Pointer<M::PointerTag>,
 965         size: Size,
 966         repeat: u64,
 967     ) -> EvalResult<'tcx> {
 968         // The bits have to be saved locally before writing to dest in case src and dest overlap.
 969         assert_eq!(size.bytes() as usize as u64, size.bytes());
 970
 971         let undef_mask = self.get(src.alloc_id)?.undef_mask.clone();
 972         let dest_allocation = self.get_mut(dest.alloc_id)?;
 973
 974         for i in 0..size.bytes() {
 975             let defined = undef_mask.get(src.offset + Size::from_bytes(i));
 976
 977             for j in 0..repeat {
 978                 dest_allocation.undef_mask.set(
 979                     dest.offset + Size::from_bytes(i + (size.bytes() * j)),
 980                     defined
 981                 );
 982             }
 983         }
 984
 985         Ok(())
 986     }
 987
 988     /// Checks that a range of bytes is defined. If not, returns the `ReadUndefBytes`
 989     /// error which will report the first byte which is undefined.
 990     #[inline]
 991     fn check_defined(&self, ptr: Pointer<M::PointerTag>, size: Size) -> EvalResult<'tcx> {
 992         let alloc = self.get(ptr.alloc_id)?;
 993         alloc.undef_mask.is_range_defined(
 994             ptr.offset,
 995             ptr.offset + size,
 996         ).or_else(|idx| err!(ReadUndefBytes(idx)))
 997     }
 998
 999     pub fn mark_definedness(
1000         &mut self,
1001         ptr: Pointer<M::PointerTag>,
1002         size: Size,
1003         new_state: bool,
1004     ) -> EvalResult<'tcx> {
1005         if size.bytes() == 0 {
1006             return Ok(());
1007         }
1008         let alloc = self.get_mut(ptr.alloc_id)?;
1009         alloc.undef_mask.set_range(
1010             ptr.offset,
1011             ptr.offset + size,
1012             new_state,
1013         );
1014         Ok(())
1015     }
1016 }