src/librustc_codegen_llvm/mir/rvalue.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 llvm;
  12 use rustc::ty::{self, Ty};
  13 use rustc::ty::cast::{CastTy, IntTy};
  14 use rustc::ty::layout::{self, LayoutOf};
  15 use rustc::mir;
  16 use rustc::middle::lang_items::ExchangeMallocFnLangItem;
  17 use rustc_apfloat::{ieee, Float, Status, Round};
  18 use std::{u128, i128};
  19
  20 use base;
  21 use builder::Builder;
  22 use callee;
  23 use common::{self, val_ty};
  24 use common::{C_bool, C_u8, C_i32, C_u32, C_u64, C_undef, C_null, C_usize, C_uint, C_uint_big};
  25 use consts;
  26 use monomorphize;
  27 use type_::Type;
  28 use type_of::LayoutLlvmExt;
  29 use value::Value;
  30
  31 use super::{FunctionCx, LocalRef};
  32 use super::operand::{OperandRef, OperandValue};
  33 use super::place::PlaceRef;
  34
  35 impl FunctionCx<'a, 'll, 'tcx> {
  36     pub fn codegen_rvalue(&mut self,
  37                         bx: Builder<'a, 'll, 'tcx>,
  38                         dest: PlaceRef<'ll, 'tcx>,
  39                         rvalue: &mir::Rvalue<'tcx>)
  40                         -> Builder<'a, 'll, 'tcx>
  41     {
  42         debug!("codegen_rvalue(dest.llval={:?}, rvalue={:?})",
  43                dest.llval, rvalue);
  44
  45         match *rvalue {
  46            mir::Rvalue::Use(ref operand) => {
  47                let cg_operand = self.codegen_operand(&bx, operand);
  48                // FIXME: consider not copying constants through stack. (fixable by codegenning
  49                // constants into OperandValue::Ref, why don’t we do that yet if we don’t?)
  50                cg_operand.val.store(&bx, dest);
  51                bx
  52            }
  53
  54             mir::Rvalue::Cast(mir::CastKind::Unsize, ref source, _) => {
  55                 // The destination necessarily contains a fat pointer, so if
  56                 // it's a scalar pair, it's a fat pointer or newtype thereof.
  57                 if dest.layout.is_llvm_scalar_pair() {
  58                     // into-coerce of a thin pointer to a fat pointer - just
  59                     // use the operand path.
  60                     let (bx, temp) = self.codegen_rvalue_operand(bx, rvalue);
  61                     temp.val.store(&bx, dest);
  62                     return bx;
  63                 }
  64
  65                 // Unsize of a nontrivial struct. I would prefer for
  66                 // this to be eliminated by MIR building, but
  67                 // `CoerceUnsized` can be passed by a where-clause,
  68                 // so the (generic) MIR may not be able to expand it.
  69                 let operand = self.codegen_operand(&bx, source);
  70                 match operand.val {
  71                     OperandValue::Pair(..) |
  72                     OperandValue::Immediate(_) => {
  73                         // unsize from an immediate structure. We don't
  74                         // really need a temporary alloca here, but
  75                         // avoiding it would require us to have
  76                         // `coerce_unsized_into` use extractvalue to
  77                         // index into the struct, and this case isn't
  78                         // important enough for it.
  79                         debug!("codegen_rvalue: creating ugly alloca");
  80                         let scratch = PlaceRef::alloca(&bx, operand.layout, "__unsize_temp");
  81                         scratch.storage_live(&bx);
  82                         operand.val.store(&bx, scratch);
  83                         base::coerce_unsized_into(&bx, scratch, dest);
  84                         scratch.storage_dead(&bx);
  85                     }
  86                     OperandValue::Ref(llref, align) => {
  87                         let source = PlaceRef::new_sized(llref, operand.layout, align);
  88                         base::coerce_unsized_into(&bx, source, dest);
  89                     }
  90                     OperandValue::UnsizedRef(..) => {
  91                         bug!("unsized coercion on an unsized rvalue")
  92                     }
  93                 }
  94                 bx
  95             }
  96
  97             mir::Rvalue::Repeat(ref elem, count) => {
  98                 let cg_elem = self.codegen_operand(&bx, elem);
  99
 100                 // Do not generate the loop for zero-sized elements or empty arrays.
 101                 if dest.layout.is_zst() {
 102                     return bx;
 103                 }
 104
 105                 let start = dest.project_index(&bx, C_usize(bx.cx, 0)).llval;
 106
 107                 if let OperandValue::Immediate(v) = cg_elem.val {
 108                     let align = C_i32(bx.cx, dest.align.abi() as i32);
 109                     let size = C_usize(bx.cx, dest.layout.size.bytes());
 110
 111                     // Use llvm.memset.p0i8.* to initialize all zero arrays
 112                     if common::is_const_integral(v) && common::const_to_uint(v) == 0 {
 113                         let fill = C_u8(bx.cx, 0);
 114                         base::call_memset(&bx, start, fill, size, align, false);
 115                         return bx;
 116                     }
 117
 118                     // Use llvm.memset.p0i8.* to initialize byte arrays
 119                     let v = base::from_immediate(&bx, v);
 120                     if common::val_ty(v) == Type::i8(bx.cx) {
 121                         base::call_memset(&bx, start, v, size, align, false);
 122                         return bx;
 123                     }
 124                 }
 125
 126                 let count = C_usize(bx.cx, count);
 127                 let end = dest.project_index(&bx, count).llval;
 128
 129                 let header_bx = bx.build_sibling_block("repeat_loop_header");
 130                 let body_bx = bx.build_sibling_block("repeat_loop_body");
 131                 let next_bx = bx.build_sibling_block("repeat_loop_next");
 132
 133                 bx.br(header_bx.llbb());
 134                 let current = header_bx.phi(common::val_ty(start), &[start], &[bx.llbb()]);
 135
 136                 let keep_going = header_bx.icmp(llvm::IntNE, current, end);
 137                 header_bx.cond_br(keep_going, body_bx.llbb(), next_bx.llbb());
 138
 139                 cg_elem.val.store(&body_bx,
 140                     PlaceRef::new_sized(current, cg_elem.layout, dest.align));
 141
 142                 let next = body_bx.inbounds_gep(current, &[C_usize(bx.cx, 1)]);
 143                 body_bx.br(header_bx.llbb());
 144                 header_bx.add_incoming_to_phi(current, next, body_bx.llbb());
 145
 146                 next_bx
 147             }
 148
 149             mir::Rvalue::Aggregate(ref kind, ref operands) => {
 150                 let (dest, active_field_index) = match **kind {
 151                     mir::AggregateKind::Adt(adt_def, variant_index, _, active_field_index) => {
 152                         dest.codegen_set_discr(&bx, variant_index);
 153                         if adt_def.is_enum() {
 154                             (dest.project_downcast(&bx, variant_index), active_field_index)
 155                         } else {
 156                             (dest, active_field_index)
 157                         }
 158                     }
 159                     _ => (dest, None)
 160                 };
 161                 for (i, operand) in operands.iter().enumerate() {
 162                     let op = self.codegen_operand(&bx, operand);
 163                     // Do not generate stores and GEPis for zero-sized fields.
 164                     if !op.layout.is_zst() {
 165                         let field_index = active_field_index.unwrap_or(i);
 166                         op.val.store(&bx, dest.project_field(&bx, field_index));
 167                     }
 168                 }
 169                 bx
 170             }
 171
 172             _ => {
 173                 assert!(self.rvalue_creates_operand(rvalue));
 174                 let (bx, temp) = self.codegen_rvalue_operand(bx, rvalue);
 175                 temp.val.store(&bx, dest);
 176                 bx
 177             }
 178         }
 179     }
 180
 181     pub fn codegen_rvalue_unsized(&mut self,
 182                         bx: Builder<'a, 'll, 'tcx>,
 183                         indirect_dest: PlaceRef<'ll, 'tcx>,
 184                         rvalue: &mir::Rvalue<'tcx>)
 185                         -> Builder<'a, 'll, 'tcx>
 186     {
 187         debug!("codegen_rvalue_unsized(indirect_dest.llval={:?}, rvalue={:?})",
 188                indirect_dest.llval, rvalue);
 189
 190         match *rvalue {
 191             mir::Rvalue::Use(ref operand) => {
 192                 let cg_operand = self.codegen_operand(&bx, operand);
 193                 cg_operand.val.store_unsized(&bx, indirect_dest);
 194                 bx
 195             }
 196
 197             _ => bug!("unsized assignment other than Rvalue::Use"),
 198         }
 199     }
 200
 201     pub fn codegen_rvalue_operand(&mut self,
 202                                 bx: Builder<'a, 'll, 'tcx>,
 203                                 rvalue: &mir::Rvalue<'tcx>)
 204                                 -> (Builder<'a, 'll, 'tcx>, OperandRef<'ll, 'tcx>)
 205     {
 206         assert!(self.rvalue_creates_operand(rvalue), "cannot codegen {:?} to operand", rvalue);
 207
 208         match *rvalue {
 209             mir::Rvalue::Cast(ref kind, ref source, mir_cast_ty) => {
 210                 let operand = self.codegen_operand(&bx, source);
 211                 debug!("cast operand is {:?}", operand);
 212                 let cast = bx.cx.layout_of(self.monomorphize(&mir_cast_ty));
 213
 214                 let val = match *kind {
 215                     mir::CastKind::ReifyFnPointer => {
 216                         match operand.layout.ty.sty {
 217                             ty::TyFnDef(def_id, substs) => {
 218                                 if bx.cx.tcx.has_attr(def_id, "rustc_args_required_const") {
 219                                     bug!("reifying a fn ptr that requires \
 220                                           const arguments");
 221                                 }
 222                                 OperandValue::Immediate(
 223                                     callee::resolve_and_get_fn(bx.cx, def_id, substs))
 224                             }
 225                             _ => {
 226                                 bug!("{} cannot be reified to a fn ptr", operand.layout.ty)
 227                             }
 228                         }
 229                     }
 230                     mir::CastKind::ClosureFnPointer => {
 231                         match operand.layout.ty.sty {
 232                             ty::TyClosure(def_id, substs) => {
 233                                 let instance = monomorphize::resolve_closure(
 234                                     bx.cx.tcx, def_id, substs, ty::ClosureKind::FnOnce);
 235                                 OperandValue::Immediate(callee::get_fn(bx.cx, instance))
 236                             }
 237                             _ => {
 238                                 bug!("{} cannot be cast to a fn ptr", operand.layout.ty)
 239                             }
 240                         }
 241                     }
 242                     mir::CastKind::UnsafeFnPointer => {
 243                         // this is a no-op at the LLVM level
 244                         operand.val
 245                     }
 246                     mir::CastKind::Unsize => {
 247                         assert!(cast.is_llvm_scalar_pair());
 248                         match operand.val {
 249                             OperandValue::Pair(lldata, llextra) => {
 250                                 // unsize from a fat pointer - this is a
 251                                 // "trait-object-to-supertrait" coercion, for
 252                                 // example,
 253                                 //   &'a fmt::Debug+Send => &'a fmt::Debug,
 254
 255                                 // HACK(eddyb) have to bitcast pointers
 256                                 // until LLVM removes pointee types.
 257                                 let lldata = bx.pointercast(lldata,
 258                                     cast.scalar_pair_element_llvm_type(bx.cx, 0, true));
 259                                 OperandValue::Pair(lldata, llextra)
 260                             }
 261                             OperandValue::Immediate(lldata) => {
 262                                 // "standard" unsize
 263                                 let (lldata, llextra) = base::unsize_thin_ptr(&bx, lldata,
 264                                     operand.layout.ty, cast.ty);
 265                                 OperandValue::Pair(lldata, llextra)
 266                             }
 267                             OperandValue::Ref(..) => {
 268                                 bug!("by-ref operand {:?} in codegen_rvalue_operand",
 269                                      operand);
 270                             }
 271                             OperandValue::UnsizedRef(..) => {
 272                                 bug!("unsized coercion on an unsized rvalue")
 273                             }
 274                         }
 275                     }
 276                     mir::CastKind::Misc if operand.layout.is_llvm_scalar_pair() => {
 277                         if let OperandValue::Pair(data_ptr, meta) = operand.val {
 278                             if cast.is_llvm_scalar_pair() {
 279                                 let data_cast = bx.pointercast(data_ptr,
 280                                     cast.scalar_pair_element_llvm_type(bx.cx, 0, true));
 281                                 OperandValue::Pair(data_cast, meta)
 282                             } else { // cast to thin-ptr
 283                                 // Cast of fat-ptr to thin-ptr is an extraction of data-ptr and
 284                                 // pointer-cast of that pointer to desired pointer type.
 285                                 let llcast_ty = cast.immediate_llvm_type(bx.cx);
 286                                 let llval = bx.pointercast(data_ptr, llcast_ty);
 287                                 OperandValue::Immediate(llval)
 288                             }
 289                         } else {
 290                             bug!("Unexpected non-Pair operand")
 291                         }
 292                     }
 293                     mir::CastKind::Misc => {
 294                         assert!(cast.is_llvm_immediate());
 295                         let ll_t_out = cast.immediate_llvm_type(bx.cx);
 296                         if operand.layout.abi == layout::Abi::Uninhabited {
 297                             return (bx, OperandRef {
 298                                 val: OperandValue::Immediate(C_undef(ll_t_out)),
 299                                 layout: cast,
 300                             });
 301                         }
 302                         let r_t_in = CastTy::from_ty(operand.layout.ty)
 303                             .expect("bad input type for cast");
 304                         let r_t_out = CastTy::from_ty(cast.ty).expect("bad output type for cast");
 305                         let ll_t_in = operand.layout.immediate_llvm_type(bx.cx);
 306                         match operand.layout.variants {
 307                             layout::Variants::Single { index } => {
 308                                 if let Some(def) = operand.layout.ty.ty_adt_def() {
 309                                     let discr_val = def
 310                                         .discriminant_for_variant(bx.cx.tcx, index)
 311                                         .val;
 312                                     let discr = C_uint_big(ll_t_out, discr_val);
 313                                     return (bx, OperandRef {
 314                                         val: OperandValue::Immediate(discr),
 315                                         layout: cast,
 316                                     });
 317                                 }
 318                             }
 319                             layout::Variants::Tagged { .. } |
 320                             layout::Variants::NicheFilling { .. } => {},
 321                         }
 322                         let llval = operand.immediate();
 323
 324                         let mut signed = false;
 325                         if let layout::Abi::Scalar(ref scalar) = operand.layout.abi {
 326                             if let layout::Int(_, s) = scalar.value {
 327                                 // We use `i1` for bytes that are always `0` or `1`,
 328                                 // e.g. `#[repr(i8)] enum E { A, B }`, but we can't
 329                                 // let LLVM interpret the `i1` as signed, because
 330                                 // then `i1 1` (i.e. E::B) is effectively `i8 -1`.
 331                                 signed = !scalar.is_bool() && s;
 332
 333                                 let er = scalar.valid_range_exclusive(bx.cx);
 334                                 if er.end != er.start &&
 335                                    scalar.valid_range.end() > scalar.valid_range.start() {
 336                                     // We want `table[e as usize]` to not
 337                                     // have bound checks, and this is the most
 338                                     // convenient place to put the `assume`.
 339
 340                                     base::call_assume(&bx, bx.icmp(
 341                                         llvm::IntULE,
 342                                         llval,
 343                                         C_uint_big(ll_t_in, *scalar.valid_range.end())
 344                                     ));
 345                                 }
 346                             }
 347                         }
 348
 349                         let newval = match (r_t_in, r_t_out) {
 350                             (CastTy::Int(_), CastTy::Int(_)) => {
 351                                 bx.intcast(llval, ll_t_out, signed)
 352                             }
 353                             (CastTy::Float, CastTy::Float) => {
 354                                 let srcsz = ll_t_in.float_width();
 355                                 let dstsz = ll_t_out.float_width();
 356                                 if dstsz > srcsz {
 357                                     bx.fpext(llval, ll_t_out)
 358                                 } else if srcsz > dstsz {
 359                                     bx.fptrunc(llval, ll_t_out)
 360                                 } else {
 361                                     llval
 362                                 }
 363                             }
 364                             (CastTy::Ptr(_), CastTy::Ptr(_)) |
 365                             (CastTy::FnPtr, CastTy::Ptr(_)) |
 366                             (CastTy::RPtr(_), CastTy::Ptr(_)) =>
 367                                 bx.pointercast(llval, ll_t_out),
 368                             (CastTy::Ptr(_), CastTy::Int(_)) |
 369                             (CastTy::FnPtr, CastTy::Int(_)) =>
 370                                 bx.ptrtoint(llval, ll_t_out),
 371                             (CastTy::Int(_), CastTy::Ptr(_)) => {
 372                                 let usize_llval = bx.intcast(llval, bx.cx.isize_ty, signed);
 373                                 bx.inttoptr(usize_llval, ll_t_out)
 374                             }
 375                             (CastTy::Int(_), CastTy::Float) =>
 376                                 cast_int_to_float(&bx, signed, llval, ll_t_in, ll_t_out),
 377                             (CastTy::Float, CastTy::Int(IntTy::I)) =>
 378                                 cast_float_to_int(&bx, true, llval, ll_t_in, ll_t_out),
 379                             (CastTy::Float, CastTy::Int(_)) =>
 380                                 cast_float_to_int(&bx, false, llval, ll_t_in, ll_t_out),
 381                             _ => bug!("unsupported cast: {:?} to {:?}", operand.layout.ty, cast.ty)
 382                         };
 383                         OperandValue::Immediate(newval)
 384                     }
 385                 };
 386                 (bx, OperandRef {
 387                     val,
 388                     layout: cast
 389                 })
 390             }
 391
 392             mir::Rvalue::Ref(_, bk, ref place) => {
 393                 let cg_place = self.codegen_place(&bx, place);
 394
 395                 let ty = cg_place.layout.ty;
 396
 397                 // Note: places are indirect, so storing the `llval` into the
 398                 // destination effectively creates a reference.
 399                 let val = if !bx.cx.type_has_metadata(ty) {
 400                     OperandValue::Immediate(cg_place.llval)
 401                 } else {
 402                     OperandValue::Pair(cg_place.llval, cg_place.llextra.unwrap())
 403                 };
 404                 (bx, OperandRef {
 405                     val,
 406                     layout: self.cx.layout_of(self.cx.tcx.mk_ref(
 407                         self.cx.tcx.types.re_erased,
 408                         ty::TypeAndMut { ty, mutbl: bk.to_mutbl_lossy() }
 409                     )),
 410                 })
 411             }
 412
 413             mir::Rvalue::Len(ref place) => {
 414                 let size = self.evaluate_array_len(&bx, place);
 415                 let operand = OperandRef {
 416                     val: OperandValue::Immediate(size),
 417                     layout: bx.cx.layout_of(bx.tcx().types.usize),
 418                 };
 419                 (bx, operand)
 420             }
 421
 422             mir::Rvalue::BinaryOp(op, ref lhs, ref rhs) => {
 423                 let lhs = self.codegen_operand(&bx, lhs);
 424                 let rhs = self.codegen_operand(&bx, rhs);
 425                 let llresult = match (lhs.val, rhs.val) {
 426                     (OperandValue::Pair(lhs_addr, lhs_extra),
 427                      OperandValue::Pair(rhs_addr, rhs_extra)) => {
 428                         self.codegen_fat_ptr_binop(&bx, op,
 429                                                  lhs_addr, lhs_extra,
 430                                                  rhs_addr, rhs_extra,
 431                                                  lhs.layout.ty)
 432                     }
 433
 434                     (OperandValue::Immediate(lhs_val),
 435                      OperandValue::Immediate(rhs_val)) => {
 436                         self.codegen_scalar_binop(&bx, op, lhs_val, rhs_val, lhs.layout.ty)
 437                     }
 438
 439                     _ => bug!()
 440                 };
 441                 let operand = OperandRef {
 442                     val: OperandValue::Immediate(llresult),
 443                     layout: bx.cx.layout_of(
 444                         op.ty(bx.tcx(), lhs.layout.ty, rhs.layout.ty)),
 445                 };
 446                 (bx, operand)
 447             }
 448             mir::Rvalue::CheckedBinaryOp(op, ref lhs, ref rhs) => {
 449                 let lhs = self.codegen_operand(&bx, lhs);
 450                 let rhs = self.codegen_operand(&bx, rhs);
 451                 let result = self.codegen_scalar_checked_binop(&bx, op,
 452                                                              lhs.immediate(), rhs.immediate(),
 453                                                              lhs.layout.ty);
 454                 let val_ty = op.ty(bx.tcx(), lhs.layout.ty, rhs.layout.ty);
 455                 let operand_ty = bx.tcx().intern_tup(&[val_ty, bx.tcx().types.bool]);
 456                 let operand = OperandRef {
 457                     val: result,
 458                     layout: bx.cx.layout_of(operand_ty)
 459                 };
 460
 461                 (bx, operand)
 462             }
 463
 464             mir::Rvalue::UnaryOp(op, ref operand) => {
 465                 let operand = self.codegen_operand(&bx, operand);
 466                 let lloperand = operand.immediate();
 467                 let is_float = operand.layout.ty.is_fp();
 468                 let llval = match op {
 469                     mir::UnOp::Not => bx.not(lloperand),
 470                     mir::UnOp::Neg => if is_float {
 471                         bx.fneg(lloperand)
 472                     } else {
 473                         bx.neg(lloperand)
 474                     }
 475                 };
 476                 (bx, OperandRef {
 477                     val: OperandValue::Immediate(llval),
 478                     layout: operand.layout,
 479                 })
 480             }
 481
 482             mir::Rvalue::Discriminant(ref place) => {
 483                 let discr_ty = rvalue.ty(&*self.mir, bx.tcx());
 484                 let discr =  self.codegen_place(&bx, place)
 485                     .codegen_get_discr(&bx, discr_ty);
 486                 (bx, OperandRef {
 487                     val: OperandValue::Immediate(discr),
 488                     layout: self.cx.layout_of(discr_ty)
 489                 })
 490             }
 491
 492             mir::Rvalue::NullaryOp(mir::NullOp::SizeOf, ty) => {
 493                 assert!(bx.cx.type_is_sized(ty));
 494                 let val = C_usize(bx.cx, bx.cx.size_of(ty).bytes());
 495                 let tcx = bx.tcx();
 496                 (bx, OperandRef {
 497                     val: OperandValue::Immediate(val),
 498                     layout: self.cx.layout_of(tcx.types.usize),
 499                 })
 500             }
 501
 502             mir::Rvalue::NullaryOp(mir::NullOp::Box, content_ty) => {
 503                 let content_ty: Ty<'tcx> = self.monomorphize(&content_ty);
 504                 let (size, align) = bx.cx.size_and_align_of(content_ty);
 505                 let llsize = C_usize(bx.cx, size.bytes());
 506                 let llalign = C_usize(bx.cx, align.abi());
 507                 let box_layout = bx.cx.layout_of(bx.tcx().mk_box(content_ty));
 508                 let llty_ptr = box_layout.llvm_type(bx.cx);
 509
 510                 // Allocate space:
 511                 let def_id = match bx.tcx().lang_items().require(ExchangeMallocFnLangItem) {
 512                     Ok(id) => id,
 513                     Err(s) => {
 514                         bx.sess().fatal(&format!("allocation of `{}` {}", box_layout.ty, s));
 515                     }
 516                 };
 517                 let instance = ty::Instance::mono(bx.tcx(), def_id);
 518                 let r = callee::get_fn(bx.cx, instance);
 519                 let val = bx.pointercast(bx.call(r, &[llsize, llalign], None), llty_ptr);
 520
 521                 let operand = OperandRef {
 522                     val: OperandValue::Immediate(val),
 523                     layout: box_layout,
 524                 };
 525                 (bx, operand)
 526             }
 527             mir::Rvalue::Use(ref operand) => {
 528                 let operand = self.codegen_operand(&bx, operand);
 529                 (bx, operand)
 530             }
 531             mir::Rvalue::Repeat(..) |
 532             mir::Rvalue::Aggregate(..) => {
 533                 // According to `rvalue_creates_operand`, only ZST
 534                 // aggregate rvalues are allowed to be operands.
 535                 let ty = rvalue.ty(self.mir, self.cx.tcx);
 536                 (bx, OperandRef::new_zst(self.cx,
 537                     self.cx.layout_of(self.monomorphize(&ty))))
 538             }
 539         }
 540     }
 541
 542     fn evaluate_array_len(
 543         &mut self,
 544         bx: &Builder<'a, 'll, 'tcx>,
 545         place: &mir::Place<'tcx>,
 546     ) -> &'ll Value {
 547         // ZST are passed as operands and require special handling
 548         // because codegen_place() panics if Local is operand.
 549         if let mir::Place::Local(index) = *place {
 550             if let LocalRef::Operand(Some(op)) = self.locals[index] {
 551                 if let ty::TyArray(_, n) = op.layout.ty.sty {
 552                     let n = n.unwrap_usize(bx.cx.tcx);
 553                     return common::C_usize(bx.cx, n);
 554                 }
 555             }
 556         }
 557         // use common size calculation for non zero-sized types
 558         let cg_value = self.codegen_place(&bx, place);
 559         return cg_value.len(bx.cx);
 560     }
 561
 562     pub fn codegen_scalar_binop(
 563         &mut self,
 564         bx: &Builder<'a, 'll, 'tcx>,
 565         op: mir::BinOp,
 566         lhs: &'ll Value,
 567         rhs: &'ll Value,
 568         input_ty: Ty<'tcx>,
 569     ) -> &'ll Value {
 570         let is_float = input_ty.is_fp();
 571         let is_signed = input_ty.is_signed();
 572         let is_nil = input_ty.is_nil();
 573         match op {
 574             mir::BinOp::Add => if is_float {
 575                 bx.fadd(lhs, rhs)
 576             } else {
 577                 bx.add(lhs, rhs)
 578             },
 579             mir::BinOp::Sub => if is_float {
 580                 bx.fsub(lhs, rhs)
 581             } else {
 582                 bx.sub(lhs, rhs)
 583             },
 584             mir::BinOp::Mul => if is_float {
 585                 bx.fmul(lhs, rhs)
 586             } else {
 587                 bx.mul(lhs, rhs)
 588             },
 589             mir::BinOp::Div => if is_float {
 590                 bx.fdiv(lhs, rhs)
 591             } else if is_signed {
 592                 bx.sdiv(lhs, rhs)
 593             } else {
 594                 bx.udiv(lhs, rhs)
 595             },
 596             mir::BinOp::Rem => if is_float {
 597                 bx.frem(lhs, rhs)
 598             } else if is_signed {
 599                 bx.srem(lhs, rhs)
 600             } else {
 601                 bx.urem(lhs, rhs)
 602             },
 603             mir::BinOp::BitOr => bx.or(lhs, rhs),
 604             mir::BinOp::BitAnd => bx.and(lhs, rhs),
 605             mir::BinOp::BitXor => bx.xor(lhs, rhs),
 606             mir::BinOp::Offset => bx.inbounds_gep(lhs, &[rhs]),
 607             mir::BinOp::Shl => common::build_unchecked_lshift(bx, lhs, rhs),
 608             mir::BinOp::Shr => common::build_unchecked_rshift(bx, input_ty, lhs, rhs),
 609             mir::BinOp::Ne | mir::BinOp::Lt | mir::BinOp::Gt |
 610             mir::BinOp::Eq | mir::BinOp::Le | mir::BinOp::Ge => if is_nil {
 611                 C_bool(bx.cx, match op {
 612                     mir::BinOp::Ne | mir::BinOp::Lt | mir::BinOp::Gt => false,
 613                     mir::BinOp::Eq | mir::BinOp::Le | mir::BinOp::Ge => true,
 614                     _ => unreachable!()
 615                 })
 616             } else if is_float {
 617                 bx.fcmp(
 618                     base::bin_op_to_fcmp_predicate(op.to_hir_binop()),
 619                     lhs, rhs
 620                 )
 621             } else {
 622                 bx.icmp(
 623                     base::bin_op_to_icmp_predicate(op.to_hir_binop(), is_signed),
 624                     lhs, rhs
 625                 )
 626             }
 627         }
 628     }
 629
 630     pub fn codegen_fat_ptr_binop(
 631         &mut self,
 632         bx: &Builder<'a, 'll, 'tcx>,
 633         op: mir::BinOp,
 634         lhs_addr: &'ll Value,
 635         lhs_extra: &'ll Value,
 636         rhs_addr: &'ll Value,
 637         rhs_extra: &'ll Value,
 638         _input_ty: Ty<'tcx>,
 639     ) -> &'ll Value {
 640         match op {
 641             mir::BinOp::Eq => {
 642                 bx.and(
 643                     bx.icmp(llvm::IntEQ, lhs_addr, rhs_addr),
 644                     bx.icmp(llvm::IntEQ, lhs_extra, rhs_extra)
 645                 )
 646             }
 647             mir::BinOp::Ne => {
 648                 bx.or(
 649                     bx.icmp(llvm::IntNE, lhs_addr, rhs_addr),
 650                     bx.icmp(llvm::IntNE, lhs_extra, rhs_extra)
 651                 )
 652             }
 653             mir::BinOp::Le | mir::BinOp::Lt |
 654             mir::BinOp::Ge | mir::BinOp::Gt => {
 655                 // a OP b ~ a.0 STRICT(OP) b.0 | (a.0 == b.0 && a.1 OP a.1)
 656                 let (op, strict_op) = match op {
 657                     mir::BinOp::Lt => (llvm::IntULT, llvm::IntULT),
 658                     mir::BinOp::Le => (llvm::IntULE, llvm::IntULT),
 659                     mir::BinOp::Gt => (llvm::IntUGT, llvm::IntUGT),
 660                     mir::BinOp::Ge => (llvm::IntUGE, llvm::IntUGT),
 661                     _ => bug!(),
 662                 };
 663
 664                 bx.or(
 665                     bx.icmp(strict_op, lhs_addr, rhs_addr),
 666                     bx.and(
 667                         bx.icmp(llvm::IntEQ, lhs_addr, rhs_addr),
 668                         bx.icmp(op, lhs_extra, rhs_extra)
 669                     )
 670                 )
 671             }
 672             _ => {
 673                 bug!("unexpected fat ptr binop");
 674             }
 675         }
 676     }
 677
 678     pub fn codegen_scalar_checked_binop(&mut self,
 679                                       bx: &Builder<'a, 'll, 'tcx>,
 680                                       op: mir::BinOp,
 681                                       lhs: &'ll Value,
 682                                       rhs: &'ll Value,
 683                                       input_ty: Ty<'tcx>) -> OperandValue<'ll> {
 684         // This case can currently arise only from functions marked
 685         // with #[rustc_inherit_overflow_checks] and inlined from
 686         // another crate (mostly core::num generic/#[inline] fns),
 687         // while the current crate doesn't use overflow checks.
 688         if !bx.cx.check_overflow {
 689             let val = self.codegen_scalar_binop(bx, op, lhs, rhs, input_ty);
 690             return OperandValue::Pair(val, C_bool(bx.cx, false));
 691         }
 692
 693         let (val, of) = match op {
 694             // These are checked using intrinsics
 695             mir::BinOp::Add | mir::BinOp::Sub | mir::BinOp::Mul => {
 696                 let oop = match op {
 697                     mir::BinOp::Add => OverflowOp::Add,
 698                     mir::BinOp::Sub => OverflowOp::Sub,
 699                     mir::BinOp::Mul => OverflowOp::Mul,
 700                     _ => unreachable!()
 701                 };
 702                 let intrinsic = get_overflow_intrinsic(oop, bx, input_ty);
 703                 let res = bx.call(intrinsic, &[lhs, rhs], None);
 704
 705                 (bx.extract_value(res, 0),
 706                  bx.extract_value(res, 1))
 707             }
 708             mir::BinOp::Shl | mir::BinOp::Shr => {
 709                 let lhs_llty = val_ty(lhs);
 710                 let rhs_llty = val_ty(rhs);
 711                 let invert_mask = common::shift_mask_val(&bx, lhs_llty, rhs_llty, true);
 712                 let outer_bits = bx.and(rhs, invert_mask);
 713
 714                 let of = bx.icmp(llvm::IntNE, outer_bits, C_null(rhs_llty));
 715                 let val = self.codegen_scalar_binop(bx, op, lhs, rhs, input_ty);
 716
 717                 (val, of)
 718             }
 719             _ => {
 720                 bug!("Operator `{:?}` is not a checkable operator", op)
 721             }
 722         };
 723
 724         OperandValue::Pair(val, of)
 725     }
 726
 727     pub fn rvalue_creates_operand(&self, rvalue: &mir::Rvalue<'tcx>) -> bool {
 728         match *rvalue {
 729             mir::Rvalue::Ref(..) |
 730             mir::Rvalue::Len(..) |
 731             mir::Rvalue::Cast(..) | // (*)
 732             mir::Rvalue::BinaryOp(..) |
 733             mir::Rvalue::CheckedBinaryOp(..) |
 734             mir::Rvalue::UnaryOp(..) |
 735             mir::Rvalue::Discriminant(..) |
 736             mir::Rvalue::NullaryOp(..) |
 737             mir::Rvalue::Use(..) => // (*)
 738                 true,
 739             mir::Rvalue::Repeat(..) |
 740             mir::Rvalue::Aggregate(..) => {
 741                 let ty = rvalue.ty(self.mir, self.cx.tcx);
 742                 let ty = self.monomorphize(&ty);
 743                 self.cx.layout_of(ty).is_zst()
 744             }
 745         }
 746
 747         // (*) this is only true if the type is suitable
 748     }
 749 }
 750
 751 #[derive(Copy, Clone)]
 752 enum OverflowOp {
 753     Add, Sub, Mul
 754 }
 755
 756 fn get_overflow_intrinsic(oop: OverflowOp, bx: &Builder<'_, 'll, '_>, ty: Ty) -> &'ll Value {
 757     use syntax::ast::IntTy::*;
 758     use syntax::ast::UintTy::*;
 759     use rustc::ty::{TyInt, TyUint};
 760
 761     let tcx = bx.tcx();
 762
 763     let new_sty = match ty.sty {
 764         TyInt(Isize) => TyInt(tcx.sess.target.isize_ty),
 765         TyUint(Usize) => TyUint(tcx.sess.target.usize_ty),
 766         ref t @ TyUint(_) | ref t @ TyInt(_) => t.clone(),
 767         _ => panic!("tried to get overflow intrinsic for op applied to non-int type")
 768     };
 769
 770     let name = match oop {
 771         OverflowOp::Add => match new_sty {
 772             TyInt(I8) => "llvm.sadd.with.overflow.i8",
 773             TyInt(I16) => "llvm.sadd.with.overflow.i16",
 774             TyInt(I32) => "llvm.sadd.with.overflow.i32",
 775             TyInt(I64) => "llvm.sadd.with.overflow.i64",
 776             TyInt(I128) => "llvm.sadd.with.overflow.i128",
 777
 778             TyUint(U8) => "llvm.uadd.with.overflow.i8",
 779             TyUint(U16) => "llvm.uadd.with.overflow.i16",
 780             TyUint(U32) => "llvm.uadd.with.overflow.i32",
 781             TyUint(U64) => "llvm.uadd.with.overflow.i64",
 782             TyUint(U128) => "llvm.uadd.with.overflow.i128",
 783
 784             _ => unreachable!(),
 785         },
 786         OverflowOp::Sub => match new_sty {
 787             TyInt(I8) => "llvm.ssub.with.overflow.i8",
 788             TyInt(I16) => "llvm.ssub.with.overflow.i16",
 789             TyInt(I32) => "llvm.ssub.with.overflow.i32",
 790             TyInt(I64) => "llvm.ssub.with.overflow.i64",
 791             TyInt(I128) => "llvm.ssub.with.overflow.i128",
 792
 793             TyUint(U8) => "llvm.usub.with.overflow.i8",
 794             TyUint(U16) => "llvm.usub.with.overflow.i16",
 795             TyUint(U32) => "llvm.usub.with.overflow.i32",
 796             TyUint(U64) => "llvm.usub.with.overflow.i64",
 797             TyUint(U128) => "llvm.usub.with.overflow.i128",
 798
 799             _ => unreachable!(),
 800         },
 801         OverflowOp::Mul => match new_sty {
 802             TyInt(I8) => "llvm.smul.with.overflow.i8",
 803             TyInt(I16) => "llvm.smul.with.overflow.i16",
 804             TyInt(I32) => "llvm.smul.with.overflow.i32",
 805             TyInt(I64) => "llvm.smul.with.overflow.i64",
 806             TyInt(I128) => "llvm.smul.with.overflow.i128",
 807
 808             TyUint(U8) => "llvm.umul.with.overflow.i8",
 809             TyUint(U16) => "llvm.umul.with.overflow.i16",
 810             TyUint(U32) => "llvm.umul.with.overflow.i32",
 811             TyUint(U64) => "llvm.umul.with.overflow.i64",
 812             TyUint(U128) => "llvm.umul.with.overflow.i128",
 813
 814             _ => unreachable!(),
 815         },
 816     };
 817
 818     bx.cx.get_intrinsic(&name)
 819 }
 820
 821 fn cast_int_to_float(bx: &Builder<'_, 'll, '_>,
 822                      signed: bool,
 823                      x: &'ll Value,
 824                      int_ty: &'ll Type,
 825                      float_ty: &'ll Type) -> &'ll Value {
 826     // Most integer types, even i128, fit into [-f32::MAX, f32::MAX] after rounding.
 827     // It's only u128 -> f32 that can cause overflows (i.e., should yield infinity).
 828     // LLVM's uitofp produces undef in those cases, so we manually check for that case.
 829     let is_u128_to_f32 = !signed && int_ty.int_width() == 128 && float_ty.float_width() == 32;
 830     if is_u128_to_f32 {
 831         // All inputs greater or equal to (f32::MAX + 0.5 ULP) are rounded to infinity,
 832         // and for everything else LLVM's uitofp works just fine.
 833         use rustc_apfloat::ieee::Single;
 834         use rustc_apfloat::Float;
 835         const MAX_F32_PLUS_HALF_ULP: u128 = ((1 << (Single::PRECISION + 1)) - 1)
 836                                             << (Single::MAX_EXP - Single::PRECISION as i16);
 837         let max = C_uint_big(int_ty, MAX_F32_PLUS_HALF_ULP);
 838         let overflow = bx.icmp(llvm::IntUGE, x, max);
 839         let infinity_bits = C_u32(bx.cx, ieee::Single::INFINITY.to_bits() as u32);
 840         let infinity = consts::bitcast(infinity_bits, float_ty);
 841         bx.select(overflow, infinity, bx.uitofp(x, float_ty))
 842     } else {
 843         if signed {
 844             bx.sitofp(x, float_ty)
 845         } else {
 846             bx.uitofp(x, float_ty)
 847         }
 848     }
 849 }
 850
 851 fn cast_float_to_int(bx: &Builder<'_, 'll, '_>,
 852                      signed: bool,
 853                      x: &'ll Value,
 854                      float_ty: &'ll Type,
 855                      int_ty: &'ll Type) -> &'ll Value {
 856     let fptosui_result = if signed {
 857         bx.fptosi(x, int_ty)
 858     } else {
 859         bx.fptoui(x, int_ty)
 860     };
 861
 862     if !bx.sess().opts.debugging_opts.saturating_float_casts {
 863         return fptosui_result;
 864     }
 865     // LLVM's fpto[su]i returns undef when the input x is infinite, NaN, or does not fit into the
 866     // destination integer type after rounding towards zero. This `undef` value can cause UB in
 867     // safe code (see issue #10184), so we implement a saturating conversion on top of it:
 868     // Semantically, the mathematical value of the input is rounded towards zero to the next
 869     // mathematical integer, and then the result is clamped into the range of the destination
 870     // integer type. Positive and negative infinity are mapped to the maximum and minimum value of
 871     // the destination integer type. NaN is mapped to 0.
 872     //
 873     // Define f_min and f_max as the largest and smallest (finite) floats that are exactly equal to
 874     // a value representable in int_ty.
 875     // They are exactly equal to int_ty::{MIN,MAX} if float_ty has enough significand bits.
 876     // Otherwise, int_ty::MAX must be rounded towards zero, as it is one less than a power of two.
 877     // int_ty::MIN, however, is either zero or a negative power of two and is thus exactly
 878     // representable. Note that this only works if float_ty's exponent range is sufficiently large.
 879     // f16 or 256 bit integers would break this property. Right now the smallest float type is f32
 880     // with exponents ranging up to 127, which is barely enough for i128::MIN = -2^127.
 881     // On the other hand, f_max works even if int_ty::MAX is greater than float_ty::MAX. Because
 882     // we're rounding towards zero, we just get float_ty::MAX (which is always an integer).
 883     // This already happens today with u128::MAX = 2^128 - 1 > f32::MAX.
 884     fn compute_clamp_bounds<F: Float>(signed: bool, int_ty: &Type) -> (u128, u128) {
 885         let rounded_min = F::from_i128_r(int_min(signed, int_ty), Round::TowardZero);
 886         assert_eq!(rounded_min.status, Status::OK);
 887         let rounded_max = F::from_u128_r(int_max(signed, int_ty), Round::TowardZero);
 888         assert!(rounded_max.value.is_finite());
 889         (rounded_min.value.to_bits(), rounded_max.value.to_bits())
 890     }
 891     fn int_max(signed: bool, int_ty: &Type) -> u128 {
 892         let shift_amount = 128 - int_ty.int_width();
 893         if signed {
 894             i128::MAX as u128 >> shift_amount
 895         } else {
 896             u128::MAX >> shift_amount
 897         }
 898     }
 899     fn int_min(signed: bool, int_ty: &Type) -> i128 {
 900         if signed {
 901             i128::MIN >> (128 - int_ty.int_width())
 902         } else {
 903             0
 904         }
 905     }
 906     let float_bits_to_llval = |bits| {
 907         let bits_llval = match float_ty.float_width() {
 908             32 => C_u32(bx.cx, bits as u32),
 909             64 => C_u64(bx.cx, bits as u64),
 910             n => bug!("unsupported float width {}", n),
 911         };
 912         consts::bitcast(bits_llval, float_ty)
 913     };
 914     let (f_min, f_max) = match float_ty.float_width() {
 915         32 => compute_clamp_bounds::<ieee::Single>(signed, int_ty),
 916         64 => compute_clamp_bounds::<ieee::Double>(signed, int_ty),
 917         n => bug!("unsupported float width {}", n),
 918     };
 919     let f_min = float_bits_to_llval(f_min);
 920     let f_max = float_bits_to_llval(f_max);
 921     // To implement saturation, we perform the following steps:
 922     //
 923     // 1. Cast x to an integer with fpto[su]i. This may result in undef.
 924     // 2. Compare x to f_min and f_max, and use the comparison results to select:
 925     //  a) int_ty::MIN if x < f_min or x is NaN
 926     //  b) int_ty::MAX if x > f_max
 927     //  c) the result of fpto[su]i otherwise
 928     // 3. If x is NaN, return 0.0, otherwise return the result of step 2.
 929     //
 930     // This avoids resulting undef because values in range [f_min, f_max] by definition fit into the
 931     // destination type. It creates an undef temporary, but *producing* undef is not UB. Our use of
 932     // undef does not introduce any non-determinism either.
 933     // More importantly, the above procedure correctly implements saturating conversion.
 934     // Proof (sketch):
 935     // If x is NaN, 0 is returned by definition.
 936     // Otherwise, x is finite or infinite and thus can be compared with f_min and f_max.
 937     // This yields three cases to consider:
 938     // (1) if x in [f_min, f_max], the result of fpto[su]i is returned, which agrees with
 939     //     saturating conversion for inputs in that range.
 940     // (2) if x > f_max, then x is larger than int_ty::MAX. This holds even if f_max is rounded
 941     //     (i.e., if f_max < int_ty::MAX) because in those cases, nextUp(f_max) is already larger
 942     //     than int_ty::MAX. Because x is larger than int_ty::MAX, the return value of int_ty::MAX
 943     //     is correct.
 944     // (3) if x < f_min, then x is smaller than int_ty::MIN. As shown earlier, f_min exactly equals
 945     //     int_ty::MIN and therefore the return value of int_ty::MIN is correct.
 946     // QED.
 947
 948     // Step 1 was already performed above.
 949
 950     // Step 2: We use two comparisons and two selects, with %s1 being the result:
 951     //     %less_or_nan = fcmp ult %x, %f_min
 952     //     %greater = fcmp olt %x, %f_max
 953     //     %s0 = select %less_or_nan, int_ty::MIN, %fptosi_result
 954     //     %s1 = select %greater, int_ty::MAX, %s0
 955     // Note that %less_or_nan uses an *unordered* comparison. This comparison is true if the
 956     // operands are not comparable (i.e., if x is NaN). The unordered comparison ensures that s1
 957     // becomes int_ty::MIN if x is NaN.
 958     // Performance note: Unordered comparison can be lowered to a "flipped" comparison and a
 959     // negation, and the negation can be merged into the select. Therefore, it not necessarily any
 960     // more expensive than a ordered ("normal") comparison. Whether these optimizations will be
 961     // performed is ultimately up to the backend, but at least x86 does perform them.
 962     let less_or_nan = bx.fcmp(llvm::RealULT, x, f_min);
 963     let greater = bx.fcmp(llvm::RealOGT, x, f_max);
 964     let int_max = C_uint_big(int_ty, int_max(signed, int_ty));
 965     let int_min = C_uint_big(int_ty, int_min(signed, int_ty) as u128);
 966     let s0 = bx.select(less_or_nan, int_min, fptosui_result);
 967     let s1 = bx.select(greater, int_max, s0);
 968
 969     // Step 3: NaN replacement.
 970     // For unsigned types, the above step already yielded int_ty::MIN == 0 if x is NaN.
 971     // Therefore we only need to execute this step for signed integer types.
 972     if signed {
 973         // LLVM has no isNaN predicate, so we use (x == x) instead
 974         bx.select(bx.fcmp(llvm::RealOEQ, x, x), s1, C_uint(int_ty, 0))
 975     } else {
 976         s1
 977     }
 978 }