folly/AtomicHashMap.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 /*
  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 #ifndef FOLLY_ATOMICHASHMAP_H_
  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 <stdexcept>
  90 #include <functional>
  91 #include <atomic>
  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<class KeyT, class ValueT,
 159          class HashFcn, class EqualFcn, class Allocator>
 160 class AtomicHashMap : boost::noncopyable {
 161   typedef AtomicHashArray<KeyT, ValueT, HashFcn, EqualFcn, Allocator> SubMap;
 162
 163  public:
 164   typedef KeyT                key_type;
 165   typedef ValueT              mapped_type;
 166   typedef std::pair<const KeyT, ValueT> value_type;
 167   typedef HashFcn             hasher;
 168   typedef EqualFcn            key_equal;
 169   typedef value_type*         pointer;
 170   typedef value_type&         reference;
 171   typedef const value_type&   const_reference;
 172   typedef std::ptrdiff_t      difference_type;
 173   typedef std::size_t         size_type;
 174   typedef typename SubMap::Config Config;
 175
 176   template<class ContT, class IterVal, class SubIt>
 177   struct ahm_iterator;
 178
 179   typedef ahm_iterator<const AtomicHashMap,
 180                        const value_type,
 181                        typename SubMap::const_iterator>
 182     const_iterator;
 183   typedef ahm_iterator<AtomicHashMap,
 184                        value_type,
 185                        typename SubMap::iterator>
 186     iterator;
 187
 188  public:
 189   const float kGrowthFrac_;  // How much to grow when we run out of capacity.
 190
 191   // The constructor takes a finalSizeEst which is the optimal
 192   // number of elements to maximize space utilization and performance,
 193   // and a Config object to specify more advanced options.
 194   explicit AtomicHashMap(size_t finalSizeEst, const Config& c = Config());
 195
 196   ~AtomicHashMap() {
 197     const int numMaps = numMapsAllocated_.load(std::memory_order_relaxed);
 198     FOR_EACH_RANGE (i, 0, numMaps) {
 199       SubMap* thisMap = subMaps_[i].load(std::memory_order_relaxed);
 200       DCHECK(thisMap);
 201       SubMap::destroy(thisMap);
 202     }
 203   }
 204
 205   key_equal key_eq() const { return key_equal(); }
 206   hasher hash_function() const { return hasher(); }
 207
 208   // TODO: emplace() support would be nice.
 209
 210   /*
 211    * insert --
 212    *
 213    *   Returns a pair with iterator to the element at r.first and
 214    *   success.  Retrieve the index with ret.first.getIndex().
 215    *
 216    *   Does not overwrite on key collision, but returns an iterator to
 217    *   the existing element (since this could due to a race with
 218    *   another thread, it is often important to check this return
 219    *   value).
 220    *
 221    *   Allocates new sub maps as the existing ones become full.  If
 222    *   all sub maps are full, no element is inserted, and
 223    *   AtomicHashMapFullError is thrown.
 224    */
 225   std::pair<iterator,bool> insert(const value_type& r) {
 226     return insert(r.first, r.second);
 227   }
 228   std::pair<iterator,bool> insert(key_type k, const mapped_type& v);
 229   std::pair<iterator,bool> insert(value_type&& r) {
 230     return insert(r.first, std::move(r.second));
 231   }
 232   std::pair<iterator,bool> insert(key_type k, mapped_type&& v);
 233
 234   /*
 235    * find --
 236    *
 237    *   Returns an iterator into the map.
 238    *
 239    *   If the key is not found, returns end().
 240    */
 241   iterator find(key_type k);
 242   const_iterator find(key_type k) const;
 243
 244   /*
 245    * erase --
 246    *
 247    *   Erases key k from the map
 248    *
 249    *   Returns 1 iff the key is found and erased, and 0 otherwise.
 250    */
 251   size_type erase(key_type k);
 252
 253   /*
 254    * clear --
 255    *
 256    *   Wipes all keys and values from primary map and destroys all secondary
 257    *   maps.  Primary map remains allocated and thus the memory can be reused
 258    *   in place.  Not thread safe.
 259    *
 260    */
 261   void clear();
 262
 263   /*
 264    * size --
 265    *
 266    *  Returns the exact size of the map.  Note this is not as cheap as typical
 267    *  size() implementations because, for each AtomicHashArray in this AHM, we
 268    *  need to grab a lock and accumulate the values from all the thread local
 269    *  counters.  See folly/ThreadCachedInt.h for more details.
 270    */
 271   size_t size() const;
 272
 273   bool empty() const { return size() == 0; }
 274
 275   size_type count(key_type k) const {
 276     return find(k) == end() ? 0 : 1;
 277   }
 278
 279
 280   /*
 281    * findAt --
 282    *
 283    *   Returns an iterator into the map.
 284    *
 285    *   idx should only be an unmodified value returned by calling getIndex() on
 286    *   a valid iterator returned by find() or insert(). If idx is invalid you
 287    *   have a bug and the process aborts.
 288    */
 289   iterator findAt(uint32_t idx) {
 290     SimpleRetT ret = findAtInternal(idx);
 291     DCHECK_LT(ret.i, numSubMaps());
 292     return iterator(this, ret.i,
 293       subMaps_[ret.i].load(std::memory_order_relaxed)->makeIter(ret.j));
 294   }
 295   const_iterator findAt(uint32_t idx) const {
 296     return const_cast<AtomicHashMap*>(this)->findAt(idx);
 297   }
 298
 299   // Total capacity - summation of capacities of all submaps.
 300   size_t capacity() const;
 301
 302   // Number of new insertions until current submaps are all at max load factor.
 303   size_t spaceRemaining() const;
 304
 305   void setEntryCountThreadCacheSize(int32_t newSize) {
 306     const int numMaps = numMapsAllocated_.load(std::memory_order_acquire);
 307     for (int i = 0; i < numMaps; ++i) {
 308       SubMap* map = subMaps_[i].load(std::memory_order_relaxed);
 309       map->setEntryCountThreadCacheSize(newSize);
 310     }
 311   }
 312
 313   // Number of sub maps allocated so far to implement this map.  The more there
 314   // are, the worse the performance.
 315   int numSubMaps() const {
 316     return numMapsAllocated_.load(std::memory_order_acquire);
 317   }
 318
 319   iterator begin() {
 320     iterator it(this, 0,
 321       subMaps_[0].load(std::memory_order_relaxed)->begin());
 322     it.checkAdvanceToNextSubmap();
 323     return it;
 324   }
 325
 326   const_iterator begin() const {
 327     const_iterator it(this, 0,
 328       subMaps_[0].load(std::memory_order_relaxed)->begin());
 329     it.checkAdvanceToNextSubmap();
 330     return it;
 331   }
 332
 333   iterator end() {
 334     return iterator();
 335   }
 336
 337   const_iterator end() const {
 338     return const_iterator();
 339   }
 340
 341   /* Advanced functions for direct access: */
 342
 343   inline uint32_t recToIdx(const value_type& r, bool mayInsert = true) {
 344     SimpleRetT ret = mayInsert ?
 345       insertInternal(r.first, r.second) : findInternal(r.first);
 346     return encodeIndex(ret.i, ret.j);
 347   }
 348
 349   inline uint32_t recToIdx(value_type&& r, bool mayInsert = true) {
 350     SimpleRetT ret = mayInsert ?
 351       insertInternal(r.first, std::move(r.second)) : findInternal(r.first);
 352     return encodeIndex(ret.i, ret.j);
 353   }
 354
 355   inline uint32_t recToIdx(key_type k, const mapped_type& v,
 356     bool mayInsert = true) {
 357     SimpleRetT ret = mayInsert ? insertInternal(k, v) : findInternal(k);
 358     return encodeIndex(ret.i, ret.j);
 359   }
 360
 361   inline uint32_t recToIdx(key_type k, mapped_type&& v, bool mayInsert = true) {
 362     SimpleRetT ret = mayInsert ?
 363       insertInternal(k, std::move(v)) : findInternal(k);
 364     return encodeIndex(ret.i, ret.j);
 365   }
 366
 367   inline uint32_t keyToIdx(const KeyT k, bool mayInsert = false) {
 368     return recToIdx(value_type(k), mayInsert);
 369   }
 370
 371   inline const value_type& idxToRec(uint32_t idx) const {
 372     SimpleRetT ret = findAtInternal(idx);
 373     return subMaps_[ret.i].load(std::memory_order_relaxed)->idxToRec(ret.j);
 374   }
 375
 376   /* Private data and helper functions... */
 377
 378  private:
 379   // This limits primary submap size to 2^31 ~= 2 billion, secondary submap
 380   // size to 2^(32 - kNumSubMapBits_ - 1) = 2^27 ~= 130 million, and num subMaps
 381   // to 2^kNumSubMapBits_ = 16.
 382   static const uint32_t  kNumSubMapBits_     = 4;
 383   static const uint32_t  kSecondaryMapBit_   = 1u << 31; // Highest bit
 384   static const uint32_t  kSubMapIndexShift_  = 32 - kNumSubMapBits_ - 1;
 385   static const uint32_t  kSubMapIndexMask_   = (1 << kSubMapIndexShift_) - 1;
 386   static const uint32_t  kNumSubMaps_        = 1 << kNumSubMapBits_;
 387   static const uintptr_t kLockedPtr_         = 0x88ULL << 48; // invalid pointer
 388
 389   struct SimpleRetT { uint32_t i; size_t j; bool success;
 390     SimpleRetT(uint32_t ii, size_t jj, bool s) : i(ii), j(jj), success(s) {}
 391     SimpleRetT() = default;
 392   };
 393
 394   template <class T>
 395   SimpleRetT insertInternal(KeyT key, T&& value);
 396
 397   SimpleRetT findInternal(const KeyT k) const;
 398
 399   SimpleRetT findAtInternal(uint32_t idx) const;
 400
 401   std::atomic<SubMap*> subMaps_[kNumSubMaps_];
 402   std::atomic<uint32_t> numMapsAllocated_;
 403
 404   inline bool tryLockMap(int idx) {
 405     SubMap* val = nullptr;
 406     return subMaps_[idx].compare_exchange_strong(val, (SubMap*)kLockedPtr_,
 407       std::memory_order_acquire);
 408   }
 409
 410   static inline uint32_t encodeIndex(uint32_t subMap, uint32_t subMapIdx);
 411
 412 }; // AtomicHashMap
 413
 414 } // namespace folly
 415
 416 #include <folly/AtomicHashMap-inl.h>
 417
 418 #endif // FOLLY_ATOMICHASHMAP_H_