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