1 // SPDX-License-Identifier: GPL-2.0+
3 * test_xarray.c: Test the XArray API
4 * Copyright (c) 2017-2018 Microsoft Corporation
5 * Author: Matthew Wilcox <willy@infradead.org>
8 #include <linux/xarray.h>
9 #include <linux/module.h>
11 static unsigned int tests_run;
12 static unsigned int tests_passed;
16 void xa_dump(const struct xarray *xa) { }
19 #define XA_BUG_ON(xa, x) do { \
22 printk("BUG at %s:%d\n", __func__, __LINE__); \
31 static void *xa_mk_index(unsigned long index)
33 return xa_mk_value(index & LONG_MAX);
36 static void *xa_store_index(struct xarray *xa, unsigned long index, gfp_t gfp)
38 return xa_store(xa, index, xa_mk_index(index), gfp);
41 static void xa_alloc_index(struct xarray *xa, unsigned long index, gfp_t gfp)
45 XA_BUG_ON(xa, xa_alloc(xa, &id, UINT_MAX, xa_mk_index(index),
47 XA_BUG_ON(xa, id != index);
50 static void xa_erase_index(struct xarray *xa, unsigned long index)
52 XA_BUG_ON(xa, xa_erase(xa, index) != xa_mk_index(index));
53 XA_BUG_ON(xa, xa_load(xa, index) != NULL);
57 * If anyone needs this, please move it to xarray.c. We have no current
58 * users outside the test suite because all current multislot users want
59 * to use the advanced API.
61 static void *xa_store_order(struct xarray *xa, unsigned long index,
62 unsigned order, void *entry, gfp_t gfp)
64 XA_STATE_ORDER(xas, xa, index, order);
69 curr = xas_store(&xas, entry);
71 } while (xas_nomem(&xas, gfp));
76 static noinline void check_xa_err(struct xarray *xa)
78 XA_BUG_ON(xa, xa_err(xa_store_index(xa, 0, GFP_NOWAIT)) != 0);
79 XA_BUG_ON(xa, xa_err(xa_erase(xa, 0)) != 0);
81 /* The kernel does not fail GFP_NOWAIT allocations */
82 XA_BUG_ON(xa, xa_err(xa_store_index(xa, 1, GFP_NOWAIT)) != -ENOMEM);
83 XA_BUG_ON(xa, xa_err(xa_store_index(xa, 1, GFP_NOWAIT)) != -ENOMEM);
85 XA_BUG_ON(xa, xa_err(xa_store_index(xa, 1, GFP_KERNEL)) != 0);
86 XA_BUG_ON(xa, xa_err(xa_store(xa, 1, xa_mk_value(0), GFP_KERNEL)) != 0);
87 XA_BUG_ON(xa, xa_err(xa_erase(xa, 1)) != 0);
88 // kills the test-suite :-(
89 // XA_BUG_ON(xa, xa_err(xa_store(xa, 0, xa_mk_internal(0), 0)) != -EINVAL);
92 static noinline void check_xas_retry(struct xarray *xa)
97 xa_store_index(xa, 0, GFP_KERNEL);
98 xa_store_index(xa, 1, GFP_KERNEL);
101 XA_BUG_ON(xa, xas_find(&xas, ULONG_MAX) != xa_mk_value(0));
102 xa_erase_index(xa, 1);
103 XA_BUG_ON(xa, !xa_is_retry(xas_reload(&xas)));
104 XA_BUG_ON(xa, xas_retry(&xas, NULL));
105 XA_BUG_ON(xa, xas_retry(&xas, xa_mk_value(0)));
107 XA_BUG_ON(xa, xas.xa_node != XAS_RESTART);
108 XA_BUG_ON(xa, xas_next_entry(&xas, ULONG_MAX) != xa_mk_value(0));
109 XA_BUG_ON(xa, xas.xa_node != NULL);
112 XA_BUG_ON(xa, xa_store_index(xa, 1, GFP_KERNEL) != NULL);
115 XA_BUG_ON(xa, !xa_is_internal(xas_reload(&xas)));
116 xas.xa_node = XAS_RESTART;
117 XA_BUG_ON(xa, xas_next_entry(&xas, ULONG_MAX) != xa_mk_value(0));
120 /* Make sure we can iterate through retry entries */
123 xas_store(&xas, XA_RETRY_ENTRY);
125 xas_store(&xas, XA_RETRY_ENTRY);
128 xas_for_each(&xas, entry, ULONG_MAX) {
129 xas_store(&xas, xa_mk_index(xas.xa_index));
133 xa_erase_index(xa, 0);
134 xa_erase_index(xa, 1);
137 static noinline void check_xa_load(struct xarray *xa)
141 for (i = 0; i < 1024; i++) {
142 for (j = 0; j < 1024; j++) {
143 void *entry = xa_load(xa, j);
145 XA_BUG_ON(xa, xa_to_value(entry) != j);
147 XA_BUG_ON(xa, entry);
149 XA_BUG_ON(xa, xa_store_index(xa, i, GFP_KERNEL) != NULL);
152 for (i = 0; i < 1024; i++) {
153 for (j = 0; j < 1024; j++) {
154 void *entry = xa_load(xa, j);
156 XA_BUG_ON(xa, xa_to_value(entry) != j);
158 XA_BUG_ON(xa, entry);
160 xa_erase_index(xa, i);
162 XA_BUG_ON(xa, !xa_empty(xa));
165 static noinline void check_xa_mark_1(struct xarray *xa, unsigned long index)
168 unsigned int max_order = IS_ENABLED(CONFIG_XARRAY_MULTI) ? 8 : 1;
170 /* NULL elements have no marks set */
171 XA_BUG_ON(xa, xa_get_mark(xa, index, XA_MARK_0));
172 xa_set_mark(xa, index, XA_MARK_0);
173 XA_BUG_ON(xa, xa_get_mark(xa, index, XA_MARK_0));
175 /* Storing a pointer will not make a mark appear */
176 XA_BUG_ON(xa, xa_store_index(xa, index, GFP_KERNEL) != NULL);
177 XA_BUG_ON(xa, xa_get_mark(xa, index, XA_MARK_0));
178 xa_set_mark(xa, index, XA_MARK_0);
179 XA_BUG_ON(xa, !xa_get_mark(xa, index, XA_MARK_0));
181 /* Setting one mark will not set another mark */
182 XA_BUG_ON(xa, xa_get_mark(xa, index + 1, XA_MARK_0));
183 XA_BUG_ON(xa, xa_get_mark(xa, index, XA_MARK_1));
185 /* Storing NULL clears marks, and they can't be set again */
186 xa_erase_index(xa, index);
187 XA_BUG_ON(xa, !xa_empty(xa));
188 XA_BUG_ON(xa, xa_get_mark(xa, index, XA_MARK_0));
189 xa_set_mark(xa, index, XA_MARK_0);
190 XA_BUG_ON(xa, xa_get_mark(xa, index, XA_MARK_0));
193 * Storing a multi-index entry over entries with marks gives the
194 * entire entry the union of the marks
196 BUG_ON((index % 4) != 0);
197 for (order = 2; order < max_order; order++) {
198 unsigned long base = round_down(index, 1UL << order);
199 unsigned long next = base + (1UL << order);
202 XA_BUG_ON(xa, xa_store_index(xa, index + 1, GFP_KERNEL));
203 xa_set_mark(xa, index + 1, XA_MARK_0);
204 XA_BUG_ON(xa, xa_store_index(xa, index + 2, GFP_KERNEL));
205 xa_set_mark(xa, index + 2, XA_MARK_2);
206 XA_BUG_ON(xa, xa_store_index(xa, next, GFP_KERNEL));
207 xa_store_order(xa, index, order, xa_mk_index(index),
209 for (i = base; i < next; i++) {
210 XA_STATE(xas, xa, i);
211 unsigned int seen = 0;
214 XA_BUG_ON(xa, !xa_get_mark(xa, i, XA_MARK_0));
215 XA_BUG_ON(xa, xa_get_mark(xa, i, XA_MARK_1));
216 XA_BUG_ON(xa, !xa_get_mark(xa, i, XA_MARK_2));
218 /* We should see two elements in the array */
220 xas_for_each(&xas, entry, ULONG_MAX)
223 XA_BUG_ON(xa, seen != 2);
225 /* One of which is marked */
229 xas_for_each_marked(&xas, entry, ULONG_MAX, XA_MARK_0)
232 XA_BUG_ON(xa, seen != 1);
234 XA_BUG_ON(xa, xa_get_mark(xa, next, XA_MARK_0));
235 XA_BUG_ON(xa, xa_get_mark(xa, next, XA_MARK_1));
236 XA_BUG_ON(xa, xa_get_mark(xa, next, XA_MARK_2));
237 xa_erase_index(xa, index);
238 xa_erase_index(xa, next);
239 XA_BUG_ON(xa, !xa_empty(xa));
241 XA_BUG_ON(xa, !xa_empty(xa));
244 static noinline void check_xa_mark_2(struct xarray *xa)
246 XA_STATE(xas, xa, 0);
248 unsigned int count = 0;
251 xa_store_index(xa, 0, GFP_KERNEL);
252 xa_set_mark(xa, 0, XA_MARK_0);
255 xas_init_marks(&xas);
257 XA_BUG_ON(xa, !xa_get_mark(xa, 0, XA_MARK_0) == 0);
259 for (index = 3500; index < 4500; index++) {
260 xa_store_index(xa, index, GFP_KERNEL);
261 xa_set_mark(xa, index, XA_MARK_0);
266 xas_for_each_marked(&xas, entry, ULONG_MAX, XA_MARK_0)
269 XA_BUG_ON(xa, count != 1000);
272 xas_for_each(&xas, entry, ULONG_MAX) {
273 xas_init_marks(&xas);
274 XA_BUG_ON(xa, !xa_get_mark(xa, xas.xa_index, XA_MARK_0));
275 XA_BUG_ON(xa, !xas_get_mark(&xas, XA_MARK_0));
282 static noinline void check_xa_mark(struct xarray *xa)
286 for (index = 0; index < 16384; index += 4)
287 check_xa_mark_1(xa, index);
292 static noinline void check_xa_shrink(struct xarray *xa)
294 XA_STATE(xas, xa, 1);
295 struct xa_node *node;
297 unsigned int max_order = IS_ENABLED(CONFIG_XARRAY_MULTI) ? 15 : 1;
299 XA_BUG_ON(xa, !xa_empty(xa));
300 XA_BUG_ON(xa, xa_store_index(xa, 0, GFP_KERNEL) != NULL);
301 XA_BUG_ON(xa, xa_store_index(xa, 1, GFP_KERNEL) != NULL);
304 * Check that erasing the entry at 1 shrinks the tree and properly
305 * marks the node as being deleted.
308 XA_BUG_ON(xa, xas_load(&xas) != xa_mk_value(1));
310 XA_BUG_ON(xa, xa_entry_locked(xa, node, 0) != xa_mk_value(0));
311 XA_BUG_ON(xa, xas_store(&xas, NULL) != xa_mk_value(1));
312 XA_BUG_ON(xa, xa_load(xa, 1) != NULL);
313 XA_BUG_ON(xa, xas.xa_node != XAS_BOUNDS);
314 XA_BUG_ON(xa, xa_entry_locked(xa, node, 0) != XA_RETRY_ENTRY);
315 XA_BUG_ON(xa, xas_load(&xas) != NULL);
317 XA_BUG_ON(xa, xa_load(xa, 0) != xa_mk_value(0));
318 xa_erase_index(xa, 0);
319 XA_BUG_ON(xa, !xa_empty(xa));
321 for (order = 0; order < max_order; order++) {
322 unsigned long max = (1UL << order) - 1;
323 xa_store_order(xa, 0, order, xa_mk_value(0), GFP_KERNEL);
324 XA_BUG_ON(xa, xa_load(xa, max) != xa_mk_value(0));
325 XA_BUG_ON(xa, xa_load(xa, max + 1) != NULL);
329 XA_BUG_ON(xa, xa_store_index(xa, ULONG_MAX, GFP_KERNEL) !=
332 XA_BUG_ON(xa, xa_head(xa) == node);
334 XA_BUG_ON(xa, xa_load(xa, max + 1) != NULL);
335 xa_erase_index(xa, ULONG_MAX);
336 XA_BUG_ON(xa, xa->xa_head != node);
337 xa_erase_index(xa, 0);
341 static noinline void check_cmpxchg(struct xarray *xa)
343 void *FIVE = xa_mk_value(5);
344 void *SIX = xa_mk_value(6);
345 void *LOTS = xa_mk_value(12345678);
347 XA_BUG_ON(xa, !xa_empty(xa));
348 XA_BUG_ON(xa, xa_store_index(xa, 12345678, GFP_KERNEL) != NULL);
349 XA_BUG_ON(xa, xa_insert(xa, 12345678, xa, GFP_KERNEL) != -EBUSY);
350 XA_BUG_ON(xa, xa_cmpxchg(xa, 12345678, SIX, FIVE, GFP_KERNEL) != LOTS);
351 XA_BUG_ON(xa, xa_cmpxchg(xa, 12345678, LOTS, FIVE, GFP_KERNEL) != LOTS);
352 XA_BUG_ON(xa, xa_cmpxchg(xa, 12345678, FIVE, LOTS, GFP_KERNEL) != FIVE);
353 XA_BUG_ON(xa, xa_cmpxchg(xa, 5, FIVE, NULL, GFP_KERNEL) != NULL);
354 XA_BUG_ON(xa, xa_cmpxchg(xa, 5, NULL, FIVE, GFP_KERNEL) != NULL);
355 xa_erase_index(xa, 12345678);
356 xa_erase_index(xa, 5);
357 XA_BUG_ON(xa, !xa_empty(xa));
360 static noinline void check_reserve(struct xarray *xa)
365 /* An array with a reserved entry is not empty */
366 XA_BUG_ON(xa, !xa_empty(xa));
367 xa_reserve(xa, 12345678, GFP_KERNEL);
368 XA_BUG_ON(xa, xa_empty(xa));
369 XA_BUG_ON(xa, xa_load(xa, 12345678));
370 xa_release(xa, 12345678);
371 XA_BUG_ON(xa, !xa_empty(xa));
373 /* Releasing a used entry does nothing */
374 xa_reserve(xa, 12345678, GFP_KERNEL);
375 XA_BUG_ON(xa, xa_store_index(xa, 12345678, GFP_NOWAIT) != NULL);
376 xa_release(xa, 12345678);
377 xa_erase_index(xa, 12345678);
378 XA_BUG_ON(xa, !xa_empty(xa));
380 /* cmpxchg sees a reserved entry as NULL */
381 xa_reserve(xa, 12345678, GFP_KERNEL);
382 XA_BUG_ON(xa, xa_cmpxchg(xa, 12345678, NULL, xa_mk_value(12345678),
383 GFP_NOWAIT) != NULL);
384 xa_release(xa, 12345678);
385 xa_erase_index(xa, 12345678);
386 XA_BUG_ON(xa, !xa_empty(xa));
388 /* But xa_insert does not */
389 xa_reserve(xa, 12345678, GFP_KERNEL);
390 XA_BUG_ON(xa, xa_insert(xa, 12345678, xa_mk_value(12345678), 0) !=
392 XA_BUG_ON(xa, xa_empty(xa));
393 XA_BUG_ON(xa, xa_erase(xa, 12345678) != NULL);
394 XA_BUG_ON(xa, !xa_empty(xa));
396 /* Can iterate through a reserved entry */
397 xa_store_index(xa, 5, GFP_KERNEL);
398 xa_reserve(xa, 6, GFP_KERNEL);
399 xa_store_index(xa, 7, GFP_KERNEL);
401 xa_for_each(xa, index, entry) {
402 XA_BUG_ON(xa, index != 5 && index != 7);
407 static noinline void check_xas_erase(struct xarray *xa)
409 XA_STATE(xas, xa, 0);
413 for (i = 0; i < 200; i++) {
414 for (j = i; j < 2 * i + 17; j++) {
418 xas_store(&xas, xa_mk_index(j));
420 } while (xas_nomem(&xas, GFP_KERNEL));
423 xas_set(&xas, ULONG_MAX);
426 xas_store(&xas, xa_mk_value(0));
428 } while (xas_nomem(&xas, GFP_KERNEL));
431 xas_store(&xas, NULL);
435 xas_for_each(&xas, entry, ULONG_MAX) {
436 XA_BUG_ON(xa, entry != xa_mk_index(j));
437 xas_store(&xas, NULL);
441 XA_BUG_ON(xa, !xa_empty(xa));
445 #ifdef CONFIG_XARRAY_MULTI
446 static noinline void check_multi_store_1(struct xarray *xa, unsigned long index,
449 XA_STATE(xas, xa, index);
450 unsigned long min = index & ~((1UL << order) - 1);
451 unsigned long max = min + (1UL << order);
453 xa_store_order(xa, index, order, xa_mk_index(index), GFP_KERNEL);
454 XA_BUG_ON(xa, xa_load(xa, min) != xa_mk_index(index));
455 XA_BUG_ON(xa, xa_load(xa, max - 1) != xa_mk_index(index));
456 XA_BUG_ON(xa, xa_load(xa, max) != NULL);
457 XA_BUG_ON(xa, xa_load(xa, min - 1) != NULL);
460 XA_BUG_ON(xa, xas_store(&xas, xa_mk_index(min)) != xa_mk_index(index));
462 XA_BUG_ON(xa, xa_load(xa, min) != xa_mk_index(min));
463 XA_BUG_ON(xa, xa_load(xa, max - 1) != xa_mk_index(min));
464 XA_BUG_ON(xa, xa_load(xa, max) != NULL);
465 XA_BUG_ON(xa, xa_load(xa, min - 1) != NULL);
467 xa_erase_index(xa, min);
468 XA_BUG_ON(xa, !xa_empty(xa));
471 static noinline void check_multi_store_2(struct xarray *xa, unsigned long index,
474 XA_STATE(xas, xa, index);
475 xa_store_order(xa, index, order, xa_mk_value(0), GFP_KERNEL);
478 XA_BUG_ON(xa, xas_store(&xas, xa_mk_value(1)) != xa_mk_value(0));
479 XA_BUG_ON(xa, xas.xa_index != index);
480 XA_BUG_ON(xa, xas_store(&xas, NULL) != xa_mk_value(1));
482 XA_BUG_ON(xa, !xa_empty(xa));
485 static noinline void check_multi_store_3(struct xarray *xa, unsigned long index,
488 XA_STATE(xas, xa, 0);
492 xa_store_order(xa, index, order, xa_mk_index(index), GFP_KERNEL);
495 xas_for_each(&xas, entry, ULONG_MAX) {
496 XA_BUG_ON(xa, entry != xa_mk_index(index));
499 XA_BUG_ON(xa, n != 1);
500 xas_set(&xas, index + 1);
501 xas_for_each(&xas, entry, ULONG_MAX) {
502 XA_BUG_ON(xa, entry != xa_mk_index(index));
505 XA_BUG_ON(xa, n != 2);
512 static noinline void check_multi_store(struct xarray *xa)
514 #ifdef CONFIG_XARRAY_MULTI
515 unsigned long i, j, k;
516 unsigned int max_order = (sizeof(long) == 4) ? 30 : 60;
518 /* Loading from any position returns the same value */
519 xa_store_order(xa, 0, 1, xa_mk_value(0), GFP_KERNEL);
520 XA_BUG_ON(xa, xa_load(xa, 0) != xa_mk_value(0));
521 XA_BUG_ON(xa, xa_load(xa, 1) != xa_mk_value(0));
522 XA_BUG_ON(xa, xa_load(xa, 2) != NULL);
524 XA_BUG_ON(xa, xa_to_node(xa_head(xa))->count != 2);
525 XA_BUG_ON(xa, xa_to_node(xa_head(xa))->nr_values != 2);
528 /* Storing adjacent to the value does not alter the value */
529 xa_store(xa, 3, xa, GFP_KERNEL);
530 XA_BUG_ON(xa, xa_load(xa, 0) != xa_mk_value(0));
531 XA_BUG_ON(xa, xa_load(xa, 1) != xa_mk_value(0));
532 XA_BUG_ON(xa, xa_load(xa, 2) != NULL);
534 XA_BUG_ON(xa, xa_to_node(xa_head(xa))->count != 3);
535 XA_BUG_ON(xa, xa_to_node(xa_head(xa))->nr_values != 2);
538 /* Overwriting multiple indexes works */
539 xa_store_order(xa, 0, 2, xa_mk_value(1), GFP_KERNEL);
540 XA_BUG_ON(xa, xa_load(xa, 0) != xa_mk_value(1));
541 XA_BUG_ON(xa, xa_load(xa, 1) != xa_mk_value(1));
542 XA_BUG_ON(xa, xa_load(xa, 2) != xa_mk_value(1));
543 XA_BUG_ON(xa, xa_load(xa, 3) != xa_mk_value(1));
544 XA_BUG_ON(xa, xa_load(xa, 4) != NULL);
546 XA_BUG_ON(xa, xa_to_node(xa_head(xa))->count != 4);
547 XA_BUG_ON(xa, xa_to_node(xa_head(xa))->nr_values != 4);
550 /* We can erase multiple values with a single store */
551 xa_store_order(xa, 0, BITS_PER_LONG - 1, NULL, GFP_KERNEL);
552 XA_BUG_ON(xa, !xa_empty(xa));
554 /* Even when the first slot is empty but the others aren't */
555 xa_store_index(xa, 1, GFP_KERNEL);
556 xa_store_index(xa, 2, GFP_KERNEL);
557 xa_store_order(xa, 0, 2, NULL, GFP_KERNEL);
558 XA_BUG_ON(xa, !xa_empty(xa));
560 for (i = 0; i < max_order; i++) {
561 for (j = 0; j < max_order; j++) {
562 xa_store_order(xa, 0, i, xa_mk_index(i), GFP_KERNEL);
563 xa_store_order(xa, 0, j, xa_mk_index(j), GFP_KERNEL);
565 for (k = 0; k < max_order; k++) {
566 void *entry = xa_load(xa, (1UL << k) - 1);
567 if ((i < k) && (j < k))
568 XA_BUG_ON(xa, entry != NULL);
570 XA_BUG_ON(xa, entry != xa_mk_index(j));
574 XA_BUG_ON(xa, !xa_empty(xa));
578 for (i = 0; i < 20; i++) {
579 check_multi_store_1(xa, 200, i);
580 check_multi_store_1(xa, 0, i);
581 check_multi_store_1(xa, (1UL << i) + 1, i);
583 check_multi_store_2(xa, 4095, 9);
585 for (i = 1; i < 20; i++) {
586 check_multi_store_3(xa, 0, i);
587 check_multi_store_3(xa, 1UL << i, i);
592 static noinline void check_xa_alloc_1(struct xarray *xa, unsigned int base)
597 XA_BUG_ON(xa, !xa_empty(xa));
598 /* An empty array should assign %base to the first alloc */
599 xa_alloc_index(xa, base, GFP_KERNEL);
601 /* Erasing it should make the array empty again */
602 xa_erase_index(xa, base);
603 XA_BUG_ON(xa, !xa_empty(xa));
605 /* And it should assign %base again */
606 xa_alloc_index(xa, base, GFP_KERNEL);
608 /* Allocating and then erasing a lot should not lose base */
609 for (i = base + 1; i < 2 * XA_CHUNK_SIZE; i++)
610 xa_alloc_index(xa, i, GFP_KERNEL);
611 for (i = base; i < 2 * XA_CHUNK_SIZE; i++)
612 xa_erase_index(xa, i);
613 xa_alloc_index(xa, base, GFP_KERNEL);
615 /* Destroying the array should do the same as erasing */
618 /* And it should assign %base again */
619 xa_alloc_index(xa, base, GFP_KERNEL);
621 /* The next assigned ID should be base+1 */
622 xa_alloc_index(xa, base + 1, GFP_KERNEL);
623 xa_erase_index(xa, base + 1);
625 /* Storing a value should mark it used */
626 xa_store_index(xa, base + 1, GFP_KERNEL);
627 xa_alloc_index(xa, base + 2, GFP_KERNEL);
629 /* If we then erase base, it should be free */
630 xa_erase_index(xa, base);
631 xa_alloc_index(xa, base, GFP_KERNEL);
633 xa_erase_index(xa, base + 1);
634 xa_erase_index(xa, base + 2);
636 for (i = 1; i < 5000; i++) {
637 xa_alloc_index(xa, base + i, GFP_KERNEL);
642 /* Check that we fail properly at the limit of allocation */
644 XA_BUG_ON(xa, xa_alloc(xa, &id, UINT_MAX, xa_mk_index(id),
646 XA_BUG_ON(xa, id != 0xfffffffeU);
647 XA_BUG_ON(xa, xa_alloc(xa, &id, UINT_MAX, xa_mk_index(id),
649 XA_BUG_ON(xa, id != 0xffffffffU);
650 XA_BUG_ON(xa, xa_alloc(xa, &id, UINT_MAX, xa_mk_index(id),
651 GFP_KERNEL) != -ENOSPC);
652 XA_BUG_ON(xa, id != 0xffffffffU);
656 XA_BUG_ON(xa, xa_alloc(xa, &id, 5, xa_mk_index(id),
657 GFP_KERNEL) != -ENOSPC);
658 XA_BUG_ON(xa, xa_store_index(xa, 3, GFP_KERNEL) != 0);
659 XA_BUG_ON(xa, xa_alloc(xa, &id, 5, xa_mk_index(id),
660 GFP_KERNEL) != -ENOSPC);
661 xa_erase_index(xa, 3);
662 XA_BUG_ON(xa, !xa_empty(xa));
665 static DEFINE_XARRAY_ALLOC(xa0);
666 static DEFINE_XARRAY_ALLOC1(xa1);
668 static noinline void check_xa_alloc(void)
670 check_xa_alloc_1(&xa0, 0);
671 check_xa_alloc_1(&xa1, 1);
674 static noinline void __check_store_iter(struct xarray *xa, unsigned long start,
675 unsigned int order, unsigned int present)
677 XA_STATE_ORDER(xas, xa, start, order);
679 unsigned int count = 0;
683 xas_for_each_conflict(&xas, entry) {
684 XA_BUG_ON(xa, !xa_is_value(entry));
685 XA_BUG_ON(xa, entry < xa_mk_index(start));
686 XA_BUG_ON(xa, entry > xa_mk_index(start + (1UL << order) - 1));
689 xas_store(&xas, xa_mk_index(start));
691 if (xas_nomem(&xas, GFP_KERNEL)) {
695 XA_BUG_ON(xa, xas_error(&xas));
696 XA_BUG_ON(xa, count != present);
697 XA_BUG_ON(xa, xa_load(xa, start) != xa_mk_index(start));
698 XA_BUG_ON(xa, xa_load(xa, start + (1UL << order) - 1) !=
700 xa_erase_index(xa, start);
703 static noinline void check_store_iter(struct xarray *xa)
706 unsigned int max_order = IS_ENABLED(CONFIG_XARRAY_MULTI) ? 20 : 1;
708 for (i = 0; i < max_order; i++) {
709 unsigned int min = 1 << i;
710 unsigned int max = (2 << i) - 1;
711 __check_store_iter(xa, 0, i, 0);
712 XA_BUG_ON(xa, !xa_empty(xa));
713 __check_store_iter(xa, min, i, 0);
714 XA_BUG_ON(xa, !xa_empty(xa));
716 xa_store_index(xa, min, GFP_KERNEL);
717 __check_store_iter(xa, min, i, 1);
718 XA_BUG_ON(xa, !xa_empty(xa));
719 xa_store_index(xa, max, GFP_KERNEL);
720 __check_store_iter(xa, min, i, 1);
721 XA_BUG_ON(xa, !xa_empty(xa));
723 for (j = 0; j < min; j++)
724 xa_store_index(xa, j, GFP_KERNEL);
725 __check_store_iter(xa, 0, i, min);
726 XA_BUG_ON(xa, !xa_empty(xa));
727 for (j = 0; j < min; j++)
728 xa_store_index(xa, min + j, GFP_KERNEL);
729 __check_store_iter(xa, min, i, min);
730 XA_BUG_ON(xa, !xa_empty(xa));
732 #ifdef CONFIG_XARRAY_MULTI
733 xa_store_index(xa, 63, GFP_KERNEL);
734 xa_store_index(xa, 65, GFP_KERNEL);
735 __check_store_iter(xa, 64, 2, 1);
736 xa_erase_index(xa, 63);
738 XA_BUG_ON(xa, !xa_empty(xa));
741 static noinline void check_multi_find(struct xarray *xa)
743 #ifdef CONFIG_XARRAY_MULTI
746 xa_store_order(xa, 12, 2, xa_mk_value(12), GFP_KERNEL);
747 XA_BUG_ON(xa, xa_store_index(xa, 16, GFP_KERNEL) != NULL);
750 XA_BUG_ON(xa, xa_find(xa, &index, ULONG_MAX, XA_PRESENT) !=
752 XA_BUG_ON(xa, index != 12);
754 XA_BUG_ON(xa, xa_find(xa, &index, ULONG_MAX, XA_PRESENT) !=
756 XA_BUG_ON(xa, (index < 12) || (index >= 16));
757 XA_BUG_ON(xa, xa_find_after(xa, &index, ULONG_MAX, XA_PRESENT) !=
759 XA_BUG_ON(xa, index != 16);
761 xa_erase_index(xa, 12);
762 xa_erase_index(xa, 16);
763 XA_BUG_ON(xa, !xa_empty(xa));
767 static noinline void check_multi_find_2(struct xarray *xa)
769 unsigned int max_order = IS_ENABLED(CONFIG_XARRAY_MULTI) ? 10 : 1;
773 for (i = 0; i < max_order; i++) {
774 unsigned long index = 1UL << i;
775 for (j = 0; j < index; j++) {
776 XA_STATE(xas, xa, j + index);
777 xa_store_index(xa, index - 1, GFP_KERNEL);
778 xa_store_order(xa, index, i, xa_mk_index(index),
781 xas_for_each(&xas, entry, ULONG_MAX) {
782 xa_erase_index(xa, index);
785 xa_erase_index(xa, index - 1);
786 XA_BUG_ON(xa, !xa_empty(xa));
791 static noinline void check_find_1(struct xarray *xa)
793 unsigned long i, j, k;
795 XA_BUG_ON(xa, !xa_empty(xa));
798 * Check xa_find with all pairs between 0 and 99 inclusive,
799 * starting at every index between 0 and 99
801 for (i = 0; i < 100; i++) {
802 XA_BUG_ON(xa, xa_store_index(xa, i, GFP_KERNEL) != NULL);
803 xa_set_mark(xa, i, XA_MARK_0);
804 for (j = 0; j < i; j++) {
805 XA_BUG_ON(xa, xa_store_index(xa, j, GFP_KERNEL) !=
807 xa_set_mark(xa, j, XA_MARK_0);
808 for (k = 0; k < 100; k++) {
809 unsigned long index = k;
810 void *entry = xa_find(xa, &index, ULONG_MAX,
813 XA_BUG_ON(xa, index != j);
815 XA_BUG_ON(xa, index != i);
817 XA_BUG_ON(xa, entry != NULL);
820 entry = xa_find(xa, &index, ULONG_MAX,
823 XA_BUG_ON(xa, index != j);
825 XA_BUG_ON(xa, index != i);
827 XA_BUG_ON(xa, entry != NULL);
829 xa_erase_index(xa, j);
830 XA_BUG_ON(xa, xa_get_mark(xa, j, XA_MARK_0));
831 XA_BUG_ON(xa, !xa_get_mark(xa, i, XA_MARK_0));
833 xa_erase_index(xa, i);
834 XA_BUG_ON(xa, xa_get_mark(xa, i, XA_MARK_0));
836 XA_BUG_ON(xa, !xa_empty(xa));
839 static noinline void check_find_2(struct xarray *xa)
842 unsigned long i, j, index;
844 xa_for_each(xa, index, entry) {
848 for (i = 0; i < 1024; i++) {
849 xa_store_index(xa, index, GFP_KERNEL);
851 xa_for_each(xa, index, entry) {
852 XA_BUG_ON(xa, xa_mk_index(index) != entry);
853 XA_BUG_ON(xa, index != j++);
860 static noinline void check_find_3(struct xarray *xa)
862 XA_STATE(xas, xa, 0);
863 unsigned long i, j, k;
866 for (i = 0; i < 100; i++) {
867 for (j = 0; j < 100; j++) {
869 for (k = 0; k < 100; k++) {
871 xas_for_each_marked(&xas, entry, k, XA_MARK_0)
875 xas.xa_node != XAS_RESTART);
879 xa_store_index(xa, i, GFP_KERNEL);
880 xa_set_mark(xa, i, XA_MARK_0);
885 static noinline void check_find(struct xarray *xa)
890 check_multi_find(xa);
891 check_multi_find_2(xa);
894 /* See find_swap_entry() in mm/shmem.c */
895 static noinline unsigned long xa_find_entry(struct xarray *xa, void *item)
897 XA_STATE(xas, xa, 0);
898 unsigned int checked = 0;
902 xas_for_each(&xas, entry, ULONG_MAX) {
903 if (xas_retry(&xas, entry))
908 if ((checked % 4) != 0)
914 return entry ? xas.xa_index : -1;
917 static noinline void check_find_entry(struct xarray *xa)
919 #ifdef CONFIG_XARRAY_MULTI
921 unsigned long offset, index;
923 for (order = 0; order < 20; order++) {
924 for (offset = 0; offset < (1UL << (order + 3));
925 offset += (1UL << order)) {
926 for (index = 0; index < (1UL << (order + 5));
927 index += (1UL << order)) {
928 xa_store_order(xa, index, order,
929 xa_mk_index(index), GFP_KERNEL);
930 XA_BUG_ON(xa, xa_load(xa, index) !=
932 XA_BUG_ON(xa, xa_find_entry(xa,
933 xa_mk_index(index)) != index);
935 XA_BUG_ON(xa, xa_find_entry(xa, xa) != -1);
941 XA_BUG_ON(xa, xa_find_entry(xa, xa) != -1);
942 xa_store_index(xa, ULONG_MAX, GFP_KERNEL);
943 XA_BUG_ON(xa, xa_find_entry(xa, xa) != -1);
944 XA_BUG_ON(xa, xa_find_entry(xa, xa_mk_index(ULONG_MAX)) != -1);
945 xa_erase_index(xa, ULONG_MAX);
946 XA_BUG_ON(xa, !xa_empty(xa));
949 static noinline void check_move_small(struct xarray *xa, unsigned long idx)
951 XA_STATE(xas, xa, 0);
954 xa_store_index(xa, 0, GFP_KERNEL);
955 xa_store_index(xa, idx, GFP_KERNEL);
958 for (i = 0; i < idx * 4; i++) {
959 void *entry = xas_next(&xas);
961 XA_BUG_ON(xa, xas.xa_node == XAS_RESTART);
962 XA_BUG_ON(xa, xas.xa_index != i);
963 if (i == 0 || i == idx)
964 XA_BUG_ON(xa, entry != xa_mk_index(i));
966 XA_BUG_ON(xa, entry != NULL);
969 XA_BUG_ON(xa, xas.xa_index != i);
972 void *entry = xas_prev(&xas);
975 XA_BUG_ON(xa, xas.xa_node == XAS_RESTART);
976 XA_BUG_ON(xa, xas.xa_index != i);
977 if (i == 0 || i == idx)
978 XA_BUG_ON(xa, entry != xa_mk_index(i));
980 XA_BUG_ON(xa, entry != NULL);
983 xas_set(&xas, ULONG_MAX);
984 XA_BUG_ON(xa, xas_next(&xas) != NULL);
985 XA_BUG_ON(xa, xas.xa_index != ULONG_MAX);
986 XA_BUG_ON(xa, xas_next(&xas) != xa_mk_value(0));
987 XA_BUG_ON(xa, xas.xa_index != 0);
988 XA_BUG_ON(xa, xas_prev(&xas) != NULL);
989 XA_BUG_ON(xa, xas.xa_index != ULONG_MAX);
992 xa_erase_index(xa, 0);
993 xa_erase_index(xa, idx);
994 XA_BUG_ON(xa, !xa_empty(xa));
997 static noinline void check_move(struct xarray *xa)
999 XA_STATE(xas, xa, (1 << 16) - 1);
1002 for (i = 0; i < (1 << 16); i++)
1003 XA_BUG_ON(xa, xa_store_index(xa, i, GFP_KERNEL) != NULL);
1007 void *entry = xas_prev(&xas);
1009 XA_BUG_ON(xa, entry != xa_mk_index(i));
1010 XA_BUG_ON(xa, i != xas.xa_index);
1013 XA_BUG_ON(xa, xas_prev(&xas) != NULL);
1014 XA_BUG_ON(xa, xas.xa_index != ULONG_MAX);
1017 void *entry = xas_next(&xas);
1018 XA_BUG_ON(xa, entry != xa_mk_index(i));
1019 XA_BUG_ON(xa, i != xas.xa_index);
1021 } while (i < (1 << 16));
1024 for (i = (1 << 8); i < (1 << 15); i++)
1025 xa_erase_index(xa, i);
1031 void *entry = xas_prev(&xas);
1033 if ((i < (1 << 8)) || (i >= (1 << 15)))
1034 XA_BUG_ON(xa, entry != xa_mk_index(i));
1036 XA_BUG_ON(xa, entry != NULL);
1037 XA_BUG_ON(xa, i != xas.xa_index);
1040 XA_BUG_ON(xa, xas_prev(&xas) != NULL);
1041 XA_BUG_ON(xa, xas.xa_index != ULONG_MAX);
1044 void *entry = xas_next(&xas);
1045 if ((i < (1 << 8)) || (i >= (1 << 15)))
1046 XA_BUG_ON(xa, entry != xa_mk_index(i));
1048 XA_BUG_ON(xa, entry != NULL);
1049 XA_BUG_ON(xa, i != xas.xa_index);
1051 } while (i < (1 << 16));
1056 for (i = 0; i < 16; i++)
1057 check_move_small(xa, 1UL << i);
1059 for (i = 2; i < 16; i++)
1060 check_move_small(xa, (1UL << i) - 1);
1063 static noinline void xa_store_many_order(struct xarray *xa,
1064 unsigned long index, unsigned order)
1066 XA_STATE_ORDER(xas, xa, index, order);
1071 XA_BUG_ON(xa, xas_find_conflict(&xas));
1072 xas_create_range(&xas);
1073 if (xas_error(&xas))
1075 for (i = 0; i < (1U << order); i++) {
1076 XA_BUG_ON(xa, xas_store(&xas, xa_mk_index(index + i)));
1081 } while (xas_nomem(&xas, GFP_KERNEL));
1083 XA_BUG_ON(xa, xas_error(&xas));
1086 static noinline void check_create_range_1(struct xarray *xa,
1087 unsigned long index, unsigned order)
1091 xa_store_many_order(xa, index, order);
1092 for (i = index; i < index + (1UL << order); i++)
1093 xa_erase_index(xa, i);
1094 XA_BUG_ON(xa, !xa_empty(xa));
1097 static noinline void check_create_range_2(struct xarray *xa, unsigned order)
1100 unsigned long nr = 1UL << order;
1102 for (i = 0; i < nr * nr; i += nr)
1103 xa_store_many_order(xa, i, order);
1104 for (i = 0; i < nr * nr; i++)
1105 xa_erase_index(xa, i);
1106 XA_BUG_ON(xa, !xa_empty(xa));
1109 static noinline void check_create_range_3(void)
1111 XA_STATE(xas, NULL, 0);
1112 xas_set_err(&xas, -EEXIST);
1113 xas_create_range(&xas);
1114 XA_BUG_ON(NULL, xas_error(&xas) != -EEXIST);
1117 static noinline void check_create_range_4(struct xarray *xa,
1118 unsigned long index, unsigned order)
1120 XA_STATE_ORDER(xas, xa, index, order);
1121 unsigned long base = xas.xa_index;
1122 unsigned long i = 0;
1124 xa_store_index(xa, index, GFP_KERNEL);
1127 xas_create_range(&xas);
1128 if (xas_error(&xas))
1130 for (i = 0; i < (1UL << order); i++) {
1131 void *old = xas_store(&xas, xa_mk_index(base + i));
1132 if (xas.xa_index == index)
1133 XA_BUG_ON(xa, old != xa_mk_index(base + i));
1135 XA_BUG_ON(xa, old != NULL);
1140 } while (xas_nomem(&xas, GFP_KERNEL));
1142 XA_BUG_ON(xa, xas_error(&xas));
1144 for (i = base; i < base + (1UL << order); i++)
1145 xa_erase_index(xa, i);
1146 XA_BUG_ON(xa, !xa_empty(xa));
1149 static noinline void check_create_range(struct xarray *xa)
1152 unsigned int max_order = IS_ENABLED(CONFIG_XARRAY_MULTI) ? 12 : 1;
1154 for (order = 0; order < max_order; order++) {
1155 check_create_range_1(xa, 0, order);
1156 check_create_range_1(xa, 1U << order, order);
1157 check_create_range_1(xa, 2U << order, order);
1158 check_create_range_1(xa, 3U << order, order);
1159 check_create_range_1(xa, 1U << 24, order);
1161 check_create_range_2(xa, order);
1163 check_create_range_4(xa, 0, order);
1164 check_create_range_4(xa, 1U << order, order);
1165 check_create_range_4(xa, 2U << order, order);
1166 check_create_range_4(xa, 3U << order, order);
1167 check_create_range_4(xa, 1U << 24, order);
1169 check_create_range_4(xa, 1, order);
1170 check_create_range_4(xa, (1U << order) + 1, order);
1171 check_create_range_4(xa, (2U << order) + 1, order);
1172 check_create_range_4(xa, (2U << order) - 1, order);
1173 check_create_range_4(xa, (3U << order) + 1, order);
1174 check_create_range_4(xa, (3U << order) - 1, order);
1175 check_create_range_4(xa, (1U << 24) + 1, order);
1178 check_create_range_3();
1181 static noinline void __check_store_range(struct xarray *xa, unsigned long first,
1184 #ifdef CONFIG_XARRAY_MULTI
1185 xa_store_range(xa, first, last, xa_mk_index(first), GFP_KERNEL);
1187 XA_BUG_ON(xa, xa_load(xa, first) != xa_mk_index(first));
1188 XA_BUG_ON(xa, xa_load(xa, last) != xa_mk_index(first));
1189 XA_BUG_ON(xa, xa_load(xa, first - 1) != NULL);
1190 XA_BUG_ON(xa, xa_load(xa, last + 1) != NULL);
1192 xa_store_range(xa, first, last, NULL, GFP_KERNEL);
1195 XA_BUG_ON(xa, !xa_empty(xa));
1198 static noinline void check_store_range(struct xarray *xa)
1202 for (i = 0; i < 128; i++) {
1203 for (j = i; j < 128; j++) {
1204 __check_store_range(xa, i, j);
1205 __check_store_range(xa, 128 + i, 128 + j);
1206 __check_store_range(xa, 4095 + i, 4095 + j);
1207 __check_store_range(xa, 4096 + i, 4096 + j);
1208 __check_store_range(xa, 123456 + i, 123456 + j);
1209 __check_store_range(xa, (1 << 24) + i, (1 << 24) + j);
1214 static void check_align_1(struct xarray *xa, char *name)
1218 unsigned long index;
1221 for (i = 0; i < 8; i++) {
1223 XA_BUG_ON(xa, xa_alloc(xa, &id, UINT_MAX, name + i, GFP_KERNEL)
1225 XA_BUG_ON(xa, id != i);
1227 xa_for_each(xa, index, entry)
1228 XA_BUG_ON(xa, xa_is_err(entry));
1232 static noinline void check_align(struct xarray *xa)
1234 char name[] = "Motorola 68000";
1236 check_align_1(xa, name);
1237 check_align_1(xa, name + 1);
1238 check_align_1(xa, name + 2);
1239 check_align_1(xa, name + 3);
1240 // check_align_2(xa, name);
1243 static LIST_HEAD(shadow_nodes);
1245 static void test_update_node(struct xa_node *node)
1247 if (node->count && node->count == node->nr_values) {
1248 if (list_empty(&node->private_list))
1249 list_add(&shadow_nodes, &node->private_list);
1251 if (!list_empty(&node->private_list))
1252 list_del_init(&node->private_list);
1256 static noinline void shadow_remove(struct xarray *xa)
1258 struct xa_node *node;
1261 while ((node = list_first_entry_or_null(&shadow_nodes,
1262 struct xa_node, private_list))) {
1263 XA_STATE(xas, node->array, 0);
1264 XA_BUG_ON(xa, node->array != xa);
1265 list_del_init(&node->private_list);
1266 xas.xa_node = xa_parent_locked(node->array, node);
1267 xas.xa_offset = node->offset;
1268 xas.xa_shift = node->shift + XA_CHUNK_SHIFT;
1269 xas_set_update(&xas, test_update_node);
1270 xas_store(&xas, NULL);
1275 static noinline void check_workingset(struct xarray *xa, unsigned long index)
1277 XA_STATE(xas, xa, index);
1278 xas_set_update(&xas, test_update_node);
1282 xas_store(&xas, xa_mk_value(0));
1284 xas_store(&xas, xa_mk_value(1));
1286 } while (xas_nomem(&xas, GFP_KERNEL));
1288 XA_BUG_ON(xa, list_empty(&shadow_nodes));
1292 xas_store(&xas, &xas);
1293 XA_BUG_ON(xa, !list_empty(&shadow_nodes));
1295 xas_store(&xas, xa_mk_value(2));
1297 XA_BUG_ON(xa, list_empty(&shadow_nodes));
1300 XA_BUG_ON(xa, !list_empty(&shadow_nodes));
1301 XA_BUG_ON(xa, !xa_empty(xa));
1305 * Check that the pointer / value / sibling entries are accounted the
1306 * way we expect them to be.
1308 static noinline void check_account(struct xarray *xa)
1310 #ifdef CONFIG_XARRAY_MULTI
1313 for (order = 1; order < 12; order++) {
1314 XA_STATE(xas, xa, 1 << order);
1316 xa_store_order(xa, 0, order, xa, GFP_KERNEL);
1319 XA_BUG_ON(xa, xas.xa_node->count == 0);
1320 XA_BUG_ON(xa, xas.xa_node->count > (1 << order));
1321 XA_BUG_ON(xa, xas.xa_node->nr_values != 0);
1324 xa_store_order(xa, 1 << order, order, xa_mk_index(1UL << order),
1326 XA_BUG_ON(xa, xas.xa_node->count != xas.xa_node->nr_values * 2);
1328 xa_erase(xa, 1 << order);
1329 XA_BUG_ON(xa, xas.xa_node->nr_values != 0);
1332 XA_BUG_ON(xa, !xa_empty(xa));
1337 static noinline void check_destroy(struct xarray *xa)
1339 unsigned long index;
1341 XA_BUG_ON(xa, !xa_empty(xa));
1343 /* Destroying an empty array is a no-op */
1345 XA_BUG_ON(xa, !xa_empty(xa));
1347 /* Destroying an array with a single entry */
1348 for (index = 0; index < 1000; index++) {
1349 xa_store_index(xa, index, GFP_KERNEL);
1350 XA_BUG_ON(xa, xa_empty(xa));
1352 XA_BUG_ON(xa, !xa_empty(xa));
1355 /* Destroying an array with a single entry at ULONG_MAX */
1356 xa_store(xa, ULONG_MAX, xa, GFP_KERNEL);
1357 XA_BUG_ON(xa, xa_empty(xa));
1359 XA_BUG_ON(xa, !xa_empty(xa));
1361 #ifdef CONFIG_XARRAY_MULTI
1362 /* Destroying an array with a multi-index entry */
1363 xa_store_order(xa, 1 << 11, 11, xa, GFP_KERNEL);
1364 XA_BUG_ON(xa, xa_empty(xa));
1366 XA_BUG_ON(xa, !xa_empty(xa));
1370 static DEFINE_XARRAY(array);
1372 static int xarray_checks(void)
1374 check_xa_err(&array);
1375 check_xas_retry(&array);
1376 check_xa_load(&array);
1377 check_xa_mark(&array);
1378 check_xa_shrink(&array);
1379 check_xas_erase(&array);
1380 check_cmpxchg(&array);
1381 check_reserve(&array);
1382 check_multi_store(&array);
1385 check_find_entry(&array);
1386 check_account(&array);
1387 check_destroy(&array);
1389 check_create_range(&array);
1390 check_store_range(&array);
1391 check_store_iter(&array);
1394 check_workingset(&array, 0);
1395 check_workingset(&array, 64);
1396 check_workingset(&array, 4096);
1398 printk("XArray: %u of %u tests passed\n", tests_passed, tests_run);
1399 return (tests_run == tests_passed) ? 0 : -EINVAL;
1402 static void xarray_exit(void)
1406 module_init(xarray_checks);
1407 module_exit(xarray_exit);
1408 MODULE_AUTHOR("Matthew Wilcox <willy@infradead.org>");
1409 MODULE_LICENSE("GPL");