1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use rustc::hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
13 use rustc::mir::{Mir, Promoted};
14 use rustc::ty::TyCtxt;
15 use rustc::ty::maps::Providers;
16 use rustc::ty::steal::Steal;
18 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
19 use rustc::util::nodemap::DefIdSet;
25 pub mod add_validation;
26 pub mod add_moves_for_packed_drops;
27 pub mod clean_end_regions;
28 pub mod check_unsafety;
29 pub mod simplify_branches;
31 pub mod erase_regions;
32 pub mod no_landing_pads;
35 pub mod elaborate_drops;
36 pub mod add_call_guards;
37 pub mod promote_consts;
38 pub mod qualify_consts;
39 pub mod remove_noop_landing_pads;
49 pub(crate) fn provide(providers: &mut Providers) {
50 self::qualify_consts::provide(providers);
51 self::check_unsafety::provide(providers);
52 *providers = Providers {
63 fn is_mir_available<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> bool {
64 tcx.mir_keys(def_id.krate).contains(&def_id)
67 /// Finds the full set of def-ids within the current crate that have
68 /// MIR associated with them.
69 fn mir_keys<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, krate: CrateNum)
71 assert_eq!(krate, LOCAL_CRATE);
73 let mut set = DefIdSet();
75 // All body-owners have MIR associated with them.
76 set.extend(tcx.body_owners());
78 // Additionally, tuple struct/variant constructors have MIR, but
79 // they don't have a BodyId, so we need to build them separately.
80 struct GatherCtors<'a, 'tcx: 'a> {
81 tcx: TyCtxt<'a, 'tcx, 'tcx>,
82 set: &'a mut DefIdSet,
84 impl<'a, 'tcx> Visitor<'tcx> for GatherCtors<'a, 'tcx> {
85 fn visit_variant_data(&mut self,
86 v: &'tcx hir::VariantData,
88 _: &'tcx hir::Generics,
91 if let hir::VariantData::Tuple(_, node_id) = *v {
92 self.set.insert(self.tcx.hir.local_def_id(node_id));
94 intravisit::walk_struct_def(self, v)
96 fn nested_visit_map<'b>(&'b mut self) -> NestedVisitorMap<'b, 'tcx> {
97 NestedVisitorMap::None
100 tcx.hir.krate().visit_all_item_likes(&mut GatherCtors {
103 }.as_deep_visitor());
108 fn mir_built<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> &'tcx Steal<Mir<'tcx>> {
109 let mir = build::mir_build(tcx, def_id);
110 tcx.alloc_steal_mir(mir)
113 /// Where a specific Mir comes from.
114 #[derive(Debug, Copy, Clone)]
115 pub struct MirSource {
118 /// If `Some`, this is a promoted rvalue within the parent function.
119 pub promoted: Option<Promoted>,
123 pub fn item(def_id: DefId) -> Self {
131 /// Generates a default name for the pass based on the name of the
133 pub fn default_name<T: ?Sized>() -> Cow<'static, str> {
134 let name = unsafe { ::std::intrinsics::type_name::<T>() };
135 if let Some(tail) = name.rfind(":") {
136 Cow::from(&name[tail+1..])
142 /// A streamlined trait that you can implement to create a pass; the
143 /// pass will be named after the type, and it will consist of a main
144 /// loop that goes over each available MIR and applies `run_pass`.
146 fn name<'a>(&'a self) -> Cow<'a, str> {
147 default_name::<Self>()
150 fn run_pass<'a, 'tcx>(&self,
151 tcx: TyCtxt<'a, 'tcx, 'tcx>,
153 mir: &mut Mir<'tcx>);
156 pub macro run_passes($tcx:ident, $mir:ident, $def_id:ident, $suite_index:expr; $($pass:expr,)*) {{
157 let suite_index: usize = $suite_index;
158 let run_passes = |mir: &mut _, promoted| {
159 let source = MirSource {
164 let mut run_pass = |pass: &MirPass| {
165 let run_hooks = |mir: &_, index, is_after| {
166 dump_mir::on_mir_pass($tcx, &format_args!("{:03}-{:03}", suite_index, index),
167 &pass.name(), source, mir, is_after);
169 run_hooks(mir, index, false);
170 pass.run_pass($tcx, source, mir);
171 run_hooks(mir, index, true);
175 $(run_pass(&$pass);)*
178 run_passes(&mut $mir, None);
180 for (index, promoted_mir) in $mir.promoted.iter_enumerated_mut() {
181 run_passes(promoted_mir, Some(index));
183 // Let's make sure we don't miss any nested instances
184 assert!(promoted_mir.promoted.is_empty());
188 fn mir_const<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> &'tcx Steal<Mir<'tcx>> {
189 // Unsafety check uses the raw mir, so make sure it is run
190 let _ = tcx.unsafety_check_result(def_id);
192 let mut mir = tcx.mir_built(def_id).steal();
193 run_passes![tcx, mir, def_id, 0;
194 // Remove all `EndRegion` statements that are not involved in borrows.
195 clean_end_regions::CleanEndRegions,
197 // What we need to do constant evaluation.
198 simplify::SimplifyCfg::new("initial"),
199 type_check::TypeckMir,
200 rustc_peek::SanityCheck,
202 tcx.alloc_steal_mir(mir)
205 fn mir_validated<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> &'tcx Steal<Mir<'tcx>> {
206 let node_id = tcx.hir.as_local_node_id(def_id).unwrap();
207 if let hir::BodyOwnerKind::Const = tcx.hir.body_owner_kind(node_id) {
208 // Ensure that we compute the `mir_const_qualif` for constants at
209 // this point, before we steal the mir-const result.
210 let _ = tcx.mir_const_qualif(def_id);
213 let mut mir = tcx.mir_const(def_id).steal();
214 run_passes![tcx, mir, def_id, 1;
215 // What we need to run borrowck etc.
216 qualify_consts::QualifyAndPromoteConstants,
217 simplify::SimplifyCfg::new("qualify-consts"),
219 tcx.alloc_steal_mir(mir)
222 fn optimized_mir<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> &'tcx Mir<'tcx> {
223 // (Mir-)Borrowck uses `mir_validated`, so we have to force it to
224 // execute before we can steal.
225 let _ = tcx.mir_borrowck(def_id);
226 let _ = tcx.borrowck(def_id);
228 let mut mir = tcx.mir_validated(def_id).steal();
229 run_passes![tcx, mir, def_id, 2;
230 // Remove all things not needed by analysis
231 no_landing_pads::NoLandingPads,
232 simplify_branches::SimplifyBranches::new("initial"),
233 remove_noop_landing_pads::RemoveNoopLandingPads,
234 simplify::SimplifyCfg::new("early-opt"),
236 // These next passes must be executed together
237 add_call_guards::CriticalCallEdges,
238 elaborate_drops::ElaborateDrops,
239 no_landing_pads::NoLandingPads,
240 // AddValidation needs to run after ElaborateDrops and before EraseRegions, and it needs
241 // an AllCallEdges pass right before it.
242 add_call_guards::AllCallEdges,
243 add_validation::AddValidation,
244 // AddMovesForPackedDrops needs to run after drop
246 add_moves_for_packed_drops::AddMovesForPackedDrops,
248 simplify::SimplifyCfg::new("elaborate-drops"),
250 // No lifetime analysis based on borrowing can be done from here on out.
252 // From here on out, regions are gone.
253 erase_regions::EraseRegions,
255 lower_128bit::Lower128Bit,
257 // Optimizations begin.
259 instcombine::InstCombine,
260 deaggregator::Deaggregator,
261 copy_prop::CopyPropagation,
262 remove_noop_landing_pads::RemoveNoopLandingPads,
263 simplify::SimplifyCfg::new("final"),
264 simplify::SimplifyLocals,
266 generator::StateTransform,
267 add_call_guards::CriticalCallEdges,
268 dump_mir::Marker("PreTrans"),