lib/Support/SmallPtrSet.cpp

   1 //===- llvm/ADT/SmallPtrSet.cpp - 'Normally small' pointer set ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner 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 SmallPtrSet class.  See SmallPtrSet.h for an
  11 // overview of the algorithm.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/ADT/SmallPtrSet.h"
  16 #include "llvm/Support/MathExtras.h"
  17 #include <cstdlib>
  18
  19 using namespace llvm;
  20
  21 bool SmallPtrSetImpl::insert(void *Ptr) {
  22   if (isSmall()) {
  23     // Check to see if it is already in the set.
  24     for (void **APtr = SmallArray, **E = SmallArray+NumElements;
  25          APtr != E; ++APtr)
  26       if (*APtr == Ptr)
  27         return false;
  28
  29     // Nope, there isn't.  If we stay small, just 'pushback' now.
  30     if (NumElements < CurArraySize-1) {
  31       SmallArray[NumElements++] = Ptr;
  32       return true;
  33     }
  34     // Otherwise, hit the big set case, which will call grow.
  35   }
  36
  37   // If more than 3/4 of the array is full, grow.
  38   if (NumElements*4 >= CurArraySize*3 ||
  39       CurArraySize-(NumElements+NumTombstones) < CurArraySize/8)
  40     Grow();
  41
  42   // Okay, we know we have space.  Find a hash bucket.
  43   void **Bucket = const_cast<void**>(FindBucketFor(Ptr));
  44   if (*Bucket == Ptr) return false; // Already inserted, good.
  45
  46   // Otherwise, insert it!
  47   if (*Bucket == getTombstoneMarker())
  48     --NumTombstones;
  49   *Bucket = Ptr;
  50   ++NumElements;  // Track density.
  51   return true;
  52 }
  53
  54 bool SmallPtrSetImpl::erase(void *Ptr) {
  55   if (isSmall()) {
  56     // Check to see if it is in the set.
  57     for (void **APtr = SmallArray, **E = SmallArray+NumElements;
  58          APtr != E; ++APtr)
  59       if (*APtr == Ptr) {
  60         // If it is in the set, replace this element.
  61         *APtr = E[-1];
  62         E[-1] = getEmptyMarker();
  63         --NumElements;
  64         return true;
  65       }
  66
  67     return false;
  68   }
  69
  70   // Okay, we know we have space.  Find a hash bucket.
  71   void **Bucket = const_cast<void**>(FindBucketFor(Ptr));
  72   if (*Bucket != Ptr) return false;  // Not in the set?
  73
  74   // Set this as a tombstone.
  75   *Bucket = getTombstoneMarker();
  76   --NumElements;
  77   ++NumTombstones;
  78   return true;
  79 }
  80
  81 void * const *SmallPtrSetImpl::FindBucketFor(void *Ptr) const {
  82   unsigned Bucket = Hash(Ptr);
  83   unsigned ArraySize = CurArraySize;
  84   unsigned ProbeAmt = 1;
  85   void *const *Array = CurArray;
  86   void *const *Tombstone = 0;
  87   while (1) {
  88     // Found Ptr's bucket?
  89     if (Array[Bucket] == Ptr)
  90       return Array+Bucket;
  91
  92     // If we found an empty bucket, the pointer doesn't exist in the set.
  93     // Return a tombstone if we've seen one so far, or the empty bucket if
  94     // not.
  95     if (Array[Bucket] == getEmptyMarker())
  96       return Tombstone ? Tombstone : Array+Bucket;
  97
  98     // If this is a tombstone, remember it.  If Ptr ends up not in the set, we
  99     // prefer to return it than something that would require more probing.
 100     if (Array[Bucket] == getTombstoneMarker() && !Tombstone)
 101       Tombstone = Array+Bucket;  // Remember the first tombstone found.
 102
 103     // It's a hash collision or a tombstone. Reprobe.
 104     Bucket = (Bucket + ProbeAmt++) & (ArraySize-1);
 105   }
 106 }
 107
 108 /// Grow - Allocate a larger backing store for the buckets and move it over.
 109 ///
 110 void SmallPtrSetImpl::Grow() {
 111   // Allocate at twice as many buckets, but at least 128.
 112   unsigned OldSize = CurArraySize;
 113   unsigned NewSize = OldSize < 64 ? 128 : OldSize*2;
 114
 115   void **OldBuckets = CurArray;
 116   bool WasSmall = isSmall();
 117
 118   // Install the new array.  Clear all the buckets to empty.
 119   CurArray = (void**)malloc(sizeof(void*) * (NewSize+1));
 120   assert(CurArray && "Failed to allocate memory?");
 121   CurArraySize = NewSize;
 122   memset(CurArray, -1, NewSize*sizeof(void*));
 123
 124   // The end pointer, always valid, is set to a valid element to help the
 125   // iterator.
 126   CurArray[NewSize] = 0;
 127
 128   // Copy over all the elements.
 129   if (WasSmall) {
 130     // Small sets store their elements in order.
 131     for (void **BucketPtr = OldBuckets, **E = OldBuckets+NumElements;
 132          BucketPtr != E; ++BucketPtr) {
 133       void *Elt = *BucketPtr;
 134       *const_cast<void**>(FindBucketFor(Elt)) = Elt;
 135     }
 136   } else {
 137     // Copy over all valid entries.
 138     for (void **BucketPtr = OldBuckets, **E = OldBuckets+OldSize;
 139          BucketPtr != E; ++BucketPtr) {
 140       // Copy over the element if it is valid.
 141       void *Elt = *BucketPtr;
 142       if (Elt != getTombstoneMarker() && Elt != getEmptyMarker())
 143         *const_cast<void**>(FindBucketFor(Elt)) = Elt;
 144     }
 145
 146     free(OldBuckets);
 147     NumTombstones = 0;
 148   }
 149 }
 150
 151 SmallPtrSetImpl::SmallPtrSetImpl(const SmallPtrSetImpl& that) {
 152   NumElements = that.NumElements;
 153   NumTombstones = 0;
 154   if (that.isSmall()) {
 155     CurArraySize = that.CurArraySize;
 156     CurArray = &SmallArray[0];
 157     // Copy the entire contents of the array, including the -1's and the null
 158     // terminator.
 159     memcpy(CurArray, that.CurArray, sizeof(void*)*(CurArraySize+1));
 160   } else {
 161     CurArraySize = that.NumElements < 64 ? 128 : that.CurArraySize*2;
 162     CurArray = (void**)malloc(sizeof(void*) * (CurArraySize+1));
 163     assert(CurArray && "Failed to allocate memory?");
 164     memset(CurArray, -1, CurArraySize*sizeof(void*));
 165
 166     // The end pointer, always valid, is set to a valid element to help the
 167     // iterator.
 168     CurArray[CurArraySize] = 0;
 169
 170     // Copy over all valid entries.
 171     for (void **BucketPtr = that.CurArray, **E = that.CurArray+that.CurArraySize;
 172          BucketPtr != E; ++BucketPtr) {
 173       // Copy over the element if it is valid.
 174       void *Elt = *BucketPtr;
 175       if (Elt != getTombstoneMarker() && Elt != getEmptyMarker())
 176         *const_cast<void**>(FindBucketFor(Elt)) = Elt;
 177     }
 178   }
 179 }
 180
 181 /// CopyFrom - implement operator= from a smallptrset that has the same pointer
 182 /// type, but may have a different small size.
 183 void SmallPtrSetImpl::CopyFrom(const SmallPtrSetImpl &RHS) {
 184   if (isSmall() && RHS.isSmall())
 185     assert(CurArraySize == RHS.CurArraySize &&
 186            "Cannot assign sets with different small sizes");
 187
 188   // If we're becoming small, prepare to insert into our stack space
 189   if (RHS.isSmall()) {
 190     if (!isSmall())
 191       free(CurArray);
 192     CurArray = &SmallArray[0];
 193   // Otherwise, allocate new heap space (unless we were the same size)
 194   } else if (CurArraySize != RHS.CurArraySize) {
 195     if (isSmall())
 196       CurArray = (void**)malloc(sizeof(void*) * (RHS.CurArraySize+1));
 197     else
 198       CurArray = (void**)realloc(CurArray, sizeof(void*)*(RHS.CurArraySize+1));
 199     assert(CurArray && "Failed to allocate memory?");
 200   }
 201
 202   // Copy over the new array size
 203   CurArraySize = RHS.CurArraySize;
 204
 205   // Copy over the contents from the other set
 206   memcpy(CurArray, RHS.CurArray, sizeof(void*)*(CurArraySize+1));
 207
 208   NumElements = RHS.NumElements;
 209   NumTombstones = RHS.NumTombstones;
 210 }
 211
 212 SmallPtrSetImpl::~SmallPtrSetImpl() {
 213   if (!isSmall())
 214     free(CurArray);
 215 }