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