2007-07-06 23:14:35 +00:00
|
|
|
//===- llvm/Analysis/MemoryDependenceAnalysis.h - Memory Deps --*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2007-07-06 23:14:35 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2008-11-28 21:36:43 +00:00
|
|
|
// This file defines the MemoryDependenceAnalysis analysis pass.
|
2007-07-06 23:14:35 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_ANALYSIS_MEMORY_DEPENDENCE_H
|
|
|
|
#define LLVM_ANALYSIS_MEMORY_DEPENDENCE_H
|
|
|
|
|
2008-11-29 03:47:00 +00:00
|
|
|
#include "llvm/BasicBlock.h"
|
2007-07-06 23:14:35 +00:00
|
|
|
#include "llvm/Pass.h"
|
|
|
|
#include "llvm/ADT/DenseMap.h"
|
2007-07-24 21:52:37 +00:00
|
|
|
#include "llvm/ADT/SmallPtrSet.h"
|
2008-12-09 06:28:49 +00:00
|
|
|
#include "llvm/ADT/OwningPtr.h"
|
2008-11-29 01:43:36 +00:00
|
|
|
#include "llvm/ADT/PointerIntPair.h"
|
2007-07-06 23:14:35 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
2008-11-28 21:36:43 +00:00
|
|
|
class Function;
|
|
|
|
class FunctionPass;
|
|
|
|
class Instruction;
|
2008-11-28 21:47:19 +00:00
|
|
|
class CallSite;
|
2008-11-30 19:24:31 +00:00
|
|
|
class AliasAnalysis;
|
|
|
|
class TargetData;
|
2008-11-30 23:17:19 +00:00
|
|
|
class MemoryDependenceAnalysis;
|
2008-12-09 06:28:49 +00:00
|
|
|
class PredIteratorCache;
|
2008-11-29 02:29:27 +00:00
|
|
|
|
|
|
|
/// MemDepResult - A memory dependence query can return one of three different
|
2008-11-30 23:17:19 +00:00
|
|
|
/// answers, described below.
|
2008-11-29 02:29:27 +00:00
|
|
|
class MemDepResult {
|
|
|
|
enum DepType {
|
2008-11-30 23:17:19 +00:00
|
|
|
/// Invalid - Clients of MemDep never see this.
|
|
|
|
Invalid = 0,
|
2008-12-01 16:55:19 +00:00
|
|
|
|
2008-12-05 21:04:20 +00:00
|
|
|
/// Clobber - This is a dependence on the specified instruction which
|
|
|
|
/// clobbers the desired value. The pointer member of the MemDepResult
|
|
|
|
/// pair holds the instruction that clobbers the memory. For example,
|
|
|
|
/// this occurs when we see a may-aliased store to the memory location we
|
|
|
|
/// care about.
|
|
|
|
Clobber,
|
2008-11-30 23:17:19 +00:00
|
|
|
|
2008-12-05 21:04:20 +00:00
|
|
|
/// Def - This is a dependence on the specified instruction which
|
|
|
|
/// defines/produces the desired memory location. The pointer member of
|
|
|
|
/// the MemDepResult pair holds the instruction that defines the memory.
|
|
|
|
/// Cases of interest:
|
|
|
|
/// 1. This could be a load or store for dependence queries on
|
|
|
|
/// load/store. The value loaded or stored is the produced value.
|
|
|
|
/// Note that the pointer operand may be different than that of the
|
|
|
|
/// queried pointer due to must aliases and phi translation. Note
|
|
|
|
/// that the def may not be the same type as the query, the pointers
|
|
|
|
/// may just be must aliases.
|
|
|
|
/// 2. For loads and stores, this could be an allocation instruction. In
|
|
|
|
/// this case, the load is loading an undef value or a store is the
|
|
|
|
/// first store to (that part of) the allocation.
|
|
|
|
/// 3. Dependence queries on calls return Def only when they are
|
|
|
|
/// readonly calls with identical callees and no intervening
|
|
|
|
/// clobbers. No validation is done that the operands to the calls
|
|
|
|
/// are the same.
|
|
|
|
Def,
|
|
|
|
|
2008-11-30 23:17:19 +00:00
|
|
|
/// NonLocal - This marker indicates that the query has no dependency in
|
|
|
|
/// the specified block. To find out more, the client should query other
|
|
|
|
/// predecessor blocks.
|
2008-12-05 21:04:20 +00:00
|
|
|
NonLocal
|
2008-11-29 02:29:27 +00:00
|
|
|
};
|
|
|
|
typedef PointerIntPair<Instruction*, 2, DepType> PairTy;
|
|
|
|
PairTy Value;
|
|
|
|
explicit MemDepResult(PairTy V) : Value(V) {}
|
|
|
|
public:
|
|
|
|
MemDepResult() : Value(0, Invalid) {}
|
|
|
|
|
|
|
|
/// get methods: These are static ctor methods for creating various
|
|
|
|
/// MemDepResult kinds.
|
2008-12-05 21:04:20 +00:00
|
|
|
static MemDepResult getDef(Instruction *Inst) {
|
|
|
|
return MemDepResult(PairTy(Inst, Def));
|
|
|
|
}
|
|
|
|
static MemDepResult getClobber(Instruction *Inst) {
|
|
|
|
return MemDepResult(PairTy(Inst, Clobber));
|
2008-11-29 02:29:27 +00:00
|
|
|
}
|
|
|
|
static MemDepResult getNonLocal() {
|
|
|
|
return MemDepResult(PairTy(0, NonLocal));
|
|
|
|
}
|
|
|
|
|
2008-12-05 21:04:20 +00:00
|
|
|
/// isClobber - Return true if this MemDepResult represents a query that is
|
|
|
|
/// a instruction clobber dependency.
|
|
|
|
bool isClobber() const { return Value.getInt() == Clobber; }
|
|
|
|
|
|
|
|
/// isDef - Return true if this MemDepResult represents a query that is
|
|
|
|
/// a instruction definition dependency.
|
|
|
|
bool isDef() const { return Value.getInt() == Def; }
|
2008-11-29 02:29:27 +00:00
|
|
|
|
|
|
|
/// isNonLocal - Return true if this MemDepResult represents an query that
|
|
|
|
/// is transparent to the start of the block, but where a non-local hasn't
|
|
|
|
/// been done.
|
2008-11-29 21:22:42 +00:00
|
|
|
bool isNonLocal() const { return Value.getInt() == NonLocal; }
|
2008-11-29 02:29:27 +00:00
|
|
|
|
|
|
|
/// getInst() - If this is a normal dependency, return the instruction that
|
|
|
|
/// is depended on. Otherwise, return null.
|
2008-11-30 23:17:19 +00:00
|
|
|
Instruction *getInst() const { return Value.getPointer(); }
|
2008-11-29 02:29:27 +00:00
|
|
|
|
2008-12-01 01:15:42 +00:00
|
|
|
bool operator==(const MemDepResult &M) const { return M.Value == Value; }
|
|
|
|
bool operator!=(const MemDepResult &M) const { return M.Value != Value; }
|
|
|
|
bool operator<(const MemDepResult &M) const { return M.Value < Value; }
|
|
|
|
bool operator>(const MemDepResult &M) const { return M.Value > Value; }
|
2008-11-30 23:17:19 +00:00
|
|
|
private:
|
|
|
|
friend class MemoryDependenceAnalysis;
|
|
|
|
/// Dirty - Entries with this marker occur in a LocalDeps map or
|
|
|
|
/// NonLocalDeps map when the instruction they previously referenced was
|
|
|
|
/// removed from MemDep. In either case, the entry may include an
|
|
|
|
/// instruction pointer. If so, the pointer is an instruction in the
|
|
|
|
/// block where scanning can start from, saving some work.
|
|
|
|
///
|
2008-12-01 01:15:42 +00:00
|
|
|
/// In a default-constructed MemDepResult object, the type will be Dirty
|
2008-11-30 23:17:19 +00:00
|
|
|
/// and the instruction pointer will be null.
|
|
|
|
///
|
2008-12-01 01:15:42 +00:00
|
|
|
|
2008-11-30 23:17:19 +00:00
|
|
|
/// isDirty - Return true if this is a MemDepResult in its dirty/invalid.
|
|
|
|
/// state.
|
|
|
|
bool isDirty() const { return Value.getInt() == Invalid; }
|
2008-12-01 01:15:42 +00:00
|
|
|
|
2008-11-30 23:17:19 +00:00
|
|
|
static MemDepResult getDirty(Instruction *Inst) {
|
|
|
|
return MemDepResult(PairTy(Inst, Invalid));
|
|
|
|
}
|
2008-11-29 02:29:27 +00:00
|
|
|
};
|
2007-07-06 23:14:35 +00:00
|
|
|
|
2008-11-28 21:36:43 +00:00
|
|
|
/// MemoryDependenceAnalysis - This is an analysis that determines, for a
|
|
|
|
/// given memory operation, what preceding memory operations it depends on.
|
|
|
|
/// It builds on alias analysis information, and tries to provide a lazy,
|
|
|
|
/// caching interface to a common kind of alias information query.
|
2008-11-30 01:17:08 +00:00
|
|
|
///
|
|
|
|
/// The dependency information returned is somewhat unusual, but is pragmatic.
|
|
|
|
/// If queried about a store or call that might modify memory, the analysis
|
|
|
|
/// will return the instruction[s] that may either load from that memory or
|
|
|
|
/// store to it. If queried with a load or call that can never modify memory,
|
|
|
|
/// the analysis will return calls and stores that might modify the pointer,
|
|
|
|
/// but generally does not return loads unless a) they are volatile, or
|
|
|
|
/// b) they load from *must-aliased* pointers. Returning a dependence on
|
|
|
|
/// must-alias'd pointers instead of all pointers interacts well with the
|
|
|
|
/// internal caching mechanism.
|
|
|
|
///
|
2008-11-28 21:36:43 +00:00
|
|
|
class MemoryDependenceAnalysis : public FunctionPass {
|
2008-11-29 03:22:12 +00:00
|
|
|
// A map from instructions to their dependency.
|
2008-11-30 23:17:19 +00:00
|
|
|
typedef DenseMap<Instruction*, MemDepResult> LocalDepMapType;
|
2008-11-29 01:43:36 +00:00
|
|
|
LocalDepMapType LocalDeps;
|
2007-07-31 20:01:27 +00:00
|
|
|
|
2008-12-01 01:15:42 +00:00
|
|
|
public:
|
|
|
|
typedef std::pair<BasicBlock*, MemDepResult> NonLocalDepEntry;
|
|
|
|
typedef std::vector<NonLocalDepEntry> NonLocalDepInfo;
|
|
|
|
private:
|
2008-12-07 08:50:20 +00:00
|
|
|
/// ValueIsLoadPair - This is a pair<Value*, bool> where the bool is true if
|
|
|
|
/// the dependence is a read only dependence, false if read/write.
|
2008-12-07 21:33:27 +00:00
|
|
|
typedef PointerIntPair<Value*, 1, bool> ValueIsLoadPair;
|
2008-12-07 08:50:20 +00:00
|
|
|
|
|
|
|
/// CachedNonLocalPointerInfo - This map stores the cached results of doing
|
2008-12-07 18:21:37 +00:00
|
|
|
/// a pointer lookup at the bottom of a block. The key of this map is the
|
2008-12-07 08:50:20 +00:00
|
|
|
/// pointer+isload bit, the value is a list of <bb->result> mappings.
|
2008-12-08 07:31:50 +00:00
|
|
|
typedef DenseMap<ValueIsLoadPair,
|
|
|
|
std::pair<BasicBlock*, NonLocalDepInfo> > CachedNonLocalPointerInfo;
|
2008-12-07 08:50:20 +00:00
|
|
|
CachedNonLocalPointerInfo NonLocalPointerDeps;
|
|
|
|
|
|
|
|
// A map from instructions to their non-local pointer dependencies.
|
|
|
|
// The elements of the SmallPtrSet are ValueIsLoadPair's.
|
|
|
|
typedef DenseMap<Instruction*,
|
|
|
|
SmallPtrSet<void*, 4> > ReverseNonLocalPtrDepTy;
|
|
|
|
ReverseNonLocalPtrDepTy ReverseNonLocalPtrDeps;
|
|
|
|
|
|
|
|
|
2008-11-30 02:52:26 +00:00
|
|
|
/// PerInstNLInfo - This is the instruction we keep for each cached access
|
|
|
|
/// that we have for an instruction. The pointer is an owning pointer and
|
|
|
|
/// the bool indicates whether we have any dirty bits in the set.
|
2008-12-01 01:15:42 +00:00
|
|
|
typedef std::pair<NonLocalDepInfo, bool> PerInstNLInfo;
|
2008-11-30 02:30:50 +00:00
|
|
|
|
2007-08-16 21:27:05 +00:00
|
|
|
// A map from instructions to their non-local dependencies.
|
2008-11-30 02:52:26 +00:00
|
|
|
typedef DenseMap<Instruction*, PerInstNLInfo> NonLocalDepMapType;
|
|
|
|
|
2008-11-29 09:20:15 +00:00
|
|
|
NonLocalDepMapType NonLocalDeps;
|
2007-08-16 21:27:05 +00:00
|
|
|
|
2008-11-28 22:41:36 +00:00
|
|
|
// A reverse mapping from dependencies to the dependees. This is
|
2007-08-08 21:53:20 +00:00
|
|
|
// used when removing instructions to keep the cache coherent.
|
2008-11-29 03:22:12 +00:00
|
|
|
typedef DenseMap<Instruction*,
|
2008-11-29 09:20:15 +00:00
|
|
|
SmallPtrSet<Instruction*, 4> > ReverseDepMapType;
|
|
|
|
ReverseDepMapType ReverseLocalDeps;
|
2007-07-06 23:14:35 +00:00
|
|
|
|
2007-08-16 21:27:05 +00:00
|
|
|
// A reverse mapping form dependencies to the non-local dependees.
|
2008-11-29 09:20:15 +00:00
|
|
|
ReverseDepMapType ReverseNonLocalDeps;
|
2007-08-16 21:27:05 +00:00
|
|
|
|
2008-11-30 19:24:31 +00:00
|
|
|
/// Current AA implementation, just a cache.
|
|
|
|
AliasAnalysis *AA;
|
|
|
|
TargetData *TD;
|
2008-12-09 06:28:49 +00:00
|
|
|
OwningPtr<PredIteratorCache> PredCache;
|
2007-08-08 21:53:20 +00:00
|
|
|
public:
|
2008-12-09 06:28:49 +00:00
|
|
|
MemoryDependenceAnalysis();
|
|
|
|
~MemoryDependenceAnalysis();
|
2008-11-29 01:43:36 +00:00
|
|
|
static char ID;
|
2008-03-18 00:39:19 +00:00
|
|
|
|
2008-11-30 19:24:31 +00:00
|
|
|
/// Pass Implementation stuff. This doesn't do any analysis eagerly.
|
|
|
|
bool runOnFunction(Function &);
|
2007-07-10 17:08:11 +00:00
|
|
|
|
|
|
|
/// Clean up memory in between runs
|
2008-12-09 06:28:49 +00:00
|
|
|
void releaseMemory();
|
|
|
|
|
2007-07-06 23:14:35 +00:00
|
|
|
/// getAnalysisUsage - Does not modify anything. It uses Value Numbering
|
|
|
|
/// and Alias Analysis.
|
|
|
|
///
|
|
|
|
virtual void getAnalysisUsage(AnalysisUsage &AU) const;
|
|
|
|
|
|
|
|
/// getDependency - Return the instruction on which a memory operation
|
2008-12-05 18:46:19 +00:00
|
|
|
/// depends. See the class comment for more details. It is illegal to call
|
|
|
|
/// this on non-memory instructions.
|
2008-11-29 03:47:00 +00:00
|
|
|
MemDepResult getDependency(Instruction *QueryInst);
|
|
|
|
|
2008-11-29 21:22:42 +00:00
|
|
|
/// getNonLocalDependency - Perform a full dependency query for the
|
|
|
|
/// specified instruction, returning the set of blocks that the value is
|
|
|
|
/// potentially live across. The returned set of results will include a
|
|
|
|
/// "NonLocal" result for all blocks where the value is live across.
|
|
|
|
///
|
2008-12-01 01:15:42 +00:00
|
|
|
/// This method assumes the instruction returns a "NonLocal" dependency
|
2008-11-29 21:22:42 +00:00
|
|
|
/// within its own block.
|
2008-12-01 01:15:42 +00:00
|
|
|
///
|
|
|
|
/// This returns a reference to an internal data structure that may be
|
|
|
|
/// invalidated on the next non-local query or when an instruction is
|
|
|
|
/// removed. Clients must copy this data if they want it around longer than
|
|
|
|
/// that.
|
|
|
|
const NonLocalDepInfo &getNonLocalDependency(Instruction *QueryInst);
|
2007-07-06 23:14:35 +00:00
|
|
|
|
2008-12-07 02:15:47 +00:00
|
|
|
|
|
|
|
/// getNonLocalPointerDependency - Perform a full dependency query for an
|
|
|
|
/// access to the specified (non-volatile) memory location, returning the
|
|
|
|
/// set of instructions that either define or clobber the value.
|
|
|
|
///
|
2008-12-07 02:56:57 +00:00
|
|
|
/// This method assumes the pointer has a "NonLocal" dependency within BB.
|
2008-12-07 02:15:47 +00:00
|
|
|
void getNonLocalPointerDependency(Value *Pointer, bool isLoad,
|
|
|
|
BasicBlock *BB,
|
|
|
|
SmallVectorImpl<NonLocalDepEntry> &Result);
|
|
|
|
|
2007-07-06 23:14:35 +00:00
|
|
|
/// removeInstruction - Remove an instruction from the dependence analysis,
|
|
|
|
/// updating the dependence of instructions that previously depended on it.
|
2008-11-29 01:43:36 +00:00
|
|
|
void removeInstruction(Instruction *InstToRemove);
|
2007-08-08 21:53:20 +00:00
|
|
|
|
|
|
|
private:
|
2008-12-07 01:50:16 +00:00
|
|
|
MemDepResult getPointerDependencyFrom(Value *Pointer, uint64_t MemSize,
|
|
|
|
bool isLoad,
|
|
|
|
BasicBlock::iterator ScanIt,
|
|
|
|
BasicBlock *BB);
|
2008-12-07 00:35:51 +00:00
|
|
|
MemDepResult getCallSiteDependencyFrom(CallSite C,
|
|
|
|
BasicBlock::iterator ScanIt,
|
|
|
|
BasicBlock *BB);
|
2008-12-09 07:47:11 +00:00
|
|
|
void getNonLocalPointerDepFromBB(Value *Pointer, uint64_t Size,
|
|
|
|
bool isLoad, BasicBlock *BB,
|
|
|
|
SmallVectorImpl<NonLocalDepEntry> &Result,
|
|
|
|
SmallPtrSet<BasicBlock*, 64> &Visited);
|
|
|
|
MemDepResult GetNonLocalInfoForBlock(Value *Pointer, uint64_t PointeeSize,
|
|
|
|
bool isLoad, BasicBlock *BB,
|
|
|
|
NonLocalDepInfo *Cache,
|
|
|
|
unsigned NumSortedEntries);
|
|
|
|
|
|
|
|
|
2008-12-07 08:50:20 +00:00
|
|
|
void RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P);
|
2008-12-07 02:56:57 +00:00
|
|
|
|
2008-11-28 21:42:09 +00:00
|
|
|
/// verifyRemoved - Verify that the specified instruction does not occur
|
|
|
|
/// in our internal data structures.
|
|
|
|
void verifyRemoved(Instruction *Inst) const;
|
|
|
|
|
2007-07-06 23:14:35 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // End llvm namespace
|
|
|
|
|
|
|
|
#endif
|