Skip to content

Replace switch to unreachable by assume statements #113970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Only emit != assumptions if the otherwise target is reachable.
  • Loading branch information
cjgillot committed Oct 31, 2023
commit cb918904fe693e93c679d4c3417cfe7776f8ebe2
13 changes: 6 additions & 7 deletions compiler/rustc_mir_transform/src/unreachable_prop.rs
Original file line number Diff line number Diff line change
Expand Up @@ -116,22 +116,21 @@ fn remove_successors_from_switch<'tcx>(
patch.add_statement(location, StatementKind::Intrinsic(Box::new(assume)));
};

let otherwise = targets.otherwise();
let otherwise_unreachable = is_unreachable(otherwise);

let reachable_iter = targets.iter().filter(|&(value, bb)| {
let is_unreachable = is_unreachable(bb);
if is_unreachable {
// We remove this target from the switch, so record the inequality using `Assume`.
// We remove this target from the switch, so record the inequality using `Assume`.
if is_unreachable && !otherwise_unreachable {
add_assumption(BinOp::Ne, value);
false
} else {
true
}
!is_unreachable
});

let otherwise = targets.otherwise();
let new_targets = SwitchTargets::new(reachable_iter, otherwise);

let num_targets = new_targets.all_targets().len();
let otherwise_unreachable = is_unreachable(otherwise);
let fully_unreachable = num_targets == 1 && otherwise_unreachable;

let terminator = match (num_targets, otherwise_unreachable) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
+ let mut _3: &std::option::Option<T>;
+ let mut _4: isize;
+ let mut _5: bool;
+ let mut _6: bool;
+ scope 2 {
+ debug val => _0;
+ }
Expand All @@ -37,14 +36,10 @@
+ StorageLive(_3);
+ StorageLive(_4);
+ StorageLive(_5);
+ StorageLive(_6);
+ _4 = discriminant(_2);
+ _5 = Ne(_4, const 0_isize);
+ _5 = Eq(_4, const 1_isize);
+ assume(move _5);
+ _6 = Eq(_4, const 1_isize);
+ assume(move _6);
+ _0 = move ((_2 as Some).0: T);
+ StorageDead(_6);
+ StorageDead(_5);
+ StorageDead(_4);
+ StorageDead(_3);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
+ let mut _3: &std::option::Option<T>;
+ let mut _4: isize;
+ let mut _5: bool;
+ let mut _6: bool;
+ scope 2 {
+ debug val => _0;
+ }
Expand All @@ -37,14 +36,10 @@
+ StorageLive(_3);
+ StorageLive(_4);
+ StorageLive(_5);
+ StorageLive(_6);
+ _4 = discriminant(_2);
+ _5 = Ne(_4, const 0_isize);
+ _5 = Eq(_4, const 1_isize);
+ assume(move _5);
+ _6 = Eq(_4, const 1_isize);
+ assume(move _6);
+ _0 = move ((_2 as Some).0: T);
+ StorageDead(_6);
+ StorageDead(_5);
+ StorageDead(_4);
+ StorageDead(_3);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ fn unwrap_unchecked(_1: Option<T>) -> T {
debug self => _1;
let mut _2: isize;
let mut _3: bool;
let mut _4: bool;
let mut _5: &std::option::Option<T>;
let mut _4: &std::option::Option<T>;
scope 2 {
debug val => _0;
}
Expand All @@ -21,25 +20,21 @@ fn unwrap_unchecked(_1: Option<T>) -> T {
}
}
scope 4 (inlined Option::<T>::is_some) {
debug self => _5;
debug self => _4;
}
}

bb0: {
StorageLive(_5);
StorageLive(_4);
StorageLive(_2);
StorageLive(_3);
StorageLive(_4);
_2 = discriminant(_1);
_3 = Ne(_2, const 0_isize);
_3 = Eq(_2, const 1_isize);
assume(move _3);
_4 = Eq(_2, const 1_isize);
assume(move _4);
_0 = move ((_1 as Some).0: T);
StorageDead(_4);
StorageDead(_3);
StorageDead(_2);
StorageDead(_5);
StorageDead(_4);
return;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ fn unwrap_unchecked(_1: Option<T>) -> T {
debug self => _1;
let mut _2: isize;
let mut _3: bool;
let mut _4: bool;
let mut _5: &std::option::Option<T>;
let mut _4: &std::option::Option<T>;
scope 2 {
debug val => _0;
}
Expand All @@ -21,25 +20,21 @@ fn unwrap_unchecked(_1: Option<T>) -> T {
}
}
scope 4 (inlined Option::<T>::is_some) {
debug self => _5;
debug self => _4;
}
}

bb0: {
StorageLive(_5);
StorageLive(_4);
StorageLive(_2);
StorageLive(_3);
StorageLive(_4);
_2 = discriminant(_1);
_3 = Ne(_2, const 0_isize);
_3 = Eq(_2, const 1_isize);
assume(move _3);
_4 = Eq(_2, const 1_isize);
assume(move _4);
_0 = move ((_1 as Some).0: T);
StorageDead(_4);
StorageDead(_3);
StorageDead(_2);
StorageDead(_5);
StorageDead(_4);
return;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ fn ub_if_b(_1: Thing) -> Thing {
let mut _0: Thing;
let mut _2: isize;
let mut _3: bool;
let mut _4: bool;
scope 1 (inlined unreachable_unchecked) {
scope 2 {
scope 3 (inlined unreachable_unchecked::runtime) {
Expand All @@ -15,10 +14,8 @@ fn ub_if_b(_1: Thing) -> Thing {

bb0: {
_2 = discriminant(_1);
_3 = Ne(_2, const 1_isize);
_3 = Eq(_2, const 0_isize);
assume(move _3);
_4 = Eq(_2, const 0_isize);
assume(move _4);
_0 = move _1;
return;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
- // MIR for `as_match` before UnreachablePropagation
+ // MIR for `as_match` after UnreachablePropagation

fn as_match() -> () {
let mut _0: ();
let mut _1: std::option::Option<Empty>;
let mut _2: isize;
let _3: Empty;
let mut _4: !;
+ let mut _5: bool;
scope 1 {
debug _x => _3;
}

bb0: {
StorageLive(_1);
_1 = empty() -> [return: bb1, unwind unreachable];
}

bb1: {
_2 = discriminant(_1);
- switchInt(move _2) -> [0: bb4, 1: bb2, otherwise: bb3];
+ _5 = Eq(_2, const 0_isize);
+ assume(move _5);
+ goto -> bb4;
}

bb2: {
- StorageLive(_3);
- _3 = move ((_1 as Some).0: Empty);
- StorageLive(_4);
unreachable;
}

bb3: {
unreachable;
}

bb4: {
_0 = const ();
StorageDead(_1);
return;
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
- // MIR for `as_match` before UnreachablePropagation
+ // MIR for `as_match` after UnreachablePropagation

fn as_match() -> () {
let mut _0: ();
let mut _1: std::option::Option<Empty>;
let mut _2: isize;
let _3: Empty;
let mut _4: !;
+ let mut _5: bool;
scope 1 {
debug _x => _3;
}

bb0: {
StorageLive(_1);
_1 = empty() -> [return: bb1, unwind continue];
}

bb1: {
_2 = discriminant(_1);
- switchInt(move _2) -> [0: bb4, 1: bb2, otherwise: bb3];
+ _5 = Eq(_2, const 0_isize);
+ assume(move _5);
+ goto -> bb4;
}

bb2: {
- StorageLive(_3);
- _3 = move ((_1 as Some).0: Empty);
- StorageLive(_4);
unreachable;
}

bb3: {
unreachable;
}

bb4: {
_0 = const ();
StorageDead(_1);
return;
}
}

Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
- // MIR for `main` before UnreachablePropagation
+ // MIR for `main` after UnreachablePropagation
- // MIR for `if_let` before UnreachablePropagation
+ // MIR for `if_let` after UnreachablePropagation

fn main() -> () {
fn if_let() -> () {
let mut _0: ();
let mut _1: std::option::Option<Empty>;
let mut _2: isize;
let _5: ();
let mut _6: bool;
let mut _7: !;
+ let mut _8: bool;
+ let mut _9: bool;
scope 1 {
debug _x => _3;
let _3: Empty;
Expand All @@ -27,8 +26,8 @@
bb1: {
_2 = discriminant(_1);
- switchInt(move _2) -> [1: bb2, otherwise: bb6];
+ _9 = Ne(_2, const 1_isize);
+ assume(move _9);
+ _8 = Ne(_2, const 1_isize);
+ assume(move _8);
+ goto -> bb6;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
- // MIR for `main` before UnreachablePropagation
+ // MIR for `main` after UnreachablePropagation
- // MIR for `if_let` before UnreachablePropagation
+ // MIR for `if_let` after UnreachablePropagation

fn main() -> () {
fn if_let() -> () {
let mut _0: ();
let mut _1: std::option::Option<Empty>;
let mut _2: isize;
let _5: ();
let mut _6: bool;
let mut _7: !;
+ let mut _8: bool;
+ let mut _9: bool;
scope 1 {
debug _x => _3;
let _3: Empty;
Expand All @@ -27,8 +26,8 @@
bb1: {
_2 = discriminant(_1);
- switchInt(move _2) -> [1: bb2, otherwise: bb6];
+ _9 = Ne(_2, const 1_isize);
+ assume(move _9);
+ _8 = Ne(_2, const 1_isize);
+ assume(move _8);
+ goto -> bb6;
}

Expand Down
32 changes: 29 additions & 3 deletions tests/mir-opt/unreachable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ fn empty() -> Option<Empty> {
None
}

// EMIT_MIR unreachable.main.UnreachablePropagation.diff
fn main() {
// CHECK-LABEL: fn main(
// EMIT_MIR unreachable.if_let.UnreachablePropagation.diff
fn if_let() {
// CHECK-LABEL: fn if_let(
// CHECK: bb0: {
// CHECK: {{_.*}} = empty()
// CHECK: bb1: {
Expand Down Expand Up @@ -38,3 +38,29 @@ fn main() {
match _x { }
}
}

// EMIT_MIR unreachable.as_match.UnreachablePropagation.diff
fn as_match() {
// CHECK-LABEL: fn as_match(
// CHECK: bb0: {
// CHECK: {{_.*}} = empty()
// CHECK: bb1: {
// CHECK: [[eq:_.*]] = Eq({{.*}}, const 0_isize);
// CHECK-NEXT: assume(move [[eq]]);
// CHECK-NEXT: goto -> bb4;
// CHECK: bb2: {
// CHECK-NEXT: unreachable;
// CHECK: bb3: {
// CHECK-NEXT: unreachable;
// CHECK: bb4: {
// CHECK: return;
match empty() {
None => {}
Some(_x) => match _x {}
}
}

fn main() {
if_let();
as_match();
}