glib/gio/tests/socket-service.c
Philip Withnall f25c3f2704 tests: Fix unlikely race in socket-service test
It’s occasionally possible for the cancellation of the service to happen
before connection_cb() gets scheduled in the other thread. The
locking/unlocking order of mutex_712570 requires:
 • test_threaded_712570(): lock mutex
 • test_threaded_712570(): start wait loop
 • connection_cb(): lock mutex
 • test_threaded_socket_service_finalize(): unlock mutex
 • test_threaded_712570(): end wait loop
 • test_threaded_712570(): unlock mutex

Fix that by quitting the main loop once connection_cb() has been called
(i.e. once the server thread has received the incoming connection
request), rather than just after the client thread (main thread) has
sent a connection request.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Helps: #1679
2019-02-21 18:15:49 +00:00

568 lines
17 KiB
C

/* GLib testing framework examples and tests
*
* Copyright 2014 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see
* <http://www.gnu.org/licenses/>.
*/
#include <gio/gio.h>
static void
active_notify_cb (GSocketService *service,
GParamSpec *pspec,
gpointer data)
{
gboolean *success = (gboolean *)data;
if (g_socket_service_is_active (service))
*success = TRUE;
}
static void
connected_cb (GObject *client,
GAsyncResult *result,
gpointer user_data)
{
GSocketService *service = G_SOCKET_SERVICE (user_data);
GSocketConnection *conn;
GError *error = NULL;
g_assert_true (g_socket_service_is_active (service));
conn = g_socket_client_connect_finish (G_SOCKET_CLIENT (client), result, &error);
g_assert_no_error (error);
g_object_unref (conn);
g_socket_service_stop (service);
g_assert_false (g_socket_service_is_active (service));
}
static void
test_start_stop (void)
{
gboolean success = FALSE;
GInetAddress *iaddr;
GSocketAddress *saddr, *listening_addr;
GSocketService *service;
GError *error = NULL;
GSocketClient *client;
iaddr = g_inet_address_new_loopback (G_SOCKET_FAMILY_IPV4);
saddr = g_inet_socket_address_new (iaddr, 0);
g_object_unref (iaddr);
/* instanciate with g_object_new so we can pass active = false */
service = g_object_new (G_TYPE_SOCKET_SERVICE, "active", FALSE, NULL);
g_assert_false (g_socket_service_is_active (service));
g_signal_connect (service, "notify::active", G_CALLBACK (active_notify_cb), &success);
g_socket_listener_add_address (G_SOCKET_LISTENER (service),
saddr,
G_SOCKET_TYPE_STREAM,
G_SOCKET_PROTOCOL_TCP,
NULL,
&listening_addr,
&error);
g_assert_no_error (error);
g_object_unref (saddr);
client = g_socket_client_new ();
g_socket_client_connect_async (client,
G_SOCKET_CONNECTABLE (listening_addr),
NULL,
connected_cb, service);
g_object_unref (client);
g_object_unref (listening_addr);
g_socket_service_start (service);
g_assert_true (g_socket_service_is_active (service));
do
g_main_context_iteration (NULL, TRUE);
while (!success);
g_object_unref (service);
}
GMutex mutex_712570;
GCond cond_712570;
volatile gboolean finalized;
GType test_threaded_socket_service_get_type (void);
typedef GThreadedSocketService TestThreadedSocketService;
typedef GThreadedSocketServiceClass TestThreadedSocketServiceClass;
G_DEFINE_TYPE (TestThreadedSocketService, test_threaded_socket_service, G_TYPE_THREADED_SOCKET_SERVICE)
static void
test_threaded_socket_service_init (TestThreadedSocketService *service)
{
}
static void
test_threaded_socket_service_finalize (GObject *object)
{
G_OBJECT_CLASS (test_threaded_socket_service_parent_class)->finalize (object);
/* Signal the main thread that finalization completed successfully
* rather than hanging.
*/
finalized = TRUE;
g_cond_signal (&cond_712570);
g_mutex_unlock (&mutex_712570);
}
static void
test_threaded_socket_service_class_init (TestThreadedSocketServiceClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = test_threaded_socket_service_finalize;
}
static gboolean
connection_cb (GThreadedSocketService *service,
GSocketConnection *connection,
GObject *source_object,
gpointer user_data)
{
GMainLoop *loop = user_data;
/* Since the connection attempt has come through to be handled, stop the main
* thread waiting for it; this causes the #GSocketService to be stopped. */
g_main_loop_quit (loop);
/* Block until the main thread has dropped its ref to @service, so that we
* will drop the final ref from this thread.
*/
g_mutex_lock (&mutex_712570);
/* The service should now have 1 ref owned by the current "run"
* signal emission, and another added by GThreadedSocketService for
* this thread. Both will be dropped after we return.
*/
g_assert_cmpint (G_OBJECT (service)->ref_count, ==, 2);
return FALSE;
}
static void
client_connected_cb (GObject *client,
GAsyncResult *result,
gpointer user_data)
{
GSocketConnection *conn;
GError *error = NULL;
conn = g_socket_client_connect_finish (G_SOCKET_CLIENT (client), result, &error);
g_assert_no_error (error);
g_object_unref (conn);
}
static void
test_threaded_712570 (void)
{
GSocketService *service;
GSocketAddress *addr, *listening_addr;
GMainLoop *loop;
GSocketClient *client;
GError *error = NULL;
g_test_bug ("712570");
g_mutex_lock (&mutex_712570);
service = g_object_new (test_threaded_socket_service_get_type (), NULL);
addr = g_inet_socket_address_new_from_string ("127.0.0.1", 0);
g_socket_listener_add_address (G_SOCKET_LISTENER (service),
addr,
G_SOCKET_TYPE_STREAM,
G_SOCKET_PROTOCOL_TCP,
NULL,
&listening_addr,
&error);
g_assert_no_error (error);
g_object_unref (addr);
loop = g_main_loop_new (NULL, FALSE);
g_signal_connect (service, "run", G_CALLBACK (connection_cb), loop);
client = g_socket_client_new ();
g_socket_client_connect_async (client,
G_SOCKET_CONNECTABLE (listening_addr),
NULL,
client_connected_cb, loop);
g_object_unref (client);
g_object_unref (listening_addr);
g_main_loop_run (loop);
g_main_loop_unref (loop);
/* Stop the service and then wait for it to asynchronously cancel
* its outstanding accept() call (and drop the associated ref).
* At least one main context iteration is required in some circumstances
* to ensure that the cancellation actually happens.
*/
g_socket_service_stop (G_SOCKET_SERVICE (service));
g_assert_false (g_socket_service_is_active (G_SOCKET_SERVICE (service)));
do
g_main_context_iteration (NULL, TRUE);
while (G_OBJECT (service)->ref_count > 3);
/* Wait some more iterations, as #GTask results are deferred to the next
* #GMainContext iteration, and propagation of a #GTask result takes an
* additional ref on the source object. */
g_main_context_iteration (NULL, FALSE);
/* Drop our ref, then unlock the mutex and wait for the service to be
* finalized. (Without the fix for 712570 it would hang forever here.)
*/
g_object_unref (service);
while (!finalized)
g_cond_wait (&cond_712570, &mutex_712570);
g_mutex_unlock (&mutex_712570);
}
static void
closed_read_write_async_cb (GSocketConnection *conn,
GAsyncResult *result,
gpointer user_data)
{
GError *error = NULL;
gboolean res;
res = g_io_stream_close_finish (G_IO_STREAM (conn), result, &error);
g_assert_no_error (error);
g_assert_true (res);
}
typedef struct {
GSocketConnection *conn;
guint8 *data;
} WriteAsyncData;
static void
written_read_write_async_cb (GOutputStream *ostream,
GAsyncResult *result,
gpointer user_data)
{
WriteAsyncData *data = user_data;
GError *error = NULL;
gboolean res;
gsize bytes_written;
GSocketConnection *conn;
conn = data->conn;
g_free (data->data);
g_free (data);
res = g_output_stream_write_all_finish (ostream, result, &bytes_written, &error);
g_assert_no_error (error);
g_assert_true (res);
g_assert_cmpuint (bytes_written, ==, 20);
g_io_stream_close_async (G_IO_STREAM (conn),
G_PRIORITY_DEFAULT,
NULL,
(GAsyncReadyCallback) closed_read_write_async_cb,
NULL);
g_object_unref (conn);
}
static void
connected_read_write_async_cb (GObject *client,
GAsyncResult *result,
gpointer user_data)
{
GSocketConnection *conn;
GOutputStream *ostream;
GError *error = NULL;
WriteAsyncData *data;
gsize i;
GSocketConnection **sconn = user_data;
conn = g_socket_client_connect_finish (G_SOCKET_CLIENT (client), result, &error);
g_assert_no_error (error);
g_assert_nonnull (conn);
ostream = g_io_stream_get_output_stream (G_IO_STREAM (conn));
data = g_new0 (WriteAsyncData, 1);
data->conn = conn;
data->data = g_new0 (guint8, 20);
for (i = 0; i < 20; i++)
data->data[i] = i;
g_output_stream_write_all_async (ostream,
data->data,
20,
G_PRIORITY_DEFAULT,
NULL,
(GAsyncReadyCallback) written_read_write_async_cb,
data /* stolen */);
*sconn = g_object_ref (conn);
}
typedef struct {
GSocketConnection *conn;
GOutputVector *vectors;
guint n_vectors;
guint8 *data;
} WritevAsyncData;
static void
writtenv_read_write_async_cb (GOutputStream *ostream,
GAsyncResult *result,
gpointer user_data)
{
WritevAsyncData *data = user_data;
GError *error = NULL;
gboolean res;
gsize bytes_written;
GSocketConnection *conn;
conn = data->conn;
g_free (data->data);
g_free (data);
res = g_output_stream_writev_all_finish (ostream, result, &bytes_written, &error);
g_assert_no_error (error);
g_assert_true (res);
g_assert_cmpuint (bytes_written, ==, 20);
g_io_stream_close_async (G_IO_STREAM (conn),
G_PRIORITY_DEFAULT,
NULL,
(GAsyncReadyCallback) closed_read_write_async_cb,
NULL);
g_object_unref (conn);
}
static void
connected_read_writev_async_cb (GObject *client,
GAsyncResult *result,
gpointer user_data)
{
GSocketConnection *conn;
GOutputStream *ostream;
GError *error = NULL;
WritevAsyncData *data;
gsize i;
GSocketConnection **sconn = user_data;
conn = g_socket_client_connect_finish (G_SOCKET_CLIENT (client), result, &error);
g_assert_no_error (error);
g_assert_nonnull (conn);
ostream = g_io_stream_get_output_stream (G_IO_STREAM (conn));
data = g_new0 (WritevAsyncData, 1);
data->conn = conn;
data->vectors = g_new0 (GOutputVector, 3);
data->n_vectors = 3;
data->data = g_new0 (guint8, 20);
for (i = 0; i < 20; i++)
data->data[i] = i;
data->vectors[0].buffer = data->data;
data->vectors[0].size = 5;
data->vectors[1].buffer = data->data + 5;
data->vectors[1].size = 10;
data->vectors[2].buffer = data->data + 15;
data->vectors[2].size = 5;
g_output_stream_writev_all_async (ostream,
data->vectors,
data->n_vectors,
G_PRIORITY_DEFAULT,
NULL,
(GAsyncReadyCallback) writtenv_read_write_async_cb,
data /* stolen */);
*sconn = g_object_ref (conn);
}
typedef struct {
GSocketConnection *conn;
guint8 *data;
} ReadAsyncData;
static void
read_read_write_async_cb (GInputStream *istream,
GAsyncResult *result,
gpointer user_data)
{
ReadAsyncData *data = user_data;
GError *error = NULL;
gboolean res;
gsize bytes_read;
GSocketConnection *conn;
const guint8 expected_data[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 };
res = g_input_stream_read_all_finish (istream, result, &bytes_read, &error);
g_assert_no_error (error);
g_assert_true (res);
g_assert_cmpmem (expected_data, sizeof expected_data, data->data, bytes_read);
conn = data->conn;
g_object_set_data (G_OBJECT (conn), "test-data-read", GINT_TO_POINTER (TRUE));
g_free (data->data);
g_free (data);
g_io_stream_close_async (G_IO_STREAM (conn),
G_PRIORITY_DEFAULT,
NULL,
(GAsyncReadyCallback) closed_read_write_async_cb,
NULL);
g_object_unref (conn);
}
static void
incoming_read_write_async_cb (GSocketService *service,
GSocketConnection *conn,
GObject *source_object,
gpointer user_data)
{
ReadAsyncData *data;
GSocketConnection **cconn = user_data;
GInputStream *istream;
istream = g_io_stream_get_input_stream (G_IO_STREAM (conn));
data = g_new0 (ReadAsyncData, 1);
data->conn = g_object_ref (conn);
data->data = g_new0 (guint8, 20);
g_input_stream_read_all_async (istream,
data->data,
20,
G_PRIORITY_DEFAULT,
NULL,
(GAsyncReadyCallback) read_read_write_async_cb,
data /* stolen */);
*cconn = g_object_ref (conn);
}
static void
test_read_write_async_internal (gboolean writev)
{
GInetAddress *iaddr;
GSocketAddress *saddr, *listening_addr;
GSocketService *service;
GError *error = NULL;
GSocketClient *client;
GSocketConnection *sconn = NULL, *cconn = NULL;
iaddr = g_inet_address_new_loopback (G_SOCKET_FAMILY_IPV4);
saddr = g_inet_socket_address_new (iaddr, 0);
g_object_unref (iaddr);
service = g_socket_service_new ();
g_socket_listener_add_address (G_SOCKET_LISTENER (service),
saddr,
G_SOCKET_TYPE_STREAM,
G_SOCKET_PROTOCOL_TCP,
NULL,
&listening_addr,
&error);
g_assert_no_error (error);
g_object_unref (saddr);
g_signal_connect (service, "incoming", G_CALLBACK (incoming_read_write_async_cb), &sconn);
client = g_socket_client_new ();
if (writev)
g_socket_client_connect_async (client,
G_SOCKET_CONNECTABLE (listening_addr),
NULL,
connected_read_writev_async_cb,
&cconn);
else
g_socket_client_connect_async (client,
G_SOCKET_CONNECTABLE (listening_addr),
NULL,
connected_read_write_async_cb,
&cconn);
g_object_unref (client);
g_object_unref (listening_addr);
g_socket_service_start (service);
g_assert_true (g_socket_service_is_active (service));
do
{
g_main_context_iteration (NULL, TRUE);
}
while (!sconn || !cconn ||
!g_io_stream_is_closed (G_IO_STREAM (sconn)) ||
!g_io_stream_is_closed (G_IO_STREAM (cconn)));
g_assert_true (GPOINTER_TO_INT (g_object_get_data (G_OBJECT (sconn), "test-data-read")));
g_object_unref (sconn);
g_object_unref (cconn);
g_object_unref (service);
}
/* Test if connecting to a socket service and asynchronously writing data on
* one side followed by reading the same data on the other side of the
* connection works correctly
*/
static void
test_read_write_async (void)
{
test_read_write_async_internal (FALSE);
}
/* Test if connecting to a socket service and asynchronously writing data on
* one side followed by reading the same data on the other side of the
* connection works correctly. This uses writev() instead of normal write().
*/
static void
test_read_writev_async (void)
{
test_read_write_async_internal (TRUE);
}
int
main (int argc,
char *argv[])
{
g_test_init (&argc, &argv, NULL);
g_test_bug_base ("http://bugzilla.gnome.org/");
g_test_add_func ("/socket-service/start-stop", test_start_stop);
g_test_add_func ("/socket-service/threaded/712570", test_threaded_712570);
g_test_add_func ("/socket-service/read_write_async", test_read_write_async);
g_test_add_func ("/socket-service/read_writev_async", test_read_writev_async);
return g_test_run();
}