compiler/rustc_codegen_cranelift/src/base.rs

   1 //! Codegen of a single function
   2
   3 use rustc_ast::InlineAsmOptions;
   4 use rustc_index::vec::IndexVec;
   5 use rustc_middle::ty::adjustment::PointerCast;
   6 use rustc_middle::ty::layout::FnAbiOf;
   7 use rustc_middle::ty::print::with_no_trimmed_paths;
   8
   9 use indexmap::IndexSet;
  10
  11 use crate::constant::ConstantCx;
  12 use crate::prelude::*;
  13 use crate::pretty_clif::CommentWriter;
  14
  15 pub(crate) fn codegen_fn<'tcx>(
  16     cx: &mut crate::CodegenCx<'tcx>,
  17     module: &mut dyn Module,
  18     instance: Instance<'tcx>,
  19 ) {
  20     let tcx = cx.tcx;
  21
  22     let _inst_guard =
  23         crate::PrintOnPanic(|| format!("{:?} {}", instance, tcx.symbol_name(instance).name));
  24     debug_assert!(!instance.substs.needs_infer());
  25
  26     let mir = tcx.instance_mir(instance.def);
  27     let _mir_guard = crate::PrintOnPanic(|| {
  28         let mut buf = Vec::new();
  29         with_no_trimmed_paths!({
  30             rustc_middle::mir::pretty::write_mir_fn(tcx, mir, &mut |_, _| Ok(()), &mut buf)
  31                 .unwrap();
  32         });
  33         String::from_utf8_lossy(&buf).into_owned()
  34     });
  35
  36     // Declare function
  37     let symbol_name = tcx.symbol_name(instance);
  38     let sig = get_function_sig(tcx, module.isa().triple(), instance);
  39     let func_id = module.declare_function(symbol_name.name, Linkage::Local, &sig).unwrap();
  40
  41     cx.cached_context.clear();
  42
  43     // Make the FunctionBuilder
  44     let mut func_ctx = FunctionBuilderContext::new();
  45     let mut func = std::mem::replace(&mut cx.cached_context.func, Function::new());
  46     func.name = ExternalName::user(0, func_id.as_u32());
  47     func.signature = sig;
  48     func.collect_debug_info();
  49
  50     let mut bcx = FunctionBuilder::new(&mut func, &mut func_ctx);
  51
  52     // Predefine blocks
  53     let start_block = bcx.create_block();
  54     let block_map: IndexVec<BasicBlock, Block> =
  55         (0..mir.basic_blocks().len()).map(|_| bcx.create_block()).collect();
  56
  57     // Make FunctionCx
  58     let target_config = module.target_config();
  59     let pointer_type = target_config.pointer_type();
  60     let clif_comments = crate::pretty_clif::CommentWriter::new(tcx, instance);
  61
  62     let mut fx = FunctionCx {
  63         cx,
  64         module,
  65         tcx,
  66         target_config,
  67         pointer_type,
  68         constants_cx: ConstantCx::new(),
  69
  70         instance,
  71         symbol_name,
  72         mir,
  73         fn_abi: Some(RevealAllLayoutCx(tcx).fn_abi_of_instance(instance, ty::List::empty())),
  74
  75         bcx,
  76         block_map,
  77         local_map: IndexVec::with_capacity(mir.local_decls.len()),
  78         caller_location: None, // set by `codegen_fn_prelude`
  79
  80         clif_comments,
  81         source_info_set: indexmap::IndexSet::new(),
  82         next_ssa_var: 0,
  83     };
  84
  85     let arg_uninhabited = fx
  86         .mir
  87         .args_iter()
  88         .any(|arg| fx.layout_of(fx.monomorphize(fx.mir.local_decls[arg].ty)).abi.is_uninhabited());
  89
  90     if !crate::constant::check_constants(&mut fx) {
  91         fx.bcx.append_block_params_for_function_params(fx.block_map[START_BLOCK]);
  92         fx.bcx.switch_to_block(fx.block_map[START_BLOCK]);
  93         crate::trap::trap_unreachable(&mut fx, "compilation should have been aborted");
  94     } else if arg_uninhabited {
  95         fx.bcx.append_block_params_for_function_params(fx.block_map[START_BLOCK]);
  96         fx.bcx.switch_to_block(fx.block_map[START_BLOCK]);
  97         fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
  98     } else {
  99         tcx.sess.time("codegen clif ir", || {
 100             tcx.sess
 101                 .time("codegen prelude", || crate::abi::codegen_fn_prelude(&mut fx, start_block));
 102             codegen_fn_content(&mut fx);
 103         });
 104     }
 105
 106     // Recover all necessary data from fx, before accessing func will prevent future access to it.
 107     let instance = fx.instance;
 108     let clif_comments = fx.clif_comments;
 109     let source_info_set = fx.source_info_set;
 110     let local_map = fx.local_map;
 111
 112     fx.constants_cx.finalize(fx.tcx, &mut *fx.module);
 113
 114     crate::pretty_clif::write_clif_file(
 115         tcx,
 116         "unopt",
 117         module.isa(),
 118         instance,
 119         &func,
 120         &clif_comments,
 121     );
 122
 123     // Verify function
 124     verify_func(tcx, &clif_comments, &func);
 125
 126     compile_fn(
 127         cx,
 128         module,
 129         instance,
 130         symbol_name.name,
 131         func_id,
 132         func,
 133         clif_comments,
 134         source_info_set,
 135         local_map,
 136     );
 137 }
 138
 139 fn compile_fn<'tcx>(
 140     cx: &mut crate::CodegenCx<'tcx>,
 141     module: &mut dyn Module,
 142     instance: Instance<'tcx>,
 143     symbol_name: &str,
 144     func_id: FuncId,
 145     func: Function,
 146     mut clif_comments: CommentWriter,
 147     source_info_set: IndexSet<SourceInfo>,
 148     local_map: IndexVec<mir::Local, CPlace<'tcx>>,
 149 ) {
 150     let tcx = cx.tcx;
 151
 152     // Store function in context
 153     let context = &mut cx.cached_context;
 154     context.clear();
 155     context.func = func;
 156
 157     // If the return block is not reachable, then the SSA builder may have inserted an `iconst.i128`
 158     // instruction, which doesn't have an encoding.
 159     context.compute_cfg();
 160     context.compute_domtree();
 161     context.eliminate_unreachable_code(module.isa()).unwrap();
 162     context.dce(module.isa()).unwrap();
 163     // Some Cranelift optimizations expect the domtree to not yet be computed and as such don't
 164     // invalidate it when it would change.
 165     context.domtree.clear();
 166
 167     // Perform rust specific optimizations
 168     tcx.sess.time("optimize clif ir", || {
 169         crate::optimize::optimize_function(
 170             tcx,
 171             module.isa(),
 172             instance,
 173             context,
 174             &mut clif_comments,
 175         );
 176     });
 177
 178     // Define function
 179     tcx.sess.time("define function", || {
 180         context.want_disasm = crate::pretty_clif::should_write_ir(tcx);
 181         module.define_function(func_id, context).unwrap()
 182     });
 183
 184     // Write optimized function to file for debugging
 185     crate::pretty_clif::write_clif_file(
 186         tcx,
 187         "opt",
 188         module.isa(),
 189         instance,
 190         &context.func,
 191         &clif_comments,
 192     );
 193
 194     if let Some(disasm) = &context.mach_compile_result.as_ref().unwrap().disasm {
 195         crate::pretty_clif::write_ir_file(
 196             tcx,
 197             || format!("{}.vcode", tcx.symbol_name(instance).name),
 198             |file| file.write_all(disasm.as_bytes()),
 199         )
 200     }
 201
 202     // Define debuginfo for function
 203     let isa = module.isa();
 204     let debug_context = &mut cx.debug_context;
 205     let unwind_context = &mut cx.unwind_context;
 206     tcx.sess.time("generate debug info", || {
 207         if let Some(debug_context) = debug_context {
 208             debug_context.define_function(
 209                 instance,
 210                 func_id,
 211                 symbol_name,
 212                 isa,
 213                 context,
 214                 &source_info_set,
 215                 local_map,
 216             );
 217         }
 218         unwind_context.add_function(func_id, &context, isa);
 219     });
 220 }
 221
 222 pub(crate) fn verify_func(
 223     tcx: TyCtxt<'_>,
 224     writer: &crate::pretty_clif::CommentWriter,
 225     func: &Function,
 226 ) {
 227     tcx.sess.time("verify clif ir", || {
 228         let flags = cranelift_codegen::settings::Flags::new(cranelift_codegen::settings::builder());
 229         match cranelift_codegen::verify_function(&func, &flags) {
 230             Ok(_) => {}
 231             Err(err) => {
 232                 tcx.sess.err(&format!("{:?}", err));
 233                 let pretty_error = cranelift_codegen::print_errors::pretty_verifier_error(
 234                     &func,
 235                     Some(Box::new(writer)),
 236                     err,
 237                 );
 238                 tcx.sess.fatal(&format!("cranelift verify error:\n{}", pretty_error));
 239             }
 240         }
 241     });
 242 }
 243
 244 fn codegen_fn_content(fx: &mut FunctionCx<'_, '_, '_>) {
 245     for (bb, bb_data) in fx.mir.basic_blocks().iter_enumerated() {
 246         let block = fx.get_block(bb);
 247         fx.bcx.switch_to_block(block);
 248
 249         if bb_data.is_cleanup {
 250             // Unwinding after panicking is not supported
 251             continue;
 252
 253             // FIXME Once unwinding is supported and Cranelift supports marking blocks as cold, do
 254             // so for cleanup blocks.
 255         }
 256
 257         fx.bcx.ins().nop();
 258         for stmt in &bb_data.statements {
 259             fx.set_debug_loc(stmt.source_info);
 260             codegen_stmt(fx, block, stmt);
 261         }
 262
 263         if fx.clif_comments.enabled() {
 264             let mut terminator_head = "\n".to_string();
 265             with_no_trimmed_paths!({
 266                 bb_data.terminator().kind.fmt_head(&mut terminator_head).unwrap();
 267             });
 268             let inst = fx.bcx.func.layout.last_inst(block).unwrap();
 269             fx.add_comment(inst, terminator_head);
 270         }
 271
 272         let source_info = bb_data.terminator().source_info;
 273         fx.set_debug_loc(source_info);
 274
 275         match &bb_data.terminator().kind {
 276             TerminatorKind::Goto { target } => {
 277                 if let TerminatorKind::Return = fx.mir[*target].terminator().kind {
 278                     let mut can_immediately_return = true;
 279                     for stmt in &fx.mir[*target].statements {
 280                         if let StatementKind::StorageDead(_) = stmt.kind {
 281                         } else {
 282                             // FIXME Can sometimes happen, see rust-lang/rust#70531
 283                             can_immediately_return = false;
 284                             break;
 285                         }
 286                     }
 287
 288                     if can_immediately_return {
 289                         crate::abi::codegen_return(fx);
 290                         continue;
 291                     }
 292                 }
 293
 294                 let block = fx.get_block(*target);
 295                 fx.bcx.ins().jump(block, &[]);
 296             }
 297             TerminatorKind::Return => {
 298                 crate::abi::codegen_return(fx);
 299             }
 300             TerminatorKind::Assert { cond, expected, msg, target, cleanup: _ } => {
 301                 if !fx.tcx.sess.overflow_checks() {
 302                     if let mir::AssertKind::OverflowNeg(_) = *msg {
 303                         let target = fx.get_block(*target);
 304                         fx.bcx.ins().jump(target, &[]);
 305                         continue;
 306                     }
 307                 }
 308                 let cond = codegen_operand(fx, cond).load_scalar(fx);
 309
 310                 let target = fx.get_block(*target);
 311                 let failure = fx.bcx.create_block();
 312                 fx.bcx.set_cold_block(failure);
 313
 314                 if *expected {
 315                     fx.bcx.ins().brz(cond, failure, &[]);
 316                 } else {
 317                     fx.bcx.ins().brnz(cond, failure, &[]);
 318                 };
 319                 fx.bcx.ins().jump(target, &[]);
 320
 321                 fx.bcx.switch_to_block(failure);
 322                 fx.bcx.ins().nop();
 323
 324                 match msg {
 325                     AssertKind::BoundsCheck { ref len, ref index } => {
 326                         let len = codegen_operand(fx, len).load_scalar(fx);
 327                         let index = codegen_operand(fx, index).load_scalar(fx);
 328                         let location = fx.get_caller_location(source_info).load_scalar(fx);
 329
 330                         codegen_panic_inner(
 331                             fx,
 332                             rustc_hir::LangItem::PanicBoundsCheck,
 333                             &[index, len, location],
 334                             source_info.span,
 335                         );
 336                     }
 337                     _ => {
 338                         let msg_str = msg.description();
 339                         codegen_panic(fx, msg_str, source_info);
 340                     }
 341                 }
 342             }
 343
 344             TerminatorKind::SwitchInt { discr, switch_ty, targets } => {
 345                 let discr = codegen_operand(fx, discr).load_scalar(fx);
 346
 347                 let use_bool_opt = switch_ty.kind() == fx.tcx.types.bool.kind()
 348                     || (targets.iter().count() == 1 && targets.iter().next().unwrap().0 == 0);
 349                 if use_bool_opt {
 350                     assert_eq!(targets.iter().count(), 1);
 351                     let (then_value, then_block) = targets.iter().next().unwrap();
 352                     let then_block = fx.get_block(then_block);
 353                     let else_block = fx.get_block(targets.otherwise());
 354                     let test_zero = match then_value {
 355                         0 => true,
 356                         1 => false,
 357                         _ => unreachable!("{:?}", targets),
 358                     };
 359
 360                     let discr = crate::optimize::peephole::maybe_unwrap_bint(&mut fx.bcx, discr);
 361                     let (discr, is_inverted) =
 362                         crate::optimize::peephole::maybe_unwrap_bool_not(&mut fx.bcx, discr);
 363                     let test_zero = if is_inverted { !test_zero } else { test_zero };
 364                     let discr = crate::optimize::peephole::maybe_unwrap_bint(&mut fx.bcx, discr);
 365                     if let Some(taken) = crate::optimize::peephole::maybe_known_branch_taken(
 366                         &fx.bcx, discr, test_zero,
 367                     ) {
 368                         if taken {
 369                             fx.bcx.ins().jump(then_block, &[]);
 370                         } else {
 371                             fx.bcx.ins().jump(else_block, &[]);
 372                         }
 373                     } else {
 374                         if test_zero {
 375                             fx.bcx.ins().brz(discr, then_block, &[]);
 376                             fx.bcx.ins().jump(else_block, &[]);
 377                         } else {
 378                             fx.bcx.ins().brnz(discr, then_block, &[]);
 379                             fx.bcx.ins().jump(else_block, &[]);
 380                         }
 381                     }
 382                 } else {
 383                     let mut switch = ::cranelift_frontend::Switch::new();
 384                     for (value, block) in targets.iter() {
 385                         let block = fx.get_block(block);
 386                         switch.set_entry(value, block);
 387                     }
 388                     let otherwise_block = fx.get_block(targets.otherwise());
 389                     switch.emit(&mut fx.bcx, discr, otherwise_block);
 390                 }
 391             }
 392             TerminatorKind::Call {
 393                 func,
 394                 args,
 395                 destination,
 396                 target,
 397                 fn_span,
 398                 cleanup: _,
 399                 from_hir_call: _,
 400             } => {
 401                 fx.tcx.sess.time("codegen call", || {
 402                     crate::abi::codegen_terminator_call(
 403                         fx,
 404                         mir::SourceInfo { span: *fn_span, ..source_info },
 405                         func,
 406                         args,
 407                         *destination,
 408                         *target,
 409                     )
 410                 });
 411             }
 412             TerminatorKind::InlineAsm {
 413                 template,
 414                 operands,
 415                 options,
 416                 destination,
 417                 line_spans: _,
 418                 cleanup: _,
 419             } => {
 420                 if options.contains(InlineAsmOptions::MAY_UNWIND) {
 421                     fx.tcx.sess.span_fatal(
 422                         source_info.span,
 423                         "cranelift doesn't support unwinding from inline assembly.",
 424                     );
 425                 }
 426
 427                 crate::inline_asm::codegen_inline_asm(
 428                     fx,
 429                     source_info.span,
 430                     template,
 431                     operands,
 432                     *options,
 433                 );
 434
 435                 match *destination {
 436                     Some(destination) => {
 437                         let destination_block = fx.get_block(destination);
 438                         fx.bcx.ins().jump(destination_block, &[]);
 439                     }
 440                     None => {
 441                         fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
 442                     }
 443                 }
 444             }
 445             TerminatorKind::Resume | TerminatorKind::Abort => {
 446                 // FIXME implement unwinding
 447                 fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
 448             }
 449             TerminatorKind::Unreachable => {
 450                 fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
 451             }
 452             TerminatorKind::Yield { .. }
 453             | TerminatorKind::FalseEdge { .. }
 454             | TerminatorKind::FalseUnwind { .. }
 455             | TerminatorKind::DropAndReplace { .. }
 456             | TerminatorKind::GeneratorDrop => {
 457                 bug!("shouldn't exist at codegen {:?}", bb_data.terminator());
 458             }
 459             TerminatorKind::Drop { place, target, unwind: _ } => {
 460                 let drop_place = codegen_place(fx, *place);
 461                 crate::abi::codegen_drop(fx, source_info, drop_place);
 462
 463                 let target_block = fx.get_block(*target);
 464                 fx.bcx.ins().jump(target_block, &[]);
 465             }
 466         };
 467     }
 468
 469     fx.bcx.seal_all_blocks();
 470     fx.bcx.finalize();
 471 }
 472
 473 fn codegen_stmt<'tcx>(
 474     fx: &mut FunctionCx<'_, '_, 'tcx>,
 475     #[allow(unused_variables)] cur_block: Block,
 476     stmt: &Statement<'tcx>,
 477 ) {
 478     let _print_guard = crate::PrintOnPanic(|| format!("stmt {:?}", stmt));
 479
 480     fx.set_debug_loc(stmt.source_info);
 481
 482     #[cfg(any())] // This is never true
 483     match &stmt.kind {
 484         StatementKind::StorageLive(..) | StatementKind::StorageDead(..) => {} // Those are not very useful
 485         _ => {
 486             if fx.clif_comments.enabled() {
 487                 let inst = fx.bcx.func.layout.last_inst(cur_block).unwrap();
 488                 fx.add_comment(inst, format!("{:?}", stmt));
 489             }
 490         }
 491     }
 492
 493     match &stmt.kind {
 494         StatementKind::SetDiscriminant { place, variant_index } => {
 495             let place = codegen_place(fx, **place);
 496             crate::discriminant::codegen_set_discriminant(fx, place, *variant_index);
 497         }
 498         StatementKind::Assign(to_place_and_rval) => {
 499             let lval = codegen_place(fx, to_place_and_rval.0);
 500             let dest_layout = lval.layout();
 501             match to_place_and_rval.1 {
 502                 Rvalue::Use(ref operand) => {
 503                     let val = codegen_operand(fx, operand);
 504                     lval.write_cvalue(fx, val);
 505                 }
 506                 Rvalue::Ref(_, _, place) | Rvalue::AddressOf(_, place) => {
 507                     let place = codegen_place(fx, place);
 508                     let ref_ = place.place_ref(fx, lval.layout());
 509                     lval.write_cvalue(fx, ref_);
 510                 }
 511                 Rvalue::ThreadLocalRef(def_id) => {
 512                     let val = crate::constant::codegen_tls_ref(fx, def_id, lval.layout());
 513                     lval.write_cvalue(fx, val);
 514                 }
 515                 Rvalue::BinaryOp(bin_op, ref lhs_rhs) => {
 516                     let lhs = codegen_operand(fx, &lhs_rhs.0);
 517                     let rhs = codegen_operand(fx, &lhs_rhs.1);
 518
 519                     let res = crate::num::codegen_binop(fx, bin_op, lhs, rhs);
 520                     lval.write_cvalue(fx, res);
 521                 }
 522                 Rvalue::CheckedBinaryOp(bin_op, ref lhs_rhs) => {
 523                     let lhs = codegen_operand(fx, &lhs_rhs.0);
 524                     let rhs = codegen_operand(fx, &lhs_rhs.1);
 525
 526                     let res = if !fx.tcx.sess.overflow_checks() {
 527                         let val =
 528                             crate::num::codegen_int_binop(fx, bin_op, lhs, rhs).load_scalar(fx);
 529                         let is_overflow = fx.bcx.ins().iconst(types::I8, 0);
 530                         CValue::by_val_pair(val, is_overflow, lval.layout())
 531                     } else {
 532                         crate::num::codegen_checked_int_binop(fx, bin_op, lhs, rhs)
 533                     };
 534
 535                     lval.write_cvalue(fx, res);
 536                 }
 537                 Rvalue::UnaryOp(un_op, ref operand) => {
 538                     let operand = codegen_operand(fx, operand);
 539                     let layout = operand.layout();
 540                     let val = operand.load_scalar(fx);
 541                     let res = match un_op {
 542                         UnOp::Not => match layout.ty.kind() {
 543                             ty::Bool => {
 544                                 let res = fx.bcx.ins().icmp_imm(IntCC::Equal, val, 0);
 545                                 CValue::by_val(fx.bcx.ins().bint(types::I8, res), layout)
 546                             }
 547                             ty::Uint(_) | ty::Int(_) => {
 548                                 CValue::by_val(fx.bcx.ins().bnot(val), layout)
 549                             }
 550                             _ => unreachable!("un op Not for {:?}", layout.ty),
 551                         },
 552                         UnOp::Neg => match layout.ty.kind() {
 553                             ty::Int(IntTy::I128) => {
 554                                 // FIXME remove this case once ineg.i128 works
 555                                 let zero =
 556                                     CValue::const_val(fx, layout, ty::ScalarInt::null(layout.size));
 557                                 crate::num::codegen_int_binop(fx, BinOp::Sub, zero, operand)
 558                             }
 559                             ty::Int(_) => CValue::by_val(fx.bcx.ins().ineg(val), layout),
 560                             ty::Float(_) => CValue::by_val(fx.bcx.ins().fneg(val), layout),
 561                             _ => unreachable!("un op Neg for {:?}", layout.ty),
 562                         },
 563                     };
 564                     lval.write_cvalue(fx, res);
 565                 }
 566                 Rvalue::Cast(
 567                     CastKind::Pointer(PointerCast::ReifyFnPointer),
 568                     ref operand,
 569                     to_ty,
 570                 ) => {
 571                     let from_ty = fx.monomorphize(operand.ty(&fx.mir.local_decls, fx.tcx));
 572                     let to_layout = fx.layout_of(fx.monomorphize(to_ty));
 573                     match *from_ty.kind() {
 574                         ty::FnDef(def_id, substs) => {
 575                             let func_ref = fx.get_function_ref(
 576                                 Instance::resolve_for_fn_ptr(
 577                                     fx.tcx,
 578                                     ParamEnv::reveal_all(),
 579                                     def_id,
 580                                     substs,
 581                                 )
 582                                 .unwrap()
 583                                 .polymorphize(fx.tcx),
 584                             );
 585                             let func_addr = fx.bcx.ins().func_addr(fx.pointer_type, func_ref);
 586                             lval.write_cvalue(fx, CValue::by_val(func_addr, to_layout));
 587                         }
 588                         _ => bug!("Trying to ReifyFnPointer on non FnDef {:?}", from_ty),
 589                     }
 590                 }
 591                 Rvalue::Cast(
 592                     CastKind::Pointer(PointerCast::UnsafeFnPointer),
 593                     ref operand,
 594                     to_ty,
 595                 )
 596                 | Rvalue::Cast(
 597                     CastKind::Pointer(PointerCast::MutToConstPointer),
 598                     ref operand,
 599                     to_ty,
 600                 )
 601                 | Rvalue::Cast(
 602                     CastKind::Pointer(PointerCast::ArrayToPointer),
 603                     ref operand,
 604                     to_ty,
 605                 ) => {
 606                     let to_layout = fx.layout_of(fx.monomorphize(to_ty));
 607                     let operand = codegen_operand(fx, operand);
 608                     lval.write_cvalue(fx, operand.cast_pointer_to(to_layout));
 609                 }
 610                 Rvalue::Cast(
 611                     CastKind::Misc | CastKind::PointerExposeAddress,
 612                     ref operand,
 613                     to_ty,
 614                 ) => {
 615                     let operand = codegen_operand(fx, operand);
 616                     let from_ty = operand.layout().ty;
 617                     let to_ty = fx.monomorphize(to_ty);
 618
 619                     fn is_fat_ptr<'tcx>(fx: &FunctionCx<'_, '_, 'tcx>, ty: Ty<'tcx>) -> bool {
 620                         ty.builtin_deref(true)
 621                             .map(|ty::TypeAndMut { ty: pointee_ty, mutbl: _ }| {
 622                                 has_ptr_meta(fx.tcx, pointee_ty)
 623                             })
 624                             .unwrap_or(false)
 625                     }
 626
 627                     if is_fat_ptr(fx, from_ty) {
 628                         if is_fat_ptr(fx, to_ty) {
 629                             // fat-ptr -> fat-ptr
 630                             lval.write_cvalue(fx, operand.cast_pointer_to(dest_layout));
 631                         } else {
 632                             // fat-ptr -> thin-ptr
 633                             let (ptr, _extra) = operand.load_scalar_pair(fx);
 634                             lval.write_cvalue(fx, CValue::by_val(ptr, dest_layout))
 635                         }
 636                     } else if let ty::Adt(adt_def, _substs) = from_ty.kind() {
 637                         // enum -> discriminant value
 638                         assert!(adt_def.is_enum());
 639                         match to_ty.kind() {
 640                             ty::Uint(_) | ty::Int(_) => {}
 641                             _ => unreachable!("cast adt {} -> {}", from_ty, to_ty),
 642                         }
 643                         let to_clif_ty = fx.clif_type(to_ty).unwrap();
 644
 645                         let discriminant = crate::discriminant::codegen_get_discriminant(
 646                             fx,
 647                             operand,
 648                             fx.layout_of(operand.layout().ty.discriminant_ty(fx.tcx)),
 649                         )
 650                         .load_scalar(fx);
 651
 652                         let res = crate::cast::clif_intcast(
 653                             fx,
 654                             discriminant,
 655                             to_clif_ty,
 656                             to_ty.is_signed(),
 657                         );
 658                         lval.write_cvalue(fx, CValue::by_val(res, dest_layout));
 659                     } else {
 660                         let to_clif_ty = fx.clif_type(to_ty).unwrap();
 661                         let from = operand.load_scalar(fx);
 662
 663                         let res = clif_int_or_float_cast(
 664                             fx,
 665                             from,
 666                             type_sign(from_ty),
 667                             to_clif_ty,
 668                             type_sign(to_ty),
 669                         );
 670                         lval.write_cvalue(fx, CValue::by_val(res, dest_layout));
 671                     }
 672                 }
 673                 Rvalue::Cast(
 674                     CastKind::Pointer(PointerCast::ClosureFnPointer(_)),
 675                     ref operand,
 676                     _to_ty,
 677                 ) => {
 678                     let operand = codegen_operand(fx, operand);
 679                     match *operand.layout().ty.kind() {
 680                         ty::Closure(def_id, substs) => {
 681                             let instance = Instance::resolve_closure(
 682                                 fx.tcx,
 683                                 def_id,
 684                                 substs,
 685                                 ty::ClosureKind::FnOnce,
 686                             )
 687                             .polymorphize(fx.tcx);
 688                             let func_ref = fx.get_function_ref(instance);
 689                             let func_addr = fx.bcx.ins().func_addr(fx.pointer_type, func_ref);
 690                             lval.write_cvalue(fx, CValue::by_val(func_addr, lval.layout()));
 691                         }
 692                         _ => bug!("{} cannot be cast to a fn ptr", operand.layout().ty),
 693                     }
 694                 }
 695                 Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), ref operand, _to_ty) => {
 696                     let operand = codegen_operand(fx, operand);
 697                     operand.unsize_value(fx, lval);
 698                 }
 699                 Rvalue::Discriminant(place) => {
 700                     let place = codegen_place(fx, place);
 701                     let value = place.to_cvalue(fx);
 702                     let discr =
 703                         crate::discriminant::codegen_get_discriminant(fx, value, dest_layout);
 704                     lval.write_cvalue(fx, discr);
 705                 }
 706                 Rvalue::Repeat(ref operand, times) => {
 707                     let operand = codegen_operand(fx, operand);
 708                     let times = fx
 709                         .monomorphize(times)
 710                         .eval(fx.tcx, ParamEnv::reveal_all())
 711                         .val()
 712                         .try_to_bits(fx.tcx.data_layout.pointer_size)
 713                         .unwrap();
 714                     if operand.layout().size.bytes() == 0 {
 715                         // Do nothing for ZST's
 716                     } else if fx.clif_type(operand.layout().ty) == Some(types::I8) {
 717                         let times = fx.bcx.ins().iconst(fx.pointer_type, times as i64);
 718                         // FIXME use emit_small_memset where possible
 719                         let addr = lval.to_ptr().get_addr(fx);
 720                         let val = operand.load_scalar(fx);
 721                         fx.bcx.call_memset(fx.target_config, addr, val, times);
 722                     } else {
 723                         let loop_block = fx.bcx.create_block();
 724                         let loop_block2 = fx.bcx.create_block();
 725                         let done_block = fx.bcx.create_block();
 726                         let index = fx.bcx.append_block_param(loop_block, fx.pointer_type);
 727                         let zero = fx.bcx.ins().iconst(fx.pointer_type, 0);
 728                         fx.bcx.ins().jump(loop_block, &[zero]);
 729
 730                         fx.bcx.switch_to_block(loop_block);
 731                         let done = fx.bcx.ins().icmp_imm(IntCC::Equal, index, times as i64);
 732                         fx.bcx.ins().brnz(done, done_block, &[]);
 733                         fx.bcx.ins().jump(loop_block2, &[]);
 734
 735                         fx.bcx.switch_to_block(loop_block2);
 736                         let to = lval.place_index(fx, index);
 737                         to.write_cvalue(fx, operand);
 738                         let index = fx.bcx.ins().iadd_imm(index, 1);
 739                         fx.bcx.ins().jump(loop_block, &[index]);
 740
 741                         fx.bcx.switch_to_block(done_block);
 742                         fx.bcx.ins().nop();
 743                     }
 744                 }
 745                 Rvalue::Len(place) => {
 746                     let place = codegen_place(fx, place);
 747                     let usize_layout = fx.layout_of(fx.tcx.types.usize);
 748                     let len = codegen_array_len(fx, place);
 749                     lval.write_cvalue(fx, CValue::by_val(len, usize_layout));
 750                 }
 751                 Rvalue::ShallowInitBox(ref operand, content_ty) => {
 752                     let content_ty = fx.monomorphize(content_ty);
 753                     let box_layout = fx.layout_of(fx.tcx.mk_box(content_ty));
 754                     let operand = codegen_operand(fx, operand);
 755                     let operand = operand.load_scalar(fx);
 756                     lval.write_cvalue(fx, CValue::by_val(operand, box_layout));
 757                 }
 758                 Rvalue::NullaryOp(null_op, ty) => {
 759                     assert!(
 760                         lval.layout()
 761                             .ty
 762                             .is_sized(fx.tcx.at(stmt.source_info.span), ParamEnv::reveal_all())
 763                     );
 764                     let layout = fx.layout_of(fx.monomorphize(ty));
 765                     let val = match null_op {
 766                         NullOp::SizeOf => layout.size.bytes(),
 767                         NullOp::AlignOf => layout.align.abi.bytes(),
 768                     };
 769                     let val = CValue::const_val(fx, fx.layout_of(fx.tcx.types.usize), val.into());
 770                     lval.write_cvalue(fx, val);
 771                 }
 772                 Rvalue::Aggregate(ref kind, ref operands) => match kind.as_ref() {
 773                     AggregateKind::Array(_ty) => {
 774                         for (i, operand) in operands.iter().enumerate() {
 775                             let operand = codegen_operand(fx, operand);
 776                             let index = fx.bcx.ins().iconst(fx.pointer_type, i as i64);
 777                             let to = lval.place_index(fx, index);
 778                             to.write_cvalue(fx, operand);
 779                         }
 780                     }
 781                     _ => unreachable!("shouldn't exist at codegen {:?}", to_place_and_rval.1),
 782                 },
 783             }
 784         }
 785         StatementKind::StorageLive(_)
 786         | StatementKind::StorageDead(_)
 787         | StatementKind::Deinit(_)
 788         | StatementKind::Nop
 789         | StatementKind::FakeRead(..)
 790         | StatementKind::Retag { .. }
 791         | StatementKind::AscribeUserType(..) => {}
 792
 793         StatementKind::Coverage { .. } => fx.tcx.sess.fatal("-Zcoverage is unimplemented"),
 794         StatementKind::CopyNonOverlapping(inner) => {
 795             let dst = codegen_operand(fx, &inner.dst);
 796             let pointee = dst
 797                 .layout()
 798                 .pointee_info_at(fx, rustc_target::abi::Size::ZERO)
 799                 .expect("Expected pointer");
 800             let dst = dst.load_scalar(fx);
 801             let src = codegen_operand(fx, &inner.src).load_scalar(fx);
 802             let count = codegen_operand(fx, &inner.count).load_scalar(fx);
 803             let elem_size: u64 = pointee.size.bytes();
 804             let bytes =
 805                 if elem_size != 1 { fx.bcx.ins().imul_imm(count, elem_size as i64) } else { count };
 806             fx.bcx.call_memcpy(fx.target_config, dst, src, bytes);
 807         }
 808     }
 809 }
 810
 811 fn codegen_array_len<'tcx>(fx: &mut FunctionCx<'_, '_, 'tcx>, place: CPlace<'tcx>) -> Value {
 812     match *place.layout().ty.kind() {
 813         ty::Array(_elem_ty, len) => {
 814             let len = fx.monomorphize(len).eval_usize(fx.tcx, ParamEnv::reveal_all()) as i64;
 815             fx.bcx.ins().iconst(fx.pointer_type, len)
 816         }
 817         ty::Slice(_elem_ty) => {
 818             place.to_ptr_maybe_unsized().1.expect("Length metadata for slice place")
 819         }
 820         _ => bug!("Rvalue::Len({:?})", place),
 821     }
 822 }
 823
 824 pub(crate) fn codegen_place<'tcx>(
 825     fx: &mut FunctionCx<'_, '_, 'tcx>,
 826     place: Place<'tcx>,
 827 ) -> CPlace<'tcx> {
 828     let mut cplace = fx.get_local_place(place.local);
 829
 830     for elem in place.projection {
 831         match elem {
 832             PlaceElem::Deref => {
 833                 if cplace.layout().ty.is_box() {
 834                     cplace = cplace
 835                         .place_field(fx, Field::new(0)) // Box<T> -> Unique<T>
 836                         .place_field(fx, Field::new(0)) // Unique<T> -> NonNull<T>
 837                         .place_field(fx, Field::new(0)) // NonNull<T> -> *mut T
 838                         .place_deref(fx);
 839                 } else {
 840                     cplace = cplace.place_deref(fx);
 841                 }
 842             }
 843             PlaceElem::Field(field, _ty) => {
 844                 cplace = cplace.place_field(fx, field);
 845             }
 846             PlaceElem::Index(local) => {
 847                 let index = fx.get_local_place(local).to_cvalue(fx).load_scalar(fx);
 848                 cplace = cplace.place_index(fx, index);
 849             }
 850             PlaceElem::ConstantIndex { offset, min_length: _, from_end } => {
 851                 let offset: u64 = offset;
 852                 let index = if !from_end {
 853                     fx.bcx.ins().iconst(fx.pointer_type, offset as i64)
 854                 } else {
 855                     let len = codegen_array_len(fx, cplace);
 856                     fx.bcx.ins().iadd_imm(len, -(offset as i64))
 857                 };
 858                 cplace = cplace.place_index(fx, index);
 859             }
 860             PlaceElem::Subslice { from, to, from_end } => {
 861                 // These indices are generated by slice patterns.
 862                 // slice[from:-to] in Python terms.
 863
 864                 let from: u64 = from;
 865                 let to: u64 = to;
 866
 867                 match cplace.layout().ty.kind() {
 868                     ty::Array(elem_ty, _len) => {
 869                         assert!(!from_end, "array subslices are never `from_end`");
 870                         let elem_layout = fx.layout_of(*elem_ty);
 871                         let ptr = cplace.to_ptr();
 872                         cplace = CPlace::for_ptr(
 873                             ptr.offset_i64(fx, elem_layout.size.bytes() as i64 * (from as i64)),
 874                             fx.layout_of(fx.tcx.mk_array(*elem_ty, to - from)),
 875                         );
 876                     }
 877                     ty::Slice(elem_ty) => {
 878                         assert!(from_end, "slice subslices should be `from_end`");
 879                         let elem_layout = fx.layout_of(*elem_ty);
 880                         let (ptr, len) = cplace.to_ptr_maybe_unsized();
 881                         let len = len.unwrap();
 882                         cplace = CPlace::for_ptr_with_extra(
 883                             ptr.offset_i64(fx, elem_layout.size.bytes() as i64 * (from as i64)),
 884                             fx.bcx.ins().iadd_imm(len, -(from as i64 + to as i64)),
 885                             cplace.layout(),
 886                         );
 887                     }
 888                     _ => unreachable!(),
 889                 }
 890             }
 891             PlaceElem::Downcast(_adt_def, variant) => {
 892                 cplace = cplace.downcast_variant(fx, variant);
 893             }
 894         }
 895     }
 896
 897     cplace
 898 }
 899
 900 pub(crate) fn codegen_operand<'tcx>(
 901     fx: &mut FunctionCx<'_, '_, 'tcx>,
 902     operand: &Operand<'tcx>,
 903 ) -> CValue<'tcx> {
 904     match operand {
 905         Operand::Move(place) | Operand::Copy(place) => {
 906             let cplace = codegen_place(fx, *place);
 907             cplace.to_cvalue(fx)
 908         }
 909         Operand::Constant(const_) => crate::constant::codegen_constant(fx, const_),
 910     }
 911 }
 912
 913 pub(crate) fn codegen_panic<'tcx>(
 914     fx: &mut FunctionCx<'_, '_, 'tcx>,
 915     msg_str: &str,
 916     source_info: mir::SourceInfo,
 917 ) {
 918     let location = fx.get_caller_location(source_info).load_scalar(fx);
 919
 920     let msg_ptr = fx.anonymous_str(msg_str);
 921     let msg_len = fx.bcx.ins().iconst(fx.pointer_type, i64::try_from(msg_str.len()).unwrap());
 922     let args = [msg_ptr, msg_len, location];
 923
 924     codegen_panic_inner(fx, rustc_hir::LangItem::Panic, &args, source_info.span);
 925 }
 926
 927 pub(crate) fn codegen_panic_inner<'tcx>(
 928     fx: &mut FunctionCx<'_, '_, 'tcx>,
 929     lang_item: rustc_hir::LangItem,
 930     args: &[Value],
 931     span: Span,
 932 ) {
 933     let def_id =
 934         fx.tcx.lang_items().require(lang_item).unwrap_or_else(|s| fx.tcx.sess.span_fatal(span, &s));
 935
 936     let instance = Instance::mono(fx.tcx, def_id).polymorphize(fx.tcx);
 937     let symbol_name = fx.tcx.symbol_name(instance).name;
 938
 939     fx.lib_call(
 940         &*symbol_name,
 941         vec![
 942             AbiParam::new(fx.pointer_type),
 943             AbiParam::new(fx.pointer_type),
 944             AbiParam::new(fx.pointer_type),
 945         ],
 946         vec![],
 947         args,
 948     );
 949
 950     fx.bcx.ins().trap(TrapCode::UnreachableCodeReached);
 951 }