Commit 7f4864e5 authored by Dan Winship's avatar Dan Winship

Bug 505361 - gunixinputstream.c assumes poll() available

	Bug 509446 - portable blocking gio cancellation

	* gcancellable.c (g_cancellable_make_pollfd): New method to make a
	GPollFD for a cancellable (which is slightly more complicated on
	Windows than Unix).

	* gunixinputstream.c (g_unix_input_stream_read):
	* gunixoutputstream.c (g_unix_output_stream_write): Use
	g_cancellable_make_pollfd() and g_poll() rather than using poll()
	directly.

	* tests/unix-streams.c: test of GUnixInputStream,
	GUnixOutputStream, and GCancellable.

svn path=/trunk/; revision=7553
parent ea0970e9
......@@ -932,6 +932,7 @@ g_cancellable_new
g_cancellable_is_cancelled
g_cancellable_set_error_if_cancelled
g_cancellable_get_fd
g_cancellable_make_pollfd
g_cancellable_get_current
g_cancellable_pop_current
g_cancellable_push_current
......
2008-09-26 Dan Winship <danw@gnome.org>
Bug 505361 – gunixinputstream.c assumes poll() available
Bug 509446 – portable blocking gio cancellation
* gcancellable.c (g_cancellable_make_pollfd): New method to make a
GPollFD for a cancellable (which is slightly more complicated on
Windows than Unix).
* gunixinputstream.c (g_unix_input_stream_read):
* gunixoutputstream.c (g_unix_output_stream_write): Use
g_cancellable_make_pollfd() and g_poll() rather than using poll()
directly.
* tests/unix-streams.c: test of GUnixInputStream,
GUnixOutputStream, and GCancellable.
2008-09-26 Dan Winship <danw@gnome.org>
* gdesktopappinfo.c (get_all_desktop_entries_for_mime_type): add a
......
......@@ -59,6 +59,10 @@ struct _GCancellable
guint cancelled : 1;
guint allocated_pipe : 1;
int cancel_pipe[2];
#ifdef G_OS_WIN32
GIOChannel *read_channel;
#endif
};
static guint signals[LAST_SIGNAL] = { 0 };
......@@ -79,6 +83,11 @@ g_cancellable_finalize (GObject *object)
if (cancellable->cancel_pipe[1] != -1)
close (cancellable->cancel_pipe[1]);
#ifdef G_OS_WIN32
if (cancellable->read_channel)
g_io_channel_unref (cancellable->read_channel);
#endif
G_OBJECT_CLASS (g_cancellable_parent_class)->finalize (object);
}
......@@ -304,6 +313,15 @@ g_cancellable_reset (GCancellable *cancellable)
if (cancellable->cancelled)
{
char ch;
#ifdef G_OS_WIN32
if (cancellable->read_channel)
{
gsize bytes_read;
g_io_channel_read_chars (cancellable->read_channel, &ch, 1,
&bytes_read, NULL);
}
else
#endif
if (cancellable->cancel_pipe[0] != -1)
read (cancellable->cancel_pipe[0], &ch, 1);
cancellable->cancelled = FALSE;
......@@ -359,7 +377,9 @@ g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
* Gets the file descriptor for a cancellable job. This can be used to
* implement cancellable operations on Unix systems. The returned fd will
* turn readable when @cancellable is cancelled.
*
*
* See also g_cancellable_make_pollfd().
*
* Returns: A valid file descriptor. %-1 if the file descriptor
* is not supported, or on errors.
**/
......@@ -383,6 +403,41 @@ g_cancellable_get_fd (GCancellable *cancellable)
return fd;
}
/**
* g_cancellable_make_pollfd:
* @cancellable: a #GCancellable.
* @pollfd: a pointer to a #GPollFD
*
* Creates a #GPollFD corresponding to @cancellable; this can be passed
* to g_poll() and used to poll for cancellation.
**/
void
g_cancellable_make_pollfd (GCancellable *cancellable, GPollFD *pollfd)
{
g_return_if_fail (G_IS_CANCELLABLE (cancellable));
g_return_if_fail (pollfd != NULL);
#ifdef G_OS_WIN32
if (!cancellable->read_channel)
{
int fd = g_cancellable_get_fd (cancellable);
cancellable->read_channel = g_io_channel_win32_new_fd (fd);
g_io_channel_set_buffered (cancellable->read_channel, FALSE);
g_io_channel_set_flags (cancellable->read_channel,
G_IO_FLAG_NONBLOCK, NULL);
g_io_channel_set_encoding (cancellable->read_channel, NULL, NULL);
}
g_io_channel_win32_make_pollfd (cancellable->read_channel, G_IO_IN, pollfd);
/* (We need to keep cancellable->read_channel around, because it's
* keeping track of state related to the pollfd.)
*/
#else /* !G_OS_WIN32 */
pollfd->fd = g_cancellable_get_fd (cancellable);
pollfd->events = G_IO_IN;
#endif /* G_OS_WIN32 */
pollfd->revents = 0;
}
/**
* g_cancellable_cancel:
* @cancellable: a #GCancellable object.
......
......@@ -68,7 +68,11 @@ GCancellable *g_cancellable_new (void);
gboolean g_cancellable_is_cancelled (GCancellable *cancellable);
gboolean g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
GError **error);
int g_cancellable_get_fd (GCancellable *cancellable);
void g_cancellable_make_pollfd (GCancellable *cancellable,
GPollFD *pollfd);
GCancellable *g_cancellable_get_current (void);
void g_cancellable_push_current (GCancellable *cancellable);
void g_cancellable_pop_current (GCancellable *cancellable);
......
......@@ -124,6 +124,7 @@ g_cancellable_new
g_cancellable_is_cancelled
g_cancellable_set_error_if_cancelled
g_cancellable_get_fd
g_cancellable_make_pollfd
g_cancellable_get_current
g_cancellable_push_current
g_cancellable_pop_current
......
......@@ -28,7 +28,6 @@
#include <errno.h>
#include <stdio.h>
#include <fcntl.h>
#include <poll.h>
#include <glib.h>
#include <glib/gstdio.h>
......@@ -173,23 +172,18 @@ g_unix_input_stream_read (GInputStream *stream,
{
GUnixInputStream *unix_stream;
gssize res;
struct pollfd poll_fds[2];
GPollFD poll_fds[2];
int poll_ret;
int cancel_fd;
unix_stream = G_UNIX_INPUT_STREAM (stream);
cancel_fd = g_cancellable_get_fd (cancellable);
if (cancel_fd != -1)
if (cancellable)
{
poll_fds[0].fd = unix_stream->priv->fd;
poll_fds[0].events = G_IO_IN;
g_cancellable_make_pollfd (cancellable, &poll_fds[1]);
do
{
poll_fds[0].events = POLLIN;
poll_fds[0].fd = unix_stream->priv->fd;
poll_fds[1].events = POLLIN;
poll_fds[1].fd = cancel_fd;
poll_ret = poll (poll_fds, 2, -1);
}
poll_ret = g_poll (poll_fds, 2, -1);
while (poll_ret == -1 && errno == EINTR);
if (poll_ret == -1)
......@@ -346,7 +340,7 @@ g_unix_input_stream_read_async (GInputStream *stream,
data->stream = unix_stream;
source = _g_fd_source_new (unix_stream->priv->fd,
POLLIN,
G_IO_IN,
cancellable);
g_source_set_callback (source, (GSourceFunc)read_async_cb, data, g_free);
......
......@@ -28,7 +28,6 @@
#include <errno.h>
#include <stdio.h>
#include <fcntl.h>
#include <poll.h>
#include <glib.h>
#include <glib/gstdio.h>
......@@ -161,23 +160,18 @@ g_unix_output_stream_write (GOutputStream *stream,
{
GUnixOutputStream *unix_stream;
gssize res;
struct pollfd poll_fds[2];
GPollFD poll_fds[2];
int poll_ret;
int cancel_fd;
unix_stream = G_UNIX_OUTPUT_STREAM (stream);
cancel_fd = g_cancellable_get_fd (cancellable);
if (cancel_fd != -1)
if (cancellable)
{
poll_fds[0].fd = unix_stream->priv->fd;
poll_fds[0].events = G_IO_OUT;
g_cancellable_make_pollfd (cancellable, &poll_fds[1]);
do
{
poll_fds[0].events = POLLOUT;
poll_fds[0].fd = unix_stream->priv->fd;
poll_fds[1].events = POLLIN;
poll_fds[1].fd = cancel_fd;
poll_ret = poll (poll_fds, 2, -1);
}
poll_ret = g_poll (poll_fds, 2, -1);
while (poll_ret == -1 && errno == EINTR);
if (poll_ret == -1)
......@@ -335,7 +329,7 @@ g_unix_output_stream_write_async (GOutputStream *stream,
data->stream = unix_stream;
source = _g_fd_source_new (unix_stream->priv->fd,
POLLOUT,
G_IO_OUT,
cancellable);
g_source_set_callback (source, (GSourceFunc)write_async_cb, data, g_free);
......
......@@ -9,7 +9,7 @@ if ! which readelf 2>/dev/null >/dev/null; then
exit 0
fi
SKIP='\<g_access\|\<g_array_\|\<g_ascii\|\<g_list_\|\<g_assertion_message\|\<g_warn_message\|\<g_atomic\|\<g_build_filename\|\<g_byte_array\|\<g_child_watch\|\<g_convert\|\<g_dir_\|\<g_error_\|\<g_clear_error\|\<g_file_error_quark\|\<g_file_get_contents\|\<g_file_set_contents\|\<g_file_test\|\<g_file_read_link\|\<g_filename_\|\<g_find_program_in_path\|\<g_free\|\<g_get_\|\<g_getenv\|\<g_hash_table_\|\<g_idle_\|\<g_intern_static_string\|\<g_io_channel_\|\<g_key_file_\|\<g_listenv\|\<g_locale_to_utf8\|\<g_log\|\<g_main_context_wakeup\|\<g_malloc\|\<g_markup_\|\<g_mkdir_\|\<g_mkstemp\|\<g_module_\|\<g_object_\|\<g_once_\|\<g_param_spec_\|\<g_path_\|\<g_printerr\|\<g_propagate_error\|\<g_ptr_array_\|\<g_qsort_\|\<g_quark_\|\<g_queue_\|\<g_realloc\|\<g_return_if_fail\|\<g_set_error\|\<g_shell_\|\<g_signal_\|\<g_slice_\|\<g_slist_\|\<g_snprintf\|\<g_source_\|\<g_spawn_\|\<g_static_\|\<g_str\|\<g_thread_pool_\|\<g_time_val_add\|\<g_timeout_\|\<g_type_\|\<g_unlink\|\<g_uri_\|\<g_utf8_\|\<g_value_\|\<g_enum_\|\<g_flags_\|\<g_checksum\|\<g_io_add_watch\|\<g_bit_'
SKIP='\<g_access\|\<g_array_\|\<g_ascii\|\<g_list_\|\<g_assertion_message\|\<g_warn_message\|\<g_atomic\|\<g_build_filename\|\<g_byte_array\|\<g_child_watch\|\<g_convert\|\<g_dir_\|\<g_error_\|\<g_clear_error\|\<g_file_error_quark\|\<g_file_get_contents\|\<g_file_set_contents\|\<g_file_test\|\<g_file_read_link\|\<g_filename_\|\<g_find_program_in_path\|\<g_free\|\<g_get_\|\<g_getenv\|\<g_hash_table_\|\<g_idle_\|\<g_intern_static_string\|\<g_io_channel_\|\<g_key_file_\|\<g_listenv\|\<g_locale_to_utf8\|\<g_log\|\<g_main_context_wakeup\|\<g_malloc\|\<g_markup_\|\<g_mkdir_\|\<g_mkstemp\|\<g_module_\|\<g_object_\|\<g_once_\|\<g_param_spec_\|\<g_path_\|\<g_printerr\|\<g_propagate_error\|\<g_ptr_array_\|\<g_qsort_\|\<g_quark_\|\<g_queue_\|\<g_realloc\|\<g_return_if_fail\|\<g_set_error\|\<g_shell_\|\<g_signal_\|\<g_slice_\|\<g_slist_\|\<g_snprintf\|\<g_source_\|\<g_spawn_\|\<g_static_\|\<g_str\|\<g_thread_pool_\|\<g_time_val_add\|\<g_timeout_\|\<g_type_\|\<g_unlink\|\<g_uri_\|\<g_utf8_\|\<g_value_\|\<g_enum_\|\<g_flags_\|\<g_checksum\|\<g_io_add_watch\|\<g_bit_\|\<g_poll'
for so in .libs/lib*.so; do
echo Checking $so for local PLT entries
......
......@@ -25,7 +25,7 @@ TEST_PROGS += \
data-output-stream
if OS_UNIX
TEST_PROGS += live-g-file
TEST_PROGS += live-g-file unix-streams
endif
memory_input_stream_SOURCES = memory-input-stream.c
......@@ -48,3 +48,8 @@ data_output_stream_LDADD = $(progs_ldadd)
live_g_file_SOURCES = live-g-file.c
live_g_file_LDADD = $(progs_ldadd)
unix_streams_SOURCES = unix-streams.c
unix_streams_LDADD = $(progs_ldadd) \
$(top_builddir)/gthread/libgthread-2.0.la
/* GLib testing framework examples and tests
* Copyright (C) 2008 Red Hat, Inc
*
* This work is provided "as is"; redistribution and modification
* in whole or in part, in any medium, physical or electronic is
* permitted without restriction.
*
* This work 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.
*
* In no event shall the authors or contributors be liable for any
* direct, indirect, incidental, special, exemplary, or consequential
* damages (including, but not limited to, procurement of substitute
* goods or services; loss of use, data, or profits; or business
* interruption) however caused and on any theory of liability, whether
* in contract, strict liability, or tort (including negligence or
* otherwise) arising in any way out of the use of this software, even
* if advised of the possibility of such damage.
*/
#include <glib/glib.h>
#include <gio/gio.h>
#include <gio/gunixinputstream.h>
#include <gio/gunixoutputstream.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#define DATA "abcdefghijklmnopqrstuvwxyz"
int writer_pipe[2], reader_pipe[2];
GCancellable *writer_cancel, *reader_cancel, *main_cancel;
GMainLoop *loop;
static gpointer
writer_thread (gpointer user_data)
{
GOutputStream *out;
gssize nwrote, offset;
GError *err = NULL;
out = g_unix_output_stream_new (writer_pipe[1], TRUE);
do
{
g_usleep (10);
offset = 0;
while (offset < sizeof (DATA))
{
nwrote = g_output_stream_write (out, DATA + offset,
sizeof (DATA) - offset,
writer_cancel, &err);
if (nwrote <= 0 || err != NULL)
break;
offset += nwrote;
}
g_assert (nwrote > 0 || err != NULL);
}
while (err == NULL);
if (g_cancellable_is_cancelled (writer_cancel))
{
g_cancellable_cancel (main_cancel);
g_object_unref (out);
return NULL;
}
g_warning ("writer: %s", err->message);
g_assert_not_reached ();
}
static gpointer
reader_thread (gpointer user_data)
{
GInputStream *in;
gssize nread, total;
GError *err = NULL;
char buf[sizeof (DATA)];
in = g_unix_input_stream_new (reader_pipe[0], TRUE);
do
{
total = 0;
while (total < sizeof (DATA))
{
nread = g_input_stream_read (in, buf + total, sizeof (buf) - total,
reader_cancel, &err);
if (nread <= 0 || err != NULL)
break;
total += nread;
}
if (err)
break;
if (nread == 0)
{
g_assert (err == NULL);
/* pipe closed */
g_object_unref (in);
return NULL;
}
g_assert_cmpstr (buf, ==, DATA);
g_assert (!g_cancellable_is_cancelled (reader_cancel));
}
while (err == NULL);
g_warning ("reader: %s", err->message);
g_assert_not_reached ();
}
char main_buf[sizeof (DATA)];
gssize main_len, main_offset;
static void readable (GObject *source, GAsyncResult *res, gpointer user_data);
static void writable (GObject *source, GAsyncResult *res, gpointer user_data);
static void
do_main_cancel (GOutputStream *out)
{
g_output_stream_close (out, NULL, NULL);
g_main_loop_quit (loop);
}
static void
readable (GObject *source, GAsyncResult *res, gpointer user_data)
{
GInputStream *in = G_INPUT_STREAM (source);
GOutputStream *out = user_data;
GError *err = NULL;
main_len = g_input_stream_read_finish (in, res, &err);
if (g_cancellable_is_cancelled (main_cancel))
{
do_main_cancel (out);
return;
}
g_assert (err == NULL);
main_offset = 0;
g_output_stream_write_async (out, main_buf, main_len,
G_PRIORITY_DEFAULT, main_cancel,
writable, in);
}
static void
writable (GObject *source, GAsyncResult *res, gpointer user_data)
{
GOutputStream *out = G_OUTPUT_STREAM (source);
GInputStream *in = user_data;
GError *err = NULL;
gssize nwrote;
nwrote = g_output_stream_write_finish (out, res, &err);
if (g_cancellable_is_cancelled (main_cancel))
{
do_main_cancel (out);
return;
}
g_assert (err == NULL);
g_assert_cmpint (nwrote, <=, main_len - main_offset);
main_offset += nwrote;
if (main_offset == main_len)
{
g_input_stream_read_async (in, main_buf, sizeof (main_buf),
G_PRIORITY_DEFAULT, main_cancel,
readable, out);
}
else
{
g_output_stream_write_async (out, main_buf + main_offset,
main_len - main_offset,
G_PRIORITY_DEFAULT, main_cancel,
writable, in);
}
}
static gboolean
timeout (gpointer cancellable)
{
g_cancellable_cancel (cancellable);
return FALSE;
}
static void
test_pipe_io (void)
{
GThread *writer, *reader;
GInputStream *in;
GOutputStream *out;
/* Split off two (additional) threads, a reader and a writer. From
* the writer thread, write data synchronously in small chunks,
* which gets read asynchronously by the main thread and then
* written asynchronously to the reader thread, which reads it
* synchronously. Eventually a timeout in the main thread will cause
* it to cancel the writer thread, which will in turn cancel the
* read op in the main thread, which will then close the pipe to
* the reader thread, causing the read op to fail.
*/
g_assert (pipe (writer_pipe) == 0 && pipe (reader_pipe) == 0);
writer_cancel = g_cancellable_new ();
reader_cancel = g_cancellable_new ();
main_cancel = g_cancellable_new ();
writer = g_thread_create (writer_thread, NULL, TRUE, NULL);
reader = g_thread_create (reader_thread, NULL, TRUE, NULL);
in = g_unix_input_stream_new (writer_pipe[0], TRUE);
out = g_unix_output_stream_new (reader_pipe[1], TRUE);
g_input_stream_read_async (in, main_buf, sizeof (main_buf),
G_PRIORITY_DEFAULT, main_cancel,
readable, out);
g_timeout_add (500, timeout, writer_cancel);
loop = g_main_loop_new (NULL, TRUE);
g_main_loop_run (loop);
g_main_loop_unref (loop);
g_thread_join (reader);
g_thread_join (writer);
g_object_unref (main_cancel);
g_object_unref (reader_cancel);
g_object_unref (writer_cancel);
g_object_unref (in);
g_object_unref (out);
}
int
main (int argc,
char *argv[])
{
g_thread_init (NULL);
g_type_init ();
g_test_init (&argc, &argv, NULL);
g_test_add_func ("/unix-streams/pipe-io-test", test_pipe_io);
return g_test_run();
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment