lib/Transforms/Scalar/DeadStoreElimination.cpp

   1 //===- DeadStoreElimination.cpp - Fast Dead Store Elimination -------------===//
   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 a trivial dead store elimination that only considers
  11 // basic-block local redundant stores.
  12 //
  13 // FIXME: This should eventually be extended to be a post-dominator tree
  14 // traversal.  Doing so would be pretty trivial.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #define DEBUG_TYPE "dse"
  19 #include "llvm/Transforms/Scalar.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/Instructions.h"
  23 #include "llvm/IntrinsicInst.h"
  24 #include "llvm/Pass.h"
  25 #include "llvm/ADT/SmallPtrSet.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/Analysis/AliasAnalysis.h"
  28 #include "llvm/Analysis/Dominators.h"
  29 #include "llvm/Analysis/MemoryBuiltins.h"
  30 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  31 #include "llvm/Target/TargetData.h"
  32 #include "llvm/Transforms/Utils/Local.h"
  33 using namespace llvm;
  34
  35 STATISTIC(NumFastStores, "Number of stores deleted");
  36 STATISTIC(NumFastOther , "Number of other instrs removed");
  37
  38 namespace {
  39   struct DSE : public FunctionPass {
  40     TargetData *TD;
  41
  42     static char ID; // Pass identification, replacement for typeid
  43     DSE() : FunctionPass(&ID) {}
  44
  45     virtual bool runOnFunction(Function &F) {
  46       bool Changed = false;
  47       for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
  48         Changed |= runOnBasicBlock(*I);
  49       return Changed;
  50     }
  51
  52     bool runOnBasicBlock(BasicBlock &BB);
  53     bool handleFreeWithNonTrivialDependency(Instruction *F, MemDepResult Dep);
  54     bool handleEndBlock(BasicBlock &BB);
  55     bool RemoveUndeadPointers(Value* Ptr, uint64_t killPointerSize,
  56                               BasicBlock::iterator& BBI,
  57                               SmallPtrSet<Value*, 64>& deadPointers);
  58     void DeleteDeadInstruction(Instruction *I,
  59                                SmallPtrSet<Value*, 64> *deadPointers = 0);
  60
  61
  62     // getAnalysisUsage - We require post dominance frontiers (aka Control
  63     // Dependence Graph)
  64     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  65       AU.setPreservesCFG();
  66       AU.addRequired<DominatorTree>();
  67       AU.addRequired<AliasAnalysis>();
  68       AU.addRequired<MemoryDependenceAnalysis>();
  69       AU.addPreserved<DominatorTree>();
  70       AU.addPreserved<AliasAnalysis>();
  71       AU.addPreserved<MemoryDependenceAnalysis>();
  72     }
  73   };
  74 }
  75
  76 char DSE::ID = 0;
  77 static RegisterPass<DSE> X("dse", "Dead Store Elimination");
  78
  79 FunctionPass *llvm::createDeadStoreEliminationPass() { return new DSE(); }
  80
  81 bool DSE::runOnBasicBlock(BasicBlock &BB) {
  82   MemoryDependenceAnalysis& MD = getAnalysis<MemoryDependenceAnalysis>();
  83   TD = getAnalysisIfAvailable<TargetData>();
  84
  85   bool MadeChange = false;
  86
  87   // Do a top-down walk on the BB.
  88   for (BasicBlock::iterator BBI = BB.begin(), BBE = BB.end(); BBI != BBE; ) {
  89     Instruction *Inst = BBI++;
  90
  91     // If we find a store or a free, get its memory dependence.
  92     if (!isa<StoreInst>(Inst) && !isFreeCall(Inst))
  93       continue;
  94
  95     // Don't molest volatile stores or do queries that will return "clobber".
  96     if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
  97       if (SI->isVolatile())
  98         continue;
  99
 100     MemDepResult InstDep = MD.getDependency(Inst);
 101
 102     // Ignore non-local stores.
 103     // FIXME: cross-block DSE would be fun. :)
 104     if (InstDep.isNonLocal()) continue;
 105
 106     // Handle frees whose dependencies are non-trivial.
 107     if (isFreeCall(Inst)) {
 108       MadeChange |= handleFreeWithNonTrivialDependency(Inst, InstDep);
 109       continue;
 110     }
 111
 112     StoreInst *SI = cast<StoreInst>(Inst);
 113
 114     // If not a definite must-alias dependency, ignore it.
 115     if (!InstDep.isDef())
 116       continue;
 117
 118     // If this is a store-store dependence, then the previous store is dead so
 119     // long as this store is at least as big as it.
 120     if (StoreInst *DepStore = dyn_cast<StoreInst>(InstDep.getInst()))
 121       if (TD &&
 122           TD->getTypeStoreSize(DepStore->getOperand(0)->getType()) <=
 123           TD->getTypeStoreSize(SI->getOperand(0)->getType())) {
 124         // Delete the store and now-dead instructions that feed it.
 125         DeleteDeadInstruction(DepStore);
 126         NumFastStores++;
 127         MadeChange = true;
 128
 129         // DeleteDeadInstruction can delete the current instruction in loop
 130         // cases, reset BBI.
 131         BBI = Inst;
 132         if (BBI != BB.begin())
 133           --BBI;
 134         continue;
 135       }
 136
 137     // If we're storing the same value back to a pointer that we just
 138     // loaded from, then the store can be removed.
 139     if (LoadInst *DepLoad = dyn_cast<LoadInst>(InstDep.getInst())) {
 140       if (SI->getPointerOperand() == DepLoad->getPointerOperand() &&
 141           SI->getOperand(0) == DepLoad) {
 142         // DeleteDeadInstruction can delete the current instruction.  Save BBI
 143         // in case we need it.
 144         WeakVH NextInst(BBI);
 145
 146         DeleteDeadInstruction(SI);
 147
 148         if (NextInst == 0)  // Next instruction deleted.
 149           BBI = BB.begin();
 150         else if (BBI != BB.begin())  // Revisit this instruction if possible.
 151           --BBI;
 152         NumFastStores++;
 153         MadeChange = true;
 154         continue;
 155       }
 156     }
 157   }
 158
 159   // If this block ends in a return, unwind, or unreachable, all allocas are
 160   // dead at its end, which means stores to them are also dead.
 161   if (BB.getTerminator()->getNumSuccessors() == 0)
 162     MadeChange |= handleEndBlock(BB);
 163
 164   return MadeChange;
 165 }
 166
 167 /// handleFreeWithNonTrivialDependency - Handle frees of entire structures whose
 168 /// dependency is a store to a field of that structure.
 169 bool DSE::handleFreeWithNonTrivialDependency(Instruction *F, MemDepResult Dep) {
 170   AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
 171
 172   StoreInst *Dependency = dyn_cast_or_null<StoreInst>(Dep.getInst());
 173   if (!Dependency || Dependency->isVolatile())
 174     return false;
 175
 176   Value *DepPointer = Dependency->getPointerOperand()->getUnderlyingObject();
 177
 178   // Check for aliasing.
 179   if (AA.alias(F->getOperand(1), 1, DepPointer, 1) !=
 180          AliasAnalysis::MustAlias)
 181     return false;
 182
 183   // DCE instructions only used to calculate that store
 184   DeleteDeadInstruction(Dependency);
 185   NumFastStores++;
 186   return true;
 187 }
 188
 189 /// handleEndBlock - Remove dead stores to stack-allocated locations in the
 190 /// function end block.  Ex:
 191 /// %A = alloca i32
 192 /// ...
 193 /// store i32 1, i32* %A
 194 /// ret void
 195 bool DSE::handleEndBlock(BasicBlock &BB) {
 196   AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
 197
 198   bool MadeChange = false;
 199
 200   // Pointers alloca'd in this function are dead in the end block
 201   SmallPtrSet<Value*, 64> deadPointers;
 202
 203   // Find all of the alloca'd pointers in the entry block.
 204   BasicBlock *Entry = BB.getParent()->begin();
 205   for (BasicBlock::iterator I = Entry->begin(), E = Entry->end(); I != E; ++I)
 206     if (AllocaInst *AI = dyn_cast<AllocaInst>(I))
 207       deadPointers.insert(AI);
 208
 209   // Treat byval arguments the same, stores to them are dead at the end of the
 210   // function.
 211   for (Function::arg_iterator AI = BB.getParent()->arg_begin(),
 212        AE = BB.getParent()->arg_end(); AI != AE; ++AI)
 213     if (AI->hasByValAttr())
 214       deadPointers.insert(AI);
 215
 216   // Scan the basic block backwards
 217   for (BasicBlock::iterator BBI = BB.end(); BBI != BB.begin(); ){
 218     --BBI;
 219
 220     // If we find a store whose pointer is dead.
 221     if (StoreInst* S = dyn_cast<StoreInst>(BBI)) {
 222       if (!S->isVolatile()) {
 223         // See through pointer-to-pointer bitcasts
 224         Value* pointerOperand = S->getPointerOperand()->getUnderlyingObject();
 225
 226         // Alloca'd pointers or byval arguments (which are functionally like
 227         // alloca's) are valid candidates for removal.
 228         if (deadPointers.count(pointerOperand)) {
 229           // DCE instructions only used to calculate that store.
 230           BBI++;
 231           DeleteDeadInstruction(S, &deadPointers);
 232           NumFastStores++;
 233           MadeChange = true;
 234         }
 235       }
 236
 237       continue;
 238     }
 239
 240     // We can also remove memcpy's to local variables at the end of a function.
 241     if (MemCpyInst *M = dyn_cast<MemCpyInst>(BBI)) {
 242       Value *dest = M->getDest()->getUnderlyingObject();
 243
 244       if (deadPointers.count(dest)) {
 245         BBI++;
 246         DeleteDeadInstruction(M, &deadPointers);
 247         NumFastOther++;
 248         MadeChange = true;
 249         continue;
 250       }
 251
 252       // Because a memcpy is also a load, we can't skip it if we didn't remove
 253       // it.
 254     }
 255
 256     Value* killPointer = 0;
 257     uint64_t killPointerSize = ~0UL;
 258
 259     // If we encounter a use of the pointer, it is no longer considered dead
 260     if (LoadInst *L = dyn_cast<LoadInst>(BBI)) {
 261       // However, if this load is unused and not volatile, we can go ahead and
 262       // remove it, and not have to worry about it making our pointer undead!
 263       if (L->use_empty() && !L->isVolatile()) {
 264         BBI++;
 265         DeleteDeadInstruction(L, &deadPointers);
 266         NumFastOther++;
 267         MadeChange = true;
 268         continue;
 269       }
 270
 271       killPointer = L->getPointerOperand();
 272     } else if (VAArgInst* V = dyn_cast<VAArgInst>(BBI)) {
 273       killPointer = V->getOperand(0);
 274     } else if (isa<MemCpyInst>(BBI) &&
 275                isa<ConstantInt>(cast<MemCpyInst>(BBI)->getLength())) {
 276       killPointer = cast<MemCpyInst>(BBI)->getSource();
 277       killPointerSize = cast<ConstantInt>(
 278                             cast<MemCpyInst>(BBI)->getLength())->getZExtValue();
 279     } else if (AllocaInst* A = dyn_cast<AllocaInst>(BBI)) {
 280       deadPointers.erase(A);
 281
 282       // Dead alloca's can be DCE'd when we reach them
 283       if (A->use_empty()) {
 284         BBI++;
 285         DeleteDeadInstruction(A, &deadPointers);
 286         NumFastOther++;
 287         MadeChange = true;
 288       }
 289
 290       continue;
 291     } else if (CallSite::get(BBI).getInstruction() != 0) {
 292       // If this call does not access memory, it can't
 293       // be undeadifying any of our pointers.
 294       CallSite CS = CallSite::get(BBI);
 295       if (AA.doesNotAccessMemory(CS))
 296         continue;
 297
 298       unsigned modRef = 0;
 299       unsigned other = 0;
 300
 301       // Remove any pointers made undead by the call from the dead set
 302       std::vector<Value*> dead;
 303       for (SmallPtrSet<Value*, 64>::iterator I = deadPointers.begin(),
 304            E = deadPointers.end(); I != E; ++I) {
 305         // HACK: if we detect that our AA is imprecise, it's not
 306         // worth it to scan the rest of the deadPointers set.  Just
 307         // assume that the AA will return ModRef for everything, and
 308         // go ahead and bail.
 309         if (modRef >= 16 && other == 0) {
 310           deadPointers.clear();
 311           return MadeChange;
 312         }
 313
 314         // Get size information for the alloca
 315         unsigned pointerSize = ~0U;
 316         if (TD) {
 317           if (AllocaInst* A = dyn_cast<AllocaInst>(*I)) {
 318             if (ConstantInt* C = dyn_cast<ConstantInt>(A->getArraySize()))
 319               pointerSize = C->getZExtValue() *
 320                             TD->getTypeAllocSize(A->getAllocatedType());
 321           } else {
 322             const PointerType* PT = cast<PointerType>(
 323                                                    cast<Argument>(*I)->getType());
 324             pointerSize = TD->getTypeAllocSize(PT->getElementType());
 325           }
 326         }
 327
 328         // See if the call site touches it
 329         AliasAnalysis::ModRefResult A = AA.getModRefInfo(CS, *I, pointerSize);
 330
 331         if (A == AliasAnalysis::ModRef)
 332           modRef++;
 333         else
 334           other++;
 335
 336         if (A == AliasAnalysis::ModRef || A == AliasAnalysis::Ref)
 337           dead.push_back(*I);
 338       }
 339
 340       for (std::vector<Value*>::iterator I = dead.begin(), E = dead.end();
 341            I != E; ++I)
 342         deadPointers.erase(*I);
 343
 344       continue;
 345     } else if (isInstructionTriviallyDead(BBI)) {
 346       // For any non-memory-affecting non-terminators, DCE them as we reach them
 347       Instruction *Inst = BBI;
 348       BBI++;
 349       DeleteDeadInstruction(Inst, &deadPointers);
 350       NumFastOther++;
 351       MadeChange = true;
 352       continue;
 353     }
 354
 355     if (!killPointer)
 356       continue;
 357
 358     killPointer = killPointer->getUnderlyingObject();
 359
 360     // Deal with undead pointers
 361     MadeChange |= RemoveUndeadPointers(killPointer, killPointerSize, BBI,
 362                                        deadPointers);
 363   }
 364
 365   return MadeChange;
 366 }
 367
 368 /// RemoveUndeadPointers - check for uses of a pointer that make it
 369 /// undead when scanning for dead stores to alloca's.
 370 bool DSE::RemoveUndeadPointers(Value* killPointer, uint64_t killPointerSize,
 371                                BasicBlock::iterator &BBI,
 372                                SmallPtrSet<Value*, 64>& deadPointers) {
 373   AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
 374
 375   // If the kill pointer can be easily reduced to an alloca,
 376   // don't bother doing extraneous AA queries.
 377   if (deadPointers.count(killPointer)) {
 378     deadPointers.erase(killPointer);
 379     return false;
 380   }
 381
 382   // A global can't be in the dead pointer set.
 383   if (isa<GlobalValue>(killPointer))
 384     return false;
 385
 386   bool MadeChange = false;
 387
 388   SmallVector<Value*, 16> undead;
 389
 390   for (SmallPtrSet<Value*, 64>::iterator I = deadPointers.begin(),
 391       E = deadPointers.end(); I != E; ++I) {
 392     // Get size information for the alloca.
 393     unsigned pointerSize = ~0U;
 394     if (TD) {
 395       if (AllocaInst* A = dyn_cast<AllocaInst>(*I)) {
 396         if (ConstantInt* C = dyn_cast<ConstantInt>(A->getArraySize()))
 397           pointerSize = C->getZExtValue() *
 398                         TD->getTypeAllocSize(A->getAllocatedType());
 399       } else {
 400         const PointerType* PT = cast<PointerType>(cast<Argument>(*I)->getType());
 401         pointerSize = TD->getTypeAllocSize(PT->getElementType());
 402       }
 403     }
 404
 405     // See if this pointer could alias it
 406     AliasAnalysis::AliasResult A = AA.alias(*I, pointerSize,
 407                                             killPointer, killPointerSize);
 408
 409     // If it must-alias and a store, we can delete it
 410     if (isa<StoreInst>(BBI) && A == AliasAnalysis::MustAlias) {
 411       StoreInst* S = cast<StoreInst>(BBI);
 412
 413       // Remove it!
 414       BBI++;
 415       DeleteDeadInstruction(S, &deadPointers);
 416       NumFastStores++;
 417       MadeChange = true;
 418
 419       continue;
 420
 421       // Otherwise, it is undead
 422     } else if (A != AliasAnalysis::NoAlias)
 423       undead.push_back(*I);
 424   }
 425
 426   for (SmallVector<Value*, 16>::iterator I = undead.begin(), E = undead.end();
 427        I != E; ++I)
 428       deadPointers.erase(*I);
 429
 430   return MadeChange;
 431 }
 432
 433 /// DeleteDeadInstruction - Delete this instruction.  Before we do, go through
 434 /// and zero out all the operands of this instruction.  If any of them become
 435 /// dead, delete them and the computation tree that feeds them.
 436 ///
 437 /// If ValueSet is non-null, remove any deleted instructions from it as well.
 438 ///
 439 void DSE::DeleteDeadInstruction(Instruction *I,
 440                                 SmallPtrSet<Value*, 64> *ValueSet) {
 441   SmallVector<Instruction*, 32> NowDeadInsts;
 442
 443   NowDeadInsts.push_back(I);
 444   --NumFastOther;
 445
 446   // Before we touch this instruction, remove it from memdep!
 447   MemoryDependenceAnalysis &MDA = getAnalysis<MemoryDependenceAnalysis>();
 448   while (!NowDeadInsts.empty()) {
 449     Instruction *DeadInst = NowDeadInsts.back();
 450     NowDeadInsts.pop_back();
 451
 452     ++NumFastOther;
 453
 454     // This instruction is dead, zap it, in stages.  Start by removing it from
 455     // MemDep, which needs to know the operands and needs it to be in the
 456     // function.
 457     MDA.removeInstruction(DeadInst);
 458
 459     for (unsigned op = 0, e = DeadInst->getNumOperands(); op != e; ++op) {
 460       Value *Op = DeadInst->getOperand(op);
 461       DeadInst->setOperand(op, 0);
 462
 463       // If this operand just became dead, add it to the NowDeadInsts list.
 464       if (!Op->use_empty()) continue;
 465
 466       if (Instruction *OpI = dyn_cast<Instruction>(Op))
 467         if (isInstructionTriviallyDead(OpI))
 468           NowDeadInsts.push_back(OpI);
 469     }
 470
 471     DeadInst->eraseFromParent();
 472
 473     if (ValueSet) ValueSet->erase(DeadInst);
 474   }
 475 }