Cleanup some comments in the OCaml bindings.
[oota-llvm.git] / tools / bugpoint / BugDriver.cpp
index 6d13f96711813553e84a8df7d5707e3f591184c3..acea37e1feef5daa9f1256cce1a38ed855d6ba7b 100644 (file)
@@ -1,10 +1,10 @@
 //===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
-// 
+//
 //                     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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
 //
 // This class contains all of the shared state and information that is used by
 //===----------------------------------------------------------------------===//
 
 #include "BugDriver.h"
+#include "ToolRunner.h"
+#include "llvm/Linker.h"
 #include "llvm/Module.h"
 #include "llvm/Pass.h"
 #include "llvm/Assembly/Parser.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Support/Linker.h"
-#include "llvm/Support/ToolRunner.h"
+#include "llvm/Bitcode/ReaderWriter.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/FileUtilities.h"
+#include "llvm/Support/MemoryBuffer.h"
 #include <iostream>
 #include <memory>
-
 using namespace llvm;
 
 // Anonymous namespace to define command line options for debugging.
@@ -35,7 +35,7 @@ namespace {
   // otherwise the raw input run through an interpreter is used as the reference
   // source.
   //
-  cl::opt<std::string> 
+  cl::opt<std::string>
   OutputFile("output", cl::desc("Specify a reference program output "
                                 "(for miscompilation detection)"));
 }
@@ -62,57 +62,68 @@ std::string llvm::getPassesString(const std::vector<const PassInfo*> &Passes) {
   return Result;
 }
 
-BugDriver::BugDriver(const char *toolname)
+BugDriver::BugDriver(const char *toolname, bool as_child, bool find_bugs,
+                     unsigned timeout, unsigned memlimit)
   : ToolName(toolname), ReferenceOutputFile(OutputFile),
-    Program(0), Interpreter(0), cbe(0), gcc(0) {}
+    Program(0), Interpreter(0), cbe(0), gcc(0), run_as_child(as_child),
+    run_find_bugs(find_bugs), Timeout(timeout), MemoryLimit(memlimit) {}
 
 
-/// ParseInputFile - Given a bytecode or assembly input filename, parse and
+/// ParseInputFile - Given a bitcode or assembly input filename, parse and
 /// return it, or return null if not possible.
 ///
-Module *llvm::ParseInputFile(const std::string &InputFilename) {
+Module *llvm::ParseInputFile(const std::string &Filename) {
+  std::auto_ptr<MemoryBuffer> Buffer(MemoryBuffer::getFileOrSTDIN(Filename));
   Module *Result = 0;
-  try {
-    Result = ParseBytecodeFile(InputFilename);
-    if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
-      std::cerr << "bugpoint: could not read input file '"
-                << InputFilename << "'!\n";
-    }
-  } catch (const ParseException &E) {
-    std::cerr << "bugpoint: " << E.getMessage() << '\n';
+  if (Buffer.get())
+    Result = ParseBitcodeFile(Buffer.get());
+  
+  ParseError Err;
+  if (!Result && !(Result = ParseAssemblyFile(Filename, &Err))) {
+    std::cerr << "bugpoint: " << Err.getMessage() << "\n"; 
     Result = 0;
   }
+  
   return Result;
 }
 
 // This method takes the specified list of LLVM input files, attempts to load
-// 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
+// them, either as assembly or bitcode, then link them together. It returns
+// true on failure (if, for example, an input bitcode 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!");
   assert(!Filenames.empty() && "Must specify at least on input filename!");
 
-  // Load the first input file...
-  Program = ParseInputFile(Filenames[0]);
-  if (Program == 0) return true;
-  std::cout << "Read input file      : '" << Filenames[0] << "'\n";
-
-  for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
-    std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
-    if (M.get() == 0) return true;
-
-    std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
-    std::string ErrorMessage;
-    if (LinkModules(Program, M.get(), &ErrorMessage)) {
-      std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
-                << ErrorMessage << '\n';
-      return true;
+  try {
+    // Load the first input file.
+    Program = ParseInputFile(Filenames[0]);
+    if (Program == 0) return true;
+    
+    if (!run_as_child)
+      std::cout << "Read input file      : '" << Filenames[0] << "'\n";
+
+    for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
+      std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
+      if (M.get() == 0) return true;
+
+      if (!run_as_child)
+        std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
+      std::string ErrorMessage;
+      if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) {
+        std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
+                  << ErrorMessage << '\n';
+        return true;
+      }
     }
+  } catch (const std::string &Error) {
+    std::cerr << ToolName << ": error reading input '" << Error << "'\n";
+    return true;
   }
 
-  std::cout << "*** All input ok\n";
+  if (!run_as_child)
+    std::cout << "*** All input ok\n";
 
   // All input files read successfully!
   return false;
@@ -124,19 +135,34 @@ bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
 /// variables are set up from command line arguments.
 ///
 bool BugDriver::run() {
-  // The first thing that we must do is determine what the problem is. Does the
-  // optimization series crash the compiler, or does it produce illegal code?
-  // We make the top-level decision by trying to run all of the passes on the
-  // the input program, which should generate a bytecode file.  If it does
-  // generate a bytecode file, then we know the compiler didn't crash, so try
-  // to diagnose a miscompilation.
+  // The first thing to do is determine if we're running as a child. If we are,
+  // then what to do is very narrow. This form of invocation is only called
+  // from the runPasses method to actually run those passes in a child process.
+  if (run_as_child) {
+    // Execute the passes
+    return runPassesAsChild(PassesToRun);
+  }
+  
+  if (run_find_bugs) {
+    // Rearrange the passes and apply them to the program. Repeat this process
+    // until the user kills the program or we find a bug.
+    return runManyPasses(PassesToRun);
+  }
+
+  // If we're not running as a child, the first thing that we must do is 
+  // determine what the problem is. Does the optimization series crash the 
+  // compiler, or does it produce illegal code?  We make the top-level 
+  // decision by trying to run all of the passes on the the input program, 
+  // which should generate a bitcode file.  If it does generate a bitcode 
+  // file, then we know the compiler didn't crash, so try to diagnose a 
+  // miscompilation.
   if (!PassesToRun.empty()) {
     std::cout << "Running selected passes on program to test for crash: ";
     if (runPasses(PassesToRun))
       return debugOptimizerCrash();
   }
 
-  // Set up the execution environment, selecting a method to run LLVM bytecode.
+  // Set up the execution environment, selecting a method to run LLVM bitcode.
   if (initializeExecutionEnvironment()) return true;
 
   // Test to see if we have a code generator crash.
@@ -157,28 +183,20 @@ bool BugDriver::run() {
   bool CreatedOutput = false;
   if (ReferenceOutputFile.empty()) {
     std::cout << "Generating reference output from raw program: ";
-    try {
-      ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
-      CreatedOutput = true;
-      std::cout << "Reference output is: " << ReferenceOutputFile << '\n';
-    } catch (ToolExecutionError &TEE) {
-      std::cerr << TEE.what();
-      if (Interpreter != cbe) {
-        std::cerr << "*** There is a bug running the C backend.  Either debug"
-                  << " it (use the -run-cbe bugpoint option), or fix the error"
-                  << " some other way.\n";
-        return 1;
-      }
+    if(!createReferenceFile(Program)){
       return debugCodeGeneratorCrash();
     }
+    CreatedOutput = true;
   }
 
   // Make sure the reference output file gets deleted on exit from this
   // function, if appropriate.
-  FileRemover RemoverInstance(ReferenceOutputFile, CreatedOutput);
+  sys::Path ROF(ReferenceOutputFile);
+  FileRemover RemoverInstance(ROF, CreatedOutput);
 
   // Diff the output of the raw program against the reference output.  If it
-  // matches, then we have a miscompilation bug.
+  // matches, then we assume there is a miscompilation bug and try to 
+  // diagnose it.
   std::cout << "*** Checking the code generator...\n";
   try {
     if (!diffProgram()) {
@@ -209,3 +227,13 @@ void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) {
     std::cout << "... <" << Funcs.size() << " total>";
   std::cout << std::flush;
 }
+
+void llvm::PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs) {
+  unsigned NumPrint = GVs.size();
+  if (NumPrint > 10) NumPrint = 10;
+  for (unsigned i = 0; i != NumPrint; ++i)
+    std::cout << " " << GVs[i]->getName();
+  if (NumPrint < GVs.size())
+    std::cout << "... <" << GVs.size() << " total>";
+  std::cout << std::flush;
+}