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