generalize skiplist from a set to an updatable map
[nbds] / struct / list.c
1 /* 
2  * Written by Josh Dybnis and released to the public domain, as explained at
3  * http://creativecommons.org/licenses/publicdomain
4  *
5  * Harris-Michael lock-free list-based set
6  * http://www.research.ibm.com/people/m/michael/spaa-2002.pdf
7  */
8 #include <stdio.h>
9 #include <string.h>
10
11 #include "common.h"
12 #include "struct.h"
13 #include "nstring.h"
14 #include "mem.h"
15
16 typedef struct node {
17     nstring_t *key;
18     uint64_t val;
19     struct node *next;
20 } node_t;
21
22 struct ll {
23     node_t *head;
24 };
25
26 static node_t *node_alloc (const void *key_data, uint32_t key_len, uint64_t val) {
27     node_t *item = (node_t *)nbd_malloc(sizeof(node_t));
28     memset(item, 0, sizeof(node_t));
29     // If <key_len> is -1 it indicates <key_data> is an integer and not a pointer
30     item->key = (key_len == (unsigned)-1) 
31               ? (void *)TAG_VALUE(key_data) 
32               : ns_alloc(key_data, key_len); 
33     item->val = val;
34     return item;
35 }
36
37 static void node_free (node_t *item) {
38     if (!IS_TAGGED(item->key)) {
39         nbd_free(item->key);
40     }
41     nbd_free(item);
42 }
43
44 static void node_defer_free (node_t *item) {
45     if (!IS_TAGGED(item->key)) {
46         nbd_defer_free(item->key);
47     }
48     nbd_defer_free(item);
49 }
50
51 list_t *ll_alloc (void) {
52     list_t *ll = (list_t *)nbd_malloc(sizeof(list_t));
53     ll->head = node_alloc(" ", 0, 0);
54     ll->head->next = NULL;
55     return ll;
56 }
57
58 static int find_pred (node_t **pred_ptr, node_t **item_ptr, list_t *ll, const void *key_data, uint32_t key_len, int help_remove) {
59     node_t *pred = ll->head;
60     node_t *item = pred->next;
61     TRACE("l2", "find_pred: searching for key %p in ll (head is %p)", key_data, pred);
62
63     while (item != NULL) {
64         node_t *next = item->next;
65
66         // A tag means an item is logically removed but not physically unlinked yet.
67         while (EXPECT_FALSE(IS_TAGGED(next))) {
68
69             // Skip over logically removed items.
70             if (!help_remove) {
71                 item = (node_t *)STRIP_TAG(item->next);
72                 if (EXPECT_FALSE(item == NULL))
73                     break;
74                 TRACE("l3", "find_pred: skipping marked item %p (next is %p)", item, next);
75                 next = item->next;
76                 continue;
77             }
78
79             // Unlink logically removed items.
80             node_t *other;
81             TRACE("l3", "find_pred: unlinking marked item %p next is %p", item, next);
82             if ((other = SYNC_CAS(&pred->next, item, STRIP_TAG(next))) == item) {
83                 TRACE("l2", "find_pred: unlinked item %p from pred %p", item, pred);
84                 item = (node_t *)STRIP_TAG(next);
85                 if (EXPECT_FALSE(item == NULL))
86                     break;
87                 next = item->next;
88                 TRACE("l3", "find_pred: now current item is %p next is %p", item, next);
89
90                 // The thread that completes the unlink should free the memory.
91                 node_defer_free(other);
92             } else {
93                 TRACE("l2", "find_pred: lost a race to unlink item %p from pred %p", item, pred);
94                 TRACE("l2", "find_pred: pred's link changed to %p", other, 0);
95                 if (IS_TAGGED(other))
96                     return find_pred(pred_ptr, item_ptr, ll, key_data, key_len, help_remove); // retry
97                 item = other;
98                 if (EXPECT_FALSE(item == NULL))
99                     break;
100                 next = item->next;
101             }
102         }
103
104         if (EXPECT_FALSE(item == NULL))
105             break;
106
107         TRACE("l3", "find_pred: visiting item %p (next is %p)", item, next);
108         TRACE("l4", "find_pred: key %p val %p", STRIP_TAG(item->key), item->val);
109
110         // A tagged key is an integer, otherwise it is a pointer to a string
111         int d;
112         if (IS_TAGGED(item->key)) {
113             d = (STRIP_TAG(item->key) - (uint64_t)key_data);
114         } else {
115             int item_key_len = item->key->len;
116             int len = (key_len < item_key_len) ? key_len : item_key_len;
117             d = memcmp(item->key->data, key_data, len);
118             if (d == 0) { d = item_key_len - key_len; }
119         }
120
121         // If we reached the key (or passed where it should be), we found the right predesssor
122         if (d >= 0) {
123             if (pred_ptr != NULL) {
124                 *pred_ptr = pred;
125             }
126             *item_ptr = item;
127             if (d == 0) {
128                 TRACE("l2", "find_pred: found matching item %p in list, pred is %p", item, pred);
129                 return TRUE;
130             } 
131             TRACE("l2", "find_pred: found proper place for key %p in list, pred is %p", key_data, pred);
132             return FALSE;
133         }
134
135         pred = item;
136         item = next;
137     }
138
139     // <key> is not in <ll>.
140     if (pred_ptr != NULL) {
141         *pred_ptr = pred;
142     }
143     *item_ptr = NULL;
144     TRACE("l2", "find_pred: reached end of list. last item is %p", pred, 0);
145     return FALSE;
146 }
147
148 // Fast find. Do not help unlink partially removed nodes and do not return the found item's predecessor.
149 uint64_t ll_lookup (list_t *ll, const void *key_data, uint32_t key_len) {
150     TRACE("l1", "ll_lookup: searching for key %p in list %p", key_data, ll);
151     node_t *item;
152     int found = find_pred(NULL, &item, ll, key_data, key_len, FALSE);
153
154     // If we found an <item> matching the key return its value.
155     if (found) {
156         uint64_t val = item->val;
157         if (val != DOES_NOT_EXIST) {
158             TRACE("l1", "ll_lookup: found item %p. val %p. returning item", item, item->val);
159             return val;
160         }
161     }
162
163     TRACE("l1", "ll_lookup: no item in the list matched the key", 0, 0);
164     return DOES_NOT_EXIST;
165 }
166
167 uint64_t ll_cas (list_t *ll, const void *key_data, uint32_t key_len, uint64_t expectation, uint64_t new_val) {
168     TRACE("l1", "ll_cas: key %p list %p", key_data, ll);
169     TRACE("l1", "ll_cas: expectation %p new value %p", expectation, new_val);
170     ASSERT((int64_t)new_val > 0);
171
172     do {
173         node_t *pred, *old_item;
174         if (!find_pred(&pred, &old_item, ll, key_data, key_len, TRUE)) {
175
176             // There was not an item in the list that matches the key. 
177             if (EXPECT_FALSE((int64_t)expectation > 0 || expectation == EXPECT_EXISTS)) {
178                 TRACE("l1", "ll_cas: the expectation was not met, the list was not changed", 0, 0);
179                 return DOES_NOT_EXIST; // failure
180             }
181
182             ASSERT(expectation == EXPECT_DOES_NOT_EXIST || expectation == EXPECT_WHATEVER);
183
184             // Create a new item and insert it into the list.
185             TRACE("l2", "ll_cas: attempting to insert item between %p and %p", pred, pred->next);
186             node_t *new_item = node_alloc(key_data, key_len, new_val);
187             node_t *next = new_item->next = old_item;
188             node_t *other = SYNC_CAS(&pred->next, next, new_item);
189             if (other == next) {
190                 TRACE("l1", "ll_cas: successfully inserted new item %p", new_item, 0);
191                 return DOES_NOT_EXIST; // success
192             }
193
194             // Lost a race. Failed to insert the new item into the list.
195             TRACE("l1", "ll_cas: lost a race. CAS failed. expected pred's link to be %p but found %p", next, other);
196             node_free(new_item);
197             continue; // retry
198         }
199
200         // Found an item in the list that matches the key.
201         uint64_t old_item_val = old_item->val;
202         do {
203             // If the item's value is DOES_NOT_EXIST it means another thread removed the node out from under us.
204             if (EXPECT_FALSE(old_item_val == DOES_NOT_EXIST)) {
205                 TRACE("l2", "ll_cas: lost a race, found an item but another thread removed it. retry", 0, 0);
206                 break; // retry
207             }
208
209             if (EXPECT_FALSE(expectation == EXPECT_DOES_NOT_EXIST)) {
210                 TRACE("l1", "ll_cas: found an item %p in the list that matched the key. the expectation was "
211                         "not met, the list was not changed", old_item, old_item_val);
212                 return old_item_val; // failure
213             }
214
215             // Use a CAS and not a SWAP. If the node is in the process of being removed and we used a SWAP, we could
216             // replace DOES_NOT_EXIST with our value. Then another thread that is updating the value could think it
217             // succeeded and return our value even though we indicated that the node has been removed. If the CAS 
218             // fails it means another thread either removed the node or updated its value.
219             uint64_t ret_val = SYNC_CAS(&old_item->val, old_item_val, new_val);
220             if (ret_val == old_item_val) {
221                 TRACE("l1", "ll_cas: the CAS succeeded. updated the value of the item", 0, 0);
222                 return ret_val; // success
223             }
224             TRACE("l2", "ll_cas: lost a race. the CAS failed. another thread changed the item's value", 0, 0);
225
226             old_item_val = ret_val;
227         } while (1);
228     } while (1);
229 }
230
231 uint64_t ll_remove (list_t *ll, const void *key_data, uint32_t key_len) {
232     TRACE("l1", "ll_remove: removing item with key %p from list %p", key_data, ll);
233     node_t *pred;
234     node_t *item;
235     int found = find_pred(&pred, &item, ll, key_data, key_len, TRUE);
236     if (!found) {
237         TRACE("l1", "ll_remove: remove failed, an item with a matching key does not exist in the list", 0, 0);
238         return DOES_NOT_EXIST;
239     }
240
241     // Mark <item> removed. This must be atomic. If multiple threads try to remove the same item
242     // only one of them should succeed.
243     node_t *next;
244     node_t *old_next = item->next;
245     do {
246         next = old_next;
247         old_next = SYNC_CAS(&item->next, next, TAG_VALUE(next));
248         if (IS_TAGGED(old_next)) {
249             TRACE("l1", "ll_remove: lost a race -- %p is already marked for removal by another thread", item, 0);
250             return DOES_NOT_EXIST;
251         }
252     } while (next != old_next);
253     TRACE("l2", "ll_remove: logically removed item %p", item, 0);
254     ASSERT(IS_TAGGED(item->next));
255
256     // This has to be an atomic swap in case another thread is updating the item while we are removing it. 
257     uint64_t val = SYNC_SWAP(&item->val, DOES_NOT_EXIST); 
258     TRACE("l2", "ll_remove: replaced item's val %p with DOES_NOT_EXIT", val, 0);
259
260     // Unlink <item> from <ll>. If we lose a race to another thread just back off. It is safe to leave the
261     // item logically removed for a later call (or some other thread) to physically unlink. By marking the
262     // item earlier, we logically removed it. 
263     TRACE("l2", "ll_remove: unlink the item by linking its pred %p to its successor %p", pred, next);
264     node_t *other;
265     if ((other = SYNC_CAS(&pred->next, item, next)) != item) {
266         TRACE("l1", "ll_remove: unlink failed; pred's link changed from %p to %p", item, other);
267         return val;
268     } 
269
270     // The thread that completes the unlink should free the memory.
271     node_defer_free(item); 
272     TRACE("l1", "ll_remove: successfully unlinked item %p from the list", item, 0);
273     return val;
274 }
275
276 void ll_print (list_t *ll) {
277     node_t *item;
278     item = ll->head->next;
279     while (item) {
280         node_t *next = item->next;
281         if (IS_TAGGED(item)) {
282             printf("*");
283         }
284         printf("%p:", item);
285         if (IS_TAGGED(item->key)) {
286             printf("0x%llx ", STRIP_TAG(item->key));
287         } else {
288             printf("%s ", (char *)item->key->data);
289         }
290         fflush(stdout);
291         item = (node_t *)STRIP_TAG(next);
292     }
293     printf("\n");
294 }