1 //! A classic liveness analysis based on dataflow over the AST. Computes,
2 //! for each local variable in a function, whether that variable is live
3 //! at a given point. Program execution points are identified by their
8 //! The basic model is that each local variable is assigned an index. We
9 //! represent sets of local variables using a vector indexed by this
10 //! index. The value in the vector is either 0, indicating the variable
11 //! is dead, or the ID of an expression that uses the variable.
13 //! We conceptually walk over the AST in reverse execution order. If we
14 //! find a use of a variable, we add it to the set of live variables. If
15 //! we find an assignment to a variable, we remove it from the set of live
16 //! variables. When we have to merge two flows, we take the union of
17 //! those two flows -- if the variable is live on both paths, we simply
18 //! pick one ID. In the event of loops, we continue doing this until a
19 //! fixed point is reached.
21 //! ## Checking initialization
23 //! At the function entry point, all variables must be dead. If this is
24 //! not the case, we can report an error using the ID found in the set of
25 //! live variables, which identifies a use of the variable which is not
26 //! dominated by an assignment.
30 //! After each explicit move, the variable must be dead.
32 //! ## Computing last uses
34 //! Any use of the variable where the variable is dead afterwards is a
37 //! # Implementation details
39 //! The actual implementation contains two (nested) walks over the AST.
40 //! The outer walk has the job of building up the ir_maps instance for the
41 //! enclosing function. On the way down the tree, it identifies those AST
42 //! nodes and variable IDs that will be needed for the liveness analysis
43 //! and assigns them contiguous IDs. The liveness ID for an AST node is
44 //! called a `live_node` (it's a newtype'd `u32`) and the ID for a variable
45 //! is called a `variable` (another newtype'd `u32`).
47 //! On the way back up the tree, as we are about to exit from a function
48 //! declaration we allocate a `liveness` instance. Now that we know
49 //! precisely how many nodes and variables we need, we can allocate all
50 //! the various arrays that we will need to precisely the right size. We then
51 //! perform the actual propagation on the `liveness` instance.
53 //! This propagation is encoded in the various `propagate_through_*()`
54 //! methods. It effectively does a reverse walk of the AST; whenever we
55 //! reach a loop node, we iterate until a fixed point is reached.
57 //! ## The `RWU` struct
59 //! At each live node `N`, we track three pieces of information for each
60 //! variable `V` (these are encapsulated in the `RWU` struct):
62 //! - `reader`: the `LiveNode` ID of some node which will read the value
63 //! that `V` holds on entry to `N`. Formally: a node `M` such
64 //! that there exists a path `P` from `N` to `M` where `P` does not
65 //! write `V`. If the `reader` is `None`, then the current
66 //! value will never be read (the variable is dead, essentially).
68 //! - `writer`: the `LiveNode` ID of some node which will write the
69 //! variable `V` and which is reachable from `N`. Formally: a node `M`
70 //! such that there exists a path `P` from `N` to `M` and `M` writes
71 //! `V`. If the `writer` is `None`, then there is no writer
72 //! of `V` that follows `N`.
74 //! - `used`: a boolean value indicating whether `V` is *used*. We
75 //! distinguish a *read* from a *use* in that a *use* is some read that
76 //! is not just used to generate a new value. For example, `x += 1` is
77 //! a read but not a use. This is used to generate better warnings.
79 //! ## Special nodes and variables
81 //! We generate various special nodes for various, well, special purposes.
82 //! These are described in the `Liveness` struct.
84 use self::LiveNodeKind::*;
87 use rustc_ast::InlineAsmOptions;
88 use rustc_data_structures::fx::FxIndexMap;
89 use rustc_errors::Applicability;
90 use rustc_errors::Diagnostic;
92 use rustc_hir::def::*;
93 use rustc_hir::def_id::{DefId, LocalDefId};
94 use rustc_hir::intravisit::{self, Visitor};
95 use rustc_hir::{Expr, HirId, HirIdMap, HirIdSet};
96 use rustc_index::vec::IndexVec;
97 use rustc_middle::ty::query::Providers;
98 use rustc_middle::ty::{self, DefIdTree, RootVariableMinCaptureList, Ty, TyCtxt};
99 use rustc_session::lint;
100 use rustc_span::symbol::{kw, sym, Symbol};
101 use rustc_span::{BytePos, Span};
103 use std::collections::VecDeque;
105 use std::io::prelude::*;
110 rustc_index::newtype_index! {
111 pub struct Variable {
112 DEBUG_FORMAT = "v({})",
116 rustc_index::newtype_index! {
117 pub struct LiveNode {
118 DEBUG_FORMAT = "ln({})",
122 #[derive(Copy, Clone, PartialEq, Debug)]
125 ExprNode(Span, HirId),
126 VarDefNode(Span, HirId),
131 fn live_node_kind_to_string(lnk: LiveNodeKind, tcx: TyCtxt<'_>) -> String {
132 let sm = tcx.sess.source_map();
134 UpvarNode(s) => format!("Upvar node [{}]", sm.span_to_diagnostic_string(s)),
135 ExprNode(s, _) => format!("Expr node [{}]", sm.span_to_diagnostic_string(s)),
136 VarDefNode(s, _) => format!("Var def node [{}]", sm.span_to_diagnostic_string(s)),
137 ClosureNode => "Closure node".to_owned(),
138 ExitNode => "Exit node".to_owned(),
142 fn check_liveness(tcx: TyCtxt<'_>, def_id: DefId) {
143 let local_def_id = match def_id.as_local() {
145 Some(def_id) => def_id,
148 // Don't run unused pass for #[derive()]
149 let parent = tcx.local_parent(local_def_id);
150 if let DefKind::Impl = tcx.def_kind(parent)
151 && tcx.has_attr(parent.to_def_id(), sym::automatically_derived)
156 // Don't run unused pass for #[naked]
157 if tcx.has_attr(def_id, sym::naked) {
161 let mut maps = IrMaps::new(tcx);
162 let body_id = tcx.hir().body_owned_by(local_def_id);
163 let hir_id = tcx.hir().body_owner(body_id);
164 let body = tcx.hir().body(body_id);
166 if let Some(upvars) = tcx.upvars_mentioned(def_id) {
167 for &var_hir_id in upvars.keys() {
168 let var_name = tcx.hir().name(var_hir_id);
169 maps.add_variable(Upvar(var_hir_id, var_name));
173 // gather up the various local variables, significant expressions,
175 maps.visit_body(body);
178 let mut lsets = Liveness::new(&mut maps, local_def_id);
179 let entry_ln = lsets.compute(&body, hir_id);
180 lsets.log_liveness(entry_ln, body_id.hir_id);
182 // check for various error conditions
183 lsets.visit_body(body);
184 lsets.warn_about_unused_upvars(entry_ln);
185 lsets.warn_about_unused_args(body, entry_ln);
188 pub fn provide(providers: &mut Providers) {
189 *providers = Providers { check_liveness, ..*providers };
192 // ______________________________________________________________________
195 // This is the first pass and the one that drives the main
196 // computation. It walks up and down the IR once. On the way down,
197 // we count for each function the number of variables as well as
198 // liveness nodes. A liveness node is basically an expression or
199 // capture clause that does something of interest: either it has
200 // interesting control flow or it uses/defines a local variable.
202 // On the way back up, at each function node we create liveness sets
203 // (we now know precisely how big to make our various vectors and so
204 // forth) and then do the data-flow propagation to compute the set
205 // of live variables at each program point.
207 // Finally, we run back over the IR one last time and, using the
208 // computed liveness, check various safety conditions. For example,
209 // there must be no live nodes at the definition site for a variable
210 // unless it has an initializer. Similarly, each non-mutable local
211 // variable must not be assigned if there is some successor
212 // assignment. And so forth.
219 #[derive(Copy, Clone, Debug)]
226 #[derive(Copy, Clone, Debug)]
228 Param(HirId, Symbol),
230 Upvar(HirId, Symbol),
233 struct CollectLitsVisitor<'tcx> {
234 lit_exprs: Vec<&'tcx hir::Expr<'tcx>>,
237 impl<'tcx> Visitor<'tcx> for CollectLitsVisitor<'tcx> {
238 fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
239 if let hir::ExprKind::Lit(_) = expr.kind {
240 self.lit_exprs.push(expr);
242 intravisit::walk_expr(self, expr);
246 struct IrMaps<'tcx> {
248 live_node_map: HirIdMap<LiveNode>,
249 variable_map: HirIdMap<Variable>,
250 capture_info_map: HirIdMap<Rc<Vec<CaptureInfo>>>,
251 var_kinds: IndexVec<Variable, VarKind>,
252 lnks: IndexVec<LiveNode, LiveNodeKind>,
255 impl<'tcx> IrMaps<'tcx> {
256 fn new(tcx: TyCtxt<'tcx>) -> IrMaps<'tcx> {
259 live_node_map: HirIdMap::default(),
260 variable_map: HirIdMap::default(),
261 capture_info_map: Default::default(),
262 var_kinds: IndexVec::new(),
263 lnks: IndexVec::new(),
267 fn add_live_node(&mut self, lnk: LiveNodeKind) -> LiveNode {
268 let ln = self.lnks.push(lnk);
270 debug!("{:?} is of kind {}", ln, live_node_kind_to_string(lnk, self.tcx));
275 fn add_live_node_for_node(&mut self, hir_id: HirId, lnk: LiveNodeKind) {
276 let ln = self.add_live_node(lnk);
277 self.live_node_map.insert(hir_id, ln);
279 debug!("{:?} is node {:?}", ln, hir_id);
282 fn add_variable(&mut self, vk: VarKind) -> Variable {
283 let v = self.var_kinds.push(vk);
286 Local(LocalInfo { id: node_id, .. }) | Param(node_id, _) | Upvar(node_id, _) => {
287 self.variable_map.insert(node_id, v);
291 debug!("{:?} is {:?}", v, vk);
296 fn variable(&self, hir_id: HirId, span: Span) -> Variable {
297 match self.variable_map.get(&hir_id) {
300 span_bug!(span, "no variable registered for id {:?}", hir_id);
305 fn variable_name(&self, var: Variable) -> Symbol {
306 match self.var_kinds[var] {
307 Local(LocalInfo { name, .. }) | Param(_, name) | Upvar(_, name) => name,
311 fn variable_is_shorthand(&self, var: Variable) -> bool {
312 match self.var_kinds[var] {
313 Local(LocalInfo { is_shorthand, .. }) => is_shorthand,
314 Param(..) | Upvar(..) => false,
318 fn set_captures(&mut self, hir_id: HirId, cs: Vec<CaptureInfo>) {
319 self.capture_info_map.insert(hir_id, Rc::new(cs));
322 fn collect_shorthand_field_ids(&self, pat: &hir::Pat<'tcx>) -> HirIdSet {
323 // For struct patterns, take note of which fields used shorthand
324 // (`x` rather than `x: x`).
325 let mut shorthand_field_ids = HirIdSet::default();
326 let mut pats = VecDeque::new();
329 while let Some(pat) = pats.pop_front() {
330 use rustc_hir::PatKind::*;
332 Binding(.., inner_pat) => {
333 pats.extend(inner_pat.iter());
335 Struct(_, fields, _) => {
336 let (short, not_short): (Vec<_>, _) =
337 fields.iter().partition(|f| f.is_shorthand);
338 shorthand_field_ids.extend(short.iter().map(|f| f.pat.hir_id));
339 pats.extend(not_short.iter().map(|f| f.pat));
341 Ref(inner_pat, _) | Box(inner_pat) => {
342 pats.push_back(inner_pat);
344 TupleStruct(_, inner_pats, _) | Tuple(inner_pats, _) | Or(inner_pats) => {
345 pats.extend(inner_pats.iter());
347 Slice(pre_pats, inner_pat, post_pats) => {
348 pats.extend(pre_pats.iter());
349 pats.extend(inner_pat.iter());
350 pats.extend(post_pats.iter());
359 fn add_from_pat(&mut self, pat: &hir::Pat<'tcx>) {
360 let shorthand_field_ids = self.collect_shorthand_field_ids(pat);
362 pat.each_binding(|_, hir_id, _, ident| {
363 self.add_live_node_for_node(hir_id, VarDefNode(ident.span, hir_id));
364 self.add_variable(Local(LocalInfo {
367 is_shorthand: shorthand_field_ids.contains(&hir_id),
373 impl<'tcx> Visitor<'tcx> for IrMaps<'tcx> {
374 fn visit_local(&mut self, local: &'tcx hir::Local<'tcx>) {
375 self.add_from_pat(&local.pat);
376 if local.els.is_some() {
377 self.add_live_node_for_node(local.hir_id, ExprNode(local.span, local.hir_id));
379 intravisit::walk_local(self, local);
382 fn visit_arm(&mut self, arm: &'tcx hir::Arm<'tcx>) {
383 self.add_from_pat(&arm.pat);
384 if let Some(hir::Guard::IfLet(ref let_expr)) = arm.guard {
385 self.add_from_pat(let_expr.pat);
387 intravisit::walk_arm(self, arm);
390 fn visit_param(&mut self, param: &'tcx hir::Param<'tcx>) {
391 let shorthand_field_ids = self.collect_shorthand_field_ids(param.pat);
392 param.pat.each_binding(|_bm, hir_id, _x, ident| {
393 let var = match param.pat.kind {
394 rustc_hir::PatKind::Struct(..) => Local(LocalInfo {
397 is_shorthand: shorthand_field_ids.contains(&hir_id),
399 _ => Param(hir_id, ident.name),
401 self.add_variable(var);
403 intravisit::walk_param(self, param);
406 fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
408 // live nodes required for uses or definitions of variables:
409 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
410 debug!("expr {}: path that leads to {:?}", expr.hir_id, path.res);
411 if let Res::Local(_var_hir_id) = path.res {
412 self.add_live_node_for_node(expr.hir_id, ExprNode(expr.span, expr.hir_id));
414 intravisit::walk_expr(self, expr);
416 hir::ExprKind::Closure(closure) => {
417 // Interesting control flow (for loops can contain labeled
418 // breaks or continues)
419 self.add_live_node_for_node(expr.hir_id, ExprNode(expr.span, expr.hir_id));
421 // Make a live_node for each mentioned variable, with the span
422 // being the location that the variable is used. This results
423 // in better error messages than just pointing at the closure
424 // construction site.
425 let mut call_caps = Vec::new();
426 if let Some(upvars) = self.tcx.upvars_mentioned(closure.def_id) {
427 call_caps.extend(upvars.keys().map(|var_id| {
428 let upvar = upvars[var_id];
429 let upvar_ln = self.add_live_node(UpvarNode(upvar.span));
430 CaptureInfo { ln: upvar_ln, var_hid: *var_id }
433 self.set_captures(expr.hir_id, call_caps);
434 intravisit::walk_expr(self, expr);
437 hir::ExprKind::Let(let_expr) => {
438 self.add_from_pat(let_expr.pat);
439 intravisit::walk_expr(self, expr);
442 // live nodes required for interesting control flow:
443 hir::ExprKind::If(..)
444 | hir::ExprKind::Match(..)
445 | hir::ExprKind::Loop(..)
446 | hir::ExprKind::Yield(..) => {
447 self.add_live_node_for_node(expr.hir_id, ExprNode(expr.span, expr.hir_id));
448 intravisit::walk_expr(self, expr);
450 hir::ExprKind::Binary(op, ..) if op.node.is_lazy() => {
451 self.add_live_node_for_node(expr.hir_id, ExprNode(expr.span, expr.hir_id));
452 intravisit::walk_expr(self, expr);
455 // otherwise, live nodes are not required:
456 hir::ExprKind::Index(..)
457 | hir::ExprKind::Field(..)
458 | hir::ExprKind::Array(..)
459 | hir::ExprKind::Call(..)
460 | hir::ExprKind::MethodCall(..)
461 | hir::ExprKind::Tup(..)
462 | hir::ExprKind::Binary(..)
463 | hir::ExprKind::AddrOf(..)
464 | hir::ExprKind::Cast(..)
465 | hir::ExprKind::DropTemps(..)
466 | hir::ExprKind::Unary(..)
467 | hir::ExprKind::Break(..)
468 | hir::ExprKind::Continue(_)
469 | hir::ExprKind::Lit(_)
470 | hir::ExprKind::ConstBlock(..)
471 | hir::ExprKind::Ret(..)
472 | hir::ExprKind::Block(..)
473 | hir::ExprKind::Assign(..)
474 | hir::ExprKind::AssignOp(..)
475 | hir::ExprKind::Struct(..)
476 | hir::ExprKind::Repeat(..)
477 | hir::ExprKind::InlineAsm(..)
478 | hir::ExprKind::Box(..)
479 | hir::ExprKind::Type(..)
481 | hir::ExprKind::Path(hir::QPath::TypeRelative(..))
482 | hir::ExprKind::Path(hir::QPath::LangItem(..)) => {
483 intravisit::walk_expr(self, expr);
489 // ______________________________________________________________________
490 // Computing liveness sets
492 // Actually we compute just a bit more than just liveness, but we use
493 // the same basic propagation framework in all cases.
495 const ACC_READ: u32 = 1;
496 const ACC_WRITE: u32 = 2;
497 const ACC_USE: u32 = 4;
499 struct Liveness<'a, 'tcx> {
500 ir: &'a mut IrMaps<'tcx>,
501 typeck_results: &'a ty::TypeckResults<'tcx>,
502 param_env: ty::ParamEnv<'tcx>,
503 closure_min_captures: Option<&'tcx RootVariableMinCaptureList<'tcx>>,
504 successors: IndexVec<LiveNode, Option<LiveNode>>,
505 rwu_table: rwu_table::RWUTable,
507 /// A live node representing a point of execution before closure entry &
508 /// after closure exit. Used to calculate liveness of captured variables
509 /// through calls to the same closure. Used for Fn & FnMut closures only.
510 closure_ln: LiveNode,
511 /// A live node representing every 'exit' from the function, whether it be
512 /// by explicit return, panic, or other means.
515 // mappings from loop node ID to LiveNode
516 // ("break" label should map to loop node ID,
517 // it probably doesn't now)
518 break_ln: HirIdMap<LiveNode>,
519 cont_ln: HirIdMap<LiveNode>,
522 impl<'a, 'tcx> Liveness<'a, 'tcx> {
523 fn new(ir: &'a mut IrMaps<'tcx>, body_owner: LocalDefId) -> Liveness<'a, 'tcx> {
524 let typeck_results = ir.tcx.typeck(body_owner);
525 let param_env = ir.tcx.param_env(body_owner);
526 let closure_min_captures = typeck_results.closure_min_captures.get(&body_owner);
527 let closure_ln = ir.add_live_node(ClosureNode);
528 let exit_ln = ir.add_live_node(ExitNode);
530 let num_live_nodes = ir.lnks.len();
531 let num_vars = ir.var_kinds.len();
537 closure_min_captures,
538 successors: IndexVec::from_elem_n(None, num_live_nodes),
539 rwu_table: rwu_table::RWUTable::new(num_live_nodes, num_vars),
542 break_ln: Default::default(),
543 cont_ln: Default::default(),
547 fn live_node(&self, hir_id: HirId, span: Span) -> LiveNode {
548 match self.ir.live_node_map.get(&hir_id) {
551 // This must be a mismatch between the ir_map construction
552 // above and the propagation code below; the two sets of
553 // code have to agree about which AST nodes are worth
554 // creating liveness nodes for.
555 span_bug!(span, "no live node registered for node {:?}", hir_id);
560 fn variable(&self, hir_id: HirId, span: Span) -> Variable {
561 self.ir.variable(hir_id, span)
564 fn define_bindings_in_pat(&mut self, pat: &hir::Pat<'_>, mut succ: LiveNode) -> LiveNode {
565 // In an or-pattern, only consider the first pattern; any later patterns
566 // must have the same bindings, and we also consider the first pattern
567 // to be the "authoritative" set of ids.
568 pat.each_binding_or_first(&mut |_, hir_id, pat_sp, ident| {
569 let ln = self.live_node(hir_id, pat_sp);
570 let var = self.variable(hir_id, ident.span);
571 self.init_from_succ(ln, succ);
572 self.define(ln, var);
578 fn live_on_entry(&self, ln: LiveNode, var: Variable) -> bool {
579 self.rwu_table.get_reader(ln, var)
582 // Is this variable live on entry to any of its successor nodes?
583 fn live_on_exit(&self, ln: LiveNode, var: Variable) -> bool {
584 let successor = self.successors[ln].unwrap();
585 self.live_on_entry(successor, var)
588 fn used_on_entry(&self, ln: LiveNode, var: Variable) -> bool {
589 self.rwu_table.get_used(ln, var)
592 fn assigned_on_entry(&self, ln: LiveNode, var: Variable) -> bool {
593 self.rwu_table.get_writer(ln, var)
596 fn assigned_on_exit(&self, ln: LiveNode, var: Variable) -> bool {
597 let successor = self.successors[ln].unwrap();
598 self.assigned_on_entry(successor, var)
601 fn write_vars<F>(&self, wr: &mut dyn Write, mut test: F) -> io::Result<()>
603 F: FnMut(Variable) -> bool,
605 for var_idx in 0..self.ir.var_kinds.len() {
606 let var = Variable::from(var_idx);
608 write!(wr, " {:?}", var)?;
614 #[allow(unused_must_use)]
615 fn ln_str(&self, ln: LiveNode) -> String {
616 let mut wr = Vec::new();
618 let wr = &mut wr as &mut dyn Write;
619 write!(wr, "[{:?} of kind {:?} reads", ln, self.ir.lnks[ln]);
620 self.write_vars(wr, |var| self.rwu_table.get_reader(ln, var));
621 write!(wr, " writes");
622 self.write_vars(wr, |var| self.rwu_table.get_writer(ln, var));
624 self.write_vars(wr, |var| self.rwu_table.get_used(ln, var));
626 write!(wr, " precedes {:?}]", self.successors[ln]);
628 String::from_utf8(wr).unwrap()
631 fn log_liveness(&self, entry_ln: LiveNode, hir_id: hir::HirId) {
632 // hack to skip the loop unless debug! is enabled:
634 "^^ liveness computation results for body {} (entry={:?})",
636 for ln_idx in 0..self.ir.lnks.len() {
637 debug!("{:?}", self.ln_str(LiveNode::from(ln_idx)));
645 fn init_empty(&mut self, ln: LiveNode, succ_ln: LiveNode) {
646 self.successors[ln] = Some(succ_ln);
648 // It is not necessary to initialize the RWUs here because they are all
649 // empty when created, and the sets only grow during iterations.
652 fn init_from_succ(&mut self, ln: LiveNode, succ_ln: LiveNode) {
653 // more efficient version of init_empty() / merge_from_succ()
654 self.successors[ln] = Some(succ_ln);
655 self.rwu_table.copy(ln, succ_ln);
656 debug!("init_from_succ(ln={}, succ={})", self.ln_str(ln), self.ln_str(succ_ln));
659 fn merge_from_succ(&mut self, ln: LiveNode, succ_ln: LiveNode) -> bool {
664 let changed = self.rwu_table.union(ln, succ_ln);
665 debug!("merge_from_succ(ln={:?}, succ={}, changed={})", ln, self.ln_str(succ_ln), changed);
669 // Indicates that a local variable was *defined*; we know that no
670 // uses of the variable can precede the definition (resolve checks
671 // this) so we just clear out all the data.
672 fn define(&mut self, writer: LiveNode, var: Variable) {
673 let used = self.rwu_table.get_used(writer, var);
674 self.rwu_table.set(writer, var, rwu_table::RWU { reader: false, writer: false, used });
675 debug!("{:?} defines {:?}: {}", writer, var, self.ln_str(writer));
678 // Either read, write, or both depending on the acc bitset
679 fn acc(&mut self, ln: LiveNode, var: Variable, acc: u32) {
680 debug!("{:?} accesses[{:x}] {:?}: {}", ln, acc, var, self.ln_str(ln));
682 let mut rwu = self.rwu_table.get(ln, var);
684 if (acc & ACC_WRITE) != 0 {
689 // Important: if we both read/write, must do read second
690 // or else the write will override.
691 if (acc & ACC_READ) != 0 {
695 if (acc & ACC_USE) != 0 {
699 self.rwu_table.set(ln, var, rwu);
702 fn compute(&mut self, body: &hir::Body<'_>, hir_id: HirId) -> LiveNode {
703 debug!("compute: for body {:?}", body.id().hir_id);
705 // # Liveness of captured variables
707 // When computing the liveness for captured variables we take into
708 // account how variable is captured (ByRef vs ByValue) and what is the
709 // closure kind (Generator / FnOnce vs Fn / FnMut).
711 // Variables captured by reference are assumed to be used on the exit
714 // In FnOnce closures, variables captured by value are known to be dead
715 // on exit since it is impossible to call the closure again.
717 // In Fn / FnMut closures, variables captured by value are live on exit
718 // if they are live on the entry to the closure, since only the closure
719 // itself can access them on subsequent calls.
721 if let Some(closure_min_captures) = self.closure_min_captures {
722 // Mark upvars captured by reference as used after closure exits.
723 for (&var_hir_id, min_capture_list) in closure_min_captures {
724 for captured_place in min_capture_list {
725 match captured_place.info.capture_kind {
726 ty::UpvarCapture::ByRef(_) => {
727 let var = self.variable(
729 captured_place.get_capture_kind_span(self.ir.tcx),
731 self.acc(self.exit_ln, var, ACC_READ | ACC_USE);
733 ty::UpvarCapture::ByValue => {}
739 let succ = self.propagate_through_expr(&body.value, self.exit_ln);
741 if self.closure_min_captures.is_none() {
742 // Either not a closure, or closure without any captured variables.
743 // No need to determine liveness of captured variables, since there
748 let ty = self.typeck_results.node_type(hir_id);
750 ty::Closure(_def_id, substs) => match substs.as_closure().kind() {
751 ty::ClosureKind::Fn => {}
752 ty::ClosureKind::FnMut => {}
753 ty::ClosureKind::FnOnce => return succ,
755 ty::Generator(..) => return succ,
759 "{} has upvars so it should have a closure type: {:?}",
766 // Propagate through calls to the closure.
768 self.init_from_succ(self.closure_ln, succ);
769 for param in body.params {
770 param.pat.each_binding(|_bm, hir_id, _x, ident| {
771 let var = self.variable(hir_id, ident.span);
772 self.define(self.closure_ln, var);
776 if !self.merge_from_succ(self.exit_ln, self.closure_ln) {
779 assert_eq!(succ, self.propagate_through_expr(&body.value, self.exit_ln));
785 fn propagate_through_block(&mut self, blk: &hir::Block<'_>, succ: LiveNode) -> LiveNode {
786 if blk.targeted_by_break {
787 self.break_ln.insert(blk.hir_id, succ);
789 let succ = self.propagate_through_opt_expr(blk.expr, succ);
790 blk.stmts.iter().rev().fold(succ, |succ, stmt| self.propagate_through_stmt(stmt, succ))
793 fn propagate_through_stmt(&mut self, stmt: &hir::Stmt<'_>, succ: LiveNode) -> LiveNode {
795 hir::StmtKind::Local(ref local) => {
796 // Note: we mark the variable as defined regardless of whether
797 // there is an initializer. Initially I had thought to only mark
798 // the live variable as defined if it was initialized, and then we
799 // could check for uninit variables just by scanning what is live
800 // at the start of the function. But that doesn't work so well for
801 // immutable variables defined in a loop:
802 // loop { let x; x = 5; }
803 // because the "assignment" loops back around and generates an error.
805 // So now we just check that variables defined w/o an
806 // initializer are not live at the point of their
807 // initialization, which is mildly more complex than checking
808 // once at the func header but otherwise equivalent.
810 if let Some(els) = local.els {
811 // Eventually, `let pat: ty = init else { els };` is mostly equivalent to
812 // `let (bindings, ...) = match init { pat => (bindings, ...), _ => els };`
813 // except that extended lifetime applies at the `init` location.
827 if let Some(init) = local.init {
828 let else_ln = self.propagate_through_block(els, succ);
829 let ln = self.live_node(local.hir_id, local.span);
830 self.init_from_succ(ln, succ);
831 self.merge_from_succ(ln, else_ln);
832 let succ = self.propagate_through_expr(init, ln);
833 self.define_bindings_in_pat(&local.pat, succ)
837 "variable is uninitialized but an unexpected else branch is found"
841 let succ = self.propagate_through_opt_expr(local.init, succ);
842 self.define_bindings_in_pat(&local.pat, succ)
845 hir::StmtKind::Item(..) => succ,
846 hir::StmtKind::Expr(ref expr) | hir::StmtKind::Semi(ref expr) => {
847 self.propagate_through_expr(&expr, succ)
852 fn propagate_through_exprs(&mut self, exprs: &[Expr<'_>], succ: LiveNode) -> LiveNode {
853 exprs.iter().rev().fold(succ, |succ, expr| self.propagate_through_expr(&expr, succ))
856 fn propagate_through_opt_expr(
858 opt_expr: Option<&Expr<'_>>,
861 opt_expr.map_or(succ, |expr| self.propagate_through_expr(expr, succ))
864 fn propagate_through_expr(&mut self, expr: &Expr<'_>, succ: LiveNode) -> LiveNode {
865 debug!("propagate_through_expr: {:?}", expr);
868 // Interesting cases with control flow or which gen/kill
869 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
870 self.access_path(expr.hir_id, path, succ, ACC_READ | ACC_USE)
873 hir::ExprKind::Field(ref e, _) => self.propagate_through_expr(&e, succ),
875 hir::ExprKind::Closure { .. } => {
876 debug!("{:?} is an ExprKind::Closure", expr);
878 // the construction of a closure itself is not important,
879 // but we have to consider the closed over variables.
885 .unwrap_or_else(|| span_bug!(expr.span, "no registered caps"));
887 caps.iter().rev().fold(succ, |succ, cap| {
888 self.init_from_succ(cap.ln, succ);
889 let var = self.variable(cap.var_hid, expr.span);
890 self.acc(cap.ln, var, ACC_READ | ACC_USE);
895 hir::ExprKind::Let(let_expr) => {
896 let succ = self.propagate_through_expr(let_expr.init, succ);
897 self.define_bindings_in_pat(let_expr.pat, succ)
900 // Note that labels have been resolved, so we don't need to look
901 // at the label ident
902 hir::ExprKind::Loop(ref blk, ..) => self.propagate_through_loop(expr, &blk, succ),
904 hir::ExprKind::Yield(ref e, ..) => {
905 let yield_ln = self.live_node(expr.hir_id, expr.span);
906 self.init_from_succ(yield_ln, succ);
907 self.merge_from_succ(yield_ln, self.exit_ln);
908 self.propagate_through_expr(e, yield_ln)
911 hir::ExprKind::If(ref cond, ref then, ref else_opt) => {
925 let else_ln = self.propagate_through_opt_expr(else_opt.as_deref(), succ);
926 let then_ln = self.propagate_through_expr(&then, succ);
927 let ln = self.live_node(expr.hir_id, expr.span);
928 self.init_from_succ(ln, else_ln);
929 self.merge_from_succ(ln, then_ln);
930 self.propagate_through_expr(&cond, ln)
933 hir::ExprKind::Match(ref e, arms, _) => {
948 let ln = self.live_node(expr.hir_id, expr.span);
949 self.init_empty(ln, succ);
951 let body_succ = self.propagate_through_expr(&arm.body, succ);
953 let guard_succ = arm.guard.as_ref().map_or(body_succ, |g| match g {
954 hir::Guard::If(e) => self.propagate_through_expr(e, body_succ),
955 hir::Guard::IfLet(let_expr) => {
956 let let_bind = self.define_bindings_in_pat(let_expr.pat, body_succ);
957 self.propagate_through_expr(let_expr.init, let_bind)
960 let arm_succ = self.define_bindings_in_pat(&arm.pat, guard_succ);
961 self.merge_from_succ(ln, arm_succ);
963 self.propagate_through_expr(&e, ln)
966 hir::ExprKind::Ret(ref o_e) => {
967 // Ignore succ and subst exit_ln.
968 self.propagate_through_opt_expr(o_e.as_deref(), self.exit_ln)
971 hir::ExprKind::Break(label, ref opt_expr) => {
972 // Find which label this break jumps to
973 let target = match label.target_id {
974 Ok(hir_id) => self.break_ln.get(&hir_id),
975 Err(err) => span_bug!(expr.span, "loop scope error: {}", err),
979 // Now that we know the label we're going to,
980 // look it up in the break loop nodes table
983 Some(b) => self.propagate_through_opt_expr(opt_expr.as_deref(), b),
984 None => span_bug!(expr.span, "`break` to unknown label"),
988 hir::ExprKind::Continue(label) => {
989 // Find which label this expr continues to
992 .unwrap_or_else(|err| span_bug!(expr.span, "loop scope error: {}", err));
994 // Now that we know the label we're going to,
995 // look it up in the continue loop nodes table
999 .unwrap_or_else(|| span_bug!(expr.span, "continue to unknown label"))
1002 hir::ExprKind::Assign(ref l, ref r, _) => {
1003 // see comment on places in
1004 // propagate_through_place_components()
1005 let succ = self.write_place(&l, succ, ACC_WRITE);
1006 let succ = self.propagate_through_place_components(&l, succ);
1007 self.propagate_through_expr(&r, succ)
1010 hir::ExprKind::AssignOp(_, ref l, ref r) => {
1011 // an overloaded assign op is like a method call
1012 if self.typeck_results.is_method_call(expr) {
1013 let succ = self.propagate_through_expr(&l, succ);
1014 self.propagate_through_expr(&r, succ)
1016 // see comment on places in
1017 // propagate_through_place_components()
1018 let succ = self.write_place(&l, succ, ACC_WRITE | ACC_READ);
1019 let succ = self.propagate_through_expr(&r, succ);
1020 self.propagate_through_place_components(&l, succ)
1024 // Uninteresting cases: just propagate in rev exec order
1025 hir::ExprKind::Array(ref exprs) => self.propagate_through_exprs(exprs, succ),
1027 hir::ExprKind::Struct(_, ref fields, ref with_expr) => {
1028 let succ = self.propagate_through_opt_expr(with_expr.as_deref(), succ);
1032 .fold(succ, |succ, field| self.propagate_through_expr(&field.expr, succ))
1035 hir::ExprKind::Call(ref f, ref args) => {
1036 let succ = self.check_is_ty_uninhabited(expr, succ);
1037 let succ = self.propagate_through_exprs(args, succ);
1038 self.propagate_through_expr(&f, succ)
1041 hir::ExprKind::MethodCall(.., receiver, ref args, _) => {
1042 let succ = self.check_is_ty_uninhabited(expr, succ);
1043 let succ = self.propagate_through_exprs(args, succ);
1044 self.propagate_through_expr(receiver, succ)
1047 hir::ExprKind::Tup(ref exprs) => self.propagate_through_exprs(exprs, succ),
1049 hir::ExprKind::Binary(op, ref l, ref r) if op.node.is_lazy() => {
1050 let r_succ = self.propagate_through_expr(&r, succ);
1052 let ln = self.live_node(expr.hir_id, expr.span);
1053 self.init_from_succ(ln, succ);
1054 self.merge_from_succ(ln, r_succ);
1056 self.propagate_through_expr(&l, ln)
1059 hir::ExprKind::Index(ref l, ref r) | hir::ExprKind::Binary(_, ref l, ref r) => {
1060 let r_succ = self.propagate_through_expr(&r, succ);
1061 self.propagate_through_expr(&l, r_succ)
1064 hir::ExprKind::Box(ref e)
1065 | hir::ExprKind::AddrOf(_, _, ref e)
1066 | hir::ExprKind::Cast(ref e, _)
1067 | hir::ExprKind::Type(ref e, _)
1068 | hir::ExprKind::DropTemps(ref e)
1069 | hir::ExprKind::Unary(_, ref e)
1070 | hir::ExprKind::Repeat(ref e, _) => self.propagate_through_expr(&e, succ),
1072 hir::ExprKind::InlineAsm(ref asm) => {
1073 // Handle non-returning asm
1074 let mut succ = if asm.options.contains(InlineAsmOptions::NORETURN) {
1080 // Do a first pass for writing outputs only
1081 for (op, _op_sp) in asm.operands.iter().rev() {
1083 hir::InlineAsmOperand::In { .. }
1084 | hir::InlineAsmOperand::Const { .. }
1085 | hir::InlineAsmOperand::SymFn { .. }
1086 | hir::InlineAsmOperand::SymStatic { .. } => {}
1087 hir::InlineAsmOperand::Out { expr, .. } => {
1088 if let Some(expr) = expr {
1089 succ = self.write_place(expr, succ, ACC_WRITE);
1092 hir::InlineAsmOperand::InOut { expr, .. } => {
1093 succ = self.write_place(expr, succ, ACC_READ | ACC_WRITE | ACC_USE);
1095 hir::InlineAsmOperand::SplitInOut { out_expr, .. } => {
1096 if let Some(expr) = out_expr {
1097 succ = self.write_place(expr, succ, ACC_WRITE);
1103 // Then do a second pass for inputs
1104 let mut succ = succ;
1105 for (op, _op_sp) in asm.operands.iter().rev() {
1107 hir::InlineAsmOperand::In { expr, .. } => {
1108 succ = self.propagate_through_expr(expr, succ)
1110 hir::InlineAsmOperand::Out { expr, .. } => {
1111 if let Some(expr) = expr {
1112 succ = self.propagate_through_place_components(expr, succ);
1115 hir::InlineAsmOperand::InOut { expr, .. } => {
1116 succ = self.propagate_through_place_components(expr, succ);
1118 hir::InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
1119 if let Some(expr) = out_expr {
1120 succ = self.propagate_through_place_components(expr, succ);
1122 succ = self.propagate_through_expr(in_expr, succ);
1124 hir::InlineAsmOperand::Const { .. }
1125 | hir::InlineAsmOperand::SymFn { .. }
1126 | hir::InlineAsmOperand::SymStatic { .. } => {}
1132 hir::ExprKind::Lit(..)
1133 | hir::ExprKind::ConstBlock(..)
1134 | hir::ExprKind::Err
1135 | hir::ExprKind::Path(hir::QPath::TypeRelative(..))
1136 | hir::ExprKind::Path(hir::QPath::LangItem(..)) => succ,
1138 // Note that labels have been resolved, so we don't need to look
1139 // at the label ident
1140 hir::ExprKind::Block(ref blk, _) => self.propagate_through_block(&blk, succ),
1144 fn propagate_through_place_components(&mut self, expr: &Expr<'_>, succ: LiveNode) -> LiveNode {
1147 // In general, the full flow graph structure for an
1148 // assignment/move/etc can be handled in one of two ways,
1149 // depending on whether what is being assigned is a "tracked
1150 // value" or not. A tracked value is basically a local
1151 // variable or argument.
1153 // The two kinds of graphs are:
1155 // Tracked place Untracked place
1156 // ----------------------++-----------------------
1160 // (rvalue) || (rvalue)
1163 // (write of place) || (place components)
1168 // ----------------------++-----------------------
1170 // I will cover the two cases in turn:
1174 // A tracked place is a local variable/argument `x`. In
1175 // these cases, the link_node where the write occurs is linked
1176 // to node id of `x`. The `write_place()` routine generates
1177 // the contents of this node. There are no subcomponents to
1180 // # Non-tracked places
1182 // These are places like `x[5]` or `x.f`. In that case, we
1183 // basically ignore the value which is written to but generate
1184 // reads for the components---`x` in these two examples. The
1185 // components reads are generated by
1186 // `propagate_through_place_components()` (this fn).
1190 // It is still possible to observe assignments to non-places;
1191 // these errors are detected in the later pass borrowck. We
1192 // just ignore such cases and treat them as reads.
1195 hir::ExprKind::Path(_) => succ,
1196 hir::ExprKind::Field(ref e, _) => self.propagate_through_expr(&e, succ),
1197 _ => self.propagate_through_expr(expr, succ),
1201 // see comment on propagate_through_place()
1202 fn write_place(&mut self, expr: &Expr<'_>, succ: LiveNode, acc: u32) -> LiveNode {
1204 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
1205 self.access_path(expr.hir_id, path, succ, acc)
1208 // We do not track other places, so just propagate through
1209 // to their subcomponents. Also, it may happen that
1210 // non-places occur here, because those are detected in the
1211 // later pass borrowck.
1224 let ln = self.live_node(hir_id, span);
1226 self.init_from_succ(ln, succ);
1227 let var = self.variable(var_hid, span);
1228 self.acc(ln, var, acc);
1236 path: &hir::Path<'_>,
1241 Res::Local(hid) => self.access_var(hir_id, hid, succ, acc, path.span),
1246 fn propagate_through_loop(
1249 body: &hir::Block<'_>,
1253 We model control flow like this:
1260 Note that a `continue` expression targeting the `loop` will have a successor of `expr`.
1261 Meanwhile, a `break` expression will have a successor of `succ`.
1265 let ln = self.live_node(expr.hir_id, expr.span);
1266 self.init_empty(ln, succ);
1267 debug!("propagate_through_loop: using id for loop body {} {:?}", expr.hir_id, body);
1269 self.break_ln.insert(expr.hir_id, succ);
1271 self.cont_ln.insert(expr.hir_id, ln);
1273 let body_ln = self.propagate_through_block(body, ln);
1275 // repeat until fixed point is reached:
1276 while self.merge_from_succ(ln, body_ln) {
1277 assert_eq!(body_ln, self.propagate_through_block(body, ln));
1283 fn check_is_ty_uninhabited(&mut self, expr: &Expr<'_>, succ: LiveNode) -> LiveNode {
1284 let ty = self.typeck_results.expr_ty(expr);
1285 let m = self.ir.tcx.parent_module(expr.hir_id).to_def_id();
1286 if ty.is_inhabited_from(self.ir.tcx, m, self.param_env) {
1289 match self.ir.lnks[succ] {
1290 LiveNodeKind::ExprNode(succ_span, succ_id) => {
1291 self.warn_about_unreachable(expr.span, ty, succ_span, succ_id, "expression");
1293 LiveNodeKind::VarDefNode(succ_span, succ_id) => {
1294 self.warn_about_unreachable(expr.span, ty, succ_span, succ_id, "definition");
1301 fn warn_about_unreachable(
1309 if !orig_ty.is_never() {
1310 // Unreachable code warnings are already emitted during type checking.
1311 // However, during type checking, full type information is being
1312 // calculated but not yet available, so the check for diverging
1313 // expressions due to uninhabited result types is pretty crude and
1314 // only checks whether ty.is_never(). Here, we have full type
1315 // information available and can issue warnings for less obviously
1316 // uninhabited types (e.g. empty enums). The check above is used so
1317 // that we do not emit the same warning twice if the uninhabited type
1320 let msg = format!("unreachable {}", descr);
1321 self.ir.tcx.struct_span_lint_hir(
1322 lint::builtin::UNREACHABLE_CODE,
1327 diag.span_label(expr_span, &msg)
1328 .span_label(orig_span, "any code following this expression is unreachable")
1332 "this expression has type `{}`, which is uninhabited",
1342 // _______________________________________________________________________
1343 // Checking for error conditions
1345 impl<'a, 'tcx> Visitor<'tcx> for Liveness<'a, 'tcx> {
1346 fn visit_local(&mut self, local: &'tcx hir::Local<'tcx>) {
1347 self.check_unused_vars_in_pat(&local.pat, None, None, |spans, hir_id, ln, var| {
1348 if local.init.is_some() {
1349 self.warn_about_dead_assign(spans, hir_id, ln, var);
1353 intravisit::walk_local(self, local);
1356 fn visit_expr(&mut self, ex: &'tcx Expr<'tcx>) {
1357 check_expr(self, ex);
1358 intravisit::walk_expr(self, ex);
1361 fn visit_arm(&mut self, arm: &'tcx hir::Arm<'tcx>) {
1362 self.check_unused_vars_in_pat(&arm.pat, None, None, |_, _, _, _| {});
1363 intravisit::walk_arm(self, arm);
1367 fn check_expr<'tcx>(this: &mut Liveness<'_, 'tcx>, expr: &'tcx Expr<'tcx>) {
1369 hir::ExprKind::Assign(ref l, ..) => {
1370 this.check_place(&l);
1373 hir::ExprKind::AssignOp(_, ref l, _) => {
1374 if !this.typeck_results.is_method_call(expr) {
1375 this.check_place(&l);
1379 hir::ExprKind::InlineAsm(ref asm) => {
1380 for (op, _op_sp) in asm.operands {
1382 hir::InlineAsmOperand::Out { expr, .. } => {
1383 if let Some(expr) = expr {
1384 this.check_place(expr);
1387 hir::InlineAsmOperand::InOut { expr, .. } => {
1388 this.check_place(expr);
1390 hir::InlineAsmOperand::SplitInOut { out_expr, .. } => {
1391 if let Some(out_expr) = out_expr {
1392 this.check_place(out_expr);
1400 hir::ExprKind::Let(let_expr) => {
1401 this.check_unused_vars_in_pat(let_expr.pat, None, None, |_, _, _, _| {});
1404 // no correctness conditions related to liveness
1405 hir::ExprKind::Call(..)
1406 | hir::ExprKind::MethodCall(..)
1407 | hir::ExprKind::Match(..)
1408 | hir::ExprKind::Loop(..)
1409 | hir::ExprKind::Index(..)
1410 | hir::ExprKind::Field(..)
1411 | hir::ExprKind::Array(..)
1412 | hir::ExprKind::Tup(..)
1413 | hir::ExprKind::Binary(..)
1414 | hir::ExprKind::Cast(..)
1415 | hir::ExprKind::If(..)
1416 | hir::ExprKind::DropTemps(..)
1417 | hir::ExprKind::Unary(..)
1418 | hir::ExprKind::Ret(..)
1419 | hir::ExprKind::Break(..)
1420 | hir::ExprKind::Continue(..)
1421 | hir::ExprKind::Lit(_)
1422 | hir::ExprKind::ConstBlock(..)
1423 | hir::ExprKind::Block(..)
1424 | hir::ExprKind::AddrOf(..)
1425 | hir::ExprKind::Struct(..)
1426 | hir::ExprKind::Repeat(..)
1427 | hir::ExprKind::Closure { .. }
1428 | hir::ExprKind::Path(_)
1429 | hir::ExprKind::Yield(..)
1430 | hir::ExprKind::Box(..)
1431 | hir::ExprKind::Type(..)
1432 | hir::ExprKind::Err => {}
1436 impl<'tcx> Liveness<'_, 'tcx> {
1437 fn check_place(&mut self, expr: &'tcx Expr<'tcx>) {
1439 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
1440 if let Res::Local(var_hid) = path.res {
1441 // Assignment to an immutable variable or argument: only legal
1442 // if there is no later assignment. If this local is actually
1443 // mutable, then check for a reassignment to flag the mutability
1445 let ln = self.live_node(expr.hir_id, expr.span);
1446 let var = self.variable(var_hid, expr.span);
1447 self.warn_about_dead_assign(vec![expr.span], expr.hir_id, ln, var);
1451 // For other kinds of places, no checks are required,
1452 // and any embedded expressions are actually rvalues
1453 intravisit::walk_expr(self, expr);
1458 fn should_warn(&self, var: Variable) -> Option<String> {
1459 let name = self.ir.variable_name(var);
1460 if name == kw::Empty {
1463 let name = name.as_str();
1464 if name.as_bytes()[0] == b'_' {
1467 Some(name.to_owned())
1470 fn warn_about_unused_upvars(&self, entry_ln: LiveNode) {
1471 let Some(closure_min_captures) = self.closure_min_captures else {
1475 // If closure_min_captures is Some(), upvars must be Some() too.
1476 for (&var_hir_id, min_capture_list) in closure_min_captures {
1477 for captured_place in min_capture_list {
1478 match captured_place.info.capture_kind {
1479 ty::UpvarCapture::ByValue => {}
1480 ty::UpvarCapture::ByRef(..) => continue,
1482 let span = captured_place.get_capture_kind_span(self.ir.tcx);
1483 let var = self.variable(var_hir_id, span);
1484 if self.used_on_entry(entry_ln, var) {
1485 if !self.live_on_entry(entry_ln, var) {
1486 if let Some(name) = self.should_warn(var) {
1487 self.ir.tcx.struct_span_lint_hir(
1488 lint::builtin::UNUSED_ASSIGNMENTS,
1491 format!("value captured by `{}` is never read", name),
1492 |lint| lint.help("did you mean to capture by reference instead?"),
1497 if let Some(name) = self.should_warn(var) {
1498 self.ir.tcx.struct_span_lint_hir(
1499 lint::builtin::UNUSED_VARIABLES,
1502 format!("unused variable: `{}`", name),
1503 |lint| lint.help("did you mean to capture by reference instead?"),
1511 fn warn_about_unused_args(&self, body: &hir::Body<'_>, entry_ln: LiveNode) {
1512 for p in body.params {
1513 self.check_unused_vars_in_pat(
1517 |spans, hir_id, ln, var| {
1518 if !self.live_on_entry(ln, var) {
1519 self.report_unused_assign(hir_id, spans, var, |name| {
1520 format!("value passed to `{}` is never read", name)
1528 fn check_unused_vars_in_pat(
1531 entry_ln: Option<LiveNode>,
1532 opt_body: Option<&hir::Body<'_>>,
1533 on_used_on_entry: impl Fn(Vec<Span>, HirId, LiveNode, Variable),
1535 // In an or-pattern, only consider the variable; any later patterns must have the same
1536 // bindings, and we also consider the first pattern to be the "authoritative" set of ids.
1537 // However, we should take the ids and spans of variables with the same name from the later
1538 // patterns so the suggestions to prefix with underscores will apply to those too.
1539 let mut vars: FxIndexMap<Symbol, (LiveNode, Variable, Vec<(HirId, Span, Span)>)> =
1542 pat.each_binding(|_, hir_id, pat_sp, ident| {
1543 let ln = entry_ln.unwrap_or_else(|| self.live_node(hir_id, pat_sp));
1544 let var = self.variable(hir_id, ident.span);
1545 let id_and_sp = (hir_id, pat_sp, ident.span);
1546 vars.entry(self.ir.variable_name(var))
1547 .and_modify(|(.., hir_ids_and_spans)| hir_ids_and_spans.push(id_and_sp))
1548 .or_insert_with(|| (ln, var, vec![id_and_sp]));
1551 let can_remove = match pat.kind {
1552 hir::PatKind::Struct(_, fields, true) => {
1553 // if all fields are shorthand, remove the struct field, otherwise, mark with _ as prefix
1554 fields.iter().all(|f| f.is_shorthand)
1559 for (_, (ln, var, hir_ids_and_spans)) in vars {
1560 if self.used_on_entry(ln, var) {
1561 let id = hir_ids_and_spans[0].0;
1563 hir_ids_and_spans.into_iter().map(|(_, _, ident_span)| ident_span).collect();
1564 on_used_on_entry(spans, id, ln, var);
1566 self.report_unused(hir_ids_and_spans, ln, var, can_remove, pat, opt_body);
1571 #[instrument(skip(self), level = "INFO")]
1574 hir_ids_and_spans: Vec<(HirId, Span, Span)>,
1579 opt_body: Option<&hir::Body<'_>>,
1581 let first_hir_id = hir_ids_and_spans[0].0;
1583 if let Some(name) = self.should_warn(var).filter(|name| name != "self") {
1584 // annoying: for parameters in funcs like `fn(x: i32)
1585 // {ret}`, there is only one node, so asking about
1586 // assigned_on_exit() is not meaningful.
1588 if ln == self.exit_ln { false } else { self.assigned_on_exit(ln, var) };
1591 self.ir.tcx.struct_span_lint_hir(
1592 lint::builtin::UNUSED_VARIABLES,
1596 .map(|(_, _, ident_span)| ident_span)
1597 .collect::<Vec<_>>(),
1598 format!("variable `{}` is assigned to, but never used", name),
1599 |lint| lint.note(&format!("consider using `_{}` instead", name)),
1601 } else if can_remove {
1602 self.ir.tcx.struct_span_lint_hir(
1603 lint::builtin::UNUSED_VARIABLES,
1605 hir_ids_and_spans.iter().map(|(_, pat_span, _)| *pat_span).collect::<Vec<_>>(),
1606 format!("unused variable: `{}`", name),
1608 lint.multipart_suggestion(
1609 "try removing the field",
1612 .map(|(_, pat_span, _)| {
1618 .span_extend_to_next_char(*pat_span, ',', true);
1619 (span.with_hi(BytePos(span.hi().0 + 1)), String::new())
1622 Applicability::MachineApplicable,
1627 let (shorthands, non_shorthands): (Vec<_>, Vec<_>) =
1628 hir_ids_and_spans.iter().copied().partition(|(hir_id, _, ident_span)| {
1629 let var = self.variable(*hir_id, *ident_span);
1630 self.ir.variable_is_shorthand(var)
1633 // If we have both shorthand and non-shorthand, prefer the "try ignoring
1634 // the field" message, and suggest `_` for the non-shorthands. If we only
1635 // have non-shorthand, then prefix with an underscore instead.
1636 if !shorthands.is_empty() {
1637 let shorthands = shorthands
1639 .map(|(_, pat_span, _)| (pat_span, format!("{}: _", name)))
1643 .map(|(_, pat_span, _)| (pat_span, "_".to_string())),
1645 .collect::<Vec<_>>();
1647 self.ir.tcx.struct_span_lint_hir(
1648 lint::builtin::UNUSED_VARIABLES,
1652 .map(|(_, pat_span, _)| *pat_span)
1653 .collect::<Vec<_>>(),
1654 format!("unused variable: `{}`", name),
1656 lint.multipart_suggestion(
1657 "try ignoring the field",
1659 Applicability::MachineApplicable,
1664 let non_shorthands = non_shorthands
1666 .map(|(_, _, ident_span)| (ident_span, format!("_{}", name)))
1667 .collect::<Vec<_>>();
1669 self.ir.tcx.struct_span_lint_hir(
1670 lint::builtin::UNUSED_VARIABLES,
1674 .map(|(_, _, ident_span)| *ident_span)
1675 .collect::<Vec<_>>(),
1676 format!("unused variable: `{}`", name),
1678 if self.has_added_lit_match_name_span(&name, opt_body, lint) {
1679 lint.span_label(pat.span, "unused variable");
1681 lint.multipart_suggestion(
1682 "if this is intentional, prefix it with an underscore",
1684 Applicability::MachineApplicable,
1693 fn has_added_lit_match_name_span(
1696 opt_body: Option<&hir::Body<'_>>,
1697 err: &mut Diagnostic,
1699 let mut has_litstring = false;
1700 let Some(opt_body) = opt_body else {return false;};
1701 let mut visitor = CollectLitsVisitor { lit_exprs: vec![] };
1702 intravisit::walk_body(&mut visitor, opt_body);
1703 for lit_expr in visitor.lit_exprs {
1704 let hir::ExprKind::Lit(litx) = &lit_expr.kind else { continue };
1705 let rustc_ast::LitKind::Str(syb, _) = litx.node else{ continue; };
1706 let name_str: &str = syb.as_str();
1707 let mut name_pa = String::from("{");
1708 name_pa.push_str(&name);
1710 if name_str.contains(&name_pa) {
1713 "you might have meant to use string interpolation in this string literal",
1715 err.multipart_suggestion(
1716 "string interpolation only works in `format!` invocations",
1718 (lit_expr.span.shrink_to_lo(), "format!(".to_string()),
1719 (lit_expr.span.shrink_to_hi(), ")".to_string()),
1721 Applicability::MachineApplicable,
1723 has_litstring = true;
1729 fn warn_about_dead_assign(&self, spans: Vec<Span>, hir_id: HirId, ln: LiveNode, var: Variable) {
1730 if !self.live_on_exit(ln, var) {
1731 self.report_unused_assign(hir_id, spans, var, |name| {
1732 format!("value assigned to `{}` is never read", name)
1737 fn report_unused_assign(
1742 message: impl Fn(&str) -> String,
1744 if let Some(name) = self.should_warn(var) {
1745 self.ir.tcx.struct_span_lint_hir(
1746 lint::builtin::UNUSED_ASSIGNMENTS,
1750 |lint| lint.help("maybe it is overwritten before being read?"),