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_session::config::OutputType;
66 use crate::prelude::*;
69 pub(crate) struct CommentWriter {
70 global_comments: Vec<String>,
71 entity_comments: FxHashMap<AnyEntity, String>,
75 pub(crate) fn new<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) -> Self {
76 let global_comments = if cfg!(debug_assertions) {
78 format!("symbol {}", tcx.symbol_name(instance).name),
79 format!("instance {:?}", instance),
82 tcx.normalize_erasing_late_bound_regions(
83 ParamEnv::reveal_all(),
84 crate::abi::fn_sig_for_fn_abi(tcx, instance)
95 entity_comments: FxHashMap::default(),
100 #[cfg(debug_assertions)]
102 pub(crate) fn add_global_comment<S: Into<String>>(&mut self, comment: S) {
103 self.global_comments.push(comment.into());
106 pub(crate) fn add_comment<S: Into<String> + AsRef<str>, E: Into<AnyEntity>>(
111 use std::collections::hash_map::Entry;
112 match self.entity_comments.entry(entity.into()) {
113 Entry::Occupied(mut occ) => {
114 occ.get_mut().push('\n');
115 occ.get_mut().push_str(comment.as_ref());
117 Entry::Vacant(vac) => {
118 vac.insert(comment.into());
124 impl FuncWriter for &'_ CommentWriter {
127 w: &mut dyn fmt::Write,
129 reg_info: Option<&isa::RegInfo>,
130 ) -> Result<bool, fmt::Error> {
131 for comment in &self.global_comments {
132 if !comment.is_empty() {
133 writeln!(w, "; {}", comment)?;
138 if !self.global_comments.is_empty() {
142 self.super_preamble(w, func, reg_info)
145 fn write_entity_definition(
147 w: &mut dyn fmt::Write,
150 value: &dyn fmt::Display,
152 write!(w, " {} = {}", entity, value)?;
154 if let Some(comment) = self.entity_comments.get(&entity) {
155 writeln!(w, " ; {}", comment.replace('\n', "\n; "))
161 fn write_block_header(
163 w: &mut dyn fmt::Write,
165 isa: Option<&dyn isa::TargetIsa>,
169 PlainWriter.write_block_header(w, func, isa, block, indent)
172 fn write_instruction(
174 w: &mut dyn fmt::Write,
176 aliases: &SecondaryMap<Value, Vec<Value>>,
177 isa: Option<&dyn isa::TargetIsa>,
181 PlainWriter.write_instruction(w, func, aliases, isa, inst, indent)?;
182 if let Some(comment) = self.entity_comments.get(&inst.into()) {
183 writeln!(w, "; {}", comment.replace('\n', "\n; "))?;
189 #[cfg(debug_assertions)]
190 impl<M: Module> FunctionCx<'_, '_, M> {
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 cfg!(debug_assertions)
210 .contains_key(&OutputType::LlvmAssembly)
213 pub(crate) fn write_ir_file<'tcx>(
216 write: impl FnOnce(&mut dyn Write) -> std::io::Result<()>,
218 if !should_write_ir(tcx) {
222 let clif_output_dir = tcx.output_filenames(LOCAL_CRATE).with_extension("clif");
224 match std::fs::create_dir(&clif_output_dir) {
226 Err(err) if err.kind() == std::io::ErrorKind::AlreadyExists => {}
227 res @ Err(_) => res.unwrap(),
230 let clif_file_name = clif_output_dir.join(name);
232 let res: std::io::Result<()> = try {
233 let mut file = std::fs::File::create(clif_file_name)?;
236 if let Err(err) = res {
237 tcx.sess.warn(&format!("error writing ir file: {}", err));
241 pub(crate) fn write_clif_file<'tcx>(
244 isa: Option<&dyn cranelift_codegen::isa::TargetIsa>,
245 instance: Instance<'tcx>,
246 context: &cranelift_codegen::Context,
247 mut clif_comments: &CommentWriter,
251 &format!("{}.{}.clif", tcx.symbol_name(instance).name, postfix),
253 let value_ranges = isa.map(|isa| {
255 .build_value_labels_ranges(isa)
256 .expect("value location ranges")
259 let mut clif = String::new();
260 cranelift_codegen::write::decorate_function(
264 &DisplayFunctionAnnotations {
265 isa: Some(&*crate::build_isa(tcx.sess)),
266 value_ranges: value_ranges.as_ref(),
271 writeln!(file, "test compile")?;
272 writeln!(file, "set is_pic")?;
273 writeln!(file, "set enable_simd")?;
274 writeln!(file, "target {} haswell", crate::target_triple(tcx.sess))?;
276 file.write_all(clif.as_bytes())?;
282 impl<M: Module> fmt::Debug for FunctionCx<'_, '_, M> {
283 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
284 writeln!(f, "{:?}", self.instance.substs)?;
285 writeln!(f, "{:?}", self.local_map)?;
287 let mut clif = String::new();
288 ::cranelift_codegen::write::decorate_function(
289 &mut &self.clif_comments,
292 &DisplayFunctionAnnotations::default(),
295 writeln!(f, "\n{}", clif)