[BOLT][NFC] Use colors in CFG dumps

[Amir]

Summary

Use color coding to distinguish nodes:

• Entry nodes have bold border
• Scalar (non-loopy) code is milk white
• Outer loops are light yellow
• Innermost loops are light blue

-print-loops needs to be enabled to provide BinaryLoopInfo.
Examples:

[rafauler]

LGTM

Should we add a description somewhere (perhaps in the option that enables graph dumps) the information that -print-loops can be enabled for color outputs?

[Amir]

Add a note in DumpDotAll help message about using -print-loops to enable
color-coded blocks.

[Amir]

In D126248#3535594, @rafauler wrote:

LGTM

Should we add a description somewhere (perhaps in the option that enables graph dumps) the information that -print-loops can be enabled for color outputs?

Done

[Amir]

clang-format

bolt/lib/Core/BinaryFunction.cpp

for (unsigned I = 0; I < Str.size(); ++I) {
     }
   }
   return Result;
 }
 
 } // namespace
 
 void BinaryFunction::dumpGraph(raw_ostream &OS) const {
-  OS << "digraph \"" << getPrintName() << "\" {\n";
-  OS << R"(node [fontname="courier"])" << '\n';
+  OS << "digraph \"" << getPrintName() << "\" {\n"
+     << "node [fontname=courier, shape=box, style=filled, colorscheme=brbg9]\n";
   uint64_t Offset = Address;
   for (BinaryBasicBlock *BB : BasicBlocks) {
     auto LayoutPos =
         std::find(BasicBlocksLayout.begin(), BasicBlocksLayout.end(), BB);
     unsigned Layout = LayoutPos - BasicBlocksLayout.begin();
     const char *ColdStr = BB->isCold() ? " (cold)" : "";
-    OS << format("\"%s\" [shape=box]\n", BB->getName().data());
+    std::vector<std::string> Attrs;
+    // Bold box for entry points
+    if (isEntryPoint(*BB))
+      Attrs.push_back("penwidth=2");
+    if (BLI && BLI->getLoopFor(BB)) {
+      // Distinguish innermost loops
+      const BinaryLoop *Loop = BLI->getLoopFor(BB);
+      if (Loop->isInnermost())
+        Attrs.push_back("fillcolor=6");
+      else // some outer loop
+        Attrs.push_back("fillcolor=4");
+    } else { // non-loopy code
+      Attrs.push_back("fillcolor=5");
+    }
+    ListSeparator LS;
+    OS << "\"" << BB->getName() << "\" [";
+    for (StringRef Attr : Attrs)
+      OS << LS << Attr;
+    OS << "]\n";
     OS << format("\"%s\" [label=\"%s%s\\n(C:%lu,O:%lu,I:%u,L:%u,CFI:%u)\\n",
                  BB->getName().data(), BB->getName().data(), ColdStr,
                  BB->getKnownExecutionCount(), BB->getOffset(), getIndex(BB),
                  Layout, BB->getCFIState());
 
     if (opts::DotToolTipCode) {
       std::string Str;
       raw_string_ostream CS(Str);

bolt/lib/Rewrite/RewriteInstance.cpp

BoltID("bolt-id",
   cl::cat(BoltCategory));
 
 cl::opt<bool>
 AllowStripped("allow-stripped",
   cl::desc("allow processing of stripped binaries"),
   cl::Hidden,
   cl::cat(BoltCategory));
 
-cl::opt<bool>
-DumpDotAll("dump-dot-all",
-  cl::desc("dump function CFGs to graphviz format after each stage"),
-  cl::ZeroOrMore,
-  cl::Hidden,
-  cl::cat(BoltCategory));
+cl::opt<bool> DumpDotAll(
+    "dump-dot-all",
+    cl::desc("dump function CFGs to graphviz format after each stage;"
+             "enable '-print-loops' for color-coded blocks"),
+    cl::ZeroOrMore, cl::Hidden, cl::cat(BoltCategory));
 
 static cl::list<std::string>
 ForceFunctionNames("funcs",
   cl::CommaSeparated,
   cl::desc("limit optimizations to functions from the list"),
   cl::value_desc("func1,func2,func3,..."),
   cl::Hidden,
   cl::cat(BoltCategory));