1 //===-- Local.cpp - Functions to perform local transformations ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This family of functions perform various local transformations to the
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Transforms/Utils/Local.h"
16 #include "llvm/Constants.h"
17 #include "llvm/GlobalAlias.h"
18 #include "llvm/GlobalVariable.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/Intrinsics.h"
22 #include "llvm/IntrinsicInst.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/Analysis/ConstantFolding.h"
26 #include "llvm/Analysis/InstructionSimplify.h"
27 #include "llvm/Analysis/ProfileInfo.h"
28 #include "llvm/Target/TargetData.h"
29 #include "llvm/Support/CFG.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/GetElementPtrTypeIterator.h"
32 #include "llvm/Support/MathExtras.h"
33 #include "llvm/Support/ValueHandle.h"
34 #include "llvm/Support/raw_ostream.h"
37 //===----------------------------------------------------------------------===//
41 /// isSafeToLoadUnconditionally - Return true if we know that executing a load
42 /// from this value cannot trap. If it is not obviously safe to load from the
43 /// specified pointer, we do a quick local scan of the basic block containing
44 /// ScanFrom, to determine if the address is already accessed.
45 bool llvm::isSafeToLoadUnconditionally(Value *V, Instruction *ScanFrom) {
46 // If it is an alloca it is always safe to load from.
47 if (isa<AllocaInst>(V)) return true;
49 // If it is a global variable it is mostly safe to load from.
50 if (const GlobalValue *GV = dyn_cast<GlobalVariable>(V))
51 // Don't try to evaluate aliases. External weak GV can be null.
52 return !isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage();
54 // Otherwise, be a little bit agressive by scanning the local block where we
55 // want to check to see if the pointer is already being loaded or stored
56 // from/to. If so, the previous load or store would have already trapped,
57 // so there is no harm doing an extra load (also, CSE will later eliminate
58 // the load entirely).
59 BasicBlock::iterator BBI = ScanFrom, E = ScanFrom->getParent()->begin();
64 // If we see a free or a call which may write to memory (i.e. which might do
65 // a free) the pointer could be marked invalid.
66 if (isa<CallInst>(BBI) && BBI->mayWriteToMemory() &&
67 !isa<DbgInfoIntrinsic>(BBI))
70 if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
71 if (LI->getOperand(0) == V) return true;
72 } else if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
73 if (SI->getOperand(1) == V) return true;
80 //===----------------------------------------------------------------------===//
81 // Local constant propagation.
84 // ConstantFoldTerminator - If a terminator instruction is predicated on a
85 // constant value, convert it into an unconditional branch to the constant
88 bool llvm::ConstantFoldTerminator(BasicBlock *BB) {
89 TerminatorInst *T = BB->getTerminator();
91 // Branch - See if we are conditional jumping on constant
92 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
93 if (BI->isUnconditional()) return false; // Can't optimize uncond branch
94 BasicBlock *Dest1 = BI->getSuccessor(0);
95 BasicBlock *Dest2 = BI->getSuccessor(1);
97 if (ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition())) {
98 // Are we branching on constant?
99 // YES. Change to unconditional branch...
100 BasicBlock *Destination = Cond->getZExtValue() ? Dest1 : Dest2;
101 BasicBlock *OldDest = Cond->getZExtValue() ? Dest2 : Dest1;
103 //cerr << "Function: " << T->getParent()->getParent()
104 // << "\nRemoving branch from " << T->getParent()
105 // << "\n\nTo: " << OldDest << endl;
107 // Let the basic block know that we are letting go of it. Based on this,
108 // it will adjust it's PHI nodes.
109 assert(BI->getParent() && "Terminator not inserted in block!");
110 OldDest->removePredecessor(BI->getParent());
112 // Set the unconditional destination, and change the insn to be an
113 // unconditional branch.
114 BI->setUnconditionalDest(Destination);
118 if (Dest2 == Dest1) { // Conditional branch to same location?
119 // This branch matches something like this:
120 // br bool %cond, label %Dest, label %Dest
121 // and changes it into: br label %Dest
123 // Let the basic block know that we are letting go of one copy of it.
124 assert(BI->getParent() && "Terminator not inserted in block!");
125 Dest1->removePredecessor(BI->getParent());
127 // Change a conditional branch to unconditional.
128 BI->setUnconditionalDest(Dest1);
134 if (SwitchInst *SI = dyn_cast<SwitchInst>(T)) {
135 // If we are switching on a constant, we can convert the switch into a
136 // single branch instruction!
137 ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition());
138 BasicBlock *TheOnlyDest = SI->getSuccessor(0); // The default dest
139 BasicBlock *DefaultDest = TheOnlyDest;
140 assert(TheOnlyDest == SI->getDefaultDest() &&
141 "Default destination is not successor #0?");
143 // Figure out which case it goes to.
144 for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
145 // Found case matching a constant operand?
146 if (SI->getSuccessorValue(i) == CI) {
147 TheOnlyDest = SI->getSuccessor(i);
151 // Check to see if this branch is going to the same place as the default
152 // dest. If so, eliminate it as an explicit compare.
153 if (SI->getSuccessor(i) == DefaultDest) {
154 // Remove this entry.
155 DefaultDest->removePredecessor(SI->getParent());
157 --i; --e; // Don't skip an entry...
161 // Otherwise, check to see if the switch only branches to one destination.
162 // We do this by reseting "TheOnlyDest" to null when we find two non-equal
164 if (SI->getSuccessor(i) != TheOnlyDest) TheOnlyDest = 0;
167 if (CI && !TheOnlyDest) {
168 // Branching on a constant, but not any of the cases, go to the default
170 TheOnlyDest = SI->getDefaultDest();
173 // If we found a single destination that we can fold the switch into, do so
176 // Insert the new branch.
177 BranchInst::Create(TheOnlyDest, SI);
178 BasicBlock *BB = SI->getParent();
180 // Remove entries from PHI nodes which we no longer branch to...
181 for (unsigned i = 0, e = SI->getNumSuccessors(); i != e; ++i) {
182 // Found case matching a constant operand?
183 BasicBlock *Succ = SI->getSuccessor(i);
184 if (Succ == TheOnlyDest)
185 TheOnlyDest = 0; // Don't modify the first branch to TheOnlyDest
187 Succ->removePredecessor(BB);
190 // Delete the old switch.
191 BB->getInstList().erase(SI);
195 if (SI->getNumSuccessors() == 2) {
196 // Otherwise, we can fold this switch into a conditional branch
197 // instruction if it has only one non-default destination.
198 Value *Cond = new ICmpInst(SI, ICmpInst::ICMP_EQ, SI->getCondition(),
199 SI->getSuccessorValue(1), "cond");
200 // Insert the new branch.
201 BranchInst::Create(SI->getSuccessor(1), SI->getSuccessor(0), Cond, SI);
203 // Delete the old switch.
204 SI->eraseFromParent();
210 if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(T)) {
211 // indirectbr blockaddress(@F, @BB) -> br label @BB
212 if (BlockAddress *BA =
213 dyn_cast<BlockAddress>(IBI->getAddress()->stripPointerCasts())) {
214 BasicBlock *TheOnlyDest = BA->getBasicBlock();
215 // Insert the new branch.
216 BranchInst::Create(TheOnlyDest, IBI);
218 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
219 if (IBI->getDestination(i) == TheOnlyDest)
222 IBI->getDestination(i)->removePredecessor(IBI->getParent());
224 IBI->eraseFromParent();
226 // If we didn't find our destination in the IBI successor list, then we
227 // have undefined behavior. Replace the unconditional branch with an
228 // 'unreachable' instruction.
230 BB->getTerminator()->eraseFromParent();
231 new UnreachableInst(BB->getContext(), BB);
242 //===----------------------------------------------------------------------===//
243 // Local dead code elimination.
246 /// isInstructionTriviallyDead - Return true if the result produced by the
247 /// instruction is not used, and the instruction has no side effects.
249 bool llvm::isInstructionTriviallyDead(Instruction *I) {
250 if (!I->use_empty() || isa<TerminatorInst>(I)) return false;
252 // We don't want debug info removed by anything this general.
253 if (isa<DbgInfoIntrinsic>(I)) return false;
255 // Likewise for memory use markers.
256 if (isa<MemoryUseIntrinsic>(I)) return false;
258 if (!I->mayHaveSideEffects()) return true;
260 // Special case intrinsics that "may have side effects" but can be deleted
262 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
263 // Safe to delete llvm.stacksave if dead.
264 if (II->getIntrinsicID() == Intrinsic::stacksave)
269 /// RecursivelyDeleteTriviallyDeadInstructions - If the specified value is a
270 /// trivially dead instruction, delete it. If that makes any of its operands
271 /// trivially dead, delete them too, recursively. Return true if any
272 /// instructions were deleted.
273 bool llvm::RecursivelyDeleteTriviallyDeadInstructions(Value *V) {
274 Instruction *I = dyn_cast<Instruction>(V);
275 if (!I || !I->use_empty() || !isInstructionTriviallyDead(I))
278 SmallVector<Instruction*, 16> DeadInsts;
279 DeadInsts.push_back(I);
282 I = DeadInsts.pop_back_val();
284 // Null out all of the instruction's operands to see if any operand becomes
286 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
287 Value *OpV = I->getOperand(i);
290 if (!OpV->use_empty()) continue;
292 // If the operand is an instruction that became dead as we nulled out the
293 // operand, and if it is 'trivially' dead, delete it in a future loop
295 if (Instruction *OpI = dyn_cast<Instruction>(OpV))
296 if (isInstructionTriviallyDead(OpI))
297 DeadInsts.push_back(OpI);
300 I->eraseFromParent();
301 } while (!DeadInsts.empty());
306 /// RecursivelyDeleteDeadPHINode - If the specified value is an effectively
307 /// dead PHI node, due to being a def-use chain of single-use nodes that
308 /// either forms a cycle or is terminated by a trivially dead instruction,
309 /// delete it. If that makes any of its operands trivially dead, delete them
310 /// too, recursively. Return true if the PHI node is actually deleted.
312 llvm::RecursivelyDeleteDeadPHINode(PHINode *PN) {
313 // We can remove a PHI if it is on a cycle in the def-use graph
314 // where each node in the cycle has degree one, i.e. only one use,
315 // and is an instruction with no side effects.
316 if (!PN->hasOneUse())
319 bool Changed = false;
320 SmallPtrSet<PHINode *, 4> PHIs;
322 for (Instruction *J = cast<Instruction>(*PN->use_begin());
323 J->hasOneUse() && !J->mayHaveSideEffects();
324 J = cast<Instruction>(*J->use_begin()))
325 // If we find a PHI more than once, we're on a cycle that
326 // won't prove fruitful.
327 if (PHINode *JP = dyn_cast<PHINode>(J))
328 if (!PHIs.insert(cast<PHINode>(JP))) {
329 // Break the cycle and delete the PHI and its operands.
330 JP->replaceAllUsesWith(UndefValue::get(JP->getType()));
331 (void)RecursivelyDeleteTriviallyDeadInstructions(JP);
338 /// SimplifyInstructionsInBlock - Scan the specified basic block and try to
339 /// simplify any instructions in it and recursively delete dead instructions.
341 /// This returns true if it changed the code, note that it can delete
342 /// instructions in other blocks as well in this block.
343 bool llvm::SimplifyInstructionsInBlock(BasicBlock *BB, const TargetData *TD) {
344 bool MadeChange = false;
345 for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
346 Instruction *Inst = BI++;
348 if (Value *V = SimplifyInstruction(Inst, TD)) {
350 ReplaceAndSimplifyAllUses(Inst, V, TD);
357 MadeChange |= RecursivelyDeleteTriviallyDeadInstructions(Inst);
362 //===----------------------------------------------------------------------===//
363 // Control Flow Graph Restructuring.
367 /// RemovePredecessorAndSimplify - Like BasicBlock::removePredecessor, this
368 /// method is called when we're about to delete Pred as a predecessor of BB. If
369 /// BB contains any PHI nodes, this drops the entries in the PHI nodes for Pred.
371 /// Unlike the removePredecessor method, this attempts to simplify uses of PHI
372 /// nodes that collapse into identity values. For example, if we have:
373 /// x = phi(1, 0, 0, 0)
376 /// .. and delete the predecessor corresponding to the '1', this will attempt to
377 /// recursively fold the and to 0.
378 void llvm::RemovePredecessorAndSimplify(BasicBlock *BB, BasicBlock *Pred,
380 // This only adjusts blocks with PHI nodes.
381 if (!isa<PHINode>(BB->begin()))
384 // Remove the entries for Pred from the PHI nodes in BB, but do not simplify
385 // them down. This will leave us with single entry phi nodes and other phis
386 // that can be removed.
387 BB->removePredecessor(Pred, true);
389 WeakVH PhiIt = &BB->front();
390 while (PHINode *PN = dyn_cast<PHINode>(PhiIt)) {
391 PhiIt = &*++BasicBlock::iterator(cast<Instruction>(PhiIt));
393 Value *PNV = PN->hasConstantValue();
394 if (PNV == 0) continue;
396 // If we're able to simplify the phi to a single value, substitute the new
397 // value into all of its uses.
398 assert(PNV != PN && "hasConstantValue broken");
400 ReplaceAndSimplifyAllUses(PN, PNV, TD);
402 // If recursive simplification ended up deleting the next PHI node we would
403 // iterate to, then our iterator is invalid, restart scanning from the top
405 if (PhiIt == 0) PhiIt = &BB->front();
410 /// MergeBasicBlockIntoOnlyPred - DestBB is a block with one predecessor and its
411 /// predecessor is known to have one successor (DestBB!). Eliminate the edge
412 /// between them, moving the instructions in the predecessor into DestBB and
413 /// deleting the predecessor block.
415 void llvm::MergeBasicBlockIntoOnlyPred(BasicBlock *DestBB, Pass *P) {
416 // If BB has single-entry PHI nodes, fold them.
417 while (PHINode *PN = dyn_cast<PHINode>(DestBB->begin())) {
418 Value *NewVal = PN->getIncomingValue(0);
419 // Replace self referencing PHI with undef, it must be dead.
420 if (NewVal == PN) NewVal = UndefValue::get(PN->getType());
421 PN->replaceAllUsesWith(NewVal);
422 PN->eraseFromParent();
425 BasicBlock *PredBB = DestBB->getSinglePredecessor();
426 assert(PredBB && "Block doesn't have a single predecessor!");
428 // Splice all the instructions from PredBB to DestBB.
429 PredBB->getTerminator()->eraseFromParent();
430 DestBB->getInstList().splice(DestBB->begin(), PredBB->getInstList());
432 // Anything that branched to PredBB now branches to DestBB.
433 PredBB->replaceAllUsesWith(DestBB);
436 ProfileInfo *PI = P->getAnalysisIfAvailable<ProfileInfo>();
438 PI->replaceAllUses(PredBB, DestBB);
439 PI->removeEdge(ProfileInfo::getEdge(PredBB, DestBB));
443 PredBB->eraseFromParent();
446 /// CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an
447 /// almost-empty BB ending in an unconditional branch to Succ, into succ.
449 /// Assumption: Succ is the single successor for BB.
451 static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) {
452 assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!");
454 DEBUG(dbgs() << "Looking to fold " << BB->getName() << " into "
455 << Succ->getName() << "\n");
456 // Shortcut, if there is only a single predecessor it must be BB and merging
458 if (Succ->getSinglePredecessor()) return true;
460 // Make a list of the predecessors of BB
461 typedef SmallPtrSet<BasicBlock*, 16> BlockSet;
462 BlockSet BBPreds(pred_begin(BB), pred_end(BB));
464 // Use that list to make another list of common predecessors of BB and Succ
465 BlockSet CommonPreds;
466 for (pred_iterator PI = pred_begin(Succ), PE = pred_end(Succ);
468 if (BBPreds.count(*PI))
469 CommonPreds.insert(*PI);
471 // Shortcut, if there are no common predecessors, merging is always safe
472 if (CommonPreds.empty())
475 // Look at all the phi nodes in Succ, to see if they present a conflict when
476 // merging these blocks
477 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
478 PHINode *PN = cast<PHINode>(I);
480 // If the incoming value from BB is again a PHINode in
481 // BB which has the same incoming value for *PI as PN does, we can
482 // merge the phi nodes and then the blocks can still be merged
483 PHINode *BBPN = dyn_cast<PHINode>(PN->getIncomingValueForBlock(BB));
484 if (BBPN && BBPN->getParent() == BB) {
485 for (BlockSet::iterator PI = CommonPreds.begin(), PE = CommonPreds.end();
487 if (BBPN->getIncomingValueForBlock(*PI)
488 != PN->getIncomingValueForBlock(*PI)) {
489 DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in "
490 << Succ->getName() << " is conflicting with "
491 << BBPN->getName() << " with regard to common predecessor "
492 << (*PI)->getName() << "\n");
497 Value* Val = PN->getIncomingValueForBlock(BB);
498 for (BlockSet::iterator PI = CommonPreds.begin(), PE = CommonPreds.end();
500 // See if the incoming value for the common predecessor is equal to the
501 // one for BB, in which case this phi node will not prevent the merging
503 if (Val != PN->getIncomingValueForBlock(*PI)) {
504 DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in "
505 << Succ->getName() << " is conflicting with regard to common "
506 << "predecessor " << (*PI)->getName() << "\n");
516 /// TryToSimplifyUncondBranchFromEmptyBlock - BB is known to contain an
517 /// unconditional branch, and contains no instructions other than PHI nodes,
518 /// potential debug intrinsics and the branch. If possible, eliminate BB by
519 /// rewriting all the predecessors to branch to the successor block and return
520 /// true. If we can't transform, return false.
521 bool llvm::TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB) {
522 // We can't eliminate infinite loops.
523 BasicBlock *Succ = cast<BranchInst>(BB->getTerminator())->getSuccessor(0);
524 if (BB == Succ) return false;
526 // Check to see if merging these blocks would cause conflicts for any of the
527 // phi nodes in BB or Succ. If not, we can safely merge.
528 if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false;
530 // Check for cases where Succ has multiple predecessors and a PHI node in BB
531 // has uses which will not disappear when the PHI nodes are merged. It is
532 // possible to handle such cases, but difficult: it requires checking whether
533 // BB dominates Succ, which is non-trivial to calculate in the case where
534 // Succ has multiple predecessors. Also, it requires checking whether
535 // constructing the necessary self-referential PHI node doesn't intoduce any
536 // conflicts; this isn't too difficult, but the previous code for doing this
539 // Note that if this check finds a live use, BB dominates Succ, so BB is
540 // something like a loop pre-header (or rarely, a part of an irreducible CFG);
541 // folding the branch isn't profitable in that case anyway.
542 if (!Succ->getSinglePredecessor()) {
543 BasicBlock::iterator BBI = BB->begin();
544 while (isa<PHINode>(*BBI)) {
545 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
547 if (PHINode* PN = dyn_cast<PHINode>(*UI)) {
548 if (PN->getIncomingBlock(UI) != BB)
558 DEBUG(dbgs() << "Killing Trivial BB: \n" << *BB);
560 if (isa<PHINode>(Succ->begin())) {
561 // If there is more than one pred of succ, and there are PHI nodes in
562 // the successor, then we need to add incoming edges for the PHI nodes
564 const SmallVector<BasicBlock*, 16> BBPreds(pred_begin(BB), pred_end(BB));
566 // Loop over all of the PHI nodes in the successor of BB.
567 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
568 PHINode *PN = cast<PHINode>(I);
569 Value *OldVal = PN->removeIncomingValue(BB, false);
570 assert(OldVal && "No entry in PHI for Pred BB!");
572 // If this incoming value is one of the PHI nodes in BB, the new entries
573 // in the PHI node are the entries from the old PHI.
574 if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) {
575 PHINode *OldValPN = cast<PHINode>(OldVal);
576 for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i)
577 // Note that, since we are merging phi nodes and BB and Succ might
578 // have common predecessors, we could end up with a phi node with
579 // identical incoming branches. This will be cleaned up later (and
580 // will trigger asserts if we try to clean it up now, without also
581 // simplifying the corresponding conditional branch).
582 PN->addIncoming(OldValPN->getIncomingValue(i),
583 OldValPN->getIncomingBlock(i));
585 // Add an incoming value for each of the new incoming values.
586 for (unsigned i = 0, e = BBPreds.size(); i != e; ++i)
587 PN->addIncoming(OldVal, BBPreds[i]);
592 while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
593 if (Succ->getSinglePredecessor()) {
594 // BB is the only predecessor of Succ, so Succ will end up with exactly
595 // the same predecessors BB had.
596 Succ->getInstList().splice(Succ->begin(),
597 BB->getInstList(), BB->begin());
599 // We explicitly check for such uses in CanPropagatePredecessorsForPHIs.
600 assert(PN->use_empty() && "There shouldn't be any uses here!");
601 PN->eraseFromParent();
605 // Everything that jumped to BB now goes to Succ.
606 BB->replaceAllUsesWith(Succ);
607 if (!Succ->hasName()) Succ->takeName(BB);
608 BB->eraseFromParent(); // Delete the old basic block.
614 /// OnlyUsedByDbgIntrinsics - Return true if the instruction I is only used
615 /// by DbgIntrinsics. If DbgInUses is specified then the vector is filled
616 /// with the DbgInfoIntrinsic that use the instruction I.
617 bool llvm::OnlyUsedByDbgInfoIntrinsics(Instruction *I,
618 SmallVectorImpl<DbgInfoIntrinsic *> *DbgInUses) {
622 for (Value::use_iterator UI = I->use_begin(), UE = I->use_end(); UI != UE;
624 if (DbgInfoIntrinsic *DI = dyn_cast<DbgInfoIntrinsic>(*UI)) {
626 DbgInUses->push_back(DI);
636 /// EliminateDuplicatePHINodes - Check for and eliminate duplicate PHI
637 /// nodes in this block. This doesn't try to be clever about PHI nodes
638 /// which differ only in the order of the incoming values, but instcombine
639 /// orders them so it usually won't matter.
641 bool llvm::EliminateDuplicatePHINodes(BasicBlock *BB) {
642 bool Changed = false;
644 // This implementation doesn't currently consider undef operands
645 // specially. Theroetically, two phis which are identical except for
646 // one having an undef where the other doesn't could be collapsed.
648 // Map from PHI hash values to PHI nodes. If multiple PHIs have
649 // the same hash value, the element is the first PHI in the
650 // linked list in CollisionMap.
651 DenseMap<uintptr_t, PHINode *> HashMap;
653 // Maintain linked lists of PHI nodes with common hash values.
654 DenseMap<PHINode *, PHINode *> CollisionMap;
657 for (BasicBlock::iterator I = BB->begin();
658 PHINode *PN = dyn_cast<PHINode>(I++); ) {
659 // Compute a hash value on the operands. Instcombine will likely have sorted
660 // them, which helps expose duplicates, but we have to check all the
661 // operands to be safe in case instcombine hasn't run.
663 for (User::op_iterator I = PN->op_begin(), E = PN->op_end(); I != E; ++I) {
664 // This hash algorithm is quite weak as hash functions go, but it seems
665 // to do a good enough job for this particular purpose, and is very quick.
666 Hash ^= reinterpret_cast<uintptr_t>(static_cast<Value *>(*I));
667 Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7));
669 // If we've never seen this hash value before, it's a unique PHI.
670 std::pair<DenseMap<uintptr_t, PHINode *>::iterator, bool> Pair =
671 HashMap.insert(std::make_pair(Hash, PN));
672 if (Pair.second) continue;
673 // Otherwise it's either a duplicate or a hash collision.
674 for (PHINode *OtherPN = Pair.first->second; ; ) {
675 if (OtherPN->isIdenticalTo(PN)) {
676 // A duplicate. Replace this PHI with its duplicate.
677 PN->replaceAllUsesWith(OtherPN);
678 PN->eraseFromParent();
682 // A non-duplicate hash collision.
683 DenseMap<PHINode *, PHINode *>::iterator I = CollisionMap.find(OtherPN);
684 if (I == CollisionMap.end()) {
685 // Set this PHI to be the head of the linked list of colliding PHIs.
686 PHINode *Old = Pair.first->second;
687 Pair.first->second = PN;
688 CollisionMap[PN] = Old;
691 // Procede to the next PHI in the list.