From 69c47717c2e0dfcc3a46f9c5d105f2fea0904d44 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Fri, 16 Sep 2022 18:32:22 +0200 Subject: [PATCH] buffer: split into multiple files wlr_buffer.c is difficult to read because it contains a mixed bag of unrelated things: base buffer type, buffer implementations, buffer resource factory, and client buffer. Split each of these into their own file. --- include/types/wlr_buffer.h | 3 + types/buffer/buffer.c | 125 ++++++++ types/buffer/client.c | 93 ++++++ types/buffer/dmabuf.c | 69 +++++ types/buffer/readonly_data.c | 87 ++++++ types/buffer/resource.c | 86 ++++++ types/buffer/shm_client.c | 125 ++++++++ types/meson.build | 7 +- types/wlr_buffer.c | 565 ----------------------------------- 9 files changed, 594 insertions(+), 566 deletions(-) create mode 100644 types/buffer/buffer.c create mode 100644 types/buffer/client.c create mode 100644 types/buffer/dmabuf.c create mode 100644 types/buffer/readonly_data.c create mode 100644 types/buffer/resource.c create mode 100644 types/buffer/shm_client.c delete mode 100644 types/wlr_buffer.c diff --git a/include/types/wlr_buffer.h b/include/types/wlr_buffer.h index e7097ae2..59d78e9c 100644 --- a/include/types/wlr_buffer.h +++ b/include/types/wlr_buffer.h @@ -22,6 +22,9 @@ struct wlr_shm_client_buffer { struct wl_listener release; }; +struct wlr_shm_client_buffer *shm_client_buffer_get_or_create( + struct wl_resource *resource); + /** * A read-only buffer that holds a data pointer. * diff --git a/types/buffer/buffer.c b/types/buffer/buffer.c new file mode 100644 index 00000000..28370aef --- /dev/null +++ b/types/buffer/buffer.c @@ -0,0 +1,125 @@ +#include +#include +#include +#include "render/pixel_format.h" +#include "types/wlr_buffer.h" + +void wlr_buffer_init(struct wlr_buffer *buffer, + const struct wlr_buffer_impl *impl, int width, int height) { + assert(impl->destroy); + if (impl->begin_data_ptr_access || impl->end_data_ptr_access) { + assert(impl->begin_data_ptr_access && impl->end_data_ptr_access); + } + + memset(buffer, 0, sizeof(*buffer)); + buffer->impl = impl; + buffer->width = width; + buffer->height = height; + wl_signal_init(&buffer->events.destroy); + wl_signal_init(&buffer->events.release); + wlr_addon_set_init(&buffer->addons); +} + +static void buffer_consider_destroy(struct wlr_buffer *buffer) { + if (!buffer->dropped || buffer->n_locks > 0) { + return; + } + + assert(!buffer->accessing_data_ptr); + + wl_signal_emit_mutable(&buffer->events.destroy, NULL); + wlr_addon_set_finish(&buffer->addons); + + buffer->impl->destroy(buffer); +} + +void wlr_buffer_drop(struct wlr_buffer *buffer) { + if (buffer == NULL) { + return; + } + + assert(!buffer->dropped); + buffer->dropped = true; + buffer_consider_destroy(buffer); +} + +struct wlr_buffer *wlr_buffer_lock(struct wlr_buffer *buffer) { + buffer->n_locks++; + return buffer; +} + +void wlr_buffer_unlock(struct wlr_buffer *buffer) { + if (buffer == NULL) { + return; + } + + assert(buffer->n_locks > 0); + buffer->n_locks--; + + if (buffer->n_locks == 0) { + wl_signal_emit_mutable(&buffer->events.release, NULL); + } + + buffer_consider_destroy(buffer); +} + +bool wlr_buffer_get_dmabuf(struct wlr_buffer *buffer, + struct wlr_dmabuf_attributes *attribs) { + if (!buffer->impl->get_dmabuf) { + return false; + } + return buffer->impl->get_dmabuf(buffer, attribs); +} + +bool wlr_buffer_begin_data_ptr_access(struct wlr_buffer *buffer, uint32_t flags, + void **data, uint32_t *format, size_t *stride) { + assert(!buffer->accessing_data_ptr); + if (!buffer->impl->begin_data_ptr_access) { + return false; + } + if (!buffer->impl->begin_data_ptr_access(buffer, flags, data, format, stride)) { + return false; + } + buffer->accessing_data_ptr = true; + return true; +} + +void wlr_buffer_end_data_ptr_access(struct wlr_buffer *buffer) { + assert(buffer->accessing_data_ptr); + buffer->impl->end_data_ptr_access(buffer); + buffer->accessing_data_ptr = false; +} + +bool wlr_buffer_get_shm(struct wlr_buffer *buffer, + struct wlr_shm_attributes *attribs) { + if (!buffer->impl->get_shm) { + return false; + } + return buffer->impl->get_shm(buffer, attribs); +} + +bool buffer_is_opaque(struct wlr_buffer *buffer) { + void *data; + uint32_t format; + size_t stride; + struct wlr_dmabuf_attributes dmabuf; + struct wlr_shm_attributes shm; + if (wlr_buffer_get_dmabuf(buffer, &dmabuf)) { + format = dmabuf.format; + } else if (wlr_buffer_get_shm(buffer, &shm)) { + format = shm.format; + } else if (wlr_buffer_begin_data_ptr_access(buffer, + WLR_BUFFER_DATA_PTR_ACCESS_READ, &data, &format, &stride)) { + wlr_buffer_end_data_ptr_access(buffer); + } else { + return false; + } + + const struct wlr_pixel_format_info *format_info = + drm_get_pixel_format_info(format); + if (format_info == NULL) { + return false; + } + + return !format_info->has_alpha; +} diff --git a/types/buffer/client.c b/types/buffer/client.c new file mode 100644 index 00000000..50c19691 --- /dev/null +++ b/types/buffer/client.c @@ -0,0 +1,93 @@ +#include +#include +#include +#include +#include +#include "types/wlr_buffer.h" + +static const struct wlr_buffer_impl client_buffer_impl; + +struct wlr_client_buffer *wlr_client_buffer_get(struct wlr_buffer *buffer) { + if (buffer->impl != &client_buffer_impl) { + return NULL; + } + return (struct wlr_client_buffer *)buffer; +} + +static struct wlr_client_buffer *client_buffer_from_buffer( + struct wlr_buffer *buffer) { + struct wlr_client_buffer *client_buffer = wlr_client_buffer_get(buffer); + assert(client_buffer != NULL); + return client_buffer; +} + +static void client_buffer_destroy(struct wlr_buffer *buffer) { + struct wlr_client_buffer *client_buffer = client_buffer_from_buffer(buffer); + wl_list_remove(&client_buffer->source_destroy.link); + wlr_texture_destroy(client_buffer->texture); + free(client_buffer); +} + +static bool client_buffer_get_dmabuf(struct wlr_buffer *buffer, + struct wlr_dmabuf_attributes *attribs) { + struct wlr_client_buffer *client_buffer = client_buffer_from_buffer(buffer); + + if (client_buffer->source == NULL) { + return false; + } + + return wlr_buffer_get_dmabuf(client_buffer->source, attribs); +} + +static const struct wlr_buffer_impl client_buffer_impl = { + .destroy = client_buffer_destroy, + .get_dmabuf = client_buffer_get_dmabuf, +}; + +static void client_buffer_handle_source_destroy(struct wl_listener *listener, + void *data) { + struct wlr_client_buffer *client_buffer = + wl_container_of(listener, client_buffer, source_destroy); + wl_list_remove(&client_buffer->source_destroy.link); + wl_list_init(&client_buffer->source_destroy.link); + client_buffer->source = NULL; +} + +struct wlr_client_buffer *wlr_client_buffer_create(struct wlr_buffer *buffer, + struct wlr_renderer *renderer) { + struct wlr_texture *texture = wlr_texture_from_buffer(renderer, buffer); + if (texture == NULL) { + wlr_log(WLR_ERROR, "Failed to create texture"); + return NULL; + } + + struct wlr_client_buffer *client_buffer = + calloc(1, sizeof(struct wlr_client_buffer)); + if (client_buffer == NULL) { + wlr_texture_destroy(texture); + return NULL; + } + wlr_buffer_init(&client_buffer->base, &client_buffer_impl, + texture->width, texture->height); + client_buffer->source = buffer; + client_buffer->texture = texture; + + wl_signal_add(&buffer->events.destroy, &client_buffer->source_destroy); + client_buffer->source_destroy.notify = client_buffer_handle_source_destroy; + + // Ensure the buffer will be released before being destroyed + wlr_buffer_lock(&client_buffer->base); + wlr_buffer_drop(&client_buffer->base); + + return client_buffer; +} + +bool wlr_client_buffer_apply_damage(struct wlr_client_buffer *client_buffer, + struct wlr_buffer *next, pixman_region32_t *damage) { + if (client_buffer->base.n_locks > 1) { + // Someone else still has a reference to the buffer + return false; + } + + return wlr_texture_update_from_buffer(client_buffer->texture, next, damage); +} diff --git a/types/buffer/dmabuf.c b/types/buffer/dmabuf.c new file mode 100644 index 00000000..b8340ac9 --- /dev/null +++ b/types/buffer/dmabuf.c @@ -0,0 +1,69 @@ +#include +#include +#include +#include +#include "types/wlr_buffer.h" + +static const struct wlr_buffer_impl dmabuf_buffer_impl; + +static struct wlr_dmabuf_buffer *dmabuf_buffer_from_buffer( + struct wlr_buffer *buffer) { + assert(buffer->impl == &dmabuf_buffer_impl); + return (struct wlr_dmabuf_buffer *)buffer; +} + +static void dmabuf_buffer_destroy(struct wlr_buffer *wlr_buffer) { + struct wlr_dmabuf_buffer *buffer = dmabuf_buffer_from_buffer(wlr_buffer); + if (buffer->saved) { + wlr_dmabuf_attributes_finish(&buffer->dmabuf); + } + free(buffer); +} + +static bool dmabuf_buffer_get_dmabuf(struct wlr_buffer *wlr_buffer, + struct wlr_dmabuf_attributes *dmabuf) { + struct wlr_dmabuf_buffer *buffer = dmabuf_buffer_from_buffer(wlr_buffer); + if (buffer->dmabuf.n_planes == 0) { + return false; + } + *dmabuf = buffer->dmabuf; + return true; +} + +static const struct wlr_buffer_impl dmabuf_buffer_impl = { + .destroy = dmabuf_buffer_destroy, + .get_dmabuf = dmabuf_buffer_get_dmabuf, +}; + +struct wlr_dmabuf_buffer *dmabuf_buffer_create( + struct wlr_dmabuf_attributes *dmabuf) { + struct wlr_dmabuf_buffer *buffer = calloc(1, sizeof(*buffer)); + if (buffer == NULL) { + return NULL; + } + wlr_buffer_init(&buffer->base, &dmabuf_buffer_impl, + dmabuf->width, dmabuf->height); + + buffer->dmabuf = *dmabuf; + + return buffer; +} + +bool dmabuf_buffer_drop(struct wlr_dmabuf_buffer *buffer) { + bool ok = true; + + if (buffer->base.n_locks > 0) { + struct wlr_dmabuf_attributes saved_dmabuf = {0}; + if (!wlr_dmabuf_attributes_copy(&saved_dmabuf, &buffer->dmabuf)) { + wlr_log(WLR_ERROR, "Failed to save DMA-BUF"); + ok = false; + memset(&buffer->dmabuf, 0, sizeof(buffer->dmabuf)); + } else { + buffer->dmabuf = saved_dmabuf; + buffer->saved = true; + } + } + + wlr_buffer_drop(&buffer->base); + return ok; +} diff --git a/types/buffer/readonly_data.c b/types/buffer/readonly_data.c new file mode 100644 index 00000000..205c12ce --- /dev/null +++ b/types/buffer/readonly_data.c @@ -0,0 +1,87 @@ +#include +#include +#include +#include +#include +#include "types/wlr_buffer.h" + +static const struct wlr_buffer_impl readonly_data_buffer_impl; + +static struct wlr_readonly_data_buffer *readonly_data_buffer_from_buffer( + struct wlr_buffer *buffer) { + assert(buffer->impl == &readonly_data_buffer_impl); + return (struct wlr_readonly_data_buffer *)buffer; +} + +static void readonly_data_buffer_destroy(struct wlr_buffer *wlr_buffer) { + struct wlr_readonly_data_buffer *buffer = + readonly_data_buffer_from_buffer(wlr_buffer); + free(buffer->saved_data); + free(buffer); +} + +static bool readonly_data_buffer_begin_data_ptr_access(struct wlr_buffer *wlr_buffer, + uint32_t flags, void **data, uint32_t *format, size_t *stride) { + struct wlr_readonly_data_buffer *buffer = + readonly_data_buffer_from_buffer(wlr_buffer); + if (buffer->data == NULL) { + return false; + } + if (flags & WLR_BUFFER_DATA_PTR_ACCESS_WRITE) { + return false; + } + *data = (void *)buffer->data; + *format = buffer->format; + *stride = buffer->stride; + return true; +} + +static void readonly_data_buffer_end_data_ptr_access(struct wlr_buffer *wlr_buffer) { + // This space is intentionally left blank +} + +static const struct wlr_buffer_impl readonly_data_buffer_impl = { + .destroy = readonly_data_buffer_destroy, + .begin_data_ptr_access = readonly_data_buffer_begin_data_ptr_access, + .end_data_ptr_access = readonly_data_buffer_end_data_ptr_access, +}; + +struct wlr_readonly_data_buffer *readonly_data_buffer_create(uint32_t format, + size_t stride, uint32_t width, uint32_t height, const void *data) { + struct wlr_readonly_data_buffer *buffer = calloc(1, sizeof(*buffer)); + if (buffer == NULL) { + return NULL; + } + wlr_buffer_init(&buffer->base, &readonly_data_buffer_impl, width, height); + + buffer->data = data; + buffer->format = format; + buffer->stride = stride; + + return buffer; +} + +bool readonly_data_buffer_drop(struct wlr_readonly_data_buffer *buffer) { + bool ok = true; + + if (buffer->base.n_locks > 0) { + size_t size = buffer->stride * buffer->base.height; + buffer->saved_data = malloc(size); + if (buffer->saved_data == NULL) { + wlr_log_errno(WLR_ERROR, "Allocation failed"); + ok = false; + buffer->data = NULL; + // We can't destroy the buffer, or we risk use-after-free in the + // consumers. We can't allow accesses to buffer->data anymore, so + // set it to NULL and make subsequent begin_data_ptr_access() + // calls fail. + } else { + memcpy(buffer->saved_data, buffer->data, size); + buffer->data = buffer->saved_data; + } + } + + wlr_buffer_drop(&buffer->base); + return ok; +} + diff --git a/types/buffer/resource.c b/types/buffer/resource.c new file mode 100644 index 00000000..14d315fb --- /dev/null +++ b/types/buffer/resource.c @@ -0,0 +1,86 @@ +#include +#include +#include +#include +#include +#include +#include +#include "types/wlr_buffer.h" + +bool wlr_resource_is_buffer(struct wl_resource *resource) { + return strcmp(wl_resource_get_class(resource), wl_buffer_interface.name) == 0; +} + +/* struct wlr_buffer_resource_interface */ +static struct wl_array buffer_resource_interfaces = {0}; + +void wlr_buffer_register_resource_interface( + const struct wlr_buffer_resource_interface *iface) { + assert(iface); + assert(iface->is_instance); + assert(iface->from_resource); + + const struct wlr_buffer_resource_interface **iface_ptr; + wl_array_for_each(iface_ptr, &buffer_resource_interfaces) { + if (*iface_ptr == iface) { + wlr_log(WLR_DEBUG, "wlr_resource_buffer_interface %s has already" + "been registered", iface->name); + return; + } + } + + iface_ptr = wl_array_add(&buffer_resource_interfaces, sizeof(iface)); + *iface_ptr = iface; +} + +static const struct wlr_buffer_resource_interface *get_buffer_resource_iface( + struct wl_resource *resource) { + struct wlr_buffer_resource_interface **iface_ptr; + wl_array_for_each(iface_ptr, &buffer_resource_interfaces) { + if ((*iface_ptr)->is_instance(resource)) { + return *iface_ptr; + } + } + + return NULL; +} + +struct wlr_buffer *wlr_buffer_from_resource(struct wl_resource *resource) { + assert(resource && wlr_resource_is_buffer(resource)); + + struct wlr_buffer *buffer; + if (wl_shm_buffer_get(resource) != NULL) { + struct wlr_shm_client_buffer *shm_client_buffer = + shm_client_buffer_get_or_create(resource); + if (shm_client_buffer == NULL) { + wlr_log(WLR_ERROR, "Failed to create shm client buffer"); + return NULL; + } + buffer = wlr_buffer_lock(&shm_client_buffer->base); + } else if (wlr_dmabuf_v1_resource_is_buffer(resource)) { + struct wlr_dmabuf_v1_buffer *dmabuf = + wlr_dmabuf_v1_buffer_from_buffer_resource(resource); + buffer = wlr_buffer_lock(&dmabuf->base); + } else if (wlr_drm_buffer_is_resource(resource)) { + struct wlr_drm_buffer *drm_buffer = + wlr_drm_buffer_from_resource(resource); + buffer = wlr_buffer_lock(&drm_buffer->base); + } else { + const struct wlr_buffer_resource_interface *iface = + get_buffer_resource_iface(resource); + if (!iface) { + wlr_log(WLR_ERROR, "Unknown buffer type"); + return NULL; + } + + struct wlr_buffer *custom_buffer = iface->from_resource(resource); + if (!custom_buffer) { + wlr_log(WLR_ERROR, "Failed to create %s buffer", iface->name); + return NULL; + } + + buffer = wlr_buffer_lock(custom_buffer); + } + + return buffer; +} diff --git a/types/buffer/shm_client.c b/types/buffer/shm_client.c new file mode 100644 index 00000000..55f2dea2 --- /dev/null +++ b/types/buffer/shm_client.c @@ -0,0 +1,125 @@ +#include +#include +#include +#include +#include "render/pixel_format.h" +#include "types/wlr_buffer.h" + +static const struct wlr_buffer_impl shm_client_buffer_impl; + +static bool buffer_is_shm_client_buffer(struct wlr_buffer *buffer) { + return buffer->impl == &shm_client_buffer_impl; +} + +static struct wlr_shm_client_buffer *shm_client_buffer_from_buffer( + struct wlr_buffer *buffer) { + assert(buffer_is_shm_client_buffer(buffer)); + return (struct wlr_shm_client_buffer *)buffer; +} + +static void shm_client_buffer_destroy(struct wlr_buffer *wlr_buffer) { + struct wlr_shm_client_buffer *buffer = + shm_client_buffer_from_buffer(wlr_buffer); + wl_list_remove(&buffer->resource_destroy.link); + wl_list_remove(&buffer->release.link); + if (buffer->saved_shm_pool != NULL) { + wl_shm_pool_unref(buffer->saved_shm_pool); + } + free(buffer); +} + +static bool shm_client_buffer_begin_data_ptr_access(struct wlr_buffer *wlr_buffer, + uint32_t flags, void **data, uint32_t *format, size_t *stride) { + struct wlr_shm_client_buffer *buffer = + shm_client_buffer_from_buffer(wlr_buffer); + *format = buffer->format; + *stride = buffer->stride; + if (buffer->shm_buffer != NULL) { + *data = wl_shm_buffer_get_data(buffer->shm_buffer); + wl_shm_buffer_begin_access(buffer->shm_buffer); + } else { + *data = buffer->saved_data; + } + return true; +} + +static void shm_client_buffer_end_data_ptr_access(struct wlr_buffer *wlr_buffer) { + struct wlr_shm_client_buffer *buffer = + shm_client_buffer_from_buffer(wlr_buffer); + if (buffer->shm_buffer != NULL) { + wl_shm_buffer_end_access(buffer->shm_buffer); + } +} + +static const struct wlr_buffer_impl shm_client_buffer_impl = { + .destroy = shm_client_buffer_destroy, + .begin_data_ptr_access = shm_client_buffer_begin_data_ptr_access, + .end_data_ptr_access = shm_client_buffer_end_data_ptr_access, +}; + +static void shm_client_buffer_resource_handle_destroy( + struct wl_listener *listener, void *data) { + struct wlr_shm_client_buffer *buffer = + wl_container_of(listener, buffer, resource_destroy); + + // In order to still be able to access the shared memory region, we need to + // keep a reference to the wl_shm_pool + buffer->saved_shm_pool = wl_shm_buffer_ref_pool(buffer->shm_buffer); + buffer->saved_data = wl_shm_buffer_get_data(buffer->shm_buffer); + + // The wl_shm_buffer destroys itself with the wl_resource + buffer->resource = NULL; + buffer->shm_buffer = NULL; + wl_list_remove(&buffer->resource_destroy.link); + wl_list_init(&buffer->resource_destroy.link); + + // This might destroy the buffer + wlr_buffer_drop(&buffer->base); +} + +static void shm_client_buffer_handle_release(struct wl_listener *listener, + void *data) { + struct wlr_shm_client_buffer *buffer = + wl_container_of(listener, buffer, release); + if (buffer->resource != NULL) { + wl_buffer_send_release(buffer->resource); + } +} + +struct wlr_shm_client_buffer *shm_client_buffer_get_or_create( + struct wl_resource *resource) { + struct wl_shm_buffer *shm_buffer = wl_shm_buffer_get(resource); + assert(shm_buffer != NULL); + + struct wl_listener *resource_destroy_listener = + wl_resource_get_destroy_listener(resource, + shm_client_buffer_resource_handle_destroy); + if (resource_destroy_listener != NULL) { + struct wlr_shm_client_buffer *buffer = + wl_container_of(resource_destroy_listener, buffer, resource_destroy); + return buffer; + } + + int32_t width = wl_shm_buffer_get_width(shm_buffer); + int32_t height = wl_shm_buffer_get_height(shm_buffer); + + struct wlr_shm_client_buffer *buffer = calloc(1, sizeof(*buffer)); + if (buffer == NULL) { + return NULL; + } + wlr_buffer_init(&buffer->base, &shm_client_buffer_impl, width, height); + buffer->resource = resource; + buffer->shm_buffer = shm_buffer; + + enum wl_shm_format wl_shm_format = wl_shm_buffer_get_format(shm_buffer); + buffer->format = convert_wl_shm_format_to_drm(wl_shm_format); + buffer->stride = wl_shm_buffer_get_stride(shm_buffer); + + buffer->resource_destroy.notify = shm_client_buffer_resource_handle_destroy; + wl_resource_add_destroy_listener(resource, &buffer->resource_destroy); + + buffer->release.notify = shm_client_buffer_handle_release; + wl_signal_add(&buffer->base.events.release, &buffer->release); + + return buffer; +} diff --git a/types/meson.build b/types/meson.build index 19360eb7..f7c24e12 100644 --- a/types/meson.build +++ b/types/meson.build @@ -27,7 +27,12 @@ wlr_files += files( 'xdg_shell/wlr_xdg_shell.c', 'xdg_shell/wlr_xdg_surface.c', 'xdg_shell/wlr_xdg_toplevel.c', - 'wlr_buffer.c', + 'buffer/buffer.c', + 'buffer/client.c', + 'buffer/dmabuf.c', + 'buffer/readonly_data.c', + 'buffer/resource.c', + 'buffer/shm_client.c', 'wlr_compositor.c', 'wlr_cursor.c', 'wlr_damage_ring.c', diff --git a/types/wlr_buffer.c b/types/wlr_buffer.c deleted file mode 100644 index 90bc40a8..00000000 --- a/types/wlr_buffer.c +++ /dev/null @@ -1,565 +0,0 @@ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "render/pixel_format.h" -#include "types/wlr_buffer.h" - -void wlr_buffer_init(struct wlr_buffer *buffer, - const struct wlr_buffer_impl *impl, int width, int height) { - assert(impl->destroy); - if (impl->begin_data_ptr_access || impl->end_data_ptr_access) { - assert(impl->begin_data_ptr_access && impl->end_data_ptr_access); - } - - memset(buffer, 0, sizeof(*buffer)); - buffer->impl = impl; - buffer->width = width; - buffer->height = height; - wl_signal_init(&buffer->events.destroy); - wl_signal_init(&buffer->events.release); - wlr_addon_set_init(&buffer->addons); -} - -static void buffer_consider_destroy(struct wlr_buffer *buffer) { - if (!buffer->dropped || buffer->n_locks > 0) { - return; - } - - assert(!buffer->accessing_data_ptr); - - wl_signal_emit_mutable(&buffer->events.destroy, NULL); - wlr_addon_set_finish(&buffer->addons); - - buffer->impl->destroy(buffer); -} - -void wlr_buffer_drop(struct wlr_buffer *buffer) { - if (buffer == NULL) { - return; - } - - assert(!buffer->dropped); - buffer->dropped = true; - buffer_consider_destroy(buffer); -} - -struct wlr_buffer *wlr_buffer_lock(struct wlr_buffer *buffer) { - buffer->n_locks++; - return buffer; -} - -void wlr_buffer_unlock(struct wlr_buffer *buffer) { - if (buffer == NULL) { - return; - } - - assert(buffer->n_locks > 0); - buffer->n_locks--; - - if (buffer->n_locks == 0) { - wl_signal_emit_mutable(&buffer->events.release, NULL); - } - - buffer_consider_destroy(buffer); -} - -bool wlr_buffer_get_dmabuf(struct wlr_buffer *buffer, - struct wlr_dmabuf_attributes *attribs) { - if (!buffer->impl->get_dmabuf) { - return false; - } - return buffer->impl->get_dmabuf(buffer, attribs); -} - -bool wlr_buffer_begin_data_ptr_access(struct wlr_buffer *buffer, uint32_t flags, - void **data, uint32_t *format, size_t *stride) { - assert(!buffer->accessing_data_ptr); - if (!buffer->impl->begin_data_ptr_access) { - return false; - } - if (!buffer->impl->begin_data_ptr_access(buffer, flags, data, format, stride)) { - return false; - } - buffer->accessing_data_ptr = true; - return true; -} - -void wlr_buffer_end_data_ptr_access(struct wlr_buffer *buffer) { - assert(buffer->accessing_data_ptr); - buffer->impl->end_data_ptr_access(buffer); - buffer->accessing_data_ptr = false; -} - -bool wlr_buffer_get_shm(struct wlr_buffer *buffer, - struct wlr_shm_attributes *attribs) { - if (!buffer->impl->get_shm) { - return false; - } - return buffer->impl->get_shm(buffer, attribs); -} - -bool wlr_resource_is_buffer(struct wl_resource *resource) { - return strcmp(wl_resource_get_class(resource), wl_buffer_interface.name) == 0; -} - -static const struct wlr_buffer_impl client_buffer_impl; - -struct wlr_client_buffer *wlr_client_buffer_get(struct wlr_buffer *buffer) { - if (buffer->impl != &client_buffer_impl) { - return NULL; - } - return (struct wlr_client_buffer *)buffer; -} - -static struct wlr_client_buffer *client_buffer_from_buffer( - struct wlr_buffer *buffer) { - struct wlr_client_buffer *client_buffer = wlr_client_buffer_get(buffer); - assert(client_buffer != NULL); - return client_buffer; -} - -static void client_buffer_destroy(struct wlr_buffer *buffer) { - struct wlr_client_buffer *client_buffer = client_buffer_from_buffer(buffer); - wl_list_remove(&client_buffer->source_destroy.link); - wlr_texture_destroy(client_buffer->texture); - free(client_buffer); -} - -static bool client_buffer_get_dmabuf(struct wlr_buffer *buffer, - struct wlr_dmabuf_attributes *attribs) { - struct wlr_client_buffer *client_buffer = client_buffer_from_buffer(buffer); - - if (client_buffer->source == NULL) { - return false; - } - - return wlr_buffer_get_dmabuf(client_buffer->source, attribs); -} - -static const struct wlr_buffer_impl client_buffer_impl = { - .destroy = client_buffer_destroy, - .get_dmabuf = client_buffer_get_dmabuf, -}; - -static void client_buffer_handle_source_destroy(struct wl_listener *listener, - void *data) { - struct wlr_client_buffer *client_buffer = - wl_container_of(listener, client_buffer, source_destroy); - wl_list_remove(&client_buffer->source_destroy.link); - wl_list_init(&client_buffer->source_destroy.link); - client_buffer->source = NULL; -} - -static struct wlr_shm_client_buffer *shm_client_buffer_get_or_create( - struct wl_resource *resource); -static bool buffer_is_shm_client_buffer(struct wlr_buffer *buffer); -static struct wlr_shm_client_buffer *shm_client_buffer_from_buffer( - struct wlr_buffer *buffer); - -/* struct wlr_buffer_resource_interface */ -static struct wl_array buffer_resource_interfaces = {0}; - -void wlr_buffer_register_resource_interface( - const struct wlr_buffer_resource_interface *iface) { - assert(iface); - assert(iface->is_instance); - assert(iface->from_resource); - - const struct wlr_buffer_resource_interface **iface_ptr; - wl_array_for_each(iface_ptr, &buffer_resource_interfaces) { - if (*iface_ptr == iface) { - wlr_log(WLR_DEBUG, "wlr_resource_buffer_interface %s has already" - "been registered", iface->name); - return; - } - } - - iface_ptr = wl_array_add(&buffer_resource_interfaces, sizeof(iface)); - *iface_ptr = iface; -} - -static const struct wlr_buffer_resource_interface *get_buffer_resource_iface( - struct wl_resource *resource) { - struct wlr_buffer_resource_interface **iface_ptr; - wl_array_for_each(iface_ptr, &buffer_resource_interfaces) { - if ((*iface_ptr)->is_instance(resource)) { - return *iface_ptr; - } - } - - return NULL; -} - -struct wlr_buffer *wlr_buffer_from_resource(struct wl_resource *resource) { - assert(resource && wlr_resource_is_buffer(resource)); - - struct wlr_buffer *buffer; - if (wl_shm_buffer_get(resource) != NULL) { - struct wlr_shm_client_buffer *shm_client_buffer = - shm_client_buffer_get_or_create(resource); - if (shm_client_buffer == NULL) { - wlr_log(WLR_ERROR, "Failed to create shm client buffer"); - return NULL; - } - buffer = wlr_buffer_lock(&shm_client_buffer->base); - } else if (wlr_dmabuf_v1_resource_is_buffer(resource)) { - struct wlr_dmabuf_v1_buffer *dmabuf = - wlr_dmabuf_v1_buffer_from_buffer_resource(resource); - buffer = wlr_buffer_lock(&dmabuf->base); - } else if (wlr_drm_buffer_is_resource(resource)) { - struct wlr_drm_buffer *drm_buffer = - wlr_drm_buffer_from_resource(resource); - buffer = wlr_buffer_lock(&drm_buffer->base); - } else { - const struct wlr_buffer_resource_interface *iface = - get_buffer_resource_iface(resource); - if (!iface) { - wlr_log(WLR_ERROR, "Unknown buffer type"); - return NULL; - } - - struct wlr_buffer *custom_buffer = iface->from_resource(resource); - if (!custom_buffer) { - wlr_log(WLR_ERROR, "Failed to create %s buffer", iface->name); - return NULL; - } - - buffer = wlr_buffer_lock(custom_buffer); - } - - return buffer; -} - -bool buffer_is_opaque(struct wlr_buffer *buffer) { - void *data; - uint32_t format; - size_t stride; - struct wlr_dmabuf_attributes dmabuf; - struct wlr_shm_attributes shm; - if (wlr_buffer_get_dmabuf(buffer, &dmabuf)) { - format = dmabuf.format; - } else if (wlr_buffer_get_shm(buffer, &shm)) { - format = shm.format; - } else if (wlr_buffer_begin_data_ptr_access(buffer, - WLR_BUFFER_DATA_PTR_ACCESS_READ, &data, &format, &stride)) { - wlr_buffer_end_data_ptr_access(buffer); - } else { - return false; - } - - const struct wlr_pixel_format_info *format_info = - drm_get_pixel_format_info(format); - if (format_info == NULL) { - return false; - } - - return !format_info->has_alpha; -} - -struct wlr_client_buffer *wlr_client_buffer_create(struct wlr_buffer *buffer, - struct wlr_renderer *renderer) { - struct wlr_texture *texture = wlr_texture_from_buffer(renderer, buffer); - if (texture == NULL) { - wlr_log(WLR_ERROR, "Failed to create texture"); - return NULL; - } - - struct wlr_client_buffer *client_buffer = - calloc(1, sizeof(struct wlr_client_buffer)); - if (client_buffer == NULL) { - wlr_texture_destroy(texture); - return NULL; - } - wlr_buffer_init(&client_buffer->base, &client_buffer_impl, - texture->width, texture->height); - client_buffer->source = buffer; - client_buffer->texture = texture; - - wl_signal_add(&buffer->events.destroy, &client_buffer->source_destroy); - client_buffer->source_destroy.notify = client_buffer_handle_source_destroy; - - // Ensure the buffer will be released before being destroyed - wlr_buffer_lock(&client_buffer->base); - wlr_buffer_drop(&client_buffer->base); - - return client_buffer; -} - -bool wlr_client_buffer_apply_damage(struct wlr_client_buffer *client_buffer, - struct wlr_buffer *next, pixman_region32_t *damage) { - if (client_buffer->base.n_locks > 1) { - // Someone else still has a reference to the buffer - return false; - } - - return wlr_texture_update_from_buffer(client_buffer->texture, next, damage); -} - -static const struct wlr_buffer_impl shm_client_buffer_impl; - -static bool buffer_is_shm_client_buffer(struct wlr_buffer *buffer) { - return buffer->impl == &shm_client_buffer_impl; -} - -static struct wlr_shm_client_buffer *shm_client_buffer_from_buffer( - struct wlr_buffer *buffer) { - assert(buffer_is_shm_client_buffer(buffer)); - return (struct wlr_shm_client_buffer *)buffer; -} - -static void shm_client_buffer_destroy(struct wlr_buffer *wlr_buffer) { - struct wlr_shm_client_buffer *buffer = - shm_client_buffer_from_buffer(wlr_buffer); - wl_list_remove(&buffer->resource_destroy.link); - wl_list_remove(&buffer->release.link); - if (buffer->saved_shm_pool != NULL) { - wl_shm_pool_unref(buffer->saved_shm_pool); - } - free(buffer); -} - -static bool shm_client_buffer_begin_data_ptr_access(struct wlr_buffer *wlr_buffer, - uint32_t flags, void **data, uint32_t *format, size_t *stride) { - struct wlr_shm_client_buffer *buffer = - shm_client_buffer_from_buffer(wlr_buffer); - *format = buffer->format; - *stride = buffer->stride; - if (buffer->shm_buffer != NULL) { - *data = wl_shm_buffer_get_data(buffer->shm_buffer); - wl_shm_buffer_begin_access(buffer->shm_buffer); - } else { - *data = buffer->saved_data; - } - return true; -} - -static void shm_client_buffer_end_data_ptr_access(struct wlr_buffer *wlr_buffer) { - struct wlr_shm_client_buffer *buffer = - shm_client_buffer_from_buffer(wlr_buffer); - if (buffer->shm_buffer != NULL) { - wl_shm_buffer_end_access(buffer->shm_buffer); - } -} - -static const struct wlr_buffer_impl shm_client_buffer_impl = { - .destroy = shm_client_buffer_destroy, - .begin_data_ptr_access = shm_client_buffer_begin_data_ptr_access, - .end_data_ptr_access = shm_client_buffer_end_data_ptr_access, -}; - -static void shm_client_buffer_resource_handle_destroy( - struct wl_listener *listener, void *data) { - struct wlr_shm_client_buffer *buffer = - wl_container_of(listener, buffer, resource_destroy); - - // In order to still be able to access the shared memory region, we need to - // keep a reference to the wl_shm_pool - buffer->saved_shm_pool = wl_shm_buffer_ref_pool(buffer->shm_buffer); - buffer->saved_data = wl_shm_buffer_get_data(buffer->shm_buffer); - - // The wl_shm_buffer destroys itself with the wl_resource - buffer->resource = NULL; - buffer->shm_buffer = NULL; - wl_list_remove(&buffer->resource_destroy.link); - wl_list_init(&buffer->resource_destroy.link); - - // This might destroy the buffer - wlr_buffer_drop(&buffer->base); -} - -static void shm_client_buffer_handle_release(struct wl_listener *listener, - void *data) { - struct wlr_shm_client_buffer *buffer = - wl_container_of(listener, buffer, release); - if (buffer->resource != NULL) { - wl_buffer_send_release(buffer->resource); - } -} - -static struct wlr_shm_client_buffer *shm_client_buffer_get_or_create( - struct wl_resource *resource) { - struct wl_shm_buffer *shm_buffer = wl_shm_buffer_get(resource); - assert(shm_buffer != NULL); - - struct wl_listener *resource_destroy_listener = - wl_resource_get_destroy_listener(resource, - shm_client_buffer_resource_handle_destroy); - if (resource_destroy_listener != NULL) { - struct wlr_shm_client_buffer *buffer = - wl_container_of(resource_destroy_listener, buffer, resource_destroy); - return buffer; - } - - int32_t width = wl_shm_buffer_get_width(shm_buffer); - int32_t height = wl_shm_buffer_get_height(shm_buffer); - - struct wlr_shm_client_buffer *buffer = calloc(1, sizeof(*buffer)); - if (buffer == NULL) { - return NULL; - } - wlr_buffer_init(&buffer->base, &shm_client_buffer_impl, width, height); - buffer->resource = resource; - buffer->shm_buffer = shm_buffer; - - enum wl_shm_format wl_shm_format = wl_shm_buffer_get_format(shm_buffer); - buffer->format = convert_wl_shm_format_to_drm(wl_shm_format); - buffer->stride = wl_shm_buffer_get_stride(shm_buffer); - - buffer->resource_destroy.notify = shm_client_buffer_resource_handle_destroy; - wl_resource_add_destroy_listener(resource, &buffer->resource_destroy); - - buffer->release.notify = shm_client_buffer_handle_release; - wl_signal_add(&buffer->base.events.release, &buffer->release); - - return buffer; -} - -static const struct wlr_buffer_impl readonly_data_buffer_impl; - -static struct wlr_readonly_data_buffer *readonly_data_buffer_from_buffer( - struct wlr_buffer *buffer) { - assert(buffer->impl == &readonly_data_buffer_impl); - return (struct wlr_readonly_data_buffer *)buffer; -} - -static void readonly_data_buffer_destroy(struct wlr_buffer *wlr_buffer) { - struct wlr_readonly_data_buffer *buffer = - readonly_data_buffer_from_buffer(wlr_buffer); - free(buffer->saved_data); - free(buffer); -} - -static bool readonly_data_buffer_begin_data_ptr_access(struct wlr_buffer *wlr_buffer, - uint32_t flags, void **data, uint32_t *format, size_t *stride) { - struct wlr_readonly_data_buffer *buffer = - readonly_data_buffer_from_buffer(wlr_buffer); - if (buffer->data == NULL) { - return false; - } - if (flags & WLR_BUFFER_DATA_PTR_ACCESS_WRITE) { - return false; - } - *data = (void *)buffer->data; - *format = buffer->format; - *stride = buffer->stride; - return true; -} - -static void readonly_data_buffer_end_data_ptr_access(struct wlr_buffer *wlr_buffer) { - // This space is intentionally left blank -} - -static const struct wlr_buffer_impl readonly_data_buffer_impl = { - .destroy = readonly_data_buffer_destroy, - .begin_data_ptr_access = readonly_data_buffer_begin_data_ptr_access, - .end_data_ptr_access = readonly_data_buffer_end_data_ptr_access, -}; - -struct wlr_readonly_data_buffer *readonly_data_buffer_create(uint32_t format, - size_t stride, uint32_t width, uint32_t height, const void *data) { - struct wlr_readonly_data_buffer *buffer = calloc(1, sizeof(*buffer)); - if (buffer == NULL) { - return NULL; - } - wlr_buffer_init(&buffer->base, &readonly_data_buffer_impl, width, height); - - buffer->data = data; - buffer->format = format; - buffer->stride = stride; - - return buffer; -} - -bool readonly_data_buffer_drop(struct wlr_readonly_data_buffer *buffer) { - bool ok = true; - - if (buffer->base.n_locks > 0) { - size_t size = buffer->stride * buffer->base.height; - buffer->saved_data = malloc(size); - if (buffer->saved_data == NULL) { - wlr_log_errno(WLR_ERROR, "Allocation failed"); - ok = false; - buffer->data = NULL; - // We can't destroy the buffer, or we risk use-after-free in the - // consumers. We can't allow accesses to buffer->data anymore, so - // set it to NULL and make subsequent begin_data_ptr_access() - // calls fail. - } else { - memcpy(buffer->saved_data, buffer->data, size); - buffer->data = buffer->saved_data; - } - } - - wlr_buffer_drop(&buffer->base); - return ok; -} - -static const struct wlr_buffer_impl dmabuf_buffer_impl; - -static struct wlr_dmabuf_buffer *dmabuf_buffer_from_buffer( - struct wlr_buffer *buffer) { - assert(buffer->impl == &dmabuf_buffer_impl); - return (struct wlr_dmabuf_buffer *)buffer; -} - -static void dmabuf_buffer_destroy(struct wlr_buffer *wlr_buffer) { - struct wlr_dmabuf_buffer *buffer = dmabuf_buffer_from_buffer(wlr_buffer); - if (buffer->saved) { - wlr_dmabuf_attributes_finish(&buffer->dmabuf); - } - free(buffer); -} - -static bool dmabuf_buffer_get_dmabuf(struct wlr_buffer *wlr_buffer, - struct wlr_dmabuf_attributes *dmabuf) { - struct wlr_dmabuf_buffer *buffer = dmabuf_buffer_from_buffer(wlr_buffer); - if (buffer->dmabuf.n_planes == 0) { - return false; - } - *dmabuf = buffer->dmabuf; - return true; -} - -static const struct wlr_buffer_impl dmabuf_buffer_impl = { - .destroy = dmabuf_buffer_destroy, - .get_dmabuf = dmabuf_buffer_get_dmabuf, -}; - -struct wlr_dmabuf_buffer *dmabuf_buffer_create( - struct wlr_dmabuf_attributes *dmabuf) { - struct wlr_dmabuf_buffer *buffer = calloc(1, sizeof(*buffer)); - if (buffer == NULL) { - return NULL; - } - wlr_buffer_init(&buffer->base, &dmabuf_buffer_impl, - dmabuf->width, dmabuf->height); - - buffer->dmabuf = *dmabuf; - - return buffer; -} - -bool dmabuf_buffer_drop(struct wlr_dmabuf_buffer *buffer) { - bool ok = true; - - if (buffer->base.n_locks > 0) { - struct wlr_dmabuf_attributes saved_dmabuf = {0}; - if (!wlr_dmabuf_attributes_copy(&saved_dmabuf, &buffer->dmabuf)) { - wlr_log(WLR_ERROR, "Failed to save DMA-BUF"); - ok = false; - memset(&buffer->dmabuf, 0, sizeof(buffer->dmabuf)); - } else { - buffer->dmabuf = saved_dmabuf; - buffer->saved = true; - } - } - - wlr_buffer_drop(&buffer->base); - return ok; -}