junction/ConcurrentMap_LeapFrog.h

   1 /*------------------------------------------------------------------------
   2   Junction: Concurrent data structures in C++
   3   Copyright (c) 2016 Jeff Preshing
   4
   5   Distributed under the Simplified BSD License.
   6   Original location: https://github.com/preshing/junction
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the LICENSE file for more information.
  11 ------------------------------------------------------------------------*/
  12
  13 #ifndef JUNCTION_CONCURRENTMAP_LEAPFROG_H
  14 #define JUNCTION_CONCURRENTMAP_LEAPFROG_H
  15
  16 #include <junction/Core.h>
  17 #include <junction/details/LeapFrog.h>
  18 #include <junction/QSBR.h>
  19 #include <turf/Heap.h>
  20 #include <turf/Trace.h>
  21
  22 namespace junction {
  23
  24 TURF_TRACE_DECLARE(ConcurrentMap_LeapFrog, 17)
  25
  26 template <typename K, typename V, class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V> >
  27 class ConcurrentMap_LeapFrog {
  28 public:
  29     typedef K Key;
  30     typedef V Value;
  31     typedef KT KeyTraits;
  32     typedef VT ValueTraits;
  33     typedef typename turf::util::BestFit<Key>::Unsigned Hash;
  34     typedef details::LeapFrog<ConcurrentMap_LeapFrog> Details;
  35
  36 private:
  37     turf::Atomic<typename Details::Table*> m_root;
  38
  39 public:
  40     ConcurrentMap_LeapFrog(ureg capacity = Details::InitialSize) : m_root(Details::Table::create(capacity)) {
  41     }
  42
  43     ~ConcurrentMap_LeapFrog() {
  44         typename Details::Table* table = m_root.loadNonatomic();
  45         table->destroy();
  46     }
  47
  48     // publishTableMigration() is called by exactly one thread from Details::TableMigration::run()
  49     // after all the threads participating in the migration have completed their work.
  50     void publishTableMigration(typename Details::TableMigration* migration) {
  51         // There are no racing calls to this function.
  52         typename Details::Table* oldRoot = m_root.loadNonatomic();
  53         m_root.store(migration->m_destination, turf::Release);
  54         TURF_ASSERT(oldRoot == migration->getSources()[0].table);
  55         // Caller will GC the TableMigration and the source table.
  56     }
  57
  58     // A Mutator represents a known cell in the hash table.
  59     // It's meant for manipulations within a temporary function scope.
  60     // Obviously you must not call QSBR::Update while holding a Mutator.
  61     // Any operation that modifies the table (exchangeValue, eraseValue)
  62     // may be forced to follow a redirected cell, which changes the Mutator itself.
  63     // Note that even if the Mutator was constructed from an existing cell,
  64     // exchangeValue() can still trigger a resize if the existing cell was previously marked deleted,
  65     // or if another thread deletes the key between the two steps.
  66     class Mutator {
  67     private:
  68         friend class ConcurrentMap_LeapFrog;
  69
  70         ConcurrentMap_LeapFrog& m_map;
  71         typename Details::Table* m_table;
  72         typename Details::Cell* m_cell;
  73         Value m_value;
  74
  75         // Constructor: Find existing cell
  76         Mutator(ConcurrentMap_LeapFrog& map, Key key, bool) : m_map(map), m_value(Value(ValueTraits::NullValue)) {
  77             TURF_TRACE(ConcurrentMap_LeapFrog, 0, "[Mutator] find constructor called", uptr(m_table), uptr(key));
  78             Hash hash = KeyTraits::hash(key);
  79             for (;;) {
  80                 m_table = m_map.m_root.load(turf::Consume);
  81                 m_cell = Details::find(hash, m_table);
  82                 if (!m_cell)
  83                     return;
  84                 m_value = m_cell->value.load(turf::Consume);
  85                 if (m_value != Value(ValueTraits::Redirect))
  86                     return; // Found an existing value
  87                 // We've encountered a Redirect value. Help finish the migration.
  88                 TURF_TRACE(ConcurrentMap_LeapFrog, 1, "[Mutator] find was redirected", uptr(m_table), 0);
  89                 m_table->jobCoordinator.participate();
  90                 // Try again using the latest root.
  91             }
  92         }
  93
  94         // Constructor: Insert cell
  95         Mutator(ConcurrentMap_LeapFrog& map, Key key)
  96             : m_map(map), m_table(map.m_root.load(turf::Consume)), m_value(Value(ValueTraits::NullValue)) {
  97             TURF_TRACE(ConcurrentMap_LeapFrog, 2, "[Mutator] insert constructor called", uptr(m_table), uptr(key));
  98             Hash hash = KeyTraits::hash(key);
  99             bool mustDouble = false;
 100             for (;;) {
 101                 m_table = m_map.m_root.load(turf::Consume);
 102                 ureg overflowIdx;
 103                 switch (Details::insert(hash, m_table, m_cell, overflowIdx)) { // Modifies m_cell
 104                 case Details::InsertResult_InsertedNew: {
 105                     // We've inserted a new cell. Don't load m_cell->value.
 106                     return;
 107                 }
 108                 case Details::InsertResult_AlreadyFound: {
 109                     // The hash was already found in the table.
 110                     m_value = m_cell->value.load(turf::Consume);
 111                     if (m_value == Value(ValueTraits::Redirect)) {
 112                         // We've encountered a Redirect value.
 113                         TURF_TRACE(ConcurrentMap_LeapFrog, 3, "[Mutator] insert was redirected", uptr(m_table), uptr(m_value));
 114                         break; // Help finish the migration.
 115                     }
 116                     return; // Found an existing value
 117                 }
 118                 case Details::InsertResult_Overflow: {
 119                     Details::beginTableMigration(m_map, m_table, overflowIdx, mustDouble);
 120                     break;
 121                 }
 122                 }
 123                 // A migration has been started (either by us, or another thread). Participate until it's complete.
 124                 m_table->jobCoordinator.participate();
 125                 // If we still overflow after this, avoid an infinite loop by forcing the next table to double.
 126                 mustDouble = true;
 127                 // Try again using the latest root.
 128             }
 129         }
 130
 131     public:
 132         Value getValue() const {
 133             // Return previously loaded value. Don't load it again.
 134             return Value(m_value);
 135         }
 136
 137         Value exchangeValue(Value desired) {
 138             TURF_ASSERT(desired != Value(ValueTraits::NullValue));
 139             TURF_ASSERT(m_cell); // Cell must have been found or inserted
 140             TURF_TRACE(ConcurrentMap_LeapFrog, 4, "[Mutator::exchangeValue] called", uptr(m_table), uptr(m_value));
 141             bool mustDouble = false;
 142             for (;;) {
 143                 Value oldValue = m_value;
 144                 if (m_cell->value.compareExchangeStrong(m_value, desired, turf::ConsumeRelease)) {
 145                     // Exchange was successful. Return previous value.
 146                     TURF_TRACE(ConcurrentMap_LeapFrog, 5, "[Mutator::exchangeValue] exchanged Value", uptr(m_value),
 147                                uptr(desired));
 148                     Value result = m_value;
 149                     m_value = desired; // Leave the mutator in a valid state
 150                     return result;
 151                 }
 152                 // The CAS failed and m_value has been updated with the latest value.
 153                 if (m_value != Value(ValueTraits::Redirect)) {
 154                     TURF_TRACE(ConcurrentMap_LeapFrog, 6, "[Mutator::exchangeValue] detected race to write value", uptr(m_table),
 155                                uptr(m_value));
 156                     if (oldValue == Value(ValueTraits::NullValue) && m_value != Value(ValueTraits::NullValue)) {
 157                         TURF_TRACE(ConcurrentMap_LeapFrog, 7, "[Mutator::exchangeValue] racing write inserted new value",
 158                                    uptr(m_table), uptr(m_value));
 159                     }
 160                     // There was a racing write (or erase) to this cell.
 161                     // Pretend we exchanged with ourselves, and just let the racing write win.
 162                     return desired;
 163                 }
 164                 // We've encountered a Redirect value. Help finish the migration.
 165                 TURF_TRACE(ConcurrentMap_LeapFrog, 8, "[Mutator::exchangeValue] was redirected", uptr(m_table), uptr(m_value));
 166                 Hash hash = m_cell->hash.load(turf::Relaxed);
 167                 for (;;) {
 168                     // Help complete the migration.
 169                     m_table->jobCoordinator.participate();
 170                     // Try again in the new table.
 171                     m_table = m_map.m_root.load(turf::Consume);
 172                     m_value = Value(ValueTraits::NullValue);
 173                     ureg overflowIdx;
 174                     switch (Details::insert(hash, m_table, m_cell, overflowIdx)) { // Modifies m_cell
 175                     case Details::InsertResult_AlreadyFound:
 176                         m_value = m_cell->value.load(turf::Consume);
 177                         if (m_value == Value(ValueTraits::Redirect)) {
 178                             TURF_TRACE(ConcurrentMap_LeapFrog, 9, "[Mutator::exchangeValue] was re-redirected", uptr(m_table),
 179                                        uptr(m_value));
 180                             break;
 181                         }
 182                         goto breakOuter;
 183                     case Details::InsertResult_InsertedNew:
 184                         goto breakOuter;
 185                     case Details::InsertResult_Overflow:
 186                         TURF_TRACE(ConcurrentMap_LeapFrog, 10, "[Mutator::exchangeValue] overflow after redirect", uptr(m_table),
 187                                    overflowIdx);
 188                         Details::beginTableMigration(m_map, m_table, overflowIdx, mustDouble);
 189                         break;
 190                     }
 191                     // We were redirected... again
 192                 }
 193             breakOuter:;
 194                 // If we still overflow after this, avoid an infinite loop by forcing the next table to double.
 195                 mustDouble = true;
 196                 // Try again in the new table.
 197             }
 198         }
 199
 200         void setValue(Value desired) {
 201             exchangeValue(desired);
 202         }
 203
 204         Value eraseValue() {
 205             TURF_ASSERT(m_cell); // Cell must have been found or inserted
 206             TURF_TRACE(ConcurrentMap_LeapFrog, 11, "[Mutator::eraseValue] called", uptr(m_table), uptr(m_cell));
 207             for (;;) {
 208                 if (m_value == Value(ValueTraits::NullValue))
 209                     return Value(m_value);
 210                 TURF_ASSERT(m_cell); // m_value is non-NullValue, therefore cell must have been found or inserted.
 211                 if (m_cell->value.compareExchangeStrong(m_value, Value(ValueTraits::NullValue), turf::Consume)) {
 212                     // Exchange was successful and a non-NULL value was erased and returned by reference in m_value.
 213                     TURF_ASSERT(m_value != ValueTraits::NullValue); // Implied by the test at the start of the loop.
 214                     Value result = m_value;
 215                     m_value = Value(ValueTraits::NullValue); // Leave the mutator in a valid state
 216                     return result;
 217                 }
 218                 // The CAS failed and m_value has been updated with the latest value.
 219                 TURF_TRACE(ConcurrentMap_LeapFrog, 12, "[Mutator::eraseValue] detected race to write value", uptr(m_table),
 220                            uptr(m_cell));
 221                 if (m_value != Value(ValueTraits::Redirect)) {
 222                     // There was a racing write (or erase) to this cell.
 223                     // Pretend we erased nothing, and just let the racing write win.
 224                     return Value(ValueTraits::NullValue);
 225                 }
 226                 // We've been redirected to a new table.
 227                 TURF_TRACE(ConcurrentMap_LeapFrog, 13, "[Mutator::eraseValue] was redirected", uptr(m_table), uptr(m_cell));
 228                 Hash hash = m_cell->hash.load(turf::Relaxed); // Re-fetch hash
 229                 for (;;) {
 230                     // Help complete the migration.
 231                     m_table->jobCoordinator.participate();
 232                     // Try again in the new table.
 233                     m_table = m_map.m_root.load(turf::Consume);
 234                     m_cell = Details::find(hash, m_table);
 235                     if (!m_cell) {
 236                         m_value = Value(ValueTraits::NullValue);
 237                         return m_value;
 238                     }
 239                     m_value = m_cell->value.load(turf::Relaxed);
 240                     if (m_value != Value(ValueTraits::Redirect))
 241                         break;
 242                     TURF_TRACE(ConcurrentMap_LeapFrog, 14, "[Mutator::eraseValue] was re-redirected", uptr(m_table),
 243                                uptr(m_cell));
 244                 }
 245             }
 246         }
 247     };
 248
 249     Mutator insert(Key key) {
 250         return Mutator(*this, key);
 251     }
 252
 253     Mutator find(Key key) {
 254         return Mutator(*this, key, false);
 255     }
 256
 257     // Lookup without creating a temporary Mutator.
 258     Value get(Key key) {
 259         Hash hash = KeyTraits::hash(key);
 260         TURF_TRACE(ConcurrentMap_LeapFrog, 15, "[get] called", uptr(this), uptr(hash));
 261         for (;;) {
 262             typename Details::Table* table = m_root.load(turf::Consume);
 263             typename Details::Cell* cell = Details::find(hash, table);
 264             if (!cell)
 265                 return Value(ValueTraits::NullValue);
 266             Value value = cell->value.load(turf::Consume);
 267             if (value != Value(ValueTraits::Redirect))
 268                 return value; // Found an existing value
 269             // We've been redirected to a new table. Help with the migration.
 270             TURF_TRACE(ConcurrentMap_LeapFrog, 16, "[get] was redirected", uptr(table), uptr(hash));
 271             table->jobCoordinator.participate();
 272             // Try again in the new table.
 273         }
 274     }
 275
 276     Value insert(Key key, Value desired) {
 277         Mutator iter(*this, key);
 278         return iter.exchangeValue(desired);
 279     }
 280
 281     Value exchange(Key key, Value desired) {
 282         Mutator iter(*this, key);
 283         return iter.exchangeValue(desired);
 284     }
 285
 286     Value erase(Key key) {
 287         Mutator iter(*this, key, false);
 288         return iter.eraseValue();
 289     }
 290
 291     // The easiest way to implement an Iterator is to prevent all Redirects.
 292     // The currrent Iterator does that by forbidding concurrent inserts.
 293     // To make it work with concurrent inserts, we'd need a way to block TableMigrations.
 294     class Iterator {
 295     private:
 296         typename Details::Table* m_table;
 297         ureg m_idx;
 298         Key m_hash;
 299         Value m_value;
 300
 301     public:
 302         Iterator(ConcurrentMap_LeapFrog& map) {
 303             // Since we've forbidden concurrent inserts (for now), nonatomic would suffice here, but let's plan ahead:
 304             m_table = map.m_root.load(turf::Consume);
 305             m_idx = -1;
 306             next();
 307         }
 308
 309         void next() {
 310             TURF_ASSERT(m_table);
 311             TURF_ASSERT(isValid() || m_idx == -1); // Either the Iterator is already valid, or we've just started iterating.
 312             while (++m_idx <= m_table->sizeMask) {
 313                 // Index still inside range of table.
 314                 typename Details::CellGroup* group = m_table->getCellGroups() + (m_idx >> 2);
 315                 typename Details::Cell* cell = group->cells + (m_idx & 3);
 316                 m_hash = cell->hash.load(turf::Relaxed);
 317                 if (m_hash != KeyTraits::NullHash) {
 318                     // Cell has been reserved.
 319                     m_value = cell->value.load(turf::Relaxed);
 320                     TURF_ASSERT(m_value != Value(ValueTraits::Redirect));
 321                     if (m_value != Value(ValueTraits::NullValue))
 322                         return; // Yield this cell.
 323                 }
 324             }
 325             // That's the end of the map.
 326             m_hash = KeyTraits::NullHash;
 327             m_value = ValueTraits::NullValue;
 328         }
 329
 330         bool isValid() const {
 331             return m_value != Value(ValueTraits::NullValue);
 332         }
 333
 334         Key getKey() const {
 335             TURF_ASSERT(isValid());
 336             // Since we've forbidden concurrent inserts (for now), nonatomic would suffice here, but let's plan ahead:
 337             return KeyTraits::dehash(m_hash);
 338         }
 339
 340         Value getValue() const {
 341             TURF_ASSERT(isValid());
 342             return m_value;
 343         }
 344     };
 345 };
 346
 347 } // namespace junction
 348
 349 #endif // JUNCTION_CONCURRENTMAP_LEAPFROG_H