2 * Copyright 2020 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
22 * Authors: Christian König
25 #include <linux/iosys-map.h>
26 #include <linux/io-mapping.h>
27 #include <linux/scatterlist.h>
29 #include <drm/ttm/ttm_bo.h>
30 #include <drm/ttm/ttm_placement.h>
31 #include <drm/ttm/ttm_resource.h>
34 * ttm_lru_bulk_move_init - initialize a bulk move structure
35 * @bulk: the structure to init
37 * For now just memset the structure to zero.
39 void ttm_lru_bulk_move_init(struct ttm_lru_bulk_move *bulk)
41 memset(bulk, 0, sizeof(*bulk));
43 EXPORT_SYMBOL(ttm_lru_bulk_move_init);
46 * ttm_lru_bulk_move_tail - bulk move range of resources to the LRU tail.
48 * @bulk: bulk move structure
50 * Bulk move BOs to the LRU tail, only valid to use when driver makes sure that
51 * resource order never changes. Should be called with &ttm_device.lru_lock held.
53 void ttm_lru_bulk_move_tail(struct ttm_lru_bulk_move *bulk)
57 for (i = 0; i < TTM_NUM_MEM_TYPES; ++i) {
58 for (j = 0; j < TTM_MAX_BO_PRIORITY; ++j) {
59 struct ttm_lru_bulk_move_pos *pos = &bulk->pos[i][j];
60 struct ttm_resource_manager *man;
65 lockdep_assert_held(&pos->first->bo->bdev->lru_lock);
66 dma_resv_assert_held(pos->first->bo->base.resv);
67 dma_resv_assert_held(pos->last->bo->base.resv);
69 man = ttm_manager_type(pos->first->bo->bdev, i);
70 list_bulk_move_tail(&man->lru[j], &pos->first->lru,
75 EXPORT_SYMBOL(ttm_lru_bulk_move_tail);
77 /* Return the bulk move pos object for this resource */
78 static struct ttm_lru_bulk_move_pos *
79 ttm_lru_bulk_move_pos(struct ttm_lru_bulk_move *bulk, struct ttm_resource *res)
81 return &bulk->pos[res->mem_type][res->bo->priority];
84 /* Move the resource to the tail of the bulk move range */
85 static void ttm_lru_bulk_move_pos_tail(struct ttm_lru_bulk_move_pos *pos,
86 struct ttm_resource *res)
88 if (pos->last != res) {
89 list_move(&res->lru, &pos->last->lru);
94 /* Add the resource to a bulk_move cursor */
95 static void ttm_lru_bulk_move_add(struct ttm_lru_bulk_move *bulk,
96 struct ttm_resource *res)
98 struct ttm_lru_bulk_move_pos *pos = ttm_lru_bulk_move_pos(bulk, res);
104 ttm_lru_bulk_move_pos_tail(pos, res);
108 /* Remove the resource from a bulk_move range */
109 static void ttm_lru_bulk_move_del(struct ttm_lru_bulk_move *bulk,
110 struct ttm_resource *res)
112 struct ttm_lru_bulk_move_pos *pos = ttm_lru_bulk_move_pos(bulk, res);
114 if (unlikely(pos->first == res && pos->last == res)) {
117 } else if (pos->first == res) {
118 pos->first = list_next_entry(res, lru);
119 } else if (pos->last == res) {
120 pos->last = list_prev_entry(res, lru);
122 list_move(&res->lru, &pos->last->lru);
126 /* Add the resource to a bulk move if the BO is configured for it */
127 void ttm_resource_add_bulk_move(struct ttm_resource *res,
128 struct ttm_buffer_object *bo)
130 if (bo->bulk_move && !bo->pin_count)
131 ttm_lru_bulk_move_add(bo->bulk_move, res);
134 /* Remove the resource from a bulk move if the BO is configured for it */
135 void ttm_resource_del_bulk_move(struct ttm_resource *res,
136 struct ttm_buffer_object *bo)
138 if (bo->bulk_move && !bo->pin_count)
139 ttm_lru_bulk_move_del(bo->bulk_move, res);
142 /* Move a resource to the LRU or bulk tail */
143 void ttm_resource_move_to_lru_tail(struct ttm_resource *res)
145 struct ttm_buffer_object *bo = res->bo;
146 struct ttm_device *bdev = bo->bdev;
148 lockdep_assert_held(&bo->bdev->lru_lock);
151 list_move_tail(&res->lru, &bdev->pinned);
153 } else if (bo->bulk_move) {
154 struct ttm_lru_bulk_move_pos *pos =
155 ttm_lru_bulk_move_pos(bo->bulk_move, res);
157 ttm_lru_bulk_move_pos_tail(pos, res);
159 struct ttm_resource_manager *man;
161 man = ttm_manager_type(bdev, res->mem_type);
162 list_move_tail(&res->lru, &man->lru[bo->priority]);
167 * ttm_resource_init - resource object constructure
168 * @bo: buffer object this resources is allocated for
169 * @place: placement of the resource
170 * @res: the resource object to inistilize
172 * Initialize a new resource object. Counterpart of ttm_resource_fini().
174 void ttm_resource_init(struct ttm_buffer_object *bo,
175 const struct ttm_place *place,
176 struct ttm_resource *res)
178 struct ttm_resource_manager *man;
181 res->size = bo->base.size;
182 res->mem_type = place->mem_type;
183 res->placement = place->flags;
184 res->bus.addr = NULL;
186 res->bus.is_iomem = false;
187 res->bus.caching = ttm_cached;
190 man = ttm_manager_type(bo->bdev, place->mem_type);
191 spin_lock(&bo->bdev->lru_lock);
193 list_add_tail(&res->lru, &bo->bdev->pinned);
195 list_add_tail(&res->lru, &man->lru[bo->priority]);
196 man->usage += res->size;
197 spin_unlock(&bo->bdev->lru_lock);
199 EXPORT_SYMBOL(ttm_resource_init);
202 * ttm_resource_fini - resource destructor
203 * @man: the resource manager this resource belongs to
204 * @res: the resource to clean up
206 * Should be used by resource manager backends to clean up the TTM resource
207 * objects before freeing the underlying structure. Makes sure the resource is
208 * removed from the LRU before destruction.
209 * Counterpart of ttm_resource_init().
211 void ttm_resource_fini(struct ttm_resource_manager *man,
212 struct ttm_resource *res)
214 struct ttm_device *bdev = man->bdev;
216 spin_lock(&bdev->lru_lock);
217 list_del_init(&res->lru);
218 man->usage -= res->size;
219 spin_unlock(&bdev->lru_lock);
221 EXPORT_SYMBOL(ttm_resource_fini);
223 int ttm_resource_alloc(struct ttm_buffer_object *bo,
224 const struct ttm_place *place,
225 struct ttm_resource **res_ptr)
227 struct ttm_resource_manager *man =
228 ttm_manager_type(bo->bdev, place->mem_type);
231 ret = man->func->alloc(man, bo, place, res_ptr);
235 spin_lock(&bo->bdev->lru_lock);
236 ttm_resource_add_bulk_move(*res_ptr, bo);
237 spin_unlock(&bo->bdev->lru_lock);
241 void ttm_resource_free(struct ttm_buffer_object *bo, struct ttm_resource **res)
243 struct ttm_resource_manager *man;
248 spin_lock(&bo->bdev->lru_lock);
249 ttm_resource_del_bulk_move(*res, bo);
250 spin_unlock(&bo->bdev->lru_lock);
251 man = ttm_manager_type(bo->bdev, (*res)->mem_type);
252 man->func->free(man, *res);
255 EXPORT_SYMBOL(ttm_resource_free);
258 * ttm_resource_intersects - test for intersection
260 * @bdev: TTM device structure
261 * @res: The resource to test
262 * @place: The placement to test
263 * @size: How many bytes the new allocation needs.
265 * Test if @res intersects with @place and @size. Used for testing if evictions
266 * are valueable or not.
268 * Returns true if the res placement intersects with @place and @size.
270 bool ttm_resource_intersects(struct ttm_device *bdev,
271 struct ttm_resource *res,
272 const struct ttm_place *place,
275 struct ttm_resource_manager *man;
280 man = ttm_manager_type(bdev, res->mem_type);
281 if (!place || !man->func->intersects)
284 return man->func->intersects(man, res, place, size);
288 * ttm_resource_compatible - test for compatibility
290 * @bdev: TTM device structure
291 * @res: The resource to test
292 * @place: The placement to test
293 * @size: How many bytes the new allocation needs.
295 * Test if @res compatible with @place and @size.
297 * Returns true if the res placement compatible with @place and @size.
299 bool ttm_resource_compatible(struct ttm_device *bdev,
300 struct ttm_resource *res,
301 const struct ttm_place *place,
304 struct ttm_resource_manager *man;
309 man = ttm_manager_type(bdev, res->mem_type);
310 if (!man->func->compatible)
313 return man->func->compatible(man, res, place, size);
316 static bool ttm_resource_places_compat(struct ttm_resource *res,
317 const struct ttm_place *places,
318 unsigned num_placement)
320 struct ttm_buffer_object *bo = res->bo;
321 struct ttm_device *bdev = bo->bdev;
324 if (res->placement & TTM_PL_FLAG_TEMPORARY)
327 for (i = 0; i < num_placement; i++) {
328 const struct ttm_place *heap = &places[i];
330 if (!ttm_resource_compatible(bdev, res, heap, bo->base.size))
333 if ((res->mem_type == heap->mem_type) &&
334 (!(heap->flags & TTM_PL_FLAG_CONTIGUOUS) ||
335 (res->placement & TTM_PL_FLAG_CONTIGUOUS)))
342 * ttm_resource_compat - check if resource is compatible with placement
344 * @res: the resource to check
345 * @placement: the placement to check against
347 * Returns true if the placement is compatible.
349 bool ttm_resource_compat(struct ttm_resource *res,
350 struct ttm_placement *placement)
352 if (ttm_resource_places_compat(res, placement->placement,
353 placement->num_placement))
356 if ((placement->busy_placement != placement->placement ||
357 placement->num_busy_placement > placement->num_placement) &&
358 ttm_resource_places_compat(res, placement->busy_placement,
359 placement->num_busy_placement))
365 void ttm_resource_set_bo(struct ttm_resource *res,
366 struct ttm_buffer_object *bo)
368 spin_lock(&bo->bdev->lru_lock);
370 spin_unlock(&bo->bdev->lru_lock);
374 * ttm_resource_manager_init
376 * @man: memory manager object to init
377 * @bdev: ttm device this manager belongs to
378 * @size: size of managed resources in arbitrary units
380 * Initialise core parts of a manager object.
382 void ttm_resource_manager_init(struct ttm_resource_manager *man,
383 struct ttm_device *bdev,
388 spin_lock_init(&man->move_lock);
393 for (i = 0; i < TTM_MAX_BO_PRIORITY; ++i)
394 INIT_LIST_HEAD(&man->lru[i]);
397 EXPORT_SYMBOL(ttm_resource_manager_init);
400 * ttm_resource_manager_evict_all
402 * @bdev - device to use
403 * @man - manager to use
405 * Evict all the objects out of a memory manager until it is empty.
406 * Part of memory manager cleanup sequence.
408 int ttm_resource_manager_evict_all(struct ttm_device *bdev,
409 struct ttm_resource_manager *man)
411 struct ttm_operation_ctx ctx = {
412 .interruptible = false,
413 .no_wait_gpu = false,
416 struct dma_fence *fence;
421 * Can't use standard list traversal since we're unlocking.
424 spin_lock(&bdev->lru_lock);
425 for (i = 0; i < TTM_MAX_BO_PRIORITY; ++i) {
426 while (!list_empty(&man->lru[i])) {
427 spin_unlock(&bdev->lru_lock);
428 ret = ttm_mem_evict_first(bdev, man, NULL, &ctx,
432 spin_lock(&bdev->lru_lock);
435 spin_unlock(&bdev->lru_lock);
437 spin_lock(&man->move_lock);
438 fence = dma_fence_get(man->move);
439 spin_unlock(&man->move_lock);
442 ret = dma_fence_wait(fence, false);
443 dma_fence_put(fence);
450 EXPORT_SYMBOL(ttm_resource_manager_evict_all);
453 * ttm_resource_manager_usage
455 * @man: A memory manager object.
457 * Return how many resources are currently used.
459 uint64_t ttm_resource_manager_usage(struct ttm_resource_manager *man)
463 spin_lock(&man->bdev->lru_lock);
465 spin_unlock(&man->bdev->lru_lock);
468 EXPORT_SYMBOL(ttm_resource_manager_usage);
471 * ttm_resource_manager_debug
473 * @man: manager type to dump.
474 * @p: printer to use for debug.
476 void ttm_resource_manager_debug(struct ttm_resource_manager *man,
477 struct drm_printer *p)
479 drm_printf(p, " use_type: %d\n", man->use_type);
480 drm_printf(p, " use_tt: %d\n", man->use_tt);
481 drm_printf(p, " size: %llu\n", man->size);
482 drm_printf(p, " usage: %llu\n", ttm_resource_manager_usage(man));
483 if (man->func->debug)
484 man->func->debug(man, p);
486 EXPORT_SYMBOL(ttm_resource_manager_debug);
489 * ttm_resource_manager_first
491 * @man: resource manager to iterate over
492 * @cursor: cursor to record the position
494 * Returns the first resource from the resource manager.
496 struct ttm_resource *
497 ttm_resource_manager_first(struct ttm_resource_manager *man,
498 struct ttm_resource_cursor *cursor)
500 struct ttm_resource *res;
502 lockdep_assert_held(&man->bdev->lru_lock);
504 for (cursor->priority = 0; cursor->priority < TTM_MAX_BO_PRIORITY;
506 list_for_each_entry(res, &man->lru[cursor->priority], lru)
513 * ttm_resource_manager_next
515 * @man: resource manager to iterate over
516 * @cursor: cursor to record the position
517 * @res: the current resource pointer
519 * Returns the next resource from the resource manager.
521 struct ttm_resource *
522 ttm_resource_manager_next(struct ttm_resource_manager *man,
523 struct ttm_resource_cursor *cursor,
524 struct ttm_resource *res)
526 lockdep_assert_held(&man->bdev->lru_lock);
528 list_for_each_entry_continue(res, &man->lru[cursor->priority], lru)
531 for (++cursor->priority; cursor->priority < TTM_MAX_BO_PRIORITY;
533 list_for_each_entry(res, &man->lru[cursor->priority], lru)
539 static void ttm_kmap_iter_iomap_map_local(struct ttm_kmap_iter *iter,
540 struct iosys_map *dmap,
543 struct ttm_kmap_iter_iomap *iter_io =
544 container_of(iter, typeof(*iter_io), base);
548 while (i >= iter_io->cache.end) {
549 iter_io->cache.sg = iter_io->cache.sg ?
550 sg_next(iter_io->cache.sg) : iter_io->st->sgl;
551 iter_io->cache.i = iter_io->cache.end;
552 iter_io->cache.end += sg_dma_len(iter_io->cache.sg) >>
554 iter_io->cache.offs = sg_dma_address(iter_io->cache.sg) -
558 if (i < iter_io->cache.i) {
559 iter_io->cache.end = 0;
560 iter_io->cache.sg = NULL;
564 addr = io_mapping_map_local_wc(iter_io->iomap, iter_io->cache.offs +
565 (((resource_size_t)i - iter_io->cache.i)
567 iosys_map_set_vaddr_iomem(dmap, addr);
570 static void ttm_kmap_iter_iomap_unmap_local(struct ttm_kmap_iter *iter,
571 struct iosys_map *map)
573 io_mapping_unmap_local(map->vaddr_iomem);
576 static const struct ttm_kmap_iter_ops ttm_kmap_iter_io_ops = {
577 .map_local = ttm_kmap_iter_iomap_map_local,
578 .unmap_local = ttm_kmap_iter_iomap_unmap_local,
583 * ttm_kmap_iter_iomap_init - Initialize a struct ttm_kmap_iter_iomap
584 * @iter_io: The struct ttm_kmap_iter_iomap to initialize.
585 * @iomap: The struct io_mapping representing the underlying linear io_memory.
586 * @st: sg_table into @iomap, representing the memory of the struct
588 * @start: Offset that needs to be subtracted from @st to make
589 * sg_dma_address(st->sgl) - @start == 0 for @iomap start.
591 * Return: Pointer to the embedded struct ttm_kmap_iter.
593 struct ttm_kmap_iter *
594 ttm_kmap_iter_iomap_init(struct ttm_kmap_iter_iomap *iter_io,
595 struct io_mapping *iomap,
597 resource_size_t start)
599 iter_io->base.ops = &ttm_kmap_iter_io_ops;
600 iter_io->iomap = iomap;
602 iter_io->start = start;
603 memset(&iter_io->cache, 0, sizeof(iter_io->cache));
605 return &iter_io->base;
607 EXPORT_SYMBOL(ttm_kmap_iter_iomap_init);
610 * DOC: Linear io iterator
612 * This code should die in the not too near future. Best would be if we could
613 * make io-mapping use memremap for all io memory, and have memremap
614 * implement a kmap_local functionality. We could then strip a huge amount of
615 * code. These linear io iterators are implemented to mimic old functionality,
616 * and they don't use kmap_local semantics at all internally. Rather ioremap or
617 * friends, and at least on 32-bit they add global TLB flushes and points
621 static void ttm_kmap_iter_linear_io_map_local(struct ttm_kmap_iter *iter,
622 struct iosys_map *dmap,
625 struct ttm_kmap_iter_linear_io *iter_io =
626 container_of(iter, typeof(*iter_io), base);
628 *dmap = iter_io->dmap;
629 iosys_map_incr(dmap, i * PAGE_SIZE);
632 static const struct ttm_kmap_iter_ops ttm_kmap_iter_linear_io_ops = {
633 .map_local = ttm_kmap_iter_linear_io_map_local,
638 * ttm_kmap_iter_linear_io_init - Initialize an iterator for linear io memory
639 * @iter_io: The iterator to initialize
640 * @bdev: The TTM device
641 * @mem: The ttm resource representing the iomap.
643 * This function is for internal TTM use only. It sets up a memcpy kmap iterator
644 * pointing at a linear chunk of io memory.
646 * Return: A pointer to the embedded struct ttm_kmap_iter or error pointer on
649 struct ttm_kmap_iter *
650 ttm_kmap_iter_linear_io_init(struct ttm_kmap_iter_linear_io *iter_io,
651 struct ttm_device *bdev,
652 struct ttm_resource *mem)
656 ret = ttm_mem_io_reserve(bdev, mem);
659 if (!mem->bus.is_iomem) {
665 iosys_map_set_vaddr(&iter_io->dmap, mem->bus.addr);
666 iter_io->needs_unmap = false;
668 iter_io->needs_unmap = true;
669 memset(&iter_io->dmap, 0, sizeof(iter_io->dmap));
670 if (mem->bus.caching == ttm_write_combined)
671 iosys_map_set_vaddr_iomem(&iter_io->dmap,
672 ioremap_wc(mem->bus.offset,
674 else if (mem->bus.caching == ttm_cached)
675 iosys_map_set_vaddr(&iter_io->dmap,
676 memremap(mem->bus.offset, mem->size,
681 /* If uncached requested or if mapping cached or wc failed */
682 if (iosys_map_is_null(&iter_io->dmap))
683 iosys_map_set_vaddr_iomem(&iter_io->dmap,
684 ioremap(mem->bus.offset,
687 if (iosys_map_is_null(&iter_io->dmap)) {
693 iter_io->base.ops = &ttm_kmap_iter_linear_io_ops;
694 return &iter_io->base;
697 ttm_mem_io_free(bdev, mem);
703 * ttm_kmap_iter_linear_io_fini - Clean up an iterator for linear io memory
704 * @iter_io: The iterator to initialize
705 * @bdev: The TTM device
706 * @mem: The ttm resource representing the iomap.
708 * This function is for internal TTM use only. It cleans up a memcpy kmap
709 * iterator initialized by ttm_kmap_iter_linear_io_init.
712 ttm_kmap_iter_linear_io_fini(struct ttm_kmap_iter_linear_io *iter_io,
713 struct ttm_device *bdev,
714 struct ttm_resource *mem)
716 if (iter_io->needs_unmap && iosys_map_is_set(&iter_io->dmap)) {
717 if (iter_io->dmap.is_iomem)
718 iounmap(iter_io->dmap.vaddr_iomem);
720 memunmap(iter_io->dmap.vaddr);
723 ttm_mem_io_free(bdev, mem);
726 #if defined(CONFIG_DEBUG_FS)
728 static int ttm_resource_manager_show(struct seq_file *m, void *unused)
730 struct ttm_resource_manager *man =
731 (struct ttm_resource_manager *)m->private;
732 struct drm_printer p = drm_seq_file_printer(m);
733 ttm_resource_manager_debug(man, &p);
736 DEFINE_SHOW_ATTRIBUTE(ttm_resource_manager);
741 * ttm_resource_manager_create_debugfs - Create debugfs entry for specified
743 * @man: The TTM resource manager for which the debugfs stats file be creates
744 * @parent: debugfs directory in which the file will reside
745 * @name: The filename to create.
747 * This function setups up a debugfs file that can be used to look
748 * at debug statistics of the specified ttm_resource_manager.
750 void ttm_resource_manager_create_debugfs(struct ttm_resource_manager *man,
751 struct dentry * parent,
754 #if defined(CONFIG_DEBUG_FS)
755 debugfs_create_file(name, 0444, parent, man, &ttm_resource_manager_fops);
758 EXPORT_SYMBOL(ttm_resource_manager_create_debugfs);