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/Function.h"
  21 #include "llvm/Instructions.h"
  22 #include "llvm/Pass.h"
  23 #include "llvm/Analysis/CFGPrinter.h"
  24 #include "llvm/Assembly/Writer.h"
  25 #include "llvm/Support/CFG.h"
  26 #include "llvm/Support/Compiler.h"
  27 #include "llvm/Support/GraphWriter.h"
  28 #include "llvm/Config/config.h"
  29 #include <iosfwd>
  30 #include <sstream>
  31 #include <fstream>
  32 using namespace llvm;
  33
  34 namespace llvm {
  35 template<>
  36 struct DOTGraphTraits<const Function*> : public DefaultDOTGraphTraits {
  37   static std::string getGraphName(const Function *F) {
  38     return "CFG for '" + F->getNameStr() + "' function";
  39   }
  40
  41   static std::string getNodeLabel(const BasicBlock *Node,
  42                                   const Function *Graph,
  43                                   bool ShortNames) {
  44     if (ShortNames && !Node->getName().empty())
  45       return Node->getNameStr() + ":";
  46
  47     std::string Str;
  48     raw_string_ostream OS(Str);
  49
  50     if (ShortNames) {
  51       WriteAsOperand(OS, Node, false);
  52       return OS.str();
  53     }
  54
  55     if (Node->getName().empty()) {
  56       WriteAsOperand(OS, Node, false);
  57       OS << ":";
  58     }
  59
  60     OS << *Node;
  61     std::string OutStr = OS.str();
  62     if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
  63
  64     // Process string output to make it nicer...
  65     for (unsigned i = 0; i != OutStr.length(); ++i)
  66       if (OutStr[i] == '\n') {                            // Left justify
  67         OutStr[i] = '\\';
  68         OutStr.insert(OutStr.begin()+i+1, 'l');
  69       } else if (OutStr[i] == ';') {                      // Delete comments!
  70         unsigned Idx = OutStr.find('\n', i+1);            // Find end of line
  71         OutStr.erase(OutStr.begin()+i, OutStr.begin()+Idx);
  72         --i;
  73       }
  74
  75     return OutStr;
  76   }
  77
  78   static std::string getEdgeSourceLabel(const BasicBlock *Node,
  79                                         succ_const_iterator I) {
  80     // Label source of conditional branches with "T" or "F"
  81     if (const BranchInst *BI = dyn_cast<BranchInst>(Node->getTerminator()))
  82       if (BI->isConditional())
  83         return (I == succ_begin(Node)) ? "T" : "F";
  84     return "";
  85   }
  86 };
  87 }
  88
  89 namespace {
  90   struct VISIBILITY_HIDDEN CFGViewer : public FunctionPass {
  91     static char ID; // Pass identifcation, replacement for typeid
  92     CFGViewer() : FunctionPass(&ID) {}
  93
  94     virtual bool runOnFunction(Function &F) {
  95       F.viewCFG();
  96       return false;
  97     }
  98
  99     void print(std::ostream &OS, const Module* = 0) const {}
 100
 101     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 102       AU.setPreservesAll();
 103     }
 104   };
 105 }
 106
 107 char CFGViewer::ID = 0;
 108 static RegisterPass<CFGViewer>
 109 V0("view-cfg", "View CFG of function", false, true);
 110
 111 namespace {
 112   struct VISIBILITY_HIDDEN CFGOnlyViewer : public FunctionPass {
 113     static char ID; // Pass identifcation, replacement for typeid
 114     CFGOnlyViewer() : FunctionPass(&ID) {}
 115
 116     virtual bool runOnFunction(Function &F) {
 117       F.viewCFG();
 118       return false;
 119     }
 120
 121     void print(std::ostream &OS, const Module* = 0) const {}
 122
 123     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 124       AU.setPreservesAll();
 125     }
 126   };
 127 }
 128
 129 char CFGOnlyViewer::ID = 0;
 130 static RegisterPass<CFGOnlyViewer>
 131 V1("view-cfg-only",
 132    "View CFG of function (with no function bodies)", false, true);
 133
 134 namespace {
 135   struct VISIBILITY_HIDDEN CFGPrinter : public FunctionPass {
 136     static char ID; // Pass identification, replacement for typeid
 137     CFGPrinter() : FunctionPass(&ID) {}
 138     explicit CFGPrinter(void *pid) : FunctionPass(pid) {}
 139
 140     virtual bool runOnFunction(Function &F) {
 141       std::string Filename = "cfg." + F.getNameStr() + ".dot";
 142       cerr << "Writing '" << Filename << "'...";
 143       std::ofstream File(Filename.c_str());
 144
 145       if (File.good())
 146         WriteGraph(File, (const Function*)&F);
 147       else
 148         cerr << "  error opening file for writing!";
 149       cerr << "\n";
 150       return false;
 151     }
 152
 153     void print(std::ostream &OS, const Module* = 0) const {}
 154
 155     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 156       AU.setPreservesAll();
 157     }
 158   };
 159 }
 160
 161 char CFGPrinter::ID = 0;
 162 static RegisterPass<CFGPrinter>
 163 P1("dot-cfg", "Print CFG of function to 'dot' file", false, true);
 164
 165 namespace {
 166   struct VISIBILITY_HIDDEN CFGOnlyPrinter : public FunctionPass {
 167     static char ID; // Pass identification, replacement for typeid
 168     CFGOnlyPrinter() : FunctionPass(&ID) {}
 169     explicit CFGOnlyPrinter(void *pid) : FunctionPass(pid) {}
 170     virtual bool runOnFunction(Function &F) {
 171       std::string Filename = "cfg." + F.getNameStr() + ".dot";
 172       cerr << "Writing '" << Filename << "'...";
 173       std::ofstream File(Filename.c_str());
 174
 175       if (File.good())
 176         WriteGraph(File, (const Function*)&F, true);
 177       else
 178         cerr << "  error opening file for writing!";
 179       cerr << "\n";
 180       return false;
 181     }
 182     void print(std::ostream &OS, const Module* = 0) const {}
 183
 184     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 185       AU.setPreservesAll();
 186     }
 187   };
 188 }
 189
 190 char CFGOnlyPrinter::ID = 0;
 191 static RegisterPass<CFGOnlyPrinter>
 192 P2("dot-cfg-only",
 193    "Print CFG of function to 'dot' file (with no function bodies)", false, true);
 194
 195 /// viewCFG - This function is meant for use from the debugger.  You can just
 196 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 197 /// program, displaying the CFG of the current function.  This depends on there
 198 /// being a 'dot' and 'gv' program in your path.
 199 ///
 200 void Function::viewCFG() const {
 201   ViewGraph(this, "cfg" + getNameStr());
 202 }
 203
 204 /// viewCFGOnly - This function is meant for use from the debugger.  It works
 205 /// just like viewCFG, but it does not include the contents of basic blocks
 206 /// into the nodes, just the label.  If you are only interested in the CFG t
 207 /// his can make the graph smaller.
 208 ///
 209 void Function::viewCFGOnly() const {
 210   ViewGraph(this, "cfg" + getNameStr(), true);
 211 }
 212
 213 FunctionPass *llvm::createCFGPrinterPass () {
 214   return new CFGPrinter();
 215 }
 216
 217 FunctionPass *llvm::createCFGOnlyPrinterPass () {
 218   return new CFGOnlyPrinter();
 219 }
 220