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