2 * idr-test.c: Test the IDR API
3 * Copyright (c) 2016 Matthew Wilcox <willy@infradead.org>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 #include <linux/bitmap.h>
15 #include <linux/idr.h>
16 #include <linux/slab.h>
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
22 #define DUMMY_PTR ((void *)0x12)
24 int item_idr_free(int id, void *p, void *data)
26 struct item *item = p;
27 assert(item->index == id);
33 void item_idr_remove(struct idr *idr, int id)
35 struct item *item = idr_find(idr, id);
36 assert(item->index == id);
41 void idr_alloc_test(void)
46 assert(idr_alloc_cyclic(&idr, DUMMY_PTR, 0, 0x4000, GFP_KERNEL) == 0);
47 assert(idr_alloc_cyclic(&idr, DUMMY_PTR, 0x3ffd, 0x4000, GFP_KERNEL) == 0x3ffd);
48 idr_remove(&idr, 0x3ffd);
51 for (i = 0x3ffe; i < 0x4003; i++) {
56 item = item_create(i, 0);
58 item = item_create(i - 0x3fff, 0);
60 id = idr_alloc_cyclic(&idr, item, 1, 0x4000, GFP_KERNEL);
61 assert(id == item->index);
64 idr_for_each(&idr, item_idr_free, &idr);
68 void idr_replace_test(void)
72 idr_alloc(&idr, (void *)-1, 10, 11, GFP_KERNEL);
73 idr_replace(&idr, &idr, 10);
79 * Unlike the radix tree, you can put a NULL pointer -- with care -- into
80 * the IDR. Some interfaces, like idr_find() do not distinguish between
81 * "present, value is NULL" and "not present", but that's exactly what some
84 void idr_null_test(void)
89 assert(idr_is_empty(&idr));
91 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
92 assert(!idr_is_empty(&idr));
94 assert(idr_is_empty(&idr));
96 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
97 assert(!idr_is_empty(&idr));
99 assert(idr_is_empty(&idr));
101 for (i = 0; i < 10; i++) {
102 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == i);
105 assert(idr_replace(&idr, DUMMY_PTR, 3) == NULL);
106 assert(idr_replace(&idr, DUMMY_PTR, 4) == NULL);
107 assert(idr_replace(&idr, NULL, 4) == DUMMY_PTR);
108 assert(idr_replace(&idr, DUMMY_PTR, 11) == ERR_PTR(-ENOENT));
110 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 5);
113 for (i = 0; i < 9; i++) {
115 assert(!idr_is_empty(&idr));
118 assert(!idr_is_empty(&idr));
120 assert(idr_is_empty(&idr));
122 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
123 assert(idr_replace(&idr, DUMMY_PTR, 3) == ERR_PTR(-ENOENT));
124 assert(idr_replace(&idr, DUMMY_PTR, 0) == NULL);
125 assert(idr_replace(&idr, NULL, 0) == DUMMY_PTR);
128 assert(idr_is_empty(&idr));
130 for (i = 1; i < 10; i++) {
131 assert(idr_alloc(&idr, NULL, 1, 0, GFP_KERNEL) == i);
135 assert(idr_is_empty(&idr));
138 void idr_nowait_test(void)
143 idr_preload(GFP_KERNEL);
145 for (i = 0; i < 3; i++) {
146 struct item *item = item_create(i, 0);
147 assert(idr_alloc(&idr, item, i, i + 1, GFP_NOWAIT) == i);
152 idr_for_each(&idr, item_idr_free, &idr);
156 void idr_get_next_test(void)
162 int indices[] = {4, 7, 9, 15, 65, 128, 1000, 99999, 0};
164 for(i = 0; indices[i]; i++) {
165 struct item *item = item_create(indices[i], 0);
166 assert(idr_alloc(&idr, item, indices[i], indices[i+1],
167 GFP_KERNEL) == indices[i]);
170 for(i = 0, nextid = 0; indices[i]; i++) {
171 idr_get_next(&idr, &nextid);
172 assert(nextid == indices[i]);
176 idr_for_each(&idr, item_idr_free, &idr);
180 static inline void *idr_mk_value(unsigned long v)
183 return (void *)((v & 1) | 2 | (v << 1));
186 DEFINE_IDR(find_idr);
188 static void *idr_throbber(void *arg)
190 time_t start = time(NULL);
191 int id = *(int *)arg;
193 rcu_register_thread();
195 idr_alloc(&find_idr, idr_mk_value(id), id, id + 1, GFP_KERNEL);
196 idr_remove(&find_idr, id);
197 } while (time(NULL) < start + 10);
198 rcu_unregister_thread();
203 void idr_find_test_1(int anchor_id, int throbber_id)
206 time_t start = time(NULL);
208 pthread_create(&throbber, NULL, idr_throbber, &throbber_id);
210 BUG_ON(idr_alloc(&find_idr, idr_mk_value(anchor_id), anchor_id,
211 anchor_id + 1, GFP_KERNEL) != anchor_id);
215 void *entry = idr_get_next(&find_idr, &id);
216 BUG_ON(entry != idr_mk_value(id));
217 } while (time(NULL) < start + 11);
219 pthread_join(throbber, NULL);
221 idr_remove(&find_idr, anchor_id);
222 BUG_ON(!idr_is_empty(&find_idr));
225 void idr_find_test(void)
227 idr_find_test_1(100000, 0);
228 idr_find_test_1(0, 100000);
231 void idr_checks(void)
236 for (i = 0; i < 10000; i++) {
237 struct item *item = item_create(i, 0);
238 assert(idr_alloc(&idr, item, 0, 20000, GFP_KERNEL) == i);
241 assert(idr_alloc(&idr, DUMMY_PTR, 5, 30, GFP_KERNEL) < 0);
243 for (i = 0; i < 5000; i++)
244 item_idr_remove(&idr, i);
248 idr_for_each(&idr, item_idr_free, &idr);
251 assert(idr_is_empty(&idr));
256 assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == 0);
258 for (i = 1; i < RADIX_TREE_MAP_SIZE; i++)
259 assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == i);
260 idr_remove(&idr, 1 << 30);
263 for (i = INT_MAX - 3UL; i < INT_MAX + 1UL; i++) {
264 struct item *item = item_create(i, 0);
265 assert(idr_alloc(&idr, item, i, i + 10, GFP_KERNEL) == i);
267 assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i, GFP_KERNEL) == -ENOSPC);
269 idr_for_each(&idr, item_idr_free, &idr);
273 assert(idr_is_empty(&idr));
275 for (i = 1; i < 10000; i++) {
276 struct item *item = item_create(i, 0);
277 assert(idr_alloc(&idr, item, 1, 20000, GFP_KERNEL) == i);
280 idr_for_each(&idr, item_idr_free, &idr);
292 * Check that we get the correct error when we run out of memory doing
293 * allocations. To ensure we run out of memory, just "forget" to preload.
294 * The first test is for not having a bitmap available, and the second test
295 * is for not being able to allocate a level of the radix tree.
297 void ida_check_nomem(void)
302 err = ida_get_new_above(&ida, 256, &id);
303 assert(err == -EAGAIN);
304 err = ida_get_new_above(&ida, 1UL << 30, &id);
305 assert(err == -EAGAIN);
309 * Check what happens when we fill a leaf and then delete it. This may
310 * discover mishandling of IDR_FREE.
312 void ida_check_leaf(void)
318 for (i = 0; i < IDA_BITMAP_BITS; i++) {
319 assert(ida_pre_get(&ida, GFP_KERNEL));
320 assert(!ida_get_new(&ida, &id));
325 assert(ida_is_empty(&ida));
327 assert(ida_pre_get(&ida, GFP_KERNEL));
328 assert(!ida_get_new(&ida, &id));
331 assert(ida_is_empty(&ida));
335 * Check handling of conversions between exceptional entries and full bitmaps.
337 void ida_check_conv(void)
343 for (i = 0; i < IDA_BITMAP_BITS * 2; i += IDA_BITMAP_BITS) {
344 assert(ida_pre_get(&ida, GFP_KERNEL));
345 assert(!ida_get_new_above(&ida, i + 1, &id));
347 assert(!ida_get_new_above(&ida, i + BITS_PER_LONG, &id));
348 assert(id == i + BITS_PER_LONG);
349 ida_remove(&ida, i + 1);
350 ida_remove(&ida, i + BITS_PER_LONG);
351 assert(ida_is_empty(&ida));
354 assert(ida_pre_get(&ida, GFP_KERNEL));
356 for (i = 0; i < IDA_BITMAP_BITS * 2; i++) {
357 assert(ida_pre_get(&ida, GFP_KERNEL));
358 assert(!ida_get_new(&ida, &id));
362 for (i = IDA_BITMAP_BITS * 2; i > 0; i--) {
363 ida_remove(&ida, i - 1);
365 assert(ida_is_empty(&ida));
367 for (i = 0; i < IDA_BITMAP_BITS + BITS_PER_LONG - 4; i++) {
368 assert(ida_pre_get(&ida, GFP_KERNEL));
369 assert(!ida_get_new(&ida, &id));
373 for (i = IDA_BITMAP_BITS + BITS_PER_LONG - 4; i > 0; i--) {
374 ida_remove(&ida, i - 1);
376 assert(ida_is_empty(&ida));
378 radix_tree_cpu_dead(1);
379 for (i = 0; i < 1000000; i++) {
380 int err = ida_get_new(&ida, &id);
381 if (err == -EAGAIN) {
382 assert((i % IDA_BITMAP_BITS) == (BITS_PER_LONG - 2));
383 assert(ida_pre_get(&ida, GFP_KERNEL));
384 err = ida_get_new(&ida, &id);
386 assert((i % IDA_BITMAP_BITS) != (BITS_PER_LONG - 2));
395 * Check allocations up to and slightly above the maximum allowed (2^31-1) ID.
396 * Allocating up to 2^31-1 should succeed, and then allocating the next one
399 void ida_check_max(void)
405 for (j = 1; j < 65537; j *= 2) {
406 unsigned long base = (1UL << 31) - j;
407 for (i = 0; i < j; i++) {
408 assert(ida_pre_get(&ida, GFP_KERNEL));
409 assert(!ida_get_new_above(&ida, base, &id));
410 assert(id == base + i);
412 assert(ida_pre_get(&ida, GFP_KERNEL));
413 err = ida_get_new_above(&ida, base, &id);
414 assert(err == -ENOSPC);
416 assert(ida_is_empty(&ida));
421 void ida_check_random(void)
424 DECLARE_BITMAP(bitmap, 2048);
427 time_t s = time(NULL);
430 memset(bitmap, 0, sizeof(bitmap));
431 for (i = 0; i < 100000; i++) {
434 if (test_bit(bit, bitmap)) {
435 __clear_bit(bit, bitmap);
436 ida_remove(&ida, bit);
438 __set_bit(bit, bitmap);
440 ida_pre_get(&ida, GFP_KERNEL);
441 err = ida_get_new_above(&ida, bit, &id);
442 } while (err == -ENOMEM);
448 if (time(NULL) < s + 10)
452 void ida_simple_get_remove_test(void)
457 for (i = 0; i < 10000; i++) {
458 assert(ida_simple_get(&ida, 0, 20000, GFP_KERNEL) == i);
460 assert(ida_simple_get(&ida, 5, 30, GFP_KERNEL) < 0);
462 for (i = 0; i < 10000; i++) {
463 ida_simple_remove(&ida, i);
465 assert(ida_is_empty(&ida));
470 void ida_checks(void)
476 radix_tree_cpu_dead(1);
479 for (i = 0; i < 10000; i++) {
480 assert(ida_pre_get(&ida, GFP_KERNEL));
481 assert(!ida_get_new(&ida, &id));
485 ida_remove(&ida, 20);
486 ida_remove(&ida, 21);
487 for (i = 0; i < 3; i++) {
488 assert(ida_pre_get(&ida, GFP_KERNEL));
489 assert(!ida_get_new(&ida, &id));
494 for (i = 0; i < 5000; i++)
497 assert(ida_pre_get(&ida, GFP_KERNEL));
498 assert(!ida_get_new_above(&ida, 5000, &id));
503 assert(ida_is_empty(&ida));
505 assert(ida_pre_get(&ida, GFP_KERNEL));
506 assert(!ida_get_new_above(&ida, 1, &id));
509 ida_remove(&ida, id);
510 assert(ida_is_empty(&ida));
512 assert(ida_is_empty(&ida));
514 assert(ida_pre_get(&ida, GFP_KERNEL));
515 assert(!ida_get_new_above(&ida, 1, &id));
517 assert(ida_is_empty(&ida));
519 assert(ida_pre_get(&ida, GFP_KERNEL));
520 assert(!ida_get_new_above(&ida, 1, &id));
522 assert(ida_pre_get(&ida, GFP_KERNEL));
523 assert(!ida_get_new_above(&ida, 1025, &id));
525 assert(ida_pre_get(&ida, GFP_KERNEL));
526 assert(!ida_get_new_above(&ida, 10000, &id));
528 ida_remove(&ida, 1025);
530 assert(ida_is_empty(&ida));
536 ida_simple_get_remove_test();
538 radix_tree_cpu_dead(1);
541 static void *ida_random_fn(void *arg)
543 rcu_register_thread();
545 rcu_unregister_thread();
549 void ida_thread_tests(void)
551 pthread_t threads[10];
554 for (i = 0; i < ARRAY_SIZE(threads); i++)
555 if (pthread_create(&threads[i], NULL, ida_random_fn, NULL)) {
556 perror("creating ida thread");
561 pthread_join(threads[i], NULL);
564 int __weak main(void)
570 radix_tree_cpu_dead(1);
573 printf("nr_allocated = %d\n", nr_allocated);