2002-11-06 17:02:03 +00:00
|
|
|
//===- IPModRef.h - Compute IP Mod/Ref information --------------*- C++ -*-===//
|
2003-10-20 20:19:47 +00:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file was developed by the LLVM research group and is distributed under
|
|
|
|
// the University of Illinois Open Source License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
2002-11-06 17:02:03 +00:00
|
|
|
//
|
|
|
|
// class IPModRef:
|
|
|
|
//
|
|
|
|
// class IPModRef is an interprocedural analysis pass that computes
|
|
|
|
// flow-insensitive IP Mod and Ref information for every function
|
|
|
|
// (the GMOD and GREF problems) and for every call site (MOD and REF).
|
|
|
|
//
|
|
|
|
// In practice, this needs to do NO real interprocedural work because
|
|
|
|
// all that is needed is done by the data structure analysis.
|
|
|
|
// This uses the top-down DS graph for a function and the bottom-up DS graph
|
|
|
|
// for each callee (including the Mod/Ref flags in the bottom-up graph)
|
|
|
|
// to compute the set of nodes that are Mod and Ref for the function and
|
|
|
|
// for each of its call sites.
|
|
|
|
//
|
|
|
|
//
|
|
|
|
// class FunctionModRefInfo:
|
|
|
|
//
|
|
|
|
// The results of IPModRef are encapsulated in the class FunctionModRefInfo.
|
|
|
|
// The results are stored as bit vectors: bit i represents node i
|
|
|
|
// in the TD DSGraph for the current function. (This node numbering is
|
|
|
|
// implemented by class FunctionModRefInfo.) Each FunctionModRefInfo
|
|
|
|
// includes:
|
|
|
|
// -- 2 bit vectors for the function (GMOD and GREF), and
|
|
|
|
// -- 2 bit vectors for each call site (MOD and REF).
|
|
|
|
//
|
|
|
|
//
|
|
|
|
// IPModRef vs. Alias Analysis for Clients:
|
|
|
|
//
|
|
|
|
// The IPModRef pass does not provide simpler query interfaces for specific
|
|
|
|
// LLVM values, instructions, or pointers because those results should be
|
|
|
|
// obtained through alias analysis (e.g., class DSAliasAnalysis).
|
|
|
|
// class IPModRef is primarily meant for other analysis passes that need to
|
|
|
|
// use Mod/Ref information efficiently for more complicated purposes;
|
|
|
|
// the bit-vector representations make propagation very efficient.
|
2002-11-06 18:38:10 +00:00
|
|
|
//
|
2002-11-06 17:02:03 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_ANALYSIS_IPMODREF_H
|
|
|
|
#define LLVM_ANALYSIS_IPMODREF_H
|
|
|
|
|
|
|
|
#include "llvm/Pass.h"
|
|
|
|
#include "Support/BitSetVector.h"
|
2003-02-01 04:52:08 +00:00
|
|
|
#include "Support/hash_map"
|
2002-11-06 17:02:03 +00:00
|
|
|
|
|
|
|
class Module;
|
|
|
|
class Function;
|
2003-09-20 16:34:13 +00:00
|
|
|
class CallSite;
|
|
|
|
class Instruction;
|
2002-11-06 17:02:03 +00:00
|
|
|
class CallInst;
|
2003-09-20 16:34:13 +00:00
|
|
|
class InvokeInst;
|
2002-11-06 18:38:10 +00:00
|
|
|
class DSNode;
|
2002-11-06 17:02:03 +00:00
|
|
|
class DSGraph;
|
2002-11-06 19:59:33 +00:00
|
|
|
class DSNodeHandle;
|
2002-11-06 17:02:03 +00:00
|
|
|
class ModRefInfo; // Result of IP Mod/Ref for one entity
|
|
|
|
class FunctionModRefInfo; // ModRefInfo for a func and all calls in it
|
|
|
|
class IPModRef; // Pass that computes IP Mod/Ref info
|
|
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
// class ModRefInfo
|
|
|
|
//
|
|
|
|
// Purpose:
|
|
|
|
// Representation of Mod/Ref information for a single function or callsite.
|
|
|
|
// This is represented as a pair of bit vectors, one each for Mod and Ref.
|
|
|
|
// Each bit vector is indexed by the node id of the DS graph node index.
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class ModRefInfo {
|
|
|
|
BitSetVector modNodeSet; // set of modified nodes
|
|
|
|
BitSetVector refNodeSet; // set of referenced nodes
|
2002-11-06 18:38:10 +00:00
|
|
|
|
2002-11-06 17:02:03 +00:00
|
|
|
public:
|
|
|
|
//
|
|
|
|
// Methods to construct ModRefInfo objects.
|
|
|
|
//
|
|
|
|
ModRefInfo(unsigned int numNodes)
|
|
|
|
: modNodeSet(numNodes),
|
|
|
|
refNodeSet(numNodes) { }
|
|
|
|
|
2002-11-06 18:38:10 +00:00
|
|
|
unsigned getSize() const {
|
|
|
|
assert(modNodeSet.size() == refNodeSet.size() &&
|
|
|
|
"Mod & Ref different size?");
|
|
|
|
return modNodeSet.size();
|
|
|
|
}
|
|
|
|
|
2002-11-06 17:02:03 +00:00
|
|
|
void setNodeIsMod (unsigned nodeId) { modNodeSet[nodeId] = true; }
|
|
|
|
void setNodeIsRef (unsigned nodeId) { refNodeSet[nodeId] = true; }
|
|
|
|
|
|
|
|
//
|
|
|
|
// Methods to query the mod/ref info
|
|
|
|
//
|
|
|
|
bool nodeIsMod (unsigned nodeId) const { return modNodeSet.test(nodeId); }
|
|
|
|
bool nodeIsRef (unsigned nodeId) const { return refNodeSet.test(nodeId); }
|
|
|
|
bool nodeIsKill(unsigned nodeId) const { return false; }
|
|
|
|
|
|
|
|
const BitSetVector& getModSet() const { return modNodeSet; }
|
|
|
|
BitSetVector& getModSet() { return modNodeSet; }
|
|
|
|
|
|
|
|
const BitSetVector& getRefSet() const { return refNodeSet; }
|
|
|
|
BitSetVector& getRefSet() { return refNodeSet; }
|
|
|
|
|
|
|
|
// Debugging support methods
|
2002-11-27 17:38:56 +00:00
|
|
|
void print(std::ostream &O, const std::string& prefix=std::string("")) const;
|
2002-11-06 17:02:03 +00:00
|
|
|
void dump() const;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
//----------------------------------------------------------------------------
|
|
|
|
// class FunctionModRefInfo
|
|
|
|
//
|
|
|
|
// Representation of the results of IP Mod/Ref analysis for a function
|
|
|
|
// and for each of the call sites within the function.
|
|
|
|
// Each of these are represented as bit vectors of size = the number of
|
|
|
|
// nodes in the top-dwon DS graph of the function. Nodes are identified by
|
|
|
|
// their nodeId, in the range [0 .. funcTDGraph.size()-1].
|
|
|
|
//----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class FunctionModRefInfo {
|
|
|
|
const Function& F; // The function
|
2002-11-06 19:07:13 +00:00
|
|
|
IPModRef& IPModRefObj; // The IPModRef Object owning this
|
2002-11-27 17:38:56 +00:00
|
|
|
DSGraph* funcTDGraph; // Top-down DS graph for function
|
2002-11-06 17:02:03 +00:00
|
|
|
ModRefInfo funcModRefInfo; // ModRefInfo for the function body
|
2003-09-20 16:34:13 +00:00
|
|
|
std::map<const Instruction*, ModRefInfo*>
|
2002-11-06 17:02:03 +00:00
|
|
|
callSiteModRefInfo; // ModRefInfo for each callsite
|
|
|
|
std::map<const DSNode*, unsigned> NodeIds;
|
|
|
|
|
|
|
|
friend class IPModRef;
|
|
|
|
|
|
|
|
void computeModRef (const Function &func);
|
2003-09-20 16:34:13 +00:00
|
|
|
void computeModRef (CallSite call);
|
|
|
|
DSGraph *ResolveCallSiteModRefInfo(CallSite CS,
|
2003-02-01 04:52:08 +00:00
|
|
|
hash_map<const DSNode*, DSNodeHandle> &NodeMap);
|
2002-11-06 17:02:03 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
/* ctor */ FunctionModRefInfo (const Function& func,
|
2002-11-27 17:38:56 +00:00
|
|
|
IPModRef& IPModRefObj,
|
|
|
|
DSGraph* tdgClone);
|
2002-11-06 17:02:03 +00:00
|
|
|
/* dtor */ ~FunctionModRefInfo ();
|
|
|
|
|
|
|
|
// Identify the function and its relevant DS graph
|
|
|
|
//
|
|
|
|
const Function& getFunction() const { return F; }
|
2002-11-27 17:38:56 +00:00
|
|
|
const DSGraph& getFuncGraph() const { return *funcTDGraph; }
|
2002-11-06 17:02:03 +00:00
|
|
|
|
|
|
|
// Retrieve Mod/Ref results for a single call site and for the function body
|
|
|
|
//
|
|
|
|
const ModRefInfo* getModRefInfo (const Function& func) const {
|
|
|
|
return &funcModRefInfo;
|
|
|
|
}
|
|
|
|
const ModRefInfo* getModRefInfo (const CallInst& callInst) const {
|
2003-09-20 16:34:13 +00:00
|
|
|
std::map<const Instruction*, ModRefInfo*>::const_iterator I =
|
|
|
|
callSiteModRefInfo.find((Instruction*)&callInst);
|
|
|
|
return (I == callSiteModRefInfo.end()) ? NULL : I->second;
|
|
|
|
}
|
|
|
|
const ModRefInfo* getModRefInfo (const InvokeInst& II) const {
|
|
|
|
std::map<const Instruction*, ModRefInfo*>::const_iterator I =
|
|
|
|
callSiteModRefInfo.find((Instruction*)&II);
|
|
|
|
return (I == callSiteModRefInfo.end()) ? NULL : I->second;
|
2002-11-06 17:02:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Get the nodeIds used to index all Mod/Ref information for current function
|
|
|
|
//
|
|
|
|
unsigned getNodeId (const DSNode* node) const {
|
|
|
|
std::map<const DSNode*, unsigned>::const_iterator iter = NodeIds.find(node);
|
2002-12-06 21:19:07 +00:00
|
|
|
assert(iter != NodeIds.end() && iter->second < funcModRefInfo.getSize());
|
|
|
|
return iter->second;
|
2002-11-06 17:02:03 +00:00
|
|
|
}
|
|
|
|
|
2002-11-06 18:38:10 +00:00
|
|
|
unsigned getNodeId (const Value* value) const;
|
|
|
|
|
2002-11-06 17:02:03 +00:00
|
|
|
// Debugging support methods
|
|
|
|
void print(std::ostream &O) const;
|
|
|
|
void dump() const;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
//----------------------------------------------------------------------------
|
|
|
|
// class IPModRef
|
|
|
|
//
|
|
|
|
// Purpose:
|
|
|
|
// An interprocedural pass that computes IP Mod/Ref info for functions and
|
|
|
|
// for individual call sites.
|
|
|
|
//
|
|
|
|
// Given the DSGraph of a function, this class can be queried for
|
|
|
|
// a ModRefInfo object describing all the nodes in the DSGraph that are
|
|
|
|
// (a) modified, and (b) referenced during an execution of the function
|
|
|
|
// from an arbitrary callsite, or during an execution of a single call-site
|
|
|
|
// within the function.
|
|
|
|
//----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class IPModRef : public Pass {
|
|
|
|
std::map<const Function*, FunctionModRefInfo*> funcToModRefInfoMap;
|
|
|
|
Module* M;
|
|
|
|
|
|
|
|
FunctionModRefInfo& getFuncInfo(const Function& func,
|
2002-11-06 18:38:10 +00:00
|
|
|
bool computeIfMissing = false);
|
2002-11-06 17:02:03 +00:00
|
|
|
public:
|
|
|
|
IPModRef() : M(NULL) { }
|
|
|
|
~IPModRef() { }
|
|
|
|
|
|
|
|
// Driver function to run IP Mod/Ref on a Module.
|
|
|
|
// This initializes the module reference, and then computes IPModRef
|
|
|
|
// results immediately if demand-driven analysis was *not* specified.
|
|
|
|
//
|
|
|
|
virtual bool run(Module &M);
|
|
|
|
|
|
|
|
// Retrieve the Mod/Ref information for a single function
|
|
|
|
//
|
|
|
|
const FunctionModRefInfo& getFunctionModRefInfo(const Function& func) {
|
|
|
|
return getFuncInfo(func);
|
|
|
|
}
|
|
|
|
|
2002-11-07 07:11:49 +00:00
|
|
|
/// getBUDSGraph - This method returns the BU data structure graph for F
|
|
|
|
/// through the use of the BUDataStructures object.
|
|
|
|
///
|
|
|
|
const DSGraph &getBUDSGraph(const Function &F);
|
|
|
|
|
2002-11-06 17:02:03 +00:00
|
|
|
// Debugging support methods
|
|
|
|
//
|
|
|
|
void print(std::ostream &O) const;
|
|
|
|
void dump() const;
|
|
|
|
|
|
|
|
// Release memory held by this pass when the pass pipeline is done
|
|
|
|
//
|
|
|
|
virtual void releaseMemory();
|
|
|
|
|
|
|
|
// getAnalysisUsage - This pass requires top-down data structure graphs.
|
|
|
|
// It modifies nothing.
|
|
|
|
//
|
2002-11-06 18:38:10 +00:00
|
|
|
virtual void getAnalysisUsage(AnalysisUsage &AU) const;
|
2002-11-06 17:02:03 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#endif
|