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