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