folly/AtomicHashArray-inl.h

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_ATOMICHASHARRAY_H_
  18 #error "This should only be included by AtomicHashArray.h"
  19 #endif
  20
  21 #include <folly/Bits.h>
  22 #include <folly/detail/AtomicHashUtils.h>
  23
  24 namespace folly {
  25
  26 // AtomicHashArray private constructor --
  27 template <class KeyT, class ValueT,
  28           class HashFcn, class EqualFcn, class Allocator>
  29 AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
  30 AtomicHashArray(size_t capacity, KeyT emptyKey, KeyT lockedKey,
  31                 KeyT erasedKey, double _maxLoadFactor, size_t cacheSize)
  32     : capacity_(capacity),
  33       maxEntries_(size_t(_maxLoadFactor * capacity_ + 0.5)),
  34       kEmptyKey_(emptyKey), kLockedKey_(lockedKey), kErasedKey_(erasedKey),
  35       kAnchorMask_(nextPowTwo(capacity_) - 1), numEntries_(0, cacheSize),
  36       numPendingEntries_(0, cacheSize), isFull_(0), numErases_(0) {
  37 }
  38
  39 /*
  40  * findInternal --
  41  *
  42  *   Sets ret.second to value found and ret.index to index
  43  *   of key and returns true, or if key does not exist returns false and
  44  *   ret.index is set to capacity_.
  45  */
  46 template <class KeyT, class ValueT,
  47           class HashFcn, class EqualFcn, class Allocator>
  48 typename AtomicHashArray<KeyT, ValueT,
  49          HashFcn, EqualFcn, Allocator>::SimpleRetT
  50 AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
  51 findInternal(const KeyT key_in) {
  52   DCHECK_NE(key_in, kEmptyKey_);
  53   DCHECK_NE(key_in, kLockedKey_);
  54   DCHECK_NE(key_in, kErasedKey_);
  55   for (size_t idx = keyToAnchorIdx(key_in), numProbes = 0;
  56        ;
  57        idx = probeNext(idx, numProbes)) {
  58     const KeyT key = acquireLoadKey(cells_[idx]);
  59     if (LIKELY(EqualFcn()(key, key_in))) {
  60       return SimpleRetT(idx, true);
  61     }
  62     if (UNLIKELY(key == kEmptyKey_)) {
  63       // if we hit an empty element, this key does not exist
  64       return SimpleRetT(capacity_, false);
  65     }
  66     ++numProbes;
  67     if (UNLIKELY(numProbes >= capacity_)) {
  68       // probed every cell...fail
  69       return SimpleRetT(capacity_, false);
  70     }
  71   }
  72 }
  73
  74 /*
  75  * insertInternal --
  76  *
  77  *   Returns false on failure due to key collision or full.
  78  *   Also sets ret.index to the index of the key.  If the map is full, sets
  79  *   ret.index = capacity_.  Also sets ret.second to cell value, thus if insert
  80  *   successful this will be what we just inserted, if there is a key collision
  81  *   this will be the previously inserted value, and if the map is full it is
  82  *   default.
  83  */
  84 template <class KeyT, class ValueT,
  85           class HashFcn, class EqualFcn, class Allocator>
  86 template <class T>
  87 typename AtomicHashArray<KeyT, ValueT,
  88          HashFcn, EqualFcn, Allocator>::SimpleRetT
  89 AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
  90 insertInternal(KeyT key_in, T&& value) {
  91   const short NO_NEW_INSERTS = 1;
  92   const short NO_PENDING_INSERTS = 2;
  93   CHECK_NE(key_in, kEmptyKey_);
  94   CHECK_NE(key_in, kLockedKey_);
  95   CHECK_NE(key_in, kErasedKey_);
  96
  97   size_t idx = keyToAnchorIdx(key_in);
  98   size_t numProbes = 0;
  99   for (;;) {
 100     DCHECK_LT(idx, capacity_);
 101     value_type* cell = &cells_[idx];
 102     if (relaxedLoadKey(*cell) == kEmptyKey_) {
 103       // NOTE: isFull_ is set based on numEntries_.readFast(), so it's
 104       // possible to insert more than maxEntries_ entries. However, it's not
 105       // possible to insert past capacity_.
 106       ++numPendingEntries_;
 107       if (isFull_.load(std::memory_order_acquire)) {
 108         --numPendingEntries_;
 109
 110         // Before deciding whether this insert succeeded, this thread needs to
 111         // wait until no other thread can add a new entry.
 112
 113         // Correctness assumes isFull_ is true at this point. If
 114         // another thread now does ++numPendingEntries_, we expect it
 115         // to pass the isFull_.load() test above. (It shouldn't insert
 116         // a new entry.)
 117         detail::atomic_hash_spin_wait([&] {
 118           return
 119             (isFull_.load(std::memory_order_acquire) != NO_PENDING_INSERTS) &&
 120             (numPendingEntries_.readFull() != 0);
 121         });
 122         isFull_.store(NO_PENDING_INSERTS, std::memory_order_release);
 123
 124         if (relaxedLoadKey(*cell) == kEmptyKey_) {
 125           // Don't insert past max load factor
 126           return SimpleRetT(capacity_, false);
 127         }
 128       } else {
 129         // An unallocated cell. Try once to lock it. If we succeed, insert here.
 130         // If we fail, fall through to comparison below; maybe the insert that
 131         // just beat us was for this very key....
 132         if (tryLockCell(cell)) {
 133           // Write the value - done before unlocking
 134           try {
 135             DCHECK(relaxedLoadKey(*cell) == kLockedKey_);
 136             /*
 137              * This happens using the copy constructor because we won't have
 138              * constructed a lhs to use an assignment operator on when
 139              * values are being set.
 140              */
 141             new (&cell->second) ValueT(std::forward<T>(value));
 142             unlockCell(cell, key_in); // Sets the new key
 143           } catch (...) {
 144             // Transition back to empty key---requires handling
 145             // locked->empty below.
 146             unlockCell(cell, kEmptyKey_);
 147             --numPendingEntries_;
 148             throw;
 149           }
 150           // Direct comparison rather than EqualFcn ok here
 151           // (we just inserted it)
 152           DCHECK(relaxedLoadKey(*cell) == key_in);
 153           --numPendingEntries_;
 154           ++numEntries_;  // This is a thread cached atomic increment :)
 155           if (numEntries_.readFast() >= maxEntries_) {
 156             isFull_.store(NO_NEW_INSERTS, std::memory_order_relaxed);
 157           }
 158           return SimpleRetT(idx, true);
 159         }
 160         --numPendingEntries_;
 161       }
 162     }
 163     DCHECK(relaxedLoadKey(*cell) != kEmptyKey_);
 164     if (kLockedKey_ == acquireLoadKey(*cell)) {
 165       detail::atomic_hash_spin_wait([&] {
 166         return kLockedKey_ == acquireLoadKey(*cell);
 167       });
 168     }
 169
 170     const KeyT thisKey = acquireLoadKey(*cell);
 171     if (EqualFcn()(thisKey, key_in)) {
 172       // Found an existing entry for our key, but we don't overwrite the
 173       // previous value.
 174       return SimpleRetT(idx, false);
 175     } else if (thisKey == kEmptyKey_ || thisKey == kLockedKey_) {
 176       // We need to try again (i.e., don't increment numProbes or
 177       // advance idx): this case can happen if the constructor for
 178       // ValueT threw for this very cell (the rethrow block above).
 179       continue;
 180     }
 181
 182     ++numProbes;
 183     if (UNLIKELY(numProbes >= capacity_)) {
 184       // probed every cell...fail
 185       return SimpleRetT(capacity_, false);
 186     }
 187
 188     idx = probeNext(idx, numProbes);
 189   }
 190 }
 191
 192
 193 /*
 194  * erase --
 195  *
 196  *   This will attempt to erase the given key key_in if the key is found. It
 197  *   returns 1 iff the key was located and marked as erased, and 0 otherwise.
 198  *
 199  *   Memory is not freed or reclaimed by erase, i.e. the cell containing the
 200  *   erased key will never be reused. If there's an associated value, we won't
 201  *   touch it either.
 202  */
 203 template <class KeyT, class ValueT,
 204           class HashFcn, class EqualFcn, class Allocator>
 205 size_t AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
 206 erase(KeyT key_in) {
 207   CHECK_NE(key_in, kEmptyKey_);
 208   CHECK_NE(key_in, kLockedKey_);
 209   CHECK_NE(key_in, kErasedKey_);
 210   for (size_t idx = keyToAnchorIdx(key_in), numProbes = 0;
 211        ;
 212        idx = probeNext(idx, numProbes)) {
 213     DCHECK_LT(idx, capacity_);
 214     value_type* cell = &cells_[idx];
 215     KeyT currentKey = acquireLoadKey(*cell);
 216     if (currentKey == kEmptyKey_ || currentKey == kLockedKey_) {
 217       // If we hit an empty (or locked) element, this key does not exist. This
 218       // is similar to how it's handled in find().
 219       return 0;
 220     }
 221     if (EqualFcn()(currentKey, key_in)) {
 222       // Found an existing entry for our key, attempt to mark it erased.
 223       // Some other thread may have erased our key, but this is ok.
 224       KeyT expect = currentKey;
 225       if (cellKeyPtr(*cell)->compare_exchange_strong(expect, kErasedKey_)) {
 226         numErases_.fetch_add(1, std::memory_order_relaxed);
 227
 228         // Even if there's a value in the cell, we won't delete (or even
 229         // default construct) it because some other thread may be accessing it.
 230         // Locking it meanwhile won't work either since another thread may be
 231         // holding a pointer to it.
 232
 233         // We found the key and successfully erased it.
 234         return 1;
 235       }
 236       // If another thread succeeds in erasing our key, we'll stop our search.
 237       return 0;
 238     }
 239     ++numProbes;
 240     if (UNLIKELY(numProbes >= capacity_)) {
 241       // probed every cell...fail
 242       return 0;
 243     }
 244   }
 245 }
 246
 247 template <class KeyT, class ValueT,
 248           class HashFcn, class EqualFcn, class Allocator>
 249 const typename AtomicHashArray<KeyT, ValueT,
 250       HashFcn, EqualFcn, Allocator>::Config
 251 AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::defaultConfig;
 252
 253 template <class KeyT, class ValueT,
 254          class HashFcn, class EqualFcn, class Allocator>
 255 typename AtomicHashArray<KeyT, ValueT,
 256          HashFcn, EqualFcn, Allocator>::SmartPtr
 257 AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
 258 create(size_t maxSize, const Config& c) {
 259   CHECK_LE(c.maxLoadFactor, 1.0);
 260   CHECK_GT(c.maxLoadFactor, 0.0);
 261   CHECK_NE(c.emptyKey, c.lockedKey);
 262   size_t capacity = size_t(maxSize / c.maxLoadFactor);
 263   size_t sz = sizeof(AtomicHashArray) + sizeof(value_type) * capacity;
 264
 265   auto const mem = Allocator().allocate(sz);
 266   try {
 267     new (mem) AtomicHashArray(capacity, c.emptyKey, c.lockedKey, c.erasedKey,
 268                               c.maxLoadFactor, c.entryCountThreadCacheSize);
 269   } catch (...) {
 270     Allocator().deallocate(mem, sz);
 271     throw;
 272   }
 273
 274   SmartPtr map(static_cast<AtomicHashArray*>((void *)mem));
 275
 276   /*
 277    * Mark all cells as empty.
 278    *
 279    * Note: we're bending the rules a little here accessing the key
 280    * element in our cells even though the cell object has not been
 281    * constructed, and casting them to atomic objects (see cellKeyPtr).
 282    * (Also, in fact we never actually invoke the value_type
 283    * constructor.)  This is in order to avoid needing to default
 284    * construct a bunch of value_type when we first start up: if you
 285    * have an expensive default constructor for the value type this can
 286    * noticeably speed construction time for an AHA.
 287    */
 288   FOR_EACH_RANGE(i, 0, map->capacity_) {
 289     cellKeyPtr(map->cells_[i])->store(map->kEmptyKey_,
 290       std::memory_order_relaxed);
 291   }
 292   return map;
 293 }
 294
 295 template <class KeyT, class ValueT,
 296           class HashFcn, class EqualFcn, class Allocator>
 297 void AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
 298 destroy(AtomicHashArray* p) {
 299   assert(p);
 300
 301   size_t sz = sizeof(AtomicHashArray) + sizeof(value_type) * p->capacity_;
 302
 303   FOR_EACH_RANGE(i, 0, p->capacity_) {
 304     if (p->cells_[i].first != p->kEmptyKey_) {
 305       p->cells_[i].~value_type();
 306     }
 307   }
 308   p->~AtomicHashArray();
 309
 310   Allocator().deallocate((char *)p, sz);
 311 }
 312
 313 // clear -- clears all keys and values in the map and resets all counters
 314 template <class KeyT, class ValueT,
 315           class HashFcn, class EqualFcn, class Allocator>
 316 void AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::
 317 clear() {
 318   FOR_EACH_RANGE(i, 0, capacity_) {
 319     if (cells_[i].first != kEmptyKey_) {
 320       cells_[i].~value_type();
 321       *const_cast<KeyT*>(&cells_[i].first) = kEmptyKey_;
 322     }
 323     CHECK(cells_[i].first == kEmptyKey_);
 324   }
 325   numEntries_.set(0);
 326   numPendingEntries_.set(0);
 327   isFull_.store(0, std::memory_order_relaxed);
 328   numErases_.store(0, std::memory_order_relaxed);
 329 }
 330
 331
 332 // Iterator implementation
 333
 334 template <class KeyT, class ValueT,
 335           class HashFcn, class EqualFcn, class Allocator>
 336 template <class ContT, class IterVal>
 337 struct AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator>::aha_iterator
 338     : boost::iterator_facade<aha_iterator<ContT,IterVal>,
 339                              IterVal,
 340                              boost::forward_traversal_tag>
 341 {
 342   explicit aha_iterator() : aha_(0) {}
 343
 344   // Conversion ctor for interoperability between const_iterator and
 345   // iterator.  The enable_if<> magic keeps us well-behaved for
 346   // is_convertible<> (v. the iterator_facade documentation).
 347   template<class OtherContT, class OtherVal>
 348   aha_iterator(const aha_iterator<OtherContT,OtherVal>& o,
 349                typename std::enable_if<
 350                std::is_convertible<OtherVal*,IterVal*>::value >::type* = 0)
 351       : aha_(o.aha_)
 352       , offset_(o.offset_)
 353   {}
 354
 355   explicit aha_iterator(ContT* array, size_t offset)
 356       : aha_(array)
 357       , offset_(offset)
 358   {}
 359
 360   // Returns unique index that can be used with findAt().
 361   // WARNING: The following function will fail silently for hashtable
 362   // with capacity > 2^32
 363   uint32_t getIndex() const { return offset_; }
 364
 365   void advancePastEmpty() {
 366     while (offset_ < aha_->capacity_ && !isValid()) {
 367       ++offset_;
 368     }
 369   }
 370
 371  private:
 372   friend class AtomicHashArray;
 373   friend class boost::iterator_core_access;
 374
 375   void increment() {
 376     ++offset_;
 377     advancePastEmpty();
 378   }
 379
 380   bool equal(const aha_iterator& o) const {
 381     return aha_ == o.aha_ && offset_ == o.offset_;
 382   }
 383
 384   IterVal& dereference() const {
 385     return aha_->cells_[offset_];
 386   }
 387
 388   bool isValid() const {
 389     KeyT key = acquireLoadKey(aha_->cells_[offset_]);
 390     return key != aha_->kEmptyKey_  &&
 391       key != aha_->kLockedKey_ &&
 392       key != aha_->kErasedKey_;
 393   }
 394
 395  private:
 396   ContT* aha_;
 397   size_t offset_;
 398 }; // aha_iterator
 399
 400 } // namespace folly