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_resource.h>
30 #include <drm/ttm/ttm_bo_driver.h>
33 * ttm_lru_bulk_move_init - initialize a bulk move structure
34 * @bulk: the structure to init
36 * For now just memset the structure to zero.
38 void ttm_lru_bulk_move_init(struct ttm_lru_bulk_move *bulk)
40 memset(bulk, 0, sizeof(*bulk));
42 EXPORT_SYMBOL(ttm_lru_bulk_move_init);
45 * ttm_lru_bulk_move_tail - bulk move range of resources to the LRU tail.
47 * @bulk: bulk move structure
49 * Bulk move BOs to the LRU tail, only valid to use when driver makes sure that
50 * resource order never changes. Should be called with &ttm_device.lru_lock held.
52 void ttm_lru_bulk_move_tail(struct ttm_lru_bulk_move *bulk)
56 for (i = 0; i < TTM_NUM_MEM_TYPES; ++i) {
57 for (j = 0; j < TTM_MAX_BO_PRIORITY; ++j) {
58 struct ttm_lru_bulk_move_pos *pos = &bulk->pos[i][j];
59 struct ttm_resource_manager *man;
64 lockdep_assert_held(&pos->first->bo->bdev->lru_lock);
65 dma_resv_assert_held(pos->first->bo->base.resv);
66 dma_resv_assert_held(pos->last->bo->base.resv);
68 man = ttm_manager_type(pos->first->bo->bdev, i);
69 list_bulk_move_tail(&man->lru[j], &pos->first->lru,
74 EXPORT_SYMBOL(ttm_lru_bulk_move_tail);
76 /* Return the bulk move pos object for this resource */
77 static struct ttm_lru_bulk_move_pos *
78 ttm_lru_bulk_move_pos(struct ttm_lru_bulk_move *bulk, struct ttm_resource *res)
80 return &bulk->pos[res->mem_type][res->bo->priority];
83 /* Move the resource to the tail of the bulk move range */
84 static void ttm_lru_bulk_move_pos_tail(struct ttm_lru_bulk_move_pos *pos,
85 struct ttm_resource *res)
87 if (pos->last != res) {
88 list_move(&res->lru, &pos->last->lru);
93 /* Add the resource to a bulk_move cursor */
94 void ttm_lru_bulk_move_add(struct ttm_lru_bulk_move *bulk,
95 struct ttm_resource *res)
97 struct ttm_lru_bulk_move_pos *pos = ttm_lru_bulk_move_pos(bulk, res);
103 ttm_lru_bulk_move_pos_tail(pos, res);
107 /* Remove the resource from a bulk_move range */
108 void ttm_lru_bulk_move_del(struct ttm_lru_bulk_move *bulk,
109 struct ttm_resource *res)
111 struct ttm_lru_bulk_move_pos *pos = ttm_lru_bulk_move_pos(bulk, res);
113 if (unlikely(pos->first == res && pos->last == res)) {
116 } else if (pos->first == res) {
117 pos->first = list_next_entry(res, lru);
118 } else if (pos->last == res) {
119 pos->last = list_prev_entry(res, lru);
121 list_move(&res->lru, &pos->last->lru);
125 /* Move a resource to the LRU or bulk tail */
126 void ttm_resource_move_to_lru_tail(struct ttm_resource *res)
128 struct ttm_buffer_object *bo = res->bo;
129 struct ttm_device *bdev = bo->bdev;
131 lockdep_assert_held(&bo->bdev->lru_lock);
134 list_move_tail(&res->lru, &bdev->pinned);
136 } else if (bo->bulk_move) {
137 struct ttm_lru_bulk_move_pos *pos =
138 ttm_lru_bulk_move_pos(bo->bulk_move, res);
140 ttm_lru_bulk_move_pos_tail(pos, res);
142 struct ttm_resource_manager *man;
144 man = ttm_manager_type(bdev, res->mem_type);
145 list_move_tail(&res->lru, &man->lru[bo->priority]);
150 * ttm_resource_init - resource object constructure
151 * @bo: buffer object this resources is allocated for
152 * @place: placement of the resource
153 * @res: the resource object to inistilize
155 * Initialize a new resource object. Counterpart of ttm_resource_fini().
157 void ttm_resource_init(struct ttm_buffer_object *bo,
158 const struct ttm_place *place,
159 struct ttm_resource *res)
161 struct ttm_resource_manager *man;
164 res->num_pages = PFN_UP(bo->base.size);
165 res->mem_type = place->mem_type;
166 res->placement = place->flags;
167 res->bus.addr = NULL;
169 res->bus.is_iomem = false;
170 res->bus.caching = ttm_cached;
172 INIT_LIST_HEAD(&res->lru);
174 man = ttm_manager_type(bo->bdev, place->mem_type);
175 spin_lock(&bo->bdev->lru_lock);
176 man->usage += res->num_pages << PAGE_SHIFT;
178 ttm_lru_bulk_move_add(bo->bulk_move, res);
180 ttm_resource_move_to_lru_tail(res);
181 spin_unlock(&bo->bdev->lru_lock);
183 EXPORT_SYMBOL(ttm_resource_init);
186 * ttm_resource_fini - resource destructor
187 * @man: the resource manager this resource belongs to
188 * @res: the resource to clean up
190 * Should be used by resource manager backends to clean up the TTM resource
191 * objects before freeing the underlying structure. Makes sure the resource is
192 * removed from the LRU before destruction.
193 * Counterpart of ttm_resource_init().
195 void ttm_resource_fini(struct ttm_resource_manager *man,
196 struct ttm_resource *res)
198 struct ttm_device *bdev = man->bdev;
200 spin_lock(&bdev->lru_lock);
201 list_del_init(&res->lru);
202 man->usage -= res->num_pages << PAGE_SHIFT;
203 spin_unlock(&bdev->lru_lock);
205 EXPORT_SYMBOL(ttm_resource_fini);
207 int ttm_resource_alloc(struct ttm_buffer_object *bo,
208 const struct ttm_place *place,
209 struct ttm_resource **res_ptr)
211 struct ttm_resource_manager *man =
212 ttm_manager_type(bo->bdev, place->mem_type);
214 return man->func->alloc(man, bo, place, res_ptr);
217 void ttm_resource_free(struct ttm_buffer_object *bo, struct ttm_resource **res)
219 struct ttm_resource_manager *man;
225 spin_lock(&bo->bdev->lru_lock);
226 ttm_lru_bulk_move_del(bo->bulk_move, *res);
227 spin_unlock(&bo->bdev->lru_lock);
230 man = ttm_manager_type(bo->bdev, (*res)->mem_type);
231 man->func->free(man, *res);
234 EXPORT_SYMBOL(ttm_resource_free);
236 static bool ttm_resource_places_compat(struct ttm_resource *res,
237 const struct ttm_place *places,
238 unsigned num_placement)
242 if (res->placement & TTM_PL_FLAG_TEMPORARY)
245 for (i = 0; i < num_placement; i++) {
246 const struct ttm_place *heap = &places[i];
248 if (res->start < heap->fpfn || (heap->lpfn &&
249 (res->start + res->num_pages) > heap->lpfn))
252 if ((res->mem_type == heap->mem_type) &&
253 (!(heap->flags & TTM_PL_FLAG_CONTIGUOUS) ||
254 (res->placement & TTM_PL_FLAG_CONTIGUOUS)))
261 * ttm_resource_compat - check if resource is compatible with placement
263 * @res: the resource to check
264 * @placement: the placement to check against
266 * Returns true if the placement is compatible.
268 bool ttm_resource_compat(struct ttm_resource *res,
269 struct ttm_placement *placement)
271 if (ttm_resource_places_compat(res, placement->placement,
272 placement->num_placement))
275 if ((placement->busy_placement != placement->placement ||
276 placement->num_busy_placement > placement->num_placement) &&
277 ttm_resource_places_compat(res, placement->busy_placement,
278 placement->num_busy_placement))
283 EXPORT_SYMBOL(ttm_resource_compat);
285 void ttm_resource_set_bo(struct ttm_resource *res,
286 struct ttm_buffer_object *bo)
288 spin_lock(&bo->bdev->lru_lock);
290 spin_unlock(&bo->bdev->lru_lock);
294 * ttm_resource_manager_init
296 * @man: memory manager object to init
297 * @bdev: ttm device this manager belongs to
298 * @size: size of managed resources in arbitrary units
300 * Initialise core parts of a manager object.
302 void ttm_resource_manager_init(struct ttm_resource_manager *man,
303 struct ttm_device *bdev,
308 spin_lock_init(&man->move_lock);
313 for (i = 0; i < TTM_MAX_BO_PRIORITY; ++i)
314 INIT_LIST_HEAD(&man->lru[i]);
317 EXPORT_SYMBOL(ttm_resource_manager_init);
320 * ttm_resource_manager_evict_all
322 * @bdev - device to use
323 * @man - manager to use
325 * Evict all the objects out of a memory manager until it is empty.
326 * Part of memory manager cleanup sequence.
328 int ttm_resource_manager_evict_all(struct ttm_device *bdev,
329 struct ttm_resource_manager *man)
331 struct ttm_operation_ctx ctx = {
332 .interruptible = false,
333 .no_wait_gpu = false,
336 struct dma_fence *fence;
341 * Can't use standard list traversal since we're unlocking.
344 spin_lock(&bdev->lru_lock);
345 for (i = 0; i < TTM_MAX_BO_PRIORITY; ++i) {
346 while (!list_empty(&man->lru[i])) {
347 spin_unlock(&bdev->lru_lock);
348 ret = ttm_mem_evict_first(bdev, man, NULL, &ctx,
352 spin_lock(&bdev->lru_lock);
355 spin_unlock(&bdev->lru_lock);
357 spin_lock(&man->move_lock);
358 fence = dma_fence_get(man->move);
359 spin_unlock(&man->move_lock);
362 ret = dma_fence_wait(fence, false);
363 dma_fence_put(fence);
370 EXPORT_SYMBOL(ttm_resource_manager_evict_all);
373 * ttm_resource_manager_usage
375 * @man: A memory manager object.
377 * Return how many resources are currently used.
379 uint64_t ttm_resource_manager_usage(struct ttm_resource_manager *man)
383 spin_lock(&man->bdev->lru_lock);
385 spin_unlock(&man->bdev->lru_lock);
388 EXPORT_SYMBOL(ttm_resource_manager_usage);
391 * ttm_resource_manager_debug
393 * @man: manager type to dump.
394 * @p: printer to use for debug.
396 void ttm_resource_manager_debug(struct ttm_resource_manager *man,
397 struct drm_printer *p)
399 drm_printf(p, " use_type: %d\n", man->use_type);
400 drm_printf(p, " use_tt: %d\n", man->use_tt);
401 drm_printf(p, " size: %llu\n", man->size);
402 drm_printf(p, " usage: %llu\n", ttm_resource_manager_usage(man));
403 if (man->func->debug)
404 man->func->debug(man, p);
406 EXPORT_SYMBOL(ttm_resource_manager_debug);
409 * ttm_resource_manager_first
411 * @man: resource manager to iterate over
412 * @cursor: cursor to record the position
414 * Returns the first resource from the resource manager.
416 struct ttm_resource *
417 ttm_resource_manager_first(struct ttm_resource_manager *man,
418 struct ttm_resource_cursor *cursor)
420 struct ttm_resource *res;
422 lockdep_assert_held(&man->bdev->lru_lock);
424 for (cursor->priority = 0; cursor->priority < TTM_MAX_BO_PRIORITY;
426 list_for_each_entry(res, &man->lru[cursor->priority], lru)
433 * ttm_resource_manager_next
435 * @man: resource manager to iterate over
436 * @cursor: cursor to record the position
437 * @res: the current resource pointer
439 * Returns the next resource from the resource manager.
441 struct ttm_resource *
442 ttm_resource_manager_next(struct ttm_resource_manager *man,
443 struct ttm_resource_cursor *cursor,
444 struct ttm_resource *res)
446 lockdep_assert_held(&man->bdev->lru_lock);
448 list_for_each_entry_continue(res, &man->lru[cursor->priority], lru)
451 for (++cursor->priority; cursor->priority < TTM_MAX_BO_PRIORITY;
453 list_for_each_entry(res, &man->lru[cursor->priority], lru)
459 static void ttm_kmap_iter_iomap_map_local(struct ttm_kmap_iter *iter,
460 struct iosys_map *dmap,
463 struct ttm_kmap_iter_iomap *iter_io =
464 container_of(iter, typeof(*iter_io), base);
468 while (i >= iter_io->cache.end) {
469 iter_io->cache.sg = iter_io->cache.sg ?
470 sg_next(iter_io->cache.sg) : iter_io->st->sgl;
471 iter_io->cache.i = iter_io->cache.end;
472 iter_io->cache.end += sg_dma_len(iter_io->cache.sg) >>
474 iter_io->cache.offs = sg_dma_address(iter_io->cache.sg) -
478 if (i < iter_io->cache.i) {
479 iter_io->cache.end = 0;
480 iter_io->cache.sg = NULL;
484 addr = io_mapping_map_local_wc(iter_io->iomap, iter_io->cache.offs +
485 (((resource_size_t)i - iter_io->cache.i)
487 iosys_map_set_vaddr_iomem(dmap, addr);
490 static void ttm_kmap_iter_iomap_unmap_local(struct ttm_kmap_iter *iter,
491 struct iosys_map *map)
493 io_mapping_unmap_local(map->vaddr_iomem);
496 static const struct ttm_kmap_iter_ops ttm_kmap_iter_io_ops = {
497 .map_local = ttm_kmap_iter_iomap_map_local,
498 .unmap_local = ttm_kmap_iter_iomap_unmap_local,
503 * ttm_kmap_iter_iomap_init - Initialize a struct ttm_kmap_iter_iomap
504 * @iter_io: The struct ttm_kmap_iter_iomap to initialize.
505 * @iomap: The struct io_mapping representing the underlying linear io_memory.
506 * @st: sg_table into @iomap, representing the memory of the struct
508 * @start: Offset that needs to be subtracted from @st to make
509 * sg_dma_address(st->sgl) - @start == 0 for @iomap start.
511 * Return: Pointer to the embedded struct ttm_kmap_iter.
513 struct ttm_kmap_iter *
514 ttm_kmap_iter_iomap_init(struct ttm_kmap_iter_iomap *iter_io,
515 struct io_mapping *iomap,
517 resource_size_t start)
519 iter_io->base.ops = &ttm_kmap_iter_io_ops;
520 iter_io->iomap = iomap;
522 iter_io->start = start;
523 memset(&iter_io->cache, 0, sizeof(iter_io->cache));
525 return &iter_io->base;
527 EXPORT_SYMBOL(ttm_kmap_iter_iomap_init);
530 * DOC: Linear io iterator
532 * This code should die in the not too near future. Best would be if we could
533 * make io-mapping use memremap for all io memory, and have memremap
534 * implement a kmap_local functionality. We could then strip a huge amount of
535 * code. These linear io iterators are implemented to mimic old functionality,
536 * and they don't use kmap_local semantics at all internally. Rather ioremap or
537 * friends, and at least on 32-bit they add global TLB flushes and points
541 static void ttm_kmap_iter_linear_io_map_local(struct ttm_kmap_iter *iter,
542 struct iosys_map *dmap,
545 struct ttm_kmap_iter_linear_io *iter_io =
546 container_of(iter, typeof(*iter_io), base);
548 *dmap = iter_io->dmap;
549 iosys_map_incr(dmap, i * PAGE_SIZE);
552 static const struct ttm_kmap_iter_ops ttm_kmap_iter_linear_io_ops = {
553 .map_local = ttm_kmap_iter_linear_io_map_local,
558 * ttm_kmap_iter_linear_io_init - Initialize an iterator for linear io memory
559 * @iter_io: The iterator to initialize
560 * @bdev: The TTM device
561 * @mem: The ttm resource representing the iomap.
563 * This function is for internal TTM use only. It sets up a memcpy kmap iterator
564 * pointing at a linear chunk of io memory.
566 * Return: A pointer to the embedded struct ttm_kmap_iter or error pointer on
569 struct ttm_kmap_iter *
570 ttm_kmap_iter_linear_io_init(struct ttm_kmap_iter_linear_io *iter_io,
571 struct ttm_device *bdev,
572 struct ttm_resource *mem)
576 ret = ttm_mem_io_reserve(bdev, mem);
579 if (!mem->bus.is_iomem) {
585 iosys_map_set_vaddr(&iter_io->dmap, mem->bus.addr);
586 iter_io->needs_unmap = false;
588 size_t bus_size = (size_t)mem->num_pages << PAGE_SHIFT;
590 iter_io->needs_unmap = true;
591 memset(&iter_io->dmap, 0, sizeof(iter_io->dmap));
592 if (mem->bus.caching == ttm_write_combined)
593 iosys_map_set_vaddr_iomem(&iter_io->dmap,
594 ioremap_wc(mem->bus.offset,
596 else if (mem->bus.caching == ttm_cached)
597 iosys_map_set_vaddr(&iter_io->dmap,
598 memremap(mem->bus.offset, bus_size,
603 /* If uncached requested or if mapping cached or wc failed */
604 if (iosys_map_is_null(&iter_io->dmap))
605 iosys_map_set_vaddr_iomem(&iter_io->dmap,
606 ioremap(mem->bus.offset,
609 if (iosys_map_is_null(&iter_io->dmap)) {
615 iter_io->base.ops = &ttm_kmap_iter_linear_io_ops;
616 return &iter_io->base;
619 ttm_mem_io_free(bdev, mem);
625 * ttm_kmap_iter_linear_io_fini - Clean up an iterator for linear io memory
626 * @iter_io: The iterator to initialize
627 * @bdev: The TTM device
628 * @mem: The ttm resource representing the iomap.
630 * This function is for internal TTM use only. It cleans up a memcpy kmap
631 * iterator initialized by ttm_kmap_iter_linear_io_init.
634 ttm_kmap_iter_linear_io_fini(struct ttm_kmap_iter_linear_io *iter_io,
635 struct ttm_device *bdev,
636 struct ttm_resource *mem)
638 if (iter_io->needs_unmap && iosys_map_is_set(&iter_io->dmap)) {
639 if (iter_io->dmap.is_iomem)
640 iounmap(iter_io->dmap.vaddr_iomem);
642 memunmap(iter_io->dmap.vaddr);
645 ttm_mem_io_free(bdev, mem);
648 #if defined(CONFIG_DEBUG_FS)
650 static int ttm_resource_manager_show(struct seq_file *m, void *unused)
652 struct ttm_resource_manager *man =
653 (struct ttm_resource_manager *)m->private;
654 struct drm_printer p = drm_seq_file_printer(m);
655 ttm_resource_manager_debug(man, &p);
658 DEFINE_SHOW_ATTRIBUTE(ttm_resource_manager);
663 * ttm_resource_manager_create_debugfs - Create debugfs entry for specified
665 * @man: The TTM resource manager for which the debugfs stats file be creates
666 * @parent: debugfs directory in which the file will reside
667 * @name: The filename to create.
669 * This function setups up a debugfs file that can be used to look
670 * at debug statistics of the specified ttm_resource_manager.
672 void ttm_resource_manager_create_debugfs(struct ttm_resource_manager *man,
673 struct dentry * parent,
676 #if defined(CONFIG_DEBUG_FS)
677 debugfs_create_file(name, 0444, parent, man, &ttm_resource_manager_fops);
680 EXPORT_SYMBOL(ttm_resource_manager_create_debugfs);