lib/Transforms/InstCombine/InstCombineLoadStoreAlloca.cpp

   1 //===- InstCombineLoadStoreAlloca.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 visit functions for load, store and alloca.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "InstCombine.h"
  15 #include "llvm/IntrinsicInst.h"
  16 #include "llvm/Analysis/Loads.h"
  17 #include "llvm/Target/TargetData.h"
  18 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  19 #include "llvm/Transforms/Utils/Local.h"
  20 #include "llvm/ADT/Statistic.h"
  21 using namespace llvm;
  22
  23 STATISTIC(NumDeadStore, "Number of dead stores eliminated");
  24
  25 Instruction *InstCombiner::visitAllocaInst(AllocaInst &AI) {
  26   // Ensure that the alloca array size argument has type intptr_t, so that
  27   // any casting is exposed early.
  28   if (TD) {
  29     const Type *IntPtrTy = TD->getIntPtrType(AI.getContext());
  30     if (AI.getArraySize()->getType() != IntPtrTy) {
  31       Value *V = Builder->CreateIntCast(AI.getArraySize(),
  32                                         IntPtrTy, false);
  33       AI.setOperand(0, V);
  34       return &AI;
  35     }
  36   }
  37
  38   // Convert: alloca Ty, C - where C is a constant != 1 into: alloca [C x Ty], 1
  39   if (AI.isArrayAllocation()) {  // Check C != 1
  40     if (const ConstantInt *C = dyn_cast<ConstantInt>(AI.getArraySize())) {
  41       const Type *NewTy =
  42         ArrayType::get(AI.getAllocatedType(), C->getZExtValue());
  43       assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
  44       AllocaInst *New = Builder->CreateAlloca(NewTy, 0, AI.getName());
  45       New->setAlignment(AI.getAlignment());
  46
  47       // Scan to the end of the allocation instructions, to skip over a block of
  48       // allocas if possible...also skip interleaved debug info
  49       //
  50       BasicBlock::iterator It = New;
  51       while (isa<AllocaInst>(*It) || isa<DbgInfoIntrinsic>(*It)) ++It;
  52
  53       // Now that I is pointing to the first non-allocation-inst in the block,
  54       // insert our getelementptr instruction...
  55       //
  56       Value *NullIdx =Constant::getNullValue(Type::getInt32Ty(AI.getContext()));
  57       Value *Idx[2];
  58       Idx[0] = NullIdx;
  59       Idx[1] = NullIdx;
  60       Value *V = GetElementPtrInst::CreateInBounds(New, Idx, Idx + 2,
  61                                                    New->getName()+".sub", It);
  62
  63       // Now make everything use the getelementptr instead of the original
  64       // allocation.
  65       return ReplaceInstUsesWith(AI, V);
  66     } else if (isa<UndefValue>(AI.getArraySize())) {
  67       return ReplaceInstUsesWith(AI, Constant::getNullValue(AI.getType()));
  68     }
  69   }
  70
  71   if (TD && isa<AllocaInst>(AI) && AI.getAllocatedType()->isSized()) {
  72     // If alloca'ing a zero byte object, replace the alloca with a null pointer.
  73     // Note that we only do this for alloca's, because malloc should allocate
  74     // and return a unique pointer, even for a zero byte allocation.
  75     if (TD->getTypeAllocSize(AI.getAllocatedType()) == 0)
  76       return ReplaceInstUsesWith(AI, Constant::getNullValue(AI.getType()));
  77
  78     // If the alignment is 0 (unspecified), assign it the preferred alignment.
  79     if (AI.getAlignment() == 0)
  80       AI.setAlignment(TD->getPrefTypeAlignment(AI.getAllocatedType()));
  81   }
  82
  83   return 0;
  84 }
  85
  86
  87 /// InstCombineLoadCast - Fold 'load (cast P)' -> cast (load P)' when possible.
  88 static Instruction *InstCombineLoadCast(InstCombiner &IC, LoadInst &LI,
  89                                         const TargetData *TD) {
  90   User *CI = cast<User>(LI.getOperand(0));
  91   Value *CastOp = CI->getOperand(0);
  92
  93   const PointerType *DestTy = cast<PointerType>(CI->getType());
  94   const Type *DestPTy = DestTy->getElementType();
  95   if (const PointerType *SrcTy = dyn_cast<PointerType>(CastOp->getType())) {
  96
  97     // If the address spaces don't match, don't eliminate the cast.
  98     if (DestTy->getAddressSpace() != SrcTy->getAddressSpace())
  99       return 0;
 100
 101     const Type *SrcPTy = SrcTy->getElementType();
 102
 103     if (DestPTy->isIntegerTy() || DestPTy->isPointerTy() ||
 104          DestPTy->isVectorTy()) {
 105       // If the source is an array, the code below will not succeed.  Check to
 106       // see if a trivial 'gep P, 0, 0' will help matters.  Only do this for
 107       // constants.
 108       if (const ArrayType *ASrcTy = dyn_cast<ArrayType>(SrcPTy))
 109         if (Constant *CSrc = dyn_cast<Constant>(CastOp))
 110           if (ASrcTy->getNumElements() != 0) {
 111             Value *Idxs[2];
 112             Idxs[0] = Constant::getNullValue(Type::getInt32Ty(LI.getContext()));
 113             Idxs[1] = Idxs[0];
 114             CastOp = ConstantExpr::getGetElementPtr(CSrc, Idxs, 2);
 115             SrcTy = cast<PointerType>(CastOp->getType());
 116             SrcPTy = SrcTy->getElementType();
 117           }
 118
 119       if (IC.getTargetData() &&
 120           (SrcPTy->isIntegerTy() || SrcPTy->isPointerTy() ||
 121             SrcPTy->isVectorTy()) &&
 122           // Do not allow turning this into a load of an integer, which is then
 123           // casted to a pointer, this pessimizes pointer analysis a lot.
 124           (SrcPTy->isPointerTy() == LI.getType()->isPointerTy()) &&
 125           IC.getTargetData()->getTypeSizeInBits(SrcPTy) ==
 126                IC.getTargetData()->getTypeSizeInBits(DestPTy)) {
 127
 128         // Okay, we are casting from one integer or pointer type to another of
 129         // the same size.  Instead of casting the pointer before the load, cast
 130         // the result of the loaded value.
 131         LoadInst *NewLoad =
 132           IC.Builder->CreateLoad(CastOp, LI.isVolatile(), CI->getName());
 133         NewLoad->setAlignment(LI.getAlignment());
 134         // Now cast the result of the load.
 135         return new BitCastInst(NewLoad, LI.getType());
 136       }
 137     }
 138   }
 139   return 0;
 140 }
 141
 142 Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
 143   Value *Op = LI.getOperand(0);
 144
 145   // Attempt to improve the alignment.
 146   if (TD) {
 147     unsigned KnownAlign =
 148       GetOrEnforceKnownAlignment(Op, TD->getPrefTypeAlignment(LI.getType()));
 149     unsigned LoadAlign = LI.getAlignment();
 150     unsigned EffectiveLoadAlign = LoadAlign != 0 ? LoadAlign :
 151       TD->getABITypeAlignment(LI.getType());
 152
 153     if (KnownAlign > EffectiveLoadAlign)
 154       LI.setAlignment(KnownAlign);
 155     else if (LoadAlign == 0)
 156       LI.setAlignment(EffectiveLoadAlign);
 157   }
 158
 159   // load (cast X) --> cast (load X) iff safe.
 160   if (isa<CastInst>(Op))
 161     if (Instruction *Res = InstCombineLoadCast(*this, LI, TD))
 162       return Res;
 163
 164   // None of the following transforms are legal for volatile loads.
 165   if (LI.isVolatile()) return 0;
 166
 167   // Do really simple store-to-load forwarding and load CSE, to catch cases
 168   // where there are several consequtive memory accesses to the same location,
 169   // separated by a few arithmetic operations.
 170   BasicBlock::iterator BBI = &LI;
 171   if (Value *AvailableVal = FindAvailableLoadedValue(Op, LI.getParent(), BBI,6))
 172     return ReplaceInstUsesWith(LI, AvailableVal);
 173
 174   // load(gep null, ...) -> unreachable
 175   if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(Op)) {
 176     const Value *GEPI0 = GEPI->getOperand(0);
 177     // TODO: Consider a target hook for valid address spaces for this xform.
 178     if (isa<ConstantPointerNull>(GEPI0) && GEPI->getPointerAddressSpace() == 0){
 179       // Insert a new store to null instruction before the load to indicate
 180       // that this code is not reachable.  We do this instead of inserting
 181       // an unreachable instruction directly because we cannot modify the
 182       // CFG.
 183       new StoreInst(UndefValue::get(LI.getType()),
 184                     Constant::getNullValue(Op->getType()), &LI);
 185       return ReplaceInstUsesWith(LI, UndefValue::get(LI.getType()));
 186     }
 187   }
 188
 189   // load null/undef -> unreachable
 190   // TODO: Consider a target hook for valid address spaces for this xform.
 191   if (isa<UndefValue>(Op) ||
 192       (isa<ConstantPointerNull>(Op) && LI.getPointerAddressSpace() == 0)) {
 193     // Insert a new store to null instruction before the load to indicate that
 194     // this code is not reachable.  We do this instead of inserting an
 195     // unreachable instruction directly because we cannot modify the CFG.
 196     new StoreInst(UndefValue::get(LI.getType()),
 197                   Constant::getNullValue(Op->getType()), &LI);
 198     return ReplaceInstUsesWith(LI, UndefValue::get(LI.getType()));
 199   }
 200
 201   // Instcombine load (constantexpr_cast global) -> cast (load global)
 202   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
 203     if (CE->isCast())
 204       if (Instruction *Res = InstCombineLoadCast(*this, LI, TD))
 205         return Res;
 206
 207   if (Op->hasOneUse()) {
 208     // Change select and PHI nodes to select values instead of addresses: this
 209     // helps alias analysis out a lot, allows many others simplifications, and
 210     // exposes redundancy in the code.
 211     //
 212     // Note that we cannot do the transformation unless we know that the
 213     // introduced loads cannot trap!  Something like this is valid as long as
 214     // the condition is always false: load (select bool %C, int* null, int* %G),
 215     // but it would not be valid if we transformed it to load from null
 216     // unconditionally.
 217     //
 218     if (SelectInst *SI = dyn_cast<SelectInst>(Op)) {
 219       // load (select (Cond, &V1, &V2))  --> select(Cond, load &V1, load &V2).
 220       unsigned Align = LI.getAlignment();
 221       if (isSafeToLoadUnconditionally(SI->getOperand(1), SI, Align, TD) &&
 222           isSafeToLoadUnconditionally(SI->getOperand(2), SI, Align, TD)) {
 223         LoadInst *V1 = Builder->CreateLoad(SI->getOperand(1),
 224                                            SI->getOperand(1)->getName()+".val");
 225         LoadInst *V2 = Builder->CreateLoad(SI->getOperand(2),
 226                                            SI->getOperand(2)->getName()+".val");
 227         V1->setAlignment(Align);
 228         V2->setAlignment(Align);
 229         return SelectInst::Create(SI->getCondition(), V1, V2);
 230       }
 231
 232       // load (select (cond, null, P)) -> load P
 233       if (Constant *C = dyn_cast<Constant>(SI->getOperand(1)))
 234         if (C->isNullValue()) {
 235           LI.setOperand(0, SI->getOperand(2));
 236           return &LI;
 237         }
 238
 239       // load (select (cond, P, null)) -> load P
 240       if (Constant *C = dyn_cast<Constant>(SI->getOperand(2)))
 241         if (C->isNullValue()) {
 242           LI.setOperand(0, SI->getOperand(1));
 243           return &LI;
 244         }
 245     }
 246   }
 247   return 0;
 248 }
 249
 250 /// InstCombineStoreToCast - Fold store V, (cast P) -> store (cast V), P
 251 /// when possible.  This makes it generally easy to do alias analysis and/or
 252 /// SROA/mem2reg of the memory object.
 253 static Instruction *InstCombineStoreToCast(InstCombiner &IC, StoreInst &SI) {
 254   User *CI = cast<User>(SI.getOperand(1));
 255   Value *CastOp = CI->getOperand(0);
 256
 257   const Type *DestPTy = cast<PointerType>(CI->getType())->getElementType();
 258   const PointerType *SrcTy = dyn_cast<PointerType>(CastOp->getType());
 259   if (SrcTy == 0) return 0;
 260
 261   const Type *SrcPTy = SrcTy->getElementType();
 262
 263   if (!DestPTy->isIntegerTy() && !DestPTy->isPointerTy())
 264     return 0;
 265
 266   /// NewGEPIndices - If SrcPTy is an aggregate type, we can emit a "noop gep"
 267   /// to its first element.  This allows us to handle things like:
 268   ///   store i32 xxx, (bitcast {foo*, float}* %P to i32*)
 269   /// on 32-bit hosts.
 270   SmallVector<Value*, 4> NewGEPIndices;
 271
 272   // If the source is an array, the code below will not succeed.  Check to
 273   // see if a trivial 'gep P, 0, 0' will help matters.  Only do this for
 274   // constants.
 275   if (SrcPTy->isArrayTy() || SrcPTy->isStructTy()) {
 276     // Index through pointer.
 277     Constant *Zero = Constant::getNullValue(Type::getInt32Ty(SI.getContext()));
 278     NewGEPIndices.push_back(Zero);
 279
 280     while (1) {
 281       if (const StructType *STy = dyn_cast<StructType>(SrcPTy)) {
 282         if (!STy->getNumElements()) /* Struct can be empty {} */
 283           break;
 284         NewGEPIndices.push_back(Zero);
 285         SrcPTy = STy->getElementType(0);
 286       } else if (const ArrayType *ATy = dyn_cast<ArrayType>(SrcPTy)) {
 287         NewGEPIndices.push_back(Zero);
 288         SrcPTy = ATy->getElementType();
 289       } else {
 290         break;
 291       }
 292     }
 293
 294     SrcTy = PointerType::get(SrcPTy, SrcTy->getAddressSpace());
 295   }
 296
 297   if (!SrcPTy->isIntegerTy() && !SrcPTy->isPointerTy())
 298     return 0;
 299
 300   // If the pointers point into different address spaces or if they point to
 301   // values with different sizes, we can't do the transformation.
 302   if (!IC.getTargetData() ||
 303       SrcTy->getAddressSpace() !=
 304         cast<PointerType>(CI->getType())->getAddressSpace() ||
 305       IC.getTargetData()->getTypeSizeInBits(SrcPTy) !=
 306       IC.getTargetData()->getTypeSizeInBits(DestPTy))
 307     return 0;
 308
 309   // Okay, we are casting from one integer or pointer type to another of
 310   // the same size.  Instead of casting the pointer before
 311   // the store, cast the value to be stored.
 312   Value *NewCast;
 313   Value *SIOp0 = SI.getOperand(0);
 314   Instruction::CastOps opcode = Instruction::BitCast;
 315   const Type* CastSrcTy = SIOp0->getType();
 316   const Type* CastDstTy = SrcPTy;
 317   if (CastDstTy->isPointerTy()) {
 318     if (CastSrcTy->isIntegerTy())
 319       opcode = Instruction::IntToPtr;
 320   } else if (CastDstTy->isIntegerTy()) {
 321     if (SIOp0->getType()->isPointerTy())
 322       opcode = Instruction::PtrToInt;
 323   }
 324
 325   // SIOp0 is a pointer to aggregate and this is a store to the first field,
 326   // emit a GEP to index into its first field.
 327   if (!NewGEPIndices.empty())
 328     CastOp = IC.Builder->CreateInBoundsGEP(CastOp, NewGEPIndices.begin(),
 329                                            NewGEPIndices.end());
 330
 331   NewCast = IC.Builder->CreateCast(opcode, SIOp0, CastDstTy,
 332                                    SIOp0->getName()+".c");
 333   return new StoreInst(NewCast, CastOp);
 334 }
 335
 336 /// equivalentAddressValues - Test if A and B will obviously have the same
 337 /// value. This includes recognizing that %t0 and %t1 will have the same
 338 /// value in code like this:
 339 ///   %t0 = getelementptr \@a, 0, 3
 340 ///   store i32 0, i32* %t0
 341 ///   %t1 = getelementptr \@a, 0, 3
 342 ///   %t2 = load i32* %t1
 343 ///
 344 static bool equivalentAddressValues(Value *A, Value *B) {
 345   // Test if the values are trivially equivalent.
 346   if (A == B) return true;
 347
 348   // Test if the values come form identical arithmetic instructions.
 349   // This uses isIdenticalToWhenDefined instead of isIdenticalTo because
 350   // its only used to compare two uses within the same basic block, which
 351   // means that they'll always either have the same value or one of them
 352   // will have an undefined value.
 353   if (isa<BinaryOperator>(A) ||
 354       isa<CastInst>(A) ||
 355       isa<PHINode>(A) ||
 356       isa<GetElementPtrInst>(A))
 357     if (Instruction *BI = dyn_cast<Instruction>(B))
 358       if (cast<Instruction>(A)->isIdenticalToWhenDefined(BI))
 359         return true;
 360
 361   // Otherwise they may not be equivalent.
 362   return false;
 363 }
 364
 365 // If this instruction has two uses, one of which is a llvm.dbg.declare,
 366 // return the llvm.dbg.declare.
 367 DbgDeclareInst *InstCombiner::hasOneUsePlusDeclare(Value *V) {
 368   if (!V->hasNUses(2))
 369     return 0;
 370   for (Value::use_iterator UI = V->use_begin(), E = V->use_end();
 371        UI != E; ++UI) {
 372     User *U = *UI;
 373     if (DbgDeclareInst *DI = dyn_cast<DbgDeclareInst>(U))
 374       return DI;
 375     if (isa<BitCastInst>(U) && U->hasOneUse()) {
 376       if (DbgDeclareInst *DI = dyn_cast<DbgDeclareInst>(*U->use_begin()))
 377         return DI;
 378       }
 379   }
 380   return 0;
 381 }
 382
 383 Instruction *InstCombiner::visitStoreInst(StoreInst &SI) {
 384   Value *Val = SI.getOperand(0);
 385   Value *Ptr = SI.getOperand(1);
 386
 387   // If the RHS is an alloca with a single use, zapify the store, making the
 388   // alloca dead.
 389   // If the RHS is an alloca with a two uses, the other one being a
 390   // llvm.dbg.declare, zapify the store and the declare, making the
 391   // alloca dead.  We must do this to prevent declares from affecting
 392   // codegen.
 393   if (!SI.isVolatile()) {
 394     if (Ptr->hasOneUse()) {
 395       if (isa<AllocaInst>(Ptr))
 396         return EraseInstFromFunction(SI);
 397       if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr)) {
 398         if (isa<AllocaInst>(GEP->getOperand(0))) {
 399           if (GEP->getOperand(0)->hasOneUse())
 400             return EraseInstFromFunction(SI);
 401           if (DbgDeclareInst *DI = hasOneUsePlusDeclare(GEP->getOperand(0))) {
 402             EraseInstFromFunction(*DI);
 403             return EraseInstFromFunction(SI);
 404           }
 405         }
 406       }
 407     }
 408     if (DbgDeclareInst *DI = hasOneUsePlusDeclare(Ptr)) {
 409       EraseInstFromFunction(*DI);
 410       return EraseInstFromFunction(SI);
 411     }
 412   }
 413
 414   // Attempt to improve the alignment.
 415   if (TD) {
 416     unsigned KnownAlign =
 417       GetOrEnforceKnownAlignment(Ptr, TD->getPrefTypeAlignment(Val->getType()));
 418     unsigned StoreAlign = SI.getAlignment();
 419     unsigned EffectiveStoreAlign = StoreAlign != 0 ? StoreAlign :
 420       TD->getABITypeAlignment(Val->getType());
 421
 422     if (KnownAlign > EffectiveStoreAlign)
 423       SI.setAlignment(KnownAlign);
 424     else if (StoreAlign == 0)
 425       SI.setAlignment(EffectiveStoreAlign);
 426   }
 427
 428   // Do really simple DSE, to catch cases where there are several consecutive
 429   // stores to the same location, separated by a few arithmetic operations. This
 430   // situation often occurs with bitfield accesses.
 431   BasicBlock::iterator BBI = &SI;
 432   for (unsigned ScanInsts = 6; BBI != SI.getParent()->begin() && ScanInsts;
 433        --ScanInsts) {
 434     --BBI;
 435     // Don't count debug info directives, lest they affect codegen,
 436     // and we skip pointer-to-pointer bitcasts, which are NOPs.
 437     if (isa<DbgInfoIntrinsic>(BBI) ||
 438         (isa<BitCastInst>(BBI) && BBI->getType()->isPointerTy())) {
 439       ScanInsts++;
 440       continue;
 441     }
 442
 443     if (StoreInst *PrevSI = dyn_cast<StoreInst>(BBI)) {
 444       // Prev store isn't volatile, and stores to the same location?
 445       if (!PrevSI->isVolatile() &&equivalentAddressValues(PrevSI->getOperand(1),
 446                                                           SI.getOperand(1))) {
 447         ++NumDeadStore;
 448         ++BBI;
 449         EraseInstFromFunction(*PrevSI);
 450         continue;
 451       }
 452       break;
 453     }
 454
 455     // If this is a load, we have to stop.  However, if the loaded value is from
 456     // the pointer we're loading and is producing the pointer we're storing,
 457     // then *this* store is dead (X = load P; store X -> P).
 458     if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
 459       if (LI == Val && equivalentAddressValues(LI->getOperand(0), Ptr) &&
 460           !SI.isVolatile())
 461         return EraseInstFromFunction(SI);
 462
 463       // Otherwise, this is a load from some other location.  Stores before it
 464       // may not be dead.
 465       break;
 466     }
 467
 468     // Don't skip over loads or things that can modify memory.
 469     if (BBI->mayWriteToMemory() || BBI->mayReadFromMemory())
 470       break;
 471   }
 472
 473
 474   if (SI.isVolatile()) return 0;  // Don't hack volatile stores.
 475
 476   // store X, null    -> turns into 'unreachable' in SimplifyCFG
 477   if (isa<ConstantPointerNull>(Ptr) && SI.getPointerAddressSpace() == 0) {
 478     if (!isa<UndefValue>(Val)) {
 479       SI.setOperand(0, UndefValue::get(Val->getType()));
 480       if (Instruction *U = dyn_cast<Instruction>(Val))
 481         Worklist.Add(U);  // Dropped a use.
 482     }
 483     return 0;  // Do not modify these!
 484   }
 485
 486   // store undef, Ptr -> noop
 487   if (isa<UndefValue>(Val))
 488     return EraseInstFromFunction(SI);
 489
 490   // If the pointer destination is a cast, see if we can fold the cast into the
 491   // source instead.
 492   if (isa<CastInst>(Ptr))
 493     if (Instruction *Res = InstCombineStoreToCast(*this, SI))
 494       return Res;
 495   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
 496     if (CE->isCast())
 497       if (Instruction *Res = InstCombineStoreToCast(*this, SI))
 498         return Res;
 499
 500
 501   // If this store is the last instruction in the basic block (possibly
 502   // excepting debug info instructions), and if the block ends with an
 503   // unconditional branch, try to move it to the successor block.
 504   BBI = &SI;
 505   do {
 506     ++BBI;
 507   } while (isa<DbgInfoIntrinsic>(BBI) ||
 508            (isa<BitCastInst>(BBI) && BBI->getType()->isPointerTy()));
 509   if (BranchInst *BI = dyn_cast<BranchInst>(BBI))
 510     if (BI->isUnconditional())
 511       if (SimplifyStoreAtEndOfBlock(SI))
 512         return 0;  // xform done!
 513
 514   return 0;
 515 }
 516
 517 /// SimplifyStoreAtEndOfBlock - Turn things like:
 518 ///   if () { *P = v1; } else { *P = v2 }
 519 /// into a phi node with a store in the successor.
 520 ///
 521 /// Simplify things like:
 522 ///   *P = v1; if () { *P = v2; }
 523 /// into a phi node with a store in the successor.
 524 ///
 525 bool InstCombiner::SimplifyStoreAtEndOfBlock(StoreInst &SI) {
 526   BasicBlock *StoreBB = SI.getParent();
 527
 528   // Check to see if the successor block has exactly two incoming edges.  If
 529   // so, see if the other predecessor contains a store to the same location.
 530   // if so, insert a PHI node (if needed) and move the stores down.
 531   BasicBlock *DestBB = StoreBB->getTerminator()->getSuccessor(0);
 532
 533   // Determine whether Dest has exactly two predecessors and, if so, compute
 534   // the other predecessor.
 535   pred_iterator PI = pred_begin(DestBB);
 536   BasicBlock *P = *PI;
 537   BasicBlock *OtherBB = 0;
 538
 539   if (P != StoreBB)
 540     OtherBB = P;
 541
 542   if (++PI == pred_end(DestBB))
 543     return false;
 544
 545   P = *PI;
 546   if (P != StoreBB) {
 547     if (OtherBB)
 548       return false;
 549     OtherBB = P;
 550   }
 551   if (++PI != pred_end(DestBB))
 552     return false;
 553
 554   // Bail out if all the relevant blocks aren't distinct (this can happen,
 555   // for example, if SI is in an infinite loop)
 556   if (StoreBB == DestBB || OtherBB == DestBB)
 557     return false;
 558
 559   // Verify that the other block ends in a branch and is not otherwise empty.
 560   BasicBlock::iterator BBI = OtherBB->getTerminator();
 561   BranchInst *OtherBr = dyn_cast<BranchInst>(BBI);
 562   if (!OtherBr || BBI == OtherBB->begin())
 563     return false;
 564
 565   // If the other block ends in an unconditional branch, check for the 'if then
 566   // else' case.  there is an instruction before the branch.
 567   StoreInst *OtherStore = 0;
 568   if (OtherBr->isUnconditional()) {
 569     --BBI;
 570     // Skip over debugging info.
 571     while (isa<DbgInfoIntrinsic>(BBI) ||
 572            (isa<BitCastInst>(BBI) && BBI->getType()->isPointerTy())) {
 573       if (BBI==OtherBB->begin())
 574         return false;
 575       --BBI;
 576     }
 577     // If this isn't a store, isn't a store to the same location, or if the
 578     // alignments differ, bail out.
 579     OtherStore = dyn_cast<StoreInst>(BBI);
 580     if (!OtherStore || OtherStore->getOperand(1) != SI.getOperand(1) ||
 581         OtherStore->getAlignment() != SI.getAlignment())
 582       return false;
 583   } else {
 584     // Otherwise, the other block ended with a conditional branch. If one of the
 585     // destinations is StoreBB, then we have the if/then case.
 586     if (OtherBr->getSuccessor(0) != StoreBB &&
 587         OtherBr->getSuccessor(1) != StoreBB)
 588       return false;
 589
 590     // Okay, we know that OtherBr now goes to Dest and StoreBB, so this is an
 591     // if/then triangle.  See if there is a store to the same ptr as SI that
 592     // lives in OtherBB.
 593     for (;; --BBI) {
 594       // Check to see if we find the matching store.
 595       if ((OtherStore = dyn_cast<StoreInst>(BBI))) {
 596         if (OtherStore->getOperand(1) != SI.getOperand(1) ||
 597             OtherStore->getAlignment() != SI.getAlignment())
 598           return false;
 599         break;
 600       }
 601       // If we find something that may be using or overwriting the stored
 602       // value, or if we run out of instructions, we can't do the xform.
 603       if (BBI->mayReadFromMemory() || BBI->mayWriteToMemory() ||
 604           BBI == OtherBB->begin())
 605         return false;
 606     }
 607
 608     // In order to eliminate the store in OtherBr, we have to
 609     // make sure nothing reads or overwrites the stored value in
 610     // StoreBB.
 611     for (BasicBlock::iterator I = StoreBB->begin(); &*I != &SI; ++I) {
 612       // FIXME: This should really be AA driven.
 613       if (I->mayReadFromMemory() || I->mayWriteToMemory())
 614         return false;
 615     }
 616   }
 617
 618   // Insert a PHI node now if we need it.
 619   Value *MergedVal = OtherStore->getOperand(0);
 620   if (MergedVal != SI.getOperand(0)) {
 621     PHINode *PN = PHINode::Create(MergedVal->getType(), "storemerge");
 622     PN->reserveOperandSpace(2);
 623     PN->addIncoming(SI.getOperand(0), SI.getParent());
 624     PN->addIncoming(OtherStore->getOperand(0), OtherBB);
 625     MergedVal = InsertNewInstBefore(PN, DestBB->front());
 626   }
 627
 628   // Advance to a place where it is safe to insert the new store and
 629   // insert it.
 630   BBI = DestBB->getFirstNonPHI();
 631   InsertNewInstBefore(new StoreInst(MergedVal, SI.getOperand(1),
 632                                     OtherStore->isVolatile(),
 633                                     SI.getAlignment()), *BBI);
 634
 635   // Nuke the old stores.
 636   EraseInstFromFunction(SI);
 637   EraseInstFromFunction(*OtherStore);
 638   return true;
 639 }