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 if (pos->first == res)
90 pos->first = list_next_entry(res, lru);
91 list_move(&res->lru, &pos->last->lru);
96 /* Add the resource to a bulk_move cursor */
97 static void ttm_lru_bulk_move_add(struct ttm_lru_bulk_move *bulk,
98 struct ttm_resource *res)
100 struct ttm_lru_bulk_move_pos *pos = ttm_lru_bulk_move_pos(bulk, res);
106 ttm_lru_bulk_move_pos_tail(pos, res);
110 /* Remove the resource from a bulk_move range */
111 static void ttm_lru_bulk_move_del(struct ttm_lru_bulk_move *bulk,
112 struct ttm_resource *res)
114 struct ttm_lru_bulk_move_pos *pos = ttm_lru_bulk_move_pos(bulk, res);
116 if (unlikely(WARN_ON(!pos->first || !pos->last) ||
117 (pos->first == res && pos->last == res))) {
120 } else if (pos->first == res) {
121 pos->first = list_next_entry(res, lru);
122 } else if (pos->last == res) {
123 pos->last = list_prev_entry(res, lru);
125 list_move(&res->lru, &pos->last->lru);
129 /* Add the resource to a bulk move if the BO is configured for it */
130 void ttm_resource_add_bulk_move(struct ttm_resource *res,
131 struct ttm_buffer_object *bo)
133 if (bo->bulk_move && !bo->pin_count)
134 ttm_lru_bulk_move_add(bo->bulk_move, res);
137 /* Remove the resource from a bulk move if the BO is configured for it */
138 void ttm_resource_del_bulk_move(struct ttm_resource *res,
139 struct ttm_buffer_object *bo)
141 if (bo->bulk_move && !bo->pin_count)
142 ttm_lru_bulk_move_del(bo->bulk_move, res);
145 /* Move a resource to the LRU or bulk tail */
146 void ttm_resource_move_to_lru_tail(struct ttm_resource *res)
148 struct ttm_buffer_object *bo = res->bo;
149 struct ttm_device *bdev = bo->bdev;
151 lockdep_assert_held(&bo->bdev->lru_lock);
154 list_move_tail(&res->lru, &bdev->pinned);
156 } else if (bo->bulk_move) {
157 struct ttm_lru_bulk_move_pos *pos =
158 ttm_lru_bulk_move_pos(bo->bulk_move, res);
160 ttm_lru_bulk_move_pos_tail(pos, res);
162 struct ttm_resource_manager *man;
164 man = ttm_manager_type(bdev, res->mem_type);
165 list_move_tail(&res->lru, &man->lru[bo->priority]);
170 * ttm_resource_init - resource object constructure
171 * @bo: buffer object this resources is allocated for
172 * @place: placement of the resource
173 * @res: the resource object to inistilize
175 * Initialize a new resource object. Counterpart of ttm_resource_fini().
177 void ttm_resource_init(struct ttm_buffer_object *bo,
178 const struct ttm_place *place,
179 struct ttm_resource *res)
181 struct ttm_resource_manager *man;
184 res->size = bo->base.size;
185 res->mem_type = place->mem_type;
186 res->placement = place->flags;
187 res->bus.addr = NULL;
189 res->bus.is_iomem = false;
190 res->bus.caching = ttm_cached;
193 man = ttm_manager_type(bo->bdev, place->mem_type);
194 spin_lock(&bo->bdev->lru_lock);
196 list_add_tail(&res->lru, &bo->bdev->pinned);
198 list_add_tail(&res->lru, &man->lru[bo->priority]);
199 man->usage += res->size;
200 spin_unlock(&bo->bdev->lru_lock);
202 EXPORT_SYMBOL(ttm_resource_init);
205 * ttm_resource_fini - resource destructor
206 * @man: the resource manager this resource belongs to
207 * @res: the resource to clean up
209 * Should be used by resource manager backends to clean up the TTM resource
210 * objects before freeing the underlying structure. Makes sure the resource is
211 * removed from the LRU before destruction.
212 * Counterpart of ttm_resource_init().
214 void ttm_resource_fini(struct ttm_resource_manager *man,
215 struct ttm_resource *res)
217 struct ttm_device *bdev = man->bdev;
219 spin_lock(&bdev->lru_lock);
220 list_del_init(&res->lru);
221 man->usage -= res->size;
222 spin_unlock(&bdev->lru_lock);
224 EXPORT_SYMBOL(ttm_resource_fini);
226 int ttm_resource_alloc(struct ttm_buffer_object *bo,
227 const struct ttm_place *place,
228 struct ttm_resource **res_ptr)
230 struct ttm_resource_manager *man =
231 ttm_manager_type(bo->bdev, place->mem_type);
234 ret = man->func->alloc(man, bo, place, res_ptr);
238 spin_lock(&bo->bdev->lru_lock);
239 ttm_resource_add_bulk_move(*res_ptr, bo);
240 spin_unlock(&bo->bdev->lru_lock);
244 void ttm_resource_free(struct ttm_buffer_object *bo, struct ttm_resource **res)
246 struct ttm_resource_manager *man;
251 spin_lock(&bo->bdev->lru_lock);
252 ttm_resource_del_bulk_move(*res, bo);
253 spin_unlock(&bo->bdev->lru_lock);
254 man = ttm_manager_type(bo->bdev, (*res)->mem_type);
255 man->func->free(man, *res);
258 EXPORT_SYMBOL(ttm_resource_free);
261 * ttm_resource_intersects - test for intersection
263 * @bdev: TTM device structure
264 * @res: The resource to test
265 * @place: The placement to test
266 * @size: How many bytes the new allocation needs.
268 * Test if @res intersects with @place and @size. Used for testing if evictions
269 * are valueable or not.
271 * Returns true if the res placement intersects with @place and @size.
273 bool ttm_resource_intersects(struct ttm_device *bdev,
274 struct ttm_resource *res,
275 const struct ttm_place *place,
278 struct ttm_resource_manager *man;
283 man = ttm_manager_type(bdev, res->mem_type);
284 if (!place || !man->func->intersects)
287 return man->func->intersects(man, res, place, size);
291 * ttm_resource_compatible - test for compatibility
293 * @bdev: TTM device structure
294 * @res: The resource to test
295 * @place: The placement to test
296 * @size: How many bytes the new allocation needs.
298 * Test if @res compatible with @place and @size.
300 * Returns true if the res placement compatible with @place and @size.
302 bool ttm_resource_compatible(struct ttm_device *bdev,
303 struct ttm_resource *res,
304 const struct ttm_place *place,
307 struct ttm_resource_manager *man;
312 man = ttm_manager_type(bdev, res->mem_type);
313 if (!man->func->compatible)
316 return man->func->compatible(man, res, place, size);
319 static bool ttm_resource_places_compat(struct ttm_resource *res,
320 const struct ttm_place *places,
321 unsigned num_placement)
323 struct ttm_buffer_object *bo = res->bo;
324 struct ttm_device *bdev = bo->bdev;
327 if (res->placement & TTM_PL_FLAG_TEMPORARY)
330 for (i = 0; i < num_placement; i++) {
331 const struct ttm_place *heap = &places[i];
333 if (!ttm_resource_compatible(bdev, res, heap, bo->base.size))
336 if ((res->mem_type == heap->mem_type) &&
337 (!(heap->flags & TTM_PL_FLAG_CONTIGUOUS) ||
338 (res->placement & TTM_PL_FLAG_CONTIGUOUS)))
345 * ttm_resource_compat - check if resource is compatible with placement
347 * @res: the resource to check
348 * @placement: the placement to check against
350 * Returns true if the placement is compatible.
352 bool ttm_resource_compat(struct ttm_resource *res,
353 struct ttm_placement *placement)
355 if (ttm_resource_places_compat(res, placement->placement,
356 placement->num_placement))
359 if ((placement->busy_placement != placement->placement ||
360 placement->num_busy_placement > placement->num_placement) &&
361 ttm_resource_places_compat(res, placement->busy_placement,
362 placement->num_busy_placement))
368 void ttm_resource_set_bo(struct ttm_resource *res,
369 struct ttm_buffer_object *bo)
371 spin_lock(&bo->bdev->lru_lock);
373 spin_unlock(&bo->bdev->lru_lock);
377 * ttm_resource_manager_init
379 * @man: memory manager object to init
380 * @bdev: ttm device this manager belongs to
381 * @size: size of managed resources in arbitrary units
383 * Initialise core parts of a manager object.
385 void ttm_resource_manager_init(struct ttm_resource_manager *man,
386 struct ttm_device *bdev,
391 spin_lock_init(&man->move_lock);
396 for (i = 0; i < TTM_MAX_BO_PRIORITY; ++i)
397 INIT_LIST_HEAD(&man->lru[i]);
400 EXPORT_SYMBOL(ttm_resource_manager_init);
403 * ttm_resource_manager_evict_all
405 * @bdev - device to use
406 * @man - manager to use
408 * Evict all the objects out of a memory manager until it is empty.
409 * Part of memory manager cleanup sequence.
411 int ttm_resource_manager_evict_all(struct ttm_device *bdev,
412 struct ttm_resource_manager *man)
414 struct ttm_operation_ctx ctx = {
415 .interruptible = false,
416 .no_wait_gpu = false,
419 struct dma_fence *fence;
424 * Can't use standard list traversal since we're unlocking.
427 spin_lock(&bdev->lru_lock);
428 for (i = 0; i < TTM_MAX_BO_PRIORITY; ++i) {
429 while (!list_empty(&man->lru[i])) {
430 spin_unlock(&bdev->lru_lock);
431 ret = ttm_mem_evict_first(bdev, man, NULL, &ctx,
435 spin_lock(&bdev->lru_lock);
438 spin_unlock(&bdev->lru_lock);
440 spin_lock(&man->move_lock);
441 fence = dma_fence_get(man->move);
442 spin_unlock(&man->move_lock);
445 ret = dma_fence_wait(fence, false);
446 dma_fence_put(fence);
453 EXPORT_SYMBOL(ttm_resource_manager_evict_all);
456 * ttm_resource_manager_usage
458 * @man: A memory manager object.
460 * Return how many resources are currently used.
462 uint64_t ttm_resource_manager_usage(struct ttm_resource_manager *man)
466 spin_lock(&man->bdev->lru_lock);
468 spin_unlock(&man->bdev->lru_lock);
471 EXPORT_SYMBOL(ttm_resource_manager_usage);
474 * ttm_resource_manager_debug
476 * @man: manager type to dump.
477 * @p: printer to use for debug.
479 void ttm_resource_manager_debug(struct ttm_resource_manager *man,
480 struct drm_printer *p)
482 drm_printf(p, " use_type: %d\n", man->use_type);
483 drm_printf(p, " use_tt: %d\n", man->use_tt);
484 drm_printf(p, " size: %llu\n", man->size);
485 drm_printf(p, " usage: %llu\n", ttm_resource_manager_usage(man));
486 if (man->func->debug)
487 man->func->debug(man, p);
489 EXPORT_SYMBOL(ttm_resource_manager_debug);
492 * ttm_resource_manager_first
494 * @man: resource manager to iterate over
495 * @cursor: cursor to record the position
497 * Returns the first resource from the resource manager.
499 struct ttm_resource *
500 ttm_resource_manager_first(struct ttm_resource_manager *man,
501 struct ttm_resource_cursor *cursor)
503 struct ttm_resource *res;
505 lockdep_assert_held(&man->bdev->lru_lock);
507 for (cursor->priority = 0; cursor->priority < TTM_MAX_BO_PRIORITY;
509 list_for_each_entry(res, &man->lru[cursor->priority], lru)
516 * ttm_resource_manager_next
518 * @man: resource manager to iterate over
519 * @cursor: cursor to record the position
520 * @res: the current resource pointer
522 * Returns the next resource from the resource manager.
524 struct ttm_resource *
525 ttm_resource_manager_next(struct ttm_resource_manager *man,
526 struct ttm_resource_cursor *cursor,
527 struct ttm_resource *res)
529 lockdep_assert_held(&man->bdev->lru_lock);
531 list_for_each_entry_continue(res, &man->lru[cursor->priority], lru)
534 for (++cursor->priority; cursor->priority < TTM_MAX_BO_PRIORITY;
536 list_for_each_entry(res, &man->lru[cursor->priority], lru)
542 static void ttm_kmap_iter_iomap_map_local(struct ttm_kmap_iter *iter,
543 struct iosys_map *dmap,
546 struct ttm_kmap_iter_iomap *iter_io =
547 container_of(iter, typeof(*iter_io), base);
551 while (i >= iter_io->cache.end) {
552 iter_io->cache.sg = iter_io->cache.sg ?
553 sg_next(iter_io->cache.sg) : iter_io->st->sgl;
554 iter_io->cache.i = iter_io->cache.end;
555 iter_io->cache.end += sg_dma_len(iter_io->cache.sg) >>
557 iter_io->cache.offs = sg_dma_address(iter_io->cache.sg) -
561 if (i < iter_io->cache.i) {
562 iter_io->cache.end = 0;
563 iter_io->cache.sg = NULL;
567 addr = io_mapping_map_local_wc(iter_io->iomap, iter_io->cache.offs +
568 (((resource_size_t)i - iter_io->cache.i)
570 iosys_map_set_vaddr_iomem(dmap, addr);
573 static void ttm_kmap_iter_iomap_unmap_local(struct ttm_kmap_iter *iter,
574 struct iosys_map *map)
576 io_mapping_unmap_local(map->vaddr_iomem);
579 static const struct ttm_kmap_iter_ops ttm_kmap_iter_io_ops = {
580 .map_local = ttm_kmap_iter_iomap_map_local,
581 .unmap_local = ttm_kmap_iter_iomap_unmap_local,
586 * ttm_kmap_iter_iomap_init - Initialize a struct ttm_kmap_iter_iomap
587 * @iter_io: The struct ttm_kmap_iter_iomap to initialize.
588 * @iomap: The struct io_mapping representing the underlying linear io_memory.
589 * @st: sg_table into @iomap, representing the memory of the struct
591 * @start: Offset that needs to be subtracted from @st to make
592 * sg_dma_address(st->sgl) - @start == 0 for @iomap start.
594 * Return: Pointer to the embedded struct ttm_kmap_iter.
596 struct ttm_kmap_iter *
597 ttm_kmap_iter_iomap_init(struct ttm_kmap_iter_iomap *iter_io,
598 struct io_mapping *iomap,
600 resource_size_t start)
602 iter_io->base.ops = &ttm_kmap_iter_io_ops;
603 iter_io->iomap = iomap;
605 iter_io->start = start;
606 memset(&iter_io->cache, 0, sizeof(iter_io->cache));
608 return &iter_io->base;
610 EXPORT_SYMBOL(ttm_kmap_iter_iomap_init);
613 * DOC: Linear io iterator
615 * This code should die in the not too near future. Best would be if we could
616 * make io-mapping use memremap for all io memory, and have memremap
617 * implement a kmap_local functionality. We could then strip a huge amount of
618 * code. These linear io iterators are implemented to mimic old functionality,
619 * and they don't use kmap_local semantics at all internally. Rather ioremap or
620 * friends, and at least on 32-bit they add global TLB flushes and points
624 static void ttm_kmap_iter_linear_io_map_local(struct ttm_kmap_iter *iter,
625 struct iosys_map *dmap,
628 struct ttm_kmap_iter_linear_io *iter_io =
629 container_of(iter, typeof(*iter_io), base);
631 *dmap = iter_io->dmap;
632 iosys_map_incr(dmap, i * PAGE_SIZE);
635 static const struct ttm_kmap_iter_ops ttm_kmap_iter_linear_io_ops = {
636 .map_local = ttm_kmap_iter_linear_io_map_local,
641 * ttm_kmap_iter_linear_io_init - Initialize an iterator for linear io memory
642 * @iter_io: The iterator to initialize
643 * @bdev: The TTM device
644 * @mem: The ttm resource representing the iomap.
646 * This function is for internal TTM use only. It sets up a memcpy kmap iterator
647 * pointing at a linear chunk of io memory.
649 * Return: A pointer to the embedded struct ttm_kmap_iter or error pointer on
652 struct ttm_kmap_iter *
653 ttm_kmap_iter_linear_io_init(struct ttm_kmap_iter_linear_io *iter_io,
654 struct ttm_device *bdev,
655 struct ttm_resource *mem)
659 ret = ttm_mem_io_reserve(bdev, mem);
662 if (!mem->bus.is_iomem) {
668 iosys_map_set_vaddr(&iter_io->dmap, mem->bus.addr);
669 iter_io->needs_unmap = false;
671 iter_io->needs_unmap = true;
672 memset(&iter_io->dmap, 0, sizeof(iter_io->dmap));
673 if (mem->bus.caching == ttm_write_combined)
674 iosys_map_set_vaddr_iomem(&iter_io->dmap,
675 ioremap_wc(mem->bus.offset,
677 else if (mem->bus.caching == ttm_cached)
678 iosys_map_set_vaddr(&iter_io->dmap,
679 memremap(mem->bus.offset, mem->size,
684 /* If uncached requested or if mapping cached or wc failed */
685 if (iosys_map_is_null(&iter_io->dmap))
686 iosys_map_set_vaddr_iomem(&iter_io->dmap,
687 ioremap(mem->bus.offset,
690 if (iosys_map_is_null(&iter_io->dmap)) {
696 iter_io->base.ops = &ttm_kmap_iter_linear_io_ops;
697 return &iter_io->base;
700 ttm_mem_io_free(bdev, mem);
706 * ttm_kmap_iter_linear_io_fini - Clean up an iterator for linear io memory
707 * @iter_io: The iterator to initialize
708 * @bdev: The TTM device
709 * @mem: The ttm resource representing the iomap.
711 * This function is for internal TTM use only. It cleans up a memcpy kmap
712 * iterator initialized by ttm_kmap_iter_linear_io_init.
715 ttm_kmap_iter_linear_io_fini(struct ttm_kmap_iter_linear_io *iter_io,
716 struct ttm_device *bdev,
717 struct ttm_resource *mem)
719 if (iter_io->needs_unmap && iosys_map_is_set(&iter_io->dmap)) {
720 if (iter_io->dmap.is_iomem)
721 iounmap(iter_io->dmap.vaddr_iomem);
723 memunmap(iter_io->dmap.vaddr);
726 ttm_mem_io_free(bdev, mem);
729 #if defined(CONFIG_DEBUG_FS)
731 static int ttm_resource_manager_show(struct seq_file *m, void *unused)
733 struct ttm_resource_manager *man =
734 (struct ttm_resource_manager *)m->private;
735 struct drm_printer p = drm_seq_file_printer(m);
736 ttm_resource_manager_debug(man, &p);
739 DEFINE_SHOW_ATTRIBUTE(ttm_resource_manager);
744 * ttm_resource_manager_create_debugfs - Create debugfs entry for specified
746 * @man: The TTM resource manager for which the debugfs stats file be creates
747 * @parent: debugfs directory in which the file will reside
748 * @name: The filename to create.
750 * This function setups up a debugfs file that can be used to look
751 * at debug statistics of the specified ttm_resource_manager.
753 void ttm_resource_manager_create_debugfs(struct ttm_resource_manager *man,
754 struct dentry * parent,
757 #if defined(CONFIG_DEBUG_FS)
758 debugfs_create_file(name, 0444, parent, man, &ttm_resource_manager_fops);
761 EXPORT_SYMBOL(ttm_resource_manager_create_debugfs);