test_rhashtable.c 10.3 KB
Newer Older
1 2 3
/*
 * Resizable, Scalable, Concurrent Hash Table
 *
4
 * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
5 6 7 8 9 10 11 12 13 14 15 16 17 18
 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

/**************************************************************************
 * Self Test
 **************************************************************************/

#include <linux/init.h>
#include <linux/jhash.h>
#include <linux/kernel.h>
19
#include <linux/kthread.h>
20 21 22
#include <linux/module.h>
#include <linux/rcupdate.h>
#include <linux/rhashtable.h>
23
#include <linux/semaphore.h>
24
#include <linux/slab.h>
25
#include <linux/sched.h>
26
#include <linux/vmalloc.h>
27

28
#define MAX_ENTRIES	1000000
29
#define TEST_INSERT_FAIL INT_MAX
30 31 32 33 34 35 36 37 38

static int entries = 50000;
module_param(entries, int, 0);
MODULE_PARM_DESC(entries, "Number of entries to add (default: 50000)");

static int runs = 4;
module_param(runs, int, 0);
MODULE_PARM_DESC(runs, "Number of test runs per variant (default: 4)");

39
static int max_size = 0;
40
module_param(max_size, int, 0);
41
MODULE_PARM_DESC(runs, "Maximum table size (default: calculated)");
42 43 44 45 46 47 48 49

static bool shrinking = false;
module_param(shrinking, bool, 0);
MODULE_PARM_DESC(shrinking, "Enable automatic shrinking (default: off)");

static int size = 8;
module_param(size, int, 0);
MODULE_PARM_DESC(size, "Initial size hint of table (default: 8)");
50

51 52 53 54
static int tcount = 10;
module_param(tcount, int, 0);
MODULE_PARM_DESC(tcount, "Number of threads to spawn (default: 10)");

55 56 57 58
static bool enomem_retry = false;
module_param(enomem_retry, bool, 0);
MODULE_PARM_DESC(enomem_retry, "Retry insert even if -ENOMEM was returned (default: off)");

59 60 61 62 63
struct test_obj {
	int			value;
	struct rhash_head	node;
};

64 65 66 67 68 69
struct thread_data {
	int id;
	struct task_struct *task;
	struct test_obj *objs;
};

70 71
static struct test_obj array[MAX_ENTRIES];

72
static struct rhashtable_params test_rht_params = {
73 74 75 76 77 78 79
	.head_offset = offsetof(struct test_obj, node),
	.key_offset = offsetof(struct test_obj, value),
	.key_len = sizeof(int),
	.hashfn = jhash,
	.nulls_base = (3U << RHT_BASE_SHIFT),
};

80 81 82
static struct semaphore prestart_sem;
static struct semaphore startup_sem = __SEMAPHORE_INITIALIZER(startup_sem, 0);

83 84 85
static int insert_retry(struct rhashtable *ht, struct rhash_head *obj,
                        const struct rhashtable_params params)
{
86
	int err, retries = -1, enomem_retries = 0;
87 88 89 90 91

	do {
		retries++;
		cond_resched();
		err = rhashtable_insert_fast(ht, obj, params);
92 93 94 95
		if (err == -ENOMEM && enomem_retry) {
			enomem_retries++;
			err = -EBUSY;
		}
96 97
	} while (err == -EBUSY);

98 99 100 101
	if (enomem_retries)
		pr_info(" %u insertions retried after -ENOMEM\n",
			enomem_retries);

102 103 104
	return err ? : retries;
}

105 106 107 108
static int __init test_rht_lookup(struct rhashtable *ht)
{
	unsigned int i;

109
	for (i = 0; i < entries * 2; i++) {
110 111 112 113
		struct test_obj *obj;
		bool expected = !(i % 2);
		u32 key = i;

114 115 116
		if (array[i / 2].value == TEST_INSERT_FAIL)
			expected = false;

117
		obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
118 119 120 121 122 123 124 125 126

		if (expected && !obj) {
			pr_warn("Test failed: Could not find key %u\n", key);
			return -ENOENT;
		} else if (!expected && obj) {
			pr_warn("Test failed: Unexpected entry found for key %u\n",
				key);
			return -EEXIST;
		} else if (expected && obj) {
127 128 129
			if (obj->value != i) {
				pr_warn("Test failed: Lookup value mismatch %u!=%u\n",
					obj->value, i);
130 131 132
				return -EINVAL;
			}
		}
133 134

		cond_resched_rcu();
135 136 137 138 139
	}

	return 0;
}

140
static void test_bucket_stats(struct rhashtable *ht)
141
{
142 143
	unsigned int err, total = 0, chain_len = 0;
	struct rhashtable_iter hti;
144 145
	struct rhash_head *pos;

146
	err = rhashtable_walk_init(ht, &hti, GFP_KERNEL);
147 148 149 150
	if (err) {
		pr_warn("Test failed: allocation error");
		return;
	}
151

152 153 154 155 156
	err = rhashtable_walk_start(&hti);
	if (err && err != -EAGAIN) {
		pr_warn("Test failed: iterator failed: %d\n", err);
		return;
	}
157

158 159 160 161 162 163 164 165 166
	while ((pos = rhashtable_walk_next(&hti))) {
		if (PTR_ERR(pos) == -EAGAIN) {
			pr_info("Info: encountered resize\n");
			chain_len++;
			continue;
		} else if (IS_ERR(pos)) {
			pr_warn("Test failed: rhashtable_walk_next() error: %ld\n",
				PTR_ERR(pos));
			break;
167 168
		}

169
		total++;
170 171
	}

172 173 174 175 176
	rhashtable_walk_stop(&hti);
	rhashtable_walk_exit(&hti);

	pr_info("  Traversal complete: counted=%u, nelems=%u, entries=%d, table-jumps=%u\n",
		total, atomic_read(&ht->nelems), entries, chain_len);
177

178
	if (total != atomic_read(&ht->nelems) || total != entries)
179 180 181
		pr_warn("Test failed: Total count mismatch ^^^");
}

182
static s64 __init test_rhashtable(struct rhashtable *ht)
183 184 185
{
	struct test_obj *obj;
	int err;
186
	unsigned int i, insert_retries = 0;
187
	s64 start, end;
188 189 190

	/*
	 * Insertion Test:
191
	 * Insert entries into table with all keys even numbers
192
	 */
193 194 195
	pr_info("  Adding %d keys\n", entries);
	start = ktime_get_ns();
	for (i = 0; i < entries; i++) {
196
		struct test_obj *obj = &array[i];
197 198

		obj->value = i * 2;
199 200 201 202
		err = insert_retry(ht, &obj->node, test_rht_params);
		if (err > 0)
			insert_retries += err;
		else if (err)
203
			return err;
204 205
	}

206 207 208
	if (insert_retries)
		pr_info("  %u insertions retried due to memory pressure\n",
			insert_retries);
209

210
	test_bucket_stats(ht);
211 212 213 214
	rcu_read_lock();
	test_rht_lookup(ht);
	rcu_read_unlock();

215
	test_bucket_stats(ht);
216

217 218
	pr_info("  Deleting %d keys\n", entries);
	for (i = 0; i < entries; i++) {
219 220
		u32 key = i * 2;

221 222 223
		if (array[i].value != TEST_INSERT_FAIL) {
			obj = rhashtable_lookup_fast(ht, &key, test_rht_params);
			BUG_ON(!obj);
224

225 226
			rhashtable_remove_fast(ht, &obj->node, test_rht_params);
		}
227 228

		cond_resched();
229 230
	}

231 232 233 234
	end = ktime_get_ns();
	pr_info("  Duration of test: %lld ns\n", end - start);

	return end - start;
235 236
}

237 238
static struct rhashtable ht;

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
static int thread_lookup_test(struct thread_data *tdata)
{
	int i, err = 0;

	for (i = 0; i < entries; i++) {
		struct test_obj *obj;
		int key = (tdata->id << 16) | i;

		obj = rhashtable_lookup_fast(&ht, &key, test_rht_params);
		if (obj && (tdata->objs[i].value == TEST_INSERT_FAIL)) {
			pr_err("  found unexpected object %d\n", key);
			err++;
		} else if (!obj && (tdata->objs[i].value != TEST_INSERT_FAIL)) {
			pr_err("  object %d not found!\n", key);
			err++;
		} else if (obj && (obj->value != key)) {
			pr_err("  wrong object returned (got %d, expected %d)\n",
			       obj->value, key);
			err++;
		}
259 260

		cond_resched();
261 262 263 264 265 266
	}
	return err;
}

static int threadfunc(void *data)
{
267
	int i, step, err = 0, insert_retries = 0;
268 269 270 271 272 273 274 275
	struct thread_data *tdata = data;

	up(&prestart_sem);
	if (down_interruptible(&startup_sem))
		pr_err("  thread[%d]: down_interruptible failed\n", tdata->id);

	for (i = 0; i < entries; i++) {
		tdata->objs[i].value = (tdata->id << 16) | i;
276 277 278
		err = insert_retry(&ht, &tdata->objs[i].node, test_rht_params);
		if (err > 0) {
			insert_retries += err;
279 280 281 282 283 284
		} else if (err) {
			pr_err("  thread[%d]: rhashtable_insert_fast failed\n",
			       tdata->id);
			goto out;
		}
	}
285 286 287
	if (insert_retries)
		pr_info("  thread[%d]: %u insertions retried due to memory pressure\n",
			tdata->id, insert_retries);
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307

	err = thread_lookup_test(tdata);
	if (err) {
		pr_err("  thread[%d]: rhashtable_lookup_test failed\n",
		       tdata->id);
		goto out;
	}

	for (step = 10; step > 0; step--) {
		for (i = 0; i < entries; i += step) {
			if (tdata->objs[i].value == TEST_INSERT_FAIL)
				continue;
			err = rhashtable_remove_fast(&ht, &tdata->objs[i].node,
			                             test_rht_params);
			if (err) {
				pr_err("  thread[%d]: rhashtable_remove_fast failed\n",
				       tdata->id);
				goto out;
			}
			tdata->objs[i].value = TEST_INSERT_FAIL;
308 309

			cond_resched();
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
		}
		err = thread_lookup_test(tdata);
		if (err) {
			pr_err("  thread[%d]: rhashtable_lookup_test (2) failed\n",
			       tdata->id);
			goto out;
		}
	}
out:
	while (!kthread_should_stop()) {
		set_current_state(TASK_INTERRUPTIBLE);
		schedule();
	}
	return err;
}

326 327
static int __init test_rht_init(void)
{
328
	int i, err, started_threads = 0, failed_threads = 0;
329
	u64 total_time = 0;
330 331
	struct thread_data *tdata;
	struct test_obj *objs;
332

333
	entries = min(entries, MAX_ENTRIES);
334

335
	test_rht_params.automatic_shrinking = shrinking;
336
	test_rht_params.max_size = max_size ? : roundup_pow_of_two(entries);
337
	test_rht_params.nelem_hint = size;
338

339 340
	pr_info("Running rhashtable test nelem=%d, max_size=%d, shrinking=%d\n",
		size, max_size, shrinking);
341

342 343
	for (i = 0; i < runs; i++) {
		s64 time;
344

345
		pr_info("Test %02d:\n", i);
346
		memset(&array, 0, sizeof(array));
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
		err = rhashtable_init(&ht, &test_rht_params);
		if (err < 0) {
			pr_warn("Test failed: Unable to initialize hashtable: %d\n",
				err);
			continue;
		}

		time = test_rhashtable(&ht);
		rhashtable_destroy(&ht);
		if (time < 0) {
			pr_warn("Test failed: return code %lld\n", time);
			return -EINVAL;
		}

		total_time += time;
	}

364 365
	do_div(total_time, runs);
	pr_info("Average test time: %llu\n", total_time);
366

367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
	if (!tcount)
		return 0;

	pr_info("Testing concurrent rhashtable access from %d threads\n",
	        tcount);
	sema_init(&prestart_sem, 1 - tcount);
	tdata = vzalloc(tcount * sizeof(struct thread_data));
	if (!tdata)
		return -ENOMEM;
	objs  = vzalloc(tcount * entries * sizeof(struct test_obj));
	if (!objs) {
		vfree(tdata);
		return -ENOMEM;
	}

382 383
	test_rht_params.max_size = max_size ? :
	                           roundup_pow_of_two(tcount * entries);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
	err = rhashtable_init(&ht, &test_rht_params);
	if (err < 0) {
		pr_warn("Test failed: Unable to initialize hashtable: %d\n",
			err);
		vfree(tdata);
		vfree(objs);
		return -EINVAL;
	}
	for (i = 0; i < tcount; i++) {
		tdata[i].id = i;
		tdata[i].objs = objs + i * entries;
		tdata[i].task = kthread_run(threadfunc, &tdata[i],
		                            "rhashtable_thrad[%d]", i);
		if (IS_ERR(tdata[i].task))
			pr_err(" kthread_run failed for thread %d\n", i);
		else
			started_threads++;
	}
	if (down_interruptible(&prestart_sem))
		pr_err("  down interruptible failed\n");
	for (i = 0; i < tcount; i++)
		up(&startup_sem);
	for (i = 0; i < tcount; i++) {
		if (IS_ERR(tdata[i].task))
			continue;
		if ((err = kthread_stop(tdata[i].task))) {
			pr_warn("Test failed: thread %d returned: %d\n",
			        i, err);
			failed_threads++;
		}
	}
	pr_info("Started %d threads, %d failed\n",
	        started_threads, failed_threads);
	rhashtable_destroy(&ht);
	vfree(tdata);
	vfree(objs);
420
	return 0;
421 422
}

423 424 425 426
static void __exit test_rht_exit(void)
{
}

427
module_init(test_rht_init);
428
module_exit(test_rht_exit);
429 430

MODULE_LICENSE("GPL v2");