lib/Analysis/DataStructure/Local.cpp

   1 //===- Local.cpp - Compute a local data structure graph for a function ----===//
   2 //
   3 // Compute the local version of the data structure graph for a function.  The
   4 // external interface to this file is the DSGraph constructor.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #include "llvm/Analysis/DataStructure.h"
   9 #include "llvm/Analysis/DSGraph.h"
  10 #include "llvm/iMemory.h"
  11 #include "llvm/iTerminators.h"
  12 #include "llvm/iPHINode.h"
  13 #include "llvm/iOther.h"
  14 #include "llvm/Constants.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/Function.h"
  17 #include "llvm/GlobalVariable.h"
  18 #include "llvm/Support/InstVisitor.h"
  19 #include "llvm/Target/TargetData.h"
  20 #include "Support/Statistic.h"
  21 #include "Support/Timer.h"
  22 #include "Support/CommandLine.h"
  23
  24 // FIXME: This should eventually be a FunctionPass that is automatically
  25 // aggregated into a Pass.
  26 //
  27 #include "llvm/Module.h"
  28
  29 static RegisterAnalysis<LocalDataStructures>
  30 X("datastructure", "Local Data Structure Analysis");
  31
  32 namespace DS {
  33   // FIXME: Do something smarter with target data!
  34   TargetData TD("temp-td");
  35
  36   // isPointerType - Return true if this type is big enough to hold a pointer.
  37   bool isPointerType(const Type *Ty) {
  38     if (isa<PointerType>(Ty))
  39       return true;
  40     else if (Ty->isPrimitiveType() && Ty->isInteger())
  41       return Ty->getPrimitiveSize() >= PointerSize;
  42     return false;
  43   }
  44 }
  45 using namespace DS;
  46
  47
  48 namespace {
  49   cl::opt<bool>
  50   DisableDirectCallOpt("disable-direct-call-dsopt", cl::Hidden,
  51                        cl::desc("Disable direct call optimization in "
  52                                 "DSGraph construction"));
  53   cl::opt<bool>
  54   DisableFieldSensitivity("disable-ds-field-sensitivity", cl::Hidden,
  55                           cl::desc("Disable field sensitivity in DSGraphs"));
  56
  57   //===--------------------------------------------------------------------===//
  58   //  GraphBuilder Class
  59   //===--------------------------------------------------------------------===//
  60   //
  61   /// This class is the builder class that constructs the local data structure
  62   /// graph by performing a single pass over the function in question.
  63   ///
  64   class GraphBuilder : InstVisitor<GraphBuilder> {
  65     DSGraph &G;
  66     std::vector<DSNode*> &Nodes;
  67     DSNodeHandle &RetNode;               // Node that gets returned...
  68     hash_map<Value*, DSNodeHandle> &ScalarMap;
  69     std::vector<DSCallSite> &FunctionCalls;
  70
  71   public:
  72     GraphBuilder(DSGraph &g, std::vector<DSNode*> &nodes, DSNodeHandle &retNode,
  73                  hash_map<Value*, DSNodeHandle> &SM,
  74                  std::vector<DSCallSite> &fc)
  75       : G(g), Nodes(nodes), RetNode(retNode), ScalarMap(SM), FunctionCalls(fc) {
  76
  77       // Create scalar nodes for all pointer arguments...
  78       for (Function::aiterator I = G.getFunction().abegin(),
  79              E = G.getFunction().aend(); I != E; ++I)
  80         if (isPointerType(I->getType()))
  81           getValueDest(*I);
  82
  83       visit(G.getFunction());  // Single pass over the function
  84     }
  85
  86   private:
  87     // Visitor functions, used to handle each instruction type we encounter...
  88     friend class InstVisitor<GraphBuilder>;
  89     void visitMallocInst(MallocInst &MI) { handleAlloc(MI, DSNode::HeapNode); }
  90     void visitAllocaInst(AllocaInst &AI) { handleAlloc(AI, DSNode::AllocaNode);}
  91     void handleAlloc(AllocationInst &AI, DSNode::NodeTy NT);
  92
  93     void visitPHINode(PHINode &PN);
  94
  95     void visitGetElementPtrInst(User &GEP);
  96     void visitReturnInst(ReturnInst &RI);
  97     void visitLoadInst(LoadInst &LI);
  98     void visitStoreInst(StoreInst &SI);
  99     void visitCallInst(CallInst &CI);
 100     void visitSetCondInst(SetCondInst &SCI) {}  // SetEQ & friends are ignored
 101     void visitFreeInst(FreeInst &FI);
 102     void visitCastInst(CastInst &CI);
 103     void visitInstruction(Instruction &I);
 104
 105   private:
 106     // Helper functions used to implement the visitation functions...
 107
 108     /// createNode - Create a new DSNode, ensuring that it is properly added to
 109     /// the graph.
 110     ///
 111     DSNode *createNode(DSNode::NodeTy NodeType, const Type *Ty = 0) {
 112       DSNode *N = new DSNode(NodeType, Ty);   // Create the node
 113       Nodes.push_back(N);                     // Add node to nodes list
 114       if (DisableFieldSensitivity)
 115         N->foldNodeCompletely();
 116       return N;
 117     }
 118
 119     /// setDestTo - Set the ScalarMap entry for the specified value to point to
 120     /// the specified destination.  If the Value already points to a node, make
 121     /// sure to merge the two destinations together.
 122     ///
 123     void setDestTo(Value &V, const DSNodeHandle &NH);
 124
 125     /// getValueDest - Return the DSNode that the actual value points to.
 126     ///
 127     DSNodeHandle getValueDest(Value &V);
 128
 129     /// getLink - This method is used to return the specified link in the
 130     /// specified node if one exists.  If a link does not already exist (it's
 131     /// null), then we create a new node, link it, then return it.
 132     ///
 133     DSNodeHandle &getLink(const DSNodeHandle &Node, unsigned Link = 0);
 134   };
 135 }
 136
 137 //===----------------------------------------------------------------------===//
 138 // DSGraph constructor - Simply use the GraphBuilder to construct the local
 139 // graph.
 140 DSGraph::DSGraph(Function &F, DSGraph *GG) : Func(&F), GlobalsGraph(GG) {
 141   PrintAuxCalls = false;
 142   // Use the graph builder to construct the local version of the graph
 143   GraphBuilder B(*this, Nodes, RetNode, ScalarMap, FunctionCalls);
 144 #ifndef NDEBUG
 145   Timer::addPeakMemoryMeasurement();
 146 #endif
 147   markIncompleteNodes(DSGraph::MarkFormalArgs);
 148
 149   // Remove any nodes made dead due to merging...
 150   removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 151 }
 152
 153
 154 //===----------------------------------------------------------------------===//
 155 // Helper method implementations...
 156 //
 157
 158 /// getValueDest - Return the DSNode that the actual value points to.
 159 ///
 160 DSNodeHandle GraphBuilder::getValueDest(Value &Val) {
 161   Value *V = &Val;
 162   if (V == Constant::getNullValue(V->getType()))
 163     return 0;  // Null doesn't point to anything, don't add to ScalarMap!
 164
 165   DSNodeHandle &NH = ScalarMap[V];
 166   if (NH.getNode())
 167     return NH;     // Already have a node?  Just return it...
 168
 169   // Otherwise we need to create a new node to point to.
 170   // Check first for constant expressions that must be traversed to
 171   // extract the actual value.
 172   if (Constant *C = dyn_cast<Constant>(V))
 173     if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)) {
 174       return NH = getValueDest(*CPR->getValue());
 175     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 176       if (CE->getOpcode() == Instruction::Cast)
 177         NH = getValueDest(*CE->getOperand(0));
 178       else if (CE->getOpcode() == Instruction::GetElementPtr) {
 179         visitGetElementPtrInst(*CE);
 180         hash_map<Value*, DSNodeHandle>::iterator I = ScalarMap.find(CE);
 181         assert(I != ScalarMap.end() && "GEP didn't get processed right?");
 182         NH = I->second;
 183       } else {
 184         // This returns a conservative unknown node for any unhandled ConstExpr
 185         return NH = createNode(DSNode::UnknownNode);
 186       }
 187       if (NH.getNode() == 0) {  // (getelementptr null, X) returns null
 188         ScalarMap.erase(V);
 189         return 0;
 190       }
 191       return NH;
 192
 193     } else if (ConstantIntegral *CI = dyn_cast<ConstantIntegral>(C)) {
 194       // Random constants are unknown mem
 195       return NH = createNode(DSNode::UnknownNode);
 196     } else {
 197       assert(0 && "Unknown constant type!");
 198     }
 199
 200   // Otherwise we need to create a new node to point to...
 201   DSNode *N;
 202   if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 203     // Create a new global node for this global variable...
 204     N = createNode(DSNode::GlobalNode, GV->getType()->getElementType());
 205     N->addGlobal(GV);
 206   } else {
 207     // Otherwise just create a shadow node
 208     N = createNode(DSNode::ShadowNode);
 209   }
 210
 211   NH.setNode(N);      // Remember that we are pointing to it...
 212   NH.setOffset(0);
 213   return NH;
 214 }
 215
 216
 217 /// getLink - This method is used to return the specified link in the
 218 /// specified node if one exists.  If a link does not already exist (it's
 219 /// null), then we create a new node, link it, then return it.  We must
 220 /// specify the type of the Node field we are accessing so that we know what
 221 /// type should be linked to if we need to create a new node.
 222 ///
 223 DSNodeHandle &GraphBuilder::getLink(const DSNodeHandle &node, unsigned LinkNo) {
 224   DSNodeHandle &Node = const_cast<DSNodeHandle&>(node);
 225   DSNodeHandle &Link = Node.getLink(LinkNo);
 226   if (!Link.getNode()) {
 227     // If the link hasn't been created yet, make and return a new shadow node
 228     Link = createNode(DSNode::ShadowNode);
 229   }
 230   return Link;
 231 }
 232
 233
 234 /// setDestTo - Set the ScalarMap entry for the specified value to point to the
 235 /// specified destination.  If the Value already points to a node, make sure to
 236 /// merge the two destinations together.
 237 ///
 238 void GraphBuilder::setDestTo(Value &V, const DSNodeHandle &NH) {
 239   DSNodeHandle &AINH = ScalarMap[&V];
 240   if (AINH.getNode() == 0)   // Not pointing to anything yet?
 241     AINH = NH;               // Just point directly to NH
 242   else
 243     AINH.mergeWith(NH);
 244 }
 245
 246
 247 //===----------------------------------------------------------------------===//
 248 // Specific instruction type handler implementations...
 249 //
 250
 251 /// Alloca & Malloc instruction implementation - Simply create a new memory
 252 /// object, pointing the scalar to it.
 253 ///
 254 void GraphBuilder::handleAlloc(AllocationInst &AI, DSNode::NodeTy NodeType) {
 255   setDestTo(AI, createNode(NodeType));
 256 }
 257
 258 // PHINode - Make the scalar for the PHI node point to all of the things the
 259 // incoming values point to... which effectively causes them to be merged.
 260 //
 261 void GraphBuilder::visitPHINode(PHINode &PN) {
 262   if (!isPointerType(PN.getType())) return; // Only pointer PHIs
 263
 264   DSNodeHandle &PNDest = ScalarMap[&PN];
 265   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 266     PNDest.mergeWith(getValueDest(*PN.getIncomingValue(i)));
 267 }
 268
 269 void GraphBuilder::visitGetElementPtrInst(User &GEP) {
 270   DSNodeHandle Value = getValueDest(*GEP.getOperand(0));
 271   if (Value.getNode() == 0) return;
 272
 273   unsigned Offset = 0;
 274   const PointerType *PTy = cast<PointerType>(GEP.getOperand(0)->getType());
 275   const Type *CurTy = PTy->getElementType();
 276
 277   if (Value.getNode()->mergeTypeInfo(CurTy, Value.getOffset())) {
 278     // If the node had to be folded... exit quickly
 279     setDestTo(GEP, Value);  // GEP result points to folded node
 280     return;
 281   }
 282
 283 #if 0
 284   // Handle the pointer index specially...
 285   if (GEP.getNumOperands() > 1 &&
 286       GEP.getOperand(1) != ConstantSInt::getNullValue(Type::LongTy)) {
 287
 288     // If we already know this is an array being accessed, don't do anything...
 289     if (!TopTypeRec.isArray) {
 290       TopTypeRec.isArray = true;
 291
 292       // If we are treating some inner field pointer as an array, fold the node
 293       // up because we cannot handle it right.  This can come because of
 294       // something like this:  &((&Pt->X)[1]) == &Pt->Y
 295       //
 296       if (Value.getOffset()) {
 297         // Value is now the pointer we want to GEP to be...
 298         Value.getNode()->foldNodeCompletely();
 299         setDestTo(GEP, Value);  // GEP result points to folded node
 300         return;
 301       } else {
 302         // This is a pointer to the first byte of the node.  Make sure that we
 303         // are pointing to the outter most type in the node.
 304         // FIXME: We need to check one more case here...
 305       }
 306     }
 307   }
 308 #endif
 309
 310   // All of these subscripts are indexing INTO the elements we have...
 311   for (unsigned i = 2, e = GEP.getNumOperands(); i < e; ++i)
 312     if (GEP.getOperand(i)->getType() == Type::LongTy) {
 313       // Get the type indexing into...
 314       const SequentialType *STy = cast<SequentialType>(CurTy);
 315       CurTy = STy->getElementType();
 316 #if 0
 317       if (ConstantSInt *CS = dyn_cast<ConstantSInt>(GEP.getOperand(i))) {
 318         Offset += CS->getValue()*TD.getTypeSize(CurTy);
 319       } else {
 320         // Variable index into a node.  We must merge all of the elements of the
 321         // sequential type here.
 322         if (isa<PointerType>(STy))
 323           std::cerr << "Pointer indexing not handled yet!\n";
 324         else {
 325           const ArrayType *ATy = cast<ArrayType>(STy);
 326           unsigned ElSize = TD.getTypeSize(CurTy);
 327           DSNode *N = Value.getNode();
 328           assert(N && "Value must have a node!");
 329           unsigned RawOffset = Offset+Value.getOffset();
 330
 331           // Loop over all of the elements of the array, merging them into the
 332           // zero'th element.
 333           for (unsigned i = 1, e = ATy->getNumElements(); i != e; ++i)
 334             // Merge all of the byte components of this array element
 335             for (unsigned j = 0; j != ElSize; ++j)
 336               N->mergeIndexes(RawOffset+j, RawOffset+i*ElSize+j);
 337         }
 338       }
 339 #endif
 340     } else if (GEP.getOperand(i)->getType() == Type::UByteTy) {
 341       unsigned FieldNo = cast<ConstantUInt>(GEP.getOperand(i))->getValue();
 342       const StructType *STy = cast<StructType>(CurTy);
 343       Offset += TD.getStructLayout(STy)->MemberOffsets[FieldNo];
 344       CurTy = STy->getContainedType(FieldNo);
 345     }
 346
 347   // Add in the offset calculated...
 348   Value.setOffset(Value.getOffset()+Offset);
 349
 350   // Value is now the pointer we want to GEP to be...
 351   setDestTo(GEP, Value);
 352 }
 353
 354 void GraphBuilder::visitLoadInst(LoadInst &LI) {
 355   DSNodeHandle Ptr = getValueDest(*LI.getOperand(0));
 356   if (Ptr.getNode() == 0) return;
 357
 358   // Make that the node is read from...
 359   Ptr.getNode()->NodeType |= DSNode::Read;
 360
 361   // Ensure a typerecord exists...
 362   Ptr.getNode()->mergeTypeInfo(LI.getType(), Ptr.getOffset());
 363
 364   if (isPointerType(LI.getType()))
 365     setDestTo(LI, getLink(Ptr));
 366 }
 367
 368 void GraphBuilder::visitStoreInst(StoreInst &SI) {
 369   const Type *StoredTy = SI.getOperand(0)->getType();
 370   DSNodeHandle Dest = getValueDest(*SI.getOperand(1));
 371   if (Dest.getNode() == 0) return;
 372
 373   // Mark that the node is written to...
 374   Dest.getNode()->NodeType |= DSNode::Modified;
 375
 376   // Ensure a typerecord exists...
 377   Dest.getNode()->mergeTypeInfo(StoredTy, Dest.getOffset());
 378
 379   // Avoid adding edges from null, or processing non-"pointer" stores
 380   if (isPointerType(StoredTy))
 381     Dest.addEdgeTo(getValueDest(*SI.getOperand(0)));
 382 }
 383
 384 void GraphBuilder::visitReturnInst(ReturnInst &RI) {
 385   if (RI.getNumOperands() && isPointerType(RI.getOperand(0)->getType()))
 386     RetNode.mergeWith(getValueDest(*RI.getOperand(0)));
 387 }
 388
 389 void GraphBuilder::visitCallInst(CallInst &CI) {
 390   // Set up the return value...
 391   DSNodeHandle RetVal;
 392   if (isPointerType(CI.getType()))
 393     RetVal = getValueDest(CI);
 394
 395   DSNode *Callee = 0;
 396   if (DisableDirectCallOpt || !isa<Function>(CI.getOperand(0)))
 397     Callee = getValueDest(*CI.getOperand(0)).getNode();
 398
 399   std::vector<DSNodeHandle> Args;
 400   Args.reserve(CI.getNumOperands()-1);
 401
 402   // Calculate the arguments vector...
 403   for (unsigned i = 1, e = CI.getNumOperands(); i != e; ++i)
 404     if (isPointerType(CI.getOperand(i)->getType()))
 405       Args.push_back(getValueDest(*CI.getOperand(i)));
 406
 407   // Add a new function call entry...
 408   if (Callee)
 409     FunctionCalls.push_back(DSCallSite(CI, RetVal, Callee, Args));
 410   else
 411     FunctionCalls.push_back(DSCallSite(CI, RetVal,
 412                                        cast<Function>(CI.getOperand(0)), Args));
 413 }
 414
 415 void GraphBuilder::visitFreeInst(FreeInst &FI) {
 416   // Mark that the node is written to...
 417   getValueDest(*FI.getOperand(0)).getNode()->NodeType
 418     |= DSNode::Modified | DSNode::HeapNode;
 419 }
 420
 421 /// Handle casts...
 422 void GraphBuilder::visitCastInst(CastInst &CI) {
 423   if (isPointerType(CI.getType()))
 424     if (isPointerType(CI.getOperand(0)->getType())) {
 425       // Cast one pointer to the other, just act like a copy instruction
 426       setDestTo(CI, getValueDest(*CI.getOperand(0)));
 427     } else {
 428       // Cast something (floating point, small integer) to a pointer.  We need
 429       // to track the fact that the node points to SOMETHING, just something we
 430       // don't know about.  Make an "Unknown" node.
 431       //
 432       setDestTo(CI, createNode(DSNode::UnknownNode));
 433     }
 434 }
 435
 436
 437 // visitInstruction - For all other instruction types, if we have any arguments
 438 // that are of pointer type, make them have unknown composition bits, and merge
 439 // the nodes together.
 440 void GraphBuilder::visitInstruction(Instruction &Inst) {
 441   DSNodeHandle CurNode;
 442   if (isPointerType(Inst.getType()))
 443     CurNode = getValueDest(Inst);
 444   for (User::op_iterator I = Inst.op_begin(), E = Inst.op_end(); I != E; ++I)
 445     if (isPointerType((*I)->getType()))
 446       CurNode.mergeWith(getValueDest(**I));
 447
 448   if (CurNode.getNode())
 449     CurNode.getNode()->NodeType |= DSNode::UnknownNode;
 450 }
 451
 452
 453
 454 //===----------------------------------------------------------------------===//
 455 // LocalDataStructures Implementation
 456 //===----------------------------------------------------------------------===//
 457
 458 bool LocalDataStructures::run(Module &M) {
 459   GlobalsGraph = new DSGraph();
 460
 461   // Calculate all of the graphs...
 462   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 463     if (!I->isExternal())
 464       DSInfo.insert(std::make_pair(I, new DSGraph(*I, GlobalsGraph)));
 465   return false;
 466 }
 467
 468 // releaseMemory - If the pass pipeline is done with this pass, we can release
 469 // our memory... here...
 470 //
 471 void LocalDataStructures::releaseMemory() {
 472   for (hash_map<const Function*, DSGraph*>::iterator I = DSInfo.begin(),
 473          E = DSInfo.end(); I != E; ++I)
 474     delete I->second;
 475
 476   // Empty map so next time memory is released, data structures are not
 477   // re-deleted.
 478   DSInfo.clear();
 479   delete GlobalsGraph;
 480   GlobalsGraph = 0;
 481 }