From c03838dbc8cc4a85cfc93914493a0f1562a53366 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 26 Oct 2022 14:05:33 +1100 Subject: GHOST/Wayland: postpone reading from the clipboard until needed A copy of the clipboard was always being, changes would re-read it. Now read the clipboard on request. This avoids having to keep a copy of the clipboard in memory as well as the need to keep a thread to running to read the clipboard for each data-offer. --- intern/ghost/intern/GHOST_SystemWayland.cpp | 227 ++++++++++++++++------------ intern/ghost/intern/GHOST_SystemWayland.h | 3 - 2 files changed, 128 insertions(+), 102 deletions(-) diff --git a/intern/ghost/intern/GHOST_SystemWayland.cpp b/intern/ghost/intern/GHOST_SystemWayland.cpp index 87e5f9bb8d5..892d15254a2 100644 --- a/intern/ghost/intern/GHOST_SystemWayland.cpp +++ b/intern/ghost/intern/GHOST_SystemWayland.cpp @@ -280,9 +280,9 @@ static void gwl_simple_buffer_free_data(GWL_SimpleBuffer *buffer) buffer->data_size = 0; } -static void gwl_simple_buffer_set_and_take_ownership(GWL_SimpleBuffer *buffer, - const char *data, - size_t data_size) +[[maybe_unused]] static void gwl_simple_buffer_set_and_take_ownership(GWL_SimpleBuffer *buffer, + const char *data, + size_t data_size) { free(const_cast(buffer->data)); buffer->data = data; @@ -298,7 +298,7 @@ static void gwl_simple_buffer_set_from_string(GWL_SimpleBuffer *buffer, const ch buffer->data = data; } -static char *gwl_simple_buffer_as_string(const GWL_SimpleBuffer *buffer) +[[maybe_unused]] static char *gwl_simple_buffer_as_string(const GWL_SimpleBuffer *buffer) { char *buffer_str = static_cast(malloc(buffer->data_size + 1)); memcpy(buffer_str, buffer->data, buffer->data_size); @@ -798,10 +798,6 @@ struct GWL_Display { struct zwp_pointer_gestures_v1 *wp_pointer_gestures = nullptr; struct zwp_primary_selection_device_manager_v1 *wp_primary_selection_device_manager = nullptr; - - GWL_SimpleBuffer clipboard; - GWL_SimpleBuffer clipboard_primary; - std::mutex clipboard_mutex; }; static void gwl_display_destroy(GWL_Display *display) @@ -836,12 +832,6 @@ static void gwl_display_destroy(GWL_Display *display) wl_display_disconnect(display->wl_display); } - { - std::lock_guard lock{display->clipboard_mutex}; - gwl_simple_buffer_free_data(&display->clipboard); - gwl_simple_buffer_free_data(&display->clipboard_primary); - } - delete display; } @@ -1539,7 +1529,7 @@ static void dnd_events(const GWL_Seat *const seat, const GHOST_TEventType event) * Read from `fd` into a buffer which is returned. * \return the buffer or null on failure. */ -static const char *read_file_as_buffer(const int fd, size_t *r_len) +static char *read_file_as_buffer(const int fd, const bool nil_terminate, size_t *r_len) { struct ByteChunk { ByteChunk *next; @@ -1575,14 +1565,23 @@ static const char *read_file_as_buffer(const int fd, size_t *r_len) char *buf = nullptr; if (ok) { - buf = static_cast(malloc(len)); + buf = static_cast(malloc(len + (nil_terminate ? 1 : 0))); if (UNLIKELY(buf == nullptr)) { CLOG_WARN(LOG, "unable to allocate file buffer: %zu bytes", len); ok = false; } } - *r_len = ok ? len : 0; + if (ok) { + *r_len = len; + if (nil_terminate) { + buf[len] = '\0'; + } + } + else { + *r_len = 0; + } + char *buf_stride = buf; while (chunk_first) { if (ok) { @@ -1599,17 +1598,23 @@ static const char *read_file_as_buffer(const int fd, size_t *r_len) return buf; } -static const char *read_buffer_from_data_offer(GWL_DataOffer *data_offer, - const char *mime_receive, - std::mutex *mutex, - size_t *r_len) +static char *read_buffer_from_data_offer(struct wl_display *wl_display, + GWL_DataOffer *data_offer, + const char *mime_receive, + std::mutex *mutex, + const bool nil_terminate, + size_t *r_len) { int pipefd[2]; if (UNLIKELY(pipe(pipefd) != 0)) { CLOG_WARN(LOG, "error creating pipe: %s", std::strerror(errno)); + if (mutex) { + mutex->unlock(); + } return nullptr; } wl_data_offer_receive(data_offer->id, mime_receive, pipefd[1]); + wl_display_flush(wl_display); close(pipefd[1]); data_offer->in_use.store(false); @@ -1619,23 +1624,28 @@ static const char *read_buffer_from_data_offer(GWL_DataOffer *data_offer, } /* WARNING: `data_offer` may be freed from now on. */ - const char *buf = read_file_as_buffer(pipefd[0], r_len); + char *buf = read_file_as_buffer(pipefd[0], nil_terminate, r_len); close(pipefd[0]); return buf; } -static const char *read_buffer_from_primary_selection_offer( - GWL_PrimarySelection_DataOffer *data_offer, - const char *mime_receive, - std::mutex *mutex, - size_t *r_len) +static char *read_buffer_from_primary_selection_offer(struct wl_display *wl_display, + GWL_PrimarySelection_DataOffer *data_offer, + const char *mime_receive, + std::mutex *mutex, + const bool nil_terminate, + size_t *r_len) { int pipefd[2]; if (UNLIKELY(pipe(pipefd) != 0)) { CLOG_WARN(LOG, "error creating pipe: %s", std::strerror(errno)); + if (mutex) { + mutex->unlock(); + } return nullptr; } zwp_primary_selection_offer_v1_receive(data_offer->id, mime_receive, pipefd[1]); + wl_display_flush(wl_display); close(pipefd[1]); data_offer->in_use.store(false); @@ -1644,7 +1654,7 @@ static const char *read_buffer_from_primary_selection_offer( mutex->unlock(); } /* WARNING: `data_offer` may be freed from now on. */ - const char *buf = read_file_as_buffer(pipefd[0], r_len); + char *buf = read_file_as_buffer(pipefd[0], nil_terminate, r_len); close(pipefd[0]); return buf; } @@ -1899,8 +1909,12 @@ static void data_device_handle_drop(void *data, struct wl_data_device * /*wl_dat const wl_fixed_t xy[2] = {UNPACK2(data_offer->dnd.xy)}; size_t data_buf_len = 0; - const char *data_buf = read_buffer_from_data_offer( - data_offer, mime_receive.c_str(), nullptr, &data_buf_len); + const char *data_buf = read_buffer_from_data_offer(seat->system->wl_display(), + data_offer, + mime_receive.c_str(), + nullptr, + false, + &data_buf_len); std::string data = data_buf ? std::string(data_buf, data_buf_len) : ""; free(const_cast(data_buf)); @@ -2004,34 +2018,6 @@ static void data_device_handle_selection(void *data, /* Get new data offer. */ data_offer = static_cast(wl_data_offer_get_user_data(id)); seat->data_offer_copy_paste = data_offer; - - auto read_selection_fn = [](GWL_Seat *seat) { - GHOST_SystemWayland *const system = seat->system; - seat->data_offer_copy_paste_mutex.lock(); - - GWL_DataOffer *data_offer = seat->data_offer_copy_paste; - std::string mime_receive; - for (const std::string type : {mime_text_utf8, mime_text_plain}) { - if (data_offer->types.count(type)) { - mime_receive = type; - break; - } - } - - size_t data_len = 0; - const char *data = read_buffer_from_data_offer( - data_offer, mime_receive.c_str(), &seat->data_offer_copy_paste_mutex, &data_len); - - { - std::mutex &clipboard_mutex = system->clipboard_mutex(); - std::lock_guard lock{clipboard_mutex}; - GWL_SimpleBuffer *buf = system->clipboard_data(false); - gwl_simple_buffer_set_and_take_ownership(buf, data, data_len); - } - }; - - std::thread read_thread(read_selection_fn, seat); - read_thread.detach(); } static const struct wl_data_device_listener data_device_listener = { @@ -3584,33 +3570,6 @@ static void primary_selection_device_handle_selection( GWL_PrimarySelection_DataOffer *data_offer = static_cast( zwp_primary_selection_offer_v1_get_user_data(id)); primary->data_offer = data_offer; - - auto read_selection_fn = [](GWL_PrimarySelection *primary) { - GHOST_SystemWayland *system = static_cast(GHOST_ISystem::getSystem()); - primary->data_offer_mutex.lock(); - - GWL_PrimarySelection_DataOffer *data_offer = primary->data_offer; - std::string mime_receive; - for (const std::string type : {mime_text_utf8, mime_text_plain}) { - if (data_offer->types.count(type)) { - mime_receive = type; - break; - } - } - size_t data_len = 0; - const char *data = read_buffer_from_primary_selection_offer( - data_offer, mime_receive.c_str(), &primary->data_offer_mutex, &data_len); - - { - std::mutex &clipboard_mutex = system->clipboard_mutex(); - std::lock_guard lock{clipboard_mutex}; - GWL_SimpleBuffer *buf = system->clipboard_data(true); - gwl_simple_buffer_set_and_take_ownership(buf, data, data_len); - } - }; - - std::thread read_thread(read_selection_fn, primary); - read_thread.detach(); } static const struct zwp_primary_selection_device_v1_listener primary_selection_device_listener = { @@ -5012,13 +4971,90 @@ GHOST_TSuccess GHOST_SystemWayland::getButtons(GHOST_Buttons &buttons) const return GHOST_kSuccess; } +/** + * Return a mime type which is supported by GHOST and exists in `types` + * (defined by the data offer). + */ +static const char *system_clipboard_text_mime_type( + const std::unordered_set &data_offer_types) +{ + const char *ghost_supported_types[] = {mime_text_utf8, mime_text_plain}; + for (size_t i = 0; i < ARRAY_SIZE(ghost_supported_types); i++) { + if (data_offer_types.count(ghost_supported_types[i])) { + return ghost_supported_types[i]; + } + } + return nullptr; +} + +static char *system_clipboard_get_primary_selection(GWL_Display *display) +{ + GWL_Seat *seat = display->seats[0]; + + GWL_PrimarySelection *primary = &seat->primary_selection; + std::mutex &mutex = primary->data_offer_mutex; + + mutex.lock(); + bool mutex_locked = true; + char *data = nullptr; + + GWL_PrimarySelection_DataOffer *data_offer = primary->data_offer; + if (data_offer != nullptr) { + const char *mime_receive = system_clipboard_text_mime_type(data_offer->types); + if (mime_receive) { + size_t data_len = 0; + data = read_buffer_from_primary_selection_offer( + display->wl_display, data_offer, mime_receive, &mutex, true, &data_len); + /* Reading the data offer unlocks the mutex. */ + mutex_locked = false; + } + } + if (mutex_locked) { + mutex.unlock(); + } + return data; +} + +static char *system_clipboard_get(GWL_Display *display) +{ + GWL_Seat *seat = display->seats[0]; + std::mutex &mutex = seat->data_offer_copy_paste_mutex; + + mutex.lock(); + bool mutex_locked = true; + char *data = nullptr; + + GWL_DataOffer *data_offer = seat->data_offer_copy_paste; + if (data_offer != nullptr) { + const char *mime_receive = system_clipboard_text_mime_type(data_offer->types); + if (mime_receive) { + size_t data_len = 0; + data = read_buffer_from_data_offer( + display->wl_display, data_offer, mime_receive, &mutex, true, &data_len); + /* Reading the data offer unlocks the mutex. */ + mutex_locked = false; + } + } + if (mutex_locked) { + mutex.unlock(); + } + return data; +} + char *GHOST_SystemWayland::getClipboard(bool selection) const { - const GWL_SimpleBuffer *buf = clipboard_data(selection); - if (buf->data == nullptr) { + if (UNLIKELY(display_->seats.empty())) { return nullptr; } - return gwl_simple_buffer_as_string(buf); + + char *data = nullptr; + if (selection) { + data = system_clipboard_get_primary_selection(display_); + } + else { + data = system_clipboard_get(display_); + } + return data; } static void system_clipboard_put_primary_selection(GWL_Display *display, const char *buffer) @@ -5057,6 +5093,9 @@ static void system_clipboard_put_primary_selection(GWL_Display *display, const c static void system_clipboard_put(GWL_Display *display, const char *buffer) { + if (!display->wl_data_device_manager) { + return; + } GWL_Seat *seat = display->seats[0]; std::lock_guard lock{seat->data_source_mutex}; @@ -5083,7 +5122,7 @@ static void system_clipboard_put(GWL_Display *display, const char *buffer) void GHOST_SystemWayland::putClipboard(const char *buffer, bool selection) const { - if (UNLIKELY(!display_->wl_data_device_manager || display_->seats.empty())) { + if (UNLIKELY(display_->seats.empty())) { return; } @@ -6107,16 +6146,6 @@ bool GHOST_SystemWayland::window_cursor_grab_set(const GHOST_TGrabCursorMode mod return GHOST_kSuccess; } -struct GWL_SimpleBuffer *GHOST_SystemWayland::clipboard_data(bool selection) const -{ - return selection ? &display_->clipboard_primary : &display_->clipboard; -} - -struct std::mutex &GHOST_SystemWayland::clipboard_mutex() const -{ - return display_->clipboard_mutex; -} - #ifdef WITH_GHOST_WAYLAND_LIBDECOR bool GHOST_SystemWayland::use_libdecor_runtime() { diff --git a/intern/ghost/intern/GHOST_SystemWayland.h b/intern/ghost/intern/GHOST_SystemWayland.h index 7c5459fc461..db4fef23538 100644 --- a/intern/ghost/intern/GHOST_SystemWayland.h +++ b/intern/ghost/intern/GHOST_SystemWayland.h @@ -189,9 +189,6 @@ class GHOST_SystemWayland : public GHOST_System { wl_surface *wl_surface, int scale); - struct GWL_SimpleBuffer *clipboard_data(bool selection) const; - struct std::mutex &clipboard_mutex() const; - #ifdef WITH_GHOST_WAYLAND_LIBDECOR static bool use_libdecor_runtime(); #endif -- cgit v1.2.3