1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
25 #include <sys/types.h>
33 #include <glib/gstdio.h>
35 #include "gsimpleasyncresult.h"
36 #include "gunixinputstream.h"
37 #include "gcancellable.h"
38 #include "gasynchelper.h"
39 #include "gfiledescriptorbased.h"
44 * SECTION:gunixinputstream
45 * @short_description: Streaming input operations for UNIX file descriptors
46 * @include: gio/gunixinputstream.h
47 * @see_also: #GInputStream
49 * #GUnixInputStream implements #GInputStream for reading from a UNIX
50 * file descriptor, including asynchronous operations. (If the file
51 * descriptor refers to a socket or pipe, this will use poll() to do
52 * asynchronous I/O. If it refers to a regular file, it will fall back
53 * to doing asynchronous I/O in another thread.)
55 * Note that <filename><gio/gunixinputstream.h></filename> belongs
56 * to the UNIX-specific GIO interfaces, thus you have to use the
57 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
66 static void g_unix_input_stream_pollable_iface_init (GPollableInputStreamInterface *iface);
67 static void g_unix_input_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface);
69 G_DEFINE_TYPE_WITH_CODE (GUnixInputStream, g_unix_input_stream, G_TYPE_INPUT_STREAM,
70 G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_INPUT_STREAM,
71 g_unix_input_stream_pollable_iface_init)
72 G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED,
73 g_unix_input_stream_file_descriptor_based_iface_init)
76 struct _GUnixInputStreamPrivate {
79 guint is_pipe_or_socket : 1;
82 static void g_unix_input_stream_set_property (GObject *object,
86 static void g_unix_input_stream_get_property (GObject *object,
90 static gssize g_unix_input_stream_read (GInputStream *stream,
93 GCancellable *cancellable,
95 static gboolean g_unix_input_stream_close (GInputStream *stream,
96 GCancellable *cancellable,
98 static void g_unix_input_stream_read_async (GInputStream *stream,
102 GCancellable *cancellable,
103 GAsyncReadyCallback callback,
105 static gssize g_unix_input_stream_read_finish (GInputStream *stream,
106 GAsyncResult *result,
108 static void g_unix_input_stream_skip_async (GInputStream *stream,
111 GCancellable *cancellable,
112 GAsyncReadyCallback callback,
114 static gssize g_unix_input_stream_skip_finish (GInputStream *stream,
115 GAsyncResult *result,
117 static void g_unix_input_stream_close_async (GInputStream *stream,
119 GCancellable *cancellable,
120 GAsyncReadyCallback callback,
122 static gboolean g_unix_input_stream_close_finish (GInputStream *stream,
123 GAsyncResult *result,
126 static gboolean g_unix_input_stream_pollable_is_readable (GPollableInputStream *stream);
127 static GSource *g_unix_input_stream_pollable_create_source (GPollableInputStream *stream,
128 GCancellable *cancellable);
131 g_unix_input_stream_finalize (GObject *object)
133 G_OBJECT_CLASS (g_unix_input_stream_parent_class)->finalize (object);
137 g_unix_input_stream_class_init (GUnixInputStreamClass *klass)
139 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
140 GInputStreamClass *stream_class = G_INPUT_STREAM_CLASS (klass);
142 g_type_class_add_private (klass, sizeof (GUnixInputStreamPrivate));
144 gobject_class->get_property = g_unix_input_stream_get_property;
145 gobject_class->set_property = g_unix_input_stream_set_property;
146 gobject_class->finalize = g_unix_input_stream_finalize;
148 stream_class->read_fn = g_unix_input_stream_read;
149 stream_class->close_fn = g_unix_input_stream_close;
150 stream_class->read_async = g_unix_input_stream_read_async;
151 stream_class->read_finish = g_unix_input_stream_read_finish;
154 /* TODO: Implement instead of using fallbacks */
155 stream_class->skip_async = g_unix_input_stream_skip_async;
156 stream_class->skip_finish = g_unix_input_stream_skip_finish;
158 stream_class->close_async = g_unix_input_stream_close_async;
159 stream_class->close_finish = g_unix_input_stream_close_finish;
162 * GUnixInputStream:fd:
164 * The file descriptor that the stream reads from.
168 g_object_class_install_property (gobject_class,
170 g_param_spec_int ("fd",
171 P_("File descriptor"),
172 P_("The file descriptor to read from"),
173 G_MININT, G_MAXINT, -1,
174 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));
177 * GUnixInputStream:close-fd:
179 * Whether to close the file descriptor when the stream is closed.
183 g_object_class_install_property (gobject_class,
185 g_param_spec_boolean ("close-fd",
186 P_("Close file descriptor"),
187 P_("Whether to close the file descriptor when the stream is closed"),
189 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));
193 g_unix_input_stream_pollable_iface_init (GPollableInputStreamInterface *iface)
195 iface->is_readable = g_unix_input_stream_pollable_is_readable;
196 iface->create_source = g_unix_input_stream_pollable_create_source;
200 g_unix_input_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface)
202 iface->get_fd = (int (*) (GFileDescriptorBased *))g_unix_input_stream_get_fd;
206 g_unix_input_stream_set_property (GObject *object,
211 GUnixInputStream *unix_stream;
213 unix_stream = G_UNIX_INPUT_STREAM (object);
218 unix_stream->priv->fd = g_value_get_int (value);
219 if (lseek (unix_stream->priv->fd, 0, SEEK_CUR) == -1 && errno == ESPIPE)
220 unix_stream->priv->is_pipe_or_socket = TRUE;
222 unix_stream->priv->is_pipe_or_socket = FALSE;
225 unix_stream->priv->close_fd = g_value_get_boolean (value);
228 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
234 g_unix_input_stream_get_property (GObject *object,
239 GUnixInputStream *unix_stream;
241 unix_stream = G_UNIX_INPUT_STREAM (object);
246 g_value_set_int (value, unix_stream->priv->fd);
249 g_value_set_boolean (value, unix_stream->priv->close_fd);
252 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
257 g_unix_input_stream_init (GUnixInputStream *unix_stream)
259 unix_stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (unix_stream,
260 G_TYPE_UNIX_INPUT_STREAM,
261 GUnixInputStreamPrivate);
263 unix_stream->priv->fd = -1;
264 unix_stream->priv->close_fd = TRUE;
268 * g_unix_input_stream_new:
269 * @fd: a UNIX file descriptor
270 * @close_fd: %TRUE to close the file descriptor when done
272 * Creates a new #GUnixInputStream for the given @fd.
274 * If @close_fd is %TRUE, the file descriptor will be closed
275 * when the stream is closed.
277 * Returns: a new #GUnixInputStream
280 g_unix_input_stream_new (gint fd,
283 GUnixInputStream *stream;
285 g_return_val_if_fail (fd != -1, NULL);
287 stream = g_object_new (G_TYPE_UNIX_INPUT_STREAM,
289 "close-fd", close_fd,
292 return G_INPUT_STREAM (stream);
296 * g_unix_input_stream_set_close_fd:
297 * @stream: a #GUnixInputStream
298 * @close_fd: %TRUE to close the file descriptor when done
300 * Sets whether the file descriptor of @stream shall be closed
301 * when the stream is closed.
306 g_unix_input_stream_set_close_fd (GUnixInputStream *stream,
309 g_return_if_fail (G_IS_UNIX_INPUT_STREAM (stream));
311 close_fd = close_fd != FALSE;
312 if (stream->priv->close_fd != close_fd)
314 stream->priv->close_fd = close_fd;
315 g_object_notify (G_OBJECT (stream), "close-fd");
320 * g_unix_input_stream_get_close_fd:
321 * @stream: a #GUnixInputStream
323 * Returns whether the file descriptor of @stream will be
324 * closed when the stream is closed.
326 * Return value: %TRUE if the file descriptor is closed when done
331 g_unix_input_stream_get_close_fd (GUnixInputStream *stream)
333 g_return_val_if_fail (G_IS_UNIX_INPUT_STREAM (stream), FALSE);
335 return stream->priv->close_fd;
339 * g_unix_input_stream_get_fd:
340 * @stream: a #GUnixInputStream
342 * Return the UNIX file descriptor that the stream reads from.
344 * Return value: The file descriptor of @stream
349 g_unix_input_stream_get_fd (GUnixInputStream *stream)
351 g_return_val_if_fail (G_IS_UNIX_INPUT_STREAM (stream), -1);
353 return stream->priv->fd;
357 g_unix_input_stream_read (GInputStream *stream,
360 GCancellable *cancellable,
363 GUnixInputStream *unix_stream;
369 unix_stream = G_UNIX_INPUT_STREAM (stream);
371 poll_fds[0].fd = unix_stream->priv->fd;
372 poll_fds[0].events = G_IO_IN;
373 if (unix_stream->priv->is_pipe_or_socket &&
374 g_cancellable_make_pollfd (cancellable, &poll_fds[1]))
381 poll_fds[0].revents = poll_fds[1].revents = 0;
383 poll_ret = g_poll (poll_fds, nfds, -1);
384 while (poll_ret == -1 && errno == EINTR);
390 g_set_error (error, G_IO_ERROR,
391 g_io_error_from_errno (errsv),
392 _("Error reading from file descriptor: %s"),
397 if (g_cancellable_set_error_if_cancelled (cancellable, error))
400 if (!poll_fds[0].revents)
403 res = read (unix_stream->priv->fd, buffer, count);
408 if (errsv == EINTR || errsv == EAGAIN)
411 g_set_error (error, G_IO_ERROR,
412 g_io_error_from_errno (errsv),
413 _("Error reading from file descriptor: %s"),
421 g_cancellable_release_fd (cancellable);
426 g_unix_input_stream_close (GInputStream *stream,
427 GCancellable *cancellable,
430 GUnixInputStream *unix_stream;
433 unix_stream = G_UNIX_INPUT_STREAM (stream);
435 if (!unix_stream->priv->close_fd)
440 /* This might block during the close. Doesn't seem to be a way to avoid it though. */
441 res = close (unix_stream->priv->fd);
446 g_set_error (error, G_IO_ERROR,
447 g_io_error_from_errno (errsv),
448 _("Error closing file descriptor: %s"),
460 GAsyncReadyCallback callback;
462 GCancellable *cancellable;
463 GUnixInputStream *stream;
467 read_async_cb (int fd,
468 GIOCondition condition,
471 GSimpleAsyncResult *simple;
472 GError *error = NULL;
475 /* We know that we can read from fd once without blocking */
478 if (g_cancellable_set_error_if_cancelled (data->cancellable, &error))
483 count_read = read (data->stream->priv->fd, data->buffer, data->count);
484 if (count_read == -1)
488 if (errsv == EINTR || errsv == EAGAIN)
491 g_set_error (&error, G_IO_ERROR,
492 g_io_error_from_errno (errsv),
493 _("Error reading from file descriptor: %s"),
499 simple = g_simple_async_result_new (G_OBJECT (data->stream),
502 g_unix_input_stream_read_async);
504 g_simple_async_result_set_op_res_gssize (simple, count_read);
506 if (count_read == -1)
507 g_simple_async_result_take_error (simple, error);
509 /* Complete immediately, not in idle, since we're already in a mainloop callout */
510 g_simple_async_result_complete (simple);
511 g_object_unref (simple);
517 g_unix_input_stream_read_async (GInputStream *stream,
521 GCancellable *cancellable,
522 GAsyncReadyCallback callback,
526 GUnixInputStream *unix_stream;
529 unix_stream = G_UNIX_INPUT_STREAM (stream);
531 if (!unix_stream->priv->is_pipe_or_socket)
533 G_INPUT_STREAM_CLASS (g_unix_input_stream_parent_class)->
534 read_async (stream, buffer, count, io_priority,
535 cancellable, callback, user_data);
539 data = g_new0 (ReadAsyncData, 1);
541 data->buffer = buffer;
542 data->callback = callback;
543 data->user_data = user_data;
544 data->cancellable = cancellable;
545 data->stream = unix_stream;
547 source = _g_fd_source_new (unix_stream->priv->fd,
550 g_source_set_name (source, "GUnixInputStream");
552 g_source_set_callback (source, (GSourceFunc)read_async_cb, data, g_free);
553 g_source_attach (source, g_main_context_get_thread_default ());
555 g_source_unref (source);
559 g_unix_input_stream_read_finish (GInputStream *stream,
560 GAsyncResult *result,
563 GUnixInputStream *unix_stream = G_UNIX_INPUT_STREAM (stream);
564 GSimpleAsyncResult *simple;
567 if (!unix_stream->priv->is_pipe_or_socket)
569 return G_INPUT_STREAM_CLASS (g_unix_input_stream_parent_class)->
570 read_finish (stream, result, error);
573 simple = G_SIMPLE_ASYNC_RESULT (result);
574 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_unix_input_stream_read_async);
576 nread = g_simple_async_result_get_op_res_gssize (simple);
581 g_unix_input_stream_skip_async (GInputStream *stream,
584 GCancellable *cancellable,
585 GAsyncReadyCallback callback,
588 g_warn_if_reached ();
589 /* TODO: Not implemented */
593 g_unix_input_stream_skip_finish (GInputStream *stream,
594 GAsyncResult *result,
597 g_warn_if_reached ();
599 /* TODO: Not implemented */
604 GInputStream *stream;
605 GAsyncReadyCallback callback;
610 close_async_data_free (gpointer _data)
612 CloseAsyncData *data = _data;
618 close_async_cb (CloseAsyncData *data)
620 GUnixInputStream *unix_stream;
621 GSimpleAsyncResult *simple;
622 GError *error = NULL;
626 unix_stream = G_UNIX_INPUT_STREAM (data->stream);
628 if (!unix_stream->priv->close_fd)
636 res = close (unix_stream->priv->fd);
641 g_set_error (&error, G_IO_ERROR,
642 g_io_error_from_errno (errsv),
643 _("Error closing file descriptor: %s"),
652 simple = g_simple_async_result_new (G_OBJECT (data->stream),
655 g_unix_input_stream_close_async);
658 g_simple_async_result_take_error (simple, error);
660 /* Complete immediately, not in idle, since we're already in a mainloop callout */
661 g_simple_async_result_complete (simple);
662 g_object_unref (simple);
668 g_unix_input_stream_close_async (GInputStream *stream,
670 GCancellable *cancellable,
671 GAsyncReadyCallback callback,
675 CloseAsyncData *data;
677 data = g_new0 (CloseAsyncData, 1);
679 data->stream = stream;
680 data->callback = callback;
681 data->user_data = user_data;
683 idle = g_idle_source_new ();
684 g_source_set_callback (idle, (GSourceFunc)close_async_cb, data, close_async_data_free);
685 g_source_attach (idle, g_main_context_get_thread_default ());
686 g_source_unref (idle);
690 g_unix_input_stream_close_finish (GInputStream *stream,
691 GAsyncResult *result,
694 /* Failures handled in generic close_finish code */
699 g_unix_input_stream_pollable_is_readable (GPollableInputStream *stream)
701 GUnixInputStream *unix_stream = G_UNIX_INPUT_STREAM (stream);
705 poll_fd.fd = unix_stream->priv->fd;
706 poll_fd.events = G_IO_IN;
709 result = g_poll (&poll_fd, 1, 0);
710 while (result == -1 && errno == EINTR);
712 return poll_fd.revents != 0;
716 g_unix_input_stream_pollable_create_source (GPollableInputStream *stream,
717 GCancellable *cancellable)
719 GUnixInputStream *unix_stream = G_UNIX_INPUT_STREAM (stream);
720 GSource *inner_source, *pollable_source;
722 pollable_source = g_pollable_source_new (G_OBJECT (stream));
724 inner_source = _g_fd_source_new (unix_stream->priv->fd, G_IO_IN, cancellable);
725 g_source_set_dummy_callback (inner_source);
726 g_source_add_child_source (pollable_source, inner_source);
727 g_source_unref (inner_source);
729 return pollable_source;