lib/Analysis/Loads.cpp

   1 //===- Loads.cpp - Local load analysis ------------------------------------===//
   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 defines simple local analyses for load instructions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/Loads.h"
  15 #include "llvm/Analysis/AliasAnalysis.h"
  16 #include "llvm/Analysis/ValueTracking.h"
  17 #include "llvm/IR/DataLayout.h"
  18 #include "llvm/IR/GlobalAlias.h"
  19 #include "llvm/IR/GlobalVariable.h"
  20 #include "llvm/IR/IntrinsicInst.h"
  21 #include "llvm/IR/LLVMContext.h"
  22 #include "llvm/IR/Operator.h"
  23 using namespace llvm;
  24
  25 /// \brief Test if A and B will obviously have the same value.
  26 ///
  27 /// This includes recognizing that %t0 and %t1 will have the same
  28 /// value in code like this:
  29 /// \code
  30 ///   %t0 = getelementptr \@a, 0, 3
  31 ///   store i32 0, i32* %t0
  32 ///   %t1 = getelementptr \@a, 0, 3
  33 ///   %t2 = load i32* %t1
  34 /// \endcode
  35 ///
  36 static bool AreEquivalentAddressValues(const Value *A, const Value *B) {
  37   // Test if the values are trivially equivalent.
  38   if (A == B)
  39     return true;
  40
  41   // Test if the values come from identical arithmetic instructions.
  42   // Use isIdenticalToWhenDefined instead of isIdenticalTo because
  43   // this function is only used when one address use dominates the
  44   // other, which means that they'll always either have the same
  45   // value or one of them will have an undefined value.
  46   if (isa<BinaryOperator>(A) || isa<CastInst>(A) || isa<PHINode>(A) ||
  47       isa<GetElementPtrInst>(A))
  48     if (const Instruction *BI = dyn_cast<Instruction>(B))
  49       if (cast<Instruction>(A)->isIdenticalToWhenDefined(BI))
  50         return true;
  51
  52   // Otherwise they may not be equivalent.
  53   return false;
  54 }
  55
  56 /// \brief Check if executing a load of this pointer value cannot trap.
  57 ///
  58 /// If it is not obviously safe to load from the specified pointer, we do
  59 /// a quick local scan of the basic block containing \c ScanFrom, to determine
  60 /// if the address is already accessed.
  61 ///
  62 /// This uses the pointee type to determine how many bytes need to be safe to
  63 /// load from the pointer.
  64 bool llvm::isSafeToLoadUnconditionally(Value *V, Instruction *ScanFrom,
  65                                        unsigned Align, const DataLayout *DL) {
  66   int64_t ByteOffset = 0;
  67   Value *Base = V;
  68   Base = GetPointerBaseWithConstantOffset(V, ByteOffset, DL);
  69
  70   if (ByteOffset < 0) // out of bounds
  71     return false;
  72
  73   Type *BaseType = nullptr;
  74   unsigned BaseAlign = 0;
  75   if (const AllocaInst *AI = dyn_cast<AllocaInst>(Base)) {
  76     // An alloca is safe to load from as load as it is suitably aligned.
  77     BaseType = AI->getAllocatedType();
  78     BaseAlign = AI->getAlignment();
  79   } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Base)) {
  80     // Global variables are not necessarily safe to load from if they are
  81     // overridden. Their size may change or they may be weak and require a test
  82     // to determine if they were in fact provided.
  83     if (!GV->mayBeOverridden()) {
  84       BaseType = GV->getType()->getElementType();
  85       BaseAlign = GV->getAlignment();
  86     }
  87   }
  88
  89   // If we found a base allocated type from either an alloca or global variable,
  90   // try to see if we are definitively within the allocated region. We need to
  91   // know the size of the base type and the loaded type to do anything in this
  92   // case, so only try this when we have the DataLayout available.
  93   if (BaseType && BaseType->isSized() && DL) {
  94     if (BaseAlign == 0)
  95       BaseAlign = DL->getPrefTypeAlignment(BaseType);
  96
  97     if (Align <= BaseAlign) {
  98       // Check if the load is within the bounds of the underlying object.
  99       PointerType *AddrTy = cast<PointerType>(V->getType());
 100       uint64_t LoadSize = DL->getTypeStoreSize(AddrTy->getElementType());
 101       if (ByteOffset + LoadSize <= DL->getTypeAllocSize(BaseType) &&
 102           (Align == 0 || (ByteOffset % Align) == 0))
 103         return true;
 104     }
 105   }
 106
 107   // Otherwise, be a little bit aggressive by scanning the local block where we
 108   // want to check to see if the pointer is already being loaded or stored
 109   // from/to.  If so, the previous load or store would have already trapped,
 110   // so there is no harm doing an extra load (also, CSE will later eliminate
 111   // the load entirely).
 112   BasicBlock::iterator BBI = ScanFrom, E = ScanFrom->getParent()->begin();
 113
 114   while (BBI != E) {
 115     --BBI;
 116
 117     // If we see a free or a call which may write to memory (i.e. which might do
 118     // a free) the pointer could be marked invalid.
 119     if (isa<CallInst>(BBI) && BBI->mayWriteToMemory() &&
 120         !isa<DbgInfoIntrinsic>(BBI))
 121       return false;
 122
 123     if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
 124       if (AreEquivalentAddressValues(LI->getOperand(0), V))
 125         return true;
 126     } else if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
 127       if (AreEquivalentAddressValues(SI->getOperand(1), V))
 128         return true;
 129     }
 130   }
 131   return false;
 132 }
 133
 134 /// \brief Scan the ScanBB block backwards to see if we have the value at the
 135 /// memory address *Ptr locally available within a small number of instructions.
 136 ///
 137 /// The scan starts from \c ScanFrom. \c MaxInstsToScan specifies the maximum
 138 /// instructions to scan in the block. If it is set to \c 0, it will scan the whole
 139 /// block.
 140 ///
 141 /// If the value is available, this function returns it. If not, it returns the
 142 /// iterator for the last validated instruction that the value would be live
 143 /// through. If we scanned the entire block and didn't find something that
 144 /// invalidates \c *Ptr or provides it, \c ScanFrom is left at the last
 145 /// instruction processed and this returns null.
 146 ///
 147 /// You can also optionally specify an alias analysis implementation, which
 148 /// makes this more precise.
 149 ///
 150 /// If \c AATags is non-null and a load or store is found, the AA tags from the
 151 /// load or store are recorded there. If there are no AA tags or if no access is
 152 /// found, it is left unmodified.
 153 Value *llvm::FindAvailableLoadedValue(Value *Ptr, BasicBlock *ScanBB,
 154                                       BasicBlock::iterator &ScanFrom,
 155                                       unsigned MaxInstsToScan,
 156                                       AliasAnalysis *AA, AAMDNodes *AATags) {
 157   if (MaxInstsToScan == 0)
 158     MaxInstsToScan = ~0U;
 159
 160   // If we're using alias analysis to disambiguate get the size of *Ptr.
 161   uint64_t AccessSize = 0;
 162   if (AA) {
 163     Type *AccessTy = cast<PointerType>(Ptr->getType())->getElementType();
 164     AccessSize = AA->getTypeStoreSize(AccessTy);
 165   }
 166
 167   while (ScanFrom != ScanBB->begin()) {
 168     // We must ignore debug info directives when counting (otherwise they
 169     // would affect codegen).
 170     Instruction *Inst = --ScanFrom;
 171     if (isa<DbgInfoIntrinsic>(Inst))
 172       continue;
 173
 174     // Restore ScanFrom to expected value in case next test succeeds
 175     ScanFrom++;
 176
 177     // Don't scan huge blocks.
 178     if (MaxInstsToScan-- == 0)
 179       return nullptr;
 180
 181     --ScanFrom;
 182     // If this is a load of Ptr, the loaded value is available.
 183     // (This is true even if the load is volatile or atomic, although
 184     // those cases are unlikely.)
 185     if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
 186       if (AreEquivalentAddressValues(LI->getOperand(0), Ptr)) {
 187         if (AATags)
 188           LI->getAAMetadata(*AATags);
 189         return LI;
 190       }
 191
 192     if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 193       // If this is a store through Ptr, the value is available!
 194       // (This is true even if the store is volatile or atomic, although
 195       // those cases are unlikely.)
 196       if (AreEquivalentAddressValues(SI->getOperand(1), Ptr)) {
 197         if (AATags)
 198           SI->getAAMetadata(*AATags);
 199         return SI->getOperand(0);
 200       }
 201
 202       // If Ptr is an alloca and this is a store to a different alloca, ignore
 203       // the store.  This is a trivial form of alias analysis that is important
 204       // for reg2mem'd code.
 205       if ((isa<AllocaInst>(Ptr) || isa<GlobalVariable>(Ptr)) &&
 206           (isa<AllocaInst>(SI->getOperand(1)) ||
 207            isa<GlobalVariable>(SI->getOperand(1))))
 208         continue;
 209
 210       // If we have alias analysis and it says the store won't modify the loaded
 211       // value, ignore the store.
 212       if (AA &&
 213           (AA->getModRefInfo(SI, Ptr, AccessSize) & AliasAnalysis::Mod) == 0)
 214         continue;
 215
 216       // Otherwise the store that may or may not alias the pointer, bail out.
 217       ++ScanFrom;
 218       return nullptr;
 219     }
 220
 221     // If this is some other instruction that may clobber Ptr, bail out.
 222     if (Inst->mayWriteToMemory()) {
 223       // If alias analysis claims that it really won't modify the load,
 224       // ignore it.
 225       if (AA &&
 226           (AA->getModRefInfo(Inst, Ptr, AccessSize) & AliasAnalysis::Mod) == 0)
 227         continue;
 228
 229       // May modify the pointer, bail out.
 230       ++ScanFrom;
 231       return nullptr;
 232     }
 233   }
 234
 235   // Got to the start of the block, we didn't find it, but are done for this
 236   // block.
 237   return nullptr;
 238 }