1 // SPDX-License-Identifier: MIT
3 * Copyright © 2021 Intel Corporation
6 #include <linux/kmemleak.h>
7 #include <linux/module.h>
8 #include <linux/sizes.h>
10 #include <drm/drm_buddy.h>
12 static struct kmem_cache *slab_blocks;
14 static struct drm_buddy_block *drm_block_alloc(struct drm_buddy *mm,
15 struct drm_buddy_block *parent,
19 struct drm_buddy_block *block;
21 BUG_ON(order > DRM_BUDDY_MAX_ORDER);
23 block = kmem_cache_zalloc(slab_blocks, GFP_KERNEL);
27 block->header = offset;
28 block->header |= order;
29 block->parent = parent;
31 BUG_ON(block->header & DRM_BUDDY_HEADER_UNUSED);
35 static void drm_block_free(struct drm_buddy *mm,
36 struct drm_buddy_block *block)
38 kmem_cache_free(slab_blocks, block);
41 static void list_insert_sorted(struct drm_buddy *mm,
42 struct drm_buddy_block *block)
44 struct drm_buddy_block *node;
45 struct list_head *head;
47 head = &mm->free_list[drm_buddy_block_order(block)];
48 if (list_empty(head)) {
49 list_add(&block->link, head);
53 list_for_each_entry(node, head, link)
54 if (drm_buddy_block_offset(block) < drm_buddy_block_offset(node))
57 __list_add(&block->link, node->link.prev, &node->link);
60 static void mark_allocated(struct drm_buddy_block *block)
62 block->header &= ~DRM_BUDDY_HEADER_STATE;
63 block->header |= DRM_BUDDY_ALLOCATED;
65 list_del(&block->link);
68 static void mark_free(struct drm_buddy *mm,
69 struct drm_buddy_block *block)
71 block->header &= ~DRM_BUDDY_HEADER_STATE;
72 block->header |= DRM_BUDDY_FREE;
74 list_insert_sorted(mm, block);
77 static void mark_split(struct drm_buddy_block *block)
79 block->header &= ~DRM_BUDDY_HEADER_STATE;
80 block->header |= DRM_BUDDY_SPLIT;
82 list_del(&block->link);
86 * drm_buddy_init - init memory manager
88 * @mm: DRM buddy manager to initialize
89 * @size: size in bytes to manage
90 * @chunk_size: minimum page size in bytes for our allocations
92 * Initializes the memory manager and its resources.
95 * 0 on success, error code on failure.
97 int drm_buddy_init(struct drm_buddy *mm, u64 size, u64 chunk_size)
102 if (size < chunk_size)
105 if (chunk_size < PAGE_SIZE)
108 if (!is_power_of_2(chunk_size))
111 size = round_down(size, chunk_size);
115 mm->chunk_size = chunk_size;
116 mm->max_order = ilog2(size) - ilog2(chunk_size);
118 BUG_ON(mm->max_order > DRM_BUDDY_MAX_ORDER);
120 mm->free_list = kmalloc_array(mm->max_order + 1,
121 sizeof(struct list_head),
126 for (i = 0; i <= mm->max_order; ++i)
127 INIT_LIST_HEAD(&mm->free_list[i]);
129 mm->n_roots = hweight64(size);
131 mm->roots = kmalloc_array(mm->n_roots,
132 sizeof(struct drm_buddy_block *),
141 * Split into power-of-two blocks, in case we are given a size that is
142 * not itself a power-of-two.
145 struct drm_buddy_block *root;
149 order = ilog2(size) - ilog2(chunk_size);
150 root_size = chunk_size << order;
152 root = drm_block_alloc(mm, NULL, order, offset);
158 BUG_ON(i > mm->max_order);
159 BUG_ON(drm_buddy_block_size(mm, root) < chunk_size);
172 drm_block_free(mm, mm->roots[i]);
175 kfree(mm->free_list);
178 EXPORT_SYMBOL(drm_buddy_init);
181 * drm_buddy_fini - tear down the memory manager
183 * @mm: DRM buddy manager to free
185 * Cleanup memory manager resources and the freelist
187 void drm_buddy_fini(struct drm_buddy *mm)
191 for (i = 0; i < mm->n_roots; ++i) {
192 WARN_ON(!drm_buddy_block_is_free(mm->roots[i]));
193 drm_block_free(mm, mm->roots[i]);
196 WARN_ON(mm->avail != mm->size);
199 kfree(mm->free_list);
201 EXPORT_SYMBOL(drm_buddy_fini);
203 static int split_block(struct drm_buddy *mm,
204 struct drm_buddy_block *block)
206 unsigned int block_order = drm_buddy_block_order(block) - 1;
207 u64 offset = drm_buddy_block_offset(block);
209 BUG_ON(!drm_buddy_block_is_free(block));
210 BUG_ON(!drm_buddy_block_order(block));
212 block->left = drm_block_alloc(mm, block, block_order, offset);
216 block->right = drm_block_alloc(mm, block, block_order,
217 offset + (mm->chunk_size << block_order));
219 drm_block_free(mm, block->left);
223 mark_free(mm, block->left);
224 mark_free(mm, block->right);
231 static struct drm_buddy_block *
232 __get_buddy(struct drm_buddy_block *block)
234 struct drm_buddy_block *parent;
236 parent = block->parent;
240 if (parent->left == block)
241 return parent->right;
247 * drm_get_buddy - get buddy address
249 * @block: DRM buddy block
251 * Returns the corresponding buddy block for @block, or NULL
252 * if this is a root block and can't be merged further.
253 * Requires some kind of locking to protect against
254 * any concurrent allocate and free operations.
256 struct drm_buddy_block *
257 drm_get_buddy(struct drm_buddy_block *block)
259 return __get_buddy(block);
261 EXPORT_SYMBOL(drm_get_buddy);
263 static void __drm_buddy_free(struct drm_buddy *mm,
264 struct drm_buddy_block *block)
266 struct drm_buddy_block *parent;
268 while ((parent = block->parent)) {
269 struct drm_buddy_block *buddy;
271 buddy = __get_buddy(block);
273 if (!drm_buddy_block_is_free(buddy))
276 list_del(&buddy->link);
278 drm_block_free(mm, block);
279 drm_block_free(mm, buddy);
284 mark_free(mm, block);
288 * drm_buddy_free_block - free a block
290 * @mm: DRM buddy manager
291 * @block: block to be freed
293 void drm_buddy_free_block(struct drm_buddy *mm,
294 struct drm_buddy_block *block)
296 BUG_ON(!drm_buddy_block_is_allocated(block));
297 mm->avail += drm_buddy_block_size(mm, block);
298 __drm_buddy_free(mm, block);
300 EXPORT_SYMBOL(drm_buddy_free_block);
303 * drm_buddy_free_list - free blocks
305 * @mm: DRM buddy manager
306 * @objects: input list head to free blocks
308 void drm_buddy_free_list(struct drm_buddy *mm, struct list_head *objects)
310 struct drm_buddy_block *block, *on;
312 list_for_each_entry_safe(block, on, objects, link) {
313 drm_buddy_free_block(mm, block);
316 INIT_LIST_HEAD(objects);
318 EXPORT_SYMBOL(drm_buddy_free_list);
320 static inline bool overlaps(u64 s1, u64 e1, u64 s2, u64 e2)
322 return s1 <= e2 && e1 >= s2;
325 static inline bool contains(u64 s1, u64 e1, u64 s2, u64 e2)
327 return s1 <= s2 && e1 >= e2;
330 static struct drm_buddy_block *
331 alloc_range_bias(struct drm_buddy *mm,
335 u64 req_size = mm->chunk_size << order;
336 struct drm_buddy_block *block;
337 struct drm_buddy_block *buddy;
344 for (i = 0; i < mm->n_roots; ++i)
345 list_add_tail(&mm->roots[i]->tmp_link, &dfs);
351 block = list_first_entry_or_null(&dfs,
352 struct drm_buddy_block,
357 list_del(&block->tmp_link);
359 if (drm_buddy_block_order(block) < order)
362 block_start = drm_buddy_block_offset(block);
363 block_end = block_start + drm_buddy_block_size(mm, block) - 1;
365 if (!overlaps(start, end, block_start, block_end))
368 if (drm_buddy_block_is_allocated(block))
371 if (block_start < start || block_end > end) {
372 u64 adjusted_start = max(block_start, start);
373 u64 adjusted_end = min(block_end, end);
375 if (round_down(adjusted_end + 1, req_size) <=
376 round_up(adjusted_start, req_size))
380 if (contains(start, end, block_start, block_end) &&
381 order == drm_buddy_block_order(block)) {
383 * Find the free block within the range.
385 if (drm_buddy_block_is_free(block))
391 if (!drm_buddy_block_is_split(block)) {
392 err = split_block(mm, block);
397 list_add(&block->right->tmp_link, &dfs);
398 list_add(&block->left->tmp_link, &dfs);
401 return ERR_PTR(-ENOSPC);
405 * We really don't want to leave around a bunch of split blocks, since
406 * bigger is better, so make sure we merge everything back before we
407 * free the allocated blocks.
409 buddy = __get_buddy(block);
411 (drm_buddy_block_is_free(block) &&
412 drm_buddy_block_is_free(buddy)))
413 __drm_buddy_free(mm, block);
417 static struct drm_buddy_block *
418 get_maxblock(struct drm_buddy *mm, unsigned int order)
420 struct drm_buddy_block *max_block = NULL, *node;
423 for (i = order; i <= mm->max_order; ++i) {
424 if (!list_empty(&mm->free_list[i])) {
425 node = list_last_entry(&mm->free_list[i],
426 struct drm_buddy_block,
433 if (drm_buddy_block_offset(node) >
434 drm_buddy_block_offset(max_block)) {
443 static struct drm_buddy_block *
444 alloc_from_freelist(struct drm_buddy *mm,
448 struct drm_buddy_block *block = NULL;
452 if (flags & DRM_BUDDY_TOPDOWN_ALLOCATION) {
453 block = get_maxblock(mm, order);
455 /* Store the obtained block order */
456 tmp = drm_buddy_block_order(block);
458 for (tmp = order; tmp <= mm->max_order; ++tmp) {
459 if (!list_empty(&mm->free_list[tmp])) {
460 block = list_last_entry(&mm->free_list[tmp],
461 struct drm_buddy_block,
470 return ERR_PTR(-ENOSPC);
472 BUG_ON(!drm_buddy_block_is_free(block));
474 while (tmp != order) {
475 err = split_block(mm, block);
479 block = block->right;
486 __drm_buddy_free(mm, block);
490 static int __alloc_range(struct drm_buddy *mm,
491 struct list_head *dfs,
493 struct list_head *blocks,
494 u64 *total_allocated_on_err)
496 struct drm_buddy_block *block;
497 struct drm_buddy_block *buddy;
498 u64 total_allocated = 0;
499 LIST_HEAD(allocated);
503 end = start + size - 1;
509 block = list_first_entry_or_null(dfs,
510 struct drm_buddy_block,
515 list_del(&block->tmp_link);
517 block_start = drm_buddy_block_offset(block);
518 block_end = block_start + drm_buddy_block_size(mm, block) - 1;
520 if (!overlaps(start, end, block_start, block_end))
523 if (drm_buddy_block_is_allocated(block)) {
528 if (contains(start, end, block_start, block_end)) {
529 if (!drm_buddy_block_is_free(block)) {
534 mark_allocated(block);
535 total_allocated += drm_buddy_block_size(mm, block);
536 mm->avail -= drm_buddy_block_size(mm, block);
537 list_add_tail(&block->link, &allocated);
541 if (!drm_buddy_block_is_split(block)) {
542 err = split_block(mm, block);
547 list_add(&block->right->tmp_link, dfs);
548 list_add(&block->left->tmp_link, dfs);
551 if (total_allocated < size) {
556 list_splice_tail(&allocated, blocks);
562 * We really don't want to leave around a bunch of split blocks, since
563 * bigger is better, so make sure we merge everything back before we
564 * free the allocated blocks.
566 buddy = __get_buddy(block);
568 (drm_buddy_block_is_free(block) &&
569 drm_buddy_block_is_free(buddy)))
570 __drm_buddy_free(mm, block);
573 if (err == -ENOSPC && total_allocated_on_err) {
574 list_splice_tail(&allocated, blocks);
575 *total_allocated_on_err = total_allocated;
577 drm_buddy_free_list(mm, &allocated);
583 static int __drm_buddy_alloc_range(struct drm_buddy *mm,
586 u64 *total_allocated_on_err,
587 struct list_head *blocks)
592 for (i = 0; i < mm->n_roots; ++i)
593 list_add_tail(&mm->roots[i]->tmp_link, &dfs);
595 return __alloc_range(mm, &dfs, start, size,
596 blocks, total_allocated_on_err);
599 static int __alloc_contig_try_harder(struct drm_buddy *mm,
602 struct list_head *blocks)
604 u64 rhs_offset, lhs_offset, lhs_size, filled;
605 struct drm_buddy_block *block;
606 struct list_head *list;
607 LIST_HEAD(blocks_lhs);
613 modify_size = rounddown_pow_of_two(size);
614 pages = modify_size >> ilog2(mm->chunk_size);
615 order = fls(pages) - 1;
619 list = &mm->free_list[order];
620 if (list_empty(list))
623 list_for_each_entry_reverse(block, list, link) {
624 /* Allocate blocks traversing RHS */
625 rhs_offset = drm_buddy_block_offset(block);
626 err = __drm_buddy_alloc_range(mm, rhs_offset, size,
628 if (!err || err != -ENOSPC)
631 lhs_size = max((size - filled), min_block_size);
632 if (!IS_ALIGNED(lhs_size, min_block_size))
633 lhs_size = round_up(lhs_size, min_block_size);
635 /* Allocate blocks traversing LHS */
636 lhs_offset = drm_buddy_block_offset(block) - lhs_size;
637 err = __drm_buddy_alloc_range(mm, lhs_offset, lhs_size,
640 list_splice(&blocks_lhs, blocks);
642 } else if (err != -ENOSPC) {
643 drm_buddy_free_list(mm, blocks);
646 /* Free blocks for the next iteration */
647 drm_buddy_free_list(mm, blocks);
654 * drm_buddy_block_trim - free unused pages
656 * @mm: DRM buddy manager
657 * @new_size: original size requested
658 * @blocks: Input and output list of allocated blocks.
659 * MUST contain single block as input to be trimmed.
660 * On success will contain the newly allocated blocks
661 * making up the @new_size. Blocks always appear in
664 * For contiguous allocation, we round up the size to the nearest
665 * power of two value, drivers consume *actual* size, so remaining
666 * portions are unused and can be optionally freed with this function
669 * 0 on success, error code on failure.
671 int drm_buddy_block_trim(struct drm_buddy *mm,
673 struct list_head *blocks)
675 struct drm_buddy_block *parent;
676 struct drm_buddy_block *block;
681 if (!list_is_singular(blocks))
684 block = list_first_entry(blocks,
685 struct drm_buddy_block,
688 if (WARN_ON(!drm_buddy_block_is_allocated(block)))
691 if (new_size > drm_buddy_block_size(mm, block))
694 if (!new_size || !IS_ALIGNED(new_size, mm->chunk_size))
697 if (new_size == drm_buddy_block_size(mm, block))
700 list_del(&block->link);
701 mark_free(mm, block);
702 mm->avail += drm_buddy_block_size(mm, block);
704 /* Prevent recursively freeing this node */
705 parent = block->parent;
706 block->parent = NULL;
708 new_start = drm_buddy_block_offset(block);
709 list_add(&block->tmp_link, &dfs);
710 err = __alloc_range(mm, &dfs, new_start, new_size, blocks, NULL);
712 mark_allocated(block);
713 mm->avail -= drm_buddy_block_size(mm, block);
714 list_add(&block->link, blocks);
717 block->parent = parent;
720 EXPORT_SYMBOL(drm_buddy_block_trim);
723 * drm_buddy_alloc_blocks - allocate power-of-two blocks
725 * @mm: DRM buddy manager to allocate from
726 * @start: start of the allowed range for this block
727 * @end: end of the allowed range for this block
728 * @size: size of the allocation
729 * @min_block_size: alignment of the allocation
730 * @blocks: output list head to add allocated blocks
731 * @flags: DRM_BUDDY_*_ALLOCATION flags
733 * alloc_range_bias() called on range limitations, which traverses
734 * the tree and returns the desired block.
736 * alloc_from_freelist() called when *no* range restrictions
737 * are enforced, which picks the block from the freelist.
740 * 0 on success, error code on failure.
742 int drm_buddy_alloc_blocks(struct drm_buddy *mm,
743 u64 start, u64 end, u64 size,
745 struct list_head *blocks,
748 struct drm_buddy_block *block = NULL;
749 u64 original_size, original_min_size;
750 unsigned int min_order, order;
751 LIST_HEAD(allocated);
755 if (size < mm->chunk_size)
758 if (min_block_size < mm->chunk_size)
761 if (!is_power_of_2(min_block_size))
764 if (!IS_ALIGNED(start | end | size, mm->chunk_size))
770 if (range_overflows(start, size, mm->size))
773 /* Actual range allocation */
774 if (start + size == end) {
775 if (!IS_ALIGNED(start | end, min_block_size))
778 return __drm_buddy_alloc_range(mm, start, size, NULL, blocks);
781 original_size = size;
782 original_min_size = min_block_size;
784 /* Roundup the size to power of 2 */
785 if (flags & DRM_BUDDY_CONTIGUOUS_ALLOCATION) {
786 size = roundup_pow_of_two(size);
787 min_block_size = size;
788 /* Align size value to min_block_size */
789 } else if (!IS_ALIGNED(size, min_block_size)) {
790 size = round_up(size, min_block_size);
793 pages = size >> ilog2(mm->chunk_size);
794 order = fls(pages) - 1;
795 min_order = ilog2(min_block_size) - ilog2(mm->chunk_size);
798 order = min(order, (unsigned int)fls(pages) - 1);
799 BUG_ON(order > mm->max_order);
800 BUG_ON(order < min_order);
803 if (flags & DRM_BUDDY_RANGE_ALLOCATION)
804 /* Allocate traversing within the range */
805 block = alloc_range_bias(mm, start, end, order);
807 /* Allocate from freelist */
808 block = alloc_from_freelist(mm, order, flags);
813 if (order-- == min_order) {
814 if (flags & DRM_BUDDY_CONTIGUOUS_ALLOCATION &&
815 !(flags & DRM_BUDDY_RANGE_ALLOCATION))
817 * Try contiguous block allocation through
820 return __alloc_contig_try_harder(mm,
829 mark_allocated(block);
830 mm->avail -= drm_buddy_block_size(mm, block);
831 kmemleak_update_trace(block);
832 list_add_tail(&block->link, &allocated);
840 /* Trim the allocated block to the required size */
841 if (original_size != size) {
842 struct list_head *trim_list;
846 trim_list = &allocated;
847 trim_size = original_size;
849 if (!list_is_singular(&allocated)) {
850 block = list_last_entry(&allocated, typeof(*block), link);
851 list_move(&block->link, &temp);
853 trim_size = drm_buddy_block_size(mm, block) -
854 (size - original_size);
857 drm_buddy_block_trim(mm,
861 if (!list_empty(&temp))
862 list_splice_tail(trim_list, &allocated);
865 list_splice_tail(&allocated, blocks);
869 drm_buddy_free_list(mm, &allocated);
872 EXPORT_SYMBOL(drm_buddy_alloc_blocks);
875 * drm_buddy_block_print - print block information
877 * @mm: DRM buddy manager
878 * @block: DRM buddy block
879 * @p: DRM printer to use
881 void drm_buddy_block_print(struct drm_buddy *mm,
882 struct drm_buddy_block *block,
883 struct drm_printer *p)
885 u64 start = drm_buddy_block_offset(block);
886 u64 size = drm_buddy_block_size(mm, block);
888 drm_printf(p, "%#018llx-%#018llx: %llu\n", start, start + size, size);
890 EXPORT_SYMBOL(drm_buddy_block_print);
893 * drm_buddy_print - print allocator state
895 * @mm: DRM buddy manager
896 * @p: DRM printer to use
898 void drm_buddy_print(struct drm_buddy *mm, struct drm_printer *p)
902 drm_printf(p, "chunk_size: %lluKiB, total: %lluMiB, free: %lluMiB\n",
903 mm->chunk_size >> 10, mm->size >> 20, mm->avail >> 20);
905 for (order = mm->max_order; order >= 0; order--) {
906 struct drm_buddy_block *block;
909 list_for_each_entry(block, &mm->free_list[order], link) {
910 BUG_ON(!drm_buddy_block_is_free(block));
914 drm_printf(p, "order-%2d ", order);
916 free = count * (mm->chunk_size << order);
918 drm_printf(p, "free: %8llu KiB", free >> 10);
920 drm_printf(p, "free: %8llu MiB", free >> 20);
922 drm_printf(p, ", blocks: %llu\n", count);
925 EXPORT_SYMBOL(drm_buddy_print);
927 static void drm_buddy_module_exit(void)
929 kmem_cache_destroy(slab_blocks);
932 static int __init drm_buddy_module_init(void)
934 slab_blocks = KMEM_CACHE(drm_buddy_block, 0);
941 module_init(drm_buddy_module_init);
942 module_exit(drm_buddy_module_exit);
944 MODULE_DESCRIPTION("DRM Buddy Allocator");
945 MODULE_LICENSE("Dual MIT/GPL");