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 mark_allocated(struct drm_buddy_block *block)
43 block->header &= ~DRM_BUDDY_HEADER_STATE;
44 block->header |= DRM_BUDDY_ALLOCATED;
46 list_del(&block->link);
49 static void mark_free(struct drm_buddy *mm,
50 struct drm_buddy_block *block)
52 block->header &= ~DRM_BUDDY_HEADER_STATE;
53 block->header |= DRM_BUDDY_FREE;
55 list_add(&block->link,
56 &mm->free_list[drm_buddy_block_order(block)]);
59 static void mark_split(struct drm_buddy_block *block)
61 block->header &= ~DRM_BUDDY_HEADER_STATE;
62 block->header |= DRM_BUDDY_SPLIT;
64 list_del(&block->link);
68 * drm_buddy_init - init memory manager
70 * @mm: DRM buddy manager to initialize
71 * @size: size in bytes to manage
72 * @chunk_size: minimum page size in bytes for our allocations
74 * Initializes the memory manager and its resources.
77 * 0 on success, error code on failure.
79 int drm_buddy_init(struct drm_buddy *mm, u64 size, u64 chunk_size)
84 if (size < chunk_size)
87 if (chunk_size < PAGE_SIZE)
90 if (!is_power_of_2(chunk_size))
93 size = round_down(size, chunk_size);
97 mm->chunk_size = chunk_size;
98 mm->max_order = ilog2(size) - ilog2(chunk_size);
100 BUG_ON(mm->max_order > DRM_BUDDY_MAX_ORDER);
102 mm->free_list = kmalloc_array(mm->max_order + 1,
103 sizeof(struct list_head),
108 for (i = 0; i <= mm->max_order; ++i)
109 INIT_LIST_HEAD(&mm->free_list[i]);
111 mm->n_roots = hweight64(size);
113 mm->roots = kmalloc_array(mm->n_roots,
114 sizeof(struct drm_buddy_block *),
123 * Split into power-of-two blocks, in case we are given a size that is
124 * not itself a power-of-two.
127 struct drm_buddy_block *root;
131 root_size = rounddown_pow_of_two(size);
132 order = ilog2(root_size) - ilog2(chunk_size);
134 root = drm_block_alloc(mm, NULL, order, offset);
140 BUG_ON(i > mm->max_order);
141 BUG_ON(drm_buddy_block_size(mm, root) < chunk_size);
154 drm_block_free(mm, mm->roots[i]);
157 kfree(mm->free_list);
160 EXPORT_SYMBOL(drm_buddy_init);
163 * drm_buddy_fini - tear down the memory manager
165 * @mm: DRM buddy manager to free
167 * Cleanup memory manager resources and the freelist
169 void drm_buddy_fini(struct drm_buddy *mm)
173 for (i = 0; i < mm->n_roots; ++i) {
174 WARN_ON(!drm_buddy_block_is_free(mm->roots[i]));
175 drm_block_free(mm, mm->roots[i]);
178 WARN_ON(mm->avail != mm->size);
181 kfree(mm->free_list);
183 EXPORT_SYMBOL(drm_buddy_fini);
185 static int split_block(struct drm_buddy *mm,
186 struct drm_buddy_block *block)
188 unsigned int block_order = drm_buddy_block_order(block) - 1;
189 u64 offset = drm_buddy_block_offset(block);
191 BUG_ON(!drm_buddy_block_is_free(block));
192 BUG_ON(!drm_buddy_block_order(block));
194 block->left = drm_block_alloc(mm, block, block_order, offset);
198 block->right = drm_block_alloc(mm, block, block_order,
199 offset + (mm->chunk_size << block_order));
201 drm_block_free(mm, block->left);
205 mark_free(mm, block->left);
206 mark_free(mm, block->right);
213 static struct drm_buddy_block *
214 __get_buddy(struct drm_buddy_block *block)
216 struct drm_buddy_block *parent;
218 parent = block->parent;
222 if (parent->left == block)
223 return parent->right;
229 * drm_get_buddy - get buddy address
231 * @block: DRM buddy block
233 * Returns the corresponding buddy block for @block, or NULL
234 * if this is a root block and can't be merged further.
235 * Requires some kind of locking to protect against
236 * any concurrent allocate and free operations.
238 struct drm_buddy_block *
239 drm_get_buddy(struct drm_buddy_block *block)
241 return __get_buddy(block);
243 EXPORT_SYMBOL(drm_get_buddy);
245 static void __drm_buddy_free(struct drm_buddy *mm,
246 struct drm_buddy_block *block)
248 struct drm_buddy_block *parent;
250 while ((parent = block->parent)) {
251 struct drm_buddy_block *buddy;
253 buddy = __get_buddy(block);
255 if (!drm_buddy_block_is_free(buddy))
258 list_del(&buddy->link);
260 drm_block_free(mm, block);
261 drm_block_free(mm, buddy);
266 mark_free(mm, block);
270 * drm_buddy_free_block - free a block
272 * @mm: DRM buddy manager
273 * @block: block to be freed
275 void drm_buddy_free_block(struct drm_buddy *mm,
276 struct drm_buddy_block *block)
278 BUG_ON(!drm_buddy_block_is_allocated(block));
279 mm->avail += drm_buddy_block_size(mm, block);
280 __drm_buddy_free(mm, block);
282 EXPORT_SYMBOL(drm_buddy_free_block);
285 * drm_buddy_free_list - free blocks
287 * @mm: DRM buddy manager
288 * @objects: input list head to free blocks
290 void drm_buddy_free_list(struct drm_buddy *mm, struct list_head *objects)
292 struct drm_buddy_block *block, *on;
294 list_for_each_entry_safe(block, on, objects, link) {
295 drm_buddy_free_block(mm, block);
298 INIT_LIST_HEAD(objects);
300 EXPORT_SYMBOL(drm_buddy_free_list);
302 static inline bool overlaps(u64 s1, u64 e1, u64 s2, u64 e2)
304 return s1 <= e2 && e1 >= s2;
307 static inline bool contains(u64 s1, u64 e1, u64 s2, u64 e2)
309 return s1 <= s2 && e1 >= e2;
312 static struct drm_buddy_block *
313 alloc_range_bias(struct drm_buddy *mm,
317 struct drm_buddy_block *block;
318 struct drm_buddy_block *buddy;
325 for (i = 0; i < mm->n_roots; ++i)
326 list_add_tail(&mm->roots[i]->tmp_link, &dfs);
332 block = list_first_entry_or_null(&dfs,
333 struct drm_buddy_block,
338 list_del(&block->tmp_link);
340 if (drm_buddy_block_order(block) < order)
343 block_start = drm_buddy_block_offset(block);
344 block_end = block_start + drm_buddy_block_size(mm, block) - 1;
346 if (!overlaps(start, end, block_start, block_end))
349 if (drm_buddy_block_is_allocated(block))
352 if (contains(start, end, block_start, block_end) &&
353 order == drm_buddy_block_order(block)) {
355 * Find the free block within the range.
357 if (drm_buddy_block_is_free(block))
363 if (!drm_buddy_block_is_split(block)) {
364 err = split_block(mm, block);
369 list_add(&block->right->tmp_link, &dfs);
370 list_add(&block->left->tmp_link, &dfs);
373 return ERR_PTR(-ENOSPC);
377 * We really don't want to leave around a bunch of split blocks, since
378 * bigger is better, so make sure we merge everything back before we
379 * free the allocated blocks.
381 buddy = __get_buddy(block);
383 (drm_buddy_block_is_free(block) &&
384 drm_buddy_block_is_free(buddy)))
385 __drm_buddy_free(mm, block);
389 static struct drm_buddy_block *
390 get_maxblock(struct list_head *head)
392 struct drm_buddy_block *max_block = NULL, *node;
394 max_block = list_first_entry_or_null(head,
395 struct drm_buddy_block,
400 list_for_each_entry(node, head, link) {
401 if (drm_buddy_block_offset(node) >
402 drm_buddy_block_offset(max_block))
409 static struct drm_buddy_block *
410 alloc_from_freelist(struct drm_buddy *mm,
414 struct drm_buddy_block *block = NULL;
418 for (i = order; i <= mm->max_order; ++i) {
419 if (flags & DRM_BUDDY_TOPDOWN_ALLOCATION) {
420 block = get_maxblock(&mm->free_list[i]);
424 block = list_first_entry_or_null(&mm->free_list[i],
425 struct drm_buddy_block,
433 return ERR_PTR(-ENOSPC);
435 BUG_ON(!drm_buddy_block_is_free(block));
438 err = split_block(mm, block);
442 block = block->right;
449 __drm_buddy_free(mm, block);
453 static int __alloc_range(struct drm_buddy *mm,
454 struct list_head *dfs,
456 struct list_head *blocks)
458 struct drm_buddy_block *block;
459 struct drm_buddy_block *buddy;
460 LIST_HEAD(allocated);
464 end = start + size - 1;
470 block = list_first_entry_or_null(dfs,
471 struct drm_buddy_block,
476 list_del(&block->tmp_link);
478 block_start = drm_buddy_block_offset(block);
479 block_end = block_start + drm_buddy_block_size(mm, block) - 1;
481 if (!overlaps(start, end, block_start, block_end))
484 if (drm_buddy_block_is_allocated(block)) {
489 if (contains(start, end, block_start, block_end)) {
490 if (!drm_buddy_block_is_free(block)) {
495 mark_allocated(block);
496 mm->avail -= drm_buddy_block_size(mm, block);
497 list_add_tail(&block->link, &allocated);
501 if (!drm_buddy_block_is_split(block)) {
502 err = split_block(mm, block);
507 list_add(&block->right->tmp_link, dfs);
508 list_add(&block->left->tmp_link, dfs);
511 list_splice_tail(&allocated, blocks);
516 * We really don't want to leave around a bunch of split blocks, since
517 * bigger is better, so make sure we merge everything back before we
518 * free the allocated blocks.
520 buddy = __get_buddy(block);
522 (drm_buddy_block_is_free(block) &&
523 drm_buddy_block_is_free(buddy)))
524 __drm_buddy_free(mm, block);
527 drm_buddy_free_list(mm, &allocated);
531 static int __drm_buddy_alloc_range(struct drm_buddy *mm,
534 struct list_head *blocks)
539 for (i = 0; i < mm->n_roots; ++i)
540 list_add_tail(&mm->roots[i]->tmp_link, &dfs);
542 return __alloc_range(mm, &dfs, start, size, blocks);
546 * drm_buddy_block_trim - free unused pages
548 * @mm: DRM buddy manager
549 * @new_size: original size requested
550 * @blocks: Input and output list of allocated blocks.
551 * MUST contain single block as input to be trimmed.
552 * On success will contain the newly allocated blocks
553 * making up the @new_size. Blocks always appear in
556 * For contiguous allocation, we round up the size to the nearest
557 * power of two value, drivers consume *actual* size, so remaining
558 * portions are unused and can be optionally freed with this function
561 * 0 on success, error code on failure.
563 int drm_buddy_block_trim(struct drm_buddy *mm,
565 struct list_head *blocks)
567 struct drm_buddy_block *parent;
568 struct drm_buddy_block *block;
573 if (!list_is_singular(blocks))
576 block = list_first_entry(blocks,
577 struct drm_buddy_block,
580 if (WARN_ON(!drm_buddy_block_is_allocated(block)))
583 if (new_size > drm_buddy_block_size(mm, block))
586 if (!new_size || !IS_ALIGNED(new_size, mm->chunk_size))
589 if (new_size == drm_buddy_block_size(mm, block))
592 list_del(&block->link);
593 mark_free(mm, block);
594 mm->avail += drm_buddy_block_size(mm, block);
596 /* Prevent recursively freeing this node */
597 parent = block->parent;
598 block->parent = NULL;
600 new_start = drm_buddy_block_offset(block);
601 list_add(&block->tmp_link, &dfs);
602 err = __alloc_range(mm, &dfs, new_start, new_size, blocks);
604 mark_allocated(block);
605 mm->avail -= drm_buddy_block_size(mm, block);
606 list_add(&block->link, blocks);
609 block->parent = parent;
612 EXPORT_SYMBOL(drm_buddy_block_trim);
615 * drm_buddy_alloc_blocks - allocate power-of-two blocks
617 * @mm: DRM buddy manager to allocate from
618 * @start: start of the allowed range for this block
619 * @end: end of the allowed range for this block
620 * @size: size of the allocation
621 * @min_page_size: alignment of the allocation
622 * @blocks: output list head to add allocated blocks
623 * @flags: DRM_BUDDY_*_ALLOCATION flags
625 * alloc_range_bias() called on range limitations, which traverses
626 * the tree and returns the desired block.
628 * alloc_from_freelist() called when *no* range restrictions
629 * are enforced, which picks the block from the freelist.
632 * 0 on success, error code on failure.
634 int drm_buddy_alloc_blocks(struct drm_buddy *mm,
635 u64 start, u64 end, u64 size,
637 struct list_head *blocks,
640 struct drm_buddy_block *block = NULL;
641 unsigned int min_order, order;
643 LIST_HEAD(allocated);
646 if (size < mm->chunk_size)
649 if (min_page_size < mm->chunk_size)
652 if (!is_power_of_2(min_page_size))
655 if (!IS_ALIGNED(start | end | size, mm->chunk_size))
661 if (range_overflows(start, size, mm->size))
664 /* Actual range allocation */
665 if (start + size == end)
666 return __drm_buddy_alloc_range(mm, start, size, blocks);
668 pages = size >> ilog2(mm->chunk_size);
669 order = fls(pages) - 1;
670 min_order = ilog2(min_page_size) - ilog2(mm->chunk_size);
673 order = min(order, (unsigned int)fls(pages) - 1);
674 BUG_ON(order > mm->max_order);
675 BUG_ON(order < min_order);
678 if (flags & DRM_BUDDY_RANGE_ALLOCATION)
679 /* Allocate traversing within the range */
680 block = alloc_range_bias(mm, start, end, order);
682 /* Allocate from freelist */
683 block = alloc_from_freelist(mm, order, flags);
688 if (order-- == min_order) {
694 mark_allocated(block);
695 mm->avail -= drm_buddy_block_size(mm, block);
696 kmemleak_update_trace(block);
697 list_add_tail(&block->link, &allocated);
705 list_splice_tail(&allocated, blocks);
709 drm_buddy_free_list(mm, &allocated);
712 EXPORT_SYMBOL(drm_buddy_alloc_blocks);
715 * drm_buddy_block_print - print block information
717 * @mm: DRM buddy manager
718 * @block: DRM buddy block
719 * @p: DRM printer to use
721 void drm_buddy_block_print(struct drm_buddy *mm,
722 struct drm_buddy_block *block,
723 struct drm_printer *p)
725 u64 start = drm_buddy_block_offset(block);
726 u64 size = drm_buddy_block_size(mm, block);
728 drm_printf(p, "%#018llx-%#018llx: %llu\n", start, start + size, size);
730 EXPORT_SYMBOL(drm_buddy_block_print);
733 * drm_buddy_print - print allocator state
735 * @mm: DRM buddy manager
736 * @p: DRM printer to use
738 void drm_buddy_print(struct drm_buddy *mm, struct drm_printer *p)
742 drm_printf(p, "chunk_size: %lluKiB, total: %lluMiB, free: %lluMiB\n",
743 mm->chunk_size >> 10, mm->size >> 20, mm->avail >> 20);
745 for (order = mm->max_order; order >= 0; order--) {
746 struct drm_buddy_block *block;
749 list_for_each_entry(block, &mm->free_list[order], link) {
750 BUG_ON(!drm_buddy_block_is_free(block));
754 drm_printf(p, "order-%d ", order);
756 free = count * (mm->chunk_size << order);
758 drm_printf(p, "free: %lluKiB", free >> 10);
760 drm_printf(p, "free: %lluMiB", free >> 20);
762 drm_printf(p, ", pages: %llu\n", count);
765 EXPORT_SYMBOL(drm_buddy_print);
767 static void drm_buddy_module_exit(void)
769 kmem_cache_destroy(slab_blocks);
772 static int __init drm_buddy_module_init(void)
774 slab_blocks = KMEM_CACHE(drm_buddy_block, 0);
781 module_init(drm_buddy_module_init);
782 module_exit(drm_buddy_module_exit);
784 MODULE_DESCRIPTION("DRM Buddy Allocator");
785 MODULE_LICENSE("Dual MIT/GPL");