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