lib/Analysis/DataStructure/Local.cpp

   1 //===- Local.cpp - Compute a local data structure graph for a function ----===//
   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 // Compute the local version of the data structure graph for a function.  The
  11 // external interface to this file is the DSGraph constructor.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/DataStructure.h"
  16 #include "llvm/Analysis/DSGraph.h"
  17 #include "llvm/Constants.h"
  18 #include "llvm/DerivedTypes.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Intrinsics.h"
  21 #include "llvm/Support/GetElementPtrTypeIterator.h"
  22 #include "llvm/Support/InstVisitor.h"
  23 #include "llvm/Target/TargetData.h"
  24 #include "Support/CommandLine.h"
  25 #include "Support/Debug.h"
  26 #include "Support/Timer.h"
  27
  28 // FIXME: This should eventually be a FunctionPass that is automatically
  29 // aggregated into a Pass.
  30 //
  31 #include "llvm/Module.h"
  32
  33 using namespace llvm;
  34
  35 static RegisterAnalysis<LocalDataStructures>
  36 X("datastructure", "Local Data Structure Analysis");
  37
  38 static cl::opt<bool>
  39 TrackIntegersAsPointers("dsa-track-integers",
  40          cl::desc("If this is set, track integers as potential pointers"));
  41
  42
  43 namespace llvm {
  44 namespace DS {
  45   // isPointerType - Return true if this type is big enough to hold a pointer.
  46   bool isPointerType(const Type *Ty) {
  47     if (isa<PointerType>(Ty))
  48       return true;
  49     else if (TrackIntegersAsPointers && Ty->isPrimitiveType() &&Ty->isInteger())
  50       return Ty->getPrimitiveSize() >= PointerSize;
  51     return false;
  52   }
  53 }}
  54
  55 using namespace DS;
  56
  57 namespace {
  58   cl::opt<bool>
  59   DisableDirectCallOpt("disable-direct-call-dsopt", cl::Hidden,
  60                        cl::desc("Disable direct call optimization in "
  61                                 "DSGraph construction"));
  62   cl::opt<bool>
  63   DisableFieldSensitivity("disable-ds-field-sensitivity", cl::Hidden,
  64                           cl::desc("Disable field sensitivity in DSGraphs"));
  65
  66   //===--------------------------------------------------------------------===//
  67   //  GraphBuilder Class
  68   //===--------------------------------------------------------------------===//
  69   //
  70   /// This class is the builder class that constructs the local data structure
  71   /// graph by performing a single pass over the function in question.
  72   ///
  73   class GraphBuilder : InstVisitor<GraphBuilder> {
  74     DSGraph &G;
  75     DSNodeHandle *RetNode;               // Node that gets returned...
  76     DSScalarMap &ScalarMap;
  77     std::vector<DSCallSite> *FunctionCalls;
  78
  79   public:
  80     GraphBuilder(Function &f, DSGraph &g, DSNodeHandle &retNode,
  81                  std::vector<DSCallSite> &fc)
  82       : G(g), RetNode(&retNode), ScalarMap(G.getScalarMap()),
  83         FunctionCalls(&fc) {
  84
  85       // Create scalar nodes for all pointer arguments...
  86       for (Function::aiterator I = f.abegin(), E = f.aend(); I != E; ++I)
  87         if (isPointerType(I->getType()))
  88           getValueDest(*I);
  89
  90       visit(f);  // Single pass over the function
  91     }
  92
  93     // GraphBuilder ctor for working on the globals graph
  94     GraphBuilder(DSGraph &g)
  95       : G(g), RetNode(0), ScalarMap(G.getScalarMap()), FunctionCalls(0) {
  96     }
  97
  98     void mergeInGlobalInitializer(GlobalVariable *GV);
  99
 100   private:
 101     // Visitor functions, used to handle each instruction type we encounter...
 102     friend class InstVisitor<GraphBuilder>;
 103     void visitMallocInst(MallocInst &MI) { handleAlloc(MI, true); }
 104     void visitAllocaInst(AllocaInst &AI) { handleAlloc(AI, false); }
 105     void handleAlloc(AllocationInst &AI, bool isHeap);
 106
 107     void visitPHINode(PHINode &PN);
 108
 109     void visitGetElementPtrInst(User &GEP);
 110     void visitReturnInst(ReturnInst &RI);
 111     void visitLoadInst(LoadInst &LI);
 112     void visitStoreInst(StoreInst &SI);
 113     void visitCallInst(CallInst &CI);
 114     void visitInvokeInst(InvokeInst &II);
 115     void visitSetCondInst(SetCondInst &SCI) {}  // SetEQ & friends are ignored
 116     void visitFreeInst(FreeInst &FI);
 117     void visitCastInst(CastInst &CI);
 118     void visitInstruction(Instruction &I);
 119
 120     void visitCallSite(CallSite CS);
 121
 122     void MergeConstantInitIntoNode(DSNodeHandle &NH, Constant *C);
 123   private:
 124     // Helper functions used to implement the visitation functions...
 125
 126     /// createNode - Create a new DSNode, ensuring that it is properly added to
 127     /// the graph.
 128     ///
 129     DSNode *createNode(const Type *Ty = 0) {
 130       DSNode *N = new DSNode(Ty, &G);   // Create the node
 131       if (DisableFieldSensitivity) {
 132         N->foldNodeCompletely();
 133         if (DSNode *FN = N->getForwardNode())
 134           N = FN;
 135       }
 136       return N;
 137     }
 138
 139     /// setDestTo - Set the ScalarMap entry for the specified value to point to
 140     /// the specified destination.  If the Value already points to a node, make
 141     /// sure to merge the two destinations together.
 142     ///
 143     void setDestTo(Value &V, const DSNodeHandle &NH);
 144
 145     /// getValueDest - Return the DSNode that the actual value points to.
 146     ///
 147     DSNodeHandle getValueDest(Value &V);
 148
 149     /// getLink - This method is used to return the specified link in the
 150     /// specified node if one exists.  If a link does not already exist (it's
 151     /// null), then we create a new node, link it, then return it.
 152     ///
 153     DSNodeHandle &getLink(const DSNodeHandle &Node, unsigned Link = 0);
 154   };
 155 }
 156
 157 using namespace DS;
 158
 159 //===----------------------------------------------------------------------===//
 160 // DSGraph constructor - Simply use the GraphBuilder to construct the local
 161 // graph.
 162 DSGraph::DSGraph(const TargetData &td, Function &F, DSGraph *GG)
 163   : GlobalsGraph(GG), TD(td) {
 164   PrintAuxCalls = false;
 165
 166   DEBUG(std::cerr << "  [Loc] Calculating graph for: " << F.getName() << "\n");
 167
 168   // Use the graph builder to construct the local version of the graph
 169   GraphBuilder B(F, *this, ReturnNodes[&F], FunctionCalls);
 170 #ifndef NDEBUG
 171   Timer::addPeakMemoryMeasurement();
 172 #endif
 173
 174   // Remove all integral constants from the scalarmap!
 175   for (DSScalarMap::iterator I = ScalarMap.begin(); I != ScalarMap.end();)
 176     if (isa<ConstantIntegral>(I->first))
 177       ScalarMap.erase(I++);
 178     else
 179       ++I;
 180
 181   markIncompleteNodes(DSGraph::MarkFormalArgs);
 182
 183   // Remove any nodes made dead due to merging...
 184   removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 185 }
 186
 187
 188 //===----------------------------------------------------------------------===//
 189 // Helper method implementations...
 190 //
 191
 192 /// getValueDest - Return the DSNode that the actual value points to.
 193 ///
 194 DSNodeHandle GraphBuilder::getValueDest(Value &Val) {
 195   Value *V = &Val;
 196   if (V == Constant::getNullValue(V->getType()))
 197     return 0;  // Null doesn't point to anything, don't add to ScalarMap!
 198
 199   DSNodeHandle &NH = ScalarMap[V];
 200   if (NH.getNode())
 201     return NH;     // Already have a node?  Just return it...
 202
 203   // Otherwise we need to create a new node to point to.
 204   // Check first for constant expressions that must be traversed to
 205   // extract the actual value.
 206   if (Constant *C = dyn_cast<Constant>(V))
 207     if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)) {
 208       return NH = getValueDest(*CPR->getValue());
 209     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 210       if (CE->getOpcode() == Instruction::Cast)
 211         NH = getValueDest(*CE->getOperand(0));
 212       else if (CE->getOpcode() == Instruction::GetElementPtr) {
 213         visitGetElementPtrInst(*CE);
 214         DSScalarMap::iterator I = ScalarMap.find(CE);
 215         assert(I != ScalarMap.end() && "GEP didn't get processed right?");
 216         NH = I->second;
 217       } else {
 218         // This returns a conservative unknown node for any unhandled ConstExpr
 219         return NH = createNode()->setUnknownNodeMarker();
 220       }
 221       if (NH.getNode() == 0) {  // (getelementptr null, X) returns null
 222         ScalarMap.erase(V);
 223         return 0;
 224       }
 225       return NH;
 226
 227     } else if (ConstantIntegral *CI = dyn_cast<ConstantIntegral>(C)) {
 228       // Random constants are unknown mem
 229       return NH = createNode()->setUnknownNodeMarker();
 230     } else {
 231       assert(0 && "Unknown constant type!");
 232     }
 233
 234   // Otherwise we need to create a new node to point to...
 235   DSNode *N;
 236   if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 237     // Create a new global node for this global variable...
 238     N = createNode(GV->getType()->getElementType());
 239     N->addGlobal(GV);
 240   } else {
 241     // Otherwise just create a shadow node
 242     N = createNode();
 243   }
 244
 245   NH.setNode(N);      // Remember that we are pointing to it...
 246   NH.setOffset(0);
 247   return NH;
 248 }
 249
 250
 251 /// getLink - This method is used to return the specified link in the
 252 /// specified node if one exists.  If a link does not already exist (it's
 253 /// null), then we create a new node, link it, then return it.  We must
 254 /// specify the type of the Node field we are accessing so that we know what
 255 /// type should be linked to if we need to create a new node.
 256 ///
 257 DSNodeHandle &GraphBuilder::getLink(const DSNodeHandle &node, unsigned LinkNo) {
 258   DSNodeHandle &Node = const_cast<DSNodeHandle&>(node);
 259   DSNodeHandle &Link = Node.getLink(LinkNo);
 260   if (!Link.getNode()) {
 261     // If the link hasn't been created yet, make and return a new shadow node
 262     Link = createNode();
 263   }
 264   return Link;
 265 }
 266
 267
 268 /// setDestTo - Set the ScalarMap entry for the specified value to point to the
 269 /// specified destination.  If the Value already points to a node, make sure to
 270 /// merge the two destinations together.
 271 ///
 272 void GraphBuilder::setDestTo(Value &V, const DSNodeHandle &NH) {
 273   DSNodeHandle &AINH = ScalarMap[&V];
 274   if (AINH.getNode() == 0)   // Not pointing to anything yet?
 275     AINH = NH;               // Just point directly to NH
 276   else
 277     AINH.mergeWith(NH);
 278 }
 279
 280
 281 //===----------------------------------------------------------------------===//
 282 // Specific instruction type handler implementations...
 283 //
 284
 285 /// Alloca & Malloc instruction implementation - Simply create a new memory
 286 /// object, pointing the scalar to it.
 287 ///
 288 void GraphBuilder::handleAlloc(AllocationInst &AI, bool isHeap) {
 289   DSNode *N = createNode();
 290   if (isHeap)
 291     N->setHeapNodeMarker();
 292   else
 293     N->setAllocaNodeMarker();
 294   setDestTo(AI, N);
 295 }
 296
 297 // PHINode - Make the scalar for the PHI node point to all of the things the
 298 // incoming values point to... which effectively causes them to be merged.
 299 //
 300 void GraphBuilder::visitPHINode(PHINode &PN) {
 301   if (!isPointerType(PN.getType())) return; // Only pointer PHIs
 302
 303   DSNodeHandle &PNDest = ScalarMap[&PN];
 304   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 305     PNDest.mergeWith(getValueDest(*PN.getIncomingValue(i)));
 306 }
 307
 308 void GraphBuilder::visitGetElementPtrInst(User &GEP) {
 309   DSNodeHandle Value = getValueDest(*GEP.getOperand(0));
 310   if (Value.getNode() == 0) return;
 311
 312   // As a special case, if all of the index operands of GEP are constant zeros,
 313   // handle this just like we handle casts (ie, don't do much).
 314   bool AllZeros = true;
 315   for (unsigned i = 1, e = GEP.getNumOperands(); i != e; ++i)
 316     if (GEP.getOperand(i) !=
 317            Constant::getNullValue(GEP.getOperand(i)->getType())) {
 318       AllZeros = false;
 319       break;
 320     }
 321
 322   // If all of the indices are zero, the result points to the operand without
 323   // applying the type.
 324   if (AllZeros) {
 325     setDestTo(GEP, Value);
 326     return;
 327   }
 328
 329
 330   const PointerType *PTy = cast<PointerType>(GEP.getOperand(0)->getType());
 331   const Type *CurTy = PTy->getElementType();
 332
 333   if (Value.getNode()->mergeTypeInfo(CurTy, Value.getOffset())) {
 334     // If the node had to be folded... exit quickly
 335     setDestTo(GEP, Value);  // GEP result points to folded node
 336     return;
 337   }
 338
 339   const TargetData &TD = Value.getNode()->getTargetData();
 340
 341 #if 0
 342   // Handle the pointer index specially...
 343   if (GEP.getNumOperands() > 1 &&
 344       GEP.getOperand(1) != ConstantSInt::getNullValue(Type::LongTy)) {
 345
 346     // If we already know this is an array being accessed, don't do anything...
 347     if (!TopTypeRec.isArray) {
 348       TopTypeRec.isArray = true;
 349
 350       // If we are treating some inner field pointer as an array, fold the node
 351       // up because we cannot handle it right.  This can come because of
 352       // something like this:  &((&Pt->X)[1]) == &Pt->Y
 353       //
 354       if (Value.getOffset()) {
 355         // Value is now the pointer we want to GEP to be...
 356         Value.getNode()->foldNodeCompletely();
 357         setDestTo(GEP, Value);  // GEP result points to folded node
 358         return;
 359       } else {
 360         // This is a pointer to the first byte of the node.  Make sure that we
 361         // are pointing to the outter most type in the node.
 362         // FIXME: We need to check one more case here...
 363       }
 364     }
 365   }
 366 #endif
 367
 368   // All of these subscripts are indexing INTO the elements we have...
 369   unsigned Offset = 0;
 370   for (gep_type_iterator I = gep_type_begin(GEP), E = gep_type_end(GEP);
 371        I != E; ++I)
 372     if (const StructType *STy = dyn_cast<StructType>(*I)) {
 373       unsigned FieldNo = cast<ConstantUInt>(I.getOperand())->getValue();
 374       Offset += TD.getStructLayout(STy)->MemberOffsets[FieldNo];
 375     }
 376
 377
 378 #if 0
 379     if (const SequentialType *STy = cast<SequentialType>(*I)) {
 380       CurTy = STy->getElementType();
 381       if (ConstantSInt *CS = dyn_cast<ConstantSInt>(GEP.getOperand(i))) {
 382         Offset += CS->getValue()*TD.getTypeSize(CurTy);
 383       } else {
 384         // Variable index into a node.  We must merge all of the elements of the
 385         // sequential type here.
 386         if (isa<PointerType>(STy))
 387           std::cerr << "Pointer indexing not handled yet!\n";
 388         else {
 389           const ArrayType *ATy = cast<ArrayType>(STy);
 390           unsigned ElSize = TD.getTypeSize(CurTy);
 391           DSNode *N = Value.getNode();
 392           assert(N && "Value must have a node!");
 393           unsigned RawOffset = Offset+Value.getOffset();
 394
 395           // Loop over all of the elements of the array, merging them into the
 396           // zeroth element.
 397           for (unsigned i = 1, e = ATy->getNumElements(); i != e; ++i)
 398             // Merge all of the byte components of this array element
 399             for (unsigned j = 0; j != ElSize; ++j)
 400               N->mergeIndexes(RawOffset+j, RawOffset+i*ElSize+j);
 401         }
 402       }
 403     }
 404 #endif
 405
 406   // Add in the offset calculated...
 407   Value.setOffset(Value.getOffset()+Offset);
 408
 409   // Value is now the pointer we want to GEP to be...
 410   setDestTo(GEP, Value);
 411 }
 412
 413 void GraphBuilder::visitLoadInst(LoadInst &LI) {
 414   DSNodeHandle Ptr = getValueDest(*LI.getOperand(0));
 415   if (Ptr.getNode() == 0) return;
 416
 417   // Make that the node is read from...
 418   Ptr.getNode()->setReadMarker();
 419
 420   // Ensure a typerecord exists...
 421   Ptr.getNode()->mergeTypeInfo(LI.getType(), Ptr.getOffset(), false);
 422
 423   if (isPointerType(LI.getType()))
 424     setDestTo(LI, getLink(Ptr));
 425 }
 426
 427 void GraphBuilder::visitStoreInst(StoreInst &SI) {
 428   const Type *StoredTy = SI.getOperand(0)->getType();
 429   DSNodeHandle Dest = getValueDest(*SI.getOperand(1));
 430   if (Dest.getNode() == 0) return;
 431
 432   // Mark that the node is written to...
 433   Dest.getNode()->setModifiedMarker();
 434
 435   // Ensure a type-record exists...
 436   Dest.getNode()->mergeTypeInfo(StoredTy, Dest.getOffset());
 437
 438   // Avoid adding edges from null, or processing non-"pointer" stores
 439   if (isPointerType(StoredTy))
 440     Dest.addEdgeTo(getValueDest(*SI.getOperand(0)));
 441 }
 442
 443 void GraphBuilder::visitReturnInst(ReturnInst &RI) {
 444   if (RI.getNumOperands() && isPointerType(RI.getOperand(0)->getType()))
 445     RetNode->mergeWith(getValueDest(*RI.getOperand(0)));
 446 }
 447
 448 void GraphBuilder::visitCallInst(CallInst &CI) {
 449   visitCallSite(&CI);
 450 }
 451
 452 void GraphBuilder::visitInvokeInst(InvokeInst &II) {
 453   visitCallSite(&II);
 454 }
 455
 456 void GraphBuilder::visitCallSite(CallSite CS) {
 457   // Special case handling of certain libc allocation functions here.
 458   if (Function *F = CS.getCalledFunction())
 459     if (F->isExternal())
 460       switch (F->getIntrinsicID()) {
 461       case Intrinsic::memmove:
 462       case Intrinsic::memcpy: {
 463         // Merge the first & second arguments, and mark the memory read and
 464         // modified.
 465         DSNodeHandle RetNH = getValueDest(**CS.arg_begin());
 466         RetNH.mergeWith(getValueDest(**(CS.arg_begin()+1)));
 467         if (DSNode *N = RetNH.getNode())
 468           N->setModifiedMarker()->setReadMarker();
 469         return;
 470       }
 471       case Intrinsic::memset:
 472         // Mark the memory modified.
 473         if (DSNode *N = getValueDest(**CS.arg_begin()).getNode())
 474           N->setModifiedMarker();
 475         return;
 476       default:
 477         if (F->getName() == "calloc") {
 478           setDestTo(*CS.getInstruction(),
 479                     createNode()->setHeapNodeMarker()->setModifiedMarker());
 480           return;
 481         } else if (F->getName() == "realloc") {
 482           DSNodeHandle RetNH = getValueDest(*CS.getInstruction());
 483           RetNH.mergeWith(getValueDest(**CS.arg_begin()));
 484           if (DSNode *N = RetNH.getNode())
 485             N->setHeapNodeMarker()->setModifiedMarker()->setReadMarker();
 486           return;
 487         } else if (F->getName() == "fopen" && CS.arg_end()-CS.arg_begin() == 2){
 488           // fopen reads the mode argument strings.
 489           CallSite::arg_iterator AI = CS.arg_begin();
 490           DSNodeHandle Path = getValueDest(**AI);
 491           DSNodeHandle Mode = getValueDest(**++AI);
 492           if (DSNode *N = Path.getNode()) N->setReadMarker();
 493           if (DSNode *N = Mode.getNode()) N->setReadMarker();
 494
 495           // fopen allocates in an unknown way and writes to the file
 496           // descriptor.  Also, merge the allocated type into the node.
 497           DSNodeHandle Result = getValueDest(*CS.getInstruction());
 498           Result.getNode()->setModifiedMarker()->setUnknownNodeMarker();
 499           const Type *RetTy = F->getFunctionType()->getReturnType();
 500           if (const PointerType *PTy = dyn_cast<PointerType>(RetTy))
 501             Result.getNode()->mergeTypeInfo(PTy->getElementType(),
 502                                             Result.getOffset());
 503           return;
 504         } else if (F->getName() == "fclose" && CS.arg_end()-CS.arg_begin() ==1){
 505           // fclose reads and deallocates the memory in an unknown way for the
 506           // file descriptor.  It merges the FILE type into the descriptor.
 507           DSNodeHandle H = getValueDest(**CS.arg_begin());
 508           H.getNode()->setReadMarker()->setUnknownNodeMarker();
 509
 510           const Type *ArgTy = *F->getFunctionType()->param_begin();
 511           if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 512             H.getNode()->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 513           return;
 514         } else if (F->getName() == "fflush" && CS.arg_end()-CS.arg_begin() ==1){
 515           // fclose reads and writes the memory for the file descriptor.  It
 516           // merges the FILE type into the descriptor.
 517           DSNodeHandle H = getValueDest(**CS.arg_begin());
 518           H.getNode()->setReadMarker()->setModifiedMarker();
 519
 520           const Type *ArgTy = *F->getFunctionType()->param_begin();
 521           if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 522             H.getNode()->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 523           return;
 524         } else if (F->getName() == "fgets" && CS.arg_end()-CS.arg_begin() == 3){
 525           // fclose reads and writes the memory for the file descriptor.  It
 526           // merges the FILE type into the descriptor, and writes to the
 527           // argument.  It returns the argument as well.
 528           CallSite::arg_iterator AI = CS.arg_begin();
 529           DSNodeHandle H = getValueDest(**AI);
 530           if (DSNode *N = H.getNode())
 531             N->setModifiedMarker();                        // Writes buffer
 532           H.mergeWith(getValueDest(*CS.getInstruction())); // Returns buffer
 533           ++AI; ++AI;
 534
 535           // Reads and writes file descriptor, merge in FILE type.
 536           H = getValueDest(**CS.arg_begin());
 537           if (DSNode *N = H.getNode())
 538             N->setReadMarker()->setModifiedMarker();
 539           const Type *ArgTy = *(F->getFunctionType()->param_begin()+2);
 540           if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 541             H.getNode()->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 542           return;
 543         } else if (F->getName() == "printf" || F->getName() == "fprintf") {
 544           CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 545
 546           if (F->getName() == "fprintf") {
 547             // fprintf reads and writes the FILE argument, and applies the type
 548             // to it.
 549             DSNodeHandle H = getValueDest(**AI);
 550             if (DSNode *N = H.getNode()) {
 551               N->setModifiedMarker();
 552               const Type *ArgTy = (*AI)->getType();
 553               if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 554                 N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 555             }
 556           }
 557
 558           for (; AI != E; ++AI) {
 559             // printf reads all pointer arguments.
 560             if (isPointerType((*AI)->getType()))
 561               if (DSNode *N = getValueDest(**AI).getNode())
 562                 N->setReadMarker();
 563           }
 564
 565         } else if (F->getName() == "exit") {
 566           // Nothing to do!
 567         } else {
 568           std::cerr << "WARNING: Call to unknown external function '"
 569                     << F->getName() << "' will cause pessimistic results!\n";
 570         }
 571       }
 572
 573
 574   // Set up the return value...
 575   DSNodeHandle RetVal;
 576   Instruction *I = CS.getInstruction();
 577   if (isPointerType(I->getType()))
 578     RetVal = getValueDest(*I);
 579
 580   DSNode *Callee = 0;
 581   if (DisableDirectCallOpt || !isa<Function>(CS.getCalledValue())) {
 582     Callee = getValueDest(*CS.getCalledValue()).getNode();
 583     if (Callee == 0) {
 584       std::cerr << "WARNING: Program is calling through a null pointer?\n"
 585                 << *I;
 586       return;  // Calling a null pointer?
 587     }
 588   }
 589
 590   std::vector<DSNodeHandle> Args;
 591   Args.reserve(CS.arg_end()-CS.arg_begin());
 592
 593   // Calculate the arguments vector...
 594   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); I != E; ++I)
 595     if (isPointerType((*I)->getType()))
 596       Args.push_back(getValueDest(**I));
 597
 598   // Add a new function call entry...
 599   if (Callee)
 600     FunctionCalls->push_back(DSCallSite(CS, RetVal, Callee, Args));
 601   else
 602     FunctionCalls->push_back(DSCallSite(CS, RetVal, CS.getCalledFunction(),
 603                                         Args));
 604 }
 605
 606 void GraphBuilder::visitFreeInst(FreeInst &FI) {
 607   // Mark that the node is written to...
 608   DSNode *N = getValueDest(*FI.getOperand(0)).getNode();
 609   N->setModifiedMarker();
 610   N->setHeapNodeMarker();
 611 }
 612
 613 /// Handle casts...
 614 void GraphBuilder::visitCastInst(CastInst &CI) {
 615   if (isPointerType(CI.getType()))
 616     if (isPointerType(CI.getOperand(0)->getType())) {
 617       // Cast one pointer to the other, just act like a copy instruction
 618       setDestTo(CI, getValueDest(*CI.getOperand(0)));
 619     } else {
 620       // Cast something (floating point, small integer) to a pointer.  We need
 621       // to track the fact that the node points to SOMETHING, just something we
 622       // don't know about.  Make an "Unknown" node.
 623       //
 624       setDestTo(CI, createNode()->setUnknownNodeMarker());
 625     }
 626 }
 627
 628
 629 // visitInstruction - For all other instruction types, if we have any arguments
 630 // that are of pointer type, make them have unknown composition bits, and merge
 631 // the nodes together.
 632 void GraphBuilder::visitInstruction(Instruction &Inst) {
 633   DSNodeHandle CurNode;
 634   if (isPointerType(Inst.getType()))
 635     CurNode = getValueDest(Inst);
 636   for (User::op_iterator I = Inst.op_begin(), E = Inst.op_end(); I != E; ++I)
 637     if (isPointerType((*I)->getType()))
 638       CurNode.mergeWith(getValueDest(**I));
 639
 640   if (CurNode.getNode())
 641     CurNode.getNode()->setUnknownNodeMarker();
 642 }
 643
 644
 645
 646 //===----------------------------------------------------------------------===//
 647 // LocalDataStructures Implementation
 648 //===----------------------------------------------------------------------===//
 649
 650 // MergeConstantInitIntoNode - Merge the specified constant into the node
 651 // pointed to by NH.
 652 void GraphBuilder::MergeConstantInitIntoNode(DSNodeHandle &NH, Constant *C) {
 653   // Ensure a type-record exists...
 654   NH.getNode()->mergeTypeInfo(C->getType(), NH.getOffset());
 655
 656   if (C->getType()->isFirstClassType()) {
 657     if (isPointerType(C->getType()))
 658       // Avoid adding edges from null, or processing non-"pointer" stores
 659       NH.addEdgeTo(getValueDest(*C));
 660     return;
 661   }
 662
 663   const TargetData &TD = NH.getNode()->getTargetData();
 664
 665   if (ConstantArray *CA = dyn_cast<ConstantArray>(C)) {
 666     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
 667       // We don't currently do any indexing for arrays...
 668       MergeConstantInitIntoNode(NH, cast<Constant>(CA->getOperand(i)));
 669   } else if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
 670     const StructLayout *SL = TD.getStructLayout(CS->getType());
 671     for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
 672       DSNodeHandle NewNH(NH.getNode(), NH.getOffset()+SL->MemberOffsets[i]);
 673       MergeConstantInitIntoNode(NewNH, cast<Constant>(CS->getOperand(i)));
 674     }
 675   } else if (ConstantAggregateZero *CAZ = dyn_cast<ConstantAggregateZero>(C)) {
 676     // Noop
 677   } else {
 678     assert(0 && "Unknown constant type!");
 679   }
 680 }
 681
 682 void GraphBuilder::mergeInGlobalInitializer(GlobalVariable *GV) {
 683   assert(!GV->isExternal() && "Cannot merge in external global!");
 684   // Get a node handle to the global node and merge the initializer into it.
 685   DSNodeHandle NH = getValueDest(*GV);
 686   MergeConstantInitIntoNode(NH, GV->getInitializer());
 687 }
 688
 689
 690 bool LocalDataStructures::run(Module &M) {
 691   GlobalsGraph = new DSGraph(getAnalysis<TargetData>());
 692
 693   const TargetData &TD = getAnalysis<TargetData>();
 694
 695   // Calculate all of the graphs...
 696   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 697     if (!I->isExternal())
 698       DSInfo.insert(std::make_pair(I, new DSGraph(TD, *I, GlobalsGraph)));
 699
 700   GraphBuilder GGB(*GlobalsGraph);
 701
 702   // Add initializers for all of the globals to the globals graph...
 703   for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
 704     if (!I->isExternal())
 705       GGB.mergeInGlobalInitializer(I);
 706
 707   GlobalsGraph->removeTriviallyDeadNodes();
 708   GlobalsGraph->markIncompleteNodes(DSGraph::MarkFormalArgs);
 709   return false;
 710 }
 711
 712 // releaseMemory - If the pass pipeline is done with this pass, we can release
 713 // our memory... here...
 714 //
 715 void LocalDataStructures::releaseMemory() {
 716   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 717          E = DSInfo.end(); I != E; ++I) {
 718     I->second->getReturnNodes().erase(I->first);
 719     if (I->second->getReturnNodes().empty())
 720       delete I->second;
 721   }
 722
 723   // Empty map so next time memory is released, data structures are not
 724   // re-deleted.
 725   DSInfo.clear();
 726   delete GlobalsGraph;
 727   GlobalsGraph = 0;
 728 }
 729