src/librustc_codegen_llvm/mir/operand.rs

   1 // Copyright 2012-2014 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 use rustc::mir::interpret::{ConstValue, ErrorHandled};
  12 use rustc::mir;
  13 use rustc::ty;
  14 use rustc::ty::layout::{self, Align, LayoutOf, TyLayout};
  15 use rustc_data_structures::sync::Lrc;
  16 use rustc_data_structures::indexed_vec::Idx;
  17
  18 use base;
  19 use common::{CodegenCx, C_undef, C_usize};
  20 use builder::{Builder, MemFlags};
  21 use value::Value;
  22 use type_of::LayoutLlvmExt;
  23 use type_::Type;
  24 use glue;
  25
  26 use std::fmt;
  27
  28 use super::{FunctionCx, LocalRef};
  29 use super::constant::scalar_to_llvm;
  30 use super::place::PlaceRef;
  31
  32 /// The representation of a Rust value. The enum variant is in fact
  33 /// uniquely determined by the value's type, but is kept as a
  34 /// safety check.
  35 #[derive(Copy, Clone, Debug)]
  36 pub enum OperandValue<'ll> {
  37     /// A reference to the actual operand. The data is guaranteed
  38     /// to be valid for the operand's lifetime.
  39     /// The second value, if any, is the extra data (vtable or length)
  40     /// which indicates that it refers to an unsized rvalue.
  41     Ref(&'ll Value, Option<&'ll Value>, Align),
  42     /// A single LLVM value.
  43     Immediate(&'ll Value),
  44     /// A pair of immediate LLVM values. Used by fat pointers too.
  45     Pair(&'ll Value, &'ll Value)
  46 }
  47
  48 /// An `OperandRef` is an "SSA" reference to a Rust value, along with
  49 /// its type.
  50 ///
  51 /// NOTE: unless you know a value's type exactly, you should not
  52 /// generate LLVM opcodes acting on it and instead act via methods,
  53 /// to avoid nasty edge cases. In particular, using `Builder::store`
  54 /// directly is sure to cause problems -- use `OperandRef::store`
  55 /// instead.
  56 #[derive(Copy, Clone)]
  57 pub struct OperandRef<'ll, 'tcx> {
  58     // The value.
  59     pub val: OperandValue<'ll>,
  60
  61     // The layout of value, based on its Rust type.
  62     pub layout: TyLayout<'tcx>,
  63 }
  64
  65 impl fmt::Debug for OperandRef<'ll, 'tcx> {
  66     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  67         write!(f, "OperandRef({:?} @ {:?})", self.val, self.layout)
  68     }
  69 }
  70
  71 impl OperandRef<'ll, 'tcx> {
  72     pub fn new_zst(cx: &CodegenCx<'ll, 'tcx>,
  73                    layout: TyLayout<'tcx>) -> OperandRef<'ll, 'tcx> {
  74         assert!(layout.is_zst());
  75         OperandRef {
  76             val: OperandValue::Immediate(C_undef(layout.immediate_llvm_type(cx))),
  77             layout
  78         }
  79     }
  80
  81     pub fn from_const(bx: &Builder<'a, 'll, 'tcx>,
  82                       val: &'tcx ty::Const<'tcx>)
  83                       -> Result<OperandRef<'ll, 'tcx>, ErrorHandled> {
  84         let layout = bx.cx.layout_of(val.ty);
  85
  86         if layout.is_zst() {
  87             return Ok(OperandRef::new_zst(bx.cx, layout));
  88         }
  89
  90         let val = match val.val {
  91             ConstValue::Unevaluated(..) => bug!(),
  92             ConstValue::Scalar(x) => {
  93                 let scalar = match layout.abi {
  94                     layout::Abi::Scalar(ref x) => x,
  95                     _ => bug!("from_const: invalid ByVal layout: {:#?}", layout)
  96                 };
  97                 let llval = scalar_to_llvm(
  98                     bx.cx,
  99                     x,
 100                     scalar,
 101                     layout.immediate_llvm_type(bx.cx),
 102                 );
 103                 OperandValue::Immediate(llval)
 104             },
 105             ConstValue::ScalarPair(a, b) => {
 106                 let (a_scalar, b_scalar) = match layout.abi {
 107                     layout::Abi::ScalarPair(ref a, ref b) => (a, b),
 108                     _ => bug!("from_const: invalid ScalarPair layout: {:#?}", layout)
 109                 };
 110                 let a_llval = scalar_to_llvm(
 111                     bx.cx,
 112                     a,
 113                     a_scalar,
 114                     layout.scalar_pair_element_llvm_type(bx.cx, 0, true),
 115                 );
 116                 let b_layout = layout.scalar_pair_element_llvm_type(bx.cx, 1, true);
 117                 let b_llval = scalar_to_llvm(
 118                     bx.cx,
 119                     b,
 120                     b_scalar,
 121                     b_layout,
 122                 );
 123                 OperandValue::Pair(a_llval, b_llval)
 124             },
 125             ConstValue::ByRef(_, alloc, offset) => {
 126                 return Ok(PlaceRef::from_const_alloc(bx, layout, alloc, offset).load(bx));
 127             },
 128         };
 129
 130         Ok(OperandRef {
 131             val,
 132             layout
 133         })
 134     }
 135
 136     /// Asserts that this operand refers to a scalar and returns
 137     /// a reference to its value.
 138     pub fn immediate(self) -> &'ll Value {
 139         match self.val {
 140             OperandValue::Immediate(s) => s,
 141             _ => bug!("not immediate: {:?}", self)
 142         }
 143     }
 144
 145     pub fn deref(self, cx: &CodegenCx<'ll, 'tcx>) -> PlaceRef<'ll, 'tcx> {
 146         let projected_ty = self.layout.ty.builtin_deref(true)
 147             .unwrap_or_else(|| bug!("deref of non-pointer {:?}", self)).ty;
 148         let (llptr, llextra) = match self.val {
 149             OperandValue::Immediate(llptr) => (llptr, None),
 150             OperandValue::Pair(llptr, llextra) => (llptr, Some(llextra)),
 151             OperandValue::Ref(..) => bug!("Deref of by-Ref operand {:?}", self)
 152         };
 153         let layout = cx.layout_of(projected_ty);
 154         PlaceRef {
 155             llval: llptr,
 156             llextra,
 157             layout,
 158             align: layout.align,
 159         }
 160     }
 161
 162     /// If this operand is a `Pair`, we return an aggregate with the two values.
 163     /// For other cases, see `immediate`.
 164     pub fn immediate_or_packed_pair(self, bx: &Builder<'a, 'll, 'tcx>) -> &'ll Value {
 165         if let OperandValue::Pair(a, b) = self.val {
 166             let llty = self.layout.llvm_type(bx.cx);
 167             debug!("Operand::immediate_or_packed_pair: packing {:?} into {:?}",
 168                    self, llty);
 169             // Reconstruct the immediate aggregate.
 170             let mut llpair = C_undef(llty);
 171             llpair = bx.insert_value(llpair, base::from_immediate(bx, a), 0);
 172             llpair = bx.insert_value(llpair, base::from_immediate(bx, b), 1);
 173             llpair
 174         } else {
 175             self.immediate()
 176         }
 177     }
 178
 179     /// If the type is a pair, we return a `Pair`, otherwise, an `Immediate`.
 180     pub fn from_immediate_or_packed_pair(bx: &Builder<'a, 'll, 'tcx>,
 181                                          llval: &'ll Value,
 182                                          layout: TyLayout<'tcx>)
 183                                          -> OperandRef<'ll, 'tcx> {
 184         let val = if let layout::Abi::ScalarPair(ref a, ref b) = layout.abi {
 185             debug!("Operand::from_immediate_or_packed_pair: unpacking {:?} @ {:?}",
 186                     llval, layout);
 187
 188             // Deconstruct the immediate aggregate.
 189             let a_llval = base::to_immediate_scalar(bx, bx.extract_value(llval, 0), a);
 190             let b_llval = base::to_immediate_scalar(bx, bx.extract_value(llval, 1), b);
 191             OperandValue::Pair(a_llval, b_llval)
 192         } else {
 193             OperandValue::Immediate(llval)
 194         };
 195         OperandRef { val, layout }
 196     }
 197
 198     pub fn extract_field(&self, bx: &Builder<'a, 'll, 'tcx>, i: usize) -> OperandRef<'ll, 'tcx> {
 199         let field = self.layout.field(bx.cx, i);
 200         let offset = self.layout.fields.offset(i);
 201
 202         let mut val = match (self.val, &self.layout.abi) {
 203             // If the field is ZST, it has no data.
 204             _ if field.is_zst() => {
 205                 return OperandRef::new_zst(bx.cx, field);
 206             }
 207
 208             // Newtype of a scalar, scalar pair or vector.
 209             (OperandValue::Immediate(_), _) |
 210             (OperandValue::Pair(..), _) if field.size == self.layout.size => {
 211                 assert_eq!(offset.bytes(), 0);
 212                 self.val
 213             }
 214
 215             // Extract a scalar component from a pair.
 216             (OperandValue::Pair(a_llval, b_llval), &layout::Abi::ScalarPair(ref a, ref b)) => {
 217                 if offset.bytes() == 0 {
 218                     assert_eq!(field.size, a.value.size(bx.cx));
 219                     OperandValue::Immediate(a_llval)
 220                 } else {
 221                     assert_eq!(offset, a.value.size(bx.cx)
 222                         .abi_align(b.value.align(bx.cx)));
 223                     assert_eq!(field.size, b.value.size(bx.cx));
 224                     OperandValue::Immediate(b_llval)
 225                 }
 226             }
 227
 228             // `#[repr(simd)]` types are also immediate.
 229             (OperandValue::Immediate(llval), &layout::Abi::Vector { .. }) => {
 230                 OperandValue::Immediate(
 231                     bx.extract_element(llval, C_usize(bx.cx, i as u64)))
 232             }
 233
 234             _ => bug!("OperandRef::extract_field({:?}): not applicable", self)
 235         };
 236
 237         // HACK(eddyb) have to bitcast pointers until LLVM removes pointee types.
 238         match val {
 239             OperandValue::Immediate(ref mut llval) => {
 240                 *llval = bx.bitcast(*llval, field.immediate_llvm_type(bx.cx));
 241             }
 242             OperandValue::Pair(ref mut a, ref mut b) => {
 243                 *a = bx.bitcast(*a, field.scalar_pair_element_llvm_type(bx.cx, 0, true));
 244                 *b = bx.bitcast(*b, field.scalar_pair_element_llvm_type(bx.cx, 1, true));
 245             }
 246             OperandValue::Ref(..) => bug!()
 247         }
 248
 249         OperandRef {
 250             val,
 251             layout: field
 252         }
 253     }
 254 }
 255
 256 impl OperandValue<'ll> {
 257     pub fn store(self, bx: &Builder<'a, 'll, 'tcx>, dest: PlaceRef<'ll, 'tcx>) {
 258         self.store_with_flags(bx, dest, MemFlags::empty());
 259     }
 260
 261     pub fn volatile_store(self, bx: &Builder<'a, 'll, 'tcx>, dest: PlaceRef<'ll, 'tcx>) {
 262         self.store_with_flags(bx, dest, MemFlags::VOLATILE);
 263     }
 264
 265     pub fn unaligned_volatile_store(self, bx: &Builder<'a, 'll, 'tcx>, dest: PlaceRef<'ll, 'tcx>) {
 266         self.store_with_flags(bx, dest, MemFlags::VOLATILE | MemFlags::UNALIGNED);
 267     }
 268
 269     pub fn nontemporal_store(self, bx: &Builder<'a, 'll, 'tcx>, dest: PlaceRef<'ll, 'tcx>) {
 270         self.store_with_flags(bx, dest, MemFlags::NONTEMPORAL);
 271     }
 272
 273     fn store_with_flags(
 274         self,
 275         bx: &Builder<'a, 'll, 'tcx>,
 276         dest: PlaceRef<'ll, 'tcx>,
 277         flags: MemFlags,
 278     ) {
 279         debug!("OperandRef::store: operand={:?}, dest={:?}", self, dest);
 280         // Avoid generating stores of zero-sized values, because the only way to have a zero-sized
 281         // value is through `undef`, and store itself is useless.
 282         if dest.layout.is_zst() {
 283             return;
 284         }
 285         match self {
 286             OperandValue::Ref(r, None, source_align) => {
 287                 base::memcpy_ty(bx, dest.llval, r, dest.layout,
 288                                 source_align.min(dest.align), flags)
 289             }
 290             OperandValue::Ref(_, Some(_), _) => {
 291                 bug!("cannot directly store unsized values");
 292             }
 293             OperandValue::Immediate(s) => {
 294                 let val = base::from_immediate(bx, s);
 295                 bx.store_with_flags(val, dest.llval, dest.align, flags);
 296             }
 297             OperandValue::Pair(a, b) => {
 298                 for (i, &x) in [a, b].iter().enumerate() {
 299                     let llptr = bx.struct_gep(dest.llval, i as u64);
 300                     let val = base::from_immediate(bx, x);
 301                     bx.store_with_flags(val, llptr, dest.align, flags);
 302                 }
 303             }
 304         }
 305     }
 306
 307     pub fn store_unsized(self, bx: &Builder<'a, 'll, 'tcx>, indirect_dest: PlaceRef<'ll, 'tcx>) {
 308         debug!("OperandRef::store_unsized: operand={:?}, indirect_dest={:?}", self, indirect_dest);
 309         let flags = MemFlags::empty();
 310
 311         // `indirect_dest` must have `*mut T` type. We extract `T` out of it.
 312         let unsized_ty = indirect_dest.layout.ty.builtin_deref(true)
 313             .unwrap_or_else(|| bug!("indirect_dest has non-pointer type: {:?}", indirect_dest)).ty;
 314
 315         let (llptr, llextra) =
 316             if let OperandValue::Ref(llptr, Some(llextra), _) = self {
 317                 (llptr, llextra)
 318             } else {
 319                 bug!("store_unsized called with a sized value")
 320             };
 321
 322         // FIXME: choose an appropriate alignment, or use dynamic align somehow
 323         let max_align = Align::from_bits(128, 128).unwrap();
 324         let min_align = Align::from_bits(8, 8).unwrap();
 325
 326         // Allocate an appropriate region on the stack, and copy the value into it
 327         let (llsize, _) = glue::size_and_align_of_dst(&bx, unsized_ty, Some(llextra));
 328         let lldst = bx.array_alloca(Type::i8(bx.cx), llsize, "unsized_tmp", max_align);
 329         base::call_memcpy(&bx, lldst, llptr, llsize, min_align, flags);
 330
 331         // Store the allocated region and the extra to the indirect place.
 332         let indirect_operand = OperandValue::Pair(lldst, llextra);
 333         indirect_operand.store(&bx, indirect_dest);
 334     }
 335 }
 336
 337 impl FunctionCx<'a, 'll, 'tcx> {
 338     fn maybe_codegen_consume_direct(&mut self,
 339                                   bx: &Builder<'a, 'll, 'tcx>,
 340                                   place: &mir::Place<'tcx>)
 341                                    -> Option<OperandRef<'ll, 'tcx>>
 342     {
 343         debug!("maybe_codegen_consume_direct(place={:?})", place);
 344
 345         // watch out for locals that do not have an
 346         // alloca; they are handled somewhat differently
 347         if let mir::Place::Local(index) = *place {
 348             match self.locals[index] {
 349                 LocalRef::Operand(Some(o)) => {
 350                     return Some(o);
 351                 }
 352                 LocalRef::Operand(None) => {
 353                     bug!("use of {:?} before def", place);
 354                 }
 355                 LocalRef::Place(..) | LocalRef::UnsizedPlace(..) => {
 356                     // use path below
 357                 }
 358             }
 359         }
 360
 361         // Moves out of scalar and scalar pair fields are trivial.
 362         if let &mir::Place::Projection(ref proj) = place {
 363             if let Some(o) = self.maybe_codegen_consume_direct(bx, &proj.base) {
 364                 match proj.elem {
 365                     mir::ProjectionElem::Field(ref f, _) => {
 366                         return Some(o.extract_field(bx, f.index()));
 367                     }
 368                     mir::ProjectionElem::Index(_) |
 369                     mir::ProjectionElem::ConstantIndex { .. } => {
 370                         // ZSTs don't require any actual memory access.
 371                         // FIXME(eddyb) deduplicate this with the identical
 372                         // checks in `codegen_consume` and `extract_field`.
 373                         let elem = o.layout.field(bx.cx, 0);
 374                         if elem.is_zst() {
 375                             return Some(OperandRef::new_zst(bx.cx, elem));
 376                         }
 377                     }
 378                     _ => {}
 379                 }
 380             }
 381         }
 382
 383         None
 384     }
 385
 386     pub fn codegen_consume(&mut self,
 387                          bx: &Builder<'a, 'll, 'tcx>,
 388                          place: &mir::Place<'tcx>)
 389                          -> OperandRef<'ll, 'tcx>
 390     {
 391         debug!("codegen_consume(place={:?})", place);
 392
 393         let ty = self.monomorphized_place_ty(place);
 394         let layout = bx.cx.layout_of(ty);
 395
 396         // ZSTs don't require any actual memory access.
 397         if layout.is_zst() {
 398             return OperandRef::new_zst(bx.cx, layout);
 399         }
 400
 401         if let Some(o) = self.maybe_codegen_consume_direct(bx, place) {
 402             return o;
 403         }
 404
 405         // for most places, to consume them we just load them
 406         // out from their home
 407         self.codegen_place(bx, place).load(bx)
 408     }
 409
 410     pub fn codegen_operand(&mut self,
 411                          bx: &Builder<'a, 'll, 'tcx>,
 412                          operand: &mir::Operand<'tcx>)
 413                          -> OperandRef<'ll, 'tcx>
 414     {
 415         debug!("codegen_operand(operand={:?})", operand);
 416
 417         match *operand {
 418             mir::Operand::Copy(ref place) |
 419             mir::Operand::Move(ref place) => {
 420                 self.codegen_consume(bx, place)
 421             }
 422
 423             mir::Operand::Constant(ref constant) => {
 424                 let ty = self.monomorphize(&constant.ty);
 425                 self.eval_mir_constant(bx, constant)
 426                     .and_then(|c| OperandRef::from_const(bx, c))
 427                     .unwrap_or_else(|err| {
 428                         match err {
 429                             // errored or at least linted
 430                             ErrorHandled::Reported => {},
 431                             ErrorHandled::TooGeneric => {
 432                                 bug!("codgen encountered polymorphic constant")
 433                             },
 434                         }
 435                         // Allow RalfJ to sleep soundly knowing that even refactorings that remove
 436                         // the above error (or silence it under some conditions) will not cause UB
 437                         let fnname = bx.cx.get_intrinsic(&("llvm.trap"));
 438                         bx.call(fnname, &[], None);
 439                         // We've errored, so we don't have to produce working code.
 440                         let layout = bx.cx.layout_of(ty);
 441                         PlaceRef::new_sized(
 442                             C_undef(layout.llvm_type(bx.cx).ptr_to()),
 443                             layout,
 444                             layout.align,
 445                         ).load(bx)
 446                     })
 447             }
 448         }
 449     }
 450 }