blob: c20f6cb4bf550541ce9b423e5abaf0bbc7ff7f54 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01002/*
3 * Resizable, Scalable, Concurrent Hash Table
4 *
Thomas Graf1aa661f52015-04-30 22:37:41 +00005 * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01006 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01007 */
8
9/**************************************************************************
10 * Self Test
11 **************************************************************************/
12
13#include <linux/init.h>
14#include <linux/jhash.h>
15#include <linux/kernel.h>
Phil Sutterf4a3e902015-08-15 00:37:15 +020016#include <linux/kthread.h>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010017#include <linux/module.h>
18#include <linux/rcupdate.h>
19#include <linux/rhashtable.h>
20#include <linux/slab.h>
Thomas Graf685a0152015-07-17 10:52:48 +020021#include <linux/sched.h>
Florian Westphalcdd4de32017-09-20 01:12:14 +020022#include <linux/random.h>
Phil Sutterf4a3e902015-08-15 00:37:15 +020023#include <linux/vmalloc.h>
Arnd Bergmann809c6702018-12-16 20:48:21 +010024#include <linux/wait.h>
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010025
Thomas Graf1aa661f52015-04-30 22:37:41 +000026#define MAX_ENTRIES 1000000
Thomas Graf67b7cbf2015-04-30 22:37:45 +000027#define TEST_INSERT_FAIL INT_MAX
Thomas Graf1aa661f52015-04-30 22:37:41 +000028
Florian Westphalf6516162017-09-20 01:12:12 +020029static int parm_entries = 50000;
30module_param(parm_entries, int, 0);
31MODULE_PARM_DESC(parm_entries, "Number of entries to add (default: 50000)");
Thomas Graf1aa661f52015-04-30 22:37:41 +000032
33static int runs = 4;
34module_param(runs, int, 0);
35MODULE_PARM_DESC(runs, "Number of test runs per variant (default: 4)");
36
Phil Sutter95e435a2015-11-20 18:17:19 +010037static int max_size = 0;
Thomas Graf1aa661f52015-04-30 22:37:41 +000038module_param(max_size, int, 0);
Phil Sutter3b3bf802016-08-04 12:37:17 +020039MODULE_PARM_DESC(max_size, "Maximum table size (default: calculated)");
Thomas Graf1aa661f52015-04-30 22:37:41 +000040
41static bool shrinking = false;
42module_param(shrinking, bool, 0);
43MODULE_PARM_DESC(shrinking, "Enable automatic shrinking (default: off)");
44
45static int size = 8;
46module_param(size, int, 0);
47MODULE_PARM_DESC(size, "Initial size hint of table (default: 8)");
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010048
Phil Sutterf4a3e902015-08-15 00:37:15 +020049static int tcount = 10;
50module_param(tcount, int, 0);
51MODULE_PARM_DESC(tcount, "Number of threads to spawn (default: 10)");
52
Phil Sutterd662e032015-11-20 18:17:20 +010053static bool enomem_retry = false;
54module_param(enomem_retry, bool, 0);
55MODULE_PARM_DESC(enomem_retry, "Retry insert even if -ENOMEM was returned (default: off)");
56
Phil Suttere859afe2017-07-21 16:51:31 +020057struct test_obj_val {
58 int id;
59 int tid;
60};
61
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010062struct test_obj {
Phil Suttere859afe2017-07-21 16:51:31 +020063 struct test_obj_val value;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +010064 struct rhash_head node;
65};
66
Florian Westphalcdd4de32017-09-20 01:12:14 +020067struct test_obj_rhl {
68 struct test_obj_val value;
69 struct rhlist_head list_node;
70};
71
Phil Sutterf4a3e902015-08-15 00:37:15 +020072struct thread_data {
Florian Westphalf6516162017-09-20 01:12:12 +020073 unsigned int entries;
Phil Sutterf4a3e902015-08-15 00:37:15 +020074 int id;
75 struct task_struct *task;
76 struct test_obj *objs;
77};
78
Paul Blakey499ac3b2018-03-04 17:29:49 +020079static u32 my_hashfn(const void *data, u32 len, u32 seed)
80{
81 const struct test_obj_rhl *obj = data;
82
NeilBrown9f9a7072018-06-18 12:52:50 +100083 return (obj->value.id % 10);
Paul Blakey499ac3b2018-03-04 17:29:49 +020084}
85
86static int my_cmpfn(struct rhashtable_compare_arg *arg, const void *obj)
87{
88 const struct test_obj_rhl *test_obj = obj;
89 const struct test_obj_val *val = arg->key;
90
91 return test_obj->value.id - val->id;
92}
93
Thomas Graf1aa661f52015-04-30 22:37:41 +000094static struct rhashtable_params test_rht_params = {
Herbert Xub182aa62015-03-20 21:57:04 +110095 .head_offset = offsetof(struct test_obj, node),
96 .key_offset = offsetof(struct test_obj, value),
Phil Suttere859afe2017-07-21 16:51:31 +020097 .key_len = sizeof(struct test_obj_val),
Herbert Xub182aa62015-03-20 21:57:04 +110098 .hashfn = jhash,
Herbert Xub182aa62015-03-20 21:57:04 +110099};
100
Paul Blakey499ac3b2018-03-04 17:29:49 +0200101static struct rhashtable_params test_rht_params_dup = {
102 .head_offset = offsetof(struct test_obj_rhl, list_node),
103 .key_offset = offsetof(struct test_obj_rhl, value),
104 .key_len = sizeof(struct test_obj_val),
105 .hashfn = jhash,
106 .obj_hashfn = my_hashfn,
107 .obj_cmpfn = my_cmpfn,
108 .nelem_hint = 128,
109 .automatic_shrinking = false,
110};
111
Arnd Bergmann809c6702018-12-16 20:48:21 +0100112static atomic_t startup_count;
113static DECLARE_WAIT_QUEUE_HEAD(startup_wait);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200114
Florian Westphal7e936bd2017-09-20 01:12:11 +0200115static int insert_retry(struct rhashtable *ht, struct test_obj *obj,
Phil Sutter9e9089e2015-11-20 18:17:18 +0100116 const struct rhashtable_params params)
117{
Phil Sutterd662e032015-11-20 18:17:20 +0100118 int err, retries = -1, enomem_retries = 0;
Phil Sutter9e9089e2015-11-20 18:17:18 +0100119
120 do {
121 retries++;
122 cond_resched();
Florian Westphal7e936bd2017-09-20 01:12:11 +0200123 err = rhashtable_insert_fast(ht, &obj->node, params);
Phil Sutterd662e032015-11-20 18:17:20 +0100124 if (err == -ENOMEM && enomem_retry) {
125 enomem_retries++;
126 err = -EBUSY;
127 }
Phil Sutter9e9089e2015-11-20 18:17:18 +0100128 } while (err == -EBUSY);
129
Phil Sutterd662e032015-11-20 18:17:20 +0100130 if (enomem_retries)
131 pr_info(" %u insertions retried after -ENOMEM\n",
132 enomem_retries);
133
Phil Sutter9e9089e2015-11-20 18:17:18 +0100134 return err ? : retries;
135}
136
Florian Westphalf6516162017-09-20 01:12:12 +0200137static int __init test_rht_lookup(struct rhashtable *ht, struct test_obj *array,
138 unsigned int entries)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100139{
140 unsigned int i;
141
Florian Westphalf6516162017-09-20 01:12:12 +0200142 for (i = 0; i < entries; i++) {
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100143 struct test_obj *obj;
144 bool expected = !(i % 2);
Phil Suttere859afe2017-07-21 16:51:31 +0200145 struct test_obj_val key = {
146 .id = i,
147 };
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100148
Phil Suttere859afe2017-07-21 16:51:31 +0200149 if (array[i / 2].value.id == TEST_INSERT_FAIL)
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000150 expected = false;
151
Herbert Xub182aa62015-03-20 21:57:04 +1100152 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100153
154 if (expected && !obj) {
Phil Suttere859afe2017-07-21 16:51:31 +0200155 pr_warn("Test failed: Could not find key %u\n", key.id);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100156 return -ENOENT;
157 } else if (!expected && obj) {
158 pr_warn("Test failed: Unexpected entry found for key %u\n",
Phil Suttere859afe2017-07-21 16:51:31 +0200159 key.id);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100160 return -EEXIST;
161 } else if (expected && obj) {
Phil Suttere859afe2017-07-21 16:51:31 +0200162 if (obj->value.id != i) {
Thomas Grafc2c8a902015-04-30 22:37:42 +0000163 pr_warn("Test failed: Lookup value mismatch %u!=%u\n",
Phil Suttere859afe2017-07-21 16:51:31 +0200164 obj->value.id, i);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100165 return -EINVAL;
166 }
167 }
Thomas Graf685a0152015-07-17 10:52:48 +0200168
169 cond_resched_rcu();
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100170 }
171
172 return 0;
173}
174
Florian Westphalf6516162017-09-20 01:12:12 +0200175static void test_bucket_stats(struct rhashtable *ht, unsigned int entries)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100176{
Herbert Xu6c4128f2019-02-14 22:03:27 +0800177 unsigned int total = 0, chain_len = 0;
Thomas Graf246b23a2015-04-30 22:37:44 +0000178 struct rhashtable_iter hti;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100179 struct rhash_head *pos;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100180
Herbert Xu6c4128f2019-02-14 22:03:27 +0800181 rhashtable_walk_enter(ht, &hti);
Tom Herbert97a6ec42017-12-04 10:31:41 -0800182 rhashtable_walk_start(&hti);
Thomas Graf246b23a2015-04-30 22:37:44 +0000183
184 while ((pos = rhashtable_walk_next(&hti))) {
185 if (PTR_ERR(pos) == -EAGAIN) {
186 pr_info("Info: encountered resize\n");
187 chain_len++;
188 continue;
189 } else if (IS_ERR(pos)) {
190 pr_warn("Test failed: rhashtable_walk_next() error: %ld\n",
191 PTR_ERR(pos));
192 break;
193 }
194
195 total++;
196 }
197
198 rhashtable_walk_stop(&hti);
199 rhashtable_walk_exit(&hti);
200
201 pr_info(" Traversal complete: counted=%u, nelems=%u, entries=%d, table-jumps=%u\n",
202 total, atomic_read(&ht->nelems), entries, chain_len);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100203
Thomas Graf1aa661f52015-04-30 22:37:41 +0000204 if (total != atomic_read(&ht->nelems) || total != entries)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100205 pr_warn("Test failed: Total count mismatch ^^^");
206}
207
Florian Westphalf6516162017-09-20 01:12:12 +0200208static s64 __init test_rhashtable(struct rhashtable *ht, struct test_obj *array,
209 unsigned int entries)
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100210{
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100211 struct test_obj *obj;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100212 int err;
Phil Sutter9e9089e2015-11-20 18:17:18 +0100213 unsigned int i, insert_retries = 0;
Thomas Graf1aa661f52015-04-30 22:37:41 +0000214 s64 start, end;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100215
216 /*
217 * Insertion Test:
Thomas Graf1aa661f52015-04-30 22:37:41 +0000218 * Insert entries into table with all keys even numbers
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100219 */
Thomas Graf1aa661f52015-04-30 22:37:41 +0000220 pr_info(" Adding %d keys\n", entries);
221 start = ktime_get_ns();
222 for (i = 0; i < entries; i++) {
Thomas Graffcc57022015-04-30 22:37:43 +0000223 struct test_obj *obj = &array[i];
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100224
Phil Suttere859afe2017-07-21 16:51:31 +0200225 obj->value.id = i * 2;
Florian Westphal7e936bd2017-09-20 01:12:11 +0200226 err = insert_retry(ht, obj, test_rht_params);
Phil Sutter9e9089e2015-11-20 18:17:18 +0100227 if (err > 0)
228 insert_retries += err;
229 else if (err)
Thomas Graffcc57022015-04-30 22:37:43 +0000230 return err;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100231 }
232
Phil Sutter9e9089e2015-11-20 18:17:18 +0100233 if (insert_retries)
234 pr_info(" %u insertions retried due to memory pressure\n",
235 insert_retries);
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000236
Florian Westphalf6516162017-09-20 01:12:12 +0200237 test_bucket_stats(ht, entries);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100238 rcu_read_lock();
Florian Westphalf6516162017-09-20 01:12:12 +0200239 test_rht_lookup(ht, array, entries);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100240 rcu_read_unlock();
241
Florian Westphalf6516162017-09-20 01:12:12 +0200242 test_bucket_stats(ht, entries);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100243
Thomas Graf1aa661f52015-04-30 22:37:41 +0000244 pr_info(" Deleting %d keys\n", entries);
245 for (i = 0; i < entries; i++) {
Phil Sutter78369252017-07-25 13:36:21 +0200246 struct test_obj_val key = {
247 .id = i * 2,
248 };
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100249
Phil Suttere859afe2017-07-21 16:51:31 +0200250 if (array[i].value.id != TEST_INSERT_FAIL) {
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000251 obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
252 BUG_ON(!obj);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100253
Thomas Graf67b7cbf2015-04-30 22:37:45 +0000254 rhashtable_remove_fast(ht, &obj->node, test_rht_params);
255 }
Thomas Graf685a0152015-07-17 10:52:48 +0200256
257 cond_resched();
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100258 }
259
Thomas Graf1aa661f52015-04-30 22:37:41 +0000260 end = ktime_get_ns();
261 pr_info(" Duration of test: %lld ns\n", end - start);
262
263 return end - start;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100264}
265
Daniel Borkmannb7f5e5c2015-02-20 21:14:21 +0100266static struct rhashtable ht;
Florian Westphal411d7882017-09-21 17:36:08 +0200267static struct rhltable rhlt;
Florian Westphalcdd4de32017-09-20 01:12:14 +0200268
269static int __init test_rhltable(unsigned int entries)
270{
271 struct test_obj_rhl *rhl_test_objects;
272 unsigned long *obj_in_table;
273 unsigned int i, j, k;
274 int ret, err;
275
276 if (entries == 0)
277 entries = 1;
278
Kees Cookfad953c2018-06-12 14:27:37 -0700279 rhl_test_objects = vzalloc(array_size(entries,
280 sizeof(*rhl_test_objects)));
Florian Westphalcdd4de32017-09-20 01:12:14 +0200281 if (!rhl_test_objects)
282 return -ENOMEM;
283
284 ret = -ENOMEM;
Kees Cookfad953c2018-06-12 14:27:37 -0700285 obj_in_table = vzalloc(array_size(sizeof(unsigned long),
286 BITS_TO_LONGS(entries)));
Florian Westphalcdd4de32017-09-20 01:12:14 +0200287 if (!obj_in_table)
288 goto out_free;
289
Florian Westphalcdd4de32017-09-20 01:12:14 +0200290 err = rhltable_init(&rhlt, &test_rht_params);
291 if (WARN_ON(err))
292 goto out_free;
293
Jason A. Donenfelda251c172022-10-05 17:43:22 +0200294 k = get_random_u32();
Florian Westphalcdd4de32017-09-20 01:12:14 +0200295 ret = 0;
296 for (i = 0; i < entries; i++) {
297 rhl_test_objects[i].value.id = k;
298 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node,
299 test_rht_params);
300 if (WARN(err, "error %d on element %d\n", err, i))
301 break;
302 if (err == 0)
303 set_bit(i, obj_in_table);
304 }
305
306 if (err)
307 ret = err;
308
309 pr_info("test %d add/delete pairs into rhlist\n", entries);
310 for (i = 0; i < entries; i++) {
311 struct rhlist_head *h, *pos;
312 struct test_obj_rhl *obj;
313 struct test_obj_val key = {
314 .id = k,
315 };
316 bool found;
317
318 rcu_read_lock();
319 h = rhltable_lookup(&rhlt, &key, test_rht_params);
320 if (WARN(!h, "key not found during iteration %d of %d", i, entries)) {
321 rcu_read_unlock();
322 break;
323 }
324
325 if (i) {
326 j = i - 1;
327 rhl_for_each_entry_rcu(obj, pos, h, list_node) {
328 if (WARN(pos == &rhl_test_objects[j].list_node, "old element found, should be gone"))
329 break;
330 }
331 }
332
333 cond_resched_rcu();
334
335 found = false;
336
337 rhl_for_each_entry_rcu(obj, pos, h, list_node) {
338 if (pos == &rhl_test_objects[i].list_node) {
339 found = true;
340 break;
341 }
342 }
343
344 rcu_read_unlock();
345
346 if (WARN(!found, "element %d not found", i))
347 break;
348
349 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
350 WARN(err, "rhltable_remove: err %d for iteration %d\n", err, i);
351 if (err == 0)
352 clear_bit(i, obj_in_table);
353 }
354
355 if (ret == 0 && err)
356 ret = err;
357
358 for (i = 0; i < entries; i++) {
359 WARN(test_bit(i, obj_in_table), "elem %d allegedly still present", i);
360
361 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node,
362 test_rht_params);
363 if (WARN(err, "error %d on element %d\n", err, i))
364 break;
365 if (err == 0)
366 set_bit(i, obj_in_table);
367 }
368
369 pr_info("test %d random rhlist add/delete operations\n", entries);
370 for (j = 0; j < entries; j++) {
Jason A. Donenfeld8032bf12022-10-09 20:44:02 -0600371 u32 i = get_random_u32_below(entries);
372 u32 prand = get_random_u32_below(4);
Florian Westphalcdd4de32017-09-20 01:12:14 +0200373
374 cond_resched();
375
Florian Westphalcdd4de32017-09-20 01:12:14 +0200376 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
377 if (test_bit(i, obj_in_table)) {
378 clear_bit(i, obj_in_table);
379 if (WARN(err, "cannot remove element at slot %d", i))
380 continue;
381 } else {
Colin Ian King56b90fa2019-02-17 22:52:09 +0000382 if (WARN(err != -ENOENT, "removed non-existent element %d, error %d not %d",
Florian Westphalcdd4de32017-09-20 01:12:14 +0200383 i, err, -ENOENT))
384 continue;
385 }
386
387 if (prand & 1) {
Florian Westphalcdd4de32017-09-20 01:12:14 +0200388 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
Rolf Eike Beerc5f0a172022-10-21 15:47:03 +0200389 if (err == 0) {
390 if (WARN(test_and_set_bit(i, obj_in_table), "succeeded to insert same object %d", i))
391 continue;
392 } else {
393 if (WARN(!test_bit(i, obj_in_table), "failed to insert object %d", i))
394 continue;
395 }
396 }
397
398 if (prand & 2) {
Jason A. Donenfeld8032bf12022-10-09 20:44:02 -0600399 i = get_random_u32_below(entries);
Rolf Eike Beerc5f0a172022-10-21 15:47:03 +0200400 if (test_bit(i, obj_in_table)) {
401 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
402 WARN(err, "cannot remove element at slot %d", i);
403 if (err == 0)
404 clear_bit(i, obj_in_table);
405 } else {
406 err = rhltable_insert(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
407 WARN(err, "failed to insert object %d", i);
408 if (err == 0)
409 set_bit(i, obj_in_table);
410 }
Florian Westphalcdd4de32017-09-20 01:12:14 +0200411 }
412 }
413
414 for (i = 0; i < entries; i++) {
415 cond_resched();
416 err = rhltable_remove(&rhlt, &rhl_test_objects[i].list_node, test_rht_params);
417 if (test_bit(i, obj_in_table)) {
418 if (WARN(err, "cannot remove element at slot %d", i))
419 continue;
420 } else {
Colin Ian King56b90fa2019-02-17 22:52:09 +0000421 if (WARN(err != -ENOENT, "removed non-existent element, error %d not %d",
Florian Westphalcdd4de32017-09-20 01:12:14 +0200422 err, -ENOENT))
Colin Ian King769f5082020-09-18 22:51:26 +0100423 continue;
Florian Westphalcdd4de32017-09-20 01:12:14 +0200424 }
425 }
426
427 rhltable_destroy(&rhlt);
428out_free:
429 vfree(rhl_test_objects);
430 vfree(obj_in_table);
431 return ret;
432}
Daniel Borkmannb7f5e5c2015-02-20 21:14:21 +0100433
Florian Westphala6359bd2017-09-20 01:12:13 +0200434static int __init test_rhashtable_max(struct test_obj *array,
435 unsigned int entries)
436{
Jiapeng Chongb084f6c2022-11-23 17:37:02 +0800437 unsigned int i;
Florian Westphala6359bd2017-09-20 01:12:13 +0200438 int err;
439
440 test_rht_params.max_size = roundup_pow_of_two(entries / 8);
441 err = rhashtable_init(&ht, &test_rht_params);
442 if (err)
443 return err;
444
445 for (i = 0; i < ht.max_elems; i++) {
446 struct test_obj *obj = &array[i];
447
448 obj->value.id = i * 2;
449 err = insert_retry(&ht, obj, test_rht_params);
Jiapeng Chongb084f6c2022-11-23 17:37:02 +0800450 if (err < 0)
Florian Westphala6359bd2017-09-20 01:12:13 +0200451 return err;
452 }
453
454 err = insert_retry(&ht, &array[ht.max_elems], test_rht_params);
455 if (err == -E2BIG) {
456 err = 0;
457 } else {
458 pr_info("insert element %u should have failed with %d, got %d\n",
459 ht.max_elems, -E2BIG, err);
460 if (err == 0)
461 err = -1;
462 }
463
464 rhashtable_destroy(&ht);
465
466 return err;
467}
468
Paul Blakey499ac3b2018-03-04 17:29:49 +0200469static unsigned int __init print_ht(struct rhltable *rhlt)
470{
471 struct rhashtable *ht;
472 const struct bucket_table *tbl;
473 char buff[512] = "";
Arnd Bergmann4adec7f2021-03-23 14:03:32 +0100474 int offset = 0;
Paul Blakey499ac3b2018-03-04 17:29:49 +0200475 unsigned int i, cnt = 0;
476
477 ht = &rhlt->ht;
NeilBrowncbab9012018-06-18 12:52:50 +1000478 /* Take the mutex to avoid RCU warning */
479 mutex_lock(&ht->mutex);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200480 tbl = rht_dereference(ht->tbl, ht);
481 for (i = 0; i < tbl->size; i++) {
482 struct rhash_head *pos, *next;
483 struct test_obj_rhl *p;
484
NeilBrownadc6a3a2019-04-12 11:52:08 +1000485 pos = rht_ptr_exclusive(tbl->buckets + i);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200486 next = !rht_is_a_nulls(pos) ? rht_dereference(pos->next, ht) : NULL;
487
488 if (!rht_is_a_nulls(pos)) {
Arnd Bergmann4adec7f2021-03-23 14:03:32 +0100489 offset += sprintf(buff + offset, "\nbucket[%d] -> ", i);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200490 }
491
492 while (!rht_is_a_nulls(pos)) {
493 struct rhlist_head *list = container_of(pos, struct rhlist_head, rhead);
Arnd Bergmann4adec7f2021-03-23 14:03:32 +0100494 offset += sprintf(buff + offset, "[[");
Paul Blakey499ac3b2018-03-04 17:29:49 +0200495 do {
496 pos = &list->rhead;
497 list = rht_dereference(list->next, ht);
498 p = rht_obj(ht, pos);
499
Arnd Bergmann4adec7f2021-03-23 14:03:32 +0100500 offset += sprintf(buff + offset, " val %d (tid=%d)%s", p->value.id, p->value.tid,
Paul Blakey499ac3b2018-03-04 17:29:49 +0200501 list? ", " : " ");
502 cnt++;
503 } while (list);
504
505 pos = next,
506 next = !rht_is_a_nulls(pos) ?
507 rht_dereference(pos->next, ht) : NULL;
508
Arnd Bergmann4adec7f2021-03-23 14:03:32 +0100509 offset += sprintf(buff + offset, "]]%s", !rht_is_a_nulls(pos) ? " -> " : "");
Paul Blakey499ac3b2018-03-04 17:29:49 +0200510 }
511 }
512 printk(KERN_ERR "\n---- ht: ----%s\n-------------\n", buff);
NeilBrowncbab9012018-06-18 12:52:50 +1000513 mutex_unlock(&ht->mutex);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200514
515 return cnt;
516}
517
518static int __init test_insert_dup(struct test_obj_rhl *rhl_test_objects,
519 int cnt, bool slow)
520{
Bart Van Asschefc42a682019-01-30 10:42:30 -0800521 struct rhltable *rhlt;
Paul Blakey499ac3b2018-03-04 17:29:49 +0200522 unsigned int i, ret;
523 const char *key;
524 int err = 0;
525
Bart Van Asschefc42a682019-01-30 10:42:30 -0800526 rhlt = kmalloc(sizeof(*rhlt), GFP_KERNEL);
527 if (WARN_ON(!rhlt))
528 return -EINVAL;
529
530 err = rhltable_init(rhlt, &test_rht_params_dup);
531 if (WARN_ON(err)) {
532 kfree(rhlt);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200533 return err;
Bart Van Asschefc42a682019-01-30 10:42:30 -0800534 }
Paul Blakey499ac3b2018-03-04 17:29:49 +0200535
536 for (i = 0; i < cnt; i++) {
537 rhl_test_objects[i].value.tid = i;
Bart Van Asschefc42a682019-01-30 10:42:30 -0800538 key = rht_obj(&rhlt->ht, &rhl_test_objects[i].list_node.rhead);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200539 key += test_rht_params_dup.key_offset;
540
541 if (slow) {
Bart Van Asschefc42a682019-01-30 10:42:30 -0800542 err = PTR_ERR(rhashtable_insert_slow(&rhlt->ht, key,
Paul Blakey499ac3b2018-03-04 17:29:49 +0200543 &rhl_test_objects[i].list_node.rhead));
544 if (err == -EAGAIN)
545 err = 0;
546 } else
Bart Van Asschefc42a682019-01-30 10:42:30 -0800547 err = rhltable_insert(rhlt,
Paul Blakey499ac3b2018-03-04 17:29:49 +0200548 &rhl_test_objects[i].list_node,
549 test_rht_params_dup);
550 if (WARN(err, "error %d on element %d/%d (%s)\n", err, i, cnt, slow? "slow" : "fast"))
551 goto skip_print;
552 }
553
Bart Van Asschefc42a682019-01-30 10:42:30 -0800554 ret = print_ht(rhlt);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200555 WARN(ret != cnt, "missing rhltable elements (%d != %d, %s)\n", ret, cnt, slow? "slow" : "fast");
556
557skip_print:
Bart Van Asschefc42a682019-01-30 10:42:30 -0800558 rhltable_destroy(rhlt);
559 kfree(rhlt);
Paul Blakey499ac3b2018-03-04 17:29:49 +0200560
561 return 0;
562}
563
564static int __init test_insert_duplicates_run(void)
565{
566 struct test_obj_rhl rhl_test_objects[3] = {};
567
568 pr_info("test inserting duplicates\n");
569
570 /* two different values that map to same bucket */
571 rhl_test_objects[0].value.id = 1;
572 rhl_test_objects[1].value.id = 21;
573
574 /* and another duplicate with same as [0] value
575 * which will be second on the bucket list */
576 rhl_test_objects[2].value.id = rhl_test_objects[0].value.id;
577
578 test_insert_dup(rhl_test_objects, 2, false);
579 test_insert_dup(rhl_test_objects, 3, false);
580 test_insert_dup(rhl_test_objects, 2, true);
581 test_insert_dup(rhl_test_objects, 3, true);
582
583 return 0;
584}
585
Phil Sutterf4a3e902015-08-15 00:37:15 +0200586static int thread_lookup_test(struct thread_data *tdata)
587{
Florian Westphalf6516162017-09-20 01:12:12 +0200588 unsigned int entries = tdata->entries;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200589 int i, err = 0;
590
591 for (i = 0; i < entries; i++) {
592 struct test_obj *obj;
Phil Suttere859afe2017-07-21 16:51:31 +0200593 struct test_obj_val key = {
594 .id = i,
595 .tid = tdata->id,
596 };
Phil Sutterf4a3e902015-08-15 00:37:15 +0200597
598 obj = rhashtable_lookup_fast(&ht, &key, test_rht_params);
Phil Suttere859afe2017-07-21 16:51:31 +0200599 if (obj && (tdata->objs[i].value.id == TEST_INSERT_FAIL)) {
600 pr_err(" found unexpected object %d-%d\n", key.tid, key.id);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200601 err++;
Phil Suttere859afe2017-07-21 16:51:31 +0200602 } else if (!obj && (tdata->objs[i].value.id != TEST_INSERT_FAIL)) {
603 pr_err(" object %d-%d not found!\n", key.tid, key.id);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200604 err++;
Phil Suttere859afe2017-07-21 16:51:31 +0200605 } else if (obj && memcmp(&obj->value, &key, sizeof(key))) {
606 pr_err(" wrong object returned (got %d-%d, expected %d-%d)\n",
607 obj->value.tid, obj->value.id, key.tid, key.id);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200608 err++;
609 }
Phil Suttercd5b3182015-11-20 18:17:17 +0100610
611 cond_resched();
Phil Sutterf4a3e902015-08-15 00:37:15 +0200612 }
613 return err;
614}
615
616static int threadfunc(void *data)
617{
Phil Sutter9e9089e2015-11-20 18:17:18 +0100618 int i, step, err = 0, insert_retries = 0;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200619 struct thread_data *tdata = data;
620
Arnd Bergmann809c6702018-12-16 20:48:21 +0100621 if (atomic_dec_and_test(&startup_count))
622 wake_up(&startup_wait);
623 if (wait_event_interruptible(startup_wait, atomic_read(&startup_count) == -1)) {
624 pr_err(" thread[%d]: interrupted\n", tdata->id);
625 goto out;
626 }
Phil Sutterf4a3e902015-08-15 00:37:15 +0200627
Florian Westphalf6516162017-09-20 01:12:12 +0200628 for (i = 0; i < tdata->entries; i++) {
Phil Suttere859afe2017-07-21 16:51:31 +0200629 tdata->objs[i].value.id = i;
630 tdata->objs[i].value.tid = tdata->id;
Florian Westphal7e936bd2017-09-20 01:12:11 +0200631 err = insert_retry(&ht, &tdata->objs[i], test_rht_params);
Phil Sutter9e9089e2015-11-20 18:17:18 +0100632 if (err > 0) {
633 insert_retries += err;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200634 } else if (err) {
635 pr_err(" thread[%d]: rhashtable_insert_fast failed\n",
636 tdata->id);
637 goto out;
638 }
639 }
Phil Sutter9e9089e2015-11-20 18:17:18 +0100640 if (insert_retries)
641 pr_info(" thread[%d]: %u insertions retried due to memory pressure\n",
642 tdata->id, insert_retries);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200643
644 err = thread_lookup_test(tdata);
645 if (err) {
646 pr_err(" thread[%d]: rhashtable_lookup_test failed\n",
647 tdata->id);
648 goto out;
649 }
650
651 for (step = 10; step > 0; step--) {
Florian Westphalf6516162017-09-20 01:12:12 +0200652 for (i = 0; i < tdata->entries; i += step) {
Phil Suttere859afe2017-07-21 16:51:31 +0200653 if (tdata->objs[i].value.id == TEST_INSERT_FAIL)
Phil Sutterf4a3e902015-08-15 00:37:15 +0200654 continue;
655 err = rhashtable_remove_fast(&ht, &tdata->objs[i].node,
656 test_rht_params);
657 if (err) {
658 pr_err(" thread[%d]: rhashtable_remove_fast failed\n",
659 tdata->id);
660 goto out;
661 }
Phil Suttere859afe2017-07-21 16:51:31 +0200662 tdata->objs[i].value.id = TEST_INSERT_FAIL;
Phil Suttercd5b3182015-11-20 18:17:17 +0100663
664 cond_resched();
Phil Sutterf4a3e902015-08-15 00:37:15 +0200665 }
666 err = thread_lookup_test(tdata);
667 if (err) {
668 pr_err(" thread[%d]: rhashtable_lookup_test (2) failed\n",
669 tdata->id);
670 goto out;
671 }
672 }
673out:
674 while (!kthread_should_stop()) {
675 set_current_state(TASK_INTERRUPTIBLE);
676 schedule();
677 }
678 return err;
679}
680
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100681static int __init test_rht_init(void)
682{
Florian Westphalf6516162017-09-20 01:12:12 +0200683 unsigned int entries;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200684 int i, err, started_threads = 0, failed_threads = 0;
Thomas Graf1aa661f52015-04-30 22:37:41 +0000685 u64 total_time = 0;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200686 struct thread_data *tdata;
687 struct test_obj *objs;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100688
Florian Westphalf6516162017-09-20 01:12:12 +0200689 if (parm_entries < 0)
690 parm_entries = 1;
691
692 entries = min(parm_entries, MAX_ENTRIES);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100693
Thomas Graf1aa661f52015-04-30 22:37:41 +0000694 test_rht_params.automatic_shrinking = shrinking;
Phil Sutter95e435a2015-11-20 18:17:19 +0100695 test_rht_params.max_size = max_size ? : roundup_pow_of_two(entries);
Thomas Graf1aa661f52015-04-30 22:37:41 +0000696 test_rht_params.nelem_hint = size;
697
Kees Cookfad953c2018-06-12 14:27:37 -0700698 objs = vzalloc(array_size(sizeof(struct test_obj),
699 test_rht_params.max_size + 1));
Florian Westphal7e936bd2017-09-20 01:12:11 +0200700 if (!objs)
701 return -ENOMEM;
702
Thomas Graf1aa661f52015-04-30 22:37:41 +0000703 pr_info("Running rhashtable test nelem=%d, max_size=%d, shrinking=%d\n",
704 size, max_size, shrinking);
705
706 for (i = 0; i < runs; i++) {
707 s64 time;
708
709 pr_info("Test %02d:\n", i);
Florian Westphal7e936bd2017-09-20 01:12:11 +0200710 memset(objs, 0, test_rht_params.max_size * sizeof(struct test_obj));
711
Thomas Graf1aa661f52015-04-30 22:37:41 +0000712 err = rhashtable_init(&ht, &test_rht_params);
713 if (err < 0) {
714 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
715 err);
716 continue;
717 }
718
Florian Westphalf6516162017-09-20 01:12:12 +0200719 time = test_rhashtable(&ht, objs, entries);
Thomas Graf1aa661f52015-04-30 22:37:41 +0000720 rhashtable_destroy(&ht);
721 if (time < 0) {
Florian Westphal7e936bd2017-09-20 01:12:11 +0200722 vfree(objs);
Thomas Graf1aa661f52015-04-30 22:37:41 +0000723 pr_warn("Test failed: return code %lld\n", time);
724 return -EINVAL;
725 }
726
727 total_time += time;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100728 }
729
Florian Westphala6359bd2017-09-20 01:12:13 +0200730 pr_info("test if its possible to exceed max_size %d: %s\n",
731 test_rht_params.max_size, test_rhashtable_max(objs, entries) == 0 ?
732 "no, ok" : "YES, failed");
Florian Westphal7e936bd2017-09-20 01:12:11 +0200733 vfree(objs);
Florian Westphala6359bd2017-09-20 01:12:13 +0200734
Thomas Graf6decd632015-05-05 02:27:02 +0200735 do_div(total_time, runs);
736 pr_info("Average test time: %llu\n", total_time);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100737
Paul Blakey499ac3b2018-03-04 17:29:49 +0200738 test_insert_duplicates_run();
739
Phil Sutterf4a3e902015-08-15 00:37:15 +0200740 if (!tcount)
741 return 0;
742
743 pr_info("Testing concurrent rhashtable access from %d threads\n",
744 tcount);
Arnd Bergmann809c6702018-12-16 20:48:21 +0100745 atomic_set(&startup_count, tcount);
Kees Cookfad953c2018-06-12 14:27:37 -0700746 tdata = vzalloc(array_size(tcount, sizeof(struct thread_data)));
Phil Sutterf4a3e902015-08-15 00:37:15 +0200747 if (!tdata)
748 return -ENOMEM;
Kees Cookfad953c2018-06-12 14:27:37 -0700749 objs = vzalloc(array3_size(sizeof(struct test_obj), tcount, entries));
Phil Sutterf4a3e902015-08-15 00:37:15 +0200750 if (!objs) {
751 vfree(tdata);
752 return -ENOMEM;
753 }
754
Phil Sutter95e435a2015-11-20 18:17:19 +0100755 test_rht_params.max_size = max_size ? :
756 roundup_pow_of_two(tcount * entries);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200757 err = rhashtable_init(&ht, &test_rht_params);
758 if (err < 0) {
759 pr_warn("Test failed: Unable to initialize hashtable: %d\n",
760 err);
761 vfree(tdata);
762 vfree(objs);
763 return -EINVAL;
764 }
765 for (i = 0; i < tcount; i++) {
766 tdata[i].id = i;
Florian Westphalf6516162017-09-20 01:12:12 +0200767 tdata[i].entries = entries;
Phil Sutterf4a3e902015-08-15 00:37:15 +0200768 tdata[i].objs = objs + i * entries;
769 tdata[i].task = kthread_run(threadfunc, &tdata[i],
770 "rhashtable_thrad[%d]", i);
Arnd Bergmann809c6702018-12-16 20:48:21 +0100771 if (IS_ERR(tdata[i].task)) {
Phil Sutterf4a3e902015-08-15 00:37:15 +0200772 pr_err(" kthread_run failed for thread %d\n", i);
Arnd Bergmann809c6702018-12-16 20:48:21 +0100773 atomic_dec(&startup_count);
774 } else {
Phil Sutterf4a3e902015-08-15 00:37:15 +0200775 started_threads++;
Arnd Bergmann809c6702018-12-16 20:48:21 +0100776 }
Phil Sutterf4a3e902015-08-15 00:37:15 +0200777 }
Arnd Bergmann809c6702018-12-16 20:48:21 +0100778 if (wait_event_interruptible(startup_wait, atomic_read(&startup_count) == 0))
779 pr_err(" wait_event interruptible failed\n");
780 /* count is 0 now, set it to -1 and wake up all threads together */
781 atomic_dec(&startup_count);
782 wake_up_all(&startup_wait);
Phil Sutterf4a3e902015-08-15 00:37:15 +0200783 for (i = 0; i < tcount; i++) {
784 if (IS_ERR(tdata[i].task))
785 continue;
786 if ((err = kthread_stop(tdata[i].task))) {
787 pr_warn("Test failed: thread %d returned: %d\n",
788 i, err);
789 failed_threads++;
790 }
791 }
Phil Sutterf4a3e902015-08-15 00:37:15 +0200792 rhashtable_destroy(&ht);
793 vfree(tdata);
794 vfree(objs);
Florian Westphalcdd4de32017-09-20 01:12:14 +0200795
796 /*
797 * rhltable_remove is very expensive, default values can cause test
798 * to run for 2 minutes or more, use a smaller number instead.
799 */
800 err = test_rhltable(entries / 16);
801 pr_info("Started %d threads, %d failed, rhltable test returns %d\n",
802 started_threads, failed_threads, err);
Thomas Graf1aa661f52015-04-30 22:37:41 +0000803 return 0;
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100804}
805
Daniel Borkmann6dd0c162015-02-20 00:53:39 +0100806static void __exit test_rht_exit(void)
807{
808}
809
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100810module_init(test_rht_init);
Daniel Borkmann6dd0c162015-02-20 00:53:39 +0100811module_exit(test_rht_exit);
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +0100812
813MODULE_LICENSE("GPL v2");