src/librustc_mir/transform/remove_noop_landing_pads.rs

   1 use rustc::ty::TyCtxt;
   2 use rustc::mir::*;
   3 use rustc_data_structures::bit_set::BitSet;
   4 use crate::transform::{MirPass, MirSource};
   5 use crate::util::patch::MirPatch;
   6
   7 /// A pass that removes noop landing pads and replaces jumps to them with
   8 /// `None`. This is important because otherwise LLVM generates terrible
   9 /// code for these.
  10 pub struct RemoveNoopLandingPads;
  11
  12 pub fn remove_noop_landing_pads<'a, 'tcx>(
  13     tcx: TyCtxt<'a, 'tcx, 'tcx>,
  14     mir: &mut Mir<'tcx>)
  15 {
  16     if tcx.sess.no_landing_pads() {
  17         return
  18     }
  19     debug!("remove_noop_landing_pads({:?})", mir);
  20
  21     RemoveNoopLandingPads.remove_nop_landing_pads(mir)
  22 }
  23
  24 impl MirPass for RemoveNoopLandingPads {
  25     fn run_pass<'a, 'tcx>(&self,
  26                           tcx: TyCtxt<'a, 'tcx, 'tcx>,
  27                           _src: MirSource<'tcx>,
  28                           mir: &mut Mir<'tcx>) {
  29         remove_noop_landing_pads(tcx, mir);
  30     }
  31 }
  32
  33 impl RemoveNoopLandingPads {
  34     fn is_nop_landing_pad(
  35         &self,
  36         bb: BasicBlock,
  37         mir: &Mir<'_>,
  38         nop_landing_pads: &BitSet<BasicBlock>,
  39     ) -> bool {
  40         for stmt in &mir[bb].statements {
  41             match stmt.kind {
  42                 StatementKind::FakeRead(..) |
  43                 StatementKind::StorageLive(_) |
  44                 StatementKind::StorageDead(_) |
  45                 StatementKind::AscribeUserType(..) |
  46                 StatementKind::Nop => {
  47                     // These are all nops in a landing pad
  48                 }
  49
  50                 StatementKind::Assign(Place::Local(_), box Rvalue::Use(_)) => {
  51                     // Writing to a local (e.g., a drop flag) does not
  52                     // turn a landing pad to a non-nop
  53                 }
  54
  55                 StatementKind::Assign { .. } |
  56                 StatementKind::SetDiscriminant { .. } |
  57                 StatementKind::InlineAsm { .. } |
  58                 StatementKind::Retag { .. } => {
  59                     return false;
  60                 }
  61             }
  62         }
  63
  64         let terminator = mir[bb].terminator();
  65         match terminator.kind {
  66             TerminatorKind::Goto { .. } |
  67             TerminatorKind::Resume |
  68             TerminatorKind::SwitchInt { .. } |
  69             TerminatorKind::FalseEdges { .. } |
  70             TerminatorKind::FalseUnwind { .. } => {
  71                 terminator.successors().all(|&succ| {
  72                     nop_landing_pads.contains(succ)
  73                 })
  74             },
  75             TerminatorKind::GeneratorDrop |
  76             TerminatorKind::Yield { .. } |
  77             TerminatorKind::Return |
  78             TerminatorKind::Abort |
  79             TerminatorKind::Unreachable |
  80             TerminatorKind::Call { .. } |
  81             TerminatorKind::Assert { .. } |
  82             TerminatorKind::DropAndReplace { .. } |
  83             TerminatorKind::Drop { .. } => {
  84                 false
  85             }
  86         }
  87     }
  88
  89     fn remove_nop_landing_pads(&self, mir: &mut Mir<'_>) {
  90         // make sure there's a single resume block
  91         let resume_block = {
  92             let patch = MirPatch::new(mir);
  93             let resume_block = patch.resume_block();
  94             patch.apply(mir);
  95             resume_block
  96         };
  97         debug!("remove_noop_landing_pads: resume block is {:?}", resume_block);
  98
  99         let mut jumps_folded = 0;
 100         let mut landing_pads_removed = 0;
 101         let mut nop_landing_pads = BitSet::new_empty(mir.basic_blocks().len());
 102
 103         // This is a post-order traversal, so that if A post-dominates B
 104         // then A will be visited before B.
 105         let postorder: Vec<_> = traversal::postorder(mir).map(|(bb, _)| bb).collect();
 106         for bb in postorder {
 107             debug!("  processing {:?}", bb);
 108             for target in mir[bb].terminator_mut().successors_mut() {
 109                 if *target != resume_block && nop_landing_pads.contains(*target) {
 110                     debug!("    folding noop jump to {:?} to resume block", target);
 111                     *target = resume_block;
 112                     jumps_folded += 1;
 113                 }
 114             }
 115
 116             match mir[bb].terminator_mut().unwind_mut() {
 117                 Some(unwind) => {
 118                     if *unwind == Some(resume_block) {
 119                         debug!("    removing noop landing pad");
 120                         jumps_folded -= 1;
 121                         landing_pads_removed += 1;
 122                         *unwind = None;
 123                     }
 124                 }
 125                 _ => {}
 126             }
 127
 128             let is_nop_landing_pad = self.is_nop_landing_pad(bb, mir, &nop_landing_pads);
 129             if is_nop_landing_pad {
 130                 nop_landing_pads.insert(bb);
 131             }
 132             debug!("    is_nop_landing_pad({:?}) = {}", bb, is_nop_landing_pad);
 133         }
 134
 135         debug!("removed {:?} jumps and {:?} landing pads", jumps_folded, landing_pads_removed);
 136     }
 137 }