xref: /linux/drivers/gpu/drm/amd/amdgpu/amdgpu_userq_fence.c (revision db217d08afc21cbe13f282948a74c528d8740d3b)
1 // SPDX-License-Identifier: MIT
2 /*
3  * Copyright 2023 Advanced Micro Devices, Inc.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21  * OTHER DEALINGS IN THE SOFTWARE.
22  *
23  */
24 
25 #include <linux/kref.h>
26 #include <linux/slab.h>
27 #include <linux/dma-fence-unwrap.h>
28 
29 #include <drm/drm_exec.h>
30 #include <drm/drm_syncobj.h>
31 
32 #include "amdgpu.h"
33 #include "amdgpu_userq_fence.h"
34 
35 static const struct dma_fence_ops amdgpu_userq_fence_ops;
36 static struct kmem_cache *amdgpu_userq_fence_slab;
37 
38 #define AMDGPU_USERQ_MAX_HANDLES	(1U << 16)
39 
40 int amdgpu_userq_fence_slab_init(void)
41 {
42 	amdgpu_userq_fence_slab = kmem_cache_create("amdgpu_userq_fence",
43 						    sizeof(struct amdgpu_userq_fence),
44 						    0,
45 						    SLAB_HWCACHE_ALIGN,
46 						    NULL);
47 	if (!amdgpu_userq_fence_slab)
48 		return -ENOMEM;
49 
50 	return 0;
51 }
52 
53 void amdgpu_userq_fence_slab_fini(void)
54 {
55 	rcu_barrier();
56 	kmem_cache_destroy(amdgpu_userq_fence_slab);
57 }
58 
59 static inline struct amdgpu_userq_fence *to_amdgpu_userq_fence(struct dma_fence *f)
60 {
61 	if (!f || f->ops != &amdgpu_userq_fence_ops)
62 		return NULL;
63 
64 	return container_of(f, struct amdgpu_userq_fence, base);
65 }
66 
67 static u64 amdgpu_userq_fence_read(struct amdgpu_userq_fence_driver *fence_drv)
68 {
69 	return le64_to_cpu(*fence_drv->cpu_addr);
70 }
71 
72 static void
73 amdgpu_userq_fence_write(struct amdgpu_userq_fence_driver *fence_drv,
74 			 u64 seq)
75 {
76 	if (fence_drv->cpu_addr)
77 		*fence_drv->cpu_addr = cpu_to_le64(seq);
78 }
79 
80 int amdgpu_userq_fence_driver_alloc(struct amdgpu_device *adev,
81 				    struct amdgpu_usermode_queue *userq)
82 {
83 	struct amdgpu_userq_fence_driver *fence_drv;
84 	unsigned long flags;
85 	int r;
86 
87 	fence_drv = kzalloc_obj(*fence_drv);
88 	if (!fence_drv)
89 		return -ENOMEM;
90 
91 	/* Acquire seq64 memory */
92 	r = amdgpu_seq64_alloc(adev, &fence_drv->va, &fence_drv->gpu_addr,
93 			       &fence_drv->cpu_addr);
94 	if (r)
95 		goto free_fence_drv;
96 
97 	memset(fence_drv->cpu_addr, 0, sizeof(u64));
98 
99 	kref_init(&fence_drv->refcount);
100 	INIT_LIST_HEAD(&fence_drv->fences);
101 	spin_lock_init(&fence_drv->fence_list_lock);
102 
103 	fence_drv->adev = adev;
104 	fence_drv->context = dma_fence_context_alloc(1);
105 	get_task_comm(fence_drv->timeline_name, current);
106 
107 	xa_lock_irqsave(&adev->userq_xa, flags);
108 	r = xa_err(__xa_store(&adev->userq_xa, userq->doorbell_index,
109 			      fence_drv, GFP_KERNEL));
110 	xa_unlock_irqrestore(&adev->userq_xa, flags);
111 	if (r)
112 		goto free_seq64;
113 
114 	userq->fence_drv = fence_drv;
115 
116 	return 0;
117 
118 free_seq64:
119 	amdgpu_seq64_free(adev, fence_drv->va);
120 free_fence_drv:
121 	kfree(fence_drv);
122 
123 	return r;
124 }
125 
126 static void amdgpu_userq_walk_and_drop_fence_drv(struct xarray *xa)
127 {
128 	struct amdgpu_userq_fence_driver *fence_drv;
129 	unsigned long index;
130 
131 	if (xa_empty(xa))
132 		return;
133 
134 	xa_lock(xa);
135 	xa_for_each(xa, index, fence_drv) {
136 		__xa_erase(xa, index);
137 		amdgpu_userq_fence_driver_put(fence_drv);
138 	}
139 
140 	xa_unlock(xa);
141 }
142 
143 void
144 amdgpu_userq_fence_driver_free(struct amdgpu_usermode_queue *userq)
145 {
146 	dma_fence_put(userq->last_fence);
147 
148 	amdgpu_userq_walk_and_drop_fence_drv(&userq->fence_drv_xa);
149 	xa_destroy(&userq->fence_drv_xa);
150 	/* Drop the fence_drv reference held by user queue */
151 	amdgpu_userq_fence_driver_put(userq->fence_drv);
152 }
153 
154 void amdgpu_userq_fence_driver_process(struct amdgpu_userq_fence_driver *fence_drv)
155 {
156 	struct amdgpu_userq_fence *userq_fence, *tmp;
157 	struct dma_fence *fence;
158 	unsigned long flags;
159 	u64 rptr;
160 	int i;
161 
162 	if (!fence_drv)
163 		return;
164 
165 	spin_lock_irqsave(&fence_drv->fence_list_lock, flags);
166 	rptr = amdgpu_userq_fence_read(fence_drv);
167 
168 	list_for_each_entry_safe(userq_fence, tmp, &fence_drv->fences, link) {
169 		fence = &userq_fence->base;
170 
171 		if (rptr < fence->seqno)
172 			break;
173 
174 		dma_fence_signal(fence);
175 
176 		for (i = 0; i < userq_fence->fence_drv_array_count; i++)
177 			amdgpu_userq_fence_driver_put(userq_fence->fence_drv_array[i]);
178 
179 		list_del(&userq_fence->link);
180 		dma_fence_put(fence);
181 	}
182 	spin_unlock_irqrestore(&fence_drv->fence_list_lock, flags);
183 }
184 
185 void amdgpu_userq_fence_driver_destroy(struct kref *ref)
186 {
187 	struct amdgpu_userq_fence_driver *fence_drv = container_of(ref,
188 					 struct amdgpu_userq_fence_driver,
189 					 refcount);
190 	struct amdgpu_userq_fence_driver *xa_fence_drv;
191 	struct amdgpu_device *adev = fence_drv->adev;
192 	struct amdgpu_userq_fence *fence, *tmp;
193 	struct xarray *xa = &adev->userq_xa;
194 	unsigned long index, flags;
195 	struct dma_fence *f;
196 
197 	spin_lock_irqsave(&fence_drv->fence_list_lock, flags);
198 	list_for_each_entry_safe(fence, tmp, &fence_drv->fences, link) {
199 		f = &fence->base;
200 
201 		if (!dma_fence_is_signaled(f)) {
202 			dma_fence_set_error(f, -ECANCELED);
203 			dma_fence_signal(f);
204 		}
205 
206 		list_del(&fence->link);
207 		dma_fence_put(f);
208 	}
209 	spin_unlock_irqrestore(&fence_drv->fence_list_lock, flags);
210 
211 	xa_lock_irqsave(xa, flags);
212 	xa_for_each(xa, index, xa_fence_drv)
213 		if (xa_fence_drv == fence_drv)
214 			__xa_erase(xa, index);
215 	xa_unlock_irqrestore(xa, flags);
216 
217 	/* Free seq64 memory */
218 	amdgpu_seq64_free(adev, fence_drv->va);
219 	kfree(fence_drv);
220 }
221 
222 void amdgpu_userq_fence_driver_get(struct amdgpu_userq_fence_driver *fence_drv)
223 {
224 	kref_get(&fence_drv->refcount);
225 }
226 
227 void amdgpu_userq_fence_driver_put(struct amdgpu_userq_fence_driver *fence_drv)
228 {
229 	kref_put(&fence_drv->refcount, amdgpu_userq_fence_driver_destroy);
230 }
231 
232 static int amdgpu_userq_fence_alloc(struct amdgpu_userq_fence **userq_fence)
233 {
234 	*userq_fence = kmem_cache_alloc(amdgpu_userq_fence_slab, GFP_ATOMIC);
235 	return *userq_fence ? 0 : -ENOMEM;
236 }
237 
238 static int amdgpu_userq_fence_create(struct amdgpu_usermode_queue *userq,
239 				     struct amdgpu_userq_fence *userq_fence,
240 				     u64 seq, struct dma_fence **f)
241 {
242 	struct amdgpu_userq_fence_driver *fence_drv;
243 	struct dma_fence *fence;
244 	unsigned long flags;
245 
246 	fence_drv = userq->fence_drv;
247 	if (!fence_drv)
248 		return -EINVAL;
249 
250 	spin_lock_init(&userq_fence->lock);
251 	INIT_LIST_HEAD(&userq_fence->link);
252 	fence = &userq_fence->base;
253 	userq_fence->fence_drv = fence_drv;
254 
255 	dma_fence_init64(fence, &amdgpu_userq_fence_ops, &userq_fence->lock,
256 			 fence_drv->context, seq);
257 
258 	amdgpu_userq_fence_driver_get(fence_drv);
259 	dma_fence_get(fence);
260 
261 	if (!xa_empty(&userq->fence_drv_xa)) {
262 		struct amdgpu_userq_fence_driver *stored_fence_drv;
263 		unsigned long index, count = 0;
264 		int i = 0;
265 
266 		xa_lock(&userq->fence_drv_xa);
267 		xa_for_each(&userq->fence_drv_xa, index, stored_fence_drv)
268 			count++;
269 
270 		userq_fence->fence_drv_array =
271 			kvmalloc_objs(struct amdgpu_userq_fence_driver *, count,
272 				      GFP_ATOMIC);
273 
274 		if (userq_fence->fence_drv_array) {
275 			xa_for_each(&userq->fence_drv_xa, index, stored_fence_drv) {
276 				userq_fence->fence_drv_array[i] = stored_fence_drv;
277 				__xa_erase(&userq->fence_drv_xa, index);
278 				i++;
279 			}
280 		}
281 
282 		userq_fence->fence_drv_array_count = i;
283 		xa_unlock(&userq->fence_drv_xa);
284 	} else {
285 		userq_fence->fence_drv_array = NULL;
286 		userq_fence->fence_drv_array_count = 0;
287 	}
288 
289 	/* Check if hardware has already processed the job */
290 	spin_lock_irqsave(&fence_drv->fence_list_lock, flags);
291 	if (!dma_fence_is_signaled(fence))
292 		list_add_tail(&userq_fence->link, &fence_drv->fences);
293 	else
294 		dma_fence_put(fence);
295 
296 	spin_unlock_irqrestore(&fence_drv->fence_list_lock, flags);
297 
298 	*f = fence;
299 
300 	return 0;
301 }
302 
303 static const char *amdgpu_userq_fence_get_driver_name(struct dma_fence *f)
304 {
305 	return "amdgpu_userq_fence";
306 }
307 
308 static const char *amdgpu_userq_fence_get_timeline_name(struct dma_fence *f)
309 {
310 	struct amdgpu_userq_fence *fence = to_amdgpu_userq_fence(f);
311 
312 	return fence->fence_drv->timeline_name;
313 }
314 
315 static bool amdgpu_userq_fence_signaled(struct dma_fence *f)
316 {
317 	struct amdgpu_userq_fence *fence = to_amdgpu_userq_fence(f);
318 	struct amdgpu_userq_fence_driver *fence_drv = fence->fence_drv;
319 	u64 rptr, wptr;
320 
321 	rptr = amdgpu_userq_fence_read(fence_drv);
322 	wptr = fence->base.seqno;
323 
324 	if (rptr >= wptr)
325 		return true;
326 
327 	return false;
328 }
329 
330 static void amdgpu_userq_fence_free(struct rcu_head *rcu)
331 {
332 	struct dma_fence *fence = container_of(rcu, struct dma_fence, rcu);
333 	struct amdgpu_userq_fence *userq_fence = to_amdgpu_userq_fence(fence);
334 	struct amdgpu_userq_fence_driver *fence_drv = userq_fence->fence_drv;
335 
336 	/* Release the fence driver reference */
337 	amdgpu_userq_fence_driver_put(fence_drv);
338 
339 	kvfree(userq_fence->fence_drv_array);
340 	kmem_cache_free(amdgpu_userq_fence_slab, userq_fence);
341 }
342 
343 static void amdgpu_userq_fence_release(struct dma_fence *f)
344 {
345 	call_rcu(&f->rcu, amdgpu_userq_fence_free);
346 }
347 
348 static const struct dma_fence_ops amdgpu_userq_fence_ops = {
349 	.get_driver_name = amdgpu_userq_fence_get_driver_name,
350 	.get_timeline_name = amdgpu_userq_fence_get_timeline_name,
351 	.signaled = amdgpu_userq_fence_signaled,
352 	.release = amdgpu_userq_fence_release,
353 };
354 
355 /**
356  * amdgpu_userq_fence_read_wptr - Read the userq wptr value
357  *
358  * @adev: amdgpu_device pointer
359  * @queue: user mode queue structure pointer
360  * @wptr: write pointer value
361  *
362  * Read the wptr value from userq's MQD. The userq signal IOCTL
363  * creates a dma_fence for the shared buffers that expects the
364  * RPTR value written to seq64 memory >= WPTR.
365  *
366  * Returns wptr value on success, error on failure.
367  */
368 static int amdgpu_userq_fence_read_wptr(struct amdgpu_device *adev,
369 					struct amdgpu_usermode_queue *queue,
370 					u64 *wptr)
371 {
372 	struct amdgpu_bo_va_mapping *mapping;
373 	struct amdgpu_bo *bo;
374 	u64 addr, *ptr;
375 	int r;
376 
377 	r = amdgpu_bo_reserve(queue->vm->root.bo, false);
378 	if (r)
379 		return r;
380 
381 	addr = queue->userq_prop->wptr_gpu_addr;
382 	addr &= AMDGPU_GMC_HOLE_MASK;
383 
384 	mapping = amdgpu_vm_bo_lookup_mapping(queue->vm, addr >> PAGE_SHIFT);
385 	if (!mapping) {
386 		amdgpu_bo_unreserve(queue->vm->root.bo);
387 		DRM_ERROR("Failed to lookup amdgpu_bo_va_mapping\n");
388 		return -EINVAL;
389 	}
390 
391 	bo = amdgpu_bo_ref(mapping->bo_va->base.bo);
392 	amdgpu_bo_unreserve(queue->vm->root.bo);
393 	r = amdgpu_bo_reserve(bo, true);
394 	if (r) {
395 		amdgpu_bo_unref(&bo);
396 		DRM_ERROR("Failed to reserve userqueue wptr bo");
397 		return r;
398 	}
399 
400 	r = amdgpu_bo_kmap(bo, (void **)&ptr);
401 	if (r) {
402 		DRM_ERROR("Failed mapping the userqueue wptr bo");
403 		goto map_error;
404 	}
405 
406 	*wptr = le64_to_cpu(*ptr);
407 
408 	amdgpu_bo_kunmap(bo);
409 	amdgpu_bo_unreserve(bo);
410 	amdgpu_bo_unref(&bo);
411 
412 	return 0;
413 
414 map_error:
415 	amdgpu_bo_unreserve(bo);
416 	amdgpu_bo_unref(&bo);
417 
418 	return r;
419 }
420 
421 static void amdgpu_userq_fence_cleanup(struct dma_fence *fence)
422 {
423 	dma_fence_put(fence);
424 }
425 
426 static void
427 amdgpu_userq_fence_driver_set_error(struct amdgpu_userq_fence *fence,
428 				    int error)
429 {
430 	struct amdgpu_userq_fence_driver *fence_drv = fence->fence_drv;
431 	unsigned long flags;
432 	struct dma_fence *f;
433 
434 	spin_lock_irqsave(&fence_drv->fence_list_lock, flags);
435 
436 	f = rcu_dereference_protected(&fence->base,
437 				      lockdep_is_held(&fence_drv->fence_list_lock));
438 	if (f && !dma_fence_is_signaled_locked(f))
439 		dma_fence_set_error(f, error);
440 	spin_unlock_irqrestore(&fence_drv->fence_list_lock, flags);
441 }
442 
443 void
444 amdgpu_userq_fence_driver_force_completion(struct amdgpu_usermode_queue *userq)
445 {
446 	struct dma_fence *f = userq->last_fence;
447 
448 	if (f) {
449 		struct amdgpu_userq_fence *fence = to_amdgpu_userq_fence(f);
450 		struct amdgpu_userq_fence_driver *fence_drv = fence->fence_drv;
451 		u64 wptr = fence->base.seqno;
452 
453 		amdgpu_userq_fence_driver_set_error(fence, -ECANCELED);
454 		amdgpu_userq_fence_write(fence_drv, wptr);
455 		amdgpu_userq_fence_driver_process(fence_drv);
456 
457 	}
458 }
459 
460 int amdgpu_userq_signal_ioctl(struct drm_device *dev, void *data,
461 			      struct drm_file *filp)
462 {
463 	struct amdgpu_device *adev = drm_to_adev(dev);
464 	struct drm_amdgpu_userq_signal *args = data;
465 	const unsigned int num_write_bo_handles = args->num_bo_write_handles;
466 	const unsigned int num_read_bo_handles = args->num_bo_read_handles;
467 	struct amdgpu_fpriv *fpriv = filp->driver_priv;
468 	struct amdgpu_userq_mgr *userq_mgr = &fpriv->userq_mgr;
469 	struct drm_gem_object **gobj_write, **gobj_read;
470 	u32 *syncobj_handles, num_syncobj_handles;
471 	struct amdgpu_userq_fence *userq_fence;
472 	struct amdgpu_usermode_queue *queue;
473 	struct drm_syncobj **syncobj = NULL;
474 	struct dma_fence *fence;
475 	struct drm_exec exec;
476 	int r, i, entry;
477 	u64 wptr;
478 
479 	if (!amdgpu_userq_enabled(dev))
480 		return -ENOTSUPP;
481 
482 	if (args->num_bo_write_handles > AMDGPU_USERQ_MAX_HANDLES ||
483 	    args->num_bo_read_handles > AMDGPU_USERQ_MAX_HANDLES)
484 		return -EINVAL;
485 
486 	num_syncobj_handles = args->num_syncobj_handles;
487 	syncobj_handles = memdup_array_user(u64_to_user_ptr(args->syncobj_handles),
488 					    num_syncobj_handles, sizeof(u32));
489 	if (IS_ERR(syncobj_handles))
490 		return PTR_ERR(syncobj_handles);
491 
492 	/* Array of pointers to the looked up syncobjs */
493 	syncobj = kmalloc_array(num_syncobj_handles, sizeof(*syncobj), GFP_KERNEL);
494 	if (!syncobj) {
495 		r = -ENOMEM;
496 		goto free_syncobj_handles;
497 	}
498 
499 	for (entry = 0; entry < num_syncobj_handles; entry++) {
500 		syncobj[entry] = drm_syncobj_find(filp, syncobj_handles[entry]);
501 		if (!syncobj[entry]) {
502 			r = -ENOENT;
503 			goto free_syncobj;
504 		}
505 	}
506 
507 	r = drm_gem_objects_lookup(filp,
508 				   u64_to_user_ptr(args->bo_read_handles),
509 				   num_read_bo_handles,
510 				   &gobj_read);
511 	if (r)
512 		goto free_syncobj;
513 
514 	r = drm_gem_objects_lookup(filp,
515 				   u64_to_user_ptr(args->bo_write_handles),
516 				   num_write_bo_handles,
517 				   &gobj_write);
518 	if (r)
519 		goto put_gobj_read;
520 
521 	/* Retrieve the user queue */
522 	queue = xa_load(&userq_mgr->userq_xa, args->queue_id);
523 	if (!queue) {
524 		r = -ENOENT;
525 		goto put_gobj_write;
526 	}
527 
528 	r = amdgpu_userq_fence_read_wptr(adev, queue, &wptr);
529 	if (r)
530 		goto put_gobj_write;
531 
532 	r = amdgpu_userq_fence_alloc(&userq_fence);
533 	if (r)
534 		goto put_gobj_write;
535 
536 	/* We are here means UQ is active, make sure the eviction fence is valid */
537 	amdgpu_userq_ensure_ev_fence(&fpriv->userq_mgr, &fpriv->evf_mgr);
538 
539 	/* Create a new fence */
540 	r = amdgpu_userq_fence_create(queue, userq_fence, wptr, &fence);
541 	if (r) {
542 		mutex_unlock(&userq_mgr->userq_mutex);
543 		kmem_cache_free(amdgpu_userq_fence_slab, userq_fence);
544 		goto put_gobj_write;
545 	}
546 
547 	dma_fence_put(queue->last_fence);
548 	queue->last_fence = dma_fence_get(fence);
549 	amdgpu_userq_start_hang_detect_work(queue);
550 	mutex_unlock(&userq_mgr->userq_mutex);
551 
552 	drm_exec_init(&exec, DRM_EXEC_INTERRUPTIBLE_WAIT,
553 		      (num_read_bo_handles + num_write_bo_handles));
554 
555 	/* Lock all BOs with retry handling */
556 	drm_exec_until_all_locked(&exec) {
557 		r = drm_exec_prepare_array(&exec, gobj_read, num_read_bo_handles, 1);
558 		drm_exec_retry_on_contention(&exec);
559 		if (r) {
560 			amdgpu_userq_fence_cleanup(fence);
561 			goto exec_fini;
562 		}
563 
564 		r = drm_exec_prepare_array(&exec, gobj_write, num_write_bo_handles, 1);
565 		drm_exec_retry_on_contention(&exec);
566 		if (r) {
567 			amdgpu_userq_fence_cleanup(fence);
568 			goto exec_fini;
569 		}
570 	}
571 
572 	for (i = 0; i < num_read_bo_handles; i++) {
573 		if (!gobj_read || !gobj_read[i]->resv)
574 			continue;
575 
576 		dma_resv_add_fence(gobj_read[i]->resv, fence,
577 				   DMA_RESV_USAGE_READ);
578 	}
579 
580 	for (i = 0; i < num_write_bo_handles; i++) {
581 		if (!gobj_write || !gobj_write[i]->resv)
582 			continue;
583 
584 		dma_resv_add_fence(gobj_write[i]->resv, fence,
585 				   DMA_RESV_USAGE_WRITE);
586 	}
587 
588 	/* Add the created fence to syncobj/BO's */
589 	for (i = 0; i < num_syncobj_handles; i++)
590 		drm_syncobj_replace_fence(syncobj[i], fence);
591 
592 	/* drop the reference acquired in fence creation function */
593 	dma_fence_put(fence);
594 
595 exec_fini:
596 	drm_exec_fini(&exec);
597 put_gobj_write:
598 	for (i = 0; i < num_write_bo_handles; i++)
599 		drm_gem_object_put(gobj_write[i]);
600 	kfree(gobj_write);
601 put_gobj_read:
602 	for (i = 0; i < num_read_bo_handles; i++)
603 		drm_gem_object_put(gobj_read[i]);
604 	kfree(gobj_read);
605 free_syncobj:
606 	while (entry-- > 0)
607 		if (syncobj[entry])
608 			drm_syncobj_put(syncobj[entry]);
609 	kfree(syncobj);
610 free_syncobj_handles:
611 	kfree(syncobj_handles);
612 
613 	return r;
614 }
615 
616 int amdgpu_userq_wait_ioctl(struct drm_device *dev, void *data,
617 			    struct drm_file *filp)
618 {
619 	struct drm_amdgpu_userq_wait *wait_info = data;
620 	const unsigned int num_write_bo_handles = wait_info->num_bo_write_handles;
621 	const unsigned int num_read_bo_handles = wait_info->num_bo_read_handles;
622 	struct drm_amdgpu_userq_fence_info *fence_info = NULL;
623 	struct amdgpu_fpriv *fpriv = filp->driver_priv;
624 	struct amdgpu_userq_mgr *userq_mgr = &fpriv->userq_mgr;
625 	struct drm_gem_object **gobj_write, **gobj_read;
626 	u32 *timeline_points, *timeline_handles;
627 	struct amdgpu_usermode_queue *waitq;
628 	u32 *syncobj_handles, num_syncobj;
629 	struct dma_fence **fences = NULL;
630 	u16 num_points, num_fences = 0;
631 	struct drm_exec exec;
632 	int r, i, cnt;
633 
634 	if (!amdgpu_userq_enabled(dev))
635 		return -ENOTSUPP;
636 
637 	if (wait_info->num_bo_write_handles > AMDGPU_USERQ_MAX_HANDLES ||
638 	    wait_info->num_bo_read_handles > AMDGPU_USERQ_MAX_HANDLES)
639 		return -EINVAL;
640 
641 	num_syncobj = wait_info->num_syncobj_handles;
642 	syncobj_handles = memdup_array_user(u64_to_user_ptr(wait_info->syncobj_handles),
643 					    num_syncobj, sizeof(u32));
644 	if (IS_ERR(syncobj_handles))
645 		return PTR_ERR(syncobj_handles);
646 
647 
648 	num_points = wait_info->num_syncobj_timeline_handles;
649 	timeline_handles = memdup_array_user(u64_to_user_ptr(wait_info->syncobj_timeline_handles),
650 					     num_points, sizeof(u32));
651 	if (IS_ERR(timeline_handles)) {
652 		r = PTR_ERR(timeline_handles);
653 		goto free_syncobj_handles;
654 	}
655 
656 	timeline_points = memdup_array_user(u64_to_user_ptr(wait_info->syncobj_timeline_points),
657 					    num_points, sizeof(u32));
658 
659 	if (IS_ERR(timeline_points)) {
660 		r = PTR_ERR(timeline_points);
661 		goto free_timeline_handles;
662 	}
663 
664 	r = drm_gem_objects_lookup(filp,
665 				   u64_to_user_ptr(wait_info->bo_read_handles),
666 				   num_read_bo_handles,
667 				   &gobj_read);
668 	if (r)
669 		goto free_timeline_points;
670 
671 	r = drm_gem_objects_lookup(filp,
672 				   u64_to_user_ptr(wait_info->bo_write_handles),
673 				   num_write_bo_handles,
674 				   &gobj_write);
675 	if (r)
676 		goto put_gobj_read;
677 
678 	drm_exec_init(&exec, DRM_EXEC_INTERRUPTIBLE_WAIT,
679 		      (num_read_bo_handles + num_write_bo_handles));
680 
681 	/* Lock all BOs with retry handling */
682 	drm_exec_until_all_locked(&exec) {
683 		r = drm_exec_prepare_array(&exec, gobj_read, num_read_bo_handles, 1);
684 		drm_exec_retry_on_contention(&exec);
685 		if (r) {
686 			drm_exec_fini(&exec);
687 			goto put_gobj_write;
688 		}
689 
690 		r = drm_exec_prepare_array(&exec, gobj_write, num_write_bo_handles, 1);
691 		drm_exec_retry_on_contention(&exec);
692 		if (r) {
693 			drm_exec_fini(&exec);
694 			goto put_gobj_write;
695 		}
696 	}
697 
698 	if (!wait_info->num_fences) {
699 		if (num_points) {
700 			struct dma_fence_unwrap iter;
701 			struct dma_fence *fence;
702 			struct dma_fence *f;
703 
704 			for (i = 0; i < num_points; i++) {
705 				r = drm_syncobj_find_fence(filp, timeline_handles[i],
706 							   timeline_points[i],
707 							   DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT,
708 							   &fence);
709 				if (r)
710 					goto exec_fini;
711 
712 				dma_fence_unwrap_for_each(f, &iter, fence)
713 					num_fences++;
714 
715 				dma_fence_put(fence);
716 			}
717 		}
718 
719 		/* Count syncobj's fence */
720 		for (i = 0; i < num_syncobj; i++) {
721 			struct dma_fence *fence;
722 
723 			r = drm_syncobj_find_fence(filp, syncobj_handles[i],
724 						   0,
725 						   DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT,
726 						   &fence);
727 			if (r)
728 				goto exec_fini;
729 
730 			num_fences++;
731 			dma_fence_put(fence);
732 		}
733 
734 		/* Count GEM objects fence */
735 		for (i = 0; i < num_read_bo_handles; i++) {
736 			struct dma_resv_iter resv_cursor;
737 			struct dma_fence *fence;
738 
739 			dma_resv_for_each_fence(&resv_cursor, gobj_read[i]->resv,
740 						DMA_RESV_USAGE_READ, fence)
741 				num_fences++;
742 		}
743 
744 		for (i = 0; i < num_write_bo_handles; i++) {
745 			struct dma_resv_iter resv_cursor;
746 			struct dma_fence *fence;
747 
748 			dma_resv_for_each_fence(&resv_cursor, gobj_write[i]->resv,
749 						DMA_RESV_USAGE_WRITE, fence)
750 				num_fences++;
751 		}
752 
753 		/*
754 		 * Passing num_fences = 0 means that userspace doesn't want to
755 		 * retrieve userq_fence_info. If num_fences = 0 we skip filling
756 		 * userq_fence_info and return the actual number of fences on
757 		 * args->num_fences.
758 		 */
759 		wait_info->num_fences = num_fences;
760 	} else {
761 		/* Array of fence info */
762 		fence_info = kmalloc_array(wait_info->num_fences, sizeof(*fence_info), GFP_KERNEL);
763 		if (!fence_info) {
764 			r = -ENOMEM;
765 			goto exec_fini;
766 		}
767 
768 		/* Array of fences */
769 		fences = kmalloc_array(wait_info->num_fences, sizeof(*fences), GFP_KERNEL);
770 		if (!fences) {
771 			r = -ENOMEM;
772 			goto free_fence_info;
773 		}
774 
775 		/* Retrieve GEM read objects fence */
776 		for (i = 0; i < num_read_bo_handles; i++) {
777 			struct dma_resv_iter resv_cursor;
778 			struct dma_fence *fence;
779 
780 			dma_resv_for_each_fence(&resv_cursor, gobj_read[i]->resv,
781 						DMA_RESV_USAGE_READ, fence) {
782 				if (num_fences >= wait_info->num_fences) {
783 					r = -EINVAL;
784 					goto free_fences;
785 				}
786 
787 				fences[num_fences++] = fence;
788 				dma_fence_get(fence);
789 			}
790 		}
791 
792 		/* Retrieve GEM write objects fence */
793 		for (i = 0; i < num_write_bo_handles; i++) {
794 			struct dma_resv_iter resv_cursor;
795 			struct dma_fence *fence;
796 
797 			dma_resv_for_each_fence(&resv_cursor, gobj_write[i]->resv,
798 						DMA_RESV_USAGE_WRITE, fence) {
799 				if (num_fences >= wait_info->num_fences) {
800 					r = -EINVAL;
801 					goto free_fences;
802 				}
803 
804 				fences[num_fences++] = fence;
805 				dma_fence_get(fence);
806 			}
807 		}
808 
809 		if (num_points) {
810 			struct dma_fence_unwrap iter;
811 			struct dma_fence *fence;
812 			struct dma_fence *f;
813 
814 			for (i = 0; i < num_points; i++) {
815 				r = drm_syncobj_find_fence(filp, timeline_handles[i],
816 							   timeline_points[i],
817 							   DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT,
818 							   &fence);
819 				if (r)
820 					goto free_fences;
821 
822 				dma_fence_unwrap_for_each(f, &iter, fence) {
823 					if (num_fences >= wait_info->num_fences) {
824 						r = -EINVAL;
825 						dma_fence_put(fence);
826 						goto free_fences;
827 					}
828 
829 					dma_fence_get(f);
830 					fences[num_fences++] = f;
831 				}
832 
833 				dma_fence_put(fence);
834 			}
835 		}
836 
837 		/* Retrieve syncobj's fence */
838 		for (i = 0; i < num_syncobj; i++) {
839 			struct dma_fence *fence;
840 
841 			r = drm_syncobj_find_fence(filp, syncobj_handles[i],
842 						   0,
843 						   DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT,
844 						   &fence);
845 			if (r)
846 				goto free_fences;
847 
848 			if (num_fences >= wait_info->num_fences) {
849 				r = -EINVAL;
850 				dma_fence_put(fence);
851 				goto free_fences;
852 			}
853 
854 			fences[num_fences++] = fence;
855 		}
856 
857 		/*
858 		 * Keep only the latest fences to reduce the number of values
859 		 * given back to userspace.
860 		 */
861 		num_fences = dma_fence_dedup_array(fences, num_fences);
862 
863 		waitq = xa_load(&userq_mgr->userq_xa, wait_info->waitq_id);
864 		if (!waitq) {
865 			r = -EINVAL;
866 			goto free_fences;
867 		}
868 
869 		for (i = 0, cnt = 0; i < num_fences; i++) {
870 			struct amdgpu_userq_fence_driver *fence_drv;
871 			struct amdgpu_userq_fence *userq_fence;
872 			u32 index;
873 
874 			userq_fence = to_amdgpu_userq_fence(fences[i]);
875 			if (!userq_fence) {
876 				/*
877 				 * Just waiting on other driver fences should
878 				 * be good for now
879 				 */
880 				r = dma_fence_wait(fences[i], true);
881 				if (r) {
882 					dma_fence_put(fences[i]);
883 					goto free_fences;
884 				}
885 
886 				dma_fence_put(fences[i]);
887 				continue;
888 			}
889 
890 			fence_drv = userq_fence->fence_drv;
891 			/*
892 			 * We need to make sure the user queue release their reference
893 			 * to the fence drivers at some point before queue destruction.
894 			 * Otherwise, we would gather those references until we don't
895 			 * have any more space left and crash.
896 			 */
897 			r = xa_alloc(&waitq->fence_drv_xa, &index, fence_drv,
898 				     xa_limit_32b, GFP_KERNEL);
899 			if (r)
900 				goto free_fences;
901 
902 			amdgpu_userq_fence_driver_get(fence_drv);
903 
904 			/* Store drm syncobj's gpu va address and value */
905 			fence_info[cnt].va = fence_drv->va;
906 			fence_info[cnt].value = fences[i]->seqno;
907 
908 			dma_fence_put(fences[i]);
909 			/* Increment the actual userq fence count */
910 			cnt++;
911 		}
912 
913 		wait_info->num_fences = cnt;
914 		/* Copy userq fence info to user space */
915 		if (copy_to_user(u64_to_user_ptr(wait_info->out_fences),
916 				 fence_info, wait_info->num_fences * sizeof(*fence_info))) {
917 			r = -EFAULT;
918 			goto free_fences;
919 		}
920 	}
921 
922 free_fences:
923 	if (fences) {
924 		while (num_fences-- > 0)
925 			dma_fence_put(fences[num_fences]);
926 		kfree(fences);
927 	}
928 free_fence_info:
929 	kfree(fence_info);
930 exec_fini:
931 	drm_exec_fini(&exec);
932 put_gobj_write:
933 	for (i = 0; i < num_write_bo_handles; i++)
934 		drm_gem_object_put(gobj_write[i]);
935 	kfree(gobj_write);
936 put_gobj_read:
937 	for (i = 0; i < num_read_bo_handles; i++)
938 		drm_gem_object_put(gobj_read[i]);
939 	kfree(gobj_read);
940 free_timeline_points:
941 	kfree(timeline_points);
942 free_timeline_handles:
943 	kfree(timeline_handles);
944 free_syncobj_handles:
945 	kfree(syncobj_handles);
946 
947 	return r;
948 }
949