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-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-29 02:29:27 +00:00
|
|
|
|
|
|
|
/// MemDepResult - A memory dependence query can return one of three different
|
|
|
|
/// answers:
|
|
|
|
/// Normal : The query is dependent on a specific instruction.
|
|
|
|
/// NonLocal: The query does not depend on anything inside this block, but
|
|
|
|
/// we haven't scanned beyond the block to find out what.
|
|
|
|
/// None : The query does not depend on anything: we found the entry
|
|
|
|
/// block or the allocation site of the memory.
|
|
|
|
class MemDepResult {
|
|
|
|
enum DepType {
|
|
|
|
Invalid = 0, Normal, NonLocal, None
|
|
|
|
};
|
|
|
|
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.
|
|
|
|
static MemDepResult get(Instruction *Inst) {
|
|
|
|
return MemDepResult(PairTy(Inst, Normal));
|
|
|
|
}
|
|
|
|
static MemDepResult getNonLocal() {
|
|
|
|
return MemDepResult(PairTy(0, NonLocal));
|
|
|
|
}
|
|
|
|
static MemDepResult getNone() {
|
|
|
|
return MemDepResult(PairTy(0, None));
|
|
|
|
}
|
|
|
|
|
|
|
|
/// isNormal - Return true if this MemDepResult represents a query that is
|
|
|
|
/// a normal instruction dependency.
|
|
|
|
bool isNormal() const { return Value.getInt() == Normal; }
|
|
|
|
|
|
|
|
/// 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.
|
|
|
|
bool isNonLocal() const { return Value.getInt() == NonLocal; }
|
|
|
|
|
|
|
|
/// isNone - Return true if this MemDepResult represents a query that
|
|
|
|
/// doesn't depend on any instruction.
|
|
|
|
bool isNone() const { return Value.getInt() == None; }
|
|
|
|
|
|
|
|
/// getInst() - If this is a normal dependency, return the instruction that
|
|
|
|
/// is depended on. Otherwise, return null.
|
|
|
|
Instruction *getInst() const { return isNormal() ? Value.getPointer() : 0; }
|
|
|
|
|
|
|
|
bool operator==(const MemDepResult &M) { return M.Value == Value; }
|
|
|
|
bool operator!=(const MemDepResult &M) { return M.Value != Value; }
|
|
|
|
};
|
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.
|
|
|
|
class MemoryDependenceAnalysis : public FunctionPass {
|
2008-11-29 01:43:36 +00:00
|
|
|
/// DepType - This enum is used to indicate what flavor of dependence this
|
|
|
|
/// is. If the type is Normal, there is an associated instruction pointer.
|
|
|
|
enum DepType {
|
2008-11-29 03:22:12 +00:00
|
|
|
/// Dirty - Entries with this marker may come in two forms, depending on
|
|
|
|
/// whether they are in a LocalDeps map or NonLocalDeps map. In either
|
|
|
|
/// case, this marker indicates that the cached value has been invalidated
|
|
|
|
/// by a removeInstruction call.
|
|
|
|
///
|
|
|
|
/// If in the LocalDeps map, the Instruction field will indicate the place
|
|
|
|
/// in the current block to start scanning. If in the non-localdeps map,
|
|
|
|
/// the instruction will be null.
|
|
|
|
///
|
|
|
|
/// In a default-constructed DepResultTy object, the type will be Dirty
|
|
|
|
/// and the instruction pointer will be null.
|
|
|
|
///
|
|
|
|
/// FIXME: Why not add a scanning point for the non-local deps map???
|
|
|
|
Dirty = 0,
|
|
|
|
|
2008-11-29 01:43:36 +00:00
|
|
|
/// Normal - This is a normal instruction dependence. The pointer member
|
|
|
|
/// of the DepResultTy pair holds the instruction.
|
2008-11-29 03:22:12 +00:00
|
|
|
Normal,
|
2008-11-29 01:43:36 +00:00
|
|
|
|
|
|
|
/// None - This dependence type indicates that the query does not depend
|
|
|
|
/// on any instructions, either because it scanned to the start of the
|
|
|
|
/// function or it scanned to the definition of the memory
|
|
|
|
/// (alloca/malloc).
|
|
|
|
None,
|
|
|
|
|
|
|
|
/// 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-11-29 03:22:12 +00:00
|
|
|
NonLocal
|
2008-11-29 01:43:36 +00:00
|
|
|
};
|
|
|
|
typedef PointerIntPair<Instruction*, 2, DepType> DepResultTy;
|
2008-11-29 02:29:27 +00:00
|
|
|
|
2008-11-29 03:22:12 +00:00
|
|
|
// A map from instructions to their dependency.
|
|
|
|
typedef DenseMap<Instruction*, DepResultTy> LocalDepMapType;
|
2008-11-29 01:43:36 +00:00
|
|
|
LocalDepMapType LocalDeps;
|
2007-07-31 20:01:27 +00:00
|
|
|
|
2007-08-16 21:27:05 +00:00
|
|
|
// A map from instructions to their non-local dependencies.
|
2008-11-29 02:29:27 +00:00
|
|
|
// FIXME: DENSEMAP of DENSEMAP not a great idea.
|
2008-11-28 22:41:36 +00:00
|
|
|
typedef DenseMap<Instruction*,
|
2008-11-29 09:20:15 +00:00
|
|
|
DenseMap<BasicBlock*, DepResultTy> > NonLocalDepMapType;
|
|
|
|
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
|
|
|
|
2007-08-08 21:53:20 +00:00
|
|
|
public:
|
2008-09-04 17:05:41 +00:00
|
|
|
MemoryDependenceAnalysis() : FunctionPass(&ID) {}
|
2008-11-29 01:43:36 +00:00
|
|
|
static char ID;
|
2008-03-18 00:39:19 +00:00
|
|
|
|
2007-07-06 23:14:35 +00:00
|
|
|
/// Pass Implementation stuff. This doesn't do any analysis.
|
|
|
|
///
|
2007-07-10 17:08:11 +00:00
|
|
|
bool runOnFunction(Function &) {return false; }
|
|
|
|
|
|
|
|
/// Clean up memory in between runs
|
|
|
|
void releaseMemory() {
|
2008-11-29 01:43:36 +00:00
|
|
|
LocalDeps.clear();
|
2008-11-29 09:20:15 +00:00
|
|
|
NonLocalDeps.clear();
|
|
|
|
ReverseLocalDeps.clear();
|
|
|
|
ReverseNonLocalDeps.clear();
|
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-11-29 03:47:00 +00:00
|
|
|
/// depends.
|
|
|
|
MemDepResult getDependency(Instruction *QueryInst);
|
|
|
|
|
|
|
|
/// getDependencyFrom - Return the instruction on which the memory operation
|
|
|
|
/// 'QueryInst' depends. This starts scanning from the instruction before
|
|
|
|
/// the position indicated by ScanIt.
|
|
|
|
MemDepResult getDependencyFrom(Instruction *QueryInst,
|
|
|
|
BasicBlock::iterator ScanIt, BasicBlock *BB);
|
|
|
|
|
2007-07-24 21:52:37 +00:00
|
|
|
|
2007-08-08 21:54:33 +00:00
|
|
|
/// getNonLocalDependency - Fills the passed-in map with the non-local
|
|
|
|
/// dependencies of the queries. The map will contain NonLocal for
|
|
|
|
/// blocks between the query and its dependencies.
|
2008-11-29 09:22:14 +00:00
|
|
|
void getNonLocalDependency(Instruction *QueryInst,
|
|
|
|
DenseMap<BasicBlock*, MemDepResult> &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
|
|
|
|
2008-02-12 21:15:18 +00:00
|
|
|
/// dropInstruction - Remove an instruction from the analysis, making
|
|
|
|
/// absolutely conservative assumptions when updating the cache. This is
|
|
|
|
/// useful, for example when an instruction is changed rather than removed.
|
2008-11-29 01:43:36 +00:00
|
|
|
void dropInstruction(Instruction *InstToDrop);
|
2008-02-12 21:15:18 +00:00
|
|
|
|
2007-08-08 21:53:20 +00:00
|
|
|
private:
|
2008-11-29 02:29:27 +00:00
|
|
|
DepResultTy ConvFromResult(MemDepResult R) {
|
|
|
|
if (Instruction *I = R.getInst())
|
|
|
|
return DepResultTy(I, Normal);
|
|
|
|
if (R.isNonLocal())
|
|
|
|
return DepResultTy(0, NonLocal);
|
|
|
|
assert(R.isNone() && "Unknown MemDepResult!");
|
|
|
|
return DepResultTy(0, None);
|
|
|
|
}
|
|
|
|
|
|
|
|
MemDepResult ConvToResult(DepResultTy R) {
|
|
|
|
if (R.getInt() == Normal)
|
|
|
|
return MemDepResult::get(R.getPointer());
|
|
|
|
if (R.getInt() == NonLocal)
|
|
|
|
return MemDepResult::getNonLocal();
|
|
|
|
assert(R.getInt() == None && "Unknown MemDepResult!");
|
|
|
|
return MemDepResult::getNone();
|
|
|
|
}
|
|
|
|
|
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;
|
|
|
|
|
2008-11-29 03:47:00 +00:00
|
|
|
MemDepResult getCallSiteDependency(CallSite C, BasicBlock::iterator ScanIt,
|
|
|
|
BasicBlock *BB);
|
2008-11-29 09:22:14 +00:00
|
|
|
void nonLocalHelper(Instruction *Query, BasicBlock *BB,
|
|
|
|
DenseMap<BasicBlock*, DepResultTy> &Result);
|
2007-07-06 23:14:35 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // End llvm namespace
|
|
|
|
|
|
|
|
#endif
|