Flush output after writing out the list of function names.

[oota-llvm.git] / tools / bugpoint / BugDriver.cpp

diff --git a/tools/bugpoint/BugDriver.cpp b/tools/bugpoint/BugDriver.cpp
index 0343f6381d604b6551f365ba89de7fee2e70785e..ff68fb05faab513a1eb66d8330330a5d059c2df0 100644 (file)
--- a/tools/bugpoint/BugDriver.cpp
+++ b/tools/bugpoint/BugDriver.cpp
@@ -8,12 +8,54 @@
 
 #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)"));
+}
+
+/// getPassesString - Turn a list of passes into a string which indicates the
+/// command line options that must be passed to add the passes.
+///
+std::string getPassesString(const std::vector<const PassInfo*> &Passes) {
+  std::string Result;
+  for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
+    if (i) Result += " ";
+    Result += "-";
+    Result += Passes[i]->getPassArgument();
+  }
+  return Result;
+}
+
+// DeleteFunctionBody - "Remove" the function by deleting all of its basic
+// blocks, making it external.
+//
+void DeleteFunctionBody(Function *F) {
+  // 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.
 ///
@@ -33,7 +75,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!");
@@ -76,25 +120,55 @@ bool BugDriver::run() {
   // a bytecode file, then we know the compiler didn't crash, so try to diagnose
   // a miscompilation.
   //
-  std::cout << "Running selected passes on program to test for crash: ";
-  if (runPasses(PassesToRun))
-    return debugCrash();
-  else
-    return debugMiscompilation();
-}
-
+  if (!PassesToRun.empty()) {
+    std::cout << "Running selected passes on program to test for crash: ";
+    if (runPasses(PassesToRun))
+      return debugCrash();
+  }
 
-/// debugMiscompilation - This method is used when the passes selected are not
-/// crashing, but the generated output is semantically different from the
-/// input.
-///
-bool BugDriver::debugMiscompilation() {
-  std::cout << "*** Debugging miscompilation!\n";
-  std::cerr << "Sorry, bugpoint cannot debug a miscompilation yet!\n";
+  // Set up the execution environment, selecting a method to run LLVM bytecode.
+  if (initializeExecutionEnvironment()) return true;
 
-  // If no reference output was specified, run the program without optimizations
-  // to get a reference output.
+  // 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...";
+    ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
+    CreatedOutput = true;
+    std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
+  }
 
-  return true;
+  // Make sure the reference output file gets deleted on exit from this
+  // function, if appropriate.
+  struct Remover {
+    bool DeleteIt; const std::string &Filename;
+    Remover(bool deleteIt, const std::string &filename)
+      : DeleteIt(deleteIt), Filename(filename) {}
+    ~Remover() {
+      if (DeleteIt) removeFile(Filename);
+    }
+  } RemoverInstance(CreatedOutput, ReferenceOutputFile);
+
+  // Diff the output of the raw program against the reference output.  If it
+  // matches, then we have a miscompilation bug.
+  std::cout << "*** Checking the code generator...\n";
+  if (!diffProgram()) {
+    std::cout << "\n*** Debugging miscompilation!\n";
+    return debugMiscompilation();
+  }
+
+  std::cout << "\n*** Input program does not match reference diff!\n";
+  std::cout << "Debugging code generator problem!\n";
+  return debugCodeGenerator();
+}
+
+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();
+  }
+  std::cout << std::flush;
 }