place.rs 25.2 KB
Newer Older
R
Ralf Jung 已提交
1 2 3 4 5 6 7
//! Computations on places -- field projections, going from mir::Place, and writing
//! into a place.
//! All high-level functions to write to memory work on places as destinations.

use std::hash::{Hash, Hasher};
use std::convert::TryFrom;

8
use rustc::mir;
R
Ralf Jung 已提交
9 10
use rustc::ty::{self, Ty};
use rustc::ty::layout::{self, Align, LayoutOf, TyLayout, HasDataLayout};
O
Oliver Schneider 已提交
11 12
use rustc_data_structures::indexed_vec::Idx;

R
Ralf Jung 已提交
13 14 15 16 17 18 19 20 21 22 23 24 25 26
use rustc::mir::interpret::{
    GlobalId, Scalar, EvalResult, Pointer, ScalarMaybeUndef
};
use super::{EvalContext, Machine, Value, ValTy, Operand, OpTy, MemoryKind};

#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
pub struct MemPlace {
    /// A place may have an integral pointer for ZSTs, and since it might
    /// be turned back into a reference before ever being dereferenced.
    /// However, it may never be undef.
    pub ptr: Scalar,
    pub align: Align,
    pub extra: PlaceExtra,
}
O
Oliver Schneider 已提交
27

28
#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
O
Oliver Schneider 已提交
29
pub enum Place {
30
    /// A place referring to a value allocated in the `Memory` system.
R
Ralf Jung 已提交
31
    Ptr(MemPlace),
O
Oliver Schneider 已提交
32

R
Ralf Jung 已提交
33 34 35 36 37 38
    /// To support alloc-free locals, we are able to write directly to a local.
    /// (Without that optimization, we'd just always be a `MemPlace`.)
    Local {
        frame: usize,
        local: mir::Local,
    },
O
Oliver Schneider 已提交
39 40
}

R
Ralf Jung 已提交
41
// Extra information for fat pointers / places
42
#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
O
Oliver Schneider 已提交
43 44 45
pub enum PlaceExtra {
    None,
    Length(u64),
46
    Vtable(Pointer),
O
Oliver Schneider 已提交
47 48
}

R
Ralf Jung 已提交
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
#[derive(Copy, Clone, Debug)]
pub struct PlaceTy<'tcx> {
    place: Place,
    pub layout: TyLayout<'tcx>,
}

impl<'tcx> ::std::ops::Deref for PlaceTy<'tcx> {
    type Target = Place;
    fn deref(&self) -> &Place {
        &self.place
    }
}

/// A MemPlace with its layout. Constructing it is only possible in this module.
#[derive(Copy, Clone, Debug)]
pub struct MPlaceTy<'tcx> {
    mplace: MemPlace,
    pub layout: TyLayout<'tcx>,
}

impl<'tcx> ::std::ops::Deref for MPlaceTy<'tcx> {
    type Target = MemPlace;
    fn deref(&self) -> &MemPlace {
        &self.mplace
O
Oliver Schneider 已提交
73
    }
R
Ralf Jung 已提交
74 75 76 77 78 79 80 81 82 83
}

impl<'tcx> From<MPlaceTy<'tcx>> for PlaceTy<'tcx> {
    fn from(mplace: MPlaceTy<'tcx>) -> Self {
        PlaceTy {
            place: Place::Ptr(mplace.mplace),
            layout: mplace.layout
        }
    }
}
O
Oliver Schneider 已提交
84

R
Ralf Jung 已提交
85 86 87 88
impl MemPlace {
    #[inline(always)]
    pub fn from_scalar_ptr(ptr: Scalar, align: Align) -> Self {
        MemPlace {
89 90
            ptr,
            align,
O
Oliver Schneider 已提交
91 92 93 94
            extra: PlaceExtra::None,
        }
    }

R
Ralf Jung 已提交
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    #[inline(always)]
    pub fn from_ptr(ptr: Pointer, align: Align) -> Self {
        Self::from_scalar_ptr(ptr.into(), align)
    }

    #[inline(always)]
    pub fn to_scalar_ptr_align(self) -> (Scalar, Align) {
        assert_eq!(self.extra, PlaceExtra::None);
        (self.ptr, self.align)
    }

    /// Extract the ptr part of the mplace
    #[inline(always)]
    pub fn to_ptr(self) -> EvalResult<'tcx, Pointer> {
        // At this point, we forget about the alignment information -- the place has been turned into a reference,
        // and no matter where it came from, it now must be aligned.
        self.to_scalar_ptr_align().0.to_ptr()
    }

    /// Turn a mplace into a (thin or fat) pointer, as a reference, pointing to the same space.
    /// This is the inverse of `ref_to_mplace`.
    pub fn to_ref(self, cx: impl HasDataLayout) -> Value {
        // We ignore the alignment of the place here -- special handling for packed structs ends
        // at the `&` operator.
        match self.extra {
            PlaceExtra::None => Value::Scalar(self.ptr.into()),
            PlaceExtra::Length(len) => Value::new_slice(self.ptr.into(), len, cx),
            PlaceExtra::Vtable(vtable) => Value::new_dyn_trait(self.ptr.into(), vtable),
        }
    }
}

impl<'tcx> MPlaceTy<'tcx> {
    #[inline]
    fn from_aligned_ptr(ptr: Pointer, layout: TyLayout<'tcx>) -> Self {
        MPlaceTy { mplace: MemPlace::from_ptr(ptr, layout.align), layout }
    }

    #[inline]
    pub(super) fn len(self) -> u64 {
        // Sanity check
        let ty_len = match self.layout.fields {
            layout::FieldPlacement::Array { count, .. } => count,
            _ => bug!("Length for non-array layout {:?} requested", self.layout),
        };
        if let PlaceExtra::Length(len) = self.extra {
            len
        } else {
            ty_len
        }
    }
}

// Validation needs to hash MPlaceTy, but we cannot hash Layout -- so we just hash the type
impl<'tcx> Hash for MPlaceTy<'tcx> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.mplace.hash(state);
        self.layout.ty.hash(state);
    }
}
impl<'tcx> PartialEq for MPlaceTy<'tcx> {
    fn eq(&self, other: &Self) -> bool {
        self.mplace == other.mplace && self.layout.ty == other.layout.ty
    }
}
impl<'tcx> Eq for MPlaceTy<'tcx> {}

impl<'tcx> OpTy<'tcx> {
    pub fn try_as_mplace(self) -> Result<MPlaceTy<'tcx>, Value> {
        match *self {
            Operand::Indirect(mplace) => Ok(MPlaceTy { mplace, layout: self.layout }),
            Operand::Immediate(value) => Err(value),
        }
    }

    #[inline]
    pub fn to_mem_place(self) -> MPlaceTy<'tcx> {
        self.try_as_mplace().unwrap()
    }
}

impl<'tcx> Place {
    /// Produces a Place that will error if attempted to be read from or written to
    #[inline]
    pub fn null(cx: impl HasDataLayout) -> Self {
        Self::from_scalar_ptr(Scalar::ptr_null(cx), Align::from_bytes(1, 1).unwrap())
    }

    #[inline]
    pub fn from_scalar_ptr(ptr: Scalar, align: Align) -> Self {
        Place::Ptr(MemPlace::from_scalar_ptr(ptr, align))
    }

    #[inline]
189
    pub fn from_ptr(ptr: Pointer, align: Align) -> Self {
R
Ralf Jung 已提交
190
        Place::Ptr(MemPlace::from_ptr(ptr, align))
O
Oliver Schneider 已提交
191 192
    }

R
Ralf Jung 已提交
193 194
    #[inline]
    pub fn to_mem_place(self) -> MemPlace {
O
Oliver Schneider 已提交
195
        match self {
R
Ralf Jung 已提交
196 197
            Place::Ptr(mplace) => mplace,
            _ => bug!("to_mem_place: expected Place::Ptr, got {:?}", self),
O
Oliver Schneider 已提交
198 199 200 201

        }
    }

R
Ralf Jung 已提交
202 203 204
    #[inline]
    pub fn to_scalar_ptr_align(self) -> (Scalar, Align) {
        self.to_mem_place().to_scalar_ptr_align()
205
    }
206

R
Ralf Jung 已提交
207
    #[inline]
208
    pub fn to_ptr(self) -> EvalResult<'tcx, Pointer> {
R
Ralf Jung 已提交
209 210 211
        self.to_mem_place().to_ptr()
    }
}
O
Oliver Schneider 已提交
212

R
Ralf Jung 已提交
213 214 215 216 217 218 219 220 221 222
impl<'tcx> PlaceTy<'tcx> {
    /// Produces a Place that will error if attempted to be read from or written to
    #[inline]
    pub fn null(cx: impl HasDataLayout, layout: TyLayout<'tcx>) -> Self {
        PlaceTy { place: Place::from_scalar_ptr(Scalar::ptr_null(cx), layout.align), layout }
    }

    #[inline]
    pub fn to_mem_place(self) -> MPlaceTy<'tcx> {
        MPlaceTy { mplace: self.place.to_mem_place(), layout: self.layout }
O
Oliver Schneider 已提交
223 224 225
    }
}

O
Oliver Schneider 已提交
226
impl<'a, 'mir, 'tcx, M: Machine<'mir, 'tcx>> EvalContext<'a, 'mir, 'tcx, M> {
R
Ralf Jung 已提交
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
    /// Take a value, which represents a (thin or fat) reference, and make it a place.
    /// Alignment is just based on the type.  This is the inverse of `MemPlace::to_ref`.
    pub fn ref_to_mplace(
        &self, val: ValTy<'tcx>
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        let pointee_type = val.layout.ty.builtin_deref(true).unwrap().ty;
        let layout = self.layout_of(pointee_type)?;
        let mplace = match self.tcx.struct_tail(pointee_type).sty {
            ty::TyDynamic(..) => {
                let (ptr, vtable) = val.to_scalar_dyn_trait()?;
                MemPlace {
                    ptr,
                    align: layout.align,
                    extra: PlaceExtra::Vtable(vtable),
                }
            }
            ty::TyStr | ty::TySlice(_) => {
                let (ptr, len) = val.to_scalar_slice(self)?;
                MemPlace {
                    ptr,
                    align: layout.align,
                    extra: PlaceExtra::Length(len),
                }
            }
            _ => MemPlace {
                ptr: val.to_scalar()?,
                align: layout.align,
                extra: PlaceExtra::None,
            },
        };
        Ok(MPlaceTy { mplace, layout })
    }

    /// Offset a pointer to project to a field. Unlike place_field, this is always
    /// possible without allocating, so it can take &self. Also return the field's layout.
    /// This supports both struct and array fields.
    #[inline(always)]
    pub fn mplace_field(
O
Oliver Schneider 已提交
265
        &self,
R
Ralf Jung 已提交
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
        base: MPlaceTy<'tcx>,
        field: u64,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        // Not using the layout method because we want to compute on u64
        let offset = match base.layout.fields {
            layout::FieldPlacement::Arbitrary { ref offsets, .. } =>
                offsets[usize::try_from(field).unwrap()],
            layout::FieldPlacement::Array { stride, .. } => {
                let len = base.len();
                assert!(field < len, "Tried to access element {} of array/slice with length {}", field, len);
                stride * field
            }
            _ => bug!("Unexpected layout for field access: {:#?}", base.layout),
        };
        // the only way conversion can fail if is this is an array (otherwise we already panicked
        // above). In that case, all fields are equal.
        let field = base.layout.field(self, usize::try_from(field).unwrap_or(0))?;

        // Adjust offset
        let offset = match base.extra {
            PlaceExtra::Vtable(tab) => {
                let (_, align) = self.size_and_align_of_dst(ValTy {
                    layout: base.layout,
                    value: Value::new_dyn_trait(base.ptr, tab),
                })?;
                offset.abi_align(align)
            }
            _ => offset,
        };

        let ptr = base.ptr.ptr_offset(offset, self)?;
        let align = base.align.min(field.align);
        let extra = if !field.is_unsized() {
            PlaceExtra::None
        } else {
            assert!(base.extra != PlaceExtra::None, "Expected fat ptr");
            base.extra
        };

        Ok(MPlaceTy { mplace: MemPlace { ptr, align, extra }, layout: field })
O
Oliver Schneider 已提交
306 307
    }

R
Ralf Jung 已提交
308
    pub fn mplace_subslice(
O
Oliver Schneider 已提交
309
        &self,
R
Ralf Jung 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322
        base: MPlaceTy<'tcx>,
        from: u64,
        to: u64,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        let len = base.len();
        assert!(from <= len - to);

        // Not using layout method because that works with usize, and does not work with slices
        // (that have count 0 in their layout).
        let from_offset = match base.layout.fields {
            layout::FieldPlacement::Array { stride, .. } =>
                stride * from,
            _ => bug!("Unexpected layout of index access: {:#?}", base.layout),
O
Oliver Schneider 已提交
323
        };
R
Ralf Jung 已提交
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
        let ptr = base.ptr.ptr_offset(from_offset, self)?;

        // Compute extra and new layout
        let inner_len = len - to - from;
        let (extra, ty) = match base.layout.ty.sty {
            ty::TyArray(inner, _) =>
                (PlaceExtra::None, self.tcx.mk_array(inner, inner_len)),
            ty::TySlice(..) =>
                (PlaceExtra::Length(inner_len), base.layout.ty),
            _ =>
                bug!("cannot subslice non-array type: `{:?}`", base.layout.ty),
        };
        let layout = self.layout_of(ty)?;

        Ok(MPlaceTy {
            mplace: MemPlace { ptr, align: base.align, extra },
            layout
        })
    }

    pub fn mplace_downcast(
        &self,
        base: MPlaceTy<'tcx>,
        variant: usize,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        // Downcasts only change the layout
        assert_eq!(base.extra, PlaceExtra::None);
        Ok(MPlaceTy { layout: base.layout.for_variant(self, variant), ..base })
O
Oliver Schneider 已提交
352 353
    }

R
Ralf Jung 已提交
354 355
    /// Project into an mplace
    pub fn mplace_projection(
O
Oliver Schneider 已提交
356
        &self,
R
Ralf Jung 已提交
357 358 359
        base: MPlaceTy<'tcx>,
        proj_elem: &mir::PlaceElem<'tcx>,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
360
        use rustc::mir::ProjectionElem::*;
R
Ralf Jung 已提交
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
        Ok(match *proj_elem {
            Field(field, _) => self.mplace_field(base, field.index() as u64)?,
            Downcast(_, variant) => self.mplace_downcast(base, variant)?,
            Deref => self.deref_operand(base.into())?,

            Index(local) => {
                let n = *self.frame().locals[local].access()?;
                let n_layout = self.layout_of(self.tcx.types.usize)?;
                let n = self.read_scalar(OpTy { op: n, layout: n_layout })?;
                let n = n.to_bits(self.tcx.data_layout.pointer_size)?;
                self.mplace_field(base, u64::try_from(n).unwrap())?
            }

            ConstantIndex {
                offset,
                min_length,
                from_end,
            } => {
                let n = base.len();
                assert!(n >= min_length as u64);

                let index = if from_end {
                    n - u64::from(offset)
                } else {
                    u64::from(offset)
                };

                self.mplace_field(base, index)?
            }

            Subslice { from, to } =>
                self.mplace_subslice(base, u64::from(from), u64::from(to))?,
        })
O
Oliver Schneider 已提交
394 395
    }

R
Ralf Jung 已提交
396 397 398
    /// Get the place of a field inside the place, and also the field's type.
    /// Just a convenience function, but used quite a bit.
    pub fn place_field(
O
Oliver Schneider 已提交
399
        &mut self,
R
Ralf Jung 已提交
400 401 402 403 404 405 406
        base : PlaceTy<'tcx>,
        field: u64,
    ) -> EvalResult<'tcx, PlaceTy<'tcx>> {
        // FIXME: We could try to be smarter and avoid allocation for fields that span the
        // entire place.
        let mplace = self.force_allocation(base)?;
        Ok(self.mplace_field(mplace, field)?.into())
O
Oliver Schneider 已提交
407 408
    }

R
Ralf Jung 已提交
409 410 411 412 413 414 415 416 417 418 419 420
    pub fn place_downcast(
        &mut self,
        base : PlaceTy<'tcx>,
        variant: usize,
    ) -> EvalResult<'tcx, PlaceTy<'tcx>> {
        // Downcast just changes the layout
        Ok(match base.place {
            Place::Ptr(mplace) =>
                self.mplace_downcast(MPlaceTy { mplace, layout: base.layout }, variant)?.into(),
            Place::Local { .. } => {
                let layout = base.layout.for_variant(&self, variant);
                PlaceTy { layout, ..base }
O
Oliver Schneider 已提交
421
            }
R
Ralf Jung 已提交
422
        })
O
Oliver Schneider 已提交
423 424
    }

R
Ralf Jung 已提交
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    /// Project into a place
    pub fn place_projection(
        &mut self,
        base: PlaceTy<'tcx>,
        proj_elem: &mir::ProjectionElem<'tcx, mir::Local, Ty<'tcx>>,
    ) -> EvalResult<'tcx, PlaceTy<'tcx>> {
        use rustc::mir::ProjectionElem::*;
        Ok(match *proj_elem {
            Field(field, _) =>  self.place_field(base, field.index() as u64)?,
            Downcast(_, variant) => self.place_downcast(base, variant)?,
            Deref => self.deref_operand(self.place_to_op(base)?)?.into(),
            // For the other variants, we have to force an allocation.
            // This matches `operand_projection`.
            Subslice { .. } | ConstantIndex { .. } | Index(_) => {
                let mplace = self.force_allocation(base)?;
                self.mplace_projection(mplace, proj_elem)?.into()
            }
        })
    }

    /// Compute a place.  You should only use this if you intend to write into this
    /// place; for reading, a more efficient alternative is `eval_place_for_read`.
    pub fn eval_place(&mut self, mir_place: &mir::Place<'tcx>) -> EvalResult<'tcx, PlaceTy<'tcx>> {
448
        use rustc::mir::Place::*;
O
Oliver Schneider 已提交
449
        let place = match *mir_place {
R
Ralf Jung 已提交
450 451 452 453 454 455 456 457 458 459
            Local(mir::RETURN_PLACE) => PlaceTy {
                place: self.frame().return_place,
                layout: self.layout_of_local(self.cur_frame(), mir::RETURN_PLACE)?,
            },
            Local(local) => PlaceTy {
                place: Place::Local {
                    frame: self.cur_frame(),
                    local,
                },
                layout: self.layout_of_local(self.cur_frame(), local)?,
O
Oliver Schneider 已提交
460 461
            },

462 463
            Promoted(ref promoted) => {
                let instance = self.frame().instance;
R
Ralf Jung 已提交
464
                let op = self.global_to_op(GlobalId {
465 466 467
                    instance,
                    promoted: Some(promoted.0),
                })?;
R
Ralf Jung 已提交
468 469 470 471 472
                let mplace = op.to_mem_place();
                let ty = self.monomorphize(promoted.1, self.substs());
                PlaceTy {
                    place: Place::Ptr(mplace),
                    layout: self.layout_of(ty)?,
473 474 475
                }
            }

O
Oliver Schneider 已提交
476
            Static(ref static_) => {
R
Ralf Jung 已提交
477 478
                let ty = self.monomorphize(static_.ty, self.substs());
                let layout = self.layout_of(ty)?;
479 480 481 482 483 484
                let instance = ty::Instance::mono(*self.tcx, static_.def_id);
                let cid = GlobalId {
                    instance,
                    promoted: None
                };
                let alloc = Machine::init_static(self, cid)?;
R
Ralf Jung 已提交
485
                MPlaceTy::from_aligned_ptr(alloc.into(), layout).into()
O
Oliver Schneider 已提交
486 487 488 489
            }

            Projection(ref proj) => {
                let place = self.eval_place(&proj.base)?;
R
Ralf Jung 已提交
490
                self.place_projection(place, &proj.elem)?
O
Oliver Schneider 已提交
491 492 493
            }
        };

R
Ralf Jung 已提交
494
        self.dump_place(place.place);
O
Oliver Schneider 已提交
495 496 497 498

        Ok(place)
    }

R
Ralf Jung 已提交
499 500
    /// Write a scalar to a place
    pub fn write_scalar(
O
Oliver Schneider 已提交
501
        &mut self,
R
Ralf Jung 已提交
502 503 504 505 506
        val: impl Into<ScalarMaybeUndef>,
        dest: PlaceTy<'tcx>,
    ) -> EvalResult<'tcx> {
        self.write_value(Value::Scalar(val.into()), dest)
    }
O
Oliver Schneider 已提交
507

R
Ralf Jung 已提交
508 509 510 511 512 513 514 515 516
    /// Write a value to a place
    pub fn write_value(
        &mut self,
        src_val: Value,
        dest : PlaceTy<'tcx>,
    ) -> EvalResult<'tcx> {
        // See if we can avoid an allocation. This is the counterpart to `try_read_value`,
        // but not factored as a separate function.
        match dest.place {
O
Oliver Schneider 已提交
517
            Place::Local { frame, local } => {
R
Ralf Jung 已提交
518 519 520 521 522
                match *self.stack[frame].locals[local].access_mut()? {
                    Operand::Immediate(ref mut dest_val) => {
                        // Yay, we can just change the local directly.
                        *dest_val = src_val;
                        return Ok(());
523
                    },
R
Ralf Jung 已提交
524
                    _ => {},
O
Oliver Schneider 已提交
525
                }
R
Ralf Jung 已提交
526 527
            },
            _ => {},
O
Oliver Schneider 已提交
528 529
        };

R
Ralf Jung 已提交
530 531 532
        // Slow path: write to memory
        let dest = self.force_allocation(dest)?;
        self.write_value_to_mplace(src_val, dest)
O
Oliver Schneider 已提交
533 534
    }

R
Ralf Jung 已提交
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
    /// Write a value to memory
    fn write_value_to_mplace(
        &mut self,
        value: Value,
        dest: MPlaceTy<'tcx>,
    ) -> EvalResult<'tcx> {
        trace!("write_value_to_ptr: {:#?}, {:#?}", value, dest.layout);
        assert_eq!(dest.extra, PlaceExtra::None);
        // Note that it is really important that the type here is the right one, and matches the type things are read at.
        // In case `src_val` is a `ScalarPair`, we don't do any magic here to handle padding properly, which is only
        // correct if we never look at this data with the wrong type.
        match value {
            Value::Scalar(scalar) => {
                let signed = match dest.layout.abi {
                    layout::Abi::Scalar(ref scal) => match scal.value {
                        layout::Primitive::Int(_, signed) => signed,
                        _ => false,
                    },
                    _ => false,
                };
                self.memory.write_scalar(
                    dest.ptr, dest.align, scalar, dest.layout.size, dest.layout.align, signed
                )
O
Oliver Schneider 已提交
558
            }
R
Ralf Jung 已提交
559 560 561 562 563 564 565 566 567 568 569 570 571
            Value::ScalarPair(a_val, b_val) => {
                let (a, b) = match dest.layout.abi {
                    layout::Abi::ScalarPair(ref a, ref b) => (&a.value, &b.value),
                    _ => bug!("write_value_to_ptr: invalid ScalarPair layout: {:#?}", dest.layout)
                };
                let (a_size, b_size) = (a.size(&self), b.size(&self));
                let (a_align, b_align) = (a.align(&self), b.align(&self));
                let a_ptr = dest.ptr;
                let b_offset = a_size.abi_align(b_align);
                let b_ptr = a_ptr.ptr_offset(b_offset, &self)?.into();
                // TODO: What about signedess?
                self.memory.write_scalar(a_ptr, dest.align, a_val, a_size, a_align, false)?;
                self.memory.write_scalar(b_ptr, dest.align, b_val, b_size, b_align, false)
O
Oliver Schneider 已提交
572
            }
R
Ralf Jung 已提交
573
        }
O
Oliver Schneider 已提交
574 575
    }

R
Ralf Jung 已提交
576 577
    /// Copy the data from an operand to a place
    pub fn copy_op(
O
Oliver Schneider 已提交
578
        &mut self,
R
Ralf Jung 已提交
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
        src: OpTy<'tcx>,
        dest: PlaceTy<'tcx>,
    ) -> EvalResult<'tcx> {
        trace!("Copying {:?} to {:?}", src, dest);
        assert_eq!(src.layout.size, dest.layout.size, "Size mismatch when copying!");

        // Let us see if the layout is simple so we take a shortcut, avoid force_allocation.
        let (src_ptr, src_align) = match self.try_read_value(src)? {
            Ok(src_val) =>
                // Yay, we got a value that we can write directly.
                return self.write_value(src_val, dest),
            Err(mplace) => mplace.to_scalar_ptr_align(),
        };
        // Slow path, this does not fit into an immediate. Just memcpy.
        let (dest_ptr, dest_align) = self.force_allocation(dest)?.to_scalar_ptr_align();
        self.memory.copy(
            src_ptr, src_align,
            dest_ptr, dest_align,
            src.layout.size, false
        )
O
Oliver Schneider 已提交
599 600
    }

R
Ralf Jung 已提交
601 602 603
    /// Make sure that a place is in memory, and return where it is.
    /// This is essentially `force_to_memplace`.
    pub fn force_allocation(
O
Oliver Schneider 已提交
604
        &mut self,
R
Ralf Jung 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
        place: PlaceTy<'tcx>,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        let mplace = match place.place {
            Place::Local { frame, local } => {
                // We need the layout of the local.  We can NOT use the layout we got,
                // that might e.g. be a downcast variant!
                let local_layout = self.layout_of_local(frame, local)?;
                // Make sure it has a place
                let rval = *self.stack[frame].locals[local].access()?;
                let mplace = self.allocate_op(OpTy { op: rval, layout: local_layout })?.mplace;
                // This might have allocated the flag
                *self.stack[frame].locals[local].access_mut()? =
                    Operand::Indirect(mplace);
                // done
                mplace
            }
            Place::Ptr(mplace) => mplace
        };
        // Return with the original layout, so that the caller can go on
        Ok(MPlaceTy { mplace, layout: place.layout })
O
Oliver Schneider 已提交
625 626
    }

R
Ralf Jung 已提交
627
    pub fn allocate(
O
Oliver Schneider 已提交
628
        &mut self,
R
Ralf Jung 已提交
629 630 631 632 633 634 635
        layout: TyLayout<'tcx>,
        kind: MemoryKind<M::MemoryKinds>,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        assert!(!layout.is_unsized(), "cannot alloc memory for unsized type");
        let ptr = self.memory.allocate(layout.size, layout.align, kind)?;
        Ok(MPlaceTy::from_aligned_ptr(ptr, layout))
    }
O
Oliver Schneider 已提交
636

R
Ralf Jung 已提交
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
    /// Make a place for an operand, allocating if needed
    pub fn allocate_op(
        &mut self,
        OpTy { op, layout }: OpTy<'tcx>,
    ) -> EvalResult<'tcx, MPlaceTy<'tcx>> {
        Ok(match op {
            Operand::Indirect(mplace) => MPlaceTy { mplace, layout },
            Operand::Immediate(value) => {
                // FIXME: Is stack always right here?
                let ptr = self.allocate(layout, MemoryKind::Stack)?;
                self.write_value_to_mplace(value, ptr)?;
                ptr
            },
        })
    }
O
Oliver Schneider 已提交
652

R
Ralf Jung 已提交
653 654 655 656 657 658 659 660 661 662 663 664 665
    pub fn write_discriminant_value(
        &mut self,
        variant_index: usize,
        dest: PlaceTy<'tcx>,
    ) -> EvalResult<'tcx> {
        match dest.layout.variants {
            layout::Variants::Single { index } => {
                if index != variant_index {
                    // If the layout of an enum is `Single`, all
                    // other variants are necessarily uninhabited.
                    assert_eq!(dest.layout.for_variant(&self, variant_index).abi,
                               layout::Abi::Uninhabited);
                }
O
Oliver Schneider 已提交
666
            }
R
Ralf Jung 已提交
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
            layout::Variants::Tagged { ref tag, .. } => {
                let discr_val = dest.layout.ty.ty_adt_def().unwrap()
                    .discriminant_for_variant(*self.tcx, variant_index)
                    .val;

                // raw discriminants for enums are isize or bigger during
                // their computation, but the in-memory tag is the smallest possible
                // representation
                let size = tag.value.size(self.tcx.tcx);
                let shift = 128 - size.bits();
                let discr_val = (discr_val << shift) >> shift;

                let discr_dest = self.place_field(dest, 0)?;
                self.write_scalar(Scalar::Bits {
                    bits: discr_val,
                    size: size.bytes() as u8,
                }, discr_dest)?;
O
Oliver Schneider 已提交
684
            }
R
Ralf Jung 已提交
685 686 687 688 689
            layout::Variants::NicheFilling {
                dataful_variant,
                ref niche_variants,
                niche_start,
                ..
O
Oliver Schneider 已提交
690
            } => {
R
Ralf Jung 已提交
691 692 693 694 695 696 697 698 699 700
                if variant_index != dataful_variant {
                    let niche_dest =
                        self.place_field(dest, 0)?;
                    let niche_value = ((variant_index - niche_variants.start()) as u128)
                        .wrapping_add(niche_start);
                    self.write_scalar(Scalar::Bits {
                        bits: niche_value,
                        size: niche_dest.layout.size.bytes() as u8,
                    }, niche_dest)?;
                }
O
Oliver Schneider 已提交
701
            }
702
        }
R
Ralf Jung 已提交
703 704

        Ok(())
O
Oliver Schneider 已提交
705 706
    }

R
Ralf Jung 已提交
707 708 709 710 711 712 713 714 715 716
    /// Every place can be read from, so we can turm them into an operand
    pub fn place_to_op(&self, place: PlaceTy<'tcx>) -> EvalResult<'tcx, OpTy<'tcx>> {
        let op = match place.place {
            Place::Ptr(mplace) => {
                Operand::Indirect(mplace)
            }
            Place::Local { frame, local } =>
                *self.stack[frame].locals[local].access()?
        };
        Ok(OpTy { op, layout: place.layout })
O
Oliver Schneider 已提交
717 718
    }
}