Hrm, operator new and new[] do not belong here. We should not CSE them! :)
[oota-llvm.git] / tools / bugpoint / ExecutionDriver.cpp
index e0e0b70c572ca03fc888d4a558dcede1e1f05ea1..969eaabaf6e992ba9a641e039f4b9c7aeb196e5d 100644 (file)
@@ -1,4 +1,11 @@
 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
+// 
+//                     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 contains code used to execute the program utilizing one of the
 // various ways of running LLVM bytecode.
@@ -22,22 +29,30 @@ BUGPOINT NOTES:
 #include "llvm/Support/ToolRunner.h"
 #include <fstream>
 #include <iostream>
+using namespace llvm;
 
 namespace {
   // OutputType - Allow the user to specify the way code should be run, to test
   // for miscompilation.
   //
   enum OutputType {
-    RunLLI, RunJIT, RunLLC, RunCBE
+    AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
   };
 
   cl::opt<OutputType>
   InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
-                 cl::values(clEnumValN(RunLLI, "run-lli", "Execute with LLI"),
+                 cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
+                            clEnumValN(RunLLI, "run-int", "Execute with the interpreter"),
                             clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
                             clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
                             clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
-                            0));
+                            0),
+                 cl::init(AutoPick));
+
+  cl::opt<bool>
+  CheckProgramExitCode("check-exit-code",
+                       cl::desc("Assume nonzero exit code is failure (default on)"),
+                       cl::init(true));
 
   cl::opt<std::string>
   InputFile("input", cl::init("/dev/null"),
@@ -49,11 +64,13 @@ namespace {
                          "into executing programs"));
 }
 
-// Anything specified after the --args option are taken as arguments to the
-// program being debugged.
-cl::list<std::string>
-InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
-          cl::ZeroOrMore);
+namespace llvm {
+  // Anything specified after the --args option are taken as arguments to the
+  // program being debugged.
+  cl::list<std::string>
+  InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
+            cl::ZeroOrMore);
+}
 
 //===----------------------------------------------------------------------===//
 // BugDriver method implementation
@@ -65,13 +82,31 @@ InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
 bool BugDriver::initializeExecutionEnvironment() {
   std::cout << "Initializing execution environment: ";
 
-  // FIXME: This should default to searching for the best interpreter to use on
-  // this platform, which would be JIT, then LLC, then CBE, then LLI.
-
   // Create an instance of the AbstractInterpreter interface as specified on
   // the command line
+  cbe = 0;
   std::string Message;
   switch (InterpreterSel) {
+  case AutoPick:
+    InterpreterSel = RunCBE;
+    Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message);
+    if (!Interpreter) {
+      InterpreterSel = RunJIT;
+      Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
+    }
+    if (!Interpreter) {
+      InterpreterSel = RunLLC;
+      Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
+    }
+    if (!Interpreter) {
+      InterpreterSel = RunLLI;
+      Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
+    }
+    if (!Interpreter) {
+      InterpreterSel = AutoPick;
+      Message = "Sorry, I can't automatically select an interpreter!\n";
+    }
+    break;
   case RunLLI:
     Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
     break;
@@ -82,7 +117,7 @@ bool BugDriver::initializeExecutionEnvironment() {
     Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
     break;
   case RunCBE:
-    Interpreter = AbstractInterpreter::createCBE(getToolName(), Message);
+    Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message);
     break;
   default:
     Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
@@ -91,8 +126,10 @@ bool BugDriver::initializeExecutionEnvironment() {
   std::cerr << Message;
 
   // Initialize auxiliary tools for debugging
-  cbe = AbstractInterpreter::createCBE(getToolName(), Message);
-  if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
+  if (!cbe) {
+    cbe = AbstractInterpreter::createCBE(getToolName(), Message);
+    if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
+  }
   gcc = GCC::create(getToolName(), Message);
   if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
 
@@ -100,6 +137,26 @@ bool BugDriver::initializeExecutionEnvironment() {
   return Interpreter == 0;
 }
 
+/// compileProgram - Try to compile the specified module, throwing an exception
+/// if an error occurs, or returning normally if not.  This is used for code
+/// generation crash testing.
+///
+void BugDriver::compileProgram(Module *M) {
+  // Emit the program to a bytecode file...
+  std::string BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
+  if (writeProgramToFile(BytecodeFile, M)) {
+    std::cerr << ToolName << ": Error emitting bytecode to file '"
+              << BytecodeFile << "'!\n";
+    exit(1);
+  }
+
+    // Remove the temporary bytecode file when we are done.
+  FileRemover BytecodeFileRemover(BytecodeFile);
+
+  // Actually compile the program!
+  Interpreter->compileProgram(BytecodeFile);
+}
+
 
 /// executeProgram - This method runs "Program", capturing the output of the
 /// program to a file, returning the filename of the file.  A recommended
@@ -108,7 +165,8 @@ bool BugDriver::initializeExecutionEnvironment() {
 std::string BugDriver::executeProgram(std::string OutputFile,
                                       std::string BytecodeFile,
                                       const std::string &SharedObj,
-                                      AbstractInterpreter *AI) {
+                                      AbstractInterpreter *AI,
+                                      bool *ProgramExitedNonzero) {
   if (AI == 0) AI = Interpreter;
   assert(AI && "Interpreter should have been created already!");
   bool CreatedBytecode = false;
@@ -124,6 +182,9 @@ std::string BugDriver::executeProgram(std::string OutputFile,
     CreatedBytecode = true;
   }
 
+  // Remove the temporary bytecode file when we are done.
+  FileRemover BytecodeFileRemover(BytecodeFile, CreatedBytecode);
+
   if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
 
   // Check to see if this is a valid output filename...
@@ -138,14 +199,29 @@ std::string BugDriver::executeProgram(std::string OutputFile,
   int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
                                   OutputFile, SharedObjs);
 
-
-  // Remove the temporary bytecode file.
-  if (CreatedBytecode) removeFile(BytecodeFile);
+  if (ProgramExitedNonzero != 0)
+    *ProgramExitedNonzero = (RetVal != 0);
 
   // Return the filename we captured the output to.
   return OutputFile;
 }
 
+/// executeProgramWithCBE - Used to create reference output with the C
+/// backend, if reference output is not provided.
+///
+std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
+  bool ProgramExitedNonzero;
+  std::string outFN = executeProgram(OutputFile, "", "",
+                                     (AbstractInterpreter*)cbe,
+                                     &ProgramExitedNonzero);
+  if (ProgramExitedNonzero) {
+    std::cerr
+      << "Warning: While generating reference output, program exited with\n"
+      << "non-zero exit code. This will NOT be treated as a failure.\n";
+    CheckProgramExitCode = false;
+  }
+  return outFN;
+}
 
 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
   assert(Interpreter && "Interpreter should have been created already!");
@@ -171,7 +247,7 @@ std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
   // Remove the intermediate C file
   removeFile(OutputCFile);
 
-  return SharedObjectFile;
+  return "./" + SharedObjectFile;
 }
 
 
@@ -182,8 +258,18 @@ std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
 bool BugDriver::diffProgram(const std::string &BytecodeFile,
                             const std::string &SharedObject,
                             bool RemoveBytecode) {
+  bool ProgramExitedNonzero;
+
   // Execute the program, generating an output file...
-  std::string Output = executeProgram("", BytecodeFile, SharedObject);
+  std::string Output = executeProgram("", BytecodeFile, SharedObject, 0,
+                                      &ProgramExitedNonzero);
+
+  // If we're checking the program exit code, assume anything nonzero is bad.
+  if (CheckProgramExitCode && ProgramExitedNonzero) {
+    removeFile(Output);
+    if (RemoveBytecode) removeFile(BytecodeFile);
+    return true;
+  }
 
   std::string Error;
   bool FilesDifferent = false;
@@ -194,7 +280,11 @@ bool BugDriver::diffProgram(const std::string &BytecodeFile,
     }
     FilesDifferent = true;
   }
+  
+  // Remove the generated output.
+  removeFile(Output);
 
+  // Remove the bytecode file if we are supposed to.
   if (RemoveBytecode) removeFile(BytecodeFile);
   return FilesDifferent;
 }
@@ -202,3 +292,4 @@ bool BugDriver::diffProgram(const std::string &BytecodeFile,
 bool BugDriver::isExecutingJIT() {
   return InterpreterSel == RunJIT;
 }
+