std::string show(const RegionDesc& region) {
return folly::format(
"Region ({} blocks):\n{}",
region.blocks().size(),
[&]{
std::string ret;
std::string arcs;
for (auto& b : region.blocks()) {
folly::toAppend(show(*b), &ret);
if (auto r = region.nextRetrans(b->id())) {
folly::toAppend(folly::format("{} -R-> {}\n", b->id(), r.value()),
&arcs);
}
for (auto s : region.succs(b->id())) {
folly::toAppend(folly::format("{} -> {}\n", b->id(), s), &arcs);
}
}
folly::toAppend("Arcs:\n" + arcs, &ret);
folly::toAppend("Side-exiting Blocks:\n",
folly::join(", ", region.sideExitingBlocks()),
"\n",
&ret);
return ret;
}()
).str();
}
std::string show(const RegionDesc& region) {
std::string ret{folly::sformat("Region ({} blocks):\n",
region.blocks().size())};
auto profData = mcg->tx().profData();
auto weight = [&] (RegionDesc::BlockPtr b) -> int64_t {
if (!profData) return 0;
auto tid = b->profTransID();
if (tid == kInvalidTransID) return 0;
return profData->transCounter(tid);
};
uint64_t maxBlockWgt = 1; // avoid div by 0
// Print contents of all blocks in pure text format.
for (auto& b : region.blocks()) {
folly::toAppend(show(*b), &ret);
auto w = weight(b);
if (w > maxBlockWgt) maxBlockWgt = w;
}
// Print CFG in dot format, coloring the blocks based on hotness.
// Print all the blocks first.
folly::toAppend("\ndigraph RegionCFG {\n node[shape=box,style=filled]\n",
&ret);
for (auto& b : region.blocks()) {
auto const id = b->id();
auto const& mergedSet = region.merged(id);
std::string mergedStr = mergedSet.empty() ? "" :
(" (" + folly::join(",", mergedSet) + ")");
uint32_t coldness = 255 - (255 * weight(b) / maxBlockWgt);
folly::format(&ret, " \"B{}\" [label=\"B {}{}\\np: {}\","
"fillcolor=\"#ff{:02x}{:02x}\"]\n",
id, id, mergedStr, weight(b), coldness, coldness);
}
// Print arcs in dot format.
for (auto& b : region.blocks()) {
if (auto r = region.nextRetrans(b->id())) {
folly::toAppend(folly::format(" \"B{}\" -> \"B{}\" [label=R,color=red]\n",
b->id(), r.value()), &ret);
}
for (auto s : region.succs(b->id())) {
folly::toAppend(folly::format(" \"B{}\" -> \"B{}\"\n", b->id(), s),
&ret);
}
}
ret += "}\n";
return ret;
}
/*
* Checks if the given region is well-formed, which entails the
* following properties:
*
* 1) The region has at least one block.
*
* 2) Each block in the region has a different id.
*
* 3) All arcs involve blocks within the region.
*
* 4) For each arc, the bytecode offset of the dst block must
* possibly follow the execution of the src block.
*
* 5) Each block contains at most one successor corresponding to a
* given SrcKey.
*
* 6) The region doesn't contain any loops, unless JitLoops is
* enabled.
*
* 7) All blocks are reachable from the entry block.
*
* 8) For each block, there must be a path from the entry to it that
* includes only earlier blocks in the region.
*
* 9) The region is topologically sorted unless loops are enabled.
*
* 10) The block-retranslation chains cannot have cycles.
*
*/
bool check(const RegionDesc& region, std::string& error) {
auto bad = [&](const std::string& errorMsg) {
error = errorMsg;
return false;
};
// 1) The region has at least one block.
if (region.empty()) return bad("empty region");
RegionDesc::BlockIdSet blockSet;
for (auto b : region.blocks()) {
auto bid = b->id();
// 2) Each block in the region has a different id.
if (blockSet.count(bid)) {
return bad(folly::sformat("many blocks with id {}", bid));
}
blockSet.insert(bid);
}
for (auto b : region.blocks()) {
auto bid = b->id();
SrcKey lastSk = region.block(bid)->last();
OffsetSet validSuccOffsets = lastSk.succOffsets();
OffsetSet succOffsets;
for (auto succ : region.succs(bid)) {
SrcKey succSk = region.block(succ)->start();
Offset succOffset = succSk.offset();
// 3) All arcs involve blocks within the region.
if (blockSet.count(succ) == 0) {
return bad(folly::sformat("arc with dst not in the region: {} -> {}",
bid, succ));
}
// Checks 4) and 5) below don't make sense for arcs corresponding
// to inlined calls and returns, so skip them in such cases.
// This won't be possible once task #4076399 is done.
if (lastSk.func() != succSk.func()) continue;
// 4) For each arc, the bytecode offset of the dst block must
// possibly follow the execution of the src block.
if (validSuccOffsets.count(succOffset) == 0) {
return bad(folly::sformat("arc with impossible control flow: {} -> {}",
bid, succ));
}
// 5) Each block contains at most one successor corresponding to a
// given SrcKey.
if (succOffsets.count(succOffset) > 0) {
return bad(folly::sformat("block {} has multiple successors with SK {}",
bid, show(succSk)));
}
succOffsets.insert(succOffset);
}
for (auto pred : region.preds(bid)) {
if (blockSet.count(pred) == 0) {
return bad(folly::sformat("arc with src not in the region: {} -> {}",
pred, bid));
}
}
}
// 6) is checked by dfsCheck.
DFSChecker dfsCheck(region);
if (!dfsCheck.check(region.entry()->id())) {
return bad("region is cyclic");
}
// 7) All blocks are reachable from the entry (first) block.
if (dfsCheck.numVisited() != blockSet.size()) {
return bad("region has unreachable blocks");
}
// 8) and 9) are checked below.
RegionDesc::BlockIdSet visited;
auto& blocks = region.blocks();
for (unsigned i = 0; i < blocks.size(); i++) {
auto bid = blocks[i]->id();
unsigned nVisited = 0;
for (auto pred : region.preds(bid)) {
nVisited += visited.count(pred);
}
// 8) For each block, there must be a path from the entry to it that
// includes only earlier blocks in the region.
if (nVisited == 0 && i != 0) {
return bad(folly::sformat("block {} appears before all its predecessors",
bid));
}
// 9) The region is topologically sorted unless loops are enabled.
if (!RuntimeOption::EvalJitLoops && nVisited != region.preds(bid).size()) {
return bad(folly::sformat("non-topological order (bid: {})", bid));
}
visited.insert(bid);
}
// 10) The block-retranslation chains cannot have cycles.
for (auto b : blocks) {
auto bid = b->id();
RegionDesc::BlockIdSet chainSet;
chainSet.insert(bid);
while (auto next = region.nextRetrans(bid)) {
auto nextId = next.value();
if (chainSet.count(nextId)) {
return bad(folly::sformat("cyclic retranslation chain for block {}",
bid));
}
chainSet.insert(nextId);
bid = nextId;
}
}
return true;
}