1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2015 Etnaviv Project
4  */
5 
6 #include <drm/drm_file.h>
7 #include <linux/dma-fence-array.h>
8 #include <linux/file.h>
9 #include <linux/pm_runtime.h>
10 #include <linux/dma-resv.h>
11 #include <linux/sync_file.h>
12 #include <linux/uaccess.h>
13 #include <linux/vmalloc.h>
14 
15 #include "etnaviv_cmdbuf.h"
16 #include "etnaviv_drv.h"
17 #include "etnaviv_gpu.h"
18 #include "etnaviv_gem.h"
19 #include "etnaviv_perfmon.h"
20 #include "etnaviv_sched.h"
21 
22 /*
23  * Cmdstream submission:
24  */
25 
26 #define BO_INVALID_FLAGS ~(ETNA_SUBMIT_BO_READ | ETNA_SUBMIT_BO_WRITE)
27 /* make sure these don't conflict w/ ETNAVIV_SUBMIT_BO_x */
28 #define BO_LOCKED   0x4000
29 #define BO_PINNED   0x2000
30 
31 static struct etnaviv_gem_submit *submit_create(struct drm_device *dev,
32 		struct etnaviv_gpu *gpu, size_t nr_bos, size_t nr_pmrs)
33 {
34 	struct etnaviv_gem_submit *submit;
35 	size_t sz = size_vstruct(nr_bos, sizeof(submit->bos[0]), sizeof(*submit));
36 
37 	submit = kzalloc(sz, GFP_KERNEL);
38 	if (!submit)
39 		return NULL;
40 
41 	submit->pmrs = kcalloc(nr_pmrs, sizeof(struct etnaviv_perfmon_request),
42 			       GFP_KERNEL);
43 	if (!submit->pmrs) {
44 		kfree(submit);
45 		return NULL;
46 	}
47 	submit->nr_pmrs = nr_pmrs;
48 
49 	submit->gpu = gpu;
50 	kref_init(&submit->refcount);
51 
52 	return submit;
53 }
54 
55 static int submit_lookup_objects(struct etnaviv_gem_submit *submit,
56 	struct drm_file *file, struct drm_etnaviv_gem_submit_bo *submit_bos,
57 	unsigned nr_bos)
58 {
59 	struct drm_etnaviv_gem_submit_bo *bo;
60 	unsigned i;
61 	int ret = 0;
62 
63 	spin_lock(&file->table_lock);
64 
65 	for (i = 0, bo = submit_bos; i < nr_bos; i++, bo++) {
66 		struct drm_gem_object *obj;
67 
68 		if (bo->flags & BO_INVALID_FLAGS) {
69 			DRM_ERROR("invalid flags: %x\n", bo->flags);
70 			ret = -EINVAL;
71 			goto out_unlock;
72 		}
73 
74 		submit->bos[i].flags = bo->flags;
75 		if (submit->flags & ETNA_SUBMIT_SOFTPIN) {
76 			if (bo->presumed < ETNAVIV_SOFTPIN_START_ADDRESS) {
77 				DRM_ERROR("invalid softpin address\n");
78 				ret = -EINVAL;
79 				goto out_unlock;
80 			}
81 			submit->bos[i].va = bo->presumed;
82 		}
83 
84 		/* normally use drm_gem_object_lookup(), but for bulk lookup
85 		 * all under single table_lock just hit object_idr directly:
86 		 */
87 		obj = idr_find(&file->object_idr, bo->handle);
88 		if (!obj) {
89 			DRM_ERROR("invalid handle %u at index %u\n",
90 				  bo->handle, i);
91 			ret = -EINVAL;
92 			goto out_unlock;
93 		}
94 
95 		/*
96 		 * Take a refcount on the object. The file table lock
97 		 * prevents the object_idr's refcount on this being dropped.
98 		 */
99 		drm_gem_object_get(obj);
100 
101 		submit->bos[i].obj = to_etnaviv_bo(obj);
102 	}
103 
104 out_unlock:
105 	submit->nr_bos = i;
106 	spin_unlock(&file->table_lock);
107 
108 	return ret;
109 }
110 
111 static void submit_unlock_object(struct etnaviv_gem_submit *submit, int i)
112 {
113 	if (submit->bos[i].flags & BO_LOCKED) {
114 		struct drm_gem_object *obj = &submit->bos[i].obj->base;
115 
116 		dma_resv_unlock(obj->resv);
117 		submit->bos[i].flags &= ~BO_LOCKED;
118 	}
119 }
120 
121 static int submit_lock_objects(struct etnaviv_gem_submit *submit,
122 		struct ww_acquire_ctx *ticket)
123 {
124 	int contended, slow_locked = -1, i, ret = 0;
125 
126 retry:
127 	for (i = 0; i < submit->nr_bos; i++) {
128 		struct drm_gem_object *obj = &submit->bos[i].obj->base;
129 
130 		if (slow_locked == i)
131 			slow_locked = -1;
132 
133 		contended = i;
134 
135 		if (!(submit->bos[i].flags & BO_LOCKED)) {
136 			ret = dma_resv_lock_interruptible(obj->resv, ticket);
137 			if (ret == -EALREADY)
138 				DRM_ERROR("BO at index %u already on submit list\n",
139 					  i);
140 			if (ret)
141 				goto fail;
142 			submit->bos[i].flags |= BO_LOCKED;
143 		}
144 	}
145 
146 	ww_acquire_done(ticket);
147 
148 	return 0;
149 
150 fail:
151 	for (; i >= 0; i--)
152 		submit_unlock_object(submit, i);
153 
154 	if (slow_locked > 0)
155 		submit_unlock_object(submit, slow_locked);
156 
157 	if (ret == -EDEADLK) {
158 		struct drm_gem_object *obj;
159 
160 		obj = &submit->bos[contended].obj->base;
161 
162 		/* we lost out in a seqno race, lock and retry.. */
163 		ret = dma_resv_lock_slow_interruptible(obj->resv, ticket);
164 		if (!ret) {
165 			submit->bos[contended].flags |= BO_LOCKED;
166 			slow_locked = contended;
167 			goto retry;
168 		}
169 	}
170 
171 	return ret;
172 }
173 
174 static int submit_fence_sync(struct etnaviv_gem_submit *submit)
175 {
176 	int i, ret = 0;
177 
178 	for (i = 0; i < submit->nr_bos; i++) {
179 		struct etnaviv_gem_submit_bo *bo = &submit->bos[i];
180 		struct dma_resv *robj = bo->obj->base.resv;
181 
182 		if (!(bo->flags & ETNA_SUBMIT_BO_WRITE)) {
183 			ret = dma_resv_reserve_shared(robj, 1);
184 			if (ret)
185 				return ret;
186 		}
187 
188 		if (submit->flags & ETNA_SUBMIT_NO_IMPLICIT)
189 			continue;
190 
191 		ret = dma_resv_get_fences(robj,
192 					  bo->flags & ETNA_SUBMIT_BO_WRITE,
193 					  &bo->nr_fences, &bo->fences);
194 		if (ret)
195 			return ret;
196 	}
197 
198 	return ret;
199 }
200 
201 static void submit_attach_object_fences(struct etnaviv_gem_submit *submit)
202 {
203 	int i;
204 
205 	for (i = 0; i < submit->nr_bos; i++) {
206 		struct drm_gem_object *obj = &submit->bos[i].obj->base;
207 
208 		if (submit->bos[i].flags & ETNA_SUBMIT_BO_WRITE)
209 			dma_resv_add_excl_fence(obj->resv,
210 							  submit->out_fence);
211 		else
212 			dma_resv_add_shared_fence(obj->resv,
213 							    submit->out_fence);
214 
215 		submit_unlock_object(submit, i);
216 	}
217 }
218 
219 static int submit_pin_objects(struct etnaviv_gem_submit *submit)
220 {
221 	int i, ret = 0;
222 
223 	for (i = 0; i < submit->nr_bos; i++) {
224 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
225 		struct etnaviv_vram_mapping *mapping;
226 
227 		mapping = etnaviv_gem_mapping_get(&etnaviv_obj->base,
228 						  submit->mmu_context,
229 						  submit->bos[i].va);
230 		if (IS_ERR(mapping)) {
231 			ret = PTR_ERR(mapping);
232 			break;
233 		}
234 
235 		if ((submit->flags & ETNA_SUBMIT_SOFTPIN) &&
236 		     submit->bos[i].va != mapping->iova) {
237 			etnaviv_gem_mapping_unreference(mapping);
238 			return -EINVAL;
239 		}
240 
241 		atomic_inc(&etnaviv_obj->gpu_active);
242 
243 		submit->bos[i].flags |= BO_PINNED;
244 		submit->bos[i].mapping = mapping;
245 	}
246 
247 	return ret;
248 }
249 
250 static int submit_bo(struct etnaviv_gem_submit *submit, u32 idx,
251 	struct etnaviv_gem_submit_bo **bo)
252 {
253 	if (idx >= submit->nr_bos) {
254 		DRM_ERROR("invalid buffer index: %u (out of %u)\n",
255 				idx, submit->nr_bos);
256 		return -EINVAL;
257 	}
258 
259 	*bo = &submit->bos[idx];
260 
261 	return 0;
262 }
263 
264 /* process the reloc's and patch up the cmdstream as needed: */
265 static int submit_reloc(struct etnaviv_gem_submit *submit, void *stream,
266 		u32 size, const struct drm_etnaviv_gem_submit_reloc *relocs,
267 		u32 nr_relocs)
268 {
269 	u32 i, last_offset = 0;
270 	u32 *ptr = stream;
271 	int ret;
272 
273 	/* Submits using softpin don't blend with relocs */
274 	if ((submit->flags & ETNA_SUBMIT_SOFTPIN) && nr_relocs != 0)
275 		return -EINVAL;
276 
277 	for (i = 0; i < nr_relocs; i++) {
278 		const struct drm_etnaviv_gem_submit_reloc *r = relocs + i;
279 		struct etnaviv_gem_submit_bo *bo;
280 		u32 off;
281 
282 		if (unlikely(r->flags)) {
283 			DRM_ERROR("invalid reloc flags\n");
284 			return -EINVAL;
285 		}
286 
287 		if (r->submit_offset % 4) {
288 			DRM_ERROR("non-aligned reloc offset: %u\n",
289 				  r->submit_offset);
290 			return -EINVAL;
291 		}
292 
293 		/* offset in dwords: */
294 		off = r->submit_offset / 4;
295 
296 		if ((off >= size ) ||
297 				(off < last_offset)) {
298 			DRM_ERROR("invalid offset %u at reloc %u\n", off, i);
299 			return -EINVAL;
300 		}
301 
302 		ret = submit_bo(submit, r->reloc_idx, &bo);
303 		if (ret)
304 			return ret;
305 
306 		if (r->reloc_offset > bo->obj->base.size - sizeof(*ptr)) {
307 			DRM_ERROR("relocation %u outside object\n", i);
308 			return -EINVAL;
309 		}
310 
311 		ptr[off] = bo->mapping->iova + r->reloc_offset;
312 
313 		last_offset = off;
314 	}
315 
316 	return 0;
317 }
318 
319 static int submit_perfmon_validate(struct etnaviv_gem_submit *submit,
320 		u32 exec_state, const struct drm_etnaviv_gem_submit_pmr *pmrs)
321 {
322 	u32 i;
323 
324 	for (i = 0; i < submit->nr_pmrs; i++) {
325 		const struct drm_etnaviv_gem_submit_pmr *r = pmrs + i;
326 		struct etnaviv_gem_submit_bo *bo;
327 		int ret;
328 
329 		ret = submit_bo(submit, r->read_idx, &bo);
330 		if (ret)
331 			return ret;
332 
333 		/* at offset 0 a sequence number gets stored used for userspace sync */
334 		if (r->read_offset == 0) {
335 			DRM_ERROR("perfmon request: offset is 0");
336 			return -EINVAL;
337 		}
338 
339 		if (r->read_offset >= bo->obj->base.size - sizeof(u32)) {
340 			DRM_ERROR("perfmon request: offset %u outside object", i);
341 			return -EINVAL;
342 		}
343 
344 		if (r->flags & ~(ETNA_PM_PROCESS_PRE | ETNA_PM_PROCESS_POST)) {
345 			DRM_ERROR("perfmon request: flags are not valid");
346 			return -EINVAL;
347 		}
348 
349 		if (etnaviv_pm_req_validate(r, exec_state)) {
350 			DRM_ERROR("perfmon request: domain or signal not valid");
351 			return -EINVAL;
352 		}
353 
354 		submit->pmrs[i].flags = r->flags;
355 		submit->pmrs[i].domain = r->domain;
356 		submit->pmrs[i].signal = r->signal;
357 		submit->pmrs[i].sequence = r->sequence;
358 		submit->pmrs[i].offset = r->read_offset;
359 		submit->pmrs[i].bo_vma = etnaviv_gem_vmap(&bo->obj->base);
360 	}
361 
362 	return 0;
363 }
364 
365 static void submit_cleanup(struct kref *kref)
366 {
367 	struct etnaviv_gem_submit *submit =
368 			container_of(kref, struct etnaviv_gem_submit, refcount);
369 	unsigned i;
370 
371 	if (submit->runtime_resumed)
372 		pm_runtime_put_autosuspend(submit->gpu->dev);
373 
374 	if (submit->cmdbuf.suballoc)
375 		etnaviv_cmdbuf_free(&submit->cmdbuf);
376 
377 	if (submit->mmu_context)
378 		etnaviv_iommu_context_put(submit->mmu_context);
379 
380 	if (submit->prev_mmu_context)
381 		etnaviv_iommu_context_put(submit->prev_mmu_context);
382 
383 	for (i = 0; i < submit->nr_bos; i++) {
384 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
385 
386 		/* unpin all objects */
387 		if (submit->bos[i].flags & BO_PINNED) {
388 			etnaviv_gem_mapping_unreference(submit->bos[i].mapping);
389 			atomic_dec(&etnaviv_obj->gpu_active);
390 			submit->bos[i].mapping = NULL;
391 			submit->bos[i].flags &= ~BO_PINNED;
392 		}
393 
394 		/* if the GPU submit failed, objects might still be locked */
395 		submit_unlock_object(submit, i);
396 		drm_gem_object_put(&etnaviv_obj->base);
397 	}
398 
399 	wake_up_all(&submit->gpu->fence_event);
400 
401 	if (submit->in_fence)
402 		dma_fence_put(submit->in_fence);
403 	if (submit->out_fence) {
404 		/* first remove from IDR, so fence can not be found anymore */
405 		mutex_lock(&submit->gpu->fence_lock);
406 		idr_remove(&submit->gpu->fence_idr, submit->out_fence_id);
407 		mutex_unlock(&submit->gpu->fence_lock);
408 		dma_fence_put(submit->out_fence);
409 	}
410 	kfree(submit->pmrs);
411 	kfree(submit);
412 }
413 
414 void etnaviv_submit_put(struct etnaviv_gem_submit *submit)
415 {
416 	kref_put(&submit->refcount, submit_cleanup);
417 }
418 
419 int etnaviv_ioctl_gem_submit(struct drm_device *dev, void *data,
420 		struct drm_file *file)
421 {
422 	struct etnaviv_file_private *ctx = file->driver_priv;
423 	struct etnaviv_drm_private *priv = dev->dev_private;
424 	struct drm_etnaviv_gem_submit *args = data;
425 	struct drm_etnaviv_gem_submit_reloc *relocs;
426 	struct drm_etnaviv_gem_submit_pmr *pmrs;
427 	struct drm_etnaviv_gem_submit_bo *bos;
428 	struct etnaviv_gem_submit *submit;
429 	struct etnaviv_gpu *gpu;
430 	struct sync_file *sync_file = NULL;
431 	struct ww_acquire_ctx ticket;
432 	int out_fence_fd = -1;
433 	void *stream;
434 	int ret;
435 
436 	if (args->pipe >= ETNA_MAX_PIPES)
437 		return -EINVAL;
438 
439 	gpu = priv->gpu[args->pipe];
440 	if (!gpu)
441 		return -ENXIO;
442 
443 	if (args->stream_size % 4) {
444 		DRM_ERROR("non-aligned cmdstream buffer size: %u\n",
445 			  args->stream_size);
446 		return -EINVAL;
447 	}
448 
449 	if (args->exec_state != ETNA_PIPE_3D &&
450 	    args->exec_state != ETNA_PIPE_2D &&
451 	    args->exec_state != ETNA_PIPE_VG) {
452 		DRM_ERROR("invalid exec_state: 0x%x\n", args->exec_state);
453 		return -EINVAL;
454 	}
455 
456 	if (args->flags & ~ETNA_SUBMIT_FLAGS) {
457 		DRM_ERROR("invalid flags: 0x%x\n", args->flags);
458 		return -EINVAL;
459 	}
460 
461 	if ((args->flags & ETNA_SUBMIT_SOFTPIN) &&
462 	    priv->mmu_global->version != ETNAVIV_IOMMU_V2) {
463 		DRM_ERROR("softpin requested on incompatible MMU\n");
464 		return -EINVAL;
465 	}
466 
467 	if (args->stream_size > SZ_128K || args->nr_relocs > SZ_128K ||
468 	    args->nr_bos > SZ_128K || args->nr_pmrs > 128) {
469 		DRM_ERROR("submit arguments out of size limits\n");
470 		return -EINVAL;
471 	}
472 
473 	/*
474 	 * Copy the command submission and bo array to kernel space in
475 	 * one go, and do this outside of any locks.
476 	 */
477 	bos = kvmalloc_array(args->nr_bos, sizeof(*bos), GFP_KERNEL);
478 	relocs = kvmalloc_array(args->nr_relocs, sizeof(*relocs), GFP_KERNEL);
479 	pmrs = kvmalloc_array(args->nr_pmrs, sizeof(*pmrs), GFP_KERNEL);
480 	stream = kvmalloc_array(1, args->stream_size, GFP_KERNEL);
481 	if (!bos || !relocs || !pmrs || !stream) {
482 		ret = -ENOMEM;
483 		goto err_submit_cmds;
484 	}
485 
486 	ret = copy_from_user(bos, u64_to_user_ptr(args->bos),
487 			     args->nr_bos * sizeof(*bos));
488 	if (ret) {
489 		ret = -EFAULT;
490 		goto err_submit_cmds;
491 	}
492 
493 	ret = copy_from_user(relocs, u64_to_user_ptr(args->relocs),
494 			     args->nr_relocs * sizeof(*relocs));
495 	if (ret) {
496 		ret = -EFAULT;
497 		goto err_submit_cmds;
498 	}
499 
500 	ret = copy_from_user(pmrs, u64_to_user_ptr(args->pmrs),
501 			     args->nr_pmrs * sizeof(*pmrs));
502 	if (ret) {
503 		ret = -EFAULT;
504 		goto err_submit_cmds;
505 	}
506 
507 	ret = copy_from_user(stream, u64_to_user_ptr(args->stream),
508 			     args->stream_size);
509 	if (ret) {
510 		ret = -EFAULT;
511 		goto err_submit_cmds;
512 	}
513 
514 	if (args->flags & ETNA_SUBMIT_FENCE_FD_OUT) {
515 		out_fence_fd = get_unused_fd_flags(O_CLOEXEC);
516 		if (out_fence_fd < 0) {
517 			ret = out_fence_fd;
518 			goto err_submit_cmds;
519 		}
520 	}
521 
522 	ww_acquire_init(&ticket, &reservation_ww_class);
523 
524 	submit = submit_create(dev, gpu, args->nr_bos, args->nr_pmrs);
525 	if (!submit) {
526 		ret = -ENOMEM;
527 		goto err_submit_ww_acquire;
528 	}
529 
530 	ret = etnaviv_cmdbuf_init(priv->cmdbuf_suballoc, &submit->cmdbuf,
531 				  ALIGN(args->stream_size, 8) + 8);
532 	if (ret)
533 		goto err_submit_objects;
534 
535 	submit->ctx = file->driver_priv;
536 	submit->mmu_context = etnaviv_iommu_context_get(submit->ctx->mmu);
537 	submit->exec_state = args->exec_state;
538 	submit->flags = args->flags;
539 
540 	ret = submit_lookup_objects(submit, file, bos, args->nr_bos);
541 	if (ret)
542 		goto err_submit_objects;
543 
544 	if ((priv->mmu_global->version != ETNAVIV_IOMMU_V2) &&
545 	    !etnaviv_cmd_validate_one(gpu, stream, args->stream_size / 4,
546 				      relocs, args->nr_relocs)) {
547 		ret = -EINVAL;
548 		goto err_submit_objects;
549 	}
550 
551 	if (args->flags & ETNA_SUBMIT_FENCE_FD_IN) {
552 		submit->in_fence = sync_file_get_fence(args->fence_fd);
553 		if (!submit->in_fence) {
554 			ret = -EINVAL;
555 			goto err_submit_objects;
556 		}
557 	}
558 
559 	ret = submit_pin_objects(submit);
560 	if (ret)
561 		goto err_submit_objects;
562 
563 	ret = submit_reloc(submit, stream, args->stream_size / 4,
564 			   relocs, args->nr_relocs);
565 	if (ret)
566 		goto err_submit_objects;
567 
568 	ret = submit_perfmon_validate(submit, args->exec_state, pmrs);
569 	if (ret)
570 		goto err_submit_objects;
571 
572 	memcpy(submit->cmdbuf.vaddr, stream, args->stream_size);
573 
574 	ret = submit_lock_objects(submit, &ticket);
575 	if (ret)
576 		goto err_submit_objects;
577 
578 	ret = submit_fence_sync(submit);
579 	if (ret)
580 		goto err_submit_objects;
581 
582 	ret = etnaviv_sched_push_job(&ctx->sched_entity[args->pipe], submit);
583 	if (ret)
584 		goto err_submit_objects;
585 
586 	submit_attach_object_fences(submit);
587 
588 	if (args->flags & ETNA_SUBMIT_FENCE_FD_OUT) {
589 		/*
590 		 * This can be improved: ideally we want to allocate the sync
591 		 * file before kicking off the GPU job and just attach the
592 		 * fence to the sync file here, eliminating the ENOMEM
593 		 * possibility at this stage.
594 		 */
595 		sync_file = sync_file_create(submit->out_fence);
596 		if (!sync_file) {
597 			ret = -ENOMEM;
598 			goto err_submit_objects;
599 		}
600 		fd_install(out_fence_fd, sync_file->file);
601 	}
602 
603 	args->fence_fd = out_fence_fd;
604 	args->fence = submit->out_fence_id;
605 
606 err_submit_objects:
607 	etnaviv_submit_put(submit);
608 
609 err_submit_ww_acquire:
610 	ww_acquire_fini(&ticket);
611 
612 err_submit_cmds:
613 	if (ret && (out_fence_fd >= 0))
614 		put_unused_fd(out_fence_fd);
615 	kvfree(stream);
616 	kvfree(bos);
617 	kvfree(relocs);
618 	kvfree(pmrs);
619 
620 	return ret;
621 }
622