Merge remote-tracking branch 'spi/for-5.12' into spi-linus
[linux-2.6-microblaze.git] / drivers / gpu / drm / amd / amdgpu / amdgpu_dma_buf.c
1 /*
2  * Copyright 2019 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * based on nouveau_prime.c
23  *
24  * Authors: Alex Deucher
25  */
26
27 /**
28  * DOC: PRIME Buffer Sharing
29  *
30  * The following callback implementations are used for :ref:`sharing GEM buffer
31  * objects between different devices via PRIME <prime_buffer_sharing>`.
32  */
33
34 #include "amdgpu.h"
35 #include "amdgpu_display.h"
36 #include "amdgpu_gem.h"
37 #include "amdgpu_dma_buf.h"
38 #include "amdgpu_xgmi.h"
39 #include <drm/amdgpu_drm.h>
40 #include <linux/dma-buf.h>
41 #include <linux/dma-fence-array.h>
42 #include <linux/pci-p2pdma.h>
43 #include <linux/pm_runtime.h>
44
45 /**
46  * amdgpu_gem_prime_mmap - &drm_driver.gem_prime_mmap implementation
47  * @obj: GEM BO
48  * @vma: Virtual memory area
49  *
50  * Sets up a userspace mapping of the BO's memory in the given
51  * virtual memory area.
52  *
53  * Returns:
54  * 0 on success or a negative error code on failure.
55  */
56 int amdgpu_gem_prime_mmap(struct drm_gem_object *obj,
57                           struct vm_area_struct *vma)
58 {
59         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
60         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
61         unsigned asize = amdgpu_bo_size(bo);
62         int ret;
63
64         if (!vma->vm_file)
65                 return -ENODEV;
66
67         if (adev == NULL)
68                 return -ENODEV;
69
70         /* Check for valid size. */
71         if (asize < vma->vm_end - vma->vm_start)
72                 return -EINVAL;
73
74         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm) ||
75             (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)) {
76                 return -EPERM;
77         }
78         vma->vm_pgoff += amdgpu_bo_mmap_offset(bo) >> PAGE_SHIFT;
79
80         /* prime mmap does not need to check access, so allow here */
81         ret = drm_vma_node_allow(&obj->vma_node, vma->vm_file->private_data);
82         if (ret)
83                 return ret;
84
85         ret = ttm_bo_mmap(vma->vm_file, vma, &adev->mman.bdev);
86         drm_vma_node_revoke(&obj->vma_node, vma->vm_file->private_data);
87
88         return ret;
89 }
90
91 static int
92 __dma_resv_make_exclusive(struct dma_resv *obj)
93 {
94         struct dma_fence **fences;
95         unsigned int count;
96         int r;
97
98         if (!dma_resv_get_list(obj)) /* no shared fences to convert */
99                 return 0;
100
101         r = dma_resv_get_fences_rcu(obj, NULL, &count, &fences);
102         if (r)
103                 return r;
104
105         if (count == 0) {
106                 /* Now that was unexpected. */
107         } else if (count == 1) {
108                 dma_resv_add_excl_fence(obj, fences[0]);
109                 dma_fence_put(fences[0]);
110                 kfree(fences);
111         } else {
112                 struct dma_fence_array *array;
113
114                 array = dma_fence_array_create(count, fences,
115                                                dma_fence_context_alloc(1), 0,
116                                                false);
117                 if (!array)
118                         goto err_fences_put;
119
120                 dma_resv_add_excl_fence(obj, &array->base);
121                 dma_fence_put(&array->base);
122         }
123
124         return 0;
125
126 err_fences_put:
127         while (count--)
128                 dma_fence_put(fences[count]);
129         kfree(fences);
130         return -ENOMEM;
131 }
132
133 /**
134  * amdgpu_dma_buf_attach - &dma_buf_ops.attach implementation
135  *
136  * @dmabuf: DMA-buf where we attach to
137  * @attach: attachment to add
138  *
139  * Add the attachment as user to the exported DMA-buf.
140  */
141 static int amdgpu_dma_buf_attach(struct dma_buf *dmabuf,
142                                  struct dma_buf_attachment *attach)
143 {
144         struct drm_gem_object *obj = dmabuf->priv;
145         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
146         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
147         int r;
148
149         if (pci_p2pdma_distance_many(adev->pdev, &attach->dev, 1, true) < 0)
150                 attach->peer2peer = false;
151
152         if (attach->dev->driver == adev->dev->driver)
153                 return 0;
154
155         r = pm_runtime_get_sync(adev_to_drm(adev)->dev);
156         if (r < 0)
157                 goto out;
158
159         r = amdgpu_bo_reserve(bo, false);
160         if (unlikely(r != 0))
161                 goto out;
162
163         /*
164          * We only create shared fences for internal use, but importers
165          * of the dmabuf rely on exclusive fences for implicitly
166          * tracking write hazards. As any of the current fences may
167          * correspond to a write, we need to convert all existing
168          * fences on the reservation object into a single exclusive
169          * fence.
170          */
171         r = __dma_resv_make_exclusive(bo->tbo.base.resv);
172         if (r)
173                 goto out;
174
175         bo->prime_shared_count++;
176         amdgpu_bo_unreserve(bo);
177         return 0;
178
179 out:
180         pm_runtime_put_autosuspend(adev_to_drm(adev)->dev);
181         return r;
182 }
183
184 /**
185  * amdgpu_dma_buf_detach - &dma_buf_ops.detach implementation
186  *
187  * @dmabuf: DMA-buf where we remove the attachment from
188  * @attach: the attachment to remove
189  *
190  * Called when an attachment is removed from the DMA-buf.
191  */
192 static void amdgpu_dma_buf_detach(struct dma_buf *dmabuf,
193                                   struct dma_buf_attachment *attach)
194 {
195         struct drm_gem_object *obj = dmabuf->priv;
196         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
197         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
198
199         if (attach->dev->driver != adev->dev->driver && bo->prime_shared_count)
200                 bo->prime_shared_count--;
201
202         pm_runtime_mark_last_busy(adev_to_drm(adev)->dev);
203         pm_runtime_put_autosuspend(adev_to_drm(adev)->dev);
204 }
205
206 /**
207  * amdgpu_dma_buf_pin - &dma_buf_ops.pin implementation
208  *
209  * @attach: attachment to pin down
210  *
211  * Pin the BO which is backing the DMA-buf so that it can't move any more.
212  */
213 static int amdgpu_dma_buf_pin(struct dma_buf_attachment *attach)
214 {
215         struct drm_gem_object *obj = attach->dmabuf->priv;
216         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
217
218         /* pin buffer into GTT */
219         return amdgpu_bo_pin(bo, AMDGPU_GEM_DOMAIN_GTT);
220 }
221
222 /**
223  * amdgpu_dma_buf_unpin - &dma_buf_ops.unpin implementation
224  *
225  * @attach: attachment to unpin
226  *
227  * Unpin a previously pinned BO to make it movable again.
228  */
229 static void amdgpu_dma_buf_unpin(struct dma_buf_attachment *attach)
230 {
231         struct drm_gem_object *obj = attach->dmabuf->priv;
232         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
233
234         amdgpu_bo_unpin(bo);
235 }
236
237 /**
238  * amdgpu_dma_buf_map - &dma_buf_ops.map_dma_buf implementation
239  * @attach: DMA-buf attachment
240  * @dir: DMA direction
241  *
242  * Makes sure that the shared DMA buffer can be accessed by the target device.
243  * For now, simply pins it to the GTT domain, where it should be accessible by
244  * all DMA devices.
245  *
246  * Returns:
247  * sg_table filled with the DMA addresses to use or ERR_PRT with negative error
248  * code.
249  */
250 static struct sg_table *amdgpu_dma_buf_map(struct dma_buf_attachment *attach,
251                                            enum dma_data_direction dir)
252 {
253         struct dma_buf *dma_buf = attach->dmabuf;
254         struct drm_gem_object *obj = dma_buf->priv;
255         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
256         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
257         struct sg_table *sgt;
258         long r;
259
260         if (!bo->tbo.pin_count) {
261                 /* move buffer into GTT or VRAM */
262                 struct ttm_operation_ctx ctx = { false, false };
263                 unsigned domains = AMDGPU_GEM_DOMAIN_GTT;
264
265                 if (bo->preferred_domains & AMDGPU_GEM_DOMAIN_VRAM &&
266                     attach->peer2peer) {
267                         bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
268                         domains |= AMDGPU_GEM_DOMAIN_VRAM;
269                 }
270                 amdgpu_bo_placement_from_domain(bo, domains);
271                 r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
272                 if (r)
273                         return ERR_PTR(r);
274
275         } else if (!(amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type) &
276                      AMDGPU_GEM_DOMAIN_GTT)) {
277                 return ERR_PTR(-EBUSY);
278         }
279
280         switch (bo->tbo.mem.mem_type) {
281         case TTM_PL_TT:
282                 sgt = drm_prime_pages_to_sg(obj->dev,
283                                             bo->tbo.ttm->pages,
284                                             bo->tbo.ttm->num_pages);
285                 if (IS_ERR(sgt))
286                         return sgt;
287
288                 if (dma_map_sgtable(attach->dev, sgt, dir,
289                                     DMA_ATTR_SKIP_CPU_SYNC))
290                         goto error_free;
291                 break;
292
293         case TTM_PL_VRAM:
294                 r = amdgpu_vram_mgr_alloc_sgt(adev, &bo->tbo.mem, 0,
295                                 bo->tbo.base.size, attach->dev, dir, &sgt);
296                 if (r)
297                         return ERR_PTR(r);
298                 break;
299         default:
300                 return ERR_PTR(-EINVAL);
301         }
302
303         return sgt;
304
305 error_free:
306         sg_free_table(sgt);
307         kfree(sgt);
308         return ERR_PTR(-EBUSY);
309 }
310
311 /**
312  * amdgpu_dma_buf_unmap - &dma_buf_ops.unmap_dma_buf implementation
313  * @attach: DMA-buf attachment
314  * @sgt: sg_table to unmap
315  * @dir: DMA direction
316  *
317  * This is called when a shared DMA buffer no longer needs to be accessible by
318  * another device. For now, simply unpins the buffer from GTT.
319  */
320 static void amdgpu_dma_buf_unmap(struct dma_buf_attachment *attach,
321                                  struct sg_table *sgt,
322                                  enum dma_data_direction dir)
323 {
324         if (sgt->sgl->page_link) {
325                 dma_unmap_sgtable(attach->dev, sgt, dir, 0);
326                 sg_free_table(sgt);
327                 kfree(sgt);
328         } else {
329                 amdgpu_vram_mgr_free_sgt(attach->dev, dir, sgt);
330         }
331 }
332
333 /**
334  * amdgpu_dma_buf_begin_cpu_access - &dma_buf_ops.begin_cpu_access implementation
335  * @dma_buf: Shared DMA buffer
336  * @direction: Direction of DMA transfer
337  *
338  * This is called before CPU access to the shared DMA buffer's memory. If it's
339  * a read access, the buffer is moved to the GTT domain if possible, for optimal
340  * CPU read performance.
341  *
342  * Returns:
343  * 0 on success or a negative error code on failure.
344  */
345 static int amdgpu_dma_buf_begin_cpu_access(struct dma_buf *dma_buf,
346                                            enum dma_data_direction direction)
347 {
348         struct amdgpu_bo *bo = gem_to_amdgpu_bo(dma_buf->priv);
349         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
350         struct ttm_operation_ctx ctx = { true, false };
351         u32 domain = amdgpu_display_supported_domains(adev, bo->flags);
352         int ret;
353         bool reads = (direction == DMA_BIDIRECTIONAL ||
354                       direction == DMA_FROM_DEVICE);
355
356         if (!reads || !(domain & AMDGPU_GEM_DOMAIN_GTT))
357                 return 0;
358
359         /* move to gtt */
360         ret = amdgpu_bo_reserve(bo, false);
361         if (unlikely(ret != 0))
362                 return ret;
363
364         if (!bo->tbo.pin_count &&
365             (bo->allowed_domains & AMDGPU_GEM_DOMAIN_GTT)) {
366                 amdgpu_bo_placement_from_domain(bo, AMDGPU_GEM_DOMAIN_GTT);
367                 ret = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
368         }
369
370         amdgpu_bo_unreserve(bo);
371         return ret;
372 }
373
374 const struct dma_buf_ops amdgpu_dmabuf_ops = {
375         .attach = amdgpu_dma_buf_attach,
376         .detach = amdgpu_dma_buf_detach,
377         .pin = amdgpu_dma_buf_pin,
378         .unpin = amdgpu_dma_buf_unpin,
379         .map_dma_buf = amdgpu_dma_buf_map,
380         .unmap_dma_buf = amdgpu_dma_buf_unmap,
381         .release = drm_gem_dmabuf_release,
382         .begin_cpu_access = amdgpu_dma_buf_begin_cpu_access,
383         .mmap = drm_gem_dmabuf_mmap,
384         .vmap = drm_gem_dmabuf_vmap,
385         .vunmap = drm_gem_dmabuf_vunmap,
386 };
387
388 /**
389  * amdgpu_gem_prime_export - &drm_driver.gem_prime_export implementation
390  * @gobj: GEM BO
391  * @flags: Flags such as DRM_CLOEXEC and DRM_RDWR.
392  *
393  * The main work is done by the &drm_gem_prime_export helper.
394  *
395  * Returns:
396  * Shared DMA buffer representing the GEM BO from the given device.
397  */
398 struct dma_buf *amdgpu_gem_prime_export(struct drm_gem_object *gobj,
399                                         int flags)
400 {
401         struct amdgpu_bo *bo = gem_to_amdgpu_bo(gobj);
402         struct dma_buf *buf;
403
404         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm) ||
405             bo->flags & AMDGPU_GEM_CREATE_VM_ALWAYS_VALID)
406                 return ERR_PTR(-EPERM);
407
408         buf = drm_gem_prime_export(gobj, flags);
409         if (!IS_ERR(buf))
410                 buf->ops = &amdgpu_dmabuf_ops;
411
412         return buf;
413 }
414
415 /**
416  * amdgpu_dma_buf_create_obj - create BO for DMA-buf import
417  *
418  * @dev: DRM device
419  * @dma_buf: DMA-buf
420  *
421  * Creates an empty SG BO for DMA-buf import.
422  *
423  * Returns:
424  * A new GEM BO of the given DRM device, representing the memory
425  * described by the given DMA-buf attachment and scatter/gather table.
426  */
427 static struct drm_gem_object *
428 amdgpu_dma_buf_create_obj(struct drm_device *dev, struct dma_buf *dma_buf)
429 {
430         struct dma_resv *resv = dma_buf->resv;
431         struct amdgpu_device *adev = drm_to_adev(dev);
432         struct drm_gem_object *gobj;
433         struct amdgpu_bo *bo;
434         uint64_t flags = 0;
435         int ret;
436
437         dma_resv_lock(resv, NULL);
438
439         if (dma_buf->ops == &amdgpu_dmabuf_ops) {
440                 struct amdgpu_bo *other = gem_to_amdgpu_bo(dma_buf->priv);
441
442                 flags |= other->flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC;
443         }
444
445         ret = amdgpu_gem_object_create(adev, dma_buf->size, PAGE_SIZE,
446                                        AMDGPU_GEM_DOMAIN_CPU, flags,
447                                        ttm_bo_type_sg, resv, &gobj);
448         if (ret)
449                 goto error;
450
451         bo = gem_to_amdgpu_bo(gobj);
452         bo->allowed_domains = AMDGPU_GEM_DOMAIN_GTT;
453         bo->preferred_domains = AMDGPU_GEM_DOMAIN_GTT;
454         if (dma_buf->ops != &amdgpu_dmabuf_ops)
455                 bo->prime_shared_count = 1;
456
457         dma_resv_unlock(resv);
458         return gobj;
459
460 error:
461         dma_resv_unlock(resv);
462         return ERR_PTR(ret);
463 }
464
465 /**
466  * amdgpu_dma_buf_move_notify - &attach.move_notify implementation
467  *
468  * @attach: the DMA-buf attachment
469  *
470  * Invalidate the DMA-buf attachment, making sure that the we re-create the
471  * mapping before the next use.
472  */
473 static void
474 amdgpu_dma_buf_move_notify(struct dma_buf_attachment *attach)
475 {
476         struct drm_gem_object *obj = attach->importer_priv;
477         struct ww_acquire_ctx *ticket = dma_resv_locking_ctx(obj->resv);
478         struct amdgpu_bo *bo = gem_to_amdgpu_bo(obj);
479         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
480         struct ttm_operation_ctx ctx = { false, false };
481         struct ttm_placement placement = {};
482         struct amdgpu_vm_bo_base *bo_base;
483         int r;
484
485         if (bo->tbo.mem.mem_type == TTM_PL_SYSTEM)
486                 return;
487
488         r = ttm_bo_validate(&bo->tbo, &placement, &ctx);
489         if (r) {
490                 DRM_ERROR("Failed to invalidate DMA-buf import (%d))\n", r);
491                 return;
492         }
493
494         for (bo_base = bo->vm_bo; bo_base; bo_base = bo_base->next) {
495                 struct amdgpu_vm *vm = bo_base->vm;
496                 struct dma_resv *resv = vm->root.base.bo->tbo.base.resv;
497
498                 if (ticket) {
499                         /* When we get an error here it means that somebody
500                          * else is holding the VM lock and updating page tables
501                          * So we can just continue here.
502                          */
503                         r = dma_resv_lock(resv, ticket);
504                         if (r)
505                                 continue;
506
507                 } else {
508                         /* TODO: This is more problematic and we actually need
509                          * to allow page tables updates without holding the
510                          * lock.
511                          */
512                         if (!dma_resv_trylock(resv))
513                                 continue;
514                 }
515
516                 r = amdgpu_vm_clear_freed(adev, vm, NULL);
517                 if (!r)
518                         r = amdgpu_vm_handle_moved(adev, vm);
519
520                 if (r && r != -EBUSY)
521                         DRM_ERROR("Failed to invalidate VM page tables (%d))\n",
522                                   r);
523
524                 dma_resv_unlock(resv);
525         }
526 }
527
528 static const struct dma_buf_attach_ops amdgpu_dma_buf_attach_ops = {
529         .allow_peer2peer = true,
530         .move_notify = amdgpu_dma_buf_move_notify
531 };
532
533 /**
534  * amdgpu_gem_prime_import - &drm_driver.gem_prime_import implementation
535  * @dev: DRM device
536  * @dma_buf: Shared DMA buffer
537  *
538  * Import a dma_buf into a the driver and potentially create a new GEM object.
539  *
540  * Returns:
541  * GEM BO representing the shared DMA buffer for the given device.
542  */
543 struct drm_gem_object *amdgpu_gem_prime_import(struct drm_device *dev,
544                                                struct dma_buf *dma_buf)
545 {
546         struct dma_buf_attachment *attach;
547         struct drm_gem_object *obj;
548
549         if (dma_buf->ops == &amdgpu_dmabuf_ops) {
550                 obj = dma_buf->priv;
551                 if (obj->dev == dev) {
552                         /*
553                          * Importing dmabuf exported from out own gem increases
554                          * refcount on gem itself instead of f_count of dmabuf.
555                          */
556                         drm_gem_object_get(obj);
557                         return obj;
558                 }
559         }
560
561         obj = amdgpu_dma_buf_create_obj(dev, dma_buf);
562         if (IS_ERR(obj))
563                 return obj;
564
565         attach = dma_buf_dynamic_attach(dma_buf, dev->dev,
566                                         &amdgpu_dma_buf_attach_ops, obj);
567         if (IS_ERR(attach)) {
568                 drm_gem_object_put(obj);
569                 return ERR_CAST(attach);
570         }
571
572         get_dma_buf(dma_buf);
573         obj->import_attach = attach;
574         return obj;
575 }
576
577 /**
578  * amdgpu_dmabuf_is_xgmi_accessible - Check if xgmi available for P2P transfer
579  *
580  * @adev: amdgpu_device pointer of the importer
581  * @bo: amdgpu buffer object
582  *
583  * Returns:
584  * True if dmabuf accessible over xgmi, false otherwise.
585  */
586 bool amdgpu_dmabuf_is_xgmi_accessible(struct amdgpu_device *adev,
587                                       struct amdgpu_bo *bo)
588 {
589         struct drm_gem_object *obj = &bo->tbo.base;
590         struct drm_gem_object *gobj;
591
592         if (obj->import_attach) {
593                 struct dma_buf *dma_buf = obj->import_attach->dmabuf;
594
595                 if (dma_buf->ops != &amdgpu_dmabuf_ops)
596                         /* No XGMI with non AMD GPUs */
597                         return false;
598
599                 gobj = dma_buf->priv;
600                 bo = gem_to_amdgpu_bo(gobj);
601         }
602
603         if (amdgpu_xgmi_same_hive(adev, amdgpu_ttm_adev(bo->tbo.bdev)) &&
604                         (bo->preferred_domains & AMDGPU_GEM_DOMAIN_VRAM))
605                 return true;
606
607         return false;
608 }