add support for caching pointer dependence queries. Nothing uses this yet
[oota-llvm.git] / lib / Analysis / IPA / Andersens.cpp
1 //===- Andersens.cpp - Andersen's Interprocedural Alias Analysis ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines an implementation of Andersen's interprocedural alias
11 // analysis
12 //
13 // In pointer analysis terms, this is a subset-based, flow-insensitive,
14 // field-sensitive, and context-insensitive algorithm pointer algorithm.
15 //
16 // This algorithm is implemented as three stages:
17 //   1. Object identification.
18 //   2. Inclusion constraint identification.
19 //   3. Offline constraint graph optimization
20 //   4. Inclusion constraint solving.
21 //
22 // The object identification stage identifies all of the memory objects in the
23 // program, which includes globals, heap allocated objects, and stack allocated
24 // objects.
25 //
26 // The inclusion constraint identification stage finds all inclusion constraints
27 // in the program by scanning the program, looking for pointer assignments and
28 // other statements that effect the points-to graph.  For a statement like "A =
29 // B", this statement is processed to indicate that A can point to anything that
30 // B can point to.  Constraints can handle copies, loads, and stores, and
31 // address taking.
32 //
33 // The offline constraint graph optimization portion includes offline variable
34 // substitution algorithms intended to compute pointer and location
35 // equivalences.  Pointer equivalences are those pointers that will have the
36 // same points-to sets, and location equivalences are those variables that
37 // always appear together in points-to sets.  It also includes an offline
38 // cycle detection algorithm that allows cycles to be collapsed sooner 
39 // during solving.
40 //
41 // The inclusion constraint solving phase iteratively propagates the inclusion
42 // constraints until a fixed point is reached.  This is an O(N^3) algorithm.
43 //
44 // Function constraints are handled as if they were structs with X fields.
45 // Thus, an access to argument X of function Y is an access to node index
46 // getNode(Y) + X.  This representation allows handling of indirect calls
47 // without any issues.  To wit, an indirect call Y(a,b) is equivalent to
48 // *(Y + 1) = a, *(Y + 2) = b.
49 // The return node for a function is always located at getNode(F) +
50 // CallReturnPos. The arguments start at getNode(F) + CallArgPos.
51 //
52 // Future Improvements:
53 //   Use of BDD's.
54 //===----------------------------------------------------------------------===//
55
56 #define DEBUG_TYPE "anders-aa"
57 #include "llvm/Constants.h"
58 #include "llvm/DerivedTypes.h"
59 #include "llvm/Instructions.h"
60 #include "llvm/Module.h"
61 #include "llvm/Pass.h"
62 #include "llvm/Support/Compiler.h"
63 #include "llvm/Support/InstIterator.h"
64 #include "llvm/Support/InstVisitor.h"
65 #include "llvm/Analysis/AliasAnalysis.h"
66 #include "llvm/Analysis/Passes.h"
67 #include "llvm/Support/Debug.h"
68 #include "llvm/ADT/Statistic.h"
69 #include "llvm/ADT/SparseBitVector.h"
70 #include "llvm/ADT/DenseSet.h"
71 #include <algorithm>
72 #include <set>
73 #include <list>
74 #include <map>
75 #include <stack>
76 #include <vector>
77 #include <queue>
78
79 // Determining the actual set of nodes the universal set can consist of is very
80 // expensive because it means propagating around very large sets.  We rely on
81 // other analysis being able to determine which nodes can never be pointed to in
82 // order to disambiguate further than "points-to anything".
83 #define FULL_UNIVERSAL 0
84
85 using namespace llvm;
86 STATISTIC(NumIters      , "Number of iterations to reach convergence");
87 STATISTIC(NumConstraints, "Number of constraints");
88 STATISTIC(NumNodes      , "Number of nodes");
89 STATISTIC(NumUnified    , "Number of variables unified");
90 STATISTIC(NumErased     , "Number of redundant constraints erased");
91
92 static const unsigned SelfRep = (unsigned)-1;
93 static const unsigned Unvisited = (unsigned)-1;
94 // Position of the function return node relative to the function node.
95 static const unsigned CallReturnPos = 1;
96 // Position of the function call node relative to the function node.
97 static const unsigned CallFirstArgPos = 2;
98
99 namespace {
100   struct BitmapKeyInfo {
101     static inline SparseBitVector<> *getEmptyKey() {
102       return reinterpret_cast<SparseBitVector<> *>(-1);
103     }
104     static inline SparseBitVector<> *getTombstoneKey() {
105       return reinterpret_cast<SparseBitVector<> *>(-2);
106     }
107     static unsigned getHashValue(const SparseBitVector<> *bitmap) {
108       return bitmap->getHashValue();
109     }
110     static bool isEqual(const SparseBitVector<> *LHS,
111                         const SparseBitVector<> *RHS) {
112       if (LHS == RHS)
113         return true;
114       else if (LHS == getEmptyKey() || RHS == getEmptyKey()
115                || LHS == getTombstoneKey() || RHS == getTombstoneKey())
116         return false;
117
118       return *LHS == *RHS;
119     }
120
121     static bool isPod() { return true; }
122   };
123
124   class VISIBILITY_HIDDEN Andersens : public ModulePass, public AliasAnalysis,
125                                       private InstVisitor<Andersens> {
126     struct Node;
127
128     /// Constraint - Objects of this structure are used to represent the various
129     /// constraints identified by the algorithm.  The constraints are 'copy',
130     /// for statements like "A = B", 'load' for statements like "A = *B",
131     /// 'store' for statements like "*A = B", and AddressOf for statements like
132     /// A = alloca;  The Offset is applied as *(A + K) = B for stores,
133     /// A = *(B + K) for loads, and A = B + K for copies.  It is
134     /// illegal on addressof constraints (because it is statically
135     /// resolvable to A = &C where C = B + K)
136
137     struct Constraint {
138       enum ConstraintType { Copy, Load, Store, AddressOf } Type;
139       unsigned Dest;
140       unsigned Src;
141       unsigned Offset;
142
143       Constraint(ConstraintType Ty, unsigned D, unsigned S, unsigned O = 0)
144         : Type(Ty), Dest(D), Src(S), Offset(O) {
145         assert((Offset == 0 || Ty != AddressOf) &&
146                "Offset is illegal on addressof constraints");
147       }
148
149       bool operator==(const Constraint &RHS) const {
150         return RHS.Type == Type
151           && RHS.Dest == Dest
152           && RHS.Src == Src
153           && RHS.Offset == Offset;
154       }
155
156       bool operator!=(const Constraint &RHS) const {
157         return !(*this == RHS);
158       }
159
160       bool operator<(const Constraint &RHS) const {
161         if (RHS.Type != Type)
162           return RHS.Type < Type;
163         else if (RHS.Dest != Dest)
164           return RHS.Dest < Dest;
165         else if (RHS.Src != Src)
166           return RHS.Src < Src;
167         return RHS.Offset < Offset;
168       }
169     };
170
171     // Information DenseSet requires implemented in order to be able to do
172     // it's thing
173     struct PairKeyInfo {
174       static inline std::pair<unsigned, unsigned> getEmptyKey() {
175         return std::make_pair(~0U, ~0U);
176       }
177       static inline std::pair<unsigned, unsigned> getTombstoneKey() {
178         return std::make_pair(~0U - 1, ~0U - 1);
179       }
180       static unsigned getHashValue(const std::pair<unsigned, unsigned> &P) {
181         return P.first ^ P.second;
182       }
183       static unsigned isEqual(const std::pair<unsigned, unsigned> &LHS,
184                               const std::pair<unsigned, unsigned> &RHS) {
185         return LHS == RHS;
186       }
187     };
188     
189     struct ConstraintKeyInfo {
190       static inline Constraint getEmptyKey() {
191         return Constraint(Constraint::Copy, ~0U, ~0U, ~0U);
192       }
193       static inline Constraint getTombstoneKey() {
194         return Constraint(Constraint::Copy, ~0U - 1, ~0U - 1, ~0U - 1);
195       }
196       static unsigned getHashValue(const Constraint &C) {
197         return C.Src ^ C.Dest ^ C.Type ^ C.Offset;
198       }
199       static bool isEqual(const Constraint &LHS,
200                           const Constraint &RHS) {
201         return LHS.Type == RHS.Type && LHS.Dest == RHS.Dest
202           && LHS.Src == RHS.Src && LHS.Offset == RHS.Offset;
203       }
204     };
205
206     // Node class - This class is used to represent a node in the constraint
207     // graph.  Due to various optimizations, it is not always the case that
208     // there is a mapping from a Node to a Value.  In particular, we add
209     // artificial Node's that represent the set of pointed-to variables shared
210     // for each location equivalent Node.
211     struct Node {
212     private:
213       static unsigned Counter;
214
215     public:
216       Value *Val;
217       SparseBitVector<> *Edges;
218       SparseBitVector<> *PointsTo;
219       SparseBitVector<> *OldPointsTo;
220       std::list<Constraint> Constraints;
221
222       // Pointer and location equivalence labels
223       unsigned PointerEquivLabel;
224       unsigned LocationEquivLabel;
225       // Predecessor edges, both real and implicit
226       SparseBitVector<> *PredEdges;
227       SparseBitVector<> *ImplicitPredEdges;
228       // Set of nodes that point to us, only use for location equivalence.
229       SparseBitVector<> *PointedToBy;
230       // Number of incoming edges, used during variable substitution to early
231       // free the points-to sets
232       unsigned NumInEdges;
233       // True if our points-to set is in the Set2PEClass map
234       bool StoredInHash;
235       // True if our node has no indirect constraints (complex or otherwise)
236       bool Direct;
237       // True if the node is address taken, *or* it is part of a group of nodes
238       // that must be kept together.  This is set to true for functions and
239       // their arg nodes, which must be kept at the same position relative to
240       // their base function node.
241       bool AddressTaken;
242
243       // Nodes in cycles (or in equivalence classes) are united together using a
244       // standard union-find representation with path compression.  NodeRep
245       // gives the index into GraphNodes for the representative Node.
246       unsigned NodeRep;
247
248       // Modification timestamp.  Assigned from Counter.
249       // Used for work list prioritization.
250       unsigned Timestamp;
251
252       explicit Node(bool direct = true) :
253         Val(0), Edges(0), PointsTo(0), OldPointsTo(0), 
254         PointerEquivLabel(0), LocationEquivLabel(0), PredEdges(0),
255         ImplicitPredEdges(0), PointedToBy(0), NumInEdges(0),
256         StoredInHash(false), Direct(direct), AddressTaken(false),
257         NodeRep(SelfRep), Timestamp(0) { }
258
259       Node *setValue(Value *V) {
260         assert(Val == 0 && "Value already set for this node!");
261         Val = V;
262         return this;
263       }
264
265       /// getValue - Return the LLVM value corresponding to this node.
266       ///
267       Value *getValue() const { return Val; }
268
269       /// addPointerTo - Add a pointer to the list of pointees of this node,
270       /// returning true if this caused a new pointer to be added, or false if
271       /// we already knew about the points-to relation.
272       bool addPointerTo(unsigned Node) {
273         return PointsTo->test_and_set(Node);
274       }
275
276       /// intersects - Return true if the points-to set of this node intersects
277       /// with the points-to set of the specified node.
278       bool intersects(Node *N) const;
279
280       /// intersectsIgnoring - Return true if the points-to set of this node
281       /// intersects with the points-to set of the specified node on any nodes
282       /// except for the specified node to ignore.
283       bool intersectsIgnoring(Node *N, unsigned) const;
284
285       // Timestamp a node (used for work list prioritization)
286       void Stamp() {
287         Timestamp = Counter++;
288       }
289
290       bool isRep() const {
291         return( (int) NodeRep < 0 );
292       }
293     };
294
295     struct WorkListElement {
296       Node* node;
297       unsigned Timestamp;
298       WorkListElement(Node* n, unsigned t) : node(n), Timestamp(t) {}
299
300       // Note that we reverse the sense of the comparison because we
301       // actually want to give low timestamps the priority over high,
302       // whereas priority is typically interpreted as a greater value is
303       // given high priority.
304       bool operator<(const WorkListElement& that) const {
305         return( this->Timestamp > that.Timestamp );
306       }
307     };
308
309     // Priority-queue based work list specialized for Nodes.
310     class WorkList {
311       std::priority_queue<WorkListElement> Q;
312
313     public:
314       void insert(Node* n) {
315         Q.push( WorkListElement(n, n->Timestamp) );
316       }
317
318       // We automatically discard non-representative nodes and nodes
319       // that were in the work list twice (we keep a copy of the
320       // timestamp in the work list so we can detect this situation by
321       // comparing against the node's current timestamp).
322       Node* pop() {
323         while( !Q.empty() ) {
324           WorkListElement x = Q.top(); Q.pop();
325           Node* INode = x.node;
326
327           if( INode->isRep() &&
328               INode->Timestamp == x.Timestamp ) {
329             return(x.node);
330           }
331         }
332         return(0);
333       }
334
335       bool empty() {
336         return Q.empty();
337       }
338     };
339
340     /// GraphNodes - This vector is populated as part of the object
341     /// identification stage of the analysis, which populates this vector with a
342     /// node for each memory object and fills in the ValueNodes map.
343     std::vector<Node> GraphNodes;
344
345     /// ValueNodes - This map indicates the Node that a particular Value* is
346     /// represented by.  This contains entries for all pointers.
347     DenseMap<Value*, unsigned> ValueNodes;
348
349     /// ObjectNodes - This map contains entries for each memory object in the
350     /// program: globals, alloca's and mallocs.
351     DenseMap<Value*, unsigned> ObjectNodes;
352
353     /// ReturnNodes - This map contains an entry for each function in the
354     /// program that returns a value.
355     DenseMap<Function*, unsigned> ReturnNodes;
356
357     /// VarargNodes - This map contains the entry used to represent all pointers
358     /// passed through the varargs portion of a function call for a particular
359     /// function.  An entry is not present in this map for functions that do not
360     /// take variable arguments.
361     DenseMap<Function*, unsigned> VarargNodes;
362
363
364     /// Constraints - This vector contains a list of all of the constraints
365     /// identified by the program.
366     std::vector<Constraint> Constraints;
367
368     // Map from graph node to maximum K value that is allowed (for functions,
369     // this is equivalent to the number of arguments + CallFirstArgPos)
370     std::map<unsigned, unsigned> MaxK;
371
372     /// This enum defines the GraphNodes indices that correspond to important
373     /// fixed sets.
374     enum {
375       UniversalSet = 0,
376       NullPtr      = 1,
377       NullObject   = 2,
378       NumberSpecialNodes
379     };
380     // Stack for Tarjan's
381     std::stack<unsigned> SCCStack;
382     // Map from Graph Node to DFS number
383     std::vector<unsigned> Node2DFS;
384     // Map from Graph Node to Deleted from graph.
385     std::vector<bool> Node2Deleted;
386     // Same as Node Maps, but implemented as std::map because it is faster to
387     // clear 
388     std::map<unsigned, unsigned> Tarjan2DFS;
389     std::map<unsigned, bool> Tarjan2Deleted;
390     // Current DFS number
391     unsigned DFSNumber;
392
393     // Work lists.
394     WorkList w1, w2;
395     WorkList *CurrWL, *NextWL; // "current" and "next" work lists
396
397     // Offline variable substitution related things
398
399     // Temporary rep storage, used because we can't collapse SCC's in the
400     // predecessor graph by uniting the variables permanently, we can only do so
401     // for the successor graph.
402     std::vector<unsigned> VSSCCRep;
403     // Mapping from node to whether we have visited it during SCC finding yet.
404     std::vector<bool> Node2Visited;
405     // During variable substitution, we create unknowns to represent the unknown
406     // value that is a dereference of a variable.  These nodes are known as
407     // "ref" nodes (since they represent the value of dereferences).
408     unsigned FirstRefNode;
409     // During HVN, we create represent address taken nodes as if they were
410     // unknown (since HVN, unlike HU, does not evaluate unions).
411     unsigned FirstAdrNode;
412     // Current pointer equivalence class number
413     unsigned PEClass;
414     // Mapping from points-to sets to equivalence classes
415     typedef DenseMap<SparseBitVector<> *, unsigned, BitmapKeyInfo> BitVectorMap;
416     BitVectorMap Set2PEClass;
417     // Mapping from pointer equivalences to the representative node.  -1 if we
418     // have no representative node for this pointer equivalence class yet.
419     std::vector<int> PEClass2Node;
420     // Mapping from pointer equivalences to representative node.  This includes
421     // pointer equivalent but not location equivalent variables. -1 if we have
422     // no representative node for this pointer equivalence class yet.
423     std::vector<int> PENLEClass2Node;
424     // Union/Find for HCD
425     std::vector<unsigned> HCDSCCRep;
426     // HCD's offline-detected cycles; "Statically DeTected"
427     // -1 if not part of such a cycle, otherwise a representative node.
428     std::vector<int> SDT;
429     // Whether to use SDT (UniteNodes can use it during solving, but not before)
430     bool SDTActive;
431
432   public:
433     static char ID;
434     Andersens() : ModulePass(&ID) {}
435
436     bool runOnModule(Module &M) {
437       InitializeAliasAnalysis(this);
438       IdentifyObjects(M);
439       CollectConstraints(M);
440 #undef DEBUG_TYPE
441 #define DEBUG_TYPE "anders-aa-constraints"
442       DEBUG(PrintConstraints());
443 #undef DEBUG_TYPE
444 #define DEBUG_TYPE "anders-aa"
445       SolveConstraints();
446       DEBUG(PrintPointsToGraph());
447
448       // Free the constraints list, as we don't need it to respond to alias
449       // requests.
450       std::vector<Constraint>().swap(Constraints);
451       //These are needed for Print() (-analyze in opt)
452       //ObjectNodes.clear();
453       //ReturnNodes.clear();
454       //VarargNodes.clear();
455       return false;
456     }
457
458     void releaseMemory() {
459       // FIXME: Until we have transitively required passes working correctly,
460       // this cannot be enabled!  Otherwise, using -count-aa with the pass
461       // causes memory to be freed too early. :(
462 #if 0
463       // The memory objects and ValueNodes data structures at the only ones that
464       // are still live after construction.
465       std::vector<Node>().swap(GraphNodes);
466       ValueNodes.clear();
467 #endif
468     }
469
470     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
471       AliasAnalysis::getAnalysisUsage(AU);
472       AU.setPreservesAll();                         // Does not transform code
473     }
474
475     //------------------------------------------------
476     // Implement the AliasAnalysis API
477     //
478     AliasResult alias(const Value *V1, unsigned V1Size,
479                       const Value *V2, unsigned V2Size);
480     virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
481     virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2);
482     void getMustAliases(Value *P, std::vector<Value*> &RetVals);
483     bool pointsToConstantMemory(const Value *P);
484
485     virtual void deleteValue(Value *V) {
486       ValueNodes.erase(V);
487       getAnalysis<AliasAnalysis>().deleteValue(V);
488     }
489
490     virtual void copyValue(Value *From, Value *To) {
491       ValueNodes[To] = ValueNodes[From];
492       getAnalysis<AliasAnalysis>().copyValue(From, To);
493     }
494
495   private:
496     /// getNode - Return the node corresponding to the specified pointer scalar.
497     ///
498     unsigned getNode(Value *V) {
499       if (Constant *C = dyn_cast<Constant>(V))
500         if (!isa<GlobalValue>(C))
501           return getNodeForConstantPointer(C);
502
503       DenseMap<Value*, unsigned>::iterator I = ValueNodes.find(V);
504       if (I == ValueNodes.end()) {
505 #ifndef NDEBUG
506         V->dump();
507 #endif
508         assert(0 && "Value does not have a node in the points-to graph!");
509       }
510       return I->second;
511     }
512
513     /// getObject - Return the node corresponding to the memory object for the
514     /// specified global or allocation instruction.
515     unsigned getObject(Value *V) const {
516       DenseMap<Value*, unsigned>::iterator I = ObjectNodes.find(V);
517       assert(I != ObjectNodes.end() &&
518              "Value does not have an object in the points-to graph!");
519       return I->second;
520     }
521
522     /// getReturnNode - Return the node representing the return value for the
523     /// specified function.
524     unsigned getReturnNode(Function *F) const {
525       DenseMap<Function*, unsigned>::iterator I = ReturnNodes.find(F);
526       assert(I != ReturnNodes.end() && "Function does not return a value!");
527       return I->second;
528     }
529
530     /// getVarargNode - Return the node representing the variable arguments
531     /// formal for the specified function.
532     unsigned getVarargNode(Function *F) const {
533       DenseMap<Function*, unsigned>::iterator I = VarargNodes.find(F);
534       assert(I != VarargNodes.end() && "Function does not take var args!");
535       return I->second;
536     }
537
538     /// getNodeValue - Get the node for the specified LLVM value and set the
539     /// value for it to be the specified value.
540     unsigned getNodeValue(Value &V) {
541       unsigned Index = getNode(&V);
542       GraphNodes[Index].setValue(&V);
543       return Index;
544     }
545
546     unsigned UniteNodes(unsigned First, unsigned Second,
547                         bool UnionByRank = true);
548     unsigned FindNode(unsigned Node);
549     unsigned FindNode(unsigned Node) const;
550
551     void IdentifyObjects(Module &M);
552     void CollectConstraints(Module &M);
553     bool AnalyzeUsesOfFunction(Value *);
554     void CreateConstraintGraph();
555     void OptimizeConstraints();
556     unsigned FindEquivalentNode(unsigned, unsigned);
557     void ClumpAddressTaken();
558     void RewriteConstraints();
559     void HU();
560     void HVN();
561     void HCD();
562     void Search(unsigned Node);
563     void UnitePointerEquivalences();
564     void SolveConstraints();
565     bool QueryNode(unsigned Node);
566     void Condense(unsigned Node);
567     void HUValNum(unsigned Node);
568     void HVNValNum(unsigned Node);
569     unsigned getNodeForConstantPointer(Constant *C);
570     unsigned getNodeForConstantPointerTarget(Constant *C);
571     void AddGlobalInitializerConstraints(unsigned, Constant *C);
572
573     void AddConstraintsForNonInternalLinkage(Function *F);
574     void AddConstraintsForCall(CallSite CS, Function *F);
575     bool AddConstraintsForExternalCall(CallSite CS, Function *F);
576
577
578     void PrintNode(const Node *N) const;
579     void PrintConstraints() const ;
580     void PrintConstraint(const Constraint &) const;
581     void PrintLabels() const;
582     void PrintPointsToGraph() const;
583
584     //===------------------------------------------------------------------===//
585     // Instruction visitation methods for adding constraints
586     //
587     friend class InstVisitor<Andersens>;
588     void visitReturnInst(ReturnInst &RI);
589     void visitInvokeInst(InvokeInst &II) { visitCallSite(CallSite(&II)); }
590     void visitCallInst(CallInst &CI) { visitCallSite(CallSite(&CI)); }
591     void visitCallSite(CallSite CS);
592     void visitAllocationInst(AllocationInst &AI);
593     void visitLoadInst(LoadInst &LI);
594     void visitStoreInst(StoreInst &SI);
595     void visitGetElementPtrInst(GetElementPtrInst &GEP);
596     void visitPHINode(PHINode &PN);
597     void visitCastInst(CastInst &CI);
598     void visitICmpInst(ICmpInst &ICI) {} // NOOP!
599     void visitFCmpInst(FCmpInst &ICI) {} // NOOP!
600     void visitSelectInst(SelectInst &SI);
601     void visitVAArg(VAArgInst &I);
602     void visitInstruction(Instruction &I);
603
604     //===------------------------------------------------------------------===//
605     // Implement Analyize interface
606     //
607     void print(std::ostream &O, const Module* M) const {
608       PrintPointsToGraph();
609     }
610   };
611 }
612
613 char Andersens::ID = 0;
614 static RegisterPass<Andersens>
615 X("anders-aa", "Andersen's Interprocedural Alias Analysis", false, true);
616 static RegisterAnalysisGroup<AliasAnalysis> Y(X);
617
618 // Initialize Timestamp Counter (static).
619 unsigned Andersens::Node::Counter = 0;
620
621 ModulePass *llvm::createAndersensPass() { return new Andersens(); }
622
623 //===----------------------------------------------------------------------===//
624 //                  AliasAnalysis Interface Implementation
625 //===----------------------------------------------------------------------===//
626
627 AliasAnalysis::AliasResult Andersens::alias(const Value *V1, unsigned V1Size,
628                                             const Value *V2, unsigned V2Size) {
629   Node *N1 = &GraphNodes[FindNode(getNode(const_cast<Value*>(V1)))];
630   Node *N2 = &GraphNodes[FindNode(getNode(const_cast<Value*>(V2)))];
631
632   // Check to see if the two pointers are known to not alias.  They don't alias
633   // if their points-to sets do not intersect.
634   if (!N1->intersectsIgnoring(N2, NullObject))
635     return NoAlias;
636
637   return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
638 }
639
640 AliasAnalysis::ModRefResult
641 Andersens::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
642   // The only thing useful that we can contribute for mod/ref information is
643   // when calling external function calls: if we know that memory never escapes
644   // from the program, it cannot be modified by an external call.
645   //
646   // NOTE: This is not really safe, at least not when the entire program is not
647   // available.  The deal is that the external function could call back into the
648   // program and modify stuff.  We ignore this technical niggle for now.  This
649   // is, after all, a "research quality" implementation of Andersen's analysis.
650   if (Function *F = CS.getCalledFunction())
651     if (F->isDeclaration()) {
652       Node *N1 = &GraphNodes[FindNode(getNode(P))];
653
654       if (N1->PointsTo->empty())
655         return NoModRef;
656 #if FULL_UNIVERSAL
657       if (!UniversalSet->PointsTo->test(FindNode(getNode(P))))
658         return NoModRef;  // Universal set does not contain P
659 #else
660       if (!N1->PointsTo->test(UniversalSet))
661         return NoModRef;  // P doesn't point to the universal set.
662 #endif
663     }
664
665   return AliasAnalysis::getModRefInfo(CS, P, Size);
666 }
667
668 AliasAnalysis::ModRefResult
669 Andersens::getModRefInfo(CallSite CS1, CallSite CS2) {
670   return AliasAnalysis::getModRefInfo(CS1,CS2);
671 }
672
673 /// getMustAlias - We can provide must alias information if we know that a
674 /// pointer can only point to a specific function or the null pointer.
675 /// Unfortunately we cannot determine must-alias information for global
676 /// variables or any other memory memory objects because we do not track whether
677 /// a pointer points to the beginning of an object or a field of it.
678 void Andersens::getMustAliases(Value *P, std::vector<Value*> &RetVals) {
679   Node *N = &GraphNodes[FindNode(getNode(P))];
680   if (N->PointsTo->count() == 1) {
681     Node *Pointee = &GraphNodes[N->PointsTo->find_first()];
682     // If a function is the only object in the points-to set, then it must be
683     // the destination.  Note that we can't handle global variables here,
684     // because we don't know if the pointer is actually pointing to a field of
685     // the global or to the beginning of it.
686     if (Value *V = Pointee->getValue()) {
687       if (Function *F = dyn_cast<Function>(V))
688         RetVals.push_back(F);
689     } else {
690       // If the object in the points-to set is the null object, then the null
691       // pointer is a must alias.
692       if (Pointee == &GraphNodes[NullObject])
693         RetVals.push_back(Constant::getNullValue(P->getType()));
694     }
695   }
696   AliasAnalysis::getMustAliases(P, RetVals);
697 }
698
699 /// pointsToConstantMemory - If we can determine that this pointer only points
700 /// to constant memory, return true.  In practice, this means that if the
701 /// pointer can only point to constant globals, functions, or the null pointer,
702 /// return true.
703 ///
704 bool Andersens::pointsToConstantMemory(const Value *P) {
705   Node *N = &GraphNodes[FindNode(getNode(const_cast<Value*>(P)))];
706   unsigned i;
707
708   for (SparseBitVector<>::iterator bi = N->PointsTo->begin();
709        bi != N->PointsTo->end();
710        ++bi) {
711     i = *bi;
712     Node *Pointee = &GraphNodes[i];
713     if (Value *V = Pointee->getValue()) {
714       if (!isa<GlobalValue>(V) || (isa<GlobalVariable>(V) &&
715                                    !cast<GlobalVariable>(V)->isConstant()))
716         return AliasAnalysis::pointsToConstantMemory(P);
717     } else {
718       if (i != NullObject)
719         return AliasAnalysis::pointsToConstantMemory(P);
720     }
721   }
722
723   return true;
724 }
725
726 //===----------------------------------------------------------------------===//
727 //                       Object Identification Phase
728 //===----------------------------------------------------------------------===//
729
730 /// IdentifyObjects - This stage scans the program, adding an entry to the
731 /// GraphNodes list for each memory object in the program (global stack or
732 /// heap), and populates the ValueNodes and ObjectNodes maps for these objects.
733 ///
734 void Andersens::IdentifyObjects(Module &M) {
735   unsigned NumObjects = 0;
736
737   // Object #0 is always the universal set: the object that we don't know
738   // anything about.
739   assert(NumObjects == UniversalSet && "Something changed!");
740   ++NumObjects;
741
742   // Object #1 always represents the null pointer.
743   assert(NumObjects == NullPtr && "Something changed!");
744   ++NumObjects;
745
746   // Object #2 always represents the null object (the object pointed to by null)
747   assert(NumObjects == NullObject && "Something changed!");
748   ++NumObjects;
749
750   // Add all the globals first.
751   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
752        I != E; ++I) {
753     ObjectNodes[I] = NumObjects++;
754     ValueNodes[I] = NumObjects++;
755   }
756
757   // Add nodes for all of the functions and the instructions inside of them.
758   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
759     // The function itself is a memory object.
760     unsigned First = NumObjects;
761     ValueNodes[F] = NumObjects++;
762     if (isa<PointerType>(F->getFunctionType()->getReturnType()))
763       ReturnNodes[F] = NumObjects++;
764     if (F->getFunctionType()->isVarArg())
765       VarargNodes[F] = NumObjects++;
766
767
768     // Add nodes for all of the incoming pointer arguments.
769     for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
770          I != E; ++I)
771       {
772         if (isa<PointerType>(I->getType()))
773           ValueNodes[I] = NumObjects++;
774       }
775     MaxK[First] = NumObjects - First;
776
777     // Scan the function body, creating a memory object for each heap/stack
778     // allocation in the body of the function and a node to represent all
779     // pointer values defined by instructions and used as operands.
780     for (inst_iterator II = inst_begin(F), E = inst_end(F); II != E; ++II) {
781       // If this is an heap or stack allocation, create a node for the memory
782       // object.
783       if (isa<PointerType>(II->getType())) {
784         ValueNodes[&*II] = NumObjects++;
785         if (AllocationInst *AI = dyn_cast<AllocationInst>(&*II))
786           ObjectNodes[AI] = NumObjects++;
787       }
788
789       // Calls to inline asm need to be added as well because the callee isn't
790       // referenced anywhere else.
791       if (CallInst *CI = dyn_cast<CallInst>(&*II)) {
792         Value *Callee = CI->getCalledValue();
793         if (isa<InlineAsm>(Callee))
794           ValueNodes[Callee] = NumObjects++;
795       }
796     }
797   }
798
799   // Now that we know how many objects to create, make them all now!
800   GraphNodes.resize(NumObjects);
801   NumNodes += NumObjects;
802 }
803
804 //===----------------------------------------------------------------------===//
805 //                     Constraint Identification Phase
806 //===----------------------------------------------------------------------===//
807
808 /// getNodeForConstantPointer - Return the node corresponding to the constant
809 /// pointer itself.
810 unsigned Andersens::getNodeForConstantPointer(Constant *C) {
811   assert(isa<PointerType>(C->getType()) && "Not a constant pointer!");
812
813   if (isa<ConstantPointerNull>(C) || isa<UndefValue>(C))
814     return NullPtr;
815   else if (GlobalValue *GV = dyn_cast<GlobalValue>(C))
816     return getNode(GV);
817   else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
818     switch (CE->getOpcode()) {
819     case Instruction::GetElementPtr:
820       return getNodeForConstantPointer(CE->getOperand(0));
821     case Instruction::IntToPtr:
822       return UniversalSet;
823     case Instruction::BitCast:
824       return getNodeForConstantPointer(CE->getOperand(0));
825     default:
826       cerr << "Constant Expr not yet handled: " << *CE << "\n";
827       assert(0);
828     }
829   } else {
830     assert(0 && "Unknown constant pointer!");
831   }
832   return 0;
833 }
834
835 /// getNodeForConstantPointerTarget - Return the node POINTED TO by the
836 /// specified constant pointer.
837 unsigned Andersens::getNodeForConstantPointerTarget(Constant *C) {
838   assert(isa<PointerType>(C->getType()) && "Not a constant pointer!");
839
840   if (isa<ConstantPointerNull>(C))
841     return NullObject;
842   else if (GlobalValue *GV = dyn_cast<GlobalValue>(C))
843     return getObject(GV);
844   else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
845     switch (CE->getOpcode()) {
846     case Instruction::GetElementPtr:
847       return getNodeForConstantPointerTarget(CE->getOperand(0));
848     case Instruction::IntToPtr:
849       return UniversalSet;
850     case Instruction::BitCast:
851       return getNodeForConstantPointerTarget(CE->getOperand(0));
852     default:
853       cerr << "Constant Expr not yet handled: " << *CE << "\n";
854       assert(0);
855     }
856   } else {
857     assert(0 && "Unknown constant pointer!");
858   }
859   return 0;
860 }
861
862 /// AddGlobalInitializerConstraints - Add inclusion constraints for the memory
863 /// object N, which contains values indicated by C.
864 void Andersens::AddGlobalInitializerConstraints(unsigned NodeIndex,
865                                                 Constant *C) {
866   if (C->getType()->isSingleValueType()) {
867     if (isa<PointerType>(C->getType()))
868       Constraints.push_back(Constraint(Constraint::Copy, NodeIndex,
869                                        getNodeForConstantPointer(C)));
870   } else if (C->isNullValue()) {
871     Constraints.push_back(Constraint(Constraint::Copy, NodeIndex,
872                                      NullObject));
873     return;
874   } else if (!isa<UndefValue>(C)) {
875     // If this is an array or struct, include constraints for each element.
876     assert(isa<ConstantArray>(C) || isa<ConstantStruct>(C));
877     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
878       AddGlobalInitializerConstraints(NodeIndex,
879                                       cast<Constant>(C->getOperand(i)));
880   }
881 }
882
883 /// AddConstraintsForNonInternalLinkage - If this function does not have
884 /// internal linkage, realize that we can't trust anything passed into or
885 /// returned by this function.
886 void Andersens::AddConstraintsForNonInternalLinkage(Function *F) {
887   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
888     if (isa<PointerType>(I->getType()))
889       // If this is an argument of an externally accessible function, the
890       // incoming pointer might point to anything.
891       Constraints.push_back(Constraint(Constraint::Copy, getNode(I),
892                                        UniversalSet));
893 }
894
895 /// AddConstraintsForCall - If this is a call to a "known" function, add the
896 /// constraints and return true.  If this is a call to an unknown function,
897 /// return false.
898 bool Andersens::AddConstraintsForExternalCall(CallSite CS, Function *F) {
899   assert(F->isDeclaration() && "Not an external function!");
900
901   // These functions don't induce any points-to constraints.
902   if (F->getName() == "atoi" || F->getName() == "atof" ||
903       F->getName() == "atol" || F->getName() == "atoll" ||
904       F->getName() == "remove" || F->getName() == "unlink" ||
905       F->getName() == "rename" || F->getName() == "memcmp" ||
906       F->getName() == "llvm.memset" ||
907       F->getName() == "strcmp" || F->getName() == "strncmp" ||
908       F->getName() == "execl" || F->getName() == "execlp" ||
909       F->getName() == "execle" || F->getName() == "execv" ||
910       F->getName() == "execvp" || F->getName() == "chmod" ||
911       F->getName() == "puts" || F->getName() == "write" ||
912       F->getName() == "open" || F->getName() == "create" ||
913       F->getName() == "truncate" || F->getName() == "chdir" ||
914       F->getName() == "mkdir" || F->getName() == "rmdir" ||
915       F->getName() == "read" || F->getName() == "pipe" ||
916       F->getName() == "wait" || F->getName() == "time" ||
917       F->getName() == "stat" || F->getName() == "fstat" ||
918       F->getName() == "lstat" || F->getName() == "strtod" ||
919       F->getName() == "strtof" || F->getName() == "strtold" ||
920       F->getName() == "fopen" || F->getName() == "fdopen" ||
921       F->getName() == "freopen" ||
922       F->getName() == "fflush" || F->getName() == "feof" ||
923       F->getName() == "fileno" || F->getName() == "clearerr" ||
924       F->getName() == "rewind" || F->getName() == "ftell" ||
925       F->getName() == "ferror" || F->getName() == "fgetc" ||
926       F->getName() == "fgetc" || F->getName() == "_IO_getc" ||
927       F->getName() == "fwrite" || F->getName() == "fread" ||
928       F->getName() == "fgets" || F->getName() == "ungetc" ||
929       F->getName() == "fputc" ||
930       F->getName() == "fputs" || F->getName() == "putc" ||
931       F->getName() == "ftell" || F->getName() == "rewind" ||
932       F->getName() == "_IO_putc" || F->getName() == "fseek" ||
933       F->getName() == "fgetpos" || F->getName() == "fsetpos" ||
934       F->getName() == "printf" || F->getName() == "fprintf" ||
935       F->getName() == "sprintf" || F->getName() == "vprintf" ||
936       F->getName() == "vfprintf" || F->getName() == "vsprintf" ||
937       F->getName() == "scanf" || F->getName() == "fscanf" ||
938       F->getName() == "sscanf" || F->getName() == "__assert_fail" ||
939       F->getName() == "modf")
940     return true;
941
942
943   // These functions do induce points-to edges.
944   if (F->getName() == "llvm.memcpy" ||
945       F->getName() == "llvm.memmove" ||
946       F->getName() == "memmove") {
947
948     // *Dest = *Src, which requires an artificial graph node to represent the
949     // constraint.  It is broken up into *Dest = temp, temp = *Src
950     unsigned FirstArg = getNode(CS.getArgument(0));
951     unsigned SecondArg = getNode(CS.getArgument(1));
952     unsigned TempArg = GraphNodes.size();
953     GraphNodes.push_back(Node());
954     Constraints.push_back(Constraint(Constraint::Store,
955                                      FirstArg, TempArg));
956     Constraints.push_back(Constraint(Constraint::Load,
957                                      TempArg, SecondArg));
958     // In addition, Dest = Src
959     Constraints.push_back(Constraint(Constraint::Copy,
960                                      FirstArg, SecondArg));
961     return true;
962   }
963
964   // Result = Arg0
965   if (F->getName() == "realloc" || F->getName() == "strchr" ||
966       F->getName() == "strrchr" || F->getName() == "strstr" ||
967       F->getName() == "strtok") {
968     Constraints.push_back(Constraint(Constraint::Copy,
969                                      getNode(CS.getInstruction()),
970                                      getNode(CS.getArgument(0))));
971     return true;
972   }
973
974   return false;
975 }
976
977
978
979 /// AnalyzeUsesOfFunction - Look at all of the users of the specified function.
980 /// If this is used by anything complex (i.e., the address escapes), return
981 /// true.
982 bool Andersens::AnalyzeUsesOfFunction(Value *V) {
983
984   if (!isa<PointerType>(V->getType())) return true;
985
986   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
987     if (dyn_cast<LoadInst>(*UI)) {
988       return false;
989     } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
990       if (V == SI->getOperand(1)) {
991         return false;
992       } else if (SI->getOperand(1)) {
993         return true;  // Storing the pointer
994       }
995     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(*UI)) {
996       if (AnalyzeUsesOfFunction(GEP)) return true;
997     } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
998       // Make sure that this is just the function being called, not that it is
999       // passing into the function.
1000       for (unsigned i = 1, e = CI->getNumOperands(); i != e; ++i)
1001         if (CI->getOperand(i) == V) return true;
1002     } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
1003       // Make sure that this is just the function being called, not that it is
1004       // passing into the function.
1005       for (unsigned i = 3, e = II->getNumOperands(); i != e; ++i)
1006         if (II->getOperand(i) == V) return true;
1007     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
1008       if (CE->getOpcode() == Instruction::GetElementPtr ||
1009           CE->getOpcode() == Instruction::BitCast) {
1010         if (AnalyzeUsesOfFunction(CE))
1011           return true;
1012       } else {
1013         return true;
1014       }
1015     } else if (ICmpInst *ICI = dyn_cast<ICmpInst>(*UI)) {
1016       if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1017         return true;  // Allow comparison against null.
1018     } else if (dyn_cast<FreeInst>(*UI)) {
1019       return false;
1020     } else {
1021       return true;
1022     }
1023   return false;
1024 }
1025
1026 /// CollectConstraints - This stage scans the program, adding a constraint to
1027 /// the Constraints list for each instruction in the program that induces a
1028 /// constraint, and setting up the initial points-to graph.
1029 ///
1030 void Andersens::CollectConstraints(Module &M) {
1031   // First, the universal set points to itself.
1032   Constraints.push_back(Constraint(Constraint::AddressOf, UniversalSet,
1033                                    UniversalSet));
1034   Constraints.push_back(Constraint(Constraint::Store, UniversalSet,
1035                                    UniversalSet));
1036
1037   // Next, the null pointer points to the null object.
1038   Constraints.push_back(Constraint(Constraint::AddressOf, NullPtr, NullObject));
1039
1040   // Next, add any constraints on global variables and their initializers.
1041   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1042        I != E; ++I) {
1043     // Associate the address of the global object as pointing to the memory for
1044     // the global: &G = <G memory>
1045     unsigned ObjectIndex = getObject(I);
1046     Node *Object = &GraphNodes[ObjectIndex];
1047     Object->setValue(I);
1048     Constraints.push_back(Constraint(Constraint::AddressOf, getNodeValue(*I),
1049                                      ObjectIndex));
1050
1051     if (I->hasInitializer()) {
1052       AddGlobalInitializerConstraints(ObjectIndex, I->getInitializer());
1053     } else {
1054       // If it doesn't have an initializer (i.e. it's defined in another
1055       // translation unit), it points to the universal set.
1056       Constraints.push_back(Constraint(Constraint::Copy, ObjectIndex,
1057                                        UniversalSet));
1058     }
1059   }
1060
1061   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
1062     // Set up the return value node.
1063     if (isa<PointerType>(F->getFunctionType()->getReturnType()))
1064       GraphNodes[getReturnNode(F)].setValue(F);
1065     if (F->getFunctionType()->isVarArg())
1066       GraphNodes[getVarargNode(F)].setValue(F);
1067
1068     // Set up incoming argument nodes.
1069     for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
1070          I != E; ++I)
1071       if (isa<PointerType>(I->getType()))
1072         getNodeValue(*I);
1073
1074     // At some point we should just add constraints for the escaping functions
1075     // at solve time, but this slows down solving. For now, we simply mark
1076     // address taken functions as escaping and treat them as external.
1077     if (!F->hasInternalLinkage() || AnalyzeUsesOfFunction(F))
1078       AddConstraintsForNonInternalLinkage(F);
1079
1080     if (!F->isDeclaration()) {
1081       // Scan the function body, creating a memory object for each heap/stack
1082       // allocation in the body of the function and a node to represent all
1083       // pointer values defined by instructions and used as operands.
1084       visit(F);
1085     } else {
1086       // External functions that return pointers return the universal set.
1087       if (isa<PointerType>(F->getFunctionType()->getReturnType()))
1088         Constraints.push_back(Constraint(Constraint::Copy,
1089                                          getReturnNode(F),
1090                                          UniversalSet));
1091
1092       // Any pointers that are passed into the function have the universal set
1093       // stored into them.
1094       for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
1095            I != E; ++I)
1096         if (isa<PointerType>(I->getType())) {
1097           // Pointers passed into external functions could have anything stored
1098           // through them.
1099           Constraints.push_back(Constraint(Constraint::Store, getNode(I),
1100                                            UniversalSet));
1101           // Memory objects passed into external function calls can have the
1102           // universal set point to them.
1103 #if FULL_UNIVERSAL
1104           Constraints.push_back(Constraint(Constraint::Copy,
1105                                            UniversalSet,
1106                                            getNode(I)));
1107 #else
1108           Constraints.push_back(Constraint(Constraint::Copy,
1109                                            getNode(I),
1110                                            UniversalSet));
1111 #endif
1112         }
1113
1114       // If this is an external varargs function, it can also store pointers
1115       // into any pointers passed through the varargs section.
1116       if (F->getFunctionType()->isVarArg())
1117         Constraints.push_back(Constraint(Constraint::Store, getVarargNode(F),
1118                                          UniversalSet));
1119     }
1120   }
1121   NumConstraints += Constraints.size();
1122 }
1123
1124
1125 void Andersens::visitInstruction(Instruction &I) {
1126 #ifdef NDEBUG
1127   return;          // This function is just a big assert.
1128 #endif
1129   if (isa<BinaryOperator>(I))
1130     return;
1131   // Most instructions don't have any effect on pointer values.
1132   switch (I.getOpcode()) {
1133   case Instruction::Br:
1134   case Instruction::Switch:
1135   case Instruction::Unwind:
1136   case Instruction::Unreachable:
1137   case Instruction::Free:
1138   case Instruction::ICmp:
1139   case Instruction::FCmp:
1140     return;
1141   default:
1142     // Is this something we aren't handling yet?
1143     cerr << "Unknown instruction: " << I;
1144     abort();
1145   }
1146 }
1147
1148 void Andersens::visitAllocationInst(AllocationInst &AI) {
1149   unsigned ObjectIndex = getObject(&AI);
1150   GraphNodes[ObjectIndex].setValue(&AI);
1151   Constraints.push_back(Constraint(Constraint::AddressOf, getNodeValue(AI),
1152                                    ObjectIndex));
1153 }
1154
1155 void Andersens::visitReturnInst(ReturnInst &RI) {
1156   if (RI.getNumOperands() && isa<PointerType>(RI.getOperand(0)->getType()))
1157     // return V   -->   <Copy/retval{F}/v>
1158     Constraints.push_back(Constraint(Constraint::Copy,
1159                                      getReturnNode(RI.getParent()->getParent()),
1160                                      getNode(RI.getOperand(0))));
1161 }
1162
1163 void Andersens::visitLoadInst(LoadInst &LI) {
1164   if (isa<PointerType>(LI.getType()))
1165     // P1 = load P2  -->  <Load/P1/P2>
1166     Constraints.push_back(Constraint(Constraint::Load, getNodeValue(LI),
1167                                      getNode(LI.getOperand(0))));
1168 }
1169
1170 void Andersens::visitStoreInst(StoreInst &SI) {
1171   if (isa<PointerType>(SI.getOperand(0)->getType()))
1172     // store P1, P2  -->  <Store/P2/P1>
1173     Constraints.push_back(Constraint(Constraint::Store,
1174                                      getNode(SI.getOperand(1)),
1175                                      getNode(SI.getOperand(0))));
1176 }
1177
1178 void Andersens::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1179   // P1 = getelementptr P2, ... --> <Copy/P1/P2>
1180   Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(GEP),
1181                                    getNode(GEP.getOperand(0))));
1182 }
1183
1184 void Andersens::visitPHINode(PHINode &PN) {
1185   if (isa<PointerType>(PN.getType())) {
1186     unsigned PNN = getNodeValue(PN);
1187     for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
1188       // P1 = phi P2, P3  -->  <Copy/P1/P2>, <Copy/P1/P3>, ...
1189       Constraints.push_back(Constraint(Constraint::Copy, PNN,
1190                                        getNode(PN.getIncomingValue(i))));
1191   }
1192 }
1193
1194 void Andersens::visitCastInst(CastInst &CI) {
1195   Value *Op = CI.getOperand(0);
1196   if (isa<PointerType>(CI.getType())) {
1197     if (isa<PointerType>(Op->getType())) {
1198       // P1 = cast P2  --> <Copy/P1/P2>
1199       Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(CI),
1200                                        getNode(CI.getOperand(0))));
1201     } else {
1202       // P1 = cast int --> <Copy/P1/Univ>
1203 #if 0
1204       Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(CI),
1205                                        UniversalSet));
1206 #else
1207       getNodeValue(CI);
1208 #endif
1209     }
1210   } else if (isa<PointerType>(Op->getType())) {
1211     // int = cast P1 --> <Copy/Univ/P1>
1212 #if 0
1213     Constraints.push_back(Constraint(Constraint::Copy,
1214                                      UniversalSet,
1215                                      getNode(CI.getOperand(0))));
1216 #else
1217     getNode(CI.getOperand(0));
1218 #endif
1219   }
1220 }
1221
1222 void Andersens::visitSelectInst(SelectInst &SI) {
1223   if (isa<PointerType>(SI.getType())) {
1224     unsigned SIN = getNodeValue(SI);
1225     // P1 = select C, P2, P3   ---> <Copy/P1/P2>, <Copy/P1/P3>
1226     Constraints.push_back(Constraint(Constraint::Copy, SIN,
1227                                      getNode(SI.getOperand(1))));
1228     Constraints.push_back(Constraint(Constraint::Copy, SIN,
1229                                      getNode(SI.getOperand(2))));
1230   }
1231 }
1232
1233 void Andersens::visitVAArg(VAArgInst &I) {
1234   assert(0 && "vaarg not handled yet!");
1235 }
1236
1237 /// AddConstraintsForCall - Add constraints for a call with actual arguments
1238 /// specified by CS to the function specified by F.  Note that the types of
1239 /// arguments might not match up in the case where this is an indirect call and
1240 /// the function pointer has been casted.  If this is the case, do something
1241 /// reasonable.
1242 void Andersens::AddConstraintsForCall(CallSite CS, Function *F) {
1243   Value *CallValue = CS.getCalledValue();
1244   bool IsDeref = F == NULL;
1245
1246   // If this is a call to an external function, try to handle it directly to get
1247   // some taste of context sensitivity.
1248   if (F && F->isDeclaration() && AddConstraintsForExternalCall(CS, F))
1249     return;
1250
1251   if (isa<PointerType>(CS.getType())) {
1252     unsigned CSN = getNode(CS.getInstruction());
1253     if (!F || isa<PointerType>(F->getFunctionType()->getReturnType())) {
1254       if (IsDeref)
1255         Constraints.push_back(Constraint(Constraint::Load, CSN,
1256                                          getNode(CallValue), CallReturnPos));
1257       else
1258         Constraints.push_back(Constraint(Constraint::Copy, CSN,
1259                                          getNode(CallValue) + CallReturnPos));
1260     } else {
1261       // If the function returns a non-pointer value, handle this just like we
1262       // treat a nonpointer cast to pointer.
1263       Constraints.push_back(Constraint(Constraint::Copy, CSN,
1264                                        UniversalSet));
1265     }
1266   } else if (F && isa<PointerType>(F->getFunctionType()->getReturnType())) {
1267 #if FULL_UNIVERSAL
1268     Constraints.push_back(Constraint(Constraint::Copy,
1269                                      UniversalSet,
1270                                      getNode(CallValue) + CallReturnPos));
1271 #else
1272     Constraints.push_back(Constraint(Constraint::Copy,
1273                                       getNode(CallValue) + CallReturnPos,
1274                                       UniversalSet));
1275 #endif
1276                           
1277     
1278   }
1279
1280   CallSite::arg_iterator ArgI = CS.arg_begin(), ArgE = CS.arg_end();
1281   bool external = !F ||  F->isDeclaration();
1282   if (F) {
1283     // Direct Call
1284     Function::arg_iterator AI = F->arg_begin(), AE = F->arg_end();
1285     for (; AI != AE && ArgI != ArgE; ++AI, ++ArgI) 
1286       {
1287 #if !FULL_UNIVERSAL
1288         if (external && isa<PointerType>((*ArgI)->getType())) 
1289           {
1290             // Add constraint that ArgI can now point to anything due to
1291             // escaping, as can everything it points to. The second portion of
1292             // this should be taken care of by universal = *universal
1293             Constraints.push_back(Constraint(Constraint::Copy,
1294                                              getNode(*ArgI),
1295                                              UniversalSet));
1296           }
1297 #endif
1298         if (isa<PointerType>(AI->getType())) {
1299           if (isa<PointerType>((*ArgI)->getType())) {
1300             // Copy the actual argument into the formal argument.
1301             Constraints.push_back(Constraint(Constraint::Copy, getNode(AI),
1302                                              getNode(*ArgI)));
1303           } else {
1304             Constraints.push_back(Constraint(Constraint::Copy, getNode(AI),
1305                                              UniversalSet));
1306           }
1307         } else if (isa<PointerType>((*ArgI)->getType())) {
1308 #if FULL_UNIVERSAL
1309           Constraints.push_back(Constraint(Constraint::Copy,
1310                                            UniversalSet,
1311                                            getNode(*ArgI)));
1312 #else
1313           Constraints.push_back(Constraint(Constraint::Copy,
1314                                            getNode(*ArgI),
1315                                            UniversalSet));
1316 #endif
1317         }
1318       }
1319   } else {
1320     //Indirect Call
1321     unsigned ArgPos = CallFirstArgPos;
1322     for (; ArgI != ArgE; ++ArgI) {
1323       if (isa<PointerType>((*ArgI)->getType())) {
1324         // Copy the actual argument into the formal argument.
1325         Constraints.push_back(Constraint(Constraint::Store,
1326                                          getNode(CallValue),
1327                                          getNode(*ArgI), ArgPos++));
1328       } else {
1329         Constraints.push_back(Constraint(Constraint::Store,
1330                                          getNode (CallValue),
1331                                          UniversalSet, ArgPos++));
1332       }
1333     }
1334   }
1335   // Copy all pointers passed through the varargs section to the varargs node.
1336   if (F && F->getFunctionType()->isVarArg())
1337     for (; ArgI != ArgE; ++ArgI)
1338       if (isa<PointerType>((*ArgI)->getType()))
1339         Constraints.push_back(Constraint(Constraint::Copy, getVarargNode(F),
1340                                          getNode(*ArgI)));
1341   // If more arguments are passed in than we track, just drop them on the floor.
1342 }
1343
1344 void Andersens::visitCallSite(CallSite CS) {
1345   if (isa<PointerType>(CS.getType()))
1346     getNodeValue(*CS.getInstruction());
1347
1348   if (Function *F = CS.getCalledFunction()) {
1349     AddConstraintsForCall(CS, F);
1350   } else {
1351     AddConstraintsForCall(CS, NULL);
1352   }
1353 }
1354
1355 //===----------------------------------------------------------------------===//
1356 //                         Constraint Solving Phase
1357 //===----------------------------------------------------------------------===//
1358
1359 /// intersects - Return true if the points-to set of this node intersects
1360 /// with the points-to set of the specified node.
1361 bool Andersens::Node::intersects(Node *N) const {
1362   return PointsTo->intersects(N->PointsTo);
1363 }
1364
1365 /// intersectsIgnoring - Return true if the points-to set of this node
1366 /// intersects with the points-to set of the specified node on any nodes
1367 /// except for the specified node to ignore.
1368 bool Andersens::Node::intersectsIgnoring(Node *N, unsigned Ignoring) const {
1369   // TODO: If we are only going to call this with the same value for Ignoring,
1370   // we should move the special values out of the points-to bitmap.
1371   bool WeHadIt = PointsTo->test(Ignoring);
1372   bool NHadIt = N->PointsTo->test(Ignoring);
1373   bool Result = false;
1374   if (WeHadIt)
1375     PointsTo->reset(Ignoring);
1376   if (NHadIt)
1377     N->PointsTo->reset(Ignoring);
1378   Result = PointsTo->intersects(N->PointsTo);
1379   if (WeHadIt)
1380     PointsTo->set(Ignoring);
1381   if (NHadIt)
1382     N->PointsTo->set(Ignoring);
1383   return Result;
1384 }
1385
1386 void dumpToDOUT(SparseBitVector<> *bitmap) {
1387 #ifndef NDEBUG
1388   dump(*bitmap, DOUT);
1389 #endif
1390 }
1391
1392
1393 /// Clump together address taken variables so that the points-to sets use up
1394 /// less space and can be operated on faster.
1395
1396 void Andersens::ClumpAddressTaken() {
1397 #undef DEBUG_TYPE
1398 #define DEBUG_TYPE "anders-aa-renumber"
1399   std::vector<unsigned> Translate;
1400   std::vector<Node> NewGraphNodes;
1401
1402   Translate.resize(GraphNodes.size());
1403   unsigned NewPos = 0;
1404
1405   for (unsigned i = 0; i < Constraints.size(); ++i) {
1406     Constraint &C = Constraints[i];
1407     if (C.Type == Constraint::AddressOf) {
1408       GraphNodes[C.Src].AddressTaken = true;
1409     }
1410   }
1411   for (unsigned i = 0; i < NumberSpecialNodes; ++i) {
1412     unsigned Pos = NewPos++;
1413     Translate[i] = Pos;
1414     NewGraphNodes.push_back(GraphNodes[i]);
1415     DOUT << "Renumbering node " << i << " to node " << Pos << "\n";
1416   }
1417
1418   // I believe this ends up being faster than making two vectors and splicing
1419   // them.
1420   for (unsigned i = NumberSpecialNodes; i < GraphNodes.size(); ++i) {
1421     if (GraphNodes[i].AddressTaken) {
1422       unsigned Pos = NewPos++;
1423       Translate[i] = Pos;
1424       NewGraphNodes.push_back(GraphNodes[i]);
1425       DOUT << "Renumbering node " << i << " to node " << Pos << "\n";
1426     }
1427   }
1428
1429   for (unsigned i = NumberSpecialNodes; i < GraphNodes.size(); ++i) {
1430     if (!GraphNodes[i].AddressTaken) {
1431       unsigned Pos = NewPos++;
1432       Translate[i] = Pos;
1433       NewGraphNodes.push_back(GraphNodes[i]);
1434       DOUT << "Renumbering node " << i << " to node " << Pos << "\n";
1435     }
1436   }
1437
1438   for (DenseMap<Value*, unsigned>::iterator Iter = ValueNodes.begin();
1439        Iter != ValueNodes.end();
1440        ++Iter)
1441     Iter->second = Translate[Iter->second];
1442
1443   for (DenseMap<Value*, unsigned>::iterator Iter = ObjectNodes.begin();
1444        Iter != ObjectNodes.end();
1445        ++Iter)
1446     Iter->second = Translate[Iter->second];
1447
1448   for (DenseMap<Function*, unsigned>::iterator Iter = ReturnNodes.begin();
1449        Iter != ReturnNodes.end();
1450        ++Iter)
1451     Iter->second = Translate[Iter->second];
1452
1453   for (DenseMap<Function*, unsigned>::iterator Iter = VarargNodes.begin();
1454        Iter != VarargNodes.end();
1455        ++Iter)
1456     Iter->second = Translate[Iter->second];
1457
1458   for (unsigned i = 0; i < Constraints.size(); ++i) {
1459     Constraint &C = Constraints[i];
1460     C.Src = Translate[C.Src];
1461     C.Dest = Translate[C.Dest];
1462   }
1463
1464   GraphNodes.swap(NewGraphNodes);
1465 #undef DEBUG_TYPE
1466 #define DEBUG_TYPE "anders-aa"
1467 }
1468
1469 /// The technique used here is described in "Exploiting Pointer and Location
1470 /// Equivalence to Optimize Pointer Analysis. In the 14th International Static
1471 /// Analysis Symposium (SAS), August 2007."  It is known as the "HVN" algorithm,
1472 /// and is equivalent to value numbering the collapsed constraint graph without
1473 /// evaluating unions.  This is used as a pre-pass to HU in order to resolve
1474 /// first order pointer dereferences and speed up/reduce memory usage of HU.
1475 /// Running both is equivalent to HRU without the iteration
1476 /// HVN in more detail:
1477 /// Imagine the set of constraints was simply straight line code with no loops
1478 /// (we eliminate cycles, so there are no loops), such as:
1479 /// E = &D
1480 /// E = &C
1481 /// E = F
1482 /// F = G
1483 /// G = F
1484 /// Applying value numbering to this code tells us:
1485 /// G == F == E
1486 ///
1487 /// For HVN, this is as far as it goes.  We assign new value numbers to every
1488 /// "address node", and every "reference node".
1489 /// To get the optimal result for this, we use a DFS + SCC (since all nodes in a
1490 /// cycle must have the same value number since the = operation is really
1491 /// inclusion, not overwrite), and value number nodes we receive points-to sets
1492 /// before we value our own node.
1493 /// The advantage of HU over HVN is that HU considers the inclusion property, so
1494 /// that if you have
1495 /// E = &D
1496 /// E = &C
1497 /// E = F
1498 /// F = G
1499 /// F = &D
1500 /// G = F
1501 /// HU will determine that G == F == E.  HVN will not, because it cannot prove
1502 /// that the points to information ends up being the same because they all
1503 /// receive &D from E anyway.
1504
1505 void Andersens::HVN() {
1506   DOUT << "Beginning HVN\n";
1507   // Build a predecessor graph.  This is like our constraint graph with the
1508   // edges going in the opposite direction, and there are edges for all the
1509   // constraints, instead of just copy constraints.  We also build implicit
1510   // edges for constraints are implied but not explicit.  I.E for the constraint
1511   // a = &b, we add implicit edges *a = b.  This helps us capture more cycles
1512   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1513     Constraint &C = Constraints[i];
1514     if (C.Type == Constraint::AddressOf) {
1515       GraphNodes[C.Src].AddressTaken = true;
1516       GraphNodes[C.Src].Direct = false;
1517
1518       // Dest = &src edge
1519       unsigned AdrNode = C.Src + FirstAdrNode;
1520       if (!GraphNodes[C.Dest].PredEdges)
1521         GraphNodes[C.Dest].PredEdges = new SparseBitVector<>;
1522       GraphNodes[C.Dest].PredEdges->set(AdrNode);
1523
1524       // *Dest = src edge
1525       unsigned RefNode = C.Dest + FirstRefNode;
1526       if (!GraphNodes[RefNode].ImplicitPredEdges)
1527         GraphNodes[RefNode].ImplicitPredEdges = new SparseBitVector<>;
1528       GraphNodes[RefNode].ImplicitPredEdges->set(C.Src);
1529     } else if (C.Type == Constraint::Load) {
1530       if (C.Offset == 0) {
1531         // dest = *src edge
1532         if (!GraphNodes[C.Dest].PredEdges)
1533           GraphNodes[C.Dest].PredEdges = new SparseBitVector<>;
1534         GraphNodes[C.Dest].PredEdges->set(C.Src + FirstRefNode);
1535       } else {
1536         GraphNodes[C.Dest].Direct = false;
1537       }
1538     } else if (C.Type == Constraint::Store) {
1539       if (C.Offset == 0) {
1540         // *dest = src edge
1541         unsigned RefNode = C.Dest + FirstRefNode;
1542         if (!GraphNodes[RefNode].PredEdges)
1543           GraphNodes[RefNode].PredEdges = new SparseBitVector<>;
1544         GraphNodes[RefNode].PredEdges->set(C.Src);
1545       }
1546     } else {
1547       // Dest = Src edge and *Dest = *Src edge
1548       if (!GraphNodes[C.Dest].PredEdges)
1549         GraphNodes[C.Dest].PredEdges = new SparseBitVector<>;
1550       GraphNodes[C.Dest].PredEdges->set(C.Src);
1551       unsigned RefNode = C.Dest + FirstRefNode;
1552       if (!GraphNodes[RefNode].ImplicitPredEdges)
1553         GraphNodes[RefNode].ImplicitPredEdges = new SparseBitVector<>;
1554       GraphNodes[RefNode].ImplicitPredEdges->set(C.Src + FirstRefNode);
1555     }
1556   }
1557   PEClass = 1;
1558   // Do SCC finding first to condense our predecessor graph
1559   DFSNumber = 0;
1560   Node2DFS.insert(Node2DFS.begin(), GraphNodes.size(), 0);
1561   Node2Deleted.insert(Node2Deleted.begin(), GraphNodes.size(), false);
1562   Node2Visited.insert(Node2Visited.begin(), GraphNodes.size(), false);
1563
1564   for (unsigned i = 0; i < FirstRefNode; ++i) {
1565     unsigned Node = VSSCCRep[i];
1566     if (!Node2Visited[Node])
1567       HVNValNum(Node);
1568   }
1569   for (BitVectorMap::iterator Iter = Set2PEClass.begin();
1570        Iter != Set2PEClass.end();
1571        ++Iter)
1572     delete Iter->first;
1573   Set2PEClass.clear();
1574   Node2DFS.clear();
1575   Node2Deleted.clear();
1576   Node2Visited.clear();
1577   DOUT << "Finished HVN\n";
1578
1579 }
1580
1581 /// This is the workhorse of HVN value numbering. We combine SCC finding at the
1582 /// same time because it's easy.
1583 void Andersens::HVNValNum(unsigned NodeIndex) {
1584   unsigned MyDFS = DFSNumber++;
1585   Node *N = &GraphNodes[NodeIndex];
1586   Node2Visited[NodeIndex] = true;
1587   Node2DFS[NodeIndex] = MyDFS;
1588
1589   // First process all our explicit edges
1590   if (N->PredEdges)
1591     for (SparseBitVector<>::iterator Iter = N->PredEdges->begin();
1592          Iter != N->PredEdges->end();
1593          ++Iter) {
1594       unsigned j = VSSCCRep[*Iter];
1595       if (!Node2Deleted[j]) {
1596         if (!Node2Visited[j])
1597           HVNValNum(j);
1598         if (Node2DFS[NodeIndex] > Node2DFS[j])
1599           Node2DFS[NodeIndex] = Node2DFS[j];
1600       }
1601     }
1602
1603   // Now process all the implicit edges
1604   if (N->ImplicitPredEdges)
1605     for (SparseBitVector<>::iterator Iter = N->ImplicitPredEdges->begin();
1606          Iter != N->ImplicitPredEdges->end();
1607          ++Iter) {
1608       unsigned j = VSSCCRep[*Iter];
1609       if (!Node2Deleted[j]) {
1610         if (!Node2Visited[j])
1611           HVNValNum(j);
1612         if (Node2DFS[NodeIndex] > Node2DFS[j])
1613           Node2DFS[NodeIndex] = Node2DFS[j];
1614       }
1615     }
1616
1617   // See if we found any cycles
1618   if (MyDFS == Node2DFS[NodeIndex]) {
1619     while (!SCCStack.empty() && Node2DFS[SCCStack.top()] >= MyDFS) {
1620       unsigned CycleNodeIndex = SCCStack.top();
1621       Node *CycleNode = &GraphNodes[CycleNodeIndex];
1622       VSSCCRep[CycleNodeIndex] = NodeIndex;
1623       // Unify the nodes
1624       N->Direct &= CycleNode->Direct;
1625
1626       if (CycleNode->PredEdges) {
1627         if (!N->PredEdges)
1628           N->PredEdges = new SparseBitVector<>;
1629         *(N->PredEdges) |= CycleNode->PredEdges;
1630         delete CycleNode->PredEdges;
1631         CycleNode->PredEdges = NULL;
1632       }
1633       if (CycleNode->ImplicitPredEdges) {
1634         if (!N->ImplicitPredEdges)
1635           N->ImplicitPredEdges = new SparseBitVector<>;
1636         *(N->ImplicitPredEdges) |= CycleNode->ImplicitPredEdges;
1637         delete CycleNode->ImplicitPredEdges;
1638         CycleNode->ImplicitPredEdges = NULL;
1639       }
1640
1641       SCCStack.pop();
1642     }
1643
1644     Node2Deleted[NodeIndex] = true;
1645
1646     if (!N->Direct) {
1647       GraphNodes[NodeIndex].PointerEquivLabel = PEClass++;
1648       return;
1649     }
1650
1651     // Collect labels of successor nodes
1652     bool AllSame = true;
1653     unsigned First = ~0;
1654     SparseBitVector<> *Labels = new SparseBitVector<>;
1655     bool Used = false;
1656
1657     if (N->PredEdges)
1658       for (SparseBitVector<>::iterator Iter = N->PredEdges->begin();
1659            Iter != N->PredEdges->end();
1660          ++Iter) {
1661         unsigned j = VSSCCRep[*Iter];
1662         unsigned Label = GraphNodes[j].PointerEquivLabel;
1663         // Ignore labels that are equal to us or non-pointers
1664         if (j == NodeIndex || Label == 0)
1665           continue;
1666         if (First == (unsigned)~0)
1667           First = Label;
1668         else if (First != Label)
1669           AllSame = false;
1670         Labels->set(Label);
1671     }
1672
1673     // We either have a non-pointer, a copy of an existing node, or a new node.
1674     // Assign the appropriate pointer equivalence label.
1675     if (Labels->empty()) {
1676       GraphNodes[NodeIndex].PointerEquivLabel = 0;
1677     } else if (AllSame) {
1678       GraphNodes[NodeIndex].PointerEquivLabel = First;
1679     } else {
1680       GraphNodes[NodeIndex].PointerEquivLabel = Set2PEClass[Labels];
1681       if (GraphNodes[NodeIndex].PointerEquivLabel == 0) {
1682         unsigned EquivClass = PEClass++;
1683         Set2PEClass[Labels] = EquivClass;
1684         GraphNodes[NodeIndex].PointerEquivLabel = EquivClass;
1685         Used = true;
1686       }
1687     }
1688     if (!Used)
1689       delete Labels;
1690   } else {
1691     SCCStack.push(NodeIndex);
1692   }
1693 }
1694
1695 /// The technique used here is described in "Exploiting Pointer and Location
1696 /// Equivalence to Optimize Pointer Analysis. In the 14th International Static
1697 /// Analysis Symposium (SAS), August 2007."  It is known as the "HU" algorithm,
1698 /// and is equivalent to value numbering the collapsed constraint graph
1699 /// including evaluating unions.
1700 void Andersens::HU() {
1701   DOUT << "Beginning HU\n";
1702   // Build a predecessor graph.  This is like our constraint graph with the
1703   // edges going in the opposite direction, and there are edges for all the
1704   // constraints, instead of just copy constraints.  We also build implicit
1705   // edges for constraints are implied but not explicit.  I.E for the constraint
1706   // a = &b, we add implicit edges *a = b.  This helps us capture more cycles
1707   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1708     Constraint &C = Constraints[i];
1709     if (C.Type == Constraint::AddressOf) {
1710       GraphNodes[C.Src].AddressTaken = true;
1711       GraphNodes[C.Src].Direct = false;
1712
1713       GraphNodes[C.Dest].PointsTo->set(C.Src);
1714       // *Dest = src edge
1715       unsigned RefNode = C.Dest + FirstRefNode;
1716       if (!GraphNodes[RefNode].ImplicitPredEdges)
1717         GraphNodes[RefNode].ImplicitPredEdges = new SparseBitVector<>;
1718       GraphNodes[RefNode].ImplicitPredEdges->set(C.Src);
1719       GraphNodes[C.Src].PointedToBy->set(C.Dest);
1720     } else if (C.Type == Constraint::Load) {
1721       if (C.Offset == 0) {
1722         // dest = *src edge
1723         if (!GraphNodes[C.Dest].PredEdges)
1724           GraphNodes[C.Dest].PredEdges = new SparseBitVector<>;
1725         GraphNodes[C.Dest].PredEdges->set(C.Src + FirstRefNode);
1726       } else {
1727         GraphNodes[C.Dest].Direct = false;
1728       }
1729     } else if (C.Type == Constraint::Store) {
1730       if (C.Offset == 0) {
1731         // *dest = src edge
1732         unsigned RefNode = C.Dest + FirstRefNode;
1733         if (!GraphNodes[RefNode].PredEdges)
1734           GraphNodes[RefNode].PredEdges = new SparseBitVector<>;
1735         GraphNodes[RefNode].PredEdges->set(C.Src);
1736       }
1737     } else {
1738       // Dest = Src edge and *Dest = *Src edg
1739       if (!GraphNodes[C.Dest].PredEdges)
1740         GraphNodes[C.Dest].PredEdges = new SparseBitVector<>;
1741       GraphNodes[C.Dest].PredEdges->set(C.Src);
1742       unsigned RefNode = C.Dest + FirstRefNode;
1743       if (!GraphNodes[RefNode].ImplicitPredEdges)
1744         GraphNodes[RefNode].ImplicitPredEdges = new SparseBitVector<>;
1745       GraphNodes[RefNode].ImplicitPredEdges->set(C.Src + FirstRefNode);
1746     }
1747   }
1748   PEClass = 1;
1749   // Do SCC finding first to condense our predecessor graph
1750   DFSNumber = 0;
1751   Node2DFS.insert(Node2DFS.begin(), GraphNodes.size(), 0);
1752   Node2Deleted.insert(Node2Deleted.begin(), GraphNodes.size(), false);
1753   Node2Visited.insert(Node2Visited.begin(), GraphNodes.size(), false);
1754
1755   for (unsigned i = 0; i < FirstRefNode; ++i) {
1756     if (FindNode(i) == i) {
1757       unsigned Node = VSSCCRep[i];
1758       if (!Node2Visited[Node])
1759         Condense(Node);
1760     }
1761   }
1762
1763   // Reset tables for actual labeling
1764   Node2DFS.clear();
1765   Node2Visited.clear();
1766   Node2Deleted.clear();
1767   // Pre-grow our densemap so that we don't get really bad behavior
1768   Set2PEClass.resize(GraphNodes.size());
1769
1770   // Visit the condensed graph and generate pointer equivalence labels.
1771   Node2Visited.insert(Node2Visited.begin(), GraphNodes.size(), false);
1772   for (unsigned i = 0; i < FirstRefNode; ++i) {
1773     if (FindNode(i) == i) {
1774       unsigned Node = VSSCCRep[i];
1775       if (!Node2Visited[Node])
1776         HUValNum(Node);
1777     }
1778   }
1779   // PEClass nodes will be deleted by the deleting of N->PointsTo in our caller.
1780   Set2PEClass.clear();
1781   DOUT << "Finished HU\n";
1782 }
1783
1784
1785 /// Implementation of standard Tarjan SCC algorithm as modified by Nuutilla.
1786 void Andersens::Condense(unsigned NodeIndex) {
1787   unsigned MyDFS = DFSNumber++;
1788   Node *N = &GraphNodes[NodeIndex];
1789   Node2Visited[NodeIndex] = true;
1790   Node2DFS[NodeIndex] = MyDFS;
1791
1792   // First process all our explicit edges
1793   if (N->PredEdges)
1794     for (SparseBitVector<>::iterator Iter = N->PredEdges->begin();
1795          Iter != N->PredEdges->end();
1796          ++Iter) {
1797       unsigned j = VSSCCRep[*Iter];
1798       if (!Node2Deleted[j]) {
1799         if (!Node2Visited[j])
1800           Condense(j);
1801         if (Node2DFS[NodeIndex] > Node2DFS[j])
1802           Node2DFS[NodeIndex] = Node2DFS[j];
1803       }
1804     }
1805
1806   // Now process all the implicit edges
1807   if (N->ImplicitPredEdges)
1808     for (SparseBitVector<>::iterator Iter = N->ImplicitPredEdges->begin();
1809          Iter != N->ImplicitPredEdges->end();
1810          ++Iter) {
1811       unsigned j = VSSCCRep[*Iter];
1812       if (!Node2Deleted[j]) {
1813         if (!Node2Visited[j])
1814           Condense(j);
1815         if (Node2DFS[NodeIndex] > Node2DFS[j])
1816           Node2DFS[NodeIndex] = Node2DFS[j];
1817       }
1818     }
1819
1820   // See if we found any cycles
1821   if (MyDFS == Node2DFS[NodeIndex]) {
1822     while (!SCCStack.empty() && Node2DFS[SCCStack.top()] >= MyDFS) {
1823       unsigned CycleNodeIndex = SCCStack.top();
1824       Node *CycleNode = &GraphNodes[CycleNodeIndex];
1825       VSSCCRep[CycleNodeIndex] = NodeIndex;
1826       // Unify the nodes
1827       N->Direct &= CycleNode->Direct;
1828
1829       *(N->PointsTo) |= CycleNode->PointsTo;
1830       delete CycleNode->PointsTo;
1831       CycleNode->PointsTo = NULL;
1832       if (CycleNode->PredEdges) {
1833         if (!N->PredEdges)
1834           N->PredEdges = new SparseBitVector<>;
1835         *(N->PredEdges) |= CycleNode->PredEdges;
1836         delete CycleNode->PredEdges;
1837         CycleNode->PredEdges = NULL;
1838       }
1839       if (CycleNode->ImplicitPredEdges) {
1840         if (!N->ImplicitPredEdges)
1841           N->ImplicitPredEdges = new SparseBitVector<>;
1842         *(N->ImplicitPredEdges) |= CycleNode->ImplicitPredEdges;
1843         delete CycleNode->ImplicitPredEdges;
1844         CycleNode->ImplicitPredEdges = NULL;
1845       }
1846       SCCStack.pop();
1847     }
1848
1849     Node2Deleted[NodeIndex] = true;
1850
1851     // Set up number of incoming edges for other nodes
1852     if (N->PredEdges)
1853       for (SparseBitVector<>::iterator Iter = N->PredEdges->begin();
1854            Iter != N->PredEdges->end();
1855            ++Iter)
1856         ++GraphNodes[VSSCCRep[*Iter]].NumInEdges;
1857   } else {
1858     SCCStack.push(NodeIndex);
1859   }
1860 }
1861
1862 void Andersens::HUValNum(unsigned NodeIndex) {
1863   Node *N = &GraphNodes[NodeIndex];
1864   Node2Visited[NodeIndex] = true;
1865
1866   // Eliminate dereferences of non-pointers for those non-pointers we have
1867   // already identified.  These are ref nodes whose non-ref node:
1868   // 1. Has already been visited determined to point to nothing (and thus, a
1869   // dereference of it must point to nothing)
1870   // 2. Any direct node with no predecessor edges in our graph and with no
1871   // points-to set (since it can't point to anything either, being that it
1872   // receives no points-to sets and has none).
1873   if (NodeIndex >= FirstRefNode) {
1874     unsigned j = VSSCCRep[FindNode(NodeIndex - FirstRefNode)];
1875     if ((Node2Visited[j] && !GraphNodes[j].PointerEquivLabel)
1876         || (GraphNodes[j].Direct && !GraphNodes[j].PredEdges
1877             && GraphNodes[j].PointsTo->empty())){
1878       return;
1879     }
1880   }
1881     // Process all our explicit edges
1882   if (N->PredEdges)
1883     for (SparseBitVector<>::iterator Iter = N->PredEdges->begin();
1884          Iter != N->PredEdges->end();
1885          ++Iter) {
1886       unsigned j = VSSCCRep[*Iter];
1887       if (!Node2Visited[j])
1888         HUValNum(j);
1889
1890       // If this edge turned out to be the same as us, or got no pointer
1891       // equivalence label (and thus points to nothing) , just decrement our
1892       // incoming edges and continue.
1893       if (j == NodeIndex || GraphNodes[j].PointerEquivLabel == 0) {
1894         --GraphNodes[j].NumInEdges;
1895         continue;
1896       }
1897
1898       *(N->PointsTo) |= GraphNodes[j].PointsTo;
1899
1900       // If we didn't end up storing this in the hash, and we're done with all
1901       // the edges, we don't need the points-to set anymore.
1902       --GraphNodes[j].NumInEdges;
1903       if (!GraphNodes[j].NumInEdges && !GraphNodes[j].StoredInHash) {
1904         delete GraphNodes[j].PointsTo;
1905         GraphNodes[j].PointsTo = NULL;
1906       }
1907     }
1908   // If this isn't a direct node, generate a fresh variable.
1909   if (!N->Direct) {
1910     N->PointsTo->set(FirstRefNode + NodeIndex);
1911   }
1912
1913   // See If we have something equivalent to us, if not, generate a new
1914   // equivalence class.
1915   if (N->PointsTo->empty()) {
1916     delete N->PointsTo;
1917     N->PointsTo = NULL;
1918   } else {
1919     if (N->Direct) {
1920       N->PointerEquivLabel = Set2PEClass[N->PointsTo];
1921       if (N->PointerEquivLabel == 0) {
1922         unsigned EquivClass = PEClass++;
1923         N->StoredInHash = true;
1924         Set2PEClass[N->PointsTo] = EquivClass;
1925         N->PointerEquivLabel = EquivClass;
1926       }
1927     } else {
1928       N->PointerEquivLabel = PEClass++;
1929     }
1930   }
1931 }
1932
1933 /// Rewrite our list of constraints so that pointer equivalent nodes are
1934 /// replaced by their the pointer equivalence class representative.
1935 void Andersens::RewriteConstraints() {
1936   std::vector<Constraint> NewConstraints;
1937   DenseSet<Constraint, ConstraintKeyInfo> Seen;
1938
1939   PEClass2Node.clear();
1940   PENLEClass2Node.clear();
1941
1942   // We may have from 1 to Graphnodes + 1 equivalence classes.
1943   PEClass2Node.insert(PEClass2Node.begin(), GraphNodes.size() + 1, -1);
1944   PENLEClass2Node.insert(PENLEClass2Node.begin(), GraphNodes.size() + 1, -1);
1945
1946   // Rewrite constraints, ignoring non-pointer constraints, uniting equivalent
1947   // nodes, and rewriting constraints to use the representative nodes.
1948   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1949     Constraint &C = Constraints[i];
1950     unsigned RHSNode = FindNode(C.Src);
1951     unsigned LHSNode = FindNode(C.Dest);
1952     unsigned RHSLabel = GraphNodes[VSSCCRep[RHSNode]].PointerEquivLabel;
1953     unsigned LHSLabel = GraphNodes[VSSCCRep[LHSNode]].PointerEquivLabel;
1954
1955     // First we try to eliminate constraints for things we can prove don't point
1956     // to anything.
1957     if (LHSLabel == 0) {
1958       DEBUG(PrintNode(&GraphNodes[LHSNode]));
1959       DOUT << " is a non-pointer, ignoring constraint.\n";
1960       continue;
1961     }
1962     if (RHSLabel == 0) {
1963       DEBUG(PrintNode(&GraphNodes[RHSNode]));
1964       DOUT << " is a non-pointer, ignoring constraint.\n";
1965       continue;
1966     }
1967     // This constraint may be useless, and it may become useless as we translate
1968     // it.
1969     if (C.Src == C.Dest && C.Type == Constraint::Copy)
1970       continue;
1971
1972     C.Src = FindEquivalentNode(RHSNode, RHSLabel);
1973     C.Dest = FindEquivalentNode(FindNode(LHSNode), LHSLabel);
1974     if ((C.Src == C.Dest && C.Type == Constraint::Copy)
1975         || Seen.count(C))
1976       continue;
1977
1978     Seen.insert(C);
1979     NewConstraints.push_back(C);
1980   }
1981   Constraints.swap(NewConstraints);
1982   PEClass2Node.clear();
1983 }
1984
1985 /// See if we have a node that is pointer equivalent to the one being asked
1986 /// about, and if so, unite them and return the equivalent node.  Otherwise,
1987 /// return the original node.
1988 unsigned Andersens::FindEquivalentNode(unsigned NodeIndex,
1989                                        unsigned NodeLabel) {
1990   if (!GraphNodes[NodeIndex].AddressTaken) {
1991     if (PEClass2Node[NodeLabel] != -1) {
1992       // We found an existing node with the same pointer label, so unify them.
1993       // We specifically request that Union-By-Rank not be used so that
1994       // PEClass2Node[NodeLabel] U= NodeIndex and not the other way around.
1995       return UniteNodes(PEClass2Node[NodeLabel], NodeIndex, false);
1996     } else {
1997       PEClass2Node[NodeLabel] = NodeIndex;
1998       PENLEClass2Node[NodeLabel] = NodeIndex;
1999     }
2000   } else if (PENLEClass2Node[NodeLabel] == -1) {
2001     PENLEClass2Node[NodeLabel] = NodeIndex;
2002   }
2003
2004   return NodeIndex;
2005 }
2006
2007 void Andersens::PrintLabels() const {
2008   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2009     if (i < FirstRefNode) {
2010       PrintNode(&GraphNodes[i]);
2011     } else if (i < FirstAdrNode) {
2012       DOUT << "REF(";
2013       PrintNode(&GraphNodes[i-FirstRefNode]);
2014       DOUT <<")";
2015     } else {
2016       DOUT << "ADR(";
2017       PrintNode(&GraphNodes[i-FirstAdrNode]);
2018       DOUT <<")";
2019     }
2020
2021     DOUT << " has pointer label " << GraphNodes[i].PointerEquivLabel
2022          << " and SCC rep " << VSSCCRep[i]
2023          << " and is " << (GraphNodes[i].Direct ? "Direct" : "Not direct")
2024          << "\n";
2025   }
2026 }
2027
2028 /// The technique used here is described in "The Ant and the
2029 /// Grasshopper: Fast and Accurate Pointer Analysis for Millions of
2030 /// Lines of Code. In Programming Language Design and Implementation
2031 /// (PLDI), June 2007." It is known as the "HCD" (Hybrid Cycle
2032 /// Detection) algorithm. It is called a hybrid because it performs an
2033 /// offline analysis and uses its results during the solving (online)
2034 /// phase. This is just the offline portion; the results of this
2035 /// operation are stored in SDT and are later used in SolveContraints()
2036 /// and UniteNodes().
2037 void Andersens::HCD() {
2038   DOUT << "Starting HCD.\n";
2039   HCDSCCRep.resize(GraphNodes.size());
2040
2041   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2042     GraphNodes[i].Edges = new SparseBitVector<>;
2043     HCDSCCRep[i] = i;
2044   }
2045
2046   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
2047     Constraint &C = Constraints[i];
2048     assert (C.Src < GraphNodes.size() && C.Dest < GraphNodes.size());
2049     if (C.Type == Constraint::AddressOf) {
2050       continue;
2051     } else if (C.Type == Constraint::Load) {
2052       if( C.Offset == 0 )
2053         GraphNodes[C.Dest].Edges->set(C.Src + FirstRefNode);
2054     } else if (C.Type == Constraint::Store) {
2055       if( C.Offset == 0 )
2056         GraphNodes[C.Dest + FirstRefNode].Edges->set(C.Src);
2057     } else {
2058       GraphNodes[C.Dest].Edges->set(C.Src);
2059     }
2060   }
2061
2062   Node2DFS.insert(Node2DFS.begin(), GraphNodes.size(), 0);
2063   Node2Deleted.insert(Node2Deleted.begin(), GraphNodes.size(), false);
2064   Node2Visited.insert(Node2Visited.begin(), GraphNodes.size(), false);
2065   SDT.insert(SDT.begin(), GraphNodes.size() / 2, -1);
2066
2067   DFSNumber = 0;
2068   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2069     unsigned Node = HCDSCCRep[i];
2070     if (!Node2Deleted[Node])
2071       Search(Node);
2072   }
2073
2074   for (unsigned i = 0; i < GraphNodes.size(); ++i)
2075     if (GraphNodes[i].Edges != NULL) {
2076       delete GraphNodes[i].Edges;
2077       GraphNodes[i].Edges = NULL;
2078     }
2079
2080   while( !SCCStack.empty() )
2081     SCCStack.pop();
2082
2083   Node2DFS.clear();
2084   Node2Visited.clear();
2085   Node2Deleted.clear();
2086   HCDSCCRep.clear();
2087   DOUT << "HCD complete.\n";
2088 }
2089
2090 // Component of HCD: 
2091 // Use Nuutila's variant of Tarjan's algorithm to detect
2092 // Strongly-Connected Components (SCCs). For non-trivial SCCs
2093 // containing ref nodes, insert the appropriate information in SDT.
2094 void Andersens::Search(unsigned Node) {
2095   unsigned MyDFS = DFSNumber++;
2096
2097   Node2Visited[Node] = true;
2098   Node2DFS[Node] = MyDFS;
2099
2100   for (SparseBitVector<>::iterator Iter = GraphNodes[Node].Edges->begin(),
2101                                    End  = GraphNodes[Node].Edges->end();
2102        Iter != End;
2103        ++Iter) {
2104     unsigned J = HCDSCCRep[*Iter];
2105     assert(GraphNodes[J].isRep() && "Debug check; must be representative");
2106     if (!Node2Deleted[J]) {
2107       if (!Node2Visited[J])
2108         Search(J);
2109       if (Node2DFS[Node] > Node2DFS[J])
2110         Node2DFS[Node] = Node2DFS[J];
2111     }
2112   }
2113
2114   if( MyDFS != Node2DFS[Node] ) {
2115     SCCStack.push(Node);
2116     return;
2117   }
2118
2119   // This node is the root of a SCC, so process it.
2120   //
2121   // If the SCC is "non-trivial" (not a singleton) and contains a reference 
2122   // node, we place this SCC into SDT.  We unite the nodes in any case.
2123   if (!SCCStack.empty() && Node2DFS[SCCStack.top()] >= MyDFS) {
2124     SparseBitVector<> SCC;
2125
2126     SCC.set(Node);
2127
2128     bool Ref = (Node >= FirstRefNode);
2129
2130     Node2Deleted[Node] = true;
2131
2132     do {
2133       unsigned P = SCCStack.top(); SCCStack.pop();
2134       Ref |= (P >= FirstRefNode);
2135       SCC.set(P);
2136       HCDSCCRep[P] = Node;
2137     } while (!SCCStack.empty() && Node2DFS[SCCStack.top()] >= MyDFS);
2138
2139     if (Ref) {
2140       unsigned Rep = SCC.find_first();
2141       assert(Rep < FirstRefNode && "The SCC didn't have a non-Ref node!");
2142
2143       SparseBitVector<>::iterator i = SCC.begin();
2144
2145       // Skip over the non-ref nodes
2146       while( *i < FirstRefNode )
2147         ++i;
2148
2149       while( i != SCC.end() )
2150         SDT[ (*i++) - FirstRefNode ] = Rep;
2151     }
2152   }
2153 }
2154
2155
2156 /// Optimize the constraints by performing offline variable substitution and
2157 /// other optimizations.
2158 void Andersens::OptimizeConstraints() {
2159   DOUT << "Beginning constraint optimization\n";
2160
2161   SDTActive = false;
2162
2163   // Function related nodes need to stay in the same relative position and can't
2164   // be location equivalent.
2165   for (std::map<unsigned, unsigned>::iterator Iter = MaxK.begin();
2166        Iter != MaxK.end();
2167        ++Iter) {
2168     for (unsigned i = Iter->first;
2169          i != Iter->first + Iter->second;
2170          ++i) {
2171       GraphNodes[i].AddressTaken = true;
2172       GraphNodes[i].Direct = false;
2173     }
2174   }
2175
2176   ClumpAddressTaken();
2177   FirstRefNode = GraphNodes.size();
2178   FirstAdrNode = FirstRefNode + GraphNodes.size();
2179   GraphNodes.insert(GraphNodes.end(), 2 * GraphNodes.size(),
2180                     Node(false));
2181   VSSCCRep.resize(GraphNodes.size());
2182   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2183     VSSCCRep[i] = i;
2184   }
2185   HVN();
2186   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2187     Node *N = &GraphNodes[i];
2188     delete N->PredEdges;
2189     N->PredEdges = NULL;
2190     delete N->ImplicitPredEdges;
2191     N->ImplicitPredEdges = NULL;
2192   }
2193 #undef DEBUG_TYPE
2194 #define DEBUG_TYPE "anders-aa-labels"
2195   DEBUG(PrintLabels());
2196 #undef DEBUG_TYPE
2197 #define DEBUG_TYPE "anders-aa"
2198   RewriteConstraints();
2199   // Delete the adr nodes.
2200   GraphNodes.resize(FirstRefNode * 2);
2201
2202   // Now perform HU
2203   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2204     Node *N = &GraphNodes[i];
2205     if (FindNode(i) == i) {
2206       N->PointsTo = new SparseBitVector<>;
2207       N->PointedToBy = new SparseBitVector<>;
2208       // Reset our labels
2209     }
2210     VSSCCRep[i] = i;
2211     N->PointerEquivLabel = 0;
2212   }
2213   HU();
2214 #undef DEBUG_TYPE
2215 #define DEBUG_TYPE "anders-aa-labels"
2216   DEBUG(PrintLabels());
2217 #undef DEBUG_TYPE
2218 #define DEBUG_TYPE "anders-aa"
2219   RewriteConstraints();
2220   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2221     if (FindNode(i) == i) {
2222       Node *N = &GraphNodes[i];
2223       delete N->PointsTo;
2224       N->PointsTo = NULL;
2225       delete N->PredEdges;
2226       N->PredEdges = NULL;
2227       delete N->ImplicitPredEdges;
2228       N->ImplicitPredEdges = NULL;
2229       delete N->PointedToBy;
2230       N->PointedToBy = NULL;
2231     }
2232   }
2233
2234   // perform Hybrid Cycle Detection (HCD)
2235   HCD();
2236   SDTActive = true;
2237
2238   // No longer any need for the upper half of GraphNodes (for ref nodes).
2239   GraphNodes.erase(GraphNodes.begin() + FirstRefNode, GraphNodes.end());
2240
2241   // HCD complete.
2242
2243   DOUT << "Finished constraint optimization\n";
2244   FirstRefNode = 0;
2245   FirstAdrNode = 0;
2246 }
2247
2248 /// Unite pointer but not location equivalent variables, now that the constraint
2249 /// graph is built.
2250 void Andersens::UnitePointerEquivalences() {
2251   DOUT << "Uniting remaining pointer equivalences\n";
2252   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2253     if (GraphNodes[i].AddressTaken && GraphNodes[i].isRep()) {
2254       unsigned Label = GraphNodes[i].PointerEquivLabel;
2255
2256       if (Label && PENLEClass2Node[Label] != -1)
2257         UniteNodes(i, PENLEClass2Node[Label]);
2258     }
2259   }
2260   DOUT << "Finished remaining pointer equivalences\n";
2261   PENLEClass2Node.clear();
2262 }
2263
2264 /// Create the constraint graph used for solving points-to analysis.
2265 ///
2266 void Andersens::CreateConstraintGraph() {
2267   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
2268     Constraint &C = Constraints[i];
2269     assert (C.Src < GraphNodes.size() && C.Dest < GraphNodes.size());
2270     if (C.Type == Constraint::AddressOf)
2271       GraphNodes[C.Dest].PointsTo->set(C.Src);
2272     else if (C.Type == Constraint::Load)
2273       GraphNodes[C.Src].Constraints.push_back(C);
2274     else if (C.Type == Constraint::Store)
2275       GraphNodes[C.Dest].Constraints.push_back(C);
2276     else if (C.Offset != 0)
2277       GraphNodes[C.Src].Constraints.push_back(C);
2278     else
2279       GraphNodes[C.Src].Edges->set(C.Dest);
2280   }
2281 }
2282
2283 // Perform DFS and cycle detection.
2284 bool Andersens::QueryNode(unsigned Node) {
2285   assert(GraphNodes[Node].isRep() && "Querying a non-rep node");
2286   unsigned OurDFS = ++DFSNumber;
2287   SparseBitVector<> ToErase;
2288   SparseBitVector<> NewEdges;
2289   Tarjan2DFS[Node] = OurDFS;
2290
2291   // Changed denotes a change from a recursive call that we will bubble up.
2292   // Merged is set if we actually merge a node ourselves.
2293   bool Changed = false, Merged = false;
2294
2295   for (SparseBitVector<>::iterator bi = GraphNodes[Node].Edges->begin();
2296        bi != GraphNodes[Node].Edges->end();
2297        ++bi) {
2298     unsigned RepNode = FindNode(*bi);
2299     // If this edge points to a non-representative node but we are
2300     // already planning to add an edge to its representative, we have no
2301     // need for this edge anymore.
2302     if (RepNode != *bi && NewEdges.test(RepNode)){
2303       ToErase.set(*bi);
2304       continue;
2305     }
2306
2307     // Continue about our DFS.
2308     if (!Tarjan2Deleted[RepNode]){
2309       if (Tarjan2DFS[RepNode] == 0) {
2310         Changed |= QueryNode(RepNode);
2311         // May have been changed by QueryNode
2312         RepNode = FindNode(RepNode);
2313       }
2314       if (Tarjan2DFS[RepNode] < Tarjan2DFS[Node])
2315         Tarjan2DFS[Node] = Tarjan2DFS[RepNode];
2316     }
2317
2318     // We may have just discovered that this node is part of a cycle, in
2319     // which case we can also erase it.
2320     if (RepNode != *bi) {
2321       ToErase.set(*bi);
2322       NewEdges.set(RepNode);
2323     }
2324   }
2325
2326   GraphNodes[Node].Edges->intersectWithComplement(ToErase);
2327   GraphNodes[Node].Edges |= NewEdges;
2328
2329   // If this node is a root of a non-trivial SCC, place it on our 
2330   // worklist to be processed.
2331   if (OurDFS == Tarjan2DFS[Node]) {
2332     while (!SCCStack.empty() && Tarjan2DFS[SCCStack.top()] >= OurDFS) {
2333       Node = UniteNodes(Node, SCCStack.top());
2334
2335       SCCStack.pop();
2336       Merged = true;
2337     }
2338     Tarjan2Deleted[Node] = true;
2339
2340     if (Merged)
2341       NextWL->insert(&GraphNodes[Node]);
2342   } else {
2343     SCCStack.push(Node);
2344   }
2345
2346   return(Changed | Merged);
2347 }
2348
2349 /// SolveConstraints - This stage iteratively processes the constraints list
2350 /// propagating constraints (adding edges to the Nodes in the points-to graph)
2351 /// until a fixed point is reached.
2352 ///
2353 /// We use a variant of the technique called "Lazy Cycle Detection", which is
2354 /// described in "The Ant and the Grasshopper: Fast and Accurate Pointer
2355 /// Analysis for Millions of Lines of Code. In Programming Language Design and
2356 /// Implementation (PLDI), June 2007."
2357 /// The paper describes performing cycle detection one node at a time, which can
2358 /// be expensive if there are no cycles, but there are long chains of nodes that
2359 /// it heuristically believes are cycles (because it will DFS from each node
2360 /// without state from previous nodes).
2361 /// Instead, we use the heuristic to build a worklist of nodes to check, then
2362 /// cycle detect them all at the same time to do this more cheaply.  This
2363 /// catches cycles slightly later than the original technique did, but does it
2364 /// make significantly cheaper.
2365
2366 void Andersens::SolveConstraints() {
2367   CurrWL = &w1;
2368   NextWL = &w2;
2369
2370   OptimizeConstraints();
2371 #undef DEBUG_TYPE
2372 #define DEBUG_TYPE "anders-aa-constraints"
2373       DEBUG(PrintConstraints());
2374 #undef DEBUG_TYPE
2375 #define DEBUG_TYPE "anders-aa"
2376
2377   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2378     Node *N = &GraphNodes[i];
2379     N->PointsTo = new SparseBitVector<>;
2380     N->OldPointsTo = new SparseBitVector<>;
2381     N->Edges = new SparseBitVector<>;
2382   }
2383   CreateConstraintGraph();
2384   UnitePointerEquivalences();
2385   assert(SCCStack.empty() && "SCC Stack should be empty by now!");
2386   Node2DFS.clear();
2387   Node2Deleted.clear();
2388   Node2DFS.insert(Node2DFS.begin(), GraphNodes.size(), 0);
2389   Node2Deleted.insert(Node2Deleted.begin(), GraphNodes.size(), false);
2390   DFSNumber = 0;
2391   DenseSet<Constraint, ConstraintKeyInfo> Seen;
2392   DenseSet<std::pair<unsigned,unsigned>, PairKeyInfo> EdgesChecked;
2393
2394   // Order graph and add initial nodes to work list.
2395   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2396     Node *INode = &GraphNodes[i];
2397
2398     // Add to work list if it's a representative and can contribute to the
2399     // calculation right now.
2400     if (INode->isRep() && !INode->PointsTo->empty()
2401         && (!INode->Edges->empty() || !INode->Constraints.empty())) {
2402       INode->Stamp();
2403       CurrWL->insert(INode);
2404     }
2405   }
2406   std::queue<unsigned int> TarjanWL;
2407 #if !FULL_UNIVERSAL
2408   // "Rep and special variables" - in order for HCD to maintain conservative
2409   // results when !FULL_UNIVERSAL, we need to treat the special variables in
2410   // the same way that the !FULL_UNIVERSAL tweak does throughout the rest of
2411   // the analysis - it's ok to add edges from the special nodes, but never
2412   // *to* the special nodes.
2413   std::vector<unsigned int> RSV;
2414 #endif
2415   while( !CurrWL->empty() ) {
2416     DOUT << "Starting iteration #" << ++NumIters << "\n";
2417
2418     Node* CurrNode;
2419     unsigned CurrNodeIndex;
2420
2421     // Actual cycle checking code.  We cycle check all of the lazy cycle
2422     // candidates from the last iteration in one go.
2423     if (!TarjanWL.empty()) {
2424       DFSNumber = 0;
2425       
2426       Tarjan2DFS.clear();
2427       Tarjan2Deleted.clear();
2428       while (!TarjanWL.empty()) {
2429         unsigned int ToTarjan = TarjanWL.front();
2430         TarjanWL.pop();
2431         if (!Tarjan2Deleted[ToTarjan]
2432             && GraphNodes[ToTarjan].isRep()
2433             && Tarjan2DFS[ToTarjan] == 0)
2434           QueryNode(ToTarjan);
2435       }
2436     }
2437     
2438     // Add to work list if it's a representative and can contribute to the
2439     // calculation right now.
2440     while( (CurrNode = CurrWL->pop()) != NULL ) {
2441       CurrNodeIndex = CurrNode - &GraphNodes[0];
2442       CurrNode->Stamp();
2443       
2444           
2445       // Figure out the changed points to bits
2446       SparseBitVector<> CurrPointsTo;
2447       CurrPointsTo.intersectWithComplement(CurrNode->PointsTo,
2448                                            CurrNode->OldPointsTo);
2449       if (CurrPointsTo.empty())
2450         continue;
2451
2452       *(CurrNode->OldPointsTo) |= CurrPointsTo;
2453
2454       // Check the offline-computed equivalencies from HCD.
2455       bool SCC = false;
2456       unsigned Rep;
2457
2458       if (SDT[CurrNodeIndex] >= 0) {
2459         SCC = true;
2460         Rep = FindNode(SDT[CurrNodeIndex]);
2461
2462 #if !FULL_UNIVERSAL
2463         RSV.clear();
2464 #endif
2465         for (SparseBitVector<>::iterator bi = CurrPointsTo.begin();
2466              bi != CurrPointsTo.end(); ++bi) {
2467           unsigned Node = FindNode(*bi);
2468 #if !FULL_UNIVERSAL
2469           if (Node < NumberSpecialNodes) {
2470             RSV.push_back(Node);
2471             continue;
2472           }
2473 #endif
2474           Rep = UniteNodes(Rep,Node);
2475         }
2476 #if !FULL_UNIVERSAL
2477         RSV.push_back(Rep);
2478 #endif
2479
2480         NextWL->insert(&GraphNodes[Rep]);
2481
2482         if ( ! CurrNode->isRep() )
2483           continue;
2484       }
2485
2486       Seen.clear();
2487
2488       /* Now process the constraints for this node.  */
2489       for (std::list<Constraint>::iterator li = CurrNode->Constraints.begin();
2490            li != CurrNode->Constraints.end(); ) {
2491         li->Src = FindNode(li->Src);
2492         li->Dest = FindNode(li->Dest);
2493
2494         // Delete redundant constraints
2495         if( Seen.count(*li) ) {
2496           std::list<Constraint>::iterator lk = li; li++;
2497
2498           CurrNode->Constraints.erase(lk);
2499           ++NumErased;
2500           continue;
2501         }
2502         Seen.insert(*li);
2503
2504         // Src and Dest will be the vars we are going to process.
2505         // This may look a bit ugly, but what it does is allow us to process
2506         // both store and load constraints with the same code.
2507         // Load constraints say that every member of our RHS solution has K
2508         // added to it, and that variable gets an edge to LHS. We also union
2509         // RHS+K's solution into the LHS solution.
2510         // Store constraints say that every member of our LHS solution has K
2511         // added to it, and that variable gets an edge from RHS. We also union
2512         // RHS's solution into the LHS+K solution.
2513         unsigned *Src;
2514         unsigned *Dest;
2515         unsigned K = li->Offset;
2516         unsigned CurrMember;
2517         if (li->Type == Constraint::Load) {
2518           Src = &CurrMember;
2519           Dest = &li->Dest;
2520         } else if (li->Type == Constraint::Store) {
2521           Src = &li->Src;
2522           Dest = &CurrMember;
2523         } else {
2524           // TODO Handle offseted copy constraint
2525           li++;
2526           continue;
2527         }
2528
2529         // See if we can use Hybrid Cycle Detection (that is, check
2530         // if it was a statically detected offline equivalence that
2531         // involves pointers; if so, remove the redundant constraints).
2532         if( SCC && K == 0 ) {
2533 #if FULL_UNIVERSAL
2534           CurrMember = Rep;
2535
2536           if (GraphNodes[*Src].Edges->test_and_set(*Dest))
2537             if (GraphNodes[*Dest].PointsTo |= *(GraphNodes[*Src].PointsTo))
2538               NextWL->insert(&GraphNodes[*Dest]);
2539 #else
2540           for (unsigned i=0; i < RSV.size(); ++i) {
2541             CurrMember = RSV[i];
2542
2543             if (*Dest < NumberSpecialNodes)
2544               continue;
2545             if (GraphNodes[*Src].Edges->test_and_set(*Dest))
2546               if (GraphNodes[*Dest].PointsTo |= *(GraphNodes[*Src].PointsTo))
2547                 NextWL->insert(&GraphNodes[*Dest]);
2548           }
2549 #endif
2550           // since all future elements of the points-to set will be
2551           // equivalent to the current ones, the complex constraints
2552           // become redundant.
2553           //
2554           std::list<Constraint>::iterator lk = li; li++;
2555 #if !FULL_UNIVERSAL
2556           // In this case, we can still erase the constraints when the
2557           // elements of the points-to sets are referenced by *Dest,
2558           // but not when they are referenced by *Src (i.e. for a Load
2559           // constraint). This is because if another special variable is
2560           // put into the points-to set later, we still need to add the
2561           // new edge from that special variable.
2562           if( lk->Type != Constraint::Load)
2563 #endif
2564           GraphNodes[CurrNodeIndex].Constraints.erase(lk);
2565         } else {
2566           const SparseBitVector<> &Solution = CurrPointsTo;
2567
2568           for (SparseBitVector<>::iterator bi = Solution.begin();
2569                bi != Solution.end();
2570                ++bi) {
2571             CurrMember = *bi;
2572
2573             // Need to increment the member by K since that is where we are
2574             // supposed to copy to/from.  Note that in positive weight cycles,
2575             // which occur in address taking of fields, K can go past
2576             // MaxK[CurrMember] elements, even though that is all it could point
2577             // to.
2578             if (K > 0 && K > MaxK[CurrMember])
2579               continue;
2580             else
2581               CurrMember = FindNode(CurrMember + K);
2582
2583             // Add an edge to the graph, so we can just do regular
2584             // bitmap ior next time.  It may also let us notice a cycle.
2585 #if !FULL_UNIVERSAL
2586             if (*Dest < NumberSpecialNodes)
2587               continue;
2588 #endif
2589             if (GraphNodes[*Src].Edges->test_and_set(*Dest))
2590               if (GraphNodes[*Dest].PointsTo |= *(GraphNodes[*Src].PointsTo))
2591                 NextWL->insert(&GraphNodes[*Dest]);
2592
2593           }
2594           li++;
2595         }
2596       }
2597       SparseBitVector<> NewEdges;
2598       SparseBitVector<> ToErase;
2599
2600       // Now all we have left to do is propagate points-to info along the
2601       // edges, erasing the redundant edges.
2602       for (SparseBitVector<>::iterator bi = CurrNode->Edges->begin();
2603            bi != CurrNode->Edges->end();
2604            ++bi) {
2605
2606         unsigned DestVar = *bi;
2607         unsigned Rep = FindNode(DestVar);
2608
2609         // If we ended up with this node as our destination, or we've already
2610         // got an edge for the representative, delete the current edge.
2611         if (Rep == CurrNodeIndex ||
2612             (Rep != DestVar && NewEdges.test(Rep))) {
2613             ToErase.set(DestVar);
2614             continue;
2615         }
2616         
2617         std::pair<unsigned,unsigned> edge(CurrNodeIndex,Rep);
2618         
2619         // This is where we do lazy cycle detection.
2620         // If this is a cycle candidate (equal points-to sets and this
2621         // particular edge has not been cycle-checked previously), add to the
2622         // list to check for cycles on the next iteration.
2623         if (!EdgesChecked.count(edge) &&
2624             *(GraphNodes[Rep].PointsTo) == *(CurrNode->PointsTo)) {
2625           EdgesChecked.insert(edge);
2626           TarjanWL.push(Rep);
2627         }
2628         // Union the points-to sets into the dest
2629 #if !FULL_UNIVERSAL
2630         if (Rep >= NumberSpecialNodes)
2631 #endif
2632         if (GraphNodes[Rep].PointsTo |= CurrPointsTo) {
2633           NextWL->insert(&GraphNodes[Rep]);
2634         }
2635         // If this edge's destination was collapsed, rewrite the edge.
2636         if (Rep != DestVar) {
2637           ToErase.set(DestVar);
2638           NewEdges.set(Rep);
2639         }
2640       }
2641       CurrNode->Edges->intersectWithComplement(ToErase);
2642       CurrNode->Edges |= NewEdges;
2643     }
2644
2645     // Switch to other work list.
2646     WorkList* t = CurrWL; CurrWL = NextWL; NextWL = t;
2647   }
2648
2649
2650   Node2DFS.clear();
2651   Node2Deleted.clear();
2652   for (unsigned i = 0; i < GraphNodes.size(); ++i) {
2653     Node *N = &GraphNodes[i];
2654     delete N->OldPointsTo;
2655     delete N->Edges;
2656   }
2657   SDTActive = false;
2658   SDT.clear();
2659 }
2660
2661 //===----------------------------------------------------------------------===//
2662 //                               Union-Find
2663 //===----------------------------------------------------------------------===//
2664
2665 // Unite nodes First and Second, returning the one which is now the
2666 // representative node.  First and Second are indexes into GraphNodes
2667 unsigned Andersens::UniteNodes(unsigned First, unsigned Second,
2668                                bool UnionByRank) {
2669   assert (First < GraphNodes.size() && Second < GraphNodes.size() &&
2670           "Attempting to merge nodes that don't exist");
2671
2672   Node *FirstNode = &GraphNodes[First];
2673   Node *SecondNode = &GraphNodes[Second];
2674
2675   assert (SecondNode->isRep() && FirstNode->isRep() &&
2676           "Trying to unite two non-representative nodes!");
2677   if (First == Second)
2678     return First;
2679
2680   if (UnionByRank) {
2681     int RankFirst  = (int) FirstNode ->NodeRep;
2682     int RankSecond = (int) SecondNode->NodeRep;
2683
2684     // Rank starts at -1 and gets decremented as it increases.
2685     // Translation: higher rank, lower NodeRep value, which is always negative.
2686     if (RankFirst > RankSecond) {
2687       unsigned t = First; First = Second; Second = t;
2688       Node* tp = FirstNode; FirstNode = SecondNode; SecondNode = tp;
2689     } else if (RankFirst == RankSecond) {
2690       FirstNode->NodeRep = (unsigned) (RankFirst - 1);
2691     }
2692   }
2693
2694   SecondNode->NodeRep = First;
2695 #if !FULL_UNIVERSAL
2696   if (First >= NumberSpecialNodes)
2697 #endif
2698   if (FirstNode->PointsTo && SecondNode->PointsTo)
2699     FirstNode->PointsTo |= *(SecondNode->PointsTo);
2700   if (FirstNode->Edges && SecondNode->Edges)
2701     FirstNode->Edges |= *(SecondNode->Edges);
2702   if (!SecondNode->Constraints.empty())
2703     FirstNode->Constraints.splice(FirstNode->Constraints.begin(),
2704                                   SecondNode->Constraints);
2705   if (FirstNode->OldPointsTo) {
2706     delete FirstNode->OldPointsTo;
2707     FirstNode->OldPointsTo = new SparseBitVector<>;
2708   }
2709
2710   // Destroy interesting parts of the merged-from node.
2711   delete SecondNode->OldPointsTo;
2712   delete SecondNode->Edges;
2713   delete SecondNode->PointsTo;
2714   SecondNode->Edges = NULL;
2715   SecondNode->PointsTo = NULL;
2716   SecondNode->OldPointsTo = NULL;
2717
2718   NumUnified++;
2719   DOUT << "Unified Node ";
2720   DEBUG(PrintNode(FirstNode));
2721   DOUT << " and Node ";
2722   DEBUG(PrintNode(SecondNode));
2723   DOUT << "\n";
2724
2725   if (SDTActive)
2726     if (SDT[Second] >= 0) {
2727       if (SDT[First] < 0)
2728         SDT[First] = SDT[Second];
2729       else {
2730         UniteNodes( FindNode(SDT[First]), FindNode(SDT[Second]) );
2731         First = FindNode(First);
2732       }
2733     }
2734
2735   return First;
2736 }
2737
2738 // Find the index into GraphNodes of the node representing Node, performing
2739 // path compression along the way
2740 unsigned Andersens::FindNode(unsigned NodeIndex) {
2741   assert (NodeIndex < GraphNodes.size()
2742           && "Attempting to find a node that can't exist");
2743   Node *N = &GraphNodes[NodeIndex];
2744   if (N->isRep())
2745     return NodeIndex;
2746   else
2747     return (N->NodeRep = FindNode(N->NodeRep));
2748 }
2749
2750 // Find the index into GraphNodes of the node representing Node, 
2751 // don't perform path compression along the way (for Print)
2752 unsigned Andersens::FindNode(unsigned NodeIndex) const {
2753   assert (NodeIndex < GraphNodes.size()
2754           && "Attempting to find a node that can't exist");
2755   const Node *N = &GraphNodes[NodeIndex];
2756   if (N->isRep())
2757     return NodeIndex;
2758   else
2759     return FindNode(N->NodeRep);
2760 }
2761
2762 //===----------------------------------------------------------------------===//
2763 //                               Debugging Output
2764 //===----------------------------------------------------------------------===//
2765
2766 void Andersens::PrintNode(const Node *N) const {
2767   if (N == &GraphNodes[UniversalSet]) {
2768     cerr << "<universal>";
2769     return;
2770   } else if (N == &GraphNodes[NullPtr]) {
2771     cerr << "<nullptr>";
2772     return;
2773   } else if (N == &GraphNodes[NullObject]) {
2774     cerr << "<null>";
2775     return;
2776   }
2777   if (!N->getValue()) {
2778     cerr << "artificial" << (intptr_t) N;
2779     return;
2780   }
2781
2782   assert(N->getValue() != 0 && "Never set node label!");
2783   Value *V = N->getValue();
2784   if (Function *F = dyn_cast<Function>(V)) {
2785     if (isa<PointerType>(F->getFunctionType()->getReturnType()) &&
2786         N == &GraphNodes[getReturnNode(F)]) {
2787       cerr << F->getName() << ":retval";
2788       return;
2789     } else if (F->getFunctionType()->isVarArg() &&
2790                N == &GraphNodes[getVarargNode(F)]) {
2791       cerr << F->getName() << ":vararg";
2792       return;
2793     }
2794   }
2795
2796   if (Instruction *I = dyn_cast<Instruction>(V))
2797     cerr << I->getParent()->getParent()->getName() << ":";
2798   else if (Argument *Arg = dyn_cast<Argument>(V))
2799     cerr << Arg->getParent()->getName() << ":";
2800
2801   if (V->hasName())
2802     cerr << V->getName();
2803   else
2804     cerr << "(unnamed)";
2805
2806   if (isa<GlobalValue>(V) || isa<AllocationInst>(V))
2807     if (N == &GraphNodes[getObject(V)])
2808       cerr << "<mem>";
2809 }
2810 void Andersens::PrintConstraint(const Constraint &C) const {
2811   if (C.Type == Constraint::Store) {
2812     cerr << "*";
2813     if (C.Offset != 0)
2814       cerr << "(";
2815   }
2816   PrintNode(&GraphNodes[C.Dest]);
2817   if (C.Type == Constraint::Store && C.Offset != 0)
2818     cerr << " + " << C.Offset << ")";
2819   cerr << " = ";
2820   if (C.Type == Constraint::Load) {
2821     cerr << "*";
2822     if (C.Offset != 0)
2823       cerr << "(";
2824   }
2825   else if (C.Type == Constraint::AddressOf)
2826     cerr << "&";
2827   PrintNode(&GraphNodes[C.Src]);
2828   if (C.Offset != 0 && C.Type != Constraint::Store)
2829     cerr << " + " << C.Offset;
2830   if (C.Type == Constraint::Load && C.Offset != 0)
2831     cerr << ")";
2832   cerr << "\n";
2833 }
2834
2835 void Andersens::PrintConstraints() const {
2836   cerr << "Constraints:\n";
2837
2838   for (unsigned i = 0, e = Constraints.size(); i != e; ++i)
2839     PrintConstraint(Constraints[i]);
2840 }
2841
2842 void Andersens::PrintPointsToGraph() const {
2843   cerr << "Points-to graph:\n";
2844   for (unsigned i = 0, e = GraphNodes.size(); i != e; ++i) {
2845     const Node *N = &GraphNodes[i];
2846     if (FindNode(i) != i) {
2847       PrintNode(N);
2848       cerr << "\t--> same as ";
2849       PrintNode(&GraphNodes[FindNode(i)]);
2850       cerr << "\n";
2851     } else {
2852       cerr << "[" << (N->PointsTo->count()) << "] ";
2853       PrintNode(N);
2854       cerr << "\t--> ";
2855
2856       bool first = true;
2857       for (SparseBitVector<>::iterator bi = N->PointsTo->begin();
2858            bi != N->PointsTo->end();
2859            ++bi) {
2860         if (!first)
2861           cerr << ", ";
2862         PrintNode(&GraphNodes[*bi]);
2863         first = false;
2864       }
2865       cerr << "\n";
2866     }
2867   }
2868 }