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