Skip to content

Add a MIR pass to simplify the control flow graph #29757

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 1 commit into from
Nov 12, 2015
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
1 change: 1 addition & 0 deletions src/librustc_mir/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ pub mod mir_map;
mod hair;
pub mod repr;
mod graphviz;
pub mod transform;
pub mod tcx;
pub mod visit;

5 changes: 4 additions & 1 deletion src/librustc_mir/mir_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ extern crate rustc_front;

use build;
use dot;
use transform::*;
use repr::Mir;
use hair::cx::{PatNode, Cx};
use std::fs::File;
Expand Down Expand Up @@ -147,7 +148,9 @@ impl<'a, 'm, 'tcx> visit::Visitor<'tcx> for InnerDump<'a,'m,'tcx> {
let infcx = infer::new_infer_ctxt(self.tcx, &self.tcx.tables, Some(param_env), true);

match build_mir(Cx::new(&infcx), implicit_arg_tys, id, span, decl, body) {
Ok(mir) => {
Ok(mut mir) => {
simplify_cfg::SimplifyCfg::new().run_on_mir(&mut mir);

let meta_item_list = self.attr
.iter()
.flat_map(|a| a.meta_item_list())
Expand Down
14 changes: 14 additions & 0 deletions src/librustc_mir/repr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,20 @@ impl<'tcx> Terminator<'tcx> {
Call { data: _, targets: ref b } => b,
}
}

pub fn successors_mut(&mut self) -> &mut [BasicBlock] {
use self::Terminator::*;
match *self {
Goto { target: ref mut b } => slice::mut_ref_slice(b),
Panic { target: ref mut b } => slice::mut_ref_slice(b),
If { cond: _, targets: ref mut b } => b,
Switch { targets: ref mut b, .. } => b,
SwitchInt { targets: ref mut b, .. } => b,
Diverge => &mut [],
Return => &mut [],
Call { data: _, targets: ref mut b } => b,
}
}
}

#[derive(Debug)]
Expand Down
18 changes: 18 additions & 0 deletions src/librustc_mir/transform/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Copyright 2015 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.

pub mod simplify_cfg;
mod util;

use repr::Mir;

pub trait MirPass {
fn run_on_mir(&mut self, mir: &mut Mir);
}
135 changes: 135 additions & 0 deletions src/librustc_mir/transform/simplify_cfg.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
// Copyright 2015 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.

use repr::*;
use rustc::middle::const_eval::ConstVal;
use std::mem;
use transform::util;
use transform::MirPass;

pub struct SimplifyCfg;

impl SimplifyCfg {
pub fn new() -> SimplifyCfg {
SimplifyCfg
}

fn remove_dead_blocks(&self, mir: &mut Mir) {
let mut seen = vec![false; mir.basic_blocks.len()];

// These blocks are always required.
seen[START_BLOCK.index()] = true;
seen[END_BLOCK.index()] = true;
seen[DIVERGE_BLOCK.index()] = true;

let mut worklist = vec![START_BLOCK];
while let Some(bb) = worklist.pop() {
for succ in mir.basic_block_data(bb).terminator.successors() {
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems great, but I wonder if we should encapsulate this code into a "depth-first-visitor". Well, can always do that later.

if !seen[succ.index()] {
seen[succ.index()] = true;
worklist.push(*succ);
}
}
}

util::retain_basic_blocks(mir, &seen);
}

fn remove_goto_chains(&self, mir: &mut Mir) -> bool {

// Find the target at the end of the jump chain, return None if there is a loop
fn final_target(mir: &Mir, mut target: BasicBlock) -> Option<BasicBlock> {
// Keep track of already seen blocks to detect loops
let mut seen: Vec<BasicBlock> = Vec::with_capacity(8);

while mir.basic_block_data(target).statements.is_empty() {
match mir.basic_block_data(target).terminator {
Terminator::Goto { target: next } => {
if seen.contains(&next) {
return None;
}
seen.push(next);
target = next;
}
_ => break
}
}

Some(target)
}

let mut changed = false;
for bb in mir.all_basic_blocks() {
// Temporarily swap out the terminator we're modifying to keep borrowck happy
let mut terminator = Terminator::Diverge;
mem::swap(&mut terminator, &mut mir.basic_block_data_mut(bb).terminator);

for target in terminator.successors_mut() {
let new_target = match final_target(mir, *target) {
Some(new_target) => new_target,
None if mir.basic_block_data(bb).statements.is_empty() => bb,
None => continue
};
changed |= *target != new_target;
*target = new_target;
}

mir.basic_block_data_mut(bb).terminator = terminator;
}

changed
}

fn simplify_branches(&self, mir: &mut Mir) -> bool {
let mut changed = false;

for bb in mir.all_basic_blocks() {
// Temporarily swap out the terminator we're modifying to keep borrowck happy
let mut terminator = Terminator::Diverge;
mem::swap(&mut terminator, &mut mir.basic_block_data_mut(bb).terminator);

mir.basic_block_data_mut(bb).terminator = match terminator {
Terminator::If { ref targets, .. } if targets[0] == targets[1] => {
changed = true;
Terminator::Goto { target: targets[0] }
}
Terminator::If { ref targets, cond: Operand::Constant(Constant {
literal: Literal::Value {
value: ConstVal::Bool(cond)
}, ..
}) } => {
changed = true;
let target_idx = if cond { 0 } else { 1 };
Terminator::Goto { target: targets[target_idx] }
}
Terminator::SwitchInt { ref targets, .. } if targets.len() == 1 => {
Terminator::Goto { target: targets[0] }
}
_ => terminator
}
}

changed
}
}

impl MirPass for SimplifyCfg {
fn run_on_mir(&mut self, mir: &mut Mir) {
let mut changed = true;
while changed {
changed = self.simplify_branches(mir);
changed |= self.remove_goto_chains(mir);
self.remove_dead_blocks(mir);
}

// FIXME: Should probably be moved into some kind of pass manager
mir.basic_blocks.shrink_to_fit();
}
}
51 changes: 51 additions & 0 deletions src/librustc_mir/transform/util.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Copyright 2015 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.

use repr::*;

/// Update basic block ids in all terminators using the given replacements,
/// useful e.g. after removal of several basic blocks to update all terminators
/// in a single pass
pub fn update_basic_block_ids(mir: &mut Mir, replacements: &[BasicBlock]) {
for bb in mir.all_basic_blocks() {
for target in mir.basic_block_data_mut(bb).terminator.successors_mut() {
*target = replacements[target.index()];
}
}
}

/// Mass removal of basic blocks to keep the ID-remapping cheap.
pub fn retain_basic_blocks(mir: &mut Mir, keep: &[bool]) {
let num_blocks = mir.basic_blocks.len();

// Check that we have a usage flag for every block
assert_eq!(num_blocks, keep.len());

let first_dead = match keep.iter().position(|&k| !k) {
None => return,
Some(first_dead) => first_dead,
};

// `replacements` maps the old block ids to the new ones
let mut replacements: Vec<_> = (0..num_blocks).map(BasicBlock::new).collect();

let mut dead = 0;
for i in first_dead..num_blocks {
if keep[i] {
replacements[i] = BasicBlock::new(i - dead);
mir.basic_blocks.swap(i, i - dead);
} else {
dead += 1;
}
}
mir.basic_blocks.truncate(num_blocks - dead);

update_basic_block_ids(mir, &replacements);
}