lib/Analysis/CFGPrinter.cpp

   1 //===- CFGPrinter.cpp - DOT printer for the control flow graph ------------===//
   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 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/GraphWriter.h"
  27 #include "llvm/Config/config.h"
  28 #include <sstream>
  29 #include <fstream>
  30 using namespace llvm;
  31
  32 /// CFGOnly flag - This is used to control whether or not the CFG graph printer
  33 /// prints out the contents of basic blocks or not.  This is acceptable because
  34 /// this code is only really used for debugging purposes.
  35 ///
  36 static bool CFGOnly = false;
  37
  38 namespace llvm {
  39 template<>
  40 struct DOTGraphTraits<const Function*> : public DefaultDOTGraphTraits {
  41   static std::string getGraphName(const Function *F) {
  42     return "CFG for '" + F->getName() + "' function";
  43   }
  44
  45   static std::string getNodeLabel(const BasicBlock *Node,
  46                                   const Function *Graph) {
  47     if (CFGOnly && !Node->getName().empty())
  48       return Node->getName() + ":";
  49
  50     std::ostringstream Out;
  51     if (CFGOnly) {
  52       WriteAsOperand(Out, Node, false, true);
  53       return Out.str();
  54     }
  55
  56     if (Node->getName().empty()) {
  57       WriteAsOperand(Out, Node, false, true);
  58       Out << ":";
  59     }
  60
  61     Out << *Node;
  62     std::string OutStr = Out.str();
  63     if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
  64
  65     // Process string output to make it nicer...
  66     for (unsigned i = 0; i != OutStr.length(); ++i)
  67       if (OutStr[i] == '\n') {                            // Left justify
  68         OutStr[i] = '\\';
  69         OutStr.insert(OutStr.begin()+i+1, 'l');
  70       } else if (OutStr[i] == ';') {                      // Delete comments!
  71         unsigned Idx = OutStr.find('\n', i+1);            // Find end of line
  72         OutStr.erase(OutStr.begin()+i, OutStr.begin()+Idx);
  73         --i;
  74       }
  75
  76     return OutStr;
  77   }
  78
  79   static std::string getEdgeSourceLabel(const BasicBlock *Node,
  80                                         succ_const_iterator I) {
  81     // Label source of conditional branches with "T" or "F"
  82     if (const BranchInst *BI = dyn_cast<BranchInst>(Node->getTerminator()))
  83       if (BI->isConditional())
  84         return (I == succ_begin(Node)) ? "T" : "F";
  85     return "";
  86   }
  87 };
  88 }
  89
  90 namespace {
  91   struct CFGPrinter : public FunctionPass {
  92     virtual bool runOnFunction(Function &F) {
  93       std::string Filename = "cfg." + F.getName() + ".dot";
  94       std::cerr << "Writing '" << Filename << "'...";
  95       std::ofstream File(Filename.c_str());
  96
  97       if (File.good())
  98         WriteGraph(File, (const Function*)&F);
  99       else
 100         std::cerr << "  error opening file for writing!";
 101       std::cerr << "\n";
 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   RegisterAnalysis<CFGPrinter> P1("print-cfg",
 113                                   "Print CFG of function to 'dot' file");
 114
 115   struct CFGOnlyPrinter : public CFGPrinter {
 116     virtual bool runOnFunction(Function &F) {
 117       bool OldCFGOnly = CFGOnly;
 118       CFGOnly = true;
 119       CFGPrinter::runOnFunction(F);
 120       CFGOnly = OldCFGOnly;
 121       return false;
 122     }
 123     void print(std::ostream &OS, const Module* = 0) const {}
 124
 125     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 126       AU.setPreservesAll();
 127     }
 128   };
 129
 130   RegisterAnalysis<CFGOnlyPrinter>
 131   P2("print-cfg-only",
 132      "Print CFG of function to 'dot' file (with no function bodies)");
 133 }
 134
 135 /// viewCFG - This function is meant for use from the debugger.  You can just
 136 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 137 /// program, displaying the CFG of the current function.  This depends on there
 138 /// being a 'dot' and 'gv' program in your path.
 139 ///
 140 void Function::viewCFG() const {
 141   ViewGraph(this, "cfg" + getName());
 142 }
 143
 144 /// viewCFGOnly - This function is meant for use from the debugger.  It works
 145 /// just like viewCFG, but it does not include the contents of basic blocks
 146 /// into the nodes, just the label.  If you are only interested in the CFG t
 147 /// his can make the graph smaller.
 148 ///
 149 void Function::viewCFGOnly() const {
 150   CFGOnly = true;
 151   viewCFG();
 152   CFGOnly = false;
 153 }
 154
 155 FunctionPass *llvm::createCFGPrinterPass () {
 156   return new CFGPrinter();
 157 }
 158
 159 FunctionPass *llvm::createCFGOnlyPrinterPass () {
 160   return new CFGOnlyPrinter();
 161 }
 162