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 namespace llvm {
  43 namespace DS {
  44   // isPointerType - Return true if this type is big enough to hold a pointer.
  45   bool isPointerType(const Type *Ty) {
  46     if (isa<PointerType>(Ty))
  47       return true;
  48     else if (TrackIntegersAsPointers && Ty->isPrimitiveType() &&Ty->isInteger())
  49       return Ty->getPrimitiveSize() >= PointerSize;
  50     return false;
  51   }
  52 }}
  53
  54 using namespace DS;
  55
  56 namespace {
  57   cl::opt<bool>
  58   DisableDirectCallOpt("disable-direct-call-dsopt", cl::Hidden,
  59                        cl::desc("Disable direct call optimization in "
  60                                 "DSGraph construction"));
  61   cl::opt<bool>
  62   DisableFieldSensitivity("disable-ds-field-sensitivity", cl::Hidden,
  63                           cl::desc("Disable field sensitivity in DSGraphs"));
  64
  65   //===--------------------------------------------------------------------===//
  66   //  GraphBuilder Class
  67   //===--------------------------------------------------------------------===//
  68   //
  69   /// This class is the builder class that constructs the local data structure
  70   /// graph by performing a single pass over the function in question.
  71   ///
  72   class GraphBuilder : InstVisitor<GraphBuilder> {
  73     DSGraph &G;
  74     DSNodeHandle *RetNode;               // Node that gets returned...
  75     DSScalarMap &ScalarMap;
  76     std::vector<DSCallSite> *FunctionCalls;
  77
  78   public:
  79     GraphBuilder(Function &f, DSGraph &g, DSNodeHandle &retNode,
  80                  std::vector<DSCallSite> &fc)
  81       : G(g), RetNode(&retNode), ScalarMap(G.getScalarMap()),
  82         FunctionCalls(&fc) {
  83
  84       // Create scalar nodes for all pointer arguments...
  85       for (Function::aiterator I = f.abegin(), E = f.aend(); I != E; ++I)
  86         if (isPointerType(I->getType()))
  87           getValueDest(*I);
  88
  89       visit(f);  // Single pass over the function
  90     }
  91
  92     // GraphBuilder ctor for working on the globals graph
  93     GraphBuilder(DSGraph &g)
  94       : G(g), RetNode(0), ScalarMap(G.getScalarMap()), FunctionCalls(0) {
  95     }
  96
  97     void mergeInGlobalInitializer(GlobalVariable *GV);
  98
  99   private:
 100     // Visitor functions, used to handle each instruction type we encounter...
 101     friend class InstVisitor<GraphBuilder>;
 102     void visitMallocInst(MallocInst &MI) { handleAlloc(MI, true); }
 103     void visitAllocaInst(AllocaInst &AI) { handleAlloc(AI, false); }
 104     void handleAlloc(AllocationInst &AI, bool isHeap);
 105
 106     void visitPHINode(PHINode &PN);
 107
 108     void visitGetElementPtrInst(User &GEP);
 109     void visitReturnInst(ReturnInst &RI);
 110     void visitLoadInst(LoadInst &LI);
 111     void visitStoreInst(StoreInst &SI);
 112     void visitCallInst(CallInst &CI);
 113     void visitInvokeInst(InvokeInst &II);
 114     void visitSetCondInst(SetCondInst &SCI) {}  // SetEQ & friends are ignored
 115     void visitFreeInst(FreeInst &FI);
 116     void visitCastInst(CastInst &CI);
 117     void visitInstruction(Instruction &I);
 118
 119     void visitCallSite(CallSite CS);
 120
 121     void MergeConstantInitIntoNode(DSNodeHandle &NH, Constant *C);
 122   private:
 123     // Helper functions used to implement the visitation functions...
 124
 125     /// createNode - Create a new DSNode, ensuring that it is properly added to
 126     /// the graph.
 127     ///
 128     DSNode *createNode(const Type *Ty = 0) {
 129       DSNode *N = new DSNode(Ty, &G);   // Create the node
 130       if (DisableFieldSensitivity) {
 131         N->foldNodeCompletely();
 132         if (DSNode *FN = N->getForwardNode())
 133           N = FN;
 134       }
 135       return N;
 136     }
 137
 138     /// setDestTo - Set the ScalarMap entry for the specified value to point to
 139     /// the specified destination.  If the Value already points to a node, make
 140     /// sure to merge the two destinations together.
 141     ///
 142     void setDestTo(Value &V, const DSNodeHandle &NH);
 143
 144     /// getValueDest - Return the DSNode that the actual value points to.
 145     ///
 146     DSNodeHandle getValueDest(Value &V);
 147
 148     /// getLink - This method is used to return the specified link in the
 149     /// specified node if one exists.  If a link does not already exist (it's
 150     /// null), then we create a new node, link it, then return it.
 151     ///
 152     DSNodeHandle &getLink(const DSNodeHandle &Node, unsigned Link = 0);
 153   };
 154 }
 155
 156 using namespace DS;
 157
 158 //===----------------------------------------------------------------------===//
 159 // DSGraph constructor - Simply use the GraphBuilder to construct the local
 160 // graph.
 161 DSGraph::DSGraph(const TargetData &td, Function &F, DSGraph *GG)
 162   : GlobalsGraph(GG), TD(td) {
 163   PrintAuxCalls = false;
 164
 165   DEBUG(std::cerr << "  [Loc] Calculating graph for: " << F.getName() << "\n");
 166
 167   // Use the graph builder to construct the local version of the graph
 168   GraphBuilder B(F, *this, ReturnNodes[&F], FunctionCalls);
 169 #ifndef NDEBUG
 170   Timer::addPeakMemoryMeasurement();
 171 #endif
 172
 173   // Remove all integral constants from the scalarmap!
 174   for (DSScalarMap::iterator I = ScalarMap.begin(); I != ScalarMap.end();)
 175     if (isa<ConstantIntegral>(I->first))
 176       ScalarMap.erase(I++);
 177     else
 178       ++I;
 179
 180   markIncompleteNodes(DSGraph::MarkFormalArgs);
 181
 182   // Remove any nodes made dead due to merging...
 183   removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 184 }
 185
 186
 187 //===----------------------------------------------------------------------===//
 188 // Helper method implementations...
 189 //
 190
 191 /// getValueDest - Return the DSNode that the actual value points to.
 192 ///
 193 DSNodeHandle GraphBuilder::getValueDest(Value &Val) {
 194   Value *V = &Val;
 195   if (V == Constant::getNullValue(V->getType()))
 196     return 0;  // Null doesn't point to anything, don't add to ScalarMap!
 197
 198   DSNodeHandle &NH = ScalarMap[V];
 199   if (NH.getNode())
 200     return NH;     // Already have a node?  Just return it...
 201
 202   // Otherwise we need to create a new node to point to.
 203   // Check first for constant expressions that must be traversed to
 204   // extract the actual value.
 205   if (Constant *C = dyn_cast<Constant>(V))
 206     if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)) {
 207       return NH = getValueDest(*CPR->getValue());
 208     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 209       if (CE->getOpcode() == Instruction::Cast)
 210         NH = getValueDest(*CE->getOperand(0));
 211       else if (CE->getOpcode() == Instruction::GetElementPtr) {
 212         visitGetElementPtrInst(*CE);
 213         DSScalarMap::iterator I = ScalarMap.find(CE);
 214         assert(I != ScalarMap.end() && "GEP didn't get processed right?");
 215         NH = I->second;
 216       } else {
 217         // This returns a conservative unknown node for any unhandled ConstExpr
 218         return NH = createNode()->setUnknownNodeMarker();
 219       }
 220       if (NH.getNode() == 0) {  // (getelementptr null, X) returns null
 221         ScalarMap.erase(V);
 222         return 0;
 223       }
 224       return NH;
 225
 226     } else if (ConstantIntegral *CI = dyn_cast<ConstantIntegral>(C)) {
 227       // Random constants are unknown mem
 228       return NH = createNode()->setUnknownNodeMarker();
 229     } else {
 230       assert(0 && "Unknown constant type!");
 231     }
 232
 233   // Otherwise we need to create a new node to point to...
 234   DSNode *N;
 235   if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 236     // Create a new global node for this global variable...
 237     N = createNode(GV->getType()->getElementType());
 238     N->addGlobal(GV);
 239   } else {
 240     // Otherwise just create a shadow node
 241     N = createNode();
 242   }
 243
 244   NH.setNode(N);      // Remember that we are pointing to it...
 245   NH.setOffset(0);
 246   return NH;
 247 }
 248
 249
 250 /// getLink - This method is used to return the specified link in the
 251 /// specified node if one exists.  If a link does not already exist (it's
 252 /// null), then we create a new node, link it, then return it.  We must
 253 /// specify the type of the Node field we are accessing so that we know what
 254 /// type should be linked to if we need to create a new node.
 255 ///
 256 DSNodeHandle &GraphBuilder::getLink(const DSNodeHandle &node, unsigned LinkNo) {
 257   DSNodeHandle &Node = const_cast<DSNodeHandle&>(node);
 258   DSNodeHandle &Link = Node.getLink(LinkNo);
 259   if (!Link.getNode()) {
 260     // If the link hasn't been created yet, make and return a new shadow node
 261     Link = createNode();
 262   }
 263   return Link;
 264 }
 265
 266
 267 /// setDestTo - Set the ScalarMap entry for the specified value to point to the
 268 /// specified destination.  If the Value already points to a node, make sure to
 269 /// merge the two destinations together.
 270 ///
 271 void GraphBuilder::setDestTo(Value &V, const DSNodeHandle &NH) {
 272   DSNodeHandle &AINH = ScalarMap[&V];
 273   if (AINH.getNode() == 0)   // Not pointing to anything yet?
 274     AINH = NH;               // Just point directly to NH
 275   else
 276     AINH.mergeWith(NH);
 277 }
 278
 279
 280 //===----------------------------------------------------------------------===//
 281 // Specific instruction type handler implementations...
 282 //
 283
 284 /// Alloca & Malloc instruction implementation - Simply create a new memory
 285 /// object, pointing the scalar to it.
 286 ///
 287 void GraphBuilder::handleAlloc(AllocationInst &AI, bool isHeap) {
 288   DSNode *N = createNode();
 289   if (isHeap)
 290     N->setHeapNodeMarker();
 291   else
 292     N->setAllocaNodeMarker();
 293   setDestTo(AI, N);
 294 }
 295
 296 // PHINode - Make the scalar for the PHI node point to all of the things the
 297 // incoming values point to... which effectively causes them to be merged.
 298 //
 299 void GraphBuilder::visitPHINode(PHINode &PN) {
 300   if (!isPointerType(PN.getType())) return; // Only pointer PHIs
 301
 302   DSNodeHandle &PNDest = ScalarMap[&PN];
 303   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 304     PNDest.mergeWith(getValueDest(*PN.getIncomingValue(i)));
 305 }
 306
 307 void GraphBuilder::visitGetElementPtrInst(User &GEP) {
 308   DSNodeHandle Value = getValueDest(*GEP.getOperand(0));
 309   if (Value.getNode() == 0) return;
 310
 311   // As a special case, if all of the index operands of GEP are constant zeros,
 312   // handle this just like we handle casts (ie, don't do much).
 313   bool AllZeros = true;
 314   for (unsigned i = 1, e = GEP.getNumOperands(); i != e; ++i)
 315     if (GEP.getOperand(i) !=
 316            Constant::getNullValue(GEP.getOperand(i)->getType())) {
 317       AllZeros = false;
 318       break;
 319     }
 320
 321   // If all of the indices are zero, the result points to the operand without
 322   // applying the type.
 323   if (AllZeros) {
 324     setDestTo(GEP, Value);
 325     return;
 326   }
 327
 328
 329   const PointerType *PTy = cast<PointerType>(GEP.getOperand(0)->getType());
 330   const Type *CurTy = PTy->getElementType();
 331
 332   if (Value.getNode()->mergeTypeInfo(CurTy, Value.getOffset())) {
 333     // If the node had to be folded... exit quickly
 334     setDestTo(GEP, Value);  // GEP result points to folded node
 335     return;
 336   }
 337
 338   const TargetData &TD = Value.getNode()->getTargetData();
 339
 340 #if 0
 341   // Handle the pointer index specially...
 342   if (GEP.getNumOperands() > 1 &&
 343       GEP.getOperand(1) != ConstantSInt::getNullValue(Type::LongTy)) {
 344
 345     // If we already know this is an array being accessed, don't do anything...
 346     if (!TopTypeRec.isArray) {
 347       TopTypeRec.isArray = true;
 348
 349       // If we are treating some inner field pointer as an array, fold the node
 350       // up because we cannot handle it right.  This can come because of
 351       // something like this:  &((&Pt->X)[1]) == &Pt->Y
 352       //
 353       if (Value.getOffset()) {
 354         // Value is now the pointer we want to GEP to be...
 355         Value.getNode()->foldNodeCompletely();
 356         setDestTo(GEP, Value);  // GEP result points to folded node
 357         return;
 358       } else {
 359         // This is a pointer to the first byte of the node.  Make sure that we
 360         // are pointing to the outter most type in the node.
 361         // FIXME: We need to check one more case here...
 362       }
 363     }
 364   }
 365 #endif
 366
 367   // All of these subscripts are indexing INTO the elements we have...
 368   unsigned Offset = 0;
 369   for (gep_type_iterator I = gep_type_begin(GEP), E = gep_type_end(GEP);
 370        I != E; ++I)
 371     if (const StructType *STy = dyn_cast<StructType>(*I)) {
 372       unsigned FieldNo = cast<ConstantUInt>(I.getOperand())->getValue();
 373       Offset += TD.getStructLayout(STy)->MemberOffsets[FieldNo];
 374     }
 375
 376
 377 #if 0
 378     if (const SequentialType *STy = cast<SequentialType>(*I)) {
 379       CurTy = STy->getElementType();
 380       if (ConstantSInt *CS = dyn_cast<ConstantSInt>(GEP.getOperand(i))) {
 381         Offset += CS->getValue()*TD.getTypeSize(CurTy);
 382       } else {
 383         // Variable index into a node.  We must merge all of the elements of the
 384         // sequential type here.
 385         if (isa<PointerType>(STy))
 386           std::cerr << "Pointer indexing not handled yet!\n";
 387         else {
 388           const ArrayType *ATy = cast<ArrayType>(STy);
 389           unsigned ElSize = TD.getTypeSize(CurTy);
 390           DSNode *N = Value.getNode();
 391           assert(N && "Value must have a node!");
 392           unsigned RawOffset = Offset+Value.getOffset();
 393
 394           // Loop over all of the elements of the array, merging them into the
 395           // zeroth element.
 396           for (unsigned i = 1, e = ATy->getNumElements(); i != e; ++i)
 397             // Merge all of the byte components of this array element
 398             for (unsigned j = 0; j != ElSize; ++j)
 399               N->mergeIndexes(RawOffset+j, RawOffset+i*ElSize+j);
 400         }
 401       }
 402     }
 403 #endif
 404
 405   // Add in the offset calculated...
 406   Value.setOffset(Value.getOffset()+Offset);
 407
 408   // Value is now the pointer we want to GEP to be...
 409   setDestTo(GEP, Value);
 410 }
 411
 412 void GraphBuilder::visitLoadInst(LoadInst &LI) {
 413   DSNodeHandle Ptr = getValueDest(*LI.getOperand(0));
 414   if (Ptr.getNode() == 0) return;
 415
 416   // Make that the node is read from...
 417   Ptr.getNode()->setReadMarker();
 418
 419   // Ensure a typerecord exists...
 420   Ptr.getNode()->mergeTypeInfo(LI.getType(), Ptr.getOffset(), false);
 421
 422   if (isPointerType(LI.getType()))
 423     setDestTo(LI, getLink(Ptr));
 424 }
 425
 426 void GraphBuilder::visitStoreInst(StoreInst &SI) {
 427   const Type *StoredTy = SI.getOperand(0)->getType();
 428   DSNodeHandle Dest = getValueDest(*SI.getOperand(1));
 429   if (Dest.getNode() == 0) return;
 430
 431   // Mark that the node is written to...
 432   Dest.getNode()->setModifiedMarker();
 433
 434   // Ensure a type-record exists...
 435   Dest.getNode()->mergeTypeInfo(StoredTy, Dest.getOffset());
 436
 437   // Avoid adding edges from null, or processing non-"pointer" stores
 438   if (isPointerType(StoredTy))
 439     Dest.addEdgeTo(getValueDest(*SI.getOperand(0)));
 440 }
 441
 442 void GraphBuilder::visitReturnInst(ReturnInst &RI) {
 443   if (RI.getNumOperands() && isPointerType(RI.getOperand(0)->getType()))
 444     RetNode->mergeWith(getValueDest(*RI.getOperand(0)));
 445 }
 446
 447 void GraphBuilder::visitCallInst(CallInst &CI) {
 448   visitCallSite(&CI);
 449 }
 450
 451 void GraphBuilder::visitInvokeInst(InvokeInst &II) {
 452   visitCallSite(&II);
 453 }
 454
 455 void GraphBuilder::visitCallSite(CallSite CS) {
 456   // Special case handling of certain libc allocation functions here.
 457   if (Function *F = CS.getCalledFunction())
 458     if (F->isExternal())
 459       switch (F->getIntrinsicID()) {
 460       case Intrinsic::memmove:
 461       case Intrinsic::memcpy: {
 462         // Merge the first & second arguments, and mark the memory read and
 463         // modified.
 464         DSNodeHandle RetNH = getValueDest(**CS.arg_begin());
 465         RetNH.mergeWith(getValueDest(**(CS.arg_begin()+1)));
 466         if (DSNode *N = RetNH.getNode())
 467           N->setModifiedMarker()->setReadMarker();
 468         return;
 469       }
 470       case Intrinsic::memset:
 471         // Mark the memory modified.
 472         if (DSNode *N = getValueDest(**CS.arg_begin()).getNode())
 473           N->setModifiedMarker();
 474         return;
 475       default:
 476         if (F->getName() == "calloc") {
 477           setDestTo(*CS.getInstruction(),
 478                     createNode()->setHeapNodeMarker()->setModifiedMarker());
 479           return;
 480         } else if (F->getName() == "realloc") {
 481           DSNodeHandle RetNH = getValueDest(*CS.getInstruction());
 482           RetNH.mergeWith(getValueDest(**CS.arg_begin()));
 483           if (DSNode *N = RetNH.getNode())
 484             N->setHeapNodeMarker()->setModifiedMarker()->setReadMarker();
 485           return;
 486         } else if (F->getName() == "atoi" || F->getName() == "atof" ||
 487                    F->getName() == "atol" || F->getName() == "atoll" ||
 488                    F->getName() == "remove" || F->getName() == "unlink" ||
 489                    F->getName() == "rename" || F->getName() == "memcmp" ||
 490                    F->getName() == "strcmp" || F->getName() == "strncmp" ||
 491                    F->getName() == "execl" || F->getName() == "execlp" ||
 492                    F->getName() == "execle" || F->getName() == "execv" ||
 493                    F->getName() == "execvp" || F->getName() == "chmod" ||
 494                    F->getName() == "puts" || F->getName() == "write" ||
 495                    F->getName() == "open" || F->getName() == "create" ||
 496                    F->getName() == "truncate" || F->getName() == "chdir" ||
 497                    F->getName() == "mkdir" || F->getName() == "rmdir") {
 498           // These functions read all of their pointer operands.
 499           for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 500                AI != E; ++AI) {
 501             if (isPointerType((*AI)->getType()))
 502               if (DSNode *N = getValueDest(**AI).getNode())
 503                 N->setReadMarker();
 504           }
 505           return;
 506         } else if (F->getName() == "read" || F->getName() == "pipe" ||
 507                    F->getName() == "wait") {
 508           // These functions write all of their pointer operands.
 509           for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 510                AI != E; ++AI) {
 511             if (isPointerType((*AI)->getType()))
 512               if (DSNode *N = getValueDest(**AI).getNode())
 513                 N->setModifiedMarker();
 514           }
 515           return;
 516         } else if (F->getName() == "stat" || F->getName() == "fstat" ||
 517                    F->getName() == "lstat") {
 518           // These functions read their first operand if its a pointer.
 519           CallSite::arg_iterator AI = CS.arg_begin();
 520           if (isPointerType((*AI)->getType())) {
 521             DSNodeHandle Path = getValueDest(**AI);
 522             if (DSNode *N = Path.getNode()) N->setReadMarker();
 523           }
 524
 525           // Then they write into the stat buffer.
 526           DSNodeHandle StatBuf = getValueDest(**++AI);
 527           if (DSNode *N = StatBuf.getNode()) {
 528             N->setModifiedMarker();
 529             const Type *StatTy = F->getFunctionType()->getParamType(1);
 530             if (const PointerType *PTy = dyn_cast<PointerType>(StatTy))
 531               N->mergeTypeInfo(PTy->getElementType(), StatBuf.getOffset());
 532           }
 533           return;
 534         } else if (F->getName() == "fopen" || F->getName() == "fdopen") {
 535           // fopen reads the mode argument strings.
 536           CallSite::arg_iterator AI = CS.arg_begin();
 537           if (isPointerType((*AI)->getType())) {
 538             DSNodeHandle Path = getValueDest(**AI);
 539             if (DSNode *N = Path.getNode()) N->setReadMarker();
 540           }
 541
 542           DSNodeHandle Mode = getValueDest(**++AI);
 543           if (DSNode *N = Mode.getNode()) N->setReadMarker();
 544
 545           // fopen allocates in an unknown way and writes to the file
 546           // descriptor.  Also, merge the allocated type into the node.
 547           DSNodeHandle Result = getValueDest(*CS.getInstruction());
 548           if (DSNode *N = Result.getNode()) {
 549             N->setModifiedMarker()->setUnknownNodeMarker();
 550             const Type *RetTy = F->getFunctionType()->getReturnType();
 551             if (const PointerType *PTy = dyn_cast<PointerType>(RetTy))
 552               N->mergeTypeInfo(PTy->getElementType(), Result.getOffset());
 553           }
 554           return;
 555         } else if (F->getName() == "fclose" && CS.arg_end()-CS.arg_begin() ==1){
 556           // fclose reads and deallocates the memory in an unknown way for the
 557           // file descriptor.  It merges the FILE type into the descriptor.
 558           DSNodeHandle H = getValueDest(**CS.arg_begin());
 559           if (DSNode *N = H.getNode()) {
 560             N->setReadMarker()->setUnknownNodeMarker();
 561             const Type *ArgTy = F->getFunctionType()->getParamType(0);
 562             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 563               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 564           }
 565           return;
 566         } else if (CS.arg_end()-CS.arg_begin() == 1 &&
 567                    (F->getName() == "fflush" || F->getName() == "feof" ||
 568                     F->getName() == "fileno" || F->getName() == "clearerr" ||
 569                     F->getName() == "rewind" || F->getName() == "ftell" ||
 570                     F->getName() == "ferror")) {
 571           // fflush reads and writes the memory for the file descriptor.  It
 572           // merges the FILE type into the descriptor.
 573           DSNodeHandle H = getValueDest(**CS.arg_begin());
 574           if (DSNode *N = H.getNode()) {
 575             N->setReadMarker()->setModifiedMarker();
 576
 577             const Type *ArgTy = F->getFunctionType()->getParamType(0);
 578             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 579               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 580           }
 581           return;
 582         } else if (CS.arg_end()-CS.arg_begin() == 4 &&
 583                    (F->getName() == "fwrite" || F->getName() == "fread")) {
 584           // fread writes the first operand, fwrite reads it.  They both
 585           // read/write the FILE descriptor, and merges the FILE type.
 586           DSNodeHandle H = getValueDest(**--CS.arg_end());
 587           if (DSNode *N = H.getNode()) {
 588             N->setReadMarker()->setModifiedMarker();
 589             const Type *ArgTy = F->getFunctionType()->getParamType(3);
 590             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 591               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 592           }
 593
 594           H = getValueDest(**CS.arg_begin());
 595           if (DSNode *N = H.getNode())
 596             if (F->getName() == "fwrite")
 597               N->setReadMarker();
 598             else
 599               N->setModifiedMarker();
 600           return;
 601         } else if (F->getName() == "fgets" && CS.arg_end()-CS.arg_begin() == 3){
 602           // fgets reads and writes the memory for the file descriptor.  It
 603           // merges the FILE type into the descriptor, and writes to the
 604           // argument.  It returns the argument as well.
 605           CallSite::arg_iterator AI = CS.arg_begin();
 606           DSNodeHandle H = getValueDest(**AI);
 607           if (DSNode *N = H.getNode())
 608             N->setModifiedMarker();                        // Writes buffer
 609           H.mergeWith(getValueDest(*CS.getInstruction())); // Returns buffer
 610           ++AI; ++AI;
 611
 612           // Reads and writes file descriptor, merge in FILE type.
 613           H = getValueDest(**AI);
 614           if (DSNode *N = H.getNode()) {
 615             N->setReadMarker()->setModifiedMarker();
 616             const Type *ArgTy = F->getFunctionType()->getParamType(2);
 617             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 618               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 619           }
 620           return;
 621         } else if (F->getName() == "ungetc" || F->getName() == "fputc" ||
 622                    F->getName() == "fputs" || F->getName() == "putc" ||
 623                    F->getName() == "ftell" || F->getName() == "rewind") {
 624           // These functions read and write the memory for the file descriptor.
 625           DSNodeHandle H = getValueDest(**--CS.arg_end());
 626           if (DSNode *N = H.getNode()) {
 627             N->setReadMarker()->setModifiedMarker();
 628             const Type *ArgTy = *--F->getFunctionType()->param_end();
 629             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 630               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 631           }
 632
 633           // Any pointer arguments are read.
 634           for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 635                AI != E; ++AI)
 636             if (isPointerType((*AI)->getType()))
 637               if (DSNode *N = getValueDest(**AI).getNode())
 638                 N->setReadMarker();
 639           return;
 640         } else if (F->getName() == "fseek" || F->getName() == "fgetpos" ||
 641                    F->getName() == "fsetpos") {
 642           // These functions read and write the memory for the file descriptor,
 643           // and read/write all other arguments.
 644           DSNodeHandle H = getValueDest(**CS.arg_begin());
 645           if (DSNode *N = H.getNode()) {
 646             const Type *ArgTy = *--F->getFunctionType()->param_end();
 647             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 648               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 649           }
 650
 651           // Any pointer arguments are read.
 652           for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 653                AI != E; ++AI)
 654             if (isPointerType((*AI)->getType()))
 655               if (DSNode *N = getValueDest(**AI).getNode())
 656                 N->setReadMarker()->setModifiedMarker();
 657           return;
 658         } else if (F->getName() == "printf" || F->getName() == "fprintf" ||
 659                    F->getName() == "sprintf") {
 660           CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 661
 662           if (F->getName() == "fprintf") {
 663             // fprintf reads and writes the FILE argument, and applies the type
 664             // to it.
 665             DSNodeHandle H = getValueDest(**AI);
 666             if (DSNode *N = H.getNode()) {
 667               N->setModifiedMarker();
 668               const Type *ArgTy = (*AI)->getType();
 669               if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 670                 N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 671             }
 672           } else if (F->getName() == "sprintf") {
 673             // sprintf writes the first string argument.
 674             DSNodeHandle H = getValueDest(**AI++);
 675             if (DSNode *N = H.getNode()) {
 676               N->setModifiedMarker();
 677               const Type *ArgTy = (*AI)->getType();
 678               if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 679                 N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 680             }
 681           }
 682
 683           for (; AI != E; ++AI) {
 684             // printf reads all pointer arguments.
 685             if (isPointerType((*AI)->getType()))
 686               if (DSNode *N = getValueDest(**AI).getNode())
 687                 N->setReadMarker();
 688           }
 689           return;
 690         } else if (F->getName() == "scanf" || F->getName() == "fscanf" ||
 691                    F->getName() == "sscanf") {
 692           CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
 693
 694           if (F->getName() == "fscanf") {
 695             // fscanf reads and writes the FILE argument, and applies the type
 696             // to it.
 697             DSNodeHandle H = getValueDest(**AI);
 698             if (DSNode *N = H.getNode()) {
 699               N->setReadMarker();
 700               const Type *ArgTy = (*AI)->getType();
 701               if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 702                 N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 703             }
 704           } else if (F->getName() == "sscanf") {
 705             // sscanf reads the first string argument.
 706             DSNodeHandle H = getValueDest(**AI++);
 707             if (DSNode *N = H.getNode()) {
 708               N->setReadMarker();
 709               const Type *ArgTy = (*AI)->getType();
 710               if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 711                 N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 712             }
 713           }
 714
 715           for (; AI != E; ++AI) {
 716             // scanf writes all pointer arguments.
 717             if (isPointerType((*AI)->getType()))
 718               if (DSNode *N = getValueDest(**AI).getNode())
 719                 N->setModifiedMarker();
 720           }
 721           return;
 722         } else if (F->getName() == "strtok") {
 723           // strtok reads and writes the first argument, returning it.  It reads
 724           // its second arg.  FIXME: strtok also modifies some hidden static
 725           // data.  Someday this might matter.
 726           CallSite::arg_iterator AI = CS.arg_begin();
 727           DSNodeHandle H = getValueDest(**AI++);
 728           if (DSNode *N = H.getNode()) {
 729             N->setReadMarker()->setModifiedMarker();      // Reads/Writes buffer
 730             const Type *ArgTy = F->getFunctionType()->getParamType(0);
 731             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 732               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 733           }
 734           H.mergeWith(getValueDest(*CS.getInstruction())); // Returns buffer
 735
 736           H = getValueDest(**AI);       // Reads delimiter
 737           if (DSNode *N = H.getNode()) {
 738             N->setReadMarker();
 739             const Type *ArgTy = F->getFunctionType()->getParamType(1);
 740             if (const PointerType *PTy = dyn_cast<PointerType>(ArgTy))
 741               N->mergeTypeInfo(PTy->getElementType(), H.getOffset());
 742           }
 743           return;
 744         } else if (F->getName() == "strchr" || F->getName() == "strrchr") {
 745           // These read their first argument, and return it.
 746           DSNodeHandle H = getValueDest(**CS.arg_begin());
 747           if (DSNode *N = H.getNode())
 748             N->setReadMarker();
 749           H.mergeWith(getValueDest(*CS.getInstruction())); // Returns buffer
 750           return;
 751         } else if (F->getName() == "modf" && CS.arg_end()-CS.arg_begin() == 2) {
 752           // This writes its second argument, and forces it to double.
 753           DSNodeHandle H = getValueDest(**--CS.arg_end());
 754           if (DSNode *N = H.getNode()) {
 755             N->setModifiedMarker();
 756             N->mergeTypeInfo(Type::DoubleTy, H.getOffset());
 757           }
 758           return;
 759         } else {
 760           // Unknown function, warn if it returns a pointer type or takes a
 761           // pointer argument.
 762           bool Warn = isPointerType(CS.getInstruction()->getType());
 763           if (!Warn)
 764             for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
 765                  I != E; ++I)
 766               if (isPointerType((*I)->getType())) {
 767                 Warn = true;
 768                 break;
 769               }
 770           if (Warn)
 771             std::cerr << "WARNING: Call to unknown external function '"
 772                       << F->getName() << "' will cause pessimistic results!\n";
 773         }
 774       }
 775
 776
 777   // Set up the return value...
 778   DSNodeHandle RetVal;
 779   Instruction *I = CS.getInstruction();
 780   if (isPointerType(I->getType()))
 781     RetVal = getValueDest(*I);
 782
 783   DSNode *Callee = 0;
 784   if (DisableDirectCallOpt || !isa<Function>(CS.getCalledValue())) {
 785     Callee = getValueDest(*CS.getCalledValue()).getNode();
 786     if (Callee == 0) {
 787       std::cerr << "WARNING: Program is calling through a null pointer?\n"
 788                 << *I;
 789       return;  // Calling a null pointer?
 790     }
 791   }
 792
 793   std::vector<DSNodeHandle> Args;
 794   Args.reserve(CS.arg_end()-CS.arg_begin());
 795
 796   // Calculate the arguments vector...
 797   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); I != E; ++I)
 798     if (isPointerType((*I)->getType()))
 799       Args.push_back(getValueDest(**I));
 800
 801   // Add a new function call entry...
 802   if (Callee)
 803     FunctionCalls->push_back(DSCallSite(CS, RetVal, Callee, Args));
 804   else
 805     FunctionCalls->push_back(DSCallSite(CS, RetVal, CS.getCalledFunction(),
 806                                         Args));
 807 }
 808
 809 void GraphBuilder::visitFreeInst(FreeInst &FI) {
 810   // Mark that the node is written to...
 811   if (DSNode *N = getValueDest(*FI.getOperand(0)).getNode())
 812     N->setModifiedMarker()->setHeapNodeMarker();
 813 }
 814
 815 /// Handle casts...
 816 void GraphBuilder::visitCastInst(CastInst &CI) {
 817   if (isPointerType(CI.getType()))
 818     if (isPointerType(CI.getOperand(0)->getType())) {
 819       // Cast one pointer to the other, just act like a copy instruction
 820       setDestTo(CI, getValueDest(*CI.getOperand(0)));
 821     } else {
 822       // Cast something (floating point, small integer) to a pointer.  We need
 823       // to track the fact that the node points to SOMETHING, just something we
 824       // don't know about.  Make an "Unknown" node.
 825       //
 826       setDestTo(CI, createNode()->setUnknownNodeMarker());
 827     }
 828 }
 829
 830
 831 // visitInstruction - For all other instruction types, if we have any arguments
 832 // that are of pointer type, make them have unknown composition bits, and merge
 833 // the nodes together.
 834 void GraphBuilder::visitInstruction(Instruction &Inst) {
 835   DSNodeHandle CurNode;
 836   if (isPointerType(Inst.getType()))
 837     CurNode = getValueDest(Inst);
 838   for (User::op_iterator I = Inst.op_begin(), E = Inst.op_end(); I != E; ++I)
 839     if (isPointerType((*I)->getType()))
 840       CurNode.mergeWith(getValueDest(**I));
 841
 842   if (CurNode.getNode())
 843     CurNode.getNode()->setUnknownNodeMarker();
 844 }
 845
 846
 847
 848 //===----------------------------------------------------------------------===//
 849 // LocalDataStructures Implementation
 850 //===----------------------------------------------------------------------===//
 851
 852 // MergeConstantInitIntoNode - Merge the specified constant into the node
 853 // pointed to by NH.
 854 void GraphBuilder::MergeConstantInitIntoNode(DSNodeHandle &NH, Constant *C) {
 855   // Ensure a type-record exists...
 856   NH.getNode()->mergeTypeInfo(C->getType(), NH.getOffset());
 857
 858   if (C->getType()->isFirstClassType()) {
 859     if (isPointerType(C->getType()))
 860       // Avoid adding edges from null, or processing non-"pointer" stores
 861       NH.addEdgeTo(getValueDest(*C));
 862     return;
 863   }
 864
 865   const TargetData &TD = NH.getNode()->getTargetData();
 866
 867   if (ConstantArray *CA = dyn_cast<ConstantArray>(C)) {
 868     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
 869       // We don't currently do any indexing for arrays...
 870       MergeConstantInitIntoNode(NH, cast<Constant>(CA->getOperand(i)));
 871   } else if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
 872     const StructLayout *SL = TD.getStructLayout(CS->getType());
 873     for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
 874       DSNodeHandle NewNH(NH.getNode(), NH.getOffset()+SL->MemberOffsets[i]);
 875       MergeConstantInitIntoNode(NewNH, cast<Constant>(CS->getOperand(i)));
 876     }
 877   } else if (ConstantAggregateZero *CAZ = dyn_cast<ConstantAggregateZero>(C)) {
 878     // Noop
 879   } else {
 880     assert(0 && "Unknown constant type!");
 881   }
 882 }
 883
 884 void GraphBuilder::mergeInGlobalInitializer(GlobalVariable *GV) {
 885   assert(!GV->isExternal() && "Cannot merge in external global!");
 886   // Get a node handle to the global node and merge the initializer into it.
 887   DSNodeHandle NH = getValueDest(*GV);
 888   MergeConstantInitIntoNode(NH, GV->getInitializer());
 889 }
 890
 891
 892 bool LocalDataStructures::run(Module &M) {
 893   GlobalsGraph = new DSGraph(getAnalysis<TargetData>());
 894
 895   const TargetData &TD = getAnalysis<TargetData>();
 896
 897   // Calculate all of the graphs...
 898   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 899     if (!I->isExternal())
 900       DSInfo.insert(std::make_pair(I, new DSGraph(TD, *I, GlobalsGraph)));
 901
 902   GraphBuilder GGB(*GlobalsGraph);
 903
 904   // Add initializers for all of the globals to the globals graph...
 905   for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
 906     if (!I->isExternal())
 907       GGB.mergeInGlobalInitializer(I);
 908
 909   GlobalsGraph->removeTriviallyDeadNodes();
 910   GlobalsGraph->markIncompleteNodes(DSGraph::MarkFormalArgs);
 911   return false;
 912 }
 913
 914 // releaseMemory - If the pass pipeline is done with this pass, we can release
 915 // our memory... here...
 916 //
 917 void LocalDataStructures::releaseMemory() {
 918   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 919          E = DSInfo.end(); I != E; ++I) {
 920     I->second->getReturnNodes().erase(I->first);
 921     if (I->second->getReturnNodes().empty())
 922       delete I->second;
 923   }
 924
 925   // Empty map so next time memory is released, data structures are not
 926   // re-deleted.
 927   DSInfo.clear();
 928   delete GlobalsGraph;
 929   GlobalsGraph = 0;
 930 }
 931