1321369Sdim//===- GraphWriter.cpp - Implements GraphWriter support routines ----------===// 2193323Sed// 3353358Sdim// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4353358Sdim// See https://llvm.org/LICENSE.txt for license information. 5353358Sdim// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6193323Sed// 7193323Sed//===----------------------------------------------------------------------===// 8193323Sed// 9193323Sed// This file implements misc. GraphWriter support routines. 10193323Sed// 11193323Sed//===----------------------------------------------------------------------===// 12193323Sed 13249423Sdim#include "llvm/Support/GraphWriter.h" 14321369Sdim#include "llvm/ADT/SmallString.h" 15321369Sdim#include "llvm/ADT/SmallVector.h" 16321369Sdim#include "llvm/ADT/StringRef.h" 17249423Sdim#include "llvm/Config/config.h" 18234353Sdim#include "llvm/Support/CommandLine.h" 19321369Sdim#include "llvm/Support/Compiler.h" 20321369Sdim#include "llvm/Support/ErrorHandling.h" 21321369Sdim#include "llvm/Support/ErrorOr.h" 22261991Sdim#include "llvm/Support/FileSystem.h" 23218893Sdim#include "llvm/Support/Program.h" 24321369Sdim#include "llvm/Support/raw_ostream.h" 25321369Sdim#include <cassert> 26321369Sdim#include <system_error> 27321369Sdim#include <string> 28321369Sdim#include <vector> 29321369Sdim 30193323Sedusing namespace llvm; 31193323Sed 32234353Sdimstatic cl::opt<bool> ViewBackground("view-background", cl::Hidden, 33234353Sdim cl::desc("Execute graph viewer in the background. Creates tmp file litter.")); 34234353Sdim 35198090Srdivackystd::string llvm::DOT::EscapeString(const std::string &Label) { 36198090Srdivacky std::string Str(Label); 37198090Srdivacky for (unsigned i = 0; i != Str.length(); ++i) 38198090Srdivacky switch (Str[i]) { 39198090Srdivacky case '\n': 40198090Srdivacky Str.insert(Str.begin()+i, '\\'); // Escape character... 41198090Srdivacky ++i; 42198090Srdivacky Str[i] = 'n'; 43198090Srdivacky break; 44198090Srdivacky case '\t': 45198090Srdivacky Str.insert(Str.begin()+i, ' '); // Convert to two spaces 46198090Srdivacky ++i; 47198090Srdivacky Str[i] = ' '; 48198090Srdivacky break; 49198090Srdivacky case '\\': 50198090Srdivacky if (i+1 != Str.length()) 51198090Srdivacky switch (Str[i+1]) { 52198090Srdivacky case 'l': continue; // don't disturb \l 53198090Srdivacky case '|': case '{': case '}': 54198090Srdivacky Str.erase(Str.begin()+i); continue; 55198090Srdivacky default: break; 56198090Srdivacky } 57321369Sdim LLVM_FALLTHROUGH; 58198090Srdivacky case '{': case '}': 59198090Srdivacky case '<': case '>': 60198090Srdivacky case '|': case '"': 61198090Srdivacky Str.insert(Str.begin()+i, '\\'); // Escape character... 62198090Srdivacky ++i; // don't infinite loop 63198090Srdivacky break; 64198090Srdivacky } 65198090Srdivacky return Str; 66198090Srdivacky} 67198090Srdivacky 68341825Sdim/// Get a color string for this node number. Simply round-robin selects 69249423Sdim/// from a reasonable number of colors. 70249423SdimStringRef llvm::DOT::getColorString(unsigned ColorNumber) { 71249423Sdim static const int NumColors = 20; 72249423Sdim static const char* Colors[NumColors] = { 73249423Sdim "aaaaaa", "aa0000", "00aa00", "aa5500", "0055ff", "aa00aa", "00aaaa", 74249423Sdim "555555", "ff5555", "55ff55", "ffff55", "5555ff", "ff55ff", "55ffff", 75249423Sdim "ffaaaa", "aaffaa", "ffffaa", "aaaaff", "ffaaff", "aaffff"}; 76249423Sdim return Colors[ColorNumber % NumColors]; 77249423Sdim} 78249423Sdim 79261991Sdimstd::string llvm::createGraphFilename(const Twine &Name, int &FD) { 80261991Sdim FD = -1; 81261991Sdim SmallString<128> Filename; 82276479Sdim std::error_code EC = sys::fs::createTemporaryFile(Name, "dot", FD, Filename); 83261991Sdim if (EC) { 84261991Sdim errs() << "Error: " << EC.message() << "\n"; 85261991Sdim return ""; 86261991Sdim } 87261991Sdim 88261991Sdim errs() << "Writing '" << Filename << "'... "; 89261991Sdim return Filename.str(); 90261991Sdim} 91261991Sdim 92276479Sdim// Execute the graph viewer. Return true if there were errors. 93341825Sdimstatic bool ExecGraphViewer(StringRef ExecPath, std::vector<StringRef> &args, 94276479Sdim StringRef Filename, bool wait, 95276479Sdim std::string &ErrMsg) { 96234353Sdim if (wait) { 97341825Sdim if (sys::ExecuteAndWait(ExecPath, args, None, {}, 0, 0, &ErrMsg)) { 98234353Sdim errs() << "Error: " << ErrMsg << "\n"; 99276479Sdim return true; 100234353Sdim } 101276479Sdim sys::fs::remove(Filename); 102234353Sdim errs() << " done. \n"; 103276479Sdim } else { 104341825Sdim sys::ExecuteNoWait(ExecPath, args, None, {}, 0, &ErrMsg); 105288943Sdim errs() << "Remember to erase graph file: " << Filename << "\n"; 106234353Sdim } 107276479Sdim return false; 108234353Sdim} 109198090Srdivacky 110288943Sdimnamespace { 111321369Sdim 112276479Sdimstruct GraphSession { 113276479Sdim std::string LogBuffer; 114321369Sdim 115276479Sdim bool TryFindProgram(StringRef Names, std::string &ProgramPath) { 116276479Sdim raw_string_ostream Log(LogBuffer); 117276479Sdim SmallVector<StringRef, 8> parts; 118296417Sdim Names.split(parts, '|'); 119276479Sdim for (auto Name : parts) { 120280031Sdim if (ErrorOr<std::string> P = sys::findProgramByName(Name)) { 121280031Sdim ProgramPath = *P; 122276479Sdim return true; 123280031Sdim } 124276479Sdim Log << " Tried '" << Name << "'\n"; 125276479Sdim } 126276479Sdim return false; 127276479Sdim } 128276479Sdim}; 129276479Sdim 130321369Sdim} // end anonymous namespace 131321369Sdim 132276479Sdimstatic const char *getProgramName(GraphProgram::Name program) { 133276479Sdim switch (program) { 134276479Sdim case GraphProgram::DOT: 135276479Sdim return "dot"; 136276479Sdim case GraphProgram::FDP: 137276479Sdim return "fdp"; 138276479Sdim case GraphProgram::NEATO: 139276479Sdim return "neato"; 140276479Sdim case GraphProgram::TWOPI: 141276479Sdim return "twopi"; 142276479Sdim case GraphProgram::CIRCO: 143276479Sdim return "circo"; 144276479Sdim } 145276479Sdim llvm_unreachable("bad kind"); 146276479Sdim} 147276479Sdim 148276479Sdimbool llvm::DisplayGraph(StringRef FilenameRef, bool wait, 149198090Srdivacky GraphProgram::Name program) { 150261991Sdim std::string Filename = FilenameRef; 151193323Sed std::string ErrMsg; 152276479Sdim std::string ViewerPath; 153276479Sdim GraphSession S; 154193323Sed 155288943Sdim#ifdef __APPLE__ 156288943Sdim wait &= !ViewBackground; 157288943Sdim if (S.TryFindProgram("open", ViewerPath)) { 158341825Sdim std::vector<StringRef> args; 159341825Sdim args.push_back(ViewerPath); 160288943Sdim if (wait) 161288943Sdim args.push_back("-W"); 162341825Sdim args.push_back(Filename); 163288943Sdim errs() << "Trying 'open' program... "; 164288943Sdim if (!ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg)) 165288943Sdim return false; 166288943Sdim } 167288943Sdim#endif 168288943Sdim if (S.TryFindProgram("xdg-open", ViewerPath)) { 169341825Sdim std::vector<StringRef> args; 170341825Sdim args.push_back(ViewerPath); 171341825Sdim args.push_back(Filename); 172288943Sdim errs() << "Trying 'xdg-open' program... "; 173288943Sdim if (!ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg)) 174288943Sdim return false; 175288943Sdim } 176288943Sdim 177276479Sdim // Graphviz 178276479Sdim if (S.TryFindProgram("Graphviz", ViewerPath)) { 179341825Sdim std::vector<StringRef> args; 180341825Sdim args.push_back(ViewerPath); 181341825Sdim args.push_back(Filename); 182234353Sdim 183276479Sdim errs() << "Running 'Graphviz' program... "; 184276479Sdim return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg); 185218893Sdim } 186234353Sdim 187276479Sdim // xdot 188276479Sdim if (S.TryFindProgram("xdot|xdot.py", ViewerPath)) { 189341825Sdim std::vector<StringRef> args; 190341825Sdim args.push_back(ViewerPath); 191341825Sdim args.push_back(Filename); 192218893Sdim 193276479Sdim args.push_back("-f"); 194276479Sdim args.push_back(getProgramName(program)); 195218893Sdim 196276479Sdim errs() << "Running 'xdot.py' program... "; 197276479Sdim return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg); 198276479Sdim } 199198090Srdivacky 200296417Sdim enum ViewerKind { 201296417Sdim VK_None, 202296417Sdim VK_OSXOpen, 203296417Sdim VK_XDGOpen, 204296417Sdim VK_Ghostview, 205296417Sdim VK_CmdStart 206296417Sdim }; 207296417Sdim ViewerKind Viewer = VK_None; 208276479Sdim#ifdef __APPLE__ 209296417Sdim if (!Viewer && S.TryFindProgram("open", ViewerPath)) 210296417Sdim Viewer = VK_OSXOpen; 211198090Srdivacky#endif 212296417Sdim if (!Viewer && S.TryFindProgram("gv", ViewerPath)) 213296417Sdim Viewer = VK_Ghostview; 214296417Sdim if (!Viewer && S.TryFindProgram("xdg-open", ViewerPath)) 215296417Sdim Viewer = VK_XDGOpen; 216341825Sdim#ifdef _WIN32 217296417Sdim if (!Viewer && S.TryFindProgram("cmd", ViewerPath)) { 218296417Sdim Viewer = VK_CmdStart; 219296417Sdim } 220296417Sdim#endif 221198090Srdivacky 222296417Sdim // PostScript or PDF graph generator + PostScript/PDF viewer 223276479Sdim std::string GeneratorPath; 224296417Sdim if (Viewer && 225276479Sdim (S.TryFindProgram(getProgramName(program), GeneratorPath) || 226276479Sdim S.TryFindProgram("dot|fdp|neato|twopi|circo", GeneratorPath))) { 227296417Sdim std::string OutputFilename = 228296417Sdim Filename + (Viewer == VK_CmdStart ? ".pdf" : ".ps"); 229234353Sdim 230341825Sdim std::vector<StringRef> args; 231341825Sdim args.push_back(GeneratorPath); 232296417Sdim if (Viewer == VK_CmdStart) 233296417Sdim args.push_back("-Tpdf"); 234296417Sdim else 235296417Sdim args.push_back("-Tps"); 236276479Sdim args.push_back("-Nfontname=Courier"); 237276479Sdim args.push_back("-Gsize=7.5,10"); 238341825Sdim args.push_back(Filename); 239276479Sdim args.push_back("-o"); 240341825Sdim args.push_back(OutputFilename); 241198090Srdivacky 242276479Sdim errs() << "Running '" << GeneratorPath << "' program... "; 243193323Sed 244296417Sdim if (ExecGraphViewer(GeneratorPath, args, Filename, true, ErrMsg)) 245276479Sdim return true; 246234353Sdim 247296417Sdim // The lifetime of StartArg must include the call of ExecGraphViewer 248296417Sdim // because the args are passed as vector of char*. 249296417Sdim std::string StartArg; 250296417Sdim 251276479Sdim args.clear(); 252341825Sdim args.push_back(ViewerPath); 253296417Sdim switch (Viewer) { 254296417Sdim case VK_OSXOpen: 255276479Sdim args.push_back("-W"); 256341825Sdim args.push_back(OutputFilename); 257276479Sdim break; 258296417Sdim case VK_XDGOpen: 259276479Sdim wait = false; 260341825Sdim args.push_back(OutputFilename); 261276479Sdim break; 262296417Sdim case VK_Ghostview: 263276479Sdim args.push_back("--spartan"); 264341825Sdim args.push_back(OutputFilename); 265276479Sdim break; 266296417Sdim case VK_CmdStart: 267296417Sdim args.push_back("/S"); 268296417Sdim args.push_back("/C"); 269296417Sdim StartArg = 270296417Sdim (StringRef("start ") + (wait ? "/WAIT " : "") + OutputFilename).str(); 271341825Sdim args.push_back(StartArg); 272296417Sdim break; 273296417Sdim case VK_None: 274276479Sdim llvm_unreachable("Invalid viewer"); 275276479Sdim } 276234353Sdim 277276479Sdim ErrMsg.clear(); 278296417Sdim return ExecGraphViewer(ViewerPath, args, OutputFilename, wait, ErrMsg); 279276479Sdim } 280193323Sed 281276479Sdim // dotty 282276479Sdim if (S.TryFindProgram("dotty", ViewerPath)) { 283341825Sdim std::vector<StringRef> args; 284341825Sdim args.push_back(ViewerPath); 285341825Sdim args.push_back(Filename); 286234353Sdim 287207618Srdivacky// Dotty spawns another app and doesn't wait until it returns 288341825Sdim#ifdef _WIN32 289276479Sdim wait = false; 290234353Sdim#endif 291276479Sdim errs() << "Running 'dotty' program... "; 292276479Sdim return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg); 293276479Sdim } 294276479Sdim 295276479Sdim errs() << "Error: Couldn't find a usable graph viewer program:\n"; 296276479Sdim errs() << S.LogBuffer << "\n"; 297276479Sdim return true; 298193323Sed} 299