1 //! This module provides the [CommentWriter] which makes it possible
2 //! to add comments to the written cranelift ir.
10 //! function u0:0(i64, i64, i64) system_v {
11 //! ; symbol _ZN119_$LT$example..IsNotEmpty$u20$as$u20$mini_core..FnOnce$LT$$LP$$RF$$u27$a$u20$$RF$$u27$b$u20$$u5b$u16$u5d$$C$$RP$$GT$$GT$9call_once17he85059d5e6a760a0E
12 //! ; instance Instance { def: Item(DefId(0/0:29 ~ example[8787]::{{impl}}[0]::call_once[0])), substs: [ReErased, ReErased] }
13 //! ; sig ([IsNotEmpty, (&&[u16],)]; c_variadic: false)->(u8, u8)
15 //! ; ssa {_2: NOT_SSA, _4: NOT_SSA, _0: NOT_SSA, _3: (empty), _1: NOT_SSA}
16 //! ; msg loc.idx param pass mode ssa flags ty
17 //! ; ret _0 = v0 ByRef NOT_SSA (u8, u8)
18 //! ; arg _1 = v1 ByRef NOT_SSA IsNotEmpty
19 //! ; arg _2.0 = v2 ByVal(types::I64) NOT_SSA &&[u16]
21 //! ss0 = explicit_slot 0 ; _1: IsNotEmpty size=0 align=1,8
22 //! ss1 = explicit_slot 8 ; _2: (&&[u16],) size=8 align=8,8
23 //! ss2 = explicit_slot 8 ; _4: (&&[u16],) size=8 align=8,8
24 //! sig0 = (i64, i64, i64) system_v
25 //! sig1 = (i64, i64, i64) system_v
26 //! fn0 = colocated u0:6 sig1 ; Instance { def: Item(DefId(0/0:31 ~ example[8787]::{{impl}}[1]::call_mut[0])), substs: [ReErased, ReErased] }
28 //! block0(v0: i64, v1: i64, v2: i64):
29 //! v3 = stack_addr.i64 ss0
30 //! v4 = stack_addr.i64 ss1
32 //! v5 = stack_addr.i64 ss2
42 //! ; _0 = const mini_core::FnMut::call_mut(move _3, move _4)
44 //! call fn0(v0, v3, v7)
58 use cranelift_codegen::{
60 ir::{entities::AnyEntity, function::DisplayFunctionAnnotations},
61 write::{FuncWriter, PlainWriter},
64 use rustc_middle::ty::layout::FnAbiExt;
65 use rustc_session::config::OutputType;
66 use rustc_target::abi::call::FnAbi;
68 use crate::prelude::*;
71 pub(crate) struct CommentWriter {
73 global_comments: Vec<String>,
74 entity_comments: FxHashMap<AnyEntity, String>,
78 pub(crate) fn new<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) -> Self {
79 let enabled = should_write_ir(tcx);
80 let global_comments = if enabled {
82 format!("symbol {}", tcx.symbol_name(instance).name),
83 format!("instance {:?}", instance),
84 format!("abi {:?}", FnAbi::of_instance(&RevealAllLayoutCx(tcx), instance, &[])),
91 CommentWriter { enabled, global_comments, entity_comments: FxHashMap::default() }
96 pub(crate) fn enabled(&self) -> bool {
100 pub(crate) fn add_global_comment<S: Into<String>>(&mut self, comment: S) {
101 debug_assert!(self.enabled);
102 self.global_comments.push(comment.into());
105 pub(crate) fn add_comment<S: Into<String> + AsRef<str>, E: Into<AnyEntity>>(
110 debug_assert!(self.enabled);
112 use std::collections::hash_map::Entry;
113 match self.entity_comments.entry(entity.into()) {
114 Entry::Occupied(mut occ) => {
115 occ.get_mut().push('\n');
116 occ.get_mut().push_str(comment.as_ref());
118 Entry::Vacant(vac) => {
119 vac.insert(comment.into());
125 impl FuncWriter for &'_ CommentWriter {
128 w: &mut dyn fmt::Write,
130 reg_info: Option<&isa::RegInfo>,
131 ) -> Result<bool, fmt::Error> {
132 for comment in &self.global_comments {
133 if !comment.is_empty() {
134 writeln!(w, "; {}", comment)?;
139 if !self.global_comments.is_empty() {
143 self.super_preamble(w, func, reg_info)
146 fn write_entity_definition(
148 w: &mut dyn fmt::Write,
151 value: &dyn fmt::Display,
153 write!(w, " {} = {}", entity, value)?;
155 if let Some(comment) = self.entity_comments.get(&entity) {
156 writeln!(w, " ; {}", comment.replace('\n', "\n; "))
162 fn write_block_header(
164 w: &mut dyn fmt::Write,
166 isa: Option<&dyn isa::TargetIsa>,
170 PlainWriter.write_block_header(w, func, isa, block, indent)
173 fn write_instruction(
175 w: &mut dyn fmt::Write,
177 aliases: &SecondaryMap<Value, Vec<Value>>,
178 isa: Option<&dyn isa::TargetIsa>,
182 PlainWriter.write_instruction(w, func, aliases, isa, inst, indent)?;
183 if let Some(comment) = self.entity_comments.get(&inst.into()) {
184 writeln!(w, "; {}", comment.replace('\n', "\n; "))?;
190 impl FunctionCx<'_, '_, '_> {
191 pub(crate) fn add_global_comment<S: Into<String>>(&mut self, comment: S) {
192 self.clif_comments.add_global_comment(comment);
195 pub(crate) fn add_comment<S: Into<String> + AsRef<str>, E: Into<AnyEntity>>(
200 self.clif_comments.add_comment(entity, comment);
204 pub(crate) fn should_write_ir(tcx: TyCtxt<'_>) -> bool {
205 tcx.sess.opts.output_types.contains_key(&OutputType::LlvmAssembly)
208 pub(crate) fn write_ir_file(
210 name: impl FnOnce() -> String,
211 write: impl FnOnce(&mut dyn Write) -> std::io::Result<()>,
213 if !should_write_ir(tcx) {
217 let clif_output_dir = tcx.output_filenames(()).with_extension("clif");
219 match std::fs::create_dir(&clif_output_dir) {
221 Err(err) if err.kind() == std::io::ErrorKind::AlreadyExists => {}
222 res @ Err(_) => res.unwrap(),
225 let clif_file_name = clif_output_dir.join(name());
227 let res = std::fs::File::create(clif_file_name).and_then(|mut file| write(&mut file));
228 if let Err(err) = res {
229 tcx.sess.warn(&format!("error writing ir file: {}", err));
233 pub(crate) fn write_clif_file<'tcx>(
236 isa: &dyn cranelift_codegen::isa::TargetIsa,
237 instance: Instance<'tcx>,
238 context: &cranelift_codegen::Context,
239 mut clif_comments: &CommentWriter,
243 || format!("{}.{}.clif", tcx.symbol_name(instance).name, postfix),
245 let mut clif = String::new();
246 cranelift_codegen::write::decorate_function(
250 &DisplayFunctionAnnotations { isa: Some(isa), value_ranges: None },
254 writeln!(file, "test compile")?;
255 writeln!(file, "set is_pic")?;
256 writeln!(file, "set enable_simd")?;
257 writeln!(file, "target {} nehalem", crate::target_triple(tcx.sess))?;
259 file.write_all(clif.as_bytes())?;
265 impl fmt::Debug for FunctionCx<'_, '_, '_> {
266 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
267 writeln!(f, "{:?}", self.instance.substs)?;
268 writeln!(f, "{:?}", self.local_map)?;
270 let mut clif = String::new();
271 ::cranelift_codegen::write::decorate_function(
272 &mut &self.clif_comments,
275 &DisplayFunctionAnnotations::default(),
278 writeln!(f, "\n{}", clif)