blob: 297fdb5e74bd05bc4a3258c90465510463cbf8fb [file] [log] [blame]
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01001/*
2 * Resizable, Scalable, Concurrent Hash Table
3 *
Thomas Graf1aa661f2015-04-30 22:37:41 +00004 * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01005 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
6 *
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01007 * 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.
10 */
11
12/**************************************************************************
13 * Self Test
14 **************************************************************************/
15
16#include <linux/init.h>
17#include <linux/jhash.h>
18#include <linux/kernel.h>
Phil Sutterf4a3e902015-08-15 00:37:15 +020019#include <linux/kthread.h>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010020#include <linux/module.h>
21#include <linux/rcupdate.h>
22#include <linux/rhashtable.h>
Phil Sutterf4a3e902015-08-15 00:37:15 +020023#include <linux/semaphore.h>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010024#include <linux/slab.h>
Thomas Graf685a0152015-07-17 10:52:48 +020025#include <linux/sched.h>
Phil Sutterf4a3e902015-08-15 00:37:15 +020026#include <linux/vmalloc.h>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010027
Thomas Graf1aa661f2015-04-30 22:37:41 +000028#define MAX_ENTRIES 1000000
Thomas Graf67b7cbf2015-04-30 22:37:45 +000029#define TEST_INSERT_FAIL INT_MAX
Thomas Graf1aa661f2015-04-30 22:37:41 +000030
31static int entries = 50000;
32module_param(entries, int, 0);
33MODULE_PARM_DESC(entries, "Number of entries to add (default: 50000)");
34
35static int runs = 4;
36module_param(runs, int, 0);
37MODULE_PARM_DESC(runs, "Number of test runs per variant (default: 4)");
38
Phil Sutter95e435a2015-11-20 18:17:19 +010039static int max_size = 0;
Thomas Graf1aa661f2015-04-30 22:37:41 +000040module_param(max_size, int, 0);
Phil Sutter95e435a2015-11-20 18:17:19 +010041MODULE_PARM_DESC(runs, "Maximum table size (default: calculated)");
Thomas Graf1aa661f2015-04-30 22:37:41 +000042
43static bool shrinking = false;
44module_param(shrinking, bool, 0);
45MODULE_PARM_DESC(shrinking, "Enable automatic shrinking (default: off)");
46
47static int size = 8;
48module_param(size, int, 0);
49MODULE_PARM_DESC(size, "Initial size hint of table (default: 8)");
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010050
Phil Sutterf4a3e902015-08-15 00:37:15 +020051static int tcount = 10;
52module_param(tcount, int, 0);
53MODULE_PARM_DESC(tcount, "Number of threads to spawn (default: 10)");
54
Phil Sutterd662e032015-11-20 18:17:20 +010055static bool enomem_retry = false;
56module_param(enomem_retry, bool, 0);
57MODULE_PARM_DESC(enomem_retry, "Retry insert even if -ENOMEM was returned (default: off)");
58
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010059struct test_obj {
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010060 int value;
61 struct rhash_head node;
62};
63
Phil Sutterf4a3e902015-08-15 00:37:15 +020064struct thread_data {
65 int id;
66 struct task_struct *task;
67 struct test_obj *objs;
68};
69
Thomas Graffcc57022015-04-30 22:37:43 +000070static struct test_obj array[MAX_ENTRIES];
71
Thomas Graf1aa661f2015-04-30 22:37:41 +000072static struct rhashtable_params test_rht_params = {
Herbert Xub182aa62015-03-20 21:57:04 +110073 .head_offset = offsetof(struct test_obj, node),
74 .key_offset = offsetof(struct test_obj, value),
75 .key_len = sizeof(int),
76 .hashfn = jhash,
Herbert Xub182aa62015-03-20 21:57:04 +110077 .nulls_base = (3U << RHT_BASE_SHIFT),
78};
79
Phil Sutterf4a3e902015-08-15 00:37:15 +020080static struct semaphore prestart_sem;
81static struct semaphore startup_sem = __SEMAPHORE_INITIALIZER(startup_sem, 0);
82
Phil Sutter9e9089e2015-11-20 18:17:18 +010083static int insert_retry(struct rhashtable *ht, struct rhash_head *obj,
84 const struct rhashtable_params params)
85{
Phil Sutterd662e032015-11-20 18:17:20 +010086 int err, retries = -1, enomem_retries = 0;
Phil Sutter9e9089e2015-11-20 18:17:18 +010087
88 do {
89 retries++;
90 cond_resched();
91 err = rhashtable_insert_fast(ht, obj, params);
Phil Sutterd662e032015-11-20 18:17:20 +010092 if (err == -ENOMEM && enomem_retry) {
93 enomem_retries++;
94 err = -EBUSY;
95 }
Phil Sutter9e9089e2015-11-20 18:17:18 +010096 } while (err == -EBUSY);
97
Phil Sutterd662e032015-11-20 18:17:20 +010098 if (enomem_retries)
99 pr_info(" %u insertions retried after -ENOMEM\n",
100 enomem_retries);
101
Phil Sutter9e9089e2015-11-20 18:17:18 +0100102 return err ? : retries;
103}
104
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100105static int __init test_rht_lookup(struct rhashtable *ht)
106{
107 unsigned int i;
108
Thomas Graf1aa661f2015-04-30 22:37:41 +0000109 for (i = 0; i < entries * 2; i++) {
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100110 struct test_obj *obj;
111 bool expected = !(i % 2);
112 u32 key = i;
113
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000114 if (array[i / 2].value == TEST_INSERT_FAIL)
115 expected = false;
116
Herbert Xub182aa62015-03-20 21:57:04 +1100117 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100118
119 if (expected && !obj) {
120 pr_warn("Test failed: Could not find key %u\n", key);
121 return -ENOENT;
122 } else if (!expected && obj) {
123 pr_warn("Test failed: Unexpected entry found for key %u\n",
124 key);
125 return -EEXIST;
126 } else if (expected && obj) {
Thomas Grafc2c8a902015-04-30 22:37:42 +0000127 if (obj->value != i) {
128 pr_warn("Test failed: Lookup value mismatch %u!=%u\n",
129 obj->value, i);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100130 return -EINVAL;
131 }
132 }
Thomas Graf685a0152015-07-17 10:52:48 +0200133
134 cond_resched_rcu();
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100135 }
136
137 return 0;
138}
139
Thomas Graf246b23a2015-04-30 22:37:44 +0000140static void test_bucket_stats(struct rhashtable *ht)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100141{
Thomas Graf246b23a2015-04-30 22:37:44 +0000142 unsigned int err, total = 0, chain_len = 0;
143 struct rhashtable_iter hti;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100144 struct rhash_head *pos;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100145
Bob Copeland8f6fd832016-03-02 10:09:19 -0500146 err = rhashtable_walk_init(ht, &hti, GFP_KERNEL);
Thomas Graf246b23a2015-04-30 22:37:44 +0000147 if (err) {
148 pr_warn("Test failed: allocation error");
149 return;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100150 }
151
Thomas Graf246b23a2015-04-30 22:37:44 +0000152 err = rhashtable_walk_start(&hti);
153 if (err && err != -EAGAIN) {
154 pr_warn("Test failed: iterator failed: %d\n", err);
155 return;
156 }
157
158 while ((pos = rhashtable_walk_next(&hti))) {
159 if (PTR_ERR(pos) == -EAGAIN) {
160 pr_info("Info: encountered resize\n");
161 chain_len++;
162 continue;
163 } else if (IS_ERR(pos)) {
164 pr_warn("Test failed: rhashtable_walk_next() error: %ld\n",
165 PTR_ERR(pos));
166 break;
167 }
168
169 total++;
170 }
171
172 rhashtable_walk_stop(&hti);
173 rhashtable_walk_exit(&hti);
174
175 pr_info(" Traversal complete: counted=%u, nelems=%u, entries=%d, table-jumps=%u\n",
176 total, atomic_read(&ht->nelems), entries, chain_len);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100177
Thomas Graf1aa661f2015-04-30 22:37:41 +0000178 if (total != atomic_read(&ht->nelems) || total != entries)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100179 pr_warn("Test failed: Total count mismatch ^^^");
180}
181
Thomas Graf1aa661f2015-04-30 22:37:41 +0000182static s64 __init test_rhashtable(struct rhashtable *ht)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100183{
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100184 struct test_obj *obj;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100185 int err;
Phil Sutter9e9089e2015-11-20 18:17:18 +0100186 unsigned int i, insert_retries = 0;
Thomas Graf1aa661f2015-04-30 22:37:41 +0000187 s64 start, end;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100188
189 /*
190 * Insertion Test:
Thomas Graf1aa661f2015-04-30 22:37:41 +0000191 * Insert entries into table with all keys even numbers
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100192 */
Thomas Graf1aa661f2015-04-30 22:37:41 +0000193 pr_info(" Adding %d keys\n", entries);
194 start = ktime_get_ns();
195 for (i = 0; i < entries; i++) {
Thomas Graffcc57022015-04-30 22:37:43 +0000196 struct test_obj *obj = &array[i];
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100197
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100198 obj->value = i * 2;
Phil Sutter9e9089e2015-11-20 18:17:18 +0100199 err = insert_retry(ht, &obj->node, test_rht_params);
200 if (err > 0)
201 insert_retries += err;
202 else if (err)
Thomas Graffcc57022015-04-30 22:37:43 +0000203 return err;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100204 }
205
Phil Sutter9e9089e2015-11-20 18:17:18 +0100206 if (insert_retries)
207 pr_info(" %u insertions retried due to memory pressure\n",
208 insert_retries);
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000209
Thomas Graf246b23a2015-04-30 22:37:44 +0000210 test_bucket_stats(ht);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100211 rcu_read_lock();
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100212 test_rht_lookup(ht);
213 rcu_read_unlock();
214
Thomas Graf246b23a2015-04-30 22:37:44 +0000215 test_bucket_stats(ht);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100216
Thomas Graf1aa661f2015-04-30 22:37:41 +0000217 pr_info(" Deleting %d keys\n", entries);
218 for (i = 0; i < entries; i++) {
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100219 u32 key = i * 2;
220
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000221 if (array[i].value != TEST_INSERT_FAIL) {
222 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
223 BUG_ON(!obj);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100224
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000225 rhashtable_remove_fast(ht, &obj->node, test_rht_params);
226 }
Thomas Graf685a0152015-07-17 10:52:48 +0200227
228 cond_resched();
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100229 }
230
Thomas Graf1aa661f2015-04-30 22:37:41 +0000231 end = ktime_get_ns();
232 pr_info(" Duration of test: %lld ns\n", end - start);
233
234 return end - start;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100235}
236
Daniel Borkmannb7f5e5c2015-02-20 21:14:21 +0100237static struct rhashtable ht;
238
Phil Sutterf4a3e902015-08-15 00:37:15 +0200239static int thread_lookup_test(struct thread_data *tdata)
240{
241 int i, err = 0;
242
243 for (i = 0; i < entries; i++) {
244 struct test_obj *obj;
245 int key = (tdata->id << 16) | i;
246
247 obj = rhashtable_lookup_fast(&ht, &key, test_rht_params);
248 if (obj && (tdata->objs[i].value == TEST_INSERT_FAIL)) {
249 pr_err(" found unexpected object %d\n", key);
250 err++;
251 } else if (!obj && (tdata->objs[i].value != TEST_INSERT_FAIL)) {
252 pr_err(" object %d not found!\n", key);
253 err++;
254 } else if (obj && (obj->value != key)) {
255 pr_err(" wrong object returned (got %d, expected %d)\n",
256 obj->value, key);
257 err++;
258 }
Phil Suttercd5b3182015-11-20 18:17:17 +0100259
260 cond_resched();
Phil Sutterf4a3e902015-08-15 00:37:15 +0200261 }
262 return err;
263}
264
265static int threadfunc(void *data)
266{
Phil Sutter9e9089e2015-11-20 18:17:18 +0100267 int i, step, err = 0, insert_retries = 0;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200268 struct thread_data *tdata = data;
269
270 up(&prestart_sem);
271 if (down_interruptible(&startup_sem))
272 pr_err(" thread[%d]: down_interruptible failed\n", tdata->id);
273
274 for (i = 0; i < entries; i++) {
275 tdata->objs[i].value = (tdata->id << 16) | i;
Phil Sutter9e9089e2015-11-20 18:17:18 +0100276 err = insert_retry(&ht, &tdata->objs[i].node, test_rht_params);
277 if (err > 0) {
278 insert_retries += err;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200279 } else if (err) {
280 pr_err(" thread[%d]: rhashtable_insert_fast failed\n",
281 tdata->id);
282 goto out;
283 }
284 }
Phil Sutter9e9089e2015-11-20 18:17:18 +0100285 if (insert_retries)
286 pr_info(" thread[%d]: %u insertions retried due to memory pressure\n",
287 tdata->id, insert_retries);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200288
289 err = thread_lookup_test(tdata);
290 if (err) {
291 pr_err(" thread[%d]: rhashtable_lookup_test failed\n",
292 tdata->id);
293 goto out;
294 }
295
296 for (step = 10; step > 0; step--) {
297 for (i = 0; i < entries; i += step) {
298 if (tdata->objs[i].value == TEST_INSERT_FAIL)
299 continue;
300 err = rhashtable_remove_fast(&ht, &tdata->objs[i].node,
301 test_rht_params);
302 if (err) {
303 pr_err(" thread[%d]: rhashtable_remove_fast failed\n",
304 tdata->id);
305 goto out;
306 }
307 tdata->objs[i].value = TEST_INSERT_FAIL;
Phil Suttercd5b3182015-11-20 18:17:17 +0100308
309 cond_resched();
Phil Sutterf4a3e902015-08-15 00:37:15 +0200310 }
311 err = thread_lookup_test(tdata);
312 if (err) {
313 pr_err(" thread[%d]: rhashtable_lookup_test (2) failed\n",
314 tdata->id);
315 goto out;
316 }
317 }
318out:
319 while (!kthread_should_stop()) {
320 set_current_state(TASK_INTERRUPTIBLE);
321 schedule();
322 }
323 return err;
324}
325
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100326static int __init test_rht_init(void)
327{
Phil Sutterf4a3e902015-08-15 00:37:15 +0200328 int i, err, started_threads = 0, failed_threads = 0;
Thomas Graf1aa661f2015-04-30 22:37:41 +0000329 u64 total_time = 0;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200330 struct thread_data *tdata;
331 struct test_obj *objs;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100332
Thomas Graf1aa661f2015-04-30 22:37:41 +0000333 entries = min(entries, MAX_ENTRIES);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100334
Thomas Graf1aa661f2015-04-30 22:37:41 +0000335 test_rht_params.automatic_shrinking = shrinking;
Phil Sutter95e435a2015-11-20 18:17:19 +0100336 test_rht_params.max_size = max_size ? : roundup_pow_of_two(entries);
Thomas Graf1aa661f2015-04-30 22:37:41 +0000337 test_rht_params.nelem_hint = size;
338
339 pr_info("Running rhashtable test nelem=%d, max_size=%d, shrinking=%d\n",
340 size, max_size, shrinking);
341
342 for (i = 0; i < runs; i++) {
343 s64 time;
344
345 pr_info("Test %02d:\n", i);
Thomas Graffcc57022015-04-30 22:37:43 +0000346 memset(&array, 0, sizeof(array));
Thomas Graf1aa661f2015-04-30 22:37:41 +0000347 err = rhashtable_init(&ht, &test_rht_params);
348 if (err < 0) {
349 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
350 err);
351 continue;
352 }
353
354 time = test_rhashtable(&ht);
355 rhashtable_destroy(&ht);
356 if (time < 0) {
357 pr_warn("Test failed: return code %lld\n", time);
358 return -EINVAL;
359 }
360
361 total_time += time;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100362 }
363
Thomas Graf6decd632015-05-05 02:27:02 +0200364 do_div(total_time, runs);
365 pr_info("Average test time: %llu\n", total_time);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100366
Phil Sutterf4a3e902015-08-15 00:37:15 +0200367 if (!tcount)
368 return 0;
369
370 pr_info("Testing concurrent rhashtable access from %d threads\n",
371 tcount);
372 sema_init(&prestart_sem, 1 - tcount);
373 tdata = vzalloc(tcount * sizeof(struct thread_data));
374 if (!tdata)
375 return -ENOMEM;
376 objs = vzalloc(tcount * entries * sizeof(struct test_obj));
377 if (!objs) {
378 vfree(tdata);
379 return -ENOMEM;
380 }
381
Phil Sutter95e435a2015-11-20 18:17:19 +0100382 test_rht_params.max_size = max_size ? :
383 roundup_pow_of_two(tcount * entries);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200384 err = rhashtable_init(&ht, &test_rht_params);
385 if (err < 0) {
386 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
387 err);
388 vfree(tdata);
389 vfree(objs);
390 return -EINVAL;
391 }
392 for (i = 0; i < tcount; i++) {
393 tdata[i].id = i;
394 tdata[i].objs = objs + i * entries;
395 tdata[i].task = kthread_run(threadfunc, &tdata[i],
396 "rhashtable_thrad[%d]", i);
397 if (IS_ERR(tdata[i].task))
398 pr_err(" kthread_run failed for thread %d\n", i);
399 else
400 started_threads++;
401 }
402 if (down_interruptible(&prestart_sem))
403 pr_err(" down interruptible failed\n");
404 for (i = 0; i < tcount; i++)
405 up(&startup_sem);
406 for (i = 0; i < tcount; i++) {
407 if (IS_ERR(tdata[i].task))
408 continue;
409 if ((err = kthread_stop(tdata[i].task))) {
410 pr_warn("Test failed: thread %d returned: %d\n",
411 i, err);
412 failed_threads++;
413 }
414 }
415 pr_info("Started %d threads, %d failed\n",
416 started_threads, failed_threads);
417 rhashtable_destroy(&ht);
418 vfree(tdata);
419 vfree(objs);
Thomas Graf1aa661f2015-04-30 22:37:41 +0000420 return 0;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100421}
422
Daniel Borkmann6dd0c162015-02-20 00:53:39 +0100423static void __exit test_rht_exit(void)
424{
425}
426
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100427module_init(test_rht_init);
Daniel Borkmann6dd0c162015-02-20 00:53:39 +0100428module_exit(test_rht_exit);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100429
430MODULE_LICENSE("GPL v2");