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/DominanceFrontier.h"
22 #include "llvm/Support/ToolOutputFile.h"
25 template<typename GraphType>
26 static void WriteGraphToFile(raw_ostream &O, const std::string &GraphName,
27 const GraphType >) {
28 std::string Filename = GraphName + ".dot";
29 O << "Writing '" << Filename << "'...";
31 tool_output_file F(Filename.c_str(), ErrInfo);
33 if (ErrInfo.empty()) {
34 WriteGraph(F.os(), GT);
36 if (!F.os().has_error()) {
42 O << " error opening file for writing!\n";
47 //===----------------------------------------------------------------------===//
49 //===----------------------------------------------------------------------===//
53 struct DOTGraphTraits<CallGraph*> : public DefaultDOTGraphTraits {
55 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
57 static std::string getGraphName(CallGraph *F) {
61 static std::string getNodeLabel(CallGraphNode *Node, CallGraph *Graph) {
62 if (Node->getFunction())
63 return ((Value*)Node->getFunction())->getName();
64 return "external node";
71 struct CallGraphPrinter : public ModulePass {
72 static char ID; // Pass ID, replacement for typeid
73 CallGraphPrinter() : ModulePass(ID) {}
75 virtual bool runOnModule(Module &M) {
76 WriteGraphToFile(llvm::errs(), "callgraph", &getAnalysis<CallGraph>());
80 void print(raw_ostream &OS, const llvm::Module*) const {}
82 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
83 AU.addRequired<CallGraph>();
89 char CallGraphPrinter::ID = 0;
90 static RegisterPass<CallGraphPrinter> P2("dot-callgraph",
91 "Print Call Graph to 'dot' file");
93 //===----------------------------------------------------------------------===//
94 // DomInfoPrinter Pass
95 //===----------------------------------------------------------------------===//
98 class DomInfoPrinter : public FunctionPass {
100 static char ID; // Pass identification, replacement for typeid
101 DomInfoPrinter() : FunctionPass(ID) {}
103 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
104 AU.setPreservesAll();
105 AU.addRequired<DominatorTree>();
106 AU.addRequired<DominanceFrontier>();
110 virtual bool runOnFunction(Function &F) {
111 getAnalysis<DominatorTree>().dump();
112 getAnalysis<DominanceFrontier>().dump();
118 char DomInfoPrinter::ID = 0;
119 static RegisterPass<DomInfoPrinter>
120 DIP("print-dom-info", "Dominator Info Printer", true, true);