src/librustc_mir/transform/mod.rs

   1 use crate::{build, shim};
   2 use rustc_index::vec::IndexVec;
   3 use rustc::hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
   4 use rustc::mir::{Body, MirPhase, Promoted, QualifSet};
   5 use rustc::ty::{TyCtxt, InstanceDef, TypeFoldable};
   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_consts;
  19 pub mod check_unsafety;
  20 pub mod simplify_branches;
  21 pub mod simplify;
  22 pub mod erase_regions;
  23 pub mod no_landing_pads;
  24 pub mod rustc_peek;
  25 pub mod elaborate_drops;
  26 pub mod add_call_guards;
  27 pub mod promote_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 uniform_array_move_out;
  38 pub mod uninhabited_enum_branching;
  39
  40 pub(crate) fn provide(providers: &mut Providers<'_>) {
  41     self::check_unsafety::provide(providers);
  42     *providers = Providers {
  43         mir_keys,
  44         mir_built,
  45         mir_const,
  46         mir_const_qualif,
  47         mir_validated,
  48         optimized_mir,
  49         is_mir_available,
  50         promoted_mir,
  51         ..*providers
  52     };
  53 }
  54
  55 fn is_mir_available(tcx: TyCtxt<'_>, 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: TyCtxt<'_>, krate: CrateNum) -> &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(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: TyCtxt<'_>, def_id: DefId) -> &Steal<Body<'_>> {
 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 = ::std::any::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<'tcx> {
 142     fn name(&self) -> Cow<'_, str> {
 143         default_name::<Self>()
 144     }
 145
 146     fn run_pass(&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     promoted: Option<Promoted>,
 154     mir_phase: MirPhase,
 155     passes: &[&dyn MirPass<'tcx>],
 156 ) {
 157     let phase_index = mir_phase.phase_index();
 158
 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<'tcx>| {
 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 fn mir_const_qualif(tcx: TyCtxt<'_>, def_id: DefId) -> QualifSet {
 188     let const_kind = check_consts::ConstKind::for_item(tcx, def_id);
 189
 190     // No need to const-check a non-const `fn`.
 191     if const_kind.is_none() {
 192         return Default::default();
 193     }
 194
 195     // N.B., this `borrow()` is guaranteed to be valid (i.e., the value
 196     // cannot yet be stolen), because `mir_validated()`, which steals
 197     // from `mir_const(), forces this query to execute before
 198     // performing the steal.
 199     let body = &tcx.mir_const(def_id).borrow();
 200
 201     if body.return_ty().references_error() {
 202         tcx.sess.delay_span_bug(body.span, "mir_const_qualif: MIR had errors");
 203         return Default::default();
 204     }
 205
 206     let item = check_consts::Item {
 207         body,
 208         tcx,
 209         def_id,
 210         const_kind,
 211         param_env: tcx.param_env(def_id),
 212     };
 213
 214     let mut validator = check_consts::validation::Validator::new(&item);
 215     validator.check_body();
 216
 217     // We return the qualifs in the return place for every MIR body, even though it is only used
 218     // when deciding to promote a reference to a `const` for now.
 219     validator.qualifs_in_return_place().into()
 220 }
 221
 222 fn mir_const(tcx: TyCtxt<'_>, def_id: DefId) -> &Steal<Body<'_>> {
 223     // Unsafety check uses the raw mir, so make sure it is run
 224     let _ = tcx.unsafety_check_result(def_id);
 225
 226     let mut body = tcx.mir_built(def_id).steal();
 227     run_passes(tcx, &mut body, InstanceDef::Item(def_id), None, MirPhase::Const, &[
 228         // What we need to do constant evaluation.
 229         &simplify::SimplifyCfg::new("initial"),
 230         &rustc_peek::SanityCheck,
 231         &uniform_array_move_out::UniformArrayMoveOut,
 232     ]);
 233     tcx.alloc_steal_mir(body)
 234 }
 235
 236 fn mir_validated(
 237     tcx: TyCtxt<'tcx>,
 238     def_id: DefId,
 239 ) -> (&'tcx Steal<Body<'tcx>>, &'tcx Steal<IndexVec<Promoted, Body<'tcx>>>) {
 240     // Ensure that we compute the `mir_const_qualif` for constants at
 241     // this point, before we steal the mir-const result.
 242     let _ = tcx.mir_const_qualif(def_id);
 243
 244     let mut body = tcx.mir_const(def_id).steal();
 245     let promote_pass = promote_consts::PromoteTemps::default();
 246     run_passes(tcx, &mut body, InstanceDef::Item(def_id), None, MirPhase::Validated, &[
 247         // What we need to run borrowck etc.
 248         &promote_pass,
 249         &simplify::SimplifyCfg::new("qualify-consts"),
 250     ]);
 251     let promoted = promote_pass.promoted_fragments.into_inner();
 252     (tcx.alloc_steal_mir(body), tcx.alloc_steal_promoted(promoted))
 253 }
 254
 255 fn run_optimization_passes<'tcx>(
 256     tcx: TyCtxt<'tcx>,
 257     body: &mut Body<'tcx>,
 258     def_id: DefId,
 259     promoted: Option<Promoted>,
 260 ) {
 261     run_passes(tcx, body, InstanceDef::Item(def_id), promoted, MirPhase::Optimized, &[
 262         // Remove all things only needed by analysis
 263         &no_landing_pads::NoLandingPads::new(tcx),
 264         &simplify_branches::SimplifyBranches::new("initial"),
 265         &remove_noop_landing_pads::RemoveNoopLandingPads,
 266         &cleanup_post_borrowck::CleanupNonCodegenStatements,
 267
 268         &simplify::SimplifyCfg::new("early-opt"),
 269
 270         // These next passes must be executed together
 271         &add_call_guards::CriticalCallEdges,
 272         &elaborate_drops::ElaborateDrops,
 273         &no_landing_pads::NoLandingPads::new(tcx),
 274         // AddMovesForPackedDrops needs to run after drop
 275         // elaboration.
 276         &add_moves_for_packed_drops::AddMovesForPackedDrops,
 277         // AddRetag needs to run after ElaborateDrops, and it needs
 278         // an AllCallEdges pass right before it.  Otherwise it should
 279         // run fairly late, but before optimizations begin.
 280         &add_call_guards::AllCallEdges,
 281         &add_retag::AddRetag,
 282
 283         &simplify::SimplifyCfg::new("elaborate-drops"),
 284
 285         // No lifetime analysis based on borrowing can be done from here on out.
 286
 287         // From here on out, regions are gone.
 288         &erase_regions::EraseRegions,
 289
 290
 291         // Optimizations begin.
 292         &uninhabited_enum_branching::UninhabitedEnumBranching,
 293         &simplify::SimplifyCfg::new("after-uninhabited-enum-branching"),
 294         &uniform_array_move_out::RestoreSubsliceArrayMoveOut::new(tcx),
 295         &inline::Inline,
 296
 297         // Lowering generator control-flow and variables
 298         // has to happen before we do anything else to them.
 299         &generator::StateTransform,
 300
 301         &instcombine::InstCombine,
 302         &const_prop::ConstProp,
 303         &simplify_branches::SimplifyBranches::new("after-const-prop"),
 304         &deaggregator::Deaggregator,
 305         &copy_prop::CopyPropagation,
 306         &simplify_branches::SimplifyBranches::new("after-copy-prop"),
 307         &remove_noop_landing_pads::RemoveNoopLandingPads,
 308         &simplify::SimplifyCfg::new("final"),
 309         &simplify::SimplifyLocals,
 310
 311         &add_call_guards::CriticalCallEdges,
 312         &dump_mir::Marker("PreCodegen"),
 313     ]);
 314 }
 315
 316 fn optimized_mir(tcx: TyCtxt<'_>, def_id: DefId) -> &Body<'_> {
 317     if tcx.is_constructor(def_id) {
 318         // There's no reason to run all of the MIR passes on constructors when
 319         // we can just output the MIR we want directly. This also saves const
 320         // qualification and borrow checking the trouble of special casing
 321         // constructors.
 322         return shim::build_adt_ctor(tcx, def_id);
 323     }
 324
 325     // (Mir-)Borrowck uses `mir_validated`, so we have to force it to
 326     // execute before we can steal.
 327     tcx.ensure().mir_borrowck(def_id);
 328
 329     let (body, _) = tcx.mir_validated(def_id);
 330     let mut body = body.steal();
 331     run_optimization_passes(tcx, &mut body, def_id, None);
 332     tcx.arena.alloc(body)
 333 }
 334
 335 fn promoted_mir<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx IndexVec<Promoted, Body<'tcx>> {
 336     if tcx.is_constructor(def_id) {
 337         return tcx.intern_promoted(IndexVec::new());
 338     }
 339
 340     tcx.ensure().mir_borrowck(def_id);
 341     let (_, promoted) = tcx.mir_validated(def_id);
 342     let mut promoted = promoted.steal();
 343
 344     for (p, mut body) in promoted.iter_enumerated_mut() {
 345         run_optimization_passes(tcx, &mut body, def_id, Some(p));
 346     }
 347
 348     tcx.intern_promoted(promoted)
 349 }