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