Skip to contentSkip to conversation

drm/prime: Clarify DMA-BUF/GEM Object lifetime

PATCH In review Oleksandr Andrushchenko 2 participants 3 messages Jan 27, 2017

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/prime: Clarify DMA-BUF/GEM Object lifetime

From: Oleksandr Andrushchenko <[email protected]>

From the description of the "DMA-BUF/GEM Object references and lifetime overview" it is not clear when exactly dma_buf gets destroyed and memory freed: only driver .release function mentioned which makes confusion on the real buffer's lifetime.

Add more description so all the paths are covered.

---
 drivers/gpu/drm/drm_prime.c | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)
drivers/gpu/drm/drm_prime.c +14 -2
index 8d77b2462594..893a1a6311f0 100644
@@ -40,8 +40,11 @@
  * On the export the dma_buf holds a reference to the exporting GEM
  * object. It takes this reference in handle_to_fd_ioctl, when it
  * first calls .prime_export and stores the exporting GEM object in
- * the dma_buf priv. This reference is released when the dma_buf
- * object goes away in the driver .release function.
+ * the dma_buf priv. This refernce needs to be released when the
+ * final reference to the &dma_buf itself is dropped and its
+ * &dma_buf_ops.release function is called. For GEM-based drivers,
+ * the dma_buf should be exported using drm_gem_dmabuf_export() and
+ * then released by drm_gem_dmabuf_release().
  *
  * On the import the importing GEM object holds a reference to the
  * dma_buf (which in turn holds a ref to the exporting GEM object).
@@ -51,6 +54,15 @@
  * when the imported object is destroyed, we remove the attachment
  * and drop the reference to the dma_buf.
  *
+ * When all the references to the dma_buf are dropped, e.g. when
+ * userspace closes both handles to the imported (fd_to_handle_ioctl)
+ * and exported (handle_to_fd_ioctl) dma_buf and closes the corresponding
+ * file descriptor (handle_to_fd), then dma_buf gets destroyed.
+ * This can also happen as a part of the clean up procedure in the
+ * driver .release function if userspace fails to properly clean up.
+ * Note that both the kernel and userspace (by keeeping the PRIME file
+ * descriptors open) can hold references onto a &dma_buf.
+ *
  * Thus the chain of references always flows in one direction
  * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
  *
Signature · 6 lines
2.7.4

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
#1 lore raw
Quoted 23 lines · Oleksandr Andrushchenko

From: Oleksandr Andrushchenko <[email protected]>

From the description of the "DMA-BUF/GEM Object references and lifetime overview" it is not clear when exactly dma_buf gets destroyed and memory freed: only driver .release function mentioned which makes confusion on the real buffer's lifetime.

Add more description so all the paths are covered.

---
 drivers/gpu/drm/drm_prime.c | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)
drivers/gpu/drm/drm_prime.c +0 -0
index 8d77b2462594..893a1a6311f0 100644

drivers/gpu/drm/drm_prime.c line 43

Quoted 6 lines
drivers/gpu/drm/drm_prime.c +1 -2
@@ -40,8 +40,11 @@
  * On the export the dma_buf holds a reference to the exporting GEM
  * object. It takes this reference in handle_to_fd_ioctl, when it
  * first calls .prime_export and stores the exporting GEM object in
- * the dma_buf priv. This reference is released when the dma_buf
- * object goes away in the driver .release function.
+ * the dma_buf priv. This refernce needs to be released when the

s/refernce/reference/

Quoted 8 lines
drivers/gpu/drm/drm_prime.c +4 -0
+ * final reference to the &dma_buf itself is dropped and its
+ * &dma_buf_ops.release function is called. For GEM-based drivers,
+ * the dma_buf should be exported using drm_gem_dmabuf_export() and
+ * then released by drm_gem_dmabuf_release().
  *
  * On the import the importing GEM object holds a reference to the
  * dma_buf (which in turn holds a ref to the exporting GEM object).

drivers/gpu/drm/drm_prime.c line 59

Quoted 6 lines
drivers/gpu/drm/drm_prime.c +3 -0
@@ -51,6 +54,15 @@
  * when the imported object is destroyed, we remove the attachment
  * and drop the reference to the dma_buf.
  *
+ * When all the references to the dma_buf are dropped, e.g. when
+ * userspace closes both handles to the imported (fd_to_handle_ioctl)
+ * and exported (handle_to_fd_ioctl) dma_buf and closes the corresponding

Usualla we call ioctls with uppercase, e.g. HANDLE_TO_FD IOCTL.

drivers/gpu/drm/drm_prime.c line 62

Quoted 3 lines
drivers/gpu/drm/drm_prime.c +3 -0
+ * file descriptor (handle_to_fd), then dma_buf gets destroyed.
+ * This can also happen as a part of the clean up procedure in the
+ * driver .release function if userspace fails to properly clean up.

Extended the references here to full file_ops one.

Since this is all tiny, I've done this while applying, thanks a lot for your patch.
-Daniel

Quoted 9 lines
drivers/gpu/drm/drm_prime.c +3 -0
+ * Note that both the kernel and userspace (by keeeping the PRIME file
+ * descriptors open) can hold references onto a &dma_buf.
+ *
  * Thus the chain of references always flows in one direction
  * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
  *
Signature · 1 line
2.7.4
Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
#2 lore raw
Quoted 48 lines · Daniel Vetter
Quoted 23 lines · Oleksandr Andrushchenko

From: Oleksandr Andrushchenko <[email protected]>

From the description of the "DMA-BUF/GEM Object references
and lifetime overview" it is not clear when exactly dma_buf gets destroyed and memory freed: only driver .release function mentioned which makes confusion on the real buffer's lifetime.

Add more description so all the paths are covered.

---
  drivers/gpu/drm/drm_prime.c | 16 ++++++++++++++--
  1 file changed, 14 insertions(+), 2 deletions(-)
drivers/gpu/drm/drm_prime.c +0 -0
index 8d77b2462594..893a1a6311f0 100644

drivers/gpu/drm/drm_prime.c line 43

Quoted 6 lines
drivers/gpu/drm/drm_prime.c +1 -2
@@ -40,8 +40,11 @@
   * On the export the dma_buf holds a reference to the exporting GEM
   * object. It takes this reference in handle_to_fd_ioctl, when it
   * first calls .prime_export and stores the exporting GEM object in
- * the dma_buf priv. This reference is released when the dma_buf
- * object goes away in the driver .release function.
+ * the dma_buf priv. This refernce needs to be released when the

s/refernce/reference/

Quoted 8 lines
drivers/gpu/drm/drm_prime.c +4 -0
+ * final reference to the &dma_buf itself is dropped and its
+ * &dma_buf_ops.release function is called. For GEM-based drivers,
+ * the dma_buf should be exported using drm_gem_dmabuf_export() and
+ * then released by drm_gem_dmabuf_release().
   *
   * On the import the importing GEM object holds a reference to the
   * dma_buf (which in turn holds a ref to the exporting GEM object).

drivers/gpu/drm/drm_prime.c line 59

Quoted 6 lines
drivers/gpu/drm/drm_prime.c +3 -0
@@ -51,6 +54,15 @@
   * when the imported object is destroyed, we remove the attachment
   * and drop the reference to the dma_buf.
   *
+ * When all the references to the dma_buf are dropped, e.g. when
+ * userspace closes both handles to the imported (fd_to_handle_ioctl)
+ * and exported (handle_to_fd_ioctl) dma_buf and closes the corresponding

Usualla we call ioctls with uppercase, e.g. HANDLE_TO_FD IOCTL.

Quoted 6 lines

drivers/gpu/drm/drm_prime.c line 62

Quoted 3 lines
drivers/gpu/drm/drm_prime.c +3 -0
+ * file descriptor (handle_to_fd), then dma_buf gets destroyed.
+ * This can also happen as a part of the clean up procedure in the
+ * driver .release function if userspace fails to properly clean up.

Extended the references here to full file_ops one.

Since this is all tiny, I've done this while applying,

Thank you

Quoted 2 lines

thanks a lot for
your patch.

My pleasure

Quoted 11 lines

-Daniel

Quoted 9 lines
drivers/gpu/drm/drm_prime.c +3 -0
+ * Note that both the kernel and userspace (by keeeping the PRIME file
+ * descriptors open) can hold references onto a &dma_buf.
+ *
   * Thus the chain of references always flows in one direction
   * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
   *
Signature · 1 line
2.7.4

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel