src/librustc_mir_build/lints.rs

   1 use rustc::hir::map::blocks::FnLikeNode;
   2 use rustc::lint::builtin::UNCONDITIONAL_RECURSION;
   3 use rustc::mir::{self, Body, TerminatorKind};
   4 use rustc::ty::subst::InternalSubsts;
   5 use rustc::ty::{self, AssocItem, AssocItemContainer, Instance, TyCtxt};
   6 use rustc_hir::def_id::DefId;
   7 use rustc_hir::intravisit::FnKind;
   8 use rustc_index::bit_set::BitSet;
   9
  10 crate fn check<'tcx>(tcx: TyCtxt<'tcx>, body: &Body<'tcx>, def_id: DefId) {
  11     let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
  12
  13     if let Some(fn_like_node) = FnLikeNode::from_node(tcx.hir().get(hir_id)) {
  14         check_fn_for_unconditional_recursion(tcx, fn_like_node.kind(), body, def_id);
  15     }
  16 }
  17
  18 fn check_fn_for_unconditional_recursion<'tcx>(
  19     tcx: TyCtxt<'tcx>,
  20     fn_kind: FnKind<'_>,
  21     body: &Body<'tcx>,
  22     def_id: DefId,
  23 ) {
  24     if let FnKind::Closure(_) = fn_kind {
  25         // closures can't recur, so they don't matter.
  26         return;
  27     }
  28
  29     //FIXME(#54444) rewrite this lint to use the dataflow framework
  30
  31     // Walk through this function (say `f`) looking to see if
  32     // every possible path references itself, i.e., the function is
  33     // called recursively unconditionally. This is done by trying
  34     // to find a path from the entry node to the exit node that
  35     // *doesn't* call `f` by traversing from the entry while
  36     // pretending that calls of `f` are sinks (i.e., ignoring any
  37     // exit edges from them).
  38     //
  39     // NB. this has an edge case with non-returning statements,
  40     // like `loop {}` or `panic!()`: control flow never reaches
  41     // the exit node through these, so one can have a function
  42     // that never actually calls itself but is still picked up by
  43     // this lint:
  44     //
  45     //     fn f(cond: bool) {
  46     //         if !cond { panic!() } // could come from `assert!(cond)`
  47     //         f(false)
  48     //     }
  49     //
  50     // In general, functions of that form may be able to call
  51     // itself a finite number of times and then diverge. The lint
  52     // considers this to be an error for two reasons, (a) it is
  53     // easier to implement, and (b) it seems rare to actually want
  54     // to have behaviour like the above, rather than
  55     // e.g., accidentally recursing after an assert.
  56
  57     let basic_blocks = body.basic_blocks();
  58     let mut reachable_without_self_call_queue = vec![mir::START_BLOCK];
  59     let mut reached_exit_without_self_call = false;
  60     let mut self_call_locations = vec![];
  61     let mut visited = BitSet::new_empty(basic_blocks.len());
  62
  63     let param_env = tcx.param_env(def_id);
  64     let trait_substs_count = match tcx.opt_associated_item(def_id) {
  65         Some(AssocItem { container: AssocItemContainer::TraitContainer(trait_def_id), .. }) => {
  66             tcx.generics_of(trait_def_id).count()
  67         }
  68         _ => 0,
  69     };
  70     let caller_substs = &InternalSubsts::identity_for_item(tcx, def_id)[..trait_substs_count];
  71
  72     while let Some(bb) = reachable_without_self_call_queue.pop() {
  73         if !visited.insert(bb) {
  74             //already done
  75             continue;
  76         }
  77
  78         let block = &basic_blocks[bb];
  79
  80         if let Some(ref terminator) = block.terminator {
  81             match terminator.kind {
  82                 TerminatorKind::Call { ref func, .. } => {
  83                     let func_ty = func.ty(body, tcx);
  84
  85                     if let ty::FnDef(fn_def_id, substs) = func_ty.kind {
  86                         let (call_fn_id, call_substs) = if let Some(instance) =
  87                             Instance::resolve(tcx, param_env, fn_def_id, substs)
  88                         {
  89                             (instance.def_id(), instance.substs)
  90                         } else {
  91                             (fn_def_id, substs)
  92                         };
  93
  94                         let is_self_call = call_fn_id == def_id
  95                             && &call_substs[..caller_substs.len()] == caller_substs;
  96
  97                         if is_self_call {
  98                             self_call_locations.push(terminator.source_info);
  99
 100                             //this is a self call so we shouldn't explore
 101                             //further down this path
 102                             continue;
 103                         }
 104                     }
 105                 }
 106                 TerminatorKind::Abort | TerminatorKind::Return => {
 107                     //found a path!
 108                     reached_exit_without_self_call = true;
 109                     break;
 110                 }
 111                 _ => {}
 112             }
 113
 114             for successor in terminator.successors() {
 115                 reachable_without_self_call_queue.push(*successor);
 116             }
 117         }
 118     }
 119
 120     // Check the number of self calls because a function that
 121     // doesn't return (e.g., calls a `-> !` function or `loop { /*
 122     // no break */ }`) shouldn't be linted unless it actually
 123     // recurs.
 124     if !reached_exit_without_self_call && !self_call_locations.is_empty() {
 125         let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
 126         let sp = tcx.sess.source_map().def_span(tcx.hir().span(hir_id));
 127         let mut db = tcx.struct_span_lint_hir(
 128             UNCONDITIONAL_RECURSION,
 129             hir_id,
 130             sp,
 131             "function cannot return without recursing",
 132         );
 133         db.span_label(sp, "cannot return without recursing");
 134         // offer some help to the programmer.
 135         for location in &self_call_locations {
 136             db.span_label(location.span, "recursive call site");
 137         }
 138         db.help("a `loop` may express intention better if this is on purpose");
 139         db.emit();
 140     }
 141 }