pd.if.org Git - nbds/blob - map/skiplist.c

   1 /*
   2  * Written by Josh Dybnis and released to the public domain, as explained at
   3  * http://creativecommons.org/licenses/publicdomain
   4  *
   5  * Implementation of the lock-free skiplist data-structure created by Maurice Herlihy, Yossi Lev,
   6  * and Nir Shavit. See Herlihy's and Shivit's book "The Art of Multiprocessor Programming".
   7  * http://www.amazon.com/Art-Multiprocessor-Programming-Maurice-Herlihy/dp/0123705916/
   8  *
   9  * See also Kir Fraser's dissertation "Practical Lock Freedom".
  10  * www.cl.cam.ac.uk/techreports/UCAM-CL-TR-579.pdf
  11  *
  12  * I've generalized the data structure to support update operations like set() and CAS() in addition to
  13  * the normal add() and remove() operations.
  14  *
  15  * Warning: This code is written for the x86 memory-model. The algorithim depends on certain stores
  16  * and loads being ordered. This code won't work correctly on platforms with weaker memory models if
  17  * you don't add memory barriers in the right places.
  18  */
  19
  20 #include <stdio.h>
  21 #include <string.h>
  22
  23 #include "common.h"
  24 #include "runtime.h"
  25 #include "skiplist.h"
  26 #include "mem.h"
  27
  28 // Setting MAX_LEVEL to 0 essentially makes this data structure the Harris-Michael lock-free list (in list.c).
  29 #define MAX_LEVEL 31
  30
  31 typedef struct node {
  32     void *key;
  33     uint64_t val;
  34     int top_level;
  35     struct node *next[];
  36 } node_t;
  37
  38 struct sl {
  39     node_t *head;
  40     const datatype_t *key_type;
  41 };
  42
  43 static int random_level (void) {
  44     unsigned r = nbd_rand();
  45     if (r & 1)
  46         return 0;
  47 #if MAX_LEVEL < 31
  48     r |= 1 << (MAX_LEVEL+1);
  49 #endif
  50     int n = __builtin_ctz(r)-1;
  51     assert(n <= MAX_LEVEL);
  52     return n;
  53 }
  54
  55 static node_t *node_alloc (int level, void *key, uint64_t val) {
  56     assert(level >= 0 && level <= MAX_LEVEL);
  57     size_t sz = sizeof(node_t) + (level + 1) * sizeof(node_t *);
  58     node_t *item = (node_t *)nbd_malloc(sz);
  59     memset(item, 0, sz);
  60     item->key = key;
  61     item->val = val;
  62     item->top_level = level;
  63     return item;
  64 }
  65
  66 skiplist_t *sl_alloc (const datatype_t *key_type) {
  67     skiplist_t *sl = (skiplist_t *)nbd_malloc(sizeof(skiplist_t));
  68     sl->key_type = key_type;
  69     sl->head = node_alloc(MAX_LEVEL, NULL, 0);
  70     memset(sl->head->next, 0, (MAX_LEVEL+1) * sizeof(skiplist_t *));
  71     return sl;
  72 }
  73
  74 void sl_free (skiplist_t *sl) {
  75     node_t *item = sl->head->next[0];
  76     while (item) {
  77         node_t *next = (node_t *)STRIP_TAG(item->next[0]);
  78         nbd_free(item);
  79         item = next;
  80     }
  81 }
  82
  83 uint64_t sl_count (skiplist_t *sl) {
  84     uint64_t count = 0;
  85     node_t *item = sl->head->next[0];
  86     while (item) {
  87         if (!IS_TAGGED(item->next[0])) {
  88             count++;
  89         }
  90         item = (node_t *)STRIP_TAG(item->next[0]);
  91     }
  92     return count;
  93 }
  94
  95 static node_t *find_preds (node_t **preds, node_t **succs, int n, skiplist_t *sl, void *key, int help_remove) {
  96     node_t *pred = sl->head;
  97     node_t *item = NULL;
  98     TRACE("s2", "find_preds: searching for key %p in skiplist (head is %p)", key, pred);
  99     int d;
 100     int start_level = MAX_LEVEL;
 101 #if MAX_LEVEL > 2
 102     // Optimization for small lists. No need to traverse empty higher levels.
 103     start_level = 2;
 104     while (pred->next[start_level+1] != NULL) {
 105         start_level += start_level - 1;
 106         if (EXPECT_FALSE(start_level >= MAX_LEVEL)) {
 107             start_level = MAX_LEVEL;
 108             break;
 109         }
 110     }
 111     if (EXPECT_FALSE(start_level < n)) {
 112         start_level = n;
 113     }
 114 #endif
 115
 116     // Traverse the levels of <sl> from the top level to the bottom
 117     for (int level = start_level; level >= 0; --level) {
 118         TRACE("s3", "find_preds: level %llu", level, 0);
 119         item = pred->next[level];
 120         if (EXPECT_FALSE(IS_TAGGED(item))) {
 121             TRACE("s2", "find_preds: pred %p is marked for removal (item %p); retry", pred, item);
 122             return find_preds(preds, succs, n, sl, key, help_remove); // retry
 123         }
 124         while (item != NULL) {
 125             node_t *next = item->next[level];
 126
 127             // A tag means an item is logically removed but not physically unlinked yet.
 128             while (EXPECT_FALSE(IS_TAGGED(next))) {
 129
 130                 // Skip over logically removed items.
 131                 if (!help_remove) {
 132                     item = (node_t *)STRIP_TAG(item->next);
 133                     if (EXPECT_FALSE(item == NULL))
 134                         break;
 135                     TRACE("s3", "find_preds: skipping marked item %p (next is %p)", item, next);
 136                     next = item->next[level];
 137                     continue;
 138                 }
 139
 140                 // Unlink logically removed items.
 141                 node_t *other;
 142                 TRACE("s3", "find_preds: unlinking marked item %p; next is %p", item, next);
 143                 if ((other = SYNC_CAS(&pred->next[level], item, STRIP_TAG(next))) == item) {
 144                     item = (node_t *)STRIP_TAG(next);
 145                     if (EXPECT_FALSE(item == NULL))
 146                         break;
 147                     next = item->next[level];
 148                     TRACE("s3", "find_preds: now the current item is %p next is %p", item, next);
 149
 150                     // The thread that completes the unlink should free the memory.
 151                     if (level == 0) {
 152                         if (sl->key_type != NULL) {
 153                             nbd_defer_free((void*)other->key);
 154                         }
 155                         nbd_defer_free(other);
 156                     }
 157                 } else {
 158                     TRACE("s3", "find_preds: lost race to unlink item %p from pred %p", item, pred);
 159                     TRACE("s3", "find_preds: pred's link changed to %p", other, 0);
 160                     if (IS_TAGGED(other))
 161                         return find_preds(preds, succs, n, sl, key, help_remove); // retry
 162                     item = other;
 163                     if (EXPECT_FALSE(item == NULL))
 164                         break;
 165                     next = item->next[level];
 166                 }
 167             }
 168
 169             if (EXPECT_FALSE(item == NULL))
 170                 break;
 171
 172             TRACE("s4", "find_preds: visiting item %p (next is %p)", item, next);
 173             TRACE("s4", "find_preds: key %p val %p", STRIP_TAG(item->key), item->val);
 174
 175             if (EXPECT_TRUE(sl->key_type == NULL)) {
 176                 d = (uint64_t)item->key - (uint64_t)key;
 177             } else {
 178                 d = sl->key_type->cmp(item->key, key);
 179             }
 180
 181             if (d >= 0) {
 182                 TRACE("s4", "find_preds: found pred %p item %p", pred, item);
 183                 break;
 184             }
 185
 186             pred = item;
 187             item = next;
 188         }
 189
 190         // The cast to unsigned is for the case when n is -1.
 191         if ((unsigned)level <= (unsigned)n) {
 192             if (preds != NULL) {
 193                 preds[level] = pred;
 194             }
 195             if (succs != NULL) {
 196                 succs[level] = item;
 197             }
 198         }
 199     }
 200
 201      // fill in empty levels
 202      if (n == -1 && item != NULL) {
 203          for (int level = start_level + 1; level <= item->top_level; ++level) {
 204              preds[level] = sl->head;
 205          }
 206      }
 207
 208     if (d == 0) {
 209         TRACE("s2", "find_preds: found matching item %p in skiplist, pred is %p", item, pred);
 210         return item;
 211     }
 212     TRACE("s2", "find_preds: found proper place for key %p in skiplist, pred is %p. returning null", key, pred);
 213     return NULL;
 214 }
 215
 216 // Fast find that does not help unlink partially removed nodes and does not return the node's predecessors.
 217 uint64_t sl_lookup (skiplist_t *sl, void *key) {
 218     TRACE("s1", "sl_lookup: searching for key %p in skiplist %p", key, sl);
 219     node_t *item = find_preds(NULL, NULL, 0, sl, key, FALSE);
 220
 221     // If we found an <item> matching the <key> return its value.
 222     if (item != NULL) {
 223         uint64_t val = item->val;
 224         if (val != DOES_NOT_EXIST) {
 225             TRACE("s1", "sl_lookup: found item %p. val %p. returning item", item, item->val);
 226             return val;
 227         }
 228     }
 229
 230     TRACE("l1", "sl_lookup: no item in the skiplist matched the key", 0, 0);
 231     return DOES_NOT_EXIST;
 232 }
 233
 234 uint64_t sl_cas (skiplist_t *sl, void *key, uint64_t expectation, uint64_t new_val) {
 235     TRACE("s1", "sl_cas: key %p skiplist %p", key, sl);
 236     TRACE("s1", "sl_cas: expectation %p new value %p", expectation, new_val);
 237     ASSERT((int64_t)new_val > 0);
 238
 239     node_t *preds[MAX_LEVEL+1];
 240     node_t *nexts[MAX_LEVEL+1];
 241     node_t *new_item = NULL;
 242     int n = random_level();
 243     do {
 244         node_t *old_item = find_preds(preds, nexts, n, sl, key, TRUE);
 245         if (old_item == NULL) {
 246
 247             // There was not an item in the skiplist that matches the key.
 248             if (EXPECT_FALSE((int64_t)expectation > 0 || expectation == CAS_EXPECT_EXISTS)) {
 249                 TRACE("l1", "sl_cas: the expectation was not met, the skiplist was not changed", 0, 0);
 250                 return DOES_NOT_EXIST; // failure
 251             }
 252
 253             ASSERT(expectation == CAS_EXPECT_DOES_NOT_EXIST || expectation == CAS_EXPECT_WHATEVER);
 254
 255             // First insert <new_item> into the bottom level.
 256             TRACE("s3", "sl_cas: attempting to insert item between %p and %p", preds[0], nexts[0]);
 257             void *new_key  = (sl->key_type == NULL) ? key : sl->key_type->clone(key);
 258             new_item = node_alloc(n, new_key, new_val);
 259             node_t *pred = preds[0];
 260             node_t *next = new_item->next[0] = nexts[0];
 261             for (int level = 1; level <= new_item->top_level; ++level) {
 262                 new_item->next[level] = nexts[level];
 263             }
 264             node_t *other = SYNC_CAS(&pred->next[0], next, new_item);
 265             if (other == next) {
 266                 TRACE("s3", "sl_cas: successfully inserted item %p at level 0", new_item, 0);
 267                 break; // success
 268             }
 269             TRACE("s3", "sl_cas: failed to change pred's link: expected %p found %p", next, other);
 270             if (sl->key_type != NULL) {
 271                 nbd_free(new_key);
 272             }
 273             nbd_free(new_item);
 274             continue;
 275         }
 276
 277         // Found an item in the skiplist that matches the key.
 278         uint64_t old_item_val = old_item->val;
 279         do {
 280             // If the item's value is DOES_NOT_EXIST it means another thread removed the node out from under us.
 281             if (EXPECT_FALSE(old_item_val == DOES_NOT_EXIST)) {
 282                 TRACE("s2", "sl_cas: lost a race, found an item but another thread removed it. retry", 0, 0);
 283                 break; // retry
 284             }
 285
 286             if (EXPECT_FALSE(expectation == CAS_EXPECT_DOES_NOT_EXIST)) {
 287                 TRACE("s1", "sl_cas: found an item %p in the skiplist that matched the key. the expectation was "
 288                         "not met, the skiplist was not changed", old_item, old_item_val);
 289                 return old_item_val; // failure
 290             }
 291
 292             // Use a CAS and not a SWAP. If the node is in the process of being removed and we used a SWAP, we could
 293             // replace DOES_NOT_EXIST with our value. Then another thread that is updating the value could think it
 294             // succeeded and return our value even though we indicated that the node has been removed. If the CAS
 295             // fails it means another thread either removed the node or updated its value.
 296             uint64_t ret_val = SYNC_CAS(&old_item->val, old_item_val, new_val);
 297             if (ret_val == old_item_val) {
 298                 TRACE("s1", "sl_cas: the CAS succeeded. updated the value of the item", 0, 0);
 299                 return ret_val; // success
 300             }
 301             TRACE("s2", "sl_cas: lost a race. the CAS failed. another thread changed the item's value", 0, 0);
 302
 303             old_item_val = ret_val;
 304         } while (1);
 305     } while (1);
 306
 307     // Link <new_item> into <sl> from the bottom up.
 308     for (int level = 1; level <= new_item->top_level; ++level) {
 309         node_t *pred = preds[level];
 310         node_t *next = nexts[level];
 311         do {
 312             TRACE("s3", "sl_cas: attempting to insert item between %p and %p", pred, next);
 313             node_t *other = SYNC_CAS(&pred->next[level], next, new_item);
 314             if (other == next) {
 315                 TRACE("s3", "sl_cas: successfully inserted item %p at level %llu", new_item, level);
 316                 break; // success
 317             }
 318             TRACE("s3", "sl_cas: failed to change pred's link: expected %p found %p", next, other);
 319             find_preds(preds, nexts, new_item->top_level, sl, key, TRUE);
 320             pred = preds[level];
 321             next = nexts[level];
 322
 323             // Update <new_item>'s next pointer
 324             do {
 325                 // There in no need to continue linking in the item if another thread removed it.
 326                 node_t *old_next = ((volatile node_t *)new_item)->next[level];
 327                 if (IS_TAGGED(old_next))
 328                     return DOES_NOT_EXIST; // success
 329
 330                 // Use a CAS so we do not inadvertantly stomp on a mark another thread placed on the item.
 331                 if (old_next == next || SYNC_CAS(&new_item->next[level], old_next, next) == old_next)
 332                     break;
 333             } while (1);
 334         } while (1);
 335     }
 336     return DOES_NOT_EXIST; // success
 337 }
 338
 339 uint64_t sl_remove (skiplist_t *sl, void *key) {
 340     TRACE("s1", "sl_remove: removing item with key %p from skiplist %p", key, sl);
 341     node_t *preds[MAX_LEVEL+1];
 342     node_t *item = find_preds(preds, NULL, -1, sl, key, TRUE);
 343     if (item == NULL) {
 344         TRACE("s3", "sl_remove: remove failed, an item with a matching key does not exist in the skiplist", 0, 0);
 345         return DOES_NOT_EXIST;
 346     }
 347
 348     // Mark and unlink <item> at each level of <sl> from the top down. If multiple threads try to concurrently remove
 349     // the same item only one of them should succeed. Marking the bottom level establishes which of them succeeds.
 350     for (int level = item->top_level; level > 0; --level) {
 351         node_t *next;
 352         node_t *old_next = item->next[level];
 353         do {
 354             next = old_next;
 355             old_next = SYNC_CAS(&item->next[level], next, TAG_VALUE(next));
 356             if (IS_TAGGED(old_next)) {
 357                 TRACE("s2", "sl_remove: %p is already marked for removal by another thread at level %llu", item, level);
 358                 break;
 359             }
 360         } while (next != old_next);
 361
 362         node_t *pred = preds[level];
 363         TRACE("s2", "sl_remove: linking the item's pred %p to the item's successor %p", pred, STRIP_TAG(next));
 364         node_t *other = NULL;
 365         if ((other = SYNC_CAS(&pred->next[level], item, STRIP_TAG(next))) != item) {
 366             TRACE("s1", "sl_remove: unlink failed; pred's link changed from %p to %p", item, other);
 367             // If our former predecessor now points past us we know another thread unlinked us. Otherwise, we need
 368             // to search for a new set of preds.
 369             if (other == NULL)
 370                 continue; // <pred> points past <item> to the end of the list; go on to the next level.
 371
 372             int d = -1;
 373             if (!IS_TAGGED(other)) {
 374                 if (EXPECT_TRUE(sl->key_type == NULL)) {
 375                     d = (uint64_t)item->key - (uint64_t)other->key;
 376                 } else {
 377                     d = sl->key_type->cmp(item->key, other->key);
 378                 }
 379             }
 380             if (d > 0) {
 381                 node_t *temp = find_preds(preds, NULL, level, sl, key, TRUE);
 382                 if (temp != item)
 383                     return DOES_NOT_EXIST; // Another thread removed the item we were targeting.
 384                 level++; // Redo this level.
 385             }
 386         }
 387     }
 388
 389     node_t *next;
 390     node_t *old_next = item->next[0];
 391     do {
 392         next = old_next;
 393         old_next = SYNC_CAS(&item->next[0], next, TAG_VALUE(next));
 394         if (IS_TAGGED(old_next)) {
 395             TRACE("s2", "sl_remove: %p is already marked for removal by another thread at level 0", item, 0);
 396             return DOES_NOT_EXIST;
 397         }
 398     } while (next != old_next);
 399     TRACE("s1", "sl_remove: marked item %p removed at level 0", item, 0);
 400
 401     // Atomically swap out the item's value in case another thread is updating the item while we are
 402     // removing it. This establishes which operation occurs first logically, the update or the remove.
 403     uint64_t val = SYNC_SWAP(&item->val, DOES_NOT_EXIST);
 404     TRACE("s2", "sl_remove: replaced item %p's value with DOES_NOT_EXIT", item, 0);
 405
 406     node_t *pred = preds[0];
 407     TRACE("s2", "sl_remove: linking the item's pred %p to the item's successor %p", pred, STRIP_TAG(next));
 408     if (SYNC_CAS(&pred->next[0], item, STRIP_TAG(next))) {
 409         TRACE("s2", "sl_remove: unlinked item %p from the skiplist at level 0", item, 0);
 410         // The thread that completes the unlink should free the memory.
 411         if (sl->key_type != NULL) {
 412             nbd_defer_free(item->key);
 413         }
 414         nbd_defer_free(item);
 415     }
 416     return val;
 417 }
 418
 419 void sl_print (skiplist_t *sl) {
 420     for (int level = MAX_LEVEL; level >= 0; --level) {
 421         node_t *item = sl->head;
 422         if (item->next[level] == NULL)
 423             continue;
 424         printf("(%d) ", level);
 425         int i = 0;
 426         while (item) {
 427             node_t *next = item->next[level];
 428             printf("%s%p ", IS_TAGGED(next) ? "*" : "", item);
 429             item = (node_t *)STRIP_TAG(next);
 430             if (i++ > 30) {
 431                 printf("...");
 432                 break;
 433             }
 434         }
 435         printf("\n");
 436         fflush(stdout);
 437     }
 438     node_t *item = sl->head;
 439     int i = 0;
 440     while (item) {
 441         int is_marked = IS_TAGGED(item->next[0]);
 442         printf("%s%p:%p ", is_marked ? "*" : "", item, item->key);
 443         if (item != sl->head) {
 444             printf("[%d]", item->top_level);
 445         } else {
 446             printf("[HEAD]");
 447         }
 448         for (int level = 1; level <= item->top_level; ++level) {
 449             node_t *next = (node_t *)STRIP_TAG(item->next[level]);
 450             is_marked = IS_TAGGED(item->next[0]);
 451             printf(" %p%s", next, is_marked ? "*" : "");
 452             if (item == sl->head && item->next[level] == NULL)
 453                 break;
 454         }
 455         printf("\n");
 456         fflush(stdout);
 457         item = (node_t *)STRIP_TAG(item->next[0]);
 458         if (i++ > 30) {
 459             printf("...\n");
 460             break;
 461         }
 462     }
 463 }