1 use std::collections::BTreeSet;
3 use std::fmt::Write as _;
5 use std::io::{self, Write};
6 use std::path::{Path, PathBuf};
8 use super::graphviz::write_mir_fn_graphviz;
9 use super::spanview::write_mir_fn_spanview;
11 use rustc_data_structures::fx::FxHashMap;
12 use rustc_hir::def_id::DefId;
13 use rustc_index::vec::Idx;
14 use rustc_middle::mir::interpret::{
15 alloc_range, read_target_uint, AllocId, Allocation, ConstAllocation, ConstValue, GlobalAlloc,
18 use rustc_middle::mir::visit::Visitor;
19 use rustc_middle::mir::MirSource;
20 use rustc_middle::mir::*;
21 use rustc_middle::ty::{self, TyCtxt};
22 use rustc_target::abi::Size;
24 const INDENT: &str = " ";
25 /// Alignment for lining up comments following MIR statements
26 pub(crate) const ALIGN: usize = 40;
28 /// An indication of where we are in the control flow graph. Used for printing
29 /// extra information in `dump_mir`
31 /// We have not started dumping the control flow graph, but we are about to.
34 /// We just finished dumping the control flow graph. This is right before EOF
37 /// We are about to start dumping the given basic block.
38 BeforeBlock(BasicBlock),
40 /// We are just about to dump the given statement or terminator.
41 BeforeLocation(Location),
43 /// We just dumped the given statement or terminator.
44 AfterLocation(Location),
46 /// We just dumped the terminator for a block but not the closing `}`.
47 AfterTerminator(BasicBlock),
50 /// If the session is properly configured, dumps a human-readable
51 /// representation of the mir into:
54 /// rustc.node<node_id>.<pass_num>.<pass_name>.<disambiguator>
57 /// Output from this function is controlled by passing `-Z dump-mir=<filter>`,
58 /// where `<filter>` takes the following forms:
60 /// - `all` -- dump MIR for all fns, all passes, all everything
61 /// - a filter defined by a set of substrings combined with `&` and `|`
62 /// (`&` has higher precedence). At least one of the `|`-separated groups
63 /// must match; an `|`-separated group matches if all of its `&`-separated
64 /// substrings are matched.
68 /// - `nll` == match if `nll` appears in the name
69 /// - `foo & nll` == match if `foo` and `nll` both appear in the name
70 /// - `foo & nll | typeck` == match if `foo` and `nll` both appear in the name
71 /// or `typeck` appears in the name.
72 /// - `foo & nll | bar & typeck` == match if `foo` and `nll` both appear in the name
73 /// or `typeck` and `bar` both appear in the name.
75 pub fn dump_mir<'tcx, F>(
77 pass_num: Option<&dyn Display>,
79 disambiguator: &dyn Display,
83 F: FnMut(PassWhere, &mut dyn Write) -> io::Result<()>,
85 if !dump_enabled(tcx, pass_name, body.source.def_id()) {
89 dump_matched_mir_node(tcx, pass_num, pass_name, disambiguator, body, extra_data);
92 pub fn dump_enabled<'tcx>(tcx: TyCtxt<'tcx>, pass_name: &str, def_id: DefId) -> bool {
93 let Some(ref filters) = tcx.sess.opts.unstable_opts.dump_mir else {
96 // see notes on #41697 below
97 let node_path = ty::print::with_forced_impl_filename_line!(tcx.def_path_str(def_id));
98 filters.split('|').any(|or_filter| {
99 or_filter.split('&').all(|and_filter| {
100 let and_filter_trimmed = and_filter.trim();
101 and_filter_trimmed == "all"
102 || pass_name.contains(and_filter_trimmed)
103 || node_path.contains(and_filter_trimmed)
108 // #41697 -- we use `with_forced_impl_filename_line()` because
109 // `def_path_str()` would otherwise trigger `type_of`, and this can
110 // run while we are already attempting to evaluate `type_of`.
112 fn dump_matched_mir_node<'tcx, F>(
114 pass_num: Option<&dyn Display>,
116 disambiguator: &dyn Display,
120 F: FnMut(PassWhere, &mut dyn Write) -> io::Result<()>,
122 let _: io::Result<()> = try {
124 create_dump_file(tcx, "mir", pass_num, pass_name, disambiguator, body.source)?;
125 // see notes on #41697 above
127 ty::print::with_forced_impl_filename_line!(tcx.def_path_str(body.source.def_id()));
128 write!(file, "// MIR for `{}", def_path)?;
129 match body.source.promoted {
130 None => write!(file, "`")?,
131 Some(promoted) => write!(file, "::{:?}`", promoted)?,
133 writeln!(file, " {} {}", disambiguator, pass_name)?;
134 if let Some(ref layout) = body.generator_layout() {
135 writeln!(file, "/* generator_layout = {:#?} */", layout)?;
138 extra_data(PassWhere::BeforeCFG, &mut file)?;
139 write_user_type_annotations(tcx, body, &mut file)?;
140 write_mir_fn(tcx, body, &mut extra_data, &mut file)?;
141 extra_data(PassWhere::AfterCFG, &mut file)?;
144 if tcx.sess.opts.unstable_opts.dump_mir_graphviz {
145 let _: io::Result<()> = try {
147 create_dump_file(tcx, "dot", pass_num, pass_name, disambiguator, body.source)?;
148 write_mir_fn_graphviz(tcx, body, false, &mut file)?;
152 if let Some(spanview) = tcx.sess.opts.unstable_opts.dump_mir_spanview {
153 let _: io::Result<()> = try {
155 dump_file_basename(tcx, pass_num, pass_name, disambiguator, body.source);
156 let mut file = create_dump_file_with_basename(tcx, &file_basename, "html")?;
157 if body.source.def_id().is_local() {
158 write_mir_fn_spanview(tcx, body, spanview, &file_basename, &mut file)?;
164 /// Returns the file basename portion (without extension) of a filename path
165 /// where we should dump a MIR representation output files.
166 fn dump_file_basename<'tcx>(
168 pass_num: Option<&dyn Display>,
170 disambiguator: &dyn Display,
171 source: MirSource<'tcx>,
173 let promotion_id = match source.promoted {
174 Some(id) => format!("-{:?}", id),
175 None => String::new(),
178 let pass_num = if tcx.sess.opts.unstable_opts.dump_mir_exclude_pass_number {
182 None => ".-------".to_string(),
183 Some(pass_num) => format!(".{}", pass_num),
187 let crate_name = tcx.crate_name(source.def_id().krate);
188 let item_name = tcx.def_path(source.def_id()).to_filename_friendly_no_crate();
189 // All drop shims have the same DefId, so we have to add the type
190 // to get unique file names.
191 let shim_disambiguator = match source.instance {
192 ty::InstanceDef::DropGlue(_, Some(ty)) => {
193 // Unfortunately, pretty-printed typed are not very filename-friendly.
194 // We dome some filtering.
195 let mut s = ".".to_owned();
196 s.extend(ty.to_string().chars().filter_map(|c| match c {
198 ':' | '<' | '>' => Some('_'),
208 crate_name, item_name, shim_disambiguator, promotion_id, pass_num, pass_name, disambiguator,
212 /// Returns the path to the filename where we should dump a given MIR.
213 /// Also used by other bits of code (e.g., NLL inference) that dump
214 /// graphviz data or other things.
215 fn dump_path(tcx: TyCtxt<'_>, basename: &str, extension: &str) -> PathBuf {
216 let mut file_path = PathBuf::new();
217 file_path.push(Path::new(&tcx.sess.opts.unstable_opts.dump_mir_dir));
219 let file_name = format!("{}.{}", basename, extension,);
221 file_path.push(&file_name);
226 /// Attempts to open the MIR dump file with the given name and extension.
227 fn create_dump_file_with_basename(
231 ) -> io::Result<io::BufWriter<fs::File>> {
232 let file_path = dump_path(tcx, file_basename, extension);
233 if let Some(parent) = file_path.parent() {
234 fs::create_dir_all(parent).map_err(|e| {
237 format!("IO error creating MIR dump directory: {:?}; {}", parent, e),
241 Ok(io::BufWriter::new(fs::File::create(&file_path).map_err(|e| {
242 io::Error::new(e.kind(), format!("IO error creating MIR dump file: {:?}; {}", file_path, e))
246 /// Attempts to open a file where we should dump a given MIR or other
247 /// bit of MIR-related data. Used by `mir-dump`, but also by other
248 /// bits of code (e.g., NLL inference) that dump graphviz data or
249 /// other things, and hence takes the extension as an argument.
250 pub fn create_dump_file<'tcx>(
253 pass_num: Option<&dyn Display>,
255 disambiguator: &dyn Display,
256 source: MirSource<'tcx>,
257 ) -> io::Result<io::BufWriter<fs::File>> {
258 create_dump_file_with_basename(
260 &dump_file_basename(tcx, pass_num, pass_name, disambiguator, source),
265 /// Write out a human-readable textual representation for the given MIR.
266 pub fn write_mir_pretty<'tcx>(
268 single: Option<DefId>,
270 ) -> io::Result<()> {
271 writeln!(w, "// WARNING: This output format is intended for human consumers only")?;
272 writeln!(w, "// and is subject to change without notice. Knock yourself out.")?;
274 let mut first = true;
275 for def_id in dump_mir_def_ids(tcx, single) {
279 // Put empty lines between all items
283 let render_body = |w: &mut dyn Write, body| -> io::Result<()> {
284 write_mir_fn(tcx, body, &mut |_, _| Ok(()), w)?;
286 for body in tcx.promoted_mir(def_id) {
288 write_mir_fn(tcx, body, &mut |_, _| Ok(()), w)?;
293 // For `const fn` we want to render both the optimized MIR and the MIR for ctfe.
294 if tcx.is_const_fn_raw(def_id) {
295 render_body(w, tcx.optimized_mir(def_id))?;
297 writeln!(w, "// MIR FOR CTFE")?;
298 // Do not use `render_body`, as that would render the promoteds again, but these
299 // are shared between mir_for_ctfe and optimized_mir
300 write_mir_fn(tcx, tcx.mir_for_ctfe(def_id), &mut |_, _| Ok(()), w)?;
303 tcx.instance_mir(ty::InstanceDef::Item(ty::WithOptConstParam::unknown(def_id)));
304 render_body(w, instance_mir)?;
310 /// Write out a human-readable textual representation for the given function.
311 pub fn write_mir_fn<'tcx, F>(
318 F: FnMut(PassWhere, &mut dyn Write) -> io::Result<()>,
320 write_mir_intro(tcx, body, w)?;
321 for block in body.basic_blocks.indices() {
322 extra_data(PassWhere::BeforeBlock(block), w)?;
323 write_basic_block(tcx, block, body, extra_data, w)?;
324 if block.index() + 1 != body.basic_blocks.len() {
331 write_allocations(tcx, body, w)?;
336 /// Write out a human-readable textual representation for the given basic block.
337 pub fn write_basic_block<'tcx, F>(
345 F: FnMut(PassWhere, &mut dyn Write) -> io::Result<()>,
347 let data = &body[block];
349 // Basic block label at the top.
350 let cleanup_text = if data.is_cleanup { " (cleanup)" } else { "" };
351 writeln!(w, "{}{:?}{}: {{", INDENT, block, cleanup_text)?;
353 // List of statements in the middle.
354 let mut current_location = Location { block, statement_index: 0 };
355 for statement in &data.statements {
356 extra_data(PassWhere::BeforeLocation(current_location), w)?;
357 let indented_body = format!("{0}{0}{1:?};", INDENT, statement);
362 if tcx.sess.verbose() { format!("{:?}: ", current_location) } else { String::new() },
363 comment(tcx, statement.source_info, body.span),
367 write_extra(tcx, w, |visitor| {
368 visitor.visit_statement(statement, current_location);
371 extra_data(PassWhere::AfterLocation(current_location), w)?;
373 current_location.statement_index += 1;
376 // Terminator at the bottom.
377 extra_data(PassWhere::BeforeLocation(current_location), w)?;
378 let indented_terminator = format!("{0}{0}{1:?};", INDENT, data.terminator().kind);
383 if tcx.sess.verbose() { format!("{:?}: ", current_location) } else { String::new() },
384 comment(tcx, data.terminator().source_info, body.span),
388 write_extra(tcx, w, |visitor| {
389 visitor.visit_terminator(data.terminator(), current_location);
392 extra_data(PassWhere::AfterLocation(current_location), w)?;
393 extra_data(PassWhere::AfterTerminator(block), w)?;
395 writeln!(w, "{}}}", INDENT)
398 /// After we print the main statement, we sometimes dump extra
399 /// information. There's often a lot of little things "nuzzled up" in
401 fn write_extra<'tcx, F>(tcx: TyCtxt<'tcx>, write: &mut dyn Write, mut visit_op: F) -> io::Result<()>
403 F: FnMut(&mut ExtraComments<'tcx>),
405 let mut extra_comments = ExtraComments { tcx, comments: vec![] };
406 visit_op(&mut extra_comments);
407 for comment in extra_comments.comments {
408 writeln!(write, "{:A$} // {}", "", comment, A = ALIGN)?;
413 struct ExtraComments<'tcx> {
415 comments: Vec<String>,
418 impl<'tcx> ExtraComments<'tcx> {
419 fn push(&mut self, lines: &str) {
420 for line in lines.split('\n') {
421 self.comments.push(line.to_string());
426 fn use_verbose<'tcx>(ty: Ty<'tcx>, fn_def: bool) -> bool {
428 ty::Int(_) | ty::Uint(_) | ty::Bool | ty::Char | ty::Float(_) => false,
430 ty::Tuple(g_args) if g_args.is_empty() => false,
431 ty::Tuple(g_args) => g_args.iter().any(|g_arg| use_verbose(g_arg, fn_def)),
432 ty::Array(ty, _) => use_verbose(ty, fn_def),
433 ty::FnDef(..) => fn_def,
438 impl<'tcx> Visitor<'tcx> for ExtraComments<'tcx> {
439 fn visit_constant(&mut self, constant: &Constant<'tcx>, _location: Location) {
440 let Constant { span, user_ty, literal } = constant;
441 if use_verbose(literal.ty(), true) {
442 self.push("mir::Constant");
445 self.tcx.sess.source_map().span_to_embeddable_string(*span)
447 if let Some(user_ty) = user_ty {
448 self.push(&format!("+ user_ty: {:?}", user_ty));
451 // FIXME: this is a poor version of `pretty_print_const_value`.
452 let fmt_val = |val: &ConstValue<'tcx>| match val {
453 ConstValue::ZeroSized => format!("<ZST>"),
454 ConstValue::Scalar(s) => format!("Scalar({:?})", s),
455 ConstValue::Slice { .. } => format!("Slice(..)"),
456 ConstValue::ByRef { .. } => format!("ByRef(..)"),
459 let fmt_valtree = |valtree: &ty::ValTree<'tcx>| match valtree {
460 ty::ValTree::Leaf(leaf) => format!("ValTree::Leaf({:?})", leaf),
461 ty::ValTree::Branch(_) => format!("ValTree::Branch(..)"),
464 let val = match literal {
465 ConstantKind::Ty(ct) => match ct.kind() {
466 ty::ConstKind::Param(p) => format!("Param({})", p),
467 ty::ConstKind::Unevaluated(uv) => {
469 "Unevaluated({}, {:?})",
470 self.tcx.def_path_str(uv.def.did),
474 ty::ConstKind::Value(val) => format!("Value({})", fmt_valtree(&val)),
475 ty::ConstKind::Error(_) => "Error".to_string(),
476 // These variants shouldn't exist in the MIR.
477 ty::ConstKind::Placeholder(_)
478 | ty::ConstKind::Infer(_)
479 | ty::ConstKind::Bound(..) => bug!("unexpected MIR constant: {:?}", literal),
481 ConstantKind::Unevaluated(uv, _) => {
483 "Unevaluated({}, {:?}, {:?})",
484 self.tcx.def_path_str(uv.def.did),
489 // To keep the diffs small, we render this like we render `ty::Const::Value`.
491 // This changes once `ty::Const::Value` is represented using valtrees.
492 ConstantKind::Val(val, _) => format!("Value({})", fmt_val(&val)),
495 // This reflects what `Const` looked liked before `val` was renamed
496 // as `kind`. We print it like this to avoid having to update
497 // expected output in a lot of tests.
498 self.push(&format!("+ literal: Const {{ ty: {}, val: {} }}", literal.ty(), val));
502 fn visit_rvalue(&mut self, rvalue: &Rvalue<'tcx>, location: Location) {
503 self.super_rvalue(rvalue, location);
504 if let Rvalue::Aggregate(kind, _) = rvalue {
506 AggregateKind::Closure(def_id, substs) => {
507 self.push("closure");
508 self.push(&format!("+ def_id: {:?}", def_id));
509 self.push(&format!("+ substs: {:#?}", substs));
512 AggregateKind::Generator(def_id, substs, movability) => {
513 self.push("generator");
514 self.push(&format!("+ def_id: {:?}", def_id));
515 self.push(&format!("+ substs: {:#?}", substs));
516 self.push(&format!("+ movability: {:?}", movability));
519 AggregateKind::Adt(_, _, _, Some(user_ty), _) => {
521 self.push(&format!("+ user_ty: {:?}", user_ty));
530 fn comment(tcx: TyCtxt<'_>, SourceInfo { span, scope }: SourceInfo, function_span: Span) -> String {
531 let location = if tcx.sess.opts.unstable_opts.mir_pretty_relative_line_numbers {
532 tcx.sess.source_map().span_to_relative_line_string(span, function_span)
534 tcx.sess.source_map().span_to_embeddable_string(span)
537 format!("scope {} at {}", scope.index(), location,)
540 /// Prints local variables in a scope tree.
544 scope_tree: &FxHashMap<SourceScope, Vec<SourceScope>>,
548 ) -> io::Result<()> {
549 let indent = depth * INDENT.len();
551 // Local variable debuginfo.
552 for var_debug_info in &body.var_debug_info {
553 if var_debug_info.source_info.scope != parent {
554 // Not declared in this scope.
558 let indented_debug_info = format!(
559 "{0:1$}debug {2} => {3:?};",
560 INDENT, indent, var_debug_info.name, var_debug_info.value,
568 comment(tcx, var_debug_info.source_info, body.span),
572 // Local variable types.
573 for (local, local_decl) in body.local_decls.iter_enumerated() {
574 if (1..body.arg_count + 1).contains(&local.index()) {
575 // Skip over argument locals, they're printed in the signature.
579 if local_decl.source_info.scope != parent {
580 // Not declared in this scope.
584 let mut_str = if local_decl.mutability == Mutability::Mut { "mut " } else { "" };
586 let mut indented_decl =
587 format!("{0:1$}let {2}{3:?}: {4:?}", INDENT, indent, mut_str, local, local_decl.ty);
588 if let Some(user_ty) = &local_decl.user_ty {
589 for user_ty in user_ty.projections() {
590 write!(indented_decl, " as {:?}", user_ty).unwrap();
593 indented_decl.push(';');
595 let local_name = if local == RETURN_PLACE { " return place" } else { "" };
599 "{0:1$} //{2} in {3}",
603 comment(tcx, local_decl.source_info, body.span),
607 let Some(children) = scope_tree.get(&parent) else {
611 for &child in children {
612 let child_data = &body.source_scopes[child];
613 assert_eq!(child_data.parent_scope, Some(parent));
615 let (special, span) = if let Some((callee, callsite_span)) = child_data.inlined {
619 if callee.def.requires_caller_location(tcx) { "#[track_caller] " } else { "" },
625 (String::new(), None)
628 let indented_header = format!("{0:1$}scope {2}{3} {{", "", indent, child.index(), special);
630 if let Some(span) = span {
636 tcx.sess.source_map().span_to_embeddable_string(span),
639 writeln!(w, "{}", indented_header)?;
642 write_scope_tree(tcx, body, scope_tree, w, child, depth + 1)?;
643 writeln!(w, "{0:1$}}}", "", depth * INDENT.len())?;
649 /// Write out a human-readable textual representation of the MIR's `fn` type and the types of its
650 /// local variables (both user-defined bindings and compiler temporaries).
651 pub fn write_mir_intro<'tcx>(
655 ) -> io::Result<()> {
656 write_mir_sig(tcx, body, w)?;
659 // construct a scope tree and write it out
660 let mut scope_tree: FxHashMap<SourceScope, Vec<SourceScope>> = Default::default();
661 for (index, scope_data) in body.source_scopes.iter().enumerate() {
662 if let Some(parent) = scope_data.parent_scope {
663 scope_tree.entry(parent).or_default().push(SourceScope::new(index));
665 // Only the argument scope has no parent, because it's the root.
666 assert_eq!(index, OUTERMOST_SOURCE_SCOPE.index());
670 write_scope_tree(tcx, body, &scope_tree, w, OUTERMOST_SOURCE_SCOPE, 1)?;
672 // Add an empty line before the first block is printed.
678 /// Find all `AllocId`s mentioned (recursively) in the MIR body and print their corresponding
680 pub fn write_allocations<'tcx>(
684 ) -> io::Result<()> {
685 fn alloc_ids_from_alloc(
686 alloc: ConstAllocation<'_>,
687 ) -> impl DoubleEndedIterator<Item = AllocId> + '_ {
688 alloc.inner().provenance().ptrs().values().map(|id| *id)
691 fn alloc_ids_from_const_val(val: ConstValue<'_>) -> impl Iterator<Item = AllocId> + '_ {
693 ConstValue::Scalar(interpret::Scalar::Ptr(ptr, _)) => {
694 Either::Left(Either::Left(std::iter::once(ptr.provenance)))
696 ConstValue::Scalar(interpret::Scalar::Int { .. }) => {
697 Either::Left(Either::Right(std::iter::empty()))
699 ConstValue::ZeroSized => Either::Left(Either::Right(std::iter::empty())),
700 ConstValue::ByRef { alloc, .. } | ConstValue::Slice { data: alloc, .. } => {
701 Either::Right(alloc_ids_from_alloc(alloc))
705 struct CollectAllocIds(BTreeSet<AllocId>);
707 impl<'tcx> Visitor<'tcx> for CollectAllocIds {
708 fn visit_constant(&mut self, c: &Constant<'tcx>, _: Location) {
710 ConstantKind::Ty(_) | ConstantKind::Unevaluated(..) => {}
711 ConstantKind::Val(val, _) => {
712 self.0.extend(alloc_ids_from_const_val(val));
718 let mut visitor = CollectAllocIds(Default::default());
719 visitor.visit_body(body);
721 // `seen` contains all seen allocations, including the ones we have *not* printed yet.
722 // The protocol is to first `insert` into `seen`, and only if that returns `true`
723 // then push to `todo`.
724 let mut seen = visitor.0;
725 let mut todo: Vec<_> = seen.iter().copied().collect();
726 while let Some(id) = todo.pop() {
727 let mut write_allocation_track_relocs =
728 |w: &mut dyn Write, alloc: ConstAllocation<'tcx>| -> io::Result<()> {
729 // `.rev()` because we are popping them from the back of the `todo` vector.
730 for id in alloc_ids_from_alloc(alloc).rev() {
735 write!(w, "{}", display_allocation(tcx, alloc.inner()))
737 write!(w, "\n{id:?}")?;
738 match tcx.try_get_global_alloc(id) {
739 // This can't really happen unless there are bugs, but it doesn't cost us anything to
740 // gracefully handle it and allow buggy rustc to be debugged via allocation printing.
741 None => write!(w, " (deallocated)")?,
742 Some(GlobalAlloc::Function(inst)) => write!(w, " (fn: {inst})")?,
743 Some(GlobalAlloc::VTable(ty, Some(trait_ref))) => {
744 write!(w, " (vtable: impl {trait_ref} for {ty})")?
746 Some(GlobalAlloc::VTable(ty, None)) => {
747 write!(w, " (vtable: impl <auto trait> for {ty})")?
749 Some(GlobalAlloc::Static(did)) if !tcx.is_foreign_item(did) => {
750 match tcx.eval_static_initializer(did) {
752 write!(w, " (static: {}, ", tcx.def_path_str(did))?;
753 write_allocation_track_relocs(w, alloc)?;
757 " (static: {}, error during initializer evaluation)",
758 tcx.def_path_str(did)
762 Some(GlobalAlloc::Static(did)) => {
763 write!(w, " (extern static: {})", tcx.def_path_str(did))?
765 Some(GlobalAlloc::Memory(alloc)) => {
767 write_allocation_track_relocs(w, alloc)?
775 /// Dumps the size and metadata and content of an allocation to the given writer.
776 /// The expectation is that the caller first prints other relevant metadata, so the exact
777 /// format of this function is (*without* leading or trailing newline):
780 /// size: {}, align: {}) {
785 /// The byte format is similar to how hex editors print bytes. Each line starts with the address of
786 /// the start of the line, followed by all bytes in hex format (space separated).
787 /// If the allocation is small enough to fit into a single line, no start address is given.
788 /// After the hex dump, an ascii dump follows, replacing all unprintable characters (control
789 /// characters or characters whose value is larger than 127) with a `.`
790 /// This also prints provenance adequately.
791 pub fn display_allocation<'a, 'tcx, Prov: Provenance, Extra>(
793 alloc: &'a Allocation<Prov, Extra>,
794 ) -> RenderAllocation<'a, 'tcx, Prov, Extra> {
795 RenderAllocation { tcx, alloc }
799 pub struct RenderAllocation<'a, 'tcx, Prov: Provenance, Extra> {
801 alloc: &'a Allocation<Prov, Extra>,
804 impl<'a, 'tcx, Prov: Provenance, Extra> std::fmt::Display
805 for RenderAllocation<'a, 'tcx, Prov, Extra>
807 fn fmt(&self, w: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
808 let RenderAllocation { tcx, alloc } = *self;
809 write!(w, "size: {}, align: {})", alloc.size().bytes(), alloc.align.bytes())?;
810 if alloc.size() == Size::ZERO {
812 return write!(w, " {{}}");
814 // Write allocation bytes.
816 write_allocation_bytes(tcx, alloc, w, " ")?;
822 fn write_allocation_endline(w: &mut dyn std::fmt::Write, ascii: &str) -> std::fmt::Result {
823 for _ in 0..(BYTES_PER_LINE - ascii.chars().count()) {
826 writeln!(w, " │ {}", ascii)
829 /// Number of bytes to print per allocation hex dump line.
830 const BYTES_PER_LINE: usize = 16;
832 /// Prints the line start address and returns the new line start address.
833 fn write_allocation_newline(
834 w: &mut dyn std::fmt::Write,
835 mut line_start: Size,
839 ) -> Result<Size, std::fmt::Error> {
840 write_allocation_endline(w, ascii)?;
841 line_start += Size::from_bytes(BYTES_PER_LINE);
842 write!(w, "{}0x{:02$x} │ ", prefix, line_start.bytes(), pos_width)?;
846 /// The `prefix` argument allows callers to add an arbitrary prefix before each line (even if there
847 /// is only one line). Note that your prefix should contain a trailing space as the lines are
848 /// printed directly after it.
849 fn write_allocation_bytes<'tcx, Prov: Provenance, Extra>(
851 alloc: &Allocation<Prov, Extra>,
852 w: &mut dyn std::fmt::Write,
854 ) -> std::fmt::Result {
855 let num_lines = alloc.size().bytes_usize().saturating_sub(BYTES_PER_LINE);
856 // Number of chars needed to represent all line numbers.
857 let pos_width = hex_number_length(alloc.size().bytes());
860 write!(w, "{}0x{:02$x} │ ", prefix, 0, pos_width)?;
862 write!(w, "{}", prefix)?;
865 let mut i = Size::ZERO;
866 let mut line_start = Size::ZERO;
868 let ptr_size = tcx.data_layout.pointer_size;
870 let mut ascii = String::new();
872 let oversized_ptr = |target: &mut String, width| {
873 if target.len() > width {
874 write!(target, " ({} ptr bytes)", ptr_size.bytes()).unwrap();
878 while i < alloc.size() {
879 // The line start already has a space. While we could remove that space from the line start
880 // printing and unconditionally print a space here, that would cause the single-line case
881 // to have a single space before it, which looks weird.
885 if let Some(prov) = alloc.provenance().get_ptr(i) {
886 // Memory with provenance must be defined
887 assert!(alloc.init_mask().is_range_initialized(alloc_range(i, ptr_size)).is_ok());
888 let j = i.bytes_usize();
890 .inspect_with_uninit_and_ptr_outside_interpreter(j..j + ptr_size.bytes_usize());
891 let offset = read_target_uint(tcx.data_layout.endian, offset).unwrap();
892 let offset = Size::from_bytes(offset);
893 let provenance_width = |bytes| bytes * 3;
894 let ptr = Pointer::new(prov, offset);
895 let mut target = format!("{:?}", ptr);
896 if target.len() > provenance_width(ptr_size.bytes_usize() - 1) {
897 // This is too long, try to save some space.
898 target = format!("{:#?}", ptr);
900 if ((i - line_start) + ptr_size).bytes_usize() > BYTES_PER_LINE {
901 // This branch handles the situation where a provenance starts in the current line
902 // but ends in the next one.
903 let remainder = Size::from_bytes(BYTES_PER_LINE) - (i - line_start);
904 let overflow = ptr_size - remainder;
905 let remainder_width = provenance_width(remainder.bytes_usize()) - 2;
906 let overflow_width = provenance_width(overflow.bytes_usize() - 1) + 1;
907 ascii.push('╾'); // HEAVY LEFT AND LIGHT RIGHT
908 for _ in 1..remainder.bytes() {
909 ascii.push('─'); // LIGHT HORIZONTAL
911 if overflow_width > remainder_width && overflow_width >= target.len() {
912 // The case where the provenance fits into the part in the next line
913 write!(w, "╾{0:─^1$}", "", remainder_width)?;
915 write_allocation_newline(w, line_start, &ascii, pos_width, prefix)?;
917 write!(w, "{0:─^1$}╼", target, overflow_width)?;
919 oversized_ptr(&mut target, remainder_width);
920 write!(w, "╾{0:─^1$}", target, remainder_width)?;
922 write_allocation_newline(w, line_start, &ascii, pos_width, prefix)?;
923 write!(w, "{0:─^1$}╼", "", overflow_width)?;
926 for _ in 0..overflow.bytes() - 1 {
929 ascii.push('╼'); // LIGHT LEFT AND HEAVY RIGHT
933 // This branch handles a provenance that starts and ends in the current line.
934 let provenance_width = provenance_width(ptr_size.bytes_usize() - 1);
935 oversized_ptr(&mut target, provenance_width);
937 write!(w, "╾{0:─^1$}╼", target, provenance_width)?;
938 for _ in 0..ptr_size.bytes() - 2 {
944 } else if let Some(prov) = alloc.provenance().get(i, &tcx) {
945 // Memory with provenance must be defined
947 alloc.init_mask().is_range_initialized(alloc_range(i, Size::from_bytes(1))).is_ok()
949 ascii.push('━'); // HEAVY HORIZONTAL
950 // We have two characters to display this, which is obviously not enough.
951 // Format is similar to "oversized" above.
952 let j = i.bytes_usize();
953 let c = alloc.inspect_with_uninit_and_ptr_outside_interpreter(j..j + 1)[0];
954 write!(w, "╾{:02x}{:#?} (1 ptr byte)╼", c, prov)?;
955 i += Size::from_bytes(1);
958 .is_range_initialized(alloc_range(i, Size::from_bytes(1)))
961 let j = i.bytes_usize();
963 // Checked definedness (and thus range) and provenance. This access also doesn't
964 // influence interpreter execution but is only for debugging.
965 let c = alloc.inspect_with_uninit_and_ptr_outside_interpreter(j..j + 1)[0];
966 write!(w, "{:02x}", c)?;
967 if c.is_ascii_control() || c >= 0x80 {
970 ascii.push(char::from(c));
972 i += Size::from_bytes(1);
976 i += Size::from_bytes(1);
978 // Print a new line header if the next line still has some bytes to print.
979 if i == line_start + Size::from_bytes(BYTES_PER_LINE) && i != alloc.size() {
980 line_start = write_allocation_newline(w, line_start, &ascii, pos_width, prefix)?;
984 write_allocation_endline(w, &ascii)?;
989 fn write_mir_sig(tcx: TyCtxt<'_>, body: &Body<'_>, w: &mut dyn Write) -> io::Result<()> {
990 use rustc_hir::def::DefKind;
992 trace!("write_mir_sig: {:?}", body.source.instance);
993 let def_id = body.source.def_id();
994 let kind = tcx.def_kind(def_id);
995 let is_function = match kind {
996 DefKind::Fn | DefKind::AssocFn | DefKind::Ctor(..) => true,
997 _ => tcx.is_closure(def_id),
999 match (kind, body.source.promoted) {
1000 (_, Some(i)) => write!(w, "{:?} in ", i)?,
1001 (DefKind::Const | DefKind::AssocConst, _) => write!(w, "const ")?,
1002 (DefKind::Static(hir::Mutability::Not), _) => write!(w, "static ")?,
1003 (DefKind::Static(hir::Mutability::Mut), _) => write!(w, "static mut ")?,
1004 (_, _) if is_function => write!(w, "fn ")?,
1005 (DefKind::AnonConst | DefKind::InlineConst, _) => {} // things like anon const, not an item
1006 _ => bug!("Unexpected def kind {:?}", kind),
1009 ty::print::with_forced_impl_filename_line! {
1010 // see notes on #41697 elsewhere
1011 write!(w, "{}", tcx.def_path_str(def_id))?
1014 if body.source.promoted.is_none() && is_function {
1017 // fn argument types.
1018 for (i, arg) in body.args_iter().enumerate() {
1022 write!(w, "{:?}: {}", Place::from(arg), body.local_decls[arg].ty)?;
1025 write!(w, ") -> {}", body.return_ty())?;
1027 assert_eq!(body.arg_count, 0);
1028 write!(w, ": {} =", body.return_ty())?;
1031 if let Some(yield_ty) = body.yield_ty() {
1033 writeln!(w, "yields {}", yield_ty)?;
1037 // Next thing that gets printed is the opening {
1042 fn write_user_type_annotations(
1046 ) -> io::Result<()> {
1047 if !body.user_type_annotations.is_empty() {
1048 writeln!(w, "| User Type Annotations")?;
1050 for (index, annotation) in body.user_type_annotations.iter_enumerated() {
1053 "| {:?}: user_ty: {:?}, span: {}, inferred_ty: {:?}",
1056 tcx.sess.source_map().span_to_embeddable_string(annotation.span),
1057 annotation.inferred_ty,
1060 if !body.user_type_annotations.is_empty() {
1066 pub fn dump_mir_def_ids(tcx: TyCtxt<'_>, single: Option<DefId>) -> Vec<DefId> {
1067 if let Some(i) = single {
1070 tcx.mir_keys(()).iter().map(|def_id| def_id.to_def_id()).collect()
1074 /// Calc converted u64 decimal into hex and return it's length in chars
1076 /// ```ignore (cannot-test-private-function)
1077 /// assert_eq!(1, hex_number_length(0));
1078 /// assert_eq!(1, hex_number_length(1));
1079 /// assert_eq!(2, hex_number_length(16));
1081 fn hex_number_length(x: u64) -> usize {