lib/Transforms/Scalar/ConstantHoisting.cpp

   1 //===- ConstantHoisting.cpp - Prepare code for expensive constants --------===//
   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 identifies expensive constants to hoist and coalesces them to
  11 // better prepare it for SelectionDAG-based code generation. This works around
  12 // the limitations of the basic-block-at-a-time approach.
  13 //
  14 // First it scans all instructions for integer constants and calculates its
  15 // cost. If the constant can be folded into the instruction (the cost is
  16 // TCC_Free) or the cost is just a simple operation (TCC_BASIC), then we don't
  17 // consider it expensive and leave it alone. This is the default behavior and
  18 // the default implementation of getIntImmCost will always return TCC_Free.
  19 //
  20 // If the cost is more than TCC_BASIC, then the integer constant can't be folded
  21 // into the instruction and it might be beneficial to hoist the constant.
  22 // Similar constants are coalesced to reduce register pressure and
  23 // materialization code.
  24 //
  25 // When a constant is hoisted, it is also hidden behind a bitcast to force it to
  26 // be live-out of the basic block. Otherwise the constant would be just
  27 // duplicated and each basic block would have its own copy in the SelectionDAG.
  28 // The SelectionDAG recognizes such constants as opaque and doesn't perform
  29 // certain transformations on them, which would create a new expensive constant.
  30 //
  31 // This optimization is only applied to integer constants in instructions and
  32 // simple (this means not nested) constant cast expressions. For example:
  33 // %0 = load i64* inttoptr (i64 big_constant to i64*)
  34 //===----------------------------------------------------------------------===//
  35
  36 #include "llvm/Transforms/Scalar.h"
  37 #include "llvm/ADT/SmallSet.h"
  38 #include "llvm/ADT/SmallVector.h"
  39 #include "llvm/ADT/Statistic.h"
  40 #include "llvm/Analysis/TargetTransformInfo.h"
  41 #include "llvm/IR/Constants.h"
  42 #include "llvm/IR/Dominators.h"
  43 #include "llvm/IR/IntrinsicInst.h"
  44 #include "llvm/Pass.h"
  45 #include "llvm/Support/Debug.h"
  46
  47 using namespace llvm;
  48
  49 #define DEBUG_TYPE "consthoist"
  50
  51 STATISTIC(NumConstantsHoisted, "Number of constants hoisted");
  52 STATISTIC(NumConstantsRebased, "Number of constants rebased");
  53
  54 namespace {
  55 struct ConstantUser;
  56 struct RebasedConstantInfo;
  57
  58 typedef SmallVector<ConstantUser, 8> ConstantUseListType;
  59 typedef SmallVector<RebasedConstantInfo, 4> RebasedConstantListType;
  60
  61 /// \brief Keeps track of the user of a constant and the operand index where the
  62 /// constant is used.
  63 struct ConstantUser {
  64   Instruction *Inst;
  65   unsigned OpndIdx;
  66
  67   ConstantUser(Instruction *Inst, unsigned Idx) : Inst(Inst), OpndIdx(Idx) { }
  68 };
  69
  70 /// \brief Keeps track of a constant candidate and its uses.
  71 struct ConstantCandidate {
  72   ConstantUseListType Uses;
  73   ConstantInt *ConstInt;
  74   unsigned CumulativeCost;
  75
  76   ConstantCandidate(ConstantInt *ConstInt)
  77     : ConstInt(ConstInt), CumulativeCost(0) { }
  78
  79   /// \brief Add the user to the use list and update the cost.
  80   void addUser(Instruction *Inst, unsigned Idx, unsigned Cost) {
  81     CumulativeCost += Cost;
  82     Uses.push_back(ConstantUser(Inst, Idx));
  83   }
  84 };
  85
  86 /// \brief This represents a constant that has been rebased with respect to a
  87 /// base constant. The difference to the base constant is recorded in Offset.
  88 struct RebasedConstantInfo {
  89   ConstantUseListType Uses;
  90   Constant *Offset;
  91
  92   RebasedConstantInfo(ConstantUseListType &&Uses, Constant *Offset)
  93     : Uses(Uses), Offset(Offset) { }
  94 };
  95
  96 /// \brief A base constant and all its rebased constants.
  97 struct ConstantInfo {
  98   ConstantInt *BaseConstant;
  99   RebasedConstantListType RebasedConstants;
 100 };
 101
 102 /// \brief The constant hoisting pass.
 103 class ConstantHoisting : public FunctionPass {
 104   typedef DenseMap<ConstantInt *, unsigned> ConstCandMapType;
 105   typedef std::vector<ConstantCandidate> ConstCandVecType;
 106
 107   const TargetTransformInfo *TTI;
 108   DominatorTree *DT;
 109   BasicBlock *Entry;
 110
 111   /// Keeps track of constant candidates found in the function.
 112   ConstCandVecType ConstCandVec;
 113
 114   /// Keep track of cast instructions we already cloned.
 115   SmallDenseMap<Instruction *, Instruction *> ClonedCastMap;
 116
 117   /// These are the final constants we decided to hoist.
 118   SmallVector<ConstantInfo, 8> ConstantVec;
 119 public:
 120   static char ID; // Pass identification, replacement for typeid
 121   ConstantHoisting() : FunctionPass(ID), TTI(nullptr), DT(nullptr),
 122                        Entry(nullptr) {
 123     initializeConstantHoistingPass(*PassRegistry::getPassRegistry());
 124   }
 125
 126   bool runOnFunction(Function &Fn) override;
 127
 128   const char *getPassName() const override { return "Constant Hoisting"; }
 129
 130   void getAnalysisUsage(AnalysisUsage &AU) const override {
 131     AU.setPreservesCFG();
 132     AU.addRequired<DominatorTreeWrapperPass>();
 133     AU.addRequired<TargetTransformInfo>();
 134   }
 135
 136 private:
 137   /// \brief Initialize the pass.
 138   void setup(Function &Fn) {
 139     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
 140     TTI = &getAnalysis<TargetTransformInfo>();
 141     Entry = &Fn.getEntryBlock();
 142   }
 143
 144   /// \brief Cleanup.
 145   void cleanup() {
 146     ConstantVec.clear();
 147     ClonedCastMap.clear();
 148     ConstCandVec.clear();
 149
 150     TTI = nullptr;
 151     DT = nullptr;
 152     Entry = nullptr;
 153   }
 154
 155   Instruction *findMatInsertPt(Instruction *Inst, unsigned Idx = ~0U) const;
 156   Instruction *findConstantInsertionPoint(const ConstantInfo &ConstInfo) const;
 157   void collectConstantCandidates(ConstCandMapType &ConstCandMap,
 158                                  Instruction *Inst, unsigned Idx,
 159                                  ConstantInt *ConstInt);
 160   void collectConstantCandidates(ConstCandMapType &ConstCandMap,
 161                                  Instruction *Inst);
 162   void collectConstantCandidates(Function &Fn);
 163   void findAndMakeBaseConstant(ConstCandVecType::iterator S,
 164                                ConstCandVecType::iterator E);
 165   void findBaseConstants();
 166   void emitBaseConstants(Instruction *Base, Constant *Offset,
 167                          const ConstantUser &ConstUser);
 168   bool emitBaseConstants();
 169   void deleteDeadCastInst() const;
 170   bool optimizeConstants(Function &Fn);
 171 };
 172 }
 173
 174 char ConstantHoisting::ID = 0;
 175 INITIALIZE_PASS_BEGIN(ConstantHoisting, "consthoist", "Constant Hoisting",
 176                       false, false)
 177 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 178 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
 179 INITIALIZE_PASS_END(ConstantHoisting, "consthoist", "Constant Hoisting",
 180                     false, false)
 181
 182 FunctionPass *llvm::createConstantHoistingPass() {
 183   return new ConstantHoisting();
 184 }
 185
 186 /// \brief Perform the constant hoisting optimization for the given function.
 187 bool ConstantHoisting::runOnFunction(Function &Fn) {
 188   DEBUG(dbgs() << "********** Begin Constant Hoisting **********\n");
 189   DEBUG(dbgs() << "********** Function: " << Fn.getName() << '\n');
 190
 191   setup(Fn);
 192
 193   bool MadeChange = optimizeConstants(Fn);
 194
 195   if (MadeChange) {
 196     DEBUG(dbgs() << "********** Function after Constant Hoisting: "
 197                  << Fn.getName() << '\n');
 198     DEBUG(dbgs() << Fn);
 199   }
 200   DEBUG(dbgs() << "********** End Constant Hoisting **********\n");
 201
 202   cleanup();
 203
 204   return MadeChange;
 205 }
 206
 207
 208 /// \brief Find the constant materialization insertion point.
 209 Instruction *ConstantHoisting::findMatInsertPt(Instruction *Inst,
 210                                                unsigned Idx) const {
 211   // If the operand is a cast instruction, then we have to materialize the
 212   // constant before the cast instruction.
 213   if (Idx != ~0U) {
 214     Value *Opnd = Inst->getOperand(Idx);
 215     if (auto CastInst = dyn_cast<Instruction>(Opnd))
 216       if (CastInst->isCast())
 217         return CastInst;
 218   }
 219
 220   // The simple and common case. This also includes constant expressions.
 221   if (!isa<PHINode>(Inst) && !isa<LandingPadInst>(Inst))
 222     return Inst;
 223
 224   // We can't insert directly before a phi node or landing pad. Insert before
 225   // the terminator of the incoming or dominating block.
 226   assert(Entry != Inst->getParent() && "PHI or landing pad in entry block!");
 227   if (Idx != ~0U && isa<PHINode>(Inst))
 228     return cast<PHINode>(Inst)->getIncomingBlock(Idx)->getTerminator();
 229
 230   BasicBlock *IDom = DT->getNode(Inst->getParent())->getIDom()->getBlock();
 231   return IDom->getTerminator();
 232 }
 233
 234 /// \brief Find an insertion point that dominates all uses.
 235 Instruction *ConstantHoisting::
 236 findConstantInsertionPoint(const ConstantInfo &ConstInfo) const {
 237   assert(!ConstInfo.RebasedConstants.empty() && "Invalid constant info entry.");
 238   // Collect all basic blocks.
 239   SmallPtrSet<BasicBlock *, 8> BBs;
 240   for (auto const &RCI : ConstInfo.RebasedConstants)
 241     for (auto const &U : RCI.Uses)
 242       BBs.insert(findMatInsertPt(U.Inst, U.OpndIdx)->getParent());
 243
 244   if (BBs.count(Entry))
 245     return &Entry->front();
 246
 247   while (BBs.size() >= 2) {
 248     BasicBlock *BB, *BB1, *BB2;
 249     BB1 = *BBs.begin();
 250     BB2 = *std::next(BBs.begin());
 251     BB = DT->findNearestCommonDominator(BB1, BB2);
 252     if (BB == Entry)
 253       return &Entry->front();
 254     BBs.erase(BB1);
 255     BBs.erase(BB2);
 256     BBs.insert(BB);
 257   }
 258   assert((BBs.size() == 1) && "Expected only one element.");
 259   Instruction &FirstInst = (*BBs.begin())->front();
 260   return findMatInsertPt(&FirstInst);
 261 }
 262
 263
 264 /// \brief Record constant integer ConstInt for instruction Inst at operand
 265 /// index Idx.
 266 ///
 267 /// The operand at index Idx is not necessarily the constant integer itself. It
 268 /// could also be a cast instruction or a constant expression that uses the
 269 // constant integer.
 270 void ConstantHoisting::collectConstantCandidates(ConstCandMapType &ConstCandMap,
 271                                                  Instruction *Inst,
 272                                                  unsigned Idx,
 273                                                  ConstantInt *ConstInt) {
 274   unsigned Cost;
 275   // Ask the target about the cost of materializing the constant for the given
 276   // instruction and operand index.
 277   if (auto IntrInst = dyn_cast<IntrinsicInst>(Inst))
 278     Cost = TTI->getIntImmCost(IntrInst->getIntrinsicID(), Idx,
 279                               ConstInt->getValue(), ConstInt->getType());
 280   else
 281     Cost = TTI->getIntImmCost(Inst->getOpcode(), Idx, ConstInt->getValue(),
 282                               ConstInt->getType());
 283
 284   // Ignore cheap integer constants.
 285   if (Cost > TargetTransformInfo::TCC_Basic) {
 286     ConstCandMapType::iterator Itr;
 287     bool Inserted;
 288     std::tie(Itr, Inserted) = ConstCandMap.insert(std::make_pair(ConstInt, 0));
 289     if (Inserted) {
 290       ConstCandVec.push_back(ConstantCandidate(ConstInt));
 291       Itr->second = ConstCandVec.size() - 1;
 292     }
 293     ConstCandVec[Itr->second].addUser(Inst, Idx, Cost);
 294     DEBUG(if (isa<ConstantInt>(Inst->getOperand(Idx)))
 295             dbgs() << "Collect constant " << *ConstInt << " from " << *Inst
 296                    << " with cost " << Cost << '\n';
 297           else
 298           dbgs() << "Collect constant " << *ConstInt << " indirectly from "
 299                  << *Inst << " via " << *Inst->getOperand(Idx) << " with cost "
 300                  << Cost << '\n';
 301     );
 302   }
 303 }
 304
 305 /// \brief Scan the instruction for expensive integer constants and record them
 306 /// in the constant candidate vector.
 307 void ConstantHoisting::collectConstantCandidates(ConstCandMapType &ConstCandMap,
 308                                                  Instruction *Inst) {
 309   // Skip all cast instructions. They are visited indirectly later on.
 310   if (Inst->isCast())
 311     return;
 312
 313   // Can't handle inline asm. Skip it.
 314   if (auto Call = dyn_cast<CallInst>(Inst))
 315     if (isa<InlineAsm>(Call->getCalledValue()))
 316       return;
 317
 318   // Scan all operands.
 319   for (unsigned Idx = 0, E = Inst->getNumOperands(); Idx != E; ++Idx) {
 320     Value *Opnd = Inst->getOperand(Idx);
 321
 322     // Visit constant integers.
 323     if (auto ConstInt = dyn_cast<ConstantInt>(Opnd)) {
 324       collectConstantCandidates(ConstCandMap, Inst, Idx, ConstInt);
 325       continue;
 326     }
 327
 328     // Visit cast instructions that have constant integers.
 329     if (auto CastInst = dyn_cast<Instruction>(Opnd)) {
 330       // Only visit cast instructions, which have been skipped. All other
 331       // instructions should have already been visited.
 332       if (!CastInst->isCast())
 333         continue;
 334
 335       if (auto *ConstInt = dyn_cast<ConstantInt>(CastInst->getOperand(0))) {
 336         // Pretend the constant is directly used by the instruction and ignore
 337         // the cast instruction.
 338         collectConstantCandidates(ConstCandMap, Inst, Idx, ConstInt);
 339         continue;
 340       }
 341     }
 342
 343     // Visit constant expressions that have constant integers.
 344     if (auto ConstExpr = dyn_cast<ConstantExpr>(Opnd)) {
 345       // Only visit constant cast expressions.
 346       if (!ConstExpr->isCast())
 347         continue;
 348
 349       if (auto ConstInt = dyn_cast<ConstantInt>(ConstExpr->getOperand(0))) {
 350         // Pretend the constant is directly used by the instruction and ignore
 351         // the constant expression.
 352         collectConstantCandidates(ConstCandMap, Inst, Idx, ConstInt);
 353         continue;
 354       }
 355     }
 356   } // end of for all operands
 357 }
 358
 359 /// \brief Collect all integer constants in the function that cannot be folded
 360 /// into an instruction itself.
 361 void ConstantHoisting::collectConstantCandidates(Function &Fn) {
 362   ConstCandMapType ConstCandMap;
 363   for (Function::iterator BB : Fn)
 364     for (BasicBlock::iterator Inst : *BB)
 365       collectConstantCandidates(ConstCandMap, Inst);
 366 }
 367
 368 /// \brief Find the base constant within the given range and rebase all other
 369 /// constants with respect to the base constant.
 370 void ConstantHoisting::findAndMakeBaseConstant(ConstCandVecType::iterator S,
 371                                                ConstCandVecType::iterator E) {
 372   auto MaxCostItr = S;
 373   unsigned NumUses = 0;
 374   // Use the constant that has the maximum cost as base constant.
 375   for (auto ConstCand = S; ConstCand != E; ++ConstCand) {
 376     NumUses += ConstCand->Uses.size();
 377     if (ConstCand->CumulativeCost > MaxCostItr->CumulativeCost)
 378       MaxCostItr = ConstCand;
 379   }
 380
 381   // Don't hoist constants that have only one use.
 382   if (NumUses <= 1)
 383     return;
 384
 385   ConstantInfo ConstInfo;
 386   ConstInfo.BaseConstant = MaxCostItr->ConstInt;
 387   Type *Ty = ConstInfo.BaseConstant->getType();
 388
 389   // Rebase the constants with respect to the base constant.
 390   for (auto ConstCand = S; ConstCand != E; ++ConstCand) {
 391     APInt Diff = ConstCand->ConstInt->getValue() -
 392                  ConstInfo.BaseConstant->getValue();
 393     Constant *Offset = Diff == 0 ? nullptr : ConstantInt::get(Ty, Diff);
 394     ConstInfo.RebasedConstants.push_back(
 395       RebasedConstantInfo(std::move(ConstCand->Uses), Offset));
 396   }
 397   ConstantVec.push_back(ConstInfo);
 398 }
 399
 400 /// \brief Finds and combines constant candidates that can be easily
 401 /// rematerialized with an add from a common base constant.
 402 void ConstantHoisting::findBaseConstants() {
 403   // Sort the constants by value and type. This invalidates the mapping!
 404   std::sort(ConstCandVec.begin(), ConstCandVec.end(),
 405             [](const ConstantCandidate &LHS, const ConstantCandidate &RHS) {
 406     if (LHS.ConstInt->getType() != RHS.ConstInt->getType())
 407       return LHS.ConstInt->getType()->getBitWidth() <
 408              RHS.ConstInt->getType()->getBitWidth();
 409     return LHS.ConstInt->getValue().ult(RHS.ConstInt->getValue());
 410   });
 411
 412   // Simple linear scan through the sorted constant candidate vector for viable
 413   // merge candidates.
 414   auto MinValItr = ConstCandVec.begin();
 415   for (auto CC = std::next(ConstCandVec.begin()), E = ConstCandVec.end();
 416        CC != E; ++CC) {
 417     if (MinValItr->ConstInt->getType() == CC->ConstInt->getType()) {
 418       // Check if the constant is in range of an add with immediate.
 419       APInt Diff = CC->ConstInt->getValue() - MinValItr->ConstInt->getValue();
 420       if ((Diff.getBitWidth() <= 64) &&
 421           TTI->isLegalAddImmediate(Diff.getSExtValue()))
 422         continue;
 423     }
 424     // We either have now a different constant type or the constant is not in
 425     // range of an add with immediate anymore.
 426     findAndMakeBaseConstant(MinValItr, CC);
 427     // Start a new base constant search.
 428     MinValItr = CC;
 429   }
 430   // Finalize the last base constant search.
 431   findAndMakeBaseConstant(MinValItr, ConstCandVec.end());
 432 }
 433
 434 /// \brief Updates the operand at Idx in instruction Inst with the result of
 435 ///        instruction Mat. If the instruction is a PHI node then special
 436 ///        handling for duplicate values form the same incomming basic block is
 437 ///        required.
 438 /// \return The update will always succeed, but the return value indicated if
 439 ///         Mat was used for the update or not.
 440 static bool updateOperand(Instruction *Inst, unsigned Idx, Instruction *Mat) {
 441   if (auto PHI = dyn_cast<PHINode>(Inst)) {
 442     // Check if any previous operand of the PHI node has the same incoming basic
 443     // block. This is a very odd case that happens when the incoming basic block
 444     // has a switch statement. In this case use the same value as the previous
 445     // operand(s), otherwise we will fail verification due to different values.
 446     // The values are actually the same, but the variable names are different
 447     // and the verifier doesn't like that.
 448     BasicBlock *IncomingBB = PHI->getIncomingBlock(Idx);
 449     for (unsigned i = 0; i < Idx; ++i) {
 450       if (PHI->getIncomingBlock(i) == IncomingBB) {
 451         Value *IncomingVal = PHI->getIncomingValue(i);
 452         Inst->setOperand(Idx, IncomingVal);
 453         return false;
 454       }
 455     }
 456   }
 457
 458   Inst->setOperand(Idx, Mat);
 459   return true;
 460 }
 461
 462 /// \brief Emit materialization code for all rebased constants and update their
 463 /// users.
 464 void ConstantHoisting::emitBaseConstants(Instruction *Base, Constant *Offset,
 465                                          const ConstantUser &ConstUser) {
 466   Instruction *Mat = Base;
 467   if (Offset) {
 468     Instruction *InsertionPt = findMatInsertPt(ConstUser.Inst,
 469                                                ConstUser.OpndIdx);
 470     Mat = BinaryOperator::Create(Instruction::Add, Base, Offset,
 471                                  "const_mat", InsertionPt);
 472
 473     DEBUG(dbgs() << "Materialize constant (" << *Base->getOperand(0)
 474                  << " + " << *Offset << ") in BB "
 475                  << Mat->getParent()->getName() << '\n' << *Mat << '\n');
 476     Mat->setDebugLoc(ConstUser.Inst->getDebugLoc());
 477   }
 478   Value *Opnd = ConstUser.Inst->getOperand(ConstUser.OpndIdx);
 479
 480   // Visit constant integer.
 481   if (isa<ConstantInt>(Opnd)) {
 482     DEBUG(dbgs() << "Update: " << *ConstUser.Inst << '\n');
 483     if (!updateOperand(ConstUser.Inst, ConstUser.OpndIdx, Mat) && Offset)
 484       Mat->eraseFromParent();
 485     DEBUG(dbgs() << "To    : " << *ConstUser.Inst << '\n');
 486     return;
 487   }
 488
 489   // Visit cast instruction.
 490   if (auto CastInst = dyn_cast<Instruction>(Opnd)) {
 491     assert(CastInst->isCast() && "Expected an cast instruction!");
 492     // Check if we already have visited this cast instruction before to avoid
 493     // unnecessary cloning.
 494     Instruction *&ClonedCastInst = ClonedCastMap[CastInst];
 495     if (!ClonedCastInst) {
 496       ClonedCastInst = CastInst->clone();
 497       ClonedCastInst->setOperand(0, Mat);
 498       ClonedCastInst->insertAfter(CastInst);
 499       // Use the same debug location as the original cast instruction.
 500       ClonedCastInst->setDebugLoc(CastInst->getDebugLoc());
 501       DEBUG(dbgs() << "Clone instruction: " << *CastInst << '\n'
 502                    << "To               : " << *ClonedCastInst << '\n');
 503     }
 504
 505     DEBUG(dbgs() << "Update: " << *ConstUser.Inst << '\n');
 506     updateOperand(ConstUser.Inst, ConstUser.OpndIdx, ClonedCastInst);
 507     DEBUG(dbgs() << "To    : " << *ConstUser.Inst << '\n');
 508     return;
 509   }
 510
 511   // Visit constant expression.
 512   if (auto ConstExpr = dyn_cast<ConstantExpr>(Opnd)) {
 513     Instruction *ConstExprInst = ConstExpr->getAsInstruction();
 514     ConstExprInst->setOperand(0, Mat);
 515     ConstExprInst->insertBefore(findMatInsertPt(ConstUser.Inst,
 516                                                 ConstUser.OpndIdx));
 517
 518     // Use the same debug location as the instruction we are about to update.
 519     ConstExprInst->setDebugLoc(ConstUser.Inst->getDebugLoc());
 520
 521     DEBUG(dbgs() << "Create instruction: " << *ConstExprInst << '\n'
 522                  << "From              : " << *ConstExpr << '\n');
 523     DEBUG(dbgs() << "Update: " << *ConstUser.Inst << '\n');
 524     if (!updateOperand(ConstUser.Inst, ConstUser.OpndIdx, ConstExprInst)) {
 525       ConstExprInst->eraseFromParent();
 526       if (Offset)
 527         Mat->eraseFromParent();
 528     }
 529     DEBUG(dbgs() << "To    : " << *ConstUser.Inst << '\n');
 530     return;
 531   }
 532 }
 533
 534 /// \brief Hoist and hide the base constant behind a bitcast and emit
 535 /// materialization code for derived constants.
 536 bool ConstantHoisting::emitBaseConstants() {
 537   bool MadeChange = false;
 538   for (auto const &ConstInfo : ConstantVec) {
 539     // Hoist and hide the base constant behind a bitcast.
 540     Instruction *IP = findConstantInsertionPoint(ConstInfo);
 541     IntegerType *Ty = ConstInfo.BaseConstant->getType();
 542     Instruction *Base =
 543       new BitCastInst(ConstInfo.BaseConstant, Ty, "const", IP);
 544     DEBUG(dbgs() << "Hoist constant (" << *ConstInfo.BaseConstant << ") to BB "
 545                  << IP->getParent()->getName() << '\n' << *Base << '\n');
 546     NumConstantsHoisted++;
 547
 548     // Emit materialization code for all rebased constants.
 549     for (auto const &RCI : ConstInfo.RebasedConstants) {
 550       NumConstantsRebased++;
 551       for (auto const &U : RCI.Uses)
 552         emitBaseConstants(Base, RCI.Offset, U);
 553     }
 554
 555     // Use the same debug location as the last user of the constant.
 556     assert(!Base->use_empty() && "The use list is empty!?");
 557     assert(isa<Instruction>(Base->user_back()) &&
 558            "All uses should be instructions.");
 559     Base->setDebugLoc(cast<Instruction>(Base->user_back())->getDebugLoc());
 560
 561     // Correct for base constant, which we counted above too.
 562     NumConstantsRebased--;
 563     MadeChange = true;
 564   }
 565   return MadeChange;
 566 }
 567
 568 /// \brief Check all cast instructions we made a copy of and remove them if they
 569 /// have no more users.
 570 void ConstantHoisting::deleteDeadCastInst() const {
 571   for (auto const &I : ClonedCastMap)
 572     if (I.first->use_empty())
 573       I.first->eraseFromParent();
 574 }
 575
 576 /// \brief Optimize expensive integer constants in the given function.
 577 bool ConstantHoisting::optimizeConstants(Function &Fn) {
 578   // Collect all constant candidates.
 579   collectConstantCandidates(Fn);
 580
 581   // There are no constant candidates to worry about.
 582   if (ConstCandVec.empty())
 583     return false;
 584
 585   // Combine constants that can be easily materialized with an add from a common
 586   // base constant.
 587   findBaseConstants();
 588
 589   // There are no constants to emit.
 590   if (ConstantVec.empty())
 591     return false;
 592
 593   // Finally hoist the base constant and emit materialization code for dependent
 594   // constants.
 595   bool MadeChange = emitBaseConstants();
 596
 597   // Cleanup dead instructions.
 598   deleteDeadCastInst();
 599
 600   return MadeChange;
 601 }