Skip to content

CFGPrinter: fix accidentally quadratic behavior #125396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions llvm/include/llvm/Analysis/CFGPrinter.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
#include "llvm/Support/FormatVariadic.h"

namespace llvm {
class ModuleSlotTracker;

template <class GraphType> struct GraphTraits;
class CFGViewerPass : public PassInfoMixin<CFGViewerPass> {
public:
Expand Down Expand Up @@ -61,28 +63,27 @@ class DOTFuncInfo {
const Function *F;
const BlockFrequencyInfo *BFI;
const BranchProbabilityInfo *BPI;
std::unique_ptr<ModuleSlotTracker> MSTStorage;
uint64_t MaxFreq;
bool ShowHeat;
bool EdgeWeights;
bool RawWeights;

public:
DOTFuncInfo(const Function *F) : DOTFuncInfo(F, nullptr, nullptr, 0) {}
~DOTFuncInfo();

DOTFuncInfo(const Function *F, const BlockFrequencyInfo *BFI,
const BranchProbabilityInfo *BPI, uint64_t MaxFreq)
: F(F), BFI(BFI), BPI(BPI), MaxFreq(MaxFreq) {
ShowHeat = false;
EdgeWeights = !!BPI; // Print EdgeWeights when BPI is available.
RawWeights = !!BFI; // Print RawWeights when BFI is available.
}
const BranchProbabilityInfo *BPI, uint64_t MaxFreq);

const BlockFrequencyInfo *getBFI() const { return BFI; }

const BranchProbabilityInfo *getBPI() const { return BPI; }

const Function *getFunction() const { return this->F; }

ModuleSlotTracker *getModuleSlotTracker();

uint64_t getMaxFreq() const { return MaxFreq; }

uint64_t getFreq(const BasicBlock *BB) const {
Expand Down Expand Up @@ -203,22 +204,12 @@ struct DOTGraphTraits<DOTFuncInfo *> : public DefaultDOTGraphTraits {
return SimpleNodeLabelString(Node);
}

static void printBasicBlock(raw_string_ostream &OS, const BasicBlock &Node) {
// Prepend label name
Node.printAsOperand(OS, false);
OS << ":\n";
for (const Instruction &Inst : Node)
OS << Inst << "\n";
}

static std::string getCompleteNodeLabel(
const BasicBlock *Node, DOTFuncInfo *,
function_ref<void(raw_string_ostream &, const BasicBlock &)>
HandleBasicBlock = printBasicBlock,
function_ref<void(std::string &, unsigned &, unsigned)>
HandleComment = eraseComment) {
return CompleteNodeLabelString(Node, HandleBasicBlock, HandleComment);
}
HandleBasicBlock = {},
function_ref<void(std::string &, unsigned &, unsigned)> HandleComment =
eraseComment);

std::string getNodeLabel(const BasicBlock *Node, DOTFuncInfo *CFGInfo) {

Expand Down Expand Up @@ -337,6 +328,6 @@ struct DOTGraphTraits<DOTFuncInfo *> : public DefaultDOTGraphTraits {
bool isNodeHidden(const BasicBlock *Node, const DOTFuncInfo *CFGInfo);
void computeDeoptOrUnreachablePaths(const Function *F);
};
} // End llvm namespace
} // namespace llvm

#endif
52 changes: 52 additions & 0 deletions llvm/lib/Analysis/CFGPrinter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

#include "llvm/Analysis/CFGPrinter.h"
#include "llvm/ADT/PostOrderIterator.h"
#include "llvm/IR/ModuleSlotTracker.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/GraphWriter.h"
Expand Down Expand Up @@ -90,6 +91,22 @@ static void viewCFG(Function &F, const BlockFrequencyInfo *BFI,
ViewGraph(&CFGInfo, "cfg." + F.getName(), CFGOnly);
}

DOTFuncInfo::DOTFuncInfo(const Function *F, const BlockFrequencyInfo *BFI,
const BranchProbabilityInfo *BPI, uint64_t MaxFreq)
: F(F), BFI(BFI), BPI(BPI), MaxFreq(MaxFreq) {
ShowHeat = false;
EdgeWeights = !!BPI; // Print EdgeWeights when BPI is available.
RawWeights = !!BFI; // Print RawWeights when BFI is available.
}

DOTFuncInfo::~DOTFuncInfo() = default;

ModuleSlotTracker *DOTFuncInfo::getModuleSlotTracker() {
if (!MSTStorage)
MSTStorage = std::make_unique<ModuleSlotTracker>(F->getParent());
return &*MSTStorage;
}

PreservedAnalyses CFGViewerPass::run(Function &F, FunctionAnalysisManager &AM) {
if (!CFGFuncName.empty() && !F.getName().contains(CFGFuncName))
return PreservedAnalyses::all();
Expand Down Expand Up @@ -208,3 +225,38 @@ bool DOTGraphTraits<DOTFuncInfo *>::isNodeHidden(const BasicBlock *Node,
}
return false;
}

std::string DOTGraphTraits<DOTFuncInfo *>::getCompleteNodeLabel(
const BasicBlock *Node, DOTFuncInfo *CFGInfo,
function_ref<void(raw_string_ostream &, const BasicBlock &)>
HandleBasicBlock,
function_ref<void(std::string &, unsigned &, unsigned)> HandleComment) {
if (HandleBasicBlock)
return CompleteNodeLabelString(Node, HandleBasicBlock, HandleComment);

// Default basic block printing
std::optional<ModuleSlotTracker> MSTStorage;
ModuleSlotTracker *MST = nullptr;

if (CFGInfo) {
MST = CFGInfo->getModuleSlotTracker();
} else {
MSTStorage.emplace(Node->getModule());
MST = &*MSTStorage;
}

return CompleteNodeLabelString(
Node,
function_ref<void(raw_string_ostream &, const BasicBlock &)>(
[MST](raw_string_ostream &OS, const BasicBlock &Node) -> void {
// Prepend label name
Node.printAsOperand(OS, false, *MST);
OS << ":\n";

for (const Instruction &Inst : Node) {
Inst.print(OS, *MST, /* IsForDebug */ false);
OS << '\n';
}
}),
HandleComment);
}