On Thu, Apr 25, 2024 at 5:58 AM <dongwon....@intel.com> wrote:
>
> From: Dongwon Kim <dongwon....@intel.com>
>
> New header and source files are added for containing QemuDmaBuf struct
> definition and newly introduced helpers for creating/freeing the struct
> and accessing its data.
>
> v10: Change the license type for both dmabuf.h and dmabuf.c from MIT to
> GPL to be in line with QEMU's default license
>
> v11: -- Added new helpers, qemu_dmabuf_close for closing dmabuf->fd,
> qemu_dmabuf_dup_fd for duplicating dmabuf->fd
> (Daniel P. Berrangé <berra...@redhat.com>)
>
> -- Let qemu_dmabuf_fee to call qemu_dmabuf_close before freeing
> the struct to make sure fd is closed.
> (Daniel P. Berrangé <berra...@redhat.com>)
>
> v12: Not closing fd in qemu_dmabuf_free because there are cases fd
> should still be available even after the struct is destroyed
> (e.g. virtio-gpu: res->dmabuf_fd).
>
> Suggested-by: Marc-André Lureau <marcandre.lur...@redhat.com>
> Cc: Philippe Mathieu-Daudé <phi...@linaro.org>
> Cc: Daniel P. Berrangé <berra...@redhat.com>
> Cc: Vivek Kasireddy <vivek.kasire...@intel.com>
> Signed-off-by: Dongwon Kim <dongwon....@intel.com>
Reviewed-by: Marc-André Lureau <marcandre.lur...@redhat.com>
> ---
> include/ui/console.h | 20 +----
> include/ui/dmabuf.h | 66 ++++++++++++++
> ui/dmabuf.c | 210 +++++++++++++++++++++++++++++++++++++++++++
> ui/meson.build | 1 +
> 4 files changed, 278 insertions(+), 19 deletions(-)
> create mode 100644 include/ui/dmabuf.h
> create mode 100644 ui/dmabuf.c
>
> diff --git a/include/ui/console.h b/include/ui/console.h
> index 0bc7a00ac0..a208a68b88 100644
> --- a/include/ui/console.h
> +++ b/include/ui/console.h
> @@ -7,6 +7,7 @@
> #include "qapi/qapi-types-ui.h"
> #include "ui/input.h"
> #include "ui/surface.h"
> +#include "ui/dmabuf.h"
>
> #define TYPE_QEMU_CONSOLE "qemu-console"
> OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE)
> @@ -185,25 +186,6 @@ struct QEMUGLParams {
> int minor_ver;
> };
>
> -typedef struct QemuDmaBuf {
> - int fd;
> - uint32_t width;
> - uint32_t height;
> - uint32_t stride;
> - uint32_t fourcc;
> - uint64_t modifier;
> - uint32_t texture;
> - uint32_t x;
> - uint32_t y;
> - uint32_t backing_width;
> - uint32_t backing_height;
> - bool y0_top;
> - void *sync;
> - int fence_fd;
> - bool allow_fences;
> - bool draw_submitted;
> -} QemuDmaBuf;
> -
> enum display_scanout {
> SCANOUT_NONE,
> SCANOUT_SURFACE,
> diff --git a/include/ui/dmabuf.h b/include/ui/dmabuf.h
> new file mode 100644
> index 0000000000..4198cdf85a
> --- /dev/null
> +++ b/include/ui/dmabuf.h
> @@ -0,0 +1,66 @@
> +/*
> + * SPDX-License-Identifier: GPL-2.0-or-later
> + *
> + * QemuDmaBuf struct and helpers used for accessing its data
> + *
> + * This work is licensed under the terms of the GNU GPL, version 2 or later.
> + * See the COPYING file in the top-level directory.
> + */
> +
> +#ifndef DMABUF_H
> +#define DMABUF_H
> +
> +typedef struct QemuDmaBuf {
> + int fd;
> + uint32_t width;
> + uint32_t height;
> + uint32_t stride;
> + uint32_t fourcc;
> + uint64_t modifier;
> + uint32_t texture;
> + uint32_t x;
> + uint32_t y;
> + uint32_t backing_width;
> + uint32_t backing_height;
> + bool y0_top;
> + void *sync;
> + int fence_fd;
> + bool allow_fences;
> + bool draw_submitted;
> +} QemuDmaBuf;
> +
> +QemuDmaBuf *qemu_dmabuf_new(uint32_t width, uint32_t height,
> + uint32_t stride, uint32_t x,
> + uint32_t y, uint32_t backing_width,
> + uint32_t backing_height, uint32_t fourcc,
> + uint64_t modifier, int dmabuf_fd,
> + bool allow_fences, bool y0_top);
> +void qemu_dmabuf_free(QemuDmaBuf *dmabuf);
> +
> +G_DEFINE_AUTOPTR_CLEANUP_FUNC(QemuDmaBuf, qemu_dmabuf_free);
> +
> +int qemu_dmabuf_get_fd(QemuDmaBuf *dmabuf);
> +int qemu_dmabuf_dup_fd(QemuDmaBuf *dmabuf);
> +void qemu_dmabuf_close(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_width(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_height(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_stride(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_fourcc(QemuDmaBuf *dmabuf);
> +uint64_t qemu_dmabuf_get_modifier(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_texture(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_x(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_y(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_backing_width(QemuDmaBuf *dmabuf);
> +uint32_t qemu_dmabuf_get_backing_height(QemuDmaBuf *dmabuf);
> +bool qemu_dmabuf_get_y0_top(QemuDmaBuf *dmabuf);
> +void *qemu_dmabuf_get_sync(QemuDmaBuf *dmabuf);
> +int32_t qemu_dmabuf_get_fence_fd(QemuDmaBuf *dmabuf);
> +bool qemu_dmabuf_get_allow_fences(QemuDmaBuf *dmabuf);
> +bool qemu_dmabuf_get_draw_submitted(QemuDmaBuf *dmabuf);
> +void qemu_dmabuf_set_texture(QemuDmaBuf *dmabuf, uint32_t texture);
> +void qemu_dmabuf_set_fence_fd(QemuDmaBuf *dmabuf, int32_t fence_fd);
> +void qemu_dmabuf_set_sync(QemuDmaBuf *dmabuf, void *sync);
> +void qemu_dmabuf_set_draw_submitted(QemuDmaBuf *dmabuf, bool draw_submitted);
> +void qemu_dmabuf_set_fd(QemuDmaBuf *dmabuf, int32_t fd);
> +
> +#endif
> diff --git a/ui/dmabuf.c b/ui/dmabuf.c
> new file mode 100644
> index 0000000000..e047d5ca26
> --- /dev/null
> +++ b/ui/dmabuf.c
> @@ -0,0 +1,210 @@
> +/*
> + * SPDX-License-Identifier: GPL-2.0-or-later
> + *
> + * QemuDmaBuf struct and helpers used for accessing its data
> + *
> + * This work is licensed under the terms of the GNU GPL, version 2 or later.
> + * See the COPYING file in the top-level directory.
> + */
> +
> +#include "qemu/osdep.h"
> +#include "ui/dmabuf.h"
> +
> +QemuDmaBuf *qemu_dmabuf_new(uint32_t width, uint32_t height,
> + uint32_t stride, uint32_t x,
> + uint32_t y, uint32_t backing_width,
> + uint32_t backing_height, uint32_t fourcc,
> + uint64_t modifier, int32_t dmabuf_fd,
> + bool allow_fences, bool y0_top) {
> + QemuDmaBuf *dmabuf;
> +
> + dmabuf = g_new0(QemuDmaBuf, 1);
> +
> + dmabuf->width = width;
> + dmabuf->height = height;
> + dmabuf->stride = stride;
> + dmabuf->x = x;
> + dmabuf->y = y;
> + dmabuf->backing_width = backing_width;
> + dmabuf->backing_height = backing_height;
> + dmabuf->fourcc = fourcc;
> + dmabuf->modifier = modifier;
> + dmabuf->fd = dmabuf_fd;
> + dmabuf->allow_fences = allow_fences;
> + dmabuf->y0_top = y0_top;
> + dmabuf->fence_fd = -1;
> +
> + return dmabuf;
> +}
> +
> +void qemu_dmabuf_free(QemuDmaBuf *dmabuf)
> +{
> + if (dmabuf == NULL) {
> + return;
> + }
> +
> + g_free(dmabuf);
> +}
> +
> +int qemu_dmabuf_get_fd(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->fd;
> +}
> +
> +int qemu_dmabuf_dup_fd(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + if (dmabuf->fd >= 0) {
> + return dup(dmabuf->fd);
> + } else {
> + return -1;
> + }
> +}
> +
> +void qemu_dmabuf_close(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + if (dmabuf->fd >= 0) {
> + close(dmabuf->fd);
> + dmabuf->fd = -1;
> + }
> +}
> +
> +uint32_t qemu_dmabuf_get_width(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->width;
> +}
> +
> +uint32_t qemu_dmabuf_get_height(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->height;
> +}
> +
> +uint32_t qemu_dmabuf_get_stride(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->stride;
> +}
> +
> +uint32_t qemu_dmabuf_get_fourcc(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->fourcc;
> +}
> +
> +uint64_t qemu_dmabuf_get_modifier(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->modifier;
> +}
> +
> +uint32_t qemu_dmabuf_get_texture(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->texture;
> +}
> +
> +uint32_t qemu_dmabuf_get_x(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->x;
> +}
> +
> +uint32_t qemu_dmabuf_get_y(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->y;
> +}
> +
> +uint32_t qemu_dmabuf_get_backing_width(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->backing_width;
> +}
> +
> +uint32_t qemu_dmabuf_get_backing_height(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->backing_height;
> +}
> +
> +bool qemu_dmabuf_get_y0_top(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->y0_top;
> +}
> +
> +void *qemu_dmabuf_get_sync(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->sync;
> +}
> +
> +int32_t qemu_dmabuf_get_fence_fd(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->fence_fd;
> +}
> +
> +bool qemu_dmabuf_get_allow_fences(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->allow_fences;
> +}
> +
> +bool qemu_dmabuf_get_draw_submitted(QemuDmaBuf *dmabuf)
> +{
> + assert(dmabuf != NULL);
> +
> + return dmabuf->draw_submitted;
> +}
> +
> +void qemu_dmabuf_set_texture(QemuDmaBuf *dmabuf, uint32_t texture)
> +{
> + assert(dmabuf != NULL);
> + dmabuf->texture = texture;
> +}
> +
> +void qemu_dmabuf_set_fence_fd(QemuDmaBuf *dmabuf, int32_t fence_fd)
> +{
> + assert(dmabuf != NULL);
> + dmabuf->fence_fd = fence_fd;
> +}
> +
> +void qemu_dmabuf_set_sync(QemuDmaBuf *dmabuf, void *sync)
> +{
> + assert(dmabuf != NULL);
> + dmabuf->sync = sync;
> +}
> +
> +void qemu_dmabuf_set_draw_submitted(QemuDmaBuf *dmabuf, bool draw_submitted)
> +{
> + assert(dmabuf != NULL);
> + dmabuf->draw_submitted = draw_submitted;
> +}
> +
> +void qemu_dmabuf_set_fd(QemuDmaBuf *dmabuf, int32_t fd)
> +{
> + assert(dmabuf != NULL);
> + dmabuf->fd = fd;
> +}
> diff --git a/ui/meson.build b/ui/meson.build
> index a5ce22a678..5d89986b0e 100644
> --- a/ui/meson.build
> +++ b/ui/meson.build
> @@ -7,6 +7,7 @@ system_ss.add(files(
> 'clipboard.c',
> 'console.c',
> 'cursor.c',
> + 'dmabuf.c',
> 'input-keymap.c',
> 'input-legacy.c',
> 'input-barrier.c',
> --
> 2.34.1
>
