2 * Copyright (C) 2015 Red Hat, Inc.
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
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 NONINFRINGEMENT. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
28 #include <linux/file.h>
29 #include <linux/sync_file.h>
30 #include <linux/uaccess.h>
32 #include <drm/drm_file.h>
33 #include <drm/virtgpu_drm.h>
35 #include "virtgpu_drv.h"
37 #define VIRTGPU_BLOB_FLAG_USE_MASK (VIRTGPU_BLOB_FLAG_USE_MAPPABLE | \
38 VIRTGPU_BLOB_FLAG_USE_SHAREABLE | \
39 VIRTGPU_BLOB_FLAG_USE_CROSS_DEVICE)
41 static int virtio_gpu_fence_event_create(struct drm_device *dev,
42 struct drm_file *file,
43 struct virtio_gpu_fence *fence,
46 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
47 struct virtio_gpu_fence_event *e = NULL;
50 if (!(vfpriv->ring_idx_mask & BIT_ULL(ring_idx)))
53 e = kzalloc(sizeof(*e), GFP_KERNEL);
57 e->event.type = VIRTGPU_EVENT_FENCE_SIGNALED;
58 e->event.length = sizeof(e->event);
60 ret = drm_event_reserve_init(dev, file, &e->base, &e->event);
71 /* Must be called with &virtio_gpu_fpriv.struct_mutex held. */
72 static void virtio_gpu_create_context_locked(struct virtio_gpu_device *vgdev,
73 struct virtio_gpu_fpriv *vfpriv)
75 char dbgname[TASK_COMM_LEN];
77 get_task_comm(dbgname, current);
78 virtio_gpu_cmd_context_create(vgdev, vfpriv->ctx_id,
79 vfpriv->context_init, strlen(dbgname),
82 vfpriv->context_created = true;
85 void virtio_gpu_create_context(struct drm_device *dev, struct drm_file *file)
87 struct virtio_gpu_device *vgdev = dev->dev_private;
88 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
90 mutex_lock(&vfpriv->context_lock);
91 if (vfpriv->context_created)
94 virtio_gpu_create_context_locked(vgdev, vfpriv);
97 mutex_unlock(&vfpriv->context_lock);
100 static int virtio_gpu_map_ioctl(struct drm_device *dev, void *data,
101 struct drm_file *file)
103 struct virtio_gpu_device *vgdev = dev->dev_private;
104 struct drm_virtgpu_map *virtio_gpu_map = data;
106 return virtio_gpu_mode_dumb_mmap(file, vgdev->ddev,
107 virtio_gpu_map->handle,
108 &virtio_gpu_map->offset);
112 * Usage of execbuffer:
113 * Relocations need to take into account the full VIRTIO_GPUDrawable size.
114 * However, the command as passed from user space must *not* contain the initial
115 * VIRTIO_GPUReleaseInfo struct (first XXX bytes)
117 static int virtio_gpu_execbuffer_ioctl(struct drm_device *dev, void *data,
118 struct drm_file *file)
120 struct drm_virtgpu_execbuffer *exbuf = data;
121 struct virtio_gpu_device *vgdev = dev->dev_private;
122 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
123 struct virtio_gpu_fence *out_fence;
125 uint32_t *bo_handles = NULL;
126 void __user *user_bo_handles = NULL;
127 struct virtio_gpu_object_array *buflist = NULL;
128 struct sync_file *sync_file;
129 int out_fence_fd = -1;
134 fence_ctx = vgdev->fence_drv.context;
137 if (vgdev->has_virgl_3d == false)
140 if ((exbuf->flags & ~VIRTGPU_EXECBUF_FLAGS))
143 if ((exbuf->flags & VIRTGPU_EXECBUF_RING_IDX)) {
144 if (exbuf->ring_idx >= vfpriv->num_rings)
147 if (!vfpriv->base_fence_ctx)
150 fence_ctx = vfpriv->base_fence_ctx;
151 ring_idx = exbuf->ring_idx;
154 virtio_gpu_create_context(dev, file);
155 if (exbuf->flags & VIRTGPU_EXECBUF_FENCE_FD_IN) {
156 struct dma_fence *in_fence;
158 in_fence = sync_file_get_fence(exbuf->fence_fd);
164 * Wait if the fence is from a foreign context, or if the fence
165 * array contains any fence from a foreign context.
168 if (!dma_fence_match_context(in_fence, fence_ctx + ring_idx))
169 ret = dma_fence_wait(in_fence, true);
171 dma_fence_put(in_fence);
176 if (exbuf->flags & VIRTGPU_EXECBUF_FENCE_FD_OUT) {
177 out_fence_fd = get_unused_fd_flags(O_CLOEXEC);
178 if (out_fence_fd < 0)
182 if (exbuf->num_bo_handles) {
183 bo_handles = kvmalloc_array(exbuf->num_bo_handles,
184 sizeof(uint32_t), GFP_KERNEL);
190 user_bo_handles = u64_to_user_ptr(exbuf->bo_handles);
191 if (copy_from_user(bo_handles, user_bo_handles,
192 exbuf->num_bo_handles * sizeof(uint32_t))) {
197 buflist = virtio_gpu_array_from_handles(file, bo_handles,
198 exbuf->num_bo_handles);
207 buf = vmemdup_user(u64_to_user_ptr(exbuf->command), exbuf->size);
214 ret = virtio_gpu_array_lock_resv(buflist);
219 out_fence = virtio_gpu_fence_alloc(vgdev, fence_ctx, ring_idx);
225 ret = virtio_gpu_fence_event_create(dev, file, out_fence, ring_idx);
229 if (out_fence_fd >= 0) {
230 sync_file = sync_file_create(&out_fence->f);
232 dma_fence_put(&out_fence->f);
237 exbuf->fence_fd = out_fence_fd;
238 fd_install(out_fence_fd, sync_file->file);
241 virtio_gpu_cmd_submit(vgdev, buf, exbuf->size,
242 vfpriv->ctx_id, buflist, out_fence);
243 dma_fence_put(&out_fence->f);
244 virtio_gpu_notify(vgdev);
249 virtio_gpu_array_unlock_resv(buflist);
255 virtio_gpu_array_put_free(buflist);
257 if (out_fence_fd >= 0)
258 put_unused_fd(out_fence_fd);
263 static int virtio_gpu_getparam_ioctl(struct drm_device *dev, void *data,
264 struct drm_file *file)
266 struct virtio_gpu_device *vgdev = dev->dev_private;
267 struct drm_virtgpu_getparam *param = data;
270 switch (param->param) {
271 case VIRTGPU_PARAM_3D_FEATURES:
272 value = vgdev->has_virgl_3d ? 1 : 0;
274 case VIRTGPU_PARAM_CAPSET_QUERY_FIX:
277 case VIRTGPU_PARAM_RESOURCE_BLOB:
278 value = vgdev->has_resource_blob ? 1 : 0;
280 case VIRTGPU_PARAM_HOST_VISIBLE:
281 value = vgdev->has_host_visible ? 1 : 0;
283 case VIRTGPU_PARAM_CROSS_DEVICE:
284 value = vgdev->has_resource_assign_uuid ? 1 : 0;
286 case VIRTGPU_PARAM_CONTEXT_INIT:
287 value = vgdev->has_context_init ? 1 : 0;
289 case VIRTGPU_PARAM_SUPPORTED_CAPSET_IDs:
290 value = vgdev->capset_id_mask;
295 if (copy_to_user(u64_to_user_ptr(param->value), &value, sizeof(int)))
301 static int virtio_gpu_resource_create_ioctl(struct drm_device *dev, void *data,
302 struct drm_file *file)
304 struct virtio_gpu_device *vgdev = dev->dev_private;
305 struct drm_virtgpu_resource_create *rc = data;
306 struct virtio_gpu_fence *fence;
308 struct virtio_gpu_object *qobj;
309 struct drm_gem_object *obj;
311 struct virtio_gpu_object_params params = { 0 };
313 if (vgdev->has_virgl_3d) {
314 virtio_gpu_create_context(dev, file);
316 params.target = rc->target;
317 params.bind = rc->bind;
318 params.depth = rc->depth;
319 params.array_size = rc->array_size;
320 params.last_level = rc->last_level;
321 params.nr_samples = rc->nr_samples;
322 params.flags = rc->flags;
326 if (rc->nr_samples > 1)
328 if (rc->last_level > 1)
332 if (rc->array_size > 1)
336 params.format = rc->format;
337 params.width = rc->width;
338 params.height = rc->height;
339 params.size = rc->size;
340 /* allocate a single page size object */
341 if (params.size == 0)
342 params.size = PAGE_SIZE;
344 fence = virtio_gpu_fence_alloc(vgdev, vgdev->fence_drv.context, 0);
347 ret = virtio_gpu_object_create(vgdev, ¶ms, &qobj, fence);
348 dma_fence_put(&fence->f);
351 obj = &qobj->base.base;
353 ret = drm_gem_handle_create(file, obj, &handle);
355 drm_gem_object_release(obj);
359 rc->res_handle = qobj->hw_res_handle; /* similiar to a VM address */
360 rc->bo_handle = handle;
363 * The handle owns the reference now. But we must drop our
364 * remaining reference *after* we no longer need to dereference
365 * the obj. Otherwise userspace could guess the handle and
366 * race closing it from another thread.
368 drm_gem_object_put(obj);
373 static int virtio_gpu_resource_info_ioctl(struct drm_device *dev, void *data,
374 struct drm_file *file)
376 struct drm_virtgpu_resource_info *ri = data;
377 struct drm_gem_object *gobj = NULL;
378 struct virtio_gpu_object *qobj = NULL;
380 gobj = drm_gem_object_lookup(file, ri->bo_handle);
384 qobj = gem_to_virtio_gpu_obj(gobj);
386 ri->size = qobj->base.base.size;
387 ri->res_handle = qobj->hw_res_handle;
388 if (qobj->host3d_blob || qobj->guest_blob)
389 ri->blob_mem = qobj->blob_mem;
391 drm_gem_object_put(gobj);
395 static int virtio_gpu_transfer_from_host_ioctl(struct drm_device *dev,
397 struct drm_file *file)
399 struct virtio_gpu_device *vgdev = dev->dev_private;
400 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
401 struct drm_virtgpu_3d_transfer_from_host *args = data;
402 struct virtio_gpu_object *bo;
403 struct virtio_gpu_object_array *objs;
404 struct virtio_gpu_fence *fence;
406 u32 offset = args->offset;
408 if (vgdev->has_virgl_3d == false)
411 virtio_gpu_create_context(dev, file);
412 objs = virtio_gpu_array_from_handles(file, &args->bo_handle, 1);
416 bo = gem_to_virtio_gpu_obj(objs->objs[0]);
417 if (bo->guest_blob && !bo->host3d_blob) {
422 if (!bo->host3d_blob && (args->stride || args->layer_stride)) {
427 ret = virtio_gpu_array_lock_resv(objs);
431 fence = virtio_gpu_fence_alloc(vgdev, vgdev->fence_drv.context, 0);
437 virtio_gpu_cmd_transfer_from_host_3d
438 (vgdev, vfpriv->ctx_id, offset, args->level, args->stride,
439 args->layer_stride, &args->box, objs, fence);
440 dma_fence_put(&fence->f);
441 virtio_gpu_notify(vgdev);
445 virtio_gpu_array_unlock_resv(objs);
447 virtio_gpu_array_put_free(objs);
451 static int virtio_gpu_transfer_to_host_ioctl(struct drm_device *dev, void *data,
452 struct drm_file *file)
454 struct virtio_gpu_device *vgdev = dev->dev_private;
455 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
456 struct drm_virtgpu_3d_transfer_to_host *args = data;
457 struct virtio_gpu_object *bo;
458 struct virtio_gpu_object_array *objs;
459 struct virtio_gpu_fence *fence;
461 u32 offset = args->offset;
463 objs = virtio_gpu_array_from_handles(file, &args->bo_handle, 1);
467 bo = gem_to_virtio_gpu_obj(objs->objs[0]);
468 if (bo->guest_blob && !bo->host3d_blob) {
473 if (!vgdev->has_virgl_3d) {
474 virtio_gpu_cmd_transfer_to_host_2d
476 args->box.w, args->box.h, args->box.x, args->box.y,
479 virtio_gpu_create_context(dev, file);
481 if (!bo->host3d_blob && (args->stride || args->layer_stride)) {
486 ret = virtio_gpu_array_lock_resv(objs);
491 fence = virtio_gpu_fence_alloc(vgdev, vgdev->fence_drv.context,
496 virtio_gpu_cmd_transfer_to_host_3d
498 vfpriv ? vfpriv->ctx_id : 0, offset, args->level,
499 args->stride, args->layer_stride, &args->box, objs,
501 dma_fence_put(&fence->f);
503 virtio_gpu_notify(vgdev);
507 virtio_gpu_array_unlock_resv(objs);
509 virtio_gpu_array_put_free(objs);
513 static int virtio_gpu_wait_ioctl(struct drm_device *dev, void *data,
514 struct drm_file *file)
516 struct drm_virtgpu_3d_wait *args = data;
517 struct drm_gem_object *obj;
518 long timeout = 15 * HZ;
521 obj = drm_gem_object_lookup(file, args->handle);
525 if (args->flags & VIRTGPU_WAIT_NOWAIT) {
526 ret = dma_resv_test_signaled(obj->resv, DMA_RESV_USAGE_READ);
528 ret = dma_resv_wait_timeout(obj->resv, DMA_RESV_USAGE_READ,
536 drm_gem_object_put(obj);
540 static int virtio_gpu_get_caps_ioctl(struct drm_device *dev,
541 void *data, struct drm_file *file)
543 struct virtio_gpu_device *vgdev = dev->dev_private;
544 struct drm_virtgpu_get_caps *args = data;
545 unsigned size, host_caps_size;
547 int found_valid = -1;
549 struct virtio_gpu_drv_cap_cache *cache_ent;
552 if (vgdev->num_capsets == 0)
555 /* don't allow userspace to pass 0 */
559 spin_lock(&vgdev->display_info_lock);
560 for (i = 0; i < vgdev->num_capsets; i++) {
561 if (vgdev->capsets[i].id == args->cap_set_id) {
562 if (vgdev->capsets[i].max_version >= args->cap_set_ver) {
569 if (found_valid == -1) {
570 spin_unlock(&vgdev->display_info_lock);
574 host_caps_size = vgdev->capsets[found_valid].max_size;
575 /* only copy to user the minimum of the host caps size or the guest caps size */
576 size = min(args->size, host_caps_size);
578 list_for_each_entry(cache_ent, &vgdev->cap_cache, head) {
579 if (cache_ent->id == args->cap_set_id &&
580 cache_ent->version == args->cap_set_ver) {
581 spin_unlock(&vgdev->display_info_lock);
585 spin_unlock(&vgdev->display_info_lock);
587 /* not in cache - need to talk to hw */
588 ret = virtio_gpu_cmd_get_capset(vgdev, found_valid, args->cap_set_ver,
592 virtio_gpu_notify(vgdev);
595 ret = wait_event_timeout(vgdev->resp_wq,
596 atomic_read(&cache_ent->is_valid), 5 * HZ);
600 /* is_valid check must proceed before copy of the cache entry. */
603 ptr = cache_ent->caps_cache;
605 if (copy_to_user(u64_to_user_ptr(args->addr), ptr, size))
611 static int verify_blob(struct virtio_gpu_device *vgdev,
612 struct virtio_gpu_fpriv *vfpriv,
613 struct virtio_gpu_object_params *params,
614 struct drm_virtgpu_resource_create_blob *rc_blob,
615 bool *guest_blob, bool *host3d_blob)
617 if (!vgdev->has_resource_blob)
620 if (rc_blob->blob_flags & ~VIRTGPU_BLOB_FLAG_USE_MASK)
623 if (rc_blob->blob_flags & VIRTGPU_BLOB_FLAG_USE_CROSS_DEVICE) {
624 if (!vgdev->has_resource_assign_uuid)
628 switch (rc_blob->blob_mem) {
629 case VIRTGPU_BLOB_MEM_GUEST:
632 case VIRTGPU_BLOB_MEM_HOST3D_GUEST:
635 case VIRTGPU_BLOB_MEM_HOST3D:
643 if (!vgdev->has_virgl_3d)
646 /* Must be dword aligned. */
647 if (rc_blob->cmd_size % 4 != 0)
650 params->ctx_id = vfpriv->ctx_id;
651 params->blob_id = rc_blob->blob_id;
653 if (rc_blob->blob_id != 0)
656 if (rc_blob->cmd_size != 0)
660 params->blob_mem = rc_blob->blob_mem;
661 params->size = rc_blob->size;
663 params->blob_flags = rc_blob->blob_flags;
667 static int virtio_gpu_resource_create_blob_ioctl(struct drm_device *dev,
669 struct drm_file *file)
673 bool guest_blob = false;
674 bool host3d_blob = false;
675 struct drm_gem_object *obj;
676 struct virtio_gpu_object *bo;
677 struct virtio_gpu_object_params params = { 0 };
678 struct virtio_gpu_device *vgdev = dev->dev_private;
679 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
680 struct drm_virtgpu_resource_create_blob *rc_blob = data;
682 if (verify_blob(vgdev, vfpriv, ¶ms, rc_blob,
683 &guest_blob, &host3d_blob))
686 if (vgdev->has_virgl_3d)
687 virtio_gpu_create_context(dev, file);
689 if (rc_blob->cmd_size) {
692 buf = memdup_user(u64_to_user_ptr(rc_blob->cmd),
698 virtio_gpu_cmd_submit(vgdev, buf, rc_blob->cmd_size,
699 vfpriv->ctx_id, NULL, NULL);
703 ret = virtio_gpu_object_create(vgdev, ¶ms, &bo, NULL);
704 else if (!guest_blob && host3d_blob)
705 ret = virtio_gpu_vram_create(vgdev, ¶ms, &bo);
712 bo->guest_blob = guest_blob;
713 bo->host3d_blob = host3d_blob;
714 bo->blob_mem = rc_blob->blob_mem;
715 bo->blob_flags = rc_blob->blob_flags;
717 obj = &bo->base.base;
718 if (params.blob_flags & VIRTGPU_BLOB_FLAG_USE_CROSS_DEVICE) {
719 ret = virtio_gpu_resource_assign_uuid(vgdev, bo);
721 drm_gem_object_release(obj);
726 ret = drm_gem_handle_create(file, obj, &handle);
728 drm_gem_object_release(obj);
732 rc_blob->res_handle = bo->hw_res_handle;
733 rc_blob->bo_handle = handle;
736 * The handle owns the reference now. But we must drop our
737 * remaining reference *after* we no longer need to dereference
738 * the obj. Otherwise userspace could guess the handle and
739 * race closing it from another thread.
741 drm_gem_object_put(obj);
746 static int virtio_gpu_context_init_ioctl(struct drm_device *dev,
747 void *data, struct drm_file *file)
750 uint32_t num_params, i, param, value;
751 uint64_t valid_ring_mask;
753 struct drm_virtgpu_context_set_param *ctx_set_params = NULL;
754 struct virtio_gpu_device *vgdev = dev->dev_private;
755 struct virtio_gpu_fpriv *vfpriv = file->driver_priv;
756 struct drm_virtgpu_context_init *args = data;
758 num_params = args->num_params;
759 len = num_params * sizeof(struct drm_virtgpu_context_set_param);
761 if (!vgdev->has_context_init || !vgdev->has_virgl_3d)
764 /* Number of unique parameters supported at this time. */
768 ctx_set_params = memdup_user(u64_to_user_ptr(args->ctx_set_params),
771 if (IS_ERR(ctx_set_params))
772 return PTR_ERR(ctx_set_params);
774 mutex_lock(&vfpriv->context_lock);
775 if (vfpriv->context_created) {
780 for (i = 0; i < num_params; i++) {
781 param = ctx_set_params[i].param;
782 value = ctx_set_params[i].value;
785 case VIRTGPU_CONTEXT_PARAM_CAPSET_ID:
786 if (value > MAX_CAPSET_ID) {
791 if ((vgdev->capset_id_mask & (1ULL << value)) == 0) {
796 /* Context capset ID already set */
797 if (vfpriv->context_init &
798 VIRTIO_GPU_CONTEXT_INIT_CAPSET_ID_MASK) {
803 vfpriv->context_init |= value;
805 case VIRTGPU_CONTEXT_PARAM_NUM_RINGS:
806 if (vfpriv->base_fence_ctx) {
811 if (value > MAX_RINGS) {
816 vfpriv->base_fence_ctx = dma_fence_context_alloc(value);
817 vfpriv->num_rings = value;
819 case VIRTGPU_CONTEXT_PARAM_POLL_RINGS_MASK:
820 if (vfpriv->ring_idx_mask) {
825 vfpriv->ring_idx_mask = value;
833 if (vfpriv->ring_idx_mask) {
835 for (i = 0; i < vfpriv->num_rings; i++)
836 valid_ring_mask |= 1ULL << i;
838 if (~valid_ring_mask & vfpriv->ring_idx_mask) {
844 virtio_gpu_create_context_locked(vgdev, vfpriv);
845 virtio_gpu_notify(vgdev);
848 mutex_unlock(&vfpriv->context_lock);
849 kfree(ctx_set_params);
853 struct drm_ioctl_desc virtio_gpu_ioctls[DRM_VIRTIO_NUM_IOCTLS] = {
854 DRM_IOCTL_DEF_DRV(VIRTGPU_MAP, virtio_gpu_map_ioctl,
857 DRM_IOCTL_DEF_DRV(VIRTGPU_EXECBUFFER, virtio_gpu_execbuffer_ioctl,
860 DRM_IOCTL_DEF_DRV(VIRTGPU_GETPARAM, virtio_gpu_getparam_ioctl,
863 DRM_IOCTL_DEF_DRV(VIRTGPU_RESOURCE_CREATE,
864 virtio_gpu_resource_create_ioctl,
867 DRM_IOCTL_DEF_DRV(VIRTGPU_RESOURCE_INFO, virtio_gpu_resource_info_ioctl,
870 /* make transfer async to the main ring? - no sure, can we
871 * thread these in the underlying GL
873 DRM_IOCTL_DEF_DRV(VIRTGPU_TRANSFER_FROM_HOST,
874 virtio_gpu_transfer_from_host_ioctl,
876 DRM_IOCTL_DEF_DRV(VIRTGPU_TRANSFER_TO_HOST,
877 virtio_gpu_transfer_to_host_ioctl,
880 DRM_IOCTL_DEF_DRV(VIRTGPU_WAIT, virtio_gpu_wait_ioctl,
883 DRM_IOCTL_DEF_DRV(VIRTGPU_GET_CAPS, virtio_gpu_get_caps_ioctl,
886 DRM_IOCTL_DEF_DRV(VIRTGPU_RESOURCE_CREATE_BLOB,
887 virtio_gpu_resource_create_blob_ioctl,
890 DRM_IOCTL_DEF_DRV(VIRTGPU_CONTEXT_INIT, virtio_gpu_context_init_ioctl,