client: Don't disconnect on receipt of object events destined for zombies

Server side objects give protocol designers exciting ways to break clients.
For example, if a client deletes an object at the same time the server is
sending an event containing a new object to that object, then we currently
silently drop that event. If a following event in the buffer from an
object that has not yet been deleted also contains a new object, the wl_map
constraint that new objects must be 1 higher than the current highest
object count is violated.  This results in a disconnect.

Instead, let's augment the zombie accounting code to keep the entire proxy
around on deletion, for both client and server generated objects.

This way we can create and immediately delete objects that are destined for
zombie proxies - thus creating zombie descendants.

We can go no further to clean this up in the client library - we can't call
a destructor because the protocol might dictate that child objects will be
automatically destroyed on the destruction of the parent.

So we turn a situation that would lead to an erroneous disconnect into one
that may or may not leak object ids depending on protocol definition.

Fixes #74
for some definition of "fix" anyway.

Signed-off-by: Derek Foreman <derek.foreman@collabora.com>
This commit is contained in:
Derek Foreman 2021-08-13 13:29:22 -05:00
parent f736f11f99
commit c05f4f86ea
5 changed files with 218 additions and 107 deletions

View file

@ -1629,3 +1629,134 @@ TEST(global_remove)
display_destroy(d);
}
struct new_zombie_data {
struct necromancer *necromancer;
struct necromancer *necromancer_two;
struct noop *temp_noop;
};
static void
server_object(void *data, struct necromancer *necro, struct noop *noop)
{
struct new_zombie_data *nzd = data;
/* We should only see this once, since one of the two noop
* objects we create should be created as a zombie */
assert(!nzd->temp_noop);
nzd->temp_noop = noop;
}
struct necromancer_listener necromancer_listener = {
server_object,
};
static void
new_zombie_handle_globals(void *data, struct wl_registry *registry,
uint32_t id, const char *intf, uint32_t ver)
{
struct new_zombie_data *rg = data;
if (!strcmp(intf, "necromancer")) {
rg->necromancer = wl_registry_bind(registry, id, &necromancer_interface, 1);
rg->necromancer_two = wl_registry_bind(registry, id, &necromancer_interface, 1);
necromancer_add_listener(rg->necromancer, &necromancer_listener, NULL);
necromancer_add_listener(rg->necromancer_two, &necromancer_listener, rg);
}
}
static const struct wl_registry_listener new_zombie_registry_listener = {
new_zombie_handle_globals,
NULL
};
static void noop_destructor(struct wl_client *client, struct wl_resource *res)
{
wl_resource_destroy(res);
}
static const struct noop_interface noop_server_interface = {
noop_destructor
};
static void
send_new_object(struct wl_client *client, struct wl_resource *res)
{
struct wl_resource *new_res;
new_res = wl_resource_create(client, &noop_interface, 1, 0);
wl_resource_set_implementation(new_res, &noop_server_interface, NULL, NULL);
necromancer_send_server_object(res, new_res);
}
static void necromancer_destructor(struct wl_client *client, struct wl_resource *res)
{
wl_resource_destroy(res);
}
static const struct necromancer_interface necro_interface = {
necromancer_destructor,
send_new_object
};
static void
bind_necromancer(struct wl_client *client, void *data,
uint32_t vers, uint32_t id)
{
struct wl_resource *res;
res = wl_resource_create(client, &necromancer_interface, vers, id);
wl_resource_set_implementation(res, &necro_interface, NULL, NULL);
}
static void
spawn_new_zombie(void *data)
{
struct new_zombie_data rg = {};
struct client *c = client_connect();
struct wl_registry *reg;
reg = wl_display_get_registry(c->wl_display);
wl_registry_add_listener(reg, &new_zombie_registry_listener, &rg);
/* Get the globals */
wl_display_roundtrip(c->wl_display);
wl_registry_destroy(reg);
necromancer_create_server_object(rg.necromancer);
necromancer_create_server_object(rg.necromancer_two);
necromancer_destroy(rg.necromancer);
/* We should now have two new_id events on the way,
* and the first one will be destined for a zombie
* when it arrives. That would violate the wl_map
* requirement that a new id can only be one higher
* than the current max id in the map if we simply
* dropped the first inbound object.
*/
wl_display_roundtrip(c->wl_display);
assert(rg.temp_noop);
noop_destroy(rg.temp_noop);
necromancer_destroy(rg.necromancer_two);
wl_display_roundtrip(c->wl_display);
client_disconnect(c);
}
TEST(new_zombie)
{
struct display *d;
struct wl_global *g;
d = display_create();
g = wl_global_create(d->wl_display, &necromancer_interface,
1, d, bind_necromancer);
client_create_noarg(d, spawn_new_zombie);
display_run(d);
wl_global_destroy(g);
display_destroy(d);
}