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);
355 void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo)
357 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
362 int vmw_dmabuf_init(struct vmw_private *dev_priv,
363 struct vmw_dma_buffer *vmw_bo,
364 size_t size, struct ttm_placement *placement,
366 void (*bo_free) (struct ttm_buffer_object *bo))
368 struct ttm_bo_device *bdev = &dev_priv->bdev;
374 acc_size = ttm_bo_acc_size(bdev, size, sizeof(struct vmw_dma_buffer));
375 memset(vmw_bo, 0, sizeof(*vmw_bo));
377 INIT_LIST_HEAD(&vmw_bo->res_list);
379 ret = ttm_bo_init(bdev, &vmw_bo->base, size,
380 ttm_bo_type_device, placement,
382 NULL, acc_size, NULL, bo_free);
386 static void vmw_user_dmabuf_destroy(struct ttm_buffer_object *bo)
388 struct vmw_user_dma_buffer *vmw_user_bo = vmw_user_dma_buffer(bo);
390 ttm_prime_object_kfree(vmw_user_bo, prime);
393 static void vmw_user_dmabuf_release(struct ttm_base_object **p_base)
395 struct vmw_user_dma_buffer *vmw_user_bo;
396 struct ttm_base_object *base = *p_base;
397 struct ttm_buffer_object *bo;
401 if (unlikely(base == NULL))
404 vmw_user_bo = container_of(base, struct vmw_user_dma_buffer,
406 bo = &vmw_user_bo->dma.base;
411 * vmw_user_dmabuf_alloc - Allocate a user dma buffer
413 * @dev_priv: Pointer to a struct device private.
414 * @tfile: Pointer to a struct ttm_object_file on which to register the user
416 * @size: Size of the dma buffer.
417 * @shareable: Boolean whether the buffer is shareable with other open files.
418 * @handle: Pointer to where the handle value should be assigned.
419 * @p_dma_buf: Pointer to where the refcounted struct vmw_dma_buffer pointer
420 * should be assigned.
422 int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
423 struct ttm_object_file *tfile,
427 struct vmw_dma_buffer **p_dma_buf)
429 struct vmw_user_dma_buffer *user_bo;
430 struct ttm_buffer_object *tmp;
433 user_bo = kzalloc(sizeof(*user_bo), GFP_KERNEL);
434 if (unlikely(user_bo == NULL)) {
435 DRM_ERROR("Failed to allocate a buffer.\n");
439 ret = vmw_dmabuf_init(dev_priv, &user_bo->dma, size,
440 &vmw_vram_sys_placement, true,
441 &vmw_user_dmabuf_destroy);
442 if (unlikely(ret != 0))
445 tmp = ttm_bo_reference(&user_bo->dma.base);
446 ret = ttm_prime_object_init(tfile,
451 &vmw_user_dmabuf_release, NULL);
452 if (unlikely(ret != 0)) {
454 goto out_no_base_object;
457 *p_dma_buf = &user_bo->dma;
458 *handle = user_bo->prime.base.hash.key;
465 * vmw_user_dmabuf_verify_access - verify access permissions on this
468 * @bo: Pointer to the buffer object being accessed
469 * @tfile: Identifying the caller.
471 int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
472 struct ttm_object_file *tfile)
474 struct vmw_user_dma_buffer *vmw_user_bo;
476 if (unlikely(bo->destroy != vmw_user_dmabuf_destroy))
479 vmw_user_bo = vmw_user_dma_buffer(bo);
480 return (vmw_user_bo->prime.base.tfile == tfile ||
481 vmw_user_bo->prime.base.shareable) ? 0 : -EPERM;
484 int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
485 struct drm_file *file_priv)
487 struct vmw_private *dev_priv = vmw_priv(dev);
488 union drm_vmw_alloc_dmabuf_arg *arg =
489 (union drm_vmw_alloc_dmabuf_arg *)data;
490 struct drm_vmw_alloc_dmabuf_req *req = &arg->req;
491 struct drm_vmw_dmabuf_rep *rep = &arg->rep;
492 struct vmw_dma_buffer *dma_buf;
494 struct vmw_master *vmaster = vmw_master(file_priv->master);
497 ret = ttm_read_lock(&vmaster->lock, true);
498 if (unlikely(ret != 0))
501 ret = vmw_user_dmabuf_alloc(dev_priv, vmw_fpriv(file_priv)->tfile,
502 req->size, false, &handle, &dma_buf);
503 if (unlikely(ret != 0))
506 rep->handle = handle;
507 rep->map_handle = drm_vma_node_offset_addr(&dma_buf->base.vma_node);
508 rep->cur_gmr_id = handle;
509 rep->cur_gmr_offset = 0;
511 vmw_dmabuf_unreference(&dma_buf);
514 ttm_read_unlock(&vmaster->lock);
519 int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
520 struct drm_file *file_priv)
522 struct drm_vmw_unref_dmabuf_arg *arg =
523 (struct drm_vmw_unref_dmabuf_arg *)data;
525 return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
530 int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
531 uint32_t handle, struct vmw_dma_buffer **out)
533 struct vmw_user_dma_buffer *vmw_user_bo;
534 struct ttm_base_object *base;
536 base = ttm_base_object_lookup(tfile, handle);
537 if (unlikely(base == NULL)) {
538 printk(KERN_ERR "Invalid buffer object handle 0x%08lx.\n",
539 (unsigned long)handle);
543 if (unlikely(ttm_base_object_type(base) != ttm_buffer_type)) {
544 ttm_base_object_unref(&base);
545 printk(KERN_ERR "Invalid buffer object handle 0x%08lx.\n",
546 (unsigned long)handle);
550 vmw_user_bo = container_of(base, struct vmw_user_dma_buffer,
552 (void)ttm_bo_reference(&vmw_user_bo->dma.base);
553 ttm_base_object_unref(&base);
554 *out = &vmw_user_bo->dma;
559 int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
560 struct vmw_dma_buffer *dma_buf)
562 struct vmw_user_dma_buffer *user_bo;
564 if (dma_buf->base.destroy != vmw_user_dmabuf_destroy)
567 user_bo = container_of(dma_buf, struct vmw_user_dma_buffer, dma);
568 return ttm_ref_object_add(tfile, &user_bo->prime.base,
569 TTM_REF_USAGE, NULL);
576 static void vmw_stream_destroy(struct vmw_resource *res)
578 struct vmw_private *dev_priv = res->dev_priv;
579 struct vmw_stream *stream;
582 DRM_INFO("%s: unref\n", __func__);
583 stream = container_of(res, struct vmw_stream, res);
585 ret = vmw_overlay_unref(dev_priv, stream->stream_id);
589 static int vmw_stream_init(struct vmw_private *dev_priv,
590 struct vmw_stream *stream,
591 void (*res_free) (struct vmw_resource *res))
593 struct vmw_resource *res = &stream->res;
596 ret = vmw_resource_init(dev_priv, res, false, res_free,
599 if (unlikely(ret != 0)) {
600 if (res_free == NULL)
603 res_free(&stream->res);
607 ret = vmw_overlay_claim(dev_priv, &stream->stream_id);
609 vmw_resource_unreference(&res);
613 DRM_INFO("%s: claimed\n", __func__);
615 vmw_resource_activate(&stream->res, vmw_stream_destroy);
619 static void vmw_user_stream_free(struct vmw_resource *res)
621 struct vmw_user_stream *stream =
622 container_of(res, struct vmw_user_stream, stream.res);
623 struct vmw_private *dev_priv = res->dev_priv;
625 ttm_base_object_kfree(stream, base);
626 ttm_mem_global_free(vmw_mem_glob(dev_priv),
627 vmw_user_stream_size);
631 * This function is called when user space has no more references on the
632 * base object. It releases the base-object's reference on the resource object.
635 static void vmw_user_stream_base_release(struct ttm_base_object **p_base)
637 struct ttm_base_object *base = *p_base;
638 struct vmw_user_stream *stream =
639 container_of(base, struct vmw_user_stream, base);
640 struct vmw_resource *res = &stream->stream.res;
643 vmw_resource_unreference(&res);
646 int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
647 struct drm_file *file_priv)
649 struct vmw_private *dev_priv = vmw_priv(dev);
650 struct vmw_resource *res;
651 struct vmw_user_stream *stream;
652 struct drm_vmw_stream_arg *arg = (struct drm_vmw_stream_arg *)data;
653 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
654 struct idr *idr = &dev_priv->res_idr[vmw_res_stream];
658 res = vmw_resource_lookup(dev_priv, idr, arg->stream_id);
659 if (unlikely(res == NULL))
662 if (res->res_free != &vmw_user_stream_free) {
667 stream = container_of(res, struct vmw_user_stream, stream.res);
668 if (stream->base.tfile != tfile) {
673 ttm_ref_object_base_unref(tfile, stream->base.hash.key, TTM_REF_USAGE);
675 vmw_resource_unreference(&res);
679 int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
680 struct drm_file *file_priv)
682 struct vmw_private *dev_priv = vmw_priv(dev);
683 struct vmw_user_stream *stream;
684 struct vmw_resource *res;
685 struct vmw_resource *tmp;
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 vmw_master *vmaster = vmw_master(file_priv->master);
692 * Approximate idr memory usage with 128 bytes. It will be limited
693 * by maximum number_of streams anyway?
696 if (unlikely(vmw_user_stream_size == 0))
697 vmw_user_stream_size = ttm_round_pot(sizeof(*stream)) + 128;
699 ret = ttm_read_lock(&vmaster->lock, true);
700 if (unlikely(ret != 0))
703 ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
704 vmw_user_stream_size,
706 if (unlikely(ret != 0)) {
707 if (ret != -ERESTARTSYS)
708 DRM_ERROR("Out of graphics memory for stream"
714 stream = kmalloc(sizeof(*stream), GFP_KERNEL);
715 if (unlikely(stream == NULL)) {
716 ttm_mem_global_free(vmw_mem_glob(dev_priv),
717 vmw_user_stream_size);
722 res = &stream->stream.res;
723 stream->base.shareable = false;
724 stream->base.tfile = NULL;
727 * From here on, the destructor takes over resource freeing.
730 ret = vmw_stream_init(dev_priv, &stream->stream, vmw_user_stream_free);
731 if (unlikely(ret != 0))
734 tmp = vmw_resource_reference(res);
735 ret = ttm_base_object_init(tfile, &stream->base, false, VMW_RES_STREAM,
736 &vmw_user_stream_base_release, NULL);
738 if (unlikely(ret != 0)) {
739 vmw_resource_unreference(&tmp);
743 arg->stream_id = res->id;
745 vmw_resource_unreference(&res);
747 ttm_read_unlock(&vmaster->lock);
751 int vmw_user_stream_lookup(struct vmw_private *dev_priv,
752 struct ttm_object_file *tfile,
753 uint32_t *inout_id, struct vmw_resource **out)
755 struct vmw_user_stream *stream;
756 struct vmw_resource *res;
759 res = vmw_resource_lookup(dev_priv, &dev_priv->res_idr[vmw_res_stream],
761 if (unlikely(res == NULL))
764 if (res->res_free != &vmw_user_stream_free) {
769 stream = container_of(res, struct vmw_user_stream, stream.res);
770 if (stream->base.tfile != tfile) {
775 *inout_id = stream->stream.stream_id;
779 vmw_resource_unreference(&res);
784 int vmw_dumb_create(struct drm_file *file_priv,
785 struct drm_device *dev,
786 struct drm_mode_create_dumb *args)
788 struct vmw_private *dev_priv = vmw_priv(dev);
789 struct vmw_master *vmaster = vmw_master(file_priv->master);
790 struct vmw_user_dma_buffer *vmw_user_bo;
791 struct ttm_buffer_object *tmp;
794 args->pitch = args->width * ((args->bpp + 7) / 8);
795 args->size = args->pitch * args->height;
797 vmw_user_bo = kzalloc(sizeof(*vmw_user_bo), GFP_KERNEL);
798 if (vmw_user_bo == NULL)
801 ret = ttm_read_lock(&vmaster->lock, true);
807 ret = vmw_dmabuf_init(dev_priv, &vmw_user_bo->dma, args->size,
808 &vmw_vram_sys_placement, true,
809 &vmw_user_dmabuf_destroy);
813 tmp = ttm_bo_reference(&vmw_user_bo->dma.base);
814 ret = ttm_prime_object_init(vmw_fpriv(file_priv)->tfile,
819 &vmw_user_dmabuf_release, NULL);
820 if (unlikely(ret != 0))
821 goto out_no_base_object;
823 args->handle = vmw_user_bo->prime.base.hash.key;
828 ttm_read_unlock(&vmaster->lock);
832 int vmw_dumb_map_offset(struct drm_file *file_priv,
833 struct drm_device *dev, uint32_t handle,
836 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
837 struct vmw_dma_buffer *out_buf;
840 ret = vmw_user_dmabuf_lookup(tfile, handle, &out_buf);
844 *offset = drm_vma_node_offset_addr(&out_buf->base.vma_node);
845 vmw_dmabuf_unreference(&out_buf);
849 int vmw_dumb_destroy(struct drm_file *file_priv,
850 struct drm_device *dev,
853 return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
854 handle, TTM_REF_USAGE);
858 * vmw_resource_buf_alloc - Allocate a backup buffer for a resource.
860 * @res: The resource for which to allocate a backup buffer.
861 * @interruptible: Whether any sleeps during allocation should be
862 * performed while interruptible.
864 static int vmw_resource_buf_alloc(struct vmw_resource *res,
868 (res->backup_size + PAGE_SIZE - 1) & PAGE_MASK;
869 struct vmw_dma_buffer *backup;
872 if (likely(res->backup)) {
873 BUG_ON(res->backup->base.num_pages * PAGE_SIZE < size);
877 backup = kzalloc(sizeof(*backup), GFP_KERNEL);
878 if (unlikely(backup == NULL))
881 ret = vmw_dmabuf_init(res->dev_priv, backup, res->backup_size,
882 res->func->backup_placement,
884 &vmw_dmabuf_bo_free);
885 if (unlikely(ret != 0))
888 res->backup = backup;
895 * vmw_resource_do_validate - Make a resource up-to-date and visible
898 * @res: The resource to make visible to the device.
899 * @val_buf: Information about a buffer possibly
900 * containing backup data if a bind operation is needed.
902 * On hardware resource shortage, this function returns -EBUSY and
903 * should be retried once resources have been freed up.
905 static int vmw_resource_do_validate(struct vmw_resource *res,
906 struct ttm_validate_buffer *val_buf)
909 const struct vmw_res_func *func = res->func;
911 if (unlikely(res->id == -1)) {
912 ret = func->create(res);
913 if (unlikely(ret != 0))
918 ((func->needs_backup && list_empty(&res->mob_head) &&
919 val_buf->bo != NULL) ||
920 (!func->needs_backup && val_buf->bo != NULL))) {
921 ret = func->bind(res, val_buf);
922 if (unlikely(ret != 0))
923 goto out_bind_failed;
924 if (func->needs_backup)
925 list_add_tail(&res->mob_head, &res->backup->res_list);
929 * Only do this on write operations, and move to
930 * vmw_resource_unreserve if it can be called after
931 * backup buffers have been unreserved. Otherwise
934 res->res_dirty = true;
945 * vmw_resource_unreserve - Unreserve a resource previously reserved for
946 * command submission.
948 * @res: Pointer to the struct vmw_resource to unreserve.
949 * @new_backup: Pointer to new backup buffer if command submission
951 * @new_backup_offset: New backup offset if @new_backup is !NULL.
953 * Currently unreserving a resource means putting it back on the device's
954 * resource lru list, so that it can be evicted if necessary.
956 void vmw_resource_unreserve(struct vmw_resource *res,
957 struct vmw_dma_buffer *new_backup,
958 unsigned long new_backup_offset)
960 struct vmw_private *dev_priv = res->dev_priv;
962 if (!list_empty(&res->lru_head))
965 if (new_backup && new_backup != res->backup) {
968 lockdep_assert_held(&res->backup->base.resv->lock.base);
969 list_del_init(&res->mob_head);
970 vmw_dmabuf_unreference(&res->backup);
973 res->backup = vmw_dmabuf_reference(new_backup);
974 lockdep_assert_held(&new_backup->base.resv->lock.base);
975 list_add_tail(&res->mob_head, &new_backup->res_list);
978 res->backup_offset = new_backup_offset;
980 if (!res->func->may_evict || res->id == -1)
983 write_lock(&dev_priv->resource_lock);
984 list_add_tail(&res->lru_head,
985 &res->dev_priv->res_lru[res->func->res_type]);
986 write_unlock(&dev_priv->resource_lock);
990 * vmw_resource_check_buffer - Check whether a backup buffer is needed
991 * for a resource and in that case, allocate
992 * one, reserve and validate it.
994 * @res: The resource for which to allocate a backup buffer.
995 * @interruptible: Whether any sleeps during allocation should be
996 * performed while interruptible.
997 * @val_buf: On successful return contains data about the
998 * reserved and validated backup buffer.
1001 vmw_resource_check_buffer(struct vmw_resource *res,
1003 struct ttm_validate_buffer *val_buf)
1005 struct list_head val_list;
1006 bool backup_dirty = false;
1009 if (unlikely(res->backup == NULL)) {
1010 ret = vmw_resource_buf_alloc(res, interruptible);
1011 if (unlikely(ret != 0))
1015 INIT_LIST_HEAD(&val_list);
1016 val_buf->bo = ttm_bo_reference(&res->backup->base);
1017 list_add_tail(&val_buf->head, &val_list);
1018 ret = ttm_eu_reserve_buffers(NULL, &val_list);
1019 if (unlikely(ret != 0))
1020 goto out_no_reserve;
1022 if (res->func->needs_backup && list_empty(&res->mob_head))
1025 backup_dirty = res->backup_dirty;
1026 ret = ttm_bo_validate(&res->backup->base,
1027 res->func->backup_placement,
1030 if (unlikely(ret != 0))
1031 goto out_no_validate;
1036 ttm_eu_backoff_reservation(NULL, &val_list);
1038 ttm_bo_unref(&val_buf->bo);
1040 vmw_dmabuf_unreference(&res->backup);
1046 * vmw_resource_reserve - Reserve a resource for command submission
1048 * @res: The resource to reserve.
1050 * This function takes the resource off the LRU list and make sure
1051 * a backup buffer is present for guest-backed resources. However,
1052 * the buffer may not be bound to the resource at this point.
1055 int vmw_resource_reserve(struct vmw_resource *res, bool no_backup)
1057 struct vmw_private *dev_priv = res->dev_priv;
1060 write_lock(&dev_priv->resource_lock);
1061 list_del_init(&res->lru_head);
1062 write_unlock(&dev_priv->resource_lock);
1064 if (res->func->needs_backup && res->backup == NULL &&
1066 ret = vmw_resource_buf_alloc(res, true);
1067 if (unlikely(ret != 0))
1075 * vmw_resource_backoff_reservation - Unreserve and unreference a
1078 * @val_buf: Backup buffer information.
1081 vmw_resource_backoff_reservation(struct ttm_validate_buffer *val_buf)
1083 struct list_head val_list;
1085 if (likely(val_buf->bo == NULL))
1088 INIT_LIST_HEAD(&val_list);
1089 list_add_tail(&val_buf->head, &val_list);
1090 ttm_eu_backoff_reservation(NULL, &val_list);
1091 ttm_bo_unref(&val_buf->bo);
1095 * vmw_resource_do_evict - Evict a resource, and transfer its data
1096 * to a backup buffer.
1098 * @res: The resource to evict.
1099 * @interruptible: Whether to wait interruptible.
1101 int vmw_resource_do_evict(struct vmw_resource *res, bool interruptible)
1103 struct ttm_validate_buffer val_buf;
1104 const struct vmw_res_func *func = res->func;
1107 BUG_ON(!func->may_evict);
1110 ret = vmw_resource_check_buffer(res, interruptible, &val_buf);
1111 if (unlikely(ret != 0))
1114 if (unlikely(func->unbind != NULL &&
1115 (!func->needs_backup || !list_empty(&res->mob_head)))) {
1116 ret = func->unbind(res, res->res_dirty, &val_buf);
1117 if (unlikely(ret != 0))
1119 list_del_init(&res->mob_head);
1121 ret = func->destroy(res);
1122 res->backup_dirty = true;
1123 res->res_dirty = false;
1125 vmw_resource_backoff_reservation(&val_buf);
1132 * vmw_resource_validate - Make a resource up-to-date and visible
1135 * @res: The resource to make visible to the device.
1137 * On succesful return, any backup DMA buffer pointed to by @res->backup will
1138 * be reserved and validated.
1139 * On hardware resource shortage, this function will repeatedly evict
1140 * resources of the same type until the validation succeeds.
1142 int vmw_resource_validate(struct vmw_resource *res)
1145 struct vmw_resource *evict_res;
1146 struct vmw_private *dev_priv = res->dev_priv;
1147 struct list_head *lru_list = &dev_priv->res_lru[res->func->res_type];
1148 struct ttm_validate_buffer val_buf;
1149 unsigned err_count = 0;
1151 if (likely(!res->func->may_evict))
1156 val_buf.bo = &res->backup->base;
1158 ret = vmw_resource_do_validate(res, &val_buf);
1159 if (likely(ret != -EBUSY))
1162 write_lock(&dev_priv->resource_lock);
1163 if (list_empty(lru_list) || !res->func->may_evict) {
1164 DRM_ERROR("Out of device device resources "
1165 "for %s.\n", res->func->type_name);
1167 write_unlock(&dev_priv->resource_lock);
1171 evict_res = vmw_resource_reference
1172 (list_first_entry(lru_list, struct vmw_resource,
1174 list_del_init(&evict_res->lru_head);
1176 write_unlock(&dev_priv->resource_lock);
1178 ret = vmw_resource_do_evict(evict_res, true);
1179 if (unlikely(ret != 0)) {
1180 write_lock(&dev_priv->resource_lock);
1181 list_add_tail(&evict_res->lru_head, lru_list);
1182 write_unlock(&dev_priv->resource_lock);
1183 if (ret == -ERESTARTSYS ||
1184 ++err_count > VMW_RES_EVICT_ERR_COUNT) {
1185 vmw_resource_unreference(&evict_res);
1186 goto out_no_validate;
1190 vmw_resource_unreference(&evict_res);
1193 if (unlikely(ret != 0))
1194 goto out_no_validate;
1195 else if (!res->func->needs_backup && res->backup) {
1196 list_del_init(&res->mob_head);
1197 vmw_dmabuf_unreference(&res->backup);
1207 * vmw_fence_single_bo - Utility function to fence a single TTM buffer
1208 * object without unreserving it.
1210 * @bo: Pointer to the struct ttm_buffer_object to fence.
1211 * @fence: Pointer to the fence. If NULL, this function will
1212 * insert a fence into the command stream..
1214 * Contrary to the ttm_eu version of this function, it takes only
1215 * a single buffer object instead of a list, and it also doesn't
1216 * unreserve the buffer object, which needs to be done separately.
1218 void vmw_fence_single_bo(struct ttm_buffer_object *bo,
1219 struct vmw_fence_obj *fence)
1221 struct ttm_bo_device *bdev = bo->bdev;
1222 struct ttm_bo_driver *driver = bdev->driver;
1223 struct vmw_fence_obj *old_fence_obj;
1224 struct vmw_private *dev_priv =
1225 container_of(bdev, struct vmw_private, bdev);
1228 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
1230 driver->sync_obj_ref(fence);
1232 spin_lock(&bdev->fence_lock);
1234 old_fence_obj = bo->sync_obj;
1235 bo->sync_obj = fence;
1237 spin_unlock(&bdev->fence_lock);
1240 vmw_fence_obj_unreference(&old_fence_obj);
1244 * vmw_resource_move_notify - TTM move_notify_callback
1246 * @bo: The TTM buffer object about to move.
1247 * @mem: The truct ttm_mem_reg indicating to what memory
1248 * region the move is taking place.
1250 * For now does nothing.
1252 void vmw_resource_move_notify(struct ttm_buffer_object *bo,
1253 struct ttm_mem_reg *mem)
1258 * vmw_resource_needs_backup - Return whether a resource needs a backup buffer.
1260 * @res: The resource being queried.
1262 bool vmw_resource_needs_backup(const struct vmw_resource *res)
1264 return res->func->needs_backup;
1268 * vmw_resource_evict_type - Evict all resources of a specific type
1270 * @dev_priv: Pointer to a device private struct
1271 * @type: The resource type to evict
1273 * To avoid thrashing starvation or as part of the hibernation sequence,
1274 * try to evict all evictable resources of a specific type.
1276 static void vmw_resource_evict_type(struct vmw_private *dev_priv,
1277 enum vmw_res_type type)
1279 struct list_head *lru_list = &dev_priv->res_lru[type];
1280 struct vmw_resource *evict_res;
1281 unsigned err_count = 0;
1285 write_lock(&dev_priv->resource_lock);
1287 if (list_empty(lru_list))
1290 evict_res = vmw_resource_reference(
1291 list_first_entry(lru_list, struct vmw_resource,
1293 list_del_init(&evict_res->lru_head);
1294 write_unlock(&dev_priv->resource_lock);
1296 ret = vmw_resource_do_evict(evict_res, false);
1297 if (unlikely(ret != 0)) {
1298 write_lock(&dev_priv->resource_lock);
1299 list_add_tail(&evict_res->lru_head, lru_list);
1300 write_unlock(&dev_priv->resource_lock);
1301 if (++err_count > VMW_RES_EVICT_ERR_COUNT) {
1302 vmw_resource_unreference(&evict_res);
1307 vmw_resource_unreference(&evict_res);
1311 write_unlock(&dev_priv->resource_lock);
1315 * vmw_resource_evict_all - Evict all evictable resources
1317 * @dev_priv: Pointer to a device private struct
1319 * To avoid thrashing starvation or as part of the hibernation sequence,
1320 * evict all evictable resources. In particular this means that all
1321 * guest-backed resources that are registered with the device are
1322 * evicted and the OTable becomes clean.
1324 void vmw_resource_evict_all(struct vmw_private *dev_priv)
1326 enum vmw_res_type type;
1328 mutex_lock(&dev_priv->cmdbuf_mutex);
1330 for (type = 0; type < vmw_res_max; ++type)
1331 vmw_resource_evict_type(dev_priv, type);
1333 mutex_unlock(&dev_priv->cmdbuf_mutex);