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