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->addPointerTo(getNodeForConstantPointer(C));
 582   } else if (C->isNullValue()) {
 583     N->addPointerTo(&GraphNodes[NullObject]);
 584     return;
 585   } else if (!isa<UndefValue>(C)) {
 586     // If this is an array or struct, include constraints for each element.
 587     assert(isa<ConstantArray>(C) || isa<ConstantStruct>(C));
 588     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
 589       AddGlobalInitializerConstraints(N, cast<Constant>(C->getOperand(i)));
 590   }
 591 }
 592
 593 /// AddConstraintsForNonInternalLinkage - If this function does not have
 594 /// internal linkage, realize that we can't trust anything passed into or
 595 /// returned by this function.
 596 void Andersens::AddConstraintsForNonInternalLinkage(Function *F) {
 597   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
 598     if (isa<PointerType>(I->getType()))
 599       // If this is an argument of an externally accessible function, the
 600       // incoming pointer might point to anything.
 601       Constraints.push_back(Constraint(Constraint::Copy, getNode(I),
 602                                        &GraphNodes[UniversalSet]));
 603 }
 604
 605 /// AddConstraintsForCall - If this is a call to a "known" function, add the
 606 /// constraints and return true.  If this is a call to an unknown function,
 607 /// return false.
 608 bool Andersens::AddConstraintsForExternalCall(CallSite CS, Function *F) {
 609   assert(F->isExternal() && "Not an external function!");
 610
 611   // These functions don't induce any points-to constraints.
 612   if (F->getName() == "printf" || F->getName() == "fprintf" ||
 613       F->getName() == "sprintf" ||
 614       F->getName() == "fgets" ||
 615       F->getName() == "open" || F->getName() == "fopen" ||
 616       F->getName() == "fclose" || F->getName() == "fflush" ||
 617       F->getName() == "rewind" ||
 618       F->getName() == "atoi" || F->getName() == "unlink" ||
 619       F->getName() == "sscanf" || F->getName() == "fscanf" ||
 620       F->getName() == "llvm.memset" || F->getName() == "memcmp" ||
 621       F->getName() == "read" || F->getName() == "write")
 622     return true;
 623
 624   // These functions do induce points-to edges.
 625   if (F->getName() == "llvm.memcpy" || F->getName() == "llvm.memmove" ||
 626       F->getName() == "memmove") {
 627     // Note: this is a poor approximation, this says Dest = Src, instead of
 628     // *Dest = *Src.
 629     Constraints.push_back(Constraint(Constraint::Copy,
 630                                      getNode(CS.getArgument(0)),
 631                                      getNode(CS.getArgument(1))));
 632     return true;
 633   }
 634
 635   if (F->getName() == "realloc") {
 636     // Result = Arg
 637     Constraints.push_back(Constraint(Constraint::Copy,
 638                                      getNode(CS.getInstruction()),
 639                                      getNode(CS.getArgument(0))));
 640     return true;
 641   }
 642
 643   return false;
 644 }
 645
 646
 647
 648 /// CollectConstraints - This stage scans the program, adding a constraint to
 649 /// the Constraints list for each instruction in the program that induces a
 650 /// constraint, and setting up the initial points-to graph.
 651 ///
 652 void Andersens::CollectConstraints(Module &M) {
 653   // First, the universal set points to itself.
 654   GraphNodes[UniversalSet].addPointerTo(&GraphNodes[UniversalSet]);
 655   //Constraints.push_back(Constraint(Constraint::Load, &GraphNodes[UniversalSet],
 656   //                                 &GraphNodes[UniversalSet]));
 657   Constraints.push_back(Constraint(Constraint::Store, &GraphNodes[UniversalSet],
 658                                    &GraphNodes[UniversalSet]));
 659
 660   // Next, the null pointer points to the null object.
 661   GraphNodes[NullPtr].addPointerTo(&GraphNodes[NullObject]);
 662
 663   // Next, add any constraints on global variables and their initializers.
 664   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 665        I != E; ++I) {
 666     // Associate the address of the global object as pointing to the memory for
 667     // the global: &G = <G memory>
 668     Node *Object = getObject(I);
 669     Object->setValue(I);
 670     getNodeValue(*I)->addPointerTo(Object);
 671
 672     if (I->hasInitializer()) {
 673       AddGlobalInitializerConstraints(Object, I->getInitializer());
 674     } else {
 675       // If it doesn't have an initializer (i.e. it's defined in another
 676       // translation unit), it points to the universal set.
 677       Constraints.push_back(Constraint(Constraint::Copy, Object,
 678                                        &GraphNodes[UniversalSet]));
 679     }
 680   }
 681
 682   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
 683     // Make the function address point to the function object.
 684     getNodeValue(*F)->addPointerTo(getObject(F)->setValue(F));
 685
 686     // Set up the return value node.
 687     if (isa<PointerType>(F->getFunctionType()->getReturnType()))
 688       getReturnNode(F)->setValue(F);
 689     if (F->getFunctionType()->isVarArg())
 690       getVarargNode(F)->setValue(F);
 691
 692     // Set up incoming argument nodes.
 693     for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 694          I != E; ++I)
 695       if (isa<PointerType>(I->getType()))
 696         getNodeValue(*I);
 697
 698     if (!F->hasInternalLinkage())
 699       AddConstraintsForNonInternalLinkage(F);
 700
 701     if (!F->isExternal()) {
 702       // Scan the function body, creating a memory object for each heap/stack
 703       // allocation in the body of the function and a node to represent all
 704       // pointer values defined by instructions and used as operands.
 705       visit(F);
 706     } else {
 707       // External functions that return pointers return the universal set.
 708       if (isa<PointerType>(F->getFunctionType()->getReturnType()))
 709         Constraints.push_back(Constraint(Constraint::Copy,
 710                                          getReturnNode(F),
 711                                          &GraphNodes[UniversalSet]));
 712
 713       // Any pointers that are passed into the function have the universal set
 714       // stored into them.
 715       for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 716            I != E; ++I)
 717         if (isa<PointerType>(I->getType())) {
 718           // Pointers passed into external functions could have anything stored
 719           // through them.
 720           Constraints.push_back(Constraint(Constraint::Store, getNode(I),
 721                                            &GraphNodes[UniversalSet]));
 722           // Memory objects passed into external function calls can have the
 723           // universal set point to them.
 724           Constraints.push_back(Constraint(Constraint::Copy,
 725                                            &GraphNodes[UniversalSet],
 726                                            getNode(I)));
 727         }
 728
 729       // If this is an external varargs function, it can also store pointers
 730       // into any pointers passed through the varargs section.
 731       if (F->getFunctionType()->isVarArg())
 732         Constraints.push_back(Constraint(Constraint::Store, getVarargNode(F),
 733                                          &GraphNodes[UniversalSet]));
 734     }
 735   }
 736   NumConstraints += Constraints.size();
 737 }
 738
 739
 740 void Andersens::visitInstruction(Instruction &I) {
 741 #ifdef NDEBUG
 742   return;          // This function is just a big assert.
 743 #endif
 744   if (isa<BinaryOperator>(I))
 745     return;
 746   // Most instructions don't have any effect on pointer values.
 747   switch (I.getOpcode()) {
 748   case Instruction::Br:
 749   case Instruction::Switch:
 750   case Instruction::Unwind:
 751   case Instruction::Unreachable:
 752   case Instruction::Free:
 753   case Instruction::Shl:
 754   case Instruction::Shr:
 755     return;
 756   default:
 757     // Is this something we aren't handling yet?
 758     std::cerr << "Unknown instruction: " << I;
 759     abort();
 760   }
 761 }
 762
 763 void Andersens::visitAllocationInst(AllocationInst &AI) {
 764   getNodeValue(AI)->addPointerTo(getObject(&AI)->setValue(&AI));
 765 }
 766
 767 void Andersens::visitReturnInst(ReturnInst &RI) {
 768   if (RI.getNumOperands() && isa<PointerType>(RI.getOperand(0)->getType()))
 769     // return V   -->   <Copy/retval{F}/v>
 770     Constraints.push_back(Constraint(Constraint::Copy,
 771                                      getReturnNode(RI.getParent()->getParent()),
 772                                      getNode(RI.getOperand(0))));
 773 }
 774
 775 void Andersens::visitLoadInst(LoadInst &LI) {
 776   if (isa<PointerType>(LI.getType()))
 777     // P1 = load P2  -->  <Load/P1/P2>
 778     Constraints.push_back(Constraint(Constraint::Load, getNodeValue(LI),
 779                                      getNode(LI.getOperand(0))));
 780 }
 781
 782 void Andersens::visitStoreInst(StoreInst &SI) {
 783   if (isa<PointerType>(SI.getOperand(0)->getType()))
 784     // store P1, P2  -->  <Store/P2/P1>
 785     Constraints.push_back(Constraint(Constraint::Store,
 786                                      getNode(SI.getOperand(1)),
 787                                      getNode(SI.getOperand(0))));
 788 }
 789
 790 void Andersens::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 791   // P1 = getelementptr P2, ... --> <Copy/P1/P2>
 792   Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(GEP),
 793                                    getNode(GEP.getOperand(0))));
 794 }
 795
 796 void Andersens::visitPHINode(PHINode &PN) {
 797   if (isa<PointerType>(PN.getType())) {
 798     Node *PNN = getNodeValue(PN);
 799     for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 800       // P1 = phi P2, P3  -->  <Copy/P1/P2>, <Copy/P1/P3>, ...
 801       Constraints.push_back(Constraint(Constraint::Copy, PNN,
 802                                        getNode(PN.getIncomingValue(i))));
 803   }
 804 }
 805
 806 void Andersens::visitCastInst(CastInst &CI) {
 807   Value *Op = CI.getOperand(0);
 808   if (isa<PointerType>(CI.getType())) {
 809     if (isa<PointerType>(Op->getType())) {
 810       // P1 = cast P2  --> <Copy/P1/P2>
 811       Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(CI),
 812                                        getNode(CI.getOperand(0))));
 813     } else {
 814       // P1 = cast int --> <Copy/P1/Univ>
 815       Constraints.push_back(Constraint(Constraint::Copy, getNodeValue(CI),
 816                                        &GraphNodes[UniversalSet]));
 817     }
 818   } else if (isa<PointerType>(Op->getType())) {
 819     // int = cast P1 --> <Copy/Univ/P1>
 820     Constraints.push_back(Constraint(Constraint::Copy,
 821                                      &GraphNodes[UniversalSet],
 822                                      getNode(CI.getOperand(0))));
 823   }
 824 }
 825
 826 void Andersens::visitSelectInst(SelectInst &SI) {
 827   if (isa<PointerType>(SI.getType())) {
 828     Node *SIN = getNodeValue(SI);
 829     // P1 = select C, P2, P3   ---> <Copy/P1/P2>, <Copy/P1/P3>
 830     Constraints.push_back(Constraint(Constraint::Copy, SIN,
 831                                      getNode(SI.getOperand(1))));
 832     Constraints.push_back(Constraint(Constraint::Copy, SIN,
 833                                      getNode(SI.getOperand(2))));
 834   }
 835 }
 836
 837 void Andersens::visitVANext(VANextInst &I) {
 838   // FIXME: Implement
 839   assert(0 && "vanext not handled yet!");
 840 }
 841 void Andersens::visitVAArg(VAArgInst &I) {
 842   assert(0 && "vaarg not handled yet!");
 843 }
 844
 845 /// AddConstraintsForCall - Add constraints for a call with actual arguments
 846 /// specified by CS to the function specified by F.  Note that the types of
 847 /// arguments might not match up in the case where this is an indirect call and
 848 /// the function pointer has been casted.  If this is the case, do something
 849 /// reasonable.
 850 void Andersens::AddConstraintsForCall(CallSite CS, Function *F) {
 851   // If this is a call to an external function, handle it directly to get some
 852   // taste of context sensitivity.
 853   if (F->isExternal() && AddConstraintsForExternalCall(CS, F))
 854     return;
 855
 856   if (isa<PointerType>(CS.getType())) {
 857     Node *CSN = getNode(CS.getInstruction());
 858     if (isa<PointerType>(F->getFunctionType()->getReturnType())) {
 859       Constraints.push_back(Constraint(Constraint::Copy, CSN,
 860                                        getReturnNode(F)));
 861     } else {
 862       // If the function returns a non-pointer value, handle this just like we
 863       // treat a nonpointer cast to pointer.
 864       Constraints.push_back(Constraint(Constraint::Copy, CSN,
 865                                        &GraphNodes[UniversalSet]));
 866     }
 867   } else if (isa<PointerType>(F->getFunctionType()->getReturnType())) {
 868     Constraints.push_back(Constraint(Constraint::Copy,
 869                                      &GraphNodes[UniversalSet],
 870                                      getReturnNode(F)));
 871   }
 872
 873   Function::arg_iterator AI = F->arg_begin(), AE = F->arg_end();
 874   CallSite::arg_iterator ArgI = CS.arg_begin(), ArgE = CS.arg_end();
 875   for (; AI != AE && ArgI != ArgE; ++AI, ++ArgI)
 876     if (isa<PointerType>(AI->getType())) {
 877       if (isa<PointerType>((*ArgI)->getType())) {
 878         // Copy the actual argument into the formal argument.
 879         Constraints.push_back(Constraint(Constraint::Copy, getNode(AI),
 880                                          getNode(*ArgI)));
 881       } else {
 882         Constraints.push_back(Constraint(Constraint::Copy, getNode(AI),
 883                                          &GraphNodes[UniversalSet]));
 884       }
 885     } else if (isa<PointerType>((*ArgI)->getType())) {
 886       Constraints.push_back(Constraint(Constraint::Copy,
 887                                        &GraphNodes[UniversalSet],
 888                                        getNode(*ArgI)));
 889     }
 890
 891   // Copy all pointers passed through the varargs section to the varargs node.
 892   if (F->getFunctionType()->isVarArg())
 893     for (; ArgI != ArgE; ++ArgI)
 894       if (isa<PointerType>((*ArgI)->getType()))
 895         Constraints.push_back(Constraint(Constraint::Copy, getVarargNode(F),
 896                                          getNode(*ArgI)));
 897   // If more arguments are passed in than we track, just drop them on the floor.
 898 }
 899
 900 void Andersens::visitCallSite(CallSite CS) {
 901   if (isa<PointerType>(CS.getType()))
 902     getNodeValue(*CS.getInstruction());
 903
 904   if (Function *F = CS.getCalledFunction()) {
 905     AddConstraintsForCall(CS, F);
 906   } else {
 907     // We don't handle indirect call sites yet.  Keep track of them for when we
 908     // discover the call graph incrementally.
 909     IndirectCalls.push_back(CS);
 910   }
 911 }
 912
 913 //===----------------------------------------------------------------------===//
 914 //                         Constraint Solving Phase
 915 //===----------------------------------------------------------------------===//
 916
 917 /// intersects - Return true if the points-to set of this node intersects
 918 /// with the points-to set of the specified node.
 919 bool Andersens::Node::intersects(Node *N) const {
 920   iterator I1 = begin(), I2 = N->begin(), E1 = end(), E2 = N->end();
 921   while (I1 != E1 && I2 != E2) {
 922     if (*I1 == *I2) return true;
 923     if (*I1 < *I2)
 924       ++I1;
 925     else
 926       ++I2;
 927   }
 928   return false;
 929 }
 930
 931 /// intersectsIgnoring - Return true if the points-to set of this node
 932 /// intersects with the points-to set of the specified node on any nodes
 933 /// except for the specified node to ignore.
 934 bool Andersens::Node::intersectsIgnoring(Node *N, Node *Ignoring) const {
 935   iterator I1 = begin(), I2 = N->begin(), E1 = end(), E2 = N->end();
 936   while (I1 != E1 && I2 != E2) {
 937     if (*I1 == *I2) {
 938       if (*I1 != Ignoring) return true;
 939       ++I1; ++I2;
 940     } else if (*I1 < *I2)
 941       ++I1;
 942     else
 943       ++I2;
 944   }
 945   return false;
 946 }
 947
 948 // Copy constraint: all edges out of the source node get copied to the
 949 // destination node.  This returns true if a change is made.
 950 bool Andersens::Node::copyFrom(Node *N) {
 951   // Use a mostly linear-time merge since both of the lists are sorted.
 952   bool Changed = false;
 953   iterator I = N->begin(), E = N->end();
 954   unsigned i = 0;
 955   while (I != E && i != Pointees.size()) {
 956     if (Pointees[i] < *I) {
 957       ++i;
 958     } else if (Pointees[i] == *I) {
 959       ++i; ++I;
 960     } else {
 961       // We found a new element to copy over.
 962       Changed = true;
 963       Pointees.insert(Pointees.begin()+i, *I);
 964        ++i; ++I;
 965     }
 966   }
 967
 968   if (I != E) {
 969     Pointees.insert(Pointees.end(), I, E);
 970     Changed = true;
 971   }
 972
 973   return Changed;
 974 }
 975
 976 bool Andersens::Node::loadFrom(Node *N) {
 977   bool Changed = false;
 978   for (iterator I = N->begin(), E = N->end(); I != E; ++I)
 979     Changed |= copyFrom(*I);
 980   return Changed;
 981 }
 982
 983 bool Andersens::Node::storeThrough(Node *N) {
 984   bool Changed = false;
 985   for (iterator I = begin(), E = end(); I != E; ++I)
 986     Changed |= (*I)->copyFrom(N);
 987   return Changed;
 988 }
 989
 990
 991 /// SolveConstraints - This stage iteratively processes the constraints list
 992 /// propagating constraints (adding edges to the Nodes in the points-to graph)
 993 /// until a fixed point is reached.
 994 ///
 995 void Andersens::SolveConstraints() {
 996   bool Changed = true;
 997   unsigned Iteration = 0;
 998   while (Changed) {
 999     Changed = false;
1000     ++NumIters;
1001     DEBUG(std::cerr << "Starting iteration #" << Iteration++ << "!\n");
1002
1003     // Loop over all of the constraints, applying them in turn.
1004     for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1005       Constraint &C = Constraints[i];
1006       switch (C.Type) {
1007       case Constraint::Copy:
1008         Changed |= C.Dest->copyFrom(C.Src);
1009         break;
1010       case Constraint::Load:
1011         Changed |= C.Dest->loadFrom(C.Src);
1012         break;
1013       case Constraint::Store:
1014         Changed |= C.Dest->storeThrough(C.Src);
1015         break;
1016       default:
1017         assert(0 && "Unknown constraint!");
1018       }
1019     }
1020
1021     if (Changed) {
1022       // Check to see if any internal function's addresses have been passed to
1023       // external functions.  If so, we have to assume that their incoming
1024       // arguments could be anything.  If there are any internal functions in
1025       // the universal node that we don't know about, we must iterate.
1026       for (Node::iterator I = GraphNodes[UniversalSet].begin(),
1027              E = GraphNodes[UniversalSet].end(); I != E; ++I)
1028         if (Function *F = dyn_cast_or_null<Function>((*I)->getValue()))
1029           if (F->hasInternalLinkage() &&
1030               EscapingInternalFunctions.insert(F).second) {
1031             // We found a function that is just now escaping.  Mark it as if it
1032             // didn't have internal linkage.
1033             AddConstraintsForNonInternalLinkage(F);
1034             DEBUG(std::cerr << "Found escaping internal function: "
1035                             << F->getName() << "\n");
1036             ++NumEscapingFunctions;
1037           }
1038
1039       // Check to see if we have discovered any new callees of the indirect call
1040       // sites.  If so, add constraints to the analysis.
1041       for (unsigned i = 0, e = IndirectCalls.size(); i != e; ++i) {
1042         CallSite CS = IndirectCalls[i];
1043         std::vector<Function*> &KnownCallees = IndirectCallees[CS];
1044         Node *CN = getNode(CS.getCalledValue());
1045
1046         for (Node::iterator NI = CN->begin(), E = CN->end(); NI != E; ++NI)
1047           if (Function *F = dyn_cast_or_null<Function>((*NI)->getValue())) {
1048             std::vector<Function*>::iterator IP =
1049               std::lower_bound(KnownCallees.begin(), KnownCallees.end(), F);
1050             if (IP == KnownCallees.end() || *IP != F) {
1051               // Add the constraints for the call now.
1052               AddConstraintsForCall(CS, F);
1053               DEBUG(std::cerr << "Found actual callee '"
1054                               << F->getName() << "' for call: "
1055                               << *CS.getInstruction() << "\n");
1056               ++NumIndirectCallees;
1057               KnownCallees.insert(IP, F);
1058             }
1059           }
1060       }
1061     }
1062   }
1063 }
1064
1065
1066
1067 //===----------------------------------------------------------------------===//
1068 //                               Debugging Output
1069 //===----------------------------------------------------------------------===//
1070
1071 void Andersens::PrintNode(Node *N) {
1072   if (N == &GraphNodes[UniversalSet]) {
1073     std::cerr << "<universal>";
1074     return;
1075   } else if (N == &GraphNodes[NullPtr]) {
1076     std::cerr << "<nullptr>";
1077     return;
1078   } else if (N == &GraphNodes[NullObject]) {
1079     std::cerr << "<null>";
1080     return;
1081   }
1082
1083   assert(N->getValue() != 0 && "Never set node label!");
1084   Value *V = N->getValue();
1085   if (Function *F = dyn_cast<Function>(V)) {
1086     if (isa<PointerType>(F->getFunctionType()->getReturnType()) &&
1087         N == getReturnNode(F)) {
1088       std::cerr << F->getName() << ":retval";
1089       return;
1090     } else if (F->getFunctionType()->isVarArg() && N == getVarargNode(F)) {
1091       std::cerr << F->getName() << ":vararg";
1092       return;
1093     }
1094   }
1095
1096   if (Instruction *I = dyn_cast<Instruction>(V))
1097     std::cerr << I->getParent()->getParent()->getName() << ":";
1098   else if (Argument *Arg = dyn_cast<Argument>(V))
1099     std::cerr << Arg->getParent()->getName() << ":";
1100
1101   if (V->hasName())
1102     std::cerr << V->getName();
1103   else
1104     std::cerr << "(unnamed)";
1105
1106   if (isa<GlobalValue>(V) || isa<AllocationInst>(V))
1107     if (N == getObject(V))
1108       std::cerr << "<mem>";
1109 }
1110
1111 void Andersens::PrintConstraints() {
1112   std::cerr << "Constraints:\n";
1113   for (unsigned i = 0, e = Constraints.size(); i != e; ++i) {
1114     std::cerr << "  #" << i << ":  ";
1115     Constraint &C = Constraints[i];
1116     if (C.Type == Constraint::Store)
1117       std::cerr << "*";
1118     PrintNode(C.Dest);
1119     std::cerr << " = ";
1120     if (C.Type == Constraint::Load)
1121       std::cerr << "*";
1122     PrintNode(C.Src);
1123     std::cerr << "\n";
1124   }
1125 }
1126
1127 void Andersens::PrintPointsToGraph() {
1128   std::cerr << "Points-to graph:\n";
1129   for (unsigned i = 0, e = GraphNodes.size(); i != e; ++i) {
1130     Node *N = &GraphNodes[i];
1131     std::cerr << "[" << (N->end() - N->begin()) << "] ";
1132     PrintNode(N);
1133     std::cerr << "\t--> ";
1134     for (Node::iterator I = N->begin(), E = N->end(); I != E; ++I) {
1135       if (I != N->begin()) std::cerr << ", ";
1136       PrintNode(*I);
1137     }
1138     std::cerr << "\n";
1139   }
1140 }