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/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/PassManager.h"
  20 #include "llvm/Pass.h"
  21 #include "llvm/SymbolTable.h"
  22 #include "llvm/Analysis/Verifier.h"
  23 #include "llvm/Transforms/IPO.h"
  24 #include "llvm/Transforms/Scalar.h"
  25 #include "llvm/Transforms/Utils/Cloning.h"
  26 #include "llvm/Transforms/Utils/FunctionUtils.h"
  27 #include "llvm/Target/TargetData.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/Support/FileUtilities.h"
  31 #include <set>
  32 #include <iostream>
  33 using namespace llvm;
  34
  35 namespace llvm {
  36   bool DisableSimplifyCFG = false;
  37 } // End llvm namespace
  38
  39 namespace {
  40   cl::opt<bool>
  41   NoDCE ("disable-dce",
  42          cl::desc("Do not use the -dce pass to reduce testcases"));
  43   cl::opt<bool, true>
  44   NoSCFG("disable-simplifycfg", cl::location(DisableSimplifyCFG),
  45          cl::desc("Do not use the -simplifycfg pass to reduce testcases"));
  46 }
  47
  48 /// deleteInstructionFromProgram - This method clones the current Program and
  49 /// deletes the specified instruction from the cloned module.  It then runs a
  50 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code which
  51 /// depends on the value.  The modified module is then returned.
  52 ///
  53 Module *BugDriver::deleteInstructionFromProgram(const Instruction *I,
  54                                                 unsigned Simplification) const {
  55   Module *Result = CloneModule(Program);
  56
  57   const BasicBlock *PBB = I->getParent();
  58   const Function *PF = PBB->getParent();
  59
  60   Module::iterator RFI = Result->begin(); // Get iterator to corresponding fn
  61   std::advance(RFI, std::distance(PF->getParent()->begin(),
  62                                   Module::const_iterator(PF)));
  63
  64   Function::iterator RBI = RFI->begin();  // Get iterator to corresponding BB
  65   std::advance(RBI, std::distance(PF->begin(), Function::const_iterator(PBB)));
  66
  67   BasicBlock::iterator RI = RBI->begin(); // Get iterator to corresponding inst
  68   std::advance(RI, std::distance(PBB->begin(), BasicBlock::const_iterator(I)));
  69   Instruction *TheInst = RI;              // Got the corresponding instruction!
  70
  71   // If this instruction produces a value, replace any users with null values
  72   if (TheInst->getType() != Type::VoidTy)
  73     TheInst->replaceAllUsesWith(Constant::getNullValue(TheInst->getType()));
  74
  75   // Remove the instruction from the program.
  76   TheInst->getParent()->getInstList().erase(TheInst);
  77
  78
  79   //writeProgramToFile("current.bc", Result);
  80
  81   // Spiff up the output a little bit.
  82   PassManager Passes;
  83   // Make sure that the appropriate target data is always used...
  84   Passes.add(new TargetData(Result));
  85
  86   /// FIXME: If this used runPasses() like the methods below, we could get rid
  87   /// of the -disable-* options!
  88   if (Simplification > 1 && !NoDCE)
  89     Passes.add(createDeadCodeEliminationPass());
  90   if (Simplification && !DisableSimplifyCFG)
  91     Passes.add(createCFGSimplificationPass());      // Delete dead control flow
  92
  93   Passes.add(createVerifierPass());
  94   Passes.run(*Result);
  95   return Result;
  96 }
  97
  98 static const PassInfo *getPI(Pass *P) {
  99   const PassInfo *PI = P->getPassInfo();
 100   delete P;
 101   return PI;
 102 }
 103
 104 /// performFinalCleanups - This method clones the current Program and performs
 105 /// a series of cleanups intended to get rid of extra cruft on the module
 106 /// before handing it to the user.
 107 ///
 108 Module *BugDriver::performFinalCleanups(Module *M, bool MayModifySemantics) {
 109   // Make all functions external, so GlobalDCE doesn't delete them...
 110   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 111     I->setLinkage(GlobalValue::ExternalLinkage);
 112
 113   std::vector<const PassInfo*> CleanupPasses;
 114   CleanupPasses.push_back(getPI(createFunctionResolvingPass()));
 115   CleanupPasses.push_back(getPI(createGlobalDCEPass()));
 116   CleanupPasses.push_back(getPI(createDeadTypeEliminationPass()));
 117
 118   if (MayModifySemantics)
 119     CleanupPasses.push_back(getPI(createDeadArgHackingPass()));
 120   else
 121     CleanupPasses.push_back(getPI(createDeadArgEliminationPass()));
 122
 123   Module *New = runPassesOn(M, CleanupPasses);
 124   if (New == 0) {
 125     std::cerr << "Final cleanups failed.  Sorry. :(  Please report a bug!\n";
 126     return M;
 127   }
 128   delete M;
 129   return New;
 130 }
 131
 132
 133 /// ExtractLoop - Given a module, extract up to one loop from it into a new
 134 /// function.  This returns null if there are no extractable loops in the
 135 /// program or if the loop extractor crashes.
 136 Module *BugDriver::ExtractLoop(Module *M) {
 137   std::vector<const PassInfo*> LoopExtractPasses;
 138   LoopExtractPasses.push_back(getPI(createSingleLoopExtractorPass()));
 139
 140   Module *NewM = runPassesOn(M, LoopExtractPasses);
 141   if (NewM == 0) {
 142     Module *Old = swapProgramIn(M);
 143     std::cout << "*** Loop extraction failed: ";
 144     EmitProgressBytecode("loopextraction", true);
 145     std::cout << "*** Sorry. :(  Please report a bug!\n";
 146     swapProgramIn(Old);
 147     return 0;
 148   }
 149
 150   // Check to see if we created any new functions.  If not, no loops were
 151   // extracted and we should return null.  Limit the number of loops we extract
 152   // to avoid taking forever.
 153   static unsigned NumExtracted = 32;
 154   if (M->size() == NewM->size() || --NumExtracted == 0) {
 155     delete NewM;
 156     return 0;
 157   } else {
 158     assert(M->size() < NewM->size() && "Loop extract removed functions?");
 159     Module::iterator MI = NewM->begin();
 160     for (unsigned i = 0, e = M->size(); i != e; ++i)
 161       ++MI;
 162   }
 163
 164   return NewM;
 165 }
 166
 167
 168 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
 169 // blocks, making it external.
 170 //
 171 void llvm::DeleteFunctionBody(Function *F) {
 172   // delete the body of the function...
 173   F->deleteBody();
 174   assert(F->isExternal() && "This didn't make the function external!");
 175 }
 176
 177 /// GetTorInit - Given a list of entries for static ctors/dtors, return them
 178 /// as a constant array.
 179 static Constant *GetTorInit(std::vector<std::pair<Function*, int> > &TorList) {
 180   assert(!TorList.empty() && "Don't create empty tor list!");
 181   std::vector<Constant*> ArrayElts;
 182   for (unsigned i = 0, e = TorList.size(); i != e; ++i) {
 183     std::vector<Constant*> Elts;
 184     Elts.push_back(ConstantInt::get(Type::IntTy, TorList[i].second));
 185     Elts.push_back(TorList[i].first);
 186     ArrayElts.push_back(ConstantStruct::get(Elts));
 187   }
 188   return ConstantArray::get(ArrayType::get(ArrayElts[0]->getType(),
 189                                            ArrayElts.size()),
 190                             ArrayElts);
 191 }
 192
 193 /// SplitStaticCtorDtor - A module was recently split into two parts, M1/M2, and
 194 /// M1 has all of the global variables.  If M2 contains any functions that are
 195 /// static ctors/dtors, we need to add an llvm.global_[cd]tors global to M2, and
 196 /// prune appropriate entries out of M1s list.
 197 static void SplitStaticCtorDtor(const char *GlobalName, Module *M1, Module *M2){
 198   GlobalVariable *GV = M1->getNamedGlobal(GlobalName);
 199   if (!GV || GV->isExternal() || GV->hasInternalLinkage() ||
 200       !GV->use_empty()) return;
 201
 202   std::vector<std::pair<Function*, int> > M1Tors, M2Tors;
 203   ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
 204   if (!InitList) return;
 205
 206   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
 207     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
 208       if (CS->getNumOperands() != 2) return;  // Not array of 2-element structs.
 209
 210       if (CS->getOperand(1)->isNullValue())
 211         break;  // Found a null terminator, stop here.
 212
 213       ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
 214       int Priority = CI ? CI->getSExtValue() : 0;
 215
 216       Constant *FP = CS->getOperand(1);
 217       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
 218         if (CE->getOpcode() == Instruction::Cast)
 219           FP = CE->getOperand(0);
 220       if (Function *F = dyn_cast<Function>(FP)) {
 221         if (!F->isExternal())
 222           M1Tors.push_back(std::make_pair(F, Priority));
 223         else {
 224           // Map to M2's version of the function.
 225           F = M2->getFunction(F->getName(), F->getFunctionType());
 226           M2Tors.push_back(std::make_pair(F, Priority));
 227         }
 228       }
 229     }
 230   }
 231
 232   GV->eraseFromParent();
 233   if (!M1Tors.empty()) {
 234     Constant *M1Init = GetTorInit(M1Tors);
 235     new GlobalVariable(M1Init->getType(), false, GlobalValue::AppendingLinkage,
 236                        M1Init, GlobalName, M1);
 237   }
 238
 239   GV = M2->getNamedGlobal(GlobalName);
 240   assert(GV && "Not a clone of M1?");
 241   assert(GV->use_empty() && "llvm.ctors shouldn't have uses!");
 242
 243   GV->eraseFromParent();
 244   if (!M2Tors.empty()) {
 245     Constant *M2Init = GetTorInit(M2Tors);
 246     new GlobalVariable(M2Init->getType(), false, GlobalValue::AppendingLinkage,
 247                        M2Init, GlobalName, M2);
 248   }
 249 }
 250
 251 /// RewriteUsesInNewModule - Given a constant 'OrigVal' and a module 'OrigMod',
 252 /// find all uses of the constant.  If they are not in the specified module,
 253 /// replace them with uses of another constant 'NewVal'.
 254 static void RewriteUsesInNewModule(Constant *OrigVal, Constant *NewVal,
 255                                    Module *OrigMod) {
 256   assert(OrigVal->getType() == NewVal->getType() &&
 257          "Can't replace something with a different type");
 258   for (Value::use_iterator UI = OrigVal->use_begin(), E = OrigVal->use_end();
 259        UI != E; ) {
 260     Value::use_iterator TmpUI = UI++;
 261     User *U = *TmpUI;
 262     if (Instruction *Inst = dyn_cast<Instruction>(U)) {
 263       if (Inst->getParent()->getParent()->getParent() != OrigMod)
 264         TmpUI.getUse() = NewVal;
 265     } else if (GlobalVariable *GV = dyn_cast<GlobalVariable>(U)) {
 266       if (GV->getParent() != OrigMod)
 267         TmpUI.getUse() = NewVal;
 268     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
 269       // If nothing uses this, don't bother making a copy.
 270       if (CE->use_empty()) continue;
 271       Constant *NewCE = CE->getWithOperandReplaced(TmpUI.getOperandNo(),
 272                                                    NewVal);
 273       RewriteUsesInNewModule(CE, NewCE, OrigMod);
 274     } else if (ConstantStruct *CS = dyn_cast<ConstantStruct>(U)) {
 275       // If nothing uses this, don't bother making a copy.
 276       if (CS->use_empty()) continue;
 277       unsigned OpNo = TmpUI.getOperandNo();
 278       std::vector<Constant*> Ops;
 279       for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
 280         Ops.push_back(i == OpNo ? NewVal : CS->getOperand(i));
 281       Constant *NewStruct = ConstantStruct::get(Ops);
 282       RewriteUsesInNewModule(CS, NewStruct, OrigMod);
 283      } else if (ConstantPacked *CP = dyn_cast<ConstantPacked>(U)) {
 284       // If nothing uses this, don't bother making a copy.
 285       if (CP->use_empty()) continue;
 286       unsigned OpNo = TmpUI.getOperandNo();
 287       std::vector<Constant*> Ops;
 288       for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
 289         Ops.push_back(i == OpNo ? NewVal : CP->getOperand(i));
 290       Constant *NewPacked = ConstantPacked::get(Ops);
 291       RewriteUsesInNewModule(CP, NewPacked, OrigMod);
 292     } else if (ConstantArray *CA = dyn_cast<ConstantArray>(U)) {
 293       // If nothing uses this, don't bother making a copy.
 294       if (CA->use_empty()) continue;
 295       unsigned OpNo = TmpUI.getOperandNo();
 296       std::vector<Constant*> Ops;
 297       for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) {
 298         Ops.push_back(i == OpNo ? NewVal : CA->getOperand(i));
 299       }
 300       Constant *NewArray = ConstantArray::get(CA->getType(), Ops);
 301       RewriteUsesInNewModule(CA, NewArray, OrigMod);
 302     } else {
 303       assert(0 && "Unexpected user");
 304     }
 305   }
 306 }
 307
 308
 309 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
 310 /// module, split the functions OUT of the specified module, and place them in
 311 /// the new module.
 312 Module *llvm::SplitFunctionsOutOfModule(Module *M,
 313                                         const std::vector<Function*> &F) {
 314   // Make sure functions & globals are all external so that linkage
 315   // between the two modules will work.
 316   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 317     I->setLinkage(GlobalValue::ExternalLinkage);
 318   for (Module::global_iterator I = M->global_begin(), E = M->global_end();
 319        I != E; ++I)
 320     I->setLinkage(GlobalValue::ExternalLinkage);
 321
 322   // First off, we need to create the new module...
 323   Module *New = new Module(M->getModuleIdentifier());
 324   New->setEndianness(M->getEndianness());
 325   New->setPointerSize(M->getPointerSize());
 326   New->setTargetTriple(M->getTargetTriple());
 327   New->setModuleInlineAsm(M->getModuleInlineAsm());
 328
 329   // Copy all of the dependent libraries over.
 330   for (Module::lib_iterator I = M->lib_begin(), E = M->lib_end(); I != E; ++I)
 331     New->addLibrary(*I);
 332
 333   // build a set of the functions to search later...
 334   std::set<std::pair<std::string, const PointerType*> > TestFunctions;
 335   for (unsigned i = 0, e = F.size(); i != e; ++i) {
 336     TestFunctions.insert(std::make_pair(F[i]->getName(), F[i]->getType()));
 337   }
 338
 339   std::map<GlobalValue*, GlobalValue*> GlobalToPrototypeMap;
 340   std::vector<GlobalValue*> OrigGlobals;
 341
 342   // Adding specified functions to new module...
 343   for (Module::iterator I = M->begin(), E = M->end(); I != E;) {
 344     OrigGlobals.push_back(I);
 345     if (TestFunctions.count(std::make_pair(I->getName(), I->getType()))) {
 346       Module::iterator tempI = I;
 347       I++;
 348       Function *Func = new Function(tempI->getFunctionType(),
 349                                     GlobalValue::ExternalLinkage);
 350       M->getFunctionList().insert(tempI, Func);
 351       New->getFunctionList().splice(New->end(),
 352                                     M->getFunctionList(),
 353                                     tempI);
 354       Func->setName(tempI->getName());
 355       Func->setCallingConv(tempI->getCallingConv());
 356       GlobalToPrototypeMap[tempI] = Func;
 357     } else {
 358       Function *Func = new Function(I->getFunctionType(),
 359                                     GlobalValue::ExternalLinkage,
 360                                     I->getName(),
 361                                     New);
 362       Func->setCallingConv(I->getCallingConv());
 363       GlobalToPrototypeMap[I] = Func;
 364       I++;
 365     }
 366   }
 367
 368   // Copy over global variable list.
 369   for (Module::global_iterator I = M->global_begin(), E = M->global_end();
 370        I != E; ++I) {
 371     OrigGlobals.push_back(I);
 372     GlobalVariable *G = new GlobalVariable(I->getType()->getElementType(),
 373                                            I->isConstant(),
 374                                            GlobalValue::ExternalLinkage,
 375                                            0, I->getName(), New);
 376     GlobalToPrototypeMap[I] = G;
 377   }
 378
 379   // Copy all of the type symbol table entries over.
 380   const SymbolTable &SymTab = M->getSymbolTable();
 381   SymbolTable::type_const_iterator TypeI = SymTab.type_begin();
 382   SymbolTable::type_const_iterator TypeE = SymTab.type_end();
 383   for (; TypeI != TypeE; ++TypeI)
 384     New->addTypeName(TypeI->first, TypeI->second);
 385
 386   // Loop over globals, rewriting uses in the module the prototype is in to use
 387   // the prototype.
 388   for (unsigned i = 0, e = OrigGlobals.size(); i != e; ++i) {
 389     assert(OrigGlobals[i]->getName() ==
 390            GlobalToPrototypeMap[OrigGlobals[i]]->getName() &&
 391            "Something got renamed?");
 392     RewriteUsesInNewModule(OrigGlobals[i], GlobalToPrototypeMap[OrigGlobals[i]],
 393                            OrigGlobals[i]->getParent());
 394   }
 395
 396   // Make sure that there is a global ctor/dtor array in both halves of the
 397   // module if they both have static ctor/dtor functions.
 398   SplitStaticCtorDtor("llvm.global_ctors", M, New);
 399   SplitStaticCtorDtor("llvm.global_dtors", M, New);
 400
 401   return New;
 402 }
 403
 404 //===----------------------------------------------------------------------===//
 405 // Basic Block Extraction Code
 406 //===----------------------------------------------------------------------===//
 407
 408 namespace {
 409   std::vector<BasicBlock*> BlocksToNotExtract;
 410
 411   /// BlockExtractorPass - This pass is used by bugpoint to extract all blocks
 412   /// from the module into their own functions except for those specified by the
 413   /// BlocksToNotExtract list.
 414   class BlockExtractorPass : public ModulePass {
 415     bool runOnModule(Module &M);
 416   };
 417   RegisterPass<BlockExtractorPass>
 418   XX("extract-bbs", "Extract Basic Blocks From Module (for bugpoint use)");
 419 }
 420
 421 bool BlockExtractorPass::runOnModule(Module &M) {
 422   std::set<BasicBlock*> TranslatedBlocksToNotExtract;
 423   for (unsigned i = 0, e = BlocksToNotExtract.size(); i != e; ++i) {
 424     BasicBlock *BB = BlocksToNotExtract[i];
 425     Function *F = BB->getParent();
 426
 427     // Map the corresponding function in this module.
 428     Function *MF = M.getFunction(F->getName(), F->getFunctionType());
 429
 430     // Figure out which index the basic block is in its function.
 431     Function::iterator BBI = MF->begin();
 432     std::advance(BBI, std::distance(F->begin(), Function::iterator(BB)));
 433     TranslatedBlocksToNotExtract.insert(BBI);
 434   }
 435
 436   // Now that we know which blocks to not extract, figure out which ones we WANT
 437   // to extract.
 438   std::vector<BasicBlock*> BlocksToExtract;
 439   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
 440     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 441       if (!TranslatedBlocksToNotExtract.count(BB))
 442         BlocksToExtract.push_back(BB);
 443
 444   for (unsigned i = 0, e = BlocksToExtract.size(); i != e; ++i)
 445     ExtractBasicBlock(BlocksToExtract[i]);
 446
 447   return !BlocksToExtract.empty();
 448 }
 449
 450 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks
 451 /// into their own functions.  The only detail is that M is actually a module
 452 /// cloned from the one the BBs are in, so some mapping needs to be performed.
 453 /// If this operation fails for some reason (ie the implementation is buggy),
 454 /// this function should return null, otherwise it returns a new Module.
 455 Module *BugDriver::ExtractMappedBlocksFromModule(const
 456                                                  std::vector<BasicBlock*> &BBs,
 457                                                  Module *M) {
 458   // Set the global list so that pass will be able to access it.
 459   BlocksToNotExtract = BBs;
 460
 461   std::vector<const PassInfo*> PI;
 462   PI.push_back(getPI(new BlockExtractorPass()));
 463   Module *Ret = runPassesOn(M, PI);
 464   BlocksToNotExtract.clear();
 465   if (Ret == 0) {
 466     std::cout << "*** Basic Block extraction failed, please report a bug!\n";
 467     M = swapProgramIn(M);
 468     EmitProgressBytecode("basicblockextractfail", true);
 469     swapProgramIn(M);
 470   }
 471   return Ret;
 472 }