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