1 // SPDX-License-Identifier: GPL-2.0-only
3 * idr-test.c: Test the IDR API
4 * Copyright (c) 2016 Matthew Wilcox <willy@infradead.org>
6 #include <linux/bitmap.h>
8 #include <linux/slab.h>
9 #include <linux/kernel.h>
10 #include <linux/errno.h>
14 #define DUMMY_PTR ((void *)0x10)
16 int item_idr_free(int id, void *p, void *data)
18 struct item *item = p;
19 assert(item->index == id);
25 void item_idr_remove(struct idr *idr, int id)
27 struct item *item = idr_find(idr, id);
28 assert(item->index == id);
33 void idr_alloc_test(void)
38 assert(idr_alloc_cyclic(&idr, DUMMY_PTR, 0, 0x4000, GFP_KERNEL) == 0);
39 assert(idr_alloc_cyclic(&idr, DUMMY_PTR, 0x3ffd, 0x4000, GFP_KERNEL) == 0x3ffd);
40 idr_remove(&idr, 0x3ffd);
43 for (i = 0x3ffe; i < 0x4003; i++) {
48 item = item_create(i, 0);
50 item = item_create(i - 0x3fff, 0);
52 id = idr_alloc_cyclic(&idr, item, 1, 0x4000, GFP_KERNEL);
53 assert(id == item->index);
56 idr_for_each(&idr, item_idr_free, &idr);
60 void idr_replace_test(void)
64 idr_alloc(&idr, (void *)-1, 10, 11, GFP_KERNEL);
65 idr_replace(&idr, &idr, 10);
71 * Unlike the radix tree, you can put a NULL pointer -- with care -- into
72 * the IDR. Some interfaces, like idr_find() do not distinguish between
73 * "present, value is NULL" and "not present", but that's exactly what some
76 void idr_null_test(void)
81 assert(idr_is_empty(&idr));
83 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
84 assert(!idr_is_empty(&idr));
86 assert(idr_is_empty(&idr));
88 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
89 assert(!idr_is_empty(&idr));
91 assert(idr_is_empty(&idr));
93 for (i = 0; i < 10; i++) {
94 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == i);
97 assert(idr_replace(&idr, DUMMY_PTR, 3) == NULL);
98 assert(idr_replace(&idr, DUMMY_PTR, 4) == NULL);
99 assert(idr_replace(&idr, NULL, 4) == DUMMY_PTR);
100 assert(idr_replace(&idr, DUMMY_PTR, 11) == ERR_PTR(-ENOENT));
102 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 5);
105 for (i = 0; i < 9; i++) {
107 assert(!idr_is_empty(&idr));
110 assert(!idr_is_empty(&idr));
112 assert(idr_is_empty(&idr));
114 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
115 assert(idr_replace(&idr, DUMMY_PTR, 3) == ERR_PTR(-ENOENT));
116 assert(idr_replace(&idr, DUMMY_PTR, 0) == NULL);
117 assert(idr_replace(&idr, NULL, 0) == DUMMY_PTR);
120 assert(idr_is_empty(&idr));
122 for (i = 1; i < 10; i++) {
123 assert(idr_alloc(&idr, NULL, 1, 0, GFP_KERNEL) == i);
127 assert(idr_is_empty(&idr));
130 void idr_nowait_test(void)
135 idr_preload(GFP_KERNEL);
137 for (i = 0; i < 3; i++) {
138 struct item *item = item_create(i, 0);
139 assert(idr_alloc(&idr, item, i, i + 1, GFP_NOWAIT) == i);
144 idr_for_each(&idr, item_idr_free, &idr);
148 void idr_get_next_test(int base)
153 idr_init_base(&idr, base);
155 int indices[] = {4, 7, 9, 15, 65, 128, 1000, 99999, 0};
157 for(i = 0; indices[i]; i++) {
158 struct item *item = item_create(indices[i], 0);
159 assert(idr_alloc(&idr, item, indices[i], indices[i+1],
160 GFP_KERNEL) == indices[i]);
163 for(i = 0, nextid = 0; indices[i]; i++) {
164 idr_get_next(&idr, &nextid);
165 assert(nextid == indices[i]);
169 idr_for_each(&idr, item_idr_free, &idr);
173 int idr_u32_cb(int id, void *ptr, void *data)
176 BUG_ON(ptr != DUMMY_PTR);
180 void idr_u32_test1(struct idr *idr, u32 handle)
182 static bool warned = false;
187 BUG_ON(idr_alloc_u32(idr, DUMMY_PTR, &id, id, GFP_KERNEL));
188 BUG_ON(id != handle);
189 BUG_ON(idr_alloc_u32(idr, DUMMY_PTR, &id, id, GFP_KERNEL) != -ENOSPC);
190 BUG_ON(id != handle);
191 if (!warned && id > INT_MAX)
192 printk("vvv Ignore these warnings\n");
193 ptr = idr_get_next(idr, &sid);
198 BUG_ON(ptr != DUMMY_PTR);
201 idr_for_each(idr, idr_u32_cb, NULL);
202 if (!warned && id > INT_MAX) {
203 printk("^^^ Warnings over\n");
206 BUG_ON(idr_remove(idr, id) != DUMMY_PTR);
207 BUG_ON(!idr_is_empty(idr));
210 void idr_u32_test(int base)
213 idr_init_base(&idr, base);
214 idr_u32_test1(&idr, 10);
215 idr_u32_test1(&idr, 0x7fffffff);
216 idr_u32_test1(&idr, 0x80000000);
217 idr_u32_test1(&idr, 0x80000001);
218 idr_u32_test1(&idr, 0xffe00000);
219 idr_u32_test1(&idr, 0xffffffff);
222 static void idr_align_test(struct idr *idr)
224 char name[] = "Motorola 68000";
228 for (i = 0; i < 9; i++) {
229 BUG_ON(idr_alloc(idr, &name[i], 0, 0, GFP_KERNEL) != i);
230 idr_for_each_entry(idr, entry, id);
234 for (i = 1; i < 10; i++) {
235 BUG_ON(idr_alloc(idr, &name[i], 0, 0, GFP_KERNEL) != i - 1);
236 idr_for_each_entry(idr, entry, id);
240 for (i = 2; i < 11; i++) {
241 BUG_ON(idr_alloc(idr, &name[i], 0, 0, GFP_KERNEL) != i - 2);
242 idr_for_each_entry(idr, entry, id);
246 for (i = 3; i < 12; i++) {
247 BUG_ON(idr_alloc(idr, &name[i], 0, 0, GFP_KERNEL) != i - 3);
248 idr_for_each_entry(idr, entry, id);
252 for (i = 0; i < 8; i++) {
253 BUG_ON(idr_alloc(idr, &name[i], 0, 0, GFP_KERNEL) != 0);
254 BUG_ON(idr_alloc(idr, &name[i + 1], 0, 0, GFP_KERNEL) != 1);
255 idr_for_each_entry(idr, entry, id);
257 idr_for_each_entry(idr, entry, id);
259 BUG_ON(!idr_is_empty(idr));
262 for (i = 0; i < 8; i++) {
263 BUG_ON(idr_alloc(idr, NULL, 0, 0, GFP_KERNEL) != 0);
264 idr_for_each_entry(idr, entry, id);
265 idr_replace(idr, &name[i], 0);
266 idr_for_each_entry(idr, entry, id);
267 BUG_ON(idr_find(idr, 0) != &name[i]);
271 for (i = 0; i < 8; i++) {
272 BUG_ON(idr_alloc(idr, &name[i], 0, 0, GFP_KERNEL) != 0);
273 BUG_ON(idr_alloc(idr, NULL, 0, 0, GFP_KERNEL) != 1);
275 idr_for_each_entry(idr, entry, id);
276 idr_replace(idr, &name[i + 1], 0);
277 idr_for_each_entry(idr, entry, id);
282 DEFINE_IDR(find_idr);
284 static void *idr_throbber(void *arg)
286 time_t start = time(NULL);
287 int id = *(int *)arg;
289 rcu_register_thread();
291 idr_alloc(&find_idr, xa_mk_value(id), id, id + 1, GFP_KERNEL);
292 idr_remove(&find_idr, id);
293 } while (time(NULL) < start + 10);
294 rcu_unregister_thread();
299 void idr_find_test_1(int anchor_id, int throbber_id)
302 time_t start = time(NULL);
304 BUG_ON(idr_alloc(&find_idr, xa_mk_value(anchor_id), anchor_id,
305 anchor_id + 1, GFP_KERNEL) != anchor_id);
307 pthread_create(&throbber, NULL, idr_throbber, &throbber_id);
312 void *entry = idr_get_next(&find_idr, &id);
314 BUG_ON(entry != xa_mk_value(id));
316 } while (time(NULL) < start + 11);
319 pthread_join(throbber, NULL);
321 idr_remove(&find_idr, anchor_id);
322 BUG_ON(!idr_is_empty(&find_idr));
325 void idr_find_test(void)
327 idr_find_test_1(100000, 0);
328 idr_find_test_1(0, 100000);
331 void idr_checks(void)
336 for (i = 0; i < 10000; i++) {
337 struct item *item = item_create(i, 0);
338 assert(idr_alloc(&idr, item, 0, 20000, GFP_KERNEL) == i);
341 assert(idr_alloc(&idr, DUMMY_PTR, 5, 30, GFP_KERNEL) < 0);
343 for (i = 0; i < 5000; i++)
344 item_idr_remove(&idr, i);
348 idr_for_each(&idr, item_idr_free, &idr);
351 assert(idr_is_empty(&idr));
356 assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == 0);
358 for (i = 1; i < RADIX_TREE_MAP_SIZE; i++)
359 assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == i);
360 idr_remove(&idr, 1 << 30);
363 for (i = INT_MAX - 3UL; i < INT_MAX + 1UL; i++) {
364 struct item *item = item_create(i, 0);
365 assert(idr_alloc(&idr, item, i, i + 10, GFP_KERNEL) == i);
367 assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i, GFP_KERNEL) == -ENOSPC);
368 assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i + 10, GFP_KERNEL) == -ENOSPC);
370 idr_for_each(&idr, item_idr_free, &idr);
374 assert(idr_is_empty(&idr));
376 idr_set_cursor(&idr, INT_MAX - 3UL);
377 for (i = INT_MAX - 3UL; i < INT_MAX + 3UL; i++) {
381 item = item_create(i, 0);
383 item = item_create(i - INT_MAX - 1, 0);
385 id = idr_alloc_cyclic(&idr, item, 0, 0, GFP_KERNEL);
386 assert(id == item->index);
389 idr_for_each(&idr, item_idr_free, &idr);
391 assert(idr_is_empty(&idr));
393 for (i = 1; i < 10000; i++) {
394 struct item *item = item_create(i, 0);
395 assert(idr_alloc(&idr, item, 1, 20000, GFP_KERNEL) == i);
398 idr_for_each(&idr, item_idr_free, &idr);
405 idr_get_next_test(0);
406 idr_get_next_test(1);
407 idr_get_next_test(4);
411 idr_align_test(&idr);
415 #define module_init(x)
416 #define module_exit(x)
417 #define MODULE_AUTHOR(x)
418 #define MODULE_LICENSE(x)
419 #define dump_stack() assert(0)
420 void ida_dump(struct ida *);
422 #include "../../../lib/test_ida.c"
425 * Check that we get the correct error when we run out of memory doing
426 * allocations. In userspace, GFP_NOWAIT will always fail an allocation.
427 * The first test is for not having a bitmap available, and the second test
428 * is for not being able to allocate a level of the radix tree.
430 void ida_check_nomem(void)
435 id = ida_alloc_min(&ida, 256, GFP_NOWAIT);
436 IDA_BUG_ON(&ida, id != -ENOMEM);
437 id = ida_alloc_min(&ida, 1UL << 30, GFP_NOWAIT);
438 IDA_BUG_ON(&ida, id != -ENOMEM);
439 IDA_BUG_ON(&ida, !ida_is_empty(&ida));
443 * Check handling of conversions between exceptional entries and full bitmaps.
445 void ida_check_conv_user(void)
450 for (i = 0; i < 1000000; i++) {
451 int id = ida_alloc(&ida, GFP_NOWAIT);
453 IDA_BUG_ON(&ida, ((i % IDA_BITMAP_BITS) !=
454 BITS_PER_XA_VALUE) &&
455 ((i % IDA_BITMAP_BITS) != 0));
456 id = ida_alloc(&ida, GFP_KERNEL);
458 IDA_BUG_ON(&ida, (i % IDA_BITMAP_BITS) ==
461 IDA_BUG_ON(&ida, id != i);
466 void ida_check_random(void)
469 DECLARE_BITMAP(bitmap, 2048);
471 time_t s = time(NULL);
474 memset(bitmap, 0, sizeof(bitmap));
475 for (i = 0; i < 100000; i++) {
478 if (test_bit(bit, bitmap)) {
479 __clear_bit(bit, bitmap);
482 __set_bit(bit, bitmap);
483 IDA_BUG_ON(&ida, ida_alloc_min(&ida, bit, GFP_KERNEL)
488 if (time(NULL) < s + 10)
492 void ida_simple_get_remove_test(void)
497 for (i = 0; i < 10000; i++) {
498 assert(ida_simple_get(&ida, 0, 20000, GFP_KERNEL) == i);
500 assert(ida_simple_get(&ida, 5, 30, GFP_KERNEL) < 0);
502 for (i = 0; i < 10000; i++) {
503 ida_simple_remove(&ida, i);
505 assert(ida_is_empty(&ida));
510 void user_ida_checks(void)
512 radix_tree_cpu_dead(1);
515 ida_check_conv_user();
517 ida_simple_get_remove_test();
519 radix_tree_cpu_dead(1);
522 static void *ida_random_fn(void *arg)
524 rcu_register_thread();
526 rcu_unregister_thread();
530 static void *ida_leak_fn(void *arg)
532 struct ida *ida = arg;
533 time_t s = time(NULL);
536 rcu_register_thread();
538 do for (i = 0; i < 1000; i++) {
539 ret = ida_alloc_range(ida, 128, 128, GFP_KERNEL);
542 } while (time(NULL) < s + 2);
544 rcu_unregister_thread();
548 void ida_thread_tests(void)
551 pthread_t threads[20];
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);
563 for (i = 0; i < ARRAY_SIZE(threads); i++)
564 if (pthread_create(&threads[i], NULL, ida_leak_fn, &ida)) {
565 perror("creating ida thread");
570 pthread_join(threads[i], NULL);
571 assert(ida_is_empty(&ida));
582 int __weak main(void)
584 rcu_register_thread();
588 radix_tree_cpu_dead(1);
591 printf("nr_allocated = %d\n", nr_allocated);
592 rcu_unregister_thread();