lib/Support/GraphWriter.cpp

   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       ProgramPath = sys::FindProgramByName(Name);
 109       if (!ProgramPath.empty())
 110         return true;
 111       Log << "  Tried '" << Name << "'\n";
 112     }
 113     return false;
 114   }
 115 };
 116
 117 static const char *getProgramName(GraphProgram::Name program) {
 118   switch (program) {
 119   case GraphProgram::DOT:
 120     return "dot";
 121   case GraphProgram::FDP:
 122     return "fdp";
 123   case GraphProgram::NEATO:
 124     return "neato";
 125   case GraphProgram::TWOPI:
 126     return "twopi";
 127   case GraphProgram::CIRCO:
 128     return "circo";
 129   }
 130   llvm_unreachable("bad kind");
 131 }
 132
 133 bool llvm::DisplayGraph(StringRef FilenameRef, bool wait,
 134                         GraphProgram::Name program) {
 135   std::string Filename = FilenameRef;
 136   wait &= !ViewBackground;
 137   std::string ErrMsg;
 138   std::string ViewerPath;
 139   GraphSession S;
 140
 141   // Graphviz
 142   if (S.TryFindProgram("Graphviz", ViewerPath)) {
 143     std::vector<const char *> args;
 144     args.push_back(ViewerPath.c_str());
 145     args.push_back(Filename.c_str());
 146     args.push_back(nullptr);
 147
 148     errs() << "Running 'Graphviz' program... ";
 149     return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
 150   }
 151
 152   // xdot
 153   if (S.TryFindProgram("xdot|xdot.py", ViewerPath)) {
 154     std::vector<const char *> args;
 155     args.push_back(ViewerPath.c_str());
 156     args.push_back(Filename.c_str());
 157
 158     args.push_back("-f");
 159     args.push_back(getProgramName(program));
 160
 161     args.push_back(nullptr);
 162
 163     errs() << "Running 'xdot.py' program... ";
 164     return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
 165   }
 166
 167   enum PSViewerKind { PSV_None, PSV_OSXOpen, PSV_XDGOpen, PSV_Ghostview };
 168   PSViewerKind PSViewer = PSV_None;
 169 #ifdef __APPLE__
 170   if (!PSViewer && S.TryFindProgram("open", ViewerPath))
 171     PSViewer = PSV_OSXOpen;
 172 #endif
 173   if (!PSViewer && S.TryFindProgram("gv", ViewerPath))
 174     PSViewer = PSV_Ghostview;
 175   if (!PSViewer && S.TryFindProgram("xdg-open", ViewerPath))
 176     PSViewer = PSV_XDGOpen;
 177
 178   // PostScript graph generator + PostScript viewer
 179   std::string GeneratorPath;
 180   if (PSViewer &&
 181       (S.TryFindProgram(getProgramName(program), GeneratorPath) ||
 182        S.TryFindProgram("dot|fdp|neato|twopi|circo", GeneratorPath))) {
 183     std::string PSFilename = Filename + ".ps";
 184
 185     std::vector<const char *> args;
 186     args.push_back(GeneratorPath.c_str());
 187     args.push_back("-Tps");
 188     args.push_back("-Nfontname=Courier");
 189     args.push_back("-Gsize=7.5,10");
 190     args.push_back(Filename.c_str());
 191     args.push_back("-o");
 192     args.push_back(PSFilename.c_str());
 193     args.push_back(nullptr);
 194
 195     errs() << "Running '" << GeneratorPath << "' program... ";
 196
 197     if (ExecGraphViewer(GeneratorPath, args, Filename, wait, ErrMsg))
 198       return true;
 199
 200     args.clear();
 201     args.push_back(ViewerPath.c_str());
 202     switch (PSViewer) {
 203     case PSV_OSXOpen:
 204       args.push_back("-W");
 205       args.push_back(PSFilename.c_str());
 206       break;
 207     case PSV_XDGOpen:
 208       wait = false;
 209       args.push_back(PSFilename.c_str());
 210       break;
 211     case PSV_Ghostview:
 212       args.push_back("--spartan");
 213       args.push_back(PSFilename.c_str());
 214       break;
 215     case PSV_None:
 216       llvm_unreachable("Invalid viewer");
 217     }
 218     args.push_back(nullptr);
 219
 220     ErrMsg.clear();
 221     return ExecGraphViewer(ViewerPath, args, PSFilename, wait, ErrMsg);
 222   }
 223
 224   // dotty
 225   if (S.TryFindProgram("dotty", ViewerPath)) {
 226     std::vector<const char *> args;
 227     args.push_back(ViewerPath.c_str());
 228     args.push_back(Filename.c_str());
 229     args.push_back(nullptr);
 230
 231 // Dotty spawns another app and doesn't wait until it returns
 232 #ifdef LLVM_ON_WIN32
 233     wait = false;
 234 #endif
 235     errs() << "Running 'dotty' program... ";
 236     return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
 237   }
 238
 239   errs() << "Error: Couldn't find a usable graph viewer program:\n";
 240   errs() << S.LogBuffer << "\n";
 241   return true;
 242 }