1 //===- LoadValueNumbering.cpp - Load Value #'ing Implementation -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a value numbering pass that value numbers load and call
11 // instructions. To do this, it finds lexically identical load instructions,
12 // and uses alias analysis to determine which loads are guaranteed to produce
13 // the same value. To value number call instructions, it looks for calls to
14 // functions that do not write to memory which do not have intervening
15 // instructions that clobber the memory that is read from.
17 // This pass builds off of another value numbering pass to implement value
18 // numbering for non-load and non-call instructions. It uses Alias Analysis so
19 // that it can disambiguate the load instructions. The more powerful these base
20 // analyses are, the more powerful the resultant value numbering will be.
22 //===----------------------------------------------------------------------===//
24 #include "llvm/Analysis/LoadValueNumbering.h"
25 #include "llvm/Constants.h"
26 #include "llvm/Function.h"
27 #include "llvm/Instructions.h"
28 #include "llvm/Pass.h"
29 #include "llvm/Type.h"
30 #include "llvm/Analysis/ValueNumbering.h"
31 #include "llvm/Analysis/AliasAnalysis.h"
32 #include "llvm/Analysis/Dominators.h"
33 #include "llvm/Support/CFG.h"
34 #include "llvm/Support/Compiler.h"
35 #include "llvm/Target/TargetData.h"
41 // FIXME: This should not be a FunctionPass.
42 struct VISIBILITY_HIDDEN LoadVN : public FunctionPass, public ValueNumbering {
43 static char ID; // Class identification, replacement for typeinfo
44 LoadVN() : FunctionPass((intptr_t)&ID) {}
46 /// Pass Implementation stuff. This doesn't do any analysis.
48 bool runOnFunction(Function &) { return false; }
50 /// getAnalysisUsage - Does not modify anything. It uses Value Numbering
51 /// and Alias Analysis.
53 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
55 /// getEqualNumberNodes - Return nodes with the same value number as the
56 /// specified Value. This fills in the argument vector with any equal
59 virtual void getEqualNumberNodes(Value *V1,
60 std::vector<Value*> &RetVals) const;
62 /// deleteValue - This method should be called whenever an LLVM Value is
63 /// deleted from the program, for example when an instruction is found to be
64 /// redundant and is eliminated.
66 virtual void deleteValue(Value *V) {
67 getAnalysis<AliasAnalysis>().deleteValue(V);
70 /// copyValue - This method should be used whenever a preexisting value in
71 /// the program is copied or cloned, introducing a new value. Note that
72 /// analysis implementations should tolerate clients that use this method to
73 /// introduce the same value multiple times: if the analysis already knows
74 /// about a value, it should ignore the request.
76 virtual void copyValue(Value *From, Value *To) {
77 getAnalysis<AliasAnalysis>().copyValue(From, To);
80 /// getCallEqualNumberNodes - Given a call instruction, find other calls
81 /// that have the same value number.
82 void getCallEqualNumberNodes(CallInst *CI,
83 std::vector<Value*> &RetVals) const;
87 // Register this pass...
88 RegisterPass<LoadVN> X("load-vn", "Load Value Numbering");
90 // Declare that we implement the ValueNumbering interface
91 RegisterAnalysisGroup<ValueNumbering> Y(X);
94 FunctionPass *llvm::createLoadValueNumberingPass() { return new LoadVN(); }
97 /// getAnalysisUsage - Does not modify anything. It uses Value Numbering and
100 void LoadVN::getAnalysisUsage(AnalysisUsage &AU) const {
101 AU.setPreservesAll();
102 AU.addRequiredTransitive<AliasAnalysis>();
103 AU.addRequired<ValueNumbering>();
104 AU.addRequiredTransitive<DominatorTree>();
105 AU.addRequiredTransitive<TargetData>();
108 static bool isPathTransparentTo(BasicBlock *CurBlock, BasicBlock *Dom,
109 Value *Ptr, unsigned Size, AliasAnalysis &AA,
110 std::set<BasicBlock*> &Visited,
111 std::map<BasicBlock*, bool> &TransparentBlocks){
112 // If we have already checked out this path, or if we reached our destination,
113 // stop searching, returning success.
114 if (CurBlock == Dom || !Visited.insert(CurBlock).second)
117 // Check whether this block is known transparent or not.
118 std::map<BasicBlock*, bool>::iterator TBI =
119 TransparentBlocks.lower_bound(CurBlock);
121 if (TBI == TransparentBlocks.end() || TBI->first != CurBlock) {
122 // If this basic block can modify the memory location, then the path is not
124 if (AA.canBasicBlockModify(*CurBlock, Ptr, Size)) {
125 TransparentBlocks.insert(TBI, std::make_pair(CurBlock, false));
128 TransparentBlocks.insert(TBI, std::make_pair(CurBlock, true));
129 } else if (!TBI->second)
130 // This block is known non-transparent, so that path can't be either.
133 // The current block is known to be transparent. The entire path is
134 // transparent if all of the predecessors paths to the parent is also
135 // transparent to the memory location.
136 for (pred_iterator PI = pred_begin(CurBlock), E = pred_end(CurBlock);
138 if (!isPathTransparentTo(*PI, Dom, Ptr, Size, AA, Visited,
144 /// getCallEqualNumberNodes - Given a call instruction, find other calls that
145 /// have the same value number.
146 void LoadVN::getCallEqualNumberNodes(CallInst *CI,
147 std::vector<Value*> &RetVals) const {
148 Function *CF = CI->getCalledFunction();
149 if (CF == 0) return; // Indirect call.
150 AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
151 AliasAnalysis::ModRefBehavior MRB = AA.getModRefBehavior(CI);
152 if (MRB != AliasAnalysis::DoesNotAccessMemory &&
153 MRB != AliasAnalysis::OnlyReadsMemory)
154 return; // Nothing we can do for now.
156 // Scan all of the arguments of the function, looking for one that is not
157 // global. In particular, we would prefer to have an argument or instruction
158 // operand to chase the def-use chains of.
160 for (unsigned i = 1, e = CI->getNumOperands(); i != e; ++i)
161 if (isa<Argument>(CI->getOperand(i)) ||
162 isa<Instruction>(CI->getOperand(i))) {
163 Op = CI->getOperand(i);
167 // Identify all lexically identical calls in this function.
168 std::vector<CallInst*> IdenticalCalls;
170 Function *CIFunc = CI->getParent()->getParent();
171 for (Value::use_iterator UI = Op->use_begin(), E = Op->use_end(); UI != E;
173 if (CallInst *C = dyn_cast<CallInst>(*UI))
174 if (C->getNumOperands() == CI->getNumOperands() &&
175 C->getOperand(0) == CI->getOperand(0) &&
176 C->getParent()->getParent() == CIFunc && C != CI) {
177 bool AllOperandsEqual = true;
178 for (unsigned i = 1, e = CI->getNumOperands(); i != e; ++i)
179 if (C->getOperand(i) != CI->getOperand(i)) {
180 AllOperandsEqual = false;
184 if (AllOperandsEqual)
185 IdenticalCalls.push_back(C);
188 if (IdenticalCalls.empty()) return;
190 // Eliminate duplicates, which could occur if we chose a value that is passed
191 // into a call site multiple times.
192 std::sort(IdenticalCalls.begin(), IdenticalCalls.end());
193 IdenticalCalls.erase(std::unique(IdenticalCalls.begin(),IdenticalCalls.end()),
194 IdenticalCalls.end());
196 // If the call reads memory, we must make sure that there are no stores
197 // between the calls in question.
199 // FIXME: This should use mod/ref information. What we really care about it
200 // whether an intervening instruction could modify memory that is read, not
203 if (MRB == AliasAnalysis::OnlyReadsMemory) {
204 DominatorTree &DT = getAnalysis<DominatorTree>();
205 BasicBlock *CIBB = CI->getParent();
206 for (unsigned i = 0; i != IdenticalCalls.size(); ++i) {
207 CallInst *C = IdenticalCalls[i];
208 bool CantEqual = false;
210 if (DT.dominates(CIBB, C->getParent())) {
211 // FIXME: we currently only handle the case where both calls are in the
213 if (CIBB != C->getParent()) {
216 Instruction *First = CI, *Second = C;
217 if (!DT.dominates(CI, C))
218 std::swap(First, Second);
220 // Scan the instructions between the calls, checking for stores or
221 // calls to dangerous functions.
222 BasicBlock::iterator I = First;
223 for (++First; I != BasicBlock::iterator(Second); ++I) {
224 if (isa<StoreInst>(I)) {
225 // FIXME: We could use mod/ref information to make this much
229 } else if (CallInst *CI = dyn_cast<CallInst>(I)) {
230 if (!AA.onlyReadsMemory(CI)) {
234 } else if (I->mayWriteToMemory()) {
241 } else if (DT.dominates(C->getParent(), CIBB)) {
242 // FIXME: We could implement this, but we don't for now.
245 // FIXME: if one doesn't dominate the other, we can't tell yet.
251 // This call does not produce the same value as the one in the query.
252 std::swap(IdenticalCalls[i--], IdenticalCalls.back());
253 IdenticalCalls.pop_back();
258 // Any calls that are identical and not destroyed will produce equal values!
259 for (unsigned i = 0, e = IdenticalCalls.size(); i != e; ++i)
260 RetVals.push_back(IdenticalCalls[i]);
263 // getEqualNumberNodes - Return nodes with the same value number as the
264 // specified Value. This fills in the argument vector with any equal values.
266 void LoadVN::getEqualNumberNodes(Value *V,
267 std::vector<Value*> &RetVals) const {
268 // If the alias analysis has any must alias information to share with us, we
269 // can definitely use it.
270 if (isa<PointerType>(V->getType()))
271 getAnalysis<AliasAnalysis>().getMustAliases(V, RetVals);
273 if (!isa<LoadInst>(V)) {
274 if (CallInst *CI = dyn_cast<CallInst>(V))
275 getCallEqualNumberNodes(CI, RetVals);
277 // Not a load instruction? Just chain to the base value numbering
278 // implementation to satisfy the request...
279 assert(&getAnalysis<ValueNumbering>() != (ValueNumbering*)this &&
280 "getAnalysis() returned this!");
282 return getAnalysis<ValueNumbering>().getEqualNumberNodes(V, RetVals);
285 // Volatile loads cannot be replaced with the value of other loads.
286 LoadInst *LI = cast<LoadInst>(V);
287 if (LI->isVolatile())
288 return getAnalysis<ValueNumbering>().getEqualNumberNodes(V, RetVals);
290 Value *LoadPtr = LI->getOperand(0);
291 BasicBlock *LoadBB = LI->getParent();
292 Function *F = LoadBB->getParent();
294 // Find out how many bytes of memory are loaded by the load instruction...
295 unsigned LoadSize = getAnalysis<TargetData>().getTypeStoreSize(LI->getType());
296 AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
298 // Figure out if the load is invalidated from the entry of the block it is in
299 // until the actual instruction. This scans the block backwards from LI. If
300 // we see any candidate load or store instructions, then we know that the
301 // candidates have the same value # as LI.
302 bool LoadInvalidatedInBBBefore = false;
303 for (BasicBlock::iterator I = LI; I != LoadBB->begin(); ) {
306 // If we run into an allocation of the value being loaded, then the
307 // contents are not initialized.
308 if (isa<AllocationInst>(I))
309 RetVals.push_back(UndefValue::get(LI->getType()));
311 // Otherwise, since this is the definition of what we are loading, this
312 // loaded value cannot occur before this block.
313 LoadInvalidatedInBBBefore = true;
315 } else if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
316 // If this instruction is a candidate load before LI, we know there are no
317 // invalidating instructions between it and LI, so they have the same
319 if (LI->getOperand(0) == LoadPtr && !LI->isVolatile())
320 RetVals.push_back(I);
323 if (AA.getModRefInfo(I, LoadPtr, LoadSize) & AliasAnalysis::Mod) {
324 // If the invalidating instruction is a store, and its in our candidate
325 // set, then we can do store-load forwarding: the load has the same value
326 // # as the stored value.
327 if (StoreInst *SI = dyn_cast<StoreInst>(I))
328 if (SI->getOperand(1) == LoadPtr)
329 RetVals.push_back(I->getOperand(0));
331 LoadInvalidatedInBBBefore = true;
336 // Figure out if the load is invalidated between the load and the exit of the
337 // block it is defined in. While we are scanning the current basic block, if
338 // we see any candidate loads, then we know they have the same value # as LI.
340 bool LoadInvalidatedInBBAfter = false;
342 BasicBlock::iterator I = LI;
343 for (++I; I != LoadBB->end(); ++I) {
344 // If this instruction is a load, then this instruction returns the same
346 if (isa<LoadInst>(I) && cast<LoadInst>(I)->getOperand(0) == LoadPtr)
347 RetVals.push_back(I);
349 if (AA.getModRefInfo(I, LoadPtr, LoadSize) & AliasAnalysis::Mod) {
350 LoadInvalidatedInBBAfter = true;
356 // If the pointer is clobbered on entry and on exit to the function, there is
357 // no need to do any global analysis at all.
358 if (LoadInvalidatedInBBBefore && LoadInvalidatedInBBAfter)
361 // Now that we know the value is not neccesarily killed on entry or exit to
362 // the BB, find out how many load and store instructions (to this location)
363 // live in each BB in the function.
365 std::map<BasicBlock*, unsigned> CandidateLoads;
366 std::set<BasicBlock*> CandidateStores;
368 for (Value::use_iterator UI = LoadPtr->use_begin(), UE = LoadPtr->use_end();
370 if (LoadInst *Cand = dyn_cast<LoadInst>(*UI)) {// Is a load of source?
371 if (Cand->getParent()->getParent() == F && // In the same function?
372 // Not in LI's block?
373 Cand->getParent() != LoadBB && !Cand->isVolatile())
374 ++CandidateLoads[Cand->getParent()]; // Got one.
375 } else if (StoreInst *Cand = dyn_cast<StoreInst>(*UI)) {
376 if (Cand->getParent()->getParent() == F && !Cand->isVolatile() &&
377 Cand->getOperand(1) == LoadPtr) // It's a store THROUGH the ptr.
378 CandidateStores.insert(Cand->getParent());
382 DominatorTree &DT = getAnalysis<DominatorTree>();
384 // TransparentBlocks - For each basic block the load/store is alive across,
385 // figure out if the pointer is invalidated or not. If it is invalidated, the
386 // boolean is set to false, if it's not it is set to true. If we don't know
387 // yet, the entry is not in the map.
388 std::map<BasicBlock*, bool> TransparentBlocks;
390 // Loop over all of the basic blocks that also load the value. If the value
391 // is live across the CFG from the source to destination blocks, and if the
392 // value is not invalidated in either the source or destination blocks, add it
393 // to the equivalence sets.
394 for (std::map<BasicBlock*, unsigned>::iterator
395 I = CandidateLoads.begin(), E = CandidateLoads.end(); I != E; ++I) {
396 bool CantEqual = false;
398 // Right now we only can handle cases where one load dominates the other.
399 // FIXME: generalize this!
400 BasicBlock *BB1 = I->first, *BB2 = LoadBB;
401 if (DT.dominates(BB1, BB2)) {
402 // The other load dominates LI. If the loaded value is killed entering
403 // the LoadBB block, we know the load is not live.
404 if (LoadInvalidatedInBBBefore)
406 } else if (DT.dominates(BB2, BB1)) {
407 std::swap(BB1, BB2); // Canonicalize
408 // LI dominates the other load. If the loaded value is killed exiting
409 // the LoadBB block, we know the load is not live.
410 if (LoadInvalidatedInBBAfter)
413 // None of these loads can VN the same.
418 // Ok, at this point, we know that BB1 dominates BB2, and that there is
419 // nothing in the LI block that kills the loaded value. Check to see if
420 // the value is live across the CFG.
421 std::set<BasicBlock*> Visited;
422 for (pred_iterator PI = pred_begin(BB2), E = pred_end(BB2); PI!=E; ++PI)
423 if (!isPathTransparentTo(*PI, BB1, LoadPtr, LoadSize, AA,
424 Visited, TransparentBlocks)) {
425 // None of these loads can VN the same.
431 // If the loads can equal so far, scan the basic block that contains the
432 // loads under consideration to see if they are invalidated in the block.
433 // For any loads that are not invalidated, add them to the equivalence
436 unsigned NumLoads = I->second;
438 // If LI dominates the block in question, check to see if any of the
439 // loads in this block are invalidated before they are reached.
440 for (BasicBlock::iterator BBI = I->first->begin(); ; ++BBI) {
441 if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
442 if (LI->getOperand(0) == LoadPtr && !LI->isVolatile()) {
443 // The load is in the set!
444 RetVals.push_back(BBI);
445 if (--NumLoads == 0) break; // Found last load to check.
447 } else if (AA.getModRefInfo(BBI, LoadPtr, LoadSize)
448 & AliasAnalysis::Mod) {
449 // If there is a modifying instruction, nothing below it will value
455 // If the block dominates LI, make sure that the loads in the block are
456 // not invalidated before the block ends.
457 BasicBlock::iterator BBI = I->first->end();
460 if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
461 if (LI->getOperand(0) == LoadPtr && !LI->isVolatile()) {
462 // The load is the same as this load!
463 RetVals.push_back(BBI);
464 if (--NumLoads == 0) break; // Found all of the laods.
466 } else if (AA.getModRefInfo(BBI, LoadPtr, LoadSize)
467 & AliasAnalysis::Mod) {
468 // If there is a modifying instruction, nothing above it will value
477 // Handle candidate stores. If the loaded location is clobbered on entrance
478 // to the LoadBB, no store outside of the LoadBB can value number equal, so
480 if (LoadInvalidatedInBBBefore)
483 // Stores in the load-bb are handled above.
484 CandidateStores.erase(LoadBB);
486 for (std::set<BasicBlock*>::iterator I = CandidateStores.begin(),
487 E = CandidateStores.end(); I != E; ++I)
488 if (DT.dominates(*I, LoadBB)) {
489 BasicBlock *StoreBB = *I;
491 // Check to see if the path from the store to the load is transparent
492 // w.r.t. the memory location.
493 bool CantEqual = false;
494 std::set<BasicBlock*> Visited;
495 for (pred_iterator PI = pred_begin(LoadBB), E = pred_end(LoadBB);
497 if (!isPathTransparentTo(*PI, StoreBB, LoadPtr, LoadSize, AA,
498 Visited, TransparentBlocks)) {
499 // None of these stores can VN the same.
505 // Okay, the path from the store block to the load block is clear, and
506 // we know that there are no invalidating instructions from the start
507 // of the load block to the load itself. Now we just scan the store
510 BasicBlock::iterator BBI = StoreBB->end();
512 assert(BBI != StoreBB->begin() &&
513 "There is a store in this block of the pointer, but the store"
514 " doesn't mod the address being stored to?? Must be a bug in"
515 " the alias analysis implementation!");
517 if (AA.getModRefInfo(BBI, LoadPtr, LoadSize) & AliasAnalysis::Mod) {
518 // If the invalidating instruction is one of the candidates,
519 // then it provides the value the load loads.
520 if (StoreInst *SI = dyn_cast<StoreInst>(BBI))
521 if (SI->getOperand(1) == LoadPtr)
522 RetVals.push_back(SI->getOperand(0));