llvm-6502/include/llvm/Analysis/DataStructure.h
2002-10-22 15:58:23 +00:00

187 lines
6.5 KiB
C++

//===- DataStructure.h - Build data structure graphs ------------*- C++ -*-===//
//
// Implement the LLVM data structure analysis library.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_ANALYSIS_DATA_STRUCTURE_H
#define LLVM_ANALYSIS_DATA_STRUCTURE_H
#include "llvm/Pass.h"
class Type;
class DSGraph;
class DSNode;
class DSNodeHandle;
class DSCallSite;
class LocalDataStructures; // A collection of local graphs for a program
class BUDataStructures; // A collection of bu graphs for a program
class TDDataStructures; // A collection of td graphs for a program
// FIXME: move this stuff to a private header
namespace DataStructureAnalysis {
// isPointerType - Return true if this first class type is big enough to hold
// a pointer.
//
bool isPointerType(const Type *Ty);
}
// LocalDataStructures - The analysis that computes the local data structure
// graphs for all of the functions in the program.
//
// FIXME: This should be a Function pass that can be USED by a Pass, and would
// be automatically preserved. Until we can do that, this is a Pass.
//
class LocalDataStructures : public Pass {
// DSInfo, one graph for each function
std::map<const Function*, DSGraph*> DSInfo;
public:
~LocalDataStructures() { releaseMemory(); }
virtual bool run(Module &M);
// getDSGraph - Return the data structure graph for the specified function.
DSGraph &getDSGraph(const Function &F) const {
std::map<const Function*, DSGraph*>::const_iterator I = DSInfo.find(&F);
assert(I != DSInfo.end() && "Function not in module!");
return *I->second;
}
// print - Print out the analysis results...
void print(std::ostream &O, const Module *M) const;
// If the pass pipeline is done with this pass, we can release our memory...
virtual void releaseMemory();
// getAnalysisUsage - This obviously provides a data structure graph.
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
}
};
// BUDataStructures - The analysis that computes the interprocedurally closed
// data structure graphs for all of the functions in the program. This pass
// only performs a "Bottom Up" propogation (hence the name).
//
class BUDataStructures : public Pass {
// DSInfo, one graph for each function
std::map<const Function*, DSGraph*> DSInfo;
std::map<const Function*, std::vector<DSCallSite> > CallSites;
public:
~BUDataStructures() { releaseMemory(); }
virtual bool run(Module &M);
// getDSGraph - Return the data structure graph for the specified function.
DSGraph &getDSGraph(const Function &F) const {
std::map<const Function*, DSGraph*>::const_iterator I = DSInfo.find(&F);
assert(I != DSInfo.end() && "Function not in module!");
return *I->second;
}
const std::vector<DSCallSite> *getCallSites(const Function &F) const {
std::map<const Function*, std::vector<DSCallSite> >::const_iterator I
= CallSites.find(&F);
return I != CallSites.end() ? &I->second : 0;
}
// print - Print out the analysis results...
void print(std::ostream &O, const Module *M) const;
// If the pass pipeline is done with this pass, we can release our memory...
virtual void releaseMemory();
// getAnalysisUsage - This obviously provides a data structure graph.
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequired<LocalDataStructures>();
}
private:
DSGraph &calculateGraph(Function &F);
};
// TDDataStructures - Analysis that computes new data structure graphs
// for each function using the closed graphs for the callers computed
// by the bottom-up pass.
//
class TDDataStructures : public Pass {
// DSInfo, one graph for each function
std::map<const Function*, DSGraph*> DSInfo;
// Each graph in DSInfo is based on a graph in the BUDS object. The BUMaps
// member keeps the mappings from the BU graphs to the TD graphs as they are
// calculated by calculateGraph. This information is used to properly
// implement resolving of call sites, where the call sites in the BUGraph are
// in terms of the caller function's graph in the BUGraph.
//
typedef std::map<const DSNode*, DSNodeHandle> BUNodeMapTy;
std::map<const Function*, BUNodeMapTy> BUMaps;
// CallSitesForFunction - This is a temporary map that is only kept around
// when building the top-down closures for a program. It traverses all of the
// call sites in the BU graph and holds all of the call sites that each
// function is the "resolving caller" for.
//
std::map<const Function*,
std::vector<const DSCallSite*> > CallSitesForFunction;
public:
~TDDataStructures() { releaseMemory(); }
virtual bool run(Module &M);
// getDSGraph - Return the data structure graph for the specified function.
DSGraph &getDSGraph(const Function &F) const {
std::map<const Function*, DSGraph*>::const_iterator I = DSInfo.find(&F);
assert(I != DSInfo.end() && "Function not in module!");
return *I->second;
}
// print - Print out the analysis results...
void print(std::ostream &O, const Module *M) const;
// If the pass pipeline is done with this pass, we can release our memory...
virtual void releaseMemory();
// getAnalysisUsage - This obviously provides a data structure graph.
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequired<BUDataStructures>();
}
private:
DSGraph &calculateGraph(Function &F);
void ResolveCallSite(DSGraph &Graph, const DSCallSite &CallSite);
};
#if 0
// GlobalDSGraph - A common graph for all the globals and their outgoing links
// to externally visible nodes. This includes GlobalValues, New nodes,
// Cast nodes, and Calls. This graph can only be used by one of the
// individual function graphs, and it goes away when they all go away.
//
class GlobalDSGraph : public DSGraph {
hash_set<const DSGraph*> Referrers;
void addReference(const DSGraph* referrer);
void removeReference(const DSGraph* referrer);
friend class DSGraph; // give access to Referrers
GlobalDSGraph(const GlobalDSGraph &GlobalDSG); // Do not implement
// Helper function for cloneGlobals and cloneCalls
DSNode* cloneNodeInto(DSNode *OldNode,
std::map<const DSNode*, DSNode*> &NodeCache,
bool GlobalsAreFinal = false);
public:
GlobalDSGraph(); // Create an empty DSGraph
virtual ~GlobalDSGraph();
void cloneGlobals(DSGraph& Graph, bool CloneCalls = false);
void cloneCalls (DSGraph& Graph);
};
#endif
#endif