1 //===- CFGPrinter.cpp - DOT printer for the control flow graph ------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
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
18 //===----------------------------------------------------------------------===//
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/System/Path.h"
28 #include "llvm/System/Program.h"
29 #include "llvm/Config/config.h"
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.
38 static bool CFGOnly = false;
42 struct DOTGraphTraits<const Function*> : public DefaultDOTGraphTraits {
43 static std::string getGraphName(const Function *F) {
44 return "CFG for '" + F->getName() + "' function";
47 static std::string getNodeLabel(const BasicBlock *Node,
48 const Function *Graph) {
49 if (CFGOnly && !Node->getName().empty())
50 return Node->getName() + ":";
52 std::ostringstream Out;
54 WriteAsOperand(Out, Node, false, true);
58 if (Node->getName().empty()) {
59 WriteAsOperand(Out, Node, false, true);
64 std::string OutStr = Out.str();
65 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
67 // Process string output to make it nicer...
68 for (unsigned i = 0; i != OutStr.length(); ++i)
69 if (OutStr[i] == '\n') { // Left justify
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);
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";
93 struct CFGPrinter : public FunctionPass {
94 virtual bool runOnFunction(Function &F) {
95 std::string Filename = "cfg." + F.getName() + ".dot";
96 std::cerr << "Writing '" << Filename << "'...";
97 std::ofstream File(Filename.c_str());
100 WriteGraph(File, (const Function*)&F);
102 std::cerr << " error opening file for writing!";
107 void print(std::ostream &OS, const Module* = 0) const {}
109 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
110 AU.setPreservesAll();
114 RegisterAnalysis<CFGPrinter> P1("print-cfg",
115 "Print CFG of function to 'dot' file");
117 struct CFGOnlyPrinter : public CFGPrinter {
118 virtual bool runOnFunction(Function &F) {
119 bool OldCFGOnly = CFGOnly;
121 CFGPrinter::runOnFunction(F);
122 CFGOnly = OldCFGOnly;
125 void print(std::ostream &OS, const Module* = 0) const {}
127 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
128 AU.setPreservesAll();
132 RegisterAnalysis<CFGOnlyPrinter>
134 "Print CFG of function to 'dot' file (with no function bodies)");
137 /// viewCFG - This function is meant for use from the debugger. You can just
138 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
139 /// program, displaying the CFG of the current function. This depends on there
140 /// being a 'dot' and 'gv' program in your path.
142 void Function::viewCFG() const {
146 sprintf(pathsuff, "%06u", unsigned(rand()));
148 sys::Path TempDir = sys::Path::GetTemporaryDirectory();
149 sys::Path Filename = TempDir;
151 Filename.appendComponent("cfg" + getName() + "." + pathsuff + ".dot");
152 std::cerr << "Writing '" << Filename << "'... ";
153 std::ofstream F(Filename.c_str());
156 std::cerr << " error opening file for writing!\n";
165 sys::Path Graphviz(LLVM_PATH_GRAPHVIZ);
166 std::vector<const char*> args;
167 args.push_back(Graphviz.c_str());
168 args.push_back(Filename.c_str());
171 std::cerr << "Running 'Graphviz' program... " << std::flush;
172 if (sys::Program::ExecuteAndWait(Graphviz, &args[0])) {
173 std::cerr << "Error viewing graph: 'Graphviz' not in path?\n";
175 Filename.eraseFromDisk();
178 #elif (HAVE_GV && HAVE_DOT)
179 sys::Path PSFilename = TempDir;
180 PSFilename.appendComponent(std::string("cfg.tempgraph") + "." + pathsuff + ".ps");
182 sys::Path dot(LLVM_PATH_DOT);
183 std::vector<const char*> args;
184 args.push_back(dot.c_str());
185 args.push_back("-Tps");
186 args.push_back("-Nfontname=Courier");
187 args.push_back("-Gsize=7.5,10");
188 args.push_back(Filename.c_str());
189 args.push_back("-o");
190 args.push_back(PSFilename.c_str());
193 std::cerr << "Running 'dot' program... " << std::flush;
194 if (sys::Program::ExecuteAndWait(dot, &args[0])) {
195 std::cerr << "Error viewing graph: 'dot' not in path?\n";
199 sys::Path gv(LLVM_PATH_GV);
201 args.push_back(gv.c_str());
202 args.push_back(PSFilename.c_str());
205 sys::Program::ExecuteAndWait(gv, &args[0]);
207 Filename.eraseFromDisk();
208 PSFilename.eraseFromDisk();
211 sys::Path dotty(LLVM_PATH_DOTTY);
212 std::vector<const char*> args;
213 args.push_back(dotty.c_str());
214 args.push_back(Filename.c_str());
217 std::cerr << "Running 'dotty' program... " << std::flush;
218 if (sys::Program::ExecuteAndWait(dotty, &args[0])) {
219 std::cerr << "Error viewing graph: 'dotty' not in path?\n";
221 #ifndef __MINGW32__ // Dotty spawns another app and doesn't wait until it returns
222 Filename.eraseFromDisk();
229 std::cerr << "Function::viewCFG is only available in debug builds on "
230 << "systems with Graphviz or gv or dotty!\n";
233 Filename.eraseFromDisk();
234 TempDir.eraseFromDisk(true);
238 /// viewCFGOnly - This function is meant for use from the debugger. It works
239 /// just like viewCFG, but it does not include the contents of basic blocks
240 /// into the nodes, just the label. If you are only interested in the CFG t
241 /// his can make the graph smaller.
243 void Function::viewCFGOnly() const {
249 FunctionPass *llvm::createCFGPrinterPass () {
250 return new CFGPrinter();
253 FunctionPass *llvm::createCFGOnlyPrinterPass () {
254 return new CFGOnlyPrinter();