tools/bugpoint/OptimizerDriver.cpp

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