//===- GraphPrinters.cpp - DOT printers for various graph types -----------===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
// This file defines several printers for various different types of graphs used
// by the LLVM infrastructure. It uses the generic graph interface to convert
// the graph into a .dot graph. These graphs can then be processed with the
//
//===----------------------------------------------------------------------===//
-#include "Support/GraphWriter.h"
-#include "llvm/Pass.h"
-#include "llvm/iTerminators.h"
#include "llvm/Analysis/CallGraph.h"
-#include "llvm/Support/CFG.h"
-#include <sstream>
-#include <fstream>
+#include "llvm/Analysis/Dominators.h"
+#include "llvm/IR/Value.h"
+#include "llvm/Pass.h"
+#include "llvm/Support/GraphWriter.h"
+#include "llvm/Support/ToolOutputFile.h"
+using namespace llvm;
+
+template<typename GraphType>
+static void WriteGraphToFile(raw_ostream &O, const std::string &GraphName,
+ const GraphType >) {
+ std::string Filename = GraphName + ".dot";
+ O << "Writing '" << Filename << "'...";
+ std::string ErrInfo;
+ tool_output_file F(Filename.c_str(), ErrInfo);
+
+ if (ErrInfo.empty()) {
+ WriteGraph(F.os(), GT);
+ F.os().close();
+ if (!F.os().has_error()) {
+ O << "\n";
+ F.keep();
+ return;
+ }
+ }
+ O << " error opening file for writing!\n";
+ F.os().clear_error();
+}
+
//===----------------------------------------------------------------------===//
-// Control Flow Graph Printer
+// Call Graph Printer
//===----------------------------------------------------------------------===//
-template<>
-struct DOTGraphTraits<Function*> : public DefaultDOTGraphTraits {
- static std::string getGraphName(Function *F) {
- return "CFG for '" + F->getName() + "' function";
- }
+namespace llvm {
+ template<>
+ struct DOTGraphTraits<CallGraph*> : public DefaultDOTGraphTraits {
- static std::string getNodeLabel(BasicBlock *Node, Function *Graph) {
- std::ostringstream Out;
- Out << Node;
- std::string OutStr = Out.str();
- if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
-
- // Process string output to make it nicer...
- for (unsigned i = 0; i != OutStr.length(); ++i)
- if (OutStr[i] == '\n') { // Left justify
- OutStr[i] = '\\';
- OutStr.insert(OutStr.begin()+i+1, 'l');
- } else if (OutStr[i] == ';') { // Delete comments!
- unsigned Idx = OutStr.find('\n', i+1); // Find end of line
- OutStr.erase(OutStr.begin()+i, OutStr.begin()+Idx);
- --i;
- }
-
- return OutStr;
- }
+ DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
- static std::string getNodeAttributes(BasicBlock *N) {
- return "fontname=Courier";
- }
-
- static std::string getEdgeSourceLabel(BasicBlock *Node, succ_iterator I) {
- // Label source of conditional branches with "T" or "F"
- if (BranchInst *BI = dyn_cast<BranchInst>(Node->getTerminator()))
- if (BI->isConditional())
- return (I == succ_begin(Node)) ? "T" : "F";
- return "";
- }
-};
+ static std::string getGraphName(CallGraph *F) {
+ return "Call Graph";
+ }
-template<typename GraphType>
-static void WriteGraphToFile(std::ostream &O, const std::string &GraphName,
- const GraphType >) {
- std::string Filename = GraphName + ".dot";
- O << "Writing '" << Filename << "'...";
- std::ofstream F(Filename.c_str());
-
- if (F.good())
- WriteGraph(F, GT);
- else
- O << " error opening file for writing!";
- O << "\n";
+ static std::string getNodeLabel(CallGraphNode *Node, CallGraph *Graph) {
+ if (Node->getFunction())
+ return ((Value*)Node->getFunction())->getName();
+ return "external node";
+ }
+ };
}
namespace {
- struct CFGPrinter : public FunctionPass {
- virtual bool runOnFunction(Function &Func) {
- WriteGraphToFile(std::cerr, "cfg."+Func.getName(), &Func);
+ struct CallGraphPrinter : public ModulePass {
+ static char ID; // Pass ID, replacement for typeid
+ CallGraphPrinter() : ModulePass(ID) {}
+
+ virtual bool runOnModule(Module &M) {
+ WriteGraphToFile(llvm::errs(), "callgraph", &getAnalysis<CallGraph>());
return false;
}
- void print(std::ostream &OS) const {}
-
+ void print(raw_ostream &OS, const llvm::Module*) const {}
+
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.addRequired<CallGraph>();
AU.setPreservesAll();
}
};
+}
- RegisterAnalysis<CFGPrinter> P1("print-cfg",
- "Print CFG of function to 'dot' file");
-};
-
-
+char CallGraphPrinter::ID = 0;
+static RegisterPass<CallGraphPrinter> P2("dot-callgraph",
+ "Print Call Graph to 'dot' file");
//===----------------------------------------------------------------------===//
-// Call Graph Printer
+// DomInfoPrinter Pass
//===----------------------------------------------------------------------===//
-template<>
-struct DOTGraphTraits<CallGraph*> : public DefaultDOTGraphTraits {
- static std::string getGraphName(CallGraph *F) {
- return "Call Graph";
- }
-
- static std::string getNodeLabel(CallGraphNode *Node, CallGraph *Graph) {
- if (Node->getFunction())
- return Node->getFunction()->getName();
- else
- return "Indirect call node";
- }
-};
-
-
namespace {
- struct CallGraphPrinter : public Pass {
- virtual bool run(Module &M) {
- WriteGraphToFile(std::cerr, "callgraph", &getAnalysis<CallGraph>());
- return false;
- }
+ class DomInfoPrinter : public FunctionPass {
+ public:
+ static char ID; // Pass identification, replacement for typeid
+ DomInfoPrinter() : FunctionPass(ID) {}
- void print(std::ostream &OS) const {}
-
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
- AU.addRequired<CallGraph>();
AU.setPreservesAll();
+ AU.addRequired<DominatorTree>();
+
+ }
+
+ virtual bool runOnFunction(Function &F) {
+ getAnalysis<DominatorTree>().dump();
+ return false;
}
};
+}
- RegisterAnalysis<CallGraphPrinter> P2("print-callgraph",
- "Print Call Graph to 'dot' file");
-};
+char DomInfoPrinter::ID = 0;
+static RegisterPass<DomInfoPrinter>
+DIP("print-dom-info", "Dominator Info Printer", true, true);