2 * Resizable, Scalable, Concurrent Hash Table
4 * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
5 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 /**************************************************************************
14 **************************************************************************/
16 #include <linux/init.h>
17 #include <linux/jhash.h>
18 #include <linux/kernel.h>
19 #include <linux/kthread.h>
20 #include <linux/module.h>
21 #include <linux/rcupdate.h>
22 #include <linux/rhashtable.h>
23 #include <linux/slab.h>
24 #include <linux/sched.h>
25 #include <linux/random.h>
26 #include <linux/vmalloc.h>
27 #include <linux/wait.h>
29 #define MAX_ENTRIES 1000000
30 #define TEST_INSERT_FAIL INT_MAX
32 static int parm_entries = 50000;
33 module_param(parm_entries, int, 0);
34 MODULE_PARM_DESC(parm_entries, "Number of entries to add (default: 50000)");
37 module_param(runs, int, 0);
38 MODULE_PARM_DESC(runs, "Number of test runs per variant (default: 4)");
40 static int max_size = 0;
41 module_param(max_size, int, 0);
42 MODULE_PARM_DESC(max_size, "Maximum table size (default: calculated)");
44 static bool shrinking = false;
45 module_param(shrinking, bool, 0);
46 MODULE_PARM_DESC(shrinking, "Enable automatic shrinking (default: off)");
49 module_param(size, int, 0);
50 MODULE_PARM_DESC(size, "Initial size hint of table (default: 8)");
52 static int tcount = 10;
53 module_param(tcount, int, 0);
54 MODULE_PARM_DESC(tcount, "Number of threads to spawn (default: 10)");
56 static bool enomem_retry = false;
57 module_param(enomem_retry, bool, 0);
58 MODULE_PARM_DESC(enomem_retry, "Retry insert even if -ENOMEM was returned (default: off)");
66 struct test_obj_val value;
67 struct rhash_head node;
71 struct test_obj_val value;
72 struct rhlist_head list_node;
78 struct task_struct *task;
79 struct test_obj *objs;
82 static u32 my_hashfn(const void *data, u32 len, u32 seed)
84 const struct test_obj_rhl *obj = data;
86 return (obj->value.id % 10);
89 static int my_cmpfn(struct rhashtable_compare_arg *arg, const void *obj)
91 const struct test_obj_rhl *test_obj = obj;
92 const struct test_obj_val *val = arg->key;
94 return test_obj->value.id - val->id;
97 static struct rhashtable_params test_rht_params = {
98 .head_offset = offsetof(struct test_obj, node),
99 .key_offset = offsetof(struct test_obj, value),
100 .key_len = sizeof(struct test_obj_val),
104 static struct rhashtable_params test_rht_params_dup = {
105 .head_offset = offsetof(struct test_obj_rhl, list_node),
106 .key_offset = offsetof(struct test_obj_rhl, value),
107 .key_len = sizeof(struct test_obj_val),
109 .obj_hashfn = my_hashfn,
110 .obj_cmpfn = my_cmpfn,
112 .automatic_shrinking = false,
115 static atomic_t startup_count;
116 static DECLARE_WAIT_QUEUE_HEAD(startup_wait);
118 static int insert_retry(struct rhashtable *ht, struct test_obj *obj,
119 const struct rhashtable_params params)
121 int err, retries = -1, enomem_retries = 0;
126 err = rhashtable_insert_fast(ht, &obj->node, params);
127 if (err == -ENOMEM && enomem_retry) {
131 } while (err == -EBUSY);
134 pr_info(" %u insertions retried after -ENOMEM\n",
137 return err ? : retries;
140 static int __init test_rht_lookup(struct rhashtable *ht, struct test_obj *array,
141 unsigned int entries)
145 for (i = 0; i < entries; i++) {
146 struct test_obj *obj;
147 bool expected = !(i % 2);
148 struct test_obj_val key = {
152 if (array[i / 2].value.id == TEST_INSERT_FAIL)
155 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
157 if (expected && !obj) {
158 pr_warn("Test failed: Could not find key %u\n", key.id);
160 } else if (!expected && obj) {
161 pr_warn("Test failed: Unexpected entry found for key %u\n",
164 } else if (expected && obj) {
165 if (obj->value.id != i) {
166 pr_warn("Test failed: Lookup value mismatch %u!=%u\n",
178 static void test_bucket_stats(struct rhashtable *ht, unsigned int entries)
180 unsigned int total = 0, chain_len = 0;
181 struct rhashtable_iter hti;
182 struct rhash_head *pos;
184 rhashtable_walk_enter(ht, &hti);
185 rhashtable_walk_start(&hti);
187 while ((pos = rhashtable_walk_next(&hti))) {
188 if (PTR_ERR(pos) == -EAGAIN) {
189 pr_info("Info: encountered resize\n");
192 } else if (IS_ERR(pos)) {
193 pr_warn("Test failed: rhashtable_walk_next() error: %ld\n",
201 rhashtable_walk_stop(&hti);
202 rhashtable_walk_exit(&hti);
204 pr_info(" Traversal complete: counted=%u, nelems=%u, entries=%d, table-jumps=%u\n",
205 total, atomic_read(&ht->nelems), entries, chain_len);
207 if (total != atomic_read(&ht->nelems) || total != entries)
208 pr_warn("Test failed: Total count mismatch ^^^");
211 static s64 __init test_rhashtable(struct rhashtable *ht, struct test_obj *array,
212 unsigned int entries)
214 struct test_obj *obj;
216 unsigned int i, insert_retries = 0;
221 * Insert entries into table with all keys even numbers
223 pr_info(" Adding %d keys\n", entries);
224 start = ktime_get_ns();
225 for (i = 0; i < entries; i++) {
226 struct test_obj *obj = &array[i];
228 obj->value.id = i * 2;
229 err = insert_retry(ht, obj, test_rht_params);
231 insert_retries += err;
237 pr_info(" %u insertions retried due to memory pressure\n",
240 test_bucket_stats(ht, entries);
242 test_rht_lookup(ht, array, entries);
245 test_bucket_stats(ht, entries);
247 pr_info(" Deleting %d keys\n", entries);
248 for (i = 0; i < entries; i++) {
249 struct test_obj_val key = {
253 if (array[i].value.id != TEST_INSERT_FAIL) {
254 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
257 rhashtable_remove_fast(ht, &obj->node, test_rht_params);
263 end = ktime_get_ns();
264 pr_info(" Duration of test: %lld ns\n", end - start);
269 static struct rhashtable ht;
270 static struct rhltable rhlt;
272 static int __init test_rhltable(unsigned int entries)
274 struct test_obj_rhl *rhl_test_objects;
275 unsigned long *obj_in_table;
276 unsigned int i, j, k;
282 rhl_test_objects = vzalloc(array_size(entries,
283 sizeof(*rhl_test_objects)));
284 if (!rhl_test_objects)
288 obj_in_table = vzalloc(array_size(sizeof(unsigned long),
289 BITS_TO_LONGS(entries)));
293 err = rhltable_init(&rhlt, &test_rht_params);
299 for (i = 0; i < entries; i++) {
300 rhl_test_objects[i].value.id = k;
301 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node,
303 if (WARN(err, "error %d on element %d\n", err, i))
306 set_bit(i, obj_in_table);
312 pr_info("test %d add/delete pairs into rhlist\n", entries);
313 for (i = 0; i < entries; i++) {
314 struct rhlist_head *h, *pos;
315 struct test_obj_rhl *obj;
316 struct test_obj_val key = {
322 h = rhltable_lookup(&rhlt, &key, test_rht_params);
323 if (WARN(!h, "key not found during iteration %d of %d", i, entries)) {
330 rhl_for_each_entry_rcu(obj, pos, h, list_node) {
331 if (WARN(pos == &rhl_test_objects[j].list_node, "old element found, should be gone"))
340 rhl_for_each_entry_rcu(obj, pos, h, list_node) {
341 if (pos == &rhl_test_objects[i].list_node) {
349 if (WARN(!found, "element %d not found", i))
352 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
353 WARN(err, "rhltable_remove: err %d for iteration %d\n", err, i);
355 clear_bit(i, obj_in_table);
361 for (i = 0; i < entries; i++) {
362 WARN(test_bit(i, obj_in_table), "elem %d allegedly still present", i);
364 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node,
366 if (WARN(err, "error %d on element %d\n", err, i))
369 set_bit(i, obj_in_table);
372 pr_info("test %d random rhlist add/delete operations\n", entries);
373 for (j = 0; j < entries; j++) {
374 u32 i = prandom_u32_max(entries);
375 u32 prand = prandom_u32();
380 prand = prandom_u32();
387 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
388 if (test_bit(i, obj_in_table)) {
389 clear_bit(i, obj_in_table);
390 if (WARN(err, "cannot remove element at slot %d", i))
393 if (WARN(err != -ENOENT, "removed non-existent element %d, error %d not %d",
403 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
405 if (WARN(test_and_set_bit(i, obj_in_table), "succeeded to insert same object %d", i))
408 if (WARN(!test_bit(i, obj_in_table), "failed to insert object %d", i))
417 i = prandom_u32_max(entries);
418 if (test_bit(i, obj_in_table)) {
419 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
420 WARN(err, "cannot remove element at slot %d", i);
422 clear_bit(i, obj_in_table);
424 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
425 WARN(err, "failed to insert object %d", i);
427 set_bit(i, obj_in_table);
431 for (i = 0; i < entries; i++) {
433 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
434 if (test_bit(i, obj_in_table)) {
435 if (WARN(err, "cannot remove element at slot %d", i))
438 if (WARN(err != -ENOENT, "removed non-existent element, error %d not %d",
444 rhltable_destroy(&rhlt);
446 vfree(rhl_test_objects);
451 static int __init test_rhashtable_max(struct test_obj *array,
452 unsigned int entries)
454 unsigned int i, insert_retries = 0;
457 test_rht_params.max_size = roundup_pow_of_two(entries / 8);
458 err = rhashtable_init(&ht, &test_rht_params);
462 for (i = 0; i < ht.max_elems; i++) {
463 struct test_obj *obj = &array[i];
465 obj->value.id = i * 2;
466 err = insert_retry(&ht, obj, test_rht_params);
468 insert_retries += err;
473 err = insert_retry(&ht, &array[ht.max_elems], test_rht_params);
477 pr_info("insert element %u should have failed with %d, got %d\n",
478 ht.max_elems, -E2BIG, err);
483 rhashtable_destroy(&ht);
488 static unsigned int __init print_ht(struct rhltable *rhlt)
490 struct rhashtable *ht;
491 const struct bucket_table *tbl;
493 unsigned int i, cnt = 0;
496 /* Take the mutex to avoid RCU warning */
497 mutex_lock(&ht->mutex);
498 tbl = rht_dereference(ht->tbl, ht);
499 for (i = 0; i < tbl->size; i++) {
500 struct rhash_head *pos, *next;
501 struct test_obj_rhl *p;
503 pos = rht_ptr_exclusive(tbl->buckets + i);
504 next = !rht_is_a_nulls(pos) ? rht_dereference(pos->next, ht) : NULL;
506 if (!rht_is_a_nulls(pos)) {
507 sprintf(buff, "%s\nbucket[%d] -> ", buff, i);
510 while (!rht_is_a_nulls(pos)) {
511 struct rhlist_head *list = container_of(pos, struct rhlist_head, rhead);
512 sprintf(buff, "%s[[", buff);
515 list = rht_dereference(list->next, ht);
516 p = rht_obj(ht, pos);
518 sprintf(buff, "%s val %d (tid=%d)%s", buff, p->value.id, p->value.tid,
524 next = !rht_is_a_nulls(pos) ?
525 rht_dereference(pos->next, ht) : NULL;
527 sprintf(buff, "%s]]%s", buff, !rht_is_a_nulls(pos) ? " -> " : "");
530 printk(KERN_ERR "\n---- ht: ----%s\n-------------\n", buff);
531 mutex_unlock(&ht->mutex);
536 static int __init test_insert_dup(struct test_obj_rhl *rhl_test_objects,
539 struct rhltable *rhlt;
544 rhlt = kmalloc(sizeof(*rhlt), GFP_KERNEL);
548 err = rhltable_init(rhlt, &test_rht_params_dup);
554 for (i = 0; i < cnt; i++) {
555 rhl_test_objects[i].value.tid = i;
556 key = rht_obj(&rhlt->ht, &rhl_test_objects[i].list_node.rhead);
557 key += test_rht_params_dup.key_offset;
560 err = PTR_ERR(rhashtable_insert_slow(&rhlt->ht, key,
561 &rhl_test_objects[i].list_node.rhead));
565 err = rhltable_insert(rhlt,
566 &rhl_test_objects[i].list_node,
567 test_rht_params_dup);
568 if (WARN(err, "error %d on element %d/%d (%s)\n", err, i, cnt, slow? "slow" : "fast"))
572 ret = print_ht(rhlt);
573 WARN(ret != cnt, "missing rhltable elements (%d != %d, %s)\n", ret, cnt, slow? "slow" : "fast");
576 rhltable_destroy(rhlt);
582 static int __init test_insert_duplicates_run(void)
584 struct test_obj_rhl rhl_test_objects[3] = {};
586 pr_info("test inserting duplicates\n");
588 /* two different values that map to same bucket */
589 rhl_test_objects[0].value.id = 1;
590 rhl_test_objects[1].value.id = 21;
592 /* and another duplicate with same as [0] value
593 * which will be second on the bucket list */
594 rhl_test_objects[2].value.id = rhl_test_objects[0].value.id;
596 test_insert_dup(rhl_test_objects, 2, false);
597 test_insert_dup(rhl_test_objects, 3, false);
598 test_insert_dup(rhl_test_objects, 2, true);
599 test_insert_dup(rhl_test_objects, 3, true);
604 static int thread_lookup_test(struct thread_data *tdata)
606 unsigned int entries = tdata->entries;
609 for (i = 0; i < entries; i++) {
610 struct test_obj *obj;
611 struct test_obj_val key = {
616 obj = rhashtable_lookup_fast(&ht, &key, test_rht_params);
617 if (obj && (tdata->objs[i].value.id == TEST_INSERT_FAIL)) {
618 pr_err(" found unexpected object %d-%d\n", key.tid, key.id);
620 } else if (!obj && (tdata->objs[i].value.id != TEST_INSERT_FAIL)) {
621 pr_err(" object %d-%d not found!\n", key.tid, key.id);
623 } else if (obj && memcmp(&obj->value, &key, sizeof(key))) {
624 pr_err(" wrong object returned (got %d-%d, expected %d-%d)\n",
625 obj->value.tid, obj->value.id, key.tid, key.id);
634 static int threadfunc(void *data)
636 int i, step, err = 0, insert_retries = 0;
637 struct thread_data *tdata = data;
639 if (atomic_dec_and_test(&startup_count))
640 wake_up(&startup_wait);
641 if (wait_event_interruptible(startup_wait, atomic_read(&startup_count) == -1)) {
642 pr_err(" thread[%d]: interrupted\n", tdata->id);
646 for (i = 0; i < tdata->entries; i++) {
647 tdata->objs[i].value.id = i;
648 tdata->objs[i].value.tid = tdata->id;
649 err = insert_retry(&ht, &tdata->objs[i], test_rht_params);
651 insert_retries += err;
653 pr_err(" thread[%d]: rhashtable_insert_fast failed\n",
659 pr_info(" thread[%d]: %u insertions retried due to memory pressure\n",
660 tdata->id, insert_retries);
662 err = thread_lookup_test(tdata);
664 pr_err(" thread[%d]: rhashtable_lookup_test failed\n",
669 for (step = 10; step > 0; step--) {
670 for (i = 0; i < tdata->entries; i += step) {
671 if (tdata->objs[i].value.id == TEST_INSERT_FAIL)
673 err = rhashtable_remove_fast(&ht, &tdata->objs[i].node,
676 pr_err(" thread[%d]: rhashtable_remove_fast failed\n",
680 tdata->objs[i].value.id = TEST_INSERT_FAIL;
684 err = thread_lookup_test(tdata);
686 pr_err(" thread[%d]: rhashtable_lookup_test (2) failed\n",
692 while (!kthread_should_stop()) {
693 set_current_state(TASK_INTERRUPTIBLE);
699 static int __init test_rht_init(void)
701 unsigned int entries;
702 int i, err, started_threads = 0, failed_threads = 0;
704 struct thread_data *tdata;
705 struct test_obj *objs;
707 if (parm_entries < 0)
710 entries = min(parm_entries, MAX_ENTRIES);
712 test_rht_params.automatic_shrinking = shrinking;
713 test_rht_params.max_size = max_size ? : roundup_pow_of_two(entries);
714 test_rht_params.nelem_hint = size;
716 objs = vzalloc(array_size(sizeof(struct test_obj),
717 test_rht_params.max_size + 1));
721 pr_info("Running rhashtable test nelem=%d, max_size=%d, shrinking=%d\n",
722 size, max_size, shrinking);
724 for (i = 0; i < runs; i++) {
727 pr_info("Test %02d:\n", i);
728 memset(objs, 0, test_rht_params.max_size * sizeof(struct test_obj));
730 err = rhashtable_init(&ht, &test_rht_params);
732 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
737 time = test_rhashtable(&ht, objs, entries);
738 rhashtable_destroy(&ht);
741 pr_warn("Test failed: return code %lld\n", time);
748 pr_info("test if its possible to exceed max_size %d: %s\n",
749 test_rht_params.max_size, test_rhashtable_max(objs, entries) == 0 ?
750 "no, ok" : "YES, failed");
753 do_div(total_time, runs);
754 pr_info("Average test time: %llu\n", total_time);
756 test_insert_duplicates_run();
761 pr_info("Testing concurrent rhashtable access from %d threads\n",
763 atomic_set(&startup_count, tcount);
764 tdata = vzalloc(array_size(tcount, sizeof(struct thread_data)));
767 objs = vzalloc(array3_size(sizeof(struct test_obj), tcount, entries));
773 test_rht_params.max_size = max_size ? :
774 roundup_pow_of_two(tcount * entries);
775 err = rhashtable_init(&ht, &test_rht_params);
777 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
783 for (i = 0; i < tcount; i++) {
785 tdata[i].entries = entries;
786 tdata[i].objs = objs + i * entries;
787 tdata[i].task = kthread_run(threadfunc, &tdata[i],
788 "rhashtable_thrad[%d]", i);
789 if (IS_ERR(tdata[i].task)) {
790 pr_err(" kthread_run failed for thread %d\n", i);
791 atomic_dec(&startup_count);
796 if (wait_event_interruptible(startup_wait, atomic_read(&startup_count) == 0))
797 pr_err(" wait_event interruptible failed\n");
798 /* count is 0 now, set it to -1 and wake up all threads together */
799 atomic_dec(&startup_count);
800 wake_up_all(&startup_wait);
801 for (i = 0; i < tcount; i++) {
802 if (IS_ERR(tdata[i].task))
804 if ((err = kthread_stop(tdata[i].task))) {
805 pr_warn("Test failed: thread %d returned: %d\n",
810 rhashtable_destroy(&ht);
815 * rhltable_remove is very expensive, default values can cause test
816 * to run for 2 minutes or more, use a smaller number instead.
818 err = test_rhltable(entries / 16);
819 pr_info("Started %d threads, %d failed, rhltable test returns %d\n",
820 started_threads, failed_threads, err);
824 static void __exit test_rht_exit(void)
828 module_init(test_rht_init);
829 module_exit(test_rht_exit);
831 MODULE_LICENSE("GPL v2");