aboutsummaryrefslogtreecommitdiffstats
path: root/src
Commit message (Collapse)AuthorAgeFilesLines
* connection: Add a function to parse WAYLAND_DEBUG tokensKyle Brenneman2025-09-154-2/+47
| | | | | | | | | | | | | | | Add a new function, wl_check_env_token, to scan for a token in a comma-separated string. Change wl_display_create in wayland-server.c and wl_display_connect_to_fd in wayland-client.c to use that instead of a simple substring search. This means that WAYLAND_DEBUG will accept a value like "client,server" but not "clientserver". But, this will make it easier to add other tokens without worrying about overlap between them. Signed-off-by: Kyle Brenneman <kbrenneman@nvidia.com>
* connection: Do not busy-loop if a message exceeds the buffer sizeDemi Marie Obenour2025-06-214-0/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If the length of a message exceeds the maximum length of the buffer, the buffer size will reach its maximum value and stay there forever, with no message ever being successfully processed. Since libwayland uses level-triggered epoll, this will cause the compositor to loop forever and consume CPU time. In libwayland 1.22 and below, there was an explicit check that caused messages exceeding 4096 bytes to result in an EOVERFLOW error, preventing the loop. However, this check was removed between d074d5290263 ("connection: Dynamically resize connection buffers"). To prevent this problem, always limit the size of messages to 4096 bytes. Since the default and minimum buffer size is 4096 bytes, this ensures that a single message will always fit in the buffer. It would be possible to allow larger messages if the buffer size was larger, but the maximum size of a message should not depend on the buffer size chosen by the compositor. Rejecting messages that exceed 4092 bytes seems to have the advantage of reserving 4 bits, not 3, in the size field for future use. However, message sizes in the range [0x0, 0x7] are invalid, so one can obtain a fourth bit by negating the meaning of bit 12 if bits 0 through 11 (inclusive) are 0. Allowing 4096-byte messages provides the far more important advantage that regressions compared to 1.22 are impossible and regressions compared to 1.23 are extremely unlikely. The only case where a regression is possible is: - The receiving side is using libwayland 1.23. - The sending side is either using libwayland 1.23 or is not using libwayland. - The sender sends a message exceeding 4096 bytes. - If the sender of the large message is the client, the server has increased the buffer size from the default value. This combination is considered extremely unlikely, as libwayland 1.22 and below would disconnect upon receiving such a large message. 4096-byte messages, however, have always worked, so there was no reason to avoid sending them. Fixes: d074d5290263 ("connection: Dynamically resize connection buffers"). Fixes: #494 Signed-off-by: Demi Marie Obenour <demi@invisiblethingslab.com>
* server: Document wl_display_add_socket_autoManuel Stoeckl2025-06-081-0/+18
| | | | | | The exact sequence of names tried has de facto become part of the API. Signed-off-by: Manuel Stoeckl <code@mstoeckl.com>
* client: fix conversion specifier in the discarded event log messageKirill Primak2025-06-011-1/+1
| | | | Signed-off-by: Kirill Primak <vyivel@eclair.cafe>
* debug: Colorize output for easier readingCaitlyn2025-06-014-18/+69
| | | | Signed-off-by: Caitlyn <caitlynrosestewart@gmail.com>
* connection: fix segfault in wl_closure_invoke()Caitlyn Stewart2025-05-271-0/+5
| | | | Signed-off-by: Caitlyn Stewart <caitlynrosestewart@gmail.com>
* Fix typosTobias Stoeckmann2025-05-201-1/+1
| | | | | | Typos found with codespell and during code audit. Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org>
* server: add wl_resource_get_interface()Isaac Freund2025-05-202-0/+17
| | | | | | | This is useful for the wayland bindings/scanner I'm working on for a dynamically typed language. Signed-off-by: Isaac Freund <mail@isaacfreund.com>
* client: add wl_proxy_get_interface()Isaac Freund2025-05-202-0/+17
| | | | | | | This is useful for the wayland bindings/scanner I'm working on for a dynamically typed language. Signed-off-by: Isaac Freund <mail@isaacfreund.com>
* shm: linkify function references in docsSimon Ser2025-05-201-8/+8
| | | | | | | Parentheses make it so the generated HTML documentation contains links, which makes navigation easier. Signed-off-by: Simon Ser <contact@emersion.fr>
* shm: fix comment about wl_shm_buffer_begin_access() safetySimon Ser2025-05-201-1/+1
| | | | | | | The paragraph later says that accessing different buffers is allowed. The function checks whether the same pool is accessed. Signed-off-by: Simon Ser <contact@emersion.fr>
* shm: Generate an error when shm access failed even without a resourceSebastian Wick2025-05-201-0/+26
| | | | Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* shm: Add wl_shm_buffer ref and unref functionsSebastian Wick2025-05-202-5/+79
| | | | | | | | | | | | | | | Shared memory buffers are currently tied to the lifetime of their underlying wl_buffer resource. This becomes problematic when the client destroys the resource after committing new state which references the wl_buffer because a compositor might have to defer applying the commit. This commit adds methods to keep the wl_shm_buffer alive longer than the underlying resource. This implicitly also keeps the buffer pool alive and because the wl_shm_buffer uses offsets into the pool, it even works when the underlying storage gets remapped somewhere else, which can happen when the client resizes the pool. Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* shm: Remove refcount check which cannot be triggeredSebastian Wick2025-05-201-7/+2
| | | | | | | | | If the pool refcount reaches zero, it is freed, so accessing its members is UB which ASan would catch. Also simplify check for negative refcounts. Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* shm: Linkify wl_shm_pool_unref in the ref_pool documentationSebastian Wick2025-05-201-1/+1
| | | | Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* client: document get_listener behavior for dispatchersJulian Orth2025-03-151-0/+3
| | | | | | | | | | | This seems to have been the case since 2013. This is useful for wrappers that need two pointers to identify proxies. One pointer (stored in the user data) pointing to a singleton object to identify that the proxy has a known structure. And one pointer (stored in the dispatcher data) pointing to per-proxy data. Signed-off-by: Julian Orth <ju.orth@gmail.com>
* scanner: use separate guards for validator functionsSimon Ser2025-02-231-3/+11
| | | | | | | | | | | | | | Generated XXX_is_valid() functions for enums are guarded behind the same #define as the enum itself. This worked fine until recently, but since fbd7460737c9 ("scanner: add new enum-header mode") we're also generating enum-only headers. When including the enum-only header first, and then the server header, the validator functions are missing. Define a separate guard to fix this. Signed-off-by: Simon Ser <contact@emersion.fr>
* Forward declarate timespec structVlad Zahorodnii2025-02-061-1/+2
| | | | | | | The `timespec` struct is defined in `time.h` header but only if `_POSIX_C_SOURCE` is set or when using the C11 standard. Signed-off-by: Vlad Zahorodnii <vlad.zahorodnii@kde.org>
* Also use [[deprecated]] when compiling with at least C++14David Redondo2025-02-051-1/+1
| | | | Signed-off-by: David Redondo <kde@david-redondo.de>
* Make wayland-util.h -Wundef safe when compiled by a C++ compilerDavid Redondo2025-02-051-2/+2
| | | | | Fixes #522 Signed-off-by: David Redondo <kde@david-redondo.de>
* build: Add -lm to pkg-config dependenciesDaniel Stone2025-02-051-0/+2
| | | | | | | | | Now that wl_fixed_from_double() calls round() from a function declared in a header, our users need to explicitly pick that dependency up in order to avoid build errors. Signed-off-by: Daniel Stone <daniels@collabora.com> Closes: wayland/weston#991
* client: Add wl_display_dispatch_timeoutSebastian Wick2025-02-042-0/+13
| | | | | | A variant of wl_display_dispatch_queue_timeout for the default queue. Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* client: Add wl_display_dispatch_queue_timeoutSebastian Wick2025-02-042-34/+127
| | | | | | | | | | | For dispatching messages on a queue with a timeout. This slightly changes the samantics of wl_display_dispatch. Previously it was possible for it to return even though there wasn't a single dispatched event. The function correctly returned 0 in this case but it is now used to indicate a timeout. Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* event-loop: Use timespec utils instead of hand-rolling our ownSebastian Wick2025-02-041-54/+7
| | | | Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* timespec: Implement saturating timespec substractionSebastian Wick2025-02-041-0/+18
| | | | Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* timespec: Pull in timespec_after and timespec_add from mesaSebastian Wick2025-02-041-0/+34
| | | | Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* timespec: Pull in timespec.h from westonSebastian Wick2025-02-041-0/+259
| | | | Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* server: add const qualifier to function arguments where possibleSebastian Wick2025-01-223-18/+19
| | | | | | | Makes it possible to e.g. `call wl_client_get_credentials` with a `const struct wl_client *` from a global filter callback. Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* util: reduce error of wl_fixed_from_double()Haihua Hu2025-01-091-1/+1
| | | | | | | | when cast double to fixed pointer, there will be big error, eg 1919.9998 to 1919. Call round before cast to get nearest value 1920 of 1919.9998 Signed-off-by: Haihua Hu <jared.hu@nxp.com>
* connection: Fix wrong format stringDemi Marie Obenour2024-11-301-1/+1
| | | | | | | Prevents undefined behavior if there is not enough space in the buffer for a queued message. Signed-off-by: Demi Marie Obenour <demi@invisiblethingslab.com>
* connection: Avoid undefined pointer arithmeticDemi Marie Obenour2024-11-291-4/+4
| | | | | | | | | | Creating a pointer that is more than one element past the end of an array is undefined behavior, even if the pointer is not dereferenced. Avoid this undefined behavior by using `p >= end` instead of `p + 1 > end` and `SOMETHING > end - p` instead of `p + SOMETHING > end`. Signed-off-by: Demi Marie Obenour <demi@invisiblethingslab.com>
* connection: Reject strings containing NUL bytesDemi Marie Obenour2024-08-181-1/+9
| | | | | | | | | | | | libwayland cannot construct these messages as it uses strlen() to determine string lengths. libwayland is also guaranteed to misinterpret these messages, since message handlers only get a pointer and no length. Therefore, reject strings containing NUL bytes. Also remove a redundant check from the unmarshalling code. The zero-length case has already been checked for. Signed-off-by: Demi Marie Obenour <demi@invisiblethingslab.com>
* client: Log the object and methods when marshalling or sending failsFangzhou Ge2024-08-121-2/+6
| | | | | | | | | The log that appears before a display_error can be captured as crash signature. Useful to know what it is. This is cherry-picked from chromium https://crrev.com/c/4697877 Signed-off-by: Fangzhou Ge <fangzhoug@chromium.org>
* src: Finish assert() clean-upDerek Foreman2024-08-095-6/+2
| | | | | | | | | | | | | From cleanup commit 0cecde304: assert()s can be compiled away by #defining NDEBUG. Some build systems do this. Using wl_abort gives a human readable error message and it isn't compiled away. That commit missed one final assert, presumably due to missing it with grep because of a coding style issue. Fix that up, and remove inclusion of <assert.h> as appropriate. Signed-off-by: Derek Foreman <derek.foreman@collabora.com>
* server: expose wl_resource_post_error_vargs()Kirill Primak2024-08-092-2/+14
| | | | Signed-off-by: Kirill Primak <vyivel@eclair.cafe>
* server: add wl_resource_post_error() docsKirill Primak2024-08-092-1/+9
| | | | Signed-off-by: Kirill Primak <vyivel@eclair.cafe>
* Put WL_DEPRECATED in front of the function declarationsKirill Primak2024-08-093-11/+22
| | | | | | | | | | | | | This fixes the following clang error when using C23: ../src/wayland-server-core.h:680:41: error: 'deprecated' attribute cannot be applied to types 680 | int32_t stride, uint32_t format) WL_DEPRECATED; | ^ ../src/wayland-util.h:52:25: note: expanded from macro 'WL_DEPRECATED' 52 | #define WL_DEPRECATED [[deprecated]] | ^ Signed-off-by: Kirill Primak <vyivel@eclair.cafe>
* client: Handle proxies with no queueSebastian Wick2024-07-261-1/+5
| | | | | | | | | wl_proxy_get_queue can return NULL if the queue of the proxy was already destroyed with wl_event_queue_destroy. In this case, the queue also has no name anymore. Fixes: b42218f ("client: Allow setting names for queues") Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
* src: switch asserts to wl_abortmeltq2024-07-115-16/+36
| | | | | | | | assert()s can be compiled away by #defining NDEBUG. Some build systems do this. Using wl_abort gives a human readable error message and it isn't compiled away. This commit closes issue #230. Signed-off-by: meltq <tejasvipin76@gmail.com>
* scanner: fix validator for bitfieldsSimon Ser2024-07-091-12/+25
| | | | | | | Bitfields are valid if the value only contains bits inside of the supported entries for the given version. Signed-off-by: Simon Ser <contact@emersion.fr>
* scanner: extract validator function emission to helper functionSimon Ser2024-07-091-26/+33
| | | | | | This function will grow in the next commit. Signed-off-by: Simon Ser <contact@emersion.fr>
* server: document wl_display_add_socket_fd() ownershipSimon Ser2024-05-221-0/+3
| | | | | | wl_socket_destroy() will close the socket. Signed-off-by: Simon Ser <contact@emersion.fr>
* server: Clarify fd ownership in wl_client_create()Vlad Zahorodnii2024-05-161-0/+5
| | | | | | | It's unclear whether one needs to call close() if wl_client_create() fails. Hopefully this change makes it more clear. Signed-off-by: Vlad Zahorodnii <vlad.zahorodnii@kde.org>
* client: print debug events that have no listenerDerek Foreman2024-04-241-11/+9
| | | | | | | | | | | Currently WAYLAND_DEBUG text ignores events that have no listener. It can be helpful to know when you're receiving unhandled events, as you may have forgotten to add a listener, or adding a dispatch may have magically seemed to fix code that doesn't appear to be dispatching anything. Signed-off-by: Derek Foreman <derek.foreman@collabora.com>
* client: fix invalid doc command for WL_MARSHAL_FLAG_DESTROYSimon Ser2024-04-241-1/+1
| | | | | | | | | | | | | | Fixes the following warning: src/wayland-client-core.h:125: warning: Found non-existing group 'wl_proxy' for the command '@ingroup', ignoring command "\memberof" cannot be used here because it only works on functions. The docs for "\memberof" say that "\relates" works in a similar way. While at it, use a "\" command instead of a "@" command for consistency with the rest of the file. Signed-off-by: Simon Ser <contact@emersion.fr>
* Add support for the deprecated-since XML attributeSimon Ser2024-04-241-7/+47
| | | | | | | | | | | | | | This marks a request, event or enum entry as deprecated since a given version. Note that it's not clear what it means if an entry is deprecated at some version, and the enum is used from some completely different interface than where it was defined. However, that's a more general issue with enums, see: https://gitlab.freedesktop.org/wayland/wayland/-/issues/435 Signed-off-by: Simon Ser <contact@emersion.fr> References: https://gitlab.freedesktop.org/wayland/wayland/-/issues/89
* scanner: add validators for enumsSimon Ser2024-04-231-4/+32
| | | | | | | | | | | | | | Right now compositors need to manually check that enum values sent by the client are valid. In particular: - Check that the value sent by the client is not outside of the enum. - Check that the version of the enum entry is consistent with the object version. Automatically generate validator functions to perform these tasks. Signed-off-by: Simon Ser <contact@emersion.fr> Closes: https://gitlab.freedesktop.org/wayland/wayland/-/issues/104
* connection: Dynamically resize connection buffersManuel Stoeckl2024-04-086-74/+379
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When using fixed size connection buffers, if either the client or the server is sending requests faster than the other end can cope with, the connection buffers will fill up, eventually killing the connection. This can be a problem for example with Xwayland mapping a lot of windows, faster than the Wayland compositor can cope with, or a high-rate mouse flooding the Wayland client with pointer events. To avoid the issue, resize the connection buffers dynamically when they get full. Both data and fd buffers are resized on demand. The default max buffer size is controlled via the wl_display interface while each client's connection buffer size is adjustable for finer control. The purpose is to explicitly have larger connection buffers for specific clients such as Xwayland, or set a larger buffer size for the client with pointer focus to deal with a higher input events rate. v0: Manuel: Dynamically resize connection buffers - Both data and fd buffers are resized on demand. v1: Olivier 1. Add support for unbounded buffers on the client side and growable (yet limited) connection buffers on the server side. 2. Add the API to set the default maximum size and a limit for a given client. 3. Add tests for growable connection buffers and adjustable limits. v2: Additional fixes by John: 1. Fix the size calculation in ring_buffer_check_space() 2. Fix wl_connection_read() to return gracefully once it has read up to the max buffer size, rather than returning an error. 3. If wl_connection_flush() fails with EAGAIN but the transmit ring-buffer has space remaining (or can be expanded), wl_connection_queue() should store the message rather than returning an error. 4. When the receive ring-buffer is at capacity but more data is available to be read, wl_connection_read() should attempt to expand the ring-buffer in order to read the remaining data. v3: Thomas Lukaszewicz <tluk@chromium.org> Add a test for unbounded buffers v4: Add a client API as well to force bounded buffers (unbounded by default (Olivier) v5: Simplify ring_buffer_ensure_space() (Sebastian) Co-authored-by: Olivier Fourdan <ofourdan@redhat.com> Co-authored-by: John Lindgren <john@jlindgren.net> Co-authored-by: Sebastian Wick <sebastian@sebastianwick.net> Signed-off-by: Manuel Stoeckl <code@mstoeckl.com> Signed-off-by: Olivier Fourdan <ofourdan@redhat.com> Signed-off-by: John Lindgren <john@jlindgren.net> Signed-off-by: Sebastian Wick <sebastian@sebastianwick.net> Closes: https://gitlab.freedesktop.org/wayland/wayland/-/issues/237
* util: convert macros to inline functionsSimon Ser2024-03-281-3/+17
| | | | | | | Functionally equivalent except the usual macro footguns are avoided and type safety is increased. Signed-off-by: Simon Ser <contact@emersion.fr>
* scanner: add new enum-header modeSimon Ser2024-03-281-1/+36
| | | | | | | This generates a header with only enum definitions. This is useful to share enum headers between libraries and library users. Signed-off-by: Simon Ser <contact@emersion.fr>