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/ADT/Statistic.h"
  16 #include "llvm/Analysis/Loads.h"
  17 #include "llvm/IR/DataLayout.h"
  18 #include "llvm/IR/IntrinsicInst.h"
  19 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  20 #include "llvm/Transforms/Utils/Local.h"
  21 using namespace llvm;
  22
  23 STATISTIC(NumDeadStore,    "Number of dead stores eliminated");
  24 STATISTIC(NumGlobalCopies, "Number of allocas copied from constant global");
  25
  26 /// pointsToConstantGlobal - Return true if V (possibly indirectly) points to
  27 /// some part of a constant global variable.  This intentionally only accepts
  28 /// constant expressions because we can't rewrite arbitrary instructions.
  29 static bool pointsToConstantGlobal(Value *V) {
  30   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
  31     return GV->isConstant();
  32   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
  33     if (CE->getOpcode() == Instruction::BitCast ||
  34         CE->getOpcode() == Instruction::GetElementPtr)
  35       return pointsToConstantGlobal(CE->getOperand(0));
  36   return false;
  37 }
  38
  39 /// isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived)
  40 /// pointer to an alloca.  Ignore any reads of the pointer, return false if we
  41 /// see any stores or other unknown uses.  If we see pointer arithmetic, keep
  42 /// track of whether it moves the pointer (with IsOffset) but otherwise traverse
  43 /// the uses.  If we see a memcpy/memmove that targets an unoffseted pointer to
  44 /// the alloca, and if the source pointer is a pointer to a constant global, we
  45 /// can optimize this.
  46 static bool
  47 isOnlyCopiedFromConstantGlobal(Value *V, MemTransferInst *&TheCopy,
  48                                SmallVectorImpl<Instruction *> &ToDelete,
  49                                bool IsOffset = false) {
  50   // We track lifetime intrinsics as we encounter them.  If we decide to go
  51   // ahead and replace the value with the global, this lets the caller quickly
  52   // eliminate the markers.
  53
  54   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
  55     User *U = cast<Instruction>(*UI);
  56
  57     if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
  58       // Ignore non-volatile loads, they are always ok.
  59       if (!LI->isSimple()) return false;
  60       continue;
  61     }
  62
  63     if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
  64       // If uses of the bitcast are ok, we are ok.
  65       if (!isOnlyCopiedFromConstantGlobal(BCI, TheCopy, ToDelete, IsOffset))
  66         return false;
  67       continue;
  68     }
  69     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
  70       // If the GEP has all zero indices, it doesn't offset the pointer.  If it
  71       // doesn't, it does.
  72       if (!isOnlyCopiedFromConstantGlobal(
  73               GEP, TheCopy, ToDelete, IsOffset || !GEP->hasAllZeroIndices()))
  74         return false;
  75       continue;
  76     }
  77
  78     if (CallSite CS = U) {
  79       // If this is the function being called then we treat it like a load and
  80       // ignore it.
  81       if (CS.isCallee(UI))
  82         continue;
  83
  84       // If this is a readonly/readnone call site, then we know it is just a
  85       // load (but one that potentially returns the value itself), so we can
  86       // ignore it if we know that the value isn't captured.
  87       unsigned ArgNo = CS.getArgumentNo(UI);
  88       if (CS.onlyReadsMemory() &&
  89           (CS.getInstruction()->use_empty() || CS.doesNotCapture(ArgNo)))
  90         continue;
  91
  92       // If this is being passed as a byval argument, the caller is making a
  93       // copy, so it is only a read of the alloca.
  94       if (CS.isByValArgument(ArgNo))
  95         continue;
  96     }
  97
  98     // Lifetime intrinsics can be handled by the caller.
  99     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(U)) {
 100       if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
 101           II->getIntrinsicID() == Intrinsic::lifetime_end) {
 102         assert(II->use_empty() && "Lifetime markers have no result to use!");
 103         ToDelete.push_back(II);
 104         continue;
 105       }
 106     }
 107
 108     // If this is isn't our memcpy/memmove, reject it as something we can't
 109     // handle.
 110     MemTransferInst *MI = dyn_cast<MemTransferInst>(U);
 111     if (MI == 0)
 112       return false;
 113
 114     // If the transfer is using the alloca as a source of the transfer, then
 115     // ignore it since it is a load (unless the transfer is volatile).
 116     if (UI.getOperandNo() == 1) {
 117       if (MI->isVolatile()) return false;
 118       continue;
 119     }
 120
 121     // If we already have seen a copy, reject the second one.
 122     if (TheCopy) return false;
 123
 124     // If the pointer has been offset from the start of the alloca, we can't
 125     // safely handle this.
 126     if (IsOffset) return false;
 127
 128     // If the memintrinsic isn't using the alloca as the dest, reject it.
 129     if (UI.getOperandNo() != 0) return false;
 130
 131     // If the source of the memcpy/move is not a constant global, reject it.
 132     if (!pointsToConstantGlobal(MI->getSource()))
 133       return false;
 134
 135     // Otherwise, the transform is safe.  Remember the copy instruction.
 136     TheCopy = MI;
 137   }
 138   return true;
 139 }
 140
 141 /// isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only
 142 /// modified by a copy from a constant global.  If we can prove this, we can
 143 /// replace any uses of the alloca with uses of the global directly.
 144 static MemTransferInst *
 145 isOnlyCopiedFromConstantGlobal(AllocaInst *AI,
 146                                SmallVectorImpl<Instruction *> &ToDelete) {
 147   MemTransferInst *TheCopy = 0;
 148   if (isOnlyCopiedFromConstantGlobal(AI, TheCopy, ToDelete))
 149     return TheCopy;
 150   return 0;
 151 }
 152
 153 Instruction *InstCombiner::visitAllocaInst(AllocaInst &AI) {
 154   // Ensure that the alloca array size argument has type intptr_t, so that
 155   // any casting is exposed early.
 156   if (TD) {
 157     Type *IntPtrTy = TD->getIntPtrType(AI.getType());
 158     if (AI.getArraySize()->getType() != IntPtrTy) {
 159       Value *V = Builder->CreateIntCast(AI.getArraySize(),
 160                                         IntPtrTy, false);
 161       AI.setOperand(0, V);
 162       return &AI;
 163     }
 164   }
 165
 166   // Convert: alloca Ty, C - where C is a constant != 1 into: alloca [C x Ty], 1
 167   if (AI.isArrayAllocation()) {  // Check C != 1
 168     if (const ConstantInt *C = dyn_cast<ConstantInt>(AI.getArraySize())) {
 169       Type *NewTy =
 170         ArrayType::get(AI.getAllocatedType(), C->getZExtValue());
 171       AllocaInst *New = Builder->CreateAlloca(NewTy, 0, AI.getName());
 172       New->setAlignment(AI.getAlignment());
 173
 174       // Scan to the end of the allocation instructions, to skip over a block of
 175       // allocas if possible...also skip interleaved debug info
 176       //
 177       BasicBlock::iterator It = New;
 178       while (isa<AllocaInst>(*It) || isa<DbgInfoIntrinsic>(*It)) ++It;
 179
 180       // Now that I is pointing to the first non-allocation-inst in the block,
 181       // insert our getelementptr instruction...
 182       //
 183       Type *IdxTy = TD
 184                   ? TD->getIntPtrType(AI.getType())
 185                   : Type::getInt64Ty(AI.getContext());
 186       Value *NullIdx = Constant::getNullValue(IdxTy);
 187       Value *Idx[2] = { NullIdx, NullIdx };
 188       Instruction *GEP =
 189         GetElementPtrInst::CreateInBounds(New, Idx, New->getName() + ".sub");
 190       InsertNewInstBefore(GEP, *It);
 191
 192       // Now make everything use the getelementptr instead of the original
 193       // allocation.
 194       return ReplaceInstUsesWith(AI, GEP);
 195     } else if (isa<UndefValue>(AI.getArraySize())) {
 196       return ReplaceInstUsesWith(AI, Constant::getNullValue(AI.getType()));
 197     }
 198   }
 199
 200   if (TD && AI.getAllocatedType()->isSized()) {
 201     // If the alignment is 0 (unspecified), assign it the preferred alignment.
 202     if (AI.getAlignment() == 0)
 203       AI.setAlignment(TD->getPrefTypeAlignment(AI.getAllocatedType()));
 204
 205     // Move all alloca's of zero byte objects to the entry block and merge them
 206     // together.  Note that we only do this for alloca's, because malloc should
 207     // allocate and return a unique pointer, even for a zero byte allocation.
 208     if (TD->getTypeAllocSize(AI.getAllocatedType()) == 0) {
 209       // For a zero sized alloca there is no point in doing an array allocation.
 210       // This is helpful if the array size is a complicated expression not used
 211       // elsewhere.
 212       if (AI.isArrayAllocation()) {
 213         AI.setOperand(0, ConstantInt::get(AI.getArraySize()->getType(), 1));
 214         return &AI;
 215       }
 216
 217       // Get the first instruction in the entry block.
 218       BasicBlock &EntryBlock = AI.getParent()->getParent()->getEntryBlock();
 219       Instruction *FirstInst = EntryBlock.getFirstNonPHIOrDbg();
 220       if (FirstInst != &AI) {
 221         // If the entry block doesn't start with a zero-size alloca then move
 222         // this one to the start of the entry block.  There is no problem with
 223         // dominance as the array size was forced to a constant earlier already.
 224         AllocaInst *EntryAI = dyn_cast<AllocaInst>(FirstInst);
 225         if (!EntryAI || !EntryAI->getAllocatedType()->isSized() ||
 226             TD->getTypeAllocSize(EntryAI->getAllocatedType()) != 0) {
 227           AI.moveBefore(FirstInst);
 228           return &AI;
 229         }
 230
 231         // If the alignment of the entry block alloca is 0 (unspecified),
 232         // assign it the preferred alignment.
 233         if (EntryAI->getAlignment() == 0)
 234           EntryAI->setAlignment(
 235             TD->getPrefTypeAlignment(EntryAI->getAllocatedType()));
 236         // Replace this zero-sized alloca with the one at the start of the entry
 237         // block after ensuring that the address will be aligned enough for both
 238         // types.
 239         unsigned MaxAlign = std::max(EntryAI->getAlignment(),
 240                                      AI.getAlignment());
 241         EntryAI->setAlignment(MaxAlign);
 242         if (AI.getType() != EntryAI->getType())
 243           return new BitCastInst(EntryAI, AI.getType());
 244         return ReplaceInstUsesWith(AI, EntryAI);
 245       }
 246     }
 247   }
 248
 249   if (AI.getAlignment()) {
 250     // Check to see if this allocation is only modified by a memcpy/memmove from
 251     // a constant global whose alignment is equal to or exceeds that of the
 252     // allocation.  If this is the case, we can change all users to use
 253     // the constant global instead.  This is commonly produced by the CFE by
 254     // constructs like "void foo() { int A[] = {1,2,3,4,5,6,7,8,9...}; }" if 'A'
 255     // is only subsequently read.
 256     SmallVector<Instruction *, 4> ToDelete;
 257     if (MemTransferInst *Copy = isOnlyCopiedFromConstantGlobal(&AI, ToDelete)) {
 258       unsigned SourceAlign = getOrEnforceKnownAlignment(Copy->getSource(),
 259                                                         AI.getAlignment(), TD);
 260       if (AI.getAlignment() <= SourceAlign) {
 261         DEBUG(dbgs() << "Found alloca equal to global: " << AI << '\n');
 262         DEBUG(dbgs() << "  memcpy = " << *Copy << '\n');
 263         for (unsigned i = 0, e = ToDelete.size(); i != e; ++i)
 264           EraseInstFromFunction(*ToDelete[i]);
 265         Constant *TheSrc = cast<Constant>(Copy->getSource());
 266         Instruction *NewI
 267           = ReplaceInstUsesWith(AI, ConstantExpr::getBitCast(TheSrc,
 268                                                              AI.getType()));
 269         EraseInstFromFunction(*Copy);
 270         ++NumGlobalCopies;
 271         return NewI;
 272       }
 273     }
 274   }
 275
 276   // At last, use the generic allocation site handler to aggressively remove
 277   // unused allocas.
 278   return visitAllocSite(AI);
 279 }
 280
 281
 282 /// InstCombineLoadCast - Fold 'load (cast P)' -> cast (load P)' when possible.
 283 static Instruction *InstCombineLoadCast(InstCombiner &IC, LoadInst &LI,
 284                                         const DataLayout *TD) {
 285   User *CI = cast<User>(LI.getOperand(0));
 286   Value *CastOp = CI->getOperand(0);
 287
 288   PointerType *DestTy = cast<PointerType>(CI->getType());
 289   Type *DestPTy = DestTy->getElementType();
 290   if (PointerType *SrcTy = dyn_cast<PointerType>(CastOp->getType())) {
 291
 292     // If the address spaces don't match, don't eliminate the cast.
 293     if (DestTy->getAddressSpace() != SrcTy->getAddressSpace())
 294       return 0;
 295
 296     Type *SrcPTy = SrcTy->getElementType();
 297
 298     if (DestPTy->isIntegerTy() || DestPTy->isPointerTy() ||
 299          DestPTy->isVectorTy()) {
 300       // If the source is an array, the code below will not succeed.  Check to
 301       // see if a trivial 'gep P, 0, 0' will help matters.  Only do this for
 302       // constants.
 303       if (ArrayType *ASrcTy = dyn_cast<ArrayType>(SrcPTy))
 304         if (Constant *CSrc = dyn_cast<Constant>(CastOp))
 305           if (ASrcTy->getNumElements() != 0) {
 306             Type *IdxTy = TD
 307                         ? TD->getIntPtrType(LI.getContext())
 308                         : Type::getInt64Ty(LI.getContext());
 309             Value *Idx = Constant::getNullValue(IdxTy);
 310             Value *Idxs[2] = { Idx, Idx };
 311             CastOp = ConstantExpr::getGetElementPtr(CSrc, Idxs);
 312             SrcTy = cast<PointerType>(CastOp->getType());
 313             SrcPTy = SrcTy->getElementType();
 314           }
 315
 316       if (IC.getDataLayout() &&
 317           (SrcPTy->isIntegerTy() || SrcPTy->isPointerTy() ||
 318             SrcPTy->isVectorTy()) &&
 319           // Do not allow turning this into a load of an integer, which is then
 320           // casted to a pointer, this pessimizes pointer analysis a lot.
 321           (SrcPTy->isPointerTy() == LI.getType()->isPointerTy()) &&
 322           IC.getDataLayout()->getTypeSizeInBits(SrcPTy) ==
 323                IC.getDataLayout()->getTypeSizeInBits(DestPTy)) {
 324
 325         // Okay, we are casting from one integer or pointer type to another of
 326         // the same size.  Instead of casting the pointer before the load, cast
 327         // the result of the loaded value.
 328         LoadInst *NewLoad =
 329           IC.Builder->CreateLoad(CastOp, LI.isVolatile(), CI->getName());
 330         NewLoad->setAlignment(LI.getAlignment());
 331         NewLoad->setAtomic(LI.getOrdering(), LI.getSynchScope());
 332         // Now cast the result of the load.
 333         return new BitCastInst(NewLoad, LI.getType());
 334       }
 335     }
 336   }
 337   return 0;
 338 }
 339
 340 Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
 341   Value *Op = LI.getOperand(0);
 342
 343   // Attempt to improve the alignment.
 344   if (TD) {
 345     unsigned KnownAlign =
 346       getOrEnforceKnownAlignment(Op, TD->getPrefTypeAlignment(LI.getType()),TD);
 347     unsigned LoadAlign = LI.getAlignment();
 348     unsigned EffectiveLoadAlign = LoadAlign != 0 ? LoadAlign :
 349       TD->getABITypeAlignment(LI.getType());
 350
 351     if (KnownAlign > EffectiveLoadAlign)
 352       LI.setAlignment(KnownAlign);
 353     else if (LoadAlign == 0)
 354       LI.setAlignment(EffectiveLoadAlign);
 355   }
 356
 357   // load (cast X) --> cast (load X) iff safe.
 358   if (isa<CastInst>(Op))
 359     if (Instruction *Res = InstCombineLoadCast(*this, LI, TD))
 360       return Res;
 361
 362   // None of the following transforms are legal for volatile/atomic loads.
 363   // FIXME: Some of it is okay for atomic loads; needs refactoring.
 364   if (!LI.isSimple()) return 0;
 365
 366   // Do really simple store-to-load forwarding and load CSE, to catch cases
 367   // where there are several consecutive memory accesses to the same location,
 368   // separated by a few arithmetic operations.
 369   BasicBlock::iterator BBI = &LI;
 370   if (Value *AvailableVal = FindAvailableLoadedValue(Op, LI.getParent(), BBI,6))
 371     return ReplaceInstUsesWith(LI, AvailableVal);
 372
 373   // load(gep null, ...) -> unreachable
 374   if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(Op)) {
 375     const Value *GEPI0 = GEPI->getOperand(0);
 376     // TODO: Consider a target hook for valid address spaces for this xform.
 377     if (isa<ConstantPointerNull>(GEPI0) && GEPI->getPointerAddressSpace() == 0){
 378       // Insert a new store to null instruction before the load to indicate
 379       // that this code is not reachable.  We do this instead of inserting
 380       // an unreachable instruction directly because we cannot modify the
 381       // CFG.
 382       new StoreInst(UndefValue::get(LI.getType()),
 383                     Constant::getNullValue(Op->getType()), &LI);
 384       return ReplaceInstUsesWith(LI, UndefValue::get(LI.getType()));
 385     }
 386   }
 387
 388   // load null/undef -> unreachable
 389   // TODO: Consider a target hook for valid address spaces for this xform.
 390   if (isa<UndefValue>(Op) ||
 391       (isa<ConstantPointerNull>(Op) && LI.getPointerAddressSpace() == 0)) {
 392     // Insert a new store to null instruction before the load to indicate that
 393     // this code is not reachable.  We do this instead of inserting an
 394     // unreachable instruction directly because we cannot modify the CFG.
 395     new StoreInst(UndefValue::get(LI.getType()),
 396                   Constant::getNullValue(Op->getType()), &LI);
 397     return ReplaceInstUsesWith(LI, UndefValue::get(LI.getType()));
 398   }
 399
 400   // Instcombine load (constantexpr_cast global) -> cast (load global)
 401   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
 402     if (CE->isCast())
 403       if (Instruction *Res = InstCombineLoadCast(*this, LI, TD))
 404         return Res;
 405
 406   if (Op->hasOneUse()) {
 407     // Change select and PHI nodes to select values instead of addresses: this
 408     // helps alias analysis out a lot, allows many others simplifications, and
 409     // exposes redundancy in the code.
 410     //
 411     // Note that we cannot do the transformation unless we know that the
 412     // introduced loads cannot trap!  Something like this is valid as long as
 413     // the condition is always false: load (select bool %C, int* null, int* %G),
 414     // but it would not be valid if we transformed it to load from null
 415     // unconditionally.
 416     //
 417     if (SelectInst *SI = dyn_cast<SelectInst>(Op)) {
 418       // load (select (Cond, &V1, &V2))  --> select(Cond, load &V1, load &V2).
 419       unsigned Align = LI.getAlignment();
 420       if (isSafeToLoadUnconditionally(SI->getOperand(1), SI, Align, TD) &&
 421           isSafeToLoadUnconditionally(SI->getOperand(2), SI, Align, TD)) {
 422         LoadInst *V1 = Builder->CreateLoad(SI->getOperand(1),
 423                                            SI->getOperand(1)->getName()+".val");
 424         LoadInst *V2 = Builder->CreateLoad(SI->getOperand(2),
 425                                            SI->getOperand(2)->getName()+".val");
 426         V1->setAlignment(Align);
 427         V2->setAlignment(Align);
 428         return SelectInst::Create(SI->getCondition(), V1, V2);
 429       }
 430
 431       // load (select (cond, null, P)) -> load P
 432       if (Constant *C = dyn_cast<Constant>(SI->getOperand(1)))
 433         if (C->isNullValue()) {
 434           LI.setOperand(0, SI->getOperand(2));
 435           return &LI;
 436         }
 437
 438       // load (select (cond, P, null)) -> load P
 439       if (Constant *C = dyn_cast<Constant>(SI->getOperand(2)))
 440         if (C->isNullValue()) {
 441           LI.setOperand(0, SI->getOperand(1));
 442           return &LI;
 443         }
 444     }
 445   }
 446   return 0;
 447 }
 448
 449 /// InstCombineStoreToCast - Fold store V, (cast P) -> store (cast V), P
 450 /// when possible.  This makes it generally easy to do alias analysis and/or
 451 /// SROA/mem2reg of the memory object.
 452 static Instruction *InstCombineStoreToCast(InstCombiner &IC, StoreInst &SI) {
 453   User *CI = cast<User>(SI.getOperand(1));
 454   Value *CastOp = CI->getOperand(0);
 455
 456   Type *DestPTy = cast<PointerType>(CI->getType())->getElementType();
 457   PointerType *SrcTy = dyn_cast<PointerType>(CastOp->getType());
 458   if (SrcTy == 0) return 0;
 459
 460   Type *SrcPTy = SrcTy->getElementType();
 461
 462   if (!DestPTy->isIntegerTy() && !DestPTy->isPointerTy())
 463     return 0;
 464
 465   /// NewGEPIndices - If SrcPTy is an aggregate type, we can emit a "noop gep"
 466   /// to its first element.  This allows us to handle things like:
 467   ///   store i32 xxx, (bitcast {foo*, float}* %P to i32*)
 468   /// on 32-bit hosts.
 469   SmallVector<Value*, 4> NewGEPIndices;
 470
 471   // If the source is an array, the code below will not succeed.  Check to
 472   // see if a trivial 'gep P, 0, 0' will help matters.  Only do this for
 473   // constants.
 474   if (SrcPTy->isArrayTy() || SrcPTy->isStructTy()) {
 475     // Index through pointer.
 476     Constant *Zero = Constant::getNullValue(Type::getInt32Ty(SI.getContext()));
 477     NewGEPIndices.push_back(Zero);
 478
 479     while (1) {
 480       if (StructType *STy = dyn_cast<StructType>(SrcPTy)) {
 481         if (!STy->getNumElements()) /* Struct can be empty {} */
 482           break;
 483         NewGEPIndices.push_back(Zero);
 484         SrcPTy = STy->getElementType(0);
 485       } else if (ArrayType *ATy = dyn_cast<ArrayType>(SrcPTy)) {
 486         NewGEPIndices.push_back(Zero);
 487         SrcPTy = ATy->getElementType();
 488       } else {
 489         break;
 490       }
 491     }
 492
 493     SrcTy = PointerType::get(SrcPTy, SrcTy->getAddressSpace());
 494   }
 495
 496   if (!SrcPTy->isIntegerTy() && !SrcPTy->isPointerTy())
 497     return 0;
 498
 499   // If the pointers point into different address spaces or if they point to
 500   // values with different sizes, we can't do the transformation.
 501   if (!IC.getDataLayout() ||
 502       SrcTy->getAddressSpace() !=
 503         cast<PointerType>(CI->getType())->getAddressSpace() ||
 504       IC.getDataLayout()->getTypeSizeInBits(SrcPTy) !=
 505       IC.getDataLayout()->getTypeSizeInBits(DestPTy))
 506     return 0;
 507
 508   // Okay, we are casting from one integer or pointer type to another of
 509   // the same size.  Instead of casting the pointer before
 510   // the store, cast the value to be stored.
 511   Value *NewCast;
 512   Value *SIOp0 = SI.getOperand(0);
 513   Instruction::CastOps opcode = Instruction::BitCast;
 514   Type* CastSrcTy = SIOp0->getType();
 515   Type* CastDstTy = SrcPTy;
 516   if (CastDstTy->isPointerTy()) {
 517     if (CastSrcTy->isIntegerTy())
 518       opcode = Instruction::IntToPtr;
 519   } else if (CastDstTy->isIntegerTy()) {
 520     if (SIOp0->getType()->isPointerTy())
 521       opcode = Instruction::PtrToInt;
 522   }
 523
 524   // SIOp0 is a pointer to aggregate and this is a store to the first field,
 525   // emit a GEP to index into its first field.
 526   if (!NewGEPIndices.empty())
 527     CastOp = IC.Builder->CreateInBoundsGEP(CastOp, NewGEPIndices);
 528
 529   NewCast = IC.Builder->CreateCast(opcode, SIOp0, CastDstTy,
 530                                    SIOp0->getName()+".c");
 531   SI.setOperand(0, NewCast);
 532   SI.setOperand(1, CastOp);
 533   return &SI;
 534 }
 535
 536 /// equivalentAddressValues - Test if A and B will obviously have the same
 537 /// value. This includes recognizing that %t0 and %t1 will have the same
 538 /// value in code like this:
 539 ///   %t0 = getelementptr \@a, 0, 3
 540 ///   store i32 0, i32* %t0
 541 ///   %t1 = getelementptr \@a, 0, 3
 542 ///   %t2 = load i32* %t1
 543 ///
 544 static bool equivalentAddressValues(Value *A, Value *B) {
 545   // Test if the values are trivially equivalent.
 546   if (A == B) return true;
 547
 548   // Test if the values come form identical arithmetic instructions.
 549   // This uses isIdenticalToWhenDefined instead of isIdenticalTo because
 550   // its only used to compare two uses within the same basic block, which
 551   // means that they'll always either have the same value or one of them
 552   // will have an undefined value.
 553   if (isa<BinaryOperator>(A) ||
 554       isa<CastInst>(A) ||
 555       isa<PHINode>(A) ||
 556       isa<GetElementPtrInst>(A))
 557     if (Instruction *BI = dyn_cast<Instruction>(B))
 558       if (cast<Instruction>(A)->isIdenticalToWhenDefined(BI))
 559         return true;
 560
 561   // Otherwise they may not be equivalent.
 562   return false;
 563 }
 564
 565 Instruction *InstCombiner::visitStoreInst(StoreInst &SI) {
 566   Value *Val = SI.getOperand(0);
 567   Value *Ptr = SI.getOperand(1);
 568
 569   // Attempt to improve the alignment.
 570   if (TD) {
 571     unsigned KnownAlign =
 572       getOrEnforceKnownAlignment(Ptr, TD->getPrefTypeAlignment(Val->getType()),
 573                                  TD);
 574     unsigned StoreAlign = SI.getAlignment();
 575     unsigned EffectiveStoreAlign = StoreAlign != 0 ? StoreAlign :
 576       TD->getABITypeAlignment(Val->getType());
 577
 578     if (KnownAlign > EffectiveStoreAlign)
 579       SI.setAlignment(KnownAlign);
 580     else if (StoreAlign == 0)
 581       SI.setAlignment(EffectiveStoreAlign);
 582   }
 583
 584   // Don't hack volatile/atomic stores.
 585   // FIXME: Some bits are legal for atomic stores; needs refactoring.
 586   if (!SI.isSimple()) return 0;
 587
 588   // If the RHS is an alloca with a single use, zapify the store, making the
 589   // alloca dead.
 590   if (Ptr->hasOneUse()) {
 591     if (isa<AllocaInst>(Ptr))
 592       return EraseInstFromFunction(SI);
 593     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr)) {
 594       if (isa<AllocaInst>(GEP->getOperand(0))) {
 595         if (GEP->getOperand(0)->hasOneUse())
 596           return EraseInstFromFunction(SI);
 597       }
 598     }
 599   }
 600
 601   // Do really simple DSE, to catch cases where there are several consecutive
 602   // stores to the same location, separated by a few arithmetic operations. This
 603   // situation often occurs with bitfield accesses.
 604   BasicBlock::iterator BBI = &SI;
 605   for (unsigned ScanInsts = 6; BBI != SI.getParent()->begin() && ScanInsts;
 606        --ScanInsts) {
 607     --BBI;
 608     // Don't count debug info directives, lest they affect codegen,
 609     // and we skip pointer-to-pointer bitcasts, which are NOPs.
 610     if (isa<DbgInfoIntrinsic>(BBI) ||
 611         (isa<BitCastInst>(BBI) && BBI->getType()->isPointerTy())) {
 612       ScanInsts++;
 613       continue;
 614     }
 615
 616     if (StoreInst *PrevSI = dyn_cast<StoreInst>(BBI)) {
 617       // Prev store isn't volatile, and stores to the same location?
 618       if (PrevSI->isSimple() && equivalentAddressValues(PrevSI->getOperand(1),
 619                                                         SI.getOperand(1))) {
 620         ++NumDeadStore;
 621         ++BBI;
 622         EraseInstFromFunction(*PrevSI);
 623         continue;
 624       }
 625       break;
 626     }
 627
 628     // If this is a load, we have to stop.  However, if the loaded value is from
 629     // the pointer we're loading and is producing the pointer we're storing,
 630     // then *this* store is dead (X = load P; store X -> P).
 631     if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
 632       if (LI == Val && equivalentAddressValues(LI->getOperand(0), Ptr) &&
 633           LI->isSimple())
 634         return EraseInstFromFunction(SI);
 635
 636       // Otherwise, this is a load from some other location.  Stores before it
 637       // may not be dead.
 638       break;
 639     }
 640
 641     // Don't skip over loads or things that can modify memory.
 642     if (BBI->mayWriteToMemory() || BBI->mayReadFromMemory())
 643       break;
 644   }
 645
 646   // store X, null    -> turns into 'unreachable' in SimplifyCFG
 647   if (isa<ConstantPointerNull>(Ptr) && SI.getPointerAddressSpace() == 0) {
 648     if (!isa<UndefValue>(Val)) {
 649       SI.setOperand(0, UndefValue::get(Val->getType()));
 650       if (Instruction *U = dyn_cast<Instruction>(Val))
 651         Worklist.Add(U);  // Dropped a use.
 652     }
 653     return 0;  // Do not modify these!
 654   }
 655
 656   // store undef, Ptr -> noop
 657   if (isa<UndefValue>(Val))
 658     return EraseInstFromFunction(SI);
 659
 660   // If the pointer destination is a cast, see if we can fold the cast into the
 661   // source instead.
 662   if (isa<CastInst>(Ptr))
 663     if (Instruction *Res = InstCombineStoreToCast(*this, SI))
 664       return Res;
 665   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
 666     if (CE->isCast())
 667       if (Instruction *Res = InstCombineStoreToCast(*this, SI))
 668         return Res;
 669
 670
 671   // If this store is the last instruction in the basic block (possibly
 672   // excepting debug info instructions), and if the block ends with an
 673   // unconditional branch, try to move it to the successor block.
 674   BBI = &SI;
 675   do {
 676     ++BBI;
 677   } while (isa<DbgInfoIntrinsic>(BBI) ||
 678            (isa<BitCastInst>(BBI) && BBI->getType()->isPointerTy()));
 679   if (BranchInst *BI = dyn_cast<BranchInst>(BBI))
 680     if (BI->isUnconditional())
 681       if (SimplifyStoreAtEndOfBlock(SI))
 682         return 0;  // xform done!
 683
 684   return 0;
 685 }
 686
 687 /// SimplifyStoreAtEndOfBlock - Turn things like:
 688 ///   if () { *P = v1; } else { *P = v2 }
 689 /// into a phi node with a store in the successor.
 690 ///
 691 /// Simplify things like:
 692 ///   *P = v1; if () { *P = v2; }
 693 /// into a phi node with a store in the successor.
 694 ///
 695 bool InstCombiner::SimplifyStoreAtEndOfBlock(StoreInst &SI) {
 696   BasicBlock *StoreBB = SI.getParent();
 697
 698   // Check to see if the successor block has exactly two incoming edges.  If
 699   // so, see if the other predecessor contains a store to the same location.
 700   // if so, insert a PHI node (if needed) and move the stores down.
 701   BasicBlock *DestBB = StoreBB->getTerminator()->getSuccessor(0);
 702
 703   // Determine whether Dest has exactly two predecessors and, if so, compute
 704   // the other predecessor.
 705   pred_iterator PI = pred_begin(DestBB);
 706   BasicBlock *P = *PI;
 707   BasicBlock *OtherBB = 0;
 708
 709   if (P != StoreBB)
 710     OtherBB = P;
 711
 712   if (++PI == pred_end(DestBB))
 713     return false;
 714
 715   P = *PI;
 716   if (P != StoreBB) {
 717     if (OtherBB)
 718       return false;
 719     OtherBB = P;
 720   }
 721   if (++PI != pred_end(DestBB))
 722     return false;
 723
 724   // Bail out if all the relevant blocks aren't distinct (this can happen,
 725   // for example, if SI is in an infinite loop)
 726   if (StoreBB == DestBB || OtherBB == DestBB)
 727     return false;
 728
 729   // Verify that the other block ends in a branch and is not otherwise empty.
 730   BasicBlock::iterator BBI = OtherBB->getTerminator();
 731   BranchInst *OtherBr = dyn_cast<BranchInst>(BBI);
 732   if (!OtherBr || BBI == OtherBB->begin())
 733     return false;
 734
 735   // If the other block ends in an unconditional branch, check for the 'if then
 736   // else' case.  there is an instruction before the branch.
 737   StoreInst *OtherStore = 0;
 738   if (OtherBr->isUnconditional()) {
 739     --BBI;
 740     // Skip over debugging info.
 741     while (isa<DbgInfoIntrinsic>(BBI) ||
 742            (isa<BitCastInst>(BBI) && BBI->getType()->isPointerTy())) {
 743       if (BBI==OtherBB->begin())
 744         return false;
 745       --BBI;
 746     }
 747     // If this isn't a store, isn't a store to the same location, or is not the
 748     // right kind of store, bail out.
 749     OtherStore = dyn_cast<StoreInst>(BBI);
 750     if (!OtherStore || OtherStore->getOperand(1) != SI.getOperand(1) ||
 751         !SI.isSameOperationAs(OtherStore))
 752       return false;
 753   } else {
 754     // Otherwise, the other block ended with a conditional branch. If one of the
 755     // destinations is StoreBB, then we have the if/then case.
 756     if (OtherBr->getSuccessor(0) != StoreBB &&
 757         OtherBr->getSuccessor(1) != StoreBB)
 758       return false;
 759
 760     // Okay, we know that OtherBr now goes to Dest and StoreBB, so this is an
 761     // if/then triangle.  See if there is a store to the same ptr as SI that
 762     // lives in OtherBB.
 763     for (;; --BBI) {
 764       // Check to see if we find the matching store.
 765       if ((OtherStore = dyn_cast<StoreInst>(BBI))) {
 766         if (OtherStore->getOperand(1) != SI.getOperand(1) ||
 767             !SI.isSameOperationAs(OtherStore))
 768           return false;
 769         break;
 770       }
 771       // If we find something that may be using or overwriting the stored
 772       // value, or if we run out of instructions, we can't do the xform.
 773       if (BBI->mayReadFromMemory() || BBI->mayWriteToMemory() ||
 774           BBI == OtherBB->begin())
 775         return false;
 776     }
 777
 778     // In order to eliminate the store in OtherBr, we have to
 779     // make sure nothing reads or overwrites the stored value in
 780     // StoreBB.
 781     for (BasicBlock::iterator I = StoreBB->begin(); &*I != &SI; ++I) {
 782       // FIXME: This should really be AA driven.
 783       if (I->mayReadFromMemory() || I->mayWriteToMemory())
 784         return false;
 785     }
 786   }
 787
 788   // Insert a PHI node now if we need it.
 789   Value *MergedVal = OtherStore->getOperand(0);
 790   if (MergedVal != SI.getOperand(0)) {
 791     PHINode *PN = PHINode::Create(MergedVal->getType(), 2, "storemerge");
 792     PN->addIncoming(SI.getOperand(0), SI.getParent());
 793     PN->addIncoming(OtherStore->getOperand(0), OtherBB);
 794     MergedVal = InsertNewInstBefore(PN, DestBB->front());
 795   }
 796
 797   // Advance to a place where it is safe to insert the new store and
 798   // insert it.
 799   BBI = DestBB->getFirstInsertionPt();
 800   StoreInst *NewSI = new StoreInst(MergedVal, SI.getOperand(1),
 801                                    SI.isVolatile(),
 802                                    SI.getAlignment(),
 803                                    SI.getOrdering(),
 804                                    SI.getSynchScope());
 805   InsertNewInstBefore(NewSI, *BBI);
 806   NewSI->setDebugLoc(OtherStore->getDebugLoc());
 807
 808   // If the two stores had the same TBAA tag, preserve it.
 809   if (MDNode *TBAATag = SI.getMetadata(LLVMContext::MD_tbaa))
 810     if ((TBAATag = MDNode::getMostGenericTBAA(TBAATag,
 811                                OtherStore->getMetadata(LLVMContext::MD_tbaa))))
 812       NewSI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
 813
 814
 815   // Nuke the old stores.
 816   EraseInstFromFunction(SI);
 817   EraseInstFromFunction(*OtherStore);
 818   return true;
 819 }