1 // Copyright 2014 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::{DefId, LOCAL_CRATE};
14 use rustc::mir::transform::{MirSuite, MirPassIndex, MirSource};
15 use rustc::ty::TyCtxt;
16 use rustc_data_structures::fx::FxHashMap;
17 use rustc_data_structures::indexed_vec::{Idx};
18 use std::fmt::Display;
20 use std::io::{self, Write};
21 use std::path::{PathBuf, Path};
23 const INDENT: &'static str = " ";
24 /// Alignment for lining up comments following MIR statements
25 const ALIGN: usize = 40;
27 /// If the session is properly configured, dumps a human-readable
28 /// representation of the mir into:
31 /// rustc.node<node_id>.<pass_num>.<pass_name>.<disambiguator>
34 /// Output from this function is controlled by passing `-Z dump-mir=<filter>`,
35 /// where `<filter>` takes the following forms:
37 /// - `all` -- dump MIR for all fns, all passes, all everything
38 /// - `substring1&substring2,...` -- `&`-separated list of substrings
39 /// that can appear in the pass-name or the `item_path_str` for the given
40 /// node-id. If any one of the substrings match, the data is dumped out.
41 pub fn dump_mir<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
42 pass_num: Option<(MirSuite, MirPassIndex)>,
44 disambiguator: &Display,
47 if !dump_enabled(tcx, pass_name, source) {
51 let node_path = tcx.item_path_str(tcx.hir.local_def_id(source.item_id()));
52 dump_matched_mir_node(tcx, pass_num, pass_name, &node_path,
53 disambiguator, source, mir);
54 for (index, promoted_mir) in mir.promoted.iter_enumerated() {
55 let promoted_source = MirSource::Promoted(source.item_id(), index);
56 dump_matched_mir_node(tcx, pass_num, pass_name, &node_path, disambiguator,
57 promoted_source, promoted_mir);
61 pub fn dump_enabled<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
65 let filters = match tcx.sess.opts.debugging_opts.dump_mir {
67 Some(ref filters) => filters,
69 let node_id = source.item_id();
70 let node_path = tcx.item_path_str(tcx.hir.local_def_id(node_id));
74 pass_name.contains(filter) ||
75 node_path.contains(filter)
79 fn dump_matched_mir_node<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
80 pass_num: Option<(MirSuite, MirPassIndex)>,
83 disambiguator: &Display,
86 let promotion_id = match source {
87 MirSource::Promoted(_, id) => format!("-{:?}", id),
91 let pass_num = if tcx.sess.opts.debugging_opts.dump_mir_exclude_pass_number {
95 None => format!(".-------"),
96 Some((suite, pass_num)) => format!(".{:03}-{:03}", suite.0, pass_num.0),
100 let mut file_path = PathBuf::new();
101 if let Some(ref file_dir) = tcx.sess.opts.debugging_opts.dump_mir_dir {
102 let p = Path::new(file_dir);
105 let file_name = format!("rustc.node{}{}{}.{}.{}.mir",
106 source.item_id(), promotion_id, pass_num, pass_name, disambiguator);
107 file_path.push(&file_name);
108 let _ = fs::File::create(&file_path).and_then(|mut file| {
109 writeln!(file, "// MIR for `{}`", node_path)?;
110 writeln!(file, "// source = {:?}", source)?;
111 writeln!(file, "// pass_name = {}", pass_name)?;
112 writeln!(file, "// disambiguator = {}", disambiguator)?;
114 write_mir_fn(tcx, source, mir, &mut file)?;
119 /// Write out a human-readable textual representation for the given MIR.
120 pub fn write_mir_pretty<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
121 single: Option<DefId>,
125 writeln!(w, "// WARNING: This output format is intended for human consumers only")?;
126 writeln!(w, "// and is subject to change without notice. Knock yourself out.")?;
128 let mut first = true;
129 for def_id in dump_mir_def_ids(tcx, single) {
130 let mir = &tcx.optimized_mir(def_id);
135 // Put empty lines between all items
139 let id = tcx.hir.as_local_node_id(def_id).unwrap();
140 let src = MirSource::from_node(tcx, id);
141 write_mir_fn(tcx, src, mir, w)?;
143 for (i, mir) in mir.promoted.iter_enumerated() {
145 write_mir_fn(tcx, MirSource::Promoted(id, i), mir, w)?;
151 pub fn write_mir_fn<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
156 write_mir_intro(tcx, src, mir, w)?;
157 for block in mir.basic_blocks().indices() {
158 write_basic_block(tcx, block, mir, w)?;
159 if block.index() + 1 != mir.basic_blocks().len() {
168 /// Write out a human-readable textual representation for the given basic block.
169 fn write_basic_block(tcx: TyCtxt,
174 let data = &mir[block];
176 // Basic block label at the top.
177 writeln!(w, "{}{:?}: {{", INDENT, block)?;
179 // List of statements in the middle.
180 let mut current_location = Location { block: block, statement_index: 0 };
181 for statement in &data.statements {
182 let indented_mir = format!("{0}{0}{1:?};", INDENT, statement);
183 writeln!(w, "{0:1$} // {2}",
186 comment(tcx, statement.source_info))?;
188 current_location.statement_index += 1;
191 // Terminator at the bottom.
192 let indented_terminator = format!("{0}{0}{1:?};", INDENT, data.terminator().kind);
193 writeln!(w, "{0:1$} // {2}",
196 comment(tcx, data.terminator().source_info))?;
198 writeln!(w, "{}}}", INDENT)
201 fn comment(tcx: TyCtxt, SourceInfo { span, scope }: SourceInfo) -> String {
202 format!("scope {} at {}", scope.index(), tcx.sess.codemap().span_to_string(span))
205 /// Prints user-defined variables in a scope tree.
207 /// Returns the total number of variables printed.
208 fn write_scope_tree(tcx: TyCtxt,
210 scope_tree: &FxHashMap<VisibilityScope, Vec<VisibilityScope>>,
212 parent: VisibilityScope,
215 let indent = depth * INDENT.len();
217 let children = match scope_tree.get(&parent) {
218 Some(childs) => childs,
219 None => return Ok(()),
222 for &child in children {
223 let data = &mir.visibility_scopes[child];
224 assert_eq!(data.parent_scope, Some(parent));
225 writeln!(w, "{0:1$}scope {2} {{", "", indent, child.index())?;
227 // User variable types (including the user's name in a comment).
228 for local in mir.vars_iter() {
229 let var = &mir.local_decls[local];
230 let (name, source_info) = if var.source_info.scope == child {
231 (var.name.unwrap(), var.source_info)
233 // Not a variable or not declared in this scope.
237 let mut_str = if var.mutability == Mutability::Mut {
243 let indent = indent + INDENT.len();
244 let indented_var = format!("{0:1$}let {2}{3:?}: {4};",
250 writeln!(w, "{0:1$} // \"{2}\" in {3}",
254 comment(tcx, source_info))?;
257 write_scope_tree(tcx, mir, scope_tree, w, child, depth + 1)?;
259 writeln!(w, "{0:1$}}}", "", depth * INDENT.len())?;
265 /// Write out a human-readable textual representation of the MIR's `fn` type and the types of its
266 /// local variables (both user-defined bindings and compiler temporaries).
267 fn write_mir_intro<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
272 write_mir_sig(tcx, src, mir, w)?;
275 // construct a scope tree and write it out
276 let mut scope_tree: FxHashMap<VisibilityScope, Vec<VisibilityScope>> = FxHashMap();
277 for (index, scope_data) in mir.visibility_scopes.iter().enumerate() {
278 if let Some(parent) = scope_data.parent_scope {
279 scope_tree.entry(parent)
281 .push(VisibilityScope::new(index));
283 // Only the argument scope has no parent, because it's the root.
284 assert_eq!(index, ARGUMENT_VISIBILITY_SCOPE.index());
288 // Print return pointer
289 let indented_retptr = format!("{}let mut {:?}: {};",
293 writeln!(w, "{0:1$} // return pointer",
297 write_scope_tree(tcx, mir, &scope_tree, w, ARGUMENT_VISIBILITY_SCOPE, 1)?;
299 write_temp_decls(mir, w)?;
301 // Add an empty line before the first block is printed.
307 fn write_mir_sig(tcx: TyCtxt, src: MirSource, mir: &Mir, w: &mut Write)
311 MirSource::Fn(_) => write!(w, "fn")?,
312 MirSource::Const(_) => write!(w, "const")?,
313 MirSource::Static(_, hir::MutImmutable) => write!(w, "static")?,
314 MirSource::Static(_, hir::MutMutable) => write!(w, "static mut")?,
315 MirSource::Promoted(_, i) => write!(w, "{:?} in", i)?
318 write!(w, " {}", tcx.node_path_str(src.item_id()))?;
320 if let MirSource::Fn(_) = src {
323 // fn argument types.
324 for (i, arg) in mir.args_iter().enumerate() {
328 write!(w, "{:?}: {}", Lvalue::Local(arg), mir.local_decls[arg].ty)?;
331 write!(w, ") -> {}", mir.return_ty)
333 assert_eq!(mir.arg_count, 0);
334 write!(w, ": {} =", mir.return_ty)
338 fn write_temp_decls(mir: &Mir, w: &mut Write) -> io::Result<()> {
339 // Compiler-introduced temporary types.
340 for temp in mir.temps_iter() {
341 writeln!(w, "{}let mut {:?}: {};", INDENT, temp, mir.local_decls[temp].ty)?;
347 pub fn dump_mir_def_ids(tcx: TyCtxt, single: Option<DefId>) -> Vec<DefId> {
348 if let Some(i) = single {
351 tcx.mir_keys(LOCAL_CRATE).iter().cloned().collect()