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"
21 * Cmdstream submission:
24 /* make sure these don't conflict w/ MSM_SUBMIT_BO_x */
25 #define BO_VALID 0x8000 /* is current addr in cmdstream correct/valid? */
26 #define BO_LOCKED 0x4000 /* obj lock is held */
27 #define BO_ACTIVE 0x2000 /* active refcnt is held */
28 #define BO_PINNED 0x1000 /* obj is pinned and on active list */
30 static struct msm_gem_submit *submit_create(struct drm_device *dev,
32 struct msm_gpu_submitqueue *queue, uint32_t nr_bos,
35 struct msm_gem_submit *submit;
39 sz = struct_size(submit, bos, nr_bos) +
40 ((u64)nr_cmds * sizeof(submit->cmd[0]));
43 return ERR_PTR(-ENOMEM);
45 submit = kzalloc(sz, GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
47 return ERR_PTR(-ENOMEM);
49 ret = drm_sched_job_init(&submit->base, queue->entity, queue);
55 kref_init(&submit->ref);
57 submit->aspace = queue->ctx->aspace;
59 submit->cmd = (void *)&submit->bos[nr_bos];
60 submit->queue = queue;
61 submit->ring = gpu->rb[queue->ring_nr];
62 submit->fault_dumped = false;
64 INIT_LIST_HEAD(&submit->node);
69 void __msm_gem_submit_destroy(struct kref *kref)
71 struct msm_gem_submit *submit =
72 container_of(kref, struct msm_gem_submit, ref);
75 if (submit->fence_id) {
76 mutex_lock(&submit->queue->lock);
77 idr_remove(&submit->queue->fence_idr, submit->fence_id);
78 mutex_unlock(&submit->queue->lock);
81 dma_fence_put(submit->user_fence);
82 dma_fence_put(submit->hw_fence);
85 msm_submitqueue_put(submit->queue);
87 for (i = 0; i < submit->nr_cmds; i++)
88 kfree(submit->cmd[i].relocs);
93 static int submit_lookup_objects(struct msm_gem_submit *submit,
94 struct drm_msm_gem_submit *args, struct drm_file *file)
99 for (i = 0; i < args->nr_bos; i++) {
100 struct drm_msm_gem_submit_bo submit_bo;
101 void __user *userptr =
102 u64_to_user_ptr(args->bos + (i * sizeof(submit_bo)));
104 /* make sure we don't have garbage flags, in case we hit
105 * error path before flags is initialized:
107 submit->bos[i].flags = 0;
109 if (copy_from_user(&submit_bo, userptr, sizeof(submit_bo))) {
115 /* at least one of READ and/or WRITE flags should be set: */
116 #define MANDATORY_FLAGS (MSM_SUBMIT_BO_READ | MSM_SUBMIT_BO_WRITE)
118 if ((submit_bo.flags & ~MSM_SUBMIT_BO_FLAGS) ||
119 !(submit_bo.flags & MANDATORY_FLAGS)) {
120 DRM_ERROR("invalid flags: %x\n", submit_bo.flags);
126 submit->bos[i].handle = submit_bo.handle;
127 submit->bos[i].flags = submit_bo.flags;
128 /* in validate_objects() we figure out if this is true: */
129 submit->bos[i].iova = submit_bo.presumed;
132 spin_lock(&file->table_lock);
134 for (i = 0; i < args->nr_bos; i++) {
135 struct drm_gem_object *obj;
137 /* normally use drm_gem_object_lookup(), but for bulk lookup
138 * all under single table_lock just hit object_idr directly:
140 obj = idr_find(&file->object_idr, submit->bos[i].handle);
142 DRM_ERROR("invalid handle %u at index %u\n", submit->bos[i].handle, i);
147 drm_gem_object_get(obj);
149 submit->bos[i].obj = to_msm_bo(obj);
153 spin_unlock(&file->table_lock);
161 static int submit_lookup_cmds(struct msm_gem_submit *submit,
162 struct drm_msm_gem_submit *args, struct drm_file *file)
168 for (i = 0; i < args->nr_cmds; i++) {
169 struct drm_msm_gem_submit_cmd submit_cmd;
170 void __user *userptr =
171 u64_to_user_ptr(args->cmds + (i * sizeof(submit_cmd)));
173 ret = copy_from_user(&submit_cmd, userptr, sizeof(submit_cmd));
179 /* validate input from userspace: */
180 switch (submit_cmd.type) {
181 case MSM_SUBMIT_CMD_BUF:
182 case MSM_SUBMIT_CMD_IB_TARGET_BUF:
183 case MSM_SUBMIT_CMD_CTX_RESTORE_BUF:
186 DRM_ERROR("invalid type: %08x\n", submit_cmd.type);
190 if (submit_cmd.size % 4) {
191 DRM_ERROR("non-aligned cmdstream buffer size: %u\n",
197 submit->cmd[i].type = submit_cmd.type;
198 submit->cmd[i].size = submit_cmd.size / 4;
199 submit->cmd[i].offset = submit_cmd.submit_offset / 4;
200 submit->cmd[i].idx = submit_cmd.submit_idx;
201 submit->cmd[i].nr_relocs = submit_cmd.nr_relocs;
203 userptr = u64_to_user_ptr(submit_cmd.relocs);
205 sz = array_size(submit_cmd.nr_relocs,
206 sizeof(struct drm_msm_gem_submit_reloc));
207 /* check for overflow: */
208 if (sz == SIZE_MAX) {
212 submit->cmd[i].relocs = kmalloc(sz, GFP_KERNEL);
213 ret = copy_from_user(submit->cmd[i].relocs, userptr, sz);
224 /* Unwind bo state, according to cleanup_flags. In the success case, only
225 * the lock is dropped at the end of the submit (and active/pin ref is dropped
226 * later when the submit is retired).
228 static void submit_cleanup_bo(struct msm_gem_submit *submit, int i,
229 unsigned cleanup_flags)
231 struct drm_gem_object *obj = &submit->bos[i].obj->base;
232 unsigned flags = submit->bos[i].flags & cleanup_flags;
234 if (flags & BO_PINNED)
235 msm_gem_unpin_iova_locked(obj, submit->aspace);
237 if (flags & BO_ACTIVE)
238 msm_gem_active_put(obj);
240 if (flags & BO_LOCKED)
241 dma_resv_unlock(obj->resv);
243 submit->bos[i].flags &= ~cleanup_flags;
246 static void submit_unlock_unpin_bo(struct msm_gem_submit *submit, int i)
248 submit_cleanup_bo(submit, i, BO_PINNED | BO_ACTIVE | BO_LOCKED);
250 if (!(submit->bos[i].flags & BO_VALID))
251 submit->bos[i].iova = 0;
254 /* This is where we make sure all the bo's are reserved and pin'd: */
255 static int submit_lock_objects(struct msm_gem_submit *submit)
257 int contended, slow_locked = -1, i, ret = 0;
260 for (i = 0; i < submit->nr_bos; i++) {
261 struct msm_gem_object *msm_obj = submit->bos[i].obj;
263 if (slow_locked == i)
268 if (!(submit->bos[i].flags & BO_LOCKED)) {
269 ret = dma_resv_lock_interruptible(msm_obj->base.resv,
273 submit->bos[i].flags |= BO_LOCKED;
277 ww_acquire_done(&submit->ticket);
282 if (ret == -EALREADY) {
283 DRM_ERROR("handle %u at index %u already on submit list\n",
284 submit->bos[i].handle, i);
289 submit_unlock_unpin_bo(submit, i);
292 submit_unlock_unpin_bo(submit, slow_locked);
294 if (ret == -EDEADLK) {
295 struct msm_gem_object *msm_obj = submit->bos[contended].obj;
296 /* we lost out in a seqno race, lock and retry.. */
297 ret = dma_resv_lock_slow_interruptible(msm_obj->base.resv,
300 submit->bos[contended].flags |= BO_LOCKED;
301 slow_locked = contended;
305 /* Not expecting -EALREADY here, if the bo was already
306 * locked, we should have gotten -EALREADY already from
307 * the dma_resv_lock_interruptable() call.
309 WARN_ON_ONCE(ret == -EALREADY);
315 static int submit_fence_sync(struct msm_gem_submit *submit, bool no_implicit)
319 for (i = 0; i < submit->nr_bos; i++) {
320 struct drm_gem_object *obj = &submit->bos[i].obj->base;
321 bool write = submit->bos[i].flags & MSM_SUBMIT_BO_WRITE;
324 /* NOTE: _reserve_shared() must happen before
325 * _add_shared_fence(), which makes this a slightly
326 * strange place to call it. OTOH this is a
327 * convenient can-fail point to hook it in.
329 ret = dma_resv_reserve_shared(obj->resv, 1);
334 /* exclusive fences must be ordered */
335 if (no_implicit && !write)
338 ret = drm_sched_job_add_implicit_dependencies(&submit->base,
348 static int submit_pin_objects(struct msm_gem_submit *submit)
352 submit->valid = true;
355 * Increment active_count first, so if under memory pressure, we
356 * don't inadvertently evict a bo needed by the submit in order
357 * to pin an earlier bo in the same submit.
359 for (i = 0; i < submit->nr_bos; i++) {
360 struct drm_gem_object *obj = &submit->bos[i].obj->base;
362 msm_gem_active_get(obj, submit->gpu);
363 submit->bos[i].flags |= BO_ACTIVE;
366 for (i = 0; i < submit->nr_bos; i++) {
367 struct drm_gem_object *obj = &submit->bos[i].obj->base;
370 /* if locking succeeded, pin bo: */
371 ret = msm_gem_get_and_pin_iova_locked(obj,
372 submit->aspace, &iova);
377 submit->bos[i].flags |= BO_PINNED;
379 if (iova == submit->bos[i].iova) {
380 submit->bos[i].flags |= BO_VALID;
382 submit->bos[i].iova = iova;
383 /* iova changed, so address in cmdstream is not valid: */
384 submit->bos[i].flags &= ~BO_VALID;
385 submit->valid = false;
392 static void submit_attach_object_fences(struct msm_gem_submit *submit)
396 for (i = 0; i < submit->nr_bos; i++) {
397 struct drm_gem_object *obj = &submit->bos[i].obj->base;
399 if (submit->bos[i].flags & MSM_SUBMIT_BO_WRITE)
400 dma_resv_add_excl_fence(obj->resv, submit->user_fence);
401 else if (submit->bos[i].flags & MSM_SUBMIT_BO_READ)
402 dma_resv_add_shared_fence(obj->resv, submit->user_fence);
406 static int submit_bo(struct msm_gem_submit *submit, uint32_t idx,
407 struct msm_gem_object **obj, uint64_t *iova, bool *valid)
409 if (idx >= submit->nr_bos) {
410 DRM_ERROR("invalid buffer index: %u (out of %u)\n",
411 idx, submit->nr_bos);
416 *obj = submit->bos[idx].obj;
418 *iova = submit->bos[idx].iova;
420 *valid = !!(submit->bos[idx].flags & BO_VALID);
425 /* process the reloc's and patch up the cmdstream as needed: */
426 static int submit_reloc(struct msm_gem_submit *submit, struct msm_gem_object *obj,
427 uint32_t offset, uint32_t nr_relocs, struct drm_msm_gem_submit_reloc *relocs)
429 uint32_t i, last_offset = 0;
437 DRM_ERROR("non-aligned cmdstream buffer: %u\n", offset);
441 /* For now, just map the entire thing. Eventually we probably
442 * to do it page-by-page, w/ kmap() if not vmap()d..
444 ptr = msm_gem_get_vaddr_locked(&obj->base);
448 DBG("failed to map: %d", ret);
452 for (i = 0; i < nr_relocs; i++) {
453 struct drm_msm_gem_submit_reloc submit_reloc = relocs[i];
458 if (submit_reloc.submit_offset % 4) {
459 DRM_ERROR("non-aligned reloc offset: %u\n",
460 submit_reloc.submit_offset);
465 /* offset in dwords: */
466 off = submit_reloc.submit_offset / 4;
468 if ((off >= (obj->base.size / 4)) ||
469 (off < last_offset)) {
470 DRM_ERROR("invalid offset %u at reloc %u\n", off, i);
475 ret = submit_bo(submit, submit_reloc.reloc_idx, NULL, &iova, &valid);
482 iova += submit_reloc.reloc_offset;
484 if (submit_reloc.shift < 0)
485 iova >>= -submit_reloc.shift;
487 iova <<= submit_reloc.shift;
489 ptr[off] = iova | submit_reloc.or;
495 msm_gem_put_vaddr_locked(&obj->base);
500 /* Cleanup submit at end of ioctl. In the error case, this also drops
501 * references, unpins, and drops active refcnt. In the non-error case,
502 * this is done when the submit is retired.
504 static void submit_cleanup(struct msm_gem_submit *submit, bool error)
506 unsigned cleanup_flags = BO_LOCKED;
510 cleanup_flags |= BO_PINNED | BO_ACTIVE;
512 for (i = 0; i < submit->nr_bos; i++) {
513 struct msm_gem_object *msm_obj = submit->bos[i].obj;
514 submit_cleanup_bo(submit, i, cleanup_flags);
516 drm_gem_object_put(&msm_obj->base);
520 void msm_submit_retire(struct msm_gem_submit *submit)
524 for (i = 0; i < submit->nr_bos; i++) {
525 struct drm_gem_object *obj = &submit->bos[i].obj->base;
528 submit_cleanup_bo(submit, i, BO_PINNED | BO_ACTIVE);
530 drm_gem_object_put(obj);
534 struct msm_submit_post_dep {
535 struct drm_syncobj *syncobj;
537 struct dma_fence_chain *chain;
540 static struct drm_syncobj **msm_parse_deps(struct msm_gem_submit *submit,
541 struct drm_file *file,
542 uint64_t in_syncobjs_addr,
543 uint32_t nr_in_syncobjs,
544 size_t syncobj_stride,
545 struct msm_ringbuffer *ring)
547 struct drm_syncobj **syncobjs = NULL;
548 struct drm_msm_gem_submit_syncobj syncobj_desc = {0};
552 syncobjs = kcalloc(nr_in_syncobjs, sizeof(*syncobjs),
553 GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
555 return ERR_PTR(-ENOMEM);
557 for (i = 0; i < nr_in_syncobjs; ++i) {
558 uint64_t address = in_syncobjs_addr + i * syncobj_stride;
559 struct dma_fence *fence;
561 if (copy_from_user(&syncobj_desc,
562 u64_to_user_ptr(address),
563 min(syncobj_stride, sizeof(syncobj_desc)))) {
568 if (syncobj_desc.point &&
569 !drm_core_check_feature(submit->dev, DRIVER_SYNCOBJ_TIMELINE)) {
574 if (syncobj_desc.flags & ~MSM_SUBMIT_SYNCOBJ_FLAGS) {
579 ret = drm_syncobj_find_fence(file, syncobj_desc.handle,
580 syncobj_desc.point, 0, &fence);
584 ret = drm_sched_job_add_dependency(&submit->base, fence);
588 if (syncobj_desc.flags & MSM_SUBMIT_SYNCOBJ_RESET) {
590 drm_syncobj_find(file, syncobj_desc.handle);
599 for (j = 0; j <= i; ++j) {
601 drm_syncobj_put(syncobjs[j]);
609 static void msm_reset_syncobjs(struct drm_syncobj **syncobjs,
610 uint32_t nr_syncobjs)
614 for (i = 0; syncobjs && i < nr_syncobjs; ++i) {
616 drm_syncobj_replace_fence(syncobjs[i], NULL);
620 static struct msm_submit_post_dep *msm_parse_post_deps(struct drm_device *dev,
621 struct drm_file *file,
622 uint64_t syncobjs_addr,
623 uint32_t nr_syncobjs,
624 size_t syncobj_stride)
626 struct msm_submit_post_dep *post_deps;
627 struct drm_msm_gem_submit_syncobj syncobj_desc = {0};
631 post_deps = kmalloc_array(nr_syncobjs, sizeof(*post_deps),
632 GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
634 return ERR_PTR(-ENOMEM);
636 for (i = 0; i < nr_syncobjs; ++i) {
637 uint64_t address = syncobjs_addr + i * syncobj_stride;
639 if (copy_from_user(&syncobj_desc,
640 u64_to_user_ptr(address),
641 min(syncobj_stride, sizeof(syncobj_desc)))) {
646 post_deps[i].point = syncobj_desc.point;
647 post_deps[i].chain = NULL;
649 if (syncobj_desc.flags) {
654 if (syncobj_desc.point) {
655 if (!drm_core_check_feature(dev,
656 DRIVER_SYNCOBJ_TIMELINE)) {
661 post_deps[i].chain = dma_fence_chain_alloc();
662 if (!post_deps[i].chain) {
668 post_deps[i].syncobj =
669 drm_syncobj_find(file, syncobj_desc.handle);
670 if (!post_deps[i].syncobj) {
677 for (j = 0; j <= i; ++j) {
678 dma_fence_chain_free(post_deps[j].chain);
679 if (post_deps[j].syncobj)
680 drm_syncobj_put(post_deps[j].syncobj);
690 static void msm_process_post_deps(struct msm_submit_post_dep *post_deps,
691 uint32_t count, struct dma_fence *fence)
695 for (i = 0; post_deps && i < count; ++i) {
696 if (post_deps[i].chain) {
697 drm_syncobj_add_point(post_deps[i].syncobj,
699 fence, post_deps[i].point);
700 post_deps[i].chain = NULL;
702 drm_syncobj_replace_fence(post_deps[i].syncobj,
708 int msm_ioctl_gem_submit(struct drm_device *dev, void *data,
709 struct drm_file *file)
711 static atomic_t ident = ATOMIC_INIT(0);
712 struct msm_drm_private *priv = dev->dev_private;
713 struct drm_msm_gem_submit *args = data;
714 struct msm_file_private *ctx = file->driver_priv;
715 struct msm_gem_submit *submit = NULL;
716 struct msm_gpu *gpu = priv->gpu;
717 struct msm_gpu_submitqueue *queue;
718 struct msm_ringbuffer *ring;
719 struct msm_submit_post_dep *post_deps = NULL;
720 struct drm_syncobj **syncobjs_to_reset = NULL;
721 int out_fence_fd = -1;
722 struct pid *pid = get_pid(task_pid(current));
723 bool has_ww_ticket = false;
733 /* for now, we just have 3d pipe.. eventually this would need to
734 * be more clever to dispatch to appropriate gpu module:
736 if (MSM_PIPE_ID(args->flags) != MSM_PIPE_3D0)
739 if (MSM_PIPE_FLAGS(args->flags) & ~MSM_SUBMIT_FLAGS)
742 if (args->flags & MSM_SUBMIT_SUDO) {
743 if (!IS_ENABLED(CONFIG_DRM_MSM_GPU_SUDO) ||
744 !capable(CAP_SYS_RAWIO))
748 queue = msm_submitqueue_get(ctx, args->queueid);
752 /* Get a unique identifier for the submission for logging purposes */
753 submitid = atomic_inc_return(&ident) - 1;
755 ring = gpu->rb[queue->ring_nr];
756 trace_msm_gpu_submit(pid_nr(pid), ring->id, submitid,
757 args->nr_bos, args->nr_cmds);
759 ret = mutex_lock_interruptible(&queue->lock);
761 goto out_post_unlock;
763 if (args->flags & MSM_SUBMIT_FENCE_FD_OUT) {
764 out_fence_fd = get_unused_fd_flags(O_CLOEXEC);
765 if (out_fence_fd < 0) {
771 submit = submit_create(dev, gpu, queue, args->nr_bos,
773 if (IS_ERR(submit)) {
774 ret = PTR_ERR(submit);
780 submit->ident = submitid;
782 if (args->flags & MSM_SUBMIT_SUDO)
783 submit->in_rb = true;
785 if (args->flags & MSM_SUBMIT_FENCE_FD_IN) {
786 struct dma_fence *in_fence;
788 in_fence = sync_file_get_fence(args->fence_fd);
795 ret = drm_sched_job_add_dependency(&submit->base, in_fence);
800 if (args->flags & MSM_SUBMIT_SYNCOBJ_IN) {
801 syncobjs_to_reset = msm_parse_deps(submit, file,
803 args->nr_in_syncobjs,
804 args->syncobj_stride, ring);
805 if (IS_ERR(syncobjs_to_reset)) {
806 ret = PTR_ERR(syncobjs_to_reset);
811 if (args->flags & MSM_SUBMIT_SYNCOBJ_OUT) {
812 post_deps = msm_parse_post_deps(dev, file,
814 args->nr_out_syncobjs,
815 args->syncobj_stride);
816 if (IS_ERR(post_deps)) {
817 ret = PTR_ERR(post_deps);
822 ret = submit_lookup_objects(submit, args, file);
826 ret = submit_lookup_cmds(submit, args, file);
830 /* copy_*_user while holding a ww ticket upsets lockdep */
831 ww_acquire_init(&submit->ticket, &reservation_ww_class);
832 has_ww_ticket = true;
833 ret = submit_lock_objects(submit);
837 ret = submit_fence_sync(submit, !!(args->flags & MSM_SUBMIT_NO_IMPLICIT));
841 ret = submit_pin_objects(submit);
845 for (i = 0; i < args->nr_cmds; i++) {
846 struct msm_gem_object *msm_obj;
849 ret = submit_bo(submit, submit->cmd[i].idx,
850 &msm_obj, &iova, NULL);
854 if (!submit->cmd[i].size ||
855 ((submit->cmd[i].size + submit->cmd[i].offset) >
856 msm_obj->base.size / 4)) {
857 DRM_ERROR("invalid cmdstream size: %u\n", submit->cmd[i].size * 4);
862 submit->cmd[i].iova = iova + (submit->cmd[i].offset * 4);
867 ret = submit_reloc(submit, msm_obj, submit->cmd[i].offset * 4,
868 submit->cmd[i].nr_relocs, submit->cmd[i].relocs);
875 drm_sched_job_arm(&submit->base);
877 submit->user_fence = dma_fence_get(&submit->base.s_fence->finished);
880 * Allocate an id which can be used by WAIT_FENCE ioctl to map back
881 * to the underlying fence.
883 submit->fence_id = idr_alloc_cyclic(&queue->fence_idr,
884 submit->user_fence, 1, INT_MAX, GFP_KERNEL);
885 if (submit->fence_id < 0) {
886 ret = submit->fence_id = 0;
887 submit->fence_id = 0;
890 if (ret == 0 && args->flags & MSM_SUBMIT_FENCE_FD_OUT) {
891 struct sync_file *sync_file = sync_file_create(submit->user_fence);
895 fd_install(out_fence_fd, sync_file->file);
896 args->fence_fd = out_fence_fd;
900 submit_attach_object_fences(submit);
902 /* The scheduler owns a ref now: */
903 msm_gem_submit_get(submit);
905 drm_sched_entity_push_job(&submit->base);
907 args->fence = submit->fence_id;
908 queue->last_fence = submit->fence_id;
910 msm_reset_syncobjs(syncobjs_to_reset, args->nr_in_syncobjs);
911 msm_process_post_deps(post_deps, args->nr_out_syncobjs,
916 submit_cleanup(submit, !!ret);
918 ww_acquire_fini(&submit->ticket);
920 if (ret && (out_fence_fd >= 0))
921 put_unused_fd(out_fence_fd);
922 mutex_unlock(&queue->lock);
924 msm_gem_submit_put(submit);
926 if (!IS_ERR_OR_NULL(post_deps)) {
927 for (i = 0; i < args->nr_out_syncobjs; ++i) {
928 kfree(post_deps[i].chain);
929 drm_syncobj_put(post_deps[i].syncobj);
934 if (!IS_ERR_OR_NULL(syncobjs_to_reset)) {
935 for (i = 0; i < args->nr_in_syncobjs; ++i) {
936 if (syncobjs_to_reset[i])
937 drm_syncobj_put(syncobjs_to_reset[i]);
939 kfree(syncobjs_to_reset);