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 template<typename GraphType>
  24 static void WriteGraphToFile(std::ostream &O, const std::string &GraphName,
  25                              const GraphType &GT) {
  26   std::string Filename = GraphName + ".dot";
  27   O << "Writing '" << Filename << "'...";
  28   std::ofstream F(Filename.c_str());
  29
  30   if (F.good())
  31     WriteGraph(F, GT);
  32   else
  33     O << "  error opening file for writing!";
  34   O << "\n";
  35 }
  36
  37
  38 //===----------------------------------------------------------------------===//
  39 //                              Call Graph Printer
  40 //===----------------------------------------------------------------------===//
  41
  42 template<>
  43 struct DOTGraphTraits<CallGraph*> : public DefaultDOTGraphTraits {
  44   static std::string getGraphName(CallGraph *F) {
  45     return "Call Graph";
  46   }
  47
  48   static std::string getNodeLabel(CallGraphNode *Node, CallGraph *Graph) {
  49     if (Node->getFunction())
  50       return ((Value*)Node->getFunction())->getName();
  51     else
  52       return "Indirect call node";
  53   }
  54 };
  55
  56
  57 namespace {
  58   struct CallGraphPrinter : public Pass {
  59     virtual bool run(Module &M) {
  60       WriteGraphToFile(std::cerr, "callgraph", &getAnalysis<CallGraph>());
  61       return false;
  62     }
  63
  64     void print(std::ostream &OS) const {}
  65
  66     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  67       AU.addRequired<CallGraph>();
  68       AU.setPreservesAll();
  69     }
  70   };
  71
  72   RegisterAnalysis<CallGraphPrinter> P2("print-callgraph",
  73                                         "Print Call Graph to 'dot' file");
  74 };