include/llvm/ADT/ImmutableSet.h

   1 //===--- ImmutableSet.h - Immutable (functional) set interface --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the ImutAVLTree and ImmutableSet classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_IMMUTABLESET_H
  15 #define LLVM_ADT_IMMUTABLESET_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/FoldingSet.h"
  19 #include "llvm/Support/Allocator.h"
  20 #include "llvm/Support/DataTypes.h"
  21 #include "llvm/Support/ErrorHandling.h"
  22 #include <cassert>
  23 #include <functional>
  24 #include <vector>
  25
  26 namespace llvm {
  27
  28 //===----------------------------------------------------------------------===//
  29 // Immutable AVL-Tree Definition.
  30 //===----------------------------------------------------------------------===//
  31
  32 template <typename ImutInfo> class ImutAVLFactory;
  33 template <typename ImutInfo> class ImutIntervalAVLFactory;
  34 template <typename ImutInfo> class ImutAVLTreeInOrderIterator;
  35 template <typename ImutInfo> class ImutAVLTreeGenericIterator;
  36
  37 template <typename ImutInfo >
  38 class ImutAVLTree {
  39 public:
  40   typedef typename ImutInfo::key_type_ref   key_type_ref;
  41   typedef typename ImutInfo::value_type     value_type;
  42   typedef typename ImutInfo::value_type_ref value_type_ref;
  43
  44   typedef ImutAVLFactory<ImutInfo>          Factory;
  45   friend class ImutAVLFactory<ImutInfo>;
  46   friend class ImutIntervalAVLFactory<ImutInfo>;
  47
  48   friend class ImutAVLTreeGenericIterator<ImutInfo>;
  49
  50   typedef ImutAVLTreeInOrderIterator<ImutInfo>  iterator;
  51
  52   //===----------------------------------------------------===//
  53   // Public Interface.
  54   //===----------------------------------------------------===//
  55
  56   /// Return a pointer to the left subtree.  This value
  57   ///  is NULL if there is no left subtree.
  58   ImutAVLTree *getLeft() const { return left; }
  59
  60   /// Return a pointer to the right subtree.  This value is
  61   ///  NULL if there is no right subtree.
  62   ImutAVLTree *getRight() const { return right; }
  63
  64   /// getHeight - Returns the height of the tree.  A tree with no subtrees
  65   ///  has a height of 1.
  66   unsigned getHeight() const { return height; }
  67
  68   /// getValue - Returns the data value associated with the tree node.
  69   const value_type& getValue() const { return value; }
  70
  71   /// find - Finds the subtree associated with the specified key value.
  72   ///  This method returns NULL if no matching subtree is found.
  73   ImutAVLTree* find(key_type_ref K) {
  74     ImutAVLTree *T = this;
  75     while (T) {
  76       key_type_ref CurrentKey = ImutInfo::KeyOfValue(T->getValue());
  77       if (ImutInfo::isEqual(K,CurrentKey))
  78         return T;
  79       else if (ImutInfo::isLess(K,CurrentKey))
  80         T = T->getLeft();
  81       else
  82         T = T->getRight();
  83     }
  84     return nullptr;
  85   }
  86
  87   /// getMaxElement - Find the subtree associated with the highest ranged
  88   ///  key value.
  89   ImutAVLTree* getMaxElement() {
  90     ImutAVLTree *T = this;
  91     ImutAVLTree *Right = T->getRight();
  92     while (Right) { T = Right; Right = T->getRight(); }
  93     return T;
  94   }
  95
  96   /// size - Returns the number of nodes in the tree, which includes
  97   ///  both leaves and non-leaf nodes.
  98   unsigned size() const {
  99     unsigned n = 1;
 100     if (const ImutAVLTree* L = getLeft())
 101       n += L->size();
 102     if (const ImutAVLTree* R = getRight())
 103       n += R->size();
 104     return n;
 105   }
 106
 107   /// begin - Returns an iterator that iterates over the nodes of the tree
 108   ///  in an inorder traversal.  The returned iterator thus refers to the
 109   ///  the tree node with the minimum data element.
 110   iterator begin() const { return iterator(this); }
 111
 112   /// end - Returns an iterator for the tree that denotes the end of an
 113   ///  inorder traversal.
 114   iterator end() const { return iterator(); }
 115
 116   bool isElementEqual(value_type_ref V) const {
 117     // Compare the keys.
 118     if (!ImutInfo::isEqual(ImutInfo::KeyOfValue(getValue()),
 119                            ImutInfo::KeyOfValue(V)))
 120       return false;
 121
 122     // Also compare the data values.
 123     if (!ImutInfo::isDataEqual(ImutInfo::DataOfValue(getValue()),
 124                                ImutInfo::DataOfValue(V)))
 125       return false;
 126
 127     return true;
 128   }
 129
 130   bool isElementEqual(const ImutAVLTree* RHS) const {
 131     return isElementEqual(RHS->getValue());
 132   }
 133
 134   /// isEqual - Compares two trees for structural equality and returns true
 135   ///   if they are equal.  This worst case performance of this operation is
 136   //    linear in the sizes of the trees.
 137   bool isEqual(const ImutAVLTree& RHS) const {
 138     if (&RHS == this)
 139       return true;
 140
 141     iterator LItr = begin(), LEnd = end();
 142     iterator RItr = RHS.begin(), REnd = RHS.end();
 143
 144     while (LItr != LEnd && RItr != REnd) {
 145       if (*LItr == *RItr) {
 146         LItr.skipSubTree();
 147         RItr.skipSubTree();
 148         continue;
 149       }
 150
 151       if (!LItr->isElementEqual(*RItr))
 152         return false;
 153
 154       ++LItr;
 155       ++RItr;
 156     }
 157
 158     return LItr == LEnd && RItr == REnd;
 159   }
 160
 161   /// isNotEqual - Compares two trees for structural inequality.  Performance
 162   ///  is the same is isEqual.
 163   bool isNotEqual(const ImutAVLTree& RHS) const { return !isEqual(RHS); }
 164
 165   /// contains - Returns true if this tree contains a subtree (node) that
 166   ///  has an data element that matches the specified key.  Complexity
 167   ///  is logarithmic in the size of the tree.
 168   bool contains(key_type_ref K) { return (bool) find(K); }
 169
 170   /// foreach - A member template the accepts invokes operator() on a functor
 171   ///  object (specifed by Callback) for every node/subtree in the tree.
 172   ///  Nodes are visited using an inorder traversal.
 173   template <typename Callback>
 174   void foreach(Callback& C) {
 175     if (ImutAVLTree* L = getLeft())
 176       L->foreach(C);
 177
 178     C(value);
 179
 180     if (ImutAVLTree* R = getRight())
 181       R->foreach(C);
 182   }
 183
 184   /// validateTree - A utility method that checks that the balancing and
 185   ///  ordering invariants of the tree are satisifed.  It is a recursive
 186   ///  method that returns the height of the tree, which is then consumed
 187   ///  by the enclosing validateTree call.  External callers should ignore the
 188   ///  return value.  An invalid tree will cause an assertion to fire in
 189   ///  a debug build.
 190   unsigned validateTree() const {
 191     unsigned HL = getLeft() ? getLeft()->validateTree() : 0;
 192     unsigned HR = getRight() ? getRight()->validateTree() : 0;
 193     (void) HL;
 194     (void) HR;
 195
 196     assert(getHeight() == ( HL > HR ? HL : HR ) + 1
 197             && "Height calculation wrong");
 198
 199     assert((HL > HR ? HL-HR : HR-HL) <= 2
 200            && "Balancing invariant violated");
 201
 202     assert((!getLeft() ||
 203             ImutInfo::isLess(ImutInfo::KeyOfValue(getLeft()->getValue()),
 204                              ImutInfo::KeyOfValue(getValue()))) &&
 205            "Value in left child is not less that current value");
 206
 207
 208     assert(!(getRight() ||
 209              ImutInfo::isLess(ImutInfo::KeyOfValue(getValue()),
 210                               ImutInfo::KeyOfValue(getRight()->getValue()))) &&
 211            "Current value is not less that value of right child");
 212
 213     return getHeight();
 214   }
 215
 216   //===----------------------------------------------------===//
 217   // Internal values.
 218   //===----------------------------------------------------===//
 219
 220 private:
 221   Factory *factory;
 222   ImutAVLTree *left;
 223   ImutAVLTree *right;
 224   ImutAVLTree *prev;
 225   ImutAVLTree *next;
 226
 227   unsigned height         : 28;
 228   unsigned IsMutable      : 1;
 229   unsigned IsDigestCached : 1;
 230   unsigned IsCanonicalized : 1;
 231
 232   value_type value;
 233   uint32_t digest;
 234   uint32_t refCount;
 235
 236   //===----------------------------------------------------===//
 237   // Internal methods (node manipulation; used by Factory).
 238   //===----------------------------------------------------===//
 239
 240 private:
 241   /// ImutAVLTree - Internal constructor that is only called by
 242   ///   ImutAVLFactory.
 243   ImutAVLTree(Factory *f, ImutAVLTree* l, ImutAVLTree* r, value_type_ref v,
 244               unsigned height)
 245     : factory(f), left(l), right(r), prev(nullptr), next(nullptr),
 246       height(height), IsMutable(true), IsDigestCached(false),
 247       IsCanonicalized(0), value(v), digest(0), refCount(0)
 248   {
 249     if (left) left->retain();
 250     if (right) right->retain();
 251   }
 252
 253   /// isMutable - Returns true if the left and right subtree references
 254   ///  (as well as height) can be changed.  If this method returns false,
 255   ///  the tree is truly immutable.  Trees returned from an ImutAVLFactory
 256   ///  object should always have this method return true.  Further, if this
 257   ///  method returns false for an instance of ImutAVLTree, all subtrees
 258   ///  will also have this method return false.  The converse is not true.
 259   bool isMutable() const { return IsMutable; }
 260
 261   /// hasCachedDigest - Returns true if the digest for this tree is cached.
 262   ///  This can only be true if the tree is immutable.
 263   bool hasCachedDigest() const { return IsDigestCached; }
 264
 265   //===----------------------------------------------------===//
 266   // Mutating operations.  A tree root can be manipulated as
 267   // long as its reference has not "escaped" from internal
 268   // methods of a factory object (see below).  When a tree
 269   // pointer is externally viewable by client code, the
 270   // internal "mutable bit" is cleared to mark the tree
 271   // immutable.  Note that a tree that still has its mutable
 272   // bit set may have children (subtrees) that are themselves
 273   // immutable.
 274   //===----------------------------------------------------===//
 275
 276   /// markImmutable - Clears the mutable flag for a tree.  After this happens,
 277   ///   it is an error to call setLeft(), setRight(), and setHeight().
 278   void markImmutable() {
 279     assert(isMutable() && "Mutable flag already removed.");
 280     IsMutable = false;
 281   }
 282
 283   /// markedCachedDigest - Clears the NoCachedDigest flag for a tree.
 284   void markedCachedDigest() {
 285     assert(!hasCachedDigest() && "NoCachedDigest flag already removed.");
 286     IsDigestCached = true;
 287   }
 288
 289   /// setHeight - Changes the height of the tree.  Used internally by
 290   ///  ImutAVLFactory.
 291   void setHeight(unsigned h) {
 292     assert(isMutable() && "Only a mutable tree can have its height changed.");
 293     height = h;
 294   }
 295
 296   static uint32_t computeDigest(ImutAVLTree *L, ImutAVLTree *R,
 297                                 value_type_ref V) {
 298     uint32_t digest = 0;
 299
 300     if (L)
 301       digest += L->computeDigest();
 302
 303     // Compute digest of stored data.
 304     FoldingSetNodeID ID;
 305     ImutInfo::Profile(ID,V);
 306     digest += ID.ComputeHash();
 307
 308     if (R)
 309       digest += R->computeDigest();
 310
 311     return digest;
 312   }
 313
 314   uint32_t computeDigest() {
 315     // Check the lowest bit to determine if digest has actually been
 316     // pre-computed.
 317     if (hasCachedDigest())
 318       return digest;
 319
 320     uint32_t X = computeDigest(getLeft(), getRight(), getValue());
 321     digest = X;
 322     markedCachedDigest();
 323     return X;
 324   }
 325
 326   //===----------------------------------------------------===//
 327   // Reference count operations.
 328   //===----------------------------------------------------===//
 329
 330 public:
 331   void retain() { ++refCount; }
 332   void release() {
 333     assert(refCount > 0);
 334     if (--refCount == 0)
 335       destroy();
 336   }
 337   void destroy() {
 338     if (left)
 339       left->release();
 340     if (right)
 341       right->release();
 342     if (IsCanonicalized) {
 343       if (next)
 344         next->prev = prev;
 345
 346       if (prev)
 347         prev->next = next;
 348       else
 349         factory->Cache[factory->maskCacheIndex(computeDigest())] = next;
 350     }
 351
 352     // We need to clear the mutability bit in case we are
 353     // destroying the node as part of a sweep in ImutAVLFactory::recoverNodes().
 354     IsMutable = false;
 355     factory->freeNodes.push_back(this);
 356   }
 357 };
 358
 359 //===----------------------------------------------------------------------===//
 360 // Immutable AVL-Tree Factory class.
 361 //===----------------------------------------------------------------------===//
 362
 363 template <typename ImutInfo >
 364 class ImutAVLFactory {
 365   friend class ImutAVLTree<ImutInfo>;
 366   typedef ImutAVLTree<ImutInfo> TreeTy;
 367   typedef typename TreeTy::value_type_ref value_type_ref;
 368   typedef typename TreeTy::key_type_ref   key_type_ref;
 369
 370   typedef DenseMap<unsigned, TreeTy*> CacheTy;
 371
 372   CacheTy Cache;
 373   uintptr_t Allocator;
 374   std::vector<TreeTy*> createdNodes;
 375   std::vector<TreeTy*> freeNodes;
 376
 377   bool ownsAllocator() const {
 378     return Allocator & 0x1 ? false : true;
 379   }
 380
 381   BumpPtrAllocator& getAllocator() const {
 382     return *reinterpret_cast<BumpPtrAllocator*>(Allocator & ~0x1);
 383   }
 384
 385   //===--------------------------------------------------===//
 386   // Public interface.
 387   //===--------------------------------------------------===//
 388
 389 public:
 390   ImutAVLFactory()
 391     : Allocator(reinterpret_cast<uintptr_t>(new BumpPtrAllocator())) {}
 392
 393   ImutAVLFactory(BumpPtrAllocator& Alloc)
 394     : Allocator(reinterpret_cast<uintptr_t>(&Alloc) | 0x1) {}
 395
 396   ~ImutAVLFactory() {
 397     if (ownsAllocator()) delete &getAllocator();
 398   }
 399
 400   TreeTy* add(TreeTy* T, value_type_ref V) {
 401     T = add_internal(V,T);
 402     markImmutable(T);
 403     recoverNodes();
 404     return T;
 405   }
 406
 407   TreeTy* remove(TreeTy* T, key_type_ref V) {
 408     T = remove_internal(V,T);
 409     markImmutable(T);
 410     recoverNodes();
 411     return T;
 412   }
 413
 414   TreeTy* getEmptyTree() const { return nullptr; }
 415
 416 protected:
 417
 418   //===--------------------------------------------------===//
 419   // A bunch of quick helper functions used for reasoning
 420   // about the properties of trees and their children.
 421   // These have succinct names so that the balancing code
 422   // is as terse (and readable) as possible.
 423   //===--------------------------------------------------===//
 424
 425   bool            isEmpty(TreeTy* T) const { return !T; }
 426   unsigned        getHeight(TreeTy* T) const { return T ? T->getHeight() : 0; }
 427   TreeTy*         getLeft(TreeTy* T) const { return T->getLeft(); }
 428   TreeTy*         getRight(TreeTy* T) const { return T->getRight(); }
 429   value_type_ref  getValue(TreeTy* T) const { return T->value; }
 430
 431   // Make sure the index is not the Tombstone or Entry key of the DenseMap.
 432   static unsigned maskCacheIndex(unsigned I) { return (I & ~0x02); }
 433
 434   unsigned incrementHeight(TreeTy* L, TreeTy* R) const {
 435     unsigned hl = getHeight(L);
 436     unsigned hr = getHeight(R);
 437     return (hl > hr ? hl : hr) + 1;
 438   }
 439
 440   static bool compareTreeWithSection(TreeTy* T,
 441                                      typename TreeTy::iterator& TI,
 442                                      typename TreeTy::iterator& TE) {
 443     typename TreeTy::iterator I = T->begin(), E = T->end();
 444     for ( ; I!=E ; ++I, ++TI) {
 445       if (TI == TE || !I->isElementEqual(*TI))
 446         return false;
 447     }
 448     return true;
 449   }
 450
 451   //===--------------------------------------------------===//
 452   // "createNode" is used to generate new tree roots that link
 453   // to other trees.  The functon may also simply move links
 454   // in an existing root if that root is still marked mutable.
 455   // This is necessary because otherwise our balancing code
 456   // would leak memory as it would create nodes that are
 457   // then discarded later before the finished tree is
 458   // returned to the caller.
 459   //===--------------------------------------------------===//
 460
 461   TreeTy* createNode(TreeTy* L, value_type_ref V, TreeTy* R) {
 462     BumpPtrAllocator& A = getAllocator();
 463     TreeTy* T;
 464     if (!freeNodes.empty()) {
 465       T = freeNodes.back();
 466       freeNodes.pop_back();
 467       assert(T != L);
 468       assert(T != R);
 469     } else {
 470       T = (TreeTy*) A.Allocate<TreeTy>();
 471     }
 472     new (T) TreeTy(this, L, R, V, incrementHeight(L,R));
 473     createdNodes.push_back(T);
 474     return T;
 475   }
 476
 477   TreeTy* createNode(TreeTy* newLeft, TreeTy* oldTree, TreeTy* newRight) {
 478     return createNode(newLeft, getValue(oldTree), newRight);
 479   }
 480
 481   void recoverNodes() {
 482     for (unsigned i = 0, n = createdNodes.size(); i < n; ++i) {
 483       TreeTy *N = createdNodes[i];
 484       if (N->isMutable() && N->refCount == 0)
 485         N->destroy();
 486     }
 487     createdNodes.clear();
 488   }
 489
 490   /// balanceTree - Used by add_internal and remove_internal to
 491   ///  balance a newly created tree.
 492   TreeTy* balanceTree(TreeTy* L, value_type_ref V, TreeTy* R) {
 493     unsigned hl = getHeight(L);
 494     unsigned hr = getHeight(R);
 495
 496     if (hl > hr + 2) {
 497       assert(!isEmpty(L) && "Left tree cannot be empty to have a height >= 2");
 498
 499       TreeTy *LL = getLeft(L);
 500       TreeTy *LR = getRight(L);
 501
 502       if (getHeight(LL) >= getHeight(LR))
 503         return createNode(LL, L, createNode(LR,V,R));
 504
 505       assert(!isEmpty(LR) && "LR cannot be empty because it has a height >= 1");
 506
 507       TreeTy *LRL = getLeft(LR);
 508       TreeTy *LRR = getRight(LR);
 509
 510       return createNode(createNode(LL,L,LRL), LR, createNode(LRR,V,R));
 511     }
 512
 513     if (hr > hl + 2) {
 514       assert(!isEmpty(R) && "Right tree cannot be empty to have a height >= 2");
 515
 516       TreeTy *RL = getLeft(R);
 517       TreeTy *RR = getRight(R);
 518
 519       if (getHeight(RR) >= getHeight(RL))
 520         return createNode(createNode(L,V,RL), R, RR);
 521
 522       assert(!isEmpty(RL) && "RL cannot be empty because it has a height >= 1");
 523
 524       TreeTy *RLL = getLeft(RL);
 525       TreeTy *RLR = getRight(RL);
 526
 527       return createNode(createNode(L,V,RLL), RL, createNode(RLR,R,RR));
 528     }
 529
 530     return createNode(L,V,R);
 531   }
 532
 533   /// add_internal - Creates a new tree that includes the specified
 534   ///  data and the data from the original tree.  If the original tree
 535   ///  already contained the data item, the original tree is returned.
 536   TreeTy* add_internal(value_type_ref V, TreeTy* T) {
 537     if (isEmpty(T))
 538       return createNode(T, V, T);
 539     assert(!T->isMutable());
 540
 541     key_type_ref K = ImutInfo::KeyOfValue(V);
 542     key_type_ref KCurrent = ImutInfo::KeyOfValue(getValue(T));
 543
 544     if (ImutInfo::isEqual(K,KCurrent))
 545       return createNode(getLeft(T), V, getRight(T));
 546     else if (ImutInfo::isLess(K,KCurrent))
 547       return balanceTree(add_internal(V, getLeft(T)), getValue(T), getRight(T));
 548     else
 549       return balanceTree(getLeft(T), getValue(T), add_internal(V, getRight(T)));
 550   }
 551
 552   /// remove_internal - Creates a new tree that includes all the data
 553   ///  from the original tree except the specified data.  If the
 554   ///  specified data did not exist in the original tree, the original
 555   ///  tree is returned.
 556   TreeTy* remove_internal(key_type_ref K, TreeTy* T) {
 557     if (isEmpty(T))
 558       return T;
 559
 560     assert(!T->isMutable());
 561
 562     key_type_ref KCurrent = ImutInfo::KeyOfValue(getValue(T));
 563
 564     if (ImutInfo::isEqual(K,KCurrent)) {
 565       return combineTrees(getLeft(T), getRight(T));
 566     } else if (ImutInfo::isLess(K,KCurrent)) {
 567       return balanceTree(remove_internal(K, getLeft(T)),
 568                                             getValue(T), getRight(T));
 569     } else {
 570       return balanceTree(getLeft(T), getValue(T),
 571                          remove_internal(K, getRight(T)));
 572     }
 573   }
 574
 575   TreeTy* combineTrees(TreeTy* L, TreeTy* R) {
 576     if (isEmpty(L))
 577       return R;
 578     if (isEmpty(R))
 579       return L;
 580     TreeTy* OldNode;
 581     TreeTy* newRight = removeMinBinding(R,OldNode);
 582     return balanceTree(L, getValue(OldNode), newRight);
 583   }
 584
 585   TreeTy* removeMinBinding(TreeTy* T, TreeTy*& Noderemoved) {
 586     assert(!isEmpty(T));
 587     if (isEmpty(getLeft(T))) {
 588       Noderemoved = T;
 589       return getRight(T);
 590     }
 591     return balanceTree(removeMinBinding(getLeft(T), Noderemoved),
 592                        getValue(T), getRight(T));
 593   }
 594
 595   /// markImmutable - Clears the mutable bits of a root and all of its
 596   ///  descendants.
 597   void markImmutable(TreeTy* T) {
 598     if (!T || !T->isMutable())
 599       return;
 600     T->markImmutable();
 601     markImmutable(getLeft(T));
 602     markImmutable(getRight(T));
 603   }
 604
 605 public:
 606   TreeTy *getCanonicalTree(TreeTy *TNew) {
 607     if (!TNew)
 608       return nullptr;
 609
 610     if (TNew->IsCanonicalized)
 611       return TNew;
 612
 613     // Search the hashtable for another tree with the same digest, and
 614     // if find a collision compare those trees by their contents.
 615     unsigned digest = TNew->computeDigest();
 616     TreeTy *&entry = Cache[maskCacheIndex(digest)];
 617     do {
 618       if (!entry)
 619         break;
 620       for (TreeTy *T = entry ; T != nullptr; T = T->next) {
 621         // Compare the Contents('T') with Contents('TNew')
 622         typename TreeTy::iterator TI = T->begin(), TE = T->end();
 623         if (!compareTreeWithSection(TNew, TI, TE))
 624           continue;
 625         if (TI != TE)
 626           continue; // T has more contents than TNew.
 627         // Trees did match!  Return 'T'.
 628         if (TNew->refCount == 0)
 629           TNew->destroy();
 630         return T;
 631       }
 632       entry->prev = TNew;
 633       TNew->next = entry;
 634     }
 635     while (false);
 636
 637     entry = TNew;
 638     TNew->IsCanonicalized = true;
 639     return TNew;
 640   }
 641 };
 642
 643 //===----------------------------------------------------------------------===//
 644 // Immutable AVL-Tree Iterators.
 645 //===----------------------------------------------------------------------===//
 646
 647 template <typename ImutInfo>
 648 class ImutAVLTreeGenericIterator {
 649   SmallVector<uintptr_t,20> stack;
 650 public:
 651   enum VisitFlag { VisitedNone=0x0, VisitedLeft=0x1, VisitedRight=0x3,
 652                    Flags=0x3 };
 653
 654   typedef ImutAVLTree<ImutInfo> TreeTy;
 655   typedef ImutAVLTreeGenericIterator<ImutInfo> ImutAVLTreeGenericIterator;
 656
 657   ImutAVLTreeGenericIterator() {}
 658   ImutAVLTreeGenericIterator(const TreeTy *Root) {
 659     if (Root) stack.push_back(reinterpret_cast<uintptr_t>(Root));
 660   }
 661
 662   TreeTy* operator*() const {
 663     assert(!stack.empty());
 664     return reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 665   }
 666
 667   uintptr_t getVisitState() const {
 668     assert(!stack.empty());
 669     return stack.back() & Flags;
 670   }
 671
 672
 673   bool atEnd() const { return stack.empty(); }
 674
 675   bool atBeginning() const {
 676     return stack.size() == 1 && getVisitState() == VisitedNone;
 677   }
 678
 679   void skipToParent() {
 680     assert(!stack.empty());
 681     stack.pop_back();
 682     if (stack.empty())
 683       return;
 684     switch (getVisitState()) {
 685       case VisitedNone:
 686         stack.back() |= VisitedLeft;
 687         break;
 688       case VisitedLeft:
 689         stack.back() |= VisitedRight;
 690         break;
 691       default:
 692         llvm_unreachable("Unreachable.");
 693     }
 694   }
 695
 696   bool operator==(const ImutAVLTreeGenericIterator &x) const {
 697     return stack == x.stack;
 698   }
 699
 700   bool operator!=(const ImutAVLTreeGenericIterator &x) const {
 701     return !(*this == x);
 702   }
 703
 704   ImutAVLTreeGenericIterator &operator++() {
 705     assert(!stack.empty());
 706     TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 707     assert(Current);
 708     switch (getVisitState()) {
 709       case VisitedNone:
 710         if (TreeTy* L = Current->getLeft())
 711           stack.push_back(reinterpret_cast<uintptr_t>(L));
 712         else
 713           stack.back() |= VisitedLeft;
 714         break;
 715       case VisitedLeft:
 716         if (TreeTy* R = Current->getRight())
 717           stack.push_back(reinterpret_cast<uintptr_t>(R));
 718         else
 719           stack.back() |= VisitedRight;
 720         break;
 721       case VisitedRight:
 722         skipToParent();
 723         break;
 724       default:
 725         llvm_unreachable("Unreachable.");
 726     }
 727     return *this;
 728   }
 729
 730   ImutAVLTreeGenericIterator &operator--() {
 731     assert(!stack.empty());
 732     TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 733     assert(Current);
 734     switch (getVisitState()) {
 735       case VisitedNone:
 736         stack.pop_back();
 737         break;
 738       case VisitedLeft:
 739         stack.back() &= ~Flags; // Set state to "VisitedNone."
 740         if (TreeTy* L = Current->getLeft())
 741           stack.push_back(reinterpret_cast<uintptr_t>(L) | VisitedRight);
 742         break;
 743       case VisitedRight:
 744         stack.back() &= ~Flags;
 745         stack.back() |= VisitedLeft;
 746         if (TreeTy* R = Current->getRight())
 747           stack.push_back(reinterpret_cast<uintptr_t>(R) | VisitedRight);
 748         break;
 749       default:
 750         llvm_unreachable("Unreachable.");
 751     }
 752     return *this;
 753   }
 754 };
 755
 756 template <typename ImutInfo>
 757 class ImutAVLTreeInOrderIterator {
 758   typedef ImutAVLTreeGenericIterator<ImutInfo> InternalIteratorTy;
 759   InternalIteratorTy InternalItr;
 760
 761 public:
 762   typedef ImutAVLTree<ImutInfo> TreeTy;
 763   typedef ImutAVLTreeInOrderIterator<ImutInfo> ImutAVLTreeGenericIterator;
 764
 765   ImutAVLTreeInOrderIterator(const TreeTy* Root) : InternalItr(Root) {
 766     if (Root)
 767       ++*this; // Advance to first element.
 768   }
 769
 770   ImutAVLTreeInOrderIterator() : InternalItr() {}
 771
 772   bool operator==(const ImutAVLTreeGenericIterator &x) const {
 773     return InternalItr == x.InternalItr;
 774   }
 775
 776   bool operator!=(const ImutAVLTreeGenericIterator &x) const {
 777     return !(*this == x);
 778   }
 779
 780   TreeTy *operator*() const { return *InternalItr; }
 781   TreeTy *operator->() const { return *InternalItr; }
 782
 783   ImutAVLTreeGenericIterator &operator++() {
 784     do ++InternalItr;
 785     while (!InternalItr.atEnd() &&
 786            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
 787
 788     return *this;
 789   }
 790
 791   ImutAVLTreeGenericIterator &operator--() {
 792     do --InternalItr;
 793     while (!InternalItr.atBeginning() &&
 794            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
 795
 796     return *this;
 797   }
 798
 799   void skipSubTree() {
 800     InternalItr.skipToParent();
 801
 802     while (!InternalItr.atEnd() &&
 803            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft)
 804       ++InternalItr;
 805   }
 806 };
 807
 808 //===----------------------------------------------------------------------===//
 809 // Trait classes for Profile information.
 810 //===----------------------------------------------------------------------===//
 811
 812 /// Generic profile template.  The default behavior is to invoke the
 813 /// profile method of an object.  Specializations for primitive integers
 814 /// and generic handling of pointers is done below.
 815 template <typename T>
 816 struct ImutProfileInfo {
 817   typedef const T  value_type;
 818   typedef const T& value_type_ref;
 819
 820   static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
 821     FoldingSetTrait<T>::Profile(X,ID);
 822   }
 823 };
 824
 825 /// Profile traits for integers.
 826 template <typename T>
 827 struct ImutProfileInteger {
 828   typedef const T  value_type;
 829   typedef const T& value_type_ref;
 830
 831   static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
 832     ID.AddInteger(X);
 833   }
 834 };
 835
 836 #define PROFILE_INTEGER_INFO(X)\
 837 template<> struct ImutProfileInfo<X> : ImutProfileInteger<X> {};
 838
 839 PROFILE_INTEGER_INFO(char)
 840 PROFILE_INTEGER_INFO(unsigned char)
 841 PROFILE_INTEGER_INFO(short)
 842 PROFILE_INTEGER_INFO(unsigned short)
 843 PROFILE_INTEGER_INFO(unsigned)
 844 PROFILE_INTEGER_INFO(signed)
 845 PROFILE_INTEGER_INFO(long)
 846 PROFILE_INTEGER_INFO(unsigned long)
 847 PROFILE_INTEGER_INFO(long long)
 848 PROFILE_INTEGER_INFO(unsigned long long)
 849
 850 #undef PROFILE_INTEGER_INFO
 851
 852 /// Profile traits for booleans.
 853 template <>
 854 struct ImutProfileInfo<bool> {
 855   typedef const bool  value_type;
 856   typedef const bool& value_type_ref;
 857
 858   static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
 859     ID.AddBoolean(X);
 860   }
 861 };
 862
 863
 864 /// Generic profile trait for pointer types.  We treat pointers as
 865 /// references to unique objects.
 866 template <typename T>
 867 struct ImutProfileInfo<T*> {
 868   typedef const T*   value_type;
 869   typedef value_type value_type_ref;
 870
 871   static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
 872     ID.AddPointer(X);
 873   }
 874 };
 875
 876 //===----------------------------------------------------------------------===//
 877 // Trait classes that contain element comparison operators and type
 878 //  definitions used by ImutAVLTree, ImmutableSet, and ImmutableMap.  These
 879 //  inherit from the profile traits (ImutProfileInfo) to include operations
 880 //  for element profiling.
 881 //===----------------------------------------------------------------------===//
 882
 883
 884 /// ImutContainerInfo - Generic definition of comparison operations for
 885 ///   elements of immutable containers that defaults to using
 886 ///   std::equal_to<> and std::less<> to perform comparison of elements.
 887 template <typename T>
 888 struct ImutContainerInfo : public ImutProfileInfo<T> {
 889   typedef typename ImutProfileInfo<T>::value_type      value_type;
 890   typedef typename ImutProfileInfo<T>::value_type_ref  value_type_ref;
 891   typedef value_type      key_type;
 892   typedef value_type_ref  key_type_ref;
 893   typedef bool            data_type;
 894   typedef bool            data_type_ref;
 895
 896   static key_type_ref KeyOfValue(value_type_ref D) { return D; }
 897   static data_type_ref DataOfValue(value_type_ref) { return true; }
 898
 899   static bool isEqual(key_type_ref LHS, key_type_ref RHS) {
 900     return std::equal_to<key_type>()(LHS,RHS);
 901   }
 902
 903   static bool isLess(key_type_ref LHS, key_type_ref RHS) {
 904     return std::less<key_type>()(LHS,RHS);
 905   }
 906
 907   static bool isDataEqual(data_type_ref, data_type_ref) { return true; }
 908 };
 909
 910 /// ImutContainerInfo - Specialization for pointer values to treat pointers
 911 ///  as references to unique objects.  Pointers are thus compared by
 912 ///  their addresses.
 913 template <typename T>
 914 struct ImutContainerInfo<T*> : public ImutProfileInfo<T*> {
 915   typedef typename ImutProfileInfo<T*>::value_type      value_type;
 916   typedef typename ImutProfileInfo<T*>::value_type_ref  value_type_ref;
 917   typedef value_type      key_type;
 918   typedef value_type_ref  key_type_ref;
 919   typedef bool            data_type;
 920   typedef bool            data_type_ref;
 921
 922   static key_type_ref KeyOfValue(value_type_ref D) { return D; }
 923   static data_type_ref DataOfValue(value_type_ref) { return true; }
 924
 925   static bool isEqual(key_type_ref LHS, key_type_ref RHS) { return LHS == RHS; }
 926
 927   static bool isLess(key_type_ref LHS, key_type_ref RHS) { return LHS < RHS; }
 928
 929   static bool isDataEqual(data_type_ref, data_type_ref) { return true; }
 930 };
 931
 932 //===----------------------------------------------------------------------===//
 933 // Immutable Set
 934 //===----------------------------------------------------------------------===//
 935
 936 template <typename ValT, typename ValInfo = ImutContainerInfo<ValT> >
 937 class ImmutableSet {
 938 public:
 939   typedef typename ValInfo::value_type      value_type;
 940   typedef typename ValInfo::value_type_ref  value_type_ref;
 941   typedef ImutAVLTree<ValInfo> TreeTy;
 942
 943 private:
 944   TreeTy *Root;
 945
 946 public:
 947   /// Constructs a set from a pointer to a tree root.  In general one
 948   /// should use a Factory object to create sets instead of directly
 949   /// invoking the constructor, but there are cases where make this
 950   /// constructor public is useful.
 951   explicit ImmutableSet(TreeTy* R) : Root(R) {
 952     if (Root) { Root->retain(); }
 953   }
 954   ImmutableSet(const ImmutableSet &X) : Root(X.Root) {
 955     if (Root) { Root->retain(); }
 956   }
 957   ImmutableSet &operator=(const ImmutableSet &X) {
 958     if (Root != X.Root) {
 959       if (X.Root) { X.Root->retain(); }
 960       if (Root) { Root->release(); }
 961       Root = X.Root;
 962     }
 963     return *this;
 964   }
 965   ~ImmutableSet() {
 966     if (Root) { Root->release(); }
 967   }
 968
 969   class Factory {
 970     typename TreeTy::Factory F;
 971     const bool Canonicalize;
 972
 973   public:
 974     Factory(bool canonicalize = true)
 975       : Canonicalize(canonicalize) {}
 976
 977     Factory(BumpPtrAllocator& Alloc, bool canonicalize = true)
 978       : F(Alloc), Canonicalize(canonicalize) {}
 979
 980     /// getEmptySet - Returns an immutable set that contains no elements.
 981     ImmutableSet getEmptySet() {
 982       return ImmutableSet(F.getEmptyTree());
 983     }
 984
 985     /// add - Creates a new immutable set that contains all of the values
 986     ///  of the original set with the addition of the specified value.  If
 987     ///  the original set already included the value, then the original set is
 988     ///  returned and no memory is allocated.  The time and space complexity
 989     ///  of this operation is logarithmic in the size of the original set.
 990     ///  The memory allocated to represent the set is released when the
 991     ///  factory object that created the set is destroyed.
 992     ImmutableSet add(ImmutableSet Old, value_type_ref V) {
 993       TreeTy *NewT = F.add(Old.Root, V);
 994       return ImmutableSet(Canonicalize ? F.getCanonicalTree(NewT) : NewT);
 995     }
 996
 997     /// remove - Creates a new immutable set that contains all of the values
 998     ///  of the original set with the exception of the specified value.  If
 999     ///  the original set did not contain the value, the original set is
1000     ///  returned and no memory is allocated.  The time and space complexity
1001     ///  of this operation is logarithmic in the size of the original set.
1002     ///  The memory allocated to represent the set is released when the
1003     ///  factory object that created the set is destroyed.
1004     ImmutableSet remove(ImmutableSet Old, value_type_ref V) {
1005       TreeTy *NewT = F.remove(Old.Root, V);
1006       return ImmutableSet(Canonicalize ? F.getCanonicalTree(NewT) : NewT);
1007     }
1008
1009     BumpPtrAllocator& getAllocator() { return F.getAllocator(); }
1010
1011     typename TreeTy::Factory *getTreeFactory() const {
1012       return const_cast<typename TreeTy::Factory *>(&F);
1013     }
1014
1015   private:
1016     Factory(const Factory& RHS) = delete;
1017     void operator=(const Factory& RHS) = delete;
1018   };
1019
1020   friend class Factory;
1021
1022   /// Returns true if the set contains the specified value.
1023   bool contains(value_type_ref V) const {
1024     return Root ? Root->contains(V) : false;
1025   }
1026
1027   bool operator==(const ImmutableSet &RHS) const {
1028     return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
1029   }
1030
1031   bool operator!=(const ImmutableSet &RHS) const {
1032     return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
1033   }
1034
1035   TreeTy *getRoot() {
1036     if (Root) { Root->retain(); }
1037     return Root;
1038   }
1039
1040   TreeTy *getRootWithoutRetain() const {
1041     return Root;
1042   }
1043
1044   /// isEmpty - Return true if the set contains no elements.
1045   bool isEmpty() const { return !Root; }
1046
1047   /// isSingleton - Return true if the set contains exactly one element.
1048   ///   This method runs in constant time.
1049   bool isSingleton() const { return getHeight() == 1; }
1050
1051   template <typename Callback>
1052   void foreach(Callback& C) { if (Root) Root->foreach(C); }
1053
1054   template <typename Callback>
1055   void foreach() { if (Root) { Callback C; Root->foreach(C); } }
1056
1057   //===--------------------------------------------------===//
1058   // Iterators.
1059   //===--------------------------------------------------===//
1060
1061   class iterator {
1062     typename TreeTy::iterator itr;
1063
1064     iterator() {}
1065     iterator(TreeTy* t) : itr(t) {}
1066     friend class ImmutableSet<ValT,ValInfo>;
1067
1068   public:
1069     typedef ptrdiff_t difference_type;
1070     typedef typename ImmutableSet<ValT,ValInfo>::value_type value_type;
1071     typedef typename ImmutableSet<ValT,ValInfo>::value_type_ref reference;
1072     typedef typename iterator::value_type *pointer;
1073     typedef std::bidirectional_iterator_tag iterator_category;
1074
1075     typename iterator::reference operator*() const { return itr->getValue(); }
1076     typename iterator::pointer operator->() const { return &**this; }
1077
1078     iterator& operator++() { ++itr; return *this; }
1079     iterator  operator++(int) { iterator tmp(*this); ++itr; return tmp; }
1080     iterator& operator--() { --itr; return *this; }
1081     iterator  operator--(int) { iterator tmp(*this); --itr; return tmp; }
1082
1083     bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
1084     bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
1085   };
1086
1087   iterator begin() const { return iterator(Root); }
1088   iterator end() const { return iterator(); }
1089
1090   //===--------------------------------------------------===//
1091   // Utility methods.
1092   //===--------------------------------------------------===//
1093
1094   unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
1095
1096   static void Profile(FoldingSetNodeID &ID, const ImmutableSet &S) {
1097     ID.AddPointer(S.Root);
1098   }
1099
1100   void Profile(FoldingSetNodeID &ID) const { return Profile(ID, *this); }
1101
1102   //===--------------------------------------------------===//
1103   // For testing.
1104   //===--------------------------------------------------===//
1105
1106   void validateTree() const { if (Root) Root->validateTree(); }
1107 };
1108
1109 // NOTE: This may some day replace the current ImmutableSet.
1110 template <typename ValT, typename ValInfo = ImutContainerInfo<ValT> >
1111 class ImmutableSetRef {
1112 public:
1113   typedef typename ValInfo::value_type      value_type;
1114   typedef typename ValInfo::value_type_ref  value_type_ref;
1115   typedef ImutAVLTree<ValInfo> TreeTy;
1116   typedef typename TreeTy::Factory          FactoryTy;
1117
1118 private:
1119   TreeTy *Root;
1120   FactoryTy *Factory;
1121
1122 public:
1123   /// Constructs a set from a pointer to a tree root.  In general one
1124   /// should use a Factory object to create sets instead of directly
1125   /// invoking the constructor, but there are cases where make this
1126   /// constructor public is useful.
1127   explicit ImmutableSetRef(TreeTy* R, FactoryTy *F)
1128     : Root(R),
1129       Factory(F) {
1130     if (Root) { Root->retain(); }
1131   }
1132   ImmutableSetRef(const ImmutableSetRef &X)
1133     : Root(X.Root),
1134       Factory(X.Factory) {
1135     if (Root) { Root->retain(); }
1136   }
1137   ImmutableSetRef &operator=(const ImmutableSetRef &X) {
1138     if (Root != X.Root) {
1139       if (X.Root) { X.Root->retain(); }
1140       if (Root) { Root->release(); }
1141       Root = X.Root;
1142       Factory = X.Factory;
1143     }
1144     return *this;
1145   }
1146   ~ImmutableSetRef() {
1147     if (Root) { Root->release(); }
1148   }
1149
1150   static ImmutableSetRef getEmptySet(FactoryTy *F) {
1151     return ImmutableSetRef(0, F);
1152   }
1153
1154   ImmutableSetRef add(value_type_ref V) {
1155     return ImmutableSetRef(Factory->add(Root, V), Factory);
1156   }
1157
1158   ImmutableSetRef remove(value_type_ref V) {
1159     return ImmutableSetRef(Factory->remove(Root, V), Factory);
1160   }
1161
1162   /// Returns true if the set contains the specified value.
1163   bool contains(value_type_ref V) const {
1164     return Root ? Root->contains(V) : false;
1165   }
1166
1167   ImmutableSet<ValT> asImmutableSet(bool canonicalize = true) const {
1168     return ImmutableSet<ValT>(canonicalize ?
1169                               Factory->getCanonicalTree(Root) : Root);
1170   }
1171
1172   TreeTy *getRootWithoutRetain() const {
1173     return Root;
1174   }
1175
1176   bool operator==(const ImmutableSetRef &RHS) const {
1177     return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
1178   }
1179
1180   bool operator!=(const ImmutableSetRef &RHS) const {
1181     return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
1182   }
1183
1184   /// isEmpty - Return true if the set contains no elements.
1185   bool isEmpty() const { return !Root; }
1186
1187   /// isSingleton - Return true if the set contains exactly one element.
1188   ///   This method runs in constant time.
1189   bool isSingleton() const { return getHeight() == 1; }
1190
1191   //===--------------------------------------------------===//
1192   // Iterators.
1193   //===--------------------------------------------------===//
1194
1195   class iterator {
1196     typename TreeTy::iterator itr;
1197     iterator(TreeTy* t) : itr(t) {}
1198     friend class ImmutableSetRef<ValT,ValInfo>;
1199   public:
1200     iterator() {}
1201     value_type_ref operator*() const { return itr->getValue(); }
1202     iterator &operator++() {
1203       ++itr;
1204       return *this;
1205     }
1206     iterator operator++(int) {
1207       iterator tmp(*this);
1208       ++itr;
1209       return tmp;
1210     }
1211     iterator &operator--() {
1212       --itr;
1213       return *this;
1214     }
1215     iterator operator--(int) {
1216       iterator tmp(*this);
1217       --itr;
1218       return tmp;
1219     }
1220     bool operator==(const iterator &RHS) const { return RHS.itr == itr; }
1221     bool operator!=(const iterator &RHS) const { return RHS.itr != itr; }
1222     value_type *operator->() const { return &**this; }
1223   };
1224
1225   iterator begin() const { return iterator(Root); }
1226   iterator end() const { return iterator(); }
1227
1228   //===--------------------------------------------------===//
1229   // Utility methods.
1230   //===--------------------------------------------------===//
1231
1232   unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
1233
1234   static void Profile(FoldingSetNodeID &ID, const ImmutableSetRef &S) {
1235     ID.AddPointer(S.Root);
1236   }
1237
1238   void Profile(FoldingSetNodeID &ID) const { return Profile(ID, *this); }
1239
1240   //===--------------------------------------------------===//
1241   // For testing.
1242   //===--------------------------------------------------===//
1243
1244   void validateTree() const { if (Root) Root->validateTree(); }
1245 };
1246
1247 } // end namespace llvm
1248
1249 #endif