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)
38 drm_gem_object_release(&vbo->tbo.base);
42 * vmw_bo_free - vmw_bo destructor
44 * @bo: Pointer to the embedded struct ttm_buffer_object
46 static void vmw_bo_free(struct ttm_buffer_object *bo)
48 struct vmw_bo *vbo = to_vmw_bo(&bo->base);
51 WARN_ON(!RB_EMPTY_ROOT(&vbo->res_tree));
57 * vmw_bo_pin_in_placement - Validate a buffer to placement.
59 * @dev_priv: Driver private.
60 * @buf: DMA buffer to move.
61 * @placement: The placement to pin it.
62 * @interruptible: Use interruptible wait.
63 * Return: Zero on success, Negative error code on failure. In particular
64 * -ERESTARTSYS if interrupted by a signal
66 static int vmw_bo_pin_in_placement(struct vmw_private *dev_priv,
68 struct ttm_placement *placement,
71 struct ttm_operation_ctx ctx = {interruptible, false };
72 struct ttm_buffer_object *bo = &buf->tbo;
75 vmw_execbuf_release_pinned_bo(dev_priv);
77 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
78 if (unlikely(ret != 0))
81 ret = ttm_bo_validate(bo, placement, &ctx);
83 vmw_bo_pin_reserved(buf, true);
92 * vmw_bo_pin_in_vram_or_gmr - Move a buffer to vram or gmr.
94 * This function takes the reservation_sem in write mode.
95 * Flushes and unpins the query bo to avoid failures.
97 * @dev_priv: Driver private.
98 * @buf: DMA buffer to move.
99 * @interruptible: Use interruptible wait.
100 * Return: Zero on success, Negative error code on failure. In particular
101 * -ERESTARTSYS if interrupted by a signal
103 int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
107 struct ttm_operation_ctx ctx = {interruptible, false };
108 struct ttm_buffer_object *bo = &buf->tbo;
111 vmw_execbuf_release_pinned_bo(dev_priv);
113 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
114 if (unlikely(ret != 0))
117 vmw_bo_placement_set(buf,
118 VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM,
120 ret = ttm_bo_validate(bo, &buf->placement, &ctx);
121 if (likely(ret == 0) || ret == -ERESTARTSYS)
124 vmw_bo_placement_set(buf,
127 ret = ttm_bo_validate(bo, &buf->placement, &ctx);
131 vmw_bo_pin_reserved(buf, true);
133 ttm_bo_unreserve(bo);
140 * vmw_bo_pin_in_vram - Move a buffer to vram.
142 * This function takes the reservation_sem in write mode.
143 * Flushes and unpins the query bo to avoid failures.
145 * @dev_priv: Driver private.
146 * @buf: DMA buffer to move.
147 * @interruptible: Use interruptible wait.
148 * Return: Zero on success, Negative error code on failure. In particular
149 * -ERESTARTSYS if interrupted by a signal
151 int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
155 return vmw_bo_pin_in_placement(dev_priv, buf, &vmw_vram_placement,
161 * vmw_bo_pin_in_start_of_vram - Move a buffer to start of vram.
163 * This function takes the reservation_sem in write mode.
164 * Flushes and unpins the query bo to avoid failures.
166 * @dev_priv: Driver private.
167 * @buf: DMA buffer to pin.
168 * @interruptible: Use interruptible wait.
169 * Return: Zero on success, Negative error code on failure. In particular
170 * -ERESTARTSYS if interrupted by a signal
172 int vmw_bo_pin_in_start_of_vram(struct vmw_private *dev_priv,
176 struct ttm_operation_ctx ctx = {interruptible, false };
177 struct ttm_buffer_object *bo = &buf->tbo;
180 vmw_execbuf_release_pinned_bo(dev_priv);
181 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
182 if (unlikely(ret != 0))
186 * Is this buffer already in vram but not at the start of it?
187 * In that case, evict it first because TTM isn't good at handling
190 if (bo->resource->mem_type == TTM_PL_VRAM &&
191 bo->resource->start < PFN_UP(bo->resource->size) &&
192 bo->resource->start > 0 &&
193 buf->tbo.pin_count == 0) {
194 ctx.interruptible = false;
195 vmw_bo_placement_set(buf,
198 (void)ttm_bo_validate(bo, &buf->placement, &ctx);
201 vmw_bo_placement_set(buf,
204 buf->places[0].lpfn = PFN_UP(bo->resource->size);
205 ret = ttm_bo_validate(bo, &buf->placement, &ctx);
207 /* For some reason we didn't end up at the start of vram */
208 WARN_ON(ret == 0 && bo->resource->start != 0);
210 vmw_bo_pin_reserved(buf, true);
212 ttm_bo_unreserve(bo);
220 * vmw_bo_unpin - Unpin the buffer given buffer, does not move the buffer.
222 * This function takes the reservation_sem in write mode.
224 * @dev_priv: Driver private.
225 * @buf: DMA buffer to unpin.
226 * @interruptible: Use interruptible wait.
227 * Return: Zero on success, Negative error code on failure. In particular
228 * -ERESTARTSYS if interrupted by a signal
230 int vmw_bo_unpin(struct vmw_private *dev_priv,
234 struct ttm_buffer_object *bo = &buf->tbo;
237 ret = ttm_bo_reserve(bo, interruptible, false, NULL);
238 if (unlikely(ret != 0))
241 vmw_bo_pin_reserved(buf, false);
243 ttm_bo_unreserve(bo);
250 * vmw_bo_get_guest_ptr - Get the guest ptr representing the current placement
253 * @bo: Pointer to a struct ttm_buffer_object. Must be pinned or reserved.
254 * @ptr: SVGAGuestPtr returning the result.
256 void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *bo,
259 if (bo->resource->mem_type == TTM_PL_VRAM) {
260 ptr->gmrId = SVGA_GMR_FRAMEBUFFER;
261 ptr->offset = bo->resource->start << PAGE_SHIFT;
263 ptr->gmrId = bo->resource->start;
270 * vmw_bo_pin_reserved - Pin or unpin a buffer object without moving it.
272 * @vbo: The buffer object. Must be reserved.
273 * @pin: Whether to pin or unpin.
276 void vmw_bo_pin_reserved(struct vmw_bo *vbo, bool pin)
278 struct ttm_operation_ctx ctx = { false, true };
280 struct ttm_placement placement;
281 struct ttm_buffer_object *bo = &vbo->tbo;
282 uint32_t old_mem_type = bo->resource->mem_type;
285 dma_resv_assert_held(bo->base.resv);
287 if (pin == !!bo->pin_count)
292 pl.mem_type = bo->resource->mem_type;
293 pl.flags = bo->resource->placement;
295 memset(&placement, 0, sizeof(placement));
296 placement.num_placement = 1;
297 placement.placement = &pl;
299 ret = ttm_bo_validate(bo, &placement, &ctx);
301 BUG_ON(ret != 0 || bo->resource->mem_type != old_mem_type);
310 * vmw_bo_map_and_cache - Map a buffer object and cache the map
312 * @vbo: The buffer object to map
313 * Return: A kernel virtual address or NULL if mapping failed.
315 * This function maps a buffer object into the kernel address space, or
316 * returns the virtual kernel address of an already existing map. The virtual
317 * address remains valid as long as the buffer object is pinned or reserved.
318 * The cached map is torn down on either
319 * 1) Buffer object move
320 * 2) Buffer object swapout
321 * 3) Buffer object destruction
324 void *vmw_bo_map_and_cache(struct vmw_bo *vbo)
326 struct ttm_buffer_object *bo = &vbo->tbo;
331 virtual = ttm_kmap_obj_virtual(&vbo->map, ¬_used);
335 ret = ttm_bo_kmap(bo, 0, PFN_UP(bo->base.size), &vbo->map);
337 DRM_ERROR("Buffer object map failed: %d.\n", ret);
339 return ttm_kmap_obj_virtual(&vbo->map, ¬_used);
344 * vmw_bo_unmap - Tear down a cached buffer object map.
346 * @vbo: The buffer object whose map we are tearing down.
348 * This function tears down a cached map set up using
349 * vmw_bo_map_and_cache().
351 void vmw_bo_unmap(struct vmw_bo *vbo)
353 if (vbo->map.bo == NULL)
356 ttm_bo_kunmap(&vbo->map);
362 * vmw_bo_init - Initialize a vmw buffer object
364 * @dev_priv: Pointer to the device private struct
365 * @vmw_bo: Buffer object to initialize
366 * @params: Parameters used to initialize the buffer object
367 * @destroy: The function used to delete the buffer object
368 * Returns: Zero on success, negative error code on error.
371 static int vmw_bo_init(struct vmw_private *dev_priv,
372 struct vmw_bo *vmw_bo,
373 struct vmw_bo_params *params,
374 void (*destroy)(struct ttm_buffer_object *))
376 struct ttm_operation_ctx ctx = {
377 .interruptible = params->bo_type != ttm_bo_type_kernel,
380 struct ttm_device *bdev = &dev_priv->bdev;
381 struct drm_device *vdev = &dev_priv->drm;
384 memset(vmw_bo, 0, sizeof(*vmw_bo));
386 BUILD_BUG_ON(TTM_MAX_BO_PRIORITY <= 3);
387 vmw_bo->tbo.priority = 3;
388 vmw_bo->res_tree = RB_ROOT;
390 params->size = ALIGN(params->size, PAGE_SIZE);
391 drm_gem_private_object_init(vdev, &vmw_bo->tbo.base, params->size);
393 vmw_bo_placement_set(vmw_bo, params->domain, params->busy_domain);
394 ret = ttm_bo_init_reserved(bdev, &vmw_bo->tbo, params->bo_type,
395 &vmw_bo->placement, 0, &ctx, NULL,
401 ttm_bo_pin(&vmw_bo->tbo);
402 ttm_bo_unreserve(&vmw_bo->tbo);
407 int vmw_bo_create(struct vmw_private *vmw,
408 struct vmw_bo_params *params,
409 struct vmw_bo **p_bo)
413 *p_bo = kmalloc(sizeof(**p_bo), GFP_KERNEL);
414 if (unlikely(!*p_bo)) {
415 DRM_ERROR("Failed to allocate a buffer.\n");
419 ret = vmw_bo_init(vmw, *p_bo, params, vmw_bo_free);
420 if (unlikely(ret != 0))
431 * vmw_user_bo_synccpu_grab - Grab a struct vmw_bo for cpu
432 * access, idling previous GPU operations on the buffer and optionally
433 * blocking it for further command submissions.
435 * @vmw_bo: Pointer to the buffer object being grabbed for CPU access
436 * @flags: Flags indicating how the grab should be performed.
437 * Return: Zero on success, Negative error code on error. In particular,
438 * -EBUSY will be returned if a dontblock operation is requested and the
439 * buffer object is busy, and -ERESTARTSYS will be returned if a wait is
440 * interrupted by a signal.
442 * A blocking grab will be automatically released when @tfile is closed.
444 static int vmw_user_bo_synccpu_grab(struct vmw_bo *vmw_bo,
447 bool nonblock = !!(flags & drm_vmw_synccpu_dontblock);
448 struct ttm_buffer_object *bo = &vmw_bo->tbo;
451 if (flags & drm_vmw_synccpu_allow_cs) {
454 lret = dma_resv_wait_timeout(bo->base.resv, DMA_RESV_USAGE_READ,
456 MAX_SCHEDULE_TIMEOUT);
464 ret = ttm_bo_reserve(bo, true, nonblock, NULL);
465 if (unlikely(ret != 0))
468 ret = ttm_bo_wait(bo, true, nonblock);
469 if (likely(ret == 0))
470 atomic_inc(&vmw_bo->cpu_writers);
472 ttm_bo_unreserve(bo);
473 if (unlikely(ret != 0))
480 * vmw_user_bo_synccpu_release - Release a previous grab for CPU access,
481 * and unblock command submission on the buffer if blocked.
483 * @filp: Identifying the caller.
484 * @handle: Handle identifying the buffer object.
485 * @flags: Flags indicating the type of release.
487 static int vmw_user_bo_synccpu_release(struct drm_file *filp,
491 struct vmw_bo *vmw_bo;
492 int ret = vmw_user_bo_lookup(filp, handle, &vmw_bo);
495 if (!(flags & drm_vmw_synccpu_allow_cs)) {
496 atomic_dec(&vmw_bo->cpu_writers);
498 ttm_bo_put(&vmw_bo->tbo);
506 * vmw_user_bo_synccpu_ioctl - ioctl function implementing the synccpu
509 * @dev: Identifies the drm device.
510 * @data: Pointer to the ioctl argument.
511 * @file_priv: Identifies the caller.
512 * Return: Zero on success, negative error code on error.
514 * This function checks the ioctl arguments for validity and calls the
515 * relevant synccpu functions.
517 int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
518 struct drm_file *file_priv)
520 struct drm_vmw_synccpu_arg *arg =
521 (struct drm_vmw_synccpu_arg *) data;
525 if ((arg->flags & (drm_vmw_synccpu_read | drm_vmw_synccpu_write)) == 0
526 || (arg->flags & ~(drm_vmw_synccpu_read | drm_vmw_synccpu_write |
527 drm_vmw_synccpu_dontblock |
528 drm_vmw_synccpu_allow_cs)) != 0) {
529 DRM_ERROR("Illegal synccpu flags.\n");
534 case drm_vmw_synccpu_grab:
535 ret = vmw_user_bo_lookup(file_priv, arg->handle, &vbo);
536 if (unlikely(ret != 0))
539 ret = vmw_user_bo_synccpu_grab(vbo, arg->flags);
540 vmw_bo_unreference(&vbo);
541 if (unlikely(ret != 0)) {
542 if (ret == -ERESTARTSYS || ret == -EBUSY)
544 DRM_ERROR("Failed synccpu grab on handle 0x%08x.\n",
545 (unsigned int) arg->handle);
549 case drm_vmw_synccpu_release:
550 ret = vmw_user_bo_synccpu_release(file_priv,
553 if (unlikely(ret != 0)) {
554 DRM_ERROR("Failed synccpu release on handle 0x%08x.\n",
555 (unsigned int) arg->handle);
560 DRM_ERROR("Invalid synccpu operation.\n");
568 * vmw_bo_unref_ioctl - Generic handle close ioctl.
570 * @dev: Identifies the drm device.
571 * @data: Pointer to the ioctl argument.
572 * @file_priv: Identifies the caller.
573 * Return: Zero on success, negative error code on error.
575 * This function checks the ioctl arguments for validity and closes a
576 * handle to a TTM base object, optionally freeing the object.
578 int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
579 struct drm_file *file_priv)
581 struct drm_vmw_unref_dmabuf_arg *arg =
582 (struct drm_vmw_unref_dmabuf_arg *)data;
584 return drm_gem_handle_delete(file_priv, arg->handle);
589 * vmw_user_bo_lookup - Look up a vmw user buffer object from a handle.
591 * @filp: The file the handle is registered with.
592 * @handle: The user buffer object handle
593 * @out: Pointer to a where a pointer to the embedded
594 * struct vmw_bo should be placed.
595 * Return: Zero on success, Negative error code on error.
597 * The vmw buffer object pointer will be refcounted.
599 int vmw_user_bo_lookup(struct drm_file *filp,
603 struct drm_gem_object *gobj;
605 gobj = drm_gem_object_lookup(filp, handle);
607 DRM_ERROR("Invalid buffer object handle 0x%08lx.\n",
608 (unsigned long)handle);
612 *out = to_vmw_bo(gobj);
613 ttm_bo_get(&(*out)->tbo);
614 drm_gem_object_put(gobj);
620 * vmw_bo_fence_single - Utility function to fence a single TTM buffer
621 * object without unreserving it.
623 * @bo: Pointer to the struct ttm_buffer_object to fence.
624 * @fence: Pointer to the fence. If NULL, this function will
625 * insert a fence into the command stream..
627 * Contrary to the ttm_eu version of this function, it takes only
628 * a single buffer object instead of a list, and it also doesn't
629 * unreserve the buffer object, which needs to be done separately.
631 void vmw_bo_fence_single(struct ttm_buffer_object *bo,
632 struct vmw_fence_obj *fence)
634 struct ttm_device *bdev = bo->bdev;
635 struct vmw_private *dev_priv = vmw_priv_from_ttm(bdev);
639 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
641 dma_fence_get(&fence->base);
643 ret = dma_resv_reserve_fences(bo->base.resv, 1);
645 dma_resv_add_fence(bo->base.resv, &fence->base,
646 DMA_RESV_USAGE_KERNEL);
648 /* Last resort fallback when we are OOM */
649 dma_fence_wait(&fence->base, false);
650 dma_fence_put(&fence->base);
655 * vmw_dumb_create - Create a dumb kms buffer
657 * @file_priv: Pointer to a struct drm_file identifying the caller.
658 * @dev: Pointer to the drm device.
659 * @args: Pointer to a struct drm_mode_create_dumb structure
660 * Return: Zero on success, negative error code on failure.
662 * This is a driver callback for the core drm create_dumb functionality.
663 * Note that this is very similar to the vmw_bo_alloc ioctl, except
664 * that the arguments have a different format.
666 int vmw_dumb_create(struct drm_file *file_priv,
667 struct drm_device *dev,
668 struct drm_mode_create_dumb *args)
670 struct vmw_private *dev_priv = vmw_priv(dev);
672 int cpp = DIV_ROUND_UP(args->bpp, 8);
676 case 1: /* DRM_FORMAT_C8 */
677 case 2: /* DRM_FORMAT_RGB565 */
678 case 4: /* DRM_FORMAT_XRGB8888 */
682 * Dumb buffers don't allow anything else.
683 * This is tested via IGT's dumb_buffers
688 args->pitch = args->width * cpp;
689 args->size = ALIGN(args->pitch * args->height, PAGE_SIZE);
691 ret = vmw_gem_object_create_with_handle(dev_priv, file_priv,
692 args->size, &args->handle,
699 * vmw_bo_swap_notify - swapout notify callback.
701 * @bo: The buffer object to be swapped out.
703 void vmw_bo_swap_notify(struct ttm_buffer_object *bo)
705 /* Kill any cached kernel maps before swapout */
706 vmw_bo_unmap(to_vmw_bo(&bo->base));
711 * vmw_bo_move_notify - TTM move_notify_callback
713 * @bo: The TTM buffer object about to move.
714 * @mem: The struct ttm_resource indicating to what memory
715 * region the move is taking place.
717 * Detaches cached maps and device bindings that require that the
718 * buffer doesn't move.
720 void vmw_bo_move_notify(struct ttm_buffer_object *bo,
721 struct ttm_resource *mem)
723 struct vmw_bo *vbo = to_vmw_bo(&bo->base);
726 * Kill any cached kernel maps before move to or from VRAM.
727 * With other types of moves, the underlying pages stay the same,
728 * and the map can be kept.
730 if (mem->mem_type == TTM_PL_VRAM || bo->resource->mem_type == TTM_PL_VRAM)
734 * If we're moving a backup MOB out of MOB placement, then make sure we
735 * read back all resource content first, and unbind the MOB from
738 if (mem->mem_type != VMW_PL_MOB && bo->resource->mem_type == VMW_PL_MOB)
739 vmw_resource_unbind_list(vbo);
743 set_placement_list(struct ttm_place *pl, u32 domain)
748 * The placements are ordered according to our preferences
750 if (domain & VMW_BO_DOMAIN_MOB) {
751 pl[n].mem_type = VMW_PL_MOB;
757 if (domain & VMW_BO_DOMAIN_GMR) {
758 pl[n].mem_type = VMW_PL_GMR;
764 if (domain & VMW_BO_DOMAIN_VRAM) {
765 pl[n].mem_type = TTM_PL_VRAM;
771 if (domain & VMW_BO_DOMAIN_WAITABLE_SYS) {
772 pl[n].mem_type = VMW_PL_SYSTEM;
778 if (domain & VMW_BO_DOMAIN_SYS) {
779 pl[n].mem_type = TTM_PL_SYSTEM;
788 pl[n].mem_type = TTM_PL_SYSTEM;
797 void vmw_bo_placement_set(struct vmw_bo *bo, u32 domain, u32 busy_domain)
799 struct ttm_device *bdev = bo->tbo.bdev;
800 struct vmw_private *vmw = vmw_priv_from_ttm(bdev);
801 struct ttm_placement *pl = &bo->placement;
802 bool mem_compatible = false;
805 pl->placement = bo->places;
806 pl->num_placement = set_placement_list(bo->places, domain);
808 if (drm_debug_enabled(DRM_UT_DRIVER) && bo->tbo.resource) {
809 for (i = 0; i < pl->num_placement; ++i) {
810 if (bo->tbo.resource->mem_type == TTM_PL_SYSTEM ||
811 bo->tbo.resource->mem_type == pl->placement[i].mem_type)
812 mem_compatible = true;
816 "%s: Incompatible transition from "
817 "bo->base.resource->mem_type = %u to domain = %u\n",
818 __func__, bo->tbo.resource->mem_type, domain);
821 pl->busy_placement = bo->busy_places;
822 pl->num_busy_placement = set_placement_list(bo->busy_places, busy_domain);
825 void vmw_bo_placement_set_default_accelerated(struct vmw_bo *bo)
827 struct ttm_device *bdev = bo->tbo.bdev;
828 struct vmw_private *vmw = vmw_priv_from_ttm(bdev);
829 u32 domain = VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM;
832 domain = VMW_BO_DOMAIN_MOB;
834 vmw_bo_placement_set(bo, domain, domain);