wayland/tests/client-test.c
Thomas Lukaszewicz a86fd86b5e wayland-server: Add wl_client_add_event_dispatch_listener
The patch adds a listener called after an event has been dispatched
by the server.

Wayland servers that incorporate the Wayland display into their own
event loops may dispatch multiple Wayland events to clients as they
work through their task queues.

For e.g. if system display state changes the Wayland server may
emit several output / surface Wayland events to connected clients.

Currently an explicit flush is performd immediately after each
individual Wayland event is dispatched to make sure these are
propagated to clients in a deterministic / reliable manner.

This results in hard to maintain / easy to break code. Contributors
must make sure to explicitly flush when dispatching Wayland events
to clients - or otherwise wait for some other server event to flush
the client buffer later on. In the latter case behavior is not
deterministic and makes testing the server code much harder.

The client event_dispatch_listener added in this patch allows the
server to track if the processing of a server event has resulted in
the dispatch of one or more Wayland events to clients - and ensure
the buffer is appropriately flushed.

This eliminates the need to flush in many different areas of the
codebase, making the server easier to maintain and test.

Signed-off-by: Thomas Lukaszewicz <thomaslukaszewicz@gmail.com>
2024-01-04 03:48:22 +00:00

189 lines
5.3 KiB
C

/*
* Copyright © 2012 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <assert.h>
#include <sys/socket.h>
#include <unistd.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "wayland-private.h"
#include "wayland-server.h"
#include "test-runner.h"
struct client_destroy_listener {
struct wl_listener listener;
bool done;
struct wl_listener late_listener;
bool late_done;
struct wl_listener resource_listener;
bool resource_done;
};
static void
client_destroy_notify(struct wl_listener *l, void *data)
{
struct client_destroy_listener *listener =
wl_container_of(l, listener, listener);
listener->done = true;
assert(!listener->resource_done);
assert(!listener->late_done);
}
static void
client_resource_destroy_notify(struct wl_listener *l, void *data)
{
struct client_destroy_listener *listener =
wl_container_of(l, listener, resource_listener);
assert(listener->done);
listener->resource_done = true;
assert(!listener->late_done);
}
static void
client_late_destroy_notify(struct wl_listener *l, void *data)
{
struct client_destroy_listener *listener =
wl_container_of(l, listener, late_listener);
assert(listener->done);
assert(listener->resource_done);
listener->late_done = true;
}
TEST(client_destroy_listener)
{
struct wl_display *display;
struct wl_client *client;
struct wl_resource *resource;
struct client_destroy_listener a, b;
int s[2];
assert(socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, s) == 0);
display = wl_display_create();
assert(display);
client = wl_client_create(display, s[0]);
assert(client);
resource = wl_resource_create(client, &wl_callback_interface, 1, 0);
assert(resource);
a.listener.notify = client_destroy_notify;
a.done = false;
a.resource_listener.notify = client_resource_destroy_notify;
a.resource_done = false;
a.late_listener.notify = client_late_destroy_notify;
a.late_done = false;
wl_client_add_destroy_listener(client, &a.listener);
wl_resource_add_destroy_listener(resource, &a.resource_listener);
wl_client_add_destroy_late_listener(client, &a.late_listener);
assert(wl_client_get_destroy_listener(client, client_destroy_notify) ==
&a.listener);
assert(wl_resource_get_destroy_listener(resource, client_resource_destroy_notify) ==
&a.resource_listener);
assert(wl_client_get_destroy_late_listener(client, client_late_destroy_notify) ==
&a.late_listener);
b.listener.notify = client_destroy_notify;
b.done = false;
b.resource_listener.notify = client_resource_destroy_notify;
b.resource_done = false;
b.late_listener.notify = client_late_destroy_notify;
b.late_done = false;
wl_client_add_destroy_listener(client, &b.listener);
wl_resource_add_destroy_listener(resource, &b.resource_listener);
wl_client_add_destroy_late_listener(client, &b.late_listener);
wl_list_remove(&a.listener.link);
wl_list_remove(&a.resource_listener.link);
wl_list_remove(&a.late_listener.link);
wl_client_destroy(client);
assert(!a.done);
assert(!a.resource_done);
assert(!a.late_done);
assert(b.done);
assert(b.resource_done);
assert(b.late_done);
close(s[0]);
close(s[1]);
wl_display_destroy(display);
}
struct event_dispatch_listener {
struct wl_listener listener;
bool done;
};
static void
event_dispatch_notify(struct wl_listener *l, void *data)
{
struct event_dispatch_listener *listener =
wl_container_of(l, listener, listener);
listener->done = true;
}
TEST(event_dispatch_listener)
{
struct wl_display *display;
struct wl_client *client;
struct wl_resource *resource;
struct event_dispatch_listener dispatch_listener;
int s[2];
assert(socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, s) == 0);
display = wl_display_create();
assert(display);
client = wl_client_create(display, s[0]);
assert(client);
dispatch_listener.listener.notify = event_dispatch_notify;
dispatch_listener.done = false;
wl_client_add_event_dispatch_listener(client, &dispatch_listener.listener);
resource = wl_resource_create(client, &wl_seat_interface, 4, 0);
assert(resource);
wl_seat_send_name(resource, "default");
wl_event_loop_dispatch(wl_display_get_event_loop(display), 0);
assert(dispatch_listener.done);
close(s[1]);
wl_client_destroy(client);
wl_display_destroy(display);
}