1 /**************************************************************************
3 * Copyright © 2009 VMware, Inc., Palo Alto, CA., USA
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 * USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 #include "vmwgfx_drv.h"
29 #include <drm/vmwgfx_drm.h>
30 #include <drm/ttm/ttm_object.h>
31 #include <drm/ttm/ttm_placement.h>
33 #include "vmwgfx_resource_priv.h"
35 #define VMW_RES_EVICT_ERR_COUNT 10
37 struct vmw_user_dma_buffer {
38 struct ttm_prime_object prime;
39 struct vmw_dma_buffer dma;
42 struct vmw_bo_user_rep {
48 struct vmw_resource res;
52 struct vmw_user_stream {
53 struct ttm_base_object base;
54 struct vmw_stream stream;
58 static uint64_t vmw_user_stream_size;
60 static const struct vmw_res_func vmw_stream_func = {
61 .res_type = vmw_res_stream,
62 .needs_backup = false,
64 .type_name = "video streams",
65 .backup_placement = NULL,
72 static inline struct vmw_dma_buffer *
73 vmw_dma_buffer(struct ttm_buffer_object *bo)
75 return container_of(bo, struct vmw_dma_buffer, base);
78 static inline struct vmw_user_dma_buffer *
79 vmw_user_dma_buffer(struct ttm_buffer_object *bo)
81 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
82 return container_of(vmw_bo, struct vmw_user_dma_buffer, dma);
85 struct vmw_resource *vmw_resource_reference(struct vmw_resource *res)
93 * vmw_resource_release_id - release a resource id to the id manager.
95 * @res: Pointer to the resource.
97 * Release the resource id to the resource id manager and set it to -1
99 void vmw_resource_release_id(struct vmw_resource *res)
101 struct vmw_private *dev_priv = res->dev_priv;
102 struct idr *idr = &dev_priv->res_idr[res->func->res_type];
104 write_lock(&dev_priv->resource_lock);
106 idr_remove(idr, res->id);
108 write_unlock(&dev_priv->resource_lock);
111 static void vmw_resource_release(struct kref *kref)
113 struct vmw_resource *res =
114 container_of(kref, struct vmw_resource, kref);
115 struct vmw_private *dev_priv = res->dev_priv;
117 struct idr *idr = &dev_priv->res_idr[res->func->res_type];
120 list_del_init(&res->lru_head);
121 write_unlock(&dev_priv->resource_lock);
123 struct ttm_buffer_object *bo = &res->backup->base;
125 ttm_bo_reserve(bo, false, false, false, 0);
126 if (!list_empty(&res->mob_head) &&
127 res->func->unbind != NULL) {
128 struct ttm_validate_buffer val_buf;
131 res->func->unbind(res, false, &val_buf);
133 res->backup_dirty = false;
134 list_del_init(&res->mob_head);
135 ttm_bo_unreserve(bo);
136 vmw_dmabuf_unreference(&res->backup);
139 if (likely(res->hw_destroy != NULL))
140 res->hw_destroy(res);
143 if (res->res_free != NULL)
148 write_lock(&dev_priv->resource_lock);
154 void vmw_resource_unreference(struct vmw_resource **p_res)
156 struct vmw_resource *res = *p_res;
157 struct vmw_private *dev_priv = res->dev_priv;
160 write_lock(&dev_priv->resource_lock);
161 kref_put(&res->kref, vmw_resource_release);
162 write_unlock(&dev_priv->resource_lock);
167 * vmw_resource_alloc_id - release a resource id to the id manager.
169 * @res: Pointer to the resource.
171 * Allocate the lowest free resource from the resource manager, and set
172 * @res->id to that id. Returns 0 on success and -ENOMEM on failure.
174 int vmw_resource_alloc_id(struct vmw_resource *res)
176 struct vmw_private *dev_priv = res->dev_priv;
178 struct idr *idr = &dev_priv->res_idr[res->func->res_type];
180 BUG_ON(res->id != -1);
182 idr_preload(GFP_KERNEL);
183 write_lock(&dev_priv->resource_lock);
185 ret = idr_alloc(idr, res, 1, 0, GFP_NOWAIT);
189 write_unlock(&dev_priv->resource_lock);
191 return ret < 0 ? ret : 0;
195 * vmw_resource_init - initialize a struct vmw_resource
197 * @dev_priv: Pointer to a device private struct.
198 * @res: The struct vmw_resource to initialize.
199 * @obj_type: Resource object type.
200 * @delay_id: Boolean whether to defer device id allocation until
201 * the first validation.
202 * @res_free: Resource destructor.
203 * @func: Resource function table.
205 int vmw_resource_init(struct vmw_private *dev_priv, struct vmw_resource *res,
207 void (*res_free) (struct vmw_resource *res),
208 const struct vmw_res_func *func)
210 kref_init(&res->kref);
211 res->hw_destroy = NULL;
212 res->res_free = res_free;
214 res->dev_priv = dev_priv;
216 INIT_LIST_HEAD(&res->lru_head);
217 INIT_LIST_HEAD(&res->mob_head);
220 res->backup_offset = 0;
221 res->backup_dirty = false;
222 res->res_dirty = false;
226 return vmw_resource_alloc_id(res);
230 * vmw_resource_activate
232 * @res: Pointer to the newly created resource
233 * @hw_destroy: Destroy function. NULL if none.
235 * Activate a resource after the hardware has been made aware of it.
236 * Set tye destroy function to @destroy. Typically this frees the
237 * resource and destroys the hardware resources associated with it.
238 * Activate basically means that the function vmw_resource_lookup will
241 void vmw_resource_activate(struct vmw_resource *res,
242 void (*hw_destroy) (struct vmw_resource *))
244 struct vmw_private *dev_priv = res->dev_priv;
246 write_lock(&dev_priv->resource_lock);
248 res->hw_destroy = hw_destroy;
249 write_unlock(&dev_priv->resource_lock);
252 struct vmw_resource *vmw_resource_lookup(struct vmw_private *dev_priv,
253 struct idr *idr, int id)
255 struct vmw_resource *res;
257 read_lock(&dev_priv->resource_lock);
258 res = idr_find(idr, id);
259 if (res && res->avail)
260 kref_get(&res->kref);
263 read_unlock(&dev_priv->resource_lock);
265 if (unlikely(res == NULL))
272 * vmw_user_resource_lookup_handle - lookup a struct resource from a
273 * TTM user-space handle and perform basic type checks
275 * @dev_priv: Pointer to a device private struct
276 * @tfile: Pointer to a struct ttm_object_file identifying the caller
277 * @handle: The TTM user-space handle
278 * @converter: Pointer to an object describing the resource type
279 * @p_res: On successful return the location pointed to will contain
280 * a pointer to a refcounted struct vmw_resource.
282 * If the handle can't be found or is associated with an incorrect resource
283 * type, -EINVAL will be returned.
285 int vmw_user_resource_lookup_handle(struct vmw_private *dev_priv,
286 struct ttm_object_file *tfile,
288 const struct vmw_user_resource_conv
290 struct vmw_resource **p_res)
292 struct ttm_base_object *base;
293 struct vmw_resource *res;
296 base = ttm_base_object_lookup(tfile, handle);
297 if (unlikely(base == NULL))
300 if (unlikely(ttm_base_object_type(base) != converter->object_type))
301 goto out_bad_resource;
303 res = converter->base_obj_to_res(base);
305 read_lock(&dev_priv->resource_lock);
306 if (!res->avail || res->res_free != converter->res_free) {
307 read_unlock(&dev_priv->resource_lock);
308 goto out_bad_resource;
311 kref_get(&res->kref);
312 read_unlock(&dev_priv->resource_lock);
318 ttm_base_object_unref(&base);
324 * Helper function that looks either a surface or dmabuf.
326 * The pointer this pointed at by out_surf and out_buf needs to be null.
328 int vmw_user_lookup_handle(struct vmw_private *dev_priv,
329 struct ttm_object_file *tfile,
331 struct vmw_surface **out_surf,
332 struct vmw_dma_buffer **out_buf)
334 struct vmw_resource *res;
337 BUG_ON(*out_surf || *out_buf);
339 ret = vmw_user_resource_lookup_handle(dev_priv, tfile, handle,
340 user_surface_converter,
343 *out_surf = vmw_res_to_srf(res);
348 ret = vmw_user_dmabuf_lookup(tfile, handle, out_buf);
357 * vmw_dmabuf_acc_size - Calculate the pinned memory usage of buffers
359 * @dev_priv: Pointer to a struct vmw_private identifying the device.
360 * @size: The requested buffer size.
361 * @user: Whether this is an ordinary dma buffer or a user dma buffer.
363 static size_t vmw_dmabuf_acc_size(struct vmw_private *dev_priv, size_t size,
366 static size_t struct_size, user_struct_size;
367 size_t num_pages = PAGE_ALIGN(size) >> PAGE_SHIFT;
368 size_t page_array_size = ttm_round_pot(num_pages * sizeof(void *));
370 if (unlikely(struct_size == 0)) {
371 size_t backend_size = ttm_round_pot(vmw_tt_size);
373 struct_size = backend_size +
374 ttm_round_pot(sizeof(struct vmw_dma_buffer));
375 user_struct_size = backend_size +
376 ttm_round_pot(sizeof(struct vmw_user_dma_buffer));
379 if (dev_priv->map_mode == vmw_dma_alloc_coherent)
381 ttm_round_pot(num_pages * sizeof(dma_addr_t));
383 return ((user) ? user_struct_size : struct_size) +
387 void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo)
389 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
394 static void vmw_user_dmabuf_destroy(struct ttm_buffer_object *bo)
396 struct vmw_user_dma_buffer *vmw_user_bo = vmw_user_dma_buffer(bo);
398 ttm_prime_object_kfree(vmw_user_bo, prime);
401 int vmw_dmabuf_init(struct vmw_private *dev_priv,
402 struct vmw_dma_buffer *vmw_bo,
403 size_t size, struct ttm_placement *placement,
405 void (*bo_free) (struct ttm_buffer_object *bo))
407 struct ttm_bo_device *bdev = &dev_priv->bdev;
410 bool user = (bo_free == &vmw_user_dmabuf_destroy);
412 BUG_ON(!bo_free && (!user && (bo_free != vmw_dmabuf_bo_free)));
414 acc_size = vmw_dmabuf_acc_size(dev_priv, size, user);
415 memset(vmw_bo, 0, sizeof(*vmw_bo));
417 INIT_LIST_HEAD(&vmw_bo->res_list);
419 ret = ttm_bo_init(bdev, &vmw_bo->base, size,
420 (user) ? ttm_bo_type_device :
421 ttm_bo_type_kernel, placement,
423 NULL, acc_size, NULL, bo_free);
427 static void vmw_user_dmabuf_release(struct ttm_base_object **p_base)
429 struct vmw_user_dma_buffer *vmw_user_bo;
430 struct ttm_base_object *base = *p_base;
431 struct ttm_buffer_object *bo;
435 if (unlikely(base == NULL))
438 vmw_user_bo = container_of(base, struct vmw_user_dma_buffer,
440 bo = &vmw_user_bo->dma.base;
445 * vmw_user_dmabuf_alloc - Allocate a user dma buffer
447 * @dev_priv: Pointer to a struct device private.
448 * @tfile: Pointer to a struct ttm_object_file on which to register the user
450 * @size: Size of the dma buffer.
451 * @shareable: Boolean whether the buffer is shareable with other open files.
452 * @handle: Pointer to where the handle value should be assigned.
453 * @p_dma_buf: Pointer to where the refcounted struct vmw_dma_buffer pointer
454 * should be assigned.
456 int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
457 struct ttm_object_file *tfile,
461 struct vmw_dma_buffer **p_dma_buf)
463 struct vmw_user_dma_buffer *user_bo;
464 struct ttm_buffer_object *tmp;
467 user_bo = kzalloc(sizeof(*user_bo), GFP_KERNEL);
468 if (unlikely(user_bo == NULL)) {
469 DRM_ERROR("Failed to allocate a buffer.\n");
473 ret = vmw_dmabuf_init(dev_priv, &user_bo->dma, size,
474 &vmw_vram_sys_placement, true,
475 &vmw_user_dmabuf_destroy);
476 if (unlikely(ret != 0))
479 tmp = ttm_bo_reference(&user_bo->dma.base);
480 ret = ttm_prime_object_init(tfile,
485 &vmw_user_dmabuf_release, NULL);
486 if (unlikely(ret != 0)) {
488 goto out_no_base_object;
491 *p_dma_buf = &user_bo->dma;
492 *handle = user_bo->prime.base.hash.key;
499 * vmw_user_dmabuf_verify_access - verify access permissions on this
502 * @bo: Pointer to the buffer object being accessed
503 * @tfile: Identifying the caller.
505 int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
506 struct ttm_object_file *tfile)
508 struct vmw_user_dma_buffer *vmw_user_bo;
510 if (unlikely(bo->destroy != vmw_user_dmabuf_destroy))
513 vmw_user_bo = vmw_user_dma_buffer(bo);
514 return (vmw_user_bo->prime.base.tfile == tfile ||
515 vmw_user_bo->prime.base.shareable) ? 0 : -EPERM;
518 int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
519 struct drm_file *file_priv)
521 struct vmw_private *dev_priv = vmw_priv(dev);
522 union drm_vmw_alloc_dmabuf_arg *arg =
523 (union drm_vmw_alloc_dmabuf_arg *)data;
524 struct drm_vmw_alloc_dmabuf_req *req = &arg->req;
525 struct drm_vmw_dmabuf_rep *rep = &arg->rep;
526 struct vmw_dma_buffer *dma_buf;
528 struct vmw_master *vmaster = vmw_master(file_priv->master);
531 ret = ttm_read_lock(&vmaster->lock, true);
532 if (unlikely(ret != 0))
535 ret = vmw_user_dmabuf_alloc(dev_priv, vmw_fpriv(file_priv)->tfile,
536 req->size, false, &handle, &dma_buf);
537 if (unlikely(ret != 0))
540 rep->handle = handle;
541 rep->map_handle = drm_vma_node_offset_addr(&dma_buf->base.vma_node);
542 rep->cur_gmr_id = handle;
543 rep->cur_gmr_offset = 0;
545 vmw_dmabuf_unreference(&dma_buf);
548 ttm_read_unlock(&vmaster->lock);
553 int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
554 struct drm_file *file_priv)
556 struct drm_vmw_unref_dmabuf_arg *arg =
557 (struct drm_vmw_unref_dmabuf_arg *)data;
559 return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
564 int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
565 uint32_t handle, struct vmw_dma_buffer **out)
567 struct vmw_user_dma_buffer *vmw_user_bo;
568 struct ttm_base_object *base;
570 base = ttm_base_object_lookup(tfile, handle);
571 if (unlikely(base == NULL)) {
572 printk(KERN_ERR "Invalid buffer object handle 0x%08lx.\n",
573 (unsigned long)handle);
577 if (unlikely(ttm_base_object_type(base) != ttm_buffer_type)) {
578 ttm_base_object_unref(&base);
579 printk(KERN_ERR "Invalid buffer object handle 0x%08lx.\n",
580 (unsigned long)handle);
584 vmw_user_bo = container_of(base, struct vmw_user_dma_buffer,
586 (void)ttm_bo_reference(&vmw_user_bo->dma.base);
587 ttm_base_object_unref(&base);
588 *out = &vmw_user_bo->dma;
593 int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
594 struct vmw_dma_buffer *dma_buf)
596 struct vmw_user_dma_buffer *user_bo;
598 if (dma_buf->base.destroy != vmw_user_dmabuf_destroy)
601 user_bo = container_of(dma_buf, struct vmw_user_dma_buffer, dma);
602 return ttm_ref_object_add(tfile, &user_bo->prime.base,
603 TTM_REF_USAGE, NULL);
610 static void vmw_stream_destroy(struct vmw_resource *res)
612 struct vmw_private *dev_priv = res->dev_priv;
613 struct vmw_stream *stream;
616 DRM_INFO("%s: unref\n", __func__);
617 stream = container_of(res, struct vmw_stream, res);
619 ret = vmw_overlay_unref(dev_priv, stream->stream_id);
623 static int vmw_stream_init(struct vmw_private *dev_priv,
624 struct vmw_stream *stream,
625 void (*res_free) (struct vmw_resource *res))
627 struct vmw_resource *res = &stream->res;
630 ret = vmw_resource_init(dev_priv, res, false, res_free,
633 if (unlikely(ret != 0)) {
634 if (res_free == NULL)
637 res_free(&stream->res);
641 ret = vmw_overlay_claim(dev_priv, &stream->stream_id);
643 vmw_resource_unreference(&res);
647 DRM_INFO("%s: claimed\n", __func__);
649 vmw_resource_activate(&stream->res, vmw_stream_destroy);
653 static void vmw_user_stream_free(struct vmw_resource *res)
655 struct vmw_user_stream *stream =
656 container_of(res, struct vmw_user_stream, stream.res);
657 struct vmw_private *dev_priv = res->dev_priv;
659 ttm_base_object_kfree(stream, base);
660 ttm_mem_global_free(vmw_mem_glob(dev_priv),
661 vmw_user_stream_size);
665 * This function is called when user space has no more references on the
666 * base object. It releases the base-object's reference on the resource object.
669 static void vmw_user_stream_base_release(struct ttm_base_object **p_base)
671 struct ttm_base_object *base = *p_base;
672 struct vmw_user_stream *stream =
673 container_of(base, struct vmw_user_stream, base);
674 struct vmw_resource *res = &stream->stream.res;
677 vmw_resource_unreference(&res);
680 int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
681 struct drm_file *file_priv)
683 struct vmw_private *dev_priv = vmw_priv(dev);
684 struct vmw_resource *res;
685 struct vmw_user_stream *stream;
686 struct drm_vmw_stream_arg *arg = (struct drm_vmw_stream_arg *)data;
687 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
688 struct idr *idr = &dev_priv->res_idr[vmw_res_stream];
692 res = vmw_resource_lookup(dev_priv, idr, arg->stream_id);
693 if (unlikely(res == NULL))
696 if (res->res_free != &vmw_user_stream_free) {
701 stream = container_of(res, struct vmw_user_stream, stream.res);
702 if (stream->base.tfile != tfile) {
707 ttm_ref_object_base_unref(tfile, stream->base.hash.key, TTM_REF_USAGE);
709 vmw_resource_unreference(&res);
713 int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
714 struct drm_file *file_priv)
716 struct vmw_private *dev_priv = vmw_priv(dev);
717 struct vmw_user_stream *stream;
718 struct vmw_resource *res;
719 struct vmw_resource *tmp;
720 struct drm_vmw_stream_arg *arg = (struct drm_vmw_stream_arg *)data;
721 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
722 struct vmw_master *vmaster = vmw_master(file_priv->master);
726 * Approximate idr memory usage with 128 bytes. It will be limited
727 * by maximum number_of streams anyway?
730 if (unlikely(vmw_user_stream_size == 0))
731 vmw_user_stream_size = ttm_round_pot(sizeof(*stream)) + 128;
733 ret = ttm_read_lock(&vmaster->lock, true);
734 if (unlikely(ret != 0))
737 ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
738 vmw_user_stream_size,
740 if (unlikely(ret != 0)) {
741 if (ret != -ERESTARTSYS)
742 DRM_ERROR("Out of graphics memory for stream"
748 stream = kmalloc(sizeof(*stream), GFP_KERNEL);
749 if (unlikely(stream == NULL)) {
750 ttm_mem_global_free(vmw_mem_glob(dev_priv),
751 vmw_user_stream_size);
756 res = &stream->stream.res;
757 stream->base.shareable = false;
758 stream->base.tfile = NULL;
761 * From here on, the destructor takes over resource freeing.
764 ret = vmw_stream_init(dev_priv, &stream->stream, vmw_user_stream_free);
765 if (unlikely(ret != 0))
768 tmp = vmw_resource_reference(res);
769 ret = ttm_base_object_init(tfile, &stream->base, false, VMW_RES_STREAM,
770 &vmw_user_stream_base_release, NULL);
772 if (unlikely(ret != 0)) {
773 vmw_resource_unreference(&tmp);
777 arg->stream_id = res->id;
779 vmw_resource_unreference(&res);
781 ttm_read_unlock(&vmaster->lock);
785 int vmw_user_stream_lookup(struct vmw_private *dev_priv,
786 struct ttm_object_file *tfile,
787 uint32_t *inout_id, struct vmw_resource **out)
789 struct vmw_user_stream *stream;
790 struct vmw_resource *res;
793 res = vmw_resource_lookup(dev_priv, &dev_priv->res_idr[vmw_res_stream],
795 if (unlikely(res == NULL))
798 if (res->res_free != &vmw_user_stream_free) {
803 stream = container_of(res, struct vmw_user_stream, stream.res);
804 if (stream->base.tfile != tfile) {
809 *inout_id = stream->stream.stream_id;
813 vmw_resource_unreference(&res);
819 * vmw_dumb_create - Create a dumb kms buffer
821 * @file_priv: Pointer to a struct drm_file identifying the caller.
822 * @dev: Pointer to the drm device.
823 * @args: Pointer to a struct drm_mode_create_dumb structure
825 * This is a driver callback for the core drm create_dumb functionality.
826 * Note that this is very similar to the vmw_dmabuf_alloc ioctl, except
827 * that the arguments have a different format.
829 int vmw_dumb_create(struct drm_file *file_priv,
830 struct drm_device *dev,
831 struct drm_mode_create_dumb *args)
833 struct vmw_private *dev_priv = vmw_priv(dev);
834 struct vmw_master *vmaster = vmw_master(file_priv->master);
835 struct vmw_dma_buffer *dma_buf;
838 args->pitch = args->width * ((args->bpp + 7) / 8);
839 args->size = args->pitch * args->height;
841 ret = ttm_read_lock(&vmaster->lock, true);
842 if (unlikely(ret != 0))
845 ret = vmw_user_dmabuf_alloc(dev_priv, vmw_fpriv(file_priv)->tfile,
846 args->size, false, &args->handle,
848 if (unlikely(ret != 0))
851 vmw_dmabuf_unreference(&dma_buf);
853 ttm_read_unlock(&vmaster->lock);
858 * vmw_dumb_map_offset - Return the address space offset of a dumb buffer
860 * @file_priv: Pointer to a struct drm_file identifying the caller.
861 * @dev: Pointer to the drm device.
862 * @handle: Handle identifying the dumb buffer.
863 * @offset: The address space offset returned.
865 * This is a driver callback for the core drm dumb_map_offset functionality.
867 int vmw_dumb_map_offset(struct drm_file *file_priv,
868 struct drm_device *dev, uint32_t handle,
871 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
872 struct vmw_dma_buffer *out_buf;
875 ret = vmw_user_dmabuf_lookup(tfile, handle, &out_buf);
879 *offset = drm_vma_node_offset_addr(&out_buf->base.vma_node);
880 vmw_dmabuf_unreference(&out_buf);
885 * vmw_dumb_destroy - Destroy a dumb boffer
887 * @file_priv: Pointer to a struct drm_file identifying the caller.
888 * @dev: Pointer to the drm device.
889 * @handle: Handle identifying the dumb buffer.
891 * This is a driver callback for the core drm dumb_destroy functionality.
893 int vmw_dumb_destroy(struct drm_file *file_priv,
894 struct drm_device *dev,
897 return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
898 handle, TTM_REF_USAGE);
902 * vmw_resource_buf_alloc - Allocate a backup buffer for a resource.
904 * @res: The resource for which to allocate a backup buffer.
905 * @interruptible: Whether any sleeps during allocation should be
906 * performed while interruptible.
908 static int vmw_resource_buf_alloc(struct vmw_resource *res,
912 (res->backup_size + PAGE_SIZE - 1) & PAGE_MASK;
913 struct vmw_dma_buffer *backup;
916 if (likely(res->backup)) {
917 BUG_ON(res->backup->base.num_pages * PAGE_SIZE < size);
921 backup = kzalloc(sizeof(*backup), GFP_KERNEL);
922 if (unlikely(backup == NULL))
925 ret = vmw_dmabuf_init(res->dev_priv, backup, res->backup_size,
926 res->func->backup_placement,
928 &vmw_dmabuf_bo_free);
929 if (unlikely(ret != 0))
932 res->backup = backup;
939 * vmw_resource_do_validate - Make a resource up-to-date and visible
942 * @res: The resource to make visible to the device.
943 * @val_buf: Information about a buffer possibly
944 * containing backup data if a bind operation is needed.
946 * On hardware resource shortage, this function returns -EBUSY and
947 * should be retried once resources have been freed up.
949 static int vmw_resource_do_validate(struct vmw_resource *res,
950 struct ttm_validate_buffer *val_buf)
953 const struct vmw_res_func *func = res->func;
955 if (unlikely(res->id == -1)) {
956 ret = func->create(res);
957 if (unlikely(ret != 0))
962 ((func->needs_backup && list_empty(&res->mob_head) &&
963 val_buf->bo != NULL) ||
964 (!func->needs_backup && val_buf->bo != NULL))) {
965 ret = func->bind(res, val_buf);
966 if (unlikely(ret != 0))
967 goto out_bind_failed;
968 if (func->needs_backup)
969 list_add_tail(&res->mob_head, &res->backup->res_list);
973 * Only do this on write operations, and move to
974 * vmw_resource_unreserve if it can be called after
975 * backup buffers have been unreserved. Otherwise
978 res->res_dirty = true;
989 * vmw_resource_unreserve - Unreserve a resource previously reserved for
990 * command submission.
992 * @res: Pointer to the struct vmw_resource to unreserve.
993 * @new_backup: Pointer to new backup buffer if command submission
995 * @new_backup_offset: New backup offset if @new_backup is !NULL.
997 * Currently unreserving a resource means putting it back on the device's
998 * resource lru list, so that it can be evicted if necessary.
1000 void vmw_resource_unreserve(struct vmw_resource *res,
1001 struct vmw_dma_buffer *new_backup,
1002 unsigned long new_backup_offset)
1004 struct vmw_private *dev_priv = res->dev_priv;
1006 if (!list_empty(&res->lru_head))
1009 if (new_backup && new_backup != res->backup) {
1012 lockdep_assert_held(&res->backup->base.resv->lock.base);
1013 list_del_init(&res->mob_head);
1014 vmw_dmabuf_unreference(&res->backup);
1017 res->backup = vmw_dmabuf_reference(new_backup);
1018 lockdep_assert_held(&new_backup->base.resv->lock.base);
1019 list_add_tail(&res->mob_head, &new_backup->res_list);
1022 res->backup_offset = new_backup_offset;
1024 if (!res->func->may_evict || res->id == -1)
1027 write_lock(&dev_priv->resource_lock);
1028 list_add_tail(&res->lru_head,
1029 &res->dev_priv->res_lru[res->func->res_type]);
1030 write_unlock(&dev_priv->resource_lock);
1034 * vmw_resource_check_buffer - Check whether a backup buffer is needed
1035 * for a resource and in that case, allocate
1036 * one, reserve and validate it.
1038 * @res: The resource for which to allocate a backup buffer.
1039 * @interruptible: Whether any sleeps during allocation should be
1040 * performed while interruptible.
1041 * @val_buf: On successful return contains data about the
1042 * reserved and validated backup buffer.
1045 vmw_resource_check_buffer(struct vmw_resource *res,
1047 struct ttm_validate_buffer *val_buf)
1049 struct list_head val_list;
1050 bool backup_dirty = false;
1053 if (unlikely(res->backup == NULL)) {
1054 ret = vmw_resource_buf_alloc(res, interruptible);
1055 if (unlikely(ret != 0))
1059 INIT_LIST_HEAD(&val_list);
1060 val_buf->bo = ttm_bo_reference(&res->backup->base);
1061 list_add_tail(&val_buf->head, &val_list);
1062 ret = ttm_eu_reserve_buffers(NULL, &val_list);
1063 if (unlikely(ret != 0))
1064 goto out_no_reserve;
1066 if (res->func->needs_backup && list_empty(&res->mob_head))
1069 backup_dirty = res->backup_dirty;
1070 ret = ttm_bo_validate(&res->backup->base,
1071 res->func->backup_placement,
1074 if (unlikely(ret != 0))
1075 goto out_no_validate;
1080 ttm_eu_backoff_reservation(NULL, &val_list);
1082 ttm_bo_unref(&val_buf->bo);
1084 vmw_dmabuf_unreference(&res->backup);
1090 * vmw_resource_reserve - Reserve a resource for command submission
1092 * @res: The resource to reserve.
1094 * This function takes the resource off the LRU list and make sure
1095 * a backup buffer is present for guest-backed resources. However,
1096 * the buffer may not be bound to the resource at this point.
1099 int vmw_resource_reserve(struct vmw_resource *res, bool no_backup)
1101 struct vmw_private *dev_priv = res->dev_priv;
1104 write_lock(&dev_priv->resource_lock);
1105 list_del_init(&res->lru_head);
1106 write_unlock(&dev_priv->resource_lock);
1108 if (res->func->needs_backup && res->backup == NULL &&
1110 ret = vmw_resource_buf_alloc(res, true);
1111 if (unlikely(ret != 0))
1119 * vmw_resource_backoff_reservation - Unreserve and unreference a
1122 * @val_buf: Backup buffer information.
1125 vmw_resource_backoff_reservation(struct ttm_validate_buffer *val_buf)
1127 struct list_head val_list;
1129 if (likely(val_buf->bo == NULL))
1132 INIT_LIST_HEAD(&val_list);
1133 list_add_tail(&val_buf->head, &val_list);
1134 ttm_eu_backoff_reservation(NULL, &val_list);
1135 ttm_bo_unref(&val_buf->bo);
1139 * vmw_resource_do_evict - Evict a resource, and transfer its data
1140 * to a backup buffer.
1142 * @res: The resource to evict.
1143 * @interruptible: Whether to wait interruptible.
1145 int vmw_resource_do_evict(struct vmw_resource *res, bool interruptible)
1147 struct ttm_validate_buffer val_buf;
1148 const struct vmw_res_func *func = res->func;
1151 BUG_ON(!func->may_evict);
1154 ret = vmw_resource_check_buffer(res, interruptible, &val_buf);
1155 if (unlikely(ret != 0))
1158 if (unlikely(func->unbind != NULL &&
1159 (!func->needs_backup || !list_empty(&res->mob_head)))) {
1160 ret = func->unbind(res, res->res_dirty, &val_buf);
1161 if (unlikely(ret != 0))
1163 list_del_init(&res->mob_head);
1165 ret = func->destroy(res);
1166 res->backup_dirty = true;
1167 res->res_dirty = false;
1169 vmw_resource_backoff_reservation(&val_buf);
1176 * vmw_resource_validate - Make a resource up-to-date and visible
1179 * @res: The resource to make visible to the device.
1181 * On succesful return, any backup DMA buffer pointed to by @res->backup will
1182 * be reserved and validated.
1183 * On hardware resource shortage, this function will repeatedly evict
1184 * resources of the same type until the validation succeeds.
1186 int vmw_resource_validate(struct vmw_resource *res)
1189 struct vmw_resource *evict_res;
1190 struct vmw_private *dev_priv = res->dev_priv;
1191 struct list_head *lru_list = &dev_priv->res_lru[res->func->res_type];
1192 struct ttm_validate_buffer val_buf;
1193 unsigned err_count = 0;
1195 if (likely(!res->func->may_evict))
1200 val_buf.bo = &res->backup->base;
1202 ret = vmw_resource_do_validate(res, &val_buf);
1203 if (likely(ret != -EBUSY))
1206 write_lock(&dev_priv->resource_lock);
1207 if (list_empty(lru_list) || !res->func->may_evict) {
1208 DRM_ERROR("Out of device device resources "
1209 "for %s.\n", res->func->type_name);
1211 write_unlock(&dev_priv->resource_lock);
1215 evict_res = vmw_resource_reference
1216 (list_first_entry(lru_list, struct vmw_resource,
1218 list_del_init(&evict_res->lru_head);
1220 write_unlock(&dev_priv->resource_lock);
1222 ret = vmw_resource_do_evict(evict_res, true);
1223 if (unlikely(ret != 0)) {
1224 write_lock(&dev_priv->resource_lock);
1225 list_add_tail(&evict_res->lru_head, lru_list);
1226 write_unlock(&dev_priv->resource_lock);
1227 if (ret == -ERESTARTSYS ||
1228 ++err_count > VMW_RES_EVICT_ERR_COUNT) {
1229 vmw_resource_unreference(&evict_res);
1230 goto out_no_validate;
1234 vmw_resource_unreference(&evict_res);
1237 if (unlikely(ret != 0))
1238 goto out_no_validate;
1239 else if (!res->func->needs_backup && res->backup) {
1240 list_del_init(&res->mob_head);
1241 vmw_dmabuf_unreference(&res->backup);
1251 * vmw_fence_single_bo - Utility function to fence a single TTM buffer
1252 * object without unreserving it.
1254 * @bo: Pointer to the struct ttm_buffer_object to fence.
1255 * @fence: Pointer to the fence. If NULL, this function will
1256 * insert a fence into the command stream..
1258 * Contrary to the ttm_eu version of this function, it takes only
1259 * a single buffer object instead of a list, and it also doesn't
1260 * unreserve the buffer object, which needs to be done separately.
1262 void vmw_fence_single_bo(struct ttm_buffer_object *bo,
1263 struct vmw_fence_obj *fence)
1265 struct ttm_bo_device *bdev = bo->bdev;
1266 struct ttm_bo_driver *driver = bdev->driver;
1267 struct vmw_fence_obj *old_fence_obj;
1268 struct vmw_private *dev_priv =
1269 container_of(bdev, struct vmw_private, bdev);
1272 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
1274 driver->sync_obj_ref(fence);
1276 spin_lock(&bdev->fence_lock);
1278 old_fence_obj = bo->sync_obj;
1279 bo->sync_obj = fence;
1281 spin_unlock(&bdev->fence_lock);
1284 vmw_fence_obj_unreference(&old_fence_obj);
1288 * vmw_resource_move_notify - TTM move_notify_callback
1290 * @bo: The TTM buffer object about to move.
1291 * @mem: The truct ttm_mem_reg indicating to what memory
1292 * region the move is taking place.
1294 * For now does nothing.
1296 void vmw_resource_move_notify(struct ttm_buffer_object *bo,
1297 struct ttm_mem_reg *mem)
1302 * vmw_resource_needs_backup - Return whether a resource needs a backup buffer.
1304 * @res: The resource being queried.
1306 bool vmw_resource_needs_backup(const struct vmw_resource *res)
1308 return res->func->needs_backup;
1312 * vmw_resource_evict_type - Evict all resources of a specific type
1314 * @dev_priv: Pointer to a device private struct
1315 * @type: The resource type to evict
1317 * To avoid thrashing starvation or as part of the hibernation sequence,
1318 * try to evict all evictable resources of a specific type.
1320 static void vmw_resource_evict_type(struct vmw_private *dev_priv,
1321 enum vmw_res_type type)
1323 struct list_head *lru_list = &dev_priv->res_lru[type];
1324 struct vmw_resource *evict_res;
1325 unsigned err_count = 0;
1329 write_lock(&dev_priv->resource_lock);
1331 if (list_empty(lru_list))
1334 evict_res = vmw_resource_reference(
1335 list_first_entry(lru_list, struct vmw_resource,
1337 list_del_init(&evict_res->lru_head);
1338 write_unlock(&dev_priv->resource_lock);
1340 ret = vmw_resource_do_evict(evict_res, false);
1341 if (unlikely(ret != 0)) {
1342 write_lock(&dev_priv->resource_lock);
1343 list_add_tail(&evict_res->lru_head, lru_list);
1344 write_unlock(&dev_priv->resource_lock);
1345 if (++err_count > VMW_RES_EVICT_ERR_COUNT) {
1346 vmw_resource_unreference(&evict_res);
1351 vmw_resource_unreference(&evict_res);
1355 write_unlock(&dev_priv->resource_lock);
1359 * vmw_resource_evict_all - Evict all evictable resources
1361 * @dev_priv: Pointer to a device private struct
1363 * To avoid thrashing starvation or as part of the hibernation sequence,
1364 * evict all evictable resources. In particular this means that all
1365 * guest-backed resources that are registered with the device are
1366 * evicted and the OTable becomes clean.
1368 void vmw_resource_evict_all(struct vmw_private *dev_priv)
1370 enum vmw_res_type type;
1372 mutex_lock(&dev_priv->cmdbuf_mutex);
1374 for (type = 0; type < vmw_res_max; ++type)
1375 vmw_resource_evict_type(dev_priv, type);
1377 mutex_unlock(&dev_priv->cmdbuf_mutex);