blob: 0dba28a2530c9f8bf0bd9c03c2ca974e68fa4c4a [file] [log] [blame]
Reid Spencer9d5b5322006-06-27 16:49:46 +00001//===-- GraphWriter.cpp - Implements GraphWriter support routines ---------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer9d5b5322006-06-27 16:49:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements misc. GraphWriter support routines.
11//
12//===----------------------------------------------------------------------===//
13
Chris Lattner65a392e2006-07-28 22:21:01 +000014#include "llvm/Support/GraphWriter.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000015#include "llvm/Support/Path.h"
16#include "llvm/Support/Program.h"
Reid Spencer9d5b5322006-06-27 16:49:46 +000017#include "llvm/Config/config.h"
Reid Spencer9d5b5322006-06-27 16:49:46 +000018using namespace llvm;
19
Chris Lattner103289e2009-08-23 07:19:13 +000020std::string llvm::DOT::EscapeString(const std::string &Label) {
21 std::string Str(Label);
22 for (unsigned i = 0; i != Str.length(); ++i)
23 switch (Str[i]) {
24 case '\n':
25 Str.insert(Str.begin()+i, '\\'); // Escape character...
26 ++i;
27 Str[i] = 'n';
28 break;
29 case '\t':
30 Str.insert(Str.begin()+i, ' '); // Convert to two spaces
31 ++i;
32 Str[i] = ' ';
33 break;
34 case '\\':
35 if (i+1 != Str.length())
36 switch (Str[i+1]) {
37 case 'l': continue; // don't disturb \l
38 case '|': case '{': case '}':
39 Str.erase(Str.begin()+i); continue;
40 default: break;
41 }
42 case '{': case '}':
43 case '<': case '>':
44 case '|': case '"':
45 Str.insert(Str.begin()+i, '\\'); // Escape character...
46 ++i; // don't infinite loop
47 break;
48 }
49 return Str;
50}
51
52
53
David Greene00ad26f2009-07-09 17:06:18 +000054void llvm::DisplayGraph(const sys::Path &Filename, bool wait,
55 GraphProgram::Name program) {
Reid Spencer8ea5ecb2006-08-21 06:04:45 +000056 std::string ErrMsg;
Reid Spencer9d5b5322006-06-27 16:49:46 +000057#if HAVE_GRAPHVIZ
58 sys::Path Graphviz(LLVM_PATH_GRAPHVIZ);
59
60 std::vector<const char*> args;
61 args.push_back(Graphviz.c_str());
62 args.push_back(Filename.c_str());
63 args.push_back(0);
64
Chris Lattner103289e2009-08-23 07:19:13 +000065 errs() << "Running 'Graphviz' program... ";
Dan Gohman644801a2010-10-05 15:30:27 +000066 if (sys::Program::ExecuteAndWait(Graphviz, &args[0],0,0,0,0,&ErrMsg)) {
Dan Gohmanc4633162010-10-29 17:03:40 +000067 errs() << "Error: " << ErrMsg << "\n";
Dan Gohman644801a2010-10-05 15:30:27 +000068 return;
69 }
70 Filename.eraseFromDisk();
71 errs() << " done. \n";
David Greene00ad26f2009-07-09 17:06:18 +000072
Dan Gohman48fd5a72010-09-27 16:28:34 +000073#elif HAVE_XDOT_PY
Dan Gohman48fd5a72010-09-27 16:28:34 +000074 std::vector<const char*> args;
75 args.push_back(LLVM_PATH_XDOT_PY);
76 args.push_back(Filename.c_str());
77
78 switch (program) {
79 case GraphProgram::DOT: args.push_back("-f"); args.push_back("dot"); break;
80 case GraphProgram::FDP: args.push_back("-f"); args.push_back("fdp"); break;
81 case GraphProgram::NEATO: args.push_back("-f"); args.push_back("neato");break;
82 case GraphProgram::TWOPI: args.push_back("-f"); args.push_back("twopi");break;
83 case GraphProgram::CIRCO: args.push_back("-f"); args.push_back("circo");break;
84 default: errs() << "Unknown graph layout name; using default.\n";
85 }
86
87 args.push_back(0);
88
89 errs() << "Running 'xdot.py' program... ";
90 if (sys::Program::ExecuteAndWait(sys::Path(LLVM_PATH_XDOT_PY),
Dan Gohman644801a2010-10-05 15:30:27 +000091 &args[0],0,0,0,0,&ErrMsg)) {
Dan Gohmanc4633162010-10-29 17:03:40 +000092 errs() << "Error: " << ErrMsg << "\n";
Dan Gohman644801a2010-10-05 15:30:27 +000093 return;
94 }
95 Filename.eraseFromDisk();
96 errs() << " done. \n";
Dan Gohman48fd5a72010-09-27 16:28:34 +000097
David Greene00ad26f2009-07-09 17:06:18 +000098#elif (HAVE_GV && (HAVE_DOT || HAVE_FDP || HAVE_NEATO || \
99 HAVE_TWOPI || HAVE_CIRCO))
Reid Spencer9d5b5322006-06-27 16:49:46 +0000100 sys::Path PSFilename = Filename;
101 PSFilename.appendSuffix("ps");
David Greene229509a2009-07-08 21:53:41 +0000102
David Greene00ad26f2009-07-09 17:06:18 +0000103 sys::Path prog;
104
105 // Set default grapher
106#if HAVE_CIRCO
107 prog = sys::Path(LLVM_PATH_CIRCO);
108#endif
109#if HAVE_TWOPI
110 prog = sys::Path(LLVM_PATH_TWOPI);
111#endif
112#if HAVE_NEATO
113 prog = sys::Path(LLVM_PATH_NEATO);
114#endif
David Greene229509a2009-07-08 21:53:41 +0000115#if HAVE_FDP
David Greene00ad26f2009-07-09 17:06:18 +0000116 prog = sys::Path(LLVM_PATH_FDP);
117#endif
118#if HAVE_DOT
119 prog = sys::Path(LLVM_PATH_DOT);
120#endif
121
122 // Find which program the user wants
123#if HAVE_DOT
Chris Lattner40ef79d2009-08-23 22:53:53 +0000124 if (program == GraphProgram::DOT)
David Greene00ad26f2009-07-09 17:06:18 +0000125 prog = sys::Path(LLVM_PATH_DOT);
David Greene00ad26f2009-07-09 17:06:18 +0000126#endif
127#if (HAVE_FDP)
Chris Lattner40ef79d2009-08-23 22:53:53 +0000128 if (program == GraphProgram::FDP)
David Greene00ad26f2009-07-09 17:06:18 +0000129 prog = sys::Path(LLVM_PATH_FDP);
David Greene00ad26f2009-07-09 17:06:18 +0000130#endif
131#if (HAVE_NEATO)
Chris Lattner40ef79d2009-08-23 22:53:53 +0000132 if (program == GraphProgram::NEATO)
David Greene00ad26f2009-07-09 17:06:18 +0000133 prog = sys::Path(LLVM_PATH_NEATO);
David Greene00ad26f2009-07-09 17:06:18 +0000134#endif
135#if (HAVE_TWOPI)
Chris Lattner40ef79d2009-08-23 22:53:53 +0000136 if (program == GraphProgram::TWOPI)
David Greene00ad26f2009-07-09 17:06:18 +0000137 prog = sys::Path(LLVM_PATH_TWOPI);
David Greene00ad26f2009-07-09 17:06:18 +0000138#endif
139#if (HAVE_CIRCO)
Chris Lattner40ef79d2009-08-23 22:53:53 +0000140 if (program == GraphProgram::CIRCO)
David Greene00ad26f2009-07-09 17:06:18 +0000141 prog = sys::Path(LLVM_PATH_CIRCO);
David Greene229509a2009-07-08 21:53:41 +0000142#endif
Reid Spencer9d5b5322006-06-27 16:49:46 +0000143
144 std::vector<const char*> args;
David Greene229509a2009-07-08 21:53:41 +0000145 args.push_back(prog.c_str());
Reid Spencer9d5b5322006-06-27 16:49:46 +0000146 args.push_back("-Tps");
147 args.push_back("-Nfontname=Courier");
148 args.push_back("-Gsize=7.5,10");
149 args.push_back(Filename.c_str());
150 args.push_back("-o");
151 args.push_back(PSFilename.c_str());
152 args.push_back(0);
153
Dan Gohman2d5e3ac2009-08-24 03:23:12 +0000154 errs() << "Running '" << prog.str() << "' program... ";
David Greene229509a2009-07-08 21:53:41 +0000155
Chris Lattner40ef79d2009-08-23 22:53:53 +0000156 if (sys::Program::ExecuteAndWait(prog, &args[0], 0, 0, 0, 0, &ErrMsg)) {
Dan Gohmanc4633162010-10-29 17:03:40 +0000157 errs() << "Error: " << ErrMsg << "\n";
Chris Lattner459e13a2010-04-18 03:35:23 +0000158 return;
159 }
160 errs() << " done. \n";
Reid Spencer9d5b5322006-06-27 16:49:46 +0000161
Chris Lattner459e13a2010-04-18 03:35:23 +0000162 sys::Path gv(LLVM_PATH_GV);
163 args.clear();
164 args.push_back(gv.c_str());
165 args.push_back(PSFilename.c_str());
166 args.push_back("--spartan");
167 args.push_back(0);
168
169 ErrMsg.clear();
170 if (wait) {
171 if (sys::Program::ExecuteAndWait(gv, &args[0],0,0,0,0,&ErrMsg))
Dan Gohmanc4633162010-10-29 17:03:40 +0000172 errs() << "Error: " << ErrMsg << "\n";
Chris Lattner459e13a2010-04-18 03:35:23 +0000173 Filename.eraseFromDisk();
174 PSFilename.eraseFromDisk();
175 }
176 else {
177 sys::Program::ExecuteNoWait(gv, &args[0],0,0,0,&ErrMsg);
178 errs() << "Remember to erase graph files: " << Filename.str() << " "
179 << PSFilename.str() << "\n";
Reid Spencer9d5b5322006-06-27 16:49:46 +0000180 }
Reid Spencer9d5b5322006-06-27 16:49:46 +0000181#elif HAVE_DOTTY
182 sys::Path dotty(LLVM_PATH_DOTTY);
183
184 std::vector<const char*> args;
Chris Lattner82493282007-05-03 18:32:10 +0000185 args.push_back(dotty.c_str());
Reid Spencer9d5b5322006-06-27 16:49:46 +0000186 args.push_back(Filename.c_str());
187 args.push_back(0);
188
Chris Lattner103289e2009-08-23 07:19:13 +0000189 errs() << "Running 'dotty' program... ";
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000190 if (sys::Program::ExecuteAndWait(dotty, &args[0],0,0,0,0,&ErrMsg)) {
Dan Gohmanc4633162010-10-29 17:03:40 +0000191 errs() << "Error: " << ErrMsg << "\n";
Reid Spencer9d5b5322006-06-27 16:49:46 +0000192 } else {
Chris Lattner7c57b7b2010-04-13 04:35:39 +0000193// Dotty spawns another app and doesn't wait until it returns
194#if defined (__MINGW32__) || defined (_WINDOWS)
Reid Spencer9d5b5322006-06-27 16:49:46 +0000195 return;
196#endif
David Greene229509a2009-07-08 21:53:41 +0000197 Filename.eraseFromDisk();
Reid Spencer9d5b5322006-06-27 16:49:46 +0000198 }
199#endif
Reid Spencer9d5b5322006-06-27 16:49:46 +0000200}