lib/Analysis/DataStructure/DataStructure.cpp

   1 //===- DataStructure.cpp - Implement the core data structure analysis -----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the core data structure functionality.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/DataStructure/DSGraphTraits.h"
  15 #include "llvm/Constants.h"
  16 #include "llvm/Function.h"
  17 #include "llvm/GlobalVariable.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Target/TargetData.h"
  21 #include "llvm/Assembly/Writer.h"
  22 #include "llvm/Support/CommandLine.h"
  23 #include "llvm/Support/Debug.h"
  24 #include "llvm/ADT/DepthFirstIterator.h"
  25 #include "llvm/ADT/STLExtras.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/Support/Timer.h"
  28 #include <algorithm>
  29 using namespace llvm;
  30
  31 #define COLLAPSE_ARRAYS_AGGRESSIVELY 0
  32
  33 namespace {
  34   Statistic<> NumFolds          ("dsa", "Number of nodes completely folded");
  35   Statistic<> NumCallNodesMerged("dsa", "Number of call nodes merged");
  36   Statistic<> NumNodeAllocated  ("dsa", "Number of nodes allocated");
  37   Statistic<> NumDNE            ("dsa", "Number of nodes removed by reachability");
  38   Statistic<> NumTrivialDNE     ("dsa", "Number of nodes trivially removed");
  39   Statistic<> NumTrivialGlobalDNE("dsa", "Number of globals trivially removed");
  40 };
  41
  42 #if 1
  43 #define TIME_REGION(VARNAME, DESC) \
  44    NamedRegionTimer VARNAME(DESC)
  45 #else
  46 #define TIME_REGION(VARNAME, DESC)
  47 #endif
  48
  49 using namespace DS;
  50
  51 /// isForwarding - Return true if this NodeHandle is forwarding to another
  52 /// one.
  53 bool DSNodeHandle::isForwarding() const {
  54   return N && N->isForwarding();
  55 }
  56
  57 DSNode *DSNodeHandle::HandleForwarding() const {
  58   assert(N->isForwarding() && "Can only be invoked if forwarding!");
  59
  60   // Handle node forwarding here!
  61   DSNode *Next = N->ForwardNH.getNode();  // Cause recursive shrinkage
  62   Offset += N->ForwardNH.getOffset();
  63
  64   if (--N->NumReferrers == 0) {
  65     // Removing the last referrer to the node, sever the forwarding link
  66     N->stopForwarding();
  67   }
  68
  69   N = Next;
  70   N->NumReferrers++;
  71   if (N->Size <= Offset) {
  72     assert(N->Size <= 1 && "Forwarded to shrunk but not collapsed node?");
  73     Offset = 0;
  74   }
  75   return N;
  76 }
  77
  78 //===----------------------------------------------------------------------===//
  79 // DSNode Implementation
  80 //===----------------------------------------------------------------------===//
  81
  82 DSNode::DSNode(const Type *T, DSGraph *G)
  83   : NumReferrers(0), Size(0), ParentGraph(G), Ty(Type::VoidTy), NodeType(0) {
  84   // Add the type entry if it is specified...
  85   if (T) mergeTypeInfo(T, 0);
  86   if (G) G->addNode(this);
  87   ++NumNodeAllocated;
  88 }
  89
  90 // DSNode copy constructor... do not copy over the referrers list!
  91 DSNode::DSNode(const DSNode &N, DSGraph *G, bool NullLinks)
  92   : NumReferrers(0), Size(N.Size), ParentGraph(G),
  93     Ty(N.Ty), NodeType(N.NodeType) {
  94   if (!NullLinks) {
  95     Links = N.Links;
  96     Globals = N.Globals;
  97   } else
  98     Links.resize(N.Links.size()); // Create the appropriate number of null links
  99   G->addNode(this);
 100   ++NumNodeAllocated;
 101 }
 102
 103 /// getTargetData - Get the target data object used to construct this node.
 104 ///
 105 const TargetData &DSNode::getTargetData() const {
 106   return ParentGraph->getTargetData();
 107 }
 108
 109 void DSNode::assertOK() const {
 110   assert((Ty != Type::VoidTy ||
 111           Ty == Type::VoidTy && (Size == 0 ||
 112                                  (NodeType & DSNode::Array))) &&
 113          "Node not OK!");
 114
 115   assert(ParentGraph && "Node has no parent?");
 116   const DSScalarMap &SM = ParentGraph->getScalarMap();
 117   for (unsigned i = 0, e = Globals.size(); i != e; ++i) {
 118     assert(SM.global_count(Globals[i]));
 119     assert(SM.find(Globals[i])->second.getNode() == this);
 120   }
 121 }
 122
 123 /// forwardNode - Mark this node as being obsolete, and all references to it
 124 /// should be forwarded to the specified node and offset.
 125 ///
 126 void DSNode::forwardNode(DSNode *To, unsigned Offset) {
 127   assert(this != To && "Cannot forward a node to itself!");
 128   assert(ForwardNH.isNull() && "Already forwarding from this node!");
 129   if (To->Size <= 1) Offset = 0;
 130   assert((Offset < To->Size || (Offset == To->Size && Offset == 0)) &&
 131          "Forwarded offset is wrong!");
 132   ForwardNH.setTo(To, Offset);
 133   NodeType = DEAD;
 134   Size = 0;
 135   Ty = Type::VoidTy;
 136
 137   // Remove this node from the parent graph's Nodes list.
 138   ParentGraph->unlinkNode(this);
 139   ParentGraph = 0;
 140 }
 141
 142 // addGlobal - Add an entry for a global value to the Globals list.  This also
 143 // marks the node with the 'G' flag if it does not already have it.
 144 //
 145 void DSNode::addGlobal(GlobalValue *GV) {
 146   // First, check to make sure this is the leader if the global is in an
 147   // equivalence class.
 148   GV = getParentGraph()->getScalarMap().getLeaderForGlobal(GV);
 149
 150   // Keep the list sorted.
 151   std::vector<GlobalValue*>::iterator I =
 152     std::lower_bound(Globals.begin(), Globals.end(), GV);
 153
 154   if (I == Globals.end() || *I != GV) {
 155     Globals.insert(I, GV);
 156     NodeType |= GlobalNode;
 157   }
 158 }
 159
 160 // removeGlobal - Remove the specified global that is explicitly in the globals
 161 // list.
 162 void DSNode::removeGlobal(GlobalValue *GV) {
 163   std::vector<GlobalValue*>::iterator I =
 164     std::lower_bound(Globals.begin(), Globals.end(), GV);
 165   assert(I != Globals.end() && *I == GV && "Global not in node!");
 166   Globals.erase(I);
 167 }
 168
 169 /// foldNodeCompletely - If we determine that this node has some funny
 170 /// behavior happening to it that we cannot represent, we fold it down to a
 171 /// single, completely pessimistic, node.  This node is represented as a
 172 /// single byte with a single TypeEntry of "void".
 173 ///
 174 void DSNode::foldNodeCompletely() {
 175   if (isNodeCompletelyFolded()) return;  // If this node is already folded...
 176
 177   ++NumFolds;
 178
 179   // If this node has a size that is <= 1, we don't need to create a forwarding
 180   // node.
 181   if (getSize() <= 1) {
 182     NodeType |= DSNode::Array;
 183     Ty = Type::VoidTy;
 184     Size = 1;
 185     assert(Links.size() <= 1 && "Size is 1, but has more links?");
 186     Links.resize(1);
 187   } else {
 188     // Create the node we are going to forward to.  This is required because
 189     // some referrers may have an offset that is > 0.  By forcing them to
 190     // forward, the forwarder has the opportunity to correct the offset.
 191     DSNode *DestNode = new DSNode(0, ParentGraph);
 192     DestNode->NodeType = NodeType|DSNode::Array;
 193     DestNode->Ty = Type::VoidTy;
 194     DestNode->Size = 1;
 195     DestNode->Globals.swap(Globals);
 196
 197     // Start forwarding to the destination node...
 198     forwardNode(DestNode, 0);
 199
 200     if (!Links.empty()) {
 201       DestNode->Links.reserve(1);
 202
 203       DSNodeHandle NH(DestNode);
 204       DestNode->Links.push_back(Links[0]);
 205
 206       // If we have links, merge all of our outgoing links together...
 207       for (unsigned i = Links.size()-1; i != 0; --i)
 208         NH.getNode()->Links[0].mergeWith(Links[i]);
 209       Links.clear();
 210     } else {
 211       DestNode->Links.resize(1);
 212     }
 213   }
 214 }
 215
 216 /// isNodeCompletelyFolded - Return true if this node has been completely
 217 /// folded down to something that can never be expanded, effectively losing
 218 /// all of the field sensitivity that may be present in the node.
 219 ///
 220 bool DSNode::isNodeCompletelyFolded() const {
 221   return getSize() == 1 && Ty == Type::VoidTy && isArray();
 222 }
 223
 224 /// addFullGlobalsList - Compute the full set of global values that are
 225 /// represented by this node.  Unlike getGlobalsList(), this requires fair
 226 /// amount of work to compute, so don't treat this method call as free.
 227 void DSNode::addFullGlobalsList(std::vector<GlobalValue*> &List) const {
 228   if (globals_begin() == globals_end()) return;
 229
 230   EquivalenceClasses<GlobalValue*> &EC = getParentGraph()->getGlobalECs();
 231
 232   for (globals_iterator I = globals_begin(), E = globals_end(); I != E; ++I) {
 233     EquivalenceClasses<GlobalValue*>::iterator ECI = EC.findValue(*I);
 234     if (ECI == EC.end())
 235       List.push_back(*I);
 236     else
 237       List.insert(List.end(), EC.member_begin(ECI), EC.member_end());
 238   }
 239 }
 240
 241 /// addFullFunctionList - Identical to addFullGlobalsList, but only return the
 242 /// functions in the full list.
 243 void DSNode::addFullFunctionList(std::vector<Function*> &List) const {
 244   if (globals_begin() == globals_end()) return;
 245
 246   EquivalenceClasses<GlobalValue*> &EC = getParentGraph()->getGlobalECs();
 247
 248   for (globals_iterator I = globals_begin(), E = globals_end(); I != E; ++I) {
 249     EquivalenceClasses<GlobalValue*>::iterator ECI = EC.findValue(*I);
 250     if (ECI == EC.end()) {
 251       if (Function *F = dyn_cast<Function>(*I))
 252         List.push_back(F);
 253     } else {
 254       for (EquivalenceClasses<GlobalValue*>::member_iterator MI =
 255              EC.member_begin(ECI), E = EC.member_end(); MI != E; ++MI)
 256         if (Function *F = dyn_cast<Function>(*MI))
 257           List.push_back(F);
 258     }
 259   }
 260 }
 261
 262 namespace {
 263   /// TypeElementWalker Class - Used for implementation of physical subtyping...
 264   ///
 265   class TypeElementWalker {
 266     struct StackState {
 267       const Type *Ty;
 268       unsigned Offset;
 269       unsigned Idx;
 270       StackState(const Type *T, unsigned Off = 0)
 271         : Ty(T), Offset(Off), Idx(0) {}
 272     };
 273
 274     std::vector<StackState> Stack;
 275     const TargetData &TD;
 276   public:
 277     TypeElementWalker(const Type *T, const TargetData &td) : TD(td) {
 278       Stack.push_back(T);
 279       StepToLeaf();
 280     }
 281
 282     bool isDone() const { return Stack.empty(); }
 283     const Type *getCurrentType()   const { return Stack.back().Ty;     }
 284     unsigned    getCurrentOffset() const { return Stack.back().Offset; }
 285
 286     void StepToNextType() {
 287       PopStackAndAdvance();
 288       StepToLeaf();
 289     }
 290
 291   private:
 292     /// PopStackAndAdvance - Pop the current element off of the stack and
 293     /// advance the underlying element to the next contained member.
 294     void PopStackAndAdvance() {
 295       assert(!Stack.empty() && "Cannot pop an empty stack!");
 296       Stack.pop_back();
 297       while (!Stack.empty()) {
 298         StackState &SS = Stack.back();
 299         if (const StructType *ST = dyn_cast<StructType>(SS.Ty)) {
 300           ++SS.Idx;
 301           if (SS.Idx != ST->getNumElements()) {
 302             const StructLayout *SL = TD.getStructLayout(ST);
 303             SS.Offset +=
 304                unsigned(SL->MemberOffsets[SS.Idx]-SL->MemberOffsets[SS.Idx-1]);
 305             return;
 306           }
 307           Stack.pop_back();  // At the end of the structure
 308         } else {
 309           const ArrayType *AT = cast<ArrayType>(SS.Ty);
 310           ++SS.Idx;
 311           if (SS.Idx != AT->getNumElements()) {
 312             SS.Offset += unsigned(TD.getTypeSize(AT->getElementType()));
 313             return;
 314           }
 315           Stack.pop_back();  // At the end of the array
 316         }
 317       }
 318     }
 319
 320     /// StepToLeaf - Used by physical subtyping to move to the first leaf node
 321     /// on the type stack.
 322     void StepToLeaf() {
 323       if (Stack.empty()) return;
 324       while (!Stack.empty() && !Stack.back().Ty->isFirstClassType()) {
 325         StackState &SS = Stack.back();
 326         if (const StructType *ST = dyn_cast<StructType>(SS.Ty)) {
 327           if (ST->getNumElements() == 0) {
 328             assert(SS.Idx == 0);
 329             PopStackAndAdvance();
 330           } else {
 331             // Step into the structure...
 332             assert(SS.Idx < ST->getNumElements());
 333             const StructLayout *SL = TD.getStructLayout(ST);
 334             Stack.push_back(StackState(ST->getElementType(SS.Idx),
 335                             SS.Offset+unsigned(SL->MemberOffsets[SS.Idx])));
 336           }
 337         } else {
 338           const ArrayType *AT = cast<ArrayType>(SS.Ty);
 339           if (AT->getNumElements() == 0) {
 340             assert(SS.Idx == 0);
 341             PopStackAndAdvance();
 342           } else {
 343             // Step into the array...
 344             assert(SS.Idx < AT->getNumElements());
 345             Stack.push_back(StackState(AT->getElementType(),
 346                                        SS.Offset+SS.Idx*
 347                              unsigned(TD.getTypeSize(AT->getElementType()))));
 348           }
 349         }
 350       }
 351     }
 352   };
 353 } // end anonymous namespace
 354
 355 /// ElementTypesAreCompatible - Check to see if the specified types are
 356 /// "physically" compatible.  If so, return true, else return false.  We only
 357 /// have to check the fields in T1: T2 may be larger than T1.  If AllowLargerT1
 358 /// is true, then we also allow a larger T1.
 359 ///
 360 static bool ElementTypesAreCompatible(const Type *T1, const Type *T2,
 361                                       bool AllowLargerT1, const TargetData &TD){
 362   TypeElementWalker T1W(T1, TD), T2W(T2, TD);
 363
 364   while (!T1W.isDone() && !T2W.isDone()) {
 365     if (T1W.getCurrentOffset() != T2W.getCurrentOffset())
 366       return false;
 367
 368     const Type *T1 = T1W.getCurrentType();
 369     const Type *T2 = T2W.getCurrentType();
 370     if (T1 != T2 && !T1->isLosslesslyConvertibleTo(T2))
 371       return false;
 372
 373     T1W.StepToNextType();
 374     T2W.StepToNextType();
 375   }
 376
 377   return AllowLargerT1 || T1W.isDone();
 378 }
 379
 380
 381 /// mergeTypeInfo - This method merges the specified type into the current node
 382 /// at the specified offset.  This may update the current node's type record if
 383 /// this gives more information to the node, it may do nothing to the node if
 384 /// this information is already known, or it may merge the node completely (and
 385 /// return true) if the information is incompatible with what is already known.
 386 ///
 387 /// This method returns true if the node is completely folded, otherwise false.
 388 ///
 389 bool DSNode::mergeTypeInfo(const Type *NewTy, unsigned Offset,
 390                            bool FoldIfIncompatible) {
 391   const TargetData &TD = getTargetData();
 392   // Check to make sure the Size member is up-to-date.  Size can be one of the
 393   // following:
 394   //  Size = 0, Ty = Void: Nothing is known about this node.
 395   //  Size = 0, Ty = FnTy: FunctionPtr doesn't have a size, so we use zero
 396   //  Size = 1, Ty = Void, Array = 1: The node is collapsed
 397   //  Otherwise, sizeof(Ty) = Size
 398   //
 399   assert(((Size == 0 && Ty == Type::VoidTy && !isArray()) ||
 400           (Size == 0 && !Ty->isSized() && !isArray()) ||
 401           (Size == 1 && Ty == Type::VoidTy && isArray()) ||
 402           (Size == 0 && !Ty->isSized() && !isArray()) ||
 403           (TD.getTypeSize(Ty) == Size)) &&
 404          "Size member of DSNode doesn't match the type structure!");
 405   assert(NewTy != Type::VoidTy && "Cannot merge void type into DSNode!");
 406
 407   if (Offset == 0 && NewTy == Ty)
 408     return false;  // This should be a common case, handle it efficiently
 409
 410   // Return true immediately if the node is completely folded.
 411   if (isNodeCompletelyFolded()) return true;
 412
 413   // If this is an array type, eliminate the outside arrays because they won't
 414   // be used anyway.  This greatly reduces the size of large static arrays used
 415   // as global variables, for example.
 416   //
 417   bool WillBeArray = false;
 418   while (const ArrayType *AT = dyn_cast<ArrayType>(NewTy)) {
 419     // FIXME: we might want to keep small arrays, but must be careful about
 420     // things like: [2 x [10000 x int*]]
 421     NewTy = AT->getElementType();
 422     WillBeArray = true;
 423   }
 424
 425   // Figure out how big the new type we're merging in is...
 426   unsigned NewTySize = NewTy->isSized() ? (unsigned)TD.getTypeSize(NewTy) : 0;
 427
 428   // Otherwise check to see if we can fold this type into the current node.  If
 429   // we can't, we fold the node completely, if we can, we potentially update our
 430   // internal state.
 431   //
 432   if (Ty == Type::VoidTy) {
 433     // If this is the first type that this node has seen, just accept it without
 434     // question....
 435     assert(Offset == 0 && !isArray() &&
 436            "Cannot have an offset into a void node!");
 437
 438     // If this node would have to have an unreasonable number of fields, just
 439     // collapse it.  This can occur for fortran common blocks, which have stupid
 440     // things like { [100000000 x double], [1000000 x double] }.
 441     unsigned NumFields = (NewTySize+DS::PointerSize-1) >> DS::PointerShift;
 442     if (NumFields > 64) {
 443       foldNodeCompletely();
 444       return true;
 445     }
 446
 447     Ty = NewTy;
 448     NodeType &= ~Array;
 449     if (WillBeArray) NodeType |= Array;
 450     Size = NewTySize;
 451
 452     // Calculate the number of outgoing links from this node.
 453     Links.resize(NumFields);
 454     return false;
 455   }
 456
 457   // Handle node expansion case here...
 458   if (Offset+NewTySize > Size) {
 459     // It is illegal to grow this node if we have treated it as an array of
 460     // objects...
 461     if (isArray()) {
 462       if (FoldIfIncompatible) foldNodeCompletely();
 463       return true;
 464     }
 465
 466     if (Offset) {  // We could handle this case, but we don't for now...
 467       std::cerr << "UNIMP: Trying to merge a growth type into "
 468                 << "offset != 0: Collapsing!\n";
 469       if (FoldIfIncompatible) foldNodeCompletely();
 470       return true;
 471     }
 472
 473     // Okay, the situation is nice and simple, we are trying to merge a type in
 474     // at offset 0 that is bigger than our current type.  Implement this by
 475     // switching to the new type and then merge in the smaller one, which should
 476     // hit the other code path here.  If the other code path decides it's not
 477     // ok, it will collapse the node as appropriate.
 478     //
 479
 480     // If this node would have to have an unreasonable number of fields, just
 481     // collapse it.  This can occur for fortran common blocks, which have stupid
 482     // things like { [100000000 x double], [1000000 x double] }.
 483     unsigned NumFields = (NewTySize+DS::PointerSize-1) >> DS::PointerShift;
 484     if (NumFields > 64) {
 485       foldNodeCompletely();
 486       return true;
 487     }
 488
 489     const Type *OldTy = Ty;
 490     Ty = NewTy;
 491     NodeType &= ~Array;
 492     if (WillBeArray) NodeType |= Array;
 493     Size = NewTySize;
 494
 495     // Must grow links to be the appropriate size...
 496     Links.resize(NumFields);
 497
 498     // Merge in the old type now... which is guaranteed to be smaller than the
 499     // "current" type.
 500     return mergeTypeInfo(OldTy, 0);
 501   }
 502
 503   assert(Offset <= Size &&
 504          "Cannot merge something into a part of our type that doesn't exist!");
 505
 506   // Find the section of Ty that NewTy overlaps with... first we find the
 507   // type that starts at offset Offset.
 508   //
 509   unsigned O = 0;
 510   const Type *SubType = Ty;
 511   while (O < Offset) {
 512     assert(Offset-O < TD.getTypeSize(SubType) && "Offset out of range!");
 513
 514     switch (SubType->getTypeID()) {
 515     case Type::StructTyID: {
 516       const StructType *STy = cast<StructType>(SubType);
 517       const StructLayout &SL = *TD.getStructLayout(STy);
 518       unsigned i = SL.getElementContainingOffset(Offset-O);
 519
 520       // The offset we are looking for must be in the i'th element...
 521       SubType = STy->getElementType(i);
 522       O += (unsigned)SL.MemberOffsets[i];
 523       break;
 524     }
 525     case Type::ArrayTyID: {
 526       SubType = cast<ArrayType>(SubType)->getElementType();
 527       unsigned ElSize = (unsigned)TD.getTypeSize(SubType);
 528       unsigned Remainder = (Offset-O) % ElSize;
 529       O = Offset-Remainder;
 530       break;
 531     }
 532     default:
 533       if (FoldIfIncompatible) foldNodeCompletely();
 534       return true;
 535     }
 536   }
 537
 538   assert(O == Offset && "Could not achieve the correct offset!");
 539
 540   // If we found our type exactly, early exit
 541   if (SubType == NewTy) return false;
 542
 543   // Differing function types don't require us to merge.  They are not values
 544   // anyway.
 545   if (isa<FunctionType>(SubType) &&
 546       isa<FunctionType>(NewTy)) return false;
 547
 548   unsigned SubTypeSize = SubType->isSized() ?
 549        (unsigned)TD.getTypeSize(SubType) : 0;
 550
 551   // Ok, we are getting desperate now.  Check for physical subtyping, where we
 552   // just require each element in the node to be compatible.
 553   if (NewTySize <= SubTypeSize && NewTySize && NewTySize < 256 &&
 554       SubTypeSize && SubTypeSize < 256 &&
 555       ElementTypesAreCompatible(NewTy, SubType, !isArray(), TD))
 556     return false;
 557
 558   // Okay, so we found the leader type at the offset requested.  Search the list
 559   // of types that starts at this offset.  If SubType is currently an array or
 560   // structure, the type desired may actually be the first element of the
 561   // composite type...
 562   //
 563   unsigned PadSize = SubTypeSize; // Size, including pad memory which is ignored
 564   while (SubType != NewTy) {
 565     const Type *NextSubType = 0;
 566     unsigned NextSubTypeSize = 0;
 567     unsigned NextPadSize = 0;
 568     switch (SubType->getTypeID()) {
 569     case Type::StructTyID: {
 570       const StructType *STy = cast<StructType>(SubType);
 571       const StructLayout &SL = *TD.getStructLayout(STy);
 572       if (SL.MemberOffsets.size() > 1)
 573         NextPadSize = (unsigned)SL.MemberOffsets[1];
 574       else
 575         NextPadSize = SubTypeSize;
 576       NextSubType = STy->getElementType(0);
 577       NextSubTypeSize = (unsigned)TD.getTypeSize(NextSubType);
 578       break;
 579     }
 580     case Type::ArrayTyID:
 581       NextSubType = cast<ArrayType>(SubType)->getElementType();
 582       NextSubTypeSize = (unsigned)TD.getTypeSize(NextSubType);
 583       NextPadSize = NextSubTypeSize;
 584       break;
 585     default: ;
 586       // fall out
 587     }
 588
 589     if (NextSubType == 0)
 590       break;   // In the default case, break out of the loop
 591
 592     if (NextPadSize < NewTySize)
 593       break;   // Don't allow shrinking to a smaller type than NewTySize
 594     SubType = NextSubType;
 595     SubTypeSize = NextSubTypeSize;
 596     PadSize = NextPadSize;
 597   }
 598
 599   // If we found the type exactly, return it...
 600   if (SubType == NewTy)
 601     return false;
 602
 603   // Check to see if we have a compatible, but different type...
 604   if (NewTySize == SubTypeSize) {
 605     // Check to see if this type is obviously convertible... int -> uint f.e.
 606     if (NewTy->isLosslesslyConvertibleTo(SubType))
 607       return false;
 608
 609     // Check to see if we have a pointer & integer mismatch going on here,
 610     // loading a pointer as a long, for example.
 611     //
 612     if (SubType->isInteger() && isa<PointerType>(NewTy) ||
 613         NewTy->isInteger() && isa<PointerType>(SubType))
 614       return false;
 615   } else if (NewTySize > SubTypeSize && NewTySize <= PadSize) {
 616     // We are accessing the field, plus some structure padding.  Ignore the
 617     // structure padding.
 618     return false;
 619   }
 620
 621   Module *M = 0;
 622   if (getParentGraph()->retnodes_begin() != getParentGraph()->retnodes_end())
 623     M = getParentGraph()->retnodes_begin()->first->getParent();
 624   DEBUG(std::cerr << "MergeTypeInfo Folding OrigTy: ";
 625         WriteTypeSymbolic(std::cerr, Ty, M) << "\n due to:";
 626         WriteTypeSymbolic(std::cerr, NewTy, M) << " @ " << Offset << "!\n"
 627                   << "SubType: ";
 628         WriteTypeSymbolic(std::cerr, SubType, M) << "\n\n");
 629
 630   if (FoldIfIncompatible) foldNodeCompletely();
 631   return true;
 632 }
 633
 634
 635
 636 /// addEdgeTo - Add an edge from the current node to the specified node.  This
 637 /// can cause merging of nodes in the graph.
 638 ///
 639 void DSNode::addEdgeTo(unsigned Offset, const DSNodeHandle &NH) {
 640   if (NH.isNull()) return;       // Nothing to do
 641
 642   DSNodeHandle &ExistingEdge = getLink(Offset);
 643   if (!ExistingEdge.isNull()) {
 644     // Merge the two nodes...
 645     ExistingEdge.mergeWith(NH);
 646   } else {                             // No merging to perform...
 647     setLink(Offset, NH);               // Just force a link in there...
 648   }
 649 }
 650
 651
 652 /// MergeSortedVectors - Efficiently merge a vector into another vector where
 653 /// duplicates are not allowed and both are sorted.  This assumes that 'T's are
 654 /// efficiently copyable and have sane comparison semantics.
 655 ///
 656 static void MergeSortedVectors(std::vector<GlobalValue*> &Dest,
 657                                const std::vector<GlobalValue*> &Src) {
 658   // By far, the most common cases will be the simple ones.  In these cases,
 659   // avoid having to allocate a temporary vector...
 660   //
 661   if (Src.empty()) {             // Nothing to merge in...
 662     return;
 663   } else if (Dest.empty()) {     // Just copy the result in...
 664     Dest = Src;
 665   } else if (Src.size() == 1) {  // Insert a single element...
 666     const GlobalValue *V = Src[0];
 667     std::vector<GlobalValue*>::iterator I =
 668       std::lower_bound(Dest.begin(), Dest.end(), V);
 669     if (I == Dest.end() || *I != Src[0])  // If not already contained...
 670       Dest.insert(I, Src[0]);
 671   } else if (Dest.size() == 1) {
 672     GlobalValue *Tmp = Dest[0];           // Save value in temporary...
 673     Dest = Src;                           // Copy over list...
 674     std::vector<GlobalValue*>::iterator I =
 675       std::lower_bound(Dest.begin(), Dest.end(), Tmp);
 676     if (I == Dest.end() || *I != Tmp)     // If not already contained...
 677       Dest.insert(I, Tmp);
 678
 679   } else {
 680     // Make a copy to the side of Dest...
 681     std::vector<GlobalValue*> Old(Dest);
 682
 683     // Make space for all of the type entries now...
 684     Dest.resize(Dest.size()+Src.size());
 685
 686     // Merge the two sorted ranges together... into Dest.
 687     std::merge(Old.begin(), Old.end(), Src.begin(), Src.end(), Dest.begin());
 688
 689     // Now erase any duplicate entries that may have accumulated into the
 690     // vectors (because they were in both of the input sets)
 691     Dest.erase(std::unique(Dest.begin(), Dest.end()), Dest.end());
 692   }
 693 }
 694
 695 void DSNode::mergeGlobals(const std::vector<GlobalValue*> &RHS) {
 696   MergeSortedVectors(Globals, RHS);
 697 }
 698
 699 // MergeNodes - Helper function for DSNode::mergeWith().
 700 // This function does the hard work of merging two nodes, CurNodeH
 701 // and NH after filtering out trivial cases and making sure that
 702 // CurNodeH.offset >= NH.offset.
 703 //
 704 // ***WARNING***
 705 // Since merging may cause either node to go away, we must always
 706 // use the node-handles to refer to the nodes.  These node handles are
 707 // automatically updated during merging, so will always provide access
 708 // to the correct node after a merge.
 709 //
 710 void DSNode::MergeNodes(DSNodeHandle& CurNodeH, DSNodeHandle& NH) {
 711   assert(CurNodeH.getOffset() >= NH.getOffset() &&
 712          "This should have been enforced in the caller.");
 713   assert(CurNodeH.getNode()->getParentGraph()==NH.getNode()->getParentGraph() &&
 714          "Cannot merge two nodes that are not in the same graph!");
 715
 716   // Now we know that Offset >= NH.Offset, so convert it so our "Offset" (with
 717   // respect to NH.Offset) is now zero.  NOffset is the distance from the base
 718   // of our object that N starts from.
 719   //
 720   unsigned NOffset = CurNodeH.getOffset()-NH.getOffset();
 721   unsigned NSize = NH.getNode()->getSize();
 722
 723   // If the two nodes are of different size, and the smaller node has the array
 724   // bit set, collapse!
 725   if (NSize != CurNodeH.getNode()->getSize()) {
 726 #if COLLAPSE_ARRAYS_AGGRESSIVELY
 727     if (NSize < CurNodeH.getNode()->getSize()) {
 728       if (NH.getNode()->isArray())
 729         NH.getNode()->foldNodeCompletely();
 730     } else if (CurNodeH.getNode()->isArray()) {
 731       NH.getNode()->foldNodeCompletely();
 732     }
 733 #endif
 734   }
 735
 736   // Merge the type entries of the two nodes together...
 737   if (NH.getNode()->Ty != Type::VoidTy)
 738     CurNodeH.getNode()->mergeTypeInfo(NH.getNode()->Ty, NOffset);
 739   assert(!CurNodeH.getNode()->isDeadNode());
 740
 741   // If we are merging a node with a completely folded node, then both nodes are
 742   // now completely folded.
 743   //
 744   if (CurNodeH.getNode()->isNodeCompletelyFolded()) {
 745     if (!NH.getNode()->isNodeCompletelyFolded()) {
 746       NH.getNode()->foldNodeCompletely();
 747       assert(NH.getNode() && NH.getOffset() == 0 &&
 748              "folding did not make offset 0?");
 749       NOffset = NH.getOffset();
 750       NSize = NH.getNode()->getSize();
 751       assert(NOffset == 0 && NSize == 1);
 752     }
 753   } else if (NH.getNode()->isNodeCompletelyFolded()) {
 754     CurNodeH.getNode()->foldNodeCompletely();
 755     assert(CurNodeH.getNode() && CurNodeH.getOffset() == 0 &&
 756            "folding did not make offset 0?");
 757     NSize = NH.getNode()->getSize();
 758     NOffset = NH.getOffset();
 759     assert(NOffset == 0 && NSize == 1);
 760   }
 761
 762   DSNode *N = NH.getNode();
 763   if (CurNodeH.getNode() == N || N == 0) return;
 764   assert(!CurNodeH.getNode()->isDeadNode());
 765
 766   // Merge the NodeType information.
 767   CurNodeH.getNode()->NodeType |= N->NodeType;
 768
 769   // Start forwarding to the new node!
 770   N->forwardNode(CurNodeH.getNode(), NOffset);
 771   assert(!CurNodeH.getNode()->isDeadNode());
 772
 773   // Make all of the outgoing links of N now be outgoing links of CurNodeH.
 774   //
 775   for (unsigned i = 0; i < N->getNumLinks(); ++i) {
 776     DSNodeHandle &Link = N->getLink(i << DS::PointerShift);
 777     if (Link.getNode()) {
 778       // Compute the offset into the current node at which to
 779       // merge this link.  In the common case, this is a linear
 780       // relation to the offset in the original node (with
 781       // wrapping), but if the current node gets collapsed due to
 782       // recursive merging, we must make sure to merge in all remaining
 783       // links at offset zero.
 784       unsigned MergeOffset = 0;
 785       DSNode *CN = CurNodeH.getNode();
 786       if (CN->Size != 1)
 787         MergeOffset = ((i << DS::PointerShift)+NOffset) % CN->getSize();
 788       CN->addEdgeTo(MergeOffset, Link);
 789     }
 790   }
 791
 792   // Now that there are no outgoing edges, all of the Links are dead.
 793   N->Links.clear();
 794
 795   // Merge the globals list...
 796   if (!N->Globals.empty()) {
 797     CurNodeH.getNode()->mergeGlobals(N->Globals);
 798
 799     // Delete the globals from the old node...
 800     std::vector<GlobalValue*>().swap(N->Globals);
 801   }
 802 }
 803
 804
 805 /// mergeWith - Merge this node and the specified node, moving all links to and
 806 /// from the argument node into the current node, deleting the node argument.
 807 /// Offset indicates what offset the specified node is to be merged into the
 808 /// current node.
 809 ///
 810 /// The specified node may be a null pointer (in which case, we update it to
 811 /// point to this node).
 812 ///
 813 void DSNode::mergeWith(const DSNodeHandle &NH, unsigned Offset) {
 814   DSNode *N = NH.getNode();
 815   if (N == this && NH.getOffset() == Offset)
 816     return;  // Noop
 817
 818   // If the RHS is a null node, make it point to this node!
 819   if (N == 0) {
 820     NH.mergeWith(DSNodeHandle(this, Offset));
 821     return;
 822   }
 823
 824   assert(!N->isDeadNode() && !isDeadNode());
 825   assert(!hasNoReferrers() && "Should not try to fold a useless node!");
 826
 827   if (N == this) {
 828     // We cannot merge two pieces of the same node together, collapse the node
 829     // completely.
 830     DEBUG(std::cerr << "Attempting to merge two chunks of"
 831                     << " the same node together!\n");
 832     foldNodeCompletely();
 833     return;
 834   }
 835
 836   // If both nodes are not at offset 0, make sure that we are merging the node
 837   // at an later offset into the node with the zero offset.
 838   //
 839   if (Offset < NH.getOffset()) {
 840     N->mergeWith(DSNodeHandle(this, Offset), NH.getOffset());
 841     return;
 842   } else if (Offset == NH.getOffset() && getSize() < N->getSize()) {
 843     // If the offsets are the same, merge the smaller node into the bigger node
 844     N->mergeWith(DSNodeHandle(this, Offset), NH.getOffset());
 845     return;
 846   }
 847
 848   // Ok, now we can merge the two nodes.  Use a static helper that works with
 849   // two node handles, since "this" may get merged away at intermediate steps.
 850   DSNodeHandle CurNodeH(this, Offset);
 851   DSNodeHandle NHCopy(NH);
 852   DSNode::MergeNodes(CurNodeH, NHCopy);
 853 }
 854
 855
 856 //===----------------------------------------------------------------------===//
 857 // ReachabilityCloner Implementation
 858 //===----------------------------------------------------------------------===//
 859
 860 DSNodeHandle ReachabilityCloner::getClonedNH(const DSNodeHandle &SrcNH) {
 861   if (SrcNH.isNull()) return DSNodeHandle();
 862   const DSNode *SN = SrcNH.getNode();
 863
 864   DSNodeHandle &NH = NodeMap[SN];
 865   if (!NH.isNull()) {   // Node already mapped?
 866     DSNode *NHN = NH.getNode();
 867     return DSNodeHandle(NHN, NH.getOffset()+SrcNH.getOffset());
 868   }
 869
 870   // If SrcNH has globals and the destination graph has one of the same globals,
 871   // merge this node with the destination node, which is much more efficient.
 872   if (SN->globals_begin() != SN->globals_end()) {
 873     DSScalarMap &DestSM = Dest.getScalarMap();
 874     for (DSNode::globals_iterator I = SN->globals_begin(),E = SN->globals_end();
 875          I != E; ++I) {
 876       GlobalValue *GV = *I;
 877       DSScalarMap::iterator GI = DestSM.find(GV);
 878       if (GI != DestSM.end() && !GI->second.isNull()) {
 879         // We found one, use merge instead!
 880         merge(GI->second, Src.getNodeForValue(GV));
 881         assert(!NH.isNull() && "Didn't merge node!");
 882         DSNode *NHN = NH.getNode();
 883         return DSNodeHandle(NHN, NH.getOffset()+SrcNH.getOffset());
 884       }
 885     }
 886   }
 887
 888   DSNode *DN = new DSNode(*SN, &Dest, true /* Null out all links */);
 889   DN->maskNodeTypes(BitsToKeep);
 890   NH = DN;
 891
 892   // Next, recursively clone all outgoing links as necessary.  Note that
 893   // adding these links can cause the node to collapse itself at any time, and
 894   // the current node may be merged with arbitrary other nodes.  For this
 895   // reason, we must always go through NH.
 896   DN = 0;
 897   for (unsigned i = 0, e = SN->getNumLinks(); i != e; ++i) {
 898     const DSNodeHandle &SrcEdge = SN->getLink(i << DS::PointerShift);
 899     if (!SrcEdge.isNull()) {
 900       const DSNodeHandle &DestEdge = getClonedNH(SrcEdge);
 901       // Compute the offset into the current node at which to
 902       // merge this link.  In the common case, this is a linear
 903       // relation to the offset in the original node (with
 904       // wrapping), but if the current node gets collapsed due to
 905       // recursive merging, we must make sure to merge in all remaining
 906       // links at offset zero.
 907       unsigned MergeOffset = 0;
 908       DSNode *CN = NH.getNode();
 909       if (CN->getSize() != 1)
 910         MergeOffset = ((i << DS::PointerShift)+NH.getOffset()) % CN->getSize();
 911       CN->addEdgeTo(MergeOffset, DestEdge);
 912     }
 913   }
 914
 915   // If this node contains any globals, make sure they end up in the scalar
 916   // map with the correct offset.
 917   for (DSNode::globals_iterator I = SN->globals_begin(), E = SN->globals_end();
 918        I != E; ++I) {
 919     GlobalValue *GV = *I;
 920     const DSNodeHandle &SrcGNH = Src.getNodeForValue(GV);
 921     DSNodeHandle &DestGNH = NodeMap[SrcGNH.getNode()];
 922     assert(DestGNH.getNode() == NH.getNode() &&"Global mapping inconsistent");
 923     Dest.getNodeForValue(GV).mergeWith(DSNodeHandle(DestGNH.getNode(),
 924                                        DestGNH.getOffset()+SrcGNH.getOffset()));
 925   }
 926   NH.getNode()->mergeGlobals(SN->getGlobalsList());
 927
 928   return DSNodeHandle(NH.getNode(), NH.getOffset()+SrcNH.getOffset());
 929 }
 930
 931 void ReachabilityCloner::merge(const DSNodeHandle &NH,
 932                                const DSNodeHandle &SrcNH) {
 933   if (SrcNH.isNull()) return;  // Noop
 934   if (NH.isNull()) {
 935     // If there is no destination node, just clone the source and assign the
 936     // destination node to be it.
 937     NH.mergeWith(getClonedNH(SrcNH));
 938     return;
 939   }
 940
 941   // Okay, at this point, we know that we have both a destination and a source
 942   // node that need to be merged.  Check to see if the source node has already
 943   // been cloned.
 944   const DSNode *SN = SrcNH.getNode();
 945   DSNodeHandle &SCNH = NodeMap[SN];  // SourceClonedNodeHandle
 946   if (!SCNH.isNull()) {   // Node already cloned?
 947     DSNode *SCNHN = SCNH.getNode();
 948     NH.mergeWith(DSNodeHandle(SCNHN,
 949                               SCNH.getOffset()+SrcNH.getOffset()));
 950     return;  // Nothing to do!
 951   }
 952
 953   // Okay, so the source node has not already been cloned.  Instead of creating
 954   // a new DSNode, only to merge it into the one we already have, try to perform
 955   // the merge in-place.  The only case we cannot handle here is when the offset
 956   // into the existing node is less than the offset into the virtual node we are
 957   // merging in.  In this case, we have to extend the existing node, which
 958   // requires an allocation anyway.
 959   DSNode *DN = NH.getNode();   // Make sure the Offset is up-to-date
 960   if (NH.getOffset() >= SrcNH.getOffset()) {
 961     if (!DN->isNodeCompletelyFolded()) {
 962       // Make sure the destination node is folded if the source node is folded.
 963       if (SN->isNodeCompletelyFolded()) {
 964         DN->foldNodeCompletely();
 965         DN = NH.getNode();
 966       } else if (SN->getSize() != DN->getSize()) {
 967         // If the two nodes are of different size, and the smaller node has the
 968         // array bit set, collapse!
 969 #if COLLAPSE_ARRAYS_AGGRESSIVELY
 970         if (SN->getSize() < DN->getSize()) {
 971           if (SN->isArray()) {
 972             DN->foldNodeCompletely();
 973             DN = NH.getNode();
 974           }
 975         } else if (DN->isArray()) {
 976           DN->foldNodeCompletely();
 977           DN = NH.getNode();
 978         }
 979 #endif
 980       }
 981
 982       // Merge the type entries of the two nodes together...
 983       if (SN->getType() != Type::VoidTy && !DN->isNodeCompletelyFolded()) {
 984         DN->mergeTypeInfo(SN->getType(), NH.getOffset()-SrcNH.getOffset());
 985         DN = NH.getNode();
 986       }
 987     }
 988
 989     assert(!DN->isDeadNode());
 990
 991     // Merge the NodeType information.
 992     DN->mergeNodeFlags(SN->getNodeFlags() & BitsToKeep);
 993
 994     // Before we start merging outgoing links and updating the scalar map, make
 995     // sure it is known that this is the representative node for the src node.
 996     SCNH = DSNodeHandle(DN, NH.getOffset()-SrcNH.getOffset());
 997
 998     // If the source node contains any globals, make sure they end up in the
 999     // scalar map with the correct offset.
1000     if (SN->globals_begin() != SN->globals_end()) {
1001       // Update the globals in the destination node itself.
1002       DN->mergeGlobals(SN->getGlobalsList());
1003
1004       // Update the scalar map for the graph we are merging the source node
1005       // into.
1006       for (DSNode::globals_iterator I = SN->globals_begin(),
1007              E = SN->globals_end(); I != E; ++I) {
1008         GlobalValue *GV = *I;
1009         const DSNodeHandle &SrcGNH = Src.getNodeForValue(GV);
1010         DSNodeHandle &DestGNH = NodeMap[SrcGNH.getNode()];
1011         assert(DestGNH.getNode()==NH.getNode() &&"Global mapping inconsistent");
1012         Dest.getNodeForValue(GV).mergeWith(DSNodeHandle(DestGNH.getNode(),
1013                                       DestGNH.getOffset()+SrcGNH.getOffset()));
1014       }
1015       NH.getNode()->mergeGlobals(SN->getGlobalsList());
1016     }
1017   } else {
1018     // We cannot handle this case without allocating a temporary node.  Fall
1019     // back on being simple.
1020     DSNode *NewDN = new DSNode(*SN, &Dest, true /* Null out all links */);
1021     NewDN->maskNodeTypes(BitsToKeep);
1022
1023     unsigned NHOffset = NH.getOffset();
1024     NH.mergeWith(DSNodeHandle(NewDN, SrcNH.getOffset()));
1025
1026     assert(NH.getNode() &&
1027            (NH.getOffset() > NHOffset ||
1028             (NH.getOffset() == 0 && NH.getNode()->isNodeCompletelyFolded())) &&
1029            "Merging did not adjust the offset!");
1030
1031     // Before we start merging outgoing links and updating the scalar map, make
1032     // sure it is known that this is the representative node for the src node.
1033     SCNH = DSNodeHandle(NH.getNode(), NH.getOffset()-SrcNH.getOffset());
1034
1035     // If the source node contained any globals, make sure to create entries
1036     // in the scalar map for them!
1037     for (DSNode::globals_iterator I = SN->globals_begin(),
1038            E = SN->globals_end(); I != E; ++I) {
1039       GlobalValue *GV = *I;
1040       const DSNodeHandle &SrcGNH = Src.getNodeForValue(GV);
1041       DSNodeHandle &DestGNH = NodeMap[SrcGNH.getNode()];
1042       assert(DestGNH.getNode()==NH.getNode() &&"Global mapping inconsistent");
1043       assert(SrcGNH.getNode() == SN && "Global mapping inconsistent");
1044       Dest.getNodeForValue(GV).mergeWith(DSNodeHandle(DestGNH.getNode(),
1045                                     DestGNH.getOffset()+SrcGNH.getOffset()));
1046     }
1047   }
1048
1049
1050   // Next, recursively merge all outgoing links as necessary.  Note that
1051   // adding these links can cause the destination node to collapse itself at
1052   // any time, and the current node may be merged with arbitrary other nodes.
1053   // For this reason, we must always go through NH.
1054   DN = 0;
1055   for (unsigned i = 0, e = SN->getNumLinks(); i != e; ++i) {
1056     const DSNodeHandle &SrcEdge = SN->getLink(i << DS::PointerShift);
1057     if (!SrcEdge.isNull()) {
1058       // Compute the offset into the current node at which to
1059       // merge this link.  In the common case, this is a linear
1060       // relation to the offset in the original node (with
1061       // wrapping), but if the current node gets collapsed due to
1062       // recursive merging, we must make sure to merge in all remaining
1063       // links at offset zero.
1064       DSNode *CN = SCNH.getNode();
1065       unsigned MergeOffset =
1066         ((i << DS::PointerShift)+SCNH.getOffset()) % CN->getSize();
1067
1068       DSNodeHandle Tmp = CN->getLink(MergeOffset);
1069       if (!Tmp.isNull()) {
1070         // Perform the recursive merging.  Make sure to create a temporary NH,
1071         // because the Link can disappear in the process of recursive merging.
1072         merge(Tmp, SrcEdge);
1073       } else {
1074         Tmp.mergeWith(getClonedNH(SrcEdge));
1075         // Merging this could cause all kinds of recursive things to happen,
1076         // culminating in the current node being eliminated.  Since this is
1077         // possible, make sure to reaquire the link from 'CN'.
1078
1079         unsigned MergeOffset = 0;
1080         CN = SCNH.getNode();
1081         MergeOffset = ((i << DS::PointerShift)+SCNH.getOffset()) %CN->getSize();
1082         CN->getLink(MergeOffset).mergeWith(Tmp);
1083       }
1084     }
1085   }
1086 }
1087
1088 /// mergeCallSite - Merge the nodes reachable from the specified src call
1089 /// site into the nodes reachable from DestCS.
1090 void ReachabilityCloner::mergeCallSite(const DSCallSite &DestCS,
1091                                        const DSCallSite &SrcCS) {
1092   merge(DestCS.getRetVal(), SrcCS.getRetVal());
1093   unsigned MinArgs = DestCS.getNumPtrArgs();
1094   if (SrcCS.getNumPtrArgs() < MinArgs) MinArgs = SrcCS.getNumPtrArgs();
1095
1096   for (unsigned a = 0; a != MinArgs; ++a)
1097     merge(DestCS.getPtrArg(a), SrcCS.getPtrArg(a));
1098 }
1099
1100
1101 //===----------------------------------------------------------------------===//
1102 // DSCallSite Implementation
1103 //===----------------------------------------------------------------------===//
1104
1105 // Define here to avoid including iOther.h and BasicBlock.h in DSGraph.h
1106 Function &DSCallSite::getCaller() const {
1107   return *Site.getInstruction()->getParent()->getParent();
1108 }
1109
1110 void DSCallSite::InitNH(DSNodeHandle &NH, const DSNodeHandle &Src,
1111                         ReachabilityCloner &RC) {
1112   NH = RC.getClonedNH(Src);
1113 }
1114
1115 //===----------------------------------------------------------------------===//
1116 // DSGraph Implementation
1117 //===----------------------------------------------------------------------===//
1118
1119 /// getFunctionNames - Return a space separated list of the name of the
1120 /// functions in this graph (if any)
1121 std::string DSGraph::getFunctionNames() const {
1122   switch (getReturnNodes().size()) {
1123   case 0: return "Globals graph";
1124   case 1: return retnodes_begin()->first->getName();
1125   default:
1126     std::string Return;
1127     for (DSGraph::retnodes_iterator I = retnodes_begin();
1128          I != retnodes_end(); ++I)
1129       Return += I->first->getName() + " ";
1130     Return.erase(Return.end()-1, Return.end());   // Remove last space character
1131     return Return;
1132   }
1133 }
1134
1135
1136 DSGraph::DSGraph(const DSGraph &G, EquivalenceClasses<GlobalValue*> &ECs)
1137   : GlobalsGraph(0), ScalarMap(ECs), TD(G.TD) {
1138   PrintAuxCalls = false;
1139   NodeMapTy NodeMap;
1140   cloneInto(G, ScalarMap, ReturnNodes, NodeMap);
1141 }
1142
1143 DSGraph::DSGraph(const DSGraph &G, NodeMapTy &NodeMap,
1144                  EquivalenceClasses<GlobalValue*> &ECs)
1145   : GlobalsGraph(0), ScalarMap(ECs), TD(G.TD) {
1146   PrintAuxCalls = false;
1147   cloneInto(G, ScalarMap, ReturnNodes, NodeMap);
1148 }
1149
1150 DSGraph::~DSGraph() {
1151   FunctionCalls.clear();
1152   AuxFunctionCalls.clear();
1153   ScalarMap.clear();
1154   ReturnNodes.clear();
1155
1156   // Drop all intra-node references, so that assertions don't fail...
1157   for (node_iterator NI = node_begin(), E = node_end(); NI != E; ++NI)
1158     NI->dropAllReferences();
1159
1160   // Free all of the nodes.
1161   Nodes.clear();
1162 }
1163
1164 // dump - Allow inspection of graph in a debugger.
1165 void DSGraph::dump() const { print(std::cerr); }
1166
1167
1168 /// remapLinks - Change all of the Links in the current node according to the
1169 /// specified mapping.
1170 ///
1171 void DSNode::remapLinks(DSGraph::NodeMapTy &OldNodeMap) {
1172   for (unsigned i = 0, e = Links.size(); i != e; ++i)
1173     if (DSNode *N = Links[i].getNode()) {
1174       DSGraph::NodeMapTy::const_iterator ONMI = OldNodeMap.find(N);
1175       if (ONMI != OldNodeMap.end()) {
1176         DSNode *ONMIN = ONMI->second.getNode();
1177         Links[i].setTo(ONMIN, Links[i].getOffset()+ONMI->second.getOffset());
1178       }
1179     }
1180 }
1181
1182 /// addObjectToGraph - This method can be used to add global, stack, and heap
1183 /// objects to the graph.  This can be used when updating DSGraphs due to the
1184 /// introduction of new temporary objects.  The new object is not pointed to
1185 /// and does not point to any other objects in the graph.
1186 DSNode *DSGraph::addObjectToGraph(Value *Ptr, bool UseDeclaredType) {
1187   assert(isa<PointerType>(Ptr->getType()) && "Ptr is not a pointer!");
1188   const Type *Ty = cast<PointerType>(Ptr->getType())->getElementType();
1189   DSNode *N = new DSNode(UseDeclaredType ? Ty : 0, this);
1190   assert(ScalarMap[Ptr].isNull() && "Object already in this graph!");
1191   ScalarMap[Ptr] = N;
1192
1193   if (GlobalValue *GV = dyn_cast<GlobalValue>(Ptr)) {
1194     N->addGlobal(GV);
1195   } else if (MallocInst *MI = dyn_cast<MallocInst>(Ptr)) {
1196     N->setHeapNodeMarker();
1197   } else if (AllocaInst *AI = dyn_cast<AllocaInst>(Ptr)) {
1198     N->setAllocaNodeMarker();
1199   } else {
1200     assert(0 && "Illegal memory object input!");
1201   }
1202   return N;
1203 }
1204
1205
1206 /// cloneInto - Clone the specified DSGraph into the current graph.  The
1207 /// translated ScalarMap for the old function is filled into the OldValMap
1208 /// member, and the translated ReturnNodes map is returned into ReturnNodes.
1209 ///
1210 /// The CloneFlags member controls various aspects of the cloning process.
1211 ///
1212 void DSGraph::cloneInto(const DSGraph &G, DSScalarMap &OldValMap,
1213                         ReturnNodesTy &OldReturnNodes, NodeMapTy &OldNodeMap,
1214                         unsigned CloneFlags) {
1215   TIME_REGION(X, "cloneInto");
1216   assert(OldNodeMap.empty() && "Returned OldNodeMap should be empty!");
1217   assert(&G != this && "Cannot clone graph into itself!");
1218
1219   // Remove alloca or mod/ref bits as specified...
1220   unsigned BitsToClear = ((CloneFlags & StripAllocaBit)? DSNode::AllocaNode : 0)
1221     | ((CloneFlags & StripModRefBits)? (DSNode::Modified | DSNode::Read) : 0)
1222     | ((CloneFlags & StripIncompleteBit)? DSNode::Incomplete : 0);
1223   BitsToClear |= DSNode::DEAD;  // Clear dead flag...
1224
1225   for (node_const_iterator I = G.node_begin(), E = G.node_end(); I != E; ++I) {
1226     assert(!I->isForwarding() &&
1227            "Forward nodes shouldn't be in node list!");
1228     DSNode *New = new DSNode(*I, this);
1229     New->maskNodeTypes(~BitsToClear);
1230     OldNodeMap[I] = New;
1231   }
1232
1233 #ifndef NDEBUG
1234   Timer::addPeakMemoryMeasurement();
1235 #endif
1236
1237   // Rewrite the links in the new nodes to point into the current graph now.
1238   // Note that we don't loop over the node's list to do this.  The problem is
1239   // that remaping links can cause recursive merging to happen, which means
1240   // that node_iterator's can get easily invalidated!  Because of this, we
1241   // loop over the OldNodeMap, which contains all of the new nodes as the
1242   // .second element of the map elements.  Also note that if we remap a node
1243   // more than once, we won't break anything.
1244   for (NodeMapTy::iterator I = OldNodeMap.begin(), E = OldNodeMap.end();
1245        I != E; ++I)
1246     I->second.getNode()->remapLinks(OldNodeMap);
1247
1248   // Copy the scalar map... merging all of the global nodes...
1249   for (DSScalarMap::const_iterator I = G.ScalarMap.begin(),
1250          E = G.ScalarMap.end(); I != E; ++I) {
1251     DSNodeHandle &MappedNode = OldNodeMap[I->second.getNode()];
1252     DSNodeHandle &H = OldValMap[I->first];
1253     DSNode *MappedNodeN = MappedNode.getNode();
1254     H.mergeWith(DSNodeHandle(MappedNodeN,
1255                              I->second.getOffset()+MappedNode.getOffset()));
1256
1257     // If this is a global, add the global to this fn or merge if already exists
1258     if (GlobalValue* GV = dyn_cast<GlobalValue>(I->first))
1259       ScalarMap[GV].mergeWith(H);
1260   }
1261
1262   if (!(CloneFlags & DontCloneCallNodes)) {
1263     // Copy the function calls list.
1264     for (fc_iterator I = G.fc_begin(), E = G.fc_end(); I != E; ++I)
1265       FunctionCalls.push_back(DSCallSite(*I, OldNodeMap));
1266   }
1267
1268   if (!(CloneFlags & DontCloneAuxCallNodes)) {
1269     // Copy the auxiliary function calls list.
1270     for (afc_iterator I = G.afc_begin(), E = G.afc_end(); I != E; ++I)
1271       AuxFunctionCalls.push_back(DSCallSite(*I, OldNodeMap));
1272   }
1273
1274   // Map the return node pointers over...
1275   for (retnodes_iterator I = G.retnodes_begin(),
1276          E = G.retnodes_end(); I != E; ++I) {
1277     const DSNodeHandle &Ret = I->second;
1278     DSNodeHandle &MappedRet = OldNodeMap[Ret.getNode()];
1279     DSNode *MappedRetN = MappedRet.getNode();
1280     OldReturnNodes.insert(std::make_pair(I->first,
1281                           DSNodeHandle(MappedRetN,
1282                                        MappedRet.getOffset()+Ret.getOffset())));
1283   }
1284 }
1285
1286 static bool PathExistsToClonedNode(const DSNode *N, ReachabilityCloner &RC) {
1287   if (N)
1288     for (df_iterator<const DSNode*> I = df_begin(N), E = df_end(N); I != E; ++I)
1289       if (RC.hasClonedNode(*I))
1290         return true;
1291   return false;
1292 }
1293
1294 static bool PathExistsToClonedNode(const DSCallSite &CS,
1295                                    ReachabilityCloner &RC) {
1296   if (PathExistsToClonedNode(CS.getRetVal().getNode(), RC))
1297     return true;
1298   for (unsigned i = 0, e = CS.getNumPtrArgs(); i != e; ++i)
1299     if (PathExistsToClonedNode(CS.getPtrArg(i).getNode(), RC))
1300       return true;
1301   return false;
1302 }
1303
1304 /// getFunctionArgumentsForCall - Given a function that is currently in this
1305 /// graph, return the DSNodeHandles that correspond to the pointer-compatible
1306 /// function arguments.  The vector is filled in with the return value (or
1307 /// null if it is not pointer compatible), followed by all of the
1308 /// pointer-compatible arguments.
1309 void DSGraph::getFunctionArgumentsForCall(Function *F,
1310                                        std::vector<DSNodeHandle> &Args) const {
1311   Args.push_back(getReturnNodeFor(*F));
1312   for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E; ++AI)
1313     if (isPointerType(AI->getType())) {
1314       Args.push_back(getNodeForValue(AI));
1315       assert(!Args.back().isNull() && "Pointer argument w/o scalarmap entry!?");
1316     }
1317 }
1318
1319 /// mergeInCallFromOtherGraph - This graph merges in the minimal number of
1320 /// nodes from G2 into 'this' graph, merging the bindings specified by the
1321 /// call site (in this graph) with the bindings specified by the vector in G2.
1322 /// The two DSGraphs must be different.
1323 ///
1324 void DSGraph::mergeInGraph(const DSCallSite &CS,
1325                            std::vector<DSNodeHandle> &Args,
1326                            const DSGraph &Graph, unsigned CloneFlags) {
1327   TIME_REGION(X, "mergeInGraph");
1328
1329   // If this is not a recursive call, clone the graph into this graph...
1330   if (&Graph != this) {
1331     // Clone the callee's graph into the current graph, keeping track of where
1332     // scalars in the old graph _used_ to point, and of the new nodes matching
1333     // nodes of the old graph.
1334     ReachabilityCloner RC(*this, Graph, CloneFlags);
1335
1336     // Map the return node pointer over.
1337     if (!CS.getRetVal().isNull())
1338       RC.merge(CS.getRetVal(), Args[0]);
1339
1340     // Map over all of the arguments.
1341     for (unsigned i = 0, e = CS.getNumPtrArgs(); i != e; ++i) {
1342       if (i == Args.size()-1)
1343         break;
1344
1345       // Add the link from the argument scalar to the provided value.
1346       RC.merge(CS.getPtrArg(i), Args[i+1]);
1347     }
1348
1349     // If requested, copy all of the calls.
1350     if (!(CloneFlags & DontCloneCallNodes)) {
1351       // Copy the function calls list.
1352       for (fc_iterator I = Graph.fc_begin(), E = Graph.fc_end(); I != E; ++I)
1353         FunctionCalls.push_back(DSCallSite(*I, RC));
1354     }
1355
1356     // If the user has us copying aux calls (the normal case), set up a data
1357     // structure to keep track of which ones we've copied over.
1358     std::set<const DSCallSite*> CopiedAuxCall;
1359
1360     // Clone over all globals that appear in the caller and callee graphs.
1361     hash_set<GlobalVariable*> NonCopiedGlobals;
1362     for (DSScalarMap::global_iterator GI = Graph.getScalarMap().global_begin(),
1363            E = Graph.getScalarMap().global_end(); GI != E; ++GI)
1364       if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*GI))
1365         if (ScalarMap.count(GV))
1366           RC.merge(ScalarMap[GV], Graph.getNodeForValue(GV));
1367         else
1368           NonCopiedGlobals.insert(GV);
1369
1370     // If the global does not appear in the callers graph we generally don't
1371     // want to copy the node.  However, if there is a path from the node global
1372     // node to a node that we did copy in the graph, we *must* copy it to
1373     // maintain the connection information.  Every time we decide to include a
1374     // new global, this might make other globals live, so we must iterate
1375     // unfortunately.
1376     bool MadeChange = true;
1377     while (MadeChange) {
1378       MadeChange = false;
1379       for (hash_set<GlobalVariable*>::iterator I = NonCopiedGlobals.begin();
1380            I != NonCopiedGlobals.end();) {
1381         DSNode *GlobalNode = Graph.getNodeForValue(*I).getNode();
1382         if (RC.hasClonedNode(GlobalNode)) {
1383           // Already cloned it, remove from set.
1384           NonCopiedGlobals.erase(I++);
1385           MadeChange = true;
1386         } else if (PathExistsToClonedNode(GlobalNode, RC)) {
1387           RC.getClonedNH(Graph.getNodeForValue(*I));
1388           NonCopiedGlobals.erase(I++);
1389           MadeChange = true;
1390         } else {
1391           ++I;
1392         }
1393       }
1394
1395       // If requested, copy any aux calls that can reach copied nodes.
1396       if (!(CloneFlags & DontCloneAuxCallNodes)) {
1397         for (afc_iterator I = Graph.afc_begin(), E = Graph.afc_end(); I!=E; ++I)
1398           if (CopiedAuxCall.insert(&*I).second &&
1399               PathExistsToClonedNode(*I, RC)) {
1400             AuxFunctionCalls.push_back(DSCallSite(*I, RC));
1401             MadeChange = true;
1402           }
1403       }
1404     }
1405
1406   } else {
1407     // Merge the return value with the return value of the context.
1408     Args[0].mergeWith(CS.getRetVal());
1409
1410     // Resolve all of the function arguments.
1411     for (unsigned i = 0, e = CS.getNumPtrArgs(); i != e; ++i) {
1412       if (i == Args.size()-1)
1413         break;
1414
1415       // Add the link from the argument scalar to the provided value.
1416       Args[i+1].mergeWith(CS.getPtrArg(i));
1417     }
1418   }
1419 }
1420
1421
1422
1423 /// mergeInGraph - The method is used for merging graphs together.  If the
1424 /// argument graph is not *this, it makes a clone of the specified graph, then
1425 /// merges the nodes specified in the call site with the formal arguments in the
1426 /// graph.
1427 ///
1428 void DSGraph::mergeInGraph(const DSCallSite &CS, Function &F,
1429                            const DSGraph &Graph, unsigned CloneFlags) {
1430   // Set up argument bindings.
1431   std::vector<DSNodeHandle> Args;
1432   Graph.getFunctionArgumentsForCall(&F, Args);
1433
1434   mergeInGraph(CS, Args, Graph, CloneFlags);
1435 }
1436
1437 /// getCallSiteForArguments - Get the arguments and return value bindings for
1438 /// the specified function in the current graph.
1439 ///
1440 DSCallSite DSGraph::getCallSiteForArguments(Function &F) const {
1441   std::vector<DSNodeHandle> Args;
1442
1443   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
1444     if (isPointerType(I->getType()))
1445       Args.push_back(getNodeForValue(I));
1446
1447   return DSCallSite(CallSite(), getReturnNodeFor(F), &F, Args);
1448 }
1449
1450 /// getDSCallSiteForCallSite - Given an LLVM CallSite object that is live in
1451 /// the context of this graph, return the DSCallSite for it.
1452 DSCallSite DSGraph::getDSCallSiteForCallSite(CallSite CS) const {
1453   DSNodeHandle RetVal;
1454   Instruction *I = CS.getInstruction();
1455   if (isPointerType(I->getType()))
1456     RetVal = getNodeForValue(I);
1457
1458   std::vector<DSNodeHandle> Args;
1459   Args.reserve(CS.arg_end()-CS.arg_begin());
1460
1461   // Calculate the arguments vector...
1462   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); I != E; ++I)
1463     if (isPointerType((*I)->getType()))
1464       if (isa<ConstantPointerNull>(*I))
1465         Args.push_back(DSNodeHandle());
1466       else
1467         Args.push_back(getNodeForValue(*I));
1468
1469   // Add a new function call entry...
1470   if (Function *F = CS.getCalledFunction())
1471     return DSCallSite(CS, RetVal, F, Args);
1472   else
1473     return DSCallSite(CS, RetVal,
1474                       getNodeForValue(CS.getCalledValue()).getNode(), Args);
1475 }
1476
1477
1478
1479 // markIncompleteNodes - Mark the specified node as having contents that are not
1480 // known with the current analysis we have performed.  Because a node makes all
1481 // of the nodes it can reach incomplete if the node itself is incomplete, we
1482 // must recursively traverse the data structure graph, marking all reachable
1483 // nodes as incomplete.
1484 //
1485 static void markIncompleteNode(DSNode *N) {
1486   // Stop recursion if no node, or if node already marked...
1487   if (N == 0 || N->isIncomplete()) return;
1488
1489   // Actually mark the node
1490   N->setIncompleteMarker();
1491
1492   // Recursively process children...
1493   for (DSNode::edge_iterator I = N->edge_begin(),E = N->edge_end(); I != E; ++I)
1494     if (DSNode *DSN = I->getNode())
1495       markIncompleteNode(DSN);
1496 }
1497
1498 static void markIncomplete(DSCallSite &Call) {
1499   // Then the return value is certainly incomplete!
1500   markIncompleteNode(Call.getRetVal().getNode());
1501
1502   // All objects pointed to by function arguments are incomplete!
1503   for (unsigned i = 0, e = Call.getNumPtrArgs(); i != e; ++i)
1504     markIncompleteNode(Call.getPtrArg(i).getNode());
1505 }
1506
1507 // markIncompleteNodes - Traverse the graph, identifying nodes that may be
1508 // modified by other functions that have not been resolved yet.  This marks
1509 // nodes that are reachable through three sources of "unknownness":
1510 //
1511 //  Global Variables, Function Calls, and Incoming Arguments
1512 //
1513 // For any node that may have unknown components (because something outside the
1514 // scope of current analysis may have modified it), the 'Incomplete' flag is
1515 // added to the NodeType.
1516 //
1517 void DSGraph::markIncompleteNodes(unsigned Flags) {
1518   // Mark any incoming arguments as incomplete.
1519   if (Flags & DSGraph::MarkFormalArgs)
1520     for (ReturnNodesTy::iterator FI = ReturnNodes.begin(), E =ReturnNodes.end();
1521          FI != E; ++FI) {
1522       Function &F = *FI->first;
1523       for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
1524         if (isPointerType(I->getType()))
1525           markIncompleteNode(getNodeForValue(I).getNode());
1526       markIncompleteNode(FI->second.getNode());
1527     }
1528
1529   // Mark stuff passed into functions calls as being incomplete.
1530   if (!shouldPrintAuxCalls())
1531     for (std::list<DSCallSite>::iterator I = FunctionCalls.begin(),
1532            E = FunctionCalls.end(); I != E; ++I)
1533       markIncomplete(*I);
1534   else
1535     for (std::list<DSCallSite>::iterator I = AuxFunctionCalls.begin(),
1536            E = AuxFunctionCalls.end(); I != E; ++I)
1537       markIncomplete(*I);
1538
1539   // Mark all global nodes as incomplete.
1540   for (DSScalarMap::global_iterator I = ScalarMap.global_begin(),
1541          E = ScalarMap.global_end(); I != E; ++I)
1542     if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I))
1543       if (!GV->hasInitializer() ||    // Always mark external globals incomp.
1544           (!GV->isConstant() && (Flags & DSGraph::IgnoreGlobals) == 0))
1545         markIncompleteNode(ScalarMap[GV].getNode());
1546 }
1547
1548 static inline void killIfUselessEdge(DSNodeHandle &Edge) {
1549   if (DSNode *N = Edge.getNode())  // Is there an edge?
1550     if (N->getNumReferrers() == 1)  // Does it point to a lonely node?
1551       // No interesting info?
1552       if ((N->getNodeFlags() & ~DSNode::Incomplete) == 0 &&
1553           N->getType() == Type::VoidTy && !N->isNodeCompletelyFolded())
1554         Edge.setTo(0, 0);  // Kill the edge!
1555 }
1556
1557 #if 0
1558 static inline bool nodeContainsExternalFunction(const DSNode *N) {
1559   const std::vector<GlobalValue*> &Globals = N->getGlobals();
1560   for (unsigned i = 0, e = Globals.size(); i != e; ++i)
1561     if (Globals[i]->isExternal() && isa<Function>(Globals[i]))
1562       return true;
1563   return false;
1564 }
1565 #endif
1566
1567 static void removeIdenticalCalls(std::list<DSCallSite> &Calls) {
1568   // Remove trivially identical function calls
1569   Calls.sort();  // Sort by callee as primary key!
1570
1571   // Scan the call list cleaning it up as necessary...
1572   DSNode   *LastCalleeNode = 0;
1573   Function *LastCalleeFunc = 0;
1574   unsigned NumDuplicateCalls = 0;
1575   bool LastCalleeContainsExternalFunction = false;
1576
1577   unsigned NumDeleted = 0;
1578   for (std::list<DSCallSite>::iterator I = Calls.begin(), E = Calls.end();
1579        I != E;) {
1580     DSCallSite &CS = *I;
1581     std::list<DSCallSite>::iterator OldIt = I++;
1582
1583     // If the Callee is a useless edge, this must be an unreachable call site,
1584     // eliminate it.
1585     if (CS.isIndirectCall() && CS.getCalleeNode()->getNumReferrers() == 1 &&
1586         CS.getCalleeNode()->isComplete() &&
1587         CS.getCalleeNode()->getGlobalsList().empty()) {  // No useful info?
1588 #ifndef NDEBUG
1589       std::cerr << "WARNING: Useless call site found.\n";
1590 #endif
1591       Calls.erase(OldIt);
1592       ++NumDeleted;
1593       continue;
1594     }
1595
1596     // If the return value or any arguments point to a void node with no
1597     // information at all in it, and the call node is the only node to point
1598     // to it, remove the edge to the node (killing the node).
1599     //
1600     killIfUselessEdge(CS.getRetVal());
1601     for (unsigned a = 0, e = CS.getNumPtrArgs(); a != e; ++a)
1602       killIfUselessEdge(CS.getPtrArg(a));
1603
1604 #if 0
1605     // If this call site calls the same function as the last call site, and if
1606     // the function pointer contains an external function, this node will
1607     // never be resolved.  Merge the arguments of the call node because no
1608     // information will be lost.
1609     //
1610     if ((CS.isDirectCall()   && CS.getCalleeFunc() == LastCalleeFunc) ||
1611         (CS.isIndirectCall() && CS.getCalleeNode() == LastCalleeNode)) {
1612       ++NumDuplicateCalls;
1613       if (NumDuplicateCalls == 1) {
1614         if (LastCalleeNode)
1615           LastCalleeContainsExternalFunction =
1616             nodeContainsExternalFunction(LastCalleeNode);
1617         else
1618           LastCalleeContainsExternalFunction = LastCalleeFunc->isExternal();
1619       }
1620
1621       // It is not clear why, but enabling this code makes DSA really
1622       // sensitive to node forwarding.  Basically, with this enabled, DSA
1623       // performs different number of inlinings based on which nodes are
1624       // forwarding or not.  This is clearly a problem, so this code is
1625       // disabled until this can be resolved.
1626 #if 1
1627       if (LastCalleeContainsExternalFunction
1628 #if 0
1629           ||
1630           // This should be more than enough context sensitivity!
1631           // FIXME: Evaluate how many times this is tripped!
1632           NumDuplicateCalls > 20
1633 #endif
1634           ) {
1635
1636         std::list<DSCallSite>::iterator PrevIt = OldIt;
1637         --PrevIt;
1638         PrevIt->mergeWith(CS);
1639
1640         // No need to keep this call anymore.
1641         Calls.erase(OldIt);
1642         ++NumDeleted;
1643         continue;
1644       }
1645 #endif
1646     } else {
1647       if (CS.isDirectCall()) {
1648         LastCalleeFunc = CS.getCalleeFunc();
1649         LastCalleeNode = 0;
1650       } else {
1651         LastCalleeNode = CS.getCalleeNode();
1652         LastCalleeFunc = 0;
1653       }
1654       NumDuplicateCalls = 0;
1655     }
1656 #endif
1657
1658     if (I != Calls.end() && CS == *I) {
1659       Calls.erase(OldIt);
1660       ++NumDeleted;
1661       continue;
1662     }
1663   }
1664
1665   // Resort now that we simplified things.
1666   Calls.sort();
1667
1668   // Now that we are in sorted order, eliminate duplicates.
1669   std::list<DSCallSite>::iterator CI = Calls.begin(), CE = Calls.end();
1670   if (CI != CE)
1671     while (1) {
1672       std::list<DSCallSite>::iterator OldIt = CI++;
1673       if (CI == CE) break;
1674
1675       // If this call site is now the same as the previous one, we can delete it
1676       // as a duplicate.
1677       if (*OldIt == *CI) {
1678         Calls.erase(CI);
1679         CI = OldIt;
1680         ++NumDeleted;
1681       }
1682     }
1683
1684   //Calls.erase(std::unique(Calls.begin(), Calls.end()), Calls.end());
1685
1686   // Track the number of call nodes merged away...
1687   NumCallNodesMerged += NumDeleted;
1688
1689   DEBUG(if (NumDeleted)
1690           std::cerr << "Merged " << NumDeleted << " call nodes.\n";);
1691 }
1692
1693
1694 // removeTriviallyDeadNodes - After the graph has been constructed, this method
1695 // removes all unreachable nodes that are created because they got merged with
1696 // other nodes in the graph.  These nodes will all be trivially unreachable, so
1697 // we don't have to perform any non-trivial analysis here.
1698 //
1699 void DSGraph::removeTriviallyDeadNodes() {
1700   TIME_REGION(X, "removeTriviallyDeadNodes");
1701
1702 #if 0
1703   /// NOTE: This code is disabled.  This slows down DSA on 177.mesa
1704   /// substantially!
1705
1706   // Loop over all of the nodes in the graph, calling getNode on each field.
1707   // This will cause all nodes to update their forwarding edges, causing
1708   // forwarded nodes to be delete-able.
1709   { TIME_REGION(X, "removeTriviallyDeadNodes:node_iterate");
1710   for (node_iterator NI = node_begin(), E = node_end(); NI != E; ++NI) {
1711     DSNode &N = *NI;
1712     for (unsigned l = 0, e = N.getNumLinks(); l != e; ++l)
1713       N.getLink(l*N.getPointerSize()).getNode();
1714   }
1715   }
1716
1717   // NOTE: This code is disabled.  Though it should, in theory, allow us to
1718   // remove more nodes down below, the scan of the scalar map is incredibly
1719   // expensive for certain programs (with large SCCs).  In the future, if we can
1720   // make the scalar map scan more efficient, then we can reenable this.
1721   { TIME_REGION(X, "removeTriviallyDeadNodes:scalarmap");
1722
1723   // Likewise, forward any edges from the scalar nodes.  While we are at it,
1724   // clean house a bit.
1725   for (DSScalarMap::iterator I = ScalarMap.begin(),E = ScalarMap.end();I != E;){
1726     I->second.getNode();
1727     ++I;
1728   }
1729   }
1730 #endif
1731   bool isGlobalsGraph = !GlobalsGraph;
1732
1733   for (NodeListTy::iterator NI = Nodes.begin(), E = Nodes.end(); NI != E; ) {
1734     DSNode &Node = *NI;
1735
1736     // Do not remove *any* global nodes in the globals graph.
1737     // This is a special case because such nodes may not have I, M, R flags set.
1738     if (Node.isGlobalNode() && isGlobalsGraph) {
1739       ++NI;
1740       continue;
1741     }
1742
1743     if (Node.isComplete() && !Node.isModified() && !Node.isRead()) {
1744       // This is a useless node if it has no mod/ref info (checked above),
1745       // outgoing edges (which it cannot, as it is not modified in this
1746       // context), and it has no incoming edges.  If it is a global node it may
1747       // have all of these properties and still have incoming edges, due to the
1748       // scalar map, so we check those now.
1749       //
1750       if (Node.getNumReferrers() == Node.getGlobalsList().size()) {
1751         const std::vector<GlobalValue*> &Globals = Node.getGlobalsList();
1752
1753         // Loop through and make sure all of the globals are referring directly
1754         // to the node...
1755         for (unsigned j = 0, e = Globals.size(); j != e; ++j) {
1756           DSNode *N = getNodeForValue(Globals[j]).getNode();
1757           assert(N == &Node && "ScalarMap doesn't match globals list!");
1758         }
1759
1760         // Make sure NumReferrers still agrees, if so, the node is truly dead.
1761         if (Node.getNumReferrers() == Globals.size()) {
1762           for (unsigned j = 0, e = Globals.size(); j != e; ++j)
1763             ScalarMap.erase(Globals[j]);
1764           Node.makeNodeDead();
1765           ++NumTrivialGlobalDNE;
1766         }
1767       }
1768     }
1769
1770     if (Node.getNodeFlags() == 0 && Node.hasNoReferrers()) {
1771       // This node is dead!
1772       NI = Nodes.erase(NI);    // Erase & remove from node list.
1773       ++NumTrivialDNE;
1774     } else {
1775       ++NI;
1776     }
1777   }
1778
1779   removeIdenticalCalls(FunctionCalls);
1780   removeIdenticalCalls(AuxFunctionCalls);
1781 }
1782
1783
1784 /// markReachableNodes - This method recursively traverses the specified
1785 /// DSNodes, marking any nodes which are reachable.  All reachable nodes it adds
1786 /// to the set, which allows it to only traverse visited nodes once.
1787 ///
1788 void DSNode::markReachableNodes(hash_set<const DSNode*> &ReachableNodes) const {
1789   if (this == 0) return;
1790   assert(getForwardNode() == 0 && "Cannot mark a forwarded node!");
1791   if (ReachableNodes.insert(this).second)        // Is newly reachable?
1792     for (DSNode::const_edge_iterator I = edge_begin(), E = edge_end();
1793          I != E; ++I)
1794       I->getNode()->markReachableNodes(ReachableNodes);
1795 }
1796
1797 void DSCallSite::markReachableNodes(hash_set<const DSNode*> &Nodes) const {
1798   getRetVal().getNode()->markReachableNodes(Nodes);
1799   if (isIndirectCall()) getCalleeNode()->markReachableNodes(Nodes);
1800
1801   for (unsigned i = 0, e = getNumPtrArgs(); i != e; ++i)
1802     getPtrArg(i).getNode()->markReachableNodes(Nodes);
1803 }
1804
1805 // CanReachAliveNodes - Simple graph walker that recursively traverses the graph
1806 // looking for a node that is marked alive.  If an alive node is found, return
1807 // true, otherwise return false.  If an alive node is reachable, this node is
1808 // marked as alive...
1809 //
1810 static bool CanReachAliveNodes(DSNode *N, hash_set<const DSNode*> &Alive,
1811                                hash_set<const DSNode*> &Visited,
1812                                bool IgnoreGlobals) {
1813   if (N == 0) return false;
1814   assert(N->getForwardNode() == 0 && "Cannot mark a forwarded node!");
1815
1816   // If this is a global node, it will end up in the globals graph anyway, so we
1817   // don't need to worry about it.
1818   if (IgnoreGlobals && N->isGlobalNode()) return false;
1819
1820   // If we know that this node is alive, return so!
1821   if (Alive.count(N)) return true;
1822
1823   // Otherwise, we don't think the node is alive yet, check for infinite
1824   // recursion.
1825   if (Visited.count(N)) return false;  // Found a cycle
1826   Visited.insert(N);   // No recursion, insert into Visited...
1827
1828   for (DSNode::edge_iterator I = N->edge_begin(),E = N->edge_end(); I != E; ++I)
1829     if (CanReachAliveNodes(I->getNode(), Alive, Visited, IgnoreGlobals)) {
1830       N->markReachableNodes(Alive);
1831       return true;
1832     }
1833   return false;
1834 }
1835
1836 // CallSiteUsesAliveArgs - Return true if the specified call site can reach any
1837 // alive nodes.
1838 //
1839 static bool CallSiteUsesAliveArgs(const DSCallSite &CS,
1840                                   hash_set<const DSNode*> &Alive,
1841                                   hash_set<const DSNode*> &Visited,
1842                                   bool IgnoreGlobals) {
1843   if (CanReachAliveNodes(CS.getRetVal().getNode(), Alive, Visited,
1844                          IgnoreGlobals))
1845     return true;
1846   if (CS.isIndirectCall() &&
1847       CanReachAliveNodes(CS.getCalleeNode(), Alive, Visited, IgnoreGlobals))
1848     return true;
1849   for (unsigned i = 0, e = CS.getNumPtrArgs(); i != e; ++i)
1850     if (CanReachAliveNodes(CS.getPtrArg(i).getNode(), Alive, Visited,
1851                            IgnoreGlobals))
1852       return true;
1853   return false;
1854 }
1855
1856 // removeDeadNodes - Use a more powerful reachability analysis to eliminate
1857 // subgraphs that are unreachable.  This often occurs because the data
1858 // structure doesn't "escape" into it's caller, and thus should be eliminated
1859 // from the caller's graph entirely.  This is only appropriate to use when
1860 // inlining graphs.
1861 //
1862 void DSGraph::removeDeadNodes(unsigned Flags) {
1863   DEBUG(AssertGraphOK(); if (GlobalsGraph) GlobalsGraph->AssertGraphOK());
1864
1865   // Reduce the amount of work we have to do... remove dummy nodes left over by
1866   // merging...
1867   removeTriviallyDeadNodes();
1868
1869   TIME_REGION(X, "removeDeadNodes");
1870
1871   // FIXME: Merge non-trivially identical call nodes...
1872
1873   // Alive - a set that holds all nodes found to be reachable/alive.
1874   hash_set<const DSNode*> Alive;
1875   std::vector<std::pair<Value*, DSNode*> > GlobalNodes;
1876
1877   // Copy and merge all information about globals to the GlobalsGraph if this is
1878   // not a final pass (where unreachable globals are removed).
1879   //
1880   // Strip all alloca bits since the current function is only for the BU pass.
1881   // Strip all incomplete bits since they are short-lived properties and they
1882   // will be correctly computed when rematerializing nodes into the functions.
1883   //
1884   ReachabilityCloner GGCloner(*GlobalsGraph, *this, DSGraph::StripAllocaBit |
1885                               DSGraph::StripIncompleteBit);
1886
1887   // Mark all nodes reachable by (non-global) scalar nodes as alive...
1888 { TIME_REGION(Y, "removeDeadNodes:scalarscan");
1889   for (DSScalarMap::iterator I = ScalarMap.begin(), E = ScalarMap.end();
1890        I != E; ++I)
1891     if (isa<GlobalValue>(I->first)) {             // Keep track of global nodes
1892       assert(!I->second.isNull() && "Null global node?");
1893       assert(I->second.getNode()->isGlobalNode() && "Should be a global node!");
1894       GlobalNodes.push_back(std::make_pair(I->first, I->second.getNode()));
1895
1896       // Make sure that all globals are cloned over as roots.
1897       if (!(Flags & DSGraph::RemoveUnreachableGlobals)) {
1898         DSGraph::ScalarMapTy::iterator SMI =
1899           GlobalsGraph->getScalarMap().find(I->first);
1900         if (SMI != GlobalsGraph->getScalarMap().end())
1901           GGCloner.merge(SMI->second, I->second);
1902         else
1903           GGCloner.getClonedNH(I->second);
1904       }
1905     } else {
1906       I->second.getNode()->markReachableNodes(Alive);
1907     }
1908 }
1909
1910   // The return values are alive as well.
1911   for (ReturnNodesTy::iterator I = ReturnNodes.begin(), E = ReturnNodes.end();
1912        I != E; ++I)
1913     I->second.getNode()->markReachableNodes(Alive);
1914
1915   // Mark any nodes reachable by primary calls as alive...
1916   for (fc_iterator I = fc_begin(), E = fc_end(); I != E; ++I)
1917     I->markReachableNodes(Alive);
1918
1919
1920   // Now find globals and aux call nodes that are already live or reach a live
1921   // value (which makes them live in turn), and continue till no more are found.
1922   //
1923   bool Iterate;
1924   hash_set<const DSNode*> Visited;
1925   hash_set<const DSCallSite*> AuxFCallsAlive;
1926   do {
1927     Visited.clear();
1928     // If any global node points to a non-global that is "alive", the global is
1929     // "alive" as well...  Remove it from the GlobalNodes list so we only have
1930     // unreachable globals in the list.
1931     //
1932     Iterate = false;
1933     if (!(Flags & DSGraph::RemoveUnreachableGlobals))
1934       for (unsigned i = 0; i != GlobalNodes.size(); ++i)
1935         if (CanReachAliveNodes(GlobalNodes[i].second, Alive, Visited,
1936                                Flags & DSGraph::RemoveUnreachableGlobals)) {
1937           std::swap(GlobalNodes[i--], GlobalNodes.back()); // Move to end to...
1938           GlobalNodes.pop_back();                          // erase efficiently
1939           Iterate = true;
1940         }
1941
1942     // Mark only unresolvable call nodes for moving to the GlobalsGraph since
1943     // call nodes that get resolved will be difficult to remove from that graph.
1944     // The final unresolved call nodes must be handled specially at the end of
1945     // the BU pass (i.e., in main or other roots of the call graph).
1946     for (afc_iterator CI = afc_begin(), E = afc_end(); CI != E; ++CI)
1947       if (!AuxFCallsAlive.count(&*CI) &&
1948           (CI->isIndirectCall()
1949            || CallSiteUsesAliveArgs(*CI, Alive, Visited,
1950                                   Flags & DSGraph::RemoveUnreachableGlobals))) {
1951         CI->markReachableNodes(Alive);
1952         AuxFCallsAlive.insert(&*CI);
1953         Iterate = true;
1954       }
1955   } while (Iterate);
1956
1957   // Move dead aux function calls to the end of the list
1958   unsigned CurIdx = 0;
1959   for (std::list<DSCallSite>::iterator CI = AuxFunctionCalls.begin(),
1960          E = AuxFunctionCalls.end(); CI != E; )
1961     if (AuxFCallsAlive.count(&*CI))
1962       ++CI;
1963     else {
1964       // Copy and merge global nodes and dead aux call nodes into the
1965       // GlobalsGraph, and all nodes reachable from those nodes.  Update their
1966       // target pointers using the GGCloner.
1967       //
1968       if (!(Flags & DSGraph::RemoveUnreachableGlobals))
1969         GlobalsGraph->AuxFunctionCalls.push_back(DSCallSite(*CI, GGCloner));
1970
1971       AuxFunctionCalls.erase(CI++);
1972     }
1973
1974   // We are finally done with the GGCloner so we can destroy it.
1975   GGCloner.destroy();
1976
1977   // At this point, any nodes which are visited, but not alive, are nodes
1978   // which can be removed.  Loop over all nodes, eliminating completely
1979   // unreachable nodes.
1980   //
1981   std::vector<DSNode*> DeadNodes;
1982   DeadNodes.reserve(Nodes.size());
1983   for (NodeListTy::iterator NI = Nodes.begin(), E = Nodes.end(); NI != E;) {
1984     DSNode *N = NI++;
1985     assert(!N->isForwarding() && "Forwarded node in nodes list?");
1986
1987     if (!Alive.count(N)) {
1988       Nodes.remove(N);
1989       assert(!N->isForwarding() && "Cannot remove a forwarding node!");
1990       DeadNodes.push_back(N);
1991       N->dropAllReferences();
1992       ++NumDNE;
1993     }
1994   }
1995
1996   // Remove all unreachable globals from the ScalarMap.
1997   // If flag RemoveUnreachableGlobals is set, GlobalNodes has only dead nodes.
1998   // In either case, the dead nodes will not be in the set Alive.
1999   for (unsigned i = 0, e = GlobalNodes.size(); i != e; ++i)
2000     if (!Alive.count(GlobalNodes[i].second))
2001       ScalarMap.erase(GlobalNodes[i].first);
2002     else
2003       assert((Flags & DSGraph::RemoveUnreachableGlobals) && "non-dead global");
2004
2005   // Delete all dead nodes now since their referrer counts are zero.
2006   for (unsigned i = 0, e = DeadNodes.size(); i != e; ++i)
2007     delete DeadNodes[i];
2008
2009   DEBUG(AssertGraphOK(); GlobalsGraph->AssertGraphOK());
2010 }
2011
2012 void DSGraph::AssertNodeContainsGlobal(const DSNode *N, GlobalValue *GV) const {
2013   assert(std::find(N->globals_begin(),N->globals_end(), GV) !=
2014          N->globals_end() && "Global value not in node!");
2015 }
2016
2017 void DSGraph::AssertCallSiteInGraph(const DSCallSite &CS) const {
2018   if (CS.isIndirectCall()) {
2019     AssertNodeInGraph(CS.getCalleeNode());
2020 #if 0
2021     if (CS.getNumPtrArgs() && CS.getCalleeNode() == CS.getPtrArg(0).getNode() &&
2022         CS.getCalleeNode() && CS.getCalleeNode()->getGlobals().empty())
2023       std::cerr << "WARNING: WEIRD CALL SITE FOUND!\n";
2024 #endif
2025   }
2026   AssertNodeInGraph(CS.getRetVal().getNode());
2027   for (unsigned j = 0, e = CS.getNumPtrArgs(); j != e; ++j)
2028     AssertNodeInGraph(CS.getPtrArg(j).getNode());
2029 }
2030
2031 void DSGraph::AssertCallNodesInGraph() const {
2032   for (fc_iterator I = fc_begin(), E = fc_end(); I != E; ++I)
2033     AssertCallSiteInGraph(*I);
2034 }
2035 void DSGraph::AssertAuxCallNodesInGraph() const {
2036   for (afc_iterator I = afc_begin(), E = afc_end(); I != E; ++I)
2037     AssertCallSiteInGraph(*I);
2038 }
2039
2040 void DSGraph::AssertGraphOK() const {
2041   for (node_const_iterator NI = node_begin(), E = node_end(); NI != E; ++NI)
2042     NI->assertOK();
2043
2044   for (ScalarMapTy::const_iterator I = ScalarMap.begin(),
2045          E = ScalarMap.end(); I != E; ++I) {
2046     assert(!I->second.isNull() && "Null node in scalarmap!");
2047     AssertNodeInGraph(I->second.getNode());
2048     if (GlobalValue *GV = dyn_cast<GlobalValue>(I->first)) {
2049       assert(I->second.getNode()->isGlobalNode() &&
2050              "Global points to node, but node isn't global?");
2051       AssertNodeContainsGlobal(I->second.getNode(), GV);
2052     }
2053   }
2054   AssertCallNodesInGraph();
2055   AssertAuxCallNodesInGraph();
2056
2057   // Check that all pointer arguments to any functions in this graph have
2058   // destinations.
2059   for (ReturnNodesTy::const_iterator RI = ReturnNodes.begin(),
2060          E = ReturnNodes.end();
2061        RI != E; ++RI) {
2062     Function &F = *RI->first;
2063     for (Function::arg_iterator AI = F.arg_begin(); AI != F.arg_end(); ++AI)
2064       if (isPointerType(AI->getType()))
2065         assert(!getNodeForValue(AI).isNull() &&
2066                "Pointer argument must be in the scalar map!");
2067   }
2068 }
2069
2070 /// computeNodeMapping - Given roots in two different DSGraphs, traverse the
2071 /// nodes reachable from the two graphs, computing the mapping of nodes from the
2072 /// first to the second graph.  This mapping may be many-to-one (i.e. the first
2073 /// graph may have multiple nodes representing one node in the second graph),
2074 /// but it will not work if there is a one-to-many or many-to-many mapping.
2075 ///
2076 void DSGraph::computeNodeMapping(const DSNodeHandle &NH1,
2077                                  const DSNodeHandle &NH2, NodeMapTy &NodeMap,
2078                                  bool StrictChecking) {
2079   DSNode *N1 = NH1.getNode(), *N2 = NH2.getNode();
2080   if (N1 == 0 || N2 == 0) return;
2081
2082   DSNodeHandle &Entry = NodeMap[N1];
2083   if (!Entry.isNull()) {
2084     // Termination of recursion!
2085     if (StrictChecking) {
2086       assert(Entry.getNode() == N2 && "Inconsistent mapping detected!");
2087       assert((Entry.getOffset() == (NH2.getOffset()-NH1.getOffset()) ||
2088               Entry.getNode()->isNodeCompletelyFolded()) &&
2089              "Inconsistent mapping detected!");
2090     }
2091     return;
2092   }
2093
2094   Entry.setTo(N2, NH2.getOffset()-NH1.getOffset());
2095
2096   // Loop over all of the fields that N1 and N2 have in common, recursively
2097   // mapping the edges together now.
2098   int N2Idx = NH2.getOffset()-NH1.getOffset();
2099   unsigned N2Size = N2->getSize();
2100   if (N2Size == 0) return;   // No edges to map to.
2101
2102   for (unsigned i = 0, e = N1->getSize(); i < e; i += DS::PointerSize) {
2103     const DSNodeHandle &N1NH = N1->getLink(i);
2104     // Don't call N2->getLink if not needed (avoiding crash if N2Idx is not
2105     // aligned right).
2106     if (!N1NH.isNull()) {
2107       if (unsigned(N2Idx)+i < N2Size)
2108         computeNodeMapping(N1NH, N2->getLink(N2Idx+i), NodeMap);
2109       else
2110         computeNodeMapping(N1NH,
2111                            N2->getLink(unsigned(N2Idx+i) % N2Size), NodeMap);
2112     }
2113   }
2114 }
2115
2116
2117 /// computeGToGGMapping - Compute the mapping of nodes in the global graph to
2118 /// nodes in this graph.
2119 void DSGraph::computeGToGGMapping(NodeMapTy &NodeMap) {
2120   DSGraph &GG = *getGlobalsGraph();
2121
2122   DSScalarMap &SM = getScalarMap();
2123   for (DSScalarMap::global_iterator I = SM.global_begin(),
2124          E = SM.global_end(); I != E; ++I)
2125     DSGraph::computeNodeMapping(SM[*I], GG.getNodeForValue(*I), NodeMap);
2126 }
2127
2128 /// computeGGToGMapping - Compute the mapping of nodes in the global graph to
2129 /// nodes in this graph.  Note that any uses of this method are probably bugs,
2130 /// unless it is known that the globals graph has been merged into this graph!
2131 void DSGraph::computeGGToGMapping(InvNodeMapTy &InvNodeMap) {
2132   NodeMapTy NodeMap;
2133   computeGToGGMapping(NodeMap);
2134
2135   while (!NodeMap.empty()) {
2136     InvNodeMap.insert(std::make_pair(NodeMap.begin()->second,
2137                                      NodeMap.begin()->first));
2138     NodeMap.erase(NodeMap.begin());
2139   }
2140 }
2141
2142
2143 /// computeCalleeCallerMapping - Given a call from a function in the current
2144 /// graph to the 'Callee' function (which lives in 'CalleeGraph'), compute the
2145 /// mapping of nodes from the callee to nodes in the caller.
2146 void DSGraph::computeCalleeCallerMapping(DSCallSite CS, const Function &Callee,
2147                                          DSGraph &CalleeGraph,
2148                                          NodeMapTy &NodeMap) {
2149
2150   DSCallSite CalleeArgs =
2151     CalleeGraph.getCallSiteForArguments(const_cast<Function&>(Callee));
2152
2153   computeNodeMapping(CalleeArgs.getRetVal(), CS.getRetVal(), NodeMap);
2154
2155   unsigned NumArgs = CS.getNumPtrArgs();
2156   if (NumArgs > CalleeArgs.getNumPtrArgs())
2157     NumArgs = CalleeArgs.getNumPtrArgs();
2158
2159   for (unsigned i = 0; i != NumArgs; ++i)
2160     computeNodeMapping(CalleeArgs.getPtrArg(i), CS.getPtrArg(i), NodeMap);
2161
2162   // Map the nodes that are pointed to by globals.
2163   DSScalarMap &CalleeSM = CalleeGraph.getScalarMap();
2164   DSScalarMap &CallerSM = getScalarMap();
2165
2166   if (CalleeSM.global_size() >= CallerSM.global_size()) {
2167     for (DSScalarMap::global_iterator GI = CallerSM.global_begin(),
2168            E = CallerSM.global_end(); GI != E; ++GI)
2169       if (CalleeSM.global_count(*GI))
2170         computeNodeMapping(CalleeSM[*GI], CallerSM[*GI], NodeMap);
2171   } else {
2172     for (DSScalarMap::global_iterator GI = CalleeSM.global_begin(),
2173            E = CalleeSM.global_end(); GI != E; ++GI)
2174       if (CallerSM.global_count(*GI))
2175         computeNodeMapping(CalleeSM[*GI], CallerSM[*GI], NodeMap);
2176   }
2177 }