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