xref: /linux/tools/testing/radix-tree/idr-test.c (revision e9f0878c4b2004ac19581274c1ae4c61ae3ca70e)
1 /*
2  * idr-test.c: Test the IDR API
3  * Copyright (c) 2016 Matthew Wilcox <willy@infradead.org>
4  *
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.
8  *
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
12  * more details.
13  */
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>
19 
20 #include "test.h"
21 
22 #define DUMMY_PTR	((void *)0x12)
23 
24 int item_idr_free(int id, void *p, void *data)
25 {
26 	struct item *item = p;
27 	assert(item->index == id);
28 	free(p);
29 
30 	return 0;
31 }
32 
33 void item_idr_remove(struct idr *idr, int id)
34 {
35 	struct item *item = idr_find(idr, id);
36 	assert(item->index == id);
37 	idr_remove(idr, id);
38 	free(item);
39 }
40 
41 void idr_alloc_test(void)
42 {
43 	unsigned long i;
44 	DEFINE_IDR(idr);
45 
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);
49 	idr_remove(&idr, 0);
50 
51 	for (i = 0x3ffe; i < 0x4003; i++) {
52 		int id;
53 		struct item *item;
54 
55 		if (i < 0x4000)
56 			item = item_create(i, 0);
57 		else
58 			item = item_create(i - 0x3fff, 0);
59 
60 		id = idr_alloc_cyclic(&idr, item, 1, 0x4000, GFP_KERNEL);
61 		assert(id == item->index);
62 	}
63 
64 	idr_for_each(&idr, item_idr_free, &idr);
65 	idr_destroy(&idr);
66 }
67 
68 void idr_replace_test(void)
69 {
70 	DEFINE_IDR(idr);
71 
72 	idr_alloc(&idr, (void *)-1, 10, 11, GFP_KERNEL);
73 	idr_replace(&idr, &idr, 10);
74 
75 	idr_destroy(&idr);
76 }
77 
78 /*
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
82  * users want.
83  */
84 void idr_null_test(void)
85 {
86 	int i;
87 	DEFINE_IDR(idr);
88 
89 	assert(idr_is_empty(&idr));
90 
91 	assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
92 	assert(!idr_is_empty(&idr));
93 	idr_remove(&idr, 0);
94 	assert(idr_is_empty(&idr));
95 
96 	assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0);
97 	assert(!idr_is_empty(&idr));
98 	idr_destroy(&idr);
99 	assert(idr_is_empty(&idr));
100 
101 	for (i = 0; i < 10; i++) {
102 		assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == i);
103 	}
104 
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));
109 	idr_remove(&idr, 5);
110 	assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 5);
111 	idr_remove(&idr, 5);
112 
113 	for (i = 0; i < 9; i++) {
114 		idr_remove(&idr, i);
115 		assert(!idr_is_empty(&idr));
116 	}
117 	idr_remove(&idr, 8);
118 	assert(!idr_is_empty(&idr));
119 	idr_remove(&idr, 9);
120 	assert(idr_is_empty(&idr));
121 
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);
126 
127 	idr_destroy(&idr);
128 	assert(idr_is_empty(&idr));
129 
130 	for (i = 1; i < 10; i++) {
131 		assert(idr_alloc(&idr, NULL, 1, 0, GFP_KERNEL) == i);
132 	}
133 
134 	idr_destroy(&idr);
135 	assert(idr_is_empty(&idr));
136 }
137 
138 void idr_nowait_test(void)
139 {
140 	unsigned int i;
141 	DEFINE_IDR(idr);
142 
143 	idr_preload(GFP_KERNEL);
144 
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);
148 	}
149 
150 	idr_preload_end();
151 
152 	idr_for_each(&idr, item_idr_free, &idr);
153 	idr_destroy(&idr);
154 }
155 
156 void idr_get_next_test(int base)
157 {
158 	unsigned long i;
159 	int nextid;
160 	DEFINE_IDR(idr);
161 	idr_init_base(&idr, base);
162 
163 	int indices[] = {4, 7, 9, 15, 65, 128, 1000, 99999, 0};
164 
165 	for(i = 0; indices[i]; i++) {
166 		struct item *item = item_create(indices[i], 0);
167 		assert(idr_alloc(&idr, item, indices[i], indices[i+1],
168 				 GFP_KERNEL) == indices[i]);
169 	}
170 
171 	for(i = 0, nextid = 0; indices[i]; i++) {
172 		idr_get_next(&idr, &nextid);
173 		assert(nextid == indices[i]);
174 		nextid++;
175 	}
176 
177 	idr_for_each(&idr, item_idr_free, &idr);
178 	idr_destroy(&idr);
179 }
180 
181 int idr_u32_cb(int id, void *ptr, void *data)
182 {
183 	BUG_ON(id < 0);
184 	BUG_ON(ptr != DUMMY_PTR);
185 	return 0;
186 }
187 
188 void idr_u32_test1(struct idr *idr, u32 handle)
189 {
190 	static bool warned = false;
191 	u32 id = handle;
192 	int sid = 0;
193 	void *ptr;
194 
195 	BUG_ON(idr_alloc_u32(idr, DUMMY_PTR, &id, id, GFP_KERNEL));
196 	BUG_ON(id != handle);
197 	BUG_ON(idr_alloc_u32(idr, DUMMY_PTR, &id, id, GFP_KERNEL) != -ENOSPC);
198 	BUG_ON(id != handle);
199 	if (!warned && id > INT_MAX)
200 		printk("vvv Ignore these warnings\n");
201 	ptr = idr_get_next(idr, &sid);
202 	if (id > INT_MAX) {
203 		BUG_ON(ptr != NULL);
204 		BUG_ON(sid != 0);
205 	} else {
206 		BUG_ON(ptr != DUMMY_PTR);
207 		BUG_ON(sid != id);
208 	}
209 	idr_for_each(idr, idr_u32_cb, NULL);
210 	if (!warned && id > INT_MAX) {
211 		printk("^^^ Warnings over\n");
212 		warned = true;
213 	}
214 	BUG_ON(idr_remove(idr, id) != DUMMY_PTR);
215 	BUG_ON(!idr_is_empty(idr));
216 }
217 
218 void idr_u32_test(int base)
219 {
220 	DEFINE_IDR(idr);
221 	idr_init_base(&idr, base);
222 	idr_u32_test1(&idr, 10);
223 	idr_u32_test1(&idr, 0x7fffffff);
224 	idr_u32_test1(&idr, 0x80000000);
225 	idr_u32_test1(&idr, 0x80000001);
226 	idr_u32_test1(&idr, 0xffe00000);
227 	idr_u32_test1(&idr, 0xffffffff);
228 }
229 
230 void idr_checks(void)
231 {
232 	unsigned long i;
233 	DEFINE_IDR(idr);
234 
235 	for (i = 0; i < 10000; i++) {
236 		struct item *item = item_create(i, 0);
237 		assert(idr_alloc(&idr, item, 0, 20000, GFP_KERNEL) == i);
238 	}
239 
240 	assert(idr_alloc(&idr, DUMMY_PTR, 5, 30, GFP_KERNEL) < 0);
241 
242 	for (i = 0; i < 5000; i++)
243 		item_idr_remove(&idr, i);
244 
245 	idr_remove(&idr, 3);
246 
247 	idr_for_each(&idr, item_idr_free, &idr);
248 	idr_destroy(&idr);
249 
250 	assert(idr_is_empty(&idr));
251 
252 	idr_remove(&idr, 3);
253 	idr_remove(&idr, 0);
254 
255 	assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == 0);
256 	idr_remove(&idr, 1);
257 	for (i = 1; i < RADIX_TREE_MAP_SIZE; i++)
258 		assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == i);
259 	idr_remove(&idr, 1 << 30);
260 	idr_destroy(&idr);
261 
262 	for (i = INT_MAX - 3UL; i < INT_MAX + 1UL; i++) {
263 		struct item *item = item_create(i, 0);
264 		assert(idr_alloc(&idr, item, i, i + 10, GFP_KERNEL) == i);
265 	}
266 	assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i, GFP_KERNEL) == -ENOSPC);
267 	assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i + 10, GFP_KERNEL) == -ENOSPC);
268 
269 	idr_for_each(&idr, item_idr_free, &idr);
270 	idr_destroy(&idr);
271 	idr_destroy(&idr);
272 
273 	assert(idr_is_empty(&idr));
274 
275 	idr_set_cursor(&idr, INT_MAX - 3UL);
276 	for (i = INT_MAX - 3UL; i < INT_MAX + 3UL; i++) {
277 		struct item *item;
278 		unsigned int id;
279 		if (i <= INT_MAX)
280 			item = item_create(i, 0);
281 		else
282 			item = item_create(i - INT_MAX - 1, 0);
283 
284 		id = idr_alloc_cyclic(&idr, item, 0, 0, GFP_KERNEL);
285 		assert(id == item->index);
286 	}
287 
288 	idr_for_each(&idr, item_idr_free, &idr);
289 	idr_destroy(&idr);
290 	assert(idr_is_empty(&idr));
291 
292 	for (i = 1; i < 10000; i++) {
293 		struct item *item = item_create(i, 0);
294 		assert(idr_alloc(&idr, item, 1, 20000, GFP_KERNEL) == i);
295 	}
296 
297 	idr_for_each(&idr, item_idr_free, &idr);
298 	idr_destroy(&idr);
299 
300 	idr_replace_test();
301 	idr_alloc_test();
302 	idr_null_test();
303 	idr_nowait_test();
304 	idr_get_next_test(0);
305 	idr_get_next_test(1);
306 	idr_get_next_test(4);
307 	idr_u32_test(4);
308 	idr_u32_test(1);
309 	idr_u32_test(0);
310 }
311 
312 #define module_init(x)
313 #define module_exit(x)
314 #define MODULE_AUTHOR(x)
315 #define MODULE_LICENSE(x)
316 #define dump_stack()    assert(0)
317 void ida_dump(struct ida *);
318 
319 #include "../../../lib/test_ida.c"
320 
321 /*
322  * Check that we get the correct error when we run out of memory doing
323  * allocations.  In userspace, GFP_NOWAIT will always fail an allocation.
324  * The first test is for not having a bitmap available, and the second test
325  * is for not being able to allocate a level of the radix tree.
326  */
327 void ida_check_nomem(void)
328 {
329 	DEFINE_IDA(ida);
330 	int id;
331 
332 	id = ida_alloc_min(&ida, 256, GFP_NOWAIT);
333 	IDA_BUG_ON(&ida, id != -ENOMEM);
334 	id = ida_alloc_min(&ida, 1UL << 30, GFP_NOWAIT);
335 	IDA_BUG_ON(&ida, id != -ENOMEM);
336 	IDA_BUG_ON(&ida, !ida_is_empty(&ida));
337 }
338 
339 /*
340  * Check handling of conversions between exceptional entries and full bitmaps.
341  */
342 void ida_check_conv_user(void)
343 {
344 	DEFINE_IDA(ida);
345 	unsigned long i;
346 
347 	radix_tree_cpu_dead(1);
348 	for (i = 0; i < 1000000; i++) {
349 		int id = ida_alloc(&ida, GFP_NOWAIT);
350 		if (id == -ENOMEM) {
351 			IDA_BUG_ON(&ida, (i % IDA_BITMAP_BITS) !=
352 					BITS_PER_LONG - 2);
353 			id = ida_alloc(&ida, GFP_KERNEL);
354 		} else {
355 			IDA_BUG_ON(&ida, (i % IDA_BITMAP_BITS) ==
356 					BITS_PER_LONG - 2);
357 		}
358 		IDA_BUG_ON(&ida, id != i);
359 	}
360 	ida_destroy(&ida);
361 }
362 
363 void ida_check_random(void)
364 {
365 	DEFINE_IDA(ida);
366 	DECLARE_BITMAP(bitmap, 2048);
367 	unsigned int i;
368 	time_t s = time(NULL);
369 
370  repeat:
371 	memset(bitmap, 0, sizeof(bitmap));
372 	for (i = 0; i < 100000; i++) {
373 		int i = rand();
374 		int bit = i & 2047;
375 		if (test_bit(bit, bitmap)) {
376 			__clear_bit(bit, bitmap);
377 			ida_free(&ida, bit);
378 		} else {
379 			__set_bit(bit, bitmap);
380 			IDA_BUG_ON(&ida, ida_alloc_min(&ida, bit, GFP_KERNEL)
381 					!= bit);
382 		}
383 	}
384 	ida_destroy(&ida);
385 	if (time(NULL) < s + 10)
386 		goto repeat;
387 }
388 
389 void ida_simple_get_remove_test(void)
390 {
391 	DEFINE_IDA(ida);
392 	unsigned long i;
393 
394 	for (i = 0; i < 10000; i++) {
395 		assert(ida_simple_get(&ida, 0, 20000, GFP_KERNEL) == i);
396 	}
397 	assert(ida_simple_get(&ida, 5, 30, GFP_KERNEL) < 0);
398 
399 	for (i = 0; i < 10000; i++) {
400 		ida_simple_remove(&ida, i);
401 	}
402 	assert(ida_is_empty(&ida));
403 
404 	ida_destroy(&ida);
405 }
406 
407 void user_ida_checks(void)
408 {
409 	radix_tree_cpu_dead(1);
410 
411 	ida_check_nomem();
412 	ida_check_conv_user();
413 	ida_check_random();
414 	ida_simple_get_remove_test();
415 
416 	radix_tree_cpu_dead(1);
417 }
418 
419 static void *ida_random_fn(void *arg)
420 {
421 	rcu_register_thread();
422 	ida_check_random();
423 	rcu_unregister_thread();
424 	return NULL;
425 }
426 
427 void ida_thread_tests(void)
428 {
429 	pthread_t threads[20];
430 	int i;
431 
432 	for (i = 0; i < ARRAY_SIZE(threads); i++)
433 		if (pthread_create(&threads[i], NULL, ida_random_fn, NULL)) {
434 			perror("creating ida thread");
435 			exit(1);
436 		}
437 
438 	while (i--)
439 		pthread_join(threads[i], NULL);
440 }
441 
442 void ida_tests(void)
443 {
444 	user_ida_checks();
445 	ida_checks();
446 	ida_exit();
447 	ida_thread_tests();
448 }
449 
450 int __weak main(void)
451 {
452 	radix_tree_init();
453 	idr_checks();
454 	ida_tests();
455 	radix_tree_cpu_dead(1);
456 	rcu_barrier();
457 	if (nr_allocated)
458 		printf("nr_allocated = %d\n", nr_allocated);
459 	return 0;
460 }
461