1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 * A classic liveness analysis based on dataflow over the AST. Computes,
13 * for each local variable in a function, whether that variable is live
14 * at a given point. Program execution points are identified by their
19 * The basic model is that each local variable is assigned an index. We
20 * represent sets of local variables using a vector indexed by this
21 * index. The value in the vector is either 0, indicating the variable
22 * is dead, or the id of an expression that uses the variable.
24 * We conceptually walk over the AST in reverse execution order. If we
25 * find a use of a variable, we add it to the set of live variables. If
26 * we find an assignment to a variable, we remove it from the set of live
27 * variables. When we have to merge two flows, we take the union of
28 * those two flows---if the variable is live on both paths, we simply
29 * pick one id. In the event of loops, we continue doing this until a
30 * fixed point is reached.
32 * ## Checking initialization
34 * At the function entry point, all variables must be dead. If this is
35 * not the case, we can report an error using the id found in the set of
36 * live variables, which identifies a use of the variable which is not
37 * dominated by an assignment.
41 * After each explicit move, the variable must be dead.
43 * ## Computing last uses
45 * Any use of the variable where the variable is dead afterwards is a
48 * # Implementation details
50 * The actual implementation contains two (nested) walks over the AST.
51 * The outer walk has the job of building up the ir_maps instance for the
52 * enclosing function. On the way down the tree, it identifies those AST
53 * nodes and variable IDs that will be needed for the liveness analysis
54 * and assigns them contiguous IDs. The liveness id for an AST node is
55 * called a `live_node` (it's a newtype'd uint) and the id for a variable
56 * is called a `variable` (another newtype'd uint).
58 * On the way back up the tree, as we are about to exit from a function
59 * declaration we allocate a `liveness` instance. Now that we know
60 * precisely how many nodes and variables we need, we can allocate all
61 * the various arrays that we will need to precisely the right size. We then
62 * perform the actual propagation on the `liveness` instance.
64 * This propagation is encoded in the various `propagate_through_*()`
65 * methods. It effectively does a reverse walk of the AST; whenever we
66 * reach a loop node, we iterate until a fixed point is reached.
68 * ## The `Users` struct
70 * At each live node `N`, we track three pieces of information for each
71 * variable `V` (these are encapsulated in the `Users` struct):
73 * - `reader`: the `LiveNode` ID of some node which will read the value
74 * that `V` holds on entry to `N`. Formally: a node `M` such
75 * that there exists a path `P` from `N` to `M` where `P` does not
76 * write `V`. If the `reader` is `invalid_node()`, then the current
77 * value will never be read (the variable is dead, essentially).
79 * - `writer`: the `LiveNode` ID of some node which will write the
80 * variable `V` and which is reachable from `N`. Formally: a node `M`
81 * such that there exists a path `P` from `N` to `M` and `M` writes
82 * `V`. If the `writer` is `invalid_node()`, then there is no writer
83 * of `V` that follows `N`.
85 * - `used`: a boolean value indicating whether `V` is *used*. We
86 * distinguish a *read* from a *use* in that a *use* is some read that
87 * is not just used to generate a new value. For example, `x += 1` is
88 * a read but not a use. This is used to generate better warnings.
90 * ## Special Variables
92 * We generate various special variables for various, well, special purposes.
93 * These are described in the `specials` struct:
95 * - `exit_ln`: a live node that is generated to represent every 'exit' from
96 * the function, whether it be by explicit return, fail, or other means.
98 * - `fallthrough_ln`: a live node that represents a fallthrough
100 * - `no_ret_var`: a synthetic variable that is only 'read' from, the
101 * fallthrough node. This allows us to detect functions where we fail
102 * to return explicitly.
106 use middle::freevars;
107 use middle::mem_categorization::Typer;
108 use middle::pat_util;
111 use util::nodemap::NodeMap;
115 use std::mem::transmute;
120 use syntax::codemap::{BytePos, original_sp, Span};
121 use syntax::parse::token::special_idents;
122 use syntax::parse::token;
123 use syntax::print::pprust::{expr_to_string, block_to_string};
125 use syntax::{visit, ast_util};
126 use syntax::visit::{Visitor, FnKind};
128 /// For use with `propagate_through_loop`.
130 /// An endless `loop` loop.
132 /// A `while` loop, with the given expression as condition.
134 /// A `for` loop, with the given pattern to bind.
138 #[deriving(PartialEq)]
139 struct Variable(uint);
140 #[deriving(PartialEq)]
141 struct LiveNode(uint);
144 fn get(&self) -> uint { let Variable(v) = *self; v }
148 fn get(&self) -> uint { let LiveNode(v) = *self; v }
151 impl Clone for LiveNode {
152 fn clone(&self) -> LiveNode {
157 #[deriving(PartialEq)]
165 fn live_node_kind_to_string(lnk: LiveNodeKind, cx: &ty::ctxt) -> String {
166 let cm = cx.sess.codemap();
169 format!("Free var node [{}]", cm.span_to_string(s))
172 format!("Expr node [{}]", cm.span_to_string(s))
175 format!("Var def node [{}]", cm.span_to_string(s))
177 ExitNode => "Exit node".to_string(),
181 impl<'a, 'tcx, 'v> Visitor<'v> for IrMaps<'a, 'tcx> {
182 fn visit_fn(&mut self, fk: FnKind<'v>, fd: &'v FnDecl,
183 b: &'v Block, s: Span, n: NodeId) {
184 visit_fn(self, fk, fd, b, s, n);
186 fn visit_local(&mut self, l: &Local) { visit_local(self, l); }
187 fn visit_expr(&mut self, ex: &Expr) { visit_expr(self, ex); }
188 fn visit_arm(&mut self, a: &Arm) { visit_arm(self, a); }
191 pub fn check_crate(tcx: &ty::ctxt) {
192 visit::walk_crate(&mut IrMaps::new(tcx), tcx.map.krate());
193 tcx.sess.abort_if_errors();
196 impl fmt::Show for LiveNode {
197 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
198 write!(f, "ln({})", self.get())
202 impl fmt::Show for Variable {
203 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
204 write!(f, "v({})", self.get())
208 // ______________________________________________________________________
211 // This is the first pass and the one that drives the main
212 // computation. It walks up and down the IR once. On the way down,
213 // we count for each function the number of variables as well as
214 // liveness nodes. A liveness node is basically an expression or
215 // capture clause that does something of interest: either it has
216 // interesting control flow or it uses/defines a local variable.
218 // On the way back up, at each function node we create liveness sets
219 // (we now know precisely how big to make our various vectors and so
220 // forth) and then do the data-flow propagation to compute the set
221 // of live variables at each program point.
223 // Finally, we run back over the IR one last time and, using the
224 // computed liveness, check various safety conditions. For example,
225 // there must be no live nodes at the definition site for a variable
226 // unless it has an initializer. Similarly, each non-mutable local
227 // variable must not be assigned if there is some successor
228 // assignment. And so forth.
231 fn is_valid(&self) -> bool {
232 self.get() != uint::MAX
236 fn invalid_node() -> LiveNode { LiveNode(uint::MAX) }
254 struct IrMaps<'a, 'tcx: 'a> {
255 tcx: &'a ty::ctxt<'tcx>,
257 num_live_nodes: uint,
259 live_node_map: NodeMap<LiveNode>,
260 variable_map: NodeMap<Variable>,
261 capture_info_map: NodeMap<Rc<Vec<CaptureInfo>>>,
262 var_kinds: Vec<VarKind>,
263 lnks: Vec<LiveNodeKind>,
266 impl<'a, 'tcx> IrMaps<'a, 'tcx> {
267 fn new(tcx: &'a ty::ctxt<'tcx>) -> IrMaps<'a, 'tcx> {
272 live_node_map: NodeMap::new(),
273 variable_map: NodeMap::new(),
274 capture_info_map: NodeMap::new(),
275 var_kinds: Vec::new(),
280 fn add_live_node(&mut self, lnk: LiveNodeKind) -> LiveNode {
281 let ln = LiveNode(self.num_live_nodes);
283 self.num_live_nodes += 1;
285 debug!("{} is of kind {}", ln.to_string(),
286 live_node_kind_to_string(lnk, self.tcx));
291 fn add_live_node_for_node(&mut self, node_id: NodeId, lnk: LiveNodeKind) {
292 let ln = self.add_live_node(lnk);
293 self.live_node_map.insert(node_id, ln);
295 debug!("{} is node {}", ln.to_string(), node_id);
298 fn add_variable(&mut self, vk: VarKind) -> Variable {
299 let v = Variable(self.num_vars);
300 self.var_kinds.push(vk);
304 Local(LocalInfo { id: node_id, .. }) | Arg(node_id, _) => {
305 self.variable_map.insert(node_id, v);
310 debug!("{} is {:?}", v.to_string(), vk);
315 fn variable(&self, node_id: NodeId, span: Span) -> Variable {
316 match self.variable_map.find(&node_id) {
321 .span_bug(span, format!("no variable registered for id {}",
322 node_id).as_slice());
327 fn variable_name(&self, var: Variable) -> String {
328 match self.var_kinds.get(var.get()) {
329 &Local(LocalInfo { ident: nm, .. }) | &Arg(_, nm) => {
330 token::get_ident(nm).get().to_string()
332 &ImplicitRet => "<implicit-ret>".to_string()
336 fn set_captures(&mut self, node_id: NodeId, cs: Vec<CaptureInfo>) {
337 self.capture_info_map.insert(node_id, Rc::new(cs));
340 fn lnk(&self, ln: LiveNode) -> LiveNodeKind {
341 *self.lnks.get(ln.get())
345 impl<'a, 'tcx, 'v> Visitor<'v> for Liveness<'a, 'tcx> {
346 fn visit_fn(&mut self, fk: FnKind<'v>, fd: &'v FnDecl, b: &'v Block, s: Span, n: NodeId) {
347 check_fn(self, fk, fd, b, s, n);
349 fn visit_local(&mut self, l: &Local) {
350 check_local(self, l);
352 fn visit_expr(&mut self, ex: &Expr) {
353 check_expr(self, ex);
355 fn visit_arm(&mut self, a: &Arm) {
360 fn visit_fn(ir: &mut IrMaps,
366 debug!("visit_fn: id={}", id);
367 let _i = ::util::common::indenter();
369 // swap in a new set of IR maps for this function body:
370 let mut fn_maps = IrMaps::new(ir.tcx);
373 debug!("creating fn_maps: {}",
374 transmute::<&IrMaps, *const IrMaps>(&fn_maps));
377 for arg in decl.inputs.iter() {
378 pat_util::pat_bindings(&ir.tcx.def_map,
380 |_bm, arg_id, _x, path1| {
381 debug!("adding argument {}", arg_id);
382 let ident = path1.node;
383 fn_maps.add_variable(Arg(arg_id, ident));
387 // gather up the various local variables, significant expressions,
389 visit::walk_fn(&mut fn_maps, fk, decl, body, sp);
391 // Special nodes and variables:
392 // - exit_ln represents the end of the fn, either by return or fail
393 // - implicit_ret_var is a pseudo-variable that represents
394 // an implicit return
395 let specials = Specials {
396 exit_ln: fn_maps.add_live_node(ExitNode),
397 fallthrough_ln: fn_maps.add_live_node(ExitNode),
398 no_ret_var: fn_maps.add_variable(ImplicitRet)
402 let mut lsets = Liveness::new(&mut fn_maps, specials);
403 let entry_ln = lsets.compute(decl, body);
405 // check for various error conditions
406 lsets.visit_block(body);
407 lsets.check_ret(id, sp, fk, entry_ln, body);
408 lsets.warn_about_unused_args(decl, entry_ln);
411 fn visit_local(ir: &mut IrMaps, local: &Local) {
412 pat_util::pat_bindings(&ir.tcx.def_map, &*local.pat, |_, p_id, sp, path1| {
413 debug!("adding local variable {}", p_id);
414 let name = path1.node;
415 ir.add_live_node_for_node(p_id, VarDefNode(sp));
416 ir.add_variable(Local(LocalInfo {
421 visit::walk_local(ir, local);
424 fn visit_arm(ir: &mut IrMaps, arm: &Arm) {
425 for pat in arm.pats.iter() {
426 pat_util::pat_bindings(&ir.tcx.def_map, &**pat, |bm, p_id, sp, path1| {
427 debug!("adding local variable {} from match with bm {:?}",
429 let name = path1.node;
430 ir.add_live_node_for_node(p_id, VarDefNode(sp));
431 ir.add_variable(Local(LocalInfo {
437 visit::walk_arm(ir, arm);
440 fn moved_variable_node_id_from_def(def: Def) -> Option<NodeId> {
444 DefLocal(nid, _) => Some(nid),
450 fn visit_expr(ir: &mut IrMaps, expr: &Expr) {
452 // live nodes required for uses or definitions of variables:
454 let def = ir.tcx.def_map.borrow().get_copy(&expr.id);
455 debug!("expr {}: path that leads to {:?}", expr.id, def);
456 if moved_variable_node_id_from_def(def).is_some() {
457 ir.add_live_node_for_node(expr.id, ExprNode(expr.span));
459 visit::walk_expr(ir, expr);
461 ExprFnBlock(..) | ExprProc(..) | ExprUnboxedFn(..) => {
462 // Interesting control flow (for loops can contain labeled
463 // breaks or continues)
464 ir.add_live_node_for_node(expr.id, ExprNode(expr.span));
466 // Make a live_node for each captured variable, with the span
467 // being the location that the variable is used. This results
468 // in better error messages than just pointing at the closure
469 // construction site.
470 let mut call_caps = Vec::new();
471 freevars::with_freevars(ir.tcx, expr.id, |freevars| {
472 for fv in freevars.iter() {
473 match moved_variable_node_id_from_def(fv.def) {
475 let fv_ln = ir.add_live_node(FreeVarNode(fv.span));
476 call_caps.push(CaptureInfo {ln: fv_ln,
483 ir.set_captures(expr.id, call_caps);
485 visit::walk_expr(ir, expr);
488 // live nodes required for interesting control flow:
489 ExprIf(..) | ExprMatch(..) | ExprWhile(..) | ExprLoop(..) => {
490 ir.add_live_node_for_node(expr.id, ExprNode(expr.span));
491 visit::walk_expr(ir, expr);
493 ExprForLoop(ref pat, _, _, _) => {
494 pat_util::pat_bindings(&ir.tcx.def_map, &**pat, |bm, p_id, sp, path1| {
495 debug!("adding local variable {} from for loop with bm {:?}",
497 let name = path1.node;
498 ir.add_live_node_for_node(p_id, VarDefNode(sp));
499 ir.add_variable(Local(LocalInfo {
504 ir.add_live_node_for_node(expr.id, ExprNode(expr.span));
505 visit::walk_expr(ir, expr);
507 ExprBinary(op, _, _) if ast_util::lazy_binop(op) => {
508 ir.add_live_node_for_node(expr.id, ExprNode(expr.span));
509 visit::walk_expr(ir, expr);
512 // otherwise, live nodes are not required:
513 ExprIndex(..) | ExprField(..) | ExprTupField(..) | ExprVec(..) |
514 ExprCall(..) | ExprMethodCall(..) | ExprTup(..) |
515 ExprBinary(..) | ExprAddrOf(..) |
516 ExprCast(..) | ExprUnary(..) | ExprBreak(_) |
517 ExprAgain(_) | ExprLit(_) | ExprRet(..) | ExprBlock(..) |
518 ExprAssign(..) | ExprAssignOp(..) | ExprMac(..) |
519 ExprStruct(..) | ExprRepeat(..) | ExprParen(..) |
520 ExprInlineAsm(..) | ExprBox(..) => {
521 visit::walk_expr(ir, expr);
526 // ______________________________________________________________________
527 // Computing liveness sets
529 // Actually we compute just a bit more than just liveness, but we use
530 // the same basic propagation framework in all cases.
539 fn invalid_users() -> Users {
541 reader: invalid_node(),
542 writer: invalid_node(),
549 fallthrough_ln: LiveNode,
553 static ACC_READ: uint = 1u;
554 static ACC_WRITE: uint = 2u;
555 static ACC_USE: uint = 4u;
557 struct Liveness<'a, 'tcx: 'a> {
558 ir: &'a mut IrMaps<'a, 'tcx>,
560 successors: Vec<LiveNode>,
562 // The list of node IDs for the nested loop scopes
564 loop_scope: Vec<NodeId>,
565 // mappings from loop node ID to LiveNode
566 // ("break" label should map to loop node ID,
567 // it probably doesn't now)
568 break_ln: NodeMap<LiveNode>,
569 cont_ln: NodeMap<LiveNode>
572 impl<'a, 'tcx> Liveness<'a, 'tcx> {
573 fn new(ir: &'a mut IrMaps<'a, 'tcx>, specials: Specials) -> Liveness<'a, 'tcx> {
574 let num_live_nodes = ir.num_live_nodes;
575 let num_vars = ir.num_vars;
579 successors: Vec::from_elem(num_live_nodes, invalid_node()),
580 users: Vec::from_elem(num_live_nodes * num_vars, invalid_users()),
581 loop_scope: Vec::new(),
582 break_ln: NodeMap::new(),
583 cont_ln: NodeMap::new(),
587 fn live_node(&self, node_id: NodeId, span: Span) -> LiveNode {
588 match self.ir.live_node_map.find(&node_id) {
591 // This must be a mismatch between the ir_map construction
592 // above and the propagation code below; the two sets of
593 // code have to agree about which AST nodes are worth
594 // creating liveness nodes for.
595 self.ir.tcx.sess.span_bug(
597 format!("no live node registered for node {}",
598 node_id).as_slice());
603 fn variable(&self, node_id: NodeId, span: Span) -> Variable {
604 self.ir.variable(node_id, span)
607 fn pat_bindings(&mut self,
609 f: |&mut Liveness<'a, 'tcx>, LiveNode, Variable, Span, NodeId|) {
610 pat_util::pat_bindings(&self.ir.tcx.def_map, pat, |_bm, p_id, sp, _n| {
611 let ln = self.live_node(p_id, sp);
612 let var = self.variable(p_id, sp);
613 f(self, ln, var, sp, p_id);
617 fn arm_pats_bindings(&mut self,
619 f: |&mut Liveness<'a, 'tcx>, LiveNode, Variable, Span, NodeId|) {
622 self.pat_bindings(pat, f);
628 fn define_bindings_in_pat(&mut self, pat: &Pat, succ: LiveNode)
630 self.define_bindings_in_arm_pats(Some(pat), succ)
633 fn define_bindings_in_arm_pats(&mut self, pat: Option<&Pat>, succ: LiveNode)
636 self.arm_pats_bindings(pat, |this, ln, var, _sp, _id| {
637 this.init_from_succ(ln, succ);
638 this.define(ln, var);
644 fn idx(&self, ln: LiveNode, var: Variable) -> uint {
645 ln.get() * self.ir.num_vars + var.get()
648 fn live_on_entry(&self, ln: LiveNode, var: Variable)
649 -> Option<LiveNodeKind> {
650 assert!(ln.is_valid());
651 let reader = self.users.get(self.idx(ln, var)).reader;
652 if reader.is_valid() {Some(self.ir.lnk(reader))} else {None}
656 Is this variable live on entry to any of its successor nodes?
658 fn live_on_exit(&self, ln: LiveNode, var: Variable)
659 -> Option<LiveNodeKind> {
660 let successor = *self.successors.get(ln.get());
661 self.live_on_entry(successor, var)
664 fn used_on_entry(&self, ln: LiveNode, var: Variable) -> bool {
665 assert!(ln.is_valid());
666 self.users.get(self.idx(ln, var)).used
669 fn assigned_on_entry(&self, ln: LiveNode, var: Variable)
670 -> Option<LiveNodeKind> {
671 assert!(ln.is_valid());
672 let writer = self.users.get(self.idx(ln, var)).writer;
673 if writer.is_valid() {Some(self.ir.lnk(writer))} else {None}
676 fn assigned_on_exit(&self, ln: LiveNode, var: Variable)
677 -> Option<LiveNodeKind> {
678 let successor = *self.successors.get(ln.get());
679 self.assigned_on_entry(successor, var)
682 fn indices2(&mut self,
685 op: |&mut Liveness<'a, 'tcx>, uint, uint|) {
686 let node_base_idx = self.idx(ln, Variable(0u));
687 let succ_base_idx = self.idx(succ_ln, Variable(0u));
688 for var_idx in range(0u, self.ir.num_vars) {
689 op(self, node_base_idx + var_idx, succ_base_idx + var_idx);
696 test: |uint| -> LiveNode) -> io::IoResult<()> {
697 let node_base_idx = self.idx(ln, Variable(0));
698 for var_idx in range(0u, self.ir.num_vars) {
699 let idx = node_base_idx + var_idx;
700 if test(idx).is_valid() {
701 try!(write!(wr, " {}", Variable(var_idx).to_string()));
707 fn find_loop_scope(&self,
708 opt_label: Option<Ident>,
714 // Refers to a labeled loop. Use the results of resolve
716 match self.ir.tcx.def_map.borrow().find(&id) {
717 Some(&DefLabel(loop_id)) => loop_id,
718 _ => self.ir.tcx.sess.span_bug(sp, "label on break/loop \
719 doesn't refer to a loop")
723 // Vanilla 'break' or 'loop', so use the enclosing
725 if self.loop_scope.len() == 0 {
726 self.ir.tcx.sess.span_bug(sp, "break outside loop");
728 *self.loop_scope.last().unwrap()
734 #[allow(unused_must_use)]
735 fn ln_str(&self, ln: LiveNode) -> String {
736 let mut wr = io::MemWriter::new();
738 let wr = &mut wr as &mut io::Writer;
739 write!(wr, "[ln({}) of kind {:?} reads", ln.get(), self.ir.lnk(ln));
740 self.write_vars(wr, ln, |idx| self.users.get(idx).reader);
741 write!(wr, " writes");
742 self.write_vars(wr, ln, |idx| self.users.get(idx).writer);
743 write!(wr, " precedes {}]", self.successors.get(ln.get()).to_string());
745 str::from_utf8(wr.unwrap().as_slice()).unwrap().to_string()
748 fn init_empty(&mut self, ln: LiveNode, succ_ln: LiveNode) {
749 *self.successors.get_mut(ln.get()) = succ_ln;
751 // It is not necessary to initialize the
752 // values to empty because this is the value
753 // they have when they are created, and the sets
754 // only grow during iterations.
756 // self.indices(ln) { |idx|
757 // self.users[idx] = invalid_users();
761 fn init_from_succ(&mut self, ln: LiveNode, succ_ln: LiveNode) {
762 // more efficient version of init_empty() / merge_from_succ()
763 *self.successors.get_mut(ln.get()) = succ_ln;
765 self.indices2(ln, succ_ln, |this, idx, succ_idx| {
766 *this.users.get_mut(idx) = *this.users.get(succ_idx)
768 debug!("init_from_succ(ln={}, succ={})",
769 self.ln_str(ln), self.ln_str(succ_ln));
772 fn merge_from_succ(&mut self,
777 if ln == succ_ln { return false; }
779 let mut changed = false;
780 self.indices2(ln, succ_ln, |this, idx, succ_idx| {
781 changed |= copy_if_invalid(this.users.get(succ_idx).reader,
782 &mut this.users.get_mut(idx).reader);
783 changed |= copy_if_invalid(this.users.get(succ_idx).writer,
784 &mut this.users.get_mut(idx).writer);
785 if this.users.get(succ_idx).used && !this.users.get(idx).used {
786 this.users.get_mut(idx).used = true;
791 debug!("merge_from_succ(ln={}, succ={}, first_merge={}, changed={})",
792 ln.to_string(), self.ln_str(succ_ln), first_merge, changed);
795 fn copy_if_invalid(src: LiveNode, dst: &mut LiveNode) -> bool {
796 if src.is_valid() && !dst.is_valid() {
805 // Indicates that a local variable was *defined*; we know that no
806 // uses of the variable can precede the definition (resolve checks
807 // this) so we just clear out all the data.
808 fn define(&mut self, writer: LiveNode, var: Variable) {
809 let idx = self.idx(writer, var);
810 self.users.get_mut(idx).reader = invalid_node();
811 self.users.get_mut(idx).writer = invalid_node();
813 debug!("{} defines {} (idx={}): {}", writer.to_string(), var.to_string(),
814 idx, self.ln_str(writer));
817 // Either read, write, or both depending on the acc bitset
818 fn acc(&mut self, ln: LiveNode, var: Variable, acc: uint) {
819 debug!("{} accesses[{:x}] {}: {}",
820 ln.to_string(), acc, var.to_string(), self.ln_str(ln));
822 let idx = self.idx(ln, var);
823 let user = self.users.get_mut(idx);
825 if (acc & ACC_WRITE) != 0 {
826 user.reader = invalid_node();
830 // Important: if we both read/write, must do read second
831 // or else the write will override.
832 if (acc & ACC_READ) != 0 {
836 if (acc & ACC_USE) != 0 {
841 // _______________________________________________________________________
843 fn compute(&mut self, decl: &FnDecl, body: &Block) -> LiveNode {
844 // if there is a `break` or `again` at the top level, then it's
845 // effectively a return---this only occurs in `for` loops,
846 // where the body is really a closure.
848 debug!("compute: using id for block, {}", block_to_string(body));
850 let exit_ln = self.s.exit_ln;
851 let entry_ln: LiveNode =
852 self.with_loop_nodes(body.id, exit_ln, exit_ln,
853 |this| this.propagate_through_fn_block(decl, body));
855 // hack to skip the loop unless debug! is enabled:
856 debug!("^^ liveness computation results for body {} (entry={})",
858 for ln_idx in range(0u, self.ir.num_live_nodes) {
859 debug!("{}", self.ln_str(LiveNode(ln_idx)));
863 entry_ln.to_string());
868 fn propagate_through_fn_block(&mut self, _: &FnDecl, blk: &Block)
870 // the fallthrough exit is only for those cases where we do not
871 // explicitly return:
873 self.init_from_succ(s.fallthrough_ln, s.exit_ln);
874 if blk.expr.is_none() {
875 self.acc(s.fallthrough_ln, s.no_ret_var, ACC_READ)
878 self.propagate_through_block(blk, s.fallthrough_ln)
881 fn propagate_through_block(&mut self, blk: &Block, succ: LiveNode)
883 let succ = self.propagate_through_opt_expr(blk.expr.as_ref().map(|e| &**e), succ);
884 blk.stmts.iter().rev().fold(succ, |succ, stmt| {
885 self.propagate_through_stmt(&**stmt, succ)
889 fn propagate_through_stmt(&mut self, stmt: &Stmt, succ: LiveNode)
892 StmtDecl(ref decl, _) => {
893 self.propagate_through_decl(&**decl, succ)
896 StmtExpr(ref expr, _) | StmtSemi(ref expr, _) => {
897 self.propagate_through_expr(&**expr, succ)
901 self.ir.tcx.sess.span_bug(stmt.span, "unexpanded macro");
906 fn propagate_through_decl(&mut self, decl: &Decl, succ: LiveNode)
909 DeclLocal(ref local) => {
910 self.propagate_through_local(&**local, succ)
916 fn propagate_through_local(&mut self, local: &Local, succ: LiveNode)
918 // Note: we mark the variable as defined regardless of whether
919 // there is an initializer. Initially I had thought to only mark
920 // the live variable as defined if it was initialized, and then we
921 // could check for uninit variables just by scanning what is live
922 // at the start of the function. But that doesn't work so well for
923 // immutable variables defined in a loop:
924 // loop { let x; x = 5; }
925 // because the "assignment" loops back around and generates an error.
927 // So now we just check that variables defined w/o an
928 // initializer are not live at the point of their
929 // initialization, which is mildly more complex than checking
930 // once at the func header but otherwise equivalent.
932 let succ = self.propagate_through_opt_expr(local.init.as_ref().map(|e| &**e), succ);
933 self.define_bindings_in_pat(&*local.pat, succ)
936 fn propagate_through_exprs(&mut self, exprs: &[P<Expr>], succ: LiveNode)
938 exprs.iter().rev().fold(succ, |succ, expr| {
939 self.propagate_through_expr(&**expr, succ)
943 fn propagate_through_opt_expr(&mut self,
944 opt_expr: Option<&Expr>,
947 opt_expr.iter().fold(succ, |succ, expr| {
948 self.propagate_through_expr(&**expr, succ)
952 fn propagate_through_expr(&mut self, expr: &Expr, succ: LiveNode)
954 debug!("propagate_through_expr: {}", expr_to_string(expr));
957 // Interesting cases with control flow or which gen/kill
960 self.access_path(expr, succ, ACC_READ | ACC_USE)
963 ExprField(ref e, _, _) => {
964 self.propagate_through_expr(&**e, succ)
967 ExprTupField(ref e, _, _) => {
968 self.propagate_through_expr(&**e, succ)
971 ExprFnBlock(_, _, ref blk) |
972 ExprProc(_, ref blk) |
973 ExprUnboxedFn(_, _, _, ref blk) => {
974 debug!("{} is an ExprFnBlock, ExprProc, or ExprUnboxedFn",
975 expr_to_string(expr));
978 The next-node for a break is the successor of the entire
979 loop. The next-node for a continue is the top of this loop.
981 let node = self.live_node(expr.id, expr.span);
982 self.with_loop_nodes(blk.id, succ, node, |this| {
984 // the construction of a closure itself is not important,
985 // but we have to consider the closed over variables.
986 let caps = match this.ir.capture_info_map.find(&expr.id) {
987 Some(caps) => caps.clone(),
989 this.ir.tcx.sess.span_bug(expr.span, "no registered caps");
992 caps.iter().rev().fold(succ, |succ, cap| {
993 this.init_from_succ(cap.ln, succ);
994 let var = this.variable(cap.var_nid, expr.span);
995 this.acc(cap.ln, var, ACC_READ | ACC_USE);
1001 ExprIf(ref cond, ref then, ref els) => {
1015 let else_ln = self.propagate_through_opt_expr(els.as_ref().map(|e| &**e), succ);
1016 let then_ln = self.propagate_through_block(&**then, succ);
1017 let ln = self.live_node(expr.id, expr.span);
1018 self.init_from_succ(ln, else_ln);
1019 self.merge_from_succ(ln, then_ln, false);
1020 self.propagate_through_expr(&**cond, ln)
1023 ExprWhile(ref cond, ref blk, _) => {
1024 self.propagate_through_loop(expr, WhileLoop(&**cond), &**blk, succ)
1027 ExprForLoop(ref pat, ref head, ref blk, _) => {
1028 let ln = self.propagate_through_loop(expr, ForLoop(&**pat), &**blk, succ);
1029 self.propagate_through_expr(&**head, ln)
1032 // Note that labels have been resolved, so we don't need to look
1033 // at the label ident
1034 ExprLoop(ref blk, _) => {
1035 self.propagate_through_loop(expr, LoopLoop, &**blk, succ)
1038 ExprMatch(ref e, ref arms) => {
1053 let ln = self.live_node(expr.id, expr.span);
1054 self.init_empty(ln, succ);
1055 let mut first_merge = true;
1056 for arm in arms.iter() {
1058 self.propagate_through_expr(&*arm.body, succ);
1060 self.propagate_through_opt_expr(arm.guard.as_ref().map(|e| &**e), body_succ);
1061 // only consider the first pattern; any later patterns must have
1062 // the same bindings, and we also consider the first pattern to be
1063 // the "authoritative" set of ids
1065 self.define_bindings_in_arm_pats(arm.pats.as_slice().head().map(|p| &**p),
1067 self.merge_from_succ(ln, arm_succ, first_merge);
1068 first_merge = false;
1070 self.propagate_through_expr(&**e, ln)
1073 ExprRet(ref o_e) => {
1074 // ignore succ and subst exit_ln:
1075 let exit_ln = self.s.exit_ln;
1076 self.propagate_through_opt_expr(o_e.as_ref().map(|e| &**e), exit_ln)
1079 ExprBreak(opt_label) => {
1080 // Find which label this break jumps to
1081 let sc = self.find_loop_scope(opt_label, expr.id, expr.span);
1083 // Now that we know the label we're going to,
1084 // look it up in the break loop nodes table
1086 match self.break_ln.find(&sc) {
1088 None => self.ir.tcx.sess.span_bug(expr.span,
1089 "break to unknown label")
1093 ExprAgain(opt_label) => {
1094 // Find which label this expr continues to
1095 let sc = self.find_loop_scope(opt_label, expr.id, expr.span);
1097 // Now that we know the label we're going to,
1098 // look it up in the continue loop nodes table
1100 match self.cont_ln.find(&sc) {
1102 None => self.ir.tcx.sess.span_bug(expr.span,
1103 "loop to unknown label")
1107 ExprAssign(ref l, ref r) => {
1108 // see comment on lvalues in
1109 // propagate_through_lvalue_components()
1110 let succ = self.write_lvalue(&**l, succ, ACC_WRITE);
1111 let succ = self.propagate_through_lvalue_components(&**l, succ);
1112 self.propagate_through_expr(&**r, succ)
1115 ExprAssignOp(_, ref l, ref r) => {
1116 // see comment on lvalues in
1117 // propagate_through_lvalue_components()
1118 let succ = self.write_lvalue(&**l, succ, ACC_WRITE|ACC_READ);
1119 let succ = self.propagate_through_expr(&**r, succ);
1120 self.propagate_through_lvalue_components(&**l, succ)
1123 // Uninteresting cases: just propagate in rev exec order
1125 ExprVec(ref exprs) => {
1126 self.propagate_through_exprs(exprs.as_slice(), succ)
1129 ExprRepeat(ref element, ref count) => {
1130 let succ = self.propagate_through_expr(&**count, succ);
1131 self.propagate_through_expr(&**element, succ)
1134 ExprStruct(_, ref fields, ref with_expr) => {
1135 let succ = self.propagate_through_opt_expr(with_expr.as_ref().map(|e| &**e), succ);
1136 fields.iter().rev().fold(succ, |succ, field| {
1137 self.propagate_through_expr(&*field.expr, succ)
1141 ExprCall(ref f, ref args) => {
1142 // calling a fn with bot return type means that the fn
1143 // will fail, and hence the successors can be ignored
1144 let is_bot = !self.ir.tcx.is_method_call(expr.id) && {
1145 let t_ret = ty::ty_fn_ret(ty::expr_ty(self.ir.tcx, &**f));
1146 ty::type_is_bot(t_ret)
1148 let succ = if is_bot {
1153 let succ = self.propagate_through_exprs(args.as_slice(), succ);
1154 self.propagate_through_expr(&**f, succ)
1157 ExprMethodCall(_, _, ref args) => {
1158 // calling a method with bot return type means that the method
1159 // will fail, and hence the successors can be ignored
1160 let t_ret = ty::node_id_to_type(self.ir.tcx, expr.id);
1161 let succ = if ty::type_is_bot(t_ret) {self.s.exit_ln}
1163 self.propagate_through_exprs(args.as_slice(), succ)
1166 ExprTup(ref exprs) => {
1167 self.propagate_through_exprs(exprs.as_slice(), succ)
1170 ExprBinary(op, ref l, ref r) if ast_util::lazy_binop(op) => {
1171 let r_succ = self.propagate_through_expr(&**r, succ);
1173 let ln = self.live_node(expr.id, expr.span);
1174 self.init_from_succ(ln, succ);
1175 self.merge_from_succ(ln, r_succ, false);
1177 self.propagate_through_expr(&**l, ln)
1180 ExprIndex(ref l, ref r) |
1181 ExprBinary(_, ref l, ref r) |
1182 ExprBox(ref l, ref r) => {
1183 let r_succ = self.propagate_through_expr(&**r, succ);
1184 self.propagate_through_expr(&**l, r_succ)
1187 ExprAddrOf(_, ref e) |
1188 ExprCast(ref e, _) |
1189 ExprUnary(_, ref e) |
1190 ExprParen(ref e) => {
1191 self.propagate_through_expr(&**e, succ)
1194 ExprInlineAsm(ref ia) => {
1196 let succ = ia.outputs.iter().rev().fold(succ, |succ, &(_, ref expr, _)| {
1197 // see comment on lvalues
1198 // in propagate_through_lvalue_components()
1199 let succ = self.write_lvalue(&**expr, succ, ACC_WRITE);
1200 self.propagate_through_lvalue_components(&**expr, succ)
1202 // Inputs are executed first. Propagate last because of rev order
1203 ia.inputs.iter().rev().fold(succ, |succ, &(_, ref expr)| {
1204 self.propagate_through_expr(&**expr, succ)
1212 ExprBlock(ref blk) => {
1213 self.propagate_through_block(&**blk, succ)
1217 self.ir.tcx.sess.span_bug(expr.span, "unexpanded macro");
1222 fn propagate_through_lvalue_components(&mut self,
1228 // In general, the full flow graph structure for an
1229 // assignment/move/etc can be handled in one of two ways,
1230 // depending on whether what is being assigned is a "tracked
1231 // value" or not. A tracked value is basically a local
1232 // variable or argument.
1234 // The two kinds of graphs are:
1236 // Tracked lvalue Untracked lvalue
1237 // ----------------------++-----------------------
1241 // (rvalue) || (rvalue)
1244 // (write of lvalue) || (lvalue components)
1249 // ----------------------++-----------------------
1251 // I will cover the two cases in turn:
1253 // # Tracked lvalues
1255 // A tracked lvalue is a local variable/argument `x`. In
1256 // these cases, the link_node where the write occurs is linked
1257 // to node id of `x`. The `write_lvalue()` routine generates
1258 // the contents of this node. There are no subcomponents to
1261 // # Non-tracked lvalues
1263 // These are lvalues like `x[5]` or `x.f`. In that case, we
1264 // basically ignore the value which is written to but generate
1265 // reads for the components---`x` in these two examples. The
1266 // components reads are generated by
1267 // `propagate_through_lvalue_components()` (this fn).
1269 // # Illegal lvalues
1271 // It is still possible to observe assignments to non-lvalues;
1272 // these errors are detected in the later pass borrowck. We
1273 // just ignore such cases and treat them as reads.
1276 ExprPath(_) => succ,
1277 ExprField(ref e, _, _) => self.propagate_through_expr(&**e, succ),
1278 ExprTupField(ref e, _, _) => self.propagate_through_expr(&**e, succ),
1279 _ => self.propagate_through_expr(expr, succ)
1283 // see comment on propagate_through_lvalue()
1284 fn write_lvalue(&mut self, expr: &Expr, succ: LiveNode, acc: uint)
1287 ExprPath(_) => self.access_path(expr, succ, acc),
1289 // We do not track other lvalues, so just propagate through
1290 // to their subcomponents. Also, it may happen that
1291 // non-lvalues occur here, because those are detected in the
1292 // later pass borrowck.
1297 fn access_path(&mut self, expr: &Expr, succ: LiveNode, acc: uint)
1299 let def = self.ir.tcx.def_map.borrow().get_copy(&expr.id);
1300 match moved_variable_node_id_from_def(def) {
1302 let ln = self.live_node(expr.id, expr.span);
1304 self.init_from_succ(ln, succ);
1305 let var = self.variable(nid, expr.span);
1306 self.acc(ln, var, acc);
1314 fn propagate_through_loop(&mut self,
1323 We model control flow like this:
1341 let mut first_merge = true;
1342 let ln = self.live_node(expr.id, expr.span);
1343 self.init_empty(ln, succ);
1347 // If this is not a `loop` loop, then it's possible we bypass
1348 // the body altogether. Otherwise, the only way is via a `break`
1349 // in the loop body.
1350 self.merge_from_succ(ln, succ, first_merge);
1351 first_merge = false;
1354 debug!("propagate_through_loop: using id for loop body {} {}",
1355 expr.id, block_to_string(body));
1357 let cond_ln = match kind {
1359 ForLoop(ref pat) => self.define_bindings_in_pat(*pat, ln),
1360 WhileLoop(ref cond) => self.propagate_through_expr(&**cond, ln),
1362 let body_ln = self.with_loop_nodes(expr.id, succ, ln, |this| {
1363 this.propagate_through_block(body, cond_ln)
1366 // repeat until fixed point is reached:
1367 while self.merge_from_succ(ln, body_ln, first_merge) {
1368 first_merge = false;
1370 let new_cond_ln = match kind {
1372 ForLoop(ref pat) => {
1373 self.define_bindings_in_pat(*pat, ln)
1375 WhileLoop(ref cond) => {
1376 self.propagate_through_expr(&**cond, ln)
1379 assert!(cond_ln == new_cond_ln);
1380 assert!(body_ln == self.with_loop_nodes(expr.id, succ, ln,
1381 |this| this.propagate_through_block(body, cond_ln)));
1387 fn with_loop_nodes<R>(&mut self,
1388 loop_node_id: NodeId,
1391 f: |&mut Liveness<'a, 'tcx>| -> R)
1393 debug!("with_loop_nodes: {} {}", loop_node_id, break_ln.get());
1394 self.loop_scope.push(loop_node_id);
1395 self.break_ln.insert(loop_node_id, break_ln);
1396 self.cont_ln.insert(loop_node_id, cont_ln);
1398 self.loop_scope.pop();
1403 // _______________________________________________________________________
1404 // Checking for error conditions
1406 fn check_local(this: &mut Liveness, local: &Local) {
1409 this.warn_about_unused_or_dead_vars_in_pat(&*local.pat);
1412 this.pat_bindings(&*local.pat, |this, ln, var, sp, id| {
1413 this.warn_about_unused(sp, id, ln, var);
1418 visit::walk_local(this, local);
1421 fn check_arm(this: &mut Liveness, arm: &Arm) {
1422 // only consider the first pattern; any later patterns must have
1423 // the same bindings, and we also consider the first pattern to be
1424 // the "authoritative" set of ids
1425 this.arm_pats_bindings(arm.pats.as_slice().head().map(|p| &**p), |this, ln, var, sp, id| {
1426 this.warn_about_unused(sp, id, ln, var);
1428 visit::walk_arm(this, arm);
1431 fn check_expr(this: &mut Liveness, expr: &Expr) {
1433 ExprAssign(ref l, ref r) => {
1434 this.check_lvalue(&**l);
1435 this.visit_expr(&**r);
1437 visit::walk_expr(this, expr);
1440 ExprAssignOp(_, ref l, _) => {
1441 this.check_lvalue(&**l);
1443 visit::walk_expr(this, expr);
1446 ExprInlineAsm(ref ia) => {
1447 for &(_, ref input) in ia.inputs.iter() {
1448 this.visit_expr(&**input);
1451 // Output operands must be lvalues
1452 for &(_, ref out, _) in ia.outputs.iter() {
1453 this.check_lvalue(&**out);
1454 this.visit_expr(&**out);
1457 visit::walk_expr(this, expr);
1460 ExprForLoop(ref pat, _, _, _) => {
1461 this.pat_bindings(&**pat, |this, ln, var, sp, id| {
1462 this.warn_about_unused(sp, id, ln, var);
1466 // no correctness conditions related to liveness
1467 ExprCall(..) | ExprMethodCall(..) | ExprIf(..) | ExprMatch(..) |
1468 ExprWhile(..) | ExprLoop(..) | ExprIndex(..) | ExprField(..) |
1469 ExprTupField(..) | ExprVec(..) | ExprTup(..) | ExprBinary(..) |
1470 ExprCast(..) | ExprUnary(..) | ExprRet(..) | ExprBreak(..) |
1471 ExprAgain(..) | ExprLit(_) | ExprBlock(..) |
1472 ExprMac(..) | ExprAddrOf(..) | ExprStruct(..) | ExprRepeat(..) |
1473 ExprParen(..) | ExprFnBlock(..) | ExprProc(..) | ExprUnboxedFn(..) |
1474 ExprPath(..) | ExprBox(..) => {
1475 visit::walk_expr(this, expr);
1480 fn check_fn(_v: &Liveness,
1486 // do not check contents of nested fns
1489 impl<'a, 'tcx> Liveness<'a, 'tcx> {
1496 if self.live_on_entry(entry_ln, self.s.no_ret_var).is_some() {
1497 // if no_ret_var is live, then we fall off the end of the
1498 // function without any kind of return expression:
1500 let t_ret = ty::ty_fn_ret(ty::node_id_to_type(self.ir.tcx, id));
1501 if ty::type_is_nil(t_ret) {
1502 // for nil return types, it is ok to not return a value expl.
1503 } else if ty::type_is_bot(t_ret) {
1504 // for bot return types, not ok. Function should fail.
1505 self.ir.tcx.sess.span_err(
1506 sp, "some control paths may return");
1508 let ends_with_stmt = match body.expr {
1509 None if body.stmts.len() > 0 =>
1510 match body.stmts.last().unwrap().node {
1511 StmtSemi(ref e, _) => {
1512 let t_stmt = ty::expr_ty(self.ir.tcx, &**e);
1513 ty::get(t_stmt).sty == ty::get(t_ret).sty
1519 self.ir.tcx.sess.span_err(
1520 sp, "not all control paths return a value");
1522 let last_stmt = body.stmts.last().unwrap();
1523 let original_span = original_sp(last_stmt.span, sp);
1524 let span_semicolon = Span {
1525 lo: original_span.hi - BytePos(1),
1526 hi: original_span.hi,
1527 expn_info: original_span.expn_info
1529 self.ir.tcx.sess.span_note(
1530 span_semicolon, "consider removing this semicolon:");
1536 fn check_lvalue(&mut self, expr: &Expr) {
1539 match self.ir.tcx.def_map.borrow().get_copy(&expr.id) {
1540 DefLocal(nid, _) => {
1541 // Assignment to an immutable variable or argument: only legal
1542 // if there is no later assignment. If this local is actually
1543 // mutable, then check for a reassignment to flag the mutability
1545 let ln = self.live_node(expr.id, expr.span);
1546 let var = self.variable(nid, expr.span);
1547 self.warn_about_dead_assign(expr.span, expr.id, ln, var);
1550 match moved_variable_node_id_from_def(def) {
1552 let ln = self.live_node(expr.id, expr.span);
1553 let var = self.variable(nid, expr.span);
1554 self.warn_about_dead_assign(expr.span, expr.id, ln, var);
1563 // For other kinds of lvalues, no checks are required,
1564 // and any embedded expressions are actually rvalues
1565 visit::walk_expr(self, expr);
1570 fn should_warn(&self, var: Variable) -> Option<String> {
1571 let name = self.ir.variable_name(var);
1572 if name.len() == 0 || name.as_bytes()[0] == ('_' as u8) {
1579 fn warn_about_unused_args(&self, decl: &FnDecl, entry_ln: LiveNode) {
1580 for arg in decl.inputs.iter() {
1581 pat_util::pat_bindings(&self.ir.tcx.def_map,
1583 |_bm, p_id, sp, path1| {
1584 let var = self.variable(p_id, sp);
1585 // Ignore unused self.
1586 let ident = path1.node;
1587 if ident.name != special_idents::self_.name {
1588 self.warn_about_unused(sp, p_id, entry_ln, var);
1594 fn warn_about_unused_or_dead_vars_in_pat(&mut self, pat: &Pat) {
1595 self.pat_bindings(pat, |this, ln, var, sp, id| {
1596 if !this.warn_about_unused(sp, id, ln, var) {
1597 this.warn_about_dead_assign(sp, id, ln, var);
1602 fn warn_about_unused(&self,
1608 if !self.used_on_entry(ln, var) {
1609 let r = self.should_warn(var);
1610 for name in r.iter() {
1612 // annoying: for parameters in funcs like `fn(x: int)
1613 // {ret}`, there is only one node, so asking about
1614 // assigned_on_exit() is not meaningful.
1615 let is_assigned = if ln == self.s.exit_ln {
1618 self.assigned_on_exit(ln, var).is_some()
1622 self.ir.tcx.sess.add_lint(lint::builtin::UNUSED_VARIABLE, id, sp,
1623 format!("variable `{}` is assigned to, but never used",
1626 self.ir.tcx.sess.add_lint(lint::builtin::UNUSED_VARIABLE, id, sp,
1627 format!("unused variable: `{}`", *name));
1636 fn warn_about_dead_assign(&self,
1641 if self.live_on_exit(ln, var).is_none() {
1642 let r = self.should_warn(var);
1643 for name in r.iter() {
1644 self.ir.tcx.sess.add_lint(lint::builtin::DEAD_ASSIGNMENT, id, sp,
1645 format!("value assigned to `{}` is never read", *name));