Make clif ir debug output a bit nicer

Author: bjorn3

src/abi/mod.rs

@@ -185,12 +185,11 @@ impl<'tcx> FunctionCx<'_, '_, 'tcx> {
 let sig = Signature{ params, returns,call_conv:self.target_config.default_call_conv};
 let func_id = self.module.declare_function(name,Linkage::Import,&sig).unwrap();
 let func_ref = self.module.declare_func_in_func(func_id,&mutself.bcx.func);
+let call_inst = self.bcx.ins().call(func_ref, args);
 ifself.clif_comments.enabled(){
 self.add_comment(func_ref,format!("{:?}", name));
-let inst = self.bcx.func.layout.last_inst(self.bcx.current_block().unwrap()).unwrap();
-self.add_comment(inst,format!("lib_call {}", name));
+self.add_comment(call_inst,format!("lib_call {}", name));
 }
-let call_inst = self.bcx.ins().call(func_ref, args);
 let results = self.bcx.inst_results(call_inst);
 assert!(results.len() <= 2,"{}", results.len());
  results
@@ -530,7 +529,7 @@ pub(crate) fn codegen_terminator_call<'tcx>(
 Some(Instance{def:InstanceKind::Virtual(_, idx), .. }) => {
 if fx.clif_comments.enabled(){
 let nop_inst = fx.bcx.ins().nop();
- fx.add_comment(
+ fx.add_post_comment(
  nop_inst,
 with_no_trimmed_paths!(format!(
 "virtual call; self arg pass mode: {:?}",
@@ -556,7 +555,7 @@ pub(crate) fn codegen_terminator_call<'tcx>(
 None => {
 if fx.clif_comments.enabled(){
 let nop_inst = fx.bcx.ins().nop();
- fx.add_comment(nop_inst,"indirect call");
+ fx.add_post_comment(nop_inst,"indirect call");
 }
 
 let func = func.load_scalar(fx);
@@ -586,18 +585,17 @@ pub(crate) fn codegen_terminator_call<'tcx>(
 adjust_call_for_c_variadic(fx,&fn_abi, source_info, func_ref,&mut call_args);
 }
 
-if fx.clif_comments.enabled(){
-let nop_inst = fx.bcx.ins().nop();
-with_no_trimmed_paths!(fx.add_comment(nop_inst, format!("abi: {:?}", fn_abi)));
-}
-
 let call_inst = match func_ref {
 CallTarget::Direct(func_ref) => fx.bcx.ins().call(func_ref,&call_args),
 CallTarget::Indirect(sig, func_ptr) => {
  fx.bcx.ins().call_indirect(sig, func_ptr,&call_args)
 }
 };
 
+if fx.clif_comments.enabled(){
+with_no_trimmed_paths!(fx.add_comment(call_inst, format!("abi: {:?}", fn_abi)));
+}
+
  fx.bcx.func.dfg.inst_results(call_inst).iter().copied().collect::<SmallVec<[Value;2]>>()
 });
 

src/base.rs

@@ -315,7 +315,7 @@ fn codegen_fn_body(fx: &mut FunctionCx<'_, '_, '_>, start_block: Block) {
  bb_data.terminator().kind.fmt_head(&mut terminator_head).unwrap();
 });
 let inst = fx.bcx.func.layout.last_inst(block).unwrap();
- fx.add_comment(inst, terminator_head);
+ fx.add_post_comment(inst, terminator_head);
 }
 
 let source_info = bb_data.terminator().source_info;
@@ -570,7 +570,7 @@ fn codegen_stmt<'tcx>(fx: &mut FunctionCx<'_, '_, 'tcx>, cur_block: Block, stmt:
 if fx.clif_comments.enabled(){
 let inst = fx.bcx.func.layout.last_inst(cur_block).unwrap();
 with_no_trimmed_paths!({
- fx.add_comment(inst, format!("{:?}", stmt));
+ fx.add_post_comment(inst, format!("{:?}", stmt));
 });
 }
 }

src/pretty_clif.rs

@@ -8,40 +8,41 @@
 //! target x86_64
 //!
 //! function u0:22(i64) -> i8, i8 system_v {
-//! ; symbol _ZN97_$LT$example..IsNotEmpty$u20$as$u20$mini_core..FnOnce$LT$$LP$$RF$$RF$$u5b$u16$u5d$$C$$RP$$GT$$GT$9call_once17hd517c453d67c0915E
-//! ; instance Instance { def: Item(WithOptConstParam { did: DefId(0:42 ~ example[4e51]::{impl#0}::call_once), const_param_did: None }), args: [ReErased, ReErased] }
-//! ; abi FnAbi { args: [ArgAbi { layout: TyAndLayout { ty: IsNotEmpty, layout: Layout { size: Size(0 bytes), align: AbiAndPrefAlign { abi: Align(1 bytes), pref: Align(8 bytes) }, abi: Aggregate { sized: true }, fields: Arbitrary { offsets: [], memory_index: [] }, largest_niche: None, variants: Single { index: 0 } } }, mode: Ignore }, ArgAbi { layout: TyAndLayout { ty: &&[u16], layout: Layout { size: Size(8 bytes), align: AbiAndPrefAlign { abi: Align(8 bytes), pref: Align(8 bytes) }, abi: Scalar(Initialized { value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), fields: Primitive, largest_niche: Some(Niche { offset: Size(0 bytes), value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), variants: Single { index: 0 } } }, mode: Direct(ArgAttributes { regular: NonNull | NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: Some(Align(8 bytes)) }) }], ret: ArgAbi { layout: TyAndLayout { ty: (u8, u8), layout: Layout { size: Size(2 bytes), align: AbiAndPrefAlign { abi: Align(1 bytes), pref: Align(8 bytes) }, abi: ScalarPair(Initialized { value: Int(I8, false), valid_range: 0..=255 }, Initialized { value: Int(I8, false), valid_range: 0..=255 }), fields: Arbitrary { offsets: [Size(0 bytes), Size(1 bytes)], memory_index: [0, 1] }, largest_niche: None, variants: Single { index: 0 } } }, mode: Pair(ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }, ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }) }, c_variadic: false, fixed_count: 1, conv: Rust, can_unwind: false }
+//! ; symbol _ZN97_$LT$example..IsNotEmpty$u20$as$u20$mini_core..FnOnce$LT$$LP$$RF$$RF$$u5b$u16$u5d$$C$$RP$$GT$$GT$9call_once17hd361e9f5c3d1c4deE
+//! ; instance Instance { def: Item(DefId(0:42 ~ example[3895]::{impl#0}::call_once)), args: ['{erased}, '{erased}] }
+//! ; abi FnAbi { args: [ArgAbi { layout: TyAndLayout { ty: IsNotEmpty, layout: Layout { size: Size(0 bytes), align: AbiAndPrefAlign { abi: Align(1 bytes), pref: Align(8 bytes) }, backend_repr: Memory { sized: true }, fields: Arbitrary { offsets: [], memory_index: [] }, largest_niche: None, uninhabited: false, variants: Single { index: 0 }, max_repr_align: None, unadjusted_abi_align: Align(1 bytes), randomization_seed: 12266848898570219025 } }, mode: Ignore }, ArgAbi { layout: TyAndLayout { ty: &&[u16], layout: Layout { size: Size(8 bytes), align: AbiAndPrefAlign { abi: Align(8 bytes), pref: Align(8 bytes) }, backend_repr: Scalar(Initialized { value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), fields: Primitive, largest_niche: Some(Niche { offset: Size(0 bytes), value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), uninhabited: false, variants: Single { index: 0 }, max_repr_align: None, unadjusted_abi_align: Align(8 bytes), randomization_seed: 281492156579847 } }, mode: Direct(ArgAttributes { regular: NonNull | NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: Some(Align(8 bytes)) }) }], ret: ArgAbi { layout: TyAndLayout { ty: (u8, u8), layout: Layout { size: Size(2 bytes), align: AbiAndPrefAlign { abi: Align(1 bytes), pref: Align(8 bytes) }, backend_repr: ScalarPair(Initialized { value: Int(I8, false), valid_range: 0..=255 }, Initialized { value: Int(I8, false), valid_range: 0..=255 }), fields: Arbitrary { offsets: [Size(0 bytes), Size(1 bytes)], memory_index: [0, 1] }, largest_niche: None, uninhabited: false, variants: Single { index: 0 }, max_repr_align: None, unadjusted_abi_align: Align(1 bytes), randomization_seed: 71776127651151873 } }, mode: Pair(ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }, ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }) }, c_variadic: false, fixed_count: 1, conv: Rust, can_unwind: false }
 //!
 //! ; kind loc.idx param pass mode ty
-//! ; ssa _0 (u8, u8) 2b 1, 8 var=(0, 1)
+//! ; ssa _0 (u8, u8) 2b 1 var=(0, 1)
 //! ; ret _0 - Pair(ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }, ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }) (u8, u8)
 //! ; arg _1 - Ignore IsNotEmpty
-//! ; arg _2.0 = v0 Direct(ArgAttributes { regular: NonNull | NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: Some(Align(8 bytes)) }) &&[u16]
+//! ; arg _2.0 = v0 Direct(ArgAttributes { regular: NonNull | NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: Some(Align(8 bytes)) }) &'{erased} &'{erased} [u16]
 //!
-//! ; kind local ty size align (abi,pref)
-//! ; zst _1 IsNotEmpty 0b 1, 8 align=8,offset=
-//! ; stack _2 (&&[u16],) 8b 8, 8 storage=ss0
-//! ; ssa _3 &mut IsNotEmpty 8b 8, 8 var=2
+//! ; kind local ty size align (abi)
+//! ; zst _1 IsNotEmpty 0b 1align=1,offset=
+//! ; stack _2 (&'{erased} &'{erased} [u16],) 8b 8 storage=ss0
+//! ; ssa _3 &'{erased} mut IsNotEmpty 8b 8 var=2
 //!
-//! ss0 = explicit_slot 16
+//! ss0 = explicit_slot 16, align = 16
 //! sig0 = (i64, i64) -> i8, i8 system_v
-//! fn0 = colocated u0:23 sig0 ; Instance { def: Item(WithOptConstParam { did: DefId(0:46 ~ example[4e51]::{impl#1}::call_mut), const_param_did: None }), args: [ReErased, ReErased] }
+//! fn0 = colocated u0:23 sig0 ; Instance { def: Item(DefId(0:46 ~ example[3895]::{impl#1}::call_mut)), args: ['{erased}, '{erased}] }
 //!
 //! block0(v0: i64):
 //! nop
-//! ; write_cvalue: Addr(Pointer { base: Stack(ss0), offset: Offset32(0) }, None): &&[u16] <- ByVal(v0): &&[u16]
+//! ; write_cvalue: Addr(Pointer { base: Stack(ss0), offset: Offset32(0) }, None): &'{erased} &'{erased} [u16] <- ByVal(v0): &'{erased} &'{erased} [u16]
 //! stack_store v0, ss0
 //! jump block1
 //!
 //! block1:
 //! nop
 //! ; _3 = &mut _1
-//! v1 = iconst.i64 8
-//! ; write_cvalue: Var(_3, var2): &mut IsNotEmpty <- ByVal(v1): &mut IsNotEmpty
+//! v1 = iconst.i64 1
+//! ; write_cvalue: Var(_3, var2): &'{erased} mut IsNotEmpty <- ByVal(v1): &'{erased} mut IsNotEmpty
 //! ;
-//! ; _0 = <IsNotEmpty as mini_core::FnMut<(&&[u16],)>>::call_mut(move _3, _2)
+//! ; _0 = <IsNotEmpty as mini_core::FnMut<(&&[u16],)>>::call_mut(move _3, copy _2)
 //! v2 = stack_load.i64 ss0
-//! v3, v4 = call fn0(v1, v2) ; v1 = 8
+//! ; abi: FnAbi { args: [ArgAbi { layout: TyAndLayout { ty: &mut IsNotEmpty, layout: Layout { size: Size(8 bytes), align: AbiAndPrefAlign { abi: Align(8 bytes), pref: Align(8 bytes) }, backend_repr: Scalar(Initialized { value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), fields: Primitive, largest_niche: Some(Niche { offset: Size(0 bytes), value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), uninhabited: false, variants: Single { index: 0 }, max_repr_align: None, unadjusted_abi_align: Align(8 bytes), randomization_seed: 281492156579847 } }, mode: Direct(ArgAttributes { regular: NonNull | NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: Some(Align(1 bytes)) }) }, ArgAbi { layout: TyAndLayout { ty: &&[u16], layout: Layout { size: Size(8 bytes), align: AbiAndPrefAlign { abi: Align(8 bytes), pref: Align(8 bytes) }, backend_repr: Scalar(Initialized { value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), fields: Primitive, largest_niche: Some(Niche { offset: Size(0 bytes), value: Pointer(AddressSpace(0)), valid_range: 1..=18446744073709551615 }), uninhabited: false, variants: Single { index: 0 }, max_repr_align: None, unadjusted_abi_align: Align(8 bytes), randomization_seed: 281492156579847 } }, mode: Direct(ArgAttributes { regular: NonNull | NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: Some(Align(8 bytes)) }) }], ret: ArgAbi { layout: TyAndLayout { ty: (u8, u8), layout: Layout { size: Size(2 bytes), align: AbiAndPrefAlign { abi: Align(1 bytes), pref: Align(8 bytes) }, backend_repr: ScalarPair(Initialized { value: Int(I8, false), valid_range: 0..=255 }, Initialized { value: Int(I8, false), valid_range: 0..=255 }), fields: Arbitrary { offsets: [Size(0 bytes), Size(1 bytes)], memory_index: [0, 1] }, largest_niche: None, uninhabited: false, variants: Single { index: 0 }, max_repr_align: None, unadjusted_abi_align: Align(1 bytes), randomization_seed: 71776127651151873 } }, mode: Pair(ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }, ArgAttributes { regular: NoUndef, arg_ext: None, pointee_size: Size(0 bytes), pointee_align: None }) }, c_variadic: false, fixed_count: 1, conv: Rust, can_unwind: false }
+//! v3, v4 = call fn0(v1, v2) ; v1 = 1
 //! v5 -> v3
 //! v6 -> v4
 //! ; write_cvalue: VarPair(_0, var0, var1): (u8, u8) <- ByValPair(v3, v4): (u8, u8)
@@ -73,6 +74,7 @@ pub(crate) struct CommentWriter {
 enabled:bool,
 global_comments:Vec<String>,
 entity_comments:FxHashMap<AnyEntity,String>,
+inst_post_comments:FxHashMap<Inst,String>,
 }
 
 implCommentWriter{
@@ -95,7 +97,12 @@ impl CommentWriter {
 vec![]
 };
 
-CommentWriter{ enabled, global_comments,entity_comments:FxHashMap::default()}
+CommentWriter{
+ enabled,
+ global_comments,
+entity_comments:FxHashMap::default(),
+inst_post_comments:FxHashMap::default(),
+}
 }
 }
 
@@ -127,6 +134,25 @@ impl CommentWriter {
 }
 }
 }
+
+pub(crate)fnadd_post_comment<S:Into<String> + AsRef<str>>(
+&mutself,
+entity:Inst,
+comment:S,
+){
+debug_assert!(self.enabled);
+
+use std::collections::hash_map::Entry;
+matchself.inst_post_comments.entry(entity){
+Entry::Occupied(mut occ) => {
+ occ.get_mut().push('\n');
+ occ.get_mut().push_str(comment.as_ref());
+}
+Entry::Vacant(vac) => {
+ vac.insert(comment.into());
+}
+}
+}
 }
 
 implFuncWriterfor&'_CommentWriter{
@@ -188,10 +214,13 @@ impl FuncWriter for &'_ CommentWriter {
 inst:Inst,
 indent:usize,
 ) -> fmt::Result{
-PlainWriter.write_instruction(w, func, aliases, inst, indent)?;
 ifletSome(comment) = self.entity_comments.get(&inst.into()){
 writeln!(w,"; {}", comment.replace('\n',"\n; "))?;
 }
+PlainWriter.write_instruction(w, func, aliases, inst, indent)?;
+ifletSome(comment) = self.inst_post_comments.get(&inst){
+writeln!(w,"; {}", comment.replace('\n',"\n; "))?;
+}
 Ok(())
 }
 }
@@ -208,6 +237,14 @@ impl FunctionCx<'_, '_, '_> {
 ){
 self.clif_comments.add_comment(entity, comment);
 }
+
+pub(crate)fnadd_post_comment<S:Into<String> + AsRef<str>>(
+&mutself,
+entity:Inst,
+comment:S,
+){
+self.clif_comments.add_post_comment(entity, comment);
+}
 }
 
 pub(crate)fnshould_write_ir(tcx:TyCtxt<'_>) -> bool{

src/value_and_place.rs

@@ -593,7 +593,7 @@ impl<'tcx> CPlace<'tcx> {
 
 if fx.clif_comments.enabled(){
 let inst = fx.bcx.func.layout.last_inst(fx.bcx.current_block().unwrap()).unwrap();
- fx.add_comment(
+ fx.add_post_comment(
  inst,
 format!(
 "{}: {:?}: {:?} <- {:?}: {:?}",