src/librustc_trans/common.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 #![allow(non_camel_case_types, non_snake_case)]
  12
  13 //! Code that is useful in various trans modules.
  14
  15 use llvm;
  16 use llvm::{ValueRef, ContextRef, TypeKind};
  17 use llvm::{True, False, Bool, OperandBundleDef};
  18 use rustc::hir::def_id::DefId;
  19 use rustc::hir::map::DefPathData;
  20 use rustc::middle::lang_items::LangItem;
  21 use base;
  22 use builder::Builder;
  23 use consts;
  24 use declare;
  25 use machine;
  26 use monomorphize;
  27 use type_::Type;
  28 use value::Value;
  29 use rustc::ty::{self, Ty, TyCtxt};
  30 use rustc::ty::layout::{Layout, LayoutTyper};
  31 use rustc::ty::subst::{Subst, Substs};
  32 use rustc::hir;
  33
  34 use libc::{c_uint, c_char};
  35 use std::iter;
  36
  37 use syntax::attr;
  38 use syntax::symbol::InternedString;
  39 use syntax_pos::Span;
  40
  41 pub use context::{CrateContext, SharedCrateContext};
  42
  43 pub fn type_is_fat_ptr<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
  44     if let Layout::FatPointer { .. } = *ccx.layout_of(ty) {
  45         true
  46     } else {
  47         false
  48     }
  49 }
  50
  51 pub fn type_is_immediate<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
  52     let layout = ccx.layout_of(ty);
  53     match *layout {
  54         Layout::CEnum { .. } |
  55         Layout::Scalar { .. } |
  56         Layout::Vector { .. } => true,
  57
  58         Layout::FatPointer { .. } => false,
  59
  60         Layout::Array { .. } |
  61         Layout::Univariant { .. } |
  62         Layout::General { .. } |
  63         Layout::UntaggedUnion { .. } |
  64         Layout::RawNullablePointer { .. } |
  65         Layout::StructWrappedNullablePointer { .. } => {
  66             !layout.is_unsized() && layout.size(ccx).bytes() == 0
  67         }
  68     }
  69 }
  70
  71 /// Returns Some([a, b]) if the type has a pair of fields with types a and b.
  72 pub fn type_pair_fields<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, ty: Ty<'tcx>)
  73                                   -> Option<[Ty<'tcx>; 2]> {
  74     match ty.sty {
  75         ty::TyAdt(adt, substs) => {
  76             assert_eq!(adt.variants.len(), 1);
  77             let fields = &adt.variants[0].fields;
  78             if fields.len() != 2 {
  79                 return None;
  80             }
  81             Some([monomorphize::field_ty(ccx.tcx(), substs, &fields[0]),
  82                   monomorphize::field_ty(ccx.tcx(), substs, &fields[1])])
  83         }
  84         ty::TyClosure(def_id, substs) => {
  85             let mut tys = substs.upvar_tys(def_id, ccx.tcx());
  86             tys.next().and_then(|first_ty| tys.next().and_then(|second_ty| {
  87                 if tys.next().is_some() {
  88                     None
  89                 } else {
  90                     Some([first_ty, second_ty])
  91                 }
  92             }))
  93         }
  94         ty::TyTuple(tys, _) => {
  95             if tys.len() != 2 {
  96                 return None;
  97             }
  98             Some([tys[0], tys[1]])
  99         }
 100         _ => None
 101     }
 102 }
 103
 104 /// Returns true if the type is represented as a pair of immediates.
 105 pub fn type_is_imm_pair<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, ty: Ty<'tcx>)
 106                                   -> bool {
 107     match *ccx.layout_of(ty) {
 108         Layout::FatPointer { .. } => true,
 109         Layout::Univariant { ref variant, .. } => {
 110             // There must be only 2 fields.
 111             if variant.offsets.len() != 2 {
 112                 return false;
 113             }
 114
 115             match type_pair_fields(ccx, ty) {
 116                 Some([a, b]) => {
 117                     type_is_immediate(ccx, a) && type_is_immediate(ccx, b)
 118                 }
 119                 None => false
 120             }
 121         }
 122         _ => false
 123     }
 124 }
 125
 126 /// Identify types which have size zero at runtime.
 127 pub fn type_is_zero_size<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
 128     let layout = ccx.layout_of(ty);
 129     !layout.is_unsized() && layout.size(ccx).bytes() == 0
 130 }
 131
 132 /*
 133 * A note on nomenclature of linking: "extern", "foreign", and "upcall".
 134 *
 135 * An "extern" is an LLVM symbol we wind up emitting an undefined external
 136 * reference to. This means "we don't have the thing in this compilation unit,
 137 * please make sure you link it in at runtime". This could be a reference to
 138 * C code found in a C library, or rust code found in a rust crate.
 139 *
 140 * Most "externs" are implicitly declared (automatically) as a result of a
 141 * user declaring an extern _module_ dependency; this causes the rust driver
 142 * to locate an extern crate, scan its compilation metadata, and emit extern
 143 * declarations for any symbols used by the declaring crate.
 144 *
 145 * A "foreign" is an extern that references C (or other non-rust ABI) code.
 146 * There is no metadata to scan for extern references so in these cases either
 147 * a header-digester like bindgen, or manual function prototypes, have to
 148 * serve as declarators. So these are usually given explicitly as prototype
 149 * declarations, in rust code, with ABI attributes on them noting which ABI to
 150 * link via.
 151 *
 152 * An "upcall" is a foreign call generated by the compiler (not corresponding
 153 * to any user-written call in the code) into the runtime library, to perform
 154 * some helper task such as bringing a task to life, allocating memory, etc.
 155 *
 156 */
 157
 158 /// A structure representing an active landing pad for the duration of a basic
 159 /// block.
 160 ///
 161 /// Each `Block` may contain an instance of this, indicating whether the block
 162 /// is part of a landing pad or not. This is used to make decision about whether
 163 /// to emit `invoke` instructions (e.g. in a landing pad we don't continue to
 164 /// use `invoke`) and also about various function call metadata.
 165 ///
 166 /// For GNU exceptions (`landingpad` + `resume` instructions) this structure is
 167 /// just a bunch of `None` instances (not too interesting), but for MSVC
 168 /// exceptions (`cleanuppad` + `cleanupret` instructions) this contains data.
 169 /// When inside of a landing pad, each function call in LLVM IR needs to be
 170 /// annotated with which landing pad it's a part of. This is accomplished via
 171 /// the `OperandBundleDef` value created for MSVC landing pads.
 172 pub struct Funclet {
 173     cleanuppad: ValueRef,
 174     operand: OperandBundleDef,
 175 }
 176
 177 impl Funclet {
 178     pub fn new(cleanuppad: ValueRef) -> Funclet {
 179         Funclet {
 180             cleanuppad: cleanuppad,
 181             operand: OperandBundleDef::new("funclet", &[cleanuppad]),
 182         }
 183     }
 184
 185     pub fn cleanuppad(&self) -> ValueRef {
 186         self.cleanuppad
 187     }
 188
 189     pub fn bundle(&self) -> &OperandBundleDef {
 190         &self.operand
 191     }
 192 }
 193
 194 pub fn val_ty(v: ValueRef) -> Type {
 195     unsafe {
 196         Type::from_ref(llvm::LLVMTypeOf(v))
 197     }
 198 }
 199
 200 // LLVM constant constructors.
 201 pub fn C_null(t: Type) -> ValueRef {
 202     unsafe {
 203         llvm::LLVMConstNull(t.to_ref())
 204     }
 205 }
 206
 207 pub fn C_undef(t: Type) -> ValueRef {
 208     unsafe {
 209         llvm::LLVMGetUndef(t.to_ref())
 210     }
 211 }
 212
 213 pub fn C_integral(t: Type, u: u64, sign_extend: bool) -> ValueRef {
 214     unsafe {
 215         llvm::LLVMConstInt(t.to_ref(), u, sign_extend as Bool)
 216     }
 217 }
 218
 219 pub fn C_big_integral(t: Type, u: u128) -> ValueRef {
 220     unsafe {
 221         let words = [u as u64, u.wrapping_shr(64) as u64];
 222         llvm::LLVMConstIntOfArbitraryPrecision(t.to_ref(), 2, words.as_ptr())
 223     }
 224 }
 225
 226 pub fn C_nil(ccx: &CrateContext) -> ValueRef {
 227     C_struct(ccx, &[], false)
 228 }
 229
 230 pub fn C_bool(ccx: &CrateContext, val: bool) -> ValueRef {
 231     C_integral(Type::i1(ccx), val as u64, false)
 232 }
 233
 234 pub fn C_i32(ccx: &CrateContext, i: i32) -> ValueRef {
 235     C_integral(Type::i32(ccx), i as u64, true)
 236 }
 237
 238 pub fn C_u32(ccx: &CrateContext, i: u32) -> ValueRef {
 239     C_integral(Type::i32(ccx), i as u64, false)
 240 }
 241
 242 pub fn C_u64(ccx: &CrateContext, i: u64) -> ValueRef {
 243     C_integral(Type::i64(ccx), i, false)
 244 }
 245
 246 pub fn C_uint<I: AsU64>(ccx: &CrateContext, i: I) -> ValueRef {
 247     let v = i.as_u64();
 248
 249     let bit_size = machine::llbitsize_of_real(ccx, ccx.int_type());
 250
 251     if bit_size < 64 {
 252         // make sure it doesn't overflow
 253         assert!(v < (1<<bit_size));
 254     }
 255
 256     C_integral(ccx.int_type(), v, false)
 257 }
 258
 259 pub trait AsI64 { fn as_i64(self) -> i64; }
 260 pub trait AsU64 { fn as_u64(self) -> u64; }
 261
 262 // FIXME: remove the intptr conversions, because they
 263 // are host-architecture-dependent
 264 impl AsI64 for i64 { fn as_i64(self) -> i64 { self as i64 }}
 265 impl AsI64 for i32 { fn as_i64(self) -> i64 { self as i64 }}
 266 impl AsI64 for isize { fn as_i64(self) -> i64 { self as i64 }}
 267
 268 impl AsU64 for u64  { fn as_u64(self) -> u64 { self as u64 }}
 269 impl AsU64 for u32  { fn as_u64(self) -> u64 { self as u64 }}
 270 impl AsU64 for usize { fn as_u64(self) -> u64 { self as u64 }}
 271
 272 pub fn C_u8(ccx: &CrateContext, i: u8) -> ValueRef {
 273     C_integral(Type::i8(ccx), i as u64, false)
 274 }
 275
 276
 277 // This is a 'c-like' raw string, which differs from
 278 // our boxed-and-length-annotated strings.
 279 pub fn C_cstr(cx: &CrateContext, s: InternedString, null_terminated: bool) -> ValueRef {
 280     unsafe {
 281         if let Some(&llval) = cx.const_cstr_cache().borrow().get(&s) {
 282             return llval;
 283         }
 284
 285         let sc = llvm::LLVMConstStringInContext(cx.llcx(),
 286                                                 s.as_ptr() as *const c_char,
 287                                                 s.len() as c_uint,
 288                                                 !null_terminated as Bool);
 289         let sym = cx.generate_local_symbol_name("str");
 290         let g = declare::define_global(cx, &sym[..], val_ty(sc)).unwrap_or_else(||{
 291             bug!("symbol `{}` is already defined", sym);
 292         });
 293         llvm::LLVMSetInitializer(g, sc);
 294         llvm::LLVMSetGlobalConstant(g, True);
 295         llvm::LLVMRustSetLinkage(g, llvm::Linkage::InternalLinkage);
 296
 297         cx.const_cstr_cache().borrow_mut().insert(s, g);
 298         g
 299     }
 300 }
 301
 302 // NB: Do not use `do_spill_noroot` to make this into a constant string, or
 303 // you will be kicked off fast isel. See issue #4352 for an example of this.
 304 pub fn C_str_slice(cx: &CrateContext, s: InternedString) -> ValueRef {
 305     let len = s.len();
 306     let cs = consts::ptrcast(C_cstr(cx, s, false), Type::i8p(cx));
 307     C_named_struct(cx.str_slice_type(), &[cs, C_uint(cx, len)])
 308 }
 309
 310 pub fn C_struct(cx: &CrateContext, elts: &[ValueRef], packed: bool) -> ValueRef {
 311     C_struct_in_context(cx.llcx(), elts, packed)
 312 }
 313
 314 pub fn C_struct_in_context(llcx: ContextRef, elts: &[ValueRef], packed: bool) -> ValueRef {
 315     unsafe {
 316         llvm::LLVMConstStructInContext(llcx,
 317                                        elts.as_ptr(), elts.len() as c_uint,
 318                                        packed as Bool)
 319     }
 320 }
 321
 322 pub fn C_named_struct(t: Type, elts: &[ValueRef]) -> ValueRef {
 323     unsafe {
 324         llvm::LLVMConstNamedStruct(t.to_ref(), elts.as_ptr(), elts.len() as c_uint)
 325     }
 326 }
 327
 328 pub fn C_array(ty: Type, elts: &[ValueRef]) -> ValueRef {
 329     unsafe {
 330         return llvm::LLVMConstArray(ty.to_ref(), elts.as_ptr(), elts.len() as c_uint);
 331     }
 332 }
 333
 334 pub fn C_vector(elts: &[ValueRef]) -> ValueRef {
 335     unsafe {
 336         return llvm::LLVMConstVector(elts.as_ptr(), elts.len() as c_uint);
 337     }
 338 }
 339
 340 pub fn C_bytes(cx: &CrateContext, bytes: &[u8]) -> ValueRef {
 341     C_bytes_in_context(cx.llcx(), bytes)
 342 }
 343
 344 pub fn C_bytes_in_context(llcx: ContextRef, bytes: &[u8]) -> ValueRef {
 345     unsafe {
 346         let ptr = bytes.as_ptr() as *const c_char;
 347         return llvm::LLVMConstStringInContext(llcx, ptr, bytes.len() as c_uint, True);
 348     }
 349 }
 350
 351 pub fn const_get_elt(v: ValueRef, us: &[c_uint])
 352               -> ValueRef {
 353     unsafe {
 354         let r = llvm::LLVMConstExtractValue(v, us.as_ptr(), us.len() as c_uint);
 355
 356         debug!("const_get_elt(v={:?}, us={:?}, r={:?})",
 357                Value(v), us, Value(r));
 358
 359         r
 360     }
 361 }
 362
 363 pub fn const_to_uint(v: ValueRef) -> u64 {
 364     unsafe {
 365         llvm::LLVMConstIntGetZExtValue(v)
 366     }
 367 }
 368
 369 pub fn is_const_integral(v: ValueRef) -> bool {
 370     unsafe {
 371         !llvm::LLVMIsAConstantInt(v).is_null()
 372     }
 373 }
 374
 375 #[inline]
 376 fn hi_lo_to_u128(lo: u64, hi: u64) -> u128 {
 377     ((hi as u128) << 64) | (lo as u128)
 378 }
 379
 380 pub fn const_to_opt_u128(v: ValueRef, sign_ext: bool) -> Option<u128> {
 381     unsafe {
 382         if is_const_integral(v) {
 383             let (mut lo, mut hi) = (0u64, 0u64);
 384             let success = llvm::LLVMRustConstInt128Get(v, sign_ext,
 385                                                        &mut hi as *mut u64, &mut lo as *mut u64);
 386             if success {
 387                 Some(hi_lo_to_u128(lo, hi))
 388             } else {
 389                 None
 390             }
 391         } else {
 392             None
 393         }
 394     }
 395 }
 396
 397 pub fn is_undef(val: ValueRef) -> bool {
 398     unsafe {
 399         llvm::LLVMIsUndef(val) != False
 400     }
 401 }
 402
 403 #[allow(dead_code)] // potentially useful
 404 pub fn is_null(val: ValueRef) -> bool {
 405     unsafe {
 406         llvm::LLVMIsNull(val) != False
 407     }
 408 }
 409
 410 pub fn langcall(tcx: TyCtxt,
 411                 span: Option<Span>,
 412                 msg: &str,
 413                 li: LangItem)
 414                 -> DefId {
 415     match tcx.lang_items.require(li) {
 416         Ok(id) => id,
 417         Err(s) => {
 418             let msg = format!("{} {}", msg, s);
 419             match span {
 420                 Some(span) => tcx.sess.span_fatal(span, &msg[..]),
 421                 None => tcx.sess.fatal(&msg[..]),
 422             }
 423         }
 424     }
 425 }
 426
 427 // To avoid UB from LLVM, these two functions mask RHS with an
 428 // appropriate mask unconditionally (i.e. the fallback behavior for
 429 // all shifts). For 32- and 64-bit types, this matches the semantics
 430 // of Java. (See related discussion on #1877 and #10183.)
 431
 432 pub fn build_unchecked_lshift<'a, 'tcx>(
 433     bcx: &Builder<'a, 'tcx>,
 434     lhs: ValueRef,
 435     rhs: ValueRef
 436 ) -> ValueRef {
 437     let rhs = base::cast_shift_expr_rhs(bcx, hir::BinOp_::BiShl, lhs, rhs);
 438     // #1877, #10183: Ensure that input is always valid
 439     let rhs = shift_mask_rhs(bcx, rhs);
 440     bcx.shl(lhs, rhs)
 441 }
 442
 443 pub fn build_unchecked_rshift<'a, 'tcx>(
 444     bcx: &Builder<'a, 'tcx>, lhs_t: Ty<'tcx>, lhs: ValueRef, rhs: ValueRef
 445 ) -> ValueRef {
 446     let rhs = base::cast_shift_expr_rhs(bcx, hir::BinOp_::BiShr, lhs, rhs);
 447     // #1877, #10183: Ensure that input is always valid
 448     let rhs = shift_mask_rhs(bcx, rhs);
 449     let is_signed = lhs_t.is_signed();
 450     if is_signed {
 451         bcx.ashr(lhs, rhs)
 452     } else {
 453         bcx.lshr(lhs, rhs)
 454     }
 455 }
 456
 457 fn shift_mask_rhs<'a, 'tcx>(bcx: &Builder<'a, 'tcx>, rhs: ValueRef) -> ValueRef {
 458     let rhs_llty = val_ty(rhs);
 459     bcx.and(rhs, shift_mask_val(bcx, rhs_llty, rhs_llty, false))
 460 }
 461
 462 pub fn shift_mask_val<'a, 'tcx>(
 463     bcx: &Builder<'a, 'tcx>,
 464     llty: Type,
 465     mask_llty: Type,
 466     invert: bool
 467 ) -> ValueRef {
 468     let kind = llty.kind();
 469     match kind {
 470         TypeKind::Integer => {
 471             // i8/u8 can shift by at most 7, i16/u16 by at most 15, etc.
 472             let val = llty.int_width() - 1;
 473             if invert {
 474                 C_integral(mask_llty, !val, true)
 475             } else {
 476                 C_integral(mask_llty, val, false)
 477             }
 478         },
 479         TypeKind::Vector => {
 480             let mask = shift_mask_val(bcx, llty.element_type(), mask_llty.element_type(), invert);
 481             bcx.vector_splat(mask_llty.vector_length(), mask)
 482         },
 483         _ => bug!("shift_mask_val: expected Integer or Vector, found {:?}", kind),
 484     }
 485 }
 486
 487 pub fn ty_fn_sig<'a, 'tcx>(ccx: &CrateContext<'a, 'tcx>,
 488                            ty: Ty<'tcx>)
 489                            -> ty::PolyFnSig<'tcx>
 490 {
 491     match ty.sty {
 492         ty::TyFnDef(..) |
 493         // Shims currently have type TyFnPtr. Not sure this should remain.
 494         ty::TyFnPtr(_) => ty.fn_sig(ccx.tcx()),
 495         ty::TyClosure(def_id, substs) => {
 496             let tcx = ccx.tcx();
 497             let sig = tcx.fn_sig(def_id).subst(tcx, substs.substs);
 498
 499             let env_region = ty::ReLateBound(ty::DebruijnIndex::new(1), ty::BrEnv);
 500             let env_ty = match tcx.closure_kind(def_id) {
 501                 ty::ClosureKind::Fn => tcx.mk_imm_ref(tcx.mk_region(env_region), ty),
 502                 ty::ClosureKind::FnMut => tcx.mk_mut_ref(tcx.mk_region(env_region), ty),
 503                 ty::ClosureKind::FnOnce => ty,
 504             };
 505
 506             sig.map_bound(|sig| tcx.mk_fn_sig(
 507                 iter::once(env_ty).chain(sig.inputs().iter().cloned()),
 508                 sig.output(),
 509                 sig.variadic,
 510                 sig.unsafety,
 511                 sig.abi
 512             ))
 513         }
 514         _ => bug!("unexpected type {:?} to ty_fn_sig", ty)
 515     }
 516 }
 517
 518 pub fn requests_inline<'a, 'tcx>(
 519     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 520     instance: &ty::Instance<'tcx>
 521 ) -> bool {
 522     if is_inline_instance(tcx, instance) {
 523         return true
 524     }
 525     if let ty::InstanceDef::DropGlue(..) = instance.def {
 526         // Drop glue wants to be instantiated at every translation
 527         // unit, but without an #[inline] hint. We should make this
 528         // available to normal end-users.
 529         return true
 530     }
 531     attr::requests_inline(&instance.def.attrs(tcx)[..])
 532 }
 533
 534 pub fn is_inline_instance<'a, 'tcx>(
 535     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 536     instance: &ty::Instance<'tcx>
 537 ) -> bool {
 538     let def_id = match instance.def {
 539         ty::InstanceDef::Item(def_id) => def_id,
 540         ty::InstanceDef::DropGlue(_, Some(_)) => return false,
 541         _ => return true
 542     };
 543     match tcx.def_key(def_id).disambiguated_data.data {
 544         DefPathData::StructCtor |
 545         DefPathData::EnumVariant(..) |
 546         DefPathData::ClosureExpr => true,
 547         _ => false
 548     }
 549 }
 550
 551 /// Given a DefId and some Substs, produces the monomorphic item type.
 552 pub fn def_ty<'a, 'tcx>(shared: &SharedCrateContext<'a, 'tcx>,
 553                         def_id: DefId,
 554                         substs: &'tcx Substs<'tcx>)
 555                         -> Ty<'tcx>
 556 {
 557     let ty = shared.tcx().type_of(def_id);
 558     shared.tcx().trans_apply_param_substs(substs, &ty)
 559 }
 560
 561 /// Return the substituted type of an instance.
 562 pub fn instance_ty<'a, 'tcx>(shared: &SharedCrateContext<'a, 'tcx>,
 563                              instance: &ty::Instance<'tcx>)
 564                              -> Ty<'tcx>
 565 {
 566     let ty = instance.def.def_ty(shared.tcx());
 567     shared.tcx().trans_apply_param_substs(instance.substs, &ty)
 568 }