lib/Analysis/CFGPrinter.cpp

   1 //===- CFGPrinter.cpp - DOT printer for the control flow graph ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a '-dot-cfg' analysis pass, which emits the
  11 // cfg.<fnname>.dot file for each function in the program, with a graph of the
  12 // CFG for that function.
  13 //
  14 // The other main feature of this file is that it implements the
  15 // Function::viewCFG method, which is useful for debugging passes which operate
  16 // on the CFG.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #include "llvm/Analysis/CFGPrinter.h"
  21
  22 #include "llvm/Pass.h"
  23 using namespace llvm;
  24
  25 namespace {
  26   struct CFGViewer : public FunctionPass {
  27     static char ID; // Pass identifcation, replacement for typeid
  28     CFGViewer() : FunctionPass(ID) {}
  29
  30     virtual bool runOnFunction(Function &F) {
  31       F.viewCFG();
  32       return false;
  33     }
  34
  35     void print(raw_ostream &OS, const Module* = 0) const {}
  36
  37     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  38       AU.setPreservesAll();
  39     }
  40   };
  41 }
  42
  43 char CFGViewer::ID = 0;
  44 INITIALIZE_PASS(CFGViewer, "view-cfg", "View CFG of function", false, true)
  45
  46 namespace {
  47   struct CFGOnlyViewer : public FunctionPass {
  48     static char ID; // Pass identifcation, replacement for typeid
  49     CFGOnlyViewer() : FunctionPass(ID) {}
  50
  51     virtual bool runOnFunction(Function &F) {
  52       F.viewCFGOnly();
  53       return false;
  54     }
  55
  56     void print(raw_ostream &OS, const Module* = 0) const {}
  57
  58     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  59       AU.setPreservesAll();
  60     }
  61   };
  62 }
  63
  64 char CFGOnlyViewer::ID = 0;
  65 INITIALIZE_PASS(CFGOnlyViewer, "view-cfg-only",
  66                 "View CFG of function (with no function bodies)", false, true)
  67
  68 namespace {
  69   struct CFGPrinter : public FunctionPass {
  70     static char ID; // Pass identification, replacement for typeid
  71     CFGPrinter() : FunctionPass(ID) {}
  72
  73     virtual bool runOnFunction(Function &F) {
  74       std::string Filename = "cfg." + F.getNameStr() + ".dot";
  75       errs() << "Writing '" << Filename << "'...";
  76
  77       std::string ErrorInfo;
  78       raw_fd_ostream File(Filename.c_str(), ErrorInfo);
  79
  80       if (ErrorInfo.empty())
  81         WriteGraph(File, (const Function*)&F);
  82       else
  83         errs() << "  error opening file for writing!";
  84       errs() << "\n";
  85       return false;
  86     }
  87
  88     void print(raw_ostream &OS, const Module* = 0) const {}
  89
  90     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  91       AU.setPreservesAll();
  92     }
  93   };
  94 }
  95
  96 char CFGPrinter::ID = 0;
  97 INITIALIZE_PASS(CFGPrinter, "dot-cfg", "Print CFG of function to 'dot' file",
  98                 false, true)
  99
 100 namespace {
 101   struct CFGOnlyPrinter : public FunctionPass {
 102     static char ID; // Pass identification, replacement for typeid
 103     CFGOnlyPrinter() : FunctionPass(ID) {}
 104     virtual bool runOnFunction(Function &F) {
 105       std::string Filename = "cfg." + F.getNameStr() + ".dot";
 106       errs() << "Writing '" << Filename << "'...";
 107
 108       std::string ErrorInfo;
 109       raw_fd_ostream File(Filename.c_str(), ErrorInfo);
 110
 111       if (ErrorInfo.empty())
 112         WriteGraph(File, (const Function*)&F, true);
 113       else
 114         errs() << "  error opening file for writing!";
 115       errs() << "\n";
 116       return false;
 117     }
 118     void print(raw_ostream &OS, const Module* = 0) const {}
 119
 120     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 121       AU.setPreservesAll();
 122     }
 123   };
 124 }
 125
 126 char CFGOnlyPrinter::ID = 0;
 127 INITIALIZE_PASS(CFGOnlyPrinter, "dot-cfg-only",
 128    "Print CFG of function to 'dot' file (with no function bodies)",
 129    false, true)
 130
 131 /// viewCFG - This function is meant for use from the debugger.  You can just
 132 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 133 /// program, displaying the CFG of the current function.  This depends on there
 134 /// being a 'dot' and 'gv' program in your path.
 135 ///
 136 void Function::viewCFG() const {
 137   ViewGraph(this, "cfg" + getNameStr());
 138 }
 139
 140 /// viewCFGOnly - This function is meant for use from the debugger.  It works
 141 /// just like viewCFG, but it does not include the contents of basic blocks
 142 /// into the nodes, just the label.  If you are only interested in the CFG t
 143 /// his can make the graph smaller.
 144 ///
 145 void Function::viewCFGOnly() const {
 146   ViewGraph(this, "cfg" + getNameStr(), true);
 147 }
 148
 149 FunctionPass *llvm::createCFGPrinterPass () {
 150   return new CFGPrinter();
 151 }
 152
 153 FunctionPass *llvm::createCFGOnlyPrinterPass () {
 154   return new CFGOnlyPrinter();
 155 }
 156