rhashtable-test: add cond_resched() to thread test
[linux-2.6-block.git] / lib / test_rhashtable.c
CommitLineData
9d6dbe1b
GU
1/*
2 * Resizable, Scalable, Concurrent Hash Table
3 *
1aa661f5 4 * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
9d6dbe1b
GU
5 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
6 *
9d6dbe1b
GU
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.
10 */
11
12/**************************************************************************
13 * Self Test
14 **************************************************************************/
15
16#include <linux/init.h>
17#include <linux/jhash.h>
18#include <linux/kernel.h>
f4a3e90b 19#include <linux/kthread.h>
9d6dbe1b
GU
20#include <linux/module.h>
21#include <linux/rcupdate.h>
22#include <linux/rhashtable.h>
f4a3e90b 23#include <linux/semaphore.h>
9d6dbe1b 24#include <linux/slab.h>
685a015e 25#include <linux/sched.h>
f4a3e90b 26#include <linux/vmalloc.h>
9d6dbe1b 27
1aa661f5 28#define MAX_ENTRIES 1000000
67b7cbf4 29#define TEST_INSERT_FAIL INT_MAX
1aa661f5
TG
30
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
39static int max_size = 65536;
40module_param(max_size, int, 0);
41MODULE_PARM_DESC(runs, "Maximum table size (default: 65536)");
42
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)");
9d6dbe1b 50
f4a3e90b
PS
51static int tcount = 10;
52module_param(tcount, int, 0);
53MODULE_PARM_DESC(tcount, "Number of threads to spawn (default: 10)");
54
9d6dbe1b 55struct test_obj {
9d6dbe1b
GU
56 int value;
57 struct rhash_head node;
58};
59
f4a3e90b
PS
60struct thread_data {
61 int id;
62 struct task_struct *task;
63 struct test_obj *objs;
64};
65
fcc57020
TG
66static struct test_obj array[MAX_ENTRIES];
67
1aa661f5 68static struct rhashtable_params test_rht_params = {
b182aa6e
HX
69 .head_offset = offsetof(struct test_obj, node),
70 .key_offset = offsetof(struct test_obj, value),
71 .key_len = sizeof(int),
72 .hashfn = jhash,
b182aa6e
HX
73 .nulls_base = (3U << RHT_BASE_SHIFT),
74};
75
f4a3e90b
PS
76static struct semaphore prestart_sem;
77static struct semaphore startup_sem = __SEMAPHORE_INITIALIZER(startup_sem, 0);
78
9d6dbe1b
GU
79static int __init test_rht_lookup(struct rhashtable *ht)
80{
81 unsigned int i;
82
1aa661f5 83 for (i = 0; i < entries * 2; i++) {
9d6dbe1b
GU
84 struct test_obj *obj;
85 bool expected = !(i % 2);
86 u32 key = i;
87
67b7cbf4
TG
88 if (array[i / 2].value == TEST_INSERT_FAIL)
89 expected = false;
90
b182aa6e 91 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
9d6dbe1b
GU
92
93 if (expected && !obj) {
94 pr_warn("Test failed: Could not find key %u\n", key);
95 return -ENOENT;
96 } else if (!expected && obj) {
97 pr_warn("Test failed: Unexpected entry found for key %u\n",
98 key);
99 return -EEXIST;
100 } else if (expected && obj) {
c2c8a901
TG
101 if (obj->value != i) {
102 pr_warn("Test failed: Lookup value mismatch %u!=%u\n",
103 obj->value, i);
9d6dbe1b
GU
104 return -EINVAL;
105 }
106 }
685a015e
TG
107
108 cond_resched_rcu();
9d6dbe1b
GU
109 }
110
111 return 0;
112}
113
246b23a7 114static void test_bucket_stats(struct rhashtable *ht)
9d6dbe1b 115{
246b23a7
TG
116 unsigned int err, total = 0, chain_len = 0;
117 struct rhashtable_iter hti;
9d6dbe1b 118 struct rhash_head *pos;
9d6dbe1b 119
246b23a7
TG
120 err = rhashtable_walk_init(ht, &hti);
121 if (err) {
122 pr_warn("Test failed: allocation error");
123 return;
124 }
9d6dbe1b 125
246b23a7
TG
126 err = rhashtable_walk_start(&hti);
127 if (err && err != -EAGAIN) {
128 pr_warn("Test failed: iterator failed: %d\n", err);
129 return;
130 }
9d6dbe1b 131
246b23a7
TG
132 while ((pos = rhashtable_walk_next(&hti))) {
133 if (PTR_ERR(pos) == -EAGAIN) {
134 pr_info("Info: encountered resize\n");
135 chain_len++;
136 continue;
137 } else if (IS_ERR(pos)) {
138 pr_warn("Test failed: rhashtable_walk_next() error: %ld\n",
139 PTR_ERR(pos));
140 break;
9d6dbe1b
GU
141 }
142
246b23a7 143 total++;
9d6dbe1b
GU
144 }
145
246b23a7
TG
146 rhashtable_walk_stop(&hti);
147 rhashtable_walk_exit(&hti);
148
149 pr_info(" Traversal complete: counted=%u, nelems=%u, entries=%d, table-jumps=%u\n",
150 total, atomic_read(&ht->nelems), entries, chain_len);
9d6dbe1b 151
1aa661f5 152 if (total != atomic_read(&ht->nelems) || total != entries)
9d6dbe1b
GU
153 pr_warn("Test failed: Total count mismatch ^^^");
154}
155
1aa661f5 156static s64 __init test_rhashtable(struct rhashtable *ht)
9d6dbe1b 157{
9d6dbe1b 158 struct test_obj *obj;
9d6dbe1b 159 int err;
67b7cbf4 160 unsigned int i, insert_fails = 0;
1aa661f5 161 s64 start, end;
9d6dbe1b
GU
162
163 /*
164 * Insertion Test:
1aa661f5 165 * Insert entries into table with all keys even numbers
9d6dbe1b 166 */
1aa661f5
TG
167 pr_info(" Adding %d keys\n", entries);
168 start = ktime_get_ns();
169 for (i = 0; i < entries; i++) {
fcc57020 170 struct test_obj *obj = &array[i];
9d6dbe1b 171
9d6dbe1b
GU
172 obj->value = i * 2;
173
b182aa6e 174 err = rhashtable_insert_fast(ht, &obj->node, test_rht_params);
67b7cbf4
TG
175 if (err == -ENOMEM || err == -EBUSY) {
176 /* Mark failed inserts but continue */
177 obj->value = TEST_INSERT_FAIL;
178 insert_fails++;
179 } else if (err) {
fcc57020 180 return err;
67b7cbf4 181 }
685a015e
TG
182
183 cond_resched();
9d6dbe1b
GU
184 }
185
67b7cbf4
TG
186 if (insert_fails)
187 pr_info(" %u insertions failed due to memory pressure\n",
188 insert_fails);
189
246b23a7 190 test_bucket_stats(ht);
9d6dbe1b 191 rcu_read_lock();
9d6dbe1b
GU
192 test_rht_lookup(ht);
193 rcu_read_unlock();
194
246b23a7 195 test_bucket_stats(ht);
9d6dbe1b 196
1aa661f5
TG
197 pr_info(" Deleting %d keys\n", entries);
198 for (i = 0; i < entries; i++) {
9d6dbe1b
GU
199 u32 key = i * 2;
200
67b7cbf4
TG
201 if (array[i].value != TEST_INSERT_FAIL) {
202 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
203 BUG_ON(!obj);
9d6dbe1b 204
67b7cbf4
TG
205 rhashtable_remove_fast(ht, &obj->node, test_rht_params);
206 }
685a015e
TG
207
208 cond_resched();
9d6dbe1b
GU
209 }
210
1aa661f5
TG
211 end = ktime_get_ns();
212 pr_info(" Duration of test: %lld ns\n", end - start);
213
214 return end - start;
9d6dbe1b
GU
215}
216
b7f5e5c7
DB
217static struct rhashtable ht;
218
f4a3e90b
PS
219static int thread_lookup_test(struct thread_data *tdata)
220{
221 int i, err = 0;
222
223 for (i = 0; i < entries; i++) {
224 struct test_obj *obj;
225 int key = (tdata->id << 16) | i;
226
227 obj = rhashtable_lookup_fast(&ht, &key, test_rht_params);
228 if (obj && (tdata->objs[i].value == TEST_INSERT_FAIL)) {
229 pr_err(" found unexpected object %d\n", key);
230 err++;
231 } else if (!obj && (tdata->objs[i].value != TEST_INSERT_FAIL)) {
232 pr_err(" object %d not found!\n", key);
233 err++;
234 } else if (obj && (obj->value != key)) {
235 pr_err(" wrong object returned (got %d, expected %d)\n",
236 obj->value, key);
237 err++;
238 }
cd5b318d
PS
239
240 cond_resched();
f4a3e90b
PS
241 }
242 return err;
243}
244
245static int threadfunc(void *data)
246{
247 int i, step, err = 0, insert_fails = 0;
248 struct thread_data *tdata = data;
249
250 up(&prestart_sem);
251 if (down_interruptible(&startup_sem))
252 pr_err(" thread[%d]: down_interruptible failed\n", tdata->id);
253
254 for (i = 0; i < entries; i++) {
255 tdata->objs[i].value = (tdata->id << 16) | i;
cd5b318d 256 cond_resched();
f4a3e90b
PS
257 err = rhashtable_insert_fast(&ht, &tdata->objs[i].node,
258 test_rht_params);
259 if (err == -ENOMEM || err == -EBUSY) {
260 tdata->objs[i].value = TEST_INSERT_FAIL;
261 insert_fails++;
262 } else if (err) {
263 pr_err(" thread[%d]: rhashtable_insert_fast failed\n",
264 tdata->id);
265 goto out;
266 }
267 }
268 if (insert_fails)
269 pr_info(" thread[%d]: %d insert failures\n",
270 tdata->id, insert_fails);
271
272 err = thread_lookup_test(tdata);
273 if (err) {
274 pr_err(" thread[%d]: rhashtable_lookup_test failed\n",
275 tdata->id);
276 goto out;
277 }
278
279 for (step = 10; step > 0; step--) {
280 for (i = 0; i < entries; i += step) {
281 if (tdata->objs[i].value == TEST_INSERT_FAIL)
282 continue;
283 err = rhashtable_remove_fast(&ht, &tdata->objs[i].node,
284 test_rht_params);
285 if (err) {
286 pr_err(" thread[%d]: rhashtable_remove_fast failed\n",
287 tdata->id);
288 goto out;
289 }
290 tdata->objs[i].value = TEST_INSERT_FAIL;
cd5b318d
PS
291
292 cond_resched();
f4a3e90b
PS
293 }
294 err = thread_lookup_test(tdata);
295 if (err) {
296 pr_err(" thread[%d]: rhashtable_lookup_test (2) failed\n",
297 tdata->id);
298 goto out;
299 }
300 }
301out:
302 while (!kthread_should_stop()) {
303 set_current_state(TASK_INTERRUPTIBLE);
304 schedule();
305 }
306 return err;
307}
308
9d6dbe1b
GU
309static int __init test_rht_init(void)
310{
f4a3e90b 311 int i, err, started_threads = 0, failed_threads = 0;
1aa661f5 312 u64 total_time = 0;
f4a3e90b
PS
313 struct thread_data *tdata;
314 struct test_obj *objs;
9d6dbe1b 315
1aa661f5 316 entries = min(entries, MAX_ENTRIES);
9d6dbe1b 317
1aa661f5
TG
318 test_rht_params.automatic_shrinking = shrinking;
319 test_rht_params.max_size = max_size;
320 test_rht_params.nelem_hint = size;
9d6dbe1b 321
1aa661f5
TG
322 pr_info("Running rhashtable test nelem=%d, max_size=%d, shrinking=%d\n",
323 size, max_size, shrinking);
9d6dbe1b 324
1aa661f5
TG
325 for (i = 0; i < runs; i++) {
326 s64 time;
9d6dbe1b 327
1aa661f5 328 pr_info("Test %02d:\n", i);
fcc57020 329 memset(&array, 0, sizeof(array));
1aa661f5
TG
330 err = rhashtable_init(&ht, &test_rht_params);
331 if (err < 0) {
332 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
333 err);
334 continue;
335 }
336
337 time = test_rhashtable(&ht);
338 rhashtable_destroy(&ht);
339 if (time < 0) {
340 pr_warn("Test failed: return code %lld\n", time);
341 return -EINVAL;
342 }
343
344 total_time += time;
345 }
346
6decd63a
TG
347 do_div(total_time, runs);
348 pr_info("Average test time: %llu\n", total_time);
1aa661f5 349
f4a3e90b
PS
350 if (!tcount)
351 return 0;
352
353 pr_info("Testing concurrent rhashtable access from %d threads\n",
354 tcount);
355 sema_init(&prestart_sem, 1 - tcount);
356 tdata = vzalloc(tcount * sizeof(struct thread_data));
357 if (!tdata)
358 return -ENOMEM;
359 objs = vzalloc(tcount * entries * sizeof(struct test_obj));
360 if (!objs) {
361 vfree(tdata);
362 return -ENOMEM;
363 }
364
365 err = rhashtable_init(&ht, &test_rht_params);
366 if (err < 0) {
367 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
368 err);
369 vfree(tdata);
370 vfree(objs);
371 return -EINVAL;
372 }
373 for (i = 0; i < tcount; i++) {
374 tdata[i].id = i;
375 tdata[i].objs = objs + i * entries;
376 tdata[i].task = kthread_run(threadfunc, &tdata[i],
377 "rhashtable_thrad[%d]", i);
378 if (IS_ERR(tdata[i].task))
379 pr_err(" kthread_run failed for thread %d\n", i);
380 else
381 started_threads++;
382 }
383 if (down_interruptible(&prestart_sem))
384 pr_err(" down interruptible failed\n");
385 for (i = 0; i < tcount; i++)
386 up(&startup_sem);
387 for (i = 0; i < tcount; i++) {
388 if (IS_ERR(tdata[i].task))
389 continue;
390 if ((err = kthread_stop(tdata[i].task))) {
391 pr_warn("Test failed: thread %d returned: %d\n",
392 i, err);
393 failed_threads++;
394 }
395 }
396 pr_info("Started %d threads, %d failed\n",
397 started_threads, failed_threads);
398 rhashtable_destroy(&ht);
399 vfree(tdata);
400 vfree(objs);
1aa661f5 401 return 0;
9d6dbe1b
GU
402}
403
6dd0c165
DB
404static void __exit test_rht_exit(void)
405{
406}
407
9d6dbe1b 408module_init(test_rht_init);
6dd0c165 409module_exit(test_rht_exit);
9d6dbe1b
GU
410
411MODULE_LICENSE("GPL v2");