2 * multiorder.c: Multi-order radix tree entry testing
3 * Copyright (c) 2016 Intel Corporation
4 * Author: Ross Zwisler <ross.zwisler@linux.intel.com>
5 * Author: Matthew Wilcox <matthew.r.wilcox@intel.com>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms and conditions of the GNU General Public License,
9 * version 2, as published by the Free Software Foundation.
11 * This program is distributed in the hope it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 #include <linux/radix-tree.h>
17 #include <linux/slab.h>
18 #include <linux/errno.h>
22 #define for_each_index(i, base, order) \
23 for (i = base; i < base + (1 << order); i++)
25 static void __multiorder_tag_test(int index
, int order
)
27 RADIX_TREE(tree
, GFP_KERNEL
);
30 /* our canonical entry */
31 base
= index
& ~((1 << order
) - 1);
33 printf("Multiorder tag test with index %d, canonical entry %d\n",
36 err
= item_insert_order(&tree
, index
, order
);
40 * Verify we get collisions for covered indices. We try and fail to
41 * insert an exceptional entry so we don't leak memory via
42 * item_insert_order().
44 for_each_index(i
, base
, order
) {
45 err
= __radix_tree_insert(&tree
, i
, order
,
46 (void *)(0xA0 | RADIX_TREE_EXCEPTIONAL_ENTRY
));
47 assert(err
== -EEXIST
);
50 for_each_index(i
, base
, order
) {
51 assert(!radix_tree_tag_get(&tree
, i
, 0));
52 assert(!radix_tree_tag_get(&tree
, i
, 1));
55 assert(radix_tree_tag_set(&tree
, index
, 0));
57 for_each_index(i
, base
, order
) {
58 assert(radix_tree_tag_get(&tree
, i
, 0));
59 assert(!radix_tree_tag_get(&tree
, i
, 1));
62 assert(tag_tagged_items(&tree
, NULL
, 0, ~0UL, 10, 0, 1) == 1);
63 assert(radix_tree_tag_clear(&tree
, index
, 0));
65 for_each_index(i
, base
, order
) {
66 assert(!radix_tree_tag_get(&tree
, i
, 0));
67 assert(radix_tree_tag_get(&tree
, i
, 1));
70 assert(radix_tree_tag_clear(&tree
, index
, 1));
72 assert(!radix_tree_tagged(&tree
, 0));
73 assert(!radix_tree_tagged(&tree
, 1));
75 item_kill_tree(&tree
);
78 static void __multiorder_tag_test2(unsigned order
, unsigned long index2
)
80 RADIX_TREE(tree
, GFP_KERNEL
);
81 unsigned long index
= (1 << order
);
84 assert(item_insert_order(&tree
, 0, order
) == 0);
85 assert(item_insert(&tree
, index2
) == 0);
87 assert(radix_tree_tag_set(&tree
, 0, 0));
88 assert(radix_tree_tag_set(&tree
, index2
, 0));
90 assert(tag_tagged_items(&tree
, NULL
, 0, ~0UL, 10, 0, 1) == 2);
92 item_kill_tree(&tree
);
95 static void multiorder_tag_tests(void)
99 /* test multi-order entry for indices 0-7 with no sibling pointers */
100 __multiorder_tag_test(0, 3);
101 __multiorder_tag_test(5, 3);
103 /* test multi-order entry for indices 8-15 with no sibling pointers */
104 __multiorder_tag_test(8, 3);
105 __multiorder_tag_test(15, 3);
108 * Our order 5 entry covers indices 0-31 in a tree with height=2.
109 * This is broken up as follows:
110 * 0-7: canonical entry
115 __multiorder_tag_test(0, 5);
116 __multiorder_tag_test(29, 5);
118 /* same test, but with indices 32-63 */
119 __multiorder_tag_test(32, 5);
120 __multiorder_tag_test(44, 5);
123 * Our order 8 entry covers indices 0-255 in a tree with height=3.
124 * This is broken up as follows:
125 * 0-63: canonical entry
130 __multiorder_tag_test(0, 8);
131 __multiorder_tag_test(190, 8);
133 /* same test, but with indices 256-511 */
134 __multiorder_tag_test(256, 8);
135 __multiorder_tag_test(300, 8);
137 __multiorder_tag_test(0x12345678UL
, 8);
139 for (i
= 1; i
< 10; i
++)
140 for (j
= 0; j
< (10 << i
); j
++)
141 __multiorder_tag_test2(i
, j
);
144 static void multiorder_check(unsigned long index
, int order
)
147 unsigned long min
= index
& ~((1UL << order
) - 1);
148 unsigned long max
= min
+ (1UL << order
);
150 struct item
*item2
= item_create(min
, order
);
151 RADIX_TREE(tree
, GFP_KERNEL
);
153 printf("Multiorder index %ld, order %d\n", index
, order
);
155 assert(item_insert_order(&tree
, index
, order
) == 0);
157 for (i
= min
; i
< max
; i
++) {
158 struct item
*item
= item_lookup(&tree
, i
);
160 assert(item
->index
== index
);
162 for (i
= 0; i
< min
; i
++)
163 item_check_absent(&tree
, i
);
164 for (i
= max
; i
< 2*max
; i
++)
165 item_check_absent(&tree
, i
);
166 for (i
= min
; i
< max
; i
++)
167 assert(radix_tree_insert(&tree
, i
, item2
) == -EEXIST
);
169 slot
= radix_tree_lookup_slot(&tree
, index
);
171 radix_tree_replace_slot(&tree
, slot
, item2
);
172 for (i
= min
; i
< max
; i
++) {
173 struct item
*item
= item_lookup(&tree
, i
);
175 assert(item
->index
== min
);
178 assert(item_delete(&tree
, min
) != 0);
180 for (i
= 0; i
< 2*max
; i
++)
181 item_check_absent(&tree
, i
);
184 static void multiorder_shrink(unsigned long index
, int order
)
187 unsigned long max
= 1 << order
;
188 RADIX_TREE(tree
, GFP_KERNEL
);
189 struct radix_tree_node
*node
;
191 printf("Multiorder shrink index %ld, order %d\n", index
, order
);
193 assert(item_insert_order(&tree
, 0, order
) == 0);
197 assert(item_insert(&tree
, index
) == 0);
198 assert(node
!= tree
.rnode
);
200 assert(item_delete(&tree
, index
) != 0);
201 assert(node
== tree
.rnode
);
203 for (i
= 0; i
< max
; i
++) {
204 struct item
*item
= item_lookup(&tree
, i
);
206 assert(item
->index
== 0);
208 for (i
= max
; i
< 2*max
; i
++)
209 item_check_absent(&tree
, i
);
211 if (!item_delete(&tree
, 0)) {
212 printf("failed to delete index %ld (order %d)\n", index
, order
); abort();
215 for (i
= 0; i
< 2*max
; i
++)
216 item_check_absent(&tree
, i
);
219 static void multiorder_insert_bug(void)
221 RADIX_TREE(tree
, GFP_KERNEL
);
223 item_insert(&tree
, 0);
224 radix_tree_tag_set(&tree
, 0, 0);
225 item_insert_order(&tree
, 3 << 6, 6);
227 item_kill_tree(&tree
);
230 void multiorder_iteration(void)
232 RADIX_TREE(tree
, GFP_KERNEL
);
233 struct radix_tree_iter iter
;
237 printf("Multiorder iteration test\n");
239 #define NUM_ENTRIES 11
240 int index
[NUM_ENTRIES
] = {0, 2, 4, 8, 16, 32, 34, 36, 64, 72, 128};
241 int order
[NUM_ENTRIES
] = {1, 1, 2, 3, 4, 1, 0, 1, 3, 0, 7};
243 for (i
= 0; i
< NUM_ENTRIES
; i
++) {
244 err
= item_insert_order(&tree
, index
[i
], order
[i
]);
248 for (j
= 0; j
< 256; j
++) {
249 for (i
= 0; i
< NUM_ENTRIES
; i
++)
250 if (j
<= (index
[i
] | ((1 << order
[i
]) - 1)))
253 radix_tree_for_each_slot(slot
, &tree
, &iter
, j
) {
254 int height
= order
[i
] / RADIX_TREE_MAP_SHIFT
;
255 int shift
= height
* RADIX_TREE_MAP_SHIFT
;
256 unsigned long mask
= (1UL << order
[i
]) - 1;
257 struct item
*item
= *slot
;
259 assert((iter
.index
| mask
) == (index
[i
] | mask
));
260 assert(iter
.shift
== shift
);
261 assert(!radix_tree_is_internal_node(item
));
262 assert((item
->index
| mask
) == (index
[i
] | mask
));
263 assert(item
->order
== order
[i
]);
268 item_kill_tree(&tree
);
271 void multiorder_tagged_iteration(void)
273 RADIX_TREE(tree
, GFP_KERNEL
);
274 struct radix_tree_iter iter
;
278 printf("Multiorder tagged iteration test\n");
280 #define MT_NUM_ENTRIES 9
281 int index
[MT_NUM_ENTRIES
] = {0, 2, 4, 16, 32, 40, 64, 72, 128};
282 int order
[MT_NUM_ENTRIES
] = {1, 0, 2, 4, 3, 1, 3, 0, 7};
284 #define TAG_ENTRIES 7
285 int tag_index
[TAG_ENTRIES
] = {0, 4, 16, 40, 64, 72, 128};
287 for (i
= 0; i
< MT_NUM_ENTRIES
; i
++)
288 assert(!item_insert_order(&tree
, index
[i
], order
[i
]));
290 assert(!radix_tree_tagged(&tree
, 1));
292 for (i
= 0; i
< TAG_ENTRIES
; i
++)
293 assert(radix_tree_tag_set(&tree
, tag_index
[i
], 1));
295 for (j
= 0; j
< 256; j
++) {
298 for (i
= 0; i
< TAG_ENTRIES
; i
++) {
299 for (k
= i
; index
[k
] < tag_index
[i
]; k
++)
301 if (j
<= (index
[k
] | ((1 << order
[k
]) - 1)))
305 radix_tree_for_each_tagged(slot
, &tree
, &iter
, j
, 1) {
307 struct item
*item
= *slot
;
308 for (k
= i
; index
[k
] < tag_index
[i
]; k
++)
310 mask
= (1UL << order
[k
]) - 1;
312 assert((iter
.index
| mask
) == (tag_index
[i
] | mask
));
313 assert(!radix_tree_is_internal_node(item
));
314 assert((item
->index
| mask
) == (tag_index
[i
] | mask
));
315 assert(item
->order
== order
[k
]);
320 assert(tag_tagged_items(&tree
, NULL
, 0, ~0UL, TAG_ENTRIES
, 1, 2) ==
323 for (j
= 0; j
< 256; j
++) {
326 for (i
= 0; i
< TAG_ENTRIES
; i
++) {
327 for (k
= i
; index
[k
] < tag_index
[i
]; k
++)
329 if (j
<= (index
[k
] | ((1 << order
[k
]) - 1)))
333 radix_tree_for_each_tagged(slot
, &tree
, &iter
, j
, 2) {
334 struct item
*item
= *slot
;
335 for (k
= i
; index
[k
] < tag_index
[i
]; k
++)
337 mask
= (1 << order
[k
]) - 1;
339 assert((iter
.index
| mask
) == (tag_index
[i
] | mask
));
340 assert(!radix_tree_is_internal_node(item
));
341 assert((item
->index
| mask
) == (tag_index
[i
] | mask
));
342 assert(item
->order
== order
[k
]);
347 assert(tag_tagged_items(&tree
, NULL
, 1, ~0UL, MT_NUM_ENTRIES
* 2, 1, 0)
350 radix_tree_for_each_tagged(slot
, &tree
, &iter
, 0, 0) {
351 assert(iter
.index
== tag_index
[i
]);
355 item_kill_tree(&tree
);
358 static void multiorder_join1(unsigned long index
,
359 unsigned order1
, unsigned order2
)
362 void *item
, *item2
= item_create(index
+ 1, order1
);
363 RADIX_TREE(tree
, GFP_KERNEL
);
365 item_insert_order(&tree
, index
, order2
);
366 item
= radix_tree_lookup(&tree
, index
);
367 radix_tree_join(&tree
, index
+ 1, order1
, item2
);
368 loc
= find_item(&tree
, item
);
371 item
= radix_tree_lookup(&tree
, index
+ 1);
372 assert(item
== item2
);
373 item_kill_tree(&tree
);
376 static void multiorder_join2(unsigned order1
, unsigned order2
)
378 RADIX_TREE(tree
, GFP_KERNEL
);
379 struct radix_tree_node
*node
;
380 void *item1
= item_create(0, order1
);
383 item_insert_order(&tree
, 0, order2
);
384 radix_tree_insert(&tree
, 1 << order2
, (void *)0x12UL
);
385 item2
= __radix_tree_lookup(&tree
, 1 << order2
, &node
, NULL
);
386 assert(item2
== (void *)0x12UL
);
387 assert(node
->exceptional
== 1);
389 radix_tree_join(&tree
, 0, order1
, item1
);
390 item2
= __radix_tree_lookup(&tree
, 1 << order2
, &node
, NULL
);
391 assert(item2
== item1
);
392 assert(node
->exceptional
== 0);
393 item_kill_tree(&tree
);
397 * This test revealed an accounting bug for exceptional entries at one point.
398 * Nodes were being freed back into the pool with an elevated exception count
399 * by radix_tree_join() and then radix_tree_split() was failing to zero the
400 * count of exceptional entries.
402 static void multiorder_join3(unsigned int order
)
404 RADIX_TREE(tree
, GFP_KERNEL
);
405 struct radix_tree_node
*node
;
407 struct radix_tree_iter iter
;
410 for (i
= 0; i
< (1 << order
); i
++) {
411 radix_tree_insert(&tree
, i
, (void *)0x12UL
);
414 radix_tree_join(&tree
, 0, order
, (void *)0x16UL
);
417 radix_tree_split(&tree
, 0, 0);
419 radix_tree_for_each_slot(slot
, &tree
, &iter
, 0) {
420 radix_tree_iter_replace(&tree
, &iter
, slot
, (void *)0x12UL
);
423 __radix_tree_lookup(&tree
, 0, &node
, NULL
);
424 assert(node
->exceptional
== node
->count
);
426 item_kill_tree(&tree
);
429 static void multiorder_join(void)
433 for (idx
= 0; idx
< 1024; idx
= idx
* 2 + 3) {
434 for (i
= 1; i
< 15; i
++) {
435 for (j
= 0; j
< i
; j
++) {
436 multiorder_join1(idx
, i
, j
);
441 for (i
= 1; i
< 15; i
++) {
442 for (j
= 0; j
< i
; j
++) {
443 multiorder_join2(i
, j
);
447 for (i
= 3; i
< 10; i
++) {
452 static void check_mem(unsigned old_order
, unsigned new_order
, unsigned alloc
)
454 struct radix_tree_preload
*rtp
= &radix_tree_preloads
;
456 printf("split(%u %u) remaining %u\n", old_order
, new_order
,
459 * Can't check for equality here as some nodes may have been
460 * RCU-freed while we ran. But we should never finish with more
461 * nodes allocated since they should have all been preloaded.
463 if (nr_allocated
> alloc
)
464 printf("split(%u %u) allocated %u %u\n", old_order
, new_order
,
465 alloc
, nr_allocated
);
468 static void __multiorder_split(int old_order
, int new_order
)
470 RADIX_TREE(tree
, GFP_ATOMIC
);
472 struct radix_tree_iter iter
;
475 radix_tree_preload(GFP_KERNEL
);
476 assert(item_insert_order(&tree
, 0, old_order
) == 0);
477 radix_tree_preload_end();
479 /* Wipe out the preloaded cache or it'll confuse check_mem() */
480 radix_tree_cpu_dead(0);
482 radix_tree_tag_set(&tree
, 0, 2);
484 radix_tree_split_preload(old_order
, new_order
, GFP_KERNEL
);
485 alloc
= nr_allocated
;
486 radix_tree_split(&tree
, 0, new_order
);
487 check_mem(old_order
, new_order
, alloc
);
488 radix_tree_for_each_slot(slot
, &tree
, &iter
, 0) {
489 radix_tree_iter_replace(&tree
, &iter
, slot
,
490 item_create(iter
.index
, new_order
));
492 radix_tree_preload_end();
494 item_kill_tree(&tree
);
497 static void __multiorder_split2(int old_order
, int new_order
)
499 RADIX_TREE(tree
, GFP_KERNEL
);
501 struct radix_tree_iter iter
;
502 struct radix_tree_node
*node
;
505 __radix_tree_insert(&tree
, 0, old_order
, (void *)0x12);
507 item
= __radix_tree_lookup(&tree
, 0, &node
, NULL
);
508 assert(item
== (void *)0x12);
509 assert(node
->exceptional
> 0);
511 radix_tree_split(&tree
, 0, new_order
);
512 radix_tree_for_each_slot(slot
, &tree
, &iter
, 0) {
513 radix_tree_iter_replace(&tree
, &iter
, slot
,
514 item_create(iter
.index
, new_order
));
517 item
= __radix_tree_lookup(&tree
, 0, &node
, NULL
);
518 assert(item
!= (void *)0x12);
519 assert(node
->exceptional
== 0);
521 item_kill_tree(&tree
);
524 static void __multiorder_split3(int old_order
, int new_order
)
526 RADIX_TREE(tree
, GFP_KERNEL
);
528 struct radix_tree_iter iter
;
529 struct radix_tree_node
*node
;
532 __radix_tree_insert(&tree
, 0, old_order
, (void *)0x12);
534 item
= __radix_tree_lookup(&tree
, 0, &node
, NULL
);
535 assert(item
== (void *)0x12);
536 assert(node
->exceptional
> 0);
538 radix_tree_split(&tree
, 0, new_order
);
539 radix_tree_for_each_slot(slot
, &tree
, &iter
, 0) {
540 radix_tree_iter_replace(&tree
, &iter
, slot
, (void *)0x16);
543 item
= __radix_tree_lookup(&tree
, 0, &node
, NULL
);
544 assert(item
== (void *)0x16);
545 assert(node
->exceptional
> 0);
547 item_kill_tree(&tree
);
549 __radix_tree_insert(&tree
, 0, old_order
, (void *)0x12);
551 item
= __radix_tree_lookup(&tree
, 0, &node
, NULL
);
552 assert(item
== (void *)0x12);
553 assert(node
->exceptional
> 0);
555 radix_tree_split(&tree
, 0, new_order
);
556 radix_tree_for_each_slot(slot
, &tree
, &iter
, 0) {
557 if (iter
.index
== (1 << new_order
))
558 radix_tree_iter_replace(&tree
, &iter
, slot
,
561 radix_tree_iter_replace(&tree
, &iter
, slot
, NULL
);
564 item
= __radix_tree_lookup(&tree
, 1 << new_order
, &node
, NULL
);
565 assert(item
== (void *)0x16);
566 assert(node
->count
== node
->exceptional
);
571 assert(node
->count
== 1);
572 assert(node
->exceptional
== 0);
575 item_kill_tree(&tree
);
578 static void multiorder_split(void)
582 for (i
= 3; i
< 11; i
++)
583 for (j
= 0; j
< i
; j
++) {
584 __multiorder_split(i
, j
);
585 __multiorder_split2(i
, j
);
586 __multiorder_split3(i
, j
);
590 static void multiorder_account(void)
592 RADIX_TREE(tree
, GFP_KERNEL
);
593 struct radix_tree_node
*node
;
596 item_insert_order(&tree
, 0, 5);
598 __radix_tree_insert(&tree
, 1 << 5, 5, (void *)0x12);
599 __radix_tree_lookup(&tree
, 0, &node
, NULL
);
600 assert(node
->count
== node
->exceptional
* 2);
601 radix_tree_delete(&tree
, 1 << 5);
602 assert(node
->exceptional
== 0);
604 __radix_tree_insert(&tree
, 1 << 5, 5, (void *)0x12);
605 __radix_tree_lookup(&tree
, 1 << 5, &node
, &slot
);
606 assert(node
->count
== node
->exceptional
* 2);
607 __radix_tree_replace(&tree
, node
, slot
, NULL
, NULL
, NULL
);
608 assert(node
->exceptional
== 0);
610 item_kill_tree(&tree
);
613 void multiorder_checks(void)
617 for (i
= 0; i
< 20; i
++) {
618 multiorder_check(200, i
);
619 multiorder_check(0, i
);
620 multiorder_check((1UL << i
) + 1, i
);
623 for (i
= 0; i
< 15; i
++)
624 multiorder_shrink((1UL << (i
+ RADIX_TREE_MAP_SHIFT
)), i
);
626 multiorder_insert_bug();
627 multiorder_tag_tests();
628 multiorder_iteration();
629 multiorder_tagged_iteration();
632 multiorder_account();
634 radix_tree_cpu_dead(0);