Improve stack object printing.

[madhur13490]

Summary

Need such verbosity while debugging large files which has several functions.

[madhur13490]

fix tests

[madhur13490]

@jlpeyton Any idea why the tests you added may be failing? I don't think it has anything related to my changes.

[arsenm]

llvm/lib/CodeGen/MachineFrameInfo.cpp

213

I think this should be removed

243

Don't see how this is an improvement

253

[spill] present or not maybe?

[evandro]

llvm/lib/CodeGen/MachineFrameInfo.cpp

213

I agree. It's redundant.

221

s/NumFixedObjects=/Fixed objects: /

230

s/stackid=/stack id: /

243

Agree.

253

s/isSplitSplot/Spill slot: / then yes or no.

[madhur13490]

rebase + address comments

[arsenm]

llvm/lib/CodeGen/MachineFrameInfo.cpp

221

Single quotes around \n

254

Switching from = to :, and capitalizing is inconsistent with the other fields

[madhur13490]

llvm/lib/CodeGen/MachineFrameInfo.cpp

254

This inconsistency is already present. "Frame objects:" and "size=". What are you suggesting, = or :? And why?

[evandro]

llvm/lib/CodeGen/MachineFrameInfo.cpp

243

s/fixed:/fixed/

254

Split or Spill?

[madhur13490]

llvm/lib/CodeGen/MachineFrameInfo.cpp

243

As I said earlier, there is inconsistency; at some place "=" and other ":". It depends on personal choice but we need to agree on one.

[evandro]

llvm/lib/CodeGen/MachineFrameInfo.cpp

243

Since the word fixed is followed by a comma, it should be followed by neither : nor =, as originally.

llvm/test/CodeGen/AArch64/tailcall_misched_graph.ll

26

E.g., fixed followed by : and , makes no sense.

llvm/include/llvm/CodeGen/MachineFrameInfo.h

public:
   /// but that must be preserved - they are callee saved registers that are not
   /// saved.
   ///
   /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
   /// method always returns an empty set.
   BitVector getPristineRegs(const MachineFunction &MF) const;
 
   /// Used by the MachineFunction printer to print information about
-  /// stack objects. Implemented in MachineFunction.cpp.
+  /// stack objects.
   void print(const MachineFunction &MF, raw_ostream &OS) const;
 
   /// dump - Print the function to stderr.
   void dump(const MachineFunction &MF) const;
 };
 
 } // End llvm namespace
 
 #endif

llvm/lib/CodeGen/MachineFrameInfo.cpp

for (const MachineInstr &MI : MBB) {
         if (ExtraInfo & InlineAsm::Extra_IsAlignStack)
           AdjustsStack = true;
       }
     }
   }
 }
 
 void MachineFrameInfo::print(const MachineFunction &MF, raw_ostream &OS) const{
-  if (Objects.empty()) return;
-
+  OS << "MF name: " << MF.getName() << "\n";
+  if (Objects.empty()) {
+    OS << "No stack objects.\n";
+    return;
+  }
   const TargetFrameLowering *FI = MF.getSubtarget().getFrameLowering();
   int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
 
+  OS << "NumFixedObjects=" << static_cast<unsigned>(NumFixedObjects) << "\n";
+
   OS << "Frame Objects:\n";
 
   for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
     const StackObject &SO = Objects[i];
     OS << "  fi#" << (int)(i-NumFixedObjects) << ": ";
 
     if (SO.StackID != 0)
-      OS << "id=" << static_cast<unsigned>(SO.StackID) << ' ';
+      OS << "stackid=" << static_cast<unsigned>(SO.StackID) << ", ";
 
     if (SO.Size == ~0ULL) {
       OS << "dead\n";
       continue;
     }
     if (SO.Size == 0)
       OS << "variable sized";
     else
       OS << "size=" << SO.Size;
     OS << ", align=" << SO.Alignment.value();
 
     if (i < NumFixedObjects)
-      OS << ", fixed";
+      OS << ", fixed objects:";
     if (i < NumFixedObjects || SO.SPOffset != -1) {
       int64_t Off = SO.SPOffset - ValOffset;
       OS << ", at location [SP";
       if (Off > 0)
         OS << "+" << Off;
       else if (Off < 0)
         OS << Off;
       OS << "]";
     }
+    OS << "isSplitSplot=" << static_cast<bool>(SO.isSpillSlot) << ", ";
     OS << "\n";
   }
 }
 
 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 LLVM_DUMP_METHOD void MachineFrameInfo::dump(const MachineFunction &MF) const {
   print(MF, dbgs());
 }
 #endif

llvm/test/CodeGen/AArch64/max-jump-table.ll

switch i32 %a, label %return [
     i32 12, label %bb12
     i32 13, label %bb13
     i32 14, label %bb14
     i32 15, label %bb15
     i32 16, label %bb16
     i32 17, label %bb17
   ]
 ; CHECK-LABEL: function jt1:
+; CHECK-NEXT: MF name: jt1
+; CHECK-NEXT: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 ; CHECK0-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK0-NOT:   %jump-table.1:
 ; CHECK4-NEXT:  %jump-table.0: %bb.2 %bb.3 %bb.4 %bb.5
 ; CHECK4-NEXT:  %jump-table.1: %bb.6 %bb.7 %bb.8 %bb.9
 ; CHECK4-NEXT:  %jump-table.2: %bb.10 %bb.11 %bb.12 %bb.13
 ; CHECK4-NEXT:  %jump-table.3: %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK4-NOT:   %jump-table.4:
switch i32 %x, label %return [
     i32 2,  label %bb2
     i32 3,  label %bb3
     i32 4,  label %bb4
 
     i32 14, label %bb5
     i32 15, label %bb6
   ]
 ; CHECK-LABEL: function jt2:
+; CHECK-NEXT: MF name: jt2
+; CHECK-NEXT: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 ; CHECK0-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.5 %bb.6{{$}}
 ; CHECK0-NOT:   %jump-table.1:
 ; CHECK4-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4{{$}}
 ; CHECK4-NOT:   %jump-table.1:
 ; CHECK8-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4{{$}}
 ; CHECK8-NOT:   %jump-table.1:
 ; CHECK16-NEXT: %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.7 %bb.5 %bb.6{{$}}
switch i32 %x, label %return [
 
     i32 19, label %bb9
     i32 20, label %bb10
 
     i32 22, label %bb11
     i32 23, label %bb12
   ]
 ; CHECK-LABEL: function jt3:
+; CHECK-NEXT: MF name: jt3
+; CHECK-NEXT: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 ; CHECK0-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.5 %bb.6 %bb.7 %bb.8 %bb.13 %bb.9 %bb.10 %bb.13 %bb.11 %bb.12
 ; CHECK0-NOT:   %jump-table.1:
 ; CHECK4-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4
 ; CHECK4-NEXT:  %jump-table.1: %bb.5 %bb.6 %bb.7 %bb.8
 ; CHECK4-NOT:   %jump-table.2:
 ; CHECK8-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4
 ; CHECK8-NEXT:  %jump-table.1: %bb.5 %bb.6 %bb.7 %bb.8 %bb.13 %bb.9 %bb.10
switch i32 %x, label %default [
 
     i32 19, label %bb9
     i32 20, label %bb10
 
     i32 22, label %bb11
     i32 23, label %bb12
   ]
 ; CHECK-LABEL: function jt4:
+; CHECK-NEXT: MF name: jt4
+; CHECK-NEXT: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 ; CHECK0-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.13 %bb.5 %bb.6 %bb.7 %bb.8 %bb.13 %bb.9 %bb.10 %bb.13 %bb.11 %bb.12
 ; CHECK0-NOT:   %jump-table.1:
 ; CHECK4-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4
 ; CHECK4-NEXT:  %jump-table.1: %bb.5 %bb.6 %bb.7 %bb.8
 ; CHECK4-NOT:   %jump-table.2:
 ; CHECK8-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4
 ; CHECK8-NEXT:  %jump-table.1: %bb.5 %bb.6 %bb.7 %bb.8 %bb.13 %bb.9 %bb.10
switch i32 %a, label %return [
     i32 12, label %bb12
     i32 13, label %bb13
     i32 14, label %bb14
     i32 15, label %bb15
     i32 16, label %bb16
     i32 17, label %bb17
   ]
 ; CHECK-LABEL: function jt1_optsize:
+; CHECK-NEXT: MF name: jt1_optsize
+; CHECK-NEXT: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 ; CHECK0-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK0-NOT:   %jump-table.1:
 ; CHECK4-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK4-NOT:   %jump-table.1:
 ; CHECK8-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK8-NOT:   %jump-table.1:
 ; CHECK16-NEXT: %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
switch i32 %a, label %return [
     i32 12, label %bb12
     i32 13, label %bb13
     i32 14, label %bb14
     i32 15, label %bb15
     i32 16, label %bb16
     i32 17, label %bb17
   ]
 ; CHECK-LABEL: function jt1_pgso:
+; CHECK-NEXT: MF name: jt1_pgso
+; CHECK-NEXT: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 ; CHECK0-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK0-NOT:   %jump-table.1:
 ; CHECK4-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK4-NOT:   %jump-table.1:
 ; CHECK8-NEXT:  %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17
 ; CHECK8-NOT:   %jump-table.1:
 ; CHECK16-NEXT: %jump-table.0: %bb.1 %bb.2 %bb.3 %bb.4 %bb.5 %bb.6 %bb.7 %bb.8 %bb.9 %bb.10 %bb.11 %bb.12 %bb.13 %bb.14 %bb.15 %bb.16 %bb.17

llvm/test/CodeGen/AArch64/min-jump-table.ll

 ; RUN: llc %s -O2 -print-machineinstrs -mtriple=aarch64-linux-gnu -jump-table-density=40 -min-jump-table-entries=0 -o /dev/null 2> %t; FileCheck %s --check-prefixes=CHECK,CHECK0  < %t
 ; RUN: llc %s -O2 -print-machineinstrs -mtriple=aarch64-linux-gnu -jump-table-density=40 -min-jump-table-entries=2 -o /dev/null 2> %t; FileCheck %s --check-prefixes=CHECK,CHECK2  < %t
 ; RUN: llc %s -O2 -print-machineinstrs -mtriple=aarch64-linux-gnu -jump-table-density=40 -min-jump-table-entries=4 -o /dev/null 2> %t; FileCheck %s --check-prefixes=CHECK,CHECK4  < %t
 ; RUN: llc %s -O2 -print-machineinstrs -mtriple=aarch64-linux-gnu -jump-table-density=40 -min-jump-table-entries=8 -o /dev/null 2> %t; FileCheck %s --check-prefixes=CHECK,CHECK8  < %t
 
 declare void @ext(i32, i32)
 
 define i32 @jt2(i32 %a, i32 %b) {
 entry:
   switch i32 %a, label %return [
     i32 1, label %bb1
     i32 3, label %bb2
   ]
 ; CHECK-LABEL: function jt2:
+; CHECK-LABEL: MF name: jt2
+; CHECK-LABEL: No stack objects.
 ; CHECK0-NEXT: Jump Tables:
 ; CHECK2-NEXT: Jump Tables:
 ; CHECK4-NOT: {{^}}Jump Tables:
 ; CHECK8-NOT: {{^}}Jump Tables:
 
 bb1: tail call void @ext(i32 1, i32 0) br label %return
 bb2: tail call void @ext(i32 2, i32 2) br label %return
 
 return: ret i32 %b
 }
 
 define i32 @jt4(i32 %a, i32 %b) {
 entry:
   switch i32 %a, label %return [
     i32 1, label %bb1
     i32 2, label %bb2
     i32 3, label %bb3
     i32 5, label %bb4
   ]
 ; CHECK-LABEL: function jt4:
+; CHECK-LABEL: MF name: jt4
+; CHECK-LABEL: No stack objects.
 ; CHECK0-NEXT: Jump Tables:
 ; CHECK2-NEXT: Jump Tables:
 ; CHECK4-NEXT: Jump Tables:
 ; CHECK8-NOT: {{^}}Jump Tables:
 
 bb1: tail call void @ext(i32 1, i32 0) br label %return
 bb2: tail call void @ext(i32 3, i32 2) br label %return
 bb3: tail call void @ext(i32 4, i32 4) br label %return
switch i32 %a, label %return [
     i32 3, label %bb3
     i32 4, label %bb4
     i32 5, label %bb5
     i32 6, label %bb6
     i32 7, label %bb7
     i32 9, label %bb8
   ]
 ; CHECK-LABEL: function jt8:
+; CHECK-LABEL: MF name: jt8
+; CHECK-LABEL: No stack objects.
 ; CHECK-NEXT: Jump Tables:
 
 bb1: tail call void @ext(i32 1, i32 0) br label %return
 bb2: tail call void @ext(i32 2, i32 2) br label %return
 bb3: tail call void @ext(i32 3, i32 4) br label %return
 bb4: tail call void @ext(i32 4, i32 6) br label %return
 bb5: tail call void @ext(i32 5, i32 8) br label %return
 bb6: tail call void @ext(i32 6, i32 10) br label %return
 bb7: tail call void @ext(i32 7, i32 12) br label %return
 bb8: tail call void @ext(i32 8, i32 14) br label %return
 
 return: ret i32 %b
 }

llvm/test/CodeGen/AArch64/tailcall_misched_graph.ll

declare void @callee2(i8*, i8*, i8*, i8*, i8*,
                       i8*, i8*, i8*, i8*, i8*)
 
 ; Make sure there is a dependence between the load and store to the same stack
 ; location during a tail call. Tail calls clobber the incoming argument area and
 ; therefore it is not safe to assume argument locations are invariant.
 ; PR23459 has a test case that we where miscompiling because of this at the
 ; time.
 
-; COMMON: Frame Objects
-; COMMON:  fi#-4: {{.*}} fixed, at location [SP+8]
-; COMMON:  fi#-3: {{.*}} fixed, at location [SP]
-; COMMON:  fi#-2: {{.*}} fixed, at location [SP+8]
-; COMMON:  fi#-1: {{.*}} fixed, at location [SP]
+; COMMON: MF name: caller2
+; COMMON: NumFixedObjects=4 
+; COMMON: Frame Objects:
+; COMMON:  fi#-4: {{.*}} fixed objects:, at location [SP+8]
+; COMMON:  fi#-3: {{.*}} fixed objects:, at location [SP]
+; COMMON:  fi#-2: {{.*}} fixed objects:, at location [SP+8]
+; COMMON:  fi#-1: {{.*}} fixed objects:, at location [SP]
 
 ; The order that these appear in differes in GISel than SDAG, but the
 ; dependency relationship still holds.
 ; COMMON:  [[VRA:%.*]]:gpr64 = LDRXui %fixed-stack.3
 ; COMMON:  [[VRB:%.*]]:gpr64 = LDRXui %fixed-stack.2
 ; SDAG:  STRXui %{{.*}}, %fixed-stack.0
 ; SDAG:  STRXui [[VRB]]{{[^,]*}}, %fixed-stack.1
 ; GISEL:  STRXui [[VRB]]{{[^,]*}}, %fixed-stack.1