1 /*
2  * Copyright (C) 2015 Etnaviv Project
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 2 as published by
6  * the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
11  * more details.
12  *
13  * You should have received a copy of the GNU General Public License along with
14  * this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #include <linux/reservation.h>
18 #include "etnaviv_drv.h"
19 #include "etnaviv_gpu.h"
20 #include "etnaviv_gem.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 inline void __user *to_user_ptr(u64 address)
32 {
33 	return (void __user *)(uintptr_t)address;
34 }
35 
36 static struct etnaviv_gem_submit *submit_create(struct drm_device *dev,
37 		struct etnaviv_gpu *gpu, size_t nr)
38 {
39 	struct etnaviv_gem_submit *submit;
40 	size_t sz = size_vstruct(nr, sizeof(submit->bos[0]), sizeof(*submit));
41 
42 	submit = kmalloc(sz, GFP_TEMPORARY | __GFP_NOWARN | __GFP_NORETRY);
43 	if (submit) {
44 		submit->dev = dev;
45 		submit->gpu = gpu;
46 
47 		/* initially, until copy_from_user() and bo lookup succeeds: */
48 		submit->nr_bos = 0;
49 
50 		ww_acquire_init(&submit->ticket, &reservation_ww_class);
51 	}
52 
53 	return submit;
54 }
55 
56 static int submit_lookup_objects(struct etnaviv_gem_submit *submit,
57 	struct drm_file *file, struct drm_etnaviv_gem_submit_bo *submit_bos,
58 	unsigned nr_bos)
59 {
60 	struct drm_etnaviv_gem_submit_bo *bo;
61 	unsigned i;
62 	int ret = 0;
63 
64 	spin_lock(&file->table_lock);
65 
66 	for (i = 0, bo = submit_bos; i < nr_bos; i++, bo++) {
67 		struct drm_gem_object *obj;
68 
69 		if (bo->flags & BO_INVALID_FLAGS) {
70 			DRM_ERROR("invalid flags: %x\n", bo->flags);
71 			ret = -EINVAL;
72 			goto out_unlock;
73 		}
74 
75 		submit->bos[i].flags = bo->flags;
76 
77 		/* normally use drm_gem_object_lookup(), but for bulk lookup
78 		 * all under single table_lock just hit object_idr directly:
79 		 */
80 		obj = idr_find(&file->object_idr, bo->handle);
81 		if (!obj) {
82 			DRM_ERROR("invalid handle %u at index %u\n",
83 				  bo->handle, i);
84 			ret = -EINVAL;
85 			goto out_unlock;
86 		}
87 
88 		/*
89 		 * Take a refcount on the object. The file table lock
90 		 * prevents the object_idr's refcount on this being dropped.
91 		 */
92 		drm_gem_object_reference(obj);
93 
94 		submit->bos[i].obj = to_etnaviv_bo(obj);
95 	}
96 
97 out_unlock:
98 	submit->nr_bos = i;
99 	spin_unlock(&file->table_lock);
100 
101 	return ret;
102 }
103 
104 static void submit_unlock_object(struct etnaviv_gem_submit *submit, int i)
105 {
106 	if (submit->bos[i].flags & BO_LOCKED) {
107 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
108 
109 		ww_mutex_unlock(&etnaviv_obj->resv->lock);
110 		submit->bos[i].flags &= ~BO_LOCKED;
111 	}
112 }
113 
114 static int submit_lock_objects(struct etnaviv_gem_submit *submit)
115 {
116 	int contended, slow_locked = -1, i, ret = 0;
117 
118 retry:
119 	for (i = 0; i < submit->nr_bos; i++) {
120 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
121 
122 		if (slow_locked == i)
123 			slow_locked = -1;
124 
125 		contended = i;
126 
127 		if (!(submit->bos[i].flags & BO_LOCKED)) {
128 			ret = ww_mutex_lock_interruptible(&etnaviv_obj->resv->lock,
129 					&submit->ticket);
130 			if (ret == -EALREADY)
131 				DRM_ERROR("BO at index %u already on submit list\n",
132 					  i);
133 			if (ret)
134 				goto fail;
135 			submit->bos[i].flags |= BO_LOCKED;
136 		}
137 	}
138 
139 	ww_acquire_done(&submit->ticket);
140 
141 	return 0;
142 
143 fail:
144 	for (; i >= 0; i--)
145 		submit_unlock_object(submit, i);
146 
147 	if (slow_locked > 0)
148 		submit_unlock_object(submit, slow_locked);
149 
150 	if (ret == -EDEADLK) {
151 		struct etnaviv_gem_object *etnaviv_obj;
152 
153 		etnaviv_obj = submit->bos[contended].obj;
154 
155 		/* we lost out in a seqno race, lock and retry.. */
156 		ret = ww_mutex_lock_slow_interruptible(&etnaviv_obj->resv->lock,
157 				&submit->ticket);
158 		if (!ret) {
159 			submit->bos[contended].flags |= BO_LOCKED;
160 			slow_locked = contended;
161 			goto retry;
162 		}
163 	}
164 
165 	return ret;
166 }
167 
168 static int submit_fence_sync(const struct etnaviv_gem_submit *submit)
169 {
170 	unsigned int context = submit->gpu->fence_context;
171 	int i, ret = 0;
172 
173 	for (i = 0; i < submit->nr_bos; i++) {
174 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
175 		bool write = submit->bos[i].flags & ETNA_SUBMIT_BO_WRITE;
176 
177 		ret = etnaviv_gpu_fence_sync_obj(etnaviv_obj, context, write);
178 		if (ret)
179 			break;
180 	}
181 
182 	return ret;
183 }
184 
185 static void submit_unpin_objects(struct etnaviv_gem_submit *submit)
186 {
187 	int i;
188 
189 	for (i = 0; i < submit->nr_bos; i++) {
190 		if (submit->bos[i].flags & BO_PINNED)
191 			etnaviv_gem_mapping_unreference(submit->bos[i].mapping);
192 
193 		submit->bos[i].mapping = NULL;
194 		submit->bos[i].flags &= ~BO_PINNED;
195 	}
196 }
197 
198 static int submit_pin_objects(struct etnaviv_gem_submit *submit)
199 {
200 	int i, ret = 0;
201 
202 	for (i = 0; i < submit->nr_bos; i++) {
203 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
204 		struct etnaviv_vram_mapping *mapping;
205 
206 		mapping = etnaviv_gem_mapping_get(&etnaviv_obj->base,
207 						  submit->gpu);
208 		if (IS_ERR(mapping)) {
209 			ret = PTR_ERR(mapping);
210 			break;
211 		}
212 
213 		submit->bos[i].flags |= BO_PINNED;
214 		submit->bos[i].mapping = mapping;
215 	}
216 
217 	return ret;
218 }
219 
220 static int submit_bo(struct etnaviv_gem_submit *submit, u32 idx,
221 	struct etnaviv_gem_submit_bo **bo)
222 {
223 	if (idx >= submit->nr_bos) {
224 		DRM_ERROR("invalid buffer index: %u (out of %u)\n",
225 				idx, submit->nr_bos);
226 		return -EINVAL;
227 	}
228 
229 	*bo = &submit->bos[idx];
230 
231 	return 0;
232 }
233 
234 /* process the reloc's and patch up the cmdstream as needed: */
235 static int submit_reloc(struct etnaviv_gem_submit *submit, void *stream,
236 		u32 size, const struct drm_etnaviv_gem_submit_reloc *relocs,
237 		u32 nr_relocs)
238 {
239 	u32 i, last_offset = 0;
240 	u32 *ptr = stream;
241 	int ret;
242 
243 	for (i = 0; i < nr_relocs; i++) {
244 		const struct drm_etnaviv_gem_submit_reloc *r = relocs + i;
245 		struct etnaviv_gem_submit_bo *bo;
246 		u32 off;
247 
248 		if (unlikely(r->flags)) {
249 			DRM_ERROR("invalid reloc flags\n");
250 			return -EINVAL;
251 		}
252 
253 		if (r->submit_offset % 4) {
254 			DRM_ERROR("non-aligned reloc offset: %u\n",
255 				  r->submit_offset);
256 			return -EINVAL;
257 		}
258 
259 		/* offset in dwords: */
260 		off = r->submit_offset / 4;
261 
262 		if ((off >= size ) ||
263 				(off < last_offset)) {
264 			DRM_ERROR("invalid offset %u at reloc %u\n", off, i);
265 			return -EINVAL;
266 		}
267 
268 		ret = submit_bo(submit, r->reloc_idx, &bo);
269 		if (ret)
270 			return ret;
271 
272 		if (r->reloc_offset >= bo->obj->base.size - sizeof(*ptr)) {
273 			DRM_ERROR("relocation %u outside object", i);
274 			return -EINVAL;
275 		}
276 
277 		ptr[off] = bo->mapping->iova + r->reloc_offset;
278 
279 		last_offset = off;
280 	}
281 
282 	return 0;
283 }
284 
285 static void submit_cleanup(struct etnaviv_gem_submit *submit)
286 {
287 	unsigned i;
288 
289 	for (i = 0; i < submit->nr_bos; i++) {
290 		struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
291 
292 		submit_unlock_object(submit, i);
293 		drm_gem_object_unreference_unlocked(&etnaviv_obj->base);
294 	}
295 
296 	ww_acquire_fini(&submit->ticket);
297 	kfree(submit);
298 }
299 
300 int etnaviv_ioctl_gem_submit(struct drm_device *dev, void *data,
301 		struct drm_file *file)
302 {
303 	struct etnaviv_drm_private *priv = dev->dev_private;
304 	struct drm_etnaviv_gem_submit *args = data;
305 	struct drm_etnaviv_gem_submit_reloc *relocs;
306 	struct drm_etnaviv_gem_submit_bo *bos;
307 	struct etnaviv_gem_submit *submit;
308 	struct etnaviv_cmdbuf *cmdbuf;
309 	struct etnaviv_gpu *gpu;
310 	void *stream;
311 	int ret;
312 
313 	if (args->pipe >= ETNA_MAX_PIPES)
314 		return -EINVAL;
315 
316 	gpu = priv->gpu[args->pipe];
317 	if (!gpu)
318 		return -ENXIO;
319 
320 	if (args->stream_size % 4) {
321 		DRM_ERROR("non-aligned cmdstream buffer size: %u\n",
322 			  args->stream_size);
323 		return -EINVAL;
324 	}
325 
326 	if (args->exec_state != ETNA_PIPE_3D &&
327 	    args->exec_state != ETNA_PIPE_2D &&
328 	    args->exec_state != ETNA_PIPE_VG) {
329 		DRM_ERROR("invalid exec_state: 0x%x\n", args->exec_state);
330 		return -EINVAL;
331 	}
332 
333 	/*
334 	 * Copy the command submission and bo array to kernel space in
335 	 * one go, and do this outside of any locks.
336 	 */
337 	bos = drm_malloc_ab(args->nr_bos, sizeof(*bos));
338 	relocs = drm_malloc_ab(args->nr_relocs, sizeof(*relocs));
339 	stream = drm_malloc_ab(1, args->stream_size);
340 	cmdbuf = etnaviv_gpu_cmdbuf_new(gpu, ALIGN(args->stream_size, 8) + 8,
341 					args->nr_bos);
342 	if (!bos || !relocs || !stream || !cmdbuf) {
343 		ret = -ENOMEM;
344 		goto err_submit_cmds;
345 	}
346 
347 	cmdbuf->exec_state = args->exec_state;
348 	cmdbuf->ctx = file->driver_priv;
349 
350 	ret = copy_from_user(bos, to_user_ptr(args->bos),
351 			     args->nr_bos * sizeof(*bos));
352 	if (ret) {
353 		ret = -EFAULT;
354 		goto err_submit_cmds;
355 	}
356 
357 	ret = copy_from_user(relocs, to_user_ptr(args->relocs),
358 			     args->nr_relocs * sizeof(*relocs));
359 	if (ret) {
360 		ret = -EFAULT;
361 		goto err_submit_cmds;
362 	}
363 
364 	ret = copy_from_user(stream, to_user_ptr(args->stream),
365 			     args->stream_size);
366 	if (ret) {
367 		ret = -EFAULT;
368 		goto err_submit_cmds;
369 	}
370 
371 	submit = submit_create(dev, gpu, args->nr_bos);
372 	if (!submit) {
373 		ret = -ENOMEM;
374 		goto err_submit_cmds;
375 	}
376 
377 	ret = submit_lookup_objects(submit, file, bos, args->nr_bos);
378 	if (ret)
379 		goto err_submit_objects;
380 
381 	ret = submit_lock_objects(submit);
382 	if (ret)
383 		goto err_submit_objects;
384 
385 	if (!etnaviv_cmd_validate_one(gpu, stream, args->stream_size / 4,
386 				      relocs, args->nr_relocs)) {
387 		ret = -EINVAL;
388 		goto err_submit_objects;
389 	}
390 
391 	ret = submit_fence_sync(submit);
392 	if (ret)
393 		goto err_submit_objects;
394 
395 	ret = submit_pin_objects(submit);
396 	if (ret)
397 		goto out;
398 
399 	ret = submit_reloc(submit, stream, args->stream_size / 4,
400 			   relocs, args->nr_relocs);
401 	if (ret)
402 		goto out;
403 
404 	memcpy(cmdbuf->vaddr, stream, args->stream_size);
405 	cmdbuf->user_size = ALIGN(args->stream_size, 8);
406 
407 	ret = etnaviv_gpu_submit(gpu, submit, cmdbuf);
408 	if (ret == 0)
409 		cmdbuf = NULL;
410 
411 	args->fence = submit->fence;
412 
413 out:
414 	submit_unpin_objects(submit);
415 
416 	/*
417 	 * If we're returning -EAGAIN, it may be due to the userptr code
418 	 * wanting to run its workqueue outside of any locks. Flush our
419 	 * workqueue to ensure that it is run in a timely manner.
420 	 */
421 	if (ret == -EAGAIN)
422 		flush_workqueue(priv->wq);
423 
424 err_submit_objects:
425 	submit_cleanup(submit);
426 
427 err_submit_cmds:
428 	/* if we still own the cmdbuf */
429 	if (cmdbuf)
430 		etnaviv_gpu_cmdbuf_free(cmdbuf);
431 	if (stream)
432 		drm_free_large(stream);
433 	if (bos)
434 		drm_free_large(bos);
435 	if (relocs)
436 		drm_free_large(relocs);
437 
438 	return ret;
439 }
440