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