-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
[MIR trans] Optimize trans for biased switches #33566
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,6 +24,7 @@ use meth; | |
use type_of; | ||
use glue; | ||
use type_::Type; | ||
use rustc_data_structures::fnv::FnvHashMap; | ||
|
||
use super::{MirContext, TempRef, drop}; | ||
use super::constant::Const; | ||
|
@@ -95,17 +96,32 @@ impl<'bcx, 'tcx> MirContext<'bcx, 'tcx> { | |
adt::trans_get_discr(bcx, &repr, discr_lvalue.llval, None, true) | ||
); | ||
|
||
// The else branch of the Switch can't be hit, so branch to an unreachable | ||
// instruction so LLVM knows that | ||
let unreachable_blk = self.unreachable_block(); | ||
let switch = bcx.switch(discr, unreachable_blk.llbb, targets.len()); | ||
let mut bb_hist = FnvHashMap(); | ||
for target in targets { | ||
*bb_hist.entry(target).or_insert(0) += 1; | ||
} | ||
let (default_bb, default_blk) = match bb_hist.iter().max_by_key(|&(_, c)| c) { | ||
// If a single target basic blocks is predominant, promote that to be the | ||
// default case for the switch instruction to reduce the size of the generated | ||
// code. This is especially helpful in cases like an if-let on a huge enum. | ||
// Note: This optimization is only valid for exhaustive matches. | ||
Some((&&bb, &c)) if c > targets.len() / 2 => { | ||
(Some(bb), self.blocks[bb.index()]) | ||
} | ||
// We're generating an exhaustive switch, so the else branch | ||
// can't be hit. Branching to an unreachable instruction | ||
// lets LLVM know this | ||
_ => (None, self.unreachable_block()) | ||
}; | ||
let switch = bcx.switch(discr, default_blk.llbb, targets.len()); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That doesn't work for the case where there is no predominant target, because |
||
assert_eq!(adt_def.variants.len(), targets.len()); | ||
for (adt_variant, target) in adt_def.variants.iter().zip(targets) { | ||
let llval = bcx.with_block(|bcx| | ||
adt::trans_case(bcx, &repr, Disr::from(adt_variant.disr_val)) | ||
); | ||
let llbb = self.llblock(*target); | ||
build::AddCase(switch, llval, llbb) | ||
for (adt_variant, &target) in adt_def.variants.iter().zip(targets) { | ||
if default_bb != Some(target) { | ||
let llbb = self.llblock(target); | ||
let llval = bcx.with_block(|bcx| adt::trans_case( | ||
bcx, &repr, Disr::from(adt_variant.disr_val))); | ||
build::AddCase(switch, llval, llbb) | ||
} | ||
} | ||
} | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should add a FIXME here to check for the validity of such transformation. While currently the otherwise branch is always unreachable (and contains a panic), this might not be the case after a bunch of optimisation passes are added to the MIR thus making this transformation invalid.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a note.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TerminatorKind::Switch
can't have an otherwise branch in any case.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's also the
assert_eq!(adt_def.variants.len(), targets.len());
which should in theory make sure we've covered all the cases.