finegrainify namespacification
[oota-llvm.git] / tools / bugpoint / CrashDebugger.cpp
index 2d224f3fbadbccd4504084dac13f914ee3689b16..ecb17342cb71210fb17b0ab224af8fc504fc0f25 100644 (file)
 //===- CrashDebugger.cpp - Debug compilation crashes ----------------------===//
+// 
+//                     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 the bugpoint internals that narrow down compilation crashes
 //
 //===----------------------------------------------------------------------===//
 
 #include "BugDriver.h"
-#include "SystemUtils.h"
 #include "ListReducer.h"
-#include "llvm/Module.h"
-#include "llvm/PassManager.h"
-#include "llvm/Pass.h"
 #include "llvm/Constant.h"
 #include "llvm/iTerminators.h"
-#include "llvm/Type.h"
+#include "llvm/Module.h"
+#include "llvm/Pass.h"
+#include "llvm/PassManager.h"
 #include "llvm/SymbolTable.h"
-#include "llvm/Support/CFG.h"
+#include "llvm/Type.h"
 #include "llvm/Analysis/Verifier.h"
+#include "llvm/Bytecode/Writer.h"
+#include "llvm/Support/CFG.h"
 #include "llvm/Transforms/Scalar.h"
 #include "llvm/Transforms/Utils/Cloning.h"
-#include "llvm/Bytecode/Writer.h"
+#include "Support/FileUtilities.h"
 #include <fstream>
 #include <set>
+using namespace llvm;
 
-class DebugCrashes : public ListReducer<const PassInfo*> {
-  BugDriver &BD;
-public:
-  DebugCrashes(BugDriver &bd) : BD(bd) {}
-
-  // doTest - Return true iff running the "removed" passes succeeds, and running
-  // the "Kept" passes fail when run on the output of the "removed" passes.  If
-  // we return true, we update the current module of bugpoint.
-  //
-  virtual TestResult doTest(std::vector<const PassInfo*> &Removed,
-                            std::vector<const PassInfo*> &Kept);
-};
+namespace llvm {
+  class DebugCrashes : public ListReducer<const PassInfo*> {
+    BugDriver &BD;
+  public:
+    DebugCrashes(BugDriver &bd) : BD(bd) {}
+    
+    // doTest - Return true iff running the "removed" passes succeeds, and
+    // running the "Kept" passes fail when run on the output of the "removed"
+    // passes.  If we return true, we update the current module of bugpoint.
+    //
+    virtual TestResult doTest(std::vector<const PassInfo*> &Removed,
+                              std::vector<const PassInfo*> &Kept);
+  };
+}
 
 DebugCrashes::TestResult
 DebugCrashes::doTest(std::vector<const PassInfo*> &Prefix,
                      std::vector<const PassInfo*> &Suffix) {
   std::string PrefixOutput;
+  Module *OrigProgram = 0;
   if (!Prefix.empty()) {
     std::cout << "Checking to see if these passes crash: "
               << getPassesString(Prefix) << ": ";
     if (BD.runPasses(Prefix, PrefixOutput))
       return KeepPrefix;
+
+    OrigProgram = BD.Program;
+
+    BD.Program = BD.ParseInputFile(PrefixOutput);
+    if (BD.Program == 0) {
+      std::cerr << BD.getToolName() << ": Error reading bytecode file '"
+                << PrefixOutput << "'!\n";
+      exit(1);
+    }
+    removeFile(PrefixOutput);
   }
 
   std::cout << "Checking to see if these passes crash: "
             << getPassesString(Suffix) << ": ";
-  Module *OrigProgram = BD.Program;
-  BD.Program = BD.ParseInputFile(PrefixOutput);
-  if (BD.Program == 0) {
-    std::cerr << BD.getToolName() << ": Error reading bytecode file '"
-              << PrefixOutput << "'!\n";
-    exit(1);
-  }
-  removeFile(PrefixOutput);
-
+  
   if (BD.runPasses(Suffix)) {
     delete OrigProgram;            // The suffix crashes alone...
     return KeepSuffix;
   }
 
   // Nothing failed, restore state...
-  delete BD.Program;
-  BD.Program = OrigProgram;
+  if (OrigProgram) {
+    delete BD.Program;
+    BD.Program = OrigProgram;
+  }
   return NoFailure;
 }
 
-class ReduceCrashingFunctions : public ListReducer<Function*> {
-  BugDriver &BD;
-public:
-  ReduceCrashingFunctions(BugDriver &bd) : BD(bd) {}
-
-  virtual TestResult doTest(std::vector<Function*> &Prefix,
-                            std::vector<Function*> &Kept) {
-    if (TestFuncs(Kept))
-      return KeepSuffix;
-    if (!Prefix.empty() && TestFuncs(Prefix))
-      return KeepPrefix;
-    return NoFailure;
-  }
-  
-  bool TestFuncs(std::vector<Function*> &Prefix);
-};
+namespace llvm {
+  class ReduceCrashingFunctions : public ListReducer<Function*> {
+    BugDriver &BD;
+  public:
+    ReduceCrashingFunctions(BugDriver &bd) : BD(bd) {}
+    
+    virtual TestResult doTest(std::vector<Function*> &Prefix,
+                              std::vector<Function*> &Kept) {
+      if (!Kept.empty() && TestFuncs(Kept))
+        return KeepSuffix;
+      if (!Prefix.empty() && TestFuncs(Prefix))
+        return KeepPrefix;
+      return NoFailure;
+    }
+    
+    bool TestFuncs(std::vector<Function*> &Prefix);
+  };
+}
 
 bool ReduceCrashingFunctions::TestFuncs(std::vector<Function*> &Funcs) {
-  // Clone the program to try hacking it appart...
+  // Clone the program to try hacking it apart...
   Module *M = CloneModule(BD.Program);
   
   // Convert list to set for fast lookup...
@@ -99,8 +116,12 @@ bool ReduceCrashingFunctions::TestFuncs(std::vector<Function*> &Funcs) {
   }
 
   std::cout << "Checking for crash with only these functions:";
-  for (unsigned i = 0, e = Funcs.size(); i != e; ++i)
+  unsigned NumPrint = Funcs.size();
+  if (NumPrint > 10) NumPrint = 10;
+  for (unsigned i = 0; i != NumPrint; ++i)
     std::cout << " " << Funcs[i]->getName();
+  if (NumPrint < Funcs.size())
+    std::cout << "... <" << Funcs.size() << " total>";
   std::cout << ": ";
 
   // Loop over and delete any functions which we aren't supposed to be playing
@@ -125,30 +146,32 @@ bool ReduceCrashingFunctions::TestFuncs(std::vector<Function*> &Funcs) {
 }
 
 
-/// ReduceCrashingBlocks reducer - This works by setting the terminators of all
-/// terminators except the specified basic blocks to a 'ret' instruction, then
-/// running the simplify-cfg pass.  This has the effect of chopping up the CFG
-/// really fast which can reduce large functions quickly.
-///
-class ReduceCrashingBlocks : public ListReducer<BasicBlock*> {
-  BugDriver &BD;
-public:
-  ReduceCrashingBlocks(BugDriver &bd) : BD(bd) {}
+namespace llvm {
+  /// ReduceCrashingBlocks reducer - This works by setting the terminators of
+  /// all terminators except the specified basic blocks to a 'ret' instruction,
+  /// then running the simplify-cfg pass.  This has the effect of chopping up
+  /// the CFG really fast which can reduce large functions quickly.
+  ///
+  class ReduceCrashingBlocks : public ListReducer<BasicBlock*> {
+    BugDriver &BD;
+  public:
+    ReduceCrashingBlocks(BugDriver &bd) : BD(bd) {}
     
-  virtual TestResult doTest(std::vector<BasicBlock*> &Prefix,
-                            std::vector<BasicBlock*> &Kept) {
-    if (TestBlocks(Kept))
-      return KeepSuffix;
-    if (!Prefix.empty() && TestBlocks(Prefix))
-      return KeepPrefix;
-    return NoFailure;
-  }
+    virtual TestResult doTest(std::vector<BasicBlock*> &Prefix,
+                              std::vector<BasicBlock*> &Kept) {
+      if (!Kept.empty() && TestBlocks(Kept))
+        return KeepSuffix;
+      if (!Prefix.empty() && TestBlocks(Prefix))
+        return KeepPrefix;
+      return NoFailure;
+    }
     
-  bool TestBlocks(std::vector<BasicBlock*> &Prefix);
-};
+    bool TestBlocks(std::vector<BasicBlock*> &Prefix);
+  };
+}
 
 bool ReduceCrashingBlocks::TestBlocks(std::vector<BasicBlock*> &BBs) {
-  // Clone the program to try hacking it appart...
+  // Clone the program to try hacking it apart...
   Module *M = CloneModule(BD.Program);
   
   // Convert list to set for fast lookup...
@@ -166,27 +189,34 @@ bool ReduceCrashingBlocks::TestBlocks(std::vector<BasicBlock*> &BBs) {
   }
 
   std::cout << "Checking for crash with only these blocks:";
-  for (unsigned i = 0, e = Blocks.size(); i != e; ++i)
+  unsigned NumPrint = Blocks.size();
+  if (NumPrint > 10) NumPrint = 10;
+  for (unsigned i = 0, e = NumPrint; i != e; ++i)
     std::cout << " " << BBs[i]->getName();
+  if (NumPrint < Blocks.size())
+    std::cout << "... <" << Blocks.size() << " total>";
   std::cout << ": ";
 
   // Loop over and delete any hack up any blocks that are not listed...
   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
     for (Function::iterator BB = I->begin(), E = I->end(); BB != E; ++BB)
-      if (!Blocks.count(BB) && !isa<ReturnInst>(BB->getTerminator())) {
+      if (!Blocks.count(BB) && BB->getTerminator()->getNumSuccessors()) {
         // Loop over all of the successors of this block, deleting any PHI nodes
         // that might include it.
         for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
           (*SI)->removePredecessor(BB);
 
+        if (BB->getTerminator()->getType() != Type::VoidTy)
+          BB->getTerminator()->replaceAllUsesWith(
+                      Constant::getNullValue(BB->getTerminator()->getType()));
+
         // Delete the old terminator instruction...
         BB->getInstList().pop_back();
         
         // Add a new return instruction of the appropriate type...
         const Type *RetTy = BB->getParent()->getReturnType();
-        ReturnInst *RI = new ReturnInst(RetTy == Type::VoidTy ? 0 :
-                                        Constant::getNullValue(RetTy));
-        BB->getInstList().push_back(RI);
+        new ReturnInst(RetTy == Type::VoidTy ? 0 :
+                       Constant::getNullValue(RetTy), BB);
       }
 
   // The CFG Simplifier pass may delete one of the basic blocks we are
@@ -244,6 +274,36 @@ bool BugDriver::debugCrash() {
             << getPassesString(PassesToRun) << "\n";
 
   EmitProgressBytecode("passinput");
+
+  // See if we can get away with nuking all of the global variable initializers
+  // in the program...
+  if (Program->gbegin() != Program->gend()) {
+    Module *M = CloneModule(Program);
+    bool DeletedInit = false;
+    for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
+      if (I->hasInitializer()) {
+        I->setInitializer(0);
+        I->setLinkage(GlobalValue::ExternalLinkage);
+        DeletedInit = true;
+      }
+    
+    if (!DeletedInit) {
+      delete M;  // No change made...
+    } else {
+      // See if the program still causes a crash...
+      std::cout << "\nChecking to see if we can delete global inits: ";
+      std::swap(Program, M);
+      if (runPasses(PassesToRun)) {  // Still crashes?
+        AnyReduction = true;
+        delete M;
+        std::cout << "\n*** Able to remove all global initializers!\n";
+      } else {                       // No longer crashes?
+        delete Program;              // Restore program.
+        Program = M;
+        std::cout << "  - Removing all global inits hides problem!\n";
+      }
+    }
+  }
   
   // Now try to reduce the number of functions in the module to something small.
   std::vector<Function*> Functions;
@@ -269,11 +329,13 @@ bool BugDriver::debugCrash() {
   // to a return instruction then running simplifycfg, which can potentially
   // shrinks the code dramatically quickly
   //
-  std::vector<BasicBlock*> Blocks;
-  for (Module::iterator I = Program->begin(), E = Program->end(); I != E; ++I)
-    for (Function::iterator FI = I->begin(), E = I->end(); FI != E; ++FI)
-      Blocks.push_back(FI);
-  ReduceCrashingBlocks(*this).reduceList(Blocks);
+  if (!DisableSimplifyCFG) {
+    std::vector<BasicBlock*> Blocks;
+    for (Module::iterator I = Program->begin(), E = Program->end(); I != E; ++I)
+      for (Function::iterator FI = I->begin(), E = I->end(); FI != E; ++FI)
+        Blocks.push_back(FI);
+    ReduceCrashingBlocks(*this).reduceList(Blocks);
+  }
 
   // FIXME: This should use the list reducer to converge faster by deleting
   // larger chunks of instructions at a time!
@@ -283,8 +345,8 @@ bool BugDriver::debugCrash() {
     std::cout << "\n*** Attempting to reduce testcase by deleting instruc"
               << "tions: Simplification Level #" << Simplification << "\n";
 
-    // Now that we have deleted the functions that are unneccesary for the
-    // program, try to remove instructions that are not neccesary to cause the
+    // Now that we have deleted the functions that are unnecessary for the
+    // program, try to remove instructions that are not necessary to cause the
     // crash.  To do this, we loop through all of the instructions in the
     // remaining functions, deleting them (replacing any values produced with
     // nulls), and then running ADCE and SimplifyCFG.  If the transformed input
@@ -325,20 +387,19 @@ bool BugDriver::debugCrash() {
   } while (Simplification);
 
   // Try to clean up the testcase by running funcresolve and globaldce...
-  if (AnyReduction) {
-    std::cout << "\n*** Attempting to perform final cleanups: ";
-    Module *M = performFinalCleanups();
-    std::swap(Program, M);
+  std::cout << "\n*** Attempting to perform final cleanups: ";
+  Module *M = CloneModule(Program);
+  M = performFinalCleanups(M, true);
+  std::swap(Program, M);
             
-    // Find out if the pass still crashes on the cleaned up program...
-    if (runPasses(PassesToRun)) {
-      // Yup, it does, keep the reduced version...
-      delete M;
-      AnyReduction = true;
-    } else {
-      delete Program;   // Otherwise, restore the original module...
-      Program = M;
-    }
+  // Find out if the pass still crashes on the cleaned up program...
+  if (runPasses(PassesToRun)) {
+    // Yup, it does, keep the reduced version...
+    delete M;
+    AnyReduction = true;
+  } else {
+    delete Program;   // Otherwise, restore the original module...
+    Program = M;
   }
 
   if (AnyReduction)
@@ -346,3 +407,4 @@ bool BugDriver::debugCrash() {
 
   return false;
 }
+