src/librustc_codegen_ssa/mir/mod.rs

   1 use crate::base;
   2 use crate::traits::*;
   3 use rustc::mir;
   4 use rustc::ty::layout::{FnAbiExt, HasTyCtxt, TyLayout};
   5 use rustc::ty::{self, Instance, Ty, TypeFoldable};
   6 use rustc_target::abi::call::{FnAbi, PassMode};
   7
   8 use std::iter;
   9
  10 use rustc_index::bit_set::BitSet;
  11 use rustc_index::vec::IndexVec;
  12
  13 use self::analyze::CleanupKind;
  14 use self::debuginfo::FunctionDebugContext;
  15 use self::place::PlaceRef;
  16 use rustc::mir::traversal;
  17
  18 use self::operand::{OperandRef, OperandValue};
  19
  20 /// Master context for codegenning from MIR.
  21 pub struct FunctionCx<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>> {
  22     instance: Instance<'tcx>,
  23
  24     mir: mir::ReadOnlyBodyAndCache<'tcx, 'tcx>,
  25
  26     debug_context: Option<FunctionDebugContext<Bx::DIScope>>,
  27
  28     llfn: Bx::Function,
  29
  30     cx: &'a Bx::CodegenCx,
  31
  32     fn_abi: FnAbi<'tcx, Ty<'tcx>>,
  33
  34     /// When unwinding is initiated, we have to store this personality
  35     /// value somewhere so that we can load it and re-use it in the
  36     /// resume instruction. The personality is (afaik) some kind of
  37     /// value used for C++ unwinding, which must filter by type: we
  38     /// don't really care about it very much. Anyway, this value
  39     /// contains an alloca into which the personality is stored and
  40     /// then later loaded when generating the DIVERGE_BLOCK.
  41     personality_slot: Option<PlaceRef<'tcx, Bx::Value>>,
  42
  43     /// A `Block` for each MIR `BasicBlock`
  44     blocks: IndexVec<mir::BasicBlock, Bx::BasicBlock>,
  45
  46     /// The funclet status of each basic block
  47     cleanup_kinds: IndexVec<mir::BasicBlock, analyze::CleanupKind>,
  48
  49     /// When targeting MSVC, this stores the cleanup info for each funclet
  50     /// BB. This is initialized as we compute the funclets' head block in RPO.
  51     funclets: IndexVec<mir::BasicBlock, Option<Bx::Funclet>>,
  52
  53     /// This stores the landing-pad block for a given BB, computed lazily on GNU
  54     /// and eagerly on MSVC.
  55     landing_pads: IndexVec<mir::BasicBlock, Option<Bx::BasicBlock>>,
  56
  57     /// Cached unreachable block
  58     unreachable_block: Option<Bx::BasicBlock>,
  59
  60     /// The location where each MIR arg/var/tmp/ret is stored. This is
  61     /// usually an `PlaceRef` representing an alloca, but not always:
  62     /// sometimes we can skip the alloca and just store the value
  63     /// directly using an `OperandRef`, which makes for tighter LLVM
  64     /// IR. The conditions for using an `OperandRef` are as follows:
  65     ///
  66     /// - the type of the local must be judged "immediate" by `is_llvm_immediate`
  67     /// - the operand must never be referenced indirectly
  68     ///     - we should not take its address using the `&` operator
  69     ///     - nor should it appear in a place path like `tmp.a`
  70     /// - the operand must be defined by an rvalue that can generate immediate
  71     ///   values
  72     ///
  73     /// Avoiding allocs can also be important for certain intrinsics,
  74     /// notably `expect`.
  75     locals: IndexVec<mir::Local, LocalRef<'tcx, Bx::Value>>,
  76
  77     /// All `VarDebuginfo` from the MIR body, partitioned by `Local`.
  78     /// This is `None` if no variable debuginfo/names are needed.
  79     per_local_var_debug_info: Option<IndexVec<mir::Local, Vec<&'tcx mir::VarDebugInfo<'tcx>>>>,
  80
  81     /// Caller location propagated if this function has `#[track_caller]`.
  82     caller_location: Option<OperandRef<'tcx, Bx::Value>>,
  83 }
  84
  85 impl<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>> FunctionCx<'a, 'tcx, Bx> {
  86     pub fn monomorphize<T>(&self, value: &T) -> T
  87     where
  88         T: TypeFoldable<'tcx>,
  89     {
  90         self.cx.tcx().subst_and_normalize_erasing_regions(
  91             self.instance.substs,
  92             ty::ParamEnv::reveal_all(),
  93             value,
  94         )
  95     }
  96 }
  97
  98 enum LocalRef<'tcx, V> {
  99     Place(PlaceRef<'tcx, V>),
 100     /// `UnsizedPlace(p)`: `p` itself is a thin pointer (indirect place).
 101     /// `*p` is the fat pointer that references the actual unsized place.
 102     /// Every time it is initialized, we have to reallocate the place
 103     /// and update the fat pointer. That's the reason why it is indirect.
 104     UnsizedPlace(PlaceRef<'tcx, V>),
 105     Operand(Option<OperandRef<'tcx, V>>),
 106 }
 107
 108 impl<'a, 'tcx, V: CodegenObject> LocalRef<'tcx, V> {
 109     fn new_operand<Bx: BuilderMethods<'a, 'tcx, Value = V>>(
 110         bx: &mut Bx,
 111         layout: TyLayout<'tcx>,
 112     ) -> LocalRef<'tcx, V> {
 113         if layout.is_zst() {
 114             // Zero-size temporaries aren't always initialized, which
 115             // doesn't matter because they don't contain data, but
 116             // we need something in the operand.
 117             LocalRef::Operand(Some(OperandRef::new_zst(bx, layout)))
 118         } else {
 119             LocalRef::Operand(None)
 120         }
 121     }
 122 }
 123
 124 ///////////////////////////////////////////////////////////////////////////
 125
 126 pub fn codegen_mir<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 127     cx: &'a Bx::CodegenCx,
 128     instance: Instance<'tcx>,
 129 ) {
 130     assert!(!instance.substs.needs_infer());
 131
 132     let llfn = cx.get_fn(instance);
 133
 134     let mir = cx.tcx().instance_mir(instance.def);
 135
 136     let fn_abi = FnAbi::of_instance(cx, instance, &[]);
 137     debug!("fn_abi: {:?}", fn_abi);
 138
 139     let debug_context = cx.create_function_debug_context(instance, &fn_abi, llfn, &mir);
 140
 141     let mut bx = Bx::new_block(cx, llfn, "start");
 142
 143     if mir.basic_blocks().iter().any(|bb| bb.is_cleanup) {
 144         bx.set_personality_fn(cx.eh_personality());
 145     }
 146
 147     bx.sideeffect();
 148
 149     let cleanup_kinds = analyze::cleanup_kinds(&mir);
 150     // Allocate a `Block` for every basic block, except
 151     // the start block, if nothing loops back to it.
 152     let reentrant_start_block = !mir.predecessors_for(mir::START_BLOCK).is_empty();
 153     let block_bxs: IndexVec<mir::BasicBlock, Bx::BasicBlock> = mir
 154         .basic_blocks()
 155         .indices()
 156         .map(|bb| {
 157             if bb == mir::START_BLOCK && !reentrant_start_block {
 158                 bx.llbb()
 159             } else {
 160                 bx.build_sibling_block(&format!("{:?}", bb)).llbb()
 161             }
 162         })
 163         .collect();
 164
 165     let (landing_pads, funclets) = create_funclets(&mir, &mut bx, &cleanup_kinds, &block_bxs);
 166     let mir_body: &mir::Body<'_> = *mir;
 167     let mut fx = FunctionCx {
 168         instance,
 169         mir,
 170         llfn,
 171         fn_abi,
 172         cx,
 173         personality_slot: None,
 174         blocks: block_bxs,
 175         unreachable_block: None,
 176         cleanup_kinds,
 177         landing_pads,
 178         funclets,
 179         locals: IndexVec::new(),
 180         debug_context,
 181         per_local_var_debug_info: debuginfo::per_local_var_debug_info(cx.tcx(), mir_body),
 182         caller_location: None,
 183     };
 184
 185     let memory_locals = analyze::non_ssa_locals(&fx);
 186
 187     // Allocate variable and temp allocas
 188     fx.locals = {
 189         let args = arg_local_refs(&mut bx, &mut fx, &memory_locals);
 190
 191         let mut allocate_local = |local| {
 192             let decl = &mir_body.local_decls[local];
 193             let layout = bx.layout_of(fx.monomorphize(&decl.ty));
 194             assert!(!layout.ty.has_erasable_regions());
 195
 196             if local == mir::RETURN_PLACE && fx.fn_abi.ret.is_indirect() {
 197                 debug!("alloc: {:?} (return place) -> place", local);
 198                 let llretptr = bx.get_param(0);
 199                 return LocalRef::Place(PlaceRef::new_sized(llretptr, layout));
 200             }
 201
 202             if memory_locals.contains(local) {
 203                 debug!("alloc: {:?} -> place", local);
 204                 if layout.is_unsized() {
 205                     LocalRef::UnsizedPlace(PlaceRef::alloca_unsized_indirect(&mut bx, layout))
 206                 } else {
 207                     LocalRef::Place(PlaceRef::alloca(&mut bx, layout))
 208                 }
 209             } else {
 210                 debug!("alloc: {:?} -> operand", local);
 211                 LocalRef::new_operand(&mut bx, layout)
 212             }
 213         };
 214
 215         let retptr = allocate_local(mir::RETURN_PLACE);
 216         iter::once(retptr)
 217             .chain(args.into_iter())
 218             .chain(mir_body.vars_and_temps_iter().map(allocate_local))
 219             .collect()
 220     };
 221
 222     // Apply debuginfo to the newly allocated locals.
 223     fx.debug_introduce_locals(&mut bx);
 224
 225     // Branch to the START block, if it's not the entry block.
 226     if reentrant_start_block {
 227         bx.br(fx.blocks[mir::START_BLOCK]);
 228     }
 229
 230     // Up until here, IR instructions for this function have explicitly not been annotated with
 231     // source code location, so we don't step into call setup code. From here on, source location
 232     // emitting should be enabled.
 233     if let Some(debug_context) = &mut fx.debug_context {
 234         debug_context.source_locations_enabled = true;
 235     }
 236
 237     let rpo = traversal::reverse_postorder(&mir_body);
 238     let mut visited = BitSet::new_empty(mir_body.basic_blocks().len());
 239
 240     // Codegen the body of each block using reverse postorder
 241     for (bb, _) in rpo {
 242         visited.insert(bb.index());
 243         fx.codegen_block(bb);
 244     }
 245
 246     // Remove blocks that haven't been visited, or have no
 247     // predecessors.
 248     for bb in mir_body.basic_blocks().indices() {
 249         // Unreachable block
 250         if !visited.contains(bb.index()) {
 251             debug!("codegen_mir: block {:?} was not visited", bb);
 252             unsafe {
 253                 bx.delete_basic_block(fx.blocks[bb]);
 254             }
 255         }
 256     }
 257 }
 258
 259 fn create_funclets<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 260     mir: &'tcx mir::Body<'tcx>,
 261     bx: &mut Bx,
 262     cleanup_kinds: &IndexVec<mir::BasicBlock, CleanupKind>,
 263     block_bxs: &IndexVec<mir::BasicBlock, Bx::BasicBlock>,
 264 ) -> (
 265     IndexVec<mir::BasicBlock, Option<Bx::BasicBlock>>,
 266     IndexVec<mir::BasicBlock, Option<Bx::Funclet>>,
 267 ) {
 268     block_bxs
 269         .iter_enumerated()
 270         .zip(cleanup_kinds)
 271         .map(|((bb, &llbb), cleanup_kind)| {
 272             match *cleanup_kind {
 273                 CleanupKind::Funclet if base::wants_msvc_seh(bx.sess()) => {}
 274                 _ => return (None, None),
 275             }
 276
 277             let funclet;
 278             let ret_llbb;
 279             match mir[bb].terminator.as_ref().map(|t| &t.kind) {
 280                 // This is a basic block that we're aborting the program for,
 281                 // notably in an `extern` function. These basic blocks are inserted
 282                 // so that we assert that `extern` functions do indeed not panic,
 283                 // and if they do we abort the process.
 284                 //
 285                 // On MSVC these are tricky though (where we're doing funclets). If
 286                 // we were to do a cleanuppad (like below) the normal functions like
 287                 // `longjmp` would trigger the abort logic, terminating the
 288                 // program. Instead we insert the equivalent of `catch(...)` for C++
 289                 // which magically doesn't trigger when `longjmp` files over this
 290                 // frame.
 291                 //
 292                 // Lots more discussion can be found on #48251 but this codegen is
 293                 // modeled after clang's for:
 294                 //
 295                 //      try {
 296                 //          foo();
 297                 //      } catch (...) {
 298                 //          bar();
 299                 //      }
 300                 Some(&mir::TerminatorKind::Abort) => {
 301                     let mut cs_bx = bx.build_sibling_block(&format!("cs_funclet{:?}", bb));
 302                     let mut cp_bx = bx.build_sibling_block(&format!("cp_funclet{:?}", bb));
 303                     ret_llbb = cs_bx.llbb();
 304
 305                     let cs = cs_bx.catch_switch(None, None, 1);
 306                     cs_bx.add_handler(cs, cp_bx.llbb());
 307
 308                     // The "null" here is actually a RTTI type descriptor for the
 309                     // C++ personality function, but `catch (...)` has no type so
 310                     // it's null. The 64 here is actually a bitfield which
 311                     // represents that this is a catch-all block.
 312                     let null = bx.const_null(bx.type_i8p());
 313                     let sixty_four = bx.const_i32(64);
 314                     funclet = cp_bx.catch_pad(cs, &[null, sixty_four, null]);
 315                     cp_bx.br(llbb);
 316                 }
 317                 _ => {
 318                     let mut cleanup_bx = bx.build_sibling_block(&format!("funclet_{:?}", bb));
 319                     ret_llbb = cleanup_bx.llbb();
 320                     funclet = cleanup_bx.cleanup_pad(None, &[]);
 321                     cleanup_bx.br(llbb);
 322                 }
 323             };
 324
 325             (Some(ret_llbb), Some(funclet))
 326         })
 327         .unzip()
 328 }
 329
 330 /// Produces, for each argument, a `Value` pointing at the
 331 /// argument's value. As arguments are places, these are always
 332 /// indirect.
 333 fn arg_local_refs<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 334     bx: &mut Bx,
 335     fx: &mut FunctionCx<'a, 'tcx, Bx>,
 336     memory_locals: &BitSet<mir::Local>,
 337 ) -> Vec<LocalRef<'tcx, Bx::Value>> {
 338     let mir = fx.mir;
 339     let mut idx = 0;
 340     let mut llarg_idx = fx.fn_abi.ret.is_indirect() as usize;
 341
 342     let args = mir
 343         .args_iter()
 344         .enumerate()
 345         .map(|(arg_index, local)| {
 346             let arg_decl = &mir.local_decls[local];
 347
 348             if Some(local) == mir.spread_arg {
 349                 // This argument (e.g., the last argument in the "rust-call" ABI)
 350                 // is a tuple that was spread at the ABI level and now we have
 351                 // to reconstruct it into a tuple local variable, from multiple
 352                 // individual LLVM function arguments.
 353
 354                 let arg_ty = fx.monomorphize(&arg_decl.ty);
 355                 let tupled_arg_tys = match arg_ty.kind {
 356                     ty::Tuple(ref tys) => tys,
 357                     _ => bug!("spread argument isn't a tuple?!"),
 358                 };
 359
 360                 let place = PlaceRef::alloca(bx, bx.layout_of(arg_ty));
 361                 for i in 0..tupled_arg_tys.len() {
 362                     let arg = &fx.fn_abi.args[idx];
 363                     idx += 1;
 364                     if arg.pad.is_some() {
 365                         llarg_idx += 1;
 366                     }
 367                     let pr_field = place.project_field(bx, i);
 368                     bx.store_fn_arg(arg, &mut llarg_idx, pr_field);
 369                 }
 370
 371                 return LocalRef::Place(place);
 372             }
 373
 374             if fx.fn_abi.c_variadic && arg_index == fx.fn_abi.args.len() {
 375                 let arg_ty = fx.monomorphize(&arg_decl.ty);
 376
 377                 let va_list = PlaceRef::alloca(bx, bx.layout_of(arg_ty));
 378                 bx.va_start(va_list.llval);
 379
 380                 return LocalRef::Place(va_list);
 381             }
 382
 383             let arg = &fx.fn_abi.args[idx];
 384             idx += 1;
 385             if arg.pad.is_some() {
 386                 llarg_idx += 1;
 387             }
 388
 389             if !memory_locals.contains(local) {
 390                 // We don't have to cast or keep the argument in the alloca.
 391                 // FIXME(eddyb): We should figure out how to use llvm.dbg.value instead
 392                 // of putting everything in allocas just so we can use llvm.dbg.declare.
 393                 let local = |op| LocalRef::Operand(Some(op));
 394                 match arg.mode {
 395                     PassMode::Ignore => {
 396                         return local(OperandRef::new_zst(bx, arg.layout));
 397                     }
 398                     PassMode::Direct(_) => {
 399                         let llarg = bx.get_param(llarg_idx);
 400                         llarg_idx += 1;
 401                         return local(OperandRef::from_immediate_or_packed_pair(
 402                             bx, llarg, arg.layout,
 403                         ));
 404                     }
 405                     PassMode::Pair(..) => {
 406                         let (a, b) = (bx.get_param(llarg_idx), bx.get_param(llarg_idx + 1));
 407                         llarg_idx += 2;
 408
 409                         return local(OperandRef {
 410                             val: OperandValue::Pair(a, b),
 411                             layout: arg.layout,
 412                         });
 413                     }
 414                     _ => {}
 415                 }
 416             }
 417
 418             if arg.is_sized_indirect() {
 419                 // Don't copy an indirect argument to an alloca, the caller
 420                 // already put it in a temporary alloca and gave it up.
 421                 // FIXME: lifetimes
 422                 let llarg = bx.get_param(llarg_idx);
 423                 llarg_idx += 1;
 424                 LocalRef::Place(PlaceRef::new_sized(llarg, arg.layout))
 425             } else if arg.is_unsized_indirect() {
 426                 // As the storage for the indirect argument lives during
 427                 // the whole function call, we just copy the fat pointer.
 428                 let llarg = bx.get_param(llarg_idx);
 429                 llarg_idx += 1;
 430                 let llextra = bx.get_param(llarg_idx);
 431                 llarg_idx += 1;
 432                 let indirect_operand = OperandValue::Pair(llarg, llextra);
 433
 434                 let tmp = PlaceRef::alloca_unsized_indirect(bx, arg.layout);
 435                 indirect_operand.store(bx, tmp);
 436                 LocalRef::UnsizedPlace(tmp)
 437             } else {
 438                 let tmp = PlaceRef::alloca(bx, arg.layout);
 439                 bx.store_fn_arg(arg, &mut llarg_idx, tmp);
 440                 LocalRef::Place(tmp)
 441             }
 442         })
 443         .collect::<Vec<_>>();
 444
 445     if fx.instance.def.requires_caller_location(bx.tcx()) {
 446         assert_eq!(
 447             fx.fn_abi.args.len(),
 448             args.len() + 1,
 449             "#[track_caller] fn's must have 1 more argument in their ABI than in their MIR",
 450         );
 451
 452         let arg = fx.fn_abi.args.last().unwrap();
 453         match arg.mode {
 454             PassMode::Direct(_) => (),
 455             _ => bug!("caller location must be PassMode::Direct, found {:?}", arg.mode),
 456         }
 457
 458         fx.caller_location = Some(OperandRef {
 459             val: OperandValue::Immediate(bx.get_param(llarg_idx)),
 460             layout: arg.layout,
 461         });
 462     }
 463
 464     args
 465 }
 466
 467 mod analyze;
 468 mod block;
 469 pub mod constant;
 470 pub mod debuginfo;
 471 pub mod operand;
 472 pub mod place;
 473 mod rvalue;
 474 mod statement;