drm/etnaviv: don't put fence in case of submit failure
[sfrench/cifs-2.6.git] / drivers / gpu / drm / etnaviv / etnaviv_gem_submit.c
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/dma-fence-array.h>
18 #include <linux/reservation.h>
19 #include <linux/sync_file.h>
20 #include "etnaviv_cmdbuf.h"
21 #include "etnaviv_drv.h"
22 #include "etnaviv_gpu.h"
23 #include "etnaviv_gem.h"
24
25 /*
26  * Cmdstream submission:
27  */
28
29 #define BO_INVALID_FLAGS ~(ETNA_SUBMIT_BO_READ | ETNA_SUBMIT_BO_WRITE)
30 /* make sure these don't conflict w/ ETNAVIV_SUBMIT_BO_x */
31 #define BO_LOCKED   0x4000
32 #define BO_PINNED   0x2000
33
34 static struct etnaviv_gem_submit *submit_create(struct drm_device *dev,
35                 struct etnaviv_gpu *gpu, size_t nr)
36 {
37         struct etnaviv_gem_submit *submit;
38         size_t sz = size_vstruct(nr, sizeof(submit->bos[0]), sizeof(*submit));
39
40         submit = kmalloc(sz, GFP_TEMPORARY | __GFP_NOWARN | __GFP_NORETRY);
41         if (submit) {
42                 submit->dev = dev;
43                 submit->gpu = gpu;
44
45                 /* initially, until copy_from_user() and bo lookup succeeds: */
46                 submit->nr_bos = 0;
47                 submit->fence = NULL;
48
49                 ww_acquire_init(&submit->ticket, &reservation_ww_class);
50         }
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
76                 /* normally use drm_gem_object_lookup(), but for bulk lookup
77                  * all under single table_lock just hit object_idr directly:
78                  */
79                 obj = idr_find(&file->object_idr, bo->handle);
80                 if (!obj) {
81                         DRM_ERROR("invalid handle %u at index %u\n",
82                                   bo->handle, i);
83                         ret = -EINVAL;
84                         goto out_unlock;
85                 }
86
87                 /*
88                  * Take a refcount on the object. The file table lock
89                  * prevents the object_idr's refcount on this being dropped.
90                  */
91                 drm_gem_object_reference(obj);
92
93                 submit->bos[i].obj = to_etnaviv_bo(obj);
94         }
95
96 out_unlock:
97         submit->nr_bos = i;
98         spin_unlock(&file->table_lock);
99
100         return ret;
101 }
102
103 static void submit_unlock_object(struct etnaviv_gem_submit *submit, int i)
104 {
105         if (submit->bos[i].flags & BO_LOCKED) {
106                 struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
107
108                 ww_mutex_unlock(&etnaviv_obj->resv->lock);
109                 submit->bos[i].flags &= ~BO_LOCKED;
110         }
111 }
112
113 static int submit_lock_objects(struct etnaviv_gem_submit *submit)
114 {
115         int contended, slow_locked = -1, i, ret = 0;
116
117 retry:
118         for (i = 0; i < submit->nr_bos; i++) {
119                 struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
120
121                 if (slow_locked == i)
122                         slow_locked = -1;
123
124                 contended = i;
125
126                 if (!(submit->bos[i].flags & BO_LOCKED)) {
127                         ret = ww_mutex_lock_interruptible(&etnaviv_obj->resv->lock,
128                                         &submit->ticket);
129                         if (ret == -EALREADY)
130                                 DRM_ERROR("BO at index %u already on submit list\n",
131                                           i);
132                         if (ret)
133                                 goto fail;
134                         submit->bos[i].flags |= BO_LOCKED;
135                 }
136         }
137
138         ww_acquire_done(&submit->ticket);
139
140         return 0;
141
142 fail:
143         for (; i >= 0; i--)
144                 submit_unlock_object(submit, i);
145
146         if (slow_locked > 0)
147                 submit_unlock_object(submit, slow_locked);
148
149         if (ret == -EDEADLK) {
150                 struct etnaviv_gem_object *etnaviv_obj;
151
152                 etnaviv_obj = submit->bos[contended].obj;
153
154                 /* we lost out in a seqno race, lock and retry.. */
155                 ret = ww_mutex_lock_slow_interruptible(&etnaviv_obj->resv->lock,
156                                 &submit->ticket);
157                 if (!ret) {
158                         submit->bos[contended].flags |= BO_LOCKED;
159                         slow_locked = contended;
160                         goto retry;
161                 }
162         }
163
164         return ret;
165 }
166
167 static int submit_fence_sync(const struct etnaviv_gem_submit *submit)
168 {
169         unsigned int context = submit->gpu->fence_context;
170         int i, ret = 0;
171
172         for (i = 0; i < submit->nr_bos; i++) {
173                 struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
174                 bool write = submit->bos[i].flags & ETNA_SUBMIT_BO_WRITE;
175                 bool explicit = !(submit->flags & ETNA_SUBMIT_NO_IMPLICIT);
176
177                 ret = etnaviv_gpu_fence_sync_obj(etnaviv_obj, context, write,
178                                                  explicit);
179                 if (ret)
180                         break;
181         }
182
183         return ret;
184 }
185
186 static void submit_unpin_objects(struct etnaviv_gem_submit *submit)
187 {
188         int i;
189
190         for (i = 0; i < submit->nr_bos; i++) {
191                 if (submit->bos[i].flags & BO_PINNED)
192                         etnaviv_gem_mapping_unreference(submit->bos[i].mapping);
193
194                 submit->bos[i].mapping = NULL;
195                 submit->bos[i].flags &= ~BO_PINNED;
196         }
197 }
198
199 static int submit_pin_objects(struct etnaviv_gem_submit *submit)
200 {
201         int i, ret = 0;
202
203         for (i = 0; i < submit->nr_bos; i++) {
204                 struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
205                 struct etnaviv_vram_mapping *mapping;
206
207                 mapping = etnaviv_gem_mapping_get(&etnaviv_obj->base,
208                                                   submit->gpu);
209                 if (IS_ERR(mapping)) {
210                         ret = PTR_ERR(mapping);
211                         break;
212                 }
213
214                 submit->bos[i].flags |= BO_PINNED;
215                 submit->bos[i].mapping = mapping;
216         }
217
218         return ret;
219 }
220
221 static int submit_bo(struct etnaviv_gem_submit *submit, u32 idx,
222         struct etnaviv_gem_submit_bo **bo)
223 {
224         if (idx >= submit->nr_bos) {
225                 DRM_ERROR("invalid buffer index: %u (out of %u)\n",
226                                 idx, submit->nr_bos);
227                 return -EINVAL;
228         }
229
230         *bo = &submit->bos[idx];
231
232         return 0;
233 }
234
235 /* process the reloc's and patch up the cmdstream as needed: */
236 static int submit_reloc(struct etnaviv_gem_submit *submit, void *stream,
237                 u32 size, const struct drm_etnaviv_gem_submit_reloc *relocs,
238                 u32 nr_relocs)
239 {
240         u32 i, last_offset = 0;
241         u32 *ptr = stream;
242         int ret;
243
244         for (i = 0; i < nr_relocs; i++) {
245                 const struct drm_etnaviv_gem_submit_reloc *r = relocs + i;
246                 struct etnaviv_gem_submit_bo *bo;
247                 u32 off;
248
249                 if (unlikely(r->flags)) {
250                         DRM_ERROR("invalid reloc flags\n");
251                         return -EINVAL;
252                 }
253
254                 if (r->submit_offset % 4) {
255                         DRM_ERROR("non-aligned reloc offset: %u\n",
256                                   r->submit_offset);
257                         return -EINVAL;
258                 }
259
260                 /* offset in dwords: */
261                 off = r->submit_offset / 4;
262
263                 if ((off >= size ) ||
264                                 (off < last_offset)) {
265                         DRM_ERROR("invalid offset %u at reloc %u\n", off, i);
266                         return -EINVAL;
267                 }
268
269                 ret = submit_bo(submit, r->reloc_idx, &bo);
270                 if (ret)
271                         return ret;
272
273                 if (r->reloc_offset >= bo->obj->base.size - sizeof(*ptr)) {
274                         DRM_ERROR("relocation %u outside object", i);
275                         return -EINVAL;
276                 }
277
278                 ptr[off] = bo->mapping->iova + r->reloc_offset;
279
280                 last_offset = off;
281         }
282
283         return 0;
284 }
285
286 static void submit_cleanup(struct etnaviv_gem_submit *submit)
287 {
288         unsigned i;
289
290         for (i = 0; i < submit->nr_bos; i++) {
291                 struct etnaviv_gem_object *etnaviv_obj = submit->bos[i].obj;
292
293                 submit_unlock_object(submit, i);
294                 drm_gem_object_unreference_unlocked(&etnaviv_obj->base);
295         }
296
297         ww_acquire_fini(&submit->ticket);
298         if (submit->fence)
299                 dma_fence_put(submit->fence);
300         kfree(submit);
301 }
302
303 int etnaviv_ioctl_gem_submit(struct drm_device *dev, void *data,
304                 struct drm_file *file)
305 {
306         struct etnaviv_drm_private *priv = dev->dev_private;
307         struct drm_etnaviv_gem_submit *args = data;
308         struct drm_etnaviv_gem_submit_reloc *relocs;
309         struct drm_etnaviv_gem_submit_bo *bos;
310         struct etnaviv_gem_submit *submit;
311         struct etnaviv_cmdbuf *cmdbuf;
312         struct etnaviv_gpu *gpu;
313         struct dma_fence *in_fence = NULL;
314         struct sync_file *sync_file = NULL;
315         int out_fence_fd = -1;
316         void *stream;
317         int ret;
318
319         if (args->pipe >= ETNA_MAX_PIPES)
320                 return -EINVAL;
321
322         gpu = priv->gpu[args->pipe];
323         if (!gpu)
324                 return -ENXIO;
325
326         if (args->stream_size % 4) {
327                 DRM_ERROR("non-aligned cmdstream buffer size: %u\n",
328                           args->stream_size);
329                 return -EINVAL;
330         }
331
332         if (args->exec_state != ETNA_PIPE_3D &&
333             args->exec_state != ETNA_PIPE_2D &&
334             args->exec_state != ETNA_PIPE_VG) {
335                 DRM_ERROR("invalid exec_state: 0x%x\n", args->exec_state);
336                 return -EINVAL;
337         }
338
339         if (args->flags & ~ETNA_SUBMIT_FLAGS) {
340                 DRM_ERROR("invalid flags: 0x%x\n", args->flags);
341                 return -EINVAL;
342         }
343
344         /*
345          * Copy the command submission and bo array to kernel space in
346          * one go, and do this outside of any locks.
347          */
348         bos = drm_malloc_ab(args->nr_bos, sizeof(*bos));
349         relocs = drm_malloc_ab(args->nr_relocs, sizeof(*relocs));
350         stream = drm_malloc_ab(1, args->stream_size);
351         cmdbuf = etnaviv_cmdbuf_new(gpu->cmdbuf_suballoc,
352                                     ALIGN(args->stream_size, 8) + 8,
353                                     args->nr_bos);
354         if (!bos || !relocs || !stream || !cmdbuf) {
355                 ret = -ENOMEM;
356                 goto err_submit_cmds;
357         }
358
359         cmdbuf->exec_state = args->exec_state;
360         cmdbuf->ctx = file->driver_priv;
361
362         ret = copy_from_user(bos, u64_to_user_ptr(args->bos),
363                              args->nr_bos * sizeof(*bos));
364         if (ret) {
365                 ret = -EFAULT;
366                 goto err_submit_cmds;
367         }
368
369         ret = copy_from_user(relocs, u64_to_user_ptr(args->relocs),
370                              args->nr_relocs * sizeof(*relocs));
371         if (ret) {
372                 ret = -EFAULT;
373                 goto err_submit_cmds;
374         }
375
376         ret = copy_from_user(stream, u64_to_user_ptr(args->stream),
377                              args->stream_size);
378         if (ret) {
379                 ret = -EFAULT;
380                 goto err_submit_cmds;
381         }
382
383         if (args->flags & ETNA_SUBMIT_FENCE_FD_OUT) {
384                 out_fence_fd = get_unused_fd_flags(O_CLOEXEC);
385                 if (out_fence_fd < 0) {
386                         ret = out_fence_fd;
387                         goto err_submit_cmds;
388                 }
389         }
390
391         submit = submit_create(dev, gpu, args->nr_bos);
392         if (!submit) {
393                 ret = -ENOMEM;
394                 goto err_submit_cmds;
395         }
396
397         submit->flags = args->flags;
398
399         ret = submit_lookup_objects(submit, file, bos, args->nr_bos);
400         if (ret)
401                 goto err_submit_objects;
402
403         ret = submit_lock_objects(submit);
404         if (ret)
405                 goto err_submit_objects;
406
407         if (!etnaviv_cmd_validate_one(gpu, stream, args->stream_size / 4,
408                                       relocs, args->nr_relocs)) {
409                 ret = -EINVAL;
410                 goto err_submit_objects;
411         }
412
413         if (args->flags & ETNA_SUBMIT_FENCE_FD_IN) {
414                 in_fence = sync_file_get_fence(args->fence_fd);
415                 if (!in_fence) {
416                         ret = -EINVAL;
417                         goto err_submit_objects;
418                 }
419
420                 /*
421                  * Wait if the fence is from a foreign context, or if the fence
422                  * array contains any fence from a foreign context.
423                  */
424                 if (!dma_fence_match_context(in_fence, gpu->fence_context)) {
425                         ret = dma_fence_wait(in_fence, true);
426                         if (ret)
427                                 goto err_submit_objects;
428                 }
429         }
430
431         ret = submit_fence_sync(submit);
432         if (ret)
433                 goto err_submit_objects;
434
435         ret = submit_pin_objects(submit);
436         if (ret)
437                 goto out;
438
439         ret = submit_reloc(submit, stream, args->stream_size / 4,
440                            relocs, args->nr_relocs);
441         if (ret)
442                 goto out;
443
444         memcpy(cmdbuf->vaddr, stream, args->stream_size);
445         cmdbuf->user_size = ALIGN(args->stream_size, 8);
446
447         ret = etnaviv_gpu_submit(gpu, submit, cmdbuf);
448         if (ret == 0)
449                 cmdbuf = NULL;
450
451         if (args->flags & ETNA_SUBMIT_FENCE_FD_OUT) {
452                 /*
453                  * This can be improved: ideally we want to allocate the sync
454                  * file before kicking off the GPU job and just attach the
455                  * fence to the sync file here, eliminating the ENOMEM
456                  * possibility at this stage.
457                  */
458                 sync_file = sync_file_create(submit->fence);
459                 if (!sync_file) {
460                         ret = -ENOMEM;
461                         goto out;
462                 }
463                 fd_install(out_fence_fd, sync_file->file);
464         }
465
466         args->fence_fd = out_fence_fd;
467         args->fence = submit->fence->seqno;
468
469 out:
470         submit_unpin_objects(submit);
471
472         /*
473          * If we're returning -EAGAIN, it may be due to the userptr code
474          * wanting to run its workqueue outside of any locks. Flush our
475          * workqueue to ensure that it is run in a timely manner.
476          */
477         if (ret == -EAGAIN)
478                 flush_workqueue(priv->wq);
479
480 err_submit_objects:
481         if (in_fence)
482                 dma_fence_put(in_fence);
483         submit_cleanup(submit);
484
485 err_submit_cmds:
486         if (ret && (out_fence_fd >= 0))
487                 put_unused_fd(out_fence_fd);
488         /* if we still own the cmdbuf */
489         if (cmdbuf)
490                 etnaviv_cmdbuf_free(cmdbuf);
491         if (stream)
492                 drm_free_large(stream);
493         if (bos)
494                 drm_free_large(bos);
495         if (relocs)
496                 drm_free_large(relocs);
497
498         return ret;
499 }