lib/Transforms/InstCombine/InstCombinePHI.cpp

   1 //===- InstCombinePHI.cpp -------------------------------------------------===//
   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 file implements the visitPHINode function.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "InstCombine.h"
  15 #include "llvm/ADT/STLExtras.h"
  16 #include "llvm/ADT/SmallPtrSet.h"
  17 #include "llvm/Analysis/InstructionSimplify.h"
  18 #include "llvm/IR/DataLayout.h"
  19 using namespace llvm;
  20
  21 /// FoldPHIArgBinOpIntoPHI - If we have something like phi [add (a,b), add(a,c)]
  22 /// and if a/b/c and the add's all have a single use, turn this into a phi
  23 /// and a single binop.
  24 Instruction *InstCombiner::FoldPHIArgBinOpIntoPHI(PHINode &PN) {
  25   Instruction *FirstInst = cast<Instruction>(PN.getIncomingValue(0));
  26   assert(isa<BinaryOperator>(FirstInst) || isa<CmpInst>(FirstInst));
  27   unsigned Opc = FirstInst->getOpcode();
  28   Value *LHSVal = FirstInst->getOperand(0);
  29   Value *RHSVal = FirstInst->getOperand(1);
  30
  31   Type *LHSType = LHSVal->getType();
  32   Type *RHSType = RHSVal->getType();
  33
  34   bool isNUW = false, isNSW = false, isExact = false;
  35   if (OverflowingBinaryOperator *BO =
  36         dyn_cast<OverflowingBinaryOperator>(FirstInst)) {
  37     isNUW = BO->hasNoUnsignedWrap();
  38     isNSW = BO->hasNoSignedWrap();
  39   } else if (PossiblyExactOperator *PEO =
  40                dyn_cast<PossiblyExactOperator>(FirstInst))
  41     isExact = PEO->isExact();
  42
  43   // Scan to see if all operands are the same opcode, and all have one use.
  44   for (unsigned i = 1; i != PN.getNumIncomingValues(); ++i) {
  45     Instruction *I = dyn_cast<Instruction>(PN.getIncomingValue(i));
  46     if (!I || I->getOpcode() != Opc || !I->hasOneUse() ||
  47         // Verify type of the LHS matches so we don't fold cmp's of different
  48         // types.
  49         I->getOperand(0)->getType() != LHSType ||
  50         I->getOperand(1)->getType() != RHSType)
  51       return 0;
  52
  53     // If they are CmpInst instructions, check their predicates
  54     if (CmpInst *CI = dyn_cast<CmpInst>(I))
  55       if (CI->getPredicate() != cast<CmpInst>(FirstInst)->getPredicate())
  56         return 0;
  57
  58     if (isNUW)
  59       isNUW = cast<OverflowingBinaryOperator>(I)->hasNoUnsignedWrap();
  60     if (isNSW)
  61       isNSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
  62     if (isExact)
  63       isExact = cast<PossiblyExactOperator>(I)->isExact();
  64
  65     // Keep track of which operand needs a phi node.
  66     if (I->getOperand(0) != LHSVal) LHSVal = 0;
  67     if (I->getOperand(1) != RHSVal) RHSVal = 0;
  68   }
  69
  70   // If both LHS and RHS would need a PHI, don't do this transformation,
  71   // because it would increase the number of PHIs entering the block,
  72   // which leads to higher register pressure. This is especially
  73   // bad when the PHIs are in the header of a loop.
  74   if (!LHSVal && !RHSVal)
  75     return 0;
  76
  77   // Otherwise, this is safe to transform!
  78
  79   Value *InLHS = FirstInst->getOperand(0);
  80   Value *InRHS = FirstInst->getOperand(1);
  81   PHINode *NewLHS = 0, *NewRHS = 0;
  82   if (LHSVal == 0) {
  83     NewLHS = PHINode::Create(LHSType, PN.getNumIncomingValues(),
  84                              FirstInst->getOperand(0)->getName() + ".pn");
  85     NewLHS->addIncoming(InLHS, PN.getIncomingBlock(0));
  86     InsertNewInstBefore(NewLHS, PN);
  87     LHSVal = NewLHS;
  88   }
  89
  90   if (RHSVal == 0) {
  91     NewRHS = PHINode::Create(RHSType, PN.getNumIncomingValues(),
  92                              FirstInst->getOperand(1)->getName() + ".pn");
  93     NewRHS->addIncoming(InRHS, PN.getIncomingBlock(0));
  94     InsertNewInstBefore(NewRHS, PN);
  95     RHSVal = NewRHS;
  96   }
  97
  98   // Add all operands to the new PHIs.
  99   if (NewLHS || NewRHS) {
 100     for (unsigned i = 1, e = PN.getNumIncomingValues(); i != e; ++i) {
 101       Instruction *InInst = cast<Instruction>(PN.getIncomingValue(i));
 102       if (NewLHS) {
 103         Value *NewInLHS = InInst->getOperand(0);
 104         NewLHS->addIncoming(NewInLHS, PN.getIncomingBlock(i));
 105       }
 106       if (NewRHS) {
 107         Value *NewInRHS = InInst->getOperand(1);
 108         NewRHS->addIncoming(NewInRHS, PN.getIncomingBlock(i));
 109       }
 110     }
 111   }
 112
 113   if (CmpInst *CIOp = dyn_cast<CmpInst>(FirstInst)) {
 114     CmpInst *NewCI = CmpInst::Create(CIOp->getOpcode(), CIOp->getPredicate(),
 115                                      LHSVal, RHSVal);
 116     NewCI->setDebugLoc(FirstInst->getDebugLoc());
 117     return NewCI;
 118   }
 119
 120   BinaryOperator *BinOp = cast<BinaryOperator>(FirstInst);
 121   BinaryOperator *NewBinOp =
 122     BinaryOperator::Create(BinOp->getOpcode(), LHSVal, RHSVal);
 123   if (isNUW) NewBinOp->setHasNoUnsignedWrap();
 124   if (isNSW) NewBinOp->setHasNoSignedWrap();
 125   if (isExact) NewBinOp->setIsExact();
 126   NewBinOp->setDebugLoc(FirstInst->getDebugLoc());
 127   return NewBinOp;
 128 }
 129
 130 Instruction *InstCombiner::FoldPHIArgGEPIntoPHI(PHINode &PN) {
 131   GetElementPtrInst *FirstInst =cast<GetElementPtrInst>(PN.getIncomingValue(0));
 132
 133   SmallVector<Value*, 16> FixedOperands(FirstInst->op_begin(),
 134                                         FirstInst->op_end());
 135   // This is true if all GEP bases are allocas and if all indices into them are
 136   // constants.
 137   bool AllBasePointersAreAllocas = true;
 138
 139   // We don't want to replace this phi if the replacement would require
 140   // more than one phi, which leads to higher register pressure. This is
 141   // especially bad when the PHIs are in the header of a loop.
 142   bool NeededPhi = false;
 143
 144   bool AllInBounds = true;
 145
 146   // Scan to see if all operands are the same opcode, and all have one use.
 147   for (unsigned i = 1; i != PN.getNumIncomingValues(); ++i) {
 148     GetElementPtrInst *GEP= dyn_cast<GetElementPtrInst>(PN.getIncomingValue(i));
 149     if (!GEP || !GEP->hasOneUse() || GEP->getType() != FirstInst->getType() ||
 150       GEP->getNumOperands() != FirstInst->getNumOperands())
 151       return 0;
 152
 153     AllInBounds &= GEP->isInBounds();
 154
 155     // Keep track of whether or not all GEPs are of alloca pointers.
 156     if (AllBasePointersAreAllocas &&
 157         (!isa<AllocaInst>(GEP->getOperand(0)) ||
 158          !GEP->hasAllConstantIndices()))
 159       AllBasePointersAreAllocas = false;
 160
 161     // Compare the operand lists.
 162     for (unsigned op = 0, e = FirstInst->getNumOperands(); op != e; ++op) {
 163       if (FirstInst->getOperand(op) == GEP->getOperand(op))
 164         continue;
 165
 166       // Don't merge two GEPs when two operands differ (introducing phi nodes)
 167       // if one of the PHIs has a constant for the index.  The index may be
 168       // substantially cheaper to compute for the constants, so making it a
 169       // variable index could pessimize the path.  This also handles the case
 170       // for struct indices, which must always be constant.
 171       if (isa<ConstantInt>(FirstInst->getOperand(op)) ||
 172           isa<ConstantInt>(GEP->getOperand(op)))
 173         return 0;
 174
 175       if (FirstInst->getOperand(op)->getType() !=GEP->getOperand(op)->getType())
 176         return 0;
 177
 178       // If we already needed a PHI for an earlier operand, and another operand
 179       // also requires a PHI, we'd be introducing more PHIs than we're
 180       // eliminating, which increases register pressure on entry to the PHI's
 181       // block.
 182       if (NeededPhi)
 183         return 0;
 184
 185       FixedOperands[op] = 0;  // Needs a PHI.
 186       NeededPhi = true;
 187     }
 188   }
 189
 190   // If all of the base pointers of the PHI'd GEPs are from allocas, don't
 191   // bother doing this transformation.  At best, this will just save a bit of
 192   // offset calculation, but all the predecessors will have to materialize the
 193   // stack address into a register anyway.  We'd actually rather *clone* the
 194   // load up into the predecessors so that we have a load of a gep of an alloca,
 195   // which can usually all be folded into the load.
 196   if (AllBasePointersAreAllocas)
 197     return 0;
 198
 199   // Otherwise, this is safe to transform.  Insert PHI nodes for each operand
 200   // that is variable.
 201   SmallVector<PHINode*, 16> OperandPhis(FixedOperands.size());
 202
 203   bool HasAnyPHIs = false;
 204   for (unsigned i = 0, e = FixedOperands.size(); i != e; ++i) {
 205     if (FixedOperands[i]) continue;  // operand doesn't need a phi.
 206     Value *FirstOp = FirstInst->getOperand(i);
 207     PHINode *NewPN = PHINode::Create(FirstOp->getType(), e,
 208                                      FirstOp->getName()+".pn");
 209     InsertNewInstBefore(NewPN, PN);
 210
 211     NewPN->addIncoming(FirstOp, PN.getIncomingBlock(0));
 212     OperandPhis[i] = NewPN;
 213     FixedOperands[i] = NewPN;
 214     HasAnyPHIs = true;
 215   }
 216
 217
 218   // Add all operands to the new PHIs.
 219   if (HasAnyPHIs) {
 220     for (unsigned i = 1, e = PN.getNumIncomingValues(); i != e; ++i) {
 221       GetElementPtrInst *InGEP =cast<GetElementPtrInst>(PN.getIncomingValue(i));
 222       BasicBlock *InBB = PN.getIncomingBlock(i);
 223
 224       for (unsigned op = 0, e = OperandPhis.size(); op != e; ++op)
 225         if (PHINode *OpPhi = OperandPhis[op])
 226           OpPhi->addIncoming(InGEP->getOperand(op), InBB);
 227     }
 228   }
 229
 230   Value *Base = FixedOperands[0];
 231   GetElementPtrInst *NewGEP =
 232     GetElementPtrInst::Create(Base, makeArrayRef(FixedOperands).slice(1));
 233   if (AllInBounds) NewGEP->setIsInBounds();
 234   NewGEP->setDebugLoc(FirstInst->getDebugLoc());
 235   return NewGEP;
 236 }
 237
 238
 239 /// isSafeAndProfitableToSinkLoad - Return true if we know that it is safe to
 240 /// sink the load out of the block that defines it.  This means that it must be
 241 /// obvious the value of the load is not changed from the point of the load to
 242 /// the end of the block it is in.
 243 ///
 244 /// Finally, it is safe, but not profitable, to sink a load targeting a
 245 /// non-address-taken alloca.  Doing so will cause us to not promote the alloca
 246 /// to a register.
 247 static bool isSafeAndProfitableToSinkLoad(LoadInst *L) {
 248   BasicBlock::iterator BBI = L, E = L->getParent()->end();
 249
 250   for (++BBI; BBI != E; ++BBI)
 251     if (BBI->mayWriteToMemory())
 252       return false;
 253
 254   // Check for non-address taken alloca.  If not address-taken already, it isn't
 255   // profitable to do this xform.
 256   if (AllocaInst *AI = dyn_cast<AllocaInst>(L->getOperand(0))) {
 257     bool isAddressTaken = false;
 258     for (User *U : AI->users()) {
 259       if (isa<LoadInst>(U)) continue;
 260       if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
 261         // If storing TO the alloca, then the address isn't taken.
 262         if (SI->getOperand(1) == AI) continue;
 263       }
 264       isAddressTaken = true;
 265       break;
 266     }
 267
 268     if (!isAddressTaken && AI->isStaticAlloca())
 269       return false;
 270   }
 271
 272   // If this load is a load from a GEP with a constant offset from an alloca,
 273   // then we don't want to sink it.  In its present form, it will be
 274   // load [constant stack offset].  Sinking it will cause us to have to
 275   // materialize the stack addresses in each predecessor in a register only to
 276   // do a shared load from register in the successor.
 277   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(L->getOperand(0)))
 278     if (AllocaInst *AI = dyn_cast<AllocaInst>(GEP->getOperand(0)))
 279       if (AI->isStaticAlloca() && GEP->hasAllConstantIndices())
 280         return false;
 281
 282   return true;
 283 }
 284
 285 Instruction *InstCombiner::FoldPHIArgLoadIntoPHI(PHINode &PN) {
 286   LoadInst *FirstLI = cast<LoadInst>(PN.getIncomingValue(0));
 287
 288   // FIXME: This is overconservative; this transform is allowed in some cases
 289   // for atomic operations.
 290   if (FirstLI->isAtomic())
 291     return 0;
 292
 293   // When processing loads, we need to propagate two bits of information to the
 294   // sunk load: whether it is volatile, and what its alignment is.  We currently
 295   // don't sink loads when some have their alignment specified and some don't.
 296   // visitLoadInst will propagate an alignment onto the load when TD is around,
 297   // and if TD isn't around, we can't handle the mixed case.
 298   bool isVolatile = FirstLI->isVolatile();
 299   unsigned LoadAlignment = FirstLI->getAlignment();
 300   unsigned LoadAddrSpace = FirstLI->getPointerAddressSpace();
 301
 302   // We can't sink the load if the loaded value could be modified between the
 303   // load and the PHI.
 304   if (FirstLI->getParent() != PN.getIncomingBlock(0) ||
 305       !isSafeAndProfitableToSinkLoad(FirstLI))
 306     return 0;
 307
 308   // If the PHI is of volatile loads and the load block has multiple
 309   // successors, sinking it would remove a load of the volatile value from
 310   // the path through the other successor.
 311   if (isVolatile &&
 312       FirstLI->getParent()->getTerminator()->getNumSuccessors() != 1)
 313     return 0;
 314
 315   // Check to see if all arguments are the same operation.
 316   for (unsigned i = 1, e = PN.getNumIncomingValues(); i != e; ++i) {
 317     LoadInst *LI = dyn_cast<LoadInst>(PN.getIncomingValue(i));
 318     if (!LI || !LI->hasOneUse())
 319       return 0;
 320
 321     // We can't sink the load if the loaded value could be modified between
 322     // the load and the PHI.
 323     if (LI->isVolatile() != isVolatile ||
 324         LI->getParent() != PN.getIncomingBlock(i) ||
 325         LI->getPointerAddressSpace() != LoadAddrSpace ||
 326         !isSafeAndProfitableToSinkLoad(LI))
 327       return 0;
 328
 329     // If some of the loads have an alignment specified but not all of them,
 330     // we can't do the transformation.
 331     if ((LoadAlignment != 0) != (LI->getAlignment() != 0))
 332       return 0;
 333
 334     LoadAlignment = std::min(LoadAlignment, LI->getAlignment());
 335
 336     // If the PHI is of volatile loads and the load block has multiple
 337     // successors, sinking it would remove a load of the volatile value from
 338     // the path through the other successor.
 339     if (isVolatile &&
 340         LI->getParent()->getTerminator()->getNumSuccessors() != 1)
 341       return 0;
 342   }
 343
 344   // Okay, they are all the same operation.  Create a new PHI node of the
 345   // correct type, and PHI together all of the LHS's of the instructions.
 346   PHINode *NewPN = PHINode::Create(FirstLI->getOperand(0)->getType(),
 347                                    PN.getNumIncomingValues(),
 348                                    PN.getName()+".in");
 349
 350   Value *InVal = FirstLI->getOperand(0);
 351   NewPN->addIncoming(InVal, PN.getIncomingBlock(0));
 352
 353   // Add all operands to the new PHI.
 354   for (unsigned i = 1, e = PN.getNumIncomingValues(); i != e; ++i) {
 355     Value *NewInVal = cast<LoadInst>(PN.getIncomingValue(i))->getOperand(0);
 356     if (NewInVal != InVal)
 357       InVal = 0;
 358     NewPN->addIncoming(NewInVal, PN.getIncomingBlock(i));
 359   }
 360
 361   Value *PhiVal;
 362   if (InVal) {
 363     // The new PHI unions all of the same values together.  This is really
 364     // common, so we handle it intelligently here for compile-time speed.
 365     PhiVal = InVal;
 366     delete NewPN;
 367   } else {
 368     InsertNewInstBefore(NewPN, PN);
 369     PhiVal = NewPN;
 370   }
 371
 372   // If this was a volatile load that we are merging, make sure to loop through
 373   // and mark all the input loads as non-volatile.  If we don't do this, we will
 374   // insert a new volatile load and the old ones will not be deletable.
 375   if (isVolatile)
 376     for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 377       cast<LoadInst>(PN.getIncomingValue(i))->setVolatile(false);
 378
 379   LoadInst *NewLI = new LoadInst(PhiVal, "", isVolatile, LoadAlignment);
 380   NewLI->setDebugLoc(FirstLI->getDebugLoc());
 381   return NewLI;
 382 }
 383
 384
 385
 386 /// FoldPHIArgOpIntoPHI - If all operands to a PHI node are the same "unary"
 387 /// operator and they all are only used by the PHI, PHI together their
 388 /// inputs, and do the operation once, to the result of the PHI.
 389 Instruction *InstCombiner::FoldPHIArgOpIntoPHI(PHINode &PN) {
 390   Instruction *FirstInst = cast<Instruction>(PN.getIncomingValue(0));
 391
 392   if (isa<GetElementPtrInst>(FirstInst))
 393     return FoldPHIArgGEPIntoPHI(PN);
 394   if (isa<LoadInst>(FirstInst))
 395     return FoldPHIArgLoadIntoPHI(PN);
 396
 397   // Scan the instruction, looking for input operations that can be folded away.
 398   // If all input operands to the phi are the same instruction (e.g. a cast from
 399   // the same type or "+42") we can pull the operation through the PHI, reducing
 400   // code size and simplifying code.
 401   Constant *ConstantOp = 0;
 402   Type *CastSrcTy = 0;
 403   bool isNUW = false, isNSW = false, isExact = false;
 404
 405   if (isa<CastInst>(FirstInst)) {
 406     CastSrcTy = FirstInst->getOperand(0)->getType();
 407
 408     // Be careful about transforming integer PHIs.  We don't want to pessimize
 409     // the code by turning an i32 into an i1293.
 410     if (PN.getType()->isIntegerTy() && CastSrcTy->isIntegerTy()) {
 411       if (!ShouldChangeType(PN.getType(), CastSrcTy))
 412         return 0;
 413     }
 414   } else if (isa<BinaryOperator>(FirstInst) || isa<CmpInst>(FirstInst)) {
 415     // Can fold binop, compare or shift here if the RHS is a constant,
 416     // otherwise call FoldPHIArgBinOpIntoPHI.
 417     ConstantOp = dyn_cast<Constant>(FirstInst->getOperand(1));
 418     if (ConstantOp == 0)
 419       return FoldPHIArgBinOpIntoPHI(PN);
 420
 421     if (OverflowingBinaryOperator *BO =
 422         dyn_cast<OverflowingBinaryOperator>(FirstInst)) {
 423       isNUW = BO->hasNoUnsignedWrap();
 424       isNSW = BO->hasNoSignedWrap();
 425     } else if (PossiblyExactOperator *PEO =
 426                dyn_cast<PossiblyExactOperator>(FirstInst))
 427       isExact = PEO->isExact();
 428   } else {
 429     return 0;  // Cannot fold this operation.
 430   }
 431
 432   // Check to see if all arguments are the same operation.
 433   for (unsigned i = 1, e = PN.getNumIncomingValues(); i != e; ++i) {
 434     Instruction *I = dyn_cast<Instruction>(PN.getIncomingValue(i));
 435     if (I == 0 || !I->hasOneUse() || !I->isSameOperationAs(FirstInst))
 436       return 0;
 437     if (CastSrcTy) {
 438       if (I->getOperand(0)->getType() != CastSrcTy)
 439         return 0;  // Cast operation must match.
 440     } else if (I->getOperand(1) != ConstantOp) {
 441       return 0;
 442     }
 443
 444     if (isNUW)
 445       isNUW = cast<OverflowingBinaryOperator>(I)->hasNoUnsignedWrap();
 446     if (isNSW)
 447       isNSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
 448     if (isExact)
 449       isExact = cast<PossiblyExactOperator>(I)->isExact();
 450   }
 451
 452   // Okay, they are all the same operation.  Create a new PHI node of the
 453   // correct type, and PHI together all of the LHS's of the instructions.
 454   PHINode *NewPN = PHINode::Create(FirstInst->getOperand(0)->getType(),
 455                                    PN.getNumIncomingValues(),
 456                                    PN.getName()+".in");
 457
 458   Value *InVal = FirstInst->getOperand(0);
 459   NewPN->addIncoming(InVal, PN.getIncomingBlock(0));
 460
 461   // Add all operands to the new PHI.
 462   for (unsigned i = 1, e = PN.getNumIncomingValues(); i != e; ++i) {
 463     Value *NewInVal = cast<Instruction>(PN.getIncomingValue(i))->getOperand(0);
 464     if (NewInVal != InVal)
 465       InVal = 0;
 466     NewPN->addIncoming(NewInVal, PN.getIncomingBlock(i));
 467   }
 468
 469   Value *PhiVal;
 470   if (InVal) {
 471     // The new PHI unions all of the same values together.  This is really
 472     // common, so we handle it intelligently here for compile-time speed.
 473     PhiVal = InVal;
 474     delete NewPN;
 475   } else {
 476     InsertNewInstBefore(NewPN, PN);
 477     PhiVal = NewPN;
 478   }
 479
 480   // Insert and return the new operation.
 481   if (CastInst *FirstCI = dyn_cast<CastInst>(FirstInst)) {
 482     CastInst *NewCI = CastInst::Create(FirstCI->getOpcode(), PhiVal,
 483                                        PN.getType());
 484     NewCI->setDebugLoc(FirstInst->getDebugLoc());
 485     return NewCI;
 486   }
 487
 488   if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(FirstInst)) {
 489     BinOp = BinaryOperator::Create(BinOp->getOpcode(), PhiVal, ConstantOp);
 490     if (isNUW) BinOp->setHasNoUnsignedWrap();
 491     if (isNSW) BinOp->setHasNoSignedWrap();
 492     if (isExact) BinOp->setIsExact();
 493     BinOp->setDebugLoc(FirstInst->getDebugLoc());
 494     return BinOp;
 495   }
 496
 497   CmpInst *CIOp = cast<CmpInst>(FirstInst);
 498   CmpInst *NewCI = CmpInst::Create(CIOp->getOpcode(), CIOp->getPredicate(),
 499                                    PhiVal, ConstantOp);
 500   NewCI->setDebugLoc(FirstInst->getDebugLoc());
 501   return NewCI;
 502 }
 503
 504 /// DeadPHICycle - Return true if this PHI node is only used by a PHI node cycle
 505 /// that is dead.
 506 static bool DeadPHICycle(PHINode *PN,
 507                          SmallPtrSet<PHINode*, 16> &PotentiallyDeadPHIs) {
 508   if (PN->use_empty()) return true;
 509   if (!PN->hasOneUse()) return false;
 510
 511   // Remember this node, and if we find the cycle, return.
 512   if (!PotentiallyDeadPHIs.insert(PN))
 513     return true;
 514
 515   // Don't scan crazily complex things.
 516   if (PotentiallyDeadPHIs.size() == 16)
 517     return false;
 518
 519   if (PHINode *PU = dyn_cast<PHINode>(PN->user_back()))
 520     return DeadPHICycle(PU, PotentiallyDeadPHIs);
 521
 522   return false;
 523 }
 524
 525 /// PHIsEqualValue - Return true if this phi node is always equal to
 526 /// NonPhiInVal.  This happens with mutually cyclic phi nodes like:
 527 ///   z = some value; x = phi (y, z); y = phi (x, z)
 528 static bool PHIsEqualValue(PHINode *PN, Value *NonPhiInVal,
 529                            SmallPtrSet<PHINode*, 16> &ValueEqualPHIs) {
 530   // See if we already saw this PHI node.
 531   if (!ValueEqualPHIs.insert(PN))
 532     return true;
 533
 534   // Don't scan crazily complex things.
 535   if (ValueEqualPHIs.size() == 16)
 536     return false;
 537
 538   // Scan the operands to see if they are either phi nodes or are equal to
 539   // the value.
 540   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 541     Value *Op = PN->getIncomingValue(i);
 542     if (PHINode *OpPN = dyn_cast<PHINode>(Op)) {
 543       if (!PHIsEqualValue(OpPN, NonPhiInVal, ValueEqualPHIs))
 544         return false;
 545     } else if (Op != NonPhiInVal)
 546       return false;
 547   }
 548
 549   return true;
 550 }
 551
 552
 553 namespace {
 554 struct PHIUsageRecord {
 555   unsigned PHIId;     // The ID # of the PHI (something determinstic to sort on)
 556   unsigned Shift;     // The amount shifted.
 557   Instruction *Inst;  // The trunc instruction.
 558
 559   PHIUsageRecord(unsigned pn, unsigned Sh, Instruction *User)
 560     : PHIId(pn), Shift(Sh), Inst(User) {}
 561
 562   bool operator<(const PHIUsageRecord &RHS) const {
 563     if (PHIId < RHS.PHIId) return true;
 564     if (PHIId > RHS.PHIId) return false;
 565     if (Shift < RHS.Shift) return true;
 566     if (Shift > RHS.Shift) return false;
 567     return Inst->getType()->getPrimitiveSizeInBits() <
 568            RHS.Inst->getType()->getPrimitiveSizeInBits();
 569   }
 570 };
 571
 572 struct LoweredPHIRecord {
 573   PHINode *PN;        // The PHI that was lowered.
 574   unsigned Shift;     // The amount shifted.
 575   unsigned Width;     // The width extracted.
 576
 577   LoweredPHIRecord(PHINode *pn, unsigned Sh, Type *Ty)
 578     : PN(pn), Shift(Sh), Width(Ty->getPrimitiveSizeInBits()) {}
 579
 580   // Ctor form used by DenseMap.
 581   LoweredPHIRecord(PHINode *pn, unsigned Sh)
 582     : PN(pn), Shift(Sh), Width(0) {}
 583 };
 584 }
 585
 586 namespace llvm {
 587   template<>
 588   struct DenseMapInfo<LoweredPHIRecord> {
 589     static inline LoweredPHIRecord getEmptyKey() {
 590       return LoweredPHIRecord(0, 0);
 591     }
 592     static inline LoweredPHIRecord getTombstoneKey() {
 593       return LoweredPHIRecord(0, 1);
 594     }
 595     static unsigned getHashValue(const LoweredPHIRecord &Val) {
 596       return DenseMapInfo<PHINode*>::getHashValue(Val.PN) ^ (Val.Shift>>3) ^
 597              (Val.Width>>3);
 598     }
 599     static bool isEqual(const LoweredPHIRecord &LHS,
 600                         const LoweredPHIRecord &RHS) {
 601       return LHS.PN == RHS.PN && LHS.Shift == RHS.Shift &&
 602              LHS.Width == RHS.Width;
 603     }
 604   };
 605 }
 606
 607
 608 /// SliceUpIllegalIntegerPHI - This is an integer PHI and we know that it has an
 609 /// illegal type: see if it is only used by trunc or trunc(lshr) operations.  If
 610 /// so, we split the PHI into the various pieces being extracted.  This sort of
 611 /// thing is introduced when SROA promotes an aggregate to large integer values.
 612 ///
 613 /// TODO: The user of the trunc may be an bitcast to float/double/vector or an
 614 /// inttoptr.  We should produce new PHIs in the right type.
 615 ///
 616 Instruction *InstCombiner::SliceUpIllegalIntegerPHI(PHINode &FirstPhi) {
 617   // PHIUsers - Keep track of all of the truncated values extracted from a set
 618   // of PHIs, along with their offset.  These are the things we want to rewrite.
 619   SmallVector<PHIUsageRecord, 16> PHIUsers;
 620
 621   // PHIs are often mutually cyclic, so we keep track of a whole set of PHI
 622   // nodes which are extracted from. PHIsToSlice is a set we use to avoid
 623   // revisiting PHIs, PHIsInspected is a ordered list of PHIs that we need to
 624   // check the uses of (to ensure they are all extracts).
 625   SmallVector<PHINode*, 8> PHIsToSlice;
 626   SmallPtrSet<PHINode*, 8> PHIsInspected;
 627
 628   PHIsToSlice.push_back(&FirstPhi);
 629   PHIsInspected.insert(&FirstPhi);
 630
 631   for (unsigned PHIId = 0; PHIId != PHIsToSlice.size(); ++PHIId) {
 632     PHINode *PN = PHIsToSlice[PHIId];
 633
 634     // Scan the input list of the PHI.  If any input is an invoke, and if the
 635     // input is defined in the predecessor, then we won't be split the critical
 636     // edge which is required to insert a truncate.  Because of this, we have to
 637     // bail out.
 638     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 639       InvokeInst *II = dyn_cast<InvokeInst>(PN->getIncomingValue(i));
 640       if (II == 0) continue;
 641       if (II->getParent() != PN->getIncomingBlock(i))
 642         continue;
 643
 644       // If we have a phi, and if it's directly in the predecessor, then we have
 645       // a critical edge where we need to put the truncate.  Since we can't
 646       // split the edge in instcombine, we have to bail out.
 647       return 0;
 648     }
 649
 650     for (User *U : PN->users()) {
 651       Instruction *UserI = cast<Instruction>(U);
 652
 653       // If the user is a PHI, inspect its uses recursively.
 654       if (PHINode *UserPN = dyn_cast<PHINode>(UserI)) {
 655         if (PHIsInspected.insert(UserPN))
 656           PHIsToSlice.push_back(UserPN);
 657         continue;
 658       }
 659
 660       // Truncates are always ok.
 661       if (isa<TruncInst>(UserI)) {
 662         PHIUsers.push_back(PHIUsageRecord(PHIId, 0, UserI));
 663         continue;
 664       }
 665
 666       // Otherwise it must be a lshr which can only be used by one trunc.
 667       if (UserI->getOpcode() != Instruction::LShr ||
 668           !UserI->hasOneUse() || !isa<TruncInst>(UserI->user_back()) ||
 669           !isa<ConstantInt>(UserI->getOperand(1)))
 670         return 0;
 671
 672       unsigned Shift = cast<ConstantInt>(UserI->getOperand(1))->getZExtValue();
 673       PHIUsers.push_back(PHIUsageRecord(PHIId, Shift, UserI->user_back()));
 674     }
 675   }
 676
 677   // If we have no users, they must be all self uses, just nuke the PHI.
 678   if (PHIUsers.empty())
 679     return ReplaceInstUsesWith(FirstPhi, UndefValue::get(FirstPhi.getType()));
 680
 681   // If this phi node is transformable, create new PHIs for all the pieces
 682   // extracted out of it.  First, sort the users by their offset and size.
 683   array_pod_sort(PHIUsers.begin(), PHIUsers.end());
 684
 685   DEBUG(dbgs() << "SLICING UP PHI: " << FirstPhi << '\n';
 686         for (unsigned i = 1, e = PHIsToSlice.size(); i != e; ++i)
 687           dbgs() << "AND USER PHI #" << i << ": " << *PHIsToSlice[i] << '\n';
 688     );
 689
 690   // PredValues - This is a temporary used when rewriting PHI nodes.  It is
 691   // hoisted out here to avoid construction/destruction thrashing.
 692   DenseMap<BasicBlock*, Value*> PredValues;
 693
 694   // ExtractedVals - Each new PHI we introduce is saved here so we don't
 695   // introduce redundant PHIs.
 696   DenseMap<LoweredPHIRecord, PHINode*> ExtractedVals;
 697
 698   for (unsigned UserI = 0, UserE = PHIUsers.size(); UserI != UserE; ++UserI) {
 699     unsigned PHIId = PHIUsers[UserI].PHIId;
 700     PHINode *PN = PHIsToSlice[PHIId];
 701     unsigned Offset = PHIUsers[UserI].Shift;
 702     Type *Ty = PHIUsers[UserI].Inst->getType();
 703
 704     PHINode *EltPHI;
 705
 706     // If we've already lowered a user like this, reuse the previously lowered
 707     // value.
 708     if ((EltPHI = ExtractedVals[LoweredPHIRecord(PN, Offset, Ty)]) == 0) {
 709
 710       // Otherwise, Create the new PHI node for this user.
 711       EltPHI = PHINode::Create(Ty, PN->getNumIncomingValues(),
 712                                PN->getName()+".off"+Twine(Offset), PN);
 713       assert(EltPHI->getType() != PN->getType() &&
 714              "Truncate didn't shrink phi?");
 715
 716       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 717         BasicBlock *Pred = PN->getIncomingBlock(i);
 718         Value *&PredVal = PredValues[Pred];
 719
 720         // If we already have a value for this predecessor, reuse it.
 721         if (PredVal) {
 722           EltPHI->addIncoming(PredVal, Pred);
 723           continue;
 724         }
 725
 726         // Handle the PHI self-reuse case.
 727         Value *InVal = PN->getIncomingValue(i);
 728         if (InVal == PN) {
 729           PredVal = EltPHI;
 730           EltPHI->addIncoming(PredVal, Pred);
 731           continue;
 732         }
 733
 734         if (PHINode *InPHI = dyn_cast<PHINode>(PN)) {
 735           // If the incoming value was a PHI, and if it was one of the PHIs we
 736           // already rewrote it, just use the lowered value.
 737           if (Value *Res = ExtractedVals[LoweredPHIRecord(InPHI, Offset, Ty)]) {
 738             PredVal = Res;
 739             EltPHI->addIncoming(PredVal, Pred);
 740             continue;
 741           }
 742         }
 743
 744         // Otherwise, do an extract in the predecessor.
 745         Builder->SetInsertPoint(Pred, Pred->getTerminator());
 746         Value *Res = InVal;
 747         if (Offset)
 748           Res = Builder->CreateLShr(Res, ConstantInt::get(InVal->getType(),
 749                                                           Offset), "extract");
 750         Res = Builder->CreateTrunc(Res, Ty, "extract.t");
 751         PredVal = Res;
 752         EltPHI->addIncoming(Res, Pred);
 753
 754         // If the incoming value was a PHI, and if it was one of the PHIs we are
 755         // rewriting, we will ultimately delete the code we inserted.  This
 756         // means we need to revisit that PHI to make sure we extract out the
 757         // needed piece.
 758         if (PHINode *OldInVal = dyn_cast<PHINode>(PN->getIncomingValue(i)))
 759           if (PHIsInspected.count(OldInVal)) {
 760             unsigned RefPHIId = std::find(PHIsToSlice.begin(),PHIsToSlice.end(),
 761                                           OldInVal)-PHIsToSlice.begin();
 762             PHIUsers.push_back(PHIUsageRecord(RefPHIId, Offset,
 763                                               cast<Instruction>(Res)));
 764             ++UserE;
 765           }
 766       }
 767       PredValues.clear();
 768
 769       DEBUG(dbgs() << "  Made element PHI for offset " << Offset << ": "
 770                    << *EltPHI << '\n');
 771       ExtractedVals[LoweredPHIRecord(PN, Offset, Ty)] = EltPHI;
 772     }
 773
 774     // Replace the use of this piece with the PHI node.
 775     ReplaceInstUsesWith(*PHIUsers[UserI].Inst, EltPHI);
 776   }
 777
 778   // Replace all the remaining uses of the PHI nodes (self uses and the lshrs)
 779   // with undefs.
 780   Value *Undef = UndefValue::get(FirstPhi.getType());
 781   for (unsigned i = 1, e = PHIsToSlice.size(); i != e; ++i)
 782     ReplaceInstUsesWith(*PHIsToSlice[i], Undef);
 783   return ReplaceInstUsesWith(FirstPhi, Undef);
 784 }
 785
 786 // PHINode simplification
 787 //
 788 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
 789   if (Value *V = SimplifyInstruction(&PN, DL, TLI))
 790     return ReplaceInstUsesWith(PN, V);
 791
 792   // If all PHI operands are the same operation, pull them through the PHI,
 793   // reducing code size.
 794   if (isa<Instruction>(PN.getIncomingValue(0)) &&
 795       isa<Instruction>(PN.getIncomingValue(1)) &&
 796       cast<Instruction>(PN.getIncomingValue(0))->getOpcode() ==
 797       cast<Instruction>(PN.getIncomingValue(1))->getOpcode() &&
 798       // FIXME: The hasOneUse check will fail for PHIs that use the value more
 799       // than themselves more than once.
 800       PN.getIncomingValue(0)->hasOneUse())
 801     if (Instruction *Result = FoldPHIArgOpIntoPHI(PN))
 802       return Result;
 803
 804   // If this is a trivial cycle in the PHI node graph, remove it.  Basically, if
 805   // this PHI only has a single use (a PHI), and if that PHI only has one use (a
 806   // PHI)... break the cycle.
 807   if (PN.hasOneUse()) {
 808     Instruction *PHIUser = cast<Instruction>(PN.user_back());
 809     if (PHINode *PU = dyn_cast<PHINode>(PHIUser)) {
 810       SmallPtrSet<PHINode*, 16> PotentiallyDeadPHIs;
 811       PotentiallyDeadPHIs.insert(&PN);
 812       if (DeadPHICycle(PU, PotentiallyDeadPHIs))
 813         return ReplaceInstUsesWith(PN, UndefValue::get(PN.getType()));
 814     }
 815
 816     // If this phi has a single use, and if that use just computes a value for
 817     // the next iteration of a loop, delete the phi.  This occurs with unused
 818     // induction variables, e.g. "for (int j = 0; ; ++j);".  Detecting this
 819     // common case here is good because the only other things that catch this
 820     // are induction variable analysis (sometimes) and ADCE, which is only run
 821     // late.
 822     if (PHIUser->hasOneUse() &&
 823         (isa<BinaryOperator>(PHIUser) || isa<GetElementPtrInst>(PHIUser)) &&
 824         PHIUser->user_back() == &PN) {
 825       return ReplaceInstUsesWith(PN, UndefValue::get(PN.getType()));
 826     }
 827   }
 828
 829   // We sometimes end up with phi cycles that non-obviously end up being the
 830   // same value, for example:
 831   //   z = some value; x = phi (y, z); y = phi (x, z)
 832   // where the phi nodes don't necessarily need to be in the same block.  Do a
 833   // quick check to see if the PHI node only contains a single non-phi value, if
 834   // so, scan to see if the phi cycle is actually equal to that value.
 835   {
 836     unsigned InValNo = 0, NumIncomingVals = PN.getNumIncomingValues();
 837     // Scan for the first non-phi operand.
 838     while (InValNo != NumIncomingVals &&
 839            isa<PHINode>(PN.getIncomingValue(InValNo)))
 840       ++InValNo;
 841
 842     if (InValNo != NumIncomingVals) {
 843       Value *NonPhiInVal = PN.getIncomingValue(InValNo);
 844
 845       // Scan the rest of the operands to see if there are any conflicts, if so
 846       // there is no need to recursively scan other phis.
 847       for (++InValNo; InValNo != NumIncomingVals; ++InValNo) {
 848         Value *OpVal = PN.getIncomingValue(InValNo);
 849         if (OpVal != NonPhiInVal && !isa<PHINode>(OpVal))
 850           break;
 851       }
 852
 853       // If we scanned over all operands, then we have one unique value plus
 854       // phi values.  Scan PHI nodes to see if they all merge in each other or
 855       // the value.
 856       if (InValNo == NumIncomingVals) {
 857         SmallPtrSet<PHINode*, 16> ValueEqualPHIs;
 858         if (PHIsEqualValue(&PN, NonPhiInVal, ValueEqualPHIs))
 859           return ReplaceInstUsesWith(PN, NonPhiInVal);
 860       }
 861     }
 862   }
 863
 864   // If there are multiple PHIs, sort their operands so that they all list
 865   // the blocks in the same order. This will help identical PHIs be eliminated
 866   // by other passes. Other passes shouldn't depend on this for correctness
 867   // however.
 868   PHINode *FirstPN = cast<PHINode>(PN.getParent()->begin());
 869   if (&PN != FirstPN)
 870     for (unsigned i = 0, e = FirstPN->getNumIncomingValues(); i != e; ++i) {
 871       BasicBlock *BBA = PN.getIncomingBlock(i);
 872       BasicBlock *BBB = FirstPN->getIncomingBlock(i);
 873       if (BBA != BBB) {
 874         Value *VA = PN.getIncomingValue(i);
 875         unsigned j = PN.getBasicBlockIndex(BBB);
 876         Value *VB = PN.getIncomingValue(j);
 877         PN.setIncomingBlock(i, BBB);
 878         PN.setIncomingValue(i, VB);
 879         PN.setIncomingBlock(j, BBA);
 880         PN.setIncomingValue(j, VA);
 881         // NOTE: Instcombine normally would want us to "return &PN" if we
 882         // modified any of the operands of an instruction.  However, since we
 883         // aren't adding or removing uses (just rearranging them) we don't do
 884         // this in this case.
 885       }
 886     }
 887
 888   // If this is an integer PHI and we know that it has an illegal type, see if
 889   // it is only used by trunc or trunc(lshr) operations.  If so, we split the
 890   // PHI into the various pieces being extracted.  This sort of thing is
 891   // introduced when SROA promotes an aggregate to a single large integer type.
 892   if (PN.getType()->isIntegerTy() && DL &&
 893       !DL->isLegalInteger(PN.getType()->getPrimitiveSizeInBits()))
 894     if (Instruction *Res = SliceUpIllegalIntegerPHI(PN))
 895       return Res;
 896
 897   return 0;
 898 }