lib/Transforms/IPO/MergeFunctions.cpp

   1 //===- MergeFunctions.cpp - Merge identical functions ---------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass looks for equivalent functions that are mergable and folds them.
  11 //
  12 // A hash is computed from the function, based on its type and number of
  13 // basic blocks.
  14 //
  15 // Once all hashes are computed, we perform an expensive equality comparison
  16 // on each function pair. This takes n^2/2 comparisons per bucket, so it's
  17 // important that the hash function be high quality. The equality comparison
  18 // iterates through each instruction in each basic block.
  19 //
  20 // When a match is found the functions are folded. If both functions are
  21 // overridable, we move the functionality into a new internal function and
  22 // leave two overridable thunks to it.
  23 //
  24 //===----------------------------------------------------------------------===//
  25 //
  26 // Future work:
  27 //
  28 // * virtual functions.
  29 //
  30 // Many functions have their address taken by the virtual function table for
  31 // the object they belong to. However, as long as it's only used for a lookup
  32 // and call, this is irrelevant, and we'd like to fold such functions.
  33 //
  34 // * switch from n^2 pair-wise comparisons to an n-way comparison for each
  35 // bucket.
  36 //
  37 // * be smarter about bitcasts.
  38 //
  39 // In order to fold functions, we will sometimes add either bitcast instructions
  40 // or bitcast constant expressions. Unfortunately, this can confound further
  41 // analysis since the two functions differ where one has a bitcast and the
  42 // other doesn't. We should learn to look through bitcasts.
  43 //
  44 //===----------------------------------------------------------------------===//
  45
  46 #define DEBUG_TYPE "mergefunc"
  47 #include "llvm/Transforms/IPO.h"
  48 #include "llvm/ADT/DenseSet.h"
  49 #include "llvm/ADT/FoldingSet.h"
  50 #include "llvm/ADT/SmallSet.h"
  51 #include "llvm/ADT/Statistic.h"
  52 #include "llvm/ADT/STLExtras.h"
  53 #include "llvm/Constants.h"
  54 #include "llvm/InlineAsm.h"
  55 #include "llvm/Instructions.h"
  56 #include "llvm/LLVMContext.h"
  57 #include "llvm/Module.h"
  58 #include "llvm/Pass.h"
  59 #include "llvm/Support/CallSite.h"
  60 #include "llvm/Support/Debug.h"
  61 #include "llvm/Support/ErrorHandling.h"
  62 #include "llvm/Support/IRBuilder.h"
  63 #include "llvm/Support/ValueHandle.h"
  64 #include "llvm/Support/raw_ostream.h"
  65 #include "llvm/Target/TargetData.h"
  66 #include <vector>
  67 using namespace llvm;
  68
  69 STATISTIC(NumFunctionsMerged, "Number of functions merged");
  70 STATISTIC(NumThunksWritten, "Number of thunks generated");
  71 STATISTIC(NumAliasesWritten, "Number of aliases generated");
  72 STATISTIC(NumDoubleWeak, "Number of new functions created");
  73
  74 /// ProfileFunction - Creates a hash-code for the function which is the same
  75 /// for any two functions that will compare equal, without looking at the
  76 /// instructions inside the function.
  77 static unsigned ProfileFunction(const Function *F) {
  78   const FunctionType *FTy = F->getFunctionType();
  79
  80   FoldingSetNodeID ID;
  81   ID.AddInteger(F->size());
  82   ID.AddInteger(F->getCallingConv());
  83   ID.AddBoolean(F->hasGC());
  84   ID.AddBoolean(FTy->isVarArg());
  85   ID.AddInteger(FTy->getReturnType()->getTypeID());
  86   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
  87     ID.AddInteger(FTy->getParamType(i)->getTypeID());
  88   return ID.ComputeHash();
  89 }
  90
  91 namespace {
  92
  93 /// ComparableFunction - A struct that pairs together functions with a
  94 /// TargetData so that we can keep them together as elements in the DenseSet.
  95 class ComparableFunction {
  96 public:
  97   static const ComparableFunction EmptyKey;
  98   static const ComparableFunction TombstoneKey;
  99
 100   ComparableFunction(Function *Func, TargetData *TD)
 101     : Func(Func), Hash(ProfileFunction(Func)), TD(TD) {}
 102
 103   Function *getFunc() const { return Func; }
 104   unsigned getHash() const { return Hash; }
 105   TargetData *getTD() const { return TD; }
 106
 107   // Drops AssertingVH reference to the function. Outside of debug mode, this
 108   // does nothing.
 109   void release() {
 110     assert(Func &&
 111            "Attempted to release function twice, or release empty/tombstone!");
 112     Func = NULL;
 113   }
 114
 115   bool &getOrInsertCachedComparison(const ComparableFunction &Other,
 116                                     bool &inserted) const {
 117     typedef DenseMap<Function *, bool>::iterator iterator;
 118     std::pair<iterator, bool> p =
 119         CompareResultCache.insert(std::make_pair(Other.getFunc(), false));
 120     inserted = p.second;
 121     return p.first->second;
 122   }
 123
 124 private:
 125   explicit ComparableFunction(unsigned Hash)
 126     : Func(NULL), Hash(Hash), TD(NULL) {}
 127
 128   // DenseMap::grow() triggers a recomparison of all keys in the map, which is
 129   // wildly expensive. This cache tries to preserve known results.
 130   mutable DenseMap<Function *, bool> CompareResultCache;
 131
 132   AssertingVH<Function> Func;
 133   unsigned Hash;
 134   TargetData *TD;
 135 };
 136
 137 const ComparableFunction ComparableFunction::EmptyKey = ComparableFunction(0);
 138 const ComparableFunction ComparableFunction::TombstoneKey =
 139     ComparableFunction(1);
 140
 141 }
 142
 143 namespace llvm {
 144   template <>
 145   struct DenseMapInfo<ComparableFunction> {
 146     static ComparableFunction getEmptyKey() {
 147       return ComparableFunction::EmptyKey;
 148     }
 149     static ComparableFunction getTombstoneKey() {
 150       return ComparableFunction::TombstoneKey;
 151     }
 152     static unsigned getHashValue(const ComparableFunction &CF) {
 153       return CF.getHash();
 154     }
 155     static bool isEqual(const ComparableFunction &LHS,
 156                         const ComparableFunction &RHS);
 157   };
 158 }
 159
 160 namespace {
 161
 162 /// FunctionComparator - Compares two functions to determine whether or not
 163 /// they will generate machine code with the same behaviour. TargetData is
 164 /// used if available. The comparator always fails conservatively (erring on the
 165 /// side of claiming that two functions are different).
 166 class FunctionComparator {
 167 public:
 168   FunctionComparator(const TargetData *TD, const Function *F1,
 169                      const Function *F2)
 170     : F1(F1), F2(F2), TD(TD), IDMap1Count(0), IDMap2Count(0) {}
 171
 172   /// Compare - test whether the two functions have equivalent behaviour.
 173   bool Compare();
 174
 175 private:
 176   /// Compare - test whether two basic blocks have equivalent behaviour.
 177   bool Compare(const BasicBlock *BB1, const BasicBlock *BB2);
 178
 179   /// Enumerate - Assign or look up previously assigned numbers for the two
 180   /// values, and return whether the numbers are equal. Numbers are assigned in
 181   /// the order visited.
 182   bool Enumerate(const Value *V1, const Value *V2);
 183
 184   /// isEquivalentOperation - Compare two Instructions for equivalence, similar
 185   /// to Instruction::isSameOperationAs but with modifications to the type
 186   /// comparison.
 187   bool isEquivalentOperation(const Instruction *I1,
 188                              const Instruction *I2) const;
 189
 190   /// isEquivalentGEP - Compare two GEPs for equivalent pointer arithmetic.
 191   bool isEquivalentGEP(const GEPOperator *GEP1, const GEPOperator *GEP2);
 192   bool isEquivalentGEP(const GetElementPtrInst *GEP1,
 193                        const GetElementPtrInst *GEP2) {
 194     return isEquivalentGEP(cast<GEPOperator>(GEP1), cast<GEPOperator>(GEP2));
 195   }
 196
 197   /// isEquivalentType - Compare two Types, treating all pointer types as equal.
 198   bool isEquivalentType(const Type *Ty1, const Type *Ty2) const;
 199
 200   // The two functions undergoing comparison.
 201   const Function *F1, *F2;
 202
 203   const TargetData *TD;
 204
 205   typedef DenseMap<const Value *, unsigned long> IDMap;
 206   IDMap Map1, Map2;
 207   unsigned long IDMap1Count, IDMap2Count;
 208 };
 209
 210 }
 211
 212 /// isEquivalentType - any two pointers in the same address space are
 213 /// equivalent. Otherwise, standard type equivalence rules apply.
 214 bool FunctionComparator::isEquivalentType(const Type *Ty1,
 215                                           const Type *Ty2) const {
 216   if (Ty1 == Ty2)
 217     return true;
 218   if (Ty1->getTypeID() != Ty2->getTypeID()) {
 219     if (TD) {
 220       LLVMContext &Ctx = Ty1->getContext();
 221       if (isa<PointerType>(Ty1) && Ty2 == TD->getIntPtrType(Ctx)) return true;
 222       if (isa<PointerType>(Ty2) && Ty1 == TD->getIntPtrType(Ctx)) return true;
 223     }
 224     return false;
 225   }
 226
 227   switch(Ty1->getTypeID()) {
 228   default:
 229     llvm_unreachable("Unknown type!");
 230     // Fall through in Release mode.
 231   case Type::IntegerTyID:
 232   case Type::OpaqueTyID:
 233   case Type::VectorTyID:
 234     // Ty1 == Ty2 would have returned true earlier.
 235     return false;
 236
 237   case Type::VoidTyID:
 238   case Type::FloatTyID:
 239   case Type::DoubleTyID:
 240   case Type::X86_FP80TyID:
 241   case Type::FP128TyID:
 242   case Type::PPC_FP128TyID:
 243   case Type::LabelTyID:
 244   case Type::MetadataTyID:
 245     return true;
 246
 247   case Type::PointerTyID: {
 248     const PointerType *PTy1 = cast<PointerType>(Ty1);
 249     const PointerType *PTy2 = cast<PointerType>(Ty2);
 250     return PTy1->getAddressSpace() == PTy2->getAddressSpace();
 251   }
 252
 253   case Type::StructTyID: {
 254     const StructType *STy1 = cast<StructType>(Ty1);
 255     const StructType *STy2 = cast<StructType>(Ty2);
 256     if (STy1->getNumElements() != STy2->getNumElements())
 257       return false;
 258
 259     if (STy1->isPacked() != STy2->isPacked())
 260       return false;
 261
 262     for (unsigned i = 0, e = STy1->getNumElements(); i != e; ++i) {
 263       if (!isEquivalentType(STy1->getElementType(i), STy2->getElementType(i)))
 264         return false;
 265     }
 266     return true;
 267   }
 268
 269   case Type::FunctionTyID: {
 270     const FunctionType *FTy1 = cast<FunctionType>(Ty1);
 271     const FunctionType *FTy2 = cast<FunctionType>(Ty2);
 272     if (FTy1->getNumParams() != FTy2->getNumParams() ||
 273         FTy1->isVarArg() != FTy2->isVarArg())
 274       return false;
 275
 276     if (!isEquivalentType(FTy1->getReturnType(), FTy2->getReturnType()))
 277       return false;
 278
 279     for (unsigned i = 0, e = FTy1->getNumParams(); i != e; ++i) {
 280       if (!isEquivalentType(FTy1->getParamType(i), FTy2->getParamType(i)))
 281         return false;
 282     }
 283     return true;
 284   }
 285
 286   case Type::ArrayTyID: {
 287     const ArrayType *ATy1 = cast<ArrayType>(Ty1);
 288     const ArrayType *ATy2 = cast<ArrayType>(Ty2);
 289     return ATy1->getNumElements() == ATy2->getNumElements() &&
 290            isEquivalentType(ATy1->getElementType(), ATy2->getElementType());
 291   }
 292   }
 293 }
 294
 295 /// isEquivalentOperation - determine whether the two operations are the same
 296 /// except that pointer-to-A and pointer-to-B are equivalent. This should be
 297 /// kept in sync with Instruction::isSameOperationAs.
 298 bool FunctionComparator::isEquivalentOperation(const Instruction *I1,
 299                                                const Instruction *I2) const {
 300   if (I1->getOpcode() != I2->getOpcode() ||
 301       I1->getNumOperands() != I2->getNumOperands() ||
 302       !isEquivalentType(I1->getType(), I2->getType()) ||
 303       !I1->hasSameSubclassOptionalData(I2))
 304     return false;
 305
 306   // We have two instructions of identical opcode and #operands.  Check to see
 307   // if all operands are the same type
 308   for (unsigned i = 0, e = I1->getNumOperands(); i != e; ++i)
 309     if (!isEquivalentType(I1->getOperand(i)->getType(),
 310                           I2->getOperand(i)->getType()))
 311       return false;
 312
 313   // Check special state that is a part of some instructions.
 314   if (const LoadInst *LI = dyn_cast<LoadInst>(I1))
 315     return LI->isVolatile() == cast<LoadInst>(I2)->isVolatile() &&
 316            LI->getAlignment() == cast<LoadInst>(I2)->getAlignment();
 317   if (const StoreInst *SI = dyn_cast<StoreInst>(I1))
 318     return SI->isVolatile() == cast<StoreInst>(I2)->isVolatile() &&
 319            SI->getAlignment() == cast<StoreInst>(I2)->getAlignment();
 320   if (const CmpInst *CI = dyn_cast<CmpInst>(I1))
 321     return CI->getPredicate() == cast<CmpInst>(I2)->getPredicate();
 322   if (const CallInst *CI = dyn_cast<CallInst>(I1))
 323     return CI->isTailCall() == cast<CallInst>(I2)->isTailCall() &&
 324            CI->getCallingConv() == cast<CallInst>(I2)->getCallingConv() &&
 325            CI->getAttributes() == cast<CallInst>(I2)->getAttributes();
 326   if (const InvokeInst *CI = dyn_cast<InvokeInst>(I1))
 327     return CI->getCallingConv() == cast<InvokeInst>(I2)->getCallingConv() &&
 328            CI->getAttributes() == cast<InvokeInst>(I2)->getAttributes();
 329   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(I1)) {
 330     if (IVI->getNumIndices() != cast<InsertValueInst>(I2)->getNumIndices())
 331       return false;
 332     for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
 333       if (IVI->idx_begin()[i] != cast<InsertValueInst>(I2)->idx_begin()[i])
 334         return false;
 335     return true;
 336   }
 337   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(I1)) {
 338     if (EVI->getNumIndices() != cast<ExtractValueInst>(I2)->getNumIndices())
 339       return false;
 340     for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
 341       if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I2)->idx_begin()[i])
 342         return false;
 343     return true;
 344   }
 345
 346   return true;
 347 }
 348
 349 /// isEquivalentGEP - determine whether two GEP operations perform the same
 350 /// underlying arithmetic.
 351 bool FunctionComparator::isEquivalentGEP(const GEPOperator *GEP1,
 352                                          const GEPOperator *GEP2) {
 353   // When we have target data, we can reduce the GEP down to the value in bytes
 354   // added to the address.
 355   if (TD && GEP1->hasAllConstantIndices() && GEP2->hasAllConstantIndices()) {
 356     SmallVector<Value *, 8> Indices1(GEP1->idx_begin(), GEP1->idx_end());
 357     SmallVector<Value *, 8> Indices2(GEP2->idx_begin(), GEP2->idx_end());
 358     uint64_t Offset1 = TD->getIndexedOffset(GEP1->getPointerOperandType(),
 359                                             Indices1.data(), Indices1.size());
 360     uint64_t Offset2 = TD->getIndexedOffset(GEP2->getPointerOperandType(),
 361                                             Indices2.data(), Indices2.size());
 362     return Offset1 == Offset2;
 363   }
 364
 365   if (GEP1->getPointerOperand()->getType() !=
 366       GEP2->getPointerOperand()->getType())
 367     return false;
 368
 369   if (GEP1->getNumOperands() != GEP2->getNumOperands())
 370     return false;
 371
 372   for (unsigned i = 0, e = GEP1->getNumOperands(); i != e; ++i) {
 373     if (!Enumerate(GEP1->getOperand(i), GEP2->getOperand(i)))
 374       return false;
 375   }
 376
 377   return true;
 378 }
 379
 380 /// Enumerate - Compare two values used by the two functions under pair-wise
 381 /// comparison. If this is the first time the values are seen, they're added to
 382 /// the mapping so that we will detect mismatches on next use.
 383 bool FunctionComparator::Enumerate(const Value *V1, const Value *V2) {
 384   // Check for function @f1 referring to itself and function @f2 referring to
 385   // itself, or referring to each other, or both referring to either of them.
 386   // They're all equivalent if the two functions are otherwise equivalent.
 387   if (V1 == F1 && V2 == F2)
 388     return true;
 389   if (V1 == F2 && V2 == F1)
 390     return true;
 391
 392   if (const Constant *C1 = dyn_cast<Constant>(V1)) {
 393     if (V1 == V2) return true;
 394     const Constant *C2 = dyn_cast<Constant>(V2);
 395     if (!C2) return false;
 396     // TODO: constant expressions with GEP or references to F1 or F2.
 397     if (C1->isNullValue() && C2->isNullValue() &&
 398         isEquivalentType(C1->getType(), C2->getType()))
 399       return true;
 400     // Try bitcasting C2 to C1's type. If the bitcast is legal and returns C1
 401     // then they must have equal bit patterns.
 402     return C1->getType()->canLosslesslyBitCastTo(C2->getType()) &&
 403       C1 == ConstantExpr::getBitCast(const_cast<Constant*>(C2), C1->getType());
 404   }
 405
 406   if (isa<InlineAsm>(V1) && isa<InlineAsm>(V2)) {
 407     const InlineAsm *IA1 = cast<InlineAsm>(V1);
 408     const InlineAsm *IA2 = cast<InlineAsm>(V2);
 409     return IA1->getAsmString() == IA2->getAsmString() &&
 410            IA1->getConstraintString() == IA2->getConstraintString();
 411   }
 412
 413   unsigned long &ID1 = Map1[V1];
 414   if (!ID1)
 415     ID1 = ++IDMap1Count;
 416
 417   unsigned long &ID2 = Map2[V2];
 418   if (!ID2)
 419     ID2 = ++IDMap2Count;
 420
 421   return ID1 == ID2;
 422 }
 423
 424 /// Compare - test whether two basic blocks have equivalent behaviour.
 425 bool FunctionComparator::Compare(const BasicBlock *BB1, const BasicBlock *BB2) {
 426   BasicBlock::const_iterator F1I = BB1->begin(), F1E = BB1->end();
 427   BasicBlock::const_iterator F2I = BB2->begin(), F2E = BB2->end();
 428
 429   do {
 430     if (!Enumerate(F1I, F2I))
 431       return false;
 432
 433     if (const GetElementPtrInst *GEP1 = dyn_cast<GetElementPtrInst>(F1I)) {
 434       const GetElementPtrInst *GEP2 = dyn_cast<GetElementPtrInst>(F2I);
 435       if (!GEP2)
 436         return false;
 437
 438       if (!Enumerate(GEP1->getPointerOperand(), GEP2->getPointerOperand()))
 439         return false;
 440
 441       if (!isEquivalentGEP(GEP1, GEP2))
 442         return false;
 443     } else {
 444       if (!isEquivalentOperation(F1I, F2I))
 445         return false;
 446
 447       assert(F1I->getNumOperands() == F2I->getNumOperands());
 448       for (unsigned i = 0, e = F1I->getNumOperands(); i != e; ++i) {
 449         Value *OpF1 = F1I->getOperand(i);
 450         Value *OpF2 = F2I->getOperand(i);
 451
 452         if (!Enumerate(OpF1, OpF2))
 453           return false;
 454
 455         if (OpF1->getValueID() != OpF2->getValueID() ||
 456             !isEquivalentType(OpF1->getType(), OpF2->getType()))
 457           return false;
 458       }
 459     }
 460
 461     ++F1I, ++F2I;
 462   } while (F1I != F1E && F2I != F2E);
 463
 464   return F1I == F1E && F2I == F2E;
 465 }
 466
 467 /// Compare - test whether the two functions have equivalent behaviour.
 468 bool FunctionComparator::Compare() {
 469   // We need to recheck everything, but check the things that weren't included
 470   // in the hash first.
 471
 472   if (F1->getAttributes() != F2->getAttributes())
 473     return false;
 474
 475   if (F1->hasGC() != F2->hasGC())
 476     return false;
 477
 478   if (F1->hasGC() && F1->getGC() != F2->getGC())
 479     return false;
 480
 481   if (F1->hasSection() != F2->hasSection())
 482     return false;
 483
 484   if (F1->hasSection() && F1->getSection() != F2->getSection())
 485     return false;
 486
 487   if (F1->isVarArg() != F2->isVarArg())
 488     return false;
 489
 490   // TODO: if it's internal and only used in direct calls, we could handle this
 491   // case too.
 492   if (F1->getCallingConv() != F2->getCallingConv())
 493     return false;
 494
 495   if (!isEquivalentType(F1->getFunctionType(), F2->getFunctionType()))
 496     return false;
 497
 498   assert(F1->arg_size() == F2->arg_size() &&
 499          "Identically typed functions have different numbers of args!");
 500
 501   // Visit the arguments so that they get enumerated in the order they're
 502   // passed in.
 503   for (Function::const_arg_iterator f1i = F1->arg_begin(),
 504          f2i = F2->arg_begin(), f1e = F1->arg_end(); f1i != f1e; ++f1i, ++f2i) {
 505     if (!Enumerate(f1i, f2i))
 506       llvm_unreachable("Arguments repeat!");
 507   }
 508
 509   // We do a CFG-ordered walk since the actual ordering of the blocks in the
 510   // linked list is immaterial. Our walk starts at the entry block for both
 511   // functions, then takes each block from each terminator in order. As an
 512   // artifact, this also means that unreachable blocks are ignored.
 513   SmallVector<const BasicBlock *, 8> F1BBs, F2BBs;
 514   SmallSet<const BasicBlock *, 128> VisitedBBs; // in terms of F1.
 515
 516   F1BBs.push_back(&F1->getEntryBlock());
 517   F2BBs.push_back(&F2->getEntryBlock());
 518
 519   VisitedBBs.insert(F1BBs[0]);
 520   while (!F1BBs.empty()) {
 521     const BasicBlock *F1BB = F1BBs.pop_back_val();
 522     const BasicBlock *F2BB = F2BBs.pop_back_val();
 523
 524     if (!Enumerate(F1BB, F2BB) || !Compare(F1BB, F2BB))
 525       return false;
 526
 527     const TerminatorInst *F1TI = F1BB->getTerminator();
 528     const TerminatorInst *F2TI = F2BB->getTerminator();
 529
 530     assert(F1TI->getNumSuccessors() == F2TI->getNumSuccessors());
 531     for (unsigned i = 0, e = F1TI->getNumSuccessors(); i != e; ++i) {
 532       if (!VisitedBBs.insert(F1TI->getSuccessor(i)))
 533         continue;
 534
 535       F1BBs.push_back(F1TI->getSuccessor(i));
 536       F2BBs.push_back(F2TI->getSuccessor(i));
 537     }
 538   }
 539   return true;
 540 }
 541
 542 namespace {
 543
 544 /// MergeFunctions finds functions which will generate identical machine code,
 545 /// by considering all pointer types to be equivalent. Once identified,
 546 /// MergeFunctions will fold them by replacing a call to one to a call to a
 547 /// bitcast of the other.
 548 ///
 549 class MergeFunctions : public ModulePass {
 550 public:
 551   static char ID;
 552   MergeFunctions()
 553     : ModulePass(ID), HasGlobalAliases(false) {
 554     initializeMergeFunctionsPass(*PassRegistry::getPassRegistry());
 555   }
 556
 557   bool runOnModule(Module &M);
 558
 559 private:
 560   typedef DenseSet<ComparableFunction> FnSetType;
 561
 562   /// A work queue of functions that may have been modified and should be
 563   /// analyzed again.
 564   std::vector<WeakVH> Deferred;
 565
 566   /// Insert a ComparableFunction into the FnSet, or merge it away if it's
 567   /// equal to one that's already present.
 568   bool Insert(ComparableFunction &NewF);
 569
 570   /// Remove a Function from the FnSet and queue it up for a second sweep of
 571   /// analysis.
 572   void Remove(Function *F);
 573
 574   /// Find the functions that use this Value and remove them from FnSet and
 575   /// queue the functions.
 576   void RemoveUsers(Value *V);
 577
 578   /// Replace all direct calls of Old with calls of New. Will bitcast New if
 579   /// necessary to make types match.
 580   void replaceDirectCallers(Function *Old, Function *New);
 581
 582   /// MergeTwoFunctions - Merge two equivalent functions. Upon completion, G
 583   /// may be deleted, or may be converted into a thunk. In either case, it
 584   /// should never be visited again.
 585   void MergeTwoFunctions(Function *F, Function *G);
 586
 587   /// WriteThunkOrAlias - Replace G with a thunk or an alias to F. Deletes G.
 588   void WriteThunkOrAlias(Function *F, Function *G);
 589
 590   /// WriteThunk - Replace G with a simple tail call to bitcast(F). Also
 591   /// replace direct uses of G with bitcast(F). Deletes G.
 592   void WriteThunk(Function *F, Function *G);
 593
 594   /// WriteAlias - Replace G with an alias to F. Deletes G.
 595   void WriteAlias(Function *F, Function *G);
 596
 597   /// The set of all distinct functions. Use the Insert and Remove methods to
 598   /// modify it.
 599   FnSetType FnSet;
 600
 601   /// TargetData for more accurate GEP comparisons. May be NULL.
 602   TargetData *TD;
 603
 604   /// Whether or not the target supports global aliases.
 605   bool HasGlobalAliases;
 606 };
 607
 608 }  // end anonymous namespace
 609
 610 char MergeFunctions::ID = 0;
 611 INITIALIZE_PASS(MergeFunctions, "mergefunc", "Merge Functions", false, false)
 612
 613 ModulePass *llvm::createMergeFunctionsPass() {
 614   return new MergeFunctions();
 615 }
 616
 617 bool MergeFunctions::runOnModule(Module &M) {
 618   bool Changed = false;
 619   TD = getAnalysisIfAvailable<TargetData>();
 620
 621   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 622     if (!I->isDeclaration() && !I->hasAvailableExternallyLinkage())
 623       Deferred.push_back(WeakVH(I));
 624   }
 625   FnSet.resize(Deferred.size());
 626
 627   do {
 628     std::vector<WeakVH> Worklist;
 629     Deferred.swap(Worklist);
 630
 631     DEBUG(dbgs() << "size of module: " << M.size() << '\n');
 632     DEBUG(dbgs() << "size of worklist: " << Worklist.size() << '\n');
 633
 634     // Insert only strong functions and merge them. Strong function merging
 635     // always deletes one of them.
 636     for (std::vector<WeakVH>::iterator I = Worklist.begin(),
 637            E = Worklist.end(); I != E; ++I) {
 638       if (!*I) continue;
 639       Function *F = cast<Function>(*I);
 640       if (!F->isDeclaration() && !F->hasAvailableExternallyLinkage() &&
 641           !F->mayBeOverridden()) {
 642         ComparableFunction CF = ComparableFunction(F, TD);
 643         Changed |= Insert(CF);
 644       }
 645     }
 646
 647     // Insert only weak functions and merge them. By doing these second we
 648     // create thunks to the strong function when possible. When two weak
 649     // functions are identical, we create a new strong function with two weak
 650     // weak thunks to it which are identical but not mergable.
 651     for (std::vector<WeakVH>::iterator I = Worklist.begin(),
 652            E = Worklist.end(); I != E; ++I) {
 653       if (!*I) continue;
 654       Function *F = cast<Function>(*I);
 655       if (!F->isDeclaration() && !F->hasAvailableExternallyLinkage() &&
 656           F->mayBeOverridden()) {
 657         ComparableFunction CF = ComparableFunction(F, TD);
 658         Changed |= Insert(CF);
 659       }
 660     }
 661     DEBUG(dbgs() << "size of FnSet: " << FnSet.size() << '\n');
 662   } while (!Deferred.empty());
 663
 664   FnSet.clear();
 665
 666   return Changed;
 667 }
 668
 669 bool DenseMapInfo<ComparableFunction>::isEqual(const ComparableFunction &LHS,
 670                                                const ComparableFunction &RHS) {
 671   if (LHS.getFunc() == RHS.getFunc() &&
 672       LHS.getHash() == RHS.getHash())
 673     return true;
 674   if (!LHS.getFunc() || !RHS.getFunc())
 675     return false;
 676   assert(LHS.getTD() == RHS.getTD() &&
 677          "Comparing functions for different targets");
 678
 679   bool inserted;
 680   bool &result1 = LHS.getOrInsertCachedComparison(RHS, inserted);
 681   if (!inserted)
 682     return result1;
 683   bool &result2 = RHS.getOrInsertCachedComparison(LHS, inserted);
 684   if (!inserted)
 685     return result1 = result2;
 686
 687   return result1 = result2 = FunctionComparator(LHS.getTD(), LHS.getFunc(),
 688                                                 RHS.getFunc()).Compare();
 689 }
 690
 691 /// Replace direct callers of Old with New.
 692 void MergeFunctions::replaceDirectCallers(Function *Old, Function *New) {
 693   Constant *BitcastNew = ConstantExpr::getBitCast(New, Old->getType());
 694   for (Value::use_iterator UI = Old->use_begin(), UE = Old->use_end();
 695        UI != UE;) {
 696     Value::use_iterator TheIter = UI;
 697     ++UI;
 698     CallSite CS(*TheIter);
 699     if (CS && CS.isCallee(TheIter)) {
 700       Remove(CS.getInstruction()->getParent()->getParent());
 701       TheIter.getUse().set(BitcastNew);
 702     }
 703   }
 704 }
 705
 706 void MergeFunctions::WriteThunkOrAlias(Function *F, Function *G) {
 707   if (HasGlobalAliases && G->hasUnnamedAddr()) {
 708     if (G->hasExternalLinkage() || G->hasLocalLinkage() ||
 709         G->hasWeakLinkage()) {
 710       WriteAlias(F, G);
 711       return;
 712     }
 713   }
 714
 715   WriteThunk(F, G);
 716 }
 717
 718 /// WriteThunk - Replace G with a simple tail call to bitcast(F). Also replace
 719 /// direct uses of G with bitcast(F). Deletes G.
 720 void MergeFunctions::WriteThunk(Function *F, Function *G) {
 721   if (!G->mayBeOverridden()) {
 722     // Redirect direct callers of G to F.
 723     replaceDirectCallers(G, F);
 724   }
 725
 726   // If G was internal then we may have replaced all uses of G with F. If so,
 727   // stop here and delete G. There's no need for a thunk.
 728   if (G->hasLocalLinkage() && G->use_empty()) {
 729     G->eraseFromParent();
 730     return;
 731   }
 732
 733   Function *NewG = Function::Create(G->getFunctionType(), G->getLinkage(), "",
 734                                     G->getParent());
 735   BasicBlock *BB = BasicBlock::Create(F->getContext(), "", NewG);
 736   IRBuilder<false> Builder(BB);
 737
 738   SmallVector<Value *, 16> Args;
 739   unsigned i = 0;
 740   const FunctionType *FFTy = F->getFunctionType();
 741   for (Function::arg_iterator AI = NewG->arg_begin(), AE = NewG->arg_end();
 742        AI != AE; ++AI) {
 743     Args.push_back(Builder.CreateBitCast(AI, FFTy->getParamType(i)));
 744     ++i;
 745   }
 746
 747   CallInst *CI = Builder.CreateCall(F, Args.begin(), Args.end());
 748   CI->setTailCall();
 749   CI->setCallingConv(F->getCallingConv());
 750   if (NewG->getReturnType()->isVoidTy()) {
 751     Builder.CreateRetVoid();
 752   } else {
 753     Builder.CreateRet(Builder.CreateBitCast(CI, NewG->getReturnType()));
 754   }
 755
 756   NewG->copyAttributesFrom(G);
 757   NewG->takeName(G);
 758   RemoveUsers(G);
 759   G->replaceAllUsesWith(NewG);
 760   G->eraseFromParent();
 761
 762   DEBUG(dbgs() << "WriteThunk: " << NewG->getName() << '\n');
 763   ++NumThunksWritten;
 764 }
 765
 766 /// WriteAlias - Replace G with an alias to F and delete G.
 767 void MergeFunctions::WriteAlias(Function *F, Function *G) {
 768   Constant *BitcastF = ConstantExpr::getBitCast(F, G->getType());
 769   GlobalAlias *GA = new GlobalAlias(G->getType(), G->getLinkage(), "",
 770                                     BitcastF, G->getParent());
 771   F->setAlignment(std::max(F->getAlignment(), G->getAlignment()));
 772   GA->takeName(G);
 773   GA->setVisibility(G->getVisibility());
 774   RemoveUsers(G);
 775   G->replaceAllUsesWith(GA);
 776   G->eraseFromParent();
 777
 778   DEBUG(dbgs() << "WriteAlias: " << GA->getName() << '\n');
 779   ++NumAliasesWritten;
 780 }
 781
 782 /// MergeTwoFunctions - Merge two equivalent functions. Upon completion,
 783 /// Function G is deleted.
 784 void MergeFunctions::MergeTwoFunctions(Function *F, Function *G) {
 785   if (F->mayBeOverridden()) {
 786     assert(G->mayBeOverridden());
 787
 788     if (HasGlobalAliases) {
 789       // Make them both thunks to the same internal function.
 790       Function *H = Function::Create(F->getFunctionType(), F->getLinkage(), "",
 791                                      F->getParent());
 792       H->copyAttributesFrom(F);
 793       H->takeName(F);
 794       RemoveUsers(F);
 795       F->replaceAllUsesWith(H);
 796
 797       unsigned MaxAlignment = std::max(G->getAlignment(), H->getAlignment());
 798
 799       WriteAlias(F, G);
 800       WriteAlias(F, H);
 801
 802       F->setAlignment(MaxAlignment);
 803       F->setLinkage(GlobalValue::PrivateLinkage);
 804     } else {
 805       // We can't merge them. Instead, pick one and update all direct callers
 806       // to call it and hope that we improve the instruction cache hit rate.
 807       replaceDirectCallers(G, F);
 808     }
 809
 810     ++NumDoubleWeak;
 811   } else {
 812     WriteThunkOrAlias(F, G);
 813   }
 814
 815   ++NumFunctionsMerged;
 816 }
 817
 818 // Insert - Insert a ComparableFunction into the FnSet, or merge it away if
 819 // equal to one that's already inserted.
 820 bool MergeFunctions::Insert(ComparableFunction &NewF) {
 821   std::pair<FnSetType::iterator, bool> Result = FnSet.insert(NewF);
 822   if (Result.second)
 823     return false;
 824
 825   const ComparableFunction &OldF = *Result.first;
 826
 827   // Never thunk a strong function to a weak function.
 828   assert(!OldF.getFunc()->mayBeOverridden() ||
 829          NewF.getFunc()->mayBeOverridden());
 830
 831   DEBUG(dbgs() << "  " << OldF.getFunc()->getName() << " == "
 832                << NewF.getFunc()->getName() << '\n');
 833
 834   Function *DeleteF = NewF.getFunc();
 835   NewF.release();
 836   MergeTwoFunctions(OldF.getFunc(), DeleteF);
 837   return true;
 838 }
 839
 840 // Remove - Remove a function from FnSet. If it was already in FnSet, add it to
 841 // Deferred so that we'll look at it in the next round.
 842 void MergeFunctions::Remove(Function *F) {
 843   ComparableFunction CF = ComparableFunction(F, TD);
 844   if (FnSet.erase(CF)) {
 845     Deferred.push_back(F);
 846   }
 847 }
 848
 849 // RemoveUsers - For each instruction used by the value, Remove() the function
 850 // that contains the instruction. This should happen right before a call to RAUW.
 851 void MergeFunctions::RemoveUsers(Value *V) {
 852   std::vector<Value *> Worklist;
 853   Worklist.push_back(V);
 854   while (!Worklist.empty()) {
 855     Value *V = Worklist.back();
 856     Worklist.pop_back();
 857
 858     for (Value::use_iterator UI = V->use_begin(), UE = V->use_end();
 859          UI != UE; ++UI) {
 860       Use &U = UI.getUse();
 861       if (Instruction *I = dyn_cast<Instruction>(U.getUser())) {
 862         Remove(I->getParent()->getParent());
 863       } else if (isa<GlobalValue>(U.getUser())) {
 864         // do nothing
 865       } else if (Constant *C = dyn_cast<Constant>(U.getUser())) {
 866         for (Value::use_iterator CUI = C->use_begin(), CUE = C->use_end();
 867              CUI != CUE; ++CUI)
 868           Worklist.push_back(*CUI);
 869       }
 870     }
 871   }
 872 }