1 //===- DSGraph.h - Represent a collection of data structures ----*- C++ -*-===//
3 // This header defines the primative classes that make up a data structure
6 //===----------------------------------------------------------------------===//
8 #ifndef LLVM_ANALYSIS_DSGRAPH_H
9 #define LLVM_ANALYSIS_DSGRAPH_H
19 class DSNode; // Each node in the graph
20 class DSGraph; // A graph for a function
21 class DSNodeIterator; // Data structure graph traversal iterator
23 //===----------------------------------------------------------------------===//
24 /// DSNodeHandle - Implement a "handle" to a data structure node that takes care
25 /// of all of the add/un'refing of the node to prevent the backpointers in the
26 /// graph from getting out of date. This class represents a "pointer" in the
27 /// graph, whose destination is an indexed offset into a node.
33 // Allow construction, destruction, and assignment...
34 DSNodeHandle(DSNode *n = 0, unsigned offs = 0) : N(0), Offset(offs) {
37 DSNodeHandle(const DSNodeHandle &H) : N(0), Offset(H.Offset) { setNode(H.N); }
38 ~DSNodeHandle() { setNode((DSNode*)0); }
39 DSNodeHandle &operator=(const DSNodeHandle &H) {
40 setNode(H.N); Offset = H.Offset;
44 bool operator<(const DSNodeHandle &H) const { // Allow sorting
45 return N < H.N || (N == H.N && Offset < H.Offset);
47 bool operator==(const DSNodeHandle &H) const { // Allow comparison
48 return N == H.N && Offset == H.Offset;
50 bool operator!=(const DSNodeHandle &H) const { return !operator==(H); }
52 // Allow explicit conversion to DSNode...
53 DSNode *getNode() const { return N; }
54 unsigned getOffset() const { return Offset; }
56 inline void setNode(DSNode *N); // Defined inline later...
57 void setOffset(unsigned O) { Offset = O; }
59 void addEdgeTo(unsigned LinkNo, const DSNodeHandle &N);
60 void addEdgeTo(const DSNodeHandle &N) { addEdgeTo(0, N); }
62 /// mergeWith - Merge the logical node pointed to by 'this' with the node
63 /// pointed to by 'N'.
65 void mergeWith(const DSNodeHandle &N);
67 // hasLink - Return true if there is a link at the specified offset...
68 inline bool hasLink(unsigned Num) const;
70 /// getLink - Treat this current node pointer as a pointer to a structure of
71 /// some sort. This method will return the pointer a mem[this+Num]
73 inline const DSNodeHandle *getLink(unsigned Num) const;
74 inline DSNodeHandle *getLink(unsigned Num);
76 inline void setLink(unsigned Num, const DSNodeHandle &NH);
80 //===----------------------------------------------------------------------===//
81 /// DSNode - Data structure node class
83 /// This class represents an untyped memory object of Size bytes. It keeps
84 /// track of any pointers that have been stored into the object as well as the
85 /// different types represented in this object.
88 /// Links - Contains one entry for every _distinct_ pointer field in the
89 /// memory block. These are demand allocated and indexed by the MergeMap
92 std::vector<DSNodeHandle> Links;
94 /// MergeMap - Maps from every byte in the object to a signed byte number.
95 /// This map is neccesary due to the merging that is possible as part of the
96 /// unification algorithm. To merge two distinct bytes of the object together
97 /// into a single logical byte, the indexes for the two bytes are set to the
98 /// same value. This fully general merging is capable of representing all
99 /// manners of array merging if neccesary.
101 /// This map is also used to map outgoing pointers to various byte offsets in
102 /// this data structure node. If this value is >= 0, then it indicates that
103 /// the numbered entry in the Links vector contains the outgoing edge for this
104 /// byte offset. In this way, the Links vector can be demand allocated and
105 /// byte elements of the node may be merged without needing a Link allocated
108 /// Initially, each each element of the MergeMap is assigned a unique negative
109 /// number, which are then merged as the unification occurs.
111 std::vector<signed char> MergeMap;
113 /// Referrers - Keep track of all of the node handles that point to this
114 /// DSNode. These pointers may need to be updated to point to a different
115 /// node if this node gets merged with it.
117 std::vector<DSNodeHandle*> Referrers;
119 /// TypeEntries - As part of the merging process of this algorithm, nodes of
120 /// different types can be represented by this single DSNode. This vector is
123 typedef std::pair<const Type *, unsigned> TypeRec;
124 std::vector<TypeRec> TypeEntries;
126 /// Globals - The list of global values that are merged into this node.
128 std::vector<GlobalValue*> Globals;
130 void operator=(const DSNode &); // DO NOT IMPLEMENT
133 ShadowNode = 0, // Nothing is known about this node...
134 ScalarNode = 1 << 0, // Scalar of the current function contains this value
135 AllocaNode = 1 << 1, // This node was allocated with alloca
136 NewNode = 1 << 2, // This node was allocated with malloc
137 GlobalNode = 1 << 3, // This node was allocated by a global var decl
138 Incomplete = 1 << 4, // This node may not be complete
141 /// NodeType - A union of the above bits. "Shadow" nodes do not add any flags
142 /// to the nodes in the data structure graph, so it is possible to have nodes
143 /// with a value of 0 for their NodeType. Scalar and Alloca markers go away
144 /// when function graphs are inlined.
146 unsigned char NodeType;
148 DSNode(enum NodeTy NT, const Type *T);
149 DSNode(const DSNode &);
153 dropAllReferences(); // Only needed to satisfy assertion checks...
154 assert(Referrers.empty() && "Referrers to dead node exist!");
158 // Iterator for graph interface...
159 typedef DSNodeIterator iterator;
160 inline iterator begin(); // Defined in DSGraphTraits.h
161 inline iterator end();
163 //===--------------------------------------------------
166 // getSize - Return the maximum number of bytes occupied by this object...
167 unsigned getSize() const { return MergeMap.size(); }
169 // getTypeEntries - Return the possible types and their offsets in this object
170 const std::vector<TypeRec> &getTypeEntries() const { return TypeEntries; }
172 // getReferrers - Return a list of the pointers to this node...
173 const std::vector<DSNodeHandle*> &getReferrers() const { return Referrers; }
176 /// hasLink - Return true if this memory object has a link at the specified
179 bool hasLink(unsigned i) const {
180 assert(i < getSize() && "Field Link index is out of range!");
181 return MergeMap[i] >= 0;
184 DSNodeHandle *getLink(unsigned i) {
186 return &Links[MergeMap[i]];
189 const DSNodeHandle *getLink(unsigned i) const {
191 return &Links[MergeMap[i]];
195 int getMergeMapLabel(unsigned i) {
196 assert(i < MergeMap.size() && "MergeMap index out of range!");
200 /// setLink - Set the link at the specified offset to the specified
201 /// NodeHandle, replacing what was there. It is uncommon to use this method,
202 /// instead one of the higher level methods should be used, below.
204 void setLink(unsigned i, const DSNodeHandle &NH);
206 /// addEdgeTo - Add an edge from the current node to the specified node. This
207 /// can cause merging of nodes in the graph.
209 void addEdgeTo(unsigned Offset, const DSNodeHandle &NH);
211 /// mergeWith - Merge this node and the specified node, moving all links to
212 /// and from the argument node into the current node, deleting the node
213 /// argument. Offset indicates what offset the specified node is to be merged
214 /// into the current node.
216 /// The specified node may be a null pointer (in which case, nothing happens).
218 void mergeWith(const DSNodeHandle &NH, unsigned Offset);
220 /// mergeIndexes - If we discover that two indexes are equivalent and must be
221 /// merged, this function is used to do the dirty work.
223 void mergeIndexes(unsigned idx1, unsigned idx2) {
224 assert(idx1 < getSize() && idx2 < getSize() && "Indexes out of range!");
225 signed char MV1 = MergeMap[idx1];
226 signed char MV2 = MergeMap[idx2];
228 mergeMappedValues(MV1, MV2);
232 /// addGlobal - Add an entry for a global value to the Globals list. This
233 /// also marks the node with the 'G' flag if it does not already have it.
235 void addGlobal(GlobalValue *GV);
236 const std::vector<GlobalValue*> &getGlobals() const { return Globals; }
237 std::vector<GlobalValue*> &getGlobals() { return Globals; }
239 void print(std::ostream &O, const DSGraph *G) const;
242 void dropAllReferences() {
246 /// remapLinks - Change all of the Links in the current node according to the
247 /// specified mapping.
248 void remapLinks(std::map<const DSNode*, DSNode*> &OldNodeMap);
251 friend class DSNodeHandle;
252 // addReferrer - Keep the referrer set up to date...
253 void addReferrer(DSNodeHandle *H) { Referrers.push_back(H); }
254 void removeReferrer(DSNodeHandle *H);
256 /// rewriteMergeMap - Loop over the mergemap, replacing any references to the
257 /// index From to be references to the index To.
259 void rewriteMergeMap(signed char From, signed char To) {
260 assert(From != To && "Cannot change something into itself!");
261 for (unsigned i = 0, e = MergeMap.size(); i != e; ++i)
262 if (MergeMap[i] == From)
266 /// mergeMappedValues - This is the higher level form of rewriteMergeMap. It
267 /// is fully capable of merging links together if neccesary as well as simply
268 /// rewriting the map entries.
270 void mergeMappedValues(signed char V1, signed char V2);
274 //===----------------------------------------------------------------------===//
275 // Define inline DSNodeHandle functions that depend on the definition of DSNode
278 inline void DSNodeHandle::setNode(DSNode *n) {
279 if (N) N->removeReferrer(this);
281 if (N) N->addReferrer(this);
284 inline bool DSNodeHandle::hasLink(unsigned Num) const {
285 assert(N && "DSNodeHandle does not point to a node yet!");
286 return N->hasLink(Num+Offset);
290 /// getLink - Treat this current node pointer as a pointer to a structure of
291 /// some sort. This method will return the pointer a mem[this+Num]
293 inline const DSNodeHandle *DSNodeHandle::getLink(unsigned Num) const {
294 assert(N && "DSNodeHandle does not point to a node yet!");
295 return N->getLink(Num+Offset);
297 inline DSNodeHandle *DSNodeHandle::getLink(unsigned Num) {
298 assert(N && "DSNodeHandle does not point to a node yet!");
299 return N->getLink(Num+Offset);
302 inline void DSNodeHandle::setLink(unsigned Num, const DSNodeHandle &NH) {
303 assert(N && "DSNodeHandle does not point to a node yet!");
304 N->setLink(Num+Offset, NH);
307 /// addEdgeTo - Add an edge from the current node to the specified node. This
308 /// can cause merging of nodes in the graph.
310 inline void DSNodeHandle::addEdgeTo(unsigned LinkNo, const DSNodeHandle &Node) {
311 assert(N && "DSNodeHandle does not point to a node yet!");
312 N->addEdgeTo(LinkNo+Offset, Node);
315 /// mergeWith - Merge the logical node pointed to by 'this' with the node
316 /// pointed to by 'N'.
318 inline void DSNodeHandle::mergeWith(const DSNodeHandle &Node) {
319 assert(N && "DSNodeHandle does not point to a node yet!");
320 N->mergeWith(Node, Offset);
324 //===----------------------------------------------------------------------===//
325 /// DSGraph - The graph that represents a function.
329 std::vector<DSNode*> Nodes;
330 DSNodeHandle RetNode; // Node that gets returned...
331 std::map<Value*, DSNodeHandle> ValueMap;
334 // GlobalsGraph -- Reference to the common graph of globally visible objects.
335 // This includes GlobalValues, New nodes, Cast nodes, and Calls.
337 GlobalDSGraph* GlobalsGraph;
340 // FunctionCalls - This vector maintains a single entry for each call
341 // instruction in the current graph. Each call entry contains DSNodeHandles
342 // that refer to the arguments that are passed into the function call. The
343 // first entry in the vector is the scalar that holds the return value for the
344 // call, the second is the function scalar being invoked, and the rest are
345 // pointer arguments to the function.
347 std::vector<std::vector<DSNodeHandle> > FunctionCalls;
350 // OrigFunctionCalls - This vector retains a copy of the original function
351 // calls of the current graph. This is needed to support top-down inlining
352 // after bottom-up inlining is complete, since the latter deletes call nodes.
354 std::vector<std::vector<DSNodeHandle> > OrigFunctionCalls;
356 // PendingCallers - This vector records all unresolved callers of the
357 // current function, i.e., ones whose graphs have not been inlined into
358 // the current graph. As long as there are unresolved callers, the nodes
359 // for formal arguments in the current graph cannot be eliminated, and
360 // nodes in the graph reachable from the formal argument nodes or
361 // global variable nodes must be considered incomplete.
362 std::set<Function*> PendingCallers;
368 // clone all the call nodes and save the copies in OrigFunctionCalls
369 void saveOrigFunctionCalls() {
370 assert(OrigFunctionCalls.size() == 0 && "Do this only once!");
371 OrigFunctionCalls = FunctionCalls;
374 // get the saved copies of the original function call nodes
375 std::vector<std::vector<DSNodeHandle> > &getOrigFunctionCalls() {
376 return OrigFunctionCalls;
380 void operator=(const DSGraph &); // DO NOT IMPLEMENT
382 DSGraph() : Func(0) {} // Create a new, empty, DSGraph.
383 DSGraph(Function &F); // Compute the local DSGraph
384 DSGraph(const DSGraph &DSG); // Copy ctor
387 bool hasFunction() const { return Func != 0; }
388 Function &getFunction() const { return *Func; }
390 /// getNodes - Get a vector of all the nodes in the graph
392 const std::vector<DSNode*> &getNodes() const { return Nodes; }
393 std::vector<DSNode*> &getNodes() { return Nodes; }
395 /// addNode - Add a new node to the graph.
397 void addNode(DSNode *N) { Nodes.push_back(N); }
399 /// getValueMap - Get a map that describes what the nodes the scalars in this
400 /// function point to...
402 std::map<Value*, DSNodeHandle> &getValueMap() { return ValueMap; }
403 const std::map<Value*, DSNodeHandle> &getValueMap() const { return ValueMap;}
405 std::vector<std::vector<DSNodeHandle> > &getFunctionCalls() {
406 return FunctionCalls;
408 const std::vector<std::vector<DSNodeHandle> > &getFunctionCalls() const {
409 return FunctionCalls;
412 const DSNodeHandle &getRetNode() const { return RetNode; }
413 DSNodeHandle &getRetNode() { return RetNode; }
415 unsigned getGraphSize() const {
419 void print(std::ostream &O) const;
421 void writeGraphToFile(std::ostream &O, const std::string &GraphName);
423 // maskNodeTypes - Apply a mask to all of the node types in the graph. This
424 // is useful for clearing out markers like Scalar or Incomplete.
426 void maskNodeTypes(unsigned char Mask);
427 void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
429 // markIncompleteNodes - Traverse the graph, identifying nodes that may be
430 // modified by other functions that have not been resolved yet. This marks
431 // nodes that are reachable through three sources of "unknownness":
432 // Global Variables, Function Calls, and Incoming Arguments
434 // For any node that may have unknown components (because something outside
435 // the scope of current analysis may have modified it), the 'Incomplete' flag
436 // is added to the NodeType.
438 void markIncompleteNodes(bool markFormalArgs = true);
440 // removeTriviallyDeadNodes - After the graph has been constructed, this
441 // method removes all unreachable nodes that are created because they got
442 // merged with other nodes in the graph.
444 void removeTriviallyDeadNodes(bool KeepAllGlobals = false);
446 // removeDeadNodes - Use a more powerful reachability analysis to eliminate
447 // subgraphs that are unreachable. This often occurs because the data
448 // structure doesn't "escape" into it's caller, and thus should be eliminated
449 // from the caller's graph entirely. This is only appropriate to use when
452 void removeDeadNodes(bool KeepAllGlobals = false, bool KeepCalls = true);
455 // AddCaller - add a known caller node into the graph and mark it pending.
456 // getCallers - get a vector of the functions that call this one
457 // getCallersPending - get a matching vector of bools indicating if each
458 // caller's DSGraph has been resolved into this one.
460 void addCaller(Function &caller) {
461 PendingCallers.insert(&caller);
463 std::set<Function*> &getPendingCallers() {
464 return PendingCallers;
468 // cloneInto - Clone the specified DSGraph into the current graph, returning
469 // the Return node of the graph. The translated ValueMap for the old function
470 // is filled into the OldValMap member.
471 // If StripScalars (StripAllocas) is set to true, Scalar (Alloca) markers
472 // are removed from the graph as the graph is being cloned.
473 // If CopyCallers is set to true, the PendingCallers list is copied.
474 // If CopyOrigCalls is set to true, the OrigFunctionCalls list is copied.
476 DSNodeHandle cloneInto(const DSGraph &G,
477 std::map<Value*, DSNodeHandle> &OldValMap,
478 std::map<const DSNode*, DSNode*> &OldNodeMap,
479 bool StripScalars = false, bool StripAllocas = false,
480 bool CopyCallers = true, bool CopyOrigCalls = true);
483 // cloneGlobalInto - Clone the given global node (or the node for the given
484 // GlobalValue) from the GlobalsGraph and all its target links (recursively).
486 DSNode* cloneGlobalInto(const DSNode* GNode);
487 DSNode* cloneGlobalInto(GlobalValue* GV) {
488 assert(!GV || (((DSGraph*) GlobalsGraph)->ValueMap[GV] != 0));
489 return GV? cloneGlobalInto(((DSGraph*) GlobalsGraph)->ValueMap[GV]) : 0;
494 bool isNodeDead(DSNode *N);