weston/tests/subsurface-shot-test.c
Daniel Stone 0189bfac9f surface: Add test for recursive subsurface unmapping
Make sure that in a 1 -> 2 -> 3 -> 4 parent->child subsurface nesting,
destroying surface 2 also immediately unmaps 3 and 4.

Signed-off-by: Daniel Stone <daniels@collabora.com>
2023-07-04 15:52:21 +01:00

504 lines
15 KiB
C

/*
* Copyright © 2015 Samsung Electronics Co., Ltd
* Copyright © 2016 Collabora, Ltd.
*
* 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 "config.h"
#include <stdio.h>
#include <string.h>
#include <sys/mman.h>
#include "weston-test-client-helper.h"
#include "weston-test-fixture-compositor.h"
struct setup_args {
struct fixture_metadata meta;
enum weston_renderer_type renderer;
};
static const struct setup_args my_setup_args[] = {
{
.renderer = WESTON_RENDERER_PIXMAN,
.meta.name = "pixman"
},
{
.renderer = WESTON_RENDERER_GL,
.meta.name = "GL"
},
};
static enum test_result_code
fixture_setup(struct weston_test_harness *harness, const struct setup_args *arg)
{
struct compositor_setup setup;
compositor_setup_defaults(&setup);
setup.renderer = arg->renderer;
setup.width = 320;
setup.height = 240;
setup.shell = SHELL_TEST_DESKTOP;
setup.logging_scopes = "log,test-harness-plugin";
return weston_test_harness_execute_as_client(harness, &setup);
}
DECLARE_FIXTURE_SETUP_WITH_ARG(fixture_setup, my_setup_args, meta);
static struct wl_subcompositor *
get_subcompositor(struct client *client)
{
struct global *g;
struct global *global_sub = NULL;
struct wl_subcompositor *sub;
wl_list_for_each(g, &client->global_list, link) {
if (strcmp(g->interface, "wl_subcompositor"))
continue;
if (global_sub)
assert(0 && "multiple wl_subcompositor objects");
global_sub = g;
}
assert(global_sub && "no wl_subcompositor found");
assert(global_sub->version == 1);
sub = wl_registry_bind(client->wl_registry, global_sub->name,
&wl_subcompositor_interface, 1);
assert(sub);
return sub;
}
static int
check_screen(struct client *client,
const char *ref_image,
int ref_seq_no,
const struct rectangle *clip,
int seq_no)
{
bool match;
match = verify_screen_content(client, ref_image, ref_seq_no, clip,
seq_no, NULL);
return match ? 0 : -1;
}
static struct buffer *
surface_commit_color(struct client *client, struct wl_surface *surface,
pixman_color_t *color, int width, int height)
{
struct buffer *buf;
buf = create_shm_buffer_a8r8g8b8(client, width, height);
fill_image_with_color(buf->image, color);
wl_surface_attach(surface, buf->proxy, 0, 0);
wl_surface_damage_buffer(surface, 0, 0, width, height);
wl_surface_commit(surface);
return buf;
}
TEST(subsurface_recursive_unmap)
{
struct client *client;
struct wl_subcompositor *subco;
struct buffer *bufs[5] = { 0 };
struct wl_surface *surf[5] = { 0 };
struct wl_subsurface *sub[5] = { 0 };
struct rectangle clip = { 40, 40, 280, 200 };
int fail = 0;
unsigned i;
pixman_color_t red;
pixman_color_t blue;
pixman_color_t cyan;
pixman_color_t green;
color_rgb888(&red, 255, 0, 0);
color_rgb888(&blue, 0, 0, 255);
color_rgb888(&cyan, 0, 255, 255);
color_rgb888(&green, 0, 255, 0);
client = create_client_and_test_surface(100, 50, 100, 100);
assert(client);
subco = get_subcompositor(client);
/* move the pointer clearly away from our screenshooting area */
weston_test_move_pointer(client->test->weston_test, 0, 1, 0, 2, 30);
/* make the parent surface red */
surf[0] = client->surface->wl_surface;
client->surface->wl_surface = NULL; /* we stole it and destroy it */
bufs[0] = surface_commit_color(client, surf[0], &red, 100, 100);
/* sub[0] is not used */
fail += check_screen(client, "subsurface_z_order", 0, &clip, 0);
/* create a blue sub-surface above red */
surf[1] = wl_compositor_create_surface(client->wl_compositor);
sub[1] = wl_subcompositor_get_subsurface(subco, surf[1], surf[0]);
bufs[1] = surface_commit_color(client, surf[1], &blue, 100, 100);
wl_subsurface_set_position(sub[1], 20, 20);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 1, &clip, 1);
/* create a cyan sub-surface above blue */
surf[2] = wl_compositor_create_surface(client->wl_compositor);
sub[2] = wl_subcompositor_get_subsurface(subco, surf[2], surf[1]);
bufs[2] = surface_commit_color(client, surf[2], &cyan, 100, 100);
wl_subsurface_set_position(sub[2], 20, 20);
wl_surface_commit(surf[1]);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 2, &clip, 2);
/* create a green sub-surface above blue, sibling to cyan */
surf[3] = wl_compositor_create_surface(client->wl_compositor);
sub[3] = wl_subcompositor_get_subsurface(subco, surf[3], surf[1]);
bufs[3] = surface_commit_color(client, surf[3], &green, 100, 100);
wl_subsurface_set_position(sub[3], -40, 10);
wl_surface_commit(surf[1]);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 3, &clip, 3);
/* destroy blue, to immediately unmap blue + red + cyan */
wl_surface_destroy(surf[1]);
surf[1] = NULL;
fail += check_screen(client, "subsurface_z_order", 0, &clip, 0);
assert(fail == 0);
for (i = 0; i < ARRAY_LENGTH(sub); i++)
if (sub[i])
wl_subsurface_destroy(sub[i]);
for (i = 0; i < ARRAY_LENGTH(surf); i++)
if (surf[i])
wl_surface_destroy(surf[i]);
for (i = 0; i < ARRAY_LENGTH(bufs); i++)
if (bufs[i])
buffer_destroy(bufs[i]);
wl_subcompositor_destroy(subco);
client_destroy(client);
}
TEST(subsurface_z_order)
{
struct client *client;
struct wl_subcompositor *subco;
struct buffer *bufs[5] = { 0 };
struct wl_surface *surf[5] = { 0 };
struct wl_subsurface *sub[5] = { 0 };
struct rectangle clip = { 40, 40, 280, 200 };
int fail = 0;
unsigned i;
pixman_color_t red;
pixman_color_t blue;
pixman_color_t cyan;
pixman_color_t green;
color_rgb888(&red, 255, 0, 0);
color_rgb888(&blue, 0, 0, 255);
color_rgb888(&cyan, 0, 255, 255);
color_rgb888(&green, 0, 255, 0);
client = create_client_and_test_surface(100, 50, 100, 100);
assert(client);
subco = get_subcompositor(client);
/* move the pointer clearly away from our screenshooting area */
weston_test_move_pointer(client->test->weston_test, 0, 1, 0, 2, 30);
/* make the parent surface red */
surf[0] = client->surface->wl_surface;
client->surface->wl_surface = NULL; /* we stole it and destroy it */
bufs[0] = surface_commit_color(client, surf[0], &red, 100, 100);
/* sub[0] is not used */
fail += check_screen(client, "subsurface_z_order", 0, &clip, 0);
/* create a blue sub-surface above red */
surf[1] = wl_compositor_create_surface(client->wl_compositor);
sub[1] = wl_subcompositor_get_subsurface(subco, surf[1], surf[0]);
bufs[1] = surface_commit_color(client, surf[1], &blue, 100, 100);
wl_subsurface_set_position(sub[1], 20, 20);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 1, &clip, 1);
/* create a cyan sub-surface above blue */
surf[2] = wl_compositor_create_surface(client->wl_compositor);
sub[2] = wl_subcompositor_get_subsurface(subco, surf[2], surf[1]);
bufs[2] = surface_commit_color(client, surf[2], &cyan, 100, 100);
wl_subsurface_set_position(sub[2], 20, 20);
wl_surface_commit(surf[1]);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 2, &clip, 2);
/* create a green sub-surface above blue, sibling to cyan */
surf[3] = wl_compositor_create_surface(client->wl_compositor);
sub[3] = wl_subcompositor_get_subsurface(subco, surf[3], surf[1]);
bufs[3] = surface_commit_color(client, surf[3], &green, 100, 100);
wl_subsurface_set_position(sub[3], -40, 10);
wl_surface_commit(surf[1]);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 3, &clip, 3);
/* stack blue below red, which brings also cyan and green below red */
wl_subsurface_place_below(sub[1], surf[0]);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_z_order", 4, &clip, 4);
assert(fail == 0);
for (i = 0; i < ARRAY_LENGTH(sub); i++)
if (sub[i])
wl_subsurface_destroy(sub[i]);
for (i = 0; i < ARRAY_LENGTH(surf); i++)
if (surf[i])
wl_surface_destroy(surf[i]);
for (i = 0; i < ARRAY_LENGTH(bufs); i++)
if (bufs[i])
buffer_destroy(bufs[i]);
wl_subcompositor_destroy(subco);
client_destroy(client);
}
TEST(subsurface_sync_damage_buffer)
{
struct client *client;
struct wl_subcompositor *subco;
struct buffer *bufs[2] = { 0 };
struct wl_surface *surf[2] = { 0 };
struct wl_subsurface *sub[2] = { 0 };
struct rectangle clip = { 40, 40, 280, 200 };
int fail = 0;
unsigned i;
pixman_color_t red;
pixman_color_t blue;
pixman_color_t green;
color_rgb888(&red, 255, 0, 0);
color_rgb888(&blue, 0, 0, 255);
color_rgb888(&green, 0, 255, 0);
client = create_client_and_test_surface(100, 50, 100, 100);
assert(client);
subco = get_subcompositor(client);
/* move the pointer clearly away from our screenshooting area */
weston_test_move_pointer(client->test->weston_test, 0, 1, 0, 2, 30);
/* make the parent surface red */
surf[0] = client->surface->wl_surface;
client->surface->wl_surface = NULL; /* we stole it and destroy it */
bufs[0] = surface_commit_color(client, surf[0], &red, 100, 100);
/* sub[0] is not used */
fail += check_screen(client, "subsurface_sync_damage_buffer", 0, &clip, 0);
/* create a blue sub-surface above red */
surf[1] = wl_compositor_create_surface(client->wl_compositor);
sub[1] = wl_subcompositor_get_subsurface(subco, surf[1], surf[0]);
bufs[1] = surface_commit_color(client, surf[1], &blue, 100, 100);
wl_subsurface_set_position(sub[1], 20, 20);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_sync_damage_buffer", 1, &clip, 1);
buffer_destroy(bufs[1]);
bufs[1] = surface_commit_color(client, surf[1], &green, 100, 100);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_sync_damage_buffer", 2, &clip, 2);
assert(fail == 0);
for (i = 0; i < ARRAY_LENGTH(sub); i++)
if (sub[i])
wl_subsurface_destroy(sub[i]);
for (i = 0; i < ARRAY_LENGTH(surf); i++)
if (surf[i])
wl_surface_destroy(surf[i]);
for (i = 0; i < ARRAY_LENGTH(bufs); i++)
if (bufs[i])
buffer_destroy(bufs[i]);
wl_subcompositor_destroy(subco);
client_destroy(client);
}
TEST(subsurface_empty_mapping)
{
struct client *client;
struct wl_subcompositor *subco;
struct wp_viewporter *viewporter;
struct buffer *bufs[3] = { 0 };
struct buffer *buf_tmp;
struct wl_surface *surf[3] = { 0 };
struct wl_subsurface *sub[3] = { 0 };
struct wp_viewport *viewport;
struct rectangle clip = { 40, 40, 280, 200 };
int fail = 0;
unsigned i;
pixman_color_t red;
pixman_color_t blue;
pixman_color_t green;
color_rgb888(&red, 255, 0, 0);
color_rgb888(&blue, 0, 0, 255);
color_rgb888(&green, 0, 255, 0);
client = create_client_and_test_surface(100, 50, 100, 100);
assert(client);
subco = get_subcompositor(client);
viewporter = bind_to_singleton_global(client,
&wp_viewporter_interface, 1);
/* move the pointer clearly away from our screenshooting area */
weston_test_move_pointer(client->test->weston_test, 0, 1, 0, 2, 30);
/* make the parent surface red */
surf[0] = client->surface->wl_surface;
client->surface->wl_surface = NULL; /* we stole it and destroy it */
bufs[0] = surface_commit_color(client, surf[0], &red, 100, 100);
/* sub[0] is not used */
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 0);
/* create an empty subsurface on top */
surf[1] = wl_compositor_create_surface(client->wl_compositor);
sub[1] = wl_subcompositor_get_subsurface(subco, surf[1], surf[0]);
wl_subsurface_set_desync (sub[1]);
wl_subsurface_set_position(sub[1], 20, 20);
wl_surface_commit(surf[0]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 1);
/* create a green subsurface on top */
surf[2] = wl_compositor_create_surface(client->wl_compositor);
sub[2] = wl_subcompositor_get_subsurface(subco, surf[2], surf[1]);
wl_subsurface_set_desync (sub[2]);
bufs[2] = surface_commit_color(client, surf[2], &green, 100, 100);
wl_subsurface_set_position(sub[2], 20, 20);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 2);
wl_surface_attach(surf[1], NULL, 0, 0);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 3);
wl_surface_set_buffer_scale (surf[1], 1);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 4);
viewport = wp_viewporter_get_viewport(viewporter, surf[1]);
wp_viewport_set_destination(viewport, 5, 5);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 5);
wp_viewport_set_destination(viewport, -1, -1);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 6);
/* map the previously empty middle surface with a blue buffer */
bufs[1] = surface_commit_color(client, surf[1], &blue, 100, 100);
fail += check_screen(client, "subsurface_empty_mapping", 1, &clip, 7);
/* try to trigger a recomputation of the buffer size with the
* shm-buffer potentially being released already */
wl_surface_set_buffer_scale (surf[1], 1);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 1, &clip, 8);
/* try more */
wp_viewport_set_destination(viewport, 100, 100);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 1, &clip, 9);
/* unmap the middle surface again to ensure recursive unmapping */
wl_surface_attach(surf[1], NULL, 0, 0);
wl_surface_commit(surf[1]);
fail += check_screen(client, "subsurface_empty_mapping", 0, &clip, 10);
/* remap middle surface to ensure recursive mapping */
buf_tmp = bufs[1];
bufs[1] = surface_commit_color(client, surf[1], &blue, 100, 100);
buffer_destroy(buf_tmp);
fail += check_screen(client, "subsurface_empty_mapping", 1, &clip, 11);
assert(fail == 0);
wp_viewport_destroy(viewport);
for (i = 0; i < ARRAY_LENGTH(sub); i++)
if (sub[i])
wl_subsurface_destroy(sub[i]);
for (i = 0; i < ARRAY_LENGTH(surf); i++)
if (surf[i])
wl_surface_destroy(surf[i]);
for (i = 0; i < ARRAY_LENGTH(bufs); i++)
if (bufs[i])
buffer_destroy(bufs[i]);
wp_viewporter_destroy(viewporter);
wl_subcompositor_destroy(subco);
client_destroy(client);
}