The preheader insertion pass only depends on the CFG. Mark it as such, which
[oota-llvm.git] / tools / bugpoint / BugDriver.cpp
index 7a2ce26a85406814d4a421a9d4313f86671e6d99..67f59fd54d77657e98f7a6e47a2d4a094e854441 100644 (file)
@@ -8,12 +8,35 @@
 
 #include "BugDriver.h"
 #include "llvm/Module.h"
-#include "llvm/Bytecode/Reader.h"
+#include "llvm/Pass.h"
 #include "llvm/Assembly/Parser.h"
+#include "llvm/Bytecode/Reader.h"
 #include "llvm/Transforms/Utils/Linker.h"
-#include "llvm/Pass.h"
+#include "Support/CommandLine.h"
+#include "Support/FileUtilities.h"
 #include <memory>
 
+// Anonymous namespace to define command line options for debugging.
+//
+namespace {
+  // Output - The user can specify a file containing the expected output of the
+  // program.  If this filename is set, it is used as the reference diff source,
+  // otherwise the raw input run through an interpreter is used as the reference
+  // source.
+  //
+  cl::opt<std::string> 
+  OutputFile("output", cl::desc("Specify a reference program output "
+                                "(for miscompilation detection)"));
+
+  enum DebugType { DebugCompile, DebugCodegen };
+  cl::opt<DebugType>
+  DebugMode("mode", cl::desc("Debug mode for bugpoint:"), cl::Prefix,
+            cl::values(clEnumValN(DebugCompile, "compile", "  Compilation"),
+                       clEnumValN(DebugCodegen, "codegen", "  Code generation"),
+                       0),
+            cl::init(DebugCompile));
+}
+
 /// getPassesString - Turn a list of passes into a string which indicates the
 /// command line options that must be passed to add the passes.
 ///
@@ -27,20 +50,20 @@ std::string getPassesString(const std::vector<const PassInfo*> &Passes) {
   return Result;
 }
 
-// DeleteFunctionBody - "Remove" the function by deleting all of it's basic
+// DeleteFunctionBody - "Remove" the function by deleting all of its basic
 // blocks, making it external.
 //
 void DeleteFunctionBody(Function *F) {
-  // First, break circular use/def chain references...
-  for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
-    I->dropAllReferences();
-
-  // Next, delete all of the basic blocks.
-  F->getBasicBlockList().clear();
-
+  // delete the body of the function...
+  F->deleteBody();
   assert(F->isExternal() && "This didn't make the function external!");
 }
 
+BugDriver::BugDriver(const char *toolname)
+  : ToolName(toolname), ReferenceOutputFile(OutputFile),
+    Program(0), Interpreter(0), cbe(0), gcc(0) {}
+
+
 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
 /// return it, or return null if not possible.
 ///
@@ -60,7 +83,9 @@ Module *BugDriver::ParseInputFile(const std::string &InputFilename) const {
 }
 
 // This method takes the specified list of LLVM input files, attempts to load
-// them, either as assembly or bytecode, then link them together.
+// them, either as assembly or bytecode, then link them together. It returns
+// true on failure (if, for example, an input bytecode file could not be
+// parsed), and false on success.
 //
 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
   assert(Program == 0 && "Cannot call addSources multiple times!");
@@ -106,6 +131,48 @@ bool BugDriver::run() {
   std::cout << "Running selected passes on program to test for crash: ";
   if (runPasses(PassesToRun))
     return debugCrash();
-  else
-    return debugMiscompilation();
+
+  std::cout << "Checking for a miscompilation...\n";
+
+  // Set up the execution environment, selecting a method to run LLVM bytecode.
+  if (initializeExecutionEnvironment()) return true;
+
+  // Run the raw input to see where we are coming from.  If a reference output
+  // was specified, make sure that the raw output matches it.  If not, it's a
+  // problem in the front-end or the code generator.
+  //
+  bool CreatedOutput = false;
+  if (ReferenceOutputFile.empty()) {
+    std::cout << "Generating reference output from raw program...";
+    if (DebugCodegen) {
+      ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
+    } else {
+      ReferenceOutputFile = executeProgram("bugpoint.reference.out");
+    }
+    CreatedOutput = true;
+    std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
+  } 
+
+  bool Result;
+  switch (DebugMode) {
+  default: assert(0 && "Bad value for DebugMode!");
+  case DebugCompile:
+    std::cout << "\n*** Debugging miscompilation!\n";
+    Result = debugMiscompilation();
+    break;
+  case DebugCodegen:
+    std::cout << "Debugging code generator problem!\n";
+    Result = debugCodeGenerator();
+  }
+
+  if (CreatedOutput) removeFile(ReferenceOutputFile);
+  return Result;
+}
+
+void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs)
+{
+  for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
+    if (i) std::cout << ", ";
+    std::cout << Funcs[i]->getName();
+  }
 }