Skip to content

Commit

Permalink
Rollup merge of #107524 - cjgillot:both-storage, r=RalfJung
Browse files Browse the repository at this point in the history
Remove both StorageLive and StorageDead in CopyProp.

Fixes #107511

#106908 removed StorageDead without the accompanying StorageLive. In loops, execution would see repeated StorageLive, without any StorageDead, which is UB.

So when removing storage statements, we have to remove both StorageLive and StorageDead.

~I also added a MIR validation pass for StorageLive. It may be a bit overzealous.~
  • Loading branch information
matthiaskrgr authored Feb 2, 2023
2 parents 230c9e9 + e8ac040 commit 6917040
Show file tree
Hide file tree
Showing 20 changed files with 176 additions and 48 deletions.
25 changes: 14 additions & 11 deletions compiler/rustc_mir_transform/src/copy_prop.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,17 +162,20 @@ impl<'tcx> MutVisitor<'tcx> for Replacer<'_, 'tcx> {
}

fn visit_statement(&mut self, stmt: &mut Statement<'tcx>, loc: Location) {
if let StatementKind::StorageDead(l) = stmt.kind
&& self.storage_to_remove.contains(l)
{
stmt.make_nop();
} else if let StatementKind::Assign(box (ref place, ref mut rvalue)) = stmt.kind
&& place.as_local().is_some()
{
// Do not replace assignments.
self.visit_rvalue(rvalue, loc)
} else {
self.super_statement(stmt, loc);
match stmt.kind {
// When removing storage statements, we need to remove both (#107511).
StatementKind::StorageLive(l) | StatementKind::StorageDead(l)
if self.storage_to_remove.contains(l) =>
{
stmt.make_nop()
}
StatementKind::Assign(box (ref place, ref mut rvalue))
if place.as_local().is_some() =>
{
// Do not replace assignments.
self.visit_rvalue(rvalue, loc)
}
_ => self.super_statement(stmt, loc),
}
}
}
3 changes: 0 additions & 3 deletions tests/mir-opt/const_debuginfo.main.ConstDebugInfo.diff
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,8 @@
}

bb0: {
StorageLive(_1); // scope 0 at $DIR/const_debuginfo.rs:+1:9: +1:10
_1 = const 1_u8; // scope 0 at $DIR/const_debuginfo.rs:+1:13: +1:16
StorageLive(_2); // scope 1 at $DIR/const_debuginfo.rs:+2:9: +2:10
_2 = const 2_u8; // scope 1 at $DIR/const_debuginfo.rs:+2:13: +2:16
StorageLive(_3); // scope 2 at $DIR/const_debuginfo.rs:+3:9: +3:10
_3 = const 3_u8; // scope 2 at $DIR/const_debuginfo.rs:+3:13: +3:16
StorageLive(_4); // scope 3 at $DIR/const_debuginfo.rs:+4:9: +4:12
StorageLive(_5); // scope 3 at $DIR/const_debuginfo.rs:+4:15: +4:20
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
}

bb0: {
StorageLive(_1); // scope 0 at $DIR/bad_op_mod_by_zero.rs:+1:9: +1:10
_1 = const 0_i32; // scope 0 at $DIR/bad_op_mod_by_zero.rs:+1:13: +1:14
StorageLive(_2); // scope 1 at $DIR/bad_op_mod_by_zero.rs:+2:9: +2:11
- _4 = Eq(_1, const 0_i32); // scope 1 at $DIR/bad_op_mod_by_zero.rs:+2:14: +2:19
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
}

bb0: {
StorageLive(_1); // scope 0 at $DIR/scalar_literal_propagation.rs:+1:9: +1:10
_1 = const 1_u32; // scope 0 at $DIR/scalar_literal_propagation.rs:+1:13: +1:14
StorageLive(_2); // scope 1 at $DIR/scalar_literal_propagation.rs:+2:5: +2:15
- _2 = consume(_1) -> bb1; // scope 1 at $DIR/scalar_literal_propagation.rs:+2:5: +2:15
Expand Down
2 changes: 1 addition & 1 deletion tests/mir-opt/copy-prop/cycle.main.CopyProp.diff
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
}

bb1: {
StorageLive(_2); // scope 1 at $DIR/cycle.rs:+2:9: +2:10
- StorageLive(_2); // scope 1 at $DIR/cycle.rs:+2:9: +2:10
_2 = _1; // scope 1 at $DIR/cycle.rs:+2:13: +2:14
- StorageLive(_3); // scope 2 at $DIR/cycle.rs:+3:9: +3:10
- _3 = _2; // scope 2 at $DIR/cycle.rs:+3:13: +3:14
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ fn f(_1: usize) -> usize {
}

bb0: {
StorageLive(_2); // scope 0 at $DIR/dead_stores_79191.rs:+1:9: +1:10
_2 = _1; // scope 0 at $DIR/dead_stores_79191.rs:+1:13: +1:14
_1 = const 5_usize; // scope 1 at $DIR/dead_stores_79191.rs:+2:5: +2:10
_1 = _2; // scope 1 at $DIR/dead_stores_79191.rs:+3:5: +3:10
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ fn f(_1: usize) -> usize {
}

bb0: {
StorageLive(_2); // scope 0 at $DIR/dead_stores_better.rs:+1:9: +1:10
_2 = _1; // scope 0 at $DIR/dead_stores_better.rs:+1:13: +1:14
_1 = const 5_usize; // scope 1 at $DIR/dead_stores_better.rs:+2:5: +2:10
_1 = _2; // scope 1 at $DIR/dead_stores_better.rs:+3:5: +3:10
Expand Down
140 changes: 140 additions & 0 deletions tests/mir-opt/copy-prop/issue_107511.main.CopyProp.diff
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
- // MIR for `main` before CopyProp
+ // MIR for `main` after CopyProp

fn main() -> () {
let mut _0: (); // return place in scope 0 at $DIR/issue_107511.rs:+0:11: +0:11
let mut _1: i32; // in scope 0 at $DIR/issue_107511.rs:+1:9: +1:16
let mut _3: std::ops::Range<usize>; // in scope 0 at $DIR/issue_107511.rs:+6:14: +6:24
let mut _4: std::ops::Range<usize>; // in scope 0 at $DIR/issue_107511.rs:+6:14: +6:24
let mut _5: usize; // in scope 0 at $DIR/issue_107511.rs:+6:17: +6:24
let mut _6: &[i32]; // in scope 0 at $DIR/issue_107511.rs:+6:17: +6:24
let mut _7: &[i32; 4]; // in scope 0 at $DIR/issue_107511.rs:+6:17: +6:24
let mut _9: (); // in scope 0 at $DIR/issue_107511.rs:+0:1: +9:2
let _10: (); // in scope 0 at $DIR/issue_107511.rs:+6:14: +6:24
let mut _11: std::option::Option<usize>; // in scope 0 at $DIR/issue_107511.rs:+6:14: +6:24
let mut _12: &mut std::ops::Range<usize>; // in scope 0 at $DIR/issue_107511.rs:+6:14: +6:24
let mut _13: &mut std::ops::Range<usize>; // in scope 0 at $DIR/issue_107511.rs:+6:14: +6:24
let mut _14: isize; // in scope 0 at $DIR/issue_107511.rs:+6:5: +8:6
let mut _15: !; // in scope 0 at $DIR/issue_107511.rs:+6:5: +8:6
let mut _17: i32; // in scope 0 at $DIR/issue_107511.rs:+7:16: +7:20
let _18: usize; // in scope 0 at $DIR/issue_107511.rs:+7:18: +7:19
let mut _19: usize; // in scope 0 at $DIR/issue_107511.rs:+7:16: +7:20
let mut _20: bool; // in scope 0 at $DIR/issue_107511.rs:+7:16: +7:20
scope 1 {
debug sum => _1; // in scope 1 at $DIR/issue_107511.rs:+1:9: +1:16
let _2: [i32; 4]; // in scope 1 at $DIR/issue_107511.rs:+2:9: +2:10
scope 2 {
debug a => _2; // in scope 2 at $DIR/issue_107511.rs:+2:9: +2:10
let mut _8: std::ops::Range<usize>; // in scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
scope 3 {
debug iter => _8; // in scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
let _16: usize; // in scope 3 at $DIR/issue_107511.rs:+6:9: +6:10
scope 4 {
debug i => _16; // in scope 4 at $DIR/issue_107511.rs:+6:9: +6:10
}
}
}
}

bb0: {
StorageLive(_1); // scope 0 at $DIR/issue_107511.rs:+1:9: +1:16
_1 = const 0_i32; // scope 0 at $DIR/issue_107511.rs:+1:19: +1:20
StorageLive(_2); // scope 1 at $DIR/issue_107511.rs:+2:9: +2:10
_2 = [const 0_i32, const 10_i32, const 20_i32, const 30_i32]; // scope 1 at $DIR/issue_107511.rs:+2:13: +2:28
StorageLive(_3); // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
StorageLive(_4); // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
StorageLive(_5); // scope 2 at $DIR/issue_107511.rs:+6:17: +6:24
StorageLive(_6); // scope 2 at $DIR/issue_107511.rs:+6:17: +6:24
StorageLive(_7); // scope 2 at $DIR/issue_107511.rs:+6:17: +6:24
_7 = &_2; // scope 2 at $DIR/issue_107511.rs:+6:17: +6:24
_6 = move _7 as &[i32] (Pointer(Unsize)); // scope 2 at $DIR/issue_107511.rs:+6:17: +6:24
StorageDead(_7); // scope 2 at $DIR/issue_107511.rs:+6:17: +6:18
_5 = core::slice::<impl [i32]>::len(move _6) -> bb1; // scope 2 at $DIR/issue_107511.rs:+6:17: +6:24
// mir::Constant
// + span: $DIR/issue_107511.rs:10:19: 10:22
// + literal: Const { ty: for<'a> fn(&'a [i32]) -> usize {core::slice::<impl [i32]>::len}, val: Value(<ZST>) }
}

bb1: {
StorageDead(_6); // scope 2 at $DIR/issue_107511.rs:+6:23: +6:24
Deinit(_4); // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
(_4.0: usize) = const 0_usize; // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
(_4.1: usize) = move _5; // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
StorageDead(_5); // scope 2 at $DIR/issue_107511.rs:+6:23: +6:24
_3 = <std::ops::Range<usize> as IntoIterator>::into_iter(move _4) -> bb2; // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
// mir::Constant
// + span: $DIR/issue_107511.rs:10:14: 10:24
// + literal: Const { ty: fn(std::ops::Range<usize>) -> <std::ops::Range<usize> as IntoIterator>::IntoIter {<std::ops::Range<usize> as IntoIterator>::into_iter}, val: Value(<ZST>) }
}

bb2: {
StorageDead(_4); // scope 2 at $DIR/issue_107511.rs:+6:23: +6:24
StorageLive(_8); // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
_8 = move _3; // scope 2 at $DIR/issue_107511.rs:+6:14: +6:24
goto -> bb3; // scope 3 at $DIR/issue_107511.rs:+6:5: +8:6
}

bb3: {
- StorageLive(_10); // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
StorageLive(_11); // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
StorageLive(_12); // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
StorageLive(_13); // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
_13 = &mut _8; // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
_12 = &mut (*_13); // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
_11 = <std::ops::Range<usize> as Iterator>::next(move _12) -> bb4; // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
// mir::Constant
// + span: $DIR/issue_107511.rs:10:14: 10:24
// + literal: Const { ty: for<'a> fn(&'a mut std::ops::Range<usize>) -> Option<<std::ops::Range<usize> as Iterator>::Item> {<std::ops::Range<usize> as Iterator>::next}, val: Value(<ZST>) }
}

bb4: {
StorageDead(_12); // scope 3 at $DIR/issue_107511.rs:+6:23: +6:24
_14 = discriminant(_11); // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
switchInt(move _14) -> [0: bb7, 1: bb5, otherwise: bb6]; // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
}

bb5: {
- StorageLive(_16); // scope 3 at $DIR/issue_107511.rs:+6:9: +6:10
_16 = ((_11 as Some).0: usize); // scope 3 at $DIR/issue_107511.rs:+6:9: +6:10
StorageLive(_17); // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
- StorageLive(_18); // scope 4 at $DIR/issue_107511.rs:+7:18: +7:19
- _18 = _16; // scope 4 at $DIR/issue_107511.rs:+7:18: +7:19
_19 = Len(_2); // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
- _20 = Lt(_18, _19); // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
- assert(move _20, "index out of bounds: the length is {} but the index is {}", move _19, _18) -> bb8; // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
+ _20 = Lt(_16, _19); // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
+ assert(move _20, "index out of bounds: the length is {} but the index is {}", move _19, _16) -> bb8; // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
}

bb6: {
unreachable; // scope 3 at $DIR/issue_107511.rs:+6:14: +6:24
}

bb7: {
_0 = const (); // scope 3 at $DIR/issue_107511.rs:+6:5: +8:6
StorageDead(_13); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
StorageDead(_11); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
- StorageDead(_10); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
StorageDead(_8); // scope 2 at $DIR/issue_107511.rs:+8:5: +8:6
StorageDead(_3); // scope 2 at $DIR/issue_107511.rs:+8:5: +8:6
StorageDead(_2); // scope 1 at $DIR/issue_107511.rs:+9:1: +9:2
StorageDead(_1); // scope 0 at $DIR/issue_107511.rs:+9:1: +9:2
return; // scope 0 at $DIR/issue_107511.rs:+9:2: +9:2
}

bb8: {
- _17 = _2[_18]; // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
+ _17 = _2[_16]; // scope 4 at $DIR/issue_107511.rs:+7:16: +7:20
_1 = Add(_1, move _17); // scope 4 at $DIR/issue_107511.rs:+7:9: +7:20
StorageDead(_17); // scope 4 at $DIR/issue_107511.rs:+7:19: +7:20
- StorageDead(_18); // scope 4 at $DIR/issue_107511.rs:+7:20: +7:21
- _10 = const (); // scope 4 at $DIR/issue_107511.rs:+6:25: +8:6
- StorageDead(_16); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
StorageDead(_13); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
StorageDead(_11); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
- StorageDead(_10); // scope 3 at $DIR/issue_107511.rs:+8:5: +8:6
- _9 = const (); // scope 3 at $DIR/issue_107511.rs:+6:5: +8:6
goto -> bb3; // scope 3 at $DIR/issue_107511.rs:+6:5: +8:6
}
}

13 changes: 13 additions & 0 deletions tests/mir-opt/copy-prop/issue_107511.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// unit-test: CopyProp

// EMIT_MIR issue_107511.main.CopyProp.diff
fn main() {
let mut sum = 0;
let a = [0, 10, 20, 30];

// `i` is assigned in a loop. Only removing its `StorageDead` would mean that
// execution sees repeated `StorageLive`. This would be UB.
for i in 0..a.len() {
sum += a[i];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@
}

bb0: {
StorageLive(_1); // scope 0 at $DIR/inherit_overflow.rs:+3:13: +3:47
_1 = const u8::MAX; // scope 0 at $DIR/inherit_overflow.rs:+3:13: +3:47
StorageLive(_2); // scope 0 at $DIR/inherit_overflow.rs:+3:13: +3:47
_2 = const 1_u8; // scope 0 at $DIR/inherit_overflow.rs:+3:13: +3:47
_5 = CheckedAdd(const u8::MAX, const 1_u8); // scope 2 at $SRC_DIR/core/src/ops/arith.rs:LL:COL
assert(!move (_5.1: bool), "attempt to compute `{} + {}`, which would overflow", const u8::MAX, const 1_u8) -> bb1; // scope 2 at $SRC_DIR/core/src/ops/arith.rs:LL:COL
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@
}

bb6: {
StorageLive(_10); // scope 3 at $DIR/funky_arms.rs:+13:17: +13:26
_10 = ((_7 as Some).0: usize); // scope 3 at $DIR/funky_arms.rs:+13:17: +13:26
StorageLive(_11); // scope 3 at $DIR/funky_arms.rs:+15:43: +15:46
_11 = &mut (*_1); // scope 3 at $DIR/funky_arms.rs:+15:43: +15:46
Expand Down
2 changes: 0 additions & 2 deletions tests/mir-opt/issue_101973.inner.ConstProp.diff
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
bb0: {
StorageLive(_2); // scope 0 at $DIR/issue_101973.rs:+1:5: +1:65
StorageLive(_3); // scope 0 at $DIR/issue_101973.rs:+1:5: +1:58
StorageLive(_4); // scope 0 at $DIR/issue_101973.rs:+1:5: +1:17
StorageLive(_12); // scope 2 at $DIR/issue_101973.rs:7:12: 7:27
StorageLive(_13); // scope 2 at $DIR/issue_101973.rs:7:12: 7:20
_14 = CheckedShr(_1, const 0_i32); // scope 2 at $DIR/issue_101973.rs:7:12: 7:20
Expand Down Expand Up @@ -63,7 +62,6 @@
StorageDead(_13); // scope 2 at $DIR/issue_101973.rs:7:26: 7:27
_4 = BitOr(const 0_u32, move _12); // scope 2 at $DIR/issue_101973.rs:7:5: 7:27
StorageDead(_12); // scope 2 at $DIR/issue_101973.rs:7:26: 7:27
StorageLive(_6); // scope 0 at $DIR/issue_101973.rs:+1:31: +1:57
StorageLive(_7); // scope 0 at $DIR/issue_101973.rs:+1:31: +1:52
StorageLive(_8); // scope 0 at $DIR/issue_101973.rs:+1:32: +1:45
_10 = CheckedShr(_1, const 8_i32); // scope 0 at $DIR/issue_101973.rs:+1:32: +1:45
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

bb0: {
StorageLive(_2); // scope 0 at $DIR/issue_76432.rs:+1:9: +1:10
StorageLive(_4); // scope 0 at $DIR/issue_76432.rs:+1:19: +1:29
StorageLive(_5); // scope 0 at $DIR/issue_76432.rs:+1:20: +1:29
_5 = [_1, _1, _1]; // scope 0 at $DIR/issue_76432.rs:+1:20: +1:29
_4 = &_5; // scope 0 at $DIR/issue_76432.rs:+1:19: +1:29
Expand Down
1 change: 0 additions & 1 deletion tests/mir-opt/simplify_match.main.ConstProp.diff
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
}

bb0: {
StorageLive(_2); // scope 0 at $DIR/simplify_match.rs:+1:17: +1:18
_2 = const false; // scope 0 at $DIR/simplify_match.rs:+1:21: +1:26
- switchInt(_2) -> [0: bb1, otherwise: bb2]; // scope 0 at $DIR/simplify_match.rs:+1:5: +1:31
+ switchInt(const false) -> [0: bb1, otherwise: bb2]; // scope 0 at $DIR/simplify_match.rs:+1:5: +1:31
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,16 +101,16 @@
}

bb0: {
StorageLive(_3); // scope 0 at $DIR/slice_filter.rs:+0:27: +0:28
- StorageLive(_3); // scope 0 at $DIR/slice_filter.rs:+0:27: +0:28
_25 = deref_copy (*_2); // scope 0 at $DIR/slice_filter.rs:+0:27: +0:28
_3 = &((*_25).0: usize); // scope 0 at $DIR/slice_filter.rs:+0:27: +0:28
StorageLive(_4); // scope 0 at $DIR/slice_filter.rs:+0:30: +0:31
- StorageLive(_4); // scope 0 at $DIR/slice_filter.rs:+0:30: +0:31
_26 = deref_copy (*_2); // scope 0 at $DIR/slice_filter.rs:+0:30: +0:31
_4 = &((*_26).1: usize); // scope 0 at $DIR/slice_filter.rs:+0:30: +0:31
StorageLive(_5); // scope 0 at $DIR/slice_filter.rs:+0:33: +0:34
- StorageLive(_5); // scope 0 at $DIR/slice_filter.rs:+0:33: +0:34
_27 = deref_copy (*_2); // scope 0 at $DIR/slice_filter.rs:+0:33: +0:34
_5 = &((*_27).2: usize); // scope 0 at $DIR/slice_filter.rs:+0:33: +0:34
StorageLive(_6); // scope 0 at $DIR/slice_filter.rs:+0:36: +0:37
- StorageLive(_6); // scope 0 at $DIR/slice_filter.rs:+0:36: +0:37
_28 = deref_copy (*_2); // scope 0 at $DIR/slice_filter.rs:+0:36: +0:37
_6 = &((*_28).3: usize); // scope 0 at $DIR/slice_filter.rs:+0:36: +0:37
StorageLive(_7); // scope 1 at $DIR/slice_filter.rs:+0:40: +0:56
Expand Down
Loading

0 comments on commit 6917040

Please sign in to comment.