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
  81   unsigned PassType = PassesToRun[0]->getPassType();
  82   for (unsigned i = 1, e = PassesToRun.size(); i != e; ++i)
  83     PassType &= PassesToRun[i]->getPassType();
  84
  85   if (PassType & PassInfo::Analysis)
  86     std::cout << "analyze";
  87   else if (PassType & PassInfo::Optimization)
  88     std::cout << "opt";
  89   else
  90     std::cout << "bugpoint";
  91   std::cout << " " << Filename << " ";
  92   std::cout << getPassesString(PassesToRun) << "\n";
  93 }
  94
  95 int BugDriver::runPassesAsChild(const std::vector<const PassInfo*> &Passes) {
  96
  97   std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
  98                                std::ios::binary;
  99   std::ofstream OutFile(ChildOutput.c_str(), io_mode);
 100   if (!OutFile.good()) {
 101     std::cerr << "Error opening bytecode file: " << ChildOutput << "\n";
 102     return 1;
 103   }
 104
 105   PassManager PM;
 106   // Make sure that the appropriate target data is always used...
 107   PM.add(new TargetData(Program));
 108
 109   for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
 110     if (Passes[i]->getNormalCtor())
 111       PM.add(Passes[i]->getNormalCtor()());
 112     else
 113       std::cerr << "Cannot create pass yet: " << Passes[i]->getPassName()
 114                 << "\n";
 115   }
 116   // Check that the module is well formed on completion of optimization
 117   PM.add(createVerifierPass());
 118
 119   // Write bytecode out to disk as the last step...
 120   PM.add(new WriteBytecodePass(&OutFile));
 121
 122   // Run all queued passes.
 123   PM.run(*Program);
 124
 125   return 0;
 126 }
 127
 128 /// runPasses - Run the specified passes on Program, outputting a bytecode file
 129 /// and writing the filename into OutputFile if successful.  If the
 130 /// optimizations fail for some reason (optimizer crashes), return true,
 131 /// otherwise return false.  If DeleteOutput is set to true, the bytecode is
 132 /// deleted on success, and the filename string is undefined.  This prints to
 133 /// cout a single line message indicating whether compilation was successful or
 134 /// failed.
 135 ///
 136 bool BugDriver::runPasses(const std::vector<const PassInfo*> &Passes,
 137                           std::string &OutputFilename, bool DeleteOutput,
 138                           bool Quiet) const{
 139   // setup the output file name
 140   std::cout << std::flush;
 141   sys::Path uniqueFilename("bugpoint-output.bc");
 142   uniqueFilename.makeUnique();
 143   OutputFilename = uniqueFilename.toString();
 144
 145   // set up the input file name
 146   sys::Path inputFilename("bugpoint-input.bc");
 147   inputFilename.makeUnique();
 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()+10+2*PluginLoader::getNumPlugins()));
 162   int n = 0;
 163   args[n++] = ToolName.c_str();
 164   args[n++] = "-as-child";
 165   args[n++] = "-child-output";
 166   args[n++] = OutputFilename.c_str();
 167   std::vector<std::string> pass_args;
 168   for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
 169     pass_args.push_back( std::string("-load"));
 170     pass_args.push_back( PluginLoader::getPlugin(i));
 171   }
 172   for (std::vector<const PassInfo*>::const_iterator I = Passes.begin(),
 173        E = Passes.end(); I != E; ++I )
 174     pass_args.push_back( std::string("-") + (*I)->getPassArgument() );
 175   for (std::vector<std::string>::const_iterator I = pass_args.begin(),
 176        E = pass_args.end(); I != E; ++I )
 177     args[n++] = I->c_str();
 178   args[n++] = inputFilename.c_str();
 179   args[n++] = 0;
 180
 181   sys::Path prog(sys::Program::FindProgramByName(ToolName));
 182   int result = sys::Program::ExecuteAndWait(prog,args,0,0,Timeout);
 183
 184   // If we are supposed to delete the bytecode file or if the passes crashed,
 185   // remove it now.  This may fail if the file was never created, but that's ok.
 186   if (DeleteOutput || result != 0)
 187     sys::Path(OutputFilename).eraseFromDisk();
 188
 189   // Remove the temporary input file as well
 190   inputFilename.eraseFromDisk();
 191
 192   if (!Quiet) {
 193     if (result == 0)
 194       std::cout << "Success!\n";
 195     else if (result > 0)
 196       std::cout << "Exited with error code '" << result << "'\n";
 197     else if (result < 0)
 198       std::cout << "Crashed with signal #" << abs(result) << "\n";
 199     if (result & 0x01000000)
 200       std::cout << "Dumped core\n";
 201   }
 202
 203   // Was the child successful?
 204   return result != 0;
 205 }
 206
 207
 208 /// runPassesOn - Carefully run the specified set of pass on the specified
 209 /// module, returning the transformed module on success, or a null pointer on
 210 /// failure.
 211 Module *BugDriver::runPassesOn(Module *M,
 212                                const std::vector<const PassInfo*> &Passes,
 213                                bool AutoDebugCrashes) {
 214   Module *OldProgram = swapProgramIn(M);
 215   std::string BytecodeResult;
 216   if (runPasses(Passes, BytecodeResult, false/*delete*/, true/*quiet*/)) {
 217     if (AutoDebugCrashes) {
 218       std::cerr << " Error running this sequence of passes"
 219                 << " on the input program!\n";
 220       delete OldProgram;
 221       EmitProgressBytecode("pass-error",  false);
 222       exit(debugOptimizerCrash());
 223     }
 224     swapProgramIn(OldProgram);
 225     return 0;
 226   }
 227
 228   // Restore the current program.
 229   swapProgramIn(OldProgram);
 230
 231   Module *Ret = ParseInputFile(BytecodeResult);
 232   if (Ret == 0) {
 233     std::cerr << getToolName() << ": Error reading bytecode file '"
 234               << BytecodeResult << "'!\n";
 235     exit(1);
 236   }
 237   sys::Path(BytecodeResult).eraseFromDisk();  // No longer need the file on disk
 238   return Ret;
 239 }