This is an archive of the discontinued LLVM Phabricator instance.

Differential D125945

[BOLT][NFC] Dump function CFG into html, rendered in browser using d3-graphviz
AbandonedPublic

Authored by Amir on May 18 2022, 11:08 PM.

Details

Reviewers
rafauler
maksfb
Summary

Dump BinaryFunction CFG into html.
Usage:

llvm-bolt <...> -dump-dot-all -dot-html

Then open resulting html in browser.

Diff Detail

Event Timeline

Amir created this revision.May 18 2022, 11:08 PM
Herald added a reviewer: rafauler. · View Herald TranscriptMay 18 2022, 11:08 PM
Herald added a reviewer: maksfb. · View Herald Transcript
Herald added a project: Restricted Project. · View Herald Transcript
Herald added a subscriber: ayermolo. · View Herald Transcript
Harbormaster completed remote builds in B165253: Diff 430575.May 18 2022, 11:14 PM
Amir updated this revision to Diff 430759.May 19 2022, 11:39 AM

Fixes

Amir published this revision for review.May 19 2022, 11:42 AM
Amir retitled this revision from [BOLT][NFC] Dump dot into html using d3-graphviz to [BOLT][NFC] Dump function CFG into html, rendered in browser using d3-graphviz.
Amir edited the summary of this revision. (Show Details)
Herald added a project: Restricted Project. · View Herald TranscriptMay 19 2022, 11:43 AM
Herald added subscribers: llvm-commits, yota9, aheejin. · View Herald Transcript
Harbormaster completed remote builds in B165376: Diff 430759.May 19 2022, 11:46 AM
rafauler accepted this revision.May 19 2022, 12:41 PM

Oh that's awesome

bolt/lib/Core/BinaryFunction.cpp
3065

accidental newline?

This revision is now accepted and ready to land.May 19 2022, 12:41 PM
Amir abandoned this revision.May 23 2022, 1:17 PM

I thought about it and now I don't think embedding html and javascript code into BOLT binary is a good idea.
A better approach would be to embed dot file into html template using an external tool: D126218.

Revision Contents

PathSize
bolt/
include/
bolt/
Core/
3 lines
lib/
Core/
30 lines

Diff 430759

bolt/include/bolt/Core/BinaryFunction.h

Show First 20 Lines • Show All 890 Lines • ▼ Show 20 Linespublic:
void viewGraph() const; void viewGraph() const;
/// Dump CFG in graphviz format /// Dump CFG in graphviz format
void dumpGraph(raw_ostream &OS) const; void dumpGraph(raw_ostream &OS) const;
/// Dump CFG in graphviz format to file. /// Dump CFG in graphviz format to file.
void dumpGraphToFile(std::string Filename) const; void dumpGraphToFile(std::string Filename) const;
/// Dump CFG in d3.js format
void dumpGraphD3(raw_ostream &OS) const;
/// Dump CFG in graphviz format to a file with a filename that is derived /// Dump CFG in graphviz format to a file with a filename that is derived
/// from the function name and Annotation strings. Useful for dumping the /// from the function name and Annotation strings. Useful for dumping the
/// CFG after an optimization pass. /// CFG after an optimization pass.
void dumpGraphForPass(std::string Annotation = "") const; void dumpGraphForPass(std::string Annotation = "") const;
/// Return BinaryContext for the function. /// Return BinaryContext for the function.
const BinaryContext &getBinaryContext() const { return BC; } const BinaryContext &getBinaryContext() const { return BC; }
▲ Show 20 Lines • Show All 1,565 Lines • Show Last 20 Lines

bolt/lib/Core/BinaryFunction.cpp

Show First 20 Lines • Show All 74 Lines • ▼ Show 20 Lines
static cl::opt<bool> static cl::opt<bool>
DotToolTipCode("dot-tooltip-code", DotToolTipCode("dot-tooltip-code",
cl::desc("add basic block instructions as tool tips on nodes"), cl::desc("add basic block instructions as tool tips on nodes"),
cl::ZeroOrMore, cl::ZeroOrMore,
cl::Hidden, cl::Hidden,
cl::cat(BoltCategory)); cl::cat(BoltCategory));
static cl::opt<bool> DotHtml("dot-html",
cl::desc("dump function DOT graph into html file"),
cl::ZeroOrMore, cl::Hidden, cl::cat(BoltCategory));
cl::opt<JumpTableSupportLevel> cl::opt<JumpTableSupportLevel>
JumpTables("jump-tables", JumpTables("jump-tables",
cl::desc("jump tables support (default=basic)"), cl::desc("jump tables support (default=basic)"),
cl::init(JTS_BASIC), cl::init(JTS_BASIC),
cl::values( cl::values(
clEnumValN(JTS_NONE, "none", clEnumValN(JTS_NONE, "none",
"do not optimize functions with jump tables"), "do not optimize functions with jump tables"),
clEnumValN(JTS_BASIC, "basic", clEnumValN(JTS_BASIC, "basic",
▲ Show 20 Lines • Show All 2,958 Lines • ▼ Show 20 Lines default:
break; break;
} }
} }
return Result; return Result;
} }
} // namespace } // namespace
void BinaryFunction::dumpGraphD3(raw_ostream &OS) const {
OS << "<!DOCTYPE html>\n"
<< "<meta charset=\"utf-8\">\n"
<< "<body>\n"
rafaulerUnsubmitted
Not Done
ReplyInline Actions

accidental newline?

rafauler: accidental newline?
<< "<script src=\"https://d3js.org/d3.v5.min.js\"></script>\n"
<< "<script "
<< "src=\"https://unpkg.com/@hpcc-js/wasm@0.3.11/dist/index.min.js\">"
<< "</script>\n"
<< "<script "
<< "src=\"https://unpkg.com/d3-graphviz@3.0.5/build/d3-graphviz.js\">"
<< "</script>\n"
<< "<div id=\"graph\" style=\"text-align: center;\"></div>\n"
<< "<script>\nd3.select(\"#graph\").graphviz().renderDot(`";
dumpGraph(OS);
OS << "`);\n</script>";
}
void BinaryFunction::dumpGraph(raw_ostream &OS) const { void BinaryFunction::dumpGraph(raw_ostream &OS) const {
OS << "strict digraph \"" << getPrintName() << "\" {\n"; OS << "strict digraph \"" << getPrintName() << "\" {\n";
uint64_t Offset = Address; uint64_t Offset = Address;
for (BinaryBasicBlock *BB : BasicBlocks) { for (BinaryBasicBlock *BB : BasicBlocks) {
auto LayoutPos = auto LayoutPos =
std::find(BasicBlocksLayout.begin(), BasicBlocksLayout.end(), BB); std::find(BasicBlocksLayout.begin(), BasicBlocksLayout.end(), BB);
unsigned Layout = LayoutPos - BasicBlocksLayout.begin(); unsigned Layout = LayoutPos - BasicBlocksLayout.begin();
const char *ColdStr = BB->isCold() ? " (cold)" : ""; const char *ColdStr = BB->isCold() ? " (cold)" : "";
▲ Show 20 Lines • Show All 77 Lines • ▼ Show 20 Lines if (DisplayGraph(Filename))
errs() << "BOLT-ERROR: Can't display " << Filename << " with graphviz.\n"; errs() << "BOLT-ERROR: Can't display " << Filename << " with graphviz.\n";
if (std::error_code EC = sys::fs::remove(Filename)) { if (std::error_code EC = sys::fs::remove(Filename)) {
errs() << "BOLT-WARNING: " << EC.message() << ", failed to remove " errs() << "BOLT-WARNING: " << EC.message() << ", failed to remove "
<< Filename << "\n"; << Filename << "\n";
} }
} }
void BinaryFunction::dumpGraphForPass(std::string Annotation) const { void BinaryFunction::dumpGraphForPass(std::string Annotation) const {
std::string Filename = constructFilename(getPrintName(), Annotation, ".dot"); std::string Ext = opts::DotHtml ? ".html" : ".dot";
std::string Filename = constructFilename(getPrintName(), Annotation, Ext);
outs() << "BOLT-DEBUG: Dumping CFG to " << Filename << "\n"; outs() << "BOLT-DEBUG: Dumping CFG to " << Filename << "\n";
dumpGraphToFile(Filename); dumpGraphToFile(Filename);
} }
void BinaryFunction::dumpGraphToFile(std::string Filename) const { void BinaryFunction::dumpGraphToFile(std::string Filename) const {
std::error_code EC; std::error_code EC;
raw_fd_ostream of(Filename, EC, sys::fs::OF_None); raw_fd_ostream of(Filename, EC, sys::fs::OF_None);
if (EC) { if (EC) {
if (opts::Verbosity >= 1) { if (opts::Verbosity >= 1) {
errs() << "BOLT-WARNING: " << EC.message() << ", unable to open " errs() << "BOLT-WARNING: " << EC.message() << ", unable to open "
<< Filename << " for output.\n"; << Filename << " for output.\n";
} }
return; return;
} }
if (opts::DotHtml)
dumpGraphD3(of);
else
dumpGraph(of); dumpGraph(of);
} }
bool BinaryFunction::validateCFG() const { bool BinaryFunction::validateCFG() const {
bool Valid = true; bool Valid = true;
for (BinaryBasicBlock *BB : BasicBlocks) for (BinaryBasicBlock *BB : BasicBlocks)
Valid &= BB->validateSuccessorInvariants(); Valid &= BB->validateSuccessorInvariants();
if (!Valid) if (!Valid)
▲ Show 20 Lines • Show All 1,332 Lines • Show Last 20 Lines