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 "InstCombineInternal.h"
  15 #include "llvm/ADT/STLExtras.h"
  16 #include "llvm/ADT/SmallPtrSet.h"
  17 #include "llvm/Analysis/InstructionSimplify.h"
  18 using namespace llvm;
  19
  20 #define DEBUG_TYPE "instcombine"
  21
  22 /// If we have something like phi [add (a,b), add(a,c)] and if a/b/c and the
  23 /// adds all have a single use, turn this into a phi 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 nullptr;
  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 nullptr;
  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 = nullptr;
  67     if (I->getOperand(1) != RHSVal) RHSVal = nullptr;
  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 nullptr;
  76
  77   // Otherwise, this is safe to transform!
  78
  79   Value *InLHS = FirstInst->getOperand(0);
  80   Value *InRHS = FirstInst->getOperand(1);
  81   PHINode *NewLHS = nullptr, *NewRHS = nullptr;
  82   if (!LHSVal) {
  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) {
  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 nullptr;
 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 nullptr;
 174
 175       if (FirstInst->getOperand(op)->getType() !=GEP->getOperand(op)->getType())
 176         return nullptr;
 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 nullptr;
 184
 185       FixedOperands[op] = nullptr;  // 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 nullptr;
 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(FirstInst->getSourceElementType(), Base,
 233                                 makeArrayRef(FixedOperands).slice(1));
 234   if (AllInBounds) NewGEP->setIsInBounds();
 235   NewGEP->setDebugLoc(FirstInst->getDebugLoc());
 236   return NewGEP;
 237 }
 238
 239
 240 /// Return true if we know that it is safe to sink the load out of the block
 241 /// that defines it. This means that it must be obvious the value of the load is
 242 /// not changed from the point of the load to 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 nullptr;
 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 nullptr;
 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 nullptr;
 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 nullptr;
 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 nullptr;
 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 nullptr;
 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 nullptr;
 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 = nullptr;
 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 (Value *IncValue : PN.incoming_values())
 377       cast<LoadInst>(IncValue)->setVolatile(false);
 378
 379   LoadInst *NewLI = new LoadInst(PhiVal, "", isVolatile, LoadAlignment);
 380   NewLI->setDebugLoc(FirstLI->getDebugLoc());
 381   return NewLI;
 382 }
 383
 384
 385
 386 /// If all operands to a PHI node are the same "unary" operator and they all are
 387 /// only used by the PHI, PHI together their inputs, and do the operation once,
 388 /// 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 = nullptr;
 402   Type *CastSrcTy = nullptr;
 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 nullptr;
 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)
 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 nullptr;  // 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 || !I->hasOneUse() || !I->isSameOperationAs(FirstInst))
 436       return nullptr;
 437     if (CastSrcTy) {
 438       if (I->getOperand(0)->getType() != CastSrcTy)
 439         return nullptr;  // Cast operation must match.
 440     } else if (I->getOperand(1) != ConstantOp) {
 441       return nullptr;
 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 = nullptr;
 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 /// Return true if this PHI node is only used by a PHI node cycle that is dead.
 505 static bool DeadPHICycle(PHINode *PN,
 506                          SmallPtrSetImpl<PHINode*> &PotentiallyDeadPHIs) {
 507   if (PN->use_empty()) return true;
 508   if (!PN->hasOneUse()) return false;
 509
 510   // Remember this node, and if we find the cycle, return.
 511   if (!PotentiallyDeadPHIs.insert(PN).second)
 512     return true;
 513
 514   // Don't scan crazily complex things.
 515   if (PotentiallyDeadPHIs.size() == 16)
 516     return false;
 517
 518   if (PHINode *PU = dyn_cast<PHINode>(PN->user_back()))
 519     return DeadPHICycle(PU, PotentiallyDeadPHIs);
 520
 521   return false;
 522 }
 523
 524 /// Return true if this phi node is always equal to NonPhiInVal.
 525 /// This happens with mutually cyclic phi nodes like:
 526 ///   z = some value; x = phi (y, z); y = phi (x, z)
 527 static bool PHIsEqualValue(PHINode *PN, Value *NonPhiInVal,
 528                            SmallPtrSetImpl<PHINode*> &ValueEqualPHIs) {
 529   // See if we already saw this PHI node.
 530   if (!ValueEqualPHIs.insert(PN).second)
 531     return true;
 532
 533   // Don't scan crazily complex things.
 534   if (ValueEqualPHIs.size() == 16)
 535     return false;
 536
 537   // Scan the operands to see if they are either phi nodes or are equal to
 538   // the value.
 539   for (Value *Op : PN->incoming_values()) {
 540     if (PHINode *OpPN = dyn_cast<PHINode>(Op)) {
 541       if (!PHIsEqualValue(OpPN, NonPhiInVal, ValueEqualPHIs))
 542         return false;
 543     } else if (Op != NonPhiInVal)
 544       return false;
 545   }
 546
 547   return true;
 548 }
 549
 550
 551 namespace {
 552 struct PHIUsageRecord {
 553   unsigned PHIId;     // The ID # of the PHI (something determinstic to sort on)
 554   unsigned Shift;     // The amount shifted.
 555   Instruction *Inst;  // The trunc instruction.
 556
 557   PHIUsageRecord(unsigned pn, unsigned Sh, Instruction *User)
 558     : PHIId(pn), Shift(Sh), Inst(User) {}
 559
 560   bool operator<(const PHIUsageRecord &RHS) const {
 561     if (PHIId < RHS.PHIId) return true;
 562     if (PHIId > RHS.PHIId) return false;
 563     if (Shift < RHS.Shift) return true;
 564     if (Shift > RHS.Shift) return false;
 565     return Inst->getType()->getPrimitiveSizeInBits() <
 566            RHS.Inst->getType()->getPrimitiveSizeInBits();
 567   }
 568 };
 569
 570 struct LoweredPHIRecord {
 571   PHINode *PN;        // The PHI that was lowered.
 572   unsigned Shift;     // The amount shifted.
 573   unsigned Width;     // The width extracted.
 574
 575   LoweredPHIRecord(PHINode *pn, unsigned Sh, Type *Ty)
 576     : PN(pn), Shift(Sh), Width(Ty->getPrimitiveSizeInBits()) {}
 577
 578   // Ctor form used by DenseMap.
 579   LoweredPHIRecord(PHINode *pn, unsigned Sh)
 580     : PN(pn), Shift(Sh), Width(0) {}
 581 };
 582 }
 583
 584 namespace llvm {
 585   template<>
 586   struct DenseMapInfo<LoweredPHIRecord> {
 587     static inline LoweredPHIRecord getEmptyKey() {
 588       return LoweredPHIRecord(nullptr, 0);
 589     }
 590     static inline LoweredPHIRecord getTombstoneKey() {
 591       return LoweredPHIRecord(nullptr, 1);
 592     }
 593     static unsigned getHashValue(const LoweredPHIRecord &Val) {
 594       return DenseMapInfo<PHINode*>::getHashValue(Val.PN) ^ (Val.Shift>>3) ^
 595              (Val.Width>>3);
 596     }
 597     static bool isEqual(const LoweredPHIRecord &LHS,
 598                         const LoweredPHIRecord &RHS) {
 599       return LHS.PN == RHS.PN && LHS.Shift == RHS.Shift &&
 600              LHS.Width == RHS.Width;
 601     }
 602   };
 603 }
 604
 605
 606 /// This is an integer PHI and we know that it has an illegal type: see if it is
 607 /// only used by trunc or trunc(lshr) operations. If so, we split the PHI into
 608 /// the various pieces being extracted. This sort of thing is introduced when
 609 /// SROA promotes an aggregate to large integer values.
 610 ///
 611 /// TODO: The user of the trunc may be an bitcast to float/double/vector or an
 612 /// inttoptr.  We should produce new PHIs in the right type.
 613 ///
 614 Instruction *InstCombiner::SliceUpIllegalIntegerPHI(PHINode &FirstPhi) {
 615   // PHIUsers - Keep track of all of the truncated values extracted from a set
 616   // of PHIs, along with their offset.  These are the things we want to rewrite.
 617   SmallVector<PHIUsageRecord, 16> PHIUsers;
 618
 619   // PHIs are often mutually cyclic, so we keep track of a whole set of PHI
 620   // nodes which are extracted from. PHIsToSlice is a set we use to avoid
 621   // revisiting PHIs, PHIsInspected is a ordered list of PHIs that we need to
 622   // check the uses of (to ensure they are all extracts).
 623   SmallVector<PHINode*, 8> PHIsToSlice;
 624   SmallPtrSet<PHINode*, 8> PHIsInspected;
 625
 626   PHIsToSlice.push_back(&FirstPhi);
 627   PHIsInspected.insert(&FirstPhi);
 628
 629   for (unsigned PHIId = 0; PHIId != PHIsToSlice.size(); ++PHIId) {
 630     PHINode *PN = PHIsToSlice[PHIId];
 631
 632     // Scan the input list of the PHI.  If any input is an invoke, and if the
 633     // input is defined in the predecessor, then we won't be split the critical
 634     // edge which is required to insert a truncate.  Because of this, we have to
 635     // bail out.
 636     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 637       InvokeInst *II = dyn_cast<InvokeInst>(PN->getIncomingValue(i));
 638       if (!II) continue;
 639       if (II->getParent() != PN->getIncomingBlock(i))
 640         continue;
 641
 642       // If we have a phi, and if it's directly in the predecessor, then we have
 643       // a critical edge where we need to put the truncate.  Since we can't
 644       // split the edge in instcombine, we have to bail out.
 645       return nullptr;
 646     }
 647
 648     for (User *U : PN->users()) {
 649       Instruction *UserI = cast<Instruction>(U);
 650
 651       // If the user is a PHI, inspect its uses recursively.
 652       if (PHINode *UserPN = dyn_cast<PHINode>(UserI)) {
 653         if (PHIsInspected.insert(UserPN).second)
 654           PHIsToSlice.push_back(UserPN);
 655         continue;
 656       }
 657
 658       // Truncates are always ok.
 659       if (isa<TruncInst>(UserI)) {
 660         PHIUsers.push_back(PHIUsageRecord(PHIId, 0, UserI));
 661         continue;
 662       }
 663
 664       // Otherwise it must be a lshr which can only be used by one trunc.
 665       if (UserI->getOpcode() != Instruction::LShr ||
 666           !UserI->hasOneUse() || !isa<TruncInst>(UserI->user_back()) ||
 667           !isa<ConstantInt>(UserI->getOperand(1)))
 668         return nullptr;
 669
 670       unsigned Shift = cast<ConstantInt>(UserI->getOperand(1))->getZExtValue();
 671       PHIUsers.push_back(PHIUsageRecord(PHIId, Shift, UserI->user_back()));
 672     }
 673   }
 674
 675   // If we have no users, they must be all self uses, just nuke the PHI.
 676   if (PHIUsers.empty())
 677     return ReplaceInstUsesWith(FirstPhi, UndefValue::get(FirstPhi.getType()));
 678
 679   // If this phi node is transformable, create new PHIs for all the pieces
 680   // extracted out of it.  First, sort the users by their offset and size.
 681   array_pod_sort(PHIUsers.begin(), PHIUsers.end());
 682
 683   DEBUG(dbgs() << "SLICING UP PHI: " << FirstPhi << '\n';
 684         for (unsigned i = 1, e = PHIsToSlice.size(); i != e; ++i)
 685           dbgs() << "AND USER PHI #" << i << ": " << *PHIsToSlice[i] << '\n';
 686     );
 687
 688   // PredValues - This is a temporary used when rewriting PHI nodes.  It is
 689   // hoisted out here to avoid construction/destruction thrashing.
 690   DenseMap<BasicBlock*, Value*> PredValues;
 691
 692   // ExtractedVals - Each new PHI we introduce is saved here so we don't
 693   // introduce redundant PHIs.
 694   DenseMap<LoweredPHIRecord, PHINode*> ExtractedVals;
 695
 696   for (unsigned UserI = 0, UserE = PHIUsers.size(); UserI != UserE; ++UserI) {
 697     unsigned PHIId = PHIUsers[UserI].PHIId;
 698     PHINode *PN = PHIsToSlice[PHIId];
 699     unsigned Offset = PHIUsers[UserI].Shift;
 700     Type *Ty = PHIUsers[UserI].Inst->getType();
 701
 702     PHINode *EltPHI;
 703
 704     // If we've already lowered a user like this, reuse the previously lowered
 705     // value.
 706     if ((EltPHI = ExtractedVals[LoweredPHIRecord(PN, Offset, Ty)]) == nullptr) {
 707
 708       // Otherwise, Create the new PHI node for this user.
 709       EltPHI = PHINode::Create(Ty, PN->getNumIncomingValues(),
 710                                PN->getName()+".off"+Twine(Offset), PN);
 711       assert(EltPHI->getType() != PN->getType() &&
 712              "Truncate didn't shrink phi?");
 713
 714       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 715         BasicBlock *Pred = PN->getIncomingBlock(i);
 716         Value *&PredVal = PredValues[Pred];
 717
 718         // If we already have a value for this predecessor, reuse it.
 719         if (PredVal) {
 720           EltPHI->addIncoming(PredVal, Pred);
 721           continue;
 722         }
 723
 724         // Handle the PHI self-reuse case.
 725         Value *InVal = PN->getIncomingValue(i);
 726         if (InVal == PN) {
 727           PredVal = EltPHI;
 728           EltPHI->addIncoming(PredVal, Pred);
 729           continue;
 730         }
 731
 732         if (PHINode *InPHI = dyn_cast<PHINode>(PN)) {
 733           // If the incoming value was a PHI, and if it was one of the PHIs we
 734           // already rewrote it, just use the lowered value.
 735           if (Value *Res = ExtractedVals[LoweredPHIRecord(InPHI, Offset, Ty)]) {
 736             PredVal = Res;
 737             EltPHI->addIncoming(PredVal, Pred);
 738             continue;
 739           }
 740         }
 741
 742         // Otherwise, do an extract in the predecessor.
 743         Builder->SetInsertPoint(Pred, Pred->getTerminator());
 744         Value *Res = InVal;
 745         if (Offset)
 746           Res = Builder->CreateLShr(Res, ConstantInt::get(InVal->getType(),
 747                                                           Offset), "extract");
 748         Res = Builder->CreateTrunc(Res, Ty, "extract.t");
 749         PredVal = Res;
 750         EltPHI->addIncoming(Res, Pred);
 751
 752         // If the incoming value was a PHI, and if it was one of the PHIs we are
 753         // rewriting, we will ultimately delete the code we inserted.  This
 754         // means we need to revisit that PHI to make sure we extract out the
 755         // needed piece.
 756         if (PHINode *OldInVal = dyn_cast<PHINode>(PN->getIncomingValue(i)))
 757           if (PHIsInspected.count(OldInVal)) {
 758             unsigned RefPHIId = std::find(PHIsToSlice.begin(),PHIsToSlice.end(),
 759                                           OldInVal)-PHIsToSlice.begin();
 760             PHIUsers.push_back(PHIUsageRecord(RefPHIId, Offset,
 761                                               cast<Instruction>(Res)));
 762             ++UserE;
 763           }
 764       }
 765       PredValues.clear();
 766
 767       DEBUG(dbgs() << "  Made element PHI for offset " << Offset << ": "
 768                    << *EltPHI << '\n');
 769       ExtractedVals[LoweredPHIRecord(PN, Offset, Ty)] = EltPHI;
 770     }
 771
 772     // Replace the use of this piece with the PHI node.
 773     ReplaceInstUsesWith(*PHIUsers[UserI].Inst, EltPHI);
 774   }
 775
 776   // Replace all the remaining uses of the PHI nodes (self uses and the lshrs)
 777   // with undefs.
 778   Value *Undef = UndefValue::get(FirstPhi.getType());
 779   for (unsigned i = 1, e = PHIsToSlice.size(); i != e; ++i)
 780     ReplaceInstUsesWith(*PHIsToSlice[i], Undef);
 781   return ReplaceInstUsesWith(FirstPhi, Undef);
 782 }
 783
 784 // If a PHI node has two edges and the PHI node is used in instructions like
 785 // add, sub, mul, div, shifts; if one of incoming values is a constant
 786 // that makes the instruction and identity operation, we can hoist this
 787 // instruction into one of the basic blocks.
 788 // Because of such a transformation, the identity operation won't be
 789 // executed, since it doesn't contribute to the result.
 790 //
 791 static Instruction *PartiallySimplifyIdentityOps(PHINode &PN, const Constant &C,
 792                                                  Value &IncomingVal,
 793                                                  Instruction &PNUser,
 794                                                  InstCombiner &IC) {
 795   if (!PNUser.isBinaryOp())
 796     return nullptr;
 797   if (PN.getParent() != PNUser.getParent())
 798     return nullptr;
 799
 800   //       C                  IncomingVal
 801   //        \                     /
 802   //         \  0             1  / -- (IncomingValIdx)
 803   //          \                 /
 804   // PN = phi [C , ...] [ IncomingVal, BB ]
 805   // ...
 806   //              0  1 -- (OpOperandIdx)
 807   // PNUser = op PN, x
 808   const unsigned IncomingValIdx =
 809       (&IncomingVal == PN.getIncomingValue(0)) ? 0 : 1;
 810   const unsigned OpOperandIdx = (&PN == PNUser.getOperand(0)) ? 1 : 0;
 811
 812   // Exit if not an identity operation.
 813   // For everything except add Add and Mul constant must be on the RHS.
 814   switch (PNUser.getOpcode()) {
 815   default:
 816     return nullptr;
 817   case Instruction::Add:
 818     if (!C.isZeroValue())
 819       return nullptr;
 820     break;
 821
 822   case Instruction::Sub:
 823   case Instruction::Shl:
 824   case Instruction::LShr:
 825   case Instruction::AShr:
 826     if (!C.isZeroValue() || OpOperandIdx == 1)
 827       return nullptr;
 828     break;
 829
 830   case Instruction::Mul:
 831     if (!C.isOneValue())
 832       return nullptr;
 833     break;
 834
 835   case Instruction::UDiv:
 836   case Instruction::SDiv:
 837     if (!C.isOneValue() || OpOperandIdx == 1)
 838       return nullptr;
 839     break;
 840   }
 841
 842   BasicBlock *BB = PN.getIncomingBlock(IncomingValIdx);
 843   auto *Terminator = BB->getTerminator();
 844
 845   if (const auto *Incoming = dyn_cast<Instruction>(&IncomingVal))
 846     if (!IC.getDominatorTree()->dominates(Incoming, Terminator))
 847       return nullptr;
 848
 849   // Operand must be available in newly generated instruction and
 850   // as an incoming value of the PHI node.
 851   if (const auto *Operand =
 852           dyn_cast<Instruction>(PNUser.getOperand(OpOperandIdx)))
 853     if (!IC.getDominatorTree()->dominates(Operand, Terminator) ||
 854         !IC.getDominatorTree()->dominates(Operand, &PN))
 855       return nullptr;
 856
 857   // Ensure that the non-constant value in the PHI node doesn't come
 858   // from the same BasicBlock as the PHI node. This prevents errors
 859   // that could appear with loops (loop backedge could have this
 860   // problem).
 861   if (PN.getIncomingBlock(IncomingValIdx) == PN.getParent())
 862     return nullptr;
 863
 864   Value *LHS = &IncomingVal, *RHS = PNUser.getOperand(OpOperandIdx);
 865   if (OpOperandIdx == 0)
 866     std::swap(LHS, RHS);
 867
 868   // Add new instruction to one of the edges.
 869   IRBuilder<> Builder(Terminator);
 870   auto *NewInst =
 871       Builder.CreateBinOp(cast<BinaryOperator>(PNUser).getOpcode(), LHS, RHS);
 872   cast<BinaryOperator>(NewInst)->copyIRFlags(&PNUser);
 873
 874   // The new incoming values are:
 875   // - result of the newly emmited instruction
 876   // - operand of the instruction
 877   PN.setIncomingValue(IncomingValIdx, NewInst);
 878   PN.setIncomingValue(IncomingValIdx == 0 ? 1 : 0,
 879                       PNUser.getOperand(OpOperandIdx));
 880   IC.ReplaceInstUsesWith(PNUser, &PN);
 881   return &PN;
 882 }
 883
 884 // PHINode simplification
 885 //
 886 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
 887   if (Value *V = SimplifyInstruction(&PN, DL, TLI, DT, AC))
 888     return ReplaceInstUsesWith(PN, V);
 889
 890   // If all PHI operands are the same operation, pull them through the PHI,
 891   // reducing code size.
 892   if (isa<Instruction>(PN.getIncomingValue(0)) &&
 893       isa<Instruction>(PN.getIncomingValue(1)) &&
 894       cast<Instruction>(PN.getIncomingValue(0))->getOpcode() ==
 895       cast<Instruction>(PN.getIncomingValue(1))->getOpcode() &&
 896       // FIXME: The hasOneUse check will fail for PHIs that use the value more
 897       // than themselves more than once.
 898       PN.getIncomingValue(0)->hasOneUse())
 899     if (Instruction *Result = FoldPHIArgOpIntoPHI(PN))
 900       return Result;
 901
 902   // If this is a trivial cycle in the PHI node graph, remove it.  Basically, if
 903   // this PHI only has a single use (a PHI), and if that PHI only has one use (a
 904   // PHI)... break the cycle.
 905   if (PN.hasOneUse()) {
 906     Instruction *PHIUser = cast<Instruction>(PN.user_back());
 907     if (PHINode *PU = dyn_cast<PHINode>(PHIUser)) {
 908       SmallPtrSet<PHINode*, 16> PotentiallyDeadPHIs;
 909       PotentiallyDeadPHIs.insert(&PN);
 910       if (DeadPHICycle(PU, PotentiallyDeadPHIs))
 911         return ReplaceInstUsesWith(PN, UndefValue::get(PN.getType()));
 912     }
 913
 914     // If this phi has a single use, and if that use just computes a value for
 915     // the next iteration of a loop, delete the phi.  This occurs with unused
 916     // induction variables, e.g. "for (int j = 0; ; ++j);".  Detecting this
 917     // common case here is good because the only other things that catch this
 918     // are induction variable analysis (sometimes) and ADCE, which is only run
 919     // late.
 920     if (PHIUser->hasOneUse() &&
 921         (isa<BinaryOperator>(PHIUser) || isa<GetElementPtrInst>(PHIUser)) &&
 922         PHIUser->user_back() == &PN) {
 923       return ReplaceInstUsesWith(PN, UndefValue::get(PN.getType()));
 924     }
 925
 926     // If this phi has one use, exactly 2 edges and one is a constant, we
 927     // may be able to apply the PartiallySimplifyIdentityOps optimization.
 928     if (PN.getNumIncomingValues() == 2) {
 929       const Constant *C = dyn_cast<Constant>(PN.getIncomingValue(0));
 930       Value *Val = PN.getIncomingValue(1);
 931       if (!C) {
 932         C = dyn_cast<Constant>(PN.getIncomingValue(1));
 933         Val = PN.getIncomingValue(0);
 934       }
 935       if (C && !isa<Constant>(Val))
 936         if (auto *I =
 937                 PartiallySimplifyIdentityOps(PN, *C, *Val, *PHIUser, *this))
 938           return I;
 939     }
 940   }
 941
 942   // We sometimes end up with phi cycles that non-obviously end up being the
 943   // same value, for example:
 944   //   z = some value; x = phi (y, z); y = phi (x, z)
 945   // where the phi nodes don't necessarily need to be in the same block.  Do a
 946   // quick check to see if the PHI node only contains a single non-phi value, if
 947   // so, scan to see if the phi cycle is actually equal to that value.
 948   {
 949     unsigned InValNo = 0, NumIncomingVals = PN.getNumIncomingValues();
 950     // Scan for the first non-phi operand.
 951     while (InValNo != NumIncomingVals &&
 952            isa<PHINode>(PN.getIncomingValue(InValNo)))
 953       ++InValNo;
 954
 955     if (InValNo != NumIncomingVals) {
 956       Value *NonPhiInVal = PN.getIncomingValue(InValNo);
 957
 958       // Scan the rest of the operands to see if there are any conflicts, if so
 959       // there is no need to recursively scan other phis.
 960       for (++InValNo; InValNo != NumIncomingVals; ++InValNo) {
 961         Value *OpVal = PN.getIncomingValue(InValNo);
 962         if (OpVal != NonPhiInVal && !isa<PHINode>(OpVal))
 963           break;
 964       }
 965
 966       // If we scanned over all operands, then we have one unique value plus
 967       // phi values.  Scan PHI nodes to see if they all merge in each other or
 968       // the value.
 969       if (InValNo == NumIncomingVals) {
 970         SmallPtrSet<PHINode*, 16> ValueEqualPHIs;
 971         if (PHIsEqualValue(&PN, NonPhiInVal, ValueEqualPHIs))
 972           return ReplaceInstUsesWith(PN, NonPhiInVal);
 973       }
 974     }
 975   }
 976
 977   // If there are multiple PHIs, sort their operands so that they all list
 978   // the blocks in the same order. This will help identical PHIs be eliminated
 979   // by other passes. Other passes shouldn't depend on this for correctness
 980   // however.
 981   PHINode *FirstPN = cast<PHINode>(PN.getParent()->begin());
 982   if (&PN != FirstPN)
 983     for (unsigned i = 0, e = FirstPN->getNumIncomingValues(); i != e; ++i) {
 984       BasicBlock *BBA = PN.getIncomingBlock(i);
 985       BasicBlock *BBB = FirstPN->getIncomingBlock(i);
 986       if (BBA != BBB) {
 987         Value *VA = PN.getIncomingValue(i);
 988         unsigned j = PN.getBasicBlockIndex(BBB);
 989         Value *VB = PN.getIncomingValue(j);
 990         PN.setIncomingBlock(i, BBB);
 991         PN.setIncomingValue(i, VB);
 992         PN.setIncomingBlock(j, BBA);
 993         PN.setIncomingValue(j, VA);
 994         // NOTE: Instcombine normally would want us to "return &PN" if we
 995         // modified any of the operands of an instruction.  However, since we
 996         // aren't adding or removing uses (just rearranging them) we don't do
 997         // this in this case.
 998       }
 999     }
1000
1001   // If this is an integer PHI and we know that it has an illegal type, see if
1002   // it is only used by trunc or trunc(lshr) operations.  If so, we split the
1003   // PHI into the various pieces being extracted.  This sort of thing is
1004   // introduced when SROA promotes an aggregate to a single large integer type.
1005   if (PN.getType()->isIntegerTy() &&
1006       !DL.isLegalInteger(PN.getType()->getPrimitiveSizeInBits()))
1007     if (Instruction *Res = SliceUpIllegalIntegerPHI(PN))
1008       return Res;
1009
1010   return nullptr;
1011 }