File: test_bad_buffer.cpp

package info (click to toggle)
wlcs 1.8.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,528 kB
  • sloc: cpp: 14,211; xml: 7,744; ansic: 952; sh: 164; makefile: 33
file content (182 lines) | stat: -rw-r--r-- 5,302 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/*
 * Copyright © 2012 Intel Corporation
 * Copyright © 2013 Collabora, Ltd.
 * Copyright © 2017 Canonical 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 <unistd.h>
#include <gmock/gmock.h>

#include "helpers.h"

#include "in_process_server.h"

/* tests, that attempt to crash the compositor on purpose */

static struct wl_buffer *
create_bad_shm_buffer(wlcs::Client& client, int width, int height)
{
	struct wl_shm *shm = client.shm();
	int stride = width * 4;
	int size = stride * height;
	struct wl_shm_pool *pool;
	struct wl_buffer *buffer;
	int fd;

	fd = wlcs::helpers::create_anonymous_file(size);

	pool = wl_shm_create_pool(shm, fd, size);
	buffer = wl_shm_pool_create_buffer(
        pool,
        0,
        width,
        height,
        stride,
        WL_SHM_FORMAT_ARGB8888);
	wl_shm_pool_destroy(pool);

	/* Truncate the file to a small size, so that the compositor
	 * will access it out-of-bounds, and hit SIGBUS.
	 */
	assert(ftruncate(fd, 12) == 0);
	close(fd);

	return buffer;
}

using BadBufferTest = wlcs::InProcessServer;

TEST_F(BadBufferTest, test_truncated_shm_file)
{
	using namespace testing;

	wlcs::Client client{the_server()};

	bool buffer_consumed{false};

	auto surface = client.create_visible_surface(200, 200);

	wl_buffer* bad_buffer = create_bad_shm_buffer(client, 200, 200);

	wl_surface_attach(surface, bad_buffer, 0, 0);
	wl_surface_damage(surface, 0, 0, 200, 200);

	surface.add_frame_callback([&buffer_consumed](int) { buffer_consumed = true; });

	wl_surface_commit(surface);

	try
	{
		client.dispatch_until([&buffer_consumed]() { return buffer_consumed; });
	}
	catch (wlcs::ProtocolError const& err)
	{
		wl_buffer_destroy(bad_buffer);
		EXPECT_THAT(err.error_code(), Eq(WL_SHM_ERROR_INVALID_FD));
		EXPECT_THAT(err.interface(), Eq(&wl_buffer_interface));
		return;
	}

	FAIL() << "Expected protocol error not raised";
}

TEST_F(BadBufferTest, client_lies_about_buffer_size)
{
    using namespace testing;

    wlcs::Client client{the_server()};

    auto surface = client.create_visible_surface(200, 200);

    auto const width = 200, height = 200;
    auto const incorrect_stride = width;

    auto fd = wlcs::helpers::create_anonymous_file(height * incorrect_stride);

    auto shm_pool = wl_shm_create_pool(client.shm(), fd, height * incorrect_stride);

    auto bad_buffer = wl_shm_pool_create_buffer(
        shm_pool,
        0,
        width, height,
        incorrect_stride, // Stride is in bytes, not pixels, so this is ¼ the correct value.
        WL_SHM_FORMAT_ARGB8888);

    try
    {
        /* Buffer creation should fail, so all we need is for the create_buffer
         * call to be processed
         */
        client.roundtrip();
    }
    catch (wlcs::ProtocolError const& err)
    {
        wl_buffer_destroy(bad_buffer);
        EXPECT_THAT(err.error_code(), Eq(WL_SHM_ERROR_INVALID_STRIDE));
        EXPECT_THAT(err.interface(), Eq(&wl_shm_pool_interface));
        return;
    }

    FAIL() << "Expected protocol error not raised";
}

// This should be identical to the first tests case of the previous test. It tests if a 2nd instance of the server can
// successfully handle a bad buffer. There have been issues with the server installing a SIGBUS handler (via
// wl_shm_buffer_begin_access()) that only works for the first server instance.

using SecondBadBufferTest = wlcs::InProcessServer;

TEST_F(SecondBadBufferTest, DISABLED_test_truncated_shm_file)
{
	using namespace testing;

	wlcs::Client client{the_server()};

	bool buffer_consumed{false};

	auto surface = client.create_visible_surface(200, 200);

	wl_buffer* bad_buffer = create_bad_shm_buffer(client, 200, 200);

	wl_surface_attach(surface, bad_buffer, 0, 0);
	wl_surface_damage(surface, 0, 0, 200, 200);

	surface.add_frame_callback([&buffer_consumed](int) { buffer_consumed = true; });

	wl_surface_commit(surface);

	try
	{
		client.dispatch_until([&buffer_consumed]() { return buffer_consumed; });
	}
	catch (wlcs::ProtocolError const& err)
	{
		wl_buffer_destroy(bad_buffer);
		EXPECT_THAT(err.error_code(), Eq(WL_SHM_ERROR_INVALID_FD));
		EXPECT_THAT(err.interface(), Eq(&wl_buffer_interface));
		return;
	}

	FAIL() << "Expected protocol error not raised";
}