compiler/rustc_mir_build/src/lints.rs

   1 use rustc_data_structures::graph::iterate::{
   2     ControlFlow, NodeStatus, TriColorDepthFirstSearch, TriColorVisitor,
   3 };
   4 use rustc_hir::intravisit::FnKind;
   5 use rustc_middle::hir::map::blocks::FnLikeNode;
   6 use rustc_middle::mir::{BasicBlock, Body, Operand, TerminatorKind};
   7 use rustc_middle::ty::subst::{GenericArg, InternalSubsts};
   8 use rustc_middle::ty::{self, AssocItem, AssocItemContainer, Instance, TyCtxt};
   9 use rustc_session::lint::builtin::UNCONDITIONAL_RECURSION;
  10 use rustc_span::Span;
  11
  12 crate fn check<'tcx>(tcx: TyCtxt<'tcx>, body: &Body<'tcx>) {
  13     let def_id = body.source.def_id().expect_local();
  14     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
  15
  16     if let Some(fn_like_node) = FnLikeNode::from_node(tcx.hir().get(hir_id)) {
  17         if let FnKind::Closure(_) = fn_like_node.kind() {
  18             // closures can't recur, so they don't matter.
  19             return;
  20         }
  21
  22         // If this is trait/impl method, extract the trait's substs.
  23         let trait_substs = match tcx.opt_associated_item(def_id.to_def_id()) {
  24             Some(AssocItem {
  25                 container: AssocItemContainer::TraitContainer(trait_def_id), ..
  26             }) => {
  27                 let trait_substs_count = tcx.generics_of(*trait_def_id).count();
  28                 &InternalSubsts::identity_for_item(tcx, def_id.to_def_id())[..trait_substs_count]
  29             }
  30             _ => &[],
  31         };
  32
  33         let mut vis = Search { tcx, body, reachable_recursive_calls: vec![], trait_substs };
  34         if let Some(NonRecursive) = TriColorDepthFirstSearch::new(&body).run_from_start(&mut vis) {
  35             return;
  36         }
  37
  38         vis.reachable_recursive_calls.sort();
  39
  40         let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
  41         let sp = tcx.sess.source_map().guess_head_span(tcx.hir().span_with_body(hir_id));
  42         tcx.struct_span_lint_hir(UNCONDITIONAL_RECURSION, hir_id, sp, |lint| {
  43             let mut db = lint.build("function cannot return without recursing");
  44             db.span_label(sp, "cannot return without recursing");
  45             // offer some help to the programmer.
  46             for call_span in vis.reachable_recursive_calls {
  47                 db.span_label(call_span, "recursive call site");
  48             }
  49             db.help("a `loop` may express intention better if this is on purpose");
  50             db.emit();
  51         });
  52     }
  53 }
  54
  55 struct NonRecursive;
  56
  57 struct Search<'mir, 'tcx> {
  58     tcx: TyCtxt<'tcx>,
  59     body: &'mir Body<'tcx>,
  60     trait_substs: &'tcx [GenericArg<'tcx>],
  61
  62     reachable_recursive_calls: Vec<Span>,
  63 }
  64
  65 impl<'mir, 'tcx> Search<'mir, 'tcx> {
  66     /// Returns `true` if `func` refers to the function we are searching in.
  67     fn is_recursive_call(&self, func: &Operand<'tcx>) -> bool {
  68         let Search { tcx, body, trait_substs, .. } = *self;
  69         let caller = body.source.def_id();
  70         let param_env = tcx.param_env(caller);
  71
  72         let func_ty = func.ty(body, tcx);
  73         if let ty::FnDef(callee, substs) = *func_ty.kind() {
  74             let (callee, call_substs) =
  75                 if let Ok(Some(instance)) = Instance::resolve(tcx, param_env, callee, substs) {
  76                     (instance.def_id(), instance.substs)
  77                 } else {
  78                     (callee, substs)
  79                 };
  80
  81             // FIXME(#57965): Make this work across function boundaries
  82
  83             // If this is a trait fn, the substs on the trait have to match, or we might be
  84             // calling into an entirely different method (for example, a call from the default
  85             // method in the trait to `<A as Trait<B>>::method`, where `A` and/or `B` are
  86             // specific types).
  87             return callee == caller && &call_substs[..trait_substs.len()] == trait_substs;
  88         }
  89
  90         false
  91     }
  92 }
  93
  94 impl<'mir, 'tcx> TriColorVisitor<&'mir Body<'tcx>> for Search<'mir, 'tcx> {
  95     type BreakVal = NonRecursive;
  96
  97     fn node_examined(
  98         &mut self,
  99         bb: BasicBlock,
 100         prior_status: Option<NodeStatus>,
 101     ) -> ControlFlow<Self::BreakVal> {
 102         // Back-edge in the CFG (loop).
 103         if let Some(NodeStatus::Visited) = prior_status {
 104             return ControlFlow::Break(NonRecursive);
 105         }
 106
 107         match self.body[bb].terminator().kind {
 108             // These terminators return control flow to the caller.
 109             TerminatorKind::Abort
 110             | TerminatorKind::GeneratorDrop
 111             | TerminatorKind::Resume
 112             | TerminatorKind::Return
 113             | TerminatorKind::Unreachable
 114             | TerminatorKind::Yield { .. } => ControlFlow::Break(NonRecursive),
 115
 116             // A diverging InlineAsm is treated as non-recursing
 117             TerminatorKind::InlineAsm { destination, .. } => {
 118                 if destination.is_some() {
 119                     ControlFlow::CONTINUE
 120                 } else {
 121                     ControlFlow::Break(NonRecursive)
 122                 }
 123             }
 124
 125             // These do not.
 126             TerminatorKind::Assert { .. }
 127             | TerminatorKind::Call { .. }
 128             | TerminatorKind::Drop { .. }
 129             | TerminatorKind::DropAndReplace { .. }
 130             | TerminatorKind::FalseEdge { .. }
 131             | TerminatorKind::FalseUnwind { .. }
 132             | TerminatorKind::Goto { .. }
 133             | TerminatorKind::SwitchInt { .. } => ControlFlow::CONTINUE,
 134         }
 135     }
 136
 137     fn node_settled(&mut self, bb: BasicBlock) -> ControlFlow<Self::BreakVal> {
 138         // When we examine a node for the last time, remember it if it is a recursive call.
 139         let terminator = self.body[bb].terminator();
 140         if let TerminatorKind::Call { func, .. } = &terminator.kind {
 141             if self.is_recursive_call(func) {
 142                 self.reachable_recursive_calls.push(terminator.source_info.span);
 143             }
 144         }
 145
 146         ControlFlow::CONTINUE
 147     }
 148
 149     fn ignore_edge(&mut self, bb: BasicBlock, target: BasicBlock) -> bool {
 150         // Don't traverse successors of recursive calls or false CFG edges.
 151         match self.body[bb].terminator().kind {
 152             TerminatorKind::Call { ref func, .. } => self.is_recursive_call(func),
 153
 154             TerminatorKind::FalseUnwind { unwind: Some(imaginary_target), .. }
 155             | TerminatorKind::FalseEdge { imaginary_target, .. } => imaginary_target == target,
 156
 157             _ => false,
 158         }
 159     }
 160 }