64f7a4773446d490e4f108c9a46576a2e5cf559e
[nbds] / map / hashtable.c
1 /* 
2  * Written by Josh Dybnis and released to the public domain, as explained at
3  * http://creativecommons.org/licenses/publicdomain
4  * 
5  * C implementation of Cliff Click's lock-free hash table from 
6  * http://www.azulsystems.com/events/javaone_2008/2008_CodingNonBlock.pdf
7  * http://sourceforge.net/projects/high-scale-lib
8  *
9  * Note: This is code uses synchronous atomic operations because that is all that x86 provides. 
10  * Every atomic operation is also an implicit full memory barrier. The upshot is that it simplifies
11  * the code a bit, but it won't be as fast as it could be on platforms that provide weaker 
12  * operations like and unfenced CAS which would still do the job.
13  */
14
15 #include <stdio.h>
16 #include "common.h"
17 #include "murmur.h"
18 #include "mem.h"
19 #include "hashtable.h"
20
21 #define GET_PTR(x) ((void *)((x) & MASK(48))) // low-order 48 bits is a pointer to a nstring_t
22
23 typedef struct entry {
24     uint64_t  key;
25     map_val_t val;
26 } entry_t;
27
28 typedef struct hti {
29     volatile entry_t *table;
30     hashtable_t *ht; // parent ht;
31     struct hti *next;
32     unsigned scale;
33     int max_probe;
34     int references;
35     int count; // TODO: make these counters distributed
36     int num_entries_copied;
37     int copy_scan;
38 } hti_t;
39
40 struct ht_iter {
41     hti_t *  hti;
42     int64_t  idx;
43 };
44
45 struct ht {
46     hti_t *hti;
47     const datatype_t *key_type;
48 };
49
50 static const map_val_t COPIED_VALUE           = -1;
51 static const map_val_t TOMBSTONE              = STRIP_TAG(-1, TAG1);
52
53 static const unsigned ENTRIES_PER_BUCKET     = CACHE_LINE_SIZE/sizeof(entry_t);
54 static const unsigned ENTRIES_PER_COPY_CHUNK = CACHE_LINE_SIZE/sizeof(entry_t)*2;
55 static const unsigned MIN_SCALE              = 4; // min 16 entries (4 buckets)
56 static const unsigned MAX_BUCKETS_TO_PROBE   = 250;
57
58 static int hti_copy_entry (hti_t *ht1, volatile entry_t *ent, uint32_t ent_key_hash, hti_t *ht2);
59
60 // Choose the next bucket to probe using the high-order bits of <key_hash>.
61 static inline int get_next_ndx(int old_ndx, uint32_t key_hash, int ht_scale) {
62     int incr = (key_hash >> (32 - ht_scale));
63     incr += !incr; // If the increment is 0, make it 1.
64     return (old_ndx + incr) & MASK(ht_scale);
65 }
66
67 // Lookup <key> in <hti>. 
68 //
69 // Return the entry that <key> is in, or if <key> isn't in <hti> return the entry that it would be 
70 // in if it were inserted into <hti>. If there is no room for <key> in <hti> then return NULL, to 
71 // indicate that the caller should look in <hti->next>.
72 //
73 // Record if the entry being returned is empty. Otherwise the caller will have to waste time 
74 // re-comparing the keys to confirm that it did not lose a race to fill an empty entry.
75 static volatile entry_t *hti_lookup (hti_t *hti, map_key_t key, uint32_t key_hash, int *is_empty) {
76     TRACE("h2", "hti_lookup(key %p in hti %p)", key, hti);
77     *is_empty = 0;
78
79     // Probe one cache line at a time
80     int ndx = key_hash & MASK(hti->scale); // the first entry to search
81     for (int i = 0; i < hti->max_probe; ++i) {
82
83         // The start of the bucket is the first entry in the cache line.
84         volatile entry_t *bucket = hti->table + (ndx & ~(ENTRIES_PER_BUCKET-1)); 
85
86         // Start searching at the indexed entry. Then loop around to the begining of the cache line.
87         for (int j = 0; j < ENTRIES_PER_BUCKET; ++j) {
88             volatile entry_t *ent = bucket + ((ndx + j) & (ENTRIES_PER_BUCKET-1));
89
90             uint64_t ent_key = ent->key;
91             if (ent_key == DOES_NOT_EXIST) {
92                 TRACE("h1", "hti_lookup: entry %p for key %p is empty", ent, 
93                             (hti->ht->key_type == NULL) ? (void *)ent_key : GET_PTR(ent_key));
94                 *is_empty = 1; // indicate an empty so the caller avoids an expensive key compare
95                 return ent;
96             }
97
98             // Compare <key> with the key in the entry. 
99             if (EXPECT_TRUE(hti->ht->key_type == NULL)) {
100                 // fast path for integer keys
101                 if (ent_key == (uint64_t)key) {
102                     TRACE("h1", "hti_lookup: found entry %p with key %p", ent, ent_key);
103                     return ent;
104                 }
105             } else {
106                 // The key in <ent> is made up of two parts. The 48 low-order bits are a pointer. The
107                 // high-order 16 bits are taken from the hash. The bits from the hash are used as a
108                 // quick check to rule out non-equal keys without doing a complete compare.
109                 if ((key_hash >> 16) == (ent_key >> 48) && hti->ht->key_type->cmp(GET_PTR(ent_key), key) == 0) {
110                     TRACE("h1", "hti_lookup: found entry %p with key %p", ent, GET_PTR(ent_key));
111                     return ent;
112                 }
113             }
114         }
115
116         ndx = get_next_ndx(ndx, key_hash, hti->scale);
117     }
118
119     // maximum number of probes exceeded
120     TRACE("h1", "hti_lookup: maximum number of probes exceeded returning 0x0", 0, 0);
121     return NULL;
122 }
123
124 // Allocate and initialize a hti_t with 2^<scale> entries.
125 static hti_t *hti_alloc (hashtable_t *parent, int scale) {
126     hti_t *hti = (hti_t *)nbd_malloc(sizeof(hti_t));
127     memset(hti, 0, sizeof(hti_t));
128
129     size_t sz = sizeof(entry_t) * (1 << scale);
130     entry_t *table = nbd_malloc(sz);
131     memset(table, 0, sz);
132     hti->table = table;
133
134     hti->scale = scale;
135
136     // When searching for a key probe a maximum of 1/4 of the buckets up to 1000 buckets.
137     hti->max_probe = ((1 << (hti->scale - 2)) / ENTRIES_PER_BUCKET) + 4;
138     if (hti->max_probe > MAX_BUCKETS_TO_PROBE) {
139         hti->max_probe = MAX_BUCKETS_TO_PROBE;
140     }
141
142     hti->ht = parent;
143
144     assert(hti->scale >= MIN_SCALE && hti->scale < 63); // size must be a power of 2
145     assert(sizeof(entry_t) * ENTRIES_PER_BUCKET % CACHE_LINE_SIZE == 0); // divisible into cache
146     assert((size_t)hti->table % CACHE_LINE_SIZE == 0); // cache aligned
147
148     return hti;
149 }
150
151 // Called when <hti> runs out of room for new keys.
152 //
153 // Initiates a copy by creating a larger hti_t and installing it in <hti->next>.
154 static void hti_start_copy (hti_t *hti) {
155     TRACE("h0", "hti_start_copy(hti %p scale %llu)", hti, hti->scale);
156
157     // heuristics to determine the size of the new table
158     uint64_t count = ht_count(hti->ht);
159     unsigned int new_scale = hti->scale;
160     new_scale += (count > (1 << (new_scale - 2))); // double size if more than 1/4 full
161     new_scale += (count > (1 << (new_scale - 2))); // double size again if more than 1/2 full
162
163     // Allocate the new table and attempt to install it.
164     hti_t *next = hti_alloc(hti->ht, new_scale);
165     hti_t *old_next = SYNC_CAS(&hti->next, NULL, next);
166     if (old_next != NULL) {
167         // Another thread beat us to it.
168         TRACE("h0", "hti_start_copy: lost race to install new hti; found %p", old_next, 0);
169         nbd_free(next);
170         return;
171     }
172     TRACE("h0", "hti_start_copy: new hti %p scale %llu", next, next->scale);
173 }
174
175 // Copy the key and value stored in <ht1_ent> (which must be an entry in <ht1>) to <ht2>. 
176 //
177 // Return 1 unless <ht1_ent> is already copied (then return 0), so the caller can account for the total
178 // number of entries left to copy.
179 static int hti_copy_entry (hti_t *ht1, volatile entry_t *ht1_ent, uint32_t key_hash, hti_t *ht2) {
180     TRACE("h2", "hti_copy_entry: entry %p to table %p", ht1_ent, ht2);
181     assert(ht1);
182     assert(ht1->next);
183     assert(ht2);
184     assert(ht1_ent >= ht1->table && ht1_ent < ht1->table + (1 << ht1->scale));
185     assert(key_hash == 0 || ht1->ht->key_type == NULL || (key_hash >> 16) == (ht1_ent->key >> 48));
186
187     map_val_t ht1_ent_val = ht1_ent->val;
188     if (EXPECT_FALSE(ht1_ent_val == COPIED_VALUE)) {
189         TRACE("h1", "hti_copy_entry: entry %p already copied to table %p", ht1_ent, ht2);
190         return FALSE; // already copied
191     }
192
193     // Kill empty entries.
194     if (EXPECT_FALSE(ht1_ent_val == DOES_NOT_EXIST)) {
195         map_val_t ht1_ent_val = SYNC_CAS(&ht1_ent->val, DOES_NOT_EXIST, COPIED_VALUE);
196         if (ht1_ent_val == DOES_NOT_EXIST) {
197             TRACE("h1", "hti_copy_entry: empty entry %p killed", ht1_ent, 0);
198             return TRUE;
199         }
200         if (ht1_ent_val == COPIED_VALUE) {
201             TRACE("h0", "hti_copy_entry: lost race to kill empty entry %p; the entry is already killed", ht1_ent, 0);
202             return FALSE; // another thread beat us to it
203         }
204         TRACE("h0", "hti_copy_entry: lost race to kill empty entry %p; the entry is not empty", ht1_ent, 0);
205     }
206
207     // Tag the value in the old entry to indicate a copy is in progress.
208     ht1_ent_val = SYNC_FETCH_AND_OR(&ht1_ent->val, TAG_VALUE(0, TAG1));
209     TRACE("h2", "hti_copy_entry: tagged the value %p in old entry %p", ht1_ent_val, ht1_ent);
210     if (ht1_ent_val == COPIED_VALUE) {
211         TRACE("h1", "hti_copy_entry: entry %p already copied to table %p", ht1_ent, ht2);
212         return FALSE; // <value> was already copied by another thread.
213     }
214
215     // Install the key in the new table.
216     uint64_t ht1_ent_key = ht1_ent->key;
217     map_key_t key = (ht1->ht->key_type == NULL) ? (void *)ht1_ent_key : GET_PTR(ht1_ent_key);
218
219     // The old table's dead entries don't need to be copied to the new table, but their keys need to be freed.
220     assert(COPIED_VALUE == TAG_VALUE(TOMBSTONE, TAG1));
221     if (ht1_ent_val == TOMBSTONE) {
222         TRACE("h1", "hti_copy_entry: entry %p old value was deleted, now freeing key %p", ht1_ent, key);
223         if (EXPECT_FALSE(ht1->ht->key_type != NULL)) {
224             nbd_defer_free(key);
225         }
226         return TRUE; 
227     }
228
229     // We use 0 to indicate that <key_hash> is uninitiallized. Occasionally the key's hash will really be 0 and we
230     // waste time recomputing it every time. It is rare enough (1 in 65k) that it won't hurt performance. 
231     if (key_hash == 0) { 
232         key_hash = (ht1->ht->key_type == NULL) ? murmur32_8b(ht1_ent_key) : ht1->ht->key_type->hash(key);
233     }
234
235     int ht2_ent_is_empty;
236     volatile entry_t *ht2_ent = hti_lookup(ht2, key, key_hash, &ht2_ent_is_empty);
237     TRACE("h0", "hti_copy_entry: copy entry %p to entry %p", ht1_ent, ht2_ent);
238
239     // It is possible that there isn't any room in the new table either.
240     if (EXPECT_FALSE(ht2_ent == NULL)) {
241         TRACE("h0", "hti_copy_entry: no room in table %p copy to next table %p", ht2, ht2->next);
242         if (ht2->next == NULL) {
243             hti_start_copy(ht2); // initiate nested copy, if not already started
244         }
245         return hti_copy_entry(ht1, ht1_ent, key_hash, ht2->next); // recursive tail-call
246     }
247
248     if (ht2_ent_is_empty) {
249         uint64_t old_ht2_ent_key = SYNC_CAS(&ht2_ent->key, DOES_NOT_EXIST, ht1_ent_key);
250         if (old_ht2_ent_key != DOES_NOT_EXIST) {
251             TRACE("h0", "hti_copy_entry: lost race to CAS key %p into new entry; found %p",
252                     ht1_ent_key, old_ht2_ent_key);
253             return hti_copy_entry(ht1, ht1_ent, key_hash, ht2); // recursive tail-call
254         }
255     }
256
257     // Copy the value to the entry in the new table.
258     ht1_ent_val = STRIP_TAG(ht1_ent_val, TAG1);
259     map_val_t old_ht2_ent_val = SYNC_CAS(&ht2_ent->val, DOES_NOT_EXIST, ht1_ent_val);
260
261     // If there is a nested copy in progress, we might have installed the key into a dead entry.
262     if (old_ht2_ent_val == COPIED_VALUE) {
263         TRACE("h0", "hti_copy_entry: nested copy in progress; copy %p to next table %p", ht2_ent, ht2->next);
264         return hti_copy_entry(ht1, ht1_ent, key_hash, ht2->next); // recursive tail-call
265     }
266
267     // Mark the old entry as dead.
268     ht1_ent->val = COPIED_VALUE;
269
270     // Update the count if we were the one that completed the copy.
271     if (old_ht2_ent_val == DOES_NOT_EXIST) {
272         TRACE("h0", "hti_copy_entry: key %p value %p copied to new entry", key, ht1_ent_val);
273         SYNC_ADD(&ht1->count, -1);
274         SYNC_ADD(&ht2->count, 1);
275         return TRUE;
276     }
277
278     TRACE("h0", "hti_copy_entry: lost race to install value %p in new entry; found value %p", 
279                 ht1_ent_val, old_ht2_ent_val);
280     return FALSE; // another thread completed the copy
281 }
282
283 // Compare <expected> with the existing value associated with <key>. If the values match then 
284 // replace the existing value with <new>. If <new> is DOES_NOT_EXIST, delete the value associated with 
285 // the key by replacing it with a TOMBSTONE.
286 //
287 // Return the previous value associated with <key>, or DOES_NOT_EXIST if <key> is not in the table
288 // or associated with a TOMBSTONE. If a copy is in progress and <key> has been copied to the next 
289 // table then return COPIED_VALUE. 
290 //
291 // NOTE: the returned value matches <expected> iff the set succeeds
292 //
293 // Certain values of <expected> have special meaning. If <expected> is CAS_EXPECT_EXISTS then any 
294 // real value matches (i.ent. not a TOMBSTONE or DOES_NOT_EXIST) as long as <key> is in the table. If
295 // <expected> is CAS_EXPECT_WHATEVER then skip the test entirely.
296 //
297 static map_val_t hti_cas (hti_t *hti, map_key_t key, uint32_t key_hash, map_val_t expected, map_val_t new) {
298     TRACE("h1", "hti_cas: hti %p key %p", hti, key);
299     TRACE("h1", "hti_cas: value %p expect %p", new, expected);
300     assert(hti);
301     assert(!IS_TAGGED(new, TAG1));
302     assert(key);
303
304     int is_empty;
305     volatile entry_t *ent = hti_lookup(hti, key, key_hash, &is_empty);
306
307     // There is no room for <key>, grow the table and try again.
308     if (ent == NULL) {
309         if (hti->next == NULL) {
310             hti_start_copy(hti);
311         }
312         return COPIED_VALUE;
313     }
314
315     // Install <key> in the table if it doesn't exist.
316     if (is_empty) {
317         TRACE("h0", "hti_cas: entry %p is empty", ent, 0);
318         if (expected != CAS_EXPECT_WHATEVER && expected != CAS_EXPECT_DOES_NOT_EXIST)
319             return DOES_NOT_EXIST;
320
321         // No need to do anything, <key> is already deleted.
322         if (new == DOES_NOT_EXIST)
323             return DOES_NOT_EXIST;
324
325         // Allocate <new_key>.
326         uint64_t new_key = (uint64_t)((hti->ht->key_type == NULL) ? key : hti->ht->key_type->clone(key));
327         if (EXPECT_FALSE(hti->ht->key_type != NULL)) {
328             // Combine <new_key> pointer with bits from its hash 
329             new_key = ((uint64_t)(key_hash >> 16) << 48) | new_key; 
330         }
331
332         // CAS the key into the table.
333         uint64_t old_ent_key = SYNC_CAS(&ent->key, DOES_NOT_EXIST, new_key);
334
335         // Retry if another thread stole the entry out from under us.
336         if (old_ent_key != DOES_NOT_EXIST) {
337             TRACE("h0", "hti_cas: lost race to install key %p in entry %p", new_key, ent);
338             TRACE("h0", "hti_cas: found %p instead of NULL", 
339                         (hti->ht->key_type == NULL) ? (void *)old_ent_key : GET_PTR(old_ent_key), 0);
340             if (hti->ht->key_type != NULL) {
341                 nbd_free(GET_PTR(new_key));
342             }
343             return hti_cas(hti, key, key_hash, expected, new); // tail-call
344         }
345         TRACE("h2", "hti_cas: installed key %p in entry %p", new_key, ent);
346     }
347
348     TRACE("h0", "hti_cas: entry for key %p is %p", 
349                 (hti->ht->key_type == NULL) ? (void *)ent->key : GET_PTR(ent->key), ent);
350
351     // If the entry is in the middle of a copy, the copy must be completed first.
352     map_val_t ent_val = ent->val;
353     if (EXPECT_FALSE(IS_TAGGED(ent_val, TAG1))) {
354         if (ent_val != COPIED_VALUE) {
355             int did_copy = hti_copy_entry(hti, ent, key_hash, ((volatile hti_t *)hti)->next);
356             if (did_copy) {
357                 SYNC_ADD(&hti->num_entries_copied, 1);
358             }
359             TRACE("h0", "hti_cas: value in the middle of a copy, copy completed by %s", 
360                         (did_copy ? "self" : "other"), 0);
361         }
362         TRACE("h0", "hti_cas: value copied to next table, retry on next table", 0, 0);
363         return COPIED_VALUE;
364     }
365
366     // Fail if the old value is not consistent with the caller's expectation.
367     int old_existed = (ent_val != TOMBSTONE && ent_val != DOES_NOT_EXIST);
368     if (EXPECT_FALSE(expected != CAS_EXPECT_WHATEVER && expected != ent_val)) {
369         if (EXPECT_FALSE(expected != (old_existed ? CAS_EXPECT_EXISTS : CAS_EXPECT_DOES_NOT_EXIST))) {
370             TRACE("h1", "hti_cas: value %p expected by caller not found; found value %p",
371                         expected, ent_val);
372             return ent_val;
373         }
374     }
375
376     // No need to update if value is unchanged.
377     if ((new == DOES_NOT_EXIST && !old_existed) || ent_val == new) {
378         TRACE("h1", "hti_cas: old value and new value were the same", 0, 0);
379         return ent_val;
380     }
381
382     // CAS the value into the entry. Retry if it fails.
383     map_val_t v = SYNC_CAS(&ent->val, ent_val, new == DOES_NOT_EXIST ? TOMBSTONE : new);
384     if (EXPECT_FALSE(v != ent_val)) {
385         TRACE("h0", "hti_cas: value CAS failed; expected %p found %p", ent_val, v);
386         return hti_cas(hti, key, key_hash, expected, new); // recursive tail-call
387     }
388
389     // The set succeeded. Adjust the value count.
390     if (old_existed && new == DOES_NOT_EXIST) {
391         SYNC_ADD(&hti->count, -1);
392     } else if (!old_existed && new != DOES_NOT_EXIST) {
393         SYNC_ADD(&hti->count, 1);
394     }
395
396     // Return the previous value.
397     TRACE("h0", "hti_cas: CAS succeeded; old value %p new value %p", ent_val, new);
398     return ent_val;
399 }
400
401 //
402 static map_val_t hti_get (hti_t *hti, map_key_t key, uint32_t key_hash) {
403     int is_empty;
404     volatile entry_t *ent = hti_lookup(hti, key, key_hash, &is_empty);
405
406     // When hti_lookup() returns NULL it means we hit the reprobe limit while
407     // searching the table. In that case, if a copy is in progress the key 
408     // might exist in the copy.
409     if (EXPECT_FALSE(ent == NULL)) {
410         if (((volatile hti_t *)hti)->next != NULL)
411             return hti_get(hti->next, key, key_hash); // recursive tail-call
412         return DOES_NOT_EXIST;
413     }
414
415     if (is_empty)
416         return DOES_NOT_EXIST;
417
418     // If the entry is being copied, finish the copy and retry on the next table.
419     map_val_t ent_val = ent->val;
420     if (EXPECT_FALSE(IS_TAGGED(ent_val, TAG1))) {
421         if (EXPECT_FALSE(ent_val != COPIED_VALUE)) {
422             int did_copy = hti_copy_entry(hti, ent, key_hash, ((volatile hti_t *)hti)->next);
423             if (did_copy) {
424                 SYNC_ADD(&hti->num_entries_copied, 1);
425             }
426         }
427         return hti_get(((volatile hti_t *)hti)->next, key, key_hash); // tail-call
428     }
429
430     return (ent_val == TOMBSTONE) ? DOES_NOT_EXIST : ent_val;
431 }
432
433 //
434 map_val_t ht_get (hashtable_t *ht, map_key_t key) {
435     uint32_t hash = (ht->key_type == NULL) ? murmur32_8b((uint64_t)key) : ht->key_type->hash(key);
436     return hti_get(ht->hti, key, hash);
437 }
438
439 // returns TRUE if copy is done
440 int hti_help_copy (hti_t *hti) {
441     volatile entry_t *ent;
442     uint64_t limit; 
443     uint64_t total_copied = hti->num_entries_copied;
444     uint64_t num_copied = 0;
445     uint64_t x = hti->copy_scan; 
446
447     TRACE("h1", "ht_cas: help copy. scan is %llu, size is %llu", x, 1<<hti->scale);
448     if (total_copied != (1 << hti->scale)) {
449         // Panic if we've been around the array twice and still haven't finished the copy.
450         int panic = (x >= (1 << (hti->scale + 1))); 
451         if (!panic) {
452             limit = ENTRIES_PER_COPY_CHUNK;
453
454             // Reserve some entries for this thread to copy. There is a race condition here because the
455             // fetch and add isn't atomic, but that is ok.
456             hti->copy_scan = x + ENTRIES_PER_COPY_CHUNK; 
457
458             // <copy_scan> might be larger than the size of the table, if some thread stalls while 
459             // copying. In that case we just wrap around to the begining and make another pass through
460             // the table.
461             ent = hti->table + (x & MASK(hti->scale));
462         } else {
463             TRACE("h1", "ht_cas: help copy panic", 0, 0);
464             // scan the whole table
465             ent = hti->table;
466             limit = (1 << hti->scale);
467         }
468
469         // Copy the entries
470         for (int i = 0; i < limit; ++i) {
471             num_copied += hti_copy_entry(hti, ent++, 0, hti->next);
472             assert(ent <= hti->table + (1 << hti->scale));
473         }
474         if (num_copied != 0) {
475             total_copied = SYNC_ADD(&hti->num_entries_copied, num_copied);
476         }
477     }
478
479     return (total_copied == (1 << hti->scale));
480 }
481
482 //
483 map_val_t ht_cas (hashtable_t *ht, map_key_t key, map_val_t expected_val, map_val_t new_val) {
484
485     TRACE("h2", "ht_cas: key %p ht %p", key, ht);
486     TRACE("h2", "ht_cas: expected val %p new val %p", expected_val, new_val);
487     assert(key != DOES_NOT_EXIST);
488     assert(!IS_TAGGED(new_val, TAG1) && new_val != DOES_NOT_EXIST && new_val != TOMBSTONE);
489
490     hti_t *hti = ht->hti;
491
492     // Help with an ongoing copy.
493     if (EXPECT_FALSE(hti->next != NULL)) {
494         int done = hti_help_copy(hti);
495
496         // Dispose of fully copied tables.
497         if (done && hti->references == 0) {
498
499             int r = SYNC_CAS(&hti->references, 0, -1);
500             if (r == 0) {
501                 assert(hti->next);
502                 if (SYNC_CAS(&ht->hti, hti, hti->next) == hti) {
503                     nbd_defer_free((void *)hti->table); 
504                     nbd_defer_free(hti); 
505                 }
506             }
507         }
508     }
509
510     map_val_t old_val;
511     uint32_t key_hash = (ht->key_type == NULL) ? murmur32_8b((uint64_t)key) : ht->key_type->hash(key);
512     while ((old_val = hti_cas(hti, key, key_hash, expected_val, new_val)) == COPIED_VALUE) {
513         assert(hti->next);
514         hti = hti->next;
515     }
516
517     return old_val == TOMBSTONE ? DOES_NOT_EXIST : old_val;
518 }
519
520 // Remove the value in <ht> associated with <key>. Returns the value removed, or DOES_NOT_EXIST if there was
521 // no value for that key.
522 map_val_t ht_remove (hashtable_t *ht, map_key_t key) {
523     hti_t *hti = ht->hti;
524     map_val_t val;
525     uint32_t key_hash = (ht->key_type == NULL) ? murmur32_8b((uint64_t)key) : ht->key_type->hash(key);
526     do {
527         val = hti_cas(hti, key, key_hash, CAS_EXPECT_WHATEVER, DOES_NOT_EXIST);
528         if (val != COPIED_VALUE)
529             return val == TOMBSTONE ? DOES_NOT_EXIST : val;
530         assert(hti->next);
531         hti = hti->next;
532         assert(hti);
533     } while (1);
534 }
535
536 // Returns the number of key-values pairs in <ht>
537 uint64_t ht_count (hashtable_t *ht) {
538     hti_t *hti = ht->hti;
539     uint64_t count = 0;
540     while (hti) {
541         count += hti->count;
542         hti = hti->next; 
543     }
544     return count;
545 }
546
547 // Allocate and initialize a new hash table.
548 hashtable_t *ht_alloc (const datatype_t *key_type) {
549     hashtable_t *ht = nbd_malloc(sizeof(hashtable_t));
550     ht->key_type = key_type;
551     ht->hti = (hti_t *)hti_alloc(ht, MIN_SCALE);
552     return ht;
553 }
554
555 // Free <ht> and its internal structures.
556 void ht_free (hashtable_t *ht) {
557     hti_t *hti = ht->hti;
558     do {
559         for (uint32_t i = 0; i < (1 << hti->scale); ++i) {
560             assert(hti->table[i].val == COPIED_VALUE || !IS_TAGGED(hti->table[i].val, TAG1));
561             if (ht->key_type != NULL && hti->table[i].key != DOES_NOT_EXIST) {
562                 nbd_free(GET_PTR(hti->table[i].key));
563             }
564         }
565         hti_t *next = hti->next;
566         nbd_free((void *)hti->table);
567         nbd_free(hti);
568         hti = next;
569     } while (hti);
570     nbd_free(ht);
571 }
572
573 void ht_print (hashtable_t *ht) {
574     hti_t *hti = ht->hti;
575     while (hti) {
576         printf("hti:%p scale:%u count:%d copied:%d\n", hti, hti->scale, hti->count, hti->num_entries_copied);
577         for (int i = 0; i < (1 << hti->scale); ++i) {
578             volatile entry_t *ent = hti->table + i;
579             printf("[0x%x] %p:%p\n", i, (void *)ent->key, (void *)ent->val);
580             if (i > 30) {
581                 printf("...\n");
582                 break;
583             }
584         }
585         hti = hti->next;
586     }
587 }
588
589 ht_iter_t *ht_iter_begin (hashtable_t *ht, map_key_t key) {
590     assert(key == NULL);
591     hti_t *hti = ht->hti;
592     int rcount;
593     do {
594         while (((volatile hti_t *)hti)->next != NULL) {
595             do { } while (hti_help_copy(hti) != TRUE);
596             hti = hti->next;
597         }
598
599         int old = hti->references;
600         do {
601             rcount = old;
602             if (rcount != -1) {
603                 old = SYNC_CAS(&hti->references, rcount, rcount + 1);
604             }
605         } while (rcount != old);
606     } while (rcount == -1);
607
608     ht_iter_t *iter = nbd_malloc(sizeof(ht_iter_t));
609     iter->hti = hti;
610     iter->idx = -1;
611
612     return iter;
613 }
614
615 map_val_t ht_iter_next (ht_iter_t *iter, map_key_t *key_ptr) {
616     volatile entry_t *ent;
617     map_key_t key;
618     map_val_t val;
619     uint64_t table_size = (1 << iter->hti->scale);
620     do {
621         iter->idx++;
622         if (iter->idx == table_size) {
623             return DOES_NOT_EXIST;
624         }
625         ent = &iter->hti->table[iter->idx];
626         key = (iter->hti->ht->key_type == NULL) ? (map_key_t)ent->key : GET_PTR(ent->key);
627         val = ent->val;
628
629     } while (key == DOES_NOT_EXIST || val == DOES_NOT_EXIST || val == TOMBSTONE);
630
631     if (key_ptr) {
632         *key_ptr = key;
633     }
634     if (val == COPIED_VALUE) {
635         uint32_t hash = (iter->hti->ht->key_type == NULL) 
636                       ? murmur32_8b((uint64_t)key)
637                       : iter->hti->ht->key_type->hash(key);
638         val = hti_get(iter->hti->next, (map_key_t)ent->key, hash);
639     } 
640
641     return val;
642 }
643
644 void ht_iter_free (ht_iter_t *iter) {
645     SYNC_ADD(&iter->hti->references, -1);
646     nbd_free(iter);
647 }