src/librustc_codegen_llvm/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 codegen modules.
  14
  15 use llvm::{self, TypeKind};
  16 use llvm::{True, False, Bool, BasicBlock};
  17 use rustc::hir::def_id::DefId;
  18 use rustc::middle::lang_items::LangItem;
  19 use abi;
  20 use base;
  21 use builder::Builder;
  22 use consts;
  23 use declare;
  24 use type_::Type;
  25 use type_of::LayoutLlvmExt;
  26 use value::Value;
  27 use interfaces::{Backend, CommonMethods, CommonWriteMethods};
  28
  29 use rustc::ty::{self, Ty, TyCtxt};
  30 use rustc::ty::layout::{HasDataLayout, LayoutOf};
  31 use rustc::hir;
  32 use interfaces::BuilderMethods;
  33
  34 use libc::{c_uint, c_char};
  35
  36 use syntax::symbol::LocalInternedString;
  37 use syntax_pos::{Span, DUMMY_SP};
  38
  39 pub use context::CodegenCx;
  40
  41 pub fn type_needs_drop<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, ty: Ty<'tcx>) -> bool {
  42     ty.needs_drop(tcx, ty::ParamEnv::reveal_all())
  43 }
  44
  45 pub fn type_is_sized<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, ty: Ty<'tcx>) -> bool {
  46     ty.is_sized(tcx.at(DUMMY_SP), ty::ParamEnv::reveal_all())
  47 }
  48
  49 pub fn type_is_freeze<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, ty: Ty<'tcx>) -> bool {
  50     ty.is_freeze(tcx, ty::ParamEnv::reveal_all(), DUMMY_SP)
  51 }
  52
  53 pub struct OperandBundleDef<'a, Value : 'a> {
  54     pub name: &'a str,
  55     pub val: Value
  56 }
  57
  58 impl OperandBundleDef<'ll, &'ll Value> {
  59     pub fn new(name: &'ll str, val: &'ll Value) -> Self {
  60         OperandBundleDef {
  61             name,
  62             val
  63         }
  64     }
  65 }
  66
  67 pub enum IntPredicate {
  68     IntEQ,
  69     IntNE,
  70     IntUGT,
  71     IntUGE,
  72     IntULT,
  73     IntULE,
  74     IntSGT,
  75     IntSGE,
  76     IntSLT,
  77     IntSLE
  78 }
  79
  80 #[allow(dead_code)]
  81 pub enum RealPredicate {
  82     RealPredicateFalse,
  83     RealOEQ,
  84     RealOGT,
  85     RealOGE,
  86     RealOLT,
  87     RealOLE,
  88     RealONE,
  89     RealORD,
  90     RealUNO,
  91     RealUEQ,
  92     RealUGT,
  93     RealUGE,
  94     RealULT,
  95     RealULE,
  96     RealUNE,
  97     RealPredicateTrue
  98 }
  99
 100 pub enum AtomicRmwBinOp {
 101     AtomicXchg,
 102     AtomicAdd,
 103     AtomicSub,
 104     AtomicAnd,
 105     AtomicNand,
 106     AtomicOr,
 107     AtomicXor,
 108     AtomicMax,
 109     AtomicMin,
 110     AtomicUMax,
 111     AtomicUMin
 112 }
 113
 114 pub enum AtomicOrdering {
 115     #[allow(dead_code)]
 116     NotAtomic,
 117     Unordered,
 118     Monotonic,
 119     // Consume,  // Not specified yet.
 120     Acquire,
 121     Release,
 122     AcquireRelease,
 123     SequentiallyConsistent,
 124 }
 125
 126 pub enum SynchronizationScope {
 127     // FIXME: figure out if this variant is needed at all.
 128     #[allow(dead_code)]
 129     Other,
 130     SingleThread,
 131     CrossThread,
 132 }
 133
 134 /*
 135 * A note on nomenclature of linking: "extern", "foreign", and "upcall".
 136 *
 137 * An "extern" is an LLVM symbol we wind up emitting an undefined external
 138 * reference to. This means "we don't have the thing in this compilation unit,
 139 * please make sure you link it in at runtime". This could be a reference to
 140 * C code found in a C library, or rust code found in a rust crate.
 141 *
 142 * Most "externs" are implicitly declared (automatically) as a result of a
 143 * user declaring an extern _module_ dependency; this causes the rust driver
 144 * to locate an extern crate, scan its compilation metadata, and emit extern
 145 * declarations for any symbols used by the declaring crate.
 146 *
 147 * A "foreign" is an extern that references C (or other non-rust ABI) code.
 148 * There is no metadata to scan for extern references so in these cases either
 149 * a header-digester like bindgen, or manual function prototypes, have to
 150 * serve as declarators. So these are usually given explicitly as prototype
 151 * declarations, in rust code, with ABI attributes on them noting which ABI to
 152 * link via.
 153 *
 154 * An "upcall" is a foreign call generated by the compiler (not corresponding
 155 * to any user-written call in the code) into the runtime library, to perform
 156 * some helper task such as bringing a task to life, allocating memory, etc.
 157 *
 158 */
 159
 160 /// A structure representing an active landing pad for the duration of a basic
 161 /// block.
 162 ///
 163 /// Each `Block` may contain an instance of this, indicating whether the block
 164 /// is part of a landing pad or not. This is used to make decision about whether
 165 /// to emit `invoke` instructions (e.g. in a landing pad we don't continue to
 166 /// use `invoke`) and also about various function call metadata.
 167 ///
 168 /// For GNU exceptions (`landingpad` + `resume` instructions) this structure is
 169 /// just a bunch of `None` instances (not too interesting), but for MSVC
 170 /// exceptions (`cleanuppad` + `cleanupret` instructions) this contains data.
 171 /// When inside of a landing pad, each function call in LLVM IR needs to be
 172 /// annotated with which landing pad it's a part of. This is accomplished via
 173 /// the `OperandBundleDef` value created for MSVC landing pads.
 174 pub struct Funclet<'ll> {
 175     cleanuppad: &'ll Value,
 176     operand: OperandBundleDef<'ll, &'ll Value>,
 177 }
 178
 179 impl Funclet<'ll> {
 180     pub fn new(cleanuppad: &'ll Value) -> Self {
 181         Funclet {
 182             cleanuppad,
 183             operand: OperandBundleDef::new("funclet", cleanuppad),
 184         }
 185     }
 186
 187     pub fn cleanuppad(&self) -> &'ll Value {
 188         self.cleanuppad
 189     }
 190
 191     pub fn bundle(&self) -> &OperandBundleDef<'ll, &'ll Value> {
 192         &self.operand
 193     }
 194 }
 195
 196 impl Backend for CodegenCx<'ll, 'tcx> {
 197     type Value = &'ll Value;
 198     type BasicBlock = &'ll BasicBlock;
 199     type Type = &'ll Type;
 200     type Context = &'ll llvm::Context;
 201 }
 202
 203 impl<'ll, 'tcx : 'll> CommonMethods for CodegenCx<'ll, 'tcx> {
 204
 205     // LLVM constant constructors.
 206     fn c_null(&self, t: &'ll Type) -> &'ll Value {
 207         unsafe {
 208             llvm::LLVMConstNull(t)
 209         }
 210     }
 211
 212     fn c_undef(&self, t: &'ll Type) -> &'ll Value {
 213         unsafe {
 214             llvm::LLVMGetUndef(t)
 215         }
 216     }
 217
 218     fn c_int(&self, t: &'ll Type, i: i64) -> &'ll Value {
 219         unsafe {
 220             llvm::LLVMConstInt(t, i as u64, True)
 221         }
 222     }
 223
 224     fn c_uint(&self, t: &'ll Type, i: u64) -> &'ll Value {
 225         unsafe {
 226             llvm::LLVMConstInt(t, i, False)
 227         }
 228     }
 229
 230     fn c_uint_big(&self, t: &'ll Type, u: u128) -> &'ll Value {
 231         unsafe {
 232             let words = [u as u64, (u >> 64) as u64];
 233             llvm::LLVMConstIntOfArbitraryPrecision(t, 2, words.as_ptr())
 234         }
 235     }
 236
 237     fn c_bool(&self, val: bool) -> &'ll Value {
 238         &self.c_uint(Type::i1(&self), val as u64)
 239     }
 240
 241     fn c_i32(&self, i: i32) -> &'ll Value {
 242         &self.c_int(Type::i32(&self), i as i64)
 243     }
 244
 245     fn c_u32(&self, i: u32) -> &'ll Value {
 246         &self.c_uint(Type::i32(&self), i as u64)
 247     }
 248
 249     fn c_u64(&self, i: u64) -> &'ll Value {
 250         &self.c_uint(Type::i64(&self), i)
 251     }
 252
 253     fn c_usize(&self, i: u64) -> &'ll Value {
 254         let bit_size = self.data_layout().pointer_size.bits();
 255         if bit_size < 64 {
 256             // make sure it doesn't overflow
 257             assert!(i < (1<<bit_size));
 258         }
 259
 260         &self.c_uint(&self.isize_ty, i)
 261     }
 262
 263     fn c_u8(&self, i: u8) -> &'ll Value {
 264         &self.c_uint(Type::i8(&self), i as u64)
 265     }
 266
 267
 268     // This is a 'c-like' raw string, which differs from
 269     // our boxed-and-length-annotated strings.
 270     fn c_cstr(
 271         &self,
 272         s: LocalInternedString,
 273         null_terminated: bool,
 274     ) -> &'ll Value {
 275         unsafe {
 276             if let Some(&llval) = &self.const_cstr_cache.borrow().get(&s) {
 277                 return llval;
 278             }
 279
 280             let sc = llvm::LLVMConstStringInContext(&self.llcx,
 281                                                     s.as_ptr() as *const c_char,
 282                                                     s.len() as c_uint,
 283                                                     !null_terminated as Bool);
 284             let sym = &self.generate_local_symbol_name("str");
 285             let g = declare::define_global(&self, &sym[..], &self.val_ty(sc)).unwrap_or_else(||{
 286                 bug!("symbol `{}` is already defined", sym);
 287             });
 288             llvm::LLVMSetInitializer(g, sc);
 289             llvm::LLVMSetGlobalConstant(g, True);
 290             llvm::LLVMRustSetLinkage(g, llvm::Linkage::InternalLinkage);
 291
 292             &self.const_cstr_cache.borrow_mut().insert(s, g);
 293             g
 294         }
 295     }
 296
 297     // NB: Do not use `do_spill_noroot` to make this into a constant string, or
 298     // you will be kicked off fast isel. See issue #4352 for an example of this.
 299     fn c_str_slice(&self, s: LocalInternedString) -> &'ll Value {
 300         let len = s.len();
 301         let cs = consts::ptrcast(&self.c_cstr(s, false),
 302             &self.layout_of(&self.tcx.mk_str()).llvm_type(&self).ptr_to());
 303         &self.c_fat_ptr(cs, &self.c_usize(len as u64))
 304     }
 305
 306     fn c_fat_ptr(
 307         &self,
 308         ptr: &'ll Value,
 309         meta: &'ll Value
 310     ) -> &'ll Value {
 311         assert_eq!(abi::FAT_PTR_ADDR, 0);
 312         assert_eq!(abi::FAT_PTR_EXTRA, 1);
 313         &self.c_struct(&[ptr, meta], false)
 314     }
 315
 316     fn c_struct(
 317         &self,
 318         elts: &[&'ll Value],
 319         packed: bool
 320     ) -> &'ll Value {
 321         &self.c_struct_in_context(&self.llcx, elts, packed)
 322     }
 323
 324     fn c_array(&self, ty: &'ll Type, elts: &[&'ll Value]) -> &'ll Value {
 325         unsafe {
 326             return llvm::LLVMConstArray(ty, elts.as_ptr(), elts.len() as c_uint);
 327         }
 328     }
 329
 330     fn c_vector(&self, elts: &[&'ll Value]) -> &'ll Value {
 331         unsafe {
 332             return llvm::LLVMConstVector(elts.as_ptr(), elts.len() as c_uint);
 333         }
 334     }
 335
 336     fn c_bytes(&self, bytes: &[u8]) -> &'ll Value {
 337         &self.c_bytes_in_context(&self.llcx, bytes)
 338     }
 339
 340     fn const_get_elt(&self, v: &'ll Value, idx: u64) -> &'ll Value {
 341         unsafe {
 342             assert_eq!(idx as c_uint as u64, idx);
 343             let us = &[idx as c_uint];
 344             let r = llvm::LLVMConstExtractValue(v, us.as_ptr(), us.len() as c_uint);
 345
 346             debug!("const_get_elt(v={:?}, idx={}, r={:?})",
 347                    v, idx, r);
 348
 349             r
 350         }
 351     }
 352
 353     fn const_get_real(&self, v: &'ll Value) -> Option<(f64, bool)> {
 354         unsafe {
 355             if self.is_const_real(v) {
 356                 let mut loses_info: llvm::Bool = ::std::mem::uninitialized();
 357                 let r = llvm::LLVMConstRealGetDouble(v, &mut loses_info);
 358                 let loses_info = if loses_info == 1 { true } else { false };
 359                 Some((r, loses_info))
 360             } else {
 361                 None
 362             }
 363         }
 364     }
 365
 366     fn const_to_uint(&self, v: &'ll Value) -> u64 {
 367         unsafe {
 368             llvm::LLVMConstIntGetZExtValue(v)
 369         }
 370     }
 371
 372     fn is_const_integral(&self, v: &'ll Value) -> bool {
 373         unsafe {
 374             llvm::LLVMIsAConstantInt(v).is_some()
 375         }
 376     }
 377
 378     fn is_const_real(&self, v: &'ll Value) -> bool {
 379         unsafe {
 380             llvm::LLVMIsAConstantFP(v).is_some()
 381         }
 382     }
 383
 384     fn const_to_opt_u128(&self, v: &'ll Value, sign_ext: bool) -> Option<u128> {
 385         unsafe {
 386             if self.is_const_integral(v) {
 387                 let (mut lo, mut hi) = (0u64, 0u64);
 388                 let success = llvm::LLVMRustConstInt128Get(v, sign_ext,
 389                                                            &mut hi, &mut lo);
 390                 if success {
 391                     Some(hi_lo_to_u128(lo, hi))
 392                 } else {
 393                     None
 394                 }
 395             } else {
 396                 None
 397             }
 398         }
 399     }
 400 }
 401
 402 pub fn val_ty(v: &'ll Value) -> &'ll Type {
 403     unsafe {
 404         llvm::LLVMTypeOf(v)
 405     }
 406 }
 407
 408 pub fn c_bytes_in_context(llcx: &'ll llvm::Context, bytes: &[u8]) -> &'ll Value {
 409     unsafe {
 410         let ptr = bytes.as_ptr() as *const c_char;
 411         return llvm::LLVMConstStringInContext(llcx, ptr, bytes.len() as c_uint, True);
 412     }
 413 }
 414
 415 pub fn c_struct_in_context(
 416     llcx: &'a llvm::Context,
 417     elts: &[&'a Value],
 418     packed: bool,
 419 ) -> &'a Value {
 420     unsafe {
 421         llvm::LLVMConstStructInContext(llcx,
 422                                        elts.as_ptr(), elts.len() as c_uint,
 423                                        packed as Bool)
 424     }
 425 }
 426
 427 impl<'ll, 'tcx : 'll> CommonWriteMethods for CodegenCx<'ll, 'tcx> {
 428     fn val_ty(&self, v: &'ll Value) -> &'ll Type {
 429         val_ty(v)
 430     }
 431
 432     fn c_bytes_in_context(&self, llcx: &'ll llvm::Context, bytes: &[u8]) -> &'ll Value {
 433         c_bytes_in_context(llcx, bytes)
 434     }
 435
 436     fn c_struct_in_context(
 437         &self,
 438         llcx: &'a llvm::Context,
 439         elts: &[&'a Value],
 440         packed: bool,
 441     ) -> &'a Value {
 442         c_struct_in_context(llcx, elts, packed)
 443     }
 444 }
 445
 446
 447 #[inline]
 448 fn hi_lo_to_u128(lo: u64, hi: u64) -> u128 {
 449     ((hi as u128) << 64) | (lo as u128)
 450 }
 451
 452 pub fn langcall(tcx: TyCtxt,
 453                 span: Option<Span>,
 454                 msg: &str,
 455                 li: LangItem)
 456                 -> DefId {
 457     tcx.lang_items().require(li).unwrap_or_else(|s| {
 458         let msg = format!("{} {}", msg, s);
 459         match span {
 460             Some(span) => tcx.sess.span_fatal(span, &msg[..]),
 461             None => tcx.sess.fatal(&msg[..]),
 462         }
 463     })
 464 }
 465
 466 // To avoid UB from LLVM, these two functions mask RHS with an
 467 // appropriate mask unconditionally (i.e. the fallback behavior for
 468 // all shifts). For 32- and 64-bit types, this matches the semantics
 469 // of Java. (See related discussion on #1877 and #10183.)
 470
 471 pub fn build_unchecked_lshift(
 472     bx: &Builder<'a, 'll, 'tcx>,
 473     lhs: &'ll Value,
 474     rhs: &'ll Value
 475 ) -> &'ll Value {
 476     let rhs = base::cast_shift_expr_rhs(bx, hir::BinOpKind::Shl, lhs, rhs);
 477     // #1877, #10183: Ensure that input is always valid
 478     let rhs = shift_mask_rhs(bx, rhs);
 479     bx.shl(lhs, rhs)
 480 }
 481
 482 pub fn build_unchecked_rshift(
 483     bx: &Builder<'a, 'll, 'tcx>, lhs_t: Ty<'tcx>, lhs: &'ll Value, rhs: &'ll Value
 484 ) -> &'ll Value {
 485     let rhs = base::cast_shift_expr_rhs(bx, hir::BinOpKind::Shr, lhs, rhs);
 486     // #1877, #10183: Ensure that input is always valid
 487     let rhs = shift_mask_rhs(bx, rhs);
 488     let is_signed = lhs_t.is_signed();
 489     if is_signed {
 490         bx.ashr(lhs, rhs)
 491     } else {
 492         bx.lshr(lhs, rhs)
 493     }
 494 }
 495
 496 fn shift_mask_rhs(bx: &Builder<'a, 'll, 'tcx>, rhs: &'ll Value) -> &'ll Value {
 497     let rhs_llty = bx.cx().val_ty(rhs);
 498     bx.and(rhs, shift_mask_val(bx, rhs_llty, rhs_llty, false))
 499 }
 500
 501 pub fn shift_mask_val(
 502     bx: &Builder<'a, 'll, 'tcx>,
 503     llty: &'ll Type,
 504     mask_llty: &'ll Type,
 505     invert: bool
 506 ) -> &'ll Value {
 507     let kind = llty.kind();
 508     match kind {
 509         TypeKind::Integer => {
 510             // i8/u8 can shift by at most 7, i16/u16 by at most 15, etc.
 511             let val = llty.int_width() - 1;
 512             if invert {
 513                 bx.cx.c_int(mask_llty, !val as i64)
 514             } else {
 515                 bx.cx.c_uint(mask_llty, val)
 516             }
 517         },
 518         TypeKind::Vector => {
 519             let mask = shift_mask_val(bx, llty.element_type(), mask_llty.element_type(), invert);
 520             bx.vector_splat(mask_llty.vector_length(), mask)
 521         },
 522         _ => bug!("shift_mask_val: expected Integer or Vector, found {:?}", kind),
 523     }
 524 }