1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 /**************************************************************************
4 * Copyright © 2011-2023 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 #include "vmwgfx_bo.h"
30 #include "vmwgfx_drv.h"
33 #include <drm/ttm/ttm_placement.h>
35 static void vmw_bo_release(struct vmw_bo *vbo)
37 WARN_ON(vbo->tbo.base.funcs &&
38 kref_read(&vbo->tbo.base.refcount) != 0);
40 drm_gem_object_release(&vbo->tbo.base);
44 * vmw_bo_free - vmw_bo destructor
46 * @bo: Pointer to the embedded struct ttm_buffer_object
48 static void vmw_bo_free(struct ttm_buffer_object *bo)
50 struct vmw_bo *vbo = to_vmw_bo(&bo->base);
53 WARN_ON(!RB_EMPTY_ROOT(&vbo->res_tree));
59 * vmw_bo_pin_in_placement - Validate a buffer to placement.
61 * @dev_priv: Driver private.
62 * @buf: DMA buffer to move.
63 * @placement: The placement to pin it.
64 * @interruptible: Use interruptible wait.
65 * Return: Zero on success, Negative error code on failure. In particular
66 * -ERESTARTSYS if interrupted by a signal
68 static int vmw_bo_pin_in_placement(struct vmw_private *dev_priv,
70 struct ttm_placement *placement,
73 struct ttm_operation_ctx ctx = {interruptible, false };
74 struct ttm_buffer_object *bo = &buf->tbo;
77 vmw_execbuf_release_pinned_bo(dev_priv);
79 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
80 if (unlikely(ret != 0))
83 ret = ttm_bo_validate(bo, placement, &ctx);
85 vmw_bo_pin_reserved(buf, true);
94 * vmw_bo_pin_in_vram_or_gmr - Move a buffer to vram or gmr.
96 * This function takes the reservation_sem in write mode.
97 * Flushes and unpins the query bo to avoid failures.
99 * @dev_priv: Driver private.
100 * @buf: DMA buffer to move.
101 * @interruptible: Use interruptible wait.
102 * Return: Zero on success, Negative error code on failure. In particular
103 * -ERESTARTSYS if interrupted by a signal
105 int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
109 struct ttm_operation_ctx ctx = {interruptible, false };
110 struct ttm_buffer_object *bo = &buf->tbo;
113 vmw_execbuf_release_pinned_bo(dev_priv);
115 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
116 if (unlikely(ret != 0))
119 vmw_bo_placement_set(buf,
120 VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM,
122 ret = ttm_bo_validate(bo, &buf->placement, &ctx);
123 if (likely(ret == 0) || ret == -ERESTARTSYS)
126 vmw_bo_placement_set(buf,
129 ret = ttm_bo_validate(bo, &buf->placement, &ctx);
133 vmw_bo_pin_reserved(buf, true);
135 ttm_bo_unreserve(bo);
142 * vmw_bo_pin_in_vram - Move a buffer to vram.
144 * This function takes the reservation_sem in write mode.
145 * Flushes and unpins the query bo to avoid failures.
147 * @dev_priv: Driver private.
148 * @buf: DMA buffer to move.
149 * @interruptible: Use interruptible wait.
150 * Return: Zero on success, Negative error code on failure. In particular
151 * -ERESTARTSYS if interrupted by a signal
153 int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
157 return vmw_bo_pin_in_placement(dev_priv, buf, &vmw_vram_placement,
163 * vmw_bo_pin_in_start_of_vram - Move a buffer to start of vram.
165 * This function takes the reservation_sem in write mode.
166 * Flushes and unpins the query bo to avoid failures.
168 * @dev_priv: Driver private.
169 * @buf: DMA buffer to pin.
170 * @interruptible: Use interruptible wait.
171 * Return: Zero on success, Negative error code on failure. In particular
172 * -ERESTARTSYS if interrupted by a signal
174 int vmw_bo_pin_in_start_of_vram(struct vmw_private *dev_priv,
178 struct ttm_operation_ctx ctx = {interruptible, false };
179 struct ttm_buffer_object *bo = &buf->tbo;
182 vmw_execbuf_release_pinned_bo(dev_priv);
183 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
184 if (unlikely(ret != 0))
188 * Is this buffer already in vram but not at the start of it?
189 * In that case, evict it first because TTM isn't good at handling
192 if (bo->resource->mem_type == TTM_PL_VRAM &&
193 bo->resource->start < PFN_UP(bo->resource->size) &&
194 bo->resource->start > 0 &&
195 buf->tbo.pin_count == 0) {
196 ctx.interruptible = false;
197 vmw_bo_placement_set(buf,
200 (void)ttm_bo_validate(bo, &buf->placement, &ctx);
203 vmw_bo_placement_set(buf,
206 buf->places[0].lpfn = PFN_UP(bo->resource->size);
207 ret = ttm_bo_validate(bo, &buf->placement, &ctx);
209 /* For some reason we didn't end up at the start of vram */
210 WARN_ON(ret == 0 && bo->resource->start != 0);
212 vmw_bo_pin_reserved(buf, true);
214 ttm_bo_unreserve(bo);
222 * vmw_bo_unpin - Unpin the buffer given buffer, does not move the buffer.
224 * This function takes the reservation_sem in write mode.
226 * @dev_priv: Driver private.
227 * @buf: DMA buffer to unpin.
228 * @interruptible: Use interruptible wait.
229 * Return: Zero on success, Negative error code on failure. In particular
230 * -ERESTARTSYS if interrupted by a signal
232 int vmw_bo_unpin(struct vmw_private *dev_priv,
236 struct ttm_buffer_object *bo = &buf->tbo;
239 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
240 if (unlikely(ret != 0))
243 vmw_bo_pin_reserved(buf, false);
245 ttm_bo_unreserve(bo);
252 * vmw_bo_get_guest_ptr - Get the guest ptr representing the current placement
255 * @bo: Pointer to a struct ttm_buffer_object. Must be pinned or reserved.
256 * @ptr: SVGAGuestPtr returning the result.
258 void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *bo,
261 if (bo->resource->mem_type == TTM_PL_VRAM) {
262 ptr->gmrId = SVGA_GMR_FRAMEBUFFER;
263 ptr->offset = bo->resource->start << PAGE_SHIFT;
265 ptr->gmrId = bo->resource->start;
272 * vmw_bo_pin_reserved - Pin or unpin a buffer object without moving it.
274 * @vbo: The buffer object. Must be reserved.
275 * @pin: Whether to pin or unpin.
278 void vmw_bo_pin_reserved(struct vmw_bo *vbo, bool pin)
280 struct ttm_operation_ctx ctx = { false, true };
282 struct ttm_placement placement;
283 struct ttm_buffer_object *bo = &vbo->tbo;
284 uint32_t old_mem_type = bo->resource->mem_type;
287 dma_resv_assert_held(bo->base.resv);
289 if (pin == !!bo->pin_count)
294 pl.mem_type = bo->resource->mem_type;
295 pl.flags = bo->resource->placement;
297 memset(&placement, 0, sizeof(placement));
298 placement.num_placement = 1;
299 placement.placement = &pl;
301 ret = ttm_bo_validate(bo, &placement, &ctx);
303 BUG_ON(ret != 0 || bo->resource->mem_type != old_mem_type);
312 * vmw_bo_map_and_cache - Map a buffer object and cache the map
314 * @vbo: The buffer object to map
315 * Return: A kernel virtual address or NULL if mapping failed.
317 * This function maps a buffer object into the kernel address space, or
318 * returns the virtual kernel address of an already existing map. The virtual
319 * address remains valid as long as the buffer object is pinned or reserved.
320 * The cached map is torn down on either
321 * 1) Buffer object move
322 * 2) Buffer object swapout
323 * 3) Buffer object destruction
326 void *vmw_bo_map_and_cache(struct vmw_bo *vbo)
328 struct ttm_buffer_object *bo = &vbo->tbo;
333 virtual = ttm_kmap_obj_virtual(&vbo->map, ¬_used);
337 ret = ttm_bo_kmap(bo, 0, PFN_UP(bo->base.size), &vbo->map);
339 DRM_ERROR("Buffer object map failed: %d.\n", ret);
341 return ttm_kmap_obj_virtual(&vbo->map, ¬_used);
346 * vmw_bo_unmap - Tear down a cached buffer object map.
348 * @vbo: The buffer object whose map we are tearing down.
350 * This function tears down a cached map set up using
351 * vmw_bo_map_and_cache().
353 void vmw_bo_unmap(struct vmw_bo *vbo)
355 if (vbo->map.bo == NULL)
358 ttm_bo_kunmap(&vbo->map);
364 * vmw_bo_init - Initialize a vmw buffer object
366 * @dev_priv: Pointer to the device private struct
367 * @vmw_bo: Buffer object to initialize
368 * @params: Parameters used to initialize the buffer object
369 * @destroy: The function used to delete the buffer object
370 * Returns: Zero on success, negative error code on error.
373 static int vmw_bo_init(struct vmw_private *dev_priv,
374 struct vmw_bo *vmw_bo,
375 struct vmw_bo_params *params,
376 void (*destroy)(struct ttm_buffer_object *))
378 struct ttm_operation_ctx ctx = {
379 .interruptible = params->bo_type != ttm_bo_type_kernel,
382 struct ttm_device *bdev = &dev_priv->bdev;
383 struct drm_device *vdev = &dev_priv->drm;
386 memset(vmw_bo, 0, sizeof(*vmw_bo));
388 BUILD_BUG_ON(TTM_MAX_BO_PRIORITY <= 3);
389 vmw_bo->tbo.priority = 3;
390 vmw_bo->res_tree = RB_ROOT;
392 params->size = ALIGN(params->size, PAGE_SIZE);
393 drm_gem_private_object_init(vdev, &vmw_bo->tbo.base, params->size);
395 vmw_bo_placement_set(vmw_bo, params->domain, params->busy_domain);
396 ret = ttm_bo_init_reserved(bdev, &vmw_bo->tbo, params->bo_type,
397 &vmw_bo->placement, 0, &ctx, NULL,
403 ttm_bo_pin(&vmw_bo->tbo);
404 ttm_bo_unreserve(&vmw_bo->tbo);
409 int vmw_bo_create(struct vmw_private *vmw,
410 struct vmw_bo_params *params,
411 struct vmw_bo **p_bo)
415 *p_bo = kmalloc(sizeof(**p_bo), GFP_KERNEL);
416 if (unlikely(!*p_bo)) {
417 DRM_ERROR("Failed to allocate a buffer.\n");
422 * vmw_bo_init will delete the *p_bo object if it fails
424 ret = vmw_bo_init(vmw, *p_bo, params, vmw_bo_free);
425 if (unlikely(ret != 0))
435 * vmw_user_bo_synccpu_grab - Grab a struct vmw_bo for cpu
436 * access, idling previous GPU operations on the buffer and optionally
437 * blocking it for further command submissions.
439 * @vmw_bo: Pointer to the buffer object being grabbed for CPU access
440 * @flags: Flags indicating how the grab should be performed.
441 * Return: Zero on success, Negative error code on error. In particular,
442 * -EBUSY will be returned if a dontblock operation is requested and the
443 * buffer object is busy, and -ERESTARTSYS will be returned if a wait is
444 * interrupted by a signal.
446 * A blocking grab will be automatically released when @tfile is closed.
448 static int vmw_user_bo_synccpu_grab(struct vmw_bo *vmw_bo,
451 bool nonblock = !!(flags & drm_vmw_synccpu_dontblock);
452 struct ttm_buffer_object *bo = &vmw_bo->tbo;
455 if (flags & drm_vmw_synccpu_allow_cs) {
458 lret = dma_resv_wait_timeout(bo->base.resv, DMA_RESV_USAGE_READ,
460 MAX_SCHEDULE_TIMEOUT);
468 ret = ttm_bo_reserve(bo, true, nonblock, NULL);
469 if (unlikely(ret != 0))
472 ret = ttm_bo_wait(bo, true, nonblock);
473 if (likely(ret == 0))
474 atomic_inc(&vmw_bo->cpu_writers);
476 ttm_bo_unreserve(bo);
477 if (unlikely(ret != 0))
484 * vmw_user_bo_synccpu_release - Release a previous grab for CPU access,
485 * and unblock command submission on the buffer if blocked.
487 * @filp: Identifying the caller.
488 * @handle: Handle identifying the buffer object.
489 * @flags: Flags indicating the type of release.
491 static int vmw_user_bo_synccpu_release(struct drm_file *filp,
495 struct vmw_bo *vmw_bo;
496 int ret = vmw_user_bo_lookup(filp, handle, &vmw_bo);
499 if (!(flags & drm_vmw_synccpu_allow_cs)) {
500 atomic_dec(&vmw_bo->cpu_writers);
502 vmw_user_bo_unref(&vmw_bo);
510 * vmw_user_bo_synccpu_ioctl - ioctl function implementing the synccpu
513 * @dev: Identifies the drm device.
514 * @data: Pointer to the ioctl argument.
515 * @file_priv: Identifies the caller.
516 * Return: Zero on success, negative error code on error.
518 * This function checks the ioctl arguments for validity and calls the
519 * relevant synccpu functions.
521 int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
522 struct drm_file *file_priv)
524 struct drm_vmw_synccpu_arg *arg =
525 (struct drm_vmw_synccpu_arg *) data;
529 if ((arg->flags & (drm_vmw_synccpu_read | drm_vmw_synccpu_write)) == 0
530 || (arg->flags & ~(drm_vmw_synccpu_read | drm_vmw_synccpu_write |
531 drm_vmw_synccpu_dontblock |
532 drm_vmw_synccpu_allow_cs)) != 0) {
533 DRM_ERROR("Illegal synccpu flags.\n");
538 case drm_vmw_synccpu_grab:
539 ret = vmw_user_bo_lookup(file_priv, arg->handle, &vbo);
540 if (unlikely(ret != 0))
543 ret = vmw_user_bo_synccpu_grab(vbo, arg->flags);
544 vmw_user_bo_unref(&vbo);
545 if (unlikely(ret != 0)) {
546 if (ret == -ERESTARTSYS || ret == -EBUSY)
548 DRM_ERROR("Failed synccpu grab on handle 0x%08x.\n",
549 (unsigned int) arg->handle);
553 case drm_vmw_synccpu_release:
554 ret = vmw_user_bo_synccpu_release(file_priv,
557 if (unlikely(ret != 0)) {
558 DRM_ERROR("Failed synccpu release on handle 0x%08x.\n",
559 (unsigned int) arg->handle);
564 DRM_ERROR("Invalid synccpu operation.\n");
572 * vmw_bo_unref_ioctl - Generic handle close ioctl.
574 * @dev: Identifies the drm device.
575 * @data: Pointer to the ioctl argument.
576 * @file_priv: Identifies the caller.
577 * Return: Zero on success, negative error code on error.
579 * This function checks the ioctl arguments for validity and closes a
580 * handle to a TTM base object, optionally freeing the object.
582 int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
583 struct drm_file *file_priv)
585 struct drm_vmw_unref_dmabuf_arg *arg =
586 (struct drm_vmw_unref_dmabuf_arg *)data;
588 return drm_gem_handle_delete(file_priv, arg->handle);
593 * vmw_user_bo_lookup - Look up a vmw user buffer object from a handle.
595 * @filp: The file the handle is registered with.
596 * @handle: The user buffer object handle
597 * @out: Pointer to a where a pointer to the embedded
598 * struct vmw_bo should be placed.
599 * Return: Zero on success, Negative error code on error.
601 * The vmw buffer object pointer will be refcounted (both ttm and gem)
603 int vmw_user_bo_lookup(struct drm_file *filp,
607 struct drm_gem_object *gobj;
609 gobj = drm_gem_object_lookup(filp, handle);
611 DRM_ERROR("Invalid buffer object handle 0x%08lx.\n",
612 (unsigned long)handle);
616 *out = to_vmw_bo(gobj);
622 * vmw_bo_fence_single - Utility function to fence a single TTM buffer
623 * object without unreserving it.
625 * @bo: Pointer to the struct ttm_buffer_object to fence.
626 * @fence: Pointer to the fence. If NULL, this function will
627 * insert a fence into the command stream..
629 * Contrary to the ttm_eu version of this function, it takes only
630 * a single buffer object instead of a list, and it also doesn't
631 * unreserve the buffer object, which needs to be done separately.
633 void vmw_bo_fence_single(struct ttm_buffer_object *bo,
634 struct vmw_fence_obj *fence)
636 struct ttm_device *bdev = bo->bdev;
637 struct vmw_private *dev_priv = vmw_priv_from_ttm(bdev);
641 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
643 dma_fence_get(&fence->base);
645 ret = dma_resv_reserve_fences(bo->base.resv, 1);
647 dma_resv_add_fence(bo->base.resv, &fence->base,
648 DMA_RESV_USAGE_KERNEL);
650 /* Last resort fallback when we are OOM */
651 dma_fence_wait(&fence->base, false);
652 dma_fence_put(&fence->base);
657 * vmw_dumb_create - Create a dumb kms buffer
659 * @file_priv: Pointer to a struct drm_file identifying the caller.
660 * @dev: Pointer to the drm device.
661 * @args: Pointer to a struct drm_mode_create_dumb structure
662 * Return: Zero on success, negative error code on failure.
664 * This is a driver callback for the core drm create_dumb functionality.
665 * Note that this is very similar to the vmw_bo_alloc ioctl, except
666 * that the arguments have a different format.
668 int vmw_dumb_create(struct drm_file *file_priv,
669 struct drm_device *dev,
670 struct drm_mode_create_dumb *args)
672 struct vmw_private *dev_priv = vmw_priv(dev);
674 int cpp = DIV_ROUND_UP(args->bpp, 8);
678 case 1: /* DRM_FORMAT_C8 */
679 case 2: /* DRM_FORMAT_RGB565 */
680 case 4: /* DRM_FORMAT_XRGB8888 */
684 * Dumb buffers don't allow anything else.
685 * This is tested via IGT's dumb_buffers
690 args->pitch = args->width * cpp;
691 args->size = ALIGN(args->pitch * args->height, PAGE_SIZE);
693 ret = vmw_gem_object_create_with_handle(dev_priv, file_priv,
694 args->size, &args->handle,
696 /* drop reference from allocate - handle holds it now */
697 drm_gem_object_put(&vbo->tbo.base);
702 * vmw_bo_swap_notify - swapout notify callback.
704 * @bo: The buffer object to be swapped out.
706 void vmw_bo_swap_notify(struct ttm_buffer_object *bo)
708 /* Kill any cached kernel maps before swapout */
709 vmw_bo_unmap(to_vmw_bo(&bo->base));
714 * vmw_bo_move_notify - TTM move_notify_callback
716 * @bo: The TTM buffer object about to move.
717 * @mem: The struct ttm_resource indicating to what memory
718 * region the move is taking place.
720 * Detaches cached maps and device bindings that require that the
721 * buffer doesn't move.
723 void vmw_bo_move_notify(struct ttm_buffer_object *bo,
724 struct ttm_resource *mem)
726 struct vmw_bo *vbo = to_vmw_bo(&bo->base);
729 * Kill any cached kernel maps before move to or from VRAM.
730 * With other types of moves, the underlying pages stay the same,
731 * and the map can be kept.
733 if (mem->mem_type == TTM_PL_VRAM || bo->resource->mem_type == TTM_PL_VRAM)
737 * If we're moving a backup MOB out of MOB placement, then make sure we
738 * read back all resource content first, and unbind the MOB from
741 if (mem->mem_type != VMW_PL_MOB && bo->resource->mem_type == VMW_PL_MOB)
742 vmw_resource_unbind_list(vbo);
746 set_placement_list(struct ttm_place *pl, u32 domain)
751 * The placements are ordered according to our preferences
753 if (domain & VMW_BO_DOMAIN_MOB) {
754 pl[n].mem_type = VMW_PL_MOB;
760 if (domain & VMW_BO_DOMAIN_GMR) {
761 pl[n].mem_type = VMW_PL_GMR;
767 if (domain & VMW_BO_DOMAIN_VRAM) {
768 pl[n].mem_type = TTM_PL_VRAM;
774 if (domain & VMW_BO_DOMAIN_WAITABLE_SYS) {
775 pl[n].mem_type = VMW_PL_SYSTEM;
781 if (domain & VMW_BO_DOMAIN_SYS) {
782 pl[n].mem_type = TTM_PL_SYSTEM;
791 pl[n].mem_type = TTM_PL_SYSTEM;
800 void vmw_bo_placement_set(struct vmw_bo *bo, u32 domain, u32 busy_domain)
802 struct ttm_device *bdev = bo->tbo.bdev;
803 struct vmw_private *vmw = vmw_priv_from_ttm(bdev);
804 struct ttm_placement *pl = &bo->placement;
805 bool mem_compatible = false;
808 pl->placement = bo->places;
809 pl->num_placement = set_placement_list(bo->places, domain);
811 if (drm_debug_enabled(DRM_UT_DRIVER) && bo->tbo.resource) {
812 for (i = 0; i < pl->num_placement; ++i) {
813 if (bo->tbo.resource->mem_type == TTM_PL_SYSTEM ||
814 bo->tbo.resource->mem_type == pl->placement[i].mem_type)
815 mem_compatible = true;
819 "%s: Incompatible transition from "
820 "bo->base.resource->mem_type = %u to domain = %u\n",
821 __func__, bo->tbo.resource->mem_type, domain);
824 pl->busy_placement = bo->busy_places;
825 pl->num_busy_placement = set_placement_list(bo->busy_places, busy_domain);
828 void vmw_bo_placement_set_default_accelerated(struct vmw_bo *bo)
830 struct ttm_device *bdev = bo->tbo.bdev;
831 struct vmw_private *vmw = vmw_priv_from_ttm(bdev);
832 u32 domain = VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM;
835 domain = VMW_BO_DOMAIN_MOB;
837 vmw_bo_placement_set(bo, domain, domain);