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