eliminate use of deprecated apis
[oota-llvm.git] / tools / bugpoint / OptimizerDriver.cpp
index 097dd61df1d5f518453edefbf61a534d5ec3158f..210f348f3546700a12e1e4e04356c71173abaf92 100644 (file)
@@ -1,10 +1,10 @@
 //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
 // This file defines an interface that allows bugpoint to run various passes
 //
 //===----------------------------------------------------------------------===//
 
+// Note: as a short term hack, the old Unix-specific code and platform-
+// independent code co-exist via conditional compilation until it is verified
+// that the new code works correctly on Unix.
+
 #include "BugDriver.h"
 #include "llvm/Module.h"
 #include "llvm/PassManager.h"
 #include "llvm/Bytecode/WriteBytecodePass.h"
 #include "llvm/Target/TargetData.h"
 #include "llvm/Support/FileUtilities.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/Streams.h"
+#include "llvm/System/Path.h"
+#include "llvm/System/Program.h"
+#include "llvm/Config/alloca.h"
+
+#define DONT_GET_PLUGIN_LOADER_OPTION
+#include "llvm/Support/PluginLoader.h"
+
 #include <fstream>
-#include <unistd.h>
-#include <sys/types.h>
-#include <sys/wait.h>
 using namespace llvm;
 
+namespace {
+  // ChildOutput - This option captures the name of the child output file that
+  // is set up by the parent bugpoint process
+  cl::opt<std::string> ChildOutput("child-output", cl::ReallyHidden);
+  cl::opt<bool> UseValgrind("enable-valgrind",
+                            cl::desc("Run optimizations through valgrind"));
+}
+
 /// writeProgramToFile - This writes the current "Program" to the named bytecode
 /// file.  If an error occurs, true is returned.
 ///
 bool BugDriver::writeProgramToFile(const std::string &Filename,
-                                  Module *M) const {
-  std::ofstream Out(Filename.c_str());
+                                   Module *M) const {
+  std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+                               std::ios::binary;
+  std::ofstream Out(Filename.c_str(), io_mode);
   if (!Out.good()) return true;
-  WriteBytecodeToFile(M ? M : Program, Out, /*compression=*/true);
+  try {
+    OStream L(Out);
+    WriteBytecodeToFile(M ? M : Program, L, /*compression=*/false);
+  } catch (...) {
+    return true;
+  }
   return false;
 }
 
@@ -49,57 +74,48 @@ void BugDriver::EmitProgressBytecode(const std::string &ID, bool NoFlyer) {
   //
   std::string Filename = "bugpoint-" + ID + ".bc";
   if (writeProgramToFile(Filename)) {
-    std::cerr <<  "Error opening file '" << Filename << "' for writing!\n";
+    cerr <<  "Error opening file '" << Filename << "' for writing!\n";
     return;
   }
 
-  std::cout << "Emitted bytecode to '" << Filename << "'\n";
+  cout << "Emitted bytecode to '" << Filename << "'\n";
   if (NoFlyer || PassesToRun.empty()) return;
-  std::cout << "\n*** You can reproduce the problem with: ";
-
-  unsigned PassType = PassesToRun[0]->getPassType();
-  for (unsigned i = 1, e = PassesToRun.size(); i != e; ++i)
-    PassType &= PassesToRun[i]->getPassType();
-
-  if (PassType & PassInfo::Analysis)
-    std::cout << "analyze";
-  else if (PassType & PassInfo::Optimization)
-    std::cout << "opt";
-  else if (PassType & PassInfo::LLC)
-    std::cout << "llc";
-  else
-    std::cout << "bugpoint";
-  std::cout << " " << Filename << " ";
-  std::cout << getPassesString(PassesToRun) << "\n";
+  cout << "\n*** You can reproduce the problem with: ";
+  cout << "opt " << Filename << " ";
+  cout << getPassesString(PassesToRun) << "\n";
 }
 
-static void RunChild(Module *Program,const std::vector<const PassInfo*> &Passes,
-                     const std::string &OutFilename) {
-  std::ofstream OutFile(OutFilename.c_str());
+int BugDriver::runPassesAsChild(const std::vector<const PassInfo*> &Passes) {
+
+  std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+                               std::ios::binary;
+  std::ofstream OutFile(ChildOutput.c_str(), io_mode);
   if (!OutFile.good()) {
-    std::cerr << "Error opening bytecode file: " << OutFilename << "\n";
-    exit(1);
+    cerr << "Error opening bytecode file: " << ChildOutput << "\n";
+    return 1;
   }
 
   PassManager PM;
   // Make sure that the appropriate target data is always used...
-  PM.add(new TargetData("bugpoint", Program));
+  PM.add(new TargetData(Program));
 
   for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
     if (Passes[i]->getNormalCtor())
       PM.add(Passes[i]->getNormalCtor()());
     else
-      std::cerr << "Cannot create pass yet: " << Passes[i]->getPassName()
-                << "\n";
+      cerr << "Cannot create pass yet: " << Passes[i]->getPassName() << "\n";
   }
   // Check that the module is well formed on completion of optimization
   PM.add(createVerifierPass());
 
   // Write bytecode out to disk as the last step...
-  PM.add(new WriteBytecodePass(&OutFile));
+  OStream L(OutFile);
+  PM.add(new WriteBytecodePass(&L));
 
   // Run all queued passes.
   PM.run(*Program);
+
+  return 0;
 }
 
 /// runPasses - Run the specified passes on Program, outputting a bytecode file
@@ -112,53 +128,100 @@ static void RunChild(Module *Program,const std::vector<const PassInfo*> &Passes,
 ///
 bool BugDriver::runPasses(const std::vector<const PassInfo*> &Passes,
                           std::string &OutputFilename, bool DeleteOutput,
-                         bool Quiet) const{
-  std::cout << std::flush;
-  OutputFilename = getUniqueFilename("bugpoint-output.bc");
-
-  pid_t child_pid;
-  switch (child_pid = fork()) {
-  case -1:    // Error occurred
-    std::cerr << ToolName << ": Error forking!\n";
-    exit(1);
-  case 0:     // Child process runs passes.
-    RunChild(Program, Passes, OutputFilename);
-    exit(0);  // If we finish successfully, return 0!
-  default:    // Parent continues...
-    break;
+                          bool Quiet) const {
+  // setup the output file name
+  cout << std::flush;
+  sys::Path uniqueFilename("bugpoint-output.bc");
+  std::string ErrMsg;
+  if (uniqueFilename.makeUnique(true, &ErrMsg)) {
+    cerr << getToolName() << ": Error making unique filename: " 
+         << ErrMsg << "\n";
+    return(1);
   }
+  OutputFilename = uniqueFilename.toString();
 
-  // Wait for the child process to get done.
-  int Status;
-  if (wait(&Status) != child_pid) {
-    std::cerr << "Error waiting for child process!\n";
-    exit(1);
+  // set up the input file name
+  sys::Path inputFilename("bugpoint-input.bc");
+  if (inputFilename.makeUnique(true, &ErrMsg)) {
+    cerr << getToolName() << ": Error making unique filename: " 
+         << ErrMsg << "\n";
+    return(1);
+  }
+  std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+                               std::ios::binary;
+  std::ofstream InFile(inputFilename.c_str(), io_mode);
+  if (!InFile.good()) {
+    cerr << "Error opening bytecode file: " << inputFilename << "\n";
+    return(1);
   }
+  OStream L(InFile);
+  WriteBytecodeToFile(Program,L,false);
+  InFile.close();
 
-  bool ExitedOK = WIFEXITED(Status) && WEXITSTATUS(Status) == 0;
+  // setup the child process' arguments
+  const char** args = (const char**)
+    alloca(sizeof(const char*) * 
+          (Passes.size()+13+2*PluginLoader::getNumPlugins()));
+  int n = 0;
+  sys::Path tool = sys::Program::FindProgramByName(ToolName);
+  if (UseValgrind) {
+    args[n++] = "valgrind";
+    args[n++] = "--error-exitcode=1";
+    args[n++] = "-q";
+    args[n++] = tool.c_str();
+  } else
+    args[n++] = ToolName.c_str();
+
+  args[n++] = "-as-child";
+  args[n++] = "-child-output";
+  args[n++] = OutputFilename.c_str();
+  std::vector<std::string> pass_args;
+  for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
+    pass_args.push_back( std::string("-load"));
+    pass_args.push_back( PluginLoader::getPlugin(i));
+  }
+  for (std::vector<const PassInfo*>::const_iterator I = Passes.begin(),
+       E = Passes.end(); I != E; ++I )
+    pass_args.push_back( std::string("-") + (*I)->getPassArgument() );
+  for (std::vector<std::string>::const_iterator I = pass_args.begin(),
+       E = pass_args.end(); I != E; ++I )
+    args[n++] = I->c_str();
+  args[n++] = inputFilename.c_str();
+  args[n++] = 0;
+
+  sys::Path prog;
+  if (UseValgrind)
+    prog = sys::Program::FindProgramByName("valgrind");
+  else
+    prog = tool;
+  int result = sys::Program::ExecuteAndWait(prog, args, 0, 0,
+                                            Timeout, MemoryLimit, &ErrMsg);
 
   // If we are supposed to delete the bytecode file or if the passes crashed,
   // remove it now.  This may fail if the file was never created, but that's ok.
-  if (DeleteOutput || !ExitedOK)
-    removeFile(OutputFilename);
-  
+  if (DeleteOutput || result != 0)
+    sys::Path(OutputFilename).eraseFromDisk();
+
+  // Remove the temporary input file as well
+  inputFilename.eraseFromDisk();
+
   if (!Quiet) {
-    if (ExitedOK)
-      std::cout << "Success!\n";
-    else if (WIFEXITED(Status))
-      std::cout << "Exited with error code '" << WEXITSTATUS(Status) << "'\n";
-    else if (WIFSIGNALED(Status))
-      std::cout << "Crashed with signal #" << WTERMSIG(Status) << "\n";
-#ifdef WCOREDUMP
-    else if (WCOREDUMP(Status))
-      std::cout << "Dumped core\n";
-#endif
-    else
-      std::cout << "Failed for unknown reason!\n";
+    if (result == 0)
+      cout << "Success!\n";
+    else if (result > 0)
+      cout << "Exited with error code '" << result << "'\n";
+    else if (result < 0) {
+      if (result == -1)
+        cout << "Execute failed: " << ErrMsg << "\n";
+      else
+        cout << "Crashed with signal #" << abs(result) << "\n";
+    }
+    if (result & 0x01000000)
+      cout << "Dumped core\n";
   }
 
   // Was the child successful?
-  return !ExitedOK;
+  return result != 0;
 }
 
 
@@ -172,8 +235,8 @@ Module *BugDriver::runPassesOn(Module *M,
   std::string BytecodeResult;
   if (runPasses(Passes, BytecodeResult, false/*delete*/, true/*quiet*/)) {
     if (AutoDebugCrashes) {
-      std::cerr << " Error running this sequence of passes" 
-                << " on the input program!\n";
+      cerr << " Error running this sequence of passes"
+           << " on the input program!\n";
       delete OldProgram;
       EmitProgressBytecode("pass-error",  false);
       exit(debugOptimizerCrash());
@@ -187,10 +250,10 @@ Module *BugDriver::runPassesOn(Module *M,
 
   Module *Ret = ParseInputFile(BytecodeResult);
   if (Ret == 0) {
-    std::cerr << getToolName() << ": Error reading bytecode file '"
-              << BytecodeResult << "'!\n";
+    cerr << getToolName() << ": Error reading bytecode file '"
+         << BytecodeResult << "'!\n";
     exit(1);
   }
-  removeFile(BytecodeResult);  // No longer need the file on disk
+  sys::Path(BytecodeResult).eraseFromDisk();  // No longer need the file on disk
   return Ret;
 }