1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2013 Red Hat
7 #include <linux/file.h>
8 #include <linux/sync_file.h>
9 #include <linux/uaccess.h>
11 #include <drm/drm_drv.h>
12 #include <drm/drm_file.h>
13 #include <drm/drm_syncobj.h>
18 #include "msm_gpu_trace.h"
20 /* For userspace errors, use DRM_UT_DRIVER.. so that userspace can enable
21 * error msgs for debugging, but we don't spam dmesg by default
23 #define SUBMIT_ERROR(submit, fmt, ...) \
24 DRM_DEV_DEBUG_DRIVER((submit)->dev->dev, fmt, ##__VA_ARGS__)
27 * Cmdstream submission:
30 static struct msm_gem_submit *submit_create(struct drm_device *dev,
32 struct msm_gpu_submitqueue *queue, uint32_t nr_bos,
35 static atomic_t ident = ATOMIC_INIT(0);
36 struct msm_gem_submit *submit;
40 sz = struct_size(submit, bos, nr_bos) +
41 ((u64)nr_cmds * sizeof(submit->cmd[0]));
44 return ERR_PTR(-ENOMEM);
46 submit = kzalloc(sz, GFP_KERNEL | __GFP_NOWARN);
48 return ERR_PTR(-ENOMEM);
50 submit->hw_fence = msm_fence_alloc();
51 if (IS_ERR(submit->hw_fence)) {
52 ret = PTR_ERR(submit->hw_fence);
57 ret = drm_sched_job_init(&submit->base, queue->entity, 1, queue);
59 kfree(submit->hw_fence);
64 kref_init(&submit->ref);
66 submit->aspace = queue->ctx->aspace;
68 submit->cmd = (void *)&submit->bos[nr_bos];
69 submit->queue = queue;
70 submit->pid = get_pid(task_pid(current));
71 submit->ring = gpu->rb[queue->ring_nr];
72 submit->fault_dumped = false;
74 /* Get a unique identifier for the submission for logging purposes */
75 submit->ident = atomic_inc_return(&ident) - 1;
77 INIT_LIST_HEAD(&submit->node);
82 void __msm_gem_submit_destroy(struct kref *kref)
84 struct msm_gem_submit *submit =
85 container_of(kref, struct msm_gem_submit, ref);
88 if (submit->fence_id) {
89 spin_lock(&submit->queue->idr_lock);
90 idr_remove(&submit->queue->fence_idr, submit->fence_id);
91 spin_unlock(&submit->queue->idr_lock);
94 dma_fence_put(submit->user_fence);
97 * If the submit is freed before msm_job_run(), then hw_fence is
98 * just some pre-allocated memory, not a reference counted fence.
99 * Once the job runs and the hw_fence is initialized, it will
100 * have a refcount of at least one, since the submit holds a ref
103 if (kref_read(&submit->hw_fence->refcount) == 0) {
104 kfree(submit->hw_fence);
106 dma_fence_put(submit->hw_fence);
109 put_pid(submit->pid);
110 msm_submitqueue_put(submit->queue);
112 for (i = 0; i < submit->nr_cmds; i++)
113 kfree(submit->cmd[i].relocs);
118 static int submit_lookup_objects(struct msm_gem_submit *submit,
119 struct drm_msm_gem_submit *args, struct drm_file *file)
124 for (i = 0; i < args->nr_bos; i++) {
125 struct drm_msm_gem_submit_bo submit_bo;
126 void __user *userptr =
127 u64_to_user_ptr(args->bos + (i * sizeof(submit_bo)));
129 /* make sure we don't have garbage flags, in case we hit
130 * error path before flags is initialized:
132 submit->bos[i].flags = 0;
134 if (copy_from_user(&submit_bo, userptr, sizeof(submit_bo))) {
140 /* at least one of READ and/or WRITE flags should be set: */
141 #define MANDATORY_FLAGS (MSM_SUBMIT_BO_READ | MSM_SUBMIT_BO_WRITE)
143 if ((submit_bo.flags & ~MSM_SUBMIT_BO_FLAGS) ||
144 !(submit_bo.flags & MANDATORY_FLAGS)) {
145 SUBMIT_ERROR(submit, "invalid flags: %x\n", submit_bo.flags);
151 submit->bos[i].handle = submit_bo.handle;
152 submit->bos[i].flags = submit_bo.flags;
155 spin_lock(&file->table_lock);
157 for (i = 0; i < args->nr_bos; i++) {
158 struct drm_gem_object *obj;
160 /* normally use drm_gem_object_lookup(), but for bulk lookup
161 * all under single table_lock just hit object_idr directly:
163 obj = idr_find(&file->object_idr, submit->bos[i].handle);
165 SUBMIT_ERROR(submit, "invalid handle %u at index %u\n", submit->bos[i].handle, i);
170 drm_gem_object_get(obj);
172 submit->bos[i].obj = obj;
176 spin_unlock(&file->table_lock);
184 static int submit_lookup_cmds(struct msm_gem_submit *submit,
185 struct drm_msm_gem_submit *args, struct drm_file *file)
191 for (i = 0; i < args->nr_cmds; i++) {
192 struct drm_msm_gem_submit_cmd submit_cmd;
193 void __user *userptr =
194 u64_to_user_ptr(args->cmds + (i * sizeof(submit_cmd)));
196 ret = copy_from_user(&submit_cmd, userptr, sizeof(submit_cmd));
202 /* validate input from userspace: */
203 switch (submit_cmd.type) {
204 case MSM_SUBMIT_CMD_BUF:
205 case MSM_SUBMIT_CMD_IB_TARGET_BUF:
206 case MSM_SUBMIT_CMD_CTX_RESTORE_BUF:
209 SUBMIT_ERROR(submit, "invalid type: %08x\n", submit_cmd.type);
213 if (submit_cmd.size % 4) {
214 SUBMIT_ERROR(submit, "non-aligned cmdstream buffer size: %u\n",
220 submit->cmd[i].type = submit_cmd.type;
221 submit->cmd[i].size = submit_cmd.size / 4;
222 submit->cmd[i].offset = submit_cmd.submit_offset / 4;
223 submit->cmd[i].idx = submit_cmd.submit_idx;
224 submit->cmd[i].nr_relocs = submit_cmd.nr_relocs;
226 userptr = u64_to_user_ptr(submit_cmd.relocs);
228 sz = array_size(submit_cmd.nr_relocs,
229 sizeof(struct drm_msm_gem_submit_reloc));
230 /* check for overflow: */
231 if (sz == SIZE_MAX) {
235 submit->cmd[i].relocs = kmalloc(sz, GFP_KERNEL | __GFP_NOWARN);
236 if (!submit->cmd[i].relocs) {
240 ret = copy_from_user(submit->cmd[i].relocs, userptr, sz);
251 /* This is where we make sure all the bo's are reserved and pin'd: */
252 static int submit_lock_objects(struct msm_gem_submit *submit)
256 drm_exec_init(&submit->exec, DRM_EXEC_INTERRUPTIBLE_WAIT, submit->nr_bos);
258 drm_exec_until_all_locked (&submit->exec) {
259 for (unsigned i = 0; i < submit->nr_bos; i++) {
260 struct drm_gem_object *obj = submit->bos[i].obj;
261 ret = drm_exec_prepare_obj(&submit->exec, obj, 1);
262 drm_exec_retry_on_contention(&submit->exec);
274 static int submit_fence_sync(struct msm_gem_submit *submit)
278 for (i = 0; i < submit->nr_bos; i++) {
279 struct drm_gem_object *obj = submit->bos[i].obj;
280 bool write = submit->bos[i].flags & MSM_SUBMIT_BO_WRITE;
282 /* Otherwise userspace can ask for implicit sync to be
283 * disabled on specific buffers. This is useful for internal
284 * usermode driver managed buffers, suballocation, etc.
286 if (submit->bos[i].flags & MSM_SUBMIT_BO_NO_IMPLICIT)
289 ret = drm_sched_job_add_implicit_dependencies(&submit->base,
299 static int submit_pin_objects(struct msm_gem_submit *submit)
301 struct msm_drm_private *priv = submit->dev->dev_private;
304 for (i = 0; i < submit->nr_bos; i++) {
305 struct drm_gem_object *obj = submit->bos[i].obj;
306 struct msm_gem_vma *vma;
308 /* if locking succeeded, pin bo: */
309 vma = msm_gem_get_vma_locked(obj, submit->aspace);
315 ret = msm_gem_pin_vma_locked(obj, vma);
319 submit->bos[i].iova = vma->iova;
323 * A second loop while holding the LRU lock (a) avoids acquiring/dropping
324 * the LRU lock for each individual bo, while (b) avoiding holding the
325 * LRU lock while calling msm_gem_pin_vma_locked() (which could trigger
326 * get_pages() which could trigger reclaim.. and if we held the LRU lock
327 * could trigger deadlock with the shrinker).
329 mutex_lock(&priv->lru.lock);
330 for (i = 0; i < submit->nr_bos; i++) {
331 msm_gem_pin_obj_locked(submit->bos[i].obj);
333 mutex_unlock(&priv->lru.lock);
335 submit->bos_pinned = true;
340 static void submit_unpin_objects(struct msm_gem_submit *submit)
342 if (!submit->bos_pinned)
345 for (int i = 0; i < submit->nr_bos; i++) {
346 struct drm_gem_object *obj = submit->bos[i].obj;
348 msm_gem_unpin_locked(obj);
351 submit->bos_pinned = false;
354 static void submit_attach_object_fences(struct msm_gem_submit *submit)
358 for (i = 0; i < submit->nr_bos; i++) {
359 struct drm_gem_object *obj = submit->bos[i].obj;
361 if (submit->bos[i].flags & MSM_SUBMIT_BO_WRITE)
362 dma_resv_add_fence(obj->resv, submit->user_fence,
363 DMA_RESV_USAGE_WRITE);
364 else if (submit->bos[i].flags & MSM_SUBMIT_BO_READ)
365 dma_resv_add_fence(obj->resv, submit->user_fence,
366 DMA_RESV_USAGE_READ);
370 static int submit_bo(struct msm_gem_submit *submit, uint32_t idx,
371 struct drm_gem_object **obj, uint64_t *iova)
373 if (idx >= submit->nr_bos) {
374 SUBMIT_ERROR(submit, "invalid buffer index: %u (out of %u)\n",
375 idx, submit->nr_bos);
380 *obj = submit->bos[idx].obj;
382 *iova = submit->bos[idx].iova;
387 /* process the reloc's and patch up the cmdstream as needed: */
388 static int submit_reloc(struct msm_gem_submit *submit, struct drm_gem_object *obj,
389 uint32_t offset, uint32_t nr_relocs, struct drm_msm_gem_submit_reloc *relocs)
391 uint32_t i, last_offset = 0;
396 SUBMIT_ERROR(submit, "non-aligned cmdstream buffer: %u\n", offset);
400 /* For now, just map the entire thing. Eventually we probably
401 * to do it page-by-page, w/ kmap() if not vmap()d..
403 ptr = msm_gem_get_vaddr_locked(obj);
407 DBG("failed to map: %d", ret);
411 for (i = 0; i < nr_relocs; i++) {
412 struct drm_msm_gem_submit_reloc submit_reloc = relocs[i];
416 if (submit_reloc.submit_offset % 4) {
417 SUBMIT_ERROR(submit, "non-aligned reloc offset: %u\n",
418 submit_reloc.submit_offset);
423 /* offset in dwords: */
424 off = submit_reloc.submit_offset / 4;
426 if ((off >= (obj->size / 4)) ||
427 (off < last_offset)) {
428 SUBMIT_ERROR(submit, "invalid offset %u at reloc %u\n", off, i);
433 ret = submit_bo(submit, submit_reloc.reloc_idx, NULL, &iova);
437 iova += submit_reloc.reloc_offset;
439 if (submit_reloc.shift < 0)
440 iova >>= -submit_reloc.shift;
442 iova <<= submit_reloc.shift;
444 ptr[off] = iova | submit_reloc.or;
450 msm_gem_put_vaddr_locked(obj);
455 /* Cleanup submit at end of ioctl. In the error case, this also drops
456 * references, unpins, and drops active refcnt. In the non-error case,
457 * this is done when the submit is retired.
459 static void submit_cleanup(struct msm_gem_submit *submit, bool error)
462 submit_unpin_objects(submit);
463 /* job wasn't enqueued to scheduler, so early retirement: */
464 msm_submit_retire(submit);
467 if (submit->exec.objects)
468 drm_exec_fini(&submit->exec);
471 void msm_submit_retire(struct msm_gem_submit *submit)
475 for (i = 0; i < submit->nr_bos; i++) {
476 struct drm_gem_object *obj = submit->bos[i].obj;
478 drm_gem_object_put(obj);
482 struct msm_submit_post_dep {
483 struct drm_syncobj *syncobj;
485 struct dma_fence_chain *chain;
488 static struct drm_syncobj **msm_parse_deps(struct msm_gem_submit *submit,
489 struct drm_file *file,
490 uint64_t in_syncobjs_addr,
491 uint32_t nr_in_syncobjs,
492 size_t syncobj_stride)
494 struct drm_syncobj **syncobjs = NULL;
495 struct drm_msm_gem_submit_syncobj syncobj_desc = {0};
499 syncobjs = kcalloc(nr_in_syncobjs, sizeof(*syncobjs),
500 GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
502 return ERR_PTR(-ENOMEM);
504 for (i = 0; i < nr_in_syncobjs; ++i) {
505 uint64_t address = in_syncobjs_addr + i * syncobj_stride;
507 if (copy_from_user(&syncobj_desc,
508 u64_to_user_ptr(address),
509 min(syncobj_stride, sizeof(syncobj_desc)))) {
514 if (syncobj_desc.point &&
515 !drm_core_check_feature(submit->dev, DRIVER_SYNCOBJ_TIMELINE)) {
520 if (syncobj_desc.flags & ~MSM_SUBMIT_SYNCOBJ_FLAGS) {
525 ret = drm_sched_job_add_syncobj_dependency(&submit->base, file,
526 syncobj_desc.handle, syncobj_desc.point);
530 if (syncobj_desc.flags & MSM_SUBMIT_SYNCOBJ_RESET) {
532 drm_syncobj_find(file, syncobj_desc.handle);
541 for (j = 0; j <= i; ++j) {
543 drm_syncobj_put(syncobjs[j]);
551 static void msm_reset_syncobjs(struct drm_syncobj **syncobjs,
552 uint32_t nr_syncobjs)
556 for (i = 0; syncobjs && i < nr_syncobjs; ++i) {
558 drm_syncobj_replace_fence(syncobjs[i], NULL);
562 static struct msm_submit_post_dep *msm_parse_post_deps(struct drm_device *dev,
563 struct drm_file *file,
564 uint64_t syncobjs_addr,
565 uint32_t nr_syncobjs,
566 size_t syncobj_stride)
568 struct msm_submit_post_dep *post_deps;
569 struct drm_msm_gem_submit_syncobj syncobj_desc = {0};
573 post_deps = kcalloc(nr_syncobjs, sizeof(*post_deps),
574 GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
576 return ERR_PTR(-ENOMEM);
578 for (i = 0; i < nr_syncobjs; ++i) {
579 uint64_t address = syncobjs_addr + i * syncobj_stride;
581 if (copy_from_user(&syncobj_desc,
582 u64_to_user_ptr(address),
583 min(syncobj_stride, sizeof(syncobj_desc)))) {
588 post_deps[i].point = syncobj_desc.point;
590 if (syncobj_desc.flags) {
595 if (syncobj_desc.point) {
596 if (!drm_core_check_feature(dev,
597 DRIVER_SYNCOBJ_TIMELINE)) {
602 post_deps[i].chain = dma_fence_chain_alloc();
603 if (!post_deps[i].chain) {
609 post_deps[i].syncobj =
610 drm_syncobj_find(file, syncobj_desc.handle);
611 if (!post_deps[i].syncobj) {
618 for (j = 0; j <= i; ++j) {
619 dma_fence_chain_free(post_deps[j].chain);
620 if (post_deps[j].syncobj)
621 drm_syncobj_put(post_deps[j].syncobj);
631 static void msm_process_post_deps(struct msm_submit_post_dep *post_deps,
632 uint32_t count, struct dma_fence *fence)
636 for (i = 0; post_deps && i < count; ++i) {
637 if (post_deps[i].chain) {
638 drm_syncobj_add_point(post_deps[i].syncobj,
640 fence, post_deps[i].point);
641 post_deps[i].chain = NULL;
643 drm_syncobj_replace_fence(post_deps[i].syncobj,
649 int msm_ioctl_gem_submit(struct drm_device *dev, void *data,
650 struct drm_file *file)
652 struct msm_drm_private *priv = dev->dev_private;
653 struct drm_msm_gem_submit *args = data;
654 struct msm_file_private *ctx = file->driver_priv;
655 struct msm_gem_submit *submit = NULL;
656 struct msm_gpu *gpu = priv->gpu;
657 struct msm_gpu_submitqueue *queue;
658 struct msm_ringbuffer *ring;
659 struct msm_submit_post_dep *post_deps = NULL;
660 struct drm_syncobj **syncobjs_to_reset = NULL;
661 int out_fence_fd = -1;
671 if (unlikely(!ctx->aspace) && !capable(CAP_SYS_RAWIO)) {
672 DRM_ERROR_RATELIMITED("IOMMU support or CAP_SYS_RAWIO required!\n");
676 /* for now, we just have 3d pipe.. eventually this would need to
677 * be more clever to dispatch to appropriate gpu module:
679 if (MSM_PIPE_ID(args->flags) != MSM_PIPE_3D0)
682 if (MSM_PIPE_FLAGS(args->flags) & ~MSM_SUBMIT_FLAGS)
685 if (args->flags & MSM_SUBMIT_SUDO) {
686 if (!IS_ENABLED(CONFIG_DRM_MSM_GPU_SUDO) ||
687 !capable(CAP_SYS_RAWIO))
691 queue = msm_submitqueue_get(ctx, args->queueid);
695 ring = gpu->rb[queue->ring_nr];
697 if (args->flags & MSM_SUBMIT_FENCE_FD_OUT) {
698 out_fence_fd = get_unused_fd_flags(O_CLOEXEC);
699 if (out_fence_fd < 0) {
701 goto out_post_unlock;
705 submit = submit_create(dev, gpu, queue, args->nr_bos, args->nr_cmds);
706 if (IS_ERR(submit)) {
707 ret = PTR_ERR(submit);
708 goto out_post_unlock;
711 trace_msm_gpu_submit(pid_nr(submit->pid), ring->id, submit->ident,
712 args->nr_bos, args->nr_cmds);
714 ret = mutex_lock_interruptible(&queue->lock);
716 goto out_post_unlock;
718 if (args->flags & MSM_SUBMIT_SUDO)
719 submit->in_rb = true;
721 if (args->flags & MSM_SUBMIT_FENCE_FD_IN) {
722 struct dma_fence *in_fence;
724 in_fence = sync_file_get_fence(args->fence_fd);
731 ret = drm_sched_job_add_dependency(&submit->base, in_fence);
736 if (args->flags & MSM_SUBMIT_SYNCOBJ_IN) {
737 syncobjs_to_reset = msm_parse_deps(submit, file,
739 args->nr_in_syncobjs,
740 args->syncobj_stride);
741 if (IS_ERR(syncobjs_to_reset)) {
742 ret = PTR_ERR(syncobjs_to_reset);
747 if (args->flags & MSM_SUBMIT_SYNCOBJ_OUT) {
748 post_deps = msm_parse_post_deps(dev, file,
750 args->nr_out_syncobjs,
751 args->syncobj_stride);
752 if (IS_ERR(post_deps)) {
753 ret = PTR_ERR(post_deps);
758 ret = submit_lookup_objects(submit, args, file);
762 ret = submit_lookup_cmds(submit, args, file);
766 /* copy_*_user while holding a ww ticket upsets lockdep */
767 ret = submit_lock_objects(submit);
771 if (!(args->flags & MSM_SUBMIT_NO_IMPLICIT)) {
772 ret = submit_fence_sync(submit);
777 ret = submit_pin_objects(submit);
781 for (i = 0; i < args->nr_cmds; i++) {
782 struct drm_gem_object *obj;
785 ret = submit_bo(submit, submit->cmd[i].idx, &obj, &iova);
789 if (!submit->cmd[i].size ||
790 ((submit->cmd[i].size + submit->cmd[i].offset) >
792 SUBMIT_ERROR(submit, "invalid cmdstream size: %u\n", submit->cmd[i].size * 4);
797 submit->cmd[i].iova = iova + (submit->cmd[i].offset * 4);
799 if (likely(!submit->cmd[i].nr_relocs))
802 if (!gpu->allow_relocs) {
803 SUBMIT_ERROR(submit, "relocs not allowed\n");
808 ret = submit_reloc(submit, obj, submit->cmd[i].offset * 4,
809 submit->cmd[i].nr_relocs, submit->cmd[i].relocs);
816 idr_preload(GFP_KERNEL);
818 spin_lock(&queue->idr_lock);
821 * If using userspace provided seqno fence, validate that the id
822 * is available before arming sched job. Since access to fence_idr
823 * is serialized on the queue lock, the slot should be still avail
824 * after the job is armed
826 if ((args->flags & MSM_SUBMIT_FENCE_SN_IN) &&
827 (!args->fence || idr_find(&queue->fence_idr, args->fence))) {
828 spin_unlock(&queue->idr_lock);
834 drm_sched_job_arm(&submit->base);
836 submit->user_fence = dma_fence_get(&submit->base.s_fence->finished);
838 if (args->flags & MSM_SUBMIT_FENCE_SN_IN) {
840 * Userspace has assigned the seqno fence that it wants
841 * us to use. It is an error to pick a fence sequence
842 * number that is not available.
844 submit->fence_id = args->fence;
845 ret = idr_alloc_u32(&queue->fence_idr, submit->user_fence,
846 &submit->fence_id, submit->fence_id,
849 * We've already validated that the fence_id slot is valid,
850 * so if idr_alloc_u32 failed, it is a kernel bug
855 * Allocate an id which can be used by WAIT_FENCE ioctl to map
856 * back to the underlying fence.
858 submit->fence_id = idr_alloc_cyclic(&queue->fence_idr,
859 submit->user_fence, 1,
860 INT_MAX, GFP_NOWAIT);
863 spin_unlock(&queue->idr_lock);
866 if (submit->fence_id < 0) {
867 ret = submit->fence_id;
868 submit->fence_id = 0;
871 if (ret == 0 && args->flags & MSM_SUBMIT_FENCE_FD_OUT) {
872 struct sync_file *sync_file = sync_file_create(submit->user_fence);
876 fd_install(out_fence_fd, sync_file->file);
877 args->fence_fd = out_fence_fd;
884 submit_attach_object_fences(submit);
886 /* The scheduler owns a ref now: */
887 msm_gem_submit_get(submit);
889 msm_rd_dump_submit(priv->rd, submit, NULL);
891 drm_sched_entity_push_job(&submit->base);
893 args->fence = submit->fence_id;
894 queue->last_fence = submit->fence_id;
896 msm_reset_syncobjs(syncobjs_to_reset, args->nr_in_syncobjs);
897 msm_process_post_deps(post_deps, args->nr_out_syncobjs,
902 submit_cleanup(submit, !!ret);
904 mutex_unlock(&queue->lock);
906 if (ret && (out_fence_fd >= 0))
907 put_unused_fd(out_fence_fd);
909 if (!IS_ERR_OR_NULL(submit)) {
910 msm_gem_submit_put(submit);
913 * If the submit hasn't yet taken ownership of the queue
914 * then we need to drop the reference ourself:
916 msm_submitqueue_put(queue);
918 if (!IS_ERR_OR_NULL(post_deps)) {
919 for (i = 0; i < args->nr_out_syncobjs; ++i) {
920 kfree(post_deps[i].chain);
921 drm_syncobj_put(post_deps[i].syncobj);
926 if (!IS_ERR_OR_NULL(syncobjs_to_reset)) {
927 for (i = 0; i < args->nr_in_syncobjs; ++i) {
928 if (syncobjs_to_reset[i])
929 drm_syncobj_put(syncobjs_to_reset[i]);
931 kfree(syncobjs_to_reset);