Add options to dump PGO counts in text.

[hjyamauchi]

Summary

Added text options to -pgo-view-counts and -pgo-view-raw-counts that dump block frequency and branch probability info in text.

This is useful when the graph is very large and complex (the dot command crashes, lines/edges too close to tell apart, hard to navigate without textual search) or simply when text is preferred.

[davidxl]

lib/Transforms/Instrumentation/PGOInstrumentation.cpp

181

To share most of the code, I think it is better to make PGOViewRawCounts an enum type option, just like:

ViewBlockFreqPropagationDAG

By doing so, we can do:

-pgo-view-raw-counts=graph --> dump dot graph
-pgo-view-raw-counts=text --> dump text

similarly for the other option.

[hjyamauchi]

Addressed the comment.

[davidxl]

lgtm

lib/Analysis/BlockFrequencyInfo.cpp

PGOViewCounts("pgo-view-counts", cl::init(false), cl::Hidden,
                            "profile counts are computed using branch "
                            "probabilities from the runtime profile data and "
                            "block frequency propagation algorithm. To view "
                            "the raw counts from the profile, use option "
                            "-pgo-view-raw-counts instead. To limit graph "
                            "display to only one function, use filtering option "
                            "-view-bfi-func-name."));
 
+cl::opt<bool>
+    PGOPrintCounts("pgo-print-counts", cl::init(false), cl::Hidden,
+                   cl::desc("A boolean option to print "
+                            "block profile counts and branch probabilities "
+                            "right after PGO profile annotation step. The "
+                            "profile counts are computed using branch "
+                            "probabilities from the runtime profile data and "
+                            "block frequency propagation algorithm. To view "
+                            "the raw counts from the profile, use option "
+                            "-pgo-print-raw-counts instead. To limit graph "
+                            "display to only one function, use filtering "
+                            "option -print-bfi-func-name."));
+
 static cl::opt<bool> PrintBlockFreq(
     "print-bfi", cl::init(false), cl::Hidden,
     cl::desc("Print the block frequency info."));
 
 cl::opt<std::string> PrintBlockFreqFuncName(
     "print-bfi-func-name", cl::Hidden,
     cl::desc("The option to specify the name of the function "
              "whose block frequency info is printed."));

lib/Transforms/Instrumentation/PGOInstrumentation.cpp

static cl::opt<bool>
     PGOViewRawCounts("pgo-view-raw-counts", cl::init(false), cl::Hidden,
                      cl::desc("A boolean option to show CFG dag "
                               "with raw profile counts from "
                               "profile data. See also option "
                               "-pgo-view-counts. To limit graph "
                               "display to only one function, use "
                               "filtering option -view-bfi-func-name."));
 
+// Command line option to turn on CFG dot dump of raw profile counts
+static cl::opt<bool>
+    PGOPrintRawCounts("pgo-print-raw-counts", cl::init(false), cl::Hidden,
+                      cl::desc("A boolean option to print "
+                               "raw profile counts from "
+                               "profile data. See also option "
+                               "-pgo-print-counts. To limit graph "
+                               "display to only one function, use "
+                               "filtering option -print-bfi-func-name."));
+
 // Command line option to enable/disable memop intrinsic call.size profiling.
 static cl::opt<bool>
     PGOInstrMemOP("pgo-instr-memop", cl::init(true), cl::Hidden,
                   cl::desc("Use this option to turn on/off "
                            "memory intrinsic size profiling."));
 
 // Emit branch probability as optimization remarks.
 static cl::opt<bool>
     EmitBranchProbability("pgo-emit-branch-prob", cl::init(false), cl::Hidden,
                           cl::desc("When this option is on, the annotated "
                                    "branch probability will be emitted as "
                                    " optimization remarks: -Rpass-analysis="
                                    "pgo-instr-use"));
 
 // Command line option to turn on CFG dot dump after profile annotation.
 // Defined in Analysis/BlockFrequencyInfo.cpp:  -pgo-view-counts
 extern cl::opt<bool> PGOViewCounts;
 
+// Command line option to print profile counts after profile annotation.
+// Defined in Analysis/BlockFrequencyInfo.cpp:  -pgo-print-counts
+extern cl::opt<bool> PGOPrintCounts;
+
 // Command line option to specify the name of the function for CFG dump
 // Defined in Analysis/BlockFrequencyInfo.cpp:  -view-bfi-func-name=
 extern cl::opt<std::string> ViewBlockFreqFuncName;
 
+// Command line option to specify the name of the function for count dump
+// Defined in Analysis/BlockFrequencyInfo.cpp:  -print-bfi-func-name=
+extern cl::opt<std::string> PrintBlockFreqFuncName;
+
 namespace {
 
 // Return a string describing the branch condition that can be
 // used in static branch probability heuristics:
 std::string getBranchCondString(Instruction *TI) {
   BranchInst *BI = dyn_cast<BranchInst>(TI);
   if (!BI || !BI->isConditional())
     return std::string();
public:
 
   // Return the auxiliary BB information if available.
   UseBBInfo *findBBInfo(const BasicBlock *BB) const {
     return FuncInfo.findBBInfo(BB);
   }
 
   Function &getFunc() const { return F; }
 
+  void dumpInfo(std::string Str = "") const {
+    FuncInfo.dumpInfo(Str);
+  }
+
 private:
   Function &F;
   Module *M;
   // This member stores the shared information with class PGOGenFunc.
   FuncPGOInstrumentation<PGOUseEdge, UseBBInfo> FuncInfo;
 
   // The maximum count value in the profile. This is only used in PGO use
   // compilation.
if (PGOViewCounts && (ViewBlockFreqFuncName.empty() ||
       LoopInfo LI{DominatorTree(F)};
       std::unique_ptr<BranchProbabilityInfo> NewBPI =
           llvm::make_unique<BranchProbabilityInfo>(F, LI);
       std::unique_ptr<BlockFrequencyInfo> NewBFI =
           llvm::make_unique<BlockFrequencyInfo>(F, *NewBPI, LI);
 
       NewBFI->view();
     }
+    if (PGOPrintCounts && (PrintBlockFreqFuncName.empty() ||
+                           F.getName().equals(PrintBlockFreqFuncName))) {
+      LoopInfo LI{DominatorTree(F)};
+      std::unique_ptr<BranchProbabilityInfo> NewBPI =
+          llvm::make_unique<BranchProbabilityInfo>(F, LI);
+      std::unique_ptr<BlockFrequencyInfo> NewBFI =
+          llvm::make_unique<BlockFrequencyInfo>(F, *NewBPI, LI);
+
+      dbgs() << "pgo-print-counts: " << Func.getFunc().getName() << "\n";
+      NewBFI->print(dbgs());
+    }
     if (PGOViewRawCounts && (ViewBlockFreqFuncName.empty() ||
                              F.getName().equals(ViewBlockFreqFuncName))) {
       if (ViewBlockFreqFuncName.empty())
         WriteGraph(&Func, Twine("PGORawCounts_") + Func.getFunc().getName());
       else
         ViewGraph(&Func, Twine("PGORawCounts_") + Func.getFunc().getName());
     }
+    if (PGOPrintRawCounts && (PrintBlockFreqFuncName.empty() ||
+                              F.getName().equals(PrintBlockFreqFuncName))) {
+      dbgs() << "pgo-print-raw-counts: " << Func.getFunc().getName() << "\n";
+      Func.dumpInfo();
+    }
   }
   M.setProfileSummary(PGOReader->getSummary().getMD(M.getContext()));
   // Set function hotness attribute from the profile.
   // We have to apply these attributes at the end because their presence
   // can affect the BranchProbabilityInfo of any callers, resulting in an
   // inconsistent MST between prof-gen and prof-use.
   for (auto &F : HotFunctions) {
     F->addFnAttr(llvm::Attribute::InlineHint);