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/Path.h" 19 #include "llvm/Support/Program.h" 20 using namespace llvm; 21 22 static cl::opt<bool> ViewBackground("view-background", cl::Hidden, 23 cl::desc("Execute graph viewer in the background. Creates tmp file litter.")); 24 25 std::string llvm::DOT::EscapeString(const std::string &Label) { 26 std::string Str(Label); 27 for (unsigned i = 0; i != Str.length(); ++i) 28 switch (Str[i]) { 29 case '\n': 30 Str.insert(Str.begin()+i, '\\'); // Escape character... 31 ++i; 32 Str[i] = 'n'; 33 break; 34 case '\t': 35 Str.insert(Str.begin()+i, ' '); // Convert to two spaces 36 ++i; 37 Str[i] = ' '; 38 break; 39 case '\\': 40 if (i+1 != Str.length()) 41 switch (Str[i+1]) { 42 case 'l': continue; // don't disturb \l 43 case '|': case '{': case '}': 44 Str.erase(Str.begin()+i); continue; 45 default: break; 46 } 47 case '{': case '}': 48 case '<': case '>': 49 case '|': case '"': 50 Str.insert(Str.begin()+i, '\\'); // Escape character... 51 ++i; // don't infinite loop 52 break; 53 } 54 return Str; 55 } 56 57 /// \brief Get a color string for this node number. Simply round-robin selects 58 /// from a reasonable number of colors. 59 StringRef llvm::DOT::getColorString(unsigned ColorNumber) { 60 static const int NumColors = 20; 61 static const char* Colors[NumColors] = { 62 "aaaaaa", "aa0000", "00aa00", "aa5500", "0055ff", "aa00aa", "00aaaa", 63 "555555", "ff5555", "55ff55", "ffff55", "5555ff", "ff55ff", "55ffff", 64 "ffaaaa", "aaffaa", "ffffaa", "aaaaff", "ffaaff", "aaffff"}; 65 return Colors[ColorNumber % NumColors]; 66 } 67 68 std::string llvm::createGraphFilename(const Twine &Name, int &FD) { 69 FD = -1; 70 SmallString<128> Filename; 71 std::error_code EC = sys::fs::createTemporaryFile(Name, "dot", FD, Filename); 72 if (EC) { 73 errs() << "Error: " << EC.message() << "\n"; 74 return ""; 75 } 76 77 errs() << "Writing '" << Filename << "'... "; 78 return Filename.str(); 79 } 80 81 // Execute the graph viewer. Return true if there were errors. 82 static bool ExecGraphViewer(StringRef ExecPath, std::vector<const char *> &args, 83 StringRef Filename, bool wait, 84 std::string &ErrMsg) { 85 assert(args.back() == nullptr); 86 if (wait) { 87 if (sys::ExecuteAndWait(ExecPath, args.data(), nullptr, nullptr, 0, 0, 88 &ErrMsg)) { 89 errs() << "Error: " << ErrMsg << "\n"; 90 return true; 91 } 92 sys::fs::remove(Filename); 93 errs() << " done. \n"; 94 } else { 95 sys::ExecuteNoWait(ExecPath, args.data(), nullptr, nullptr, 0, &ErrMsg); 96 errs() << "Remember to erase graph file: " << Filename.str() << "\n"; 97 } 98 return false; 99 } 100 101 struct GraphSession { 102 std::string LogBuffer; 103 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 118 static const char *getProgramName(GraphProgram::Name program) { 119 switch (program) { 120 case GraphProgram::DOT: 121 return "dot"; 122 case GraphProgram::FDP: 123 return "fdp"; 124 case GraphProgram::NEATO: 125 return "neato"; 126 case GraphProgram::TWOPI: 127 return "twopi"; 128 case GraphProgram::CIRCO: 129 return "circo"; 130 } 131 llvm_unreachable("bad kind"); 132 } 133 134 bool llvm::DisplayGraph(StringRef FilenameRef, bool wait, 135 GraphProgram::Name program) { 136 std::string Filename = FilenameRef; 137 wait &= !ViewBackground; 138 std::string ErrMsg; 139 std::string ViewerPath; 140 GraphSession S; 141 142 // Graphviz 143 if (S.TryFindProgram("Graphviz", ViewerPath)) { 144 std::vector<const char *> args; 145 args.push_back(ViewerPath.c_str()); 146 args.push_back(Filename.c_str()); 147 args.push_back(nullptr); 148 149 errs() << "Running 'Graphviz' program... "; 150 return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg); 151 } 152 153 // xdot 154 if (S.TryFindProgram("xdot|xdot.py", ViewerPath)) { 155 std::vector<const char *> args; 156 args.push_back(ViewerPath.c_str()); 157 args.push_back(Filename.c_str()); 158 159 args.push_back("-f"); 160 args.push_back(getProgramName(program)); 161 162 args.push_back(nullptr); 163 164 errs() << "Running 'xdot.py' program... "; 165 return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg); 166 } 167 168 enum PSViewerKind { PSV_None, PSV_OSXOpen, PSV_XDGOpen, PSV_Ghostview }; 169 PSViewerKind PSViewer = PSV_None; 170 #ifdef __APPLE__ 171 if (!PSViewer && S.TryFindProgram("open", ViewerPath)) 172 PSViewer = PSV_OSXOpen; 173 #endif 174 if (!PSViewer && S.TryFindProgram("gv", ViewerPath)) 175 PSViewer = PSV_Ghostview; 176 if (!PSViewer && S.TryFindProgram("xdg-open", ViewerPath)) 177 PSViewer = PSV_XDGOpen; 178 179 // PostScript graph generator + PostScript viewer 180 std::string GeneratorPath; 181 if (PSViewer && 182 (S.TryFindProgram(getProgramName(program), GeneratorPath) || 183 S.TryFindProgram("dot|fdp|neato|twopi|circo", GeneratorPath))) { 184 std::string PSFilename = Filename + ".ps"; 185 186 std::vector<const char *> args; 187 args.push_back(GeneratorPath.c_str()); 188 args.push_back("-Tps"); 189 args.push_back("-Nfontname=Courier"); 190 args.push_back("-Gsize=7.5,10"); 191 args.push_back(Filename.c_str()); 192 args.push_back("-o"); 193 args.push_back(PSFilename.c_str()); 194 args.push_back(nullptr); 195 196 errs() << "Running '" << GeneratorPath << "' program... "; 197 198 if (ExecGraphViewer(GeneratorPath, args, Filename, wait, ErrMsg)) 199 return true; 200 201 args.clear(); 202 args.push_back(ViewerPath.c_str()); 203 switch (PSViewer) { 204 case PSV_OSXOpen: 205 args.push_back("-W"); 206 args.push_back(PSFilename.c_str()); 207 break; 208 case PSV_XDGOpen: 209 wait = false; 210 args.push_back(PSFilename.c_str()); 211 break; 212 case PSV_Ghostview: 213 args.push_back("--spartan"); 214 args.push_back(PSFilename.c_str()); 215 break; 216 case PSV_None: 217 llvm_unreachable("Invalid viewer"); 218 } 219 args.push_back(nullptr); 220 221 ErrMsg.clear(); 222 return ExecGraphViewer(ViewerPath, args, PSFilename, wait, ErrMsg); 223 } 224 225 // dotty 226 if (S.TryFindProgram("dotty", ViewerPath)) { 227 std::vector<const char *> args; 228 args.push_back(ViewerPath.c_str()); 229 args.push_back(Filename.c_str()); 230 args.push_back(nullptr); 231 232 // Dotty spawns another app and doesn't wait until it returns 233 #ifdef LLVM_ON_WIN32 234 wait = false; 235 #endif 236 errs() << "Running 'dotty' program... "; 237 return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg); 238 } 239 240 errs() << "Error: Couldn't find a usable graph viewer program:\n"; 241 errs() << S.LogBuffer << "\n"; 242 return true; 243 } 244