folly/AtomicHashArray.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  *  AtomicHashArray is the building block for AtomicHashMap.  It provides the
  19  *  core lock-free functionality, but is limitted by the fact that it cannot
  20  *  grow past it's initialization size and is a little more awkward (no public
  21  *  constructor, for example).  If you're confident that you won't run out of
  22  *  space, don't mind the awkardness, and really need bare-metal performance,
  23  *  feel free to use AHA directly.
  24  *
  25  *  Check out AtomicHashMap.h for more thorough documentation on perf and
  26  *  general pros and cons relative to other hash maps.
  27  *
  28  *  @author Spencer Ahrens <sahrens@fb.com>
  29  *  @author Jordan DeLong <delong.j@fb.com>
  30  */
  31
  32 #ifndef FOLLY_ATOMICHASHARRAY_H_
  33 #define FOLLY_ATOMICHASHARRAY_H_
  34
  35 #include <atomic>
  36
  37 #include <boost/iterator/iterator_facade.hpp>
  38 #include <boost/noncopyable.hpp>
  39
  40 #include <folly/Hash.h>
  41 #include <folly/ThreadCachedInt.h>
  42
  43 namespace folly {
  44
  45 template <class KeyT, class ValueT,
  46           class HashFcn = std::hash<KeyT>,
  47           class EqualFcn = std::equal_to<KeyT>,
  48           class Allocator = std::allocator<char>>
  49 class AtomicHashMap;
  50
  51 template <class KeyT, class ValueT,
  52           class HashFcn = std::hash<KeyT>,
  53           class EqualFcn = std::equal_to<KeyT>,
  54           class Allocator = std::allocator<char>>
  55 class AtomicHashArray : boost::noncopyable {
  56   static_assert((std::is_convertible<KeyT,int32_t>::value ||
  57                  std::is_convertible<KeyT,int64_t>::value ||
  58                  std::is_convertible<KeyT,const void*>::value),
  59              "You are trying to use AtomicHashArray with disallowed key "
  60              "types.  You must use atomically compare-and-swappable integer "
  61              "keys, or a different container class.");
  62  public:
  63   typedef KeyT                key_type;
  64   typedef ValueT              mapped_type;
  65   typedef std::pair<const KeyT, ValueT> value_type;
  66   typedef std::size_t         size_type;
  67   typedef std::ptrdiff_t      difference_type;
  68   typedef value_type&         reference;
  69   typedef const value_type&   const_reference;
  70   typedef value_type*         pointer;
  71   typedef const value_type*   const_pointer;
  72
  73   const size_t  capacity_;
  74   const size_t  maxEntries_;
  75   const KeyT    kEmptyKey_;
  76   const KeyT    kLockedKey_;
  77   const KeyT    kErasedKey_;
  78
  79   template<class ContT, class IterVal>
  80   struct aha_iterator;
  81
  82   typedef aha_iterator<const AtomicHashArray,const value_type> const_iterator;
  83   typedef aha_iterator<AtomicHashArray,value_type> iterator;
  84
  85   // You really shouldn't need this if you use the SmartPtr provided by create,
  86   // but if you really want to do something crazy like stick the released
  87   // pointer into a DescriminatedPtr or something, you'll need this to clean up
  88   // after yourself.
  89   static void destroy(AtomicHashArray*);
  90
  91  private:
  92   const size_t  kAnchorMask_;
  93
  94   struct Deleter {
  95     void operator()(AtomicHashArray* ptr) {
  96       AtomicHashArray::destroy(ptr);
  97     }
  98   };
  99
 100  public:
 101   typedef std::unique_ptr<AtomicHashArray, Deleter> SmartPtr;
 102
 103   /*
 104    * create --
 105    *
 106    *   Creates AtomicHashArray objects.  Use instead of constructor/destructor.
 107    *
 108    *   We do things this way in order to avoid the perf penalty of a second
 109    *   pointer indirection when composing these into AtomicHashMap, which needs
 110    *   to store an array of pointers so that it can perform atomic operations on
 111    *   them when growing.
 112    *
 113    *   Instead of a mess of arguments, we take a max size and a Config struct to
 114    *   simulate named ctor parameters.  The Config struct has sensible defaults
 115    *   for everything, but is overloaded - if you specify a positive capacity,
 116    *   that will be used directly instead of computing it based on
 117    *   maxLoadFactor.
 118    *
 119    *   Create returns an AHA::SmartPtr which is a unique_ptr with a custom
 120    *   deleter to make sure everything is cleaned up properly.
 121    */
 122   struct Config {
 123     KeyT   emptyKey;
 124     KeyT   lockedKey;
 125     KeyT   erasedKey;
 126     double maxLoadFactor;
 127     double growthFactor;
 128     int    entryCountThreadCacheSize;
 129     size_t capacity; // if positive, overrides maxLoadFactor
 130
 131   public:
 132     //  Cannot have constexpr ctor because some compilers rightly complain.
 133     Config() : emptyKey((KeyT)-1),
 134                lockedKey((KeyT)-2),
 135                erasedKey((KeyT)-3),
 136                maxLoadFactor(0.8),
 137                growthFactor(-1),
 138                entryCountThreadCacheSize(1000),
 139                capacity(0) {}
 140   };
 141
 142   //  Cannot have pre-instantiated const Config instance because of SIOF.
 143   static SmartPtr create(size_t maxSize, const Config& c = Config());
 144
 145   iterator find(KeyT k) {
 146     return iterator(this, findInternal(k).idx);
 147   }
 148   const_iterator find(KeyT k) const {
 149     return const_cast<AtomicHashArray*>(this)->find(k);
 150   }
 151
 152   /*
 153    * insert --
 154    *
 155    *   Returns a pair with iterator to the element at r.first and bool success.
 156    *   Retrieve the index with ret.first.getIndex().
 157    *
 158    *   Fails on key collision (does not overwrite) or if map becomes
 159    *   full, at which point no element is inserted, iterator is set to end(),
 160    *   and success is set false.  On collisions, success is set false, but the
 161    *   iterator is set to the existing entry.
 162    */
 163   std::pair<iterator,bool> insert(const value_type& r) {
 164     SimpleRetT ret = insertInternal(r.first, r.second);
 165     return std::make_pair(iterator(this, ret.idx), ret.success);
 166   }
 167   std::pair<iterator,bool> insert(value_type&& r) {
 168     SimpleRetT ret = insertInternal(r.first, std::move(r.second));
 169     return std::make_pair(iterator(this, ret.idx), ret.success);
 170   }
 171
 172   // returns the number of elements erased - should never exceed 1
 173   size_t erase(KeyT k);
 174
 175   // clears all keys and values in the map and resets all counters.  Not thread
 176   // safe.
 177   void clear();
 178
 179   // Exact number of elements in the map - note that readFull() acquires a
 180   // mutex.  See folly/ThreadCachedInt.h for more details.
 181   size_t size() const {
 182     return numEntries_.readFull() -
 183       numErases_.load(std::memory_order_relaxed);
 184   }
 185
 186   bool empty() const { return size() == 0; }
 187
 188   iterator begin() {
 189     iterator it(this, 0);
 190     it.advancePastEmpty();
 191     return it;
 192   }
 193   const_iterator begin() const {
 194     const_iterator it(this, 0);
 195     it.advancePastEmpty();
 196     return it;
 197   }
 198
 199   iterator end()               { return iterator(this, capacity_); }
 200   const_iterator end() const   { return const_iterator(this, capacity_); }
 201
 202   // See AtomicHashMap::findAt - access elements directly
 203   // WARNING: The following 2 functions will fail silently for hashtable
 204   // with capacity > 2^32
 205   iterator findAt(uint32_t idx) {
 206     DCHECK_LT(idx, capacity_);
 207     return iterator(this, idx);
 208   }
 209   const_iterator findAt(uint32_t idx) const {
 210     return const_cast<AtomicHashArray*>(this)->findAt(idx);
 211   }
 212
 213   iterator makeIter(size_t idx) { return iterator(this, idx); }
 214   const_iterator makeIter(size_t idx) const {
 215     return const_iterator(this, idx);
 216   }
 217
 218   // The max load factor allowed for this map
 219   double maxLoadFactor() const { return ((double) maxEntries_) / capacity_; }
 220
 221   void setEntryCountThreadCacheSize(uint32_t newSize) {
 222     numEntries_.setCacheSize(newSize);
 223     numPendingEntries_.setCacheSize(newSize);
 224   }
 225
 226   int getEntryCountThreadCacheSize() const {
 227     return numEntries_.getCacheSize();
 228   }
 229
 230   /* Private data and helper functions... */
 231
 232  private:
 233   friend class AtomicHashMap<KeyT, ValueT, HashFcn, EqualFcn, Allocator>;
 234
 235   struct SimpleRetT { size_t idx; bool success;
 236     SimpleRetT(size_t i, bool s) : idx(i), success(s) {}
 237     SimpleRetT() = default;
 238   };
 239
 240   template <class T>
 241   SimpleRetT insertInternal(KeyT key, T&& value);
 242
 243   SimpleRetT findInternal(const KeyT key);
 244
 245   static std::atomic<KeyT>* cellKeyPtr(const value_type& r) {
 246     // We need some illegal casting here in order to actually store
 247     // our value_type as a std::pair<const,>.  But a little bit of
 248     // undefined behavior never hurt anyone ...
 249     static_assert(sizeof(std::atomic<KeyT>) == sizeof(KeyT),
 250                   "std::atomic is implemented in an unexpected way for AHM");
 251     return
 252       const_cast<std::atomic<KeyT>*>(
 253         reinterpret_cast<std::atomic<KeyT> const*>(&r.first));
 254   }
 255
 256   static KeyT relaxedLoadKey(const value_type& r) {
 257     return cellKeyPtr(r)->load(std::memory_order_relaxed);
 258   }
 259
 260   static KeyT acquireLoadKey(const value_type& r) {
 261     return cellKeyPtr(r)->load(std::memory_order_acquire);
 262   }
 263
 264   // Fun with thread local storage - atomic increment is expensive
 265   // (relatively), so we accumulate in the thread cache and periodically
 266   // flush to the actual variable, and walk through the unflushed counts when
 267   // reading the value, so be careful of calling size() too frequently.  This
 268   // increases insertion throughput several times over while keeping the count
 269   // accurate.
 270   ThreadCachedInt<uint64_t> numEntries_;  // Successful key inserts
 271   ThreadCachedInt<uint64_t> numPendingEntries_; // Used by insertInternal
 272   std::atomic<int64_t> isFull_; // Used by insertInternal
 273   std::atomic<int64_t> numErases_;   // Successful key erases
 274
 275   value_type cells_[0];  // This must be the last field of this class
 276
 277   // Force constructor/destructor private since create/destroy should be
 278   // used externally instead
 279   AtomicHashArray(size_t capacity, KeyT emptyKey, KeyT lockedKey,
 280                   KeyT erasedKey, double maxLoadFactor, size_t cacheSize);
 281
 282   ~AtomicHashArray() = default;
 283
 284   inline void unlockCell(value_type* const cell, KeyT newKey) {
 285     cellKeyPtr(*cell)->store(newKey, std::memory_order_release);
 286   }
 287
 288   inline bool tryLockCell(value_type* const cell) {
 289     KeyT expect = kEmptyKey_;
 290     return cellKeyPtr(*cell)->compare_exchange_strong(expect, kLockedKey_,
 291       std::memory_order_acq_rel);
 292   }
 293
 294   inline size_t keyToAnchorIdx(const KeyT k) const {
 295     const size_t hashVal = HashFcn()(k);
 296     const size_t probe = hashVal & kAnchorMask_;
 297     return LIKELY(probe < capacity_) ? probe : hashVal % capacity_;
 298   }
 299
 300   inline size_t probeNext(size_t idx, size_t /*numProbes*/) {
 301     //idx += numProbes; // quadratic probing
 302     idx += 1; // linear probing
 303     // Avoid modulus because it's slow
 304     return LIKELY(idx < capacity_) ? idx : (idx - capacity_);
 305   }
 306 }; // AtomicHashArray
 307
 308 } // namespace folly
 309
 310 #include <folly/AtomicHashArray-inl.h>
 311
 312 #endif // FOLLY_ATOMICHASHARRAY_H_