factor out pre_defs field by going backwards

Author: nikomatsakis

src/librustc_mir/util/liveness.rs

@@ -54,29 +54,72 @@ struct BlockInfo {
 }
 
 struct BlockInfoVisitor {
-    pre_defs: LocalSet,
     defs: LocalSet,
     uses: LocalSet,
 }
 
+impl BlockInfoVisitor {
+    fn add_def(&mut self, index: Local) {
+        // If it was used already in the block, remove that use
+        // now that we found a definition.
+        //
+        // Example:
+        //
+        //     // Defs = {X}, Uses = {}
+        //     X = 5
+        //     // Defs = {}, Uses = {X}
+        //     use(X)
+        self.uses.remove(&index);
+        self.defs.add(&index);
+    }
+
+    fn add_use(&mut self, index: Local) {
+        // Inverse of above.
+        //
+        // Example:
+        //
+        //     // Defs = {}, Uses = {X}
+        //     use(X)
+        //     // Defs = {X}, Uses = {}
+        //     X = 5
+        //     // Defs = {}, Uses = {X}
+        //     use(X)
+        self.defs.remove(&index);
+        self.uses.add(&index);
+    }
+}
+
 impl<'tcx> Visitor<'tcx> for BlockInfoVisitor {
     fn visit_local(&mut self,
                    &local: &Local,
                    context: LvalueContext<'tcx>,
                    _: Location) {
         match context {
+            ///////////////////////////////////////////////////////////////////////////
+            // DEFS
+
             LvalueContext::Store |
 
-            // We let Call defined the result in both the success and unwind cases.
-            // This may not be right.
+            // We let Call defined the result in both the success and
+            // unwind cases. This is not really correct, however it
+            // does not seem to be observable due to the way that we
+            // generate MIR. See the test case
+            // `mir-opt/nll/liveness-call-subtlety.rs`. To do things
+            // properly, we would apply the def in call only to the
+            // input from the success path and not the unwind
+            // path. -nmatsakis
             LvalueContext::Call |
 
             // Storage live and storage dead aren't proper defines, but we can ignore
             // values that come before them.
             LvalueContext::StorageLive |
             LvalueContext::StorageDead => {
-                self.defs.add(&local);
+                self.add_def(local);
             }
+
+            ///////////////////////////////////////////////////////////////////////////
+            // USES
+
             LvalueContext::Projection(..) |
 
             // Borrows only consider their local used at the point of the borrow.
@@ -93,29 +136,26 @@ impl<'tcx> Visitor<'tcx> for BlockInfoVisitor {
             // Drop eloboration should be run before this analysis otherwise
             // the results might be too pessimistic.
             LvalueContext::Drop => {
-                // Ignore uses which are already defined in this block
-                if !self.pre_defs.contains(&local) {
-                    self.uses.add(&local);
-                }
+                self.add_use(local);
             }
         }
     }
 }
 
 fn block<'tcx>(b: &BasicBlockData<'tcx>, locals: usize) -> BlockInfo {
     let mut visitor = BlockInfoVisitor {
-        pre_defs: LocalSet::new_empty(locals),
         defs: LocalSet::new_empty(locals),
         uses: LocalSet::new_empty(locals),
     };
 
     let dummy_location = Location { block: BasicBlock::new(0), statement_index: 0 };
 
-    for statement in &b.statements {
+    // Visit the various parts of the basic block in reverse. If we go
+    // forward, the logic in `add_def` and `add_use` would be wrong.
+    visitor.visit_terminator(BasicBlock::new(0), b.terminator(), dummy_location);
+    for statement in b.statements.iter().rev() {
         visitor.visit_statement(BasicBlock::new(0), statement, dummy_location);
-        visitor.pre_defs.union(&visitor.defs);
     }
-    visitor.visit_terminator(BasicBlock::new(0), b.terminator(), dummy_location);
 
     BlockInfo {
         defs: visitor.defs,

src/test/mir-opt/nll/liveness-drop-intra-block.rs

@@ -0,0 +1,36 @@
+// Copyright 2012-2016 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// compile-flags:-Znll
+
+#![allow(warnings)]
+
+fn use_x(_: usize) -> bool { true }
+
+fn main() {
+    let mut x = 22;
+    loop {
+        // Key point: `x` not live on entry to this basic block.
+        x = 55;
+        if use_x(x) { break; }
+    }
+}
+
+// END RUST SOURCE
+// START rustc.node12.nll.0.mir
+//    | Variables live on entry to the block bb1:
+//    bb1: {
+//        _1 = const 55usize;
+//        StorageLive(_3);
+//        StorageLive(_4);
+//        _4 = _1;
+//        _3 = const use_x(_4) -> bb2;
+//    }
+// END rustc.node12.nll.0.mir