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 `invalid_node()`, 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 `invalid_node()`, 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 `Specials` struct.
84 use self::LiveNodeKind::*;
87 use rustc_ast::ast::InlineAsmOptions;
88 use rustc_data_structures::fx::FxIndexMap;
89 use rustc_errors::Applicability;
91 use rustc_hir::def::*;
92 use rustc_hir::def_id::LocalDefId;
93 use rustc_hir::intravisit::{self, FnKind, NestedVisitorMap, Visitor};
94 use rustc_hir::{Expr, HirId, HirIdMap, HirIdSet, Node};
95 use rustc_middle::hir::map::Map;
96 use rustc_middle::ty::query::Providers;
97 use rustc_middle::ty::{self, TyCtxt};
98 use rustc_session::lint;
99 use rustc_span::symbol::{sym, Symbol};
100 use rustc_span::Span;
102 use std::collections::VecDeque;
105 use std::io::prelude::*;
108 #[derive(Copy, Clone, PartialEq)]
109 struct Variable(u32);
111 #[derive(Copy, Clone, PartialEq)]
112 struct LiveNode(u32);
115 fn get(&self) -> usize {
121 fn get(&self) -> usize {
126 #[derive(Copy, Clone, PartialEq, Debug)]
135 fn live_node_kind_to_string(lnk: LiveNodeKind, tcx: TyCtxt<'_>) -> String {
136 let sm = tcx.sess.source_map();
138 UpvarNode(s) => format!("Upvar node [{}]", sm.span_to_string(s)),
139 ExprNode(s) => format!("Expr node [{}]", sm.span_to_string(s)),
140 VarDefNode(s) => format!("Var def node [{}]", sm.span_to_string(s)),
141 ClosureNode => "Closure node".to_owned(),
142 ExitNode => "Exit node".to_owned(),
146 impl<'tcx> Visitor<'tcx> for IrMaps<'tcx> {
147 type Map = Map<'tcx>;
149 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
150 NestedVisitorMap::OnlyBodies(self.tcx.hir())
156 fd: &'tcx hir::FnDecl<'tcx>,
161 visit_fn(self, fk, fd, b, s, id);
164 fn visit_local(&mut self, l: &'tcx hir::Local<'tcx>) {
165 visit_local(self, l);
167 fn visit_expr(&mut self, ex: &'tcx Expr<'tcx>) {
168 visit_expr(self, ex);
170 fn visit_arm(&mut self, a: &'tcx hir::Arm<'tcx>) {
175 fn check_mod_liveness(tcx: TyCtxt<'_>, module_def_id: LocalDefId) {
176 tcx.hir().visit_item_likes_in_module(
178 &mut IrMaps::new(tcx, module_def_id).as_deep_visitor(),
182 pub fn provide(providers: &mut Providers<'_>) {
183 *providers = Providers { check_mod_liveness, ..*providers };
186 impl fmt::Debug for LiveNode {
187 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
188 write!(f, "ln({})", self.get())
192 impl fmt::Debug for Variable {
193 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
194 write!(f, "v({})", self.get())
198 // ______________________________________________________________________
201 // This is the first pass and the one that drives the main
202 // computation. It walks up and down the IR once. On the way down,
203 // we count for each function the number of variables as well as
204 // liveness nodes. A liveness node is basically an expression or
205 // capture clause that does something of interest: either it has
206 // interesting control flow or it uses/defines a local variable.
208 // On the way back up, at each function node we create liveness sets
209 // (we now know precisely how big to make our various vectors and so
210 // forth) and then do the data-flow propagation to compute the set
211 // of live variables at each program point.
213 // Finally, we run back over the IR one last time and, using the
214 // computed liveness, check various safety conditions. For example,
215 // there must be no live nodes at the definition site for a variable
216 // unless it has an initializer. Similarly, each non-mutable local
217 // variable must not be assigned if there is some successor
218 // assignment. And so forth.
221 fn is_valid(&self) -> bool {
226 fn invalid_node() -> LiveNode {
235 #[derive(Copy, Clone, Debug)]
242 #[derive(Copy, Clone, Debug)]
244 Param(HirId, Symbol),
246 Upvar(HirId, Symbol),
249 struct IrMaps<'tcx> {
251 body_owner: LocalDefId,
252 num_live_nodes: usize,
254 live_node_map: HirIdMap<LiveNode>,
255 variable_map: HirIdMap<Variable>,
256 capture_info_map: HirIdMap<Rc<Vec<CaptureInfo>>>,
257 var_kinds: Vec<VarKind>,
258 lnks: Vec<LiveNodeKind>,
262 fn new(tcx: TyCtxt<'tcx>, body_owner: LocalDefId) -> IrMaps<'tcx> {
268 live_node_map: HirIdMap::default(),
269 variable_map: HirIdMap::default(),
270 capture_info_map: Default::default(),
271 var_kinds: Vec::new(),
276 fn add_live_node(&mut self, lnk: LiveNodeKind) -> LiveNode {
277 let ln = LiveNode(self.num_live_nodes as u32);
279 self.num_live_nodes += 1;
281 debug!("{:?} is of kind {}", ln, live_node_kind_to_string(lnk, self.tcx));
286 fn add_live_node_for_node(&mut self, hir_id: HirId, lnk: LiveNodeKind) {
287 let ln = self.add_live_node(lnk);
288 self.live_node_map.insert(hir_id, ln);
290 debug!("{:?} is node {:?}", ln, hir_id);
293 fn add_variable(&mut self, vk: VarKind) -> Variable {
294 let v = Variable(self.num_vars as u32);
295 self.var_kinds.push(vk);
299 Local(LocalInfo { id: node_id, .. }) | Param(node_id, _) | Upvar(node_id, _) => {
300 self.variable_map.insert(node_id, v);
304 debug!("{:?} is {:?}", v, vk);
309 fn variable(&self, hir_id: HirId, span: Span) -> Variable {
310 match self.variable_map.get(&hir_id) {
313 span_bug!(span, "no variable registered for id {:?}", hir_id);
318 fn variable_name(&self, var: Variable) -> String {
319 match self.var_kinds[var.get()] {
320 Local(LocalInfo { name, .. }) | Param(_, name) | Upvar(_, name) => name.to_string(),
324 fn variable_is_shorthand(&self, var: Variable) -> bool {
325 match self.var_kinds[var.get()] {
326 Local(LocalInfo { is_shorthand, .. }) => is_shorthand,
327 Param(..) | Upvar(..) => false,
331 fn set_captures(&mut self, hir_id: HirId, cs: Vec<CaptureInfo>) {
332 self.capture_info_map.insert(hir_id, Rc::new(cs));
335 fn lnk(&self, ln: LiveNode) -> LiveNodeKind {
341 ir: &mut IrMaps<'tcx>,
343 decl: &'tcx hir::FnDecl<'tcx>,
344 body_id: hir::BodyId,
348 debug!("visit_fn {:?}", id);
350 // swap in a new set of IR maps for this function body:
351 let def_id = ir.tcx.hir().local_def_id(id);
352 let mut fn_maps = IrMaps::new(ir.tcx, def_id);
354 // Don't run unused pass for #[derive()]
355 if let FnKind::Method(..) = fk {
356 let parent = ir.tcx.hir().get_parent_item(id);
357 if let Some(Node::Item(i)) = ir.tcx.hir().find(parent) {
358 if i.attrs.iter().any(|a| a.check_name(sym::automatically_derived)) {
364 debug!("creating fn_maps: {:p}", &fn_maps);
366 let body = ir.tcx.hir().body(body_id);
368 if let Some(upvars) = ir.tcx.upvars_mentioned(def_id) {
369 for (&var_hir_id, _upvar) in upvars {
370 debug!("adding upvar {:?}", var_hir_id);
371 let var_name = ir.tcx.hir().name(var_hir_id);
372 fn_maps.add_variable(Upvar(var_hir_id, var_name));
376 for param in body.params {
377 let is_shorthand = match param.pat.kind {
378 rustc_hir::PatKind::Struct(..) => true,
381 param.pat.each_binding(|_bm, hir_id, _x, ident| {
382 debug!("adding parameters {:?}", hir_id);
383 let var = if is_shorthand {
384 Local(LocalInfo { id: hir_id, name: ident.name, is_shorthand: true })
386 Param(hir_id, ident.name)
388 fn_maps.add_variable(var);
392 // gather up the various local variables, significant expressions,
394 intravisit::walk_fn(&mut fn_maps, fk, decl, body_id, sp, id);
397 let mut lsets = Liveness::new(&mut fn_maps, def_id);
398 let entry_ln = lsets.compute(fk, &body, sp, id);
399 lsets.log_liveness(entry_ln, id);
401 // check for various error conditions
402 lsets.visit_body(body);
403 lsets.warn_about_unused_upvars(entry_ln);
404 lsets.warn_about_unused_args(body, entry_ln);
407 fn add_from_pat(ir: &mut IrMaps<'_>, pat: &hir::Pat<'_>) {
408 // For struct patterns, take note of which fields used shorthand
409 // (`x` rather than `x: x`).
410 let mut shorthand_field_ids = HirIdSet::default();
411 let mut pats = VecDeque::new();
413 while let Some(pat) = pats.pop_front() {
414 use rustc_hir::PatKind::*;
416 Binding(.., inner_pat) => {
417 pats.extend(inner_pat.iter());
419 Struct(_, fields, _) => {
420 let ids = fields.iter().filter(|f| f.is_shorthand).map(|f| f.pat.hir_id);
421 shorthand_field_ids.extend(ids);
423 Ref(inner_pat, _) | Box(inner_pat) => {
424 pats.push_back(inner_pat);
426 TupleStruct(_, inner_pats, _) | Tuple(inner_pats, _) | Or(inner_pats) => {
427 pats.extend(inner_pats.iter());
429 Slice(pre_pats, inner_pat, post_pats) => {
430 pats.extend(pre_pats.iter());
431 pats.extend(inner_pat.iter());
432 pats.extend(post_pats.iter());
438 pat.each_binding(|_, hir_id, _, ident| {
439 ir.add_live_node_for_node(hir_id, VarDefNode(ident.span));
440 ir.add_variable(Local(LocalInfo {
443 is_shorthand: shorthand_field_ids.contains(&hir_id),
448 fn visit_local<'tcx>(ir: &mut IrMaps<'tcx>, local: &'tcx hir::Local<'tcx>) {
449 add_from_pat(ir, &local.pat);
450 intravisit::walk_local(ir, local);
453 fn visit_arm<'tcx>(ir: &mut IrMaps<'tcx>, arm: &'tcx hir::Arm<'tcx>) {
454 add_from_pat(ir, &arm.pat);
455 intravisit::walk_arm(ir, arm);
458 fn visit_expr<'tcx>(ir: &mut IrMaps<'tcx>, expr: &'tcx Expr<'tcx>) {
460 // live nodes required for uses or definitions of variables:
461 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
462 debug!("expr {}: path that leads to {:?}", expr.hir_id, path.res);
463 if let Res::Local(_var_hir_id) = path.res {
464 ir.add_live_node_for_node(expr.hir_id, ExprNode(expr.span));
466 intravisit::walk_expr(ir, expr);
468 hir::ExprKind::Closure(..) => {
469 // Interesting control flow (for loops can contain labeled
470 // breaks or continues)
471 ir.add_live_node_for_node(expr.hir_id, ExprNode(expr.span));
473 // Make a live_node for each captured variable, with the span
474 // being the location that the variable is used. This results
475 // in better error messages than just pointing at the closure
476 // construction site.
477 let mut call_caps = Vec::new();
478 let closure_def_id = ir.tcx.hir().local_def_id(expr.hir_id);
479 if let Some(upvars) = ir.tcx.upvars_mentioned(closure_def_id) {
480 call_caps.extend(upvars.iter().map(|(&var_id, upvar)| {
481 let upvar_ln = ir.add_live_node(UpvarNode(upvar.span));
482 CaptureInfo { ln: upvar_ln, var_hid: var_id }
485 ir.set_captures(expr.hir_id, call_caps);
486 let old_body_owner = ir.body_owner;
487 ir.body_owner = closure_def_id;
488 intravisit::walk_expr(ir, expr);
489 ir.body_owner = old_body_owner;
492 // live nodes required for interesting control flow:
493 hir::ExprKind::Match(..) | hir::ExprKind::Loop(..) => {
494 ir.add_live_node_for_node(expr.hir_id, ExprNode(expr.span));
495 intravisit::walk_expr(ir, expr);
497 hir::ExprKind::Binary(op, ..) if op.node.is_lazy() => {
498 ir.add_live_node_for_node(expr.hir_id, ExprNode(expr.span));
499 intravisit::walk_expr(ir, expr);
502 // otherwise, live nodes are not required:
503 hir::ExprKind::Index(..)
504 | hir::ExprKind::Field(..)
505 | hir::ExprKind::Array(..)
506 | hir::ExprKind::Call(..)
507 | hir::ExprKind::MethodCall(..)
508 | hir::ExprKind::Tup(..)
509 | hir::ExprKind::Binary(..)
510 | hir::ExprKind::AddrOf(..)
511 | hir::ExprKind::Cast(..)
512 | hir::ExprKind::DropTemps(..)
513 | hir::ExprKind::Unary(..)
514 | hir::ExprKind::Break(..)
515 | hir::ExprKind::Continue(_)
516 | hir::ExprKind::Lit(_)
517 | hir::ExprKind::Ret(..)
518 | hir::ExprKind::Block(..)
519 | hir::ExprKind::Assign(..)
520 | hir::ExprKind::AssignOp(..)
521 | hir::ExprKind::Struct(..)
522 | hir::ExprKind::Repeat(..)
523 | hir::ExprKind::InlineAsm(..)
524 | hir::ExprKind::LlvmInlineAsm(..)
525 | hir::ExprKind::Box(..)
526 | hir::ExprKind::Yield(..)
527 | hir::ExprKind::Type(..)
529 | hir::ExprKind::Path(hir::QPath::TypeRelative(..)) => {
530 intravisit::walk_expr(ir, expr);
535 // ______________________________________________________________________
536 // Computing liveness sets
538 // Actually we compute just a bit more than just liveness, but we use
539 // the same basic propagation framework in all cases.
541 #[derive(Clone, Copy)]
548 /// Conceptually, this is like a `Vec<RWU>`. But the number of `RWU`s can get
549 /// very large, so it uses a more compact representation that takes advantage
550 /// of the fact that when the number of `RWU`s is large, most of them have an
551 /// invalid reader and an invalid writer.
553 /// Each entry in `packed_rwus` is either INV_INV_FALSE, INV_INV_TRUE, or
554 /// an index into `unpacked_rwus`. In the common cases, this compacts the
555 /// 65 bits of data into 32; in the uncommon cases, it expands the 65 bits
558 /// More compact representations are possible -- e.g., use only 2 bits per
559 /// packed `RWU` and make the secondary table a HashMap that maps from
560 /// indices to `RWU`s -- but this one strikes a good balance between size
562 packed_rwus: Vec<u32>,
563 unpacked_rwus: Vec<RWU>,
566 // A constant representing `RWU { reader: invalid_node(); writer: invalid_node(); used: false }`.
567 const INV_INV_FALSE: u32 = u32::MAX;
569 // A constant representing `RWU { reader: invalid_node(); writer: invalid_node(); used: true }`.
570 const INV_INV_TRUE: u32 = u32::MAX - 1;
573 fn new(num_rwus: usize) -> RWUTable {
574 Self { packed_rwus: vec![INV_INV_FALSE; num_rwus], unpacked_rwus: vec![] }
577 fn get(&self, idx: usize) -> RWU {
578 let packed_rwu = self.packed_rwus[idx];
580 INV_INV_FALSE => RWU { reader: invalid_node(), writer: invalid_node(), used: false },
581 INV_INV_TRUE => RWU { reader: invalid_node(), writer: invalid_node(), used: true },
582 _ => self.unpacked_rwus[packed_rwu as usize],
586 fn get_reader(&self, idx: usize) -> LiveNode {
587 let packed_rwu = self.packed_rwus[idx];
589 INV_INV_FALSE | INV_INV_TRUE => invalid_node(),
590 _ => self.unpacked_rwus[packed_rwu as usize].reader,
594 fn get_writer(&self, idx: usize) -> LiveNode {
595 let packed_rwu = self.packed_rwus[idx];
597 INV_INV_FALSE | INV_INV_TRUE => invalid_node(),
598 _ => self.unpacked_rwus[packed_rwu as usize].writer,
602 fn get_used(&self, idx: usize) -> bool {
603 let packed_rwu = self.packed_rwus[idx];
605 INV_INV_FALSE => false,
606 INV_INV_TRUE => true,
607 _ => self.unpacked_rwus[packed_rwu as usize].used,
612 fn copy_packed(&mut self, dst_idx: usize, src_idx: usize) {
613 self.packed_rwus[dst_idx] = self.packed_rwus[src_idx];
616 fn assign_unpacked(&mut self, idx: usize, rwu: RWU) {
617 if rwu.reader == invalid_node() && rwu.writer == invalid_node() {
618 // When we overwrite an indexing entry in `self.packed_rwus` with
619 // `INV_INV_{TRUE,FALSE}` we don't remove the corresponding entry
620 // from `self.unpacked_rwus`; it's not worth the effort, and we
621 // can't have entries shifting around anyway.
622 self.packed_rwus[idx] = if rwu.used { INV_INV_TRUE } else { INV_INV_FALSE }
624 // Add a new RWU to `unpacked_rwus` and make `packed_rwus[idx]`
626 self.packed_rwus[idx] = self.unpacked_rwus.len() as u32;
627 self.unpacked_rwus.push(rwu);
631 fn assign_inv_inv(&mut self, idx: usize) {
632 self.packed_rwus[idx] = if self.get_used(idx) { INV_INV_TRUE } else { INV_INV_FALSE };
636 #[derive(Copy, Clone)]
638 /// A live node representing a point of execution before closure entry &
639 /// after closure exit. Used to calculate liveness of captured variables
640 /// through calls to the same closure. Used for Fn & FnMut closures only.
641 closure_ln: LiveNode,
642 /// A live node representing every 'exit' from the function, whether it be
643 /// by explicit return, panic, or other means.
647 const ACC_READ: u32 = 1;
648 const ACC_WRITE: u32 = 2;
649 const ACC_USE: u32 = 4;
651 struct Liveness<'a, 'tcx> {
652 ir: &'a mut IrMaps<'tcx>,
653 tables: &'a ty::TypeckTables<'tcx>,
654 param_env: ty::ParamEnv<'tcx>,
656 successors: Vec<LiveNode>,
659 // mappings from loop node ID to LiveNode
660 // ("break" label should map to loop node ID,
661 // it probably doesn't now)
662 break_ln: HirIdMap<LiveNode>,
663 cont_ln: HirIdMap<LiveNode>,
666 impl<'a, 'tcx> Liveness<'a, 'tcx> {
667 fn new(ir: &'a mut IrMaps<'tcx>, def_id: LocalDefId) -> Liveness<'a, 'tcx> {
668 let specials = Specials {
669 closure_ln: ir.add_live_node(ClosureNode),
670 exit_ln: ir.add_live_node(ExitNode),
673 let tables = ir.tcx.typeck_tables_of(def_id);
674 let param_env = ir.tcx.param_env(def_id);
676 let num_live_nodes = ir.num_live_nodes;
677 let num_vars = ir.num_vars;
684 successors: vec![invalid_node(); num_live_nodes],
685 rwu_table: RWUTable::new(num_live_nodes * num_vars),
686 break_ln: Default::default(),
687 cont_ln: Default::default(),
691 fn live_node(&self, hir_id: HirId, span: Span) -> LiveNode {
692 match self.ir.live_node_map.get(&hir_id) {
695 // This must be a mismatch between the ir_map construction
696 // above and the propagation code below; the two sets of
697 // code have to agree about which AST nodes are worth
698 // creating liveness nodes for.
699 span_bug!(span, "no live node registered for node {:?}", hir_id);
704 fn variable(&self, hir_id: HirId, span: Span) -> Variable {
705 self.ir.variable(hir_id, span)
708 fn define_bindings_in_pat(&mut self, pat: &hir::Pat<'_>, mut succ: LiveNode) -> LiveNode {
709 // In an or-pattern, only consider the first pattern; any later patterns
710 // must have the same bindings, and we also consider the first pattern
711 // to be the "authoritative" set of ids.
712 pat.each_binding_or_first(&mut |_, hir_id, pat_sp, ident| {
713 let ln = self.live_node(hir_id, pat_sp);
714 let var = self.variable(hir_id, ident.span);
715 self.init_from_succ(ln, succ);
716 self.define(ln, var);
722 fn idx(&self, ln: LiveNode, var: Variable) -> usize {
723 ln.get() * self.ir.num_vars + var.get()
726 fn live_on_entry(&self, ln: LiveNode, var: Variable) -> Option<LiveNodeKind> {
727 assert!(ln.is_valid());
728 let reader = self.rwu_table.get_reader(self.idx(ln, var));
729 if reader.is_valid() { Some(self.ir.lnk(reader)) } else { None }
732 // Is this variable live on entry to any of its successor nodes?
733 fn live_on_exit(&self, ln: LiveNode, var: Variable) -> Option<LiveNodeKind> {
734 let successor = self.successors[ln.get()];
735 self.live_on_entry(successor, var)
738 fn used_on_entry(&self, ln: LiveNode, var: Variable) -> bool {
739 assert!(ln.is_valid());
740 self.rwu_table.get_used(self.idx(ln, var))
743 fn assigned_on_entry(&self, ln: LiveNode, var: Variable) -> Option<LiveNodeKind> {
744 assert!(ln.is_valid());
745 let writer = self.rwu_table.get_writer(self.idx(ln, var));
746 if writer.is_valid() { Some(self.ir.lnk(writer)) } else { None }
749 fn assigned_on_exit(&self, ln: LiveNode, var: Variable) -> Option<LiveNodeKind> {
750 let successor = self.successors[ln.get()];
751 self.assigned_on_entry(successor, var)
754 fn indices2<F>(&mut self, ln: LiveNode, succ_ln: LiveNode, mut op: F)
756 F: FnMut(&mut Liveness<'a, 'tcx>, usize, usize),
758 let node_base_idx = self.idx(ln, Variable(0));
759 let succ_base_idx = self.idx(succ_ln, Variable(0));
760 for var_idx in 0..self.ir.num_vars {
761 op(self, node_base_idx + var_idx, succ_base_idx + var_idx);
765 fn write_vars<F>(&self, wr: &mut dyn Write, ln: LiveNode, mut test: F) -> io::Result<()>
767 F: FnMut(usize) -> bool,
769 let node_base_idx = self.idx(ln, Variable(0));
770 for var_idx in 0..self.ir.num_vars {
771 let idx = node_base_idx + var_idx;
773 write!(wr, " {:?}", Variable(var_idx as u32))?;
779 #[allow(unused_must_use)]
780 fn ln_str(&self, ln: LiveNode) -> String {
781 let mut wr = Vec::new();
783 let wr = &mut wr as &mut dyn Write;
784 write!(wr, "[ln({:?}) of kind {:?} reads", ln.get(), self.ir.lnk(ln));
785 self.write_vars(wr, ln, |idx| self.rwu_table.get_reader(idx).is_valid());
786 write!(wr, " writes");
787 self.write_vars(wr, ln, |idx| self.rwu_table.get_writer(idx).is_valid());
789 self.write_vars(wr, ln, |idx| self.rwu_table.get_used(idx));
791 write!(wr, " precedes {:?}]", self.successors[ln.get()]);
793 String::from_utf8(wr).unwrap()
796 fn log_liveness(&self, entry_ln: LiveNode, hir_id: hir::HirId) {
797 // hack to skip the loop unless debug! is enabled:
799 "^^ liveness computation results for body {} (entry={:?})",
801 for ln_idx in 0..self.ir.num_live_nodes {
802 debug!("{:?}", self.ln_str(LiveNode(ln_idx as u32)));
810 fn init_empty(&mut self, ln: LiveNode, succ_ln: LiveNode) {
811 self.successors[ln.get()] = succ_ln;
813 // It is not necessary to initialize the RWUs here because they are all
814 // set to INV_INV_FALSE when they are created, and the sets only grow
815 // during iterations.
818 fn init_from_succ(&mut self, ln: LiveNode, succ_ln: LiveNode) {
819 // more efficient version of init_empty() / merge_from_succ()
820 self.successors[ln.get()] = succ_ln;
822 self.indices2(ln, succ_ln, |this, idx, succ_idx| {
823 this.rwu_table.copy_packed(idx, succ_idx);
825 debug!("init_from_succ(ln={}, succ={})", self.ln_str(ln), self.ln_str(succ_ln));
828 fn merge_from_succ(&mut self, ln: LiveNode, succ_ln: LiveNode, first_merge: bool) -> bool {
833 let mut any_changed = false;
834 self.indices2(ln, succ_ln, |this, idx, succ_idx| {
835 // This is a special case, pulled out from the code below, where we
836 // don't have to do anything. It occurs about 60-70% of the time.
837 if this.rwu_table.packed_rwus[succ_idx] == INV_INV_FALSE {
841 let mut changed = false;
842 let mut rwu = this.rwu_table.get(idx);
843 let succ_rwu = this.rwu_table.get(succ_idx);
844 if succ_rwu.reader.is_valid() && !rwu.reader.is_valid() {
845 rwu.reader = succ_rwu.reader;
849 if succ_rwu.writer.is_valid() && !rwu.writer.is_valid() {
850 rwu.writer = succ_rwu.writer;
854 if succ_rwu.used && !rwu.used {
860 this.rwu_table.assign_unpacked(idx, rwu);
866 "merge_from_succ(ln={:?}, succ={}, first_merge={}, changed={})",
868 self.ln_str(succ_ln),
875 // Indicates that a local variable was *defined*; we know that no
876 // uses of the variable can precede the definition (resolve checks
877 // this) so we just clear out all the data.
878 fn define(&mut self, writer: LiveNode, var: Variable) {
879 let idx = self.idx(writer, var);
880 self.rwu_table.assign_inv_inv(idx);
882 debug!("{:?} defines {:?} (idx={}): {}", writer, var, idx, self.ln_str(writer));
885 // Either read, write, or both depending on the acc bitset
886 fn acc(&mut self, ln: LiveNode, var: Variable, acc: u32) {
887 debug!("{:?} accesses[{:x}] {:?}: {}", ln, acc, var, self.ln_str(ln));
889 let idx = self.idx(ln, var);
890 let mut rwu = self.rwu_table.get(idx);
892 if (acc & ACC_WRITE) != 0 {
893 rwu.reader = invalid_node();
897 // Important: if we both read/write, must do read second
898 // or else the write will override.
899 if (acc & ACC_READ) != 0 {
903 if (acc & ACC_USE) != 0 {
907 self.rwu_table.assign_unpacked(idx, rwu);
913 body: &hir::Body<'_>,
917 debug!("compute: using id for body, {:?}", body.value);
919 // # Liveness of captured variables
921 // When computing the liveness for captured variables we take into
922 // account how variable is captured (ByRef vs ByValue) and what is the
923 // closure kind (Generator / FnOnce vs Fn / FnMut).
925 // Variables captured by reference are assumed to be used on the exit
928 // In FnOnce closures, variables captured by value are known to be dead
929 // on exit since it is impossible to call the closure again.
931 // In Fn / FnMut closures, variables captured by value are live on exit
932 // if they are live on the entry to the closure, since only the closure
933 // itself can access them on subsequent calls.
935 if let Some(upvars) = self.ir.tcx.upvars_mentioned(self.ir.body_owner) {
936 // Mark upvars captured by reference as used after closure exits.
937 for (&var_hir_id, upvar) in upvars.iter().rev() {
938 let upvar_id = ty::UpvarId {
939 var_path: ty::UpvarPath { hir_id: var_hir_id },
940 closure_expr_id: self.ir.body_owner,
942 match self.tables.upvar_capture(upvar_id) {
943 ty::UpvarCapture::ByRef(_) => {
944 let var = self.variable(var_hir_id, upvar.span);
945 self.acc(self.s.exit_ln, var, ACC_READ | ACC_USE);
947 ty::UpvarCapture::ByValue => {}
952 let succ = self.propagate_through_expr(&body.value, self.s.exit_ln);
955 FnKind::Method(..) | FnKind::ItemFn(..) => return succ,
956 FnKind::Closure(..) => {}
959 let ty = self.tables.node_type(id);
961 ty::Closure(_def_id, substs) => match substs.as_closure().kind() {
962 ty::ClosureKind::Fn => {}
963 ty::ClosureKind::FnMut => {}
964 ty::ClosureKind::FnOnce => return succ,
966 ty::Generator(..) => return succ,
968 span_bug!(span, "type of closure expr {:?} is not a closure {:?}", id, ty,);
972 // Propagate through calls to the closure.
973 let mut first_merge = true;
975 self.init_from_succ(self.s.closure_ln, succ);
976 for param in body.params {
977 param.pat.each_binding(|_bm, hir_id, _x, ident| {
978 let var = self.variable(hir_id, ident.span);
979 self.define(self.s.closure_ln, var);
983 if !self.merge_from_succ(self.s.exit_ln, self.s.closure_ln, first_merge) {
987 assert_eq!(succ, self.propagate_through_expr(&body.value, self.s.exit_ln));
993 fn propagate_through_block(&mut self, blk: &hir::Block<'_>, succ: LiveNode) -> LiveNode {
994 if blk.targeted_by_break {
995 self.break_ln.insert(blk.hir_id, succ);
997 let succ = self.propagate_through_opt_expr(blk.expr.as_deref(), succ);
998 blk.stmts.iter().rev().fold(succ, |succ, stmt| self.propagate_through_stmt(stmt, succ))
1001 fn propagate_through_stmt(&mut self, stmt: &hir::Stmt<'_>, succ: LiveNode) -> LiveNode {
1003 hir::StmtKind::Local(ref local) => {
1004 // Note: we mark the variable as defined regardless of whether
1005 // there is an initializer. Initially I had thought to only mark
1006 // the live variable as defined if it was initialized, and then we
1007 // could check for uninit variables just by scanning what is live
1008 // at the start of the function. But that doesn't work so well for
1009 // immutable variables defined in a loop:
1010 // loop { let x; x = 5; }
1011 // because the "assignment" loops back around and generates an error.
1013 // So now we just check that variables defined w/o an
1014 // initializer are not live at the point of their
1015 // initialization, which is mildly more complex than checking
1016 // once at the func header but otherwise equivalent.
1018 let succ = self.propagate_through_opt_expr(local.init.as_deref(), succ);
1019 self.define_bindings_in_pat(&local.pat, succ)
1021 hir::StmtKind::Item(..) => succ,
1022 hir::StmtKind::Expr(ref expr) | hir::StmtKind::Semi(ref expr) => {
1023 self.propagate_through_expr(&expr, succ)
1028 fn propagate_through_exprs(&mut self, exprs: &[Expr<'_>], succ: LiveNode) -> LiveNode {
1029 exprs.iter().rev().fold(succ, |succ, expr| self.propagate_through_expr(&expr, succ))
1032 fn propagate_through_opt_expr(
1034 opt_expr: Option<&Expr<'_>>,
1037 opt_expr.map_or(succ, |expr| self.propagate_through_expr(expr, succ))
1040 fn propagate_through_expr(&mut self, expr: &Expr<'_>, succ: LiveNode) -> LiveNode {
1041 debug!("propagate_through_expr: {:?}", expr);
1044 // Interesting cases with control flow or which gen/kill
1045 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
1046 self.access_path(expr.hir_id, path, succ, ACC_READ | ACC_USE)
1049 hir::ExprKind::Field(ref e, _) => self.propagate_through_expr(&e, succ),
1051 hir::ExprKind::Closure(..) => {
1052 debug!("{:?} is an ExprKind::Closure", expr);
1054 // the construction of a closure itself is not important,
1055 // but we have to consider the closed over variables.
1061 .unwrap_or_else(|| span_bug!(expr.span, "no registered caps"));
1063 caps.iter().rev().fold(succ, |succ, cap| {
1064 self.init_from_succ(cap.ln, succ);
1065 let var = self.variable(cap.var_hid, expr.span);
1066 self.acc(cap.ln, var, ACC_READ | ACC_USE);
1071 // Note that labels have been resolved, so we don't need to look
1072 // at the label ident
1073 hir::ExprKind::Loop(ref blk, _, _) => self.propagate_through_loop(expr, &blk, succ),
1075 hir::ExprKind::Match(ref e, arms, _) => {
1090 let ln = self.live_node(expr.hir_id, expr.span);
1091 self.init_empty(ln, succ);
1092 let mut first_merge = true;
1094 let body_succ = self.propagate_through_expr(&arm.body, succ);
1096 let guard_succ = self.propagate_through_opt_expr(
1097 arm.guard.as_ref().map(|hir::Guard::If(e)| *e),
1100 let arm_succ = self.define_bindings_in_pat(&arm.pat, guard_succ);
1101 self.merge_from_succ(ln, arm_succ, first_merge);
1102 first_merge = false;
1104 self.propagate_through_expr(&e, ln)
1107 hir::ExprKind::Ret(ref o_e) => {
1108 // ignore succ and subst exit_ln:
1109 let exit_ln = self.s.exit_ln;
1110 self.propagate_through_opt_expr(o_e.as_ref().map(|e| &**e), exit_ln)
1113 hir::ExprKind::Break(label, ref opt_expr) => {
1114 // Find which label this break jumps to
1115 let target = match label.target_id {
1116 Ok(hir_id) => self.break_ln.get(&hir_id),
1117 Err(err) => span_bug!(expr.span, "loop scope error: {}", err),
1121 // Now that we know the label we're going to,
1122 // look it up in the break loop nodes table
1125 Some(b) => self.propagate_through_opt_expr(opt_expr.as_ref().map(|e| &**e), b),
1126 None => span_bug!(expr.span, "`break` to unknown label"),
1130 hir::ExprKind::Continue(label) => {
1131 // Find which label this expr continues to
1134 .unwrap_or_else(|err| span_bug!(expr.span, "loop scope error: {}", err));
1136 // Now that we know the label we're going to,
1137 // look it up in the continue loop nodes table
1141 .unwrap_or_else(|| span_bug!(expr.span, "continue to unknown label"))
1144 hir::ExprKind::Assign(ref l, ref r, _) => {
1145 // see comment on places in
1146 // propagate_through_place_components()
1147 let succ = self.write_place(&l, succ, ACC_WRITE);
1148 let succ = self.propagate_through_place_components(&l, succ);
1149 self.propagate_through_expr(&r, succ)
1152 hir::ExprKind::AssignOp(_, ref l, ref r) => {
1153 // an overloaded assign op is like a method call
1154 if self.tables.is_method_call(expr) {
1155 let succ = self.propagate_through_expr(&l, succ);
1156 self.propagate_through_expr(&r, succ)
1158 // see comment on places in
1159 // propagate_through_place_components()
1160 let succ = self.write_place(&l, succ, ACC_WRITE | ACC_READ);
1161 let succ = self.propagate_through_expr(&r, succ);
1162 self.propagate_through_place_components(&l, succ)
1166 // Uninteresting cases: just propagate in rev exec order
1167 hir::ExprKind::Array(ref exprs) => self.propagate_through_exprs(exprs, succ),
1169 hir::ExprKind::Struct(_, ref fields, ref with_expr) => {
1170 let succ = self.propagate_through_opt_expr(with_expr.as_ref().map(|e| &**e), succ);
1174 .fold(succ, |succ, field| self.propagate_through_expr(&field.expr, succ))
1177 hir::ExprKind::Call(ref f, ref args) => {
1178 let m = self.ir.tcx.parent_module(expr.hir_id).to_def_id();
1179 let succ = if self.ir.tcx.is_ty_uninhabited_from(
1181 self.tables.expr_ty(expr),
1188 let succ = self.propagate_through_exprs(args, succ);
1189 self.propagate_through_expr(&f, succ)
1192 hir::ExprKind::MethodCall(.., ref args, _) => {
1193 let m = self.ir.tcx.parent_module(expr.hir_id).to_def_id();
1194 let succ = if self.ir.tcx.is_ty_uninhabited_from(
1196 self.tables.expr_ty(expr),
1204 self.propagate_through_exprs(args, succ)
1207 hir::ExprKind::Tup(ref exprs) => self.propagate_through_exprs(exprs, succ),
1209 hir::ExprKind::Binary(op, ref l, ref r) if op.node.is_lazy() => {
1210 let r_succ = self.propagate_through_expr(&r, succ);
1212 let ln = self.live_node(expr.hir_id, expr.span);
1213 self.init_from_succ(ln, succ);
1214 self.merge_from_succ(ln, r_succ, false);
1216 self.propagate_through_expr(&l, ln)
1219 hir::ExprKind::Index(ref l, ref r) | hir::ExprKind::Binary(_, ref l, ref r) => {
1220 let r_succ = self.propagate_through_expr(&r, succ);
1221 self.propagate_through_expr(&l, r_succ)
1224 hir::ExprKind::Box(ref e)
1225 | hir::ExprKind::AddrOf(_, _, ref e)
1226 | hir::ExprKind::Cast(ref e, _)
1227 | hir::ExprKind::Type(ref e, _)
1228 | hir::ExprKind::DropTemps(ref e)
1229 | hir::ExprKind::Unary(_, ref e)
1230 | hir::ExprKind::Yield(ref e, _)
1231 | hir::ExprKind::Repeat(ref e, _) => self.propagate_through_expr(&e, succ),
1233 hir::ExprKind::InlineAsm(ref asm) => {
1234 // Handle non-returning asm
1235 let mut succ = if asm.options.contains(InlineAsmOptions::NORETURN) {
1241 // Do a first pass for writing outputs only
1242 for op in asm.operands.iter().rev() {
1244 hir::InlineAsmOperand::In { .. }
1245 | hir::InlineAsmOperand::Const { .. }
1246 | hir::InlineAsmOperand::Sym { .. } => {}
1247 hir::InlineAsmOperand::Out { expr, .. } => {
1248 if let Some(expr) = expr {
1249 succ = self.write_place(expr, succ, ACC_WRITE);
1252 hir::InlineAsmOperand::InOut { expr, .. } => {
1253 succ = self.write_place(expr, succ, ACC_READ | ACC_WRITE);
1255 hir::InlineAsmOperand::SplitInOut { out_expr, .. } => {
1256 if let Some(expr) = out_expr {
1257 succ = self.write_place(expr, succ, ACC_WRITE);
1263 // Then do a second pass for inputs
1264 let mut succ = succ;
1265 for op in asm.operands.iter().rev() {
1267 hir::InlineAsmOperand::In { expr, .. }
1268 | hir::InlineAsmOperand::Const { expr, .. }
1269 | hir::InlineAsmOperand::Sym { expr, .. } => {
1270 succ = self.propagate_through_expr(expr, succ)
1272 hir::InlineAsmOperand::Out { expr, .. } => {
1273 if let Some(expr) = expr {
1274 succ = self.propagate_through_place_components(expr, succ);
1277 hir::InlineAsmOperand::InOut { expr, .. } => {
1278 succ = self.propagate_through_place_components(expr, succ);
1280 hir::InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
1281 if let Some(expr) = out_expr {
1282 succ = self.propagate_through_place_components(expr, succ);
1284 succ = self.propagate_through_expr(in_expr, succ);
1291 hir::ExprKind::LlvmInlineAsm(ref asm) => {
1292 let ia = &asm.inner;
1293 let outputs = asm.outputs_exprs;
1294 let inputs = asm.inputs_exprs;
1295 let succ = ia.outputs.iter().zip(outputs).rev().fold(succ, |succ, (o, output)| {
1296 // see comment on places
1297 // in propagate_through_place_components()
1299 self.propagate_through_expr(output, succ)
1301 let acc = if o.is_rw { ACC_WRITE | ACC_READ } else { ACC_WRITE };
1302 let succ = self.write_place(output, succ, acc);
1303 self.propagate_through_place_components(output, succ)
1307 // Inputs are executed first. Propagate last because of rev order
1308 self.propagate_through_exprs(inputs, succ)
1311 hir::ExprKind::Lit(..)
1312 | hir::ExprKind::Err
1313 | hir::ExprKind::Path(hir::QPath::TypeRelative(..)) => succ,
1315 // Note that labels have been resolved, so we don't need to look
1316 // at the label ident
1317 hir::ExprKind::Block(ref blk, _) => self.propagate_through_block(&blk, succ),
1321 fn propagate_through_place_components(&mut self, expr: &Expr<'_>, succ: LiveNode) -> LiveNode {
1324 // In general, the full flow graph structure for an
1325 // assignment/move/etc can be handled in one of two ways,
1326 // depending on whether what is being assigned is a "tracked
1327 // value" or not. A tracked value is basically a local
1328 // variable or argument.
1330 // The two kinds of graphs are:
1332 // Tracked place Untracked place
1333 // ----------------------++-----------------------
1337 // (rvalue) || (rvalue)
1340 // (write of place) || (place components)
1345 // ----------------------++-----------------------
1347 // I will cover the two cases in turn:
1351 // A tracked place is a local variable/argument `x`. In
1352 // these cases, the link_node where the write occurs is linked
1353 // to node id of `x`. The `write_place()` routine generates
1354 // the contents of this node. There are no subcomponents to
1357 // # Non-tracked places
1359 // These are places like `x[5]` or `x.f`. In that case, we
1360 // basically ignore the value which is written to but generate
1361 // reads for the components---`x` in these two examples. The
1362 // components reads are generated by
1363 // `propagate_through_place_components()` (this fn).
1367 // It is still possible to observe assignments to non-places;
1368 // these errors are detected in the later pass borrowck. We
1369 // just ignore such cases and treat them as reads.
1372 hir::ExprKind::Path(_) => succ,
1373 hir::ExprKind::Field(ref e, _) => self.propagate_through_expr(&e, succ),
1374 _ => self.propagate_through_expr(expr, succ),
1378 // see comment on propagate_through_place()
1379 fn write_place(&mut self, expr: &Expr<'_>, succ: LiveNode, acc: u32) -> LiveNode {
1381 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
1382 self.access_path(expr.hir_id, path, succ, acc)
1385 // We do not track other places, so just propagate through
1386 // to their subcomponents. Also, it may happen that
1387 // non-places occur here, because those are detected in the
1388 // later pass borrowck.
1401 let ln = self.live_node(hir_id, span);
1403 self.init_from_succ(ln, succ);
1404 let var = self.variable(var_hid, span);
1405 self.acc(ln, var, acc);
1413 path: &hir::Path<'_>,
1418 Res::Local(hid) => self.access_var(hir_id, hid, succ, acc, path.span),
1423 fn propagate_through_loop(
1426 body: &hir::Block<'_>,
1430 We model control flow like this:
1437 Note that a `continue` expression targeting the `loop` will have a successor of `expr`.
1438 Meanwhile, a `break` expression will have a successor of `succ`.
1442 let mut first_merge = true;
1443 let ln = self.live_node(expr.hir_id, expr.span);
1444 self.init_empty(ln, succ);
1445 debug!("propagate_through_loop: using id for loop body {} {:?}", expr.hir_id, body);
1447 self.break_ln.insert(expr.hir_id, succ);
1449 self.cont_ln.insert(expr.hir_id, ln);
1451 let body_ln = self.propagate_through_block(body, ln);
1453 // repeat until fixed point is reached:
1454 while self.merge_from_succ(ln, body_ln, first_merge) {
1455 first_merge = false;
1456 assert_eq!(body_ln, self.propagate_through_block(body, ln));
1463 // _______________________________________________________________________
1464 // Checking for error conditions
1466 impl<'a, 'tcx> Visitor<'tcx> for Liveness<'a, 'tcx> {
1467 type Map = intravisit::ErasedMap<'tcx>;
1469 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1470 NestedVisitorMap::None
1473 fn visit_local(&mut self, local: &'tcx hir::Local<'tcx>) {
1474 self.check_unused_vars_in_pat(&local.pat, None, |spans, hir_id, ln, var| {
1475 if local.init.is_some() {
1476 self.warn_about_dead_assign(spans, hir_id, ln, var);
1480 intravisit::walk_local(self, local);
1483 fn visit_expr(&mut self, ex: &'tcx Expr<'tcx>) {
1484 check_expr(self, ex);
1487 fn visit_arm(&mut self, arm: &'tcx hir::Arm<'tcx>) {
1488 self.check_unused_vars_in_pat(&arm.pat, None, |_, _, _, _| {});
1489 intravisit::walk_arm(self, arm);
1493 fn check_expr<'tcx>(this: &mut Liveness<'_, 'tcx>, expr: &'tcx Expr<'tcx>) {
1495 hir::ExprKind::Assign(ref l, ..) => {
1496 this.check_place(&l);
1499 hir::ExprKind::AssignOp(_, ref l, _) => {
1500 if !this.tables.is_method_call(expr) {
1501 this.check_place(&l);
1505 hir::ExprKind::InlineAsm(ref asm) => {
1506 for op in asm.operands {
1508 hir::InlineAsmOperand::Out { expr, .. } => {
1509 if let Some(expr) = expr {
1510 this.check_place(expr);
1513 hir::InlineAsmOperand::InOut { expr, .. } => {
1514 this.check_place(expr);
1516 hir::InlineAsmOperand::SplitInOut { out_expr, .. } => {
1517 if let Some(out_expr) = out_expr {
1518 this.check_place(out_expr);
1526 hir::ExprKind::LlvmInlineAsm(ref asm) => {
1527 for input in asm.inputs_exprs {
1528 this.visit_expr(input);
1531 // Output operands must be places
1532 for (o, output) in asm.inner.outputs.iter().zip(asm.outputs_exprs) {
1534 this.check_place(output);
1536 this.visit_expr(output);
1540 // no correctness conditions related to liveness
1541 hir::ExprKind::Call(..)
1542 | hir::ExprKind::MethodCall(..)
1543 | hir::ExprKind::Match(..)
1544 | hir::ExprKind::Loop(..)
1545 | hir::ExprKind::Index(..)
1546 | hir::ExprKind::Field(..)
1547 | hir::ExprKind::Array(..)
1548 | hir::ExprKind::Tup(..)
1549 | hir::ExprKind::Binary(..)
1550 | hir::ExprKind::Cast(..)
1551 | hir::ExprKind::DropTemps(..)
1552 | hir::ExprKind::Unary(..)
1553 | hir::ExprKind::Ret(..)
1554 | hir::ExprKind::Break(..)
1555 | hir::ExprKind::Continue(..)
1556 | hir::ExprKind::Lit(_)
1557 | hir::ExprKind::Block(..)
1558 | hir::ExprKind::AddrOf(..)
1559 | hir::ExprKind::Struct(..)
1560 | hir::ExprKind::Repeat(..)
1561 | hir::ExprKind::Closure(..)
1562 | hir::ExprKind::Path(_)
1563 | hir::ExprKind::Yield(..)
1564 | hir::ExprKind::Box(..)
1565 | hir::ExprKind::Type(..)
1566 | hir::ExprKind::Err => {}
1569 intravisit::walk_expr(this, expr);
1572 impl<'tcx> Liveness<'_, 'tcx> {
1573 fn check_place(&mut self, expr: &'tcx Expr<'tcx>) {
1575 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => {
1576 if let Res::Local(var_hid) = path.res {
1577 // Assignment to an immutable variable or argument: only legal
1578 // if there is no later assignment. If this local is actually
1579 // mutable, then check for a reassignment to flag the mutability
1581 let ln = self.live_node(expr.hir_id, expr.span);
1582 let var = self.variable(var_hid, expr.span);
1583 self.warn_about_dead_assign(vec![expr.span], expr.hir_id, ln, var);
1587 // For other kinds of places, no checks are required,
1588 // and any embedded expressions are actually rvalues
1589 intravisit::walk_expr(self, expr);
1594 fn should_warn(&self, var: Variable) -> Option<String> {
1595 let name = self.ir.variable_name(var);
1596 if name.is_empty() || name.as_bytes()[0] == b'_' { None } else { Some(name) }
1599 fn warn_about_unused_upvars(&self, entry_ln: LiveNode) {
1600 let upvars = match self.ir.tcx.upvars_mentioned(self.ir.body_owner) {
1602 Some(upvars) => upvars,
1604 for (&var_hir_id, upvar) in upvars.iter() {
1605 let var = self.variable(var_hir_id, upvar.span);
1606 let upvar_id = ty::UpvarId {
1607 var_path: ty::UpvarPath { hir_id: var_hir_id },
1608 closure_expr_id: self.ir.body_owner,
1610 match self.tables.upvar_capture(upvar_id) {
1611 ty::UpvarCapture::ByValue => {}
1612 ty::UpvarCapture::ByRef(..) => continue,
1614 if self.used_on_entry(entry_ln, var) {
1615 if self.live_on_entry(entry_ln, var).is_none() {
1616 if let Some(name) = self.should_warn(var) {
1617 self.ir.tcx.struct_span_lint_hir(
1618 lint::builtin::UNUSED_ASSIGNMENTS,
1622 lint.build(&format!("value captured by `{}` is never read", name))
1623 .help("did you mean to capture by reference instead?")
1630 if let Some(name) = self.should_warn(var) {
1631 self.ir.tcx.struct_span_lint_hir(
1632 lint::builtin::UNUSED_VARIABLES,
1636 lint.build(&format!("unused variable: `{}`", name))
1637 .help("did you mean to capture by reference instead?")
1646 fn warn_about_unused_args(&self, body: &hir::Body<'_>, entry_ln: LiveNode) {
1647 for p in body.params {
1648 self.check_unused_vars_in_pat(&p.pat, Some(entry_ln), |spans, hir_id, ln, var| {
1649 if self.live_on_entry(ln, var).is_none() {
1650 self.report_unsed_assign(hir_id, spans, var, |name| {
1651 format!("value passed to `{}` is never read", name)
1658 fn check_unused_vars_in_pat(
1661 entry_ln: Option<LiveNode>,
1662 on_used_on_entry: impl Fn(Vec<Span>, HirId, LiveNode, Variable),
1664 // In an or-pattern, only consider the variable; any later patterns must have the same
1665 // bindings, and we also consider the first pattern to be the "authoritative" set of ids.
1666 // However, we should take the ids and spans of variables with the same name from the later
1667 // patterns so the suggestions to prefix with underscores will apply to those too.
1668 let mut vars: FxIndexMap<String, (LiveNode, Variable, Vec<(HirId, Span)>)> = <_>::default();
1670 pat.each_binding(|_, hir_id, pat_sp, ident| {
1671 let ln = entry_ln.unwrap_or_else(|| self.live_node(hir_id, pat_sp));
1672 let var = self.variable(hir_id, ident.span);
1673 let id_and_sp = (hir_id, pat_sp);
1674 vars.entry(self.ir.variable_name(var))
1675 .and_modify(|(.., hir_ids_and_spans)| hir_ids_and_spans.push(id_and_sp))
1676 .or_insert_with(|| (ln, var, vec![id_and_sp]));
1679 for (_, (ln, var, hir_ids_and_spans)) in vars {
1680 if self.used_on_entry(ln, var) {
1681 let id = hir_ids_and_spans[0].0;
1682 let spans = hir_ids_and_spans.into_iter().map(|(_, sp)| sp).collect();
1683 on_used_on_entry(spans, id, ln, var);
1685 self.report_unused(hir_ids_and_spans, ln, var);
1690 fn report_unused(&self, hir_ids_and_spans: Vec<(HirId, Span)>, ln: LiveNode, var: Variable) {
1691 let first_hir_id = hir_ids_and_spans[0].0;
1693 if let Some(name) = self.should_warn(var).filter(|name| name != "self") {
1694 // annoying: for parameters in funcs like `fn(x: i32)
1695 // {ret}`, there is only one node, so asking about
1696 // assigned_on_exit() is not meaningful.
1698 if ln == self.s.exit_ln { false } else { self.assigned_on_exit(ln, var).is_some() };
1701 self.ir.tcx.struct_span_lint_hir(
1702 lint::builtin::UNUSED_VARIABLES,
1704 hir_ids_and_spans.into_iter().map(|(_, sp)| sp).collect::<Vec<_>>(),
1706 lint.build(&format!("variable `{}` is assigned to, but never used", name))
1707 .note(&format!("consider using `_{}` instead", name))
1712 self.ir.tcx.struct_span_lint_hir(
1713 lint::builtin::UNUSED_VARIABLES,
1715 hir_ids_and_spans.iter().map(|(_, sp)| *sp).collect::<Vec<_>>(),
1717 let mut err = lint.build(&format!("unused variable: `{}`", name));
1719 let (shorthands, non_shorthands): (Vec<_>, Vec<_>) =
1720 hir_ids_and_spans.into_iter().partition(|(hir_id, span)| {
1721 let var = self.variable(*hir_id, *span);
1722 self.ir.variable_is_shorthand(var)
1725 let mut shorthands = shorthands
1727 .map(|(_, span)| (span, format!("{}: _", name)))
1728 .collect::<Vec<_>>();
1730 // If we have both shorthand and non-shorthand, prefer the "try ignoring
1731 // the field" message, and suggest `_` for the non-shorthands. If we only
1732 // have non-shorthand, then prefix with an underscore instead.
1733 if !shorthands.is_empty() {
1737 .map(|(_, span)| (span, "_".to_string()))
1738 .collect::<Vec<_>>(),
1741 err.multipart_suggestion(
1742 "try ignoring the field",
1744 Applicability::MachineApplicable,
1747 err.multipart_suggestion(
1748 "if this is intentional, prefix it with an underscore",
1751 .map(|(_, span)| (span, format!("_{}", name)))
1752 .collect::<Vec<_>>(),
1753 Applicability::MachineApplicable,
1764 fn warn_about_dead_assign(&self, spans: Vec<Span>, hir_id: HirId, ln: LiveNode, var: Variable) {
1765 if self.live_on_exit(ln, var).is_none() {
1766 self.report_unsed_assign(hir_id, spans, var, |name| {
1767 format!("value assigned to `{}` is never read", name)
1772 fn report_unsed_assign(
1777 message: impl Fn(&str) -> String,
1779 if let Some(name) = self.should_warn(var) {
1780 self.ir.tcx.struct_span_lint_hir(
1781 lint::builtin::UNUSED_ASSIGNMENTS,
1785 lint.build(&message(&name))
1786 .help("maybe it is overwritten before being read?")