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