src/librustc_mir/transform/mod.rs

   1 use crate::{build, shim};
   2 use rustc_data_structures::indexed_vec::IndexVec;
   3 use rustc::hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
   4 use rustc::mir::{Body, MirPhase, Promoted};
   5 use rustc::ty::{TyCtxt, InstanceDef};
   6 use rustc::ty::query::Providers;
   7 use rustc::ty::steal::Steal;
   8 use rustc::hir;
   9 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
  10 use rustc::util::nodemap::DefIdSet;
  11 use std::borrow::Cow;
  12 use syntax::ast;
  13 use syntax_pos::Span;
  14
  15 pub mod add_retag;
  16 pub mod add_moves_for_packed_drops;
  17 pub mod cleanup_post_borrowck;
  18 pub mod check_unsafety;
  19 pub mod simplify_branches;
  20 pub mod simplify;
  21 pub mod erase_regions;
  22 pub mod no_landing_pads;
  23 pub mod rustc_peek;
  24 pub mod elaborate_drops;
  25 pub mod add_call_guards;
  26 pub mod promote_consts;
  27 pub mod qualify_consts;
  28 pub mod qualify_min_const_fn;
  29 pub mod remove_noop_landing_pads;
  30 pub mod dump_mir;
  31 pub mod deaggregator;
  32 pub mod instcombine;
  33 pub mod copy_prop;
  34 pub mod const_prop;
  35 pub mod generator;
  36 pub mod inline;
  37 pub mod lower_128bit;
  38 pub mod uniform_array_move_out;
  39
  40 pub(crate) fn provide(providers: &mut Providers<'_>) {
  41     self::qualify_consts::provide(providers);
  42     self::check_unsafety::provide(providers);
  43     *providers = Providers {
  44         mir_keys,
  45         mir_built,
  46         mir_const,
  47         mir_validated,
  48         optimized_mir,
  49         is_mir_available,
  50         promoted_mir,
  51         ..*providers
  52     };
  53 }
  54
  55 fn is_mir_available<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> bool {
  56     tcx.mir_keys(def_id.krate).contains(&def_id)
  57 }
  58
  59 /// Finds the full set of `DefId`s within the current crate that have
  60 /// MIR associated with them.
  61 fn mir_keys<'tcx>(tcx: TyCtxt<'tcx>, krate: CrateNum) -> &'tcx DefIdSet {
  62     assert_eq!(krate, LOCAL_CRATE);
  63
  64     let mut set = DefIdSet::default();
  65
  66     // All body-owners have MIR associated with them.
  67     set.extend(tcx.body_owners());
  68
  69     // Additionally, tuple struct/variant constructors have MIR, but
  70     // they don't have a BodyId, so we need to build them separately.
  71     struct GatherCtors<'a, 'tcx> {
  72         tcx: TyCtxt<'tcx>,
  73         set: &'a mut DefIdSet,
  74     }
  75     impl<'a, 'tcx> Visitor<'tcx> for GatherCtors<'a, 'tcx> {
  76         fn visit_variant_data(&mut self,
  77                               v: &'tcx hir::VariantData,
  78                               _: ast::Name,
  79                               _: &'tcx hir::Generics,
  80                               _: hir::HirId,
  81                               _: Span) {
  82             if let hir::VariantData::Tuple(_, hir_id) = *v {
  83                 self.set.insert(self.tcx.hir().local_def_id_from_hir_id(hir_id));
  84             }
  85             intravisit::walk_struct_def(self, v)
  86         }
  87         fn nested_visit_map<'b>(&'b mut self) -> NestedVisitorMap<'b, 'tcx> {
  88             NestedVisitorMap::None
  89         }
  90     }
  91     tcx.hir().krate().visit_all_item_likes(&mut GatherCtors {
  92         tcx,
  93         set: &mut set,
  94     }.as_deep_visitor());
  95
  96     tcx.arena.alloc(set)
  97 }
  98
  99 fn mir_built<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx Steal<Body<'tcx>> {
 100     let mir = build::mir_build(tcx, def_id);
 101     tcx.alloc_steal_mir(mir)
 102 }
 103
 104 /// Where a specific `mir::Body` comes from.
 105 #[derive(Debug, Copy, Clone)]
 106 pub struct MirSource<'tcx> {
 107     pub instance: InstanceDef<'tcx>,
 108
 109     /// If `Some`, this is a promoted rvalue within the parent function.
 110     pub promoted: Option<Promoted>,
 111 }
 112
 113 impl<'tcx> MirSource<'tcx> {
 114     pub fn item(def_id: DefId) -> Self {
 115         MirSource {
 116             instance: InstanceDef::Item(def_id),
 117             promoted: None
 118         }
 119     }
 120
 121     #[inline]
 122     pub fn def_id(&self) -> DefId {
 123         self.instance.def_id()
 124     }
 125 }
 126
 127 /// Generates a default name for the pass based on the name of the
 128 /// type `T`.
 129 pub fn default_name<T: ?Sized>() -> Cow<'static, str> {
 130     let name = unsafe { ::std::intrinsics::type_name::<T>() };
 131     if let Some(tail) = name.rfind(":") {
 132         Cow::from(&name[tail+1..])
 133     } else {
 134         Cow::from(name)
 135     }
 136 }
 137
 138 /// A streamlined trait that you can implement to create a pass; the
 139 /// pass will be named after the type, and it will consist of a main
 140 /// loop that goes over each available MIR and applies `run_pass`.
 141 pub trait MirPass {
 142     fn name<'a>(&'a self) -> Cow<'a, str> {
 143         default_name::<Self>()
 144     }
 145
 146     fn run_pass<'tcx>(&self, tcx: TyCtxt<'tcx>, source: MirSource<'tcx>, body: &mut Body<'tcx>);
 147 }
 148
 149 pub fn run_passes(
 150     tcx: TyCtxt<'tcx>,
 151     body: &mut Body<'tcx>,
 152     instance: InstanceDef<'tcx>,
 153     mir_phase: MirPhase,
 154     passes: &[&dyn MirPass],
 155 ) {
 156     let phase_index = mir_phase.phase_index();
 157
 158     let run_passes = |body: &mut Body<'tcx>, promoted| {
 159         if body.phase >= mir_phase {
 160             return;
 161         }
 162
 163         let source = MirSource {
 164             instance,
 165             promoted,
 166         };
 167         let mut index = 0;
 168         let mut run_pass = |pass: &dyn MirPass| {
 169             let run_hooks = |body: &_, index, is_after| {
 170                 dump_mir::on_mir_pass(tcx, &format_args!("{:03}-{:03}", phase_index, index),
 171                                       &pass.name(), source, body, is_after);
 172             };
 173             run_hooks(body, index, false);
 174             pass.run_pass(tcx, source, body);
 175             run_hooks(body, index, true);
 176
 177             index += 1;
 178         };
 179
 180         for pass in passes {
 181             run_pass(*pass);
 182         }
 183
 184         body.phase = mir_phase;
 185     };
 186
 187     run_passes(body, None);
 188
 189     for (index, promoted_body) in body.promoted.iter_enumerated_mut() {
 190         run_passes(promoted_body, Some(index));
 191
 192         //Let's make sure we don't miss any nested instances
 193         assert!(promoted_body.promoted.is_empty())
 194     }
 195 }
 196
 197 fn mir_const<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx Steal<Body<'tcx>> {
 198     // Unsafety check uses the raw mir, so make sure it is run
 199     let _ = tcx.unsafety_check_result(def_id);
 200
 201     let mut body = tcx.mir_built(def_id).steal();
 202     run_passes(tcx, &mut body, InstanceDef::Item(def_id), MirPhase::Const, &[
 203         // What we need to do constant evaluation.
 204         &simplify::SimplifyCfg::new("initial"),
 205         &rustc_peek::SanityCheck,
 206         &uniform_array_move_out::UniformArrayMoveOut,
 207     ]);
 208     tcx.alloc_steal_mir(body)
 209 }
 210
 211 fn mir_validated(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx Steal<Body<'tcx>> {
 212     let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
 213     if let hir::BodyOwnerKind::Const = tcx.hir().body_owner_kind(hir_id) {
 214         // Ensure that we compute the `mir_const_qualif` for constants at
 215         // this point, before we steal the mir-const result.
 216         let _ = tcx.mir_const_qualif(def_id);
 217     }
 218
 219     let mut body = tcx.mir_const(def_id).steal();
 220     run_passes(tcx, &mut body, InstanceDef::Item(def_id), MirPhase::Validated, &[
 221         // What we need to run borrowck etc.
 222         &qualify_consts::QualifyAndPromoteConstants,
 223         &simplify::SimplifyCfg::new("qualify-consts"),
 224     ]);
 225     tcx.alloc_steal_mir(body)
 226 }
 227
 228 fn optimized_mir<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx Body<'tcx> {
 229     if tcx.is_constructor(def_id) {
 230         // There's no reason to run all of the MIR passes on constructors when
 231         // we can just output the MIR we want directly. This also saves const
 232         // qualification and borrow checking the trouble of special casing
 233         // constructors.
 234         return shim::build_adt_ctor(tcx, def_id);
 235     }
 236
 237     // (Mir-)Borrowck uses `mir_validated`, so we have to force it to
 238     // execute before we can steal.
 239     tcx.ensure().mir_borrowck(def_id);
 240
 241     if tcx.use_ast_borrowck() {
 242         tcx.ensure().borrowck(def_id);
 243     }
 244
 245     let mut body = tcx.mir_validated(def_id).steal();
 246     run_passes(tcx, &mut body, InstanceDef::Item(def_id), MirPhase::Optimized, &[
 247         // Remove all things only needed by analysis
 248         &no_landing_pads::NoLandingPads,
 249         &simplify_branches::SimplifyBranches::new("initial"),
 250         &remove_noop_landing_pads::RemoveNoopLandingPads,
 251         &cleanup_post_borrowck::CleanupNonCodegenStatements,
 252
 253         &simplify::SimplifyCfg::new("early-opt"),
 254
 255         // These next passes must be executed together
 256         &add_call_guards::CriticalCallEdges,
 257         &elaborate_drops::ElaborateDrops,
 258         &no_landing_pads::NoLandingPads,
 259         // AddMovesForPackedDrops needs to run after drop
 260         // elaboration.
 261         &add_moves_for_packed_drops::AddMovesForPackedDrops,
 262         // AddRetag needs to run after ElaborateDrops, and it needs
 263         // an AllCallEdges pass right before it.  Otherwise it should
 264         // run fairly late, but before optimizations begin.
 265         &add_call_guards::AllCallEdges,
 266         &add_retag::AddRetag,
 267
 268         &simplify::SimplifyCfg::new("elaborate-drops"),
 269
 270         // No lifetime analysis based on borrowing can be done from here on out.
 271
 272         // From here on out, regions are gone.
 273         &erase_regions::EraseRegions,
 274
 275         &lower_128bit::Lower128Bit,
 276
 277
 278         // Optimizations begin.
 279         &uniform_array_move_out::RestoreSubsliceArrayMoveOut,
 280         &inline::Inline,
 281
 282         // Lowering generator control-flow and variables
 283         // has to happen before we do anything else to them.
 284         &generator::StateTransform,
 285
 286         &instcombine::InstCombine,
 287         &const_prop::ConstProp,
 288         &simplify_branches::SimplifyBranches::new("after-const-prop"),
 289         &deaggregator::Deaggregator,
 290         &copy_prop::CopyPropagation,
 291         &simplify_branches::SimplifyBranches::new("after-copy-prop"),
 292         &remove_noop_landing_pads::RemoveNoopLandingPads,
 293         &simplify::SimplifyCfg::new("final"),
 294         &simplify::SimplifyLocals,
 295
 296         &add_call_guards::CriticalCallEdges,
 297         &dump_mir::Marker("PreCodegen"),
 298     ]);
 299     tcx.arena.alloc(body)
 300 }
 301
 302 fn promoted_mir<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx IndexVec<Promoted, Body<'tcx>> {
 303     let body = tcx.optimized_mir(def_id);
 304     &body.promoted
 305 }