1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
4 * Copyright (c) 2007-2009 VMware, Inc., Palo Alto, CA., USA
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sub license, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
25 * USE OR OTHER DEALINGS IN THE SOFTWARE.
27 **************************************************************************/
29 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
32 #include <drm/ttm/ttm_bo_driver.h>
33 #include <drm/ttm/ttm_placement.h>
34 #include <drm/drm_cache.h>
35 #include <drm/drm_vma_manager.h>
36 #include <linux/iosys-map.h>
38 #include <linux/highmem.h>
39 #include <linux/wait.h>
40 #include <linux/slab.h>
41 #include <linux/vmalloc.h>
42 #include <linux/module.h>
43 #include <linux/dma-resv.h>
45 struct ttm_transfer_obj {
46 struct ttm_buffer_object base;
47 struct ttm_buffer_object *bo;
50 int ttm_mem_io_reserve(struct ttm_device *bdev,
51 struct ttm_resource *mem)
53 if (mem->bus.offset || mem->bus.addr)
56 mem->bus.is_iomem = false;
57 if (!bdev->funcs->io_mem_reserve)
60 return bdev->funcs->io_mem_reserve(bdev, mem);
63 void ttm_mem_io_free(struct ttm_device *bdev,
64 struct ttm_resource *mem)
69 if (!mem->bus.offset && !mem->bus.addr)
72 if (bdev->funcs->io_mem_free)
73 bdev->funcs->io_mem_free(bdev, mem);
80 * ttm_move_memcpy - Helper to perform a memcpy ttm move operation.
81 * @clear: Whether to clear rather than copy.
82 * @num_pages: Number of pages of the operation.
83 * @dst_iter: A struct ttm_kmap_iter representing the destination resource.
84 * @src_iter: A struct ttm_kmap_iter representing the source resource.
86 * This function is intended to be able to move out async under a
87 * dma-fence if desired.
89 void ttm_move_memcpy(bool clear,
91 struct ttm_kmap_iter *dst_iter,
92 struct ttm_kmap_iter *src_iter)
94 const struct ttm_kmap_iter_ops *dst_ops = dst_iter->ops;
95 const struct ttm_kmap_iter_ops *src_ops = src_iter->ops;
96 struct iosys_map src_map, dst_map;
99 /* Single TTM move. NOP */
100 if (dst_ops->maps_tt && src_ops->maps_tt)
103 /* Don't move nonexistent data. Clear destination instead. */
105 for (i = 0; i < num_pages; ++i) {
106 dst_ops->map_local(dst_iter, &dst_map, i);
107 if (dst_map.is_iomem)
108 memset_io(dst_map.vaddr_iomem, 0, PAGE_SIZE);
110 memset(dst_map.vaddr, 0, PAGE_SIZE);
111 if (dst_ops->unmap_local)
112 dst_ops->unmap_local(dst_iter, &dst_map);
117 for (i = 0; i < num_pages; ++i) {
118 dst_ops->map_local(dst_iter, &dst_map, i);
119 src_ops->map_local(src_iter, &src_map, i);
121 drm_memcpy_from_wc(&dst_map, &src_map, PAGE_SIZE);
123 if (src_ops->unmap_local)
124 src_ops->unmap_local(src_iter, &src_map);
125 if (dst_ops->unmap_local)
126 dst_ops->unmap_local(dst_iter, &dst_map);
129 EXPORT_SYMBOL(ttm_move_memcpy);
131 int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
132 struct ttm_operation_ctx *ctx,
133 struct ttm_resource *dst_mem)
135 struct ttm_device *bdev = bo->bdev;
136 struct ttm_resource_manager *dst_man =
137 ttm_manager_type(bo->bdev, dst_mem->mem_type);
138 struct ttm_tt *ttm = bo->ttm;
139 struct ttm_resource *src_mem = bo->resource;
140 struct ttm_resource_manager *src_man =
141 ttm_manager_type(bdev, src_mem->mem_type);
143 struct ttm_kmap_iter_tt tt;
144 struct ttm_kmap_iter_linear_io io;
145 } _dst_iter, _src_iter;
146 struct ttm_kmap_iter *dst_iter, *src_iter;
150 if (ttm && ((ttm->page_flags & TTM_TT_FLAG_SWAPPED) ||
152 ret = ttm_tt_populate(bdev, ttm, ctx);
157 dst_iter = ttm_kmap_iter_linear_io_init(&_dst_iter.io, bdev, dst_mem);
158 if (PTR_ERR(dst_iter) == -EINVAL && dst_man->use_tt)
159 dst_iter = ttm_kmap_iter_tt_init(&_dst_iter.tt, bo->ttm);
160 if (IS_ERR(dst_iter))
161 return PTR_ERR(dst_iter);
163 src_iter = ttm_kmap_iter_linear_io_init(&_src_iter.io, bdev, src_mem);
164 if (PTR_ERR(src_iter) == -EINVAL && src_man->use_tt)
165 src_iter = ttm_kmap_iter_tt_init(&_src_iter.tt, bo->ttm);
166 if (IS_ERR(src_iter)) {
167 ret = PTR_ERR(src_iter);
171 clear = src_iter->ops->maps_tt && (!ttm || !ttm_tt_is_populated(ttm));
172 if (!(clear && ttm && !(ttm->page_flags & TTM_TT_FLAG_ZERO_ALLOC)))
173 ttm_move_memcpy(clear, dst_mem->num_pages, dst_iter, src_iter);
175 if (!src_iter->ops->maps_tt)
176 ttm_kmap_iter_linear_io_fini(&_src_iter.io, bdev, src_mem);
177 ttm_bo_move_sync_cleanup(bo, dst_mem);
180 if (!dst_iter->ops->maps_tt)
181 ttm_kmap_iter_linear_io_fini(&_dst_iter.io, bdev, dst_mem);
185 EXPORT_SYMBOL(ttm_bo_move_memcpy);
187 static void ttm_transfered_destroy(struct ttm_buffer_object *bo)
189 struct ttm_transfer_obj *fbo;
191 fbo = container_of(bo, struct ttm_transfer_obj, base);
192 dma_resv_fini(&fbo->base.base._resv);
198 * ttm_buffer_object_transfer
200 * @bo: A pointer to a struct ttm_buffer_object.
201 * @new_obj: A pointer to a pointer to a newly created ttm_buffer_object,
202 * holding the data of @bo with the old placement.
204 * This is a utility function that may be called after an accelerated move
205 * has been scheduled. A new buffer object is created as a placeholder for
206 * the old data while it's being copied. When that buffer object is idle,
207 * it can be destroyed, releasing the space of the old placement.
212 static int ttm_buffer_object_transfer(struct ttm_buffer_object *bo,
213 struct ttm_buffer_object **new_obj)
215 struct ttm_transfer_obj *fbo;
218 fbo = kmalloc(sizeof(*fbo), GFP_KERNEL);
225 * Fix up members that we shouldn't copy directly:
226 * TODO: Explicit member copy would probably be better here.
229 atomic_inc(&ttm_glob.bo_count);
230 INIT_LIST_HEAD(&fbo->base.ddestroy);
231 drm_vma_node_reset(&fbo->base.base.vma_node);
233 kref_init(&fbo->base.kref);
234 fbo->base.destroy = &ttm_transfered_destroy;
235 fbo->base.pin_count = 0;
236 if (bo->type != ttm_bo_type_sg)
237 fbo->base.base.resv = &fbo->base.base._resv;
239 dma_resv_init(&fbo->base.base._resv);
240 fbo->base.base.dev = NULL;
241 ret = dma_resv_trylock(&fbo->base.base._resv);
244 if (fbo->base.resource) {
245 ttm_resource_set_bo(fbo->base.resource, &fbo->base);
247 ttm_bo_set_bulk_move(&fbo->base, NULL);
249 fbo->base.bulk_move = NULL;
252 ret = dma_resv_reserve_fences(&fbo->base.base._resv, 1);
261 ttm_bo_move_to_lru_tail_unlocked(&fbo->base);
263 *new_obj = &fbo->base;
267 pgprot_t ttm_io_prot(struct ttm_buffer_object *bo, struct ttm_resource *res,
270 struct ttm_resource_manager *man;
271 enum ttm_caching caching;
273 man = ttm_manager_type(bo->bdev, res->mem_type);
274 caching = man->use_tt ? bo->ttm->caching : res->bus.caching;
276 return ttm_prot_from_caching(caching, tmp);
278 EXPORT_SYMBOL(ttm_io_prot);
280 static int ttm_bo_ioremap(struct ttm_buffer_object *bo,
281 unsigned long offset,
283 struct ttm_bo_kmap_obj *map)
285 struct ttm_resource *mem = bo->resource;
287 if (bo->resource->bus.addr) {
288 map->bo_kmap_type = ttm_bo_map_premapped;
289 map->virtual = ((u8 *)bo->resource->bus.addr) + offset;
291 resource_size_t res = bo->resource->bus.offset + offset;
293 map->bo_kmap_type = ttm_bo_map_iomap;
294 if (mem->bus.caching == ttm_write_combined)
295 map->virtual = ioremap_wc(res, size);
297 else if (mem->bus.caching == ttm_cached)
298 map->virtual = ioremap_cache(res, size);
301 map->virtual = ioremap(res, size);
303 return (!map->virtual) ? -ENOMEM : 0;
306 static int ttm_bo_kmap_ttm(struct ttm_buffer_object *bo,
307 unsigned long start_page,
308 unsigned long num_pages,
309 struct ttm_bo_kmap_obj *map)
311 struct ttm_resource *mem = bo->resource;
312 struct ttm_operation_ctx ctx = {
313 .interruptible = false,
316 struct ttm_tt *ttm = bo->ttm;
322 ret = ttm_tt_populate(bo->bdev, ttm, &ctx);
326 if (num_pages == 1 && ttm->caching == ttm_cached) {
328 * We're mapping a single page, and the desired
329 * page protection is consistent with the bo.
332 map->bo_kmap_type = ttm_bo_map_kmap;
333 map->page = ttm->pages[start_page];
334 map->virtual = kmap(map->page);
337 * We need to use vmap to get the desired page protection
338 * or to make the buffer object look contiguous.
340 prot = ttm_io_prot(bo, mem, PAGE_KERNEL);
341 map->bo_kmap_type = ttm_bo_map_vmap;
342 map->virtual = vmap(ttm->pages + start_page, num_pages,
345 return (!map->virtual) ? -ENOMEM : 0;
348 int ttm_bo_kmap(struct ttm_buffer_object *bo,
349 unsigned long start_page, unsigned long num_pages,
350 struct ttm_bo_kmap_obj *map)
352 unsigned long offset, size;
357 if (num_pages > bo->resource->num_pages)
359 if ((start_page + num_pages) > bo->resource->num_pages)
362 ret = ttm_mem_io_reserve(bo->bdev, bo->resource);
365 if (!bo->resource->bus.is_iomem) {
366 return ttm_bo_kmap_ttm(bo, start_page, num_pages, map);
368 offset = start_page << PAGE_SHIFT;
369 size = num_pages << PAGE_SHIFT;
370 return ttm_bo_ioremap(bo, offset, size, map);
373 EXPORT_SYMBOL(ttm_bo_kmap);
375 void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map)
379 switch (map->bo_kmap_type) {
380 case ttm_bo_map_iomap:
381 iounmap(map->virtual);
383 case ttm_bo_map_vmap:
384 vunmap(map->virtual);
386 case ttm_bo_map_kmap:
389 case ttm_bo_map_premapped:
394 ttm_mem_io_free(map->bo->bdev, map->bo->resource);
398 EXPORT_SYMBOL(ttm_bo_kunmap);
400 int ttm_bo_vmap(struct ttm_buffer_object *bo, struct iosys_map *map)
402 struct ttm_resource *mem = bo->resource;
405 ret = ttm_mem_io_reserve(bo->bdev, mem);
409 if (mem->bus.is_iomem) {
410 void __iomem *vaddr_iomem;
413 vaddr_iomem = (void __iomem *)mem->bus.addr;
414 else if (mem->bus.caching == ttm_write_combined)
415 vaddr_iomem = ioremap_wc(mem->bus.offset,
418 else if (mem->bus.caching == ttm_cached)
419 vaddr_iomem = ioremap_cache(mem->bus.offset,
423 vaddr_iomem = ioremap(mem->bus.offset, bo->base.size);
428 iosys_map_set_vaddr_iomem(map, vaddr_iomem);
431 struct ttm_operation_ctx ctx = {
432 .interruptible = false,
435 struct ttm_tt *ttm = bo->ttm;
439 ret = ttm_tt_populate(bo->bdev, ttm, &ctx);
444 * We need to use vmap to get the desired page protection
445 * or to make the buffer object look contiguous.
447 prot = ttm_io_prot(bo, mem, PAGE_KERNEL);
448 vaddr = vmap(ttm->pages, ttm->num_pages, 0, prot);
452 iosys_map_set_vaddr(map, vaddr);
457 EXPORT_SYMBOL(ttm_bo_vmap);
459 void ttm_bo_vunmap(struct ttm_buffer_object *bo, struct iosys_map *map)
461 struct ttm_resource *mem = bo->resource;
463 if (iosys_map_is_null(map))
468 else if (!mem->bus.addr)
469 iounmap(map->vaddr_iomem);
470 iosys_map_clear(map);
472 ttm_mem_io_free(bo->bdev, bo->resource);
474 EXPORT_SYMBOL(ttm_bo_vunmap);
476 static int ttm_bo_wait_free_node(struct ttm_buffer_object *bo,
480 ret = ttm_bo_wait(bo, false, false);
485 ttm_bo_tt_destroy(bo);
486 ttm_resource_free(bo, &bo->resource);
490 static int ttm_bo_move_to_ghost(struct ttm_buffer_object *bo,
491 struct dma_fence *fence,
494 struct ttm_buffer_object *ghost_obj;
498 * This should help pipeline ordinary buffer moves.
500 * Hang old buffer memory on a new buffer object,
501 * and leave it to be released when the GPU
502 * operation has completed.
505 ret = ttm_buffer_object_transfer(bo, &ghost_obj);
509 dma_resv_add_fence(&ghost_obj->base._resv, fence,
510 DMA_RESV_USAGE_KERNEL);
513 * If we're not moving to fixed memory, the TTM object
514 * needs to stay alive. Otherwhise hang it on the ghost
515 * bo to be unbound and destroyed.
519 ghost_obj->ttm = NULL;
523 dma_resv_unlock(&ghost_obj->base._resv);
524 ttm_bo_put(ghost_obj);
528 static void ttm_bo_move_pipeline_evict(struct ttm_buffer_object *bo,
529 struct dma_fence *fence)
531 struct ttm_device *bdev = bo->bdev;
532 struct ttm_resource_manager *from;
534 from = ttm_manager_type(bdev, bo->resource->mem_type);
537 * BO doesn't have a TTM we need to bind/unbind. Just remember
538 * this eviction and free up the allocation
540 spin_lock(&from->move_lock);
541 if (!from->move || dma_fence_is_later(fence, from->move)) {
542 dma_fence_put(from->move);
543 from->move = dma_fence_get(fence);
545 spin_unlock(&from->move_lock);
547 ttm_resource_free(bo, &bo->resource);
550 int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
551 struct dma_fence *fence,
554 struct ttm_resource *new_mem)
556 struct ttm_device *bdev = bo->bdev;
557 struct ttm_resource_manager *from = ttm_manager_type(bdev, bo->resource->mem_type);
558 struct ttm_resource_manager *man = ttm_manager_type(bdev, new_mem->mem_type);
561 dma_resv_add_fence(bo->base.resv, fence, DMA_RESV_USAGE_KERNEL);
563 ret = ttm_bo_move_to_ghost(bo, fence, man->use_tt);
564 else if (!from->use_tt && pipeline)
565 ttm_bo_move_pipeline_evict(bo, fence);
567 ret = ttm_bo_wait_free_node(bo, man->use_tt);
572 ttm_bo_assign_mem(bo, new_mem);
576 EXPORT_SYMBOL(ttm_bo_move_accel_cleanup);
578 void ttm_bo_move_sync_cleanup(struct ttm_buffer_object *bo,
579 struct ttm_resource *new_mem)
581 struct ttm_device *bdev = bo->bdev;
582 struct ttm_resource_manager *man = ttm_manager_type(bdev, new_mem->mem_type);
585 ret = ttm_bo_wait_free_node(bo, man->use_tt);
589 ttm_bo_assign_mem(bo, new_mem);
591 EXPORT_SYMBOL(ttm_bo_move_sync_cleanup);
594 * ttm_bo_pipeline_gutting - purge the contents of a bo
595 * @bo: The buffer object
597 * Purge the contents of a bo, async if the bo is not idle.
598 * After a successful call, the bo is left unpopulated in
599 * system placement. The function may wait uninterruptible
602 * Return: 0 if successful, negative error code on failure.
604 int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo)
606 static const struct ttm_place sys_mem = { .mem_type = TTM_PL_SYSTEM };
607 struct ttm_buffer_object *ghost;
608 struct ttm_resource *sys_res;
612 ret = ttm_resource_alloc(bo, &sys_mem, &sys_res);
616 /* If already idle, no need for ghost object dance. */
617 ret = ttm_bo_wait(bo, false, true);
620 /* See comment below about clearing. */
621 ret = ttm_tt_create(bo, true);
623 goto error_free_sys_mem;
625 ttm_tt_unpopulate(bo->bdev, bo->ttm);
626 if (bo->type == ttm_bo_type_device)
627 ttm_tt_mark_for_clear(bo->ttm);
629 ttm_resource_free(bo, &bo->resource);
630 ttm_bo_assign_mem(bo, sys_res);
635 * We need an unpopulated ttm_tt after giving our current one,
636 * if any, to the ghost object. And we can't afford to fail
637 * creating one *after* the operation. If the bo subsequently gets
638 * resurrected, make sure it's cleared (if ttm_bo_type_device)
639 * to avoid leaking sensitive information to user-space.
644 ret = ttm_tt_create(bo, true);
647 goto error_free_sys_mem;
649 ret = ttm_buffer_object_transfer(bo, &ghost);
651 goto error_destroy_tt;
653 ret = dma_resv_copy_fences(&ghost->base._resv, bo->base.resv);
654 /* Last resort, wait for the BO to be idle when we are OOM */
656 ttm_bo_wait(bo, false, false);
658 dma_resv_unlock(&ghost->base._resv);
661 ttm_bo_assign_mem(bo, sys_res);
665 ttm_tt_destroy(bo->bdev, ttm);
668 ttm_resource_free(bo, &sys_res);