1 //===-- GraphWriter.cpp - Implements GraphWriter support routines ---------===//
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 implements misc. GraphWriter support routines.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/Support/GraphWriter.h"
15 #include "llvm/Config/config.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Support/FileSystem.h"
18 #include "llvm/Support/Program.h"
19 using namespace llvm;
20 
21 static cl::opt<bool> ViewBackground("view-background", cl::Hidden,
22   cl::desc("Execute graph viewer in the background. Creates tmp file litter."));
23 
EscapeString(const std::string & Label)24 std::string llvm::DOT::EscapeString(const std::string &Label) {
25   std::string Str(Label);
26   for (unsigned i = 0; i != Str.length(); ++i)
27   switch (Str[i]) {
28     case '\n':
29       Str.insert(Str.begin()+i, '\\');  // Escape character...
30       ++i;
31       Str[i] = 'n';
32       break;
33     case '\t':
34       Str.insert(Str.begin()+i, ' ');  // Convert to two spaces
35       ++i;
36       Str[i] = ' ';
37       break;
38     case '\\':
39       if (i+1 != Str.length())
40         switch (Str[i+1]) {
41           case 'l': continue; // don't disturb \l
42           case '|': case '{': case '}':
43             Str.erase(Str.begin()+i); continue;
44           default: break;
45         }
46     case '{': case '}':
47     case '<': case '>':
48     case '|': case '"':
49       Str.insert(Str.begin()+i, '\\');  // Escape character...
50       ++i;  // don't infinite loop
51       break;
52   }
53   return Str;
54 }
55 
56 /// \brief Get a color string for this node number. Simply round-robin selects
57 /// from a reasonable number of colors.
getColorString(unsigned ColorNumber)58 StringRef llvm::DOT::getColorString(unsigned ColorNumber) {
59   static const int NumColors = 20;
60   static const char* Colors[NumColors] = {
61     "aaaaaa", "aa0000", "00aa00", "aa5500", "0055ff", "aa00aa", "00aaaa",
62     "555555", "ff5555", "55ff55", "ffff55", "5555ff", "ff55ff", "55ffff",
63     "ffaaaa", "aaffaa", "ffffaa", "aaaaff", "ffaaff", "aaffff"};
64   return Colors[ColorNumber % NumColors];
65 }
66 
createGraphFilename(const Twine & Name,int & FD)67 std::string llvm::createGraphFilename(const Twine &Name, int &FD) {
68   FD = -1;
69   SmallString<128> Filename;
70   std::error_code EC = sys::fs::createTemporaryFile(Name, "dot", FD, Filename);
71   if (EC) {
72     errs() << "Error: " << EC.message() << "\n";
73     return "";
74   }
75 
76   errs() << "Writing '" << Filename << "'... ";
77   return Filename.str();
78 }
79 
80 // Execute the graph viewer. Return true if there were errors.
ExecGraphViewer(StringRef ExecPath,std::vector<const char * > & args,StringRef Filename,bool wait,std::string & ErrMsg)81 static bool ExecGraphViewer(StringRef ExecPath, std::vector<const char *> &args,
82                             StringRef Filename, bool wait,
83                             std::string &ErrMsg) {
84   assert(args.back() == nullptr);
85   if (wait) {
86     if (sys::ExecuteAndWait(ExecPath, args.data(), nullptr, nullptr, 0, 0,
87                             &ErrMsg)) {
88       errs() << "Error: " << ErrMsg << "\n";
89       return true;
90     }
91     sys::fs::remove(Filename);
92     errs() << " done. \n";
93   } else {
94     sys::ExecuteNoWait(ExecPath, args.data(), nullptr, nullptr, 0, &ErrMsg);
95     errs() << "Remember to erase graph file: " << Filename << "\n";
96   }
97   return false;
98 }
99 
100 namespace {
101 struct GraphSession {
102   std::string LogBuffer;
TryFindProgram__anon19a2f42d0111::GraphSession103   bool TryFindProgram(StringRef Names, std::string &ProgramPath) {
104     raw_string_ostream Log(LogBuffer);
105     SmallVector<StringRef, 8> parts;
106     Names.split(parts, '|');
107     for (auto Name : parts) {
108       if (ErrorOr<std::string> P = sys::findProgramByName(Name)) {
109         ProgramPath = *P;
110         return true;
111       }
112       Log << "  Tried '" << Name << "'\n";
113     }
114     return false;
115   }
116 };
117 } // namespace
118 
getProgramName(GraphProgram::Name program)119 static const char *getProgramName(GraphProgram::Name program) {
120   switch (program) {
121   case GraphProgram::DOT:
122     return "dot";
123   case GraphProgram::FDP:
124     return "fdp";
125   case GraphProgram::NEATO:
126     return "neato";
127   case GraphProgram::TWOPI:
128     return "twopi";
129   case GraphProgram::CIRCO:
130     return "circo";
131   }
132   llvm_unreachable("bad kind");
133 }
134 
DisplayGraph(StringRef FilenameRef,bool wait,GraphProgram::Name program)135 bool llvm::DisplayGraph(StringRef FilenameRef, bool wait,
136                         GraphProgram::Name program) {
137   std::string Filename = FilenameRef;
138   std::string ErrMsg;
139   std::string ViewerPath;
140   GraphSession S;
141 
142 #ifdef __APPLE__
143   wait &= !ViewBackground;
144   if (S.TryFindProgram("open", ViewerPath)) {
145     std::vector<const char *> args;
146     args.push_back(ViewerPath.c_str());
147     if (wait)
148       args.push_back("-W");
149     args.push_back(Filename.c_str());
150     args.push_back(nullptr);
151     errs() << "Trying 'open' program... ";
152     if (!ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg))
153       return false;
154   }
155 #endif
156   if (S.TryFindProgram("xdg-open", ViewerPath)) {
157     std::vector<const char *> args;
158     args.push_back(ViewerPath.c_str());
159     args.push_back(Filename.c_str());
160     args.push_back(nullptr);
161     errs() << "Trying 'xdg-open' program... ";
162     if (!ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg))
163       return false;
164   }
165 
166   // Graphviz
167   if (S.TryFindProgram("Graphviz", ViewerPath)) {
168     std::vector<const char *> args;
169     args.push_back(ViewerPath.c_str());
170     args.push_back(Filename.c_str());
171     args.push_back(nullptr);
172 
173     errs() << "Running 'Graphviz' program... ";
174     return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
175   }
176 
177   // xdot
178   if (S.TryFindProgram("xdot|xdot.py", ViewerPath)) {
179     std::vector<const char *> args;
180     args.push_back(ViewerPath.c_str());
181     args.push_back(Filename.c_str());
182 
183     args.push_back("-f");
184     args.push_back(getProgramName(program));
185 
186     args.push_back(nullptr);
187 
188     errs() << "Running 'xdot.py' program... ";
189     return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
190   }
191 
192   enum ViewerKind {
193     VK_None,
194     VK_OSXOpen,
195     VK_XDGOpen,
196     VK_Ghostview,
197     VK_CmdStart
198   };
199   ViewerKind Viewer = VK_None;
200 #ifdef __APPLE__
201   if (!Viewer && S.TryFindProgram("open", ViewerPath))
202     Viewer = VK_OSXOpen;
203 #endif
204   if (!Viewer && S.TryFindProgram("gv", ViewerPath))
205     Viewer = VK_Ghostview;
206   if (!Viewer && S.TryFindProgram("xdg-open", ViewerPath))
207     Viewer = VK_XDGOpen;
208 #ifdef LLVM_ON_WIN32
209   if (!Viewer && S.TryFindProgram("cmd", ViewerPath)) {
210     Viewer = VK_CmdStart;
211   }
212 #endif
213 
214   // PostScript or PDF graph generator + PostScript/PDF viewer
215   std::string GeneratorPath;
216   if (Viewer &&
217       (S.TryFindProgram(getProgramName(program), GeneratorPath) ||
218        S.TryFindProgram("dot|fdp|neato|twopi|circo", GeneratorPath))) {
219     std::string OutputFilename =
220         Filename + (Viewer == VK_CmdStart ? ".pdf" : ".ps");
221 
222     std::vector<const char *> args;
223     args.push_back(GeneratorPath.c_str());
224     if (Viewer == VK_CmdStart)
225       args.push_back("-Tpdf");
226     else
227       args.push_back("-Tps");
228     args.push_back("-Nfontname=Courier");
229     args.push_back("-Gsize=7.5,10");
230     args.push_back(Filename.c_str());
231     args.push_back("-o");
232     args.push_back(OutputFilename.c_str());
233     args.push_back(nullptr);
234 
235     errs() << "Running '" << GeneratorPath << "' program... ";
236 
237     if (ExecGraphViewer(GeneratorPath, args, Filename, true, ErrMsg))
238       return true;
239 
240     // The lifetime of StartArg must include the call of ExecGraphViewer
241     // because the args are passed as vector of char*.
242     std::string StartArg;
243 
244     args.clear();
245     args.push_back(ViewerPath.c_str());
246     switch (Viewer) {
247     case VK_OSXOpen:
248       args.push_back("-W");
249       args.push_back(OutputFilename.c_str());
250       break;
251     case VK_XDGOpen:
252       wait = false;
253       args.push_back(OutputFilename.c_str());
254       break;
255     case VK_Ghostview:
256       args.push_back("--spartan");
257       args.push_back(OutputFilename.c_str());
258       break;
259     case VK_CmdStart:
260       args.push_back("/S");
261       args.push_back("/C");
262       StartArg =
263           (StringRef("start ") + (wait ? "/WAIT " : "") + OutputFilename).str();
264       args.push_back(StartArg.c_str());
265       break;
266     case VK_None:
267       llvm_unreachable("Invalid viewer");
268     }
269     args.push_back(nullptr);
270 
271     ErrMsg.clear();
272     return ExecGraphViewer(ViewerPath, args, OutputFilename, wait, ErrMsg);
273   }
274 
275   // dotty
276   if (S.TryFindProgram("dotty", ViewerPath)) {
277     std::vector<const char *> args;
278     args.push_back(ViewerPath.c_str());
279     args.push_back(Filename.c_str());
280     args.push_back(nullptr);
281 
282 // Dotty spawns another app and doesn't wait until it returns
283 #ifdef LLVM_ON_WIN32
284     wait = false;
285 #endif
286     errs() << "Running 'dotty' program... ";
287     return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
288   }
289 
290   errs() << "Error: Couldn't find a usable graph viewer program:\n";
291   errs() << S.LogBuffer << "\n";
292   return true;
293 }
294