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