tools/bugpoint/ExtractFunction.cpp

   1 //===- ExtractFunction.cpp - Extract a function from Program --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements several methods that are used to extract functions,
  11 // loops, or portions of a module from the rest of the module.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "BugDriver.h"
  16 #include "llvm/Constant.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/PassManager.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/Type.h"
  21 #include "llvm/Analysis/Verifier.h"
  22 #include "llvm/Transforms/IPO.h"
  23 #include "llvm/Transforms/Scalar.h"
  24 #include "llvm/Transforms/Utils/Cloning.h"
  25 #include "llvm/Transforms/Utils/FunctionUtils.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Support/CommandLine.h"
  28 #include "llvm/Support/Debug.h"
  29 #include "llvm/Support/FileUtilities.h"
  30 #include <set>
  31 using namespace llvm;
  32
  33 namespace llvm {
  34   bool DisableSimplifyCFG = false;
  35 } // End llvm namespace
  36
  37 namespace {
  38   cl::opt<bool>
  39   NoDCE ("disable-dce",
  40          cl::desc("Do not use the -dce pass to reduce testcases"));
  41   cl::opt<bool, true>
  42   NoSCFG("disable-simplifycfg", cl::location(DisableSimplifyCFG),
  43          cl::desc("Do not use the -simplifycfg pass to reduce testcases"));
  44 }
  45
  46 /// deleteInstructionFromProgram - This method clones the current Program and
  47 /// deletes the specified instruction from the cloned module.  It then runs a
  48 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code which
  49 /// depends on the value.  The modified module is then returned.
  50 ///
  51 Module *BugDriver::deleteInstructionFromProgram(const Instruction *I,
  52                                                 unsigned Simplification) const {
  53   Module *Result = CloneModule(Program);
  54
  55   const BasicBlock *PBB = I->getParent();
  56   const Function *PF = PBB->getParent();
  57
  58   Module::iterator RFI = Result->begin(); // Get iterator to corresponding fn
  59   std::advance(RFI, std::distance(PF->getParent()->begin(),
  60                                   Module::const_iterator(PF)));
  61
  62   Function::iterator RBI = RFI->begin();  // Get iterator to corresponding BB
  63   std::advance(RBI, std::distance(PF->begin(), Function::const_iterator(PBB)));
  64
  65   BasicBlock::iterator RI = RBI->begin(); // Get iterator to corresponding inst
  66   std::advance(RI, std::distance(PBB->begin(), BasicBlock::const_iterator(I)));
  67   Instruction *TheInst = RI;              // Got the corresponding instruction!
  68
  69   // If this instruction produces a value, replace any users with null values
  70   if (TheInst->getType() != Type::VoidTy)
  71     TheInst->replaceAllUsesWith(Constant::getNullValue(TheInst->getType()));
  72
  73   // Remove the instruction from the program.
  74   TheInst->getParent()->getInstList().erase(TheInst);
  75
  76   // Spiff up the output a little bit.
  77   PassManager Passes;
  78   // Make sure that the appropriate target data is always used...
  79   Passes.add(new TargetData("bugpoint", Result));
  80
  81   /// FIXME: If this used runPasses() like the methods below, we could get rid
  82   /// of the -disable-* options!
  83   if (Simplification > 1 && !NoDCE)
  84     Passes.add(createDeadCodeEliminationPass());
  85   if (Simplification && !DisableSimplifyCFG)
  86     Passes.add(createCFGSimplificationPass());      // Delete dead control flow
  87
  88   Passes.add(createVerifierPass());
  89   Passes.run(*Result);
  90   return Result;
  91 }
  92
  93 static const PassInfo *getPI(Pass *P) {
  94   const PassInfo *PI = P->getPassInfo();
  95   delete P;
  96   return PI;
  97 }
  98
  99 /// performFinalCleanups - This method clones the current Program and performs
 100 /// a series of cleanups intended to get rid of extra cruft on the module
 101 /// before handing it to the user.
 102 ///
 103 Module *BugDriver::performFinalCleanups(Module *M, bool MayModifySemantics) {
 104   // Make all functions external, so GlobalDCE doesn't delete them...
 105   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 106     I->setLinkage(GlobalValue::ExternalLinkage);
 107
 108   std::vector<const PassInfo*> CleanupPasses;
 109   CleanupPasses.push_back(getPI(createFunctionResolvingPass()));
 110   CleanupPasses.push_back(getPI(createGlobalDCEPass()));
 111   CleanupPasses.push_back(getPI(createDeadTypeEliminationPass()));
 112
 113   if (MayModifySemantics)
 114     CleanupPasses.push_back(getPI(createDeadArgHackingPass()));
 115   else
 116     CleanupPasses.push_back(getPI(createDeadArgEliminationPass()));
 117
 118   Module *New = runPassesOn(M, CleanupPasses);
 119   if (New == 0) {
 120     std::cerr << "Final cleanups failed.  Sorry. :(  Please report a bug!\n";
 121     return M;
 122   }
 123   delete M;
 124   return New;
 125 }
 126
 127
 128 /// ExtractLoop - Given a module, extract up to one loop from it into a new
 129 /// function.  This returns null if there are no extractable loops in the
 130 /// program or if the loop extractor crashes.
 131 Module *BugDriver::ExtractLoop(Module *M) {
 132   std::vector<const PassInfo*> LoopExtractPasses;
 133   LoopExtractPasses.push_back(getPI(createSingleLoopExtractorPass()));
 134
 135   Module *NewM = runPassesOn(M, LoopExtractPasses);
 136   if (NewM == 0) {
 137     Module *Old = swapProgramIn(M);
 138     std::cout << "*** Loop extraction failed: ";
 139     EmitProgressBytecode("loopextraction", true);
 140     std::cout << "*** Sorry. :(  Please report a bug!\n";
 141     swapProgramIn(Old);
 142     return 0;
 143   }
 144
 145   // Check to see if we created any new functions.  If not, no loops were
 146   // extracted and we should return null.  Limit the number of loops we extract
 147   // to avoid taking forever.
 148   static unsigned NumExtracted = 32;
 149   if (M->size() == NewM->size() || --NumExtracted == 0) {
 150     delete NewM;
 151     return 0;
 152   } else {
 153     assert(M->size() < NewM->size() && "Loop extract removed functions?");
 154     Module::iterator MI = NewM->begin();
 155     for (unsigned i = 0, e = M->size(); i != e; ++i)
 156       ++MI;
 157   }
 158
 159   return NewM;
 160 }
 161
 162
 163 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
 164 // blocks, making it external.
 165 //
 166 void llvm::DeleteFunctionBody(Function *F) {
 167   // delete the body of the function...
 168   F->deleteBody();
 169   assert(F->isExternal() && "This didn't make the function external!");
 170 }
 171
 172 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
 173 /// module, split the functions OUT of the specified module, and place them in
 174 /// the new module.
 175 ///
 176 /// FIXME: this could be made DRAMATICALLY more efficient for large programs if
 177 /// we just MOVED functions from one module to the other, instead of cloning the
 178 /// whole module, then proceeding to delete an entire module's worth of stuff.
 179 ///
 180 Module *llvm::SplitFunctionsOutOfModule(Module *M,
 181                                         const std::vector<Function*> &F) {
 182   // Make sure functions & globals are all external so that linkage
 183   // between the two modules will work.
 184   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 185     I->setLinkage(GlobalValue::ExternalLinkage);
 186   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 187     I->setLinkage(GlobalValue::ExternalLinkage);
 188
 189   Module *New = CloneModule(M);
 190
 191   // Make sure global initializers exist only in the safe module (CBE->.so)
 192   for (Module::giterator I = New->gbegin(), E = New->gend(); I != E; ++I)
 193     I->setInitializer(0);  // Delete the initializer to make it external
 194
 195   // Remove the Test functions from the Safe module
 196   std::set<std::pair<std::string, const PointerType*> > TestFunctions;
 197   for (unsigned i = 0, e = F.size(); i != e; ++i) {
 198     TestFunctions.insert(std::make_pair(F[i]->getName(), F[i]->getType()));
 199     Function *TNOF = M->getFunction(F[i]->getName(), F[i]->getFunctionType());
 200     DEBUG(std::cerr << "Removing function " << F[i]->getName() << "\n");
 201     assert(TNOF && "Function doesn't exist in module!");
 202     DeleteFunctionBody(TNOF);       // Function is now external in this module!
 203   }
 204
 205   // Remove the Safe functions from the Test module
 206   for (Module::iterator I = New->begin(), E = New->end(); I != E; ++I)
 207     if (!TestFunctions.count(std::make_pair(I->getName(), I->getType())))
 208       DeleteFunctionBody(I);
 209   return New;
 210 }
 211
 212 //===----------------------------------------------------------------------===//
 213 // Basic Block Extraction Code
 214 //===----------------------------------------------------------------------===//
 215
 216 namespace {
 217   std::vector<BasicBlock*> BlocksToNotExtract;
 218
 219   /// BlockExtractorPass - This pass is used by bugpoint to extract all blocks
 220   /// from the module into their own functions except for those specified by the
 221   /// BlocksToNotExtract list.
 222   class BlockExtractorPass : public ModulePass {
 223     bool runOnModule(Module &M);
 224   };
 225   RegisterOpt<BlockExtractorPass>
 226   XX("extract-bbs", "Extract Basic Blocks From Module (for bugpoint use)");
 227 }
 228
 229 bool BlockExtractorPass::runOnModule(Module &M) {
 230   std::set<BasicBlock*> TranslatedBlocksToNotExtract;
 231   for (unsigned i = 0, e = BlocksToNotExtract.size(); i != e; ++i) {
 232     BasicBlock *BB = BlocksToNotExtract[i];
 233     Function *F = BB->getParent();
 234
 235     // Map the corresponding function in this module.
 236     Function *MF = M.getFunction(F->getName(), F->getFunctionType());
 237
 238     // Figure out which index the basic block is in its function.
 239     Function::iterator BBI = MF->begin();
 240     std::advance(BBI, std::distance(F->begin(), Function::iterator(BB)));
 241     TranslatedBlocksToNotExtract.insert(BBI);
 242   }
 243
 244   // Now that we know which blocks to not extract, figure out which ones we WANT
 245   // to extract.
 246   std::vector<BasicBlock*> BlocksToExtract;
 247   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
 248     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 249       if (!TranslatedBlocksToNotExtract.count(BB))
 250         BlocksToExtract.push_back(BB);
 251
 252   for (unsigned i = 0, e = BlocksToExtract.size(); i != e; ++i)
 253     ExtractBasicBlock(BlocksToExtract[i]);
 254
 255   return !BlocksToExtract.empty();
 256 }
 257
 258 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks
 259 /// into their own functions.  The only detail is that M is actually a module
 260 /// cloned from the one the BBs are in, so some mapping needs to be performed.
 261 /// If this operation fails for some reason (ie the implementation is buggy),
 262 /// this function should return null, otherwise it returns a new Module.
 263 Module *BugDriver::ExtractMappedBlocksFromModule(const
 264                                                  std::vector<BasicBlock*> &BBs,
 265                                                  Module *M) {
 266   // Set the global list so that pass will be able to access it.
 267   BlocksToNotExtract = BBs;
 268
 269   std::vector<const PassInfo*> PI;
 270   PI.push_back(getPI(new BlockExtractorPass()));
 271   Module *Ret = runPassesOn(M, PI);
 272   BlocksToNotExtract.clear();
 273   if (Ret == 0) {
 274     std::cout << "*** Basic Block extraction failed, please report a bug!\n";
 275     M = swapProgramIn(M);
 276     EmitProgressBytecode("basicblockextractfail", true);
 277     M = swapProgramIn(M);
 278   }
 279   return Ret;
 280 }