1 //===- GraphPrinters.cpp - DOT printers for various graph types -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines several printers for various different types of graphs used
11 // by the LLVM infrastructure. It uses the generic graph interface to convert
12 // the graph into a .dot graph. These graphs can then be processed with the
13 // "dot" tool to convert them to postscript or some other suitable format.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Support/GraphWriter.h"
18 #include "llvm/Pass.h"
19 #include "llvm/Value.h"
20 #include "llvm/Analysis/CallGraph.h"
21 #include "llvm/Analysis/Dominators.h"
26 template<typename GraphType>
27 static void WriteGraphToFile(std::ostream &O, const std::string &GraphName,
28 const GraphType >) {
29 std::string Filename = GraphName + ".dot";
30 O << "Writing '" << Filename << "'...";
31 std::ofstream F(Filename.c_str());
36 O << " error opening file for writing!";
41 //===----------------------------------------------------------------------===//
43 //===----------------------------------------------------------------------===//
47 struct DOTGraphTraits<CallGraph*> : public DefaultDOTGraphTraits {
48 static std::string getGraphName(CallGraph *F) {
52 static std::string getNodeLabel(CallGraphNode *Node, CallGraph *Graph) {
53 if (Node->getFunction())
54 return ((Value*)Node->getFunction())->getName();
56 return "Indirect call node";
63 struct CallGraphPrinter : public ModulePass {
64 static char ID; // Pass ID, replacement for typeid
65 CallGraphPrinter() : ModulePass((intptr_t)&ID) {}
67 virtual bool runOnModule(Module &M) {
68 WriteGraphToFile(std::cerr, "callgraph", &getAnalysis<CallGraph>());
72 void print(std::ostream &OS) const {}
73 void print(std::ostream &OS, const llvm::Module*) const {}
75 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
76 AU.addRequired<CallGraph>();
81 char CallGraphPrinter::ID = 0;
82 RegisterPass<CallGraphPrinter> P2("dot-callgraph",
83 "Print Call Graph to 'dot' file");
86 //===----------------------------------------------------------------------===//
87 // DomInfoPrinter Pass
88 //===----------------------------------------------------------------------===//
91 class DomInfoPrinter : public FunctionPass {
93 static char ID; // Pass identification, replacement for typeid
94 DomInfoPrinter() : FunctionPass((intptr_t)&ID) {}
96 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
98 AU.addRequired<DominatorTree>();
99 AU.addRequired<DominanceFrontier>();
103 virtual bool runOnFunction(Function &F) {
104 DominatorTree &DT = getAnalysis<DominatorTree>();
106 DominanceFrontier &DF = getAnalysis<DominanceFrontier>();
112 char DomInfoPrinter::ID = 0;
113 static RegisterPass<DomInfoPrinter>
114 DIP("print-dom-info", "Dominator Info Printer", true, true);