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