folly/AtomicHashMap.h

   1 /*
   2  * Copyright 2017 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 /*
  18  * AtomicHashMap --
  19  *
  20  * A high-performance concurrent hash map with int32 or int64 keys. Supports
  21  * insert, find(key), findAt(index), erase(key), size, and more.  Memory cannot
  22  * be freed or reclaimed by erase.  Can grow to a maximum of about 18 times the
  23  * initial capacity, but performance degrades linearly with growth. Can also be
  24  * used as an object store with unique 32-bit references directly into the
  25  * internal storage (retrieved with iterator::getIndex()).
  26  *
  27  * Advantages:
  28  *    - High-performance (~2-4x tbb::concurrent_hash_map in heavily
  29  *      multi-threaded environments).
  30  *    - Efficient memory usage if initial capacity is not over estimated
  31  *      (especially for small keys and values).
  32  *    - Good fragmentation properties (only allocates in large slabs which can
  33  *      be reused with clear() and never move).
  34  *    - Can generate unique, long-lived 32-bit references for efficient lookup
  35  *      (see findAt()).
  36  *
  37  * Disadvantages:
  38  *    - Keys must be native int32 or int64, or explicitly converted.
  39  *    - Must be able to specify unique empty, locked, and erased keys
  40  *    - Performance degrades linearly as size grows beyond initialization
  41  *      capacity.
  42  *    - Max size limit of ~18x initial size (dependent on max load factor).
  43  *    - Memory is not freed or reclaimed by erase.
  44  *
  45  * Usage and Operation Details:
  46  *   Simple performance/memory tradeoff with maxLoadFactor.  Higher load factors
  47  *   give better memory utilization but probe lengths increase, reducing
  48  *   performance.
  49  *
  50  * Implementation and Performance Details:
  51  *   AHArray is a fixed size contiguous block of value_type cells.  When
  52  *   writing a cell, the key is locked while the rest of the record is
  53  *   written.  Once done, the cell is unlocked by setting the key.  find()
  54  *   is completely wait-free and doesn't require any non-relaxed atomic
  55  *   operations.  AHA cannot grow beyond initialization capacity, but is
  56  *   faster because of reduced data indirection.
  57  *
  58  *   AHMap is a wrapper around AHArray sub-maps that allows growth and provides
  59  *   an interface closer to the STL UnorderedAssociativeContainer concept. These
  60  *   sub-maps are allocated on the fly and are processed in series, so the more
  61  *   there are (from growing past initial capacity), the worse the performance.
  62  *
  63  *   Insert returns false if there is a key collision and throws if the max size
  64  *   of the map is exceeded.
  65  *
  66  *   Benchmark performance with 8 simultaneous threads processing 1 million
  67  *   unique <int64, int64> entries on a 4-core, 2.5 GHz machine:
  68  *
  69  *     Load Factor   Mem Efficiency   usec/Insert   usec/Find
  70  *         50%             50%           0.19         0.05
  71  *         85%             85%           0.20         0.06
  72  *         90%             90%           0.23         0.08
  73  *         95%             95%           0.27         0.10
  74  *
  75  *   See folly/tests/AtomicHashMapTest.cpp for more benchmarks.
  76  *
  77  * @author Spencer Ahrens <sahrens@fb.com>
  78  * @author Jordan DeLong <delong.j@fb.com>
  79  *
  80  */
  81
  82 #pragma once
  83 #define FOLLY_ATOMICHASHMAP_H_
  84
  85 #include <boost/iterator/iterator_facade.hpp>
  86 #include <boost/noncopyable.hpp>
  87 #include <boost/type_traits/is_convertible.hpp>
  88
  89 #include <atomic>
  90 #include <functional>
  91 #include <stdexcept>
  92
  93 #include <folly/AtomicHashArray.h>
  94 #include <folly/Foreach.h>
  95 #include <folly/Hash.h>
  96 #include <folly/Likely.h>
  97 #include <folly/ThreadCachedInt.h>
  98
  99 namespace folly {
 100
 101 /*
 102  * AtomicHashMap provides an interface somewhat similar to the
 103  * UnorderedAssociativeContainer concept in C++.  This does not
 104  * exactly match this concept (or even the basic Container concept),
 105  * because of some restrictions imposed by our datastructure.
 106  *
 107  * Specific differences (there are quite a few):
 108  *
 109  * - Efficiently thread safe for inserts (main point of this stuff),
 110  *   wait-free for lookups.
 111  *
 112  * - You can erase from this container, but the cell containing the key will
 113  *   not be free or reclaimed.
 114  *
 115  * - You can erase everything by calling clear() (and you must guarantee only
 116  *   one thread can be using the container to do that).
 117  *
 118  * - We aren't DefaultConstructible, CopyConstructible, Assignable, or
 119  *   EqualityComparable.  (Most of these are probably not something
 120  *   you actually want to do with this anyway.)
 121  *
 122  * - We don't support the various bucket functions, rehash(),
 123  *   reserve(), or equal_range().  Also no constructors taking
 124  *   iterators, although this could change.
 125  *
 126  * - Several insertion functions, notably operator[], are not
 127  *   implemented.  It is a little too easy to misuse these functions
 128  *   with this container, where part of the point is that when an
 129  *   insertion happens for a new key, it will atomically have the
 130  *   desired value.
 131  *
 132  * - The map has no templated insert() taking an iterator range, but
 133  *   we do provide an insert(key, value).  The latter seems more
 134  *   frequently useful for this container (to avoid sprinkling
 135  *   make_pair everywhere), and providing both can lead to some gross
 136  *   template error messages.
 137  *
 138  * - The Allocator must not be stateful (a new instance will be spun up for
 139  *   each allocation), and its allocate() method must take a raw number of
 140  *   bytes.
 141  *
 142  * - KeyT must be a 32 bit or 64 bit atomic integer type, and you must
 143  *   define special 'locked' and 'empty' key values in the ctor
 144  *
 145  * - We don't take the Hash function object as an instance in the
 146  *   constructor.
 147  *
 148  */
 149
 150 // Thrown when insertion fails due to running out of space for
 151 // submaps.
 152 struct AtomicHashMapFullError : std::runtime_error {
 153   explicit AtomicHashMapFullError()
 154     : std::runtime_error("AtomicHashMap is full")
 155   {}
 156 };
 157
 158 template <
 159     class KeyT,
 160     class ValueT,
 161     class HashFcn,
 162     class EqualFcn,
 163     class Allocator,
 164     class ProbeFcn,
 165     class KeyConvertFcn>
 166 class AtomicHashMap : boost::noncopyable {
 167 typedef AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn,
 168                         Allocator, ProbeFcn, KeyConvertFcn>
 169     SubMap;
 170
 171  public:
 172   typedef KeyT                key_type;
 173   typedef ValueT              mapped_type;
 174   typedef std::pair<const KeyT, ValueT> value_type;
 175   typedef HashFcn             hasher;
 176   typedef EqualFcn            key_equal;
 177   typedef KeyConvertFcn       key_convert;
 178   typedef value_type*         pointer;
 179   typedef value_type&         reference;
 180   typedef const value_type&   const_reference;
 181   typedef std::ptrdiff_t      difference_type;
 182   typedef std::size_t         size_type;
 183   typedef typename SubMap::Config Config;
 184
 185   template <class ContT, class IterVal, class SubIt>
 186   struct ahm_iterator;
 187
 188   typedef ahm_iterator<const AtomicHashMap,
 189                        const value_type,
 190                        typename SubMap::const_iterator>
 191     const_iterator;
 192   typedef ahm_iterator<AtomicHashMap,
 193                        value_type,
 194                        typename SubMap::iterator>
 195     iterator;
 196
 197  public:
 198   const float kGrowthFrac_;  // How much to grow when we run out of capacity.
 199
 200   // The constructor takes a finalSizeEst which is the optimal
 201   // number of elements to maximize space utilization and performance,
 202   // and a Config object to specify more advanced options.
 203   explicit AtomicHashMap(size_t finalSizeEst, const Config& c = Config());
 204
 205   ~AtomicHashMap() {
 206     const unsigned int numMaps =
 207         numMapsAllocated_.load(std::memory_order_relaxed);
 208     FOR_EACH_RANGE (i, 0, numMaps) {
 209       SubMap* thisMap = subMaps_[i].load(std::memory_order_relaxed);
 210       DCHECK(thisMap);
 211       SubMap::destroy(thisMap);
 212     }
 213   }
 214
 215   key_equal key_eq() const { return key_equal(); }
 216   hasher hash_function() const { return hasher(); }
 217
 218   /*
 219    * insert --
 220    *
 221    *   Returns a pair with iterator to the element at r.first and
 222    *   success.  Retrieve the index with ret.first.getIndex().
 223    *
 224    *   Does not overwrite on key collision, but returns an iterator to
 225    *   the existing element (since this could due to a race with
 226    *   another thread, it is often important to check this return
 227    *   value).
 228    *
 229    *   Allocates new sub maps as the existing ones become full.  If
 230    *   all sub maps are full, no element is inserted, and
 231    *   AtomicHashMapFullError is thrown.
 232    */
 233   std::pair<iterator,bool> insert(const value_type& r) {
 234     return emplace(r.first, r.second);
 235   }
 236   std::pair<iterator,bool> insert(key_type k, const mapped_type& v) {
 237     return emplace(k, v);
 238   }
 239   std::pair<iterator,bool> insert(value_type&& r) {
 240     return emplace(r.first, std::move(r.second));
 241   }
 242   std::pair<iterator,bool> insert(key_type k, mapped_type&& v) {
 243     return emplace(k, std::move(v));
 244   }
 245
 246   /*
 247    * emplace --
 248    *
 249    *   Same contract as insert(), but performs in-place construction
 250    *   of the value type using the specified arguments.
 251    *
 252    *   Also, like find(), this method optionally allows 'key_in' to have a type
 253    *   different from that stored in the table; see find(). If and only if no
 254    *   equal key is already present, this method converts 'key_in' to a key of
 255    *   type KeyT using the provided LookupKeyToKeyFcn.
 256    */
 257   template <typename LookupKeyT = key_type,
 258             typename LookupHashFcn = hasher,
 259             typename LookupEqualFcn = key_equal,
 260             typename LookupKeyToKeyFcn = key_convert,
 261             typename... ArgTs>
 262   std::pair<iterator,bool> emplace(LookupKeyT k, ArgTs&&... vCtorArg);
 263
 264   /*
 265    * find --
 266    *
 267    *   Returns the iterator to the element if found, otherwise end().
 268    *
 269    *   As an optional feature, the type of the key to look up (LookupKeyT) is
 270    *   allowed to be different from the type of keys actually stored (KeyT).
 271    *
 272    *   This enables use cases where materializing the key is costly and usually
 273    *   redudant, e.g., canonicalizing/interning a set of strings and being able
 274    *   to look up by StringPiece. To use this feature, LookupHashFcn must take
 275    *   a LookupKeyT, and LookupEqualFcn must take KeyT and LookupKeyT as first
 276    *   and second parameter, respectively.
 277    *
 278    *   See folly/test/ArrayHashMapTest.cpp for sample usage.
 279    */
 280   template <typename LookupKeyT = key_type,
 281             typename LookupHashFcn = hasher,
 282             typename LookupEqualFcn = key_equal>
 283   iterator find(LookupKeyT k);
 284
 285   template <typename LookupKeyT = key_type,
 286             typename LookupHashFcn = hasher,
 287             typename LookupEqualFcn = key_equal>
 288   const_iterator find(LookupKeyT k) const;
 289
 290   /*
 291    * erase --
 292    *
 293    *   Erases key k from the map
 294    *
 295    *   Returns 1 iff the key is found and erased, and 0 otherwise.
 296    */
 297   size_type erase(key_type k);
 298
 299   /*
 300    * clear --
 301    *
 302    *   Wipes all keys and values from primary map and destroys all secondary
 303    *   maps.  Primary map remains allocated and thus the memory can be reused
 304    *   in place.  Not thread safe.
 305    *
 306    */
 307   void clear();
 308
 309   /*
 310    * size --
 311    *
 312    *  Returns the exact size of the map.  Note this is not as cheap as typical
 313    *  size() implementations because, for each AtomicHashArray in this AHM, we
 314    *  need to grab a lock and accumulate the values from all the thread local
 315    *  counters.  See folly/ThreadCachedInt.h for more details.
 316    */
 317   size_t size() const;
 318
 319   bool empty() const { return size() == 0; }
 320
 321   size_type count(key_type k) const {
 322     return find(k) == end() ? 0 : 1;
 323   }
 324
 325
 326   /*
 327    * findAt --
 328    *
 329    *   Returns an iterator into the map.
 330    *
 331    *   idx should only be an unmodified value returned by calling getIndex() on
 332    *   a valid iterator returned by find() or insert(). If idx is invalid you
 333    *   have a bug and the process aborts.
 334    */
 335   iterator findAt(uint32_t idx) {
 336     SimpleRetT ret = findAtInternal(idx);
 337     DCHECK_LT(ret.i, numSubMaps());
 338     return iterator(this, ret.i,
 339       subMaps_[ret.i].load(std::memory_order_relaxed)->makeIter(ret.j));
 340   }
 341   const_iterator findAt(uint32_t idx) const {
 342     return const_cast<AtomicHashMap*>(this)->findAt(idx);
 343   }
 344
 345   // Total capacity - summation of capacities of all submaps.
 346   size_t capacity() const;
 347
 348   // Number of new insertions until current submaps are all at max load factor.
 349   size_t spaceRemaining() const;
 350
 351   void setEntryCountThreadCacheSize(int32_t newSize) {
 352     const int numMaps = numMapsAllocated_.load(std::memory_order_acquire);
 353     for (int i = 0; i < numMaps; ++i) {
 354       SubMap* map = subMaps_[i].load(std::memory_order_relaxed);
 355       map->setEntryCountThreadCacheSize(newSize);
 356     }
 357   }
 358
 359   // Number of sub maps allocated so far to implement this map.  The more there
 360   // are, the worse the performance.
 361   int numSubMaps() const {
 362     return numMapsAllocated_.load(std::memory_order_acquire);
 363   }
 364
 365   iterator begin() {
 366     iterator it(this, 0,
 367       subMaps_[0].load(std::memory_order_relaxed)->begin());
 368     it.checkAdvanceToNextSubmap();
 369     return it;
 370   }
 371
 372   const_iterator begin() const {
 373     const_iterator it(this, 0,
 374       subMaps_[0].load(std::memory_order_relaxed)->begin());
 375     it.checkAdvanceToNextSubmap();
 376     return it;
 377   }
 378
 379   iterator end() {
 380     return iterator();
 381   }
 382
 383   const_iterator end() const {
 384     return const_iterator();
 385   }
 386
 387   /* Advanced functions for direct access: */
 388
 389   inline uint32_t recToIdx(const value_type& r, bool mayInsert = true) {
 390     SimpleRetT ret = mayInsert ?
 391       insertInternal(r.first, r.second) : findInternal(r.first);
 392     return encodeIndex(ret.i, ret.j);
 393   }
 394
 395   inline uint32_t recToIdx(value_type&& r, bool mayInsert = true) {
 396     SimpleRetT ret = mayInsert ?
 397       insertInternal(r.first, std::move(r.second)) : findInternal(r.first);
 398     return encodeIndex(ret.i, ret.j);
 399   }
 400
 401   inline uint32_t recToIdx(key_type k, const mapped_type& v,
 402     bool mayInsert = true) {
 403     SimpleRetT ret = mayInsert ? insertInternal(k, v) : findInternal(k);
 404     return encodeIndex(ret.i, ret.j);
 405   }
 406
 407   inline uint32_t recToIdx(key_type k, mapped_type&& v, bool mayInsert = true) {
 408     SimpleRetT ret = mayInsert ?
 409       insertInternal(k, std::move(v)) : findInternal(k);
 410     return encodeIndex(ret.i, ret.j);
 411   }
 412
 413   inline uint32_t keyToIdx(const KeyT k, bool mayInsert = false) {
 414     return recToIdx(value_type(k), mayInsert);
 415   }
 416
 417   inline const value_type& idxToRec(uint32_t idx) const {
 418     SimpleRetT ret = findAtInternal(idx);
 419     return subMaps_[ret.i].load(std::memory_order_relaxed)->idxToRec(ret.j);
 420   }
 421
 422   /* Private data and helper functions... */
 423
 424  private:
 425   // This limits primary submap size to 2^31 ~= 2 billion, secondary submap
 426   // size to 2^(32 - kNumSubMapBits_ - 1) = 2^27 ~= 130 million, and num subMaps
 427   // to 2^kNumSubMapBits_ = 16.
 428   static const uint32_t  kNumSubMapBits_     = 4;
 429   static const uint32_t  kSecondaryMapBit_   = 1u << 31; // Highest bit
 430   static const uint32_t  kSubMapIndexShift_  = 32 - kNumSubMapBits_ - 1;
 431   static const uint32_t  kSubMapIndexMask_   = (1 << kSubMapIndexShift_) - 1;
 432   static const uint32_t  kNumSubMaps_        = 1 << kNumSubMapBits_;
 433   static const uintptr_t kLockedPtr_         = 0x88ULL << 48; // invalid pointer
 434
 435   struct SimpleRetT { uint32_t i; size_t j; bool success;
 436     SimpleRetT(uint32_t ii, size_t jj, bool s) : i(ii), j(jj), success(s) {}
 437     SimpleRetT() = default;
 438   };
 439
 440   template <typename LookupKeyT = key_type,
 441             typename LookupHashFcn = hasher,
 442             typename LookupEqualFcn = key_equal,
 443             typename LookupKeyToKeyFcn = key_convert,
 444             typename... ArgTs>
 445   SimpleRetT insertInternal(LookupKeyT key, ArgTs&&... value);
 446
 447   template <typename LookupKeyT = key_type,
 448             typename LookupHashFcn = hasher,
 449             typename LookupEqualFcn = key_equal>
 450   SimpleRetT findInternal(const LookupKeyT k) const;
 451
 452   SimpleRetT findAtInternal(uint32_t idx) const;
 453
 454   std::atomic<SubMap*> subMaps_[kNumSubMaps_];
 455   std::atomic<uint32_t> numMapsAllocated_;
 456
 457   inline bool tryLockMap(unsigned int idx) {
 458     SubMap* val = nullptr;
 459     return subMaps_[idx].compare_exchange_strong(val, (SubMap*)kLockedPtr_,
 460       std::memory_order_acquire);
 461   }
 462
 463   static inline uint32_t encodeIndex(uint32_t subMap, uint32_t subMapIdx);
 464
 465 }; // AtomicHashMap
 466
 467 template <class KeyT,
 468           class ValueT,
 469           class HashFcn = std::hash<KeyT>,
 470           class EqualFcn = std::equal_to<KeyT>,
 471           class Allocator = std::allocator<char>>
 472 using QuadraticProbingAtomicHashMap =
 473     AtomicHashMap<KeyT,
 474                   ValueT,
 475                   HashFcn,
 476                   EqualFcn,
 477                   Allocator,
 478                   AtomicHashArrayQuadraticProbeFcn>;
 479 } // namespace folly
 480
 481 #include <folly/AtomicHashMap-inl.h>