1 // SPDX-License-Identifier: MIT
3 * Copyright © 2019 Intel Corporation
6 #define pr_fmt(fmt) "drm_buddy: " fmt
8 #include <linux/module.h>
9 #include <linux/prime_numbers.h>
10 #include <linux/sched/signal.h>
12 #include <drm/drm_buddy.h>
14 #include "../lib/drm_random.h"
16 #define TESTS "drm_buddy_selftests.h"
17 #include "drm_selftest.h"
19 #define IGT_TIMEOUT(name__) \
20 unsigned long name__ = jiffies + MAX_SCHEDULE_TIMEOUT
22 static unsigned int random_seed;
24 static inline u64 get_size(int order, u64 chunk_size)
26 return (1 << order) * chunk_size;
30 static bool __igt_timeout(unsigned long timeout, const char *fmt, ...)
34 if (!signal_pending(current)) {
36 if (time_before(jiffies, timeout))
49 static inline const char *yesno(bool v)
51 return v ? "yes" : "no";
54 static void __igt_dump_block(struct drm_buddy *mm,
55 struct drm_buddy_block *block,
58 pr_err("block info: header=%llx, state=%u, order=%d, offset=%llx size=%llx root=%s buddy=%s\n",
60 drm_buddy_block_state(block),
61 drm_buddy_block_order(block),
62 drm_buddy_block_offset(block),
63 drm_buddy_block_size(mm, block),
64 yesno(!block->parent),
68 static void igt_dump_block(struct drm_buddy *mm,
69 struct drm_buddy_block *block)
71 struct drm_buddy_block *buddy;
73 __igt_dump_block(mm, block, false);
75 buddy = drm_get_buddy(block);
77 __igt_dump_block(mm, buddy, true);
80 static int igt_check_block(struct drm_buddy *mm,
81 struct drm_buddy_block *block)
83 struct drm_buddy_block *buddy;
84 unsigned int block_state;
89 block_state = drm_buddy_block_state(block);
91 if (block_state != DRM_BUDDY_ALLOCATED &&
92 block_state != DRM_BUDDY_FREE &&
93 block_state != DRM_BUDDY_SPLIT) {
94 pr_err("block state mismatch\n");
98 block_size = drm_buddy_block_size(mm, block);
99 offset = drm_buddy_block_offset(block);
101 if (block_size < mm->chunk_size) {
102 pr_err("block size smaller than min size\n");
106 if (!is_power_of_2(block_size)) {
107 pr_err("block size not power of two\n");
111 if (!IS_ALIGNED(block_size, mm->chunk_size)) {
112 pr_err("block size not aligned to min size\n");
116 if (!IS_ALIGNED(offset, mm->chunk_size)) {
117 pr_err("block offset not aligned to min size\n");
121 if (!IS_ALIGNED(offset, block_size)) {
122 pr_err("block offset not aligned to block size\n");
126 buddy = drm_get_buddy(block);
128 if (!buddy && block->parent) {
129 pr_err("buddy has gone fishing\n");
134 if (drm_buddy_block_offset(buddy) != (offset ^ block_size)) {
135 pr_err("buddy has wrong offset\n");
139 if (drm_buddy_block_size(mm, buddy) != block_size) {
140 pr_err("buddy size mismatch\n");
144 if (drm_buddy_block_state(buddy) == block_state &&
145 block_state == DRM_BUDDY_FREE) {
146 pr_err("block and its buddy are free\n");
154 static int igt_check_blocks(struct drm_buddy *mm,
155 struct list_head *blocks,
159 struct drm_buddy_block *block;
160 struct drm_buddy_block *prev;
168 list_for_each_entry(block, blocks, link) {
169 err = igt_check_block(mm, block);
171 if (!drm_buddy_block_is_allocated(block)) {
172 pr_err("block not allocated\n"),
176 if (is_contiguous && prev) {
181 prev_offset = drm_buddy_block_offset(prev);
182 prev_block_size = drm_buddy_block_size(mm, prev);
183 offset = drm_buddy_block_offset(block);
185 if (offset != (prev_offset + prev_block_size)) {
186 pr_err("block offset mismatch\n");
194 total += drm_buddy_block_size(mm, block);
199 if (total != expected_size) {
200 pr_err("size mismatch, expected=%llx, found=%llx\n",
201 expected_size, total);
208 pr_err("prev block, dump:\n");
209 igt_dump_block(mm, prev);
212 pr_err("bad block, dump:\n");
213 igt_dump_block(mm, block);
218 static int igt_check_mm(struct drm_buddy *mm)
220 struct drm_buddy_block *root;
221 struct drm_buddy_block *prev;
227 pr_err("n_roots is zero\n");
231 if (mm->n_roots != hweight64(mm->size)) {
232 pr_err("n_roots mismatch, n_roots=%u, expected=%lu\n",
233 mm->n_roots, hweight64(mm->size));
241 for (i = 0; i < mm->n_roots; ++i) {
242 struct drm_buddy_block *block;
247 pr_err("root(%u) is NULL\n", i);
252 err = igt_check_block(mm, root);
254 if (!drm_buddy_block_is_free(root)) {
255 pr_err("root not free\n");
259 order = drm_buddy_block_order(root);
262 if (order != mm->max_order) {
263 pr_err("max order root missing\n");
273 prev_offset = drm_buddy_block_offset(prev);
274 prev_block_size = drm_buddy_block_size(mm, prev);
275 offset = drm_buddy_block_offset(root);
277 if (offset != (prev_offset + prev_block_size)) {
278 pr_err("root offset mismatch\n");
283 block = list_first_entry_or_null(&mm->free_list[order],
284 struct drm_buddy_block,
287 pr_err("root mismatch at order=%u\n", order);
295 total += drm_buddy_block_size(mm, root);
299 if (total != mm->size) {
300 pr_err("expected mm size=%llx, found=%llx\n", mm->size,
308 pr_err("prev root(%u), dump:\n", i - 1);
309 igt_dump_block(mm, prev);
313 pr_err("bad root(%u), dump:\n", i);
314 igt_dump_block(mm, root);
320 static void igt_mm_config(u64 *size, u64 *chunk_size)
322 DRM_RND_STATE(prng, random_seed);
325 /* Nothing fancy, just try to get an interesting bit pattern */
327 prandom_seed_state(&prng, random_seed);
329 /* Let size be a random number of pages up to 8 GB (2M pages) */
330 s = 1 + drm_prandom_u32_max_state((BIT(33 - 12)) - 1, &prng);
331 /* Let the chunk size be a random power of 2 less than size */
332 ms = BIT(drm_prandom_u32_max_state(ilog2(s), &prng));
333 /* Round size down to the chunk size */
336 /* Convert from pages to bytes */
337 *chunk_size = (u64)ms << 12;
338 *size = (u64)s << 12;
341 static int igt_buddy_alloc_pathological(void *arg)
343 u64 mm_size, size, min_page_size, start = 0;
344 struct drm_buddy_block *block;
345 const int max_order = 3;
346 unsigned long flags = 0;
354 * Create a pot-sized mm, then allocate one of each possible
355 * order within. This should leave the mm with exactly one
356 * page left. Free the largest block, then whittle down again.
357 * Eventually we will have a fully 50% fragmented mm.
360 mm_size = PAGE_SIZE << max_order;
361 err = drm_buddy_init(&mm, mm_size, PAGE_SIZE);
363 pr_err("buddy_init failed(%d)\n", err);
366 BUG_ON(mm.max_order != max_order);
368 for (top = max_order; top; top--) {
369 /* Make room by freeing the largest allocated block */
370 block = list_first_entry_or_null(&blocks, typeof(*block), link);
372 list_del(&block->link);
373 drm_buddy_free_block(&mm, block);
376 for (order = top; order--; ) {
377 size = min_page_size = get_size(order, PAGE_SIZE);
378 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size,
379 min_page_size, &tmp, flags);
381 pr_info("buddy_alloc hit -ENOMEM with order=%d, top=%d\n",
386 block = list_first_entry_or_null(&tmp,
387 struct drm_buddy_block,
390 pr_err("alloc_blocks has no blocks\n");
395 list_move_tail(&block->link, &blocks);
398 /* There should be one final page for this sub-allocation */
399 size = min_page_size = get_size(0, PAGE_SIZE);
400 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
402 pr_info("buddy_alloc hit -ENOMEM for hole\n");
406 block = list_first_entry_or_null(&tmp,
407 struct drm_buddy_block,
410 pr_err("alloc_blocks has no blocks\n");
415 list_move_tail(&block->link, &holes);
417 size = min_page_size = get_size(top, PAGE_SIZE);
418 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
420 pr_info("buddy_alloc unexpectedly succeeded at top-order %d/%d, it should be full!",
422 block = list_first_entry_or_null(&tmp,
423 struct drm_buddy_block,
426 pr_err("alloc_blocks has no blocks\n");
431 list_move_tail(&block->link, &blocks);
437 drm_buddy_free_list(&mm, &holes);
439 /* Nothing larger than blocks of chunk_size now available */
440 for (order = 1; order <= max_order; order++) {
441 size = min_page_size = get_size(order, PAGE_SIZE);
442 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
444 pr_info("buddy_alloc unexpectedly succeeded at order %d, it should be full!",
446 block = list_first_entry_or_null(&tmp,
447 struct drm_buddy_block,
450 pr_err("alloc_blocks has no blocks\n");
455 list_move_tail(&block->link, &blocks);
465 list_splice_tail(&holes, &blocks);
466 drm_buddy_free_list(&mm, &blocks);
471 static int igt_buddy_alloc_smoke(void *arg)
473 u64 mm_size, min_page_size, chunk_size, start = 0;
474 unsigned long flags = 0;
479 DRM_RND_STATE(prng, random_seed);
480 IGT_TIMEOUT(end_time);
482 igt_mm_config(&mm_size, &chunk_size);
484 err = drm_buddy_init(&mm, mm_size, chunk_size);
486 pr_err("buddy_init failed(%d)\n", err);
490 order = drm_random_order(mm.max_order + 1, &prng);
496 for (i = 0; i <= mm.max_order; ++i) {
497 struct drm_buddy_block *block;
498 int max_order = order[i];
499 bool timeout = false;
505 err = igt_check_mm(&mm);
507 pr_err("pre-mm check failed, abort\n");
516 size = min_page_size = get_size(order, chunk_size);
517 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size,
518 min_page_size, &tmp, flags);
520 if (err == -ENOMEM) {
521 pr_info("buddy_alloc hit -ENOMEM with order=%d\n",
529 pr_err("buddy_alloc with order=%d failed(%d)\n",
536 block = list_first_entry_or_null(&tmp,
537 struct drm_buddy_block,
540 pr_err("alloc_blocks has no blocks\n");
545 list_move_tail(&block->link, &blocks);
547 if (drm_buddy_block_order(block) != order) {
548 pr_err("buddy_alloc order mismatch\n");
553 total += drm_buddy_block_size(&mm, block);
555 if (__igt_timeout(end_time, NULL)) {
559 } while (total < mm.size);
562 err = igt_check_blocks(&mm, &blocks, total, false);
564 drm_buddy_free_list(&mm, &blocks);
567 err = igt_check_mm(&mm);
569 pr_err("post-mm check failed\n");
588 static int igt_buddy_alloc_pessimistic(void *arg)
590 u64 mm_size, size, min_page_size, start = 0;
591 struct drm_buddy_block *block, *bn;
592 const unsigned int max_order = 16;
593 unsigned long flags = 0;
601 * Create a pot-sized mm, then allocate one of each possible
602 * order within. This should leave the mm with exactly one
606 mm_size = PAGE_SIZE << max_order;
607 err = drm_buddy_init(&mm, mm_size, PAGE_SIZE);
609 pr_err("buddy_init failed(%d)\n", err);
612 BUG_ON(mm.max_order != max_order);
614 for (order = 0; order < max_order; order++) {
615 size = min_page_size = get_size(order, PAGE_SIZE);
616 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
618 pr_info("buddy_alloc hit -ENOMEM with order=%d\n",
623 block = list_first_entry_or_null(&tmp,
624 struct drm_buddy_block,
627 pr_err("alloc_blocks has no blocks\n");
632 list_move_tail(&block->link, &blocks);
635 /* And now the last remaining block available */
636 size = min_page_size = get_size(0, PAGE_SIZE);
637 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
639 pr_info("buddy_alloc hit -ENOMEM on final alloc\n");
643 block = list_first_entry_or_null(&tmp,
644 struct drm_buddy_block,
647 pr_err("alloc_blocks has no blocks\n");
652 list_move_tail(&block->link, &blocks);
654 /* Should be completely full! */
655 for (order = max_order; order--; ) {
656 size = min_page_size = get_size(order, PAGE_SIZE);
657 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
659 pr_info("buddy_alloc unexpectedly succeeded at order %d, it should be full!",
661 block = list_first_entry_or_null(&tmp,
662 struct drm_buddy_block,
665 pr_err("alloc_blocks has no blocks\n");
670 list_move_tail(&block->link, &blocks);
676 block = list_last_entry(&blocks, typeof(*block), link);
677 list_del(&block->link);
678 drm_buddy_free_block(&mm, block);
680 /* As we free in increasing size, we make available larger blocks */
682 list_for_each_entry_safe(block, bn, &blocks, link) {
683 list_del(&block->link);
684 drm_buddy_free_block(&mm, block);
686 size = min_page_size = get_size(order, PAGE_SIZE);
687 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
689 pr_info("buddy_alloc (realloc) hit -ENOMEM with order=%d\n",
694 block = list_first_entry_or_null(&tmp,
695 struct drm_buddy_block,
698 pr_err("alloc_blocks has no blocks\n");
703 list_del(&block->link);
704 drm_buddy_free_block(&mm, block);
708 /* To confirm, now the whole mm should be available */
709 size = min_page_size = get_size(max_order, PAGE_SIZE);
710 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
712 pr_info("buddy_alloc (realloc) hit -ENOMEM with order=%d\n",
717 block = list_first_entry_or_null(&tmp,
718 struct drm_buddy_block,
721 pr_err("alloc_blocks has no blocks\n");
726 list_del(&block->link);
727 drm_buddy_free_block(&mm, block);
730 drm_buddy_free_list(&mm, &blocks);
735 static int igt_buddy_alloc_optimistic(void *arg)
737 u64 mm_size, size, min_page_size, start = 0;
738 struct drm_buddy_block *block;
739 unsigned long flags = 0;
740 const int max_order = 16;
747 * Create a mm with one block of each order available, and
748 * try to allocate them all.
751 mm_size = PAGE_SIZE * ((1 << (max_order + 1)) - 1);
752 err = drm_buddy_init(&mm,
756 pr_err("buddy_init failed(%d)\n", err);
760 BUG_ON(mm.max_order != max_order);
762 for (order = 0; order <= max_order; order++) {
763 size = min_page_size = get_size(order, PAGE_SIZE);
764 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
766 pr_info("buddy_alloc hit -ENOMEM with order=%d\n",
771 block = list_first_entry_or_null(&tmp,
772 struct drm_buddy_block,
775 pr_err("alloc_blocks has no blocks\n");
780 list_move_tail(&block->link, &blocks);
783 /* Should be completely full! */
784 size = min_page_size = get_size(0, PAGE_SIZE);
785 err = drm_buddy_alloc_blocks(&mm, start, mm_size, size, min_page_size, &tmp, flags);
787 pr_info("buddy_alloc unexpectedly succeeded, it should be full!");
788 block = list_first_entry_or_null(&tmp,
789 struct drm_buddy_block,
792 pr_err("alloc_blocks has no blocks\n");
797 list_move_tail(&block->link, &blocks);
805 drm_buddy_free_list(&mm, &blocks);
810 static int igt_buddy_alloc_range(void *arg)
812 unsigned long flags = DRM_BUDDY_RANGE_ALLOCATION;
813 u64 offset, size, rem, chunk_size, end;
814 unsigned long page_num;
819 igt_mm_config(&size, &chunk_size);
821 err = drm_buddy_init(&mm, size, chunk_size);
823 pr_err("buddy_init failed(%d)\n", err);
827 err = igt_check_mm(&mm);
829 pr_err("pre-mm check failed, abort, abort, abort!\n");
836 for_each_prime_number_from(page_num, 1, ULONG_MAX - 1) {
837 struct drm_buddy_block *block;
840 size = min(page_num * mm.chunk_size, rem);
843 err = drm_buddy_alloc_blocks(&mm, offset, end, size, mm.chunk_size, &tmp, flags);
845 if (err == -ENOMEM) {
846 pr_info("alloc_range hit -ENOMEM with size=%llx\n",
849 pr_err("alloc_range with offset=%llx, size=%llx failed(%d)\n",
856 block = list_first_entry_or_null(&tmp,
857 struct drm_buddy_block,
860 pr_err("alloc_range has no blocks\n");
865 if (drm_buddy_block_offset(block) != offset) {
866 pr_err("alloc_range start offset mismatch, found=%llx, expected=%llx\n",
867 drm_buddy_block_offset(block), offset);
872 err = igt_check_blocks(&mm, &tmp, size, true);
874 list_splice_tail(&tmp, &blocks);
891 drm_buddy_free_list(&mm, &blocks);
894 err = igt_check_mm(&mm);
896 pr_err("post-mm check failed\n");
905 static int igt_buddy_alloc_limit(void *arg)
907 u64 size = U64_MAX, start = 0;
908 struct drm_buddy_block *block;
909 unsigned long flags = 0;
910 LIST_HEAD(allocated);
914 err = drm_buddy_init(&mm, size, PAGE_SIZE);
918 if (mm.max_order != DRM_BUDDY_MAX_ORDER) {
919 pr_err("mm.max_order(%d) != %d\n",
920 mm.max_order, DRM_BUDDY_MAX_ORDER);
925 size = mm.chunk_size << mm.max_order;
926 err = drm_buddy_alloc_blocks(&mm, start, size, size,
927 PAGE_SIZE, &allocated, flags);
932 block = list_first_entry_or_null(&allocated,
933 struct drm_buddy_block,
941 if (drm_buddy_block_order(block) != mm.max_order) {
942 pr_err("block order(%d) != %d\n",
943 drm_buddy_block_order(block), mm.max_order);
948 if (drm_buddy_block_size(&mm, block) !=
949 BIT_ULL(mm.max_order) * PAGE_SIZE) {
950 pr_err("block size(%llu) != %llu\n",
951 drm_buddy_block_size(&mm, block),
952 BIT_ULL(mm.max_order) * PAGE_SIZE);
958 drm_buddy_free_list(&mm, &allocated);
964 static int igt_sanitycheck(void *ignored)
966 pr_info("%s - ok!\n", __func__);
970 #include "drm_selftest.c"
972 static int __init test_drm_buddy_init(void)
977 random_seed = get_random_int();
979 pr_info("Testing DRM buddy manager (struct drm_buddy), with random_seed=0x%x\n",
981 err = run_selftests(selftests, ARRAY_SIZE(selftests), NULL);
983 return err > 0 ? 0 : err;
986 static void __exit test_drm_buddy_exit(void)
990 module_init(test_drm_buddy_init);
991 module_exit(test_drm_buddy_exit);
993 MODULE_AUTHOR("Intel Corporation");
994 MODULE_LICENSE("GPL");