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, &G);   // Create the node
 113       if (DisableFieldSensitivity)
 114         N->foldNodeCompletely();
 115       return N;
 116     }
 117
 118     /// setDestTo - Set the ScalarMap entry for the specified value to point to
 119     /// the specified destination.  If the Value already points to a node, make
 120     /// sure to merge the two destinations together.
 121     ///
 122     void setDestTo(Value &V, const DSNodeHandle &NH);
 123
 124     /// getValueDest - Return the DSNode that the actual value points to.
 125     ///
 126     DSNodeHandle getValueDest(Value &V);
 127
 128     /// getLink - This method is used to return the specified link in the
 129     /// specified node if one exists.  If a link does not already exist (it's
 130     /// null), then we create a new node, link it, then return it.
 131     ///
 132     DSNodeHandle &getLink(const DSNodeHandle &Node, unsigned Link = 0);
 133   };
 134 }
 135
 136 //===----------------------------------------------------------------------===//
 137 // DSGraph constructor - Simply use the GraphBuilder to construct the local
 138 // graph.
 139 DSGraph::DSGraph(Function &F, DSGraph *GG) : Func(&F), GlobalsGraph(GG) {
 140   PrintAuxCalls = false;
 141   // Use the graph builder to construct the local version of the graph
 142   GraphBuilder B(*this, Nodes, RetNode, ScalarMap, FunctionCalls);
 143 #ifndef NDEBUG
 144   Timer::addPeakMemoryMeasurement();
 145 #endif
 146
 147   // Remove all integral constants from the scalarmap!
 148   for (hash_map<Value*, DSNodeHandle>::iterator I = ScalarMap.begin();
 149        I != ScalarMap.end();)
 150     if (isa<ConstantIntegral>(I->first)) {
 151       hash_map<Value*, DSNodeHandle>::iterator J = I++;
 152       ScalarMap.erase(J);
 153     } else
 154       ++I;
 155
 156   markIncompleteNodes(DSGraph::MarkFormalArgs);
 157
 158   // Remove any nodes made dead due to merging...
 159   removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 160 }
 161
 162
 163 //===----------------------------------------------------------------------===//
 164 // Helper method implementations...
 165 //
 166
 167 /// getValueDest - Return the DSNode that the actual value points to.
 168 ///
 169 DSNodeHandle GraphBuilder::getValueDest(Value &Val) {
 170   Value *V = &Val;
 171   if (V == Constant::getNullValue(V->getType()))
 172     return 0;  // Null doesn't point to anything, don't add to ScalarMap!
 173
 174   DSNodeHandle &NH = ScalarMap[V];
 175   if (NH.getNode())
 176     return NH;     // Already have a node?  Just return it...
 177
 178   // Otherwise we need to create a new node to point to.
 179   // Check first for constant expressions that must be traversed to
 180   // extract the actual value.
 181   if (Constant *C = dyn_cast<Constant>(V))
 182     if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)) {
 183       return NH = getValueDest(*CPR->getValue());
 184     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 185       if (CE->getOpcode() == Instruction::Cast)
 186         NH = getValueDest(*CE->getOperand(0));
 187       else if (CE->getOpcode() == Instruction::GetElementPtr) {
 188         visitGetElementPtrInst(*CE);
 189         hash_map<Value*, DSNodeHandle>::iterator I = ScalarMap.find(CE);
 190         assert(I != ScalarMap.end() && "GEP didn't get processed right?");
 191         NH = I->second;
 192       } else {
 193         // This returns a conservative unknown node for any unhandled ConstExpr
 194         return NH = createNode(DSNode::UnknownNode);
 195       }
 196       if (NH.getNode() == 0) {  // (getelementptr null, X) returns null
 197         ScalarMap.erase(V);
 198         return 0;
 199       }
 200       return NH;
 201
 202     } else if (ConstantIntegral *CI = dyn_cast<ConstantIntegral>(C)) {
 203       // Random constants are unknown mem
 204       return NH = createNode(DSNode::UnknownNode);
 205     } else {
 206       assert(0 && "Unknown constant type!");
 207     }
 208
 209   // Otherwise we need to create a new node to point to...
 210   DSNode *N;
 211   if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 212     // Create a new global node for this global variable...
 213     N = createNode(DSNode::GlobalNode, GV->getType()->getElementType());
 214     N->addGlobal(GV);
 215   } else {
 216     // Otherwise just create a shadow node
 217     N = createNode(DSNode::ShadowNode);
 218   }
 219
 220   NH.setNode(N);      // Remember that we are pointing to it...
 221   NH.setOffset(0);
 222   return NH;
 223 }
 224
 225
 226 /// getLink - This method is used to return the specified link in the
 227 /// specified node if one exists.  If a link does not already exist (it's
 228 /// null), then we create a new node, link it, then return it.  We must
 229 /// specify the type of the Node field we are accessing so that we know what
 230 /// type should be linked to if we need to create a new node.
 231 ///
 232 DSNodeHandle &GraphBuilder::getLink(const DSNodeHandle &node, unsigned LinkNo) {
 233   DSNodeHandle &Node = const_cast<DSNodeHandle&>(node);
 234   DSNodeHandle &Link = Node.getLink(LinkNo);
 235   if (!Link.getNode()) {
 236     // If the link hasn't been created yet, make and return a new shadow node
 237     Link = createNode(DSNode::ShadowNode);
 238   }
 239   return Link;
 240 }
 241
 242
 243 /// setDestTo - Set the ScalarMap entry for the specified value to point to the
 244 /// specified destination.  If the Value already points to a node, make sure to
 245 /// merge the two destinations together.
 246 ///
 247 void GraphBuilder::setDestTo(Value &V, const DSNodeHandle &NH) {
 248   DSNodeHandle &AINH = ScalarMap[&V];
 249   if (AINH.getNode() == 0)   // Not pointing to anything yet?
 250     AINH = NH;               // Just point directly to NH
 251   else
 252     AINH.mergeWith(NH);
 253 }
 254
 255
 256 //===----------------------------------------------------------------------===//
 257 // Specific instruction type handler implementations...
 258 //
 259
 260 /// Alloca & Malloc instruction implementation - Simply create a new memory
 261 /// object, pointing the scalar to it.
 262 ///
 263 void GraphBuilder::handleAlloc(AllocationInst &AI, DSNode::NodeTy NodeType) {
 264   setDestTo(AI, createNode(NodeType));
 265 }
 266
 267 // PHINode - Make the scalar for the PHI node point to all of the things the
 268 // incoming values point to... which effectively causes them to be merged.
 269 //
 270 void GraphBuilder::visitPHINode(PHINode &PN) {
 271   if (!isPointerType(PN.getType())) return; // Only pointer PHIs
 272
 273   DSNodeHandle &PNDest = ScalarMap[&PN];
 274   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 275     PNDest.mergeWith(getValueDest(*PN.getIncomingValue(i)));
 276 }
 277
 278 void GraphBuilder::visitGetElementPtrInst(User &GEP) {
 279   DSNodeHandle Value = getValueDest(*GEP.getOperand(0));
 280   if (Value.getNode() == 0) return;
 281
 282   unsigned Offset = 0;
 283   const PointerType *PTy = cast<PointerType>(GEP.getOperand(0)->getType());
 284   const Type *CurTy = PTy->getElementType();
 285
 286   if (Value.getNode()->mergeTypeInfo(CurTy, Value.getOffset())) {
 287     // If the node had to be folded... exit quickly
 288     setDestTo(GEP, Value);  // GEP result points to folded node
 289     return;
 290   }
 291
 292 #if 0
 293   // Handle the pointer index specially...
 294   if (GEP.getNumOperands() > 1 &&
 295       GEP.getOperand(1) != ConstantSInt::getNullValue(Type::LongTy)) {
 296
 297     // If we already know this is an array being accessed, don't do anything...
 298     if (!TopTypeRec.isArray) {
 299       TopTypeRec.isArray = true;
 300
 301       // If we are treating some inner field pointer as an array, fold the node
 302       // up because we cannot handle it right.  This can come because of
 303       // something like this:  &((&Pt->X)[1]) == &Pt->Y
 304       //
 305       if (Value.getOffset()) {
 306         // Value is now the pointer we want to GEP to be...
 307         Value.getNode()->foldNodeCompletely();
 308         setDestTo(GEP, Value);  // GEP result points to folded node
 309         return;
 310       } else {
 311         // This is a pointer to the first byte of the node.  Make sure that we
 312         // are pointing to the outter most type in the node.
 313         // FIXME: We need to check one more case here...
 314       }
 315     }
 316   }
 317 #endif
 318
 319   // All of these subscripts are indexing INTO the elements we have...
 320   for (unsigned i = 2, e = GEP.getNumOperands(); i < e; ++i)
 321     if (GEP.getOperand(i)->getType() == Type::LongTy) {
 322       // Get the type indexing into...
 323       const SequentialType *STy = cast<SequentialType>(CurTy);
 324       CurTy = STy->getElementType();
 325 #if 0
 326       if (ConstantSInt *CS = dyn_cast<ConstantSInt>(GEP.getOperand(i))) {
 327         Offset += CS->getValue()*TD.getTypeSize(CurTy);
 328       } else {
 329         // Variable index into a node.  We must merge all of the elements of the
 330         // sequential type here.
 331         if (isa<PointerType>(STy))
 332           std::cerr << "Pointer indexing not handled yet!\n";
 333         else {
 334           const ArrayType *ATy = cast<ArrayType>(STy);
 335           unsigned ElSize = TD.getTypeSize(CurTy);
 336           DSNode *N = Value.getNode();
 337           assert(N && "Value must have a node!");
 338           unsigned RawOffset = Offset+Value.getOffset();
 339
 340           // Loop over all of the elements of the array, merging them into the
 341           // zero'th element.
 342           for (unsigned i = 1, e = ATy->getNumElements(); i != e; ++i)
 343             // Merge all of the byte components of this array element
 344             for (unsigned j = 0; j != ElSize; ++j)
 345               N->mergeIndexes(RawOffset+j, RawOffset+i*ElSize+j);
 346         }
 347       }
 348 #endif
 349     } else if (GEP.getOperand(i)->getType() == Type::UByteTy) {
 350       unsigned FieldNo = cast<ConstantUInt>(GEP.getOperand(i))->getValue();
 351       const StructType *STy = cast<StructType>(CurTy);
 352       Offset += TD.getStructLayout(STy)->MemberOffsets[FieldNo];
 353       CurTy = STy->getContainedType(FieldNo);
 354     }
 355
 356   // Add in the offset calculated...
 357   Value.setOffset(Value.getOffset()+Offset);
 358
 359   // Value is now the pointer we want to GEP to be...
 360   setDestTo(GEP, Value);
 361 }
 362
 363 void GraphBuilder::visitLoadInst(LoadInst &LI) {
 364   DSNodeHandle Ptr = getValueDest(*LI.getOperand(0));
 365   if (Ptr.getNode() == 0) return;
 366
 367   // Make that the node is read from...
 368   Ptr.getNode()->NodeType |= DSNode::Read;
 369
 370   // Ensure a typerecord exists...
 371   Ptr.getNode()->mergeTypeInfo(LI.getType(), Ptr.getOffset(), false);
 372
 373   if (isPointerType(LI.getType()))
 374     setDestTo(LI, getLink(Ptr));
 375 }
 376
 377 void GraphBuilder::visitStoreInst(StoreInst &SI) {
 378   const Type *StoredTy = SI.getOperand(0)->getType();
 379   DSNodeHandle Dest = getValueDest(*SI.getOperand(1));
 380   if (Dest.getNode() == 0) return;
 381
 382   // Mark that the node is written to...
 383   Dest.getNode()->NodeType |= DSNode::Modified;
 384
 385   // Ensure a typerecord exists...
 386   Dest.getNode()->mergeTypeInfo(StoredTy, Dest.getOffset());
 387
 388   // Avoid adding edges from null, or processing non-"pointer" stores
 389   if (isPointerType(StoredTy))
 390     Dest.addEdgeTo(getValueDest(*SI.getOperand(0)));
 391 }
 392
 393 void GraphBuilder::visitReturnInst(ReturnInst &RI) {
 394   if (RI.getNumOperands() && isPointerType(RI.getOperand(0)->getType()))
 395     RetNode.mergeWith(getValueDest(*RI.getOperand(0)));
 396 }
 397
 398 void GraphBuilder::visitCallInst(CallInst &CI) {
 399   // Set up the return value...
 400   DSNodeHandle RetVal;
 401   if (isPointerType(CI.getType()))
 402     RetVal = getValueDest(CI);
 403
 404   DSNode *Callee = 0;
 405   if (DisableDirectCallOpt || !isa<Function>(CI.getOperand(0)))
 406     Callee = getValueDest(*CI.getOperand(0)).getNode();
 407
 408   std::vector<DSNodeHandle> Args;
 409   Args.reserve(CI.getNumOperands()-1);
 410
 411   // Calculate the arguments vector...
 412   for (unsigned i = 1, e = CI.getNumOperands(); i != e; ++i)
 413     if (isPointerType(CI.getOperand(i)->getType()))
 414       Args.push_back(getValueDest(*CI.getOperand(i)));
 415
 416   // Add a new function call entry...
 417   if (Callee)
 418     FunctionCalls.push_back(DSCallSite(CI, RetVal, Callee, Args));
 419   else
 420     FunctionCalls.push_back(DSCallSite(CI, RetVal,
 421                                        cast<Function>(CI.getOperand(0)), Args));
 422 }
 423
 424 void GraphBuilder::visitFreeInst(FreeInst &FI) {
 425   // Mark that the node is written to...
 426   getValueDest(*FI.getOperand(0)).getNode()->NodeType
 427     |= DSNode::Modified | DSNode::HeapNode;
 428 }
 429
 430 /// Handle casts...
 431 void GraphBuilder::visitCastInst(CastInst &CI) {
 432   if (isPointerType(CI.getType()))
 433     if (isPointerType(CI.getOperand(0)->getType())) {
 434       // Cast one pointer to the other, just act like a copy instruction
 435       setDestTo(CI, getValueDest(*CI.getOperand(0)));
 436     } else {
 437       // Cast something (floating point, small integer) to a pointer.  We need
 438       // to track the fact that the node points to SOMETHING, just something we
 439       // don't know about.  Make an "Unknown" node.
 440       //
 441       setDestTo(CI, createNode(DSNode::UnknownNode));
 442     }
 443 }
 444
 445
 446 // visitInstruction - For all other instruction types, if we have any arguments
 447 // that are of pointer type, make them have unknown composition bits, and merge
 448 // the nodes together.
 449 void GraphBuilder::visitInstruction(Instruction &Inst) {
 450   DSNodeHandle CurNode;
 451   if (isPointerType(Inst.getType()))
 452     CurNode = getValueDest(Inst);
 453   for (User::op_iterator I = Inst.op_begin(), E = Inst.op_end(); I != E; ++I)
 454     if (isPointerType((*I)->getType()))
 455       CurNode.mergeWith(getValueDest(**I));
 456
 457   if (CurNode.getNode())
 458     CurNode.getNode()->NodeType |= DSNode::UnknownNode;
 459 }
 460
 461
 462
 463 //===----------------------------------------------------------------------===//
 464 // LocalDataStructures Implementation
 465 //===----------------------------------------------------------------------===//
 466
 467 bool LocalDataStructures::run(Module &M) {
 468   GlobalsGraph = new DSGraph();
 469
 470   // Calculate all of the graphs...
 471   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 472     if (!I->isExternal())
 473       DSInfo.insert(std::make_pair(I, new DSGraph(*I, GlobalsGraph)));
 474   return false;
 475 }
 476
 477 // releaseMemory - If the pass pipeline is done with this pass, we can release
 478 // our memory... here...
 479 //
 480 void LocalDataStructures::releaseMemory() {
 481   for (hash_map<const Function*, DSGraph*>::iterator I = DSInfo.begin(),
 482          E = DSInfo.end(); I != E; ++I)
 483     delete I->second;
 484
 485   // Empty map so next time memory is released, data structures are not
 486   // re-deleted.
 487   DSInfo.clear();
 488   delete GlobalsGraph;
 489   GlobalsGraph = 0;
 490 }