1 //! Inlining pass for MIR functions
2 use crate::deref_separator::deref_finder;
3 use rustc_attr::InlineAttr;
4 use rustc_hir::def_id::DefId;
5 use rustc_index::bit_set::BitSet;
6 use rustc_index::vec::Idx;
7 use rustc_middle::middle::codegen_fn_attrs::{CodegenFnAttrFlags, CodegenFnAttrs};
8 use rustc_middle::mir::visit::*;
9 use rustc_middle::mir::*;
10 use rustc_middle::ty::{self, Instance, InstanceDef, ParamEnv, Ty, TyCtxt};
11 use rustc_session::config::OptLevel;
12 use rustc_span::{hygiene::ExpnKind, ExpnData, LocalExpnId, Span};
13 use rustc_target::abi::VariantIdx;
14 use rustc_target::spec::abi::Abi;
16 use crate::simplify::{remove_dead_blocks, CfgSimplifier};
20 use std::ops::{Range, RangeFrom};
24 const INSTR_COST: usize = 5;
25 const CALL_PENALTY: usize = 25;
26 const LANDINGPAD_PENALTY: usize = 50;
27 const RESUME_PENALTY: usize = 45;
29 const UNKNOWN_SIZE_COST: usize = 10;
31 const TOP_DOWN_DEPTH_LIMIT: usize = 5;
35 #[derive(Copy, Clone, Debug)]
36 struct CallSite<'tcx> {
37 callee: Instance<'tcx>,
38 fn_sig: ty::PolyFnSig<'tcx>,
40 target: Option<BasicBlock>,
41 source_info: SourceInfo,
44 impl<'tcx> MirPass<'tcx> for Inline {
45 fn is_enabled(&self, sess: &rustc_session::Session) -> bool {
46 if let Some(enabled) = sess.opts.unstable_opts.inline_mir {
50 match sess.mir_opt_level() {
53 (sess.opts.optimize == OptLevel::Default
54 || sess.opts.optimize == OptLevel::Aggressive)
55 && sess.opts.incremental == None
61 fn run_pass(&self, tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) {
62 let span = trace_span!("inline", body = %tcx.def_path_str(body.source.def_id()));
63 let _guard = span.enter();
64 if inline(tcx, body) {
65 debug!("running simplify cfg on {:?}", body.source);
66 CfgSimplifier::new(body).simplify();
67 remove_dead_blocks(tcx, body);
68 deref_finder(tcx, body);
73 fn inline<'tcx>(tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) -> bool {
74 let def_id = body.source.def_id().expect_local();
76 // Only do inlining into fn bodies.
77 if !tcx.hir().body_owner_kind(def_id).is_fn_or_closure() {
80 if body.source.promoted.is_some() {
83 // Avoid inlining into generators, since their `optimized_mir` is used for layout computation,
84 // which can create a cycle, even when no attempt is made to inline the function in the other
86 if body.generator.is_some() {
90 let param_env = tcx.param_env_reveal_all_normalized(def_id);
92 let mut this = Inliner {
95 codegen_fn_attrs: tcx.codegen_fn_attrs(def_id),
99 let blocks = BasicBlock::new(0)..body.basic_blocks.next_index();
100 this.process_blocks(body, blocks);
104 struct Inliner<'tcx> {
106 param_env: ParamEnv<'tcx>,
107 /// Caller codegen attributes.
108 codegen_fn_attrs: &'tcx CodegenFnAttrs,
109 /// Stack of inlined instances.
110 /// We only check the `DefId` and not the substs because we want to
111 /// avoid inlining cases of polymorphic recursion.
112 /// The number of `DefId`s is finite, so checking history is enough
113 /// to ensure that we do not loop endlessly while inlining.
115 /// Indicates that the caller body has been modified.
119 impl<'tcx> Inliner<'tcx> {
120 fn process_blocks(&mut self, caller_body: &mut Body<'tcx>, blocks: Range<BasicBlock>) {
121 // How many callsites in this body are we allowed to inline? We need to limit this in order
122 // to prevent super-linear growth in MIR size
123 let inline_limit = match self.history.len() {
125 1..=TOP_DOWN_DEPTH_LIMIT => 1,
128 let mut inlined_count = 0;
130 let bb_data = &caller_body[bb];
131 if bb_data.is_cleanup {
135 let Some(callsite) = self.resolve_callsite(caller_body, bb, bb_data) else {
139 let span = trace_span!("process_blocks", %callsite.callee, ?bb);
140 let _guard = span.enter();
142 match self.try_inlining(caller_body, &callsite) {
144 debug!("not-inlined {} [{}]", callsite.callee, reason);
148 debug!("inlined {}", callsite.callee);
151 if inlined_count == inline_limit {
154 self.history.push(callsite.callee.def_id());
155 self.process_blocks(caller_body, new_blocks);
162 /// Attempts to inline a callsite into the caller body. When successful returns basic blocks
163 /// containing the inlined body. Otherwise returns an error describing why inlining didn't take
167 caller_body: &mut Body<'tcx>,
168 callsite: &CallSite<'tcx>,
169 ) -> Result<std::ops::Range<BasicBlock>, &'static str> {
170 let callee_attrs = self.tcx.codegen_fn_attrs(callsite.callee.def_id());
171 self.check_codegen_attributes(callsite, callee_attrs)?;
172 self.check_mir_is_available(caller_body, &callsite.callee)?;
173 let callee_body = self.tcx.instance_mir(callsite.callee.def);
174 self.check_mir_body(callsite, callee_body, callee_attrs)?;
176 if !self.tcx.consider_optimizing(|| {
177 format!("Inline {:?} into {:?}", callsite.callee, caller_body.source)
179 return Err("optimization fuel exhausted");
182 let Ok(callee_body) = callsite.callee.try_subst_mir_and_normalize_erasing_regions(
187 return Err("failed to normalize callee body");
190 // Check call signature compatibility.
191 // Normally, this shouldn't be required, but trait normalization failure can create a
193 let terminator = caller_body[callsite.block].terminator.as_ref().unwrap();
194 let TerminatorKind::Call { args, destination, .. } = &terminator.kind else { bug!() };
195 let destination_ty = destination.ty(&caller_body.local_decls, self.tcx).ty;
196 let output_type = callee_body.return_ty();
197 if !util::is_subtype(self.tcx, self.param_env, output_type, destination_ty) {
198 trace!(?output_type, ?destination_ty);
199 return Err("failed to normalize return type");
201 if callsite.fn_sig.abi() == Abi::RustCall {
202 let (arg_tuple, skipped_args) = match &args[..] {
203 [arg_tuple] => (arg_tuple, 0),
204 [_, arg_tuple] => (arg_tuple, 1),
205 _ => bug!("Expected `rust-call` to have 1 or 2 args"),
208 let arg_tuple_ty = arg_tuple.ty(&caller_body.local_decls, self.tcx);
209 let ty::Tuple(arg_tuple_tys) = arg_tuple_ty.kind() else {
210 bug!("Closure arguments are not passed as a tuple");
213 for (arg_ty, input) in
214 arg_tuple_tys.iter().zip(callee_body.args_iter().skip(skipped_args))
216 let input_type = callee_body.local_decls[input].ty;
217 if !util::is_subtype(self.tcx, self.param_env, input_type, arg_ty) {
218 trace!(?arg_ty, ?input_type);
219 return Err("failed to normalize tuple argument type");
223 for (arg, input) in args.iter().zip(callee_body.args_iter()) {
224 let input_type = callee_body.local_decls[input].ty;
225 let arg_ty = arg.ty(&caller_body.local_decls, self.tcx);
226 if !util::is_subtype(self.tcx, self.param_env, input_type, arg_ty) {
227 trace!(?arg_ty, ?input_type);
228 return Err("failed to normalize argument type");
233 let old_blocks = caller_body.basic_blocks.next_index();
234 self.inline_call(caller_body, &callsite, callee_body);
235 let new_blocks = old_blocks..caller_body.basic_blocks.next_index();
240 fn check_mir_is_available(
242 caller_body: &Body<'tcx>,
243 callee: &Instance<'tcx>,
244 ) -> Result<(), &'static str> {
245 let caller_def_id = caller_body.source.def_id();
246 let callee_def_id = callee.def_id();
247 if callee_def_id == caller_def_id {
248 return Err("self-recursion");
252 InstanceDef::Item(_) => {
253 // If there is no MIR available (either because it was not in metadata or
254 // because it has no MIR because it's an extern function), then the inliner
255 // won't cause cycles on this.
256 if !self.tcx.is_mir_available(callee_def_id) {
257 return Err("item MIR unavailable");
260 // These have no own callable MIR.
261 InstanceDef::Intrinsic(_) | InstanceDef::Virtual(..) => {
262 return Err("instance without MIR (intrinsic / virtual)");
264 // This cannot result in an immediate cycle since the callee MIR is a shim, which does
265 // not get any optimizations run on it. Any subsequent inlining may cause cycles, but we
266 // do not need to catch this here, we can wait until the inliner decides to continue
267 // inlining a second time.
268 InstanceDef::VTableShim(_)
269 | InstanceDef::ReifyShim(_)
270 | InstanceDef::FnPtrShim(..)
271 | InstanceDef::ClosureOnceShim { .. }
272 | InstanceDef::DropGlue(..)
273 | InstanceDef::CloneShim(..) => return Ok(()),
276 if self.tcx.is_constructor(callee_def_id) {
277 trace!("constructors always have MIR");
278 // Constructor functions cannot cause a query cycle.
282 if callee_def_id.is_local() {
283 // Avoid a cycle here by only using `instance_mir` only if we have
284 // a lower `DefPathHash` than the callee. This ensures that the callee will
285 // not inline us. This trick even works with incremental compilation,
286 // since `DefPathHash` is stable.
287 if self.tcx.def_path_hash(caller_def_id).local_hash()
288 < self.tcx.def_path_hash(callee_def_id).local_hash()
293 // If we know for sure that the function we're calling will itself try to
294 // call us, then we avoid inlining that function.
295 if self.tcx.mir_callgraph_reachable((*callee, caller_def_id.expect_local())) {
296 return Err("caller might be reachable from callee (query cycle avoidance)");
301 // This cannot result in an immediate cycle since the callee MIR is from another crate
302 // and is already optimized. Any subsequent inlining may cause cycles, but we do
303 // not need to catch this here, we can wait until the inliner decides to continue
304 // inlining a second time.
305 trace!("functions from other crates always have MIR");
312 caller_body: &Body<'tcx>,
314 bb_data: &BasicBlockData<'tcx>,
315 ) -> Option<CallSite<'tcx>> {
316 // Only consider direct calls to functions
317 let terminator = bb_data.terminator();
318 if let TerminatorKind::Call { ref func, target, fn_span, .. } = terminator.kind {
319 let func_ty = func.ty(caller_body, self.tcx);
320 if let ty::FnDef(def_id, substs) = *func_ty.kind() {
321 // To resolve an instance its substs have to be fully normalized.
322 let substs = self.tcx.try_normalize_erasing_regions(self.param_env, substs).ok()?;
324 Instance::resolve(self.tcx, self.param_env, def_id, substs).ok().flatten()?;
326 if let InstanceDef::Virtual(..) | InstanceDef::Intrinsic(_) = callee.def {
330 if self.history.contains(&callee.def_id()) {
334 let fn_sig = self.tcx.bound_fn_sig(def_id).subst(self.tcx, substs);
335 let source_info = SourceInfo { span: fn_span, ..terminator.source_info };
337 return Some(CallSite { callee, fn_sig, block: bb, target, source_info });
344 /// Returns an error if inlining is not possible based on codegen attributes alone. A success
345 /// indicates that inlining decision should be based on other criteria.
346 fn check_codegen_attributes(
348 callsite: &CallSite<'tcx>,
349 callee_attrs: &CodegenFnAttrs,
350 ) -> Result<(), &'static str> {
351 match callee_attrs.inline {
352 InlineAttr::Never => return Err("never inline hint"),
353 InlineAttr::Always | InlineAttr::Hint => {}
354 InlineAttr::None => {
355 if self.tcx.sess.mir_opt_level() <= 2 {
356 return Err("at mir-opt-level=2, only #[inline] is inlined");
361 // Only inline local functions if they would be eligible for cross-crate
362 // inlining. This is to ensure that the final crate doesn't have MIR that
363 // reference unexported symbols
364 if callsite.callee.def_id().is_local() {
365 let is_generic = callsite.callee.substs.non_erasable_generics().next().is_some();
366 if !is_generic && !callee_attrs.requests_inline() {
367 return Err("not exported");
371 if callsite.fn_sig.c_variadic() {
372 return Err("C variadic");
375 if callee_attrs.flags.contains(CodegenFnAttrFlags::COLD) {
379 if callee_attrs.no_sanitize != self.codegen_fn_attrs.no_sanitize {
380 return Err("incompatible sanitizer set");
383 // Two functions are compatible if the callee has no attribute (meaning
384 // that it's codegen agnostic), or sets an attribute that is identical
385 // to this function's attribute.
386 if callee_attrs.instruction_set.is_some()
387 && callee_attrs.instruction_set != self.codegen_fn_attrs.instruction_set
389 return Err("incompatible instruction set");
392 for feature in &callee_attrs.target_features {
393 if !self.codegen_fn_attrs.target_features.contains(feature) {
394 return Err("incompatible target feature");
401 /// Returns inlining decision that is based on the examination of callee MIR body.
402 /// Assumes that codegen attributes have been checked for compatibility already.
403 #[instrument(level = "debug", skip(self, callee_body))]
406 callsite: &CallSite<'tcx>,
407 callee_body: &Body<'tcx>,
408 callee_attrs: &CodegenFnAttrs,
409 ) -> Result<(), &'static str> {
412 let mut threshold = if callee_attrs.requests_inline() {
413 self.tcx.sess.opts.unstable_opts.inline_mir_hint_threshold.unwrap_or(100)
415 self.tcx.sess.opts.unstable_opts.inline_mir_threshold.unwrap_or(50)
418 // Give a bonus functions with a small number of blocks,
419 // We normally have two or three blocks for even
420 // very small functions.
421 if callee_body.basic_blocks.len() <= 3 {
422 threshold += threshold / 4;
424 debug!(" final inline threshold = {}", threshold);
426 // FIXME: Give a bonus to functions with only a single caller
427 let diverges = matches!(
428 callee_body.basic_blocks[START_BLOCK].terminator().kind,
429 TerminatorKind::Unreachable | TerminatorKind::Call { target: None, .. }
431 if diverges && !matches!(callee_attrs.inline, InlineAttr::Always) {
432 return Err("callee diverges unconditionally");
435 let mut checker = CostChecker {
437 param_env: self.param_env,
438 instance: callsite.callee,
444 // Traverse the MIR manually so we can account for the effects of inlining on the CFG.
445 let mut work_list = vec![START_BLOCK];
446 let mut visited = BitSet::new_empty(callee_body.basic_blocks.len());
447 while let Some(bb) = work_list.pop() {
448 if !visited.insert(bb.index()) {
452 let blk = &callee_body.basic_blocks[bb];
453 checker.visit_basic_block_data(bb, blk);
455 let term = blk.terminator();
456 if let TerminatorKind::Drop { ref place, target, unwind }
457 | TerminatorKind::DropAndReplace { ref place, target, unwind, .. } = term.kind
459 work_list.push(target);
461 // If the place doesn't actually need dropping, treat it like a regular goto.
462 let ty = callsite.callee.subst_mir(self.tcx, &place.ty(callee_body, tcx).ty);
463 if ty.needs_drop(tcx, self.param_env) && let Some(unwind) = unwind {
464 work_list.push(unwind);
466 } else if callee_attrs.instruction_set != self.codegen_fn_attrs.instruction_set
467 && matches!(term.kind, TerminatorKind::InlineAsm { .. })
469 // During the attribute checking stage we allow a callee with no
470 // instruction_set assigned to count as compatible with a function that does
471 // assign one. However, during this stage we require an exact match when any
472 // inline-asm is detected. LLVM will still possibly do an inline later on
473 // if the no-attribute function ends up with the same instruction set anyway.
474 return Err("Cannot move inline-asm across instruction sets");
476 work_list.extend(term.successors())
480 // Count up the cost of local variables and temps, if we know the size
481 // use that, otherwise we use a moderately-large dummy cost.
482 for v in callee_body.vars_and_temps_iter() {
483 checker.visit_local_decl(v, &callee_body.local_decls[v]);
486 // Abort if type validation found anything fishy.
489 let cost = checker.cost;
490 if let InlineAttr::Always = callee_attrs.inline {
491 debug!("INLINING {:?} because inline(always) [cost={}]", callsite, cost);
493 } else if cost <= threshold {
494 debug!("INLINING {:?} [cost={} <= threshold={}]", callsite, cost, threshold);
497 debug!("NOT inlining {:?} [cost={} > threshold={}]", callsite, cost, threshold);
498 Err("cost above threshold")
504 caller_body: &mut Body<'tcx>,
505 callsite: &CallSite<'tcx>,
506 mut callee_body: Body<'tcx>,
508 let terminator = caller_body[callsite.block].terminator.take().unwrap();
509 match terminator.kind {
510 TerminatorKind::Call { args, destination, cleanup, .. } => {
511 // If the call is something like `a[*i] = f(i)`, where
512 // `i : &mut usize`, then just duplicating the `a[*i]`
513 // Place could result in two different locations if `f`
514 // writes to `i`. To prevent this we need to create a temporary
515 // borrow of the place and pass the destination as `*temp` instead.
516 fn dest_needs_borrow(place: Place<'_>) -> bool {
517 for elem in place.projection.iter() {
519 ProjectionElem::Deref | ProjectionElem::Index(_) => return true,
527 let dest = if dest_needs_borrow(destination) {
528 trace!("creating temp for return destination");
529 let dest = Rvalue::Ref(
530 self.tcx.lifetimes.re_erased,
531 BorrowKind::Mut { allow_two_phase_borrow: false },
534 let dest_ty = dest.ty(caller_body, self.tcx);
535 let temp = Place::from(self.new_call_temp(caller_body, &callsite, dest_ty));
536 caller_body[callsite.block].statements.push(Statement {
537 source_info: callsite.source_info,
538 kind: StatementKind::Assign(Box::new((temp, dest))),
540 self.tcx.mk_place_deref(temp)
545 // Copy the arguments if needed.
546 let args: Vec<_> = self.make_call_args(args, &callsite, caller_body, &callee_body);
548 let mut expn_data = ExpnData::default(
550 callsite.source_info.span,
551 self.tcx.sess.edition(),
555 expn_data.def_site = callee_body.span;
557 self.tcx.with_stable_hashing_context(|hcx| LocalExpnId::fresh(expn_data, hcx));
558 let mut integrator = Integrator {
560 new_locals: Local::new(caller_body.local_decls.len())..,
561 new_scopes: SourceScope::new(caller_body.source_scopes.len())..,
562 new_blocks: BasicBlock::new(caller_body.basic_blocks.len())..,
564 callsite_scope: caller_body.source_scopes[callsite.source_info.scope].clone(),
566 cleanup_block: cleanup,
567 in_cleanup_block: false,
570 always_live_locals: BitSet::new_filled(callee_body.local_decls.len()),
573 // Map all `Local`s, `SourceScope`s and `BasicBlock`s to new ones
574 // (or existing ones, in a few special cases) in the caller.
575 integrator.visit_body(&mut callee_body);
577 // If there are any locals without storage markers, give them storage only for the
578 // duration of the call.
579 for local in callee_body.vars_and_temps_iter() {
580 if !callee_body.local_decls[local].internal
581 && integrator.always_live_locals.contains(local)
583 let new_local = integrator.map_local(local);
584 caller_body[callsite.block].statements.push(Statement {
585 source_info: callsite.source_info,
586 kind: StatementKind::StorageLive(new_local),
590 if let Some(block) = callsite.target {
591 // To avoid repeated O(n) insert, push any new statements to the end and rotate
594 for local in callee_body.vars_and_temps_iter().rev() {
595 if !callee_body.local_decls[local].internal
596 && integrator.always_live_locals.contains(local)
598 let new_local = integrator.map_local(local);
599 caller_body[block].statements.push(Statement {
600 source_info: callsite.source_info,
601 kind: StatementKind::StorageDead(new_local),
606 caller_body[block].statements.rotate_right(n);
609 // Insert all of the (mapped) parts of the callee body into the caller.
610 caller_body.local_decls.extend(callee_body.drain_vars_and_temps());
611 caller_body.source_scopes.extend(&mut callee_body.source_scopes.drain(..));
612 caller_body.var_debug_info.append(&mut callee_body.var_debug_info);
613 caller_body.basic_blocks_mut().extend(callee_body.basic_blocks_mut().drain(..));
615 caller_body[callsite.block].terminator = Some(Terminator {
616 source_info: callsite.source_info,
617 kind: TerminatorKind::Goto { target: integrator.map_block(START_BLOCK) },
620 // Copy only unevaluated constants from the callee_body into the caller_body.
621 // Although we are only pushing `ConstKind::Unevaluated` consts to
622 // `required_consts`, here we may not only have `ConstKind::Unevaluated`
623 // because we are calling `subst_and_normalize_erasing_regions`.
624 caller_body.required_consts.extend(
625 callee_body.required_consts.iter().copied().filter(|&ct| match ct.literal {
626 ConstantKind::Ty(_) => {
627 bug!("should never encounter ty::UnevaluatedConst in `required_consts`")
629 ConstantKind::Val(..) | ConstantKind::Unevaluated(..) => true,
633 kind => bug!("unexpected terminator kind {:?}", kind),
639 args: Vec<Operand<'tcx>>,
640 callsite: &CallSite<'tcx>,
641 caller_body: &mut Body<'tcx>,
642 callee_body: &Body<'tcx>,
646 // There is a bit of a mismatch between the *caller* of a closure and the *callee*.
647 // The caller provides the arguments wrapped up in a tuple:
649 // tuple_tmp = (a, b, c)
650 // Fn::call(closure_ref, tuple_tmp)
652 // meanwhile the closure body expects the arguments (here, `a`, `b`, and `c`)
653 // as distinct arguments. (This is the "rust-call" ABI hack.) Normally, codegen has
654 // the job of unpacking this tuple. But here, we are codegen. =) So we want to create
657 // [closure_ref, tuple_tmp.0, tuple_tmp.1, tuple_tmp.2]
659 // Except for one tiny wrinkle: we don't actually want `tuple_tmp.0`. It's more convenient
660 // if we "spill" that into *another* temporary, so that we can map the argument
661 // variable in the callee MIR directly to an argument variable on our side.
662 // So we introduce temporaries like:
664 // tmp0 = tuple_tmp.0
665 // tmp1 = tuple_tmp.1
666 // tmp2 = tuple_tmp.2
668 // and the vector is `[closure_ref, tmp0, tmp1, tmp2]`.
669 if callsite.fn_sig.abi() == Abi::RustCall && callee_body.spread_arg.is_none() {
670 let mut args = args.into_iter();
671 let self_ = self.create_temp_if_necessary(args.next().unwrap(), callsite, caller_body);
672 let tuple = self.create_temp_if_necessary(args.next().unwrap(), callsite, caller_body);
673 assert!(args.next().is_none());
675 let tuple = Place::from(tuple);
676 let ty::Tuple(tuple_tys) = tuple.ty(caller_body, tcx).ty.kind() else {
677 bug!("Closure arguments are not passed as a tuple");
680 // The `closure_ref` in our example above.
681 let closure_ref_arg = iter::once(self_);
683 // The `tmp0`, `tmp1`, and `tmp2` in our example above.
684 let tuple_tmp_args = tuple_tys.iter().enumerate().map(|(i, ty)| {
685 // This is e.g., `tuple_tmp.0` in our example above.
686 let tuple_field = Operand::Move(tcx.mk_place_field(tuple, Field::new(i), ty));
688 // Spill to a local to make e.g., `tmp0`.
689 self.create_temp_if_necessary(tuple_field, callsite, caller_body)
692 closure_ref_arg.chain(tuple_tmp_args).collect()
695 .map(|a| self.create_temp_if_necessary(a, callsite, caller_body))
700 /// If `arg` is already a temporary, returns it. Otherwise, introduces a fresh
701 /// temporary `T` and an instruction `T = arg`, and returns `T`.
702 fn create_temp_if_necessary(
705 callsite: &CallSite<'tcx>,
706 caller_body: &mut Body<'tcx>,
708 // Reuse the operand if it is a moved temporary.
709 if let Operand::Move(place) = &arg
710 && let Some(local) = place.as_local()
711 && caller_body.local_kind(local) == LocalKind::Temp
716 // Otherwise, create a temporary for the argument.
717 trace!("creating temp for argument {:?}", arg);
718 let arg_ty = arg.ty(caller_body, self.tcx);
719 let local = self.new_call_temp(caller_body, callsite, arg_ty);
720 caller_body[callsite.block].statements.push(Statement {
721 source_info: callsite.source_info,
722 kind: StatementKind::Assign(Box::new((Place::from(local), Rvalue::Use(arg)))),
727 /// Introduces a new temporary into the caller body that is live for the duration of the call.
730 caller_body: &mut Body<'tcx>,
731 callsite: &CallSite<'tcx>,
734 let local = caller_body.local_decls.push(LocalDecl::new(ty, callsite.source_info.span));
736 caller_body[callsite.block].statements.push(Statement {
737 source_info: callsite.source_info,
738 kind: StatementKind::StorageLive(local),
741 if let Some(block) = callsite.target {
742 caller_body[block].statements.insert(
745 source_info: callsite.source_info,
746 kind: StatementKind::StorageDead(local),
755 fn type_size_of<'tcx>(
757 param_env: ty::ParamEnv<'tcx>,
760 tcx.layout_of(param_env.and(ty)).ok().map(|layout| layout.size.bytes())
763 /// Verify that the callee body is compatible with the caller.
765 /// This visitor mostly computes the inlining cost,
766 /// but also needs to verify that types match because of normalization failure.
767 struct CostChecker<'b, 'tcx> {
769 param_env: ParamEnv<'tcx>,
771 callee_body: &'b Body<'tcx>,
772 instance: ty::Instance<'tcx>,
773 validation: Result<(), &'static str>,
776 impl<'tcx> Visitor<'tcx> for CostChecker<'_, 'tcx> {
777 fn visit_statement(&mut self, statement: &Statement<'tcx>, location: Location) {
778 // Don't count StorageLive/StorageDead in the inlining cost.
779 match statement.kind {
780 StatementKind::StorageLive(_)
781 | StatementKind::StorageDead(_)
782 | StatementKind::Deinit(_)
783 | StatementKind::Nop => {}
784 _ => self.cost += INSTR_COST,
787 self.super_statement(statement, location);
790 fn visit_terminator(&mut self, terminator: &Terminator<'tcx>, location: Location) {
792 match terminator.kind {
793 TerminatorKind::Drop { ref place, unwind, .. }
794 | TerminatorKind::DropAndReplace { ref place, unwind, .. } => {
795 // If the place doesn't actually need dropping, treat it like a regular goto.
796 let ty = self.instance.subst_mir(tcx, &place.ty(self.callee_body, tcx).ty);
797 if ty.needs_drop(tcx, self.param_env) {
798 self.cost += CALL_PENALTY;
799 if unwind.is_some() {
800 self.cost += LANDINGPAD_PENALTY;
803 self.cost += INSTR_COST;
806 TerminatorKind::Call { func: Operand::Constant(ref f), cleanup, .. } => {
807 let fn_ty = self.instance.subst_mir(tcx, &f.literal.ty());
808 self.cost += if let ty::FnDef(def_id, _) = *fn_ty.kind() && tcx.is_intrinsic(def_id) {
809 // Don't give intrinsics the extra penalty for calls
814 if cleanup.is_some() {
815 self.cost += LANDINGPAD_PENALTY;
818 TerminatorKind::Assert { cleanup, .. } => {
819 self.cost += CALL_PENALTY;
820 if cleanup.is_some() {
821 self.cost += LANDINGPAD_PENALTY;
824 TerminatorKind::Resume => self.cost += RESUME_PENALTY,
825 TerminatorKind::InlineAsm { cleanup, .. } => {
826 self.cost += INSTR_COST;
827 if cleanup.is_some() {
828 self.cost += LANDINGPAD_PENALTY;
831 _ => self.cost += INSTR_COST,
834 self.super_terminator(terminator, location);
837 /// Count up the cost of local variables and temps, if we know the size
838 /// use that, otherwise we use a moderately-large dummy cost.
839 fn visit_local_decl(&mut self, local: Local, local_decl: &LocalDecl<'tcx>) {
841 let ptr_size = tcx.data_layout.pointer_size.bytes();
843 let ty = self.instance.subst_mir(tcx, &local_decl.ty);
844 // Cost of the var is the size in machine-words, if we know
846 if let Some(size) = type_size_of(tcx, self.param_env, ty) {
847 self.cost += ((size + ptr_size - 1) / ptr_size) as usize;
849 self.cost += UNKNOWN_SIZE_COST;
852 self.super_local_decl(local, local_decl)
855 /// This method duplicates code from MIR validation in an attempt to detect type mismatches due
856 /// to normalization failure.
857 fn visit_projection_elem(
860 proj_base: &[PlaceElem<'tcx>],
861 elem: PlaceElem<'tcx>,
862 context: PlaceContext,
865 if let ProjectionElem::Field(f, ty) = elem {
866 let parent = Place { local, projection: self.tcx.intern_place_elems(proj_base) };
867 let parent_ty = parent.ty(&self.callee_body.local_decls, self.tcx);
868 let check_equal = |this: &mut Self, f_ty| {
869 if !util::is_equal_up_to_subtyping(this.tcx, this.param_env, ty, f_ty) {
871 this.validation = Err("failed to normalize projection type");
876 let kind = match parent_ty.ty.kind() {
877 &ty::Alias(ty::Opaque, ty::AliasTy { def_id, substs, .. }) => {
878 self.tcx.bound_type_of(def_id).subst(self.tcx, substs).kind()
884 ty::Tuple(fields) => {
885 let Some(f_ty) = fields.get(f.as_usize()) else {
886 self.validation = Err("malformed MIR");
889 check_equal(self, *f_ty);
891 ty::Adt(adt_def, substs) => {
892 let var = parent_ty.variant_index.unwrap_or(VariantIdx::from_u32(0));
893 let Some(field) = adt_def.variant(var).fields.get(f.as_usize()) else {
894 self.validation = Err("malformed MIR");
897 check_equal(self, field.ty(self.tcx, substs));
899 ty::Closure(_, substs) => {
900 let substs = substs.as_closure();
901 let Some(f_ty) = substs.upvar_tys().nth(f.as_usize()) else {
902 self.validation = Err("malformed MIR");
905 check_equal(self, f_ty);
907 &ty::Generator(def_id, substs, _) => {
908 let f_ty = if let Some(var) = parent_ty.variant_index {
909 let gen_body = if def_id == self.callee_body.source.def_id() {
912 self.tcx.optimized_mir(def_id)
915 let Some(layout) = gen_body.generator_layout() else {
916 self.validation = Err("malformed MIR");
920 let Some(&local) = layout.variant_fields[var].get(f) else {
921 self.validation = Err("malformed MIR");
925 let Some(&f_ty) = layout.field_tys.get(local) else {
926 self.validation = Err("malformed MIR");
932 let Some(f_ty) = substs.as_generator().prefix_tys().nth(f.index()) else {
933 self.validation = Err("malformed MIR");
940 check_equal(self, f_ty);
942 _ => self.validation = Err("malformed MIR"),
946 self.super_projection_elem(local, proj_base, elem, context, location);
953 * Integrates blocks from the callee function into the calling function.
954 * Updates block indices, references to locals and other control flow
957 struct Integrator<'a, 'tcx> {
959 new_locals: RangeFrom<Local>,
960 new_scopes: RangeFrom<SourceScope>,
961 new_blocks: RangeFrom<BasicBlock>,
962 destination: Place<'tcx>,
963 callsite_scope: SourceScopeData<'tcx>,
964 callsite: &'a CallSite<'tcx>,
965 cleanup_block: Option<BasicBlock>,
966 in_cleanup_block: bool,
968 expn_data: LocalExpnId,
969 always_live_locals: BitSet<Local>,
972 impl Integrator<'_, '_> {
973 fn map_local(&self, local: Local) -> Local {
974 let new = if local == RETURN_PLACE {
975 self.destination.local
977 let idx = local.index() - 1;
978 if idx < self.args.len() {
981 Local::new(self.new_locals.start.index() + (idx - self.args.len()))
984 trace!("mapping local `{:?}` to `{:?}`", local, new);
988 fn map_scope(&self, scope: SourceScope) -> SourceScope {
989 let new = SourceScope::new(self.new_scopes.start.index() + scope.index());
990 trace!("mapping scope `{:?}` to `{:?}`", scope, new);
994 fn map_block(&self, block: BasicBlock) -> BasicBlock {
995 let new = BasicBlock::new(self.new_blocks.start.index() + block.index());
996 trace!("mapping block `{:?}` to `{:?}`", block, new);
1000 fn map_unwind(&self, unwind: Option<BasicBlock>) -> Option<BasicBlock> {
1001 if self.in_cleanup_block {
1002 if unwind.is_some() {
1003 bug!("cleanup on cleanup block");
1009 Some(target) => Some(self.map_block(target)),
1010 // Add an unwind edge to the original call's cleanup block
1011 None => self.cleanup_block,
1016 impl<'tcx> MutVisitor<'tcx> for Integrator<'_, 'tcx> {
1017 fn tcx(&self) -> TyCtxt<'tcx> {
1021 fn visit_local(&mut self, local: &mut Local, _ctxt: PlaceContext, _location: Location) {
1022 *local = self.map_local(*local);
1025 fn visit_source_scope_data(&mut self, scope_data: &mut SourceScopeData<'tcx>) {
1026 self.super_source_scope_data(scope_data);
1027 if scope_data.parent_scope.is_none() {
1028 // Attach the outermost callee scope as a child of the callsite
1029 // scope, via the `parent_scope` and `inlined_parent_scope` chains.
1030 scope_data.parent_scope = Some(self.callsite.source_info.scope);
1031 assert_eq!(scope_data.inlined_parent_scope, None);
1032 scope_data.inlined_parent_scope = if self.callsite_scope.inlined.is_some() {
1033 Some(self.callsite.source_info.scope)
1035 self.callsite_scope.inlined_parent_scope
1038 // Mark the outermost callee scope as an inlined one.
1039 assert_eq!(scope_data.inlined, None);
1040 scope_data.inlined = Some((self.callsite.callee, self.callsite.source_info.span));
1041 } else if scope_data.inlined_parent_scope.is_none() {
1042 // Make it easy to find the scope with `inlined` set above.
1043 scope_data.inlined_parent_scope = Some(self.map_scope(OUTERMOST_SOURCE_SCOPE));
1047 fn visit_source_scope(&mut self, scope: &mut SourceScope) {
1048 *scope = self.map_scope(*scope);
1051 fn visit_span(&mut self, span: &mut Span) {
1052 // Make sure that all spans track the fact that they were inlined.
1053 *span = span.fresh_expansion(self.expn_data);
1056 fn visit_place(&mut self, place: &mut Place<'tcx>, context: PlaceContext, location: Location) {
1057 for elem in place.projection {
1058 // FIXME: Make sure that return place is not used in an indexing projection, since it
1059 // won't be rebased as it is supposed to be.
1060 assert_ne!(ProjectionElem::Index(RETURN_PLACE), elem);
1063 // If this is the `RETURN_PLACE`, we need to rebase any projections onto it.
1064 let dest_proj_len = self.destination.projection.len();
1065 if place.local == RETURN_PLACE && dest_proj_len > 0 {
1066 let mut projs = Vec::with_capacity(dest_proj_len + place.projection.len());
1067 projs.extend(self.destination.projection);
1068 projs.extend(place.projection);
1070 place.projection = self.tcx.intern_place_elems(&*projs);
1072 // Handles integrating any locals that occur in the base
1074 self.super_place(place, context, location)
1077 fn visit_basic_block_data(&mut self, block: BasicBlock, data: &mut BasicBlockData<'tcx>) {
1078 self.in_cleanup_block = data.is_cleanup;
1079 self.super_basic_block_data(block, data);
1080 self.in_cleanup_block = false;
1083 fn visit_retag(&mut self, kind: &mut RetagKind, place: &mut Place<'tcx>, loc: Location) {
1084 self.super_retag(kind, place, loc);
1086 // We have to patch all inlined retags to be aware that they are no longer
1087 // happening on function entry.
1088 if *kind == RetagKind::FnEntry {
1089 *kind = RetagKind::Default;
1093 fn visit_statement(&mut self, statement: &mut Statement<'tcx>, location: Location) {
1094 if let StatementKind::StorageLive(local) | StatementKind::StorageDead(local) =
1097 self.always_live_locals.remove(local);
1099 self.super_statement(statement, location);
1102 fn visit_terminator(&mut self, terminator: &mut Terminator<'tcx>, loc: Location) {
1103 // Don't try to modify the implicit `_0` access on return (`return` terminators are
1104 // replaced down below anyways).
1105 if !matches!(terminator.kind, TerminatorKind::Return) {
1106 self.super_terminator(terminator, loc);
1109 match terminator.kind {
1110 TerminatorKind::GeneratorDrop | TerminatorKind::Yield { .. } => bug!(),
1111 TerminatorKind::Goto { ref mut target } => {
1112 *target = self.map_block(*target);
1114 TerminatorKind::SwitchInt { ref mut targets, .. } => {
1115 for tgt in targets.all_targets_mut() {
1116 *tgt = self.map_block(*tgt);
1119 TerminatorKind::Drop { ref mut target, ref mut unwind, .. }
1120 | TerminatorKind::DropAndReplace { ref mut target, ref mut unwind, .. } => {
1121 *target = self.map_block(*target);
1122 *unwind = self.map_unwind(*unwind);
1124 TerminatorKind::Call { ref mut target, ref mut cleanup, .. } => {
1125 if let Some(ref mut tgt) = *target {
1126 *tgt = self.map_block(*tgt);
1128 *cleanup = self.map_unwind(*cleanup);
1130 TerminatorKind::Assert { ref mut target, ref mut cleanup, .. } => {
1131 *target = self.map_block(*target);
1132 *cleanup = self.map_unwind(*cleanup);
1134 TerminatorKind::Return => {
1135 terminator.kind = if let Some(tgt) = self.callsite.target {
1136 TerminatorKind::Goto { target: tgt }
1138 TerminatorKind::Unreachable
1141 TerminatorKind::Resume => {
1142 if let Some(tgt) = self.cleanup_block {
1143 terminator.kind = TerminatorKind::Goto { target: tgt }
1146 TerminatorKind::Abort => {}
1147 TerminatorKind::Unreachable => {}
1148 TerminatorKind::FalseEdge { ref mut real_target, ref mut imaginary_target } => {
1149 *real_target = self.map_block(*real_target);
1150 *imaginary_target = self.map_block(*imaginary_target);
1152 TerminatorKind::FalseUnwind { real_target: _, unwind: _ } =>
1153 // see the ordering of passes in the optimized_mir query.
1155 bug!("False unwinds should have been removed before inlining")
1157 TerminatorKind::InlineAsm { ref mut destination, ref mut cleanup, .. } => {
1158 if let Some(ref mut tgt) = *destination {
1159 *tgt = self.map_block(*tgt);
1161 *cleanup = self.map_unwind(*cleanup);