tools/bugpoint/OptimizerDriver.cpp

   1 //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===//
   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 defines an interface that allows bugpoint to run various passes
  11 // without the threat of a buggy pass corrupting bugpoint (of course, bugpoint
  12 // may have its own bugs, but that's another story...).  It achieves this by
  13 // forking a copy of itself and having the child process do the optimizations.
  14 // If this client dies, we can always fork a new one.  :)
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "BugDriver.h"
  19 #include "llvm/Bitcode/ReaderWriter.h"
  20 #include "llvm/IR/DataLayout.h"
  21 #include "llvm/IR/Module.h"
  22 #include "llvm/IR/Verifier.h"
  23 #include "llvm/PassManager.h"
  24 #include "llvm/Support/CommandLine.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/FileUtilities.h"
  27 #include "llvm/Support/Path.h"
  28 #include "llvm/Support/Program.h"
  29 #include "llvm/Support/SystemUtils.h"
  30 #include "llvm/Support/ToolOutputFile.h"
  31
  32 #define DONT_GET_PLUGIN_LOADER_OPTION
  33 #include "llvm/Support/PluginLoader.h"
  34
  35 #include <fstream>
  36
  37 using namespace llvm;
  38 using std::error_code;
  39
  40 #define DEBUG_TYPE "bugpoint"
  41
  42 namespace llvm {
  43   extern cl::opt<std::string> OutputPrefix;
  44 }
  45
  46 namespace {
  47   // ChildOutput - This option captures the name of the child output file that
  48   // is set up by the parent bugpoint process
  49   cl::opt<std::string> ChildOutput("child-output", cl::ReallyHidden);
  50   cl::opt<std::string> OptCmd("opt-command", cl::init(""),
  51                               cl::desc("Path to opt. (default: search path "
  52                                        "for 'opt'.)"));
  53 }
  54
  55 /// writeProgramToFile - This writes the current "Program" to the named bitcode
  56 /// file.  If an error occurs, true is returned.
  57 ///
  58 static bool writeProgramToFileAux(tool_output_file &Out, const Module *M) {
  59   WriteBitcodeToFile(M, Out.os());
  60   Out.os().close();
  61   if (!Out.os().has_error()) {
  62     Out.keep();
  63     return false;
  64   }
  65   return true;
  66 }
  67
  68 bool BugDriver::writeProgramToFile(const std::string &Filename, int FD,
  69                                    const Module *M) const {
  70   tool_output_file Out(Filename.c_str(), FD);
  71   return writeProgramToFileAux(Out, M);
  72 }
  73
  74 bool BugDriver::writeProgramToFile(const std::string &Filename,
  75                                    const Module *M) const {
  76   std::string ErrInfo;
  77   tool_output_file Out(Filename.c_str(), ErrInfo, sys::fs::F_None);
  78   if (ErrInfo.empty())
  79     return writeProgramToFileAux(Out, M);
  80   return true;
  81 }
  82
  83
  84 /// EmitProgressBitcode - This function is used to output the current Program
  85 /// to a file named "bugpoint-ID.bc".
  86 ///
  87 void BugDriver::EmitProgressBitcode(const Module *M,
  88                                     const std::string &ID,
  89                                     bool NoFlyer)  const {
  90   // Output the input to the current pass to a bitcode file, emit a message
  91   // telling the user how to reproduce it: opt -foo blah.bc
  92   //
  93   std::string Filename = OutputPrefix + "-" + ID + ".bc";
  94   if (writeProgramToFile(Filename, M)) {
  95     errs() <<  "Error opening file '" << Filename << "' for writing!\n";
  96     return;
  97   }
  98
  99   outs() << "Emitted bitcode to '" << Filename << "'\n";
 100   if (NoFlyer || PassesToRun.empty()) return;
 101   outs() << "\n*** You can reproduce the problem with: ";
 102   if (UseValgrind) outs() << "valgrind ";
 103   outs() << "opt " << Filename;
 104   for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
 105     outs() << " -load " << PluginLoader::getPlugin(i);
 106   }
 107   outs() << " " << getPassesString(PassesToRun) << "\n";
 108 }
 109
 110 cl::opt<bool> SilencePasses("silence-passes",
 111         cl::desc("Suppress output of running passes (both stdout and stderr)"));
 112
 113 static cl::list<std::string> OptArgs("opt-args", cl::Positional,
 114                                      cl::desc("<opt arguments>..."),
 115                                      cl::ZeroOrMore, cl::PositionalEatsArgs);
 116
 117 /// runPasses - Run the specified passes on Program, outputting a bitcode file
 118 /// and writing the filename into OutputFile if successful.  If the
 119 /// optimizations fail for some reason (optimizer crashes), return true,
 120 /// otherwise return false.  If DeleteOutput is set to true, the bitcode is
 121 /// deleted on success, and the filename string is undefined.  This prints to
 122 /// outs() a single line message indicating whether compilation was successful
 123 /// or failed.
 124 ///
 125 bool BugDriver::runPasses(Module *Program,
 126                           const std::vector<std::string> &Passes,
 127                           std::string &OutputFilename, bool DeleteOutput,
 128                           bool Quiet, unsigned NumExtraArgs,
 129                           const char * const *ExtraArgs) const {
 130   // setup the output file name
 131   outs().flush();
 132   SmallString<128> UniqueFilename;
 133   error_code EC = sys::fs::createUniqueFile(
 134       OutputPrefix + "-output-%%%%%%%.bc", UniqueFilename);
 135   if (EC) {
 136     errs() << getToolName() << ": Error making unique filename: "
 137            << EC.message() << "\n";
 138     return 1;
 139   }
 140   OutputFilename = UniqueFilename.str();
 141
 142   // set up the input file name
 143   SmallString<128> InputFilename;
 144   int InputFD;
 145   EC = sys::fs::createUniqueFile(OutputPrefix + "-input-%%%%%%%.bc", InputFD,
 146                                  InputFilename);
 147   if (EC) {
 148     errs() << getToolName() << ": Error making unique filename: "
 149            << EC.message() << "\n";
 150     return 1;
 151   }
 152
 153   tool_output_file InFile(InputFilename.c_str(), InputFD);
 154
 155   WriteBitcodeToFile(Program, InFile.os());
 156   InFile.os().close();
 157   if (InFile.os().has_error()) {
 158     errs() << "Error writing bitcode file: " << InputFilename << "\n";
 159     InFile.os().clear_error();
 160     return 1;
 161   }
 162
 163   std::string tool = OptCmd.empty()? sys::FindProgramByName("opt") : OptCmd;
 164   if (tool.empty()) {
 165     errs() << "Cannot find `opt' in PATH!\n";
 166     return 1;
 167   }
 168
 169   // Ok, everything that could go wrong before running opt is done.
 170   InFile.keep();
 171
 172   // setup the child process' arguments
 173   SmallVector<const char*, 8> Args;
 174   if (UseValgrind) {
 175     Args.push_back("valgrind");
 176     Args.push_back("--error-exitcode=1");
 177     Args.push_back("-q");
 178     Args.push_back(tool.c_str());
 179   } else
 180     Args.push_back(tool.c_str());
 181
 182   Args.push_back("-o");
 183   Args.push_back(OutputFilename.c_str());
 184   for (unsigned i = 0, e = OptArgs.size(); i != e; ++i)
 185     Args.push_back(OptArgs[i].c_str());
 186   std::vector<std::string> pass_args;
 187   for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
 188     pass_args.push_back( std::string("-load"));
 189     pass_args.push_back( PluginLoader::getPlugin(i));
 190   }
 191   for (std::vector<std::string>::const_iterator I = Passes.begin(),
 192        E = Passes.end(); I != E; ++I )
 193     pass_args.push_back( std::string("-") + (*I) );
 194   for (std::vector<std::string>::const_iterator I = pass_args.begin(),
 195        E = pass_args.end(); I != E; ++I )
 196     Args.push_back(I->c_str());
 197   Args.push_back(InputFilename.c_str());
 198   for (unsigned i = 0; i < NumExtraArgs; ++i)
 199     Args.push_back(*ExtraArgs);
 200   Args.push_back(nullptr);
 201
 202   DEBUG(errs() << "\nAbout to run:\t";
 203         for (unsigned i = 0, e = Args.size()-1; i != e; ++i)
 204           errs() << " " << Args[i];
 205         errs() << "\n";
 206         );
 207
 208   std::string Prog;
 209   if (UseValgrind)
 210     Prog = sys::FindProgramByName("valgrind");
 211   else
 212     Prog = tool;
 213
 214   // Redirect stdout and stderr to nowhere if SilencePasses is given
 215   StringRef Nowhere;
 216   const StringRef *Redirects[3] = {nullptr, &Nowhere, &Nowhere};
 217
 218   std::string ErrMsg;
 219   int result = sys::ExecuteAndWait(Prog, Args.data(), nullptr,
 220                                    (SilencePasses ? Redirects : nullptr),
 221                                    Timeout, MemoryLimit, &ErrMsg);
 222
 223   // If we are supposed to delete the bitcode file or if the passes crashed,
 224   // remove it now.  This may fail if the file was never created, but that's ok.
 225   if (DeleteOutput || result != 0)
 226     sys::fs::remove(OutputFilename);
 227
 228   // Remove the temporary input file as well
 229   sys::fs::remove(InputFilename.c_str());
 230
 231   if (!Quiet) {
 232     if (result == 0)
 233       outs() << "Success!\n";
 234     else if (result > 0)
 235       outs() << "Exited with error code '" << result << "'\n";
 236     else if (result < 0) {
 237       if (result == -1)
 238         outs() << "Execute failed: " << ErrMsg << "\n";
 239       else
 240         outs() << "Crashed: " << ErrMsg << "\n";
 241     }
 242     if (result & 0x01000000)
 243       outs() << "Dumped core\n";
 244   }
 245
 246   // Was the child successful?
 247   return result != 0;
 248 }
 249
 250
 251 /// runPassesOn - Carefully run the specified set of pass on the specified
 252 /// module, returning the transformed module on success, or a null pointer on
 253 /// failure.
 254 Module *BugDriver::runPassesOn(Module *M,
 255                                const std::vector<std::string> &Passes,
 256                                bool AutoDebugCrashes, unsigned NumExtraArgs,
 257                                const char * const *ExtraArgs) {
 258   std::string BitcodeResult;
 259   if (runPasses(M, Passes, BitcodeResult, false/*delete*/, true/*quiet*/,
 260                 NumExtraArgs, ExtraArgs)) {
 261     if (AutoDebugCrashes) {
 262       errs() << " Error running this sequence of passes"
 263              << " on the input program!\n";
 264       delete swapProgramIn(M);
 265       EmitProgressBitcode(M, "pass-error",  false);
 266       exit(debugOptimizerCrash());
 267     }
 268     return nullptr;
 269   }
 270
 271   Module *Ret = ParseInputFile(BitcodeResult, Context);
 272   if (!Ret) {
 273     errs() << getToolName() << ": Error reading bitcode file '"
 274            << BitcodeResult << "'!\n";
 275     exit(1);
 276   }
 277   sys::fs::remove(BitcodeResult);
 278   return Ret;
 279 }