tools/analyze/GraphPrinters.cpp

   1 //===- GraphPrinters.cpp - DOT printers for various graph types -----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "Support/GraphWriter.h"
  18 #include "llvm/Pass.h"
  19 #include "llvm/Value.h"
  20 #include "llvm/Analysis/CallGraph.h"
  21 #include <fstream>
  22
  23 namespace llvm {
  24
  25 template<typename GraphType>
  26 static void WriteGraphToFile(std::ostream &O, const std::string &GraphName,
  27                              const GraphType &GT) {
  28   std::string Filename = GraphName + ".dot";
  29   O << "Writing '" << Filename << "'...";
  30   std::ofstream F(Filename.c_str());
  31
  32   if (F.good())
  33     WriteGraph(F, GT);
  34   else
  35     O << "  error opening file for writing!";
  36   O << "\n";
  37 }
  38
  39
  40 //===----------------------------------------------------------------------===//
  41 //                              Call Graph Printer
  42 //===----------------------------------------------------------------------===//
  43
  44 template<>
  45 struct DOTGraphTraits<CallGraph*> : public DefaultDOTGraphTraits {
  46   static std::string getGraphName(CallGraph *F) {
  47     return "Call Graph";
  48   }
  49
  50   static std::string getNodeLabel(CallGraphNode *Node, CallGraph *Graph) {
  51     if (Node->getFunction())
  52       return ((Value*)Node->getFunction())->getName();
  53     else
  54       return "Indirect call node";
  55   }
  56 };
  57
  58
  59 namespace {
  60   struct CallGraphPrinter : public Pass {
  61     virtual bool run(Module &M) {
  62       WriteGraphToFile(std::cerr, "callgraph", &getAnalysis<CallGraph>());
  63       return false;
  64     }
  65
  66     void print(std::ostream &OS) const {}
  67
  68     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  69       AU.addRequired<CallGraph>();
  70       AU.setPreservesAll();
  71     }
  72   };
  73
  74   RegisterAnalysis<CallGraphPrinter> P2("print-callgraph",
  75                                         "Print Call Graph to 'dot' file");
  76 };
  77
  78 } // End llvm namespace