Skip to content
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

Add an InstSimplify for repetitive array expressions #135274

Merged
merged 1 commit into from
Jan 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
30 changes: 30 additions & 0 deletions compiler/rustc_mir_transform/src/instsimplify.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ impl<'tcx> crate::MirPass<'tcx> for InstSimplify {
ctx.simplify_ref_deref(rvalue);
ctx.simplify_ptr_aggregate(rvalue);
ctx.simplify_cast(rvalue);
ctx.simplify_repeated_aggregate(rvalue);
}
_ => {}
}
Expand All @@ -68,6 +69,35 @@ struct InstSimplifyContext<'a, 'tcx> {
}

impl<'tcx> InstSimplifyContext<'_, 'tcx> {
/// Transform aggregates like [0, 0, 0, 0, 0] into [0; 5].
/// GVN can also do this optimization, but GVN is only run at mir-opt-level 2 so having this in
/// InstSimplify helps unoptimized builds.
fn simplify_repeated_aggregate(&self, rvalue: &mut Rvalue<'tcx>) {
let Rvalue::Aggregate(box AggregateKind::Array(_), fields) = rvalue else {
return;
};
if fields.len() < 5 {
return;
}
let first = &fields[rustc_abi::FieldIdx::ZERO];
let Operand::Constant(first) = first else {
return;
};
let Ok(first_val) = first.const_.eval(self.tcx, self.typing_env, first.span) else {
return;
};
if fields.iter().all(|field| {
let Operand::Constant(field) = field else {
return false;
};
let field = field.const_.eval(self.tcx, self.typing_env, field.span);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be cool to see more tests exercising this eval call. Specifically, maybe something like [CONST, CONST, ...] for some global const, something with ZSTs, something gauging whether or not it works with things like nested slices/string lits (probably doesn't? const eval doesn't deduplicate allocations like that right?)

Copy link
Member Author

@saethlin saethlin Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The optimization doesn't work on ZSTs. Ultimately that doesn't matter because RemoveZsts will run before InstSimplify and completely eliminate the statement we would optimize.

But it makes me a bit worried that this doesn't work with ZSTs because we generate a local per array element for ZSTs, but we don't for a numeric literal, and this optimization relies on generating an Operand::Const, not a local per array element that we then Move from.

field == Ok(first_val)
}) {
let len = ty::Const::from_target_usize(self.tcx, fields.len().try_into().unwrap());
*rvalue = Rvalue::Repeat(Operand::Constant(first.clone()), len);
}
}

/// Transform boolean comparisons into logical operations.
fn simplify_bool_cmp(&self, rvalue: &mut Rvalue<'tcx>) {
match rvalue {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
- // MIR for `const_items` before InstSimplify-after-simplifycfg
+ // MIR for `const_items` after InstSimplify-after-simplifycfg

fn const_items() -> [u8; 5] {
let mut _0: [u8; 5];

bb0: {
- _0 = [const const_items::A, const const_items::B, const const_items::C, const const_items::D, const const_items::E];
+ _0 = [const const_items::A; 5];
return;
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
- // MIR for `equal_referents` before InstSimplify-after-simplifycfg
+ // MIR for `equal_referents` after InstSimplify-after-simplifycfg

fn equal_referents() -> [&u8; 5] {
let mut _0: [&u8; 5];

bb0: {
_0 = [const equal_referents::A, const equal_referents::B, const equal_referents::C, const equal_referents::D, const equal_referents::E];
return;
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
- // MIR for `literals` before InstSimplify-after-simplifycfg
+ // MIR for `literals` after InstSimplify-after-simplifycfg

fn literals() -> [u8; 5] {
let mut _0: [u8; 5];

bb0: {
- _0 = [const 0_u8, const 0_u8, const 0_u8, const 0_u8, const 0_u8];
+ _0 = [const 0_u8; 5];
return;
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- // MIR for `local` before InstSimplify-after-simplifycfg
+ // MIR for `local` after InstSimplify-after-simplifycfg

fn local() -> [u8; 5] {
let mut _0: [u8; 5];
let _1: u8;
let mut _2: u8;
let mut _3: u8;
let mut _4: u8;
let mut _5: u8;
let mut _6: u8;
scope 1 {
debug val => _1;
}

bb0: {
StorageLive(_1);
_1 = const 0_u8;
StorageLive(_2);
_2 = copy _1;
StorageLive(_3);
_3 = copy _1;
StorageLive(_4);
_4 = copy _1;
StorageLive(_5);
_5 = copy _1;
StorageLive(_6);
_6 = copy _1;
_0 = [move _2, move _3, move _4, move _5, move _6];
StorageDead(_6);
StorageDead(_5);
StorageDead(_4);
StorageDead(_3);
StorageDead(_2);
StorageDead(_1);
return;
}
}

56 changes: 56 additions & 0 deletions tests/mir-opt/instsimplify/aggregate_array.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
//@ test-mir-pass: InstSimplify-after-simplifycfg
#![crate_type = "lib"]

// This is the easy case, and the most plausible to run into in real code.
// EMIT_MIR aggregate_array.literals.InstSimplify-after-simplifycfg.diff
pub fn literals() -> [u8; 5] {
// CHECK-LABEL: fn literals(
// CHECK: _0 = [const 0_u8; 5];
[0, 0, 0, 0, 0]
}

// Check that hiding the const value behind a const item doesn't prevent the optimization
// EMIT_MIR aggregate_array.const_items.InstSimplify-after-simplifycfg.diff
pub fn const_items() -> [u8; 5] {
const A: u8 = 0;
const B: u8 = 0;
const C: u8 = 0;
const D: u8 = 0;
const E: u8 = 0;

// CHECK-LABEL: fn const_items(
// CHECK: _0 = [const const_items::A; 5];
[A, B, C, D, E]
}

// EMIT_MIR aggregate_array.strs.InstSimplify-after-simplifycfg.diff
pub fn strs() -> [&'static str; 5] {
// CHECK-LABEL: fn strs(
// CHECK: _0 = [const "a"; 5];
["a", "a", "a", "a", "a"]
}

// InstSimplify isn't able to see through the move operands, but GVN can.
// EMIT_MIR aggregate_array.local.InstSimplify-after-simplifycfg.diff
pub fn local() -> [u8; 5] {
// CHECK-LABEL: fn local(
// CHECK: _0 = [move _2, move _3, move _4, move _5, move _6];
let val = 0;
[val, val, val, val, val]
}

// All of these consts refer to the same value, but the addresses are all different.
// It would be wrong to apply the optimization here.
// EMIT_MIR aggregate_array.equal_referents.InstSimplify-after-simplifycfg.diff
pub fn equal_referents() -> [&'static u8; 5] {
const DATA: &[u8] = &[0, 0, 0, 0, 0];
const A: &u8 = &DATA[0];
const B: &u8 = &DATA[1];
const C: &u8 = &DATA[2];
const D: &u8 = &DATA[3];
const E: &u8 = &DATA[4];

// CHECK-LABEL: fn equal_referents(
// CHECK: _0 = [const equal_referents::A, const equal_referents::B, const equal_referents::C, const equal_referents::D, const equal_referents::E];
[A, B, C, D, E]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
- // MIR for `strs` before InstSimplify-after-simplifycfg
+ // MIR for `strs` after InstSimplify-after-simplifycfg

fn strs() -> [&str; 5] {
let mut _0: [&str; 5];

bb0: {
- _0 = [const "a", const "a", const "a", const "a", const "a"];
+ _0 = [const "a"; 5];
return;
}
}

Loading