lib/Analysis/IPA/Andersens.cpp

   1 //===- Andersens.cpp - Andersen's Interprocedural Alias Analysis ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a very simple implementation of Andersen's interprocedural
  11 // alias analysis.  This implementation does not include any of the fancy
  12 // features that make Andersen's reasonably efficient (like cycle elimination or
  13 // variable substitution), but it should be useful for getting precision
  14 // numbers and can be extended in the future.
  15 //
  16 // In pointer analysis terms, this is a subset-based, flow-insensitive,
  17 // field-insensitive, and context-insensitive algorithm pointer algorithm.
  18 //
  19 // This algorithm is implemented as three stages:
  20 //   1. Object identification.
  21 //   2. Inclusion constraint identification.
  22 //   3. Inclusion constraint solving.
  23 //
  24 // The object identification stage identifies all of the memory objects in the
  25 // program, which includes globals, heap allocated objects, and stack allocated
  26 // objects.
  27 //
  28 // The inclusion constraint identification stage finds all inclusion constraints
  29 // in the program by scanning the program, looking for pointer assignments and
  30 // other statements that effect the points-to graph.  For a statement like "A =
  31 // B", this statement is processed to indicate that A can point to anything that
  32 // B can point to.  Constraints can handle copies, loads, and stores.
  33 //
  34 // The inclusion constraint solving phase iteratively propagates the inclusion
  35 // constraints until a fixed point is reached.  This is an O(N^3) algorithm.
  36 //
  37 // In the initial pass, all indirect function calls are completely ignored.  As
  38 // the analysis discovers new targets of function pointers, it iteratively
  39 // resolves a precise (and conservative) call graph.  Also related, this
  40 // analysis initially assumes that all internal functions have known incoming
  41 // pointers.  If we find that an internal function's address escapes outside of
  42 // the program, we update this assumption.
  43 //
  44 // Future Improvements:
  45 //   This implementation of Andersen's algorithm is extremely slow.  To make it
  46 //   scale reasonably well, the inclusion constraints could be sorted (easy),
  47 //   offline variable substitution would be a huge win (straight-forward), and
  48 //   online cycle elimination (trickier) might help as well.
  49 //
  50 //===----------------------------------------------------------------------===//
  51
  52 #define DEBUG_TYPE "anders-aa"
  53 #include "llvm/Constants.h"
  54 #include "llvm/DerivedTypes.h"
  55 #include "llvm/Instructions.h"
  56 #include "llvm/Module.h"
  57 #include "llvm/Pass.h"
  58 #include "llvm/Support/InstIterator.h"
  59 #include "llvm/Support/InstVisitor.h"
  60 #include "llvm/Analysis/AliasAnalysis.h"
  61 #include "llvm/Analysis/Passes.h"
  62 #include "llvm/Support/Debug.h"
  63 #include "llvm/ADT/Statistic.h"
  64 #include <set>
  65 using namespace llvm;
  66
  67 namespace {
  68   Statistic<>
  69   NumIters("anders-aa", "Number of iterations to reach convergence");
  70   Statistic<>
  71   NumConstraints("anders-aa", "Number of constraints");
  72   Statistic<>
  73   NumNodes("anders-aa", "Number of nodes");
  74   Statistic<>
  75   NumEscapingFunctions("anders-aa", "Number of internal functions that escape");
  76   Statistic<>
  77   NumIndirectCallees("anders-aa", "Number of indirect callees found");
  78
  79   class Andersens : public ModulePass, public AliasAnalysis,
  80                     private InstVisitor<Andersens> {
  81     /// Node class - This class is used to represent a memory object in the
  82     /// program, and is the primitive used to build the points-to graph.
  83     class Node {
  84       std::vector<Node*> Pointees;
  85       Value *Val;
  86     public:
  87       Node() : Val(0) {}
  88       Node *setValue(Value *V) {
  89         assert(Val == 0 && "Value already set for this node!");
  90         Val = V;
  91         return this;
  92       }
  93
  94       /// getValue - Return the LLVM value corresponding to this node.
  95       ///
  96       Value *getValue() const { return Val; }
  97
  98       typedef std::vector<Node*>::const_iterator iterator;
  99       iterator begin() const { return Pointees.begin(); }
 100       iterator end() const { return Pointees.end(); }
 101
 102       /// addPointerTo - Add a pointer to the list of pointees of this node,
 103       /// returning true if this caused a new pointer to be added, or false if
 104       /// we already knew about the points-to relation.
 105       bool addPointerTo(Node *N) {
 106         std::vector<Node*>::iterator I = std::lower_bound(Pointees.begin(),
 107                                                           Pointees.end(),
 108                                                           N);
 109         if (I != Pointees.end() && *I == N)
 110           return false;
 111         Pointees.insert(I, N);
 112         return true;
 113       }
 114
 115       /// intersects - Return true if the points-to set of this node intersects
 116       /// with the points-to set of the specified node.
 117       bool intersects(Node *N) const;
 118
 119       /// intersectsIgnoring - Return true if the points-to set of this node
 120       /// intersects with the points-to set of the specified node on any nodes
 121       /// except for the specified node to ignore.
 122       bool intersectsIgnoring(Node *N, Node *Ignoring) const;
 123
 124       // Constraint application methods.
 125       bool copyFrom(Node *N);
 126       bool loadFrom(Node *N);
 127       bool storeThrough(Node *N);
 128     };
 129
 130     /// GraphNodes - This vector is populated as part of the object
 131     /// identification stage of the analysis, which populates this vector with a
 132     /// node for each memory object and fills in the ValueNodes map.
 133     std::vector<Node> GraphNodes;
 134
 135     /// ValueNodes - This map indicates the Node that a particular Value* is
 136     /// represented by.  This contains entries for all pointers.
 137     std::map<Value*, unsigned> ValueNodes;
 138
 139     /// ObjectNodes - This map contains entries for each memory object in the
 140     /// program: globals, alloca's and mallocs.
 141     std::map<Value*, unsigned> ObjectNodes;
 142
 143     /// ReturnNodes - This map contains an entry for each function in the
 144     /// program that returns a value.
 145     std::map<Function*, unsigned> ReturnNodes;
 146
 147     /// VarargNodes - This map contains the entry used to represent all pointers
 148     /// passed through the varargs portion of a function call for a particular
 149     /// function.  An entry is not present in this map for functions that do not
 150     /// take variable arguments.
 151     std::map<Function*, unsigned> VarargNodes;
 152
 153     /// Constraint - Objects of this structure are used to represent the various
 154     /// constraints identified by the algorithm.  The constraints are 'copy',
 155     /// for statements like "A = B", 'load' for statements like "A = *B", and
 156     /// 'store' for statements like "*A = B".
 157     struct Constraint {
 158       enum ConstraintType { Copy, Load, Store } Type;
 159       Node *Dest, *Src;
 160
 161       Constraint(ConstraintType Ty, Node *D, Node *S)
 162         : Type(Ty), Dest(D), Src(S) {}
 163     };
 164
 165     /// Constraints - This vector contains a list of all of the constraints
 166     /// identified by the program.
 167     std::vector<Constraint> Constraints;
 168
 169     /// EscapingInternalFunctions - This set contains all of the internal
 170     /// functions that are found to escape from the program.  If the address of
 171     /// an internal function is passed to an external function or otherwise
 172     /// escapes from the analyzed portion of the program, we must assume that
 173     /// any pointer arguments can alias the universal node.  This set keeps
 174     /// track of those functions we are assuming to escape so far.
 175     std::set<Function*> EscapingInternalFunctions;
 176
 177     /// IndirectCalls - This contains a list of all of the indirect call sites
 178     /// in the program.  Since the call graph is iteratively discovered, we may
 179     /// need to add constraints to our graph as we find new targets of function
 180     /// pointers.
 181     std::vector<CallSite> IndirectCalls;
 182
 183     /// IndirectCallees - For each call site in the indirect calls list, keep
 184     /// track of the callees that we have discovered so far.  As the analysis
 185     /// proceeds, more callees are discovered, until the call graph finally
 186     /// stabilizes.
 187     std::map<CallSite, std::vector<Function*> > IndirectCallees;
 188
 189     /// This enum defines the GraphNodes indices that correspond to important
 190     /// fixed sets.
 191     enum {
 192       UniversalSet = 0,
 193       NullPtr      = 1,
 194       NullObject   = 2,
 195     };
 196
 197   public:
 198     bool runOnModule(Module &M) {
 199       InitializeAliasAnalysis(this);
 200       IdentifyObjects(M);
 201       CollectConstraints(M);
 202       DEBUG(PrintConstraints());
 203       SolveConstraints();
 204       DEBUG(PrintPointsToGraph());
 205
 206       // Free the constraints list, as we don't need it to respond to alias
 207       // requests.
 208       ObjectNodes.clear();
 209       ReturnNodes.clear();
 210       VarargNodes.clear();
 211       EscapingInternalFunctions.clear();
 212       std::vector<Constraint>().swap(Constraints);
 213       return false;
 214     }
 215
 216     void releaseMemory() {
 217       // FIXME: Until we have transitively required passes working correctly,
 218       // this cannot be enabled!  Otherwise, using -count-aa with the pass
 219       // causes memory to be freed too early. :(
 220 #if 0
 221       // The memory objects and ValueNodes data structures at the only ones that
 222       // are still live after construction.
 223       std::vector<Node>().swap(GraphNodes);
 224       ValueNodes.clear();
 225 #endif
 226     }
 227
 228     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 229       AliasAnalysis::getAnalysisUsage(AU);
 230       AU.setPreservesAll();                         // Does not transform code
 231     }
 232
 233     //------------------------------------------------
 234     // Implement the AliasAnalysis API
 235     //
 236     AliasResult alias(const Value *V1, unsigned V1Size,
 237                       const Value *V2, unsigned V2Size);
 238     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
 239     void getMustAliases(Value *P, std::vector<Value*> &RetVals);
 240     bool pointsToConstantMemory(const Value *P);
 241
 242     virtual void deleteValue(Value *V) {
 243       ValueNodes.erase(V);
 244       getAnalysis<AliasAnalysis>().deleteValue(V);
 245     }
 246
 247     virtual void copyValue(Value *From, Value *To) {
 248       ValueNodes[To] = ValueNodes[From];
 249       getAnalysis<AliasAnalysis>().copyValue(From, To);
 250     }
 251
 252   private:
 253     /// getNode - Return the node corresponding to the specified pointer scalar.
 254     ///
 255     Node *getNode(Value *V) {
 256       if (Constant *C = dyn_cast<Constant>(V))
 257         if (!isa<GlobalValue>(C))
 258           return getNodeForConstantPointer(C);
 259
 260       std::map<Value*, unsigned>::iterator I = ValueNodes.find(V);
 261       if (I == ValueNodes.end()) {
 262         V->dump();
 263         assert(I != ValueNodes.end() &&
 264                "Value does not have a node in the points-to graph!");
 265       }
 266       return &GraphNodes[I->second];
 267     }
 268
 269     /// getObject - Return the node corresponding to the memory object for the
 270     /// specified global or allocation instruction.
 271     Node *getObject(Value *V) {
 272       std::map<Value*, unsigned>::iterator I = ObjectNodes.find(V);
 273       assert(I != ObjectNodes.end() &&
 274              "Value does not have an object in the points-to graph!");
 275       return &GraphNodes[I->second];
 276     }
 277
 278     /// getReturnNode - Return the node representing the return value for the
 279     /// specified function.
 280     Node *getReturnNode(Function *F) {
 281       std::map<Function*, unsigned>::iterator I = ReturnNodes.find(F);
 282       assert(I != ReturnNodes.end() && "Function does not return a value!");
 283       return &GraphNodes[I->second];
 284     }
 285
 286     /// getVarargNode - Return the node representing the variable arguments
 287     /// formal for the specified function.
 288     Node *getVarargNode(Function *F) {
 289       std::map<Function*, unsigned>::iterator I = VarargNodes.find(F);
 290       assert(I != VarargNodes.end() && "Function does not take var args!");
 291       return &GraphNodes[I->second];
 292     }
 293
 294     /// getNodeValue - Get the node for the specified LLVM value and set the
 295     /// value for it to be the specified value.
 296     Node *getNodeValue(Value &V) {
 297       return getNode(&V)->setValue(&V);
 298     }
 299
 300     void IdentifyObjects(Module &M);
 301     void CollectConstraints(Module &M);
 302     void SolveConstraints();
 303
 304     Node *getNodeForConstantPointer(Constant *C);
 305     Node *getNodeForConstantPointerTarget(Constant *C);
 306     void AddGlobalInitializerConstraints(Node *N, Constant *C);
 307
 308     void AddConstraintsForNonInternalLinkage(Function *F);
 309     void AddConstraintsForCall(CallSite CS, Function *F);
 310     bool AddConstraintsForExternalCall(CallSite CS, Function *F);
 311
 312
 313     void PrintNode(Node *N);
 314     void PrintConstraints();
 315     void PrintPointsToGraph();
 316
 317     //===------------------------------------------------------------------===//
 318     // Instruction visitation methods for adding constraints
 319     //
 320     friend class InstVisitor<Andersens>;
 321     void visitReturnInst(ReturnInst &RI);
 322     void visitInvokeInst(InvokeInst &II) { visitCallSite(CallSite(&II)); }
 323     void visitCallInst(CallInst &CI) { visitCallSite(CallSite(&CI)); }
 324     void visitCallSite(CallSite CS);
 325     void visitAllocationInst(AllocationInst &AI);
 326     void visitLoadInst(LoadInst &LI);
 327     void visitStoreInst(StoreInst &SI);
 328     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 329     void visitPHINode(PHINode &PN);
 330     void visitCastInst(CastInst &CI);
 331     void visitSetCondInst(SetCondInst &SCI) {} // NOOP!
 332     void visitSelectInst(SelectInst &SI);
 333     void visitVANext(VANextInst &I);
 334     void visitVAArg(VAArgInst &I);
 335     void visitInstruction(Instruction &I);
 336   };
 337
 338   RegisterOpt<Andersens> X("anders-aa",
 339                            "Andersen's Interprocedural Alias Analysis");
 340   RegisterAnalysisGroup<AliasAnalysis, Andersens> Y;
 341 }
 342
 343 ModulePass *llvm::createAndersensPass() { return new Andersens(); }
 344
 345 //===----------------------------------------------------------------------===//
 346 //                  AliasAnalysis Interface Implementation
 347 //===----------------------------------------------------------------------===//
 348
 349 AliasAnalysis::AliasResult Andersens::alias(const Value *V1, unsigned V1Size,
 350                                             const Value *V2, unsigned V2Size) {
 351   Node *N1 = getNode(const_cast<Value*>(V1));
 352   Node *N2 = getNode(const_cast<Value*>(V2));
 353
 354   // Check to see if the two pointers are known to not alias.  They don't alias
 355   // if their points-to sets do not intersect.
 356   if (!N1->intersectsIgnoring(N2, &GraphNodes[NullObject]))
 357     return NoAlias;
 358
 359   return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
 360 }
 361
 362 AliasAnalysis::ModRefResult
 363 Andersens::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 364   // The only thing useful that we can contribute for mod/ref information is
 365   // when calling external function calls: if we know that memory never escapes
 366   // from the program, it cannot be modified by an external call.
 367   //
 368   // NOTE: This is not really safe, at least not when the entire program is not
 369   // available.  The deal is that the external function could call back into the
 370   // program and modify stuff.  We ignore this technical niggle for now.  This
 371   // is, after all, a "research quality" implementation of Andersen's analysis.
 372   if (Function *F = CS.getCalledFunction())
 373     if (F->isExternal()) {
 374       Node *N1 = getNode(P);
 375       bool PointsToUniversalSet = false;
 376
 377       for (Node::iterator NI = N1->begin(), E = N1->end(); NI != E; ++NI) {
 378         Node *PN = *NI;
 379         if (PN->begin() == PN->end())
 380           continue;  // P doesn't point to anything.
 381         // Get the first pointee.
 382         Node *FirstPointee = *PN->begin();
 383         if (FirstPointee == &GraphNodes[UniversalSet]) {
 384           PointsToUniversalSet = true;
 385           break;
 386         }
 387       }
 388
 389       if (!PointsToUniversalSet)
 390         return NoModRef;  // P doesn't point to the universal set.
 391     }
 392
 393   return AliasAnalysis::getModRefInfo(CS, P, Size);
 394 }
 395
 396 /// getMustAlias - We can provide must alias information if we know that a
 397 /// pointer can only point to a specific function or the null pointer.
 398 /// Unfortunately we cannot determine must-alias information for global
 399 /// variables or any other memory memory objects because we do not track whether
 400 /// a pointer points to the beginning of an object or a field of it.
 401 void Andersens::getMustAliases(Value *P, std::vector<Value*> &RetVals) {
 402   Node *N = getNode(P);
 403   Node::iterator I = N->begin();
 404   if (I != N->end()) {
 405     // If there is exactly one element in the points-to set for the object...
 406     ++I;
 407     if (I == N->end()) {
 408       Node *Pointee = *N->begin();
 409
 410       // If a function is the only object in the points-to set, then it must be
 411       // the destination.  Note that we can't handle global variables here,
 412       // because we don't know if the pointer is actually pointing to a field of
 413       // the global or to the beginning of it.
 414       if (Value *V = Pointee->getValue()) {
 415         if (Function *F = dyn_cast<Function>(V))
 416           RetVals.push_back(F);
 417       } else {
 418         // If the object in the points-to set is the null object, then the null
 419         // pointer is a must alias.
 420         if (Pointee == &GraphNodes[NullObject])
 421           RetVals.push_back(Constant::getNullValue(P->getType()));
 422       }
 423     }
 424   }
 425
 426   AliasAnalysis::getMustAliases(P, RetVals);
 427 }
 428
 429 /// pointsToConstantMemory - If we can determine that this pointer only points
 430 /// to constant memory, return true.  In practice, this means that if the
 431 /// pointer can only point to constant globals, functions, or the null pointer,
 432 /// return true.
 433 ///
 434 bool Andersens::pointsToConstantMemory(const Value *P) {
 435   Node *N = getNode((Value*)P);
 436   for (Node::iterator I = N->begin(), E = N->end(); I != E; ++I) {
 437     if (Value *V = (*I)->getValue()) {
 438       if (!isa<GlobalValue>(V) || (isa<GlobalVariable>(V) &&
 439                                    !cast<GlobalVariable>(V)->isConstant()))
 440         return AliasAnalysis::pointsToConstantMemory(P);
 441     } else {
 442       if (*I != &GraphNodes[NullObject])
 443         return AliasAnalysis::pointsToConstantMemory(P);
 444     }
 445   }
 446
 447   return true;
 448 }
 449
 450 //===----------------------------------------------------------------------===//
 451 //                       Object Identification Phase
 452 //===----------------------------------------------------------------------===//
 453
 454 /// IdentifyObjects - This stage scans the program, adding an entry to the
 455 /// GraphNodes list for each memory object in the program (global stack or
 456 /// heap), and populates the ValueNodes and ObjectNodes maps for these objects.
 457 ///
 458 void Andersens::IdentifyObjects(Module &M) {
 459   unsigned NumObjects = 0;
 460
 461   // Object #0 is always the universal set: the object that we don't know
 462   // anything about.
 463   assert(NumObjects == UniversalSet && "Something changed!");
 464   ++NumObjects;
 465
 466   // Object #1 always represents the null pointer.
 467   assert(NumObjects == NullPtr && "Something changed!");
 468   ++NumObjects;
 469
 470   // Object #2 always represents the null object (the object pointed to by null)
 471   assert(NumObjects == NullObject && "Something changed!");
 472   ++NumObjects;
 473
 474   // Add all the globals first.
 475   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 476        I != E; ++I) {
 477     ObjectNodes[I] = NumObjects++;
 478     ValueNodes[I] = NumObjects++;
 479   }
 480
 481   // Add nodes for all of the functions and the instructions inside of them.
 482   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
 483     // The function itself is a memory object.
 484     ValueNodes[F] = NumObjects++;
 485     ObjectNodes[F] = NumObjects++;
 486     if (isa<PointerType>(F->getFunctionType()->getReturnType()))
 487       ReturnNodes[F] = NumObjects++;
 488     if (F->getFunctionType()->isVarArg())
 489       VarargNodes[F] = NumObjects++;
 490
 491     // Add nodes for all of the incoming pointer arguments.
 492     for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 493          I != E; ++I)
 494       if (isa<PointerType>(I->getType()))
 495         ValueNodes[I] = NumObjects++;
 496
 497     // Scan the function body, creating a memory object for each heap/stack
 498     // allocation in the body of the function and a node to represent all
 499     // pointer values defined by instructions and used as operands.
 500     for (inst_iterator II = inst_begin(F), E = inst_end(F); II != E; ++II) {
 501       // If this is an heap or stack allocation, create a node for the memory
 502       // object.
 503       if (isa<PointerType>(II->getType())) {
 504         ValueNodes[&*II] = NumObjects++;
 505         if (AllocationInst *AI = dyn_cast<AllocationInst>(&*II))
 506           ObjectNodes[AI] = NumObjects++;
 507       }
 508     }
 509   }
 510
 511   // Now that we know how many objects to create, make them all now!
 512   GraphNodes.resize(NumObjects);
 513   NumNodes += NumObjects;
 514 }
 515
 516 //===----------------------------------------------------------------------===//
 517 //                     Constraint Identification Phase
 518 //===----------------------------------------------------------------------===//
 519
 520 /// getNodeForConstantPointer - Return the node corresponding to the constant
 521 /// pointer itself.
 522 Andersens::Node *Andersens::getNodeForConstantPointer(Constant *C) {
 523   assert(isa<PointerType>(C->getType()) && "Not a constant pointer!");
 524
 525   if (isa<ConstantPointerNull>(C) || isa<UndefValue>(C))
 526     return &GraphNodes[NullPtr];
 527   else if (GlobalValue *GV = dyn_cast<GlobalValue>(C))
 528     return getNode(GV);
 529   else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 530     switch (CE->getOpcode()) {
 531     case Instruction::GetElementPtr:
 532       return getNodeForConstantPointer(CE->getOperand(0));
 533     case Instruction::Cast:
 534       if (isa<PointerType>(CE->getOperand(0)->getType()))
 535         return getNodeForConstantPointer(CE->getOperand(0));
 536       else
 537         return &GraphNodes[UniversalSet];
 538     default:
 539       std::cerr << "Constant Expr not yet handled: " << *CE << "\n";
 540       assert(0);
 541     }
 542   } else {
 543     assert(0 && "Unknown constant pointer!");
 544   }
 545   return 0;
 546 }
 547
 548 /// getNodeForConstantPointerTarget - Return the node POINTED TO by the
 549 /// specified constant pointer.
 550 Andersens::Node *Andersens::getNodeForConstantPointerTarget(Constant *C) {
 551   assert(isa<PointerType>(C->getType()) && "Not a constant pointer!");
 552
 553   if (isa<ConstantPointerNull>(C))
 554     return &GraphNodes[NullObject];
 555   else if (GlobalValue *GV = dyn_cast<GlobalValue>(C))
 556     return getObject(GV);
 557   else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 558     switch (CE->getOpcode()) {
 559     case Instruction::GetElementPtr:
 560       return getNodeForConstantPointerTarget(CE->getOperand(0));
 561     case Instruction::Cast:
 562       if (isa<PointerType>(CE->getOperand(0)->getType()))
 563         return getNodeForConstantPointerTarget(CE->getOperand(0));
 564       else
 565         return &GraphNodes[UniversalSet];
 566     default:
 567       std::cerr << "Constant Expr not yet handled: " << *CE << "\n";
 568       assert(0);
 569     }
 570   } else {
 571     assert(0 && "Unknown constant pointer!");
 572   }
 573   return 0;
 574 }
 575
 576 /// AddGlobalInitializerConstraints - Add inclusion constraints for the memory
 577 /// object N, which contains values indicated by C.
 578 void Andersens::AddGlobalInitializerConstraints(Node *N, Constant *C) {
 579   if (C->getType()->isFirstClassType()) {
 580     if (isa<PointerType>(C->getType()))
 581       N->copyFrom(getNodeForConstantPointer(C));
 582
 583   } else if (C->isNullValue()) {
 584     N->addPointerTo(&GraphNodes[NullObject]);
 585     return;
 586   } else if (!isa<UndefValue>(C)) {
 587     // If this is an array or struct, include constraints for each element.
 588     assert(isa<ConstantArray>(C) || isa<ConstantStruct>(C));
 589     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
 590       AddGlobalInitializerConstraints(N, cast<Constant>(C->getOperand(i)));
 591   }
 592 }
 593
 594 /// AddConstraintsForNonInternalLinkage - If this function does not have
 595 /// internal linkage, realize that we can't trust anything passed into or
 596 /// returned by this function.
 597 void Andersens::AddConstraintsForNonInternalLinkage(Function *F) {
 598   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
 599     if (isa<PointerType>(I->getType()))
 600       // If this is an argument of an externally accessible function, the
 601       // incoming pointer might point to anything.
 602       Constraints.push_back(Constraint(Constraint::Copy, getNode(I),
 603                                        &GraphNodes[UniversalSet]));
 604 }
 605
 606 /// AddConstraintsForCall - If this is a call to a "known" function, add the
 607 /// constraints and return true.  If this is a call to an unknown function,
 608 /// return false.
 609 bool Andersens::AddConstraintsForExternalCall(CallSite CS, Function *F) {
 610   assert(F->isExternal() && "Not an external function!");
 611
 612   // These functions don't induce any points-to constraints.
 613   if (F->getName() == "printf" || F->getName() == "fprintf" ||
 614       F->getName() == "sprintf" ||
 615       F->getName() == "fgets" ||
 616       F->getName() == "open" || F->getName() == "fopen" ||
 617       F->getName() == "fclose" || F->getName() == "fflush" ||
 618       F->getName() == "rewind" ||
 619       F->getName() == "atoi" || F->getName() == "unlink" ||
 620       F->getName() == "sscanf" || F->getName() == "fscanf" ||
 621       F->getName() == "llvm.memset" || F->getName() == "memcmp" ||
 622       F->getName() == "read" || F->getName() == "write")
 623     return true;
 624
 625   // These functions do induce points-to edges.
 626   if (F->getName() == "llvm.memcpy" || F->getName() == "llvm.memmove" ||
 627       F->getName() == "memmove") {
 628     // Note: this is a poor approximation, this says Dest = Src, instead of
 629     // *Dest = *Src.
 630     Constraints.push_back(Constraint(Constraint::Copy,
 631                                      getNode(CS.getArgument(0)),
 632                                      getNode(CS.getArgument(1))));
 633     return true;
 634   }
 635
 636   if (F->getName() == "realloc") {
 637     // Result = Arg
 638     Constraints.push_back(Constraint(Constraint::Copy,
 639                                      getNode(CS.getInstruction()),
 640                                      getNode(CS.getArgument(0))));
 641     return true;
 642   }
 643
 644   return false;
 645 }
 646
 647
 648
 649 /// CollectConstraints - This stage scans the program, adding a constraint to
 650 /// the Constraints list for each instruction in the program that induces a
 651 /// constraint, and setting up the initial points-to graph.
 652 ///
 653 void Andersens::CollectConstraints(Module &M) {
 654   // First, the universal set points to itself.
 655   GraphNodes[UniversalSet].addPointerTo(&GraphNodes[UniversalSet]);
 656   //Constraints.push_back(Constraint(Constraint::Load, &GraphNodes[UniversalSet],
 657   //                                 &GraphNodes[UniversalSet]));
 658   Constraints.push_back(Constraint(Constraint::Store, &GraphNodes[UniversalSet],
 659                                    &GraphNodes[UniversalSet]));
 660
 661   // Next, the null pointer points to the null object.
 662   GraphNodes[NullPtr].addPointerTo(&GraphNodes[NullObject]);
 663
 664   // Next, add any constraints on global variables and their initializers.
 665   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 666        I != E; ++I) {
 667     // Associate the address of the global object as pointing to the memory for
 668     // the global: &G = <G memory>
 669     Node *Object = getObject(I);
 670     Object->setValue(I);
 671     getNodeValue(*I)->addPointerTo(Object);
 672
 673     if (I->hasInitializer()) {
 674       AddGlobalInitializerConstraints(Object, I->getInitializer());
 675     } else {
 676       // If it doesn't have an initializer (i.e. it's defined in another
 677       // translation unit), it points to the universal set.
 678       Constraints.push_back(Constraint(Constraint::Copy, Object,
 679                                        &GraphNodes[UniversalSet]));
 680     }
 681   }
 682
 683   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
 684     // Make the function address point to the function object.
 685     getNodeValue(*F)->addPointerTo(getObject(F)->setValue(F));
 686
 687     // Set up the return value node.
 688     if (isa<PointerType>(F->getFunctionType()->getReturnType()))
 689       getReturnNode(F)->setValue(F);
 690     if (F->getFunctionType()->isVarArg())
 691       getVarargNode(F)->setValue(F);
 692
 693     // Set up incoming argument nodes.
 694     for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 695          I != E; ++I)
 696       if (isa<PointerType>(I->getType()))
 697         getNodeValue(*I);
 698
 699     if (!F->hasInternalLinkage())
 700       AddConstraintsForNonInternalLinkage(F);
 701
 702     if (!F->isExternal()) {
 703       // Scan the function body, creating a memory object for each heap/stack
 704       // allocation in the body of the function and a node to represent all
 705       // pointer values defined by instructions and used as operands.
 706       visit(F);
 707     } else {
 708       // External functions that return pointers return the universal set.
 709       if (isa<PointerType>(F->getFunctionType()->getReturnType()))
 710         Constraints.push_back(Constraint(Constraint::Copy,
 711                                          getReturnNode(F),
 712                                          &GraphNodes[UniversalSet]));
 713
 714       // Any pointers that are passed into the function have the universal set
 715       // stored into them.
 716       for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 717            I != E; ++I)
 718         if (isa<PointerType>(I->getType())) {
 719           // Pointers passed into external functions could have anything stored
 720           // through them.
 721           Constraints.push_back(Constraint(Constraint::Store, getNode(I),
 722                                            &GraphNodes[UniversalSet]));
 723           // Memory objects passed into external function calls can have the
 724           // universal set point to them.
 725           Constraints.push_back(Constraint(Constraint::Copy,
 726                                            &GraphNodes[UniversalSet],
 727                                            getNode(I)));
 728         }
 729
 730       // If this is an external varargs function, it can also store pointers
 731       // into any pointers passed through the varargs section.
 732       if (F->getFunctionType()->isVarArg())
 733         Constraints.push_back(Constraint(Constraint::Store, getVarargNode(F),
 734                                          &GraphNodes[UniversalSet]));
 735     }
 736   }
 737   NumConstraints += Constraints.size();
 738 }
 739
 740
 741 void Andersens::visitInstruction(Instruction &I) {
 742 #ifdef NDEBUG
 743   return;          // This function is just a big assert.
 744 #endif
 745   if (isa<BinaryOperator>(I))
 746     return;
 747   // Most instructions don't have any effect on pointer values.
 748   switch (I.getOpcode()) {
 749   case Instruction::Br:
 750   case Instruction::Switch:
 751   case Instruction::Unwind:
 752   case Instruction::Unreachable:
 753   case Instruction::Free:
 754   case Instruction::Shl:
 755   case Instruction::Shr:
 756     return;
 757   default:
 758     // Is this something we aren't handling yet?
 759     std::cerr << "Unknown instruction: " << I;
 760     abort();
 761   }
 762 }
 763
 764 void Andersens::visitAllocationInst(AllocationInst &AI) {
 765   getNodeValue(AI)->addPointerTo(getObject(&AI)->setValue(&AI));
 766 }
 767
 768 void Andersens::visitReturnInst(ReturnInst &RI) {
 769   if (RI.getNumOperands() && isa<PointerType>(RI.getOperand(0)->getType()))
 770     // return V   -->   <Copy/retval{F}/v>
 771     Constraints.push_back(Constraint(Constraint::Copy,
 772                                      getReturnNode(RI.getParent()->getParent()),
 773                                      getNode(RI.getOperand(0))));
 774 }
 775
 776 void Andersens::visitLoadInst(LoadInst &LI) {
 777   if (isa<PointerType>(LI.getType()))
 778     // P1 = load P2  -->  <Load/P1/P2>
 779     Constraints.push_back(Constraint(Constraint::Load, getNodeValue(LI),
 780                                      getNode(LI.getOperand(0))));
 781 }
 782
 783 void Andersens::visitStoreInst(StoreInst &SI) {
 784   if (isa<PointerType>(SI.getOperand(0)->getType()))
 785     // store P1, P2  -->  <Store/P2/P1>
 786     Constraints.push_back(Constraint(Constraint::Store,
 787                                      getNode(SI.getOperand(1)),
 788                                      getNode(SI.getOperand(0))));
 789 }
 790
 791 void Andersens::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 792   // P1 = getelementptr P2, ... --> <Copy/P1/P2>
 793   Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(GEP),
 794                                    getNode(GEP.getOperand(0))));
 795 }
 796
 797 void Andersens::visitPHINode(PHINode &PN) {
 798   if (isa<PointerType>(PN.getType())) {
 799     Node *PNN = getNodeValue(PN);
 800     for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 801       // P1 = phi P2, P3  -->  <Copy/P1/P2>, <Copy/P1/P3>, ...
 802       Constraints.push_back(Constraint(Constraint::Copy, PNN,
 803                                        getNode(PN.getIncomingValue(i))));
 804   }
 805 }
 806
 807 void Andersens::visitCastInst(CastInst &CI) {
 808   Value *Op = CI.getOperand(0);
 809   if (isa<PointerType>(CI.getType())) {
 810     if (isa<PointerType>(Op->getType())) {
 811       // P1 = cast P2  --> <Copy/P1/P2>
 812       Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(CI),
 813                                        getNode(CI.getOperand(0))));
 814     } else {
 815       // P1 = cast int --> <Copy/P1/Univ>
 816       Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(CI),
 817                                        &GraphNodes[UniversalSet]));
 818     }
 819   } else if (isa<PointerType>(Op->getType())) {
 820     // int = cast P1 --> <Copy/Univ/P1>
 821     Constraints.push_back(Constraint(Constraint::Copy,
 822                                      &GraphNodes[UniversalSet],
 823                                      getNode(CI.getOperand(0))));
 824   }
 825 }
 826
 827 void Andersens::visitSelectInst(SelectInst &SI) {
 828   if (isa<PointerType>(SI.getType())) {
 829     Node *SIN = getNodeValue(SI);
 830     // P1 = select C, P2, P3   ---> <Copy/P1/P2>, <Copy/P1/P3>
 831     Constraints.push_back(Constraint(Constraint::Copy, SIN,
 832                                      getNode(SI.getOperand(1))));
 833     Constraints.push_back(Constraint(Constraint::Copy, SIN,
 834                                      getNode(SI.getOperand(2))));
 835   }
 836 }
 837
 838 void Andersens::visitVANext(VANextInst &I) {
 839   // FIXME: Implement
 840   assert(0 && "vanext not handled yet!");
 841 }
 842 void Andersens::visitVAArg(VAArgInst &I) {
 843   assert(0 && "vaarg not handled yet!");
 844 }
 845
 846 /// AddConstraintsForCall - Add constraints for a call with actual arguments
 847 /// specified by CS to the function specified by F.  Note that the types of
 848 /// arguments might not match up in the case where this is an indirect call and
 849 /// the function pointer has been casted.  If this is the case, do something
 850 /// reasonable.
 851 void Andersens::AddConstraintsForCall(CallSite CS, Function *F) {
 852   // If this is a call to an external function, handle it directly to get some
 853   // taste of context sensitivity.
 854   if (F->isExternal() && AddConstraintsForExternalCall(CS, F))
 855     return;
 856
 857   if (isa<PointerType>(CS.getType())) {
 858     Node *CSN = getNode(CS.getInstruction());
 859     if (isa<PointerType>(F->getFunctionType()->getReturnType())) {
 860       Constraints.push_back(Constraint(Constraint::Copy, CSN,
 861                                        getReturnNode(F)));
 862     } else {
 863       // If the function returns a non-pointer value, handle this just like we
 864       // treat a nonpointer cast to pointer.
 865       Constraints.push_back(Constraint(Constraint::Copy, CSN,
 866                                        &GraphNodes[UniversalSet]));
 867     }
 868   } else if (isa<PointerType>(F->getFunctionType()->getReturnType())) {
 869     Constraints.push_back(Constraint(Constraint::Copy,
 870                                      &GraphNodes[UniversalSet],
 871                                      getReturnNode(F)));
 872   }
 873
 874   Function::arg_iterator AI = F->arg_begin(), AE = F->arg_end();
 875   CallSite::arg_iterator ArgI = CS.arg_begin(), ArgE = CS.arg_end();
 876   for (; AI != AE && ArgI != ArgE; ++AI, ++ArgI)
 877     if (isa<PointerType>(AI->getType())) {
 878       if (isa<PointerType>((*ArgI)->getType())) {
 879         // Copy the actual argument into the formal argument.
 880         Constraints.push_back(Constraint(Constraint::Copy, getNode(AI),
 881                                          getNode(*ArgI)));
 882       } else {
 883         Constraints.push_back(Constraint(Constraint::Copy, getNode(AI),
 884                                          &GraphNodes[UniversalSet]));
 885       }
 886     } else if (isa<PointerType>((*ArgI)->getType())) {
 887       Constraints.push_back(Constraint(Constraint::Copy,
 888                                        &GraphNodes[UniversalSet],
 889                                        getNode(*ArgI)));
 890     }
 891
 892   // Copy all pointers passed through the varargs section to the varargs node.
 893   if (F->getFunctionType()->isVarArg())
 894     for (; ArgI != ArgE; ++ArgI)
 895       if (isa<PointerType>((*ArgI)->getType()))
 896         Constraints.push_back(Constraint(Constraint::Copy, getVarargNode(F),
 897                                          getNode(*ArgI)));
 898   // If more arguments are passed in than we track, just drop them on the floor.
 899 }
 900
 901 void Andersens::visitCallSite(CallSite CS) {
 902   if (isa<PointerType>(CS.getType()))
 903     getNodeValue(*CS.getInstruction());
 904
 905   if (Function *F = CS.getCalledFunction()) {
 906     AddConstraintsForCall(CS, F);
 907   } else {
 908     // We don't handle indirect call sites yet.  Keep track of them for when we
 909     // discover the call graph incrementally.
 910     IndirectCalls.push_back(CS);
 911   }
 912 }
 913
 914 //===----------------------------------------------------------------------===//
 915 //                         Constraint Solving Phase
 916 //===----------------------------------------------------------------------===//
 917
 918 /// intersects - Return true if the points-to set of this node intersects
 919 /// with the points-to set of the specified node.
 920 bool Andersens::Node::intersects(Node *N) const {
 921   iterator I1 = begin(), I2 = N->begin(), E1 = end(), E2 = N->end();
 922   while (I1 != E1 && I2 != E2) {
 923     if (*I1 == *I2) return true;
 924     if (*I1 < *I2)
 925       ++I1;
 926     else
 927       ++I2;
 928   }
 929   return false;
 930 }
 931
 932 /// intersectsIgnoring - Return true if the points-to set of this node
 933 /// intersects with the points-to set of the specified node on any nodes
 934 /// except for the specified node to ignore.
 935 bool Andersens::Node::intersectsIgnoring(Node *N, Node *Ignoring) const {
 936   iterator I1 = begin(), I2 = N->begin(), E1 = end(), E2 = N->end();
 937   while (I1 != E1 && I2 != E2) {
 938     if (*I1 == *I2) {
 939       if (*I1 != Ignoring) return true;
 940       ++I1; ++I2;
 941     } else if (*I1 < *I2)
 942       ++I1;
 943     else
 944       ++I2;
 945   }
 946   return false;
 947 }
 948
 949 // Copy constraint: all edges out of the source node get copied to the
 950 // destination node.  This returns true if a change is made.
 951 bool Andersens::Node::copyFrom(Node *N) {
 952   // Use a mostly linear-time merge since both of the lists are sorted.
 953   bool Changed = false;
 954   iterator I = N->begin(), E = N->end();
 955   unsigned i = 0;
 956   while (I != E && i != Pointees.size()) {
 957     if (Pointees[i] < *I) {
 958       ++i;
 959     } else if (Pointees[i] == *I) {
 960       ++i; ++I;
 961     } else {
 962       // We found a new element to copy over.
 963       Changed = true;
 964       Pointees.insert(Pointees.begin()+i, *I);
 965        ++i; ++I;
 966     }
 967   }
 968
 969   if (I != E) {
 970     Pointees.insert(Pointees.end(), I, E);
 971     Changed = true;
 972   }
 973
 974   return Changed;
 975 }
 976
 977 bool Andersens::Node::loadFrom(Node *N) {
 978   bool Changed = false;
 979   for (iterator I = N->begin(), E = N->end(); I != E; ++I)
 980     Changed |= copyFrom(*I);
 981   return Changed;
 982 }
 983
 984 bool Andersens::Node::storeThrough(Node *N) {
 985   bool Changed = false;
 986   for (iterator I = begin(), E = end(); I != E; ++I)
 987     Changed |= (*I)->copyFrom(N);
 988   return Changed;
 989 }
 990
 991
 992 /// SolveConstraints - This stage iteratively processes the constraints list
 993 /// propagating constraints (adding edges to the Nodes in the points-to graph)
 994 /// until a fixed point is reached.
 995 ///
 996 void Andersens::SolveConstraints() {
 997   bool Changed = true;
 998   unsigned Iteration = 0;
 999   while (Changed) {
1000     Changed = false;
1001     ++NumIters;
1002     DEBUG(std::cerr << "Starting iteration #" << Iteration++ << "!\n");
1003
1004     // Loop over all of the constraints, applying them in turn.
1005     for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1006       Constraint &C = Constraints[i];
1007       switch (C.Type) {
1008       case Constraint::Copy:
1009         Changed |= C.Dest->copyFrom(C.Src);
1010         break;
1011       case Constraint::Load:
1012         Changed |= C.Dest->loadFrom(C.Src);
1013         break;
1014       case Constraint::Store:
1015         Changed |= C.Dest->storeThrough(C.Src);
1016         break;
1017       default:
1018         assert(0 && "Unknown constraint!");
1019       }
1020     }
1021
1022     if (Changed) {
1023       // Check to see if any internal function's addresses have been passed to
1024       // external functions.  If so, we have to assume that their incoming
1025       // arguments could be anything.  If there are any internal functions in
1026       // the universal node that we don't know about, we must iterate.
1027       for (Node::iterator I = GraphNodes[UniversalSet].begin(),
1028              E = GraphNodes[UniversalSet].end(); I != E; ++I)
1029         if (Function *F = dyn_cast_or_null<Function>((*I)->getValue()))
1030           if (F->hasInternalLinkage() &&
1031               EscapingInternalFunctions.insert(F).second) {
1032             // We found a function that is just now escaping.  Mark it as if it
1033             // didn't have internal linkage.
1034             AddConstraintsForNonInternalLinkage(F);
1035             DEBUG(std::cerr << "Found escaping internal function: "
1036                             << F->getName() << "\n");
1037             ++NumEscapingFunctions;
1038           }
1039
1040       // Check to see if we have discovered any new callees of the indirect call
1041       // sites.  If so, add constraints to the analysis.
1042       for (unsigned i = 0, e = IndirectCalls.size(); i != e; ++i) {
1043         CallSite CS = IndirectCalls[i];
1044         std::vector<Function*> &KnownCallees = IndirectCallees[CS];
1045         Node *CN = getNode(CS.getCalledValue());
1046
1047         for (Node::iterator NI = CN->begin(), E = CN->end(); NI != E; ++NI)
1048           if (Function *F = dyn_cast_or_null<Function>((*NI)->getValue())) {
1049             std::vector<Function*>::iterator IP =
1050               std::lower_bound(KnownCallees.begin(), KnownCallees.end(), F);
1051             if (IP == KnownCallees.end() || *IP != F) {
1052               // Add the constraints for the call now.
1053               AddConstraintsForCall(CS, F);
1054               DEBUG(std::cerr << "Found actual callee '"
1055                               << F->getName() << "' for call: "
1056                               << *CS.getInstruction() << "\n");
1057               ++NumIndirectCallees;
1058               KnownCallees.insert(IP, F);
1059             }
1060           }
1061       }
1062     }
1063   }
1064 }
1065
1066
1067
1068 //===----------------------------------------------------------------------===//
1069 //                               Debugging Output
1070 //===----------------------------------------------------------------------===//
1071
1072 void Andersens::PrintNode(Node *N) {
1073   if (N == &GraphNodes[UniversalSet]) {
1074     std::cerr << "<universal>";
1075     return;
1076   } else if (N == &GraphNodes[NullPtr]) {
1077     std::cerr << "<nullptr>";
1078     return;
1079   } else if (N == &GraphNodes[NullObject]) {
1080     std::cerr << "<null>";
1081     return;
1082   }
1083
1084   assert(N->getValue() != 0 && "Never set node label!");
1085   Value *V = N->getValue();
1086   if (Function *F = dyn_cast<Function>(V)) {
1087     if (isa<PointerType>(F->getFunctionType()->getReturnType()) &&
1088         N == getReturnNode(F)) {
1089       std::cerr << F->getName() << ":retval";
1090       return;
1091     } else if (F->getFunctionType()->isVarArg() && N == getVarargNode(F)) {
1092       std::cerr << F->getName() << ":vararg";
1093       return;
1094     }
1095   }
1096
1097   if (Instruction *I = dyn_cast<Instruction>(V))
1098     std::cerr << I->getParent()->getParent()->getName() << ":";
1099   else if (Argument *Arg = dyn_cast<Argument>(V))
1100     std::cerr << Arg->getParent()->getName() << ":";
1101
1102   if (V->hasName())
1103     std::cerr << V->getName();
1104   else
1105     std::cerr << "(unnamed)";
1106
1107   if (isa<GlobalValue>(V) || isa<AllocationInst>(V))
1108     if (N == getObject(V))
1109       std::cerr << "<mem>";
1110 }
1111
1112 void Andersens::PrintConstraints() {
1113   std::cerr << "Constraints:\n";
1114   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1115     std::cerr << "  #" << i << ":  ";
1116     Constraint &C = Constraints[i];
1117     if (C.Type == Constraint::Store)
1118       std::cerr << "*";
1119     PrintNode(C.Dest);
1120     std::cerr << " = ";
1121     if (C.Type == Constraint::Load)
1122       std::cerr << "*";
1123     PrintNode(C.Src);
1124     std::cerr << "\n";
1125   }
1126 }
1127
1128 void Andersens::PrintPointsToGraph() {
1129   std::cerr << "Points-to graph:\n";
1130   for (unsigned i = 0, e = GraphNodes.size(); i != e; ++i) {
1131     Node *N = &GraphNodes[i];
1132     std::cerr << "[" << (N->end() - N->begin()) << "] ";
1133     PrintNode(N);
1134     std::cerr << "\t--> ";
1135     for (Node::iterator I = N->begin(), E = N->end(); I != E; ++I) {
1136       if (I != N->begin()) std::cerr << ", ";
1137       PrintNode(*I);
1138     }
1139     std::cerr << "\n";
1140   }
1141 }