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>
34 #include <glib/glib-unix.h>
36 #include "gsimpleasyncresult.h"
37 #include "gunixinputstream.h"
38 #include "gcancellable.h"
39 #include "gasynchelper.h"
40 #include "gfiledescriptorbased.h"
45 * SECTION:gunixinputstream
46 * @short_description: Streaming input operations for UNIX file descriptors
47 * @include: gio/gunixinputstream.h
48 * @see_also: #GInputStream
50 * #GUnixInputStream implements #GInputStream for reading from a UNIX
51 * file descriptor, including asynchronous operations. (If the file
52 * descriptor refers to a socket or pipe, this will use poll() to do
53 * asynchronous I/O. If it refers to a regular file, it will fall back
54 * to doing asynchronous I/O in another thread.)
56 * Note that <filename><gio/gunixinputstream.h></filename> belongs
57 * to the UNIX-specific GIO interfaces, thus you have to use the
58 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
67 struct _GUnixInputStreamPrivate
{
70 guint is_pipe_or_socket
: 1;
73 static void g_unix_input_stream_pollable_iface_init (GPollableInputStreamInterface
*iface
);
74 static void g_unix_input_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface
*iface
);
76 G_DEFINE_TYPE_WITH_CODE (GUnixInputStream
, g_unix_input_stream
, G_TYPE_INPUT_STREAM
,
77 G_ADD_PRIVATE (GUnixInputStream
)
78 G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_INPUT_STREAM
,
79 g_unix_input_stream_pollable_iface_init
)
80 G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED
,
81 g_unix_input_stream_file_descriptor_based_iface_init
)
84 static void g_unix_input_stream_set_property (GObject
*object
,
88 static void g_unix_input_stream_get_property (GObject
*object
,
92 static gssize
g_unix_input_stream_read (GInputStream
*stream
,
95 GCancellable
*cancellable
,
97 static gboolean
g_unix_input_stream_close (GInputStream
*stream
,
98 GCancellable
*cancellable
,
100 static void g_unix_input_stream_skip_async (GInputStream
*stream
,
103 GCancellable
*cancellable
,
104 GAsyncReadyCallback callback
,
106 static gssize
g_unix_input_stream_skip_finish (GInputStream
*stream
,
107 GAsyncResult
*result
,
109 static void g_unix_input_stream_close_async (GInputStream
*stream
,
111 GCancellable
*cancellable
,
112 GAsyncReadyCallback callback
,
114 static gboolean
g_unix_input_stream_close_finish (GInputStream
*stream
,
115 GAsyncResult
*result
,
118 static gboolean
g_unix_input_stream_pollable_can_poll (GPollableInputStream
*stream
);
119 static gboolean
g_unix_input_stream_pollable_is_readable (GPollableInputStream
*stream
);
120 static GSource
*g_unix_input_stream_pollable_create_source (GPollableInputStream
*stream
,
121 GCancellable
*cancellable
);
124 g_unix_input_stream_class_init (GUnixInputStreamClass
*klass
)
126 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
127 GInputStreamClass
*stream_class
= G_INPUT_STREAM_CLASS (klass
);
129 gobject_class
->get_property
= g_unix_input_stream_get_property
;
130 gobject_class
->set_property
= g_unix_input_stream_set_property
;
132 stream_class
->read_fn
= g_unix_input_stream_read
;
133 stream_class
->close_fn
= g_unix_input_stream_close
;
136 /* TODO: Implement instead of using fallbacks */
137 stream_class
->skip_async
= g_unix_input_stream_skip_async
;
138 stream_class
->skip_finish
= g_unix_input_stream_skip_finish
;
140 stream_class
->close_async
= g_unix_input_stream_close_async
;
141 stream_class
->close_finish
= g_unix_input_stream_close_finish
;
144 * GUnixInputStream:fd:
146 * The file descriptor that the stream reads from.
150 g_object_class_install_property (gobject_class
,
152 g_param_spec_int ("fd",
153 P_("File descriptor"),
154 P_("The file descriptor to read from"),
155 G_MININT
, G_MAXINT
, -1,
156 G_PARAM_READABLE
| G_PARAM_WRITABLE
| G_PARAM_CONSTRUCT_ONLY
| G_PARAM_STATIC_NAME
| G_PARAM_STATIC_NICK
| G_PARAM_STATIC_BLURB
));
159 * GUnixInputStream:close-fd:
161 * Whether to close the file descriptor when the stream is closed.
165 g_object_class_install_property (gobject_class
,
167 g_param_spec_boolean ("close-fd",
168 P_("Close file descriptor"),
169 P_("Whether to close the file descriptor when the stream is closed"),
171 G_PARAM_READABLE
| G_PARAM_WRITABLE
| G_PARAM_STATIC_NAME
| G_PARAM_STATIC_NICK
| G_PARAM_STATIC_BLURB
));
175 g_unix_input_stream_pollable_iface_init (GPollableInputStreamInterface
*iface
)
177 iface
->can_poll
= g_unix_input_stream_pollable_can_poll
;
178 iface
->is_readable
= g_unix_input_stream_pollable_is_readable
;
179 iface
->create_source
= g_unix_input_stream_pollable_create_source
;
183 g_unix_input_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface
*iface
)
185 iface
->get_fd
= (int (*) (GFileDescriptorBased
*))g_unix_input_stream_get_fd
;
189 g_unix_input_stream_set_property (GObject
*object
,
194 GUnixInputStream
*unix_stream
;
196 unix_stream
= G_UNIX_INPUT_STREAM (object
);
201 unix_stream
->priv
->fd
= g_value_get_int (value
);
202 if (lseek (unix_stream
->priv
->fd
, 0, SEEK_CUR
) == -1 && errno
== ESPIPE
)
203 unix_stream
->priv
->is_pipe_or_socket
= TRUE
;
205 unix_stream
->priv
->is_pipe_or_socket
= FALSE
;
208 unix_stream
->priv
->close_fd
= g_value_get_boolean (value
);
211 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
217 g_unix_input_stream_get_property (GObject
*object
,
222 GUnixInputStream
*unix_stream
;
224 unix_stream
= G_UNIX_INPUT_STREAM (object
);
229 g_value_set_int (value
, unix_stream
->priv
->fd
);
232 g_value_set_boolean (value
, unix_stream
->priv
->close_fd
);
235 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
240 g_unix_input_stream_init (GUnixInputStream
*unix_stream
)
242 unix_stream
->priv
= g_unix_input_stream_get_instance_private (unix_stream
);
243 unix_stream
->priv
->fd
= -1;
244 unix_stream
->priv
->close_fd
= TRUE
;
248 * g_unix_input_stream_new:
249 * @fd: a UNIX file descriptor
250 * @close_fd: %TRUE to close the file descriptor when done
252 * Creates a new #GUnixInputStream for the given @fd.
254 * If @close_fd is %TRUE, the file descriptor will be closed
255 * when the stream is closed.
257 * Returns: a new #GUnixInputStream
260 g_unix_input_stream_new (gint fd
,
263 GUnixInputStream
*stream
;
265 g_return_val_if_fail (fd
!= -1, NULL
);
267 stream
= g_object_new (G_TYPE_UNIX_INPUT_STREAM
,
269 "close-fd", close_fd
,
272 return G_INPUT_STREAM (stream
);
276 * g_unix_input_stream_set_close_fd:
277 * @stream: a #GUnixInputStream
278 * @close_fd: %TRUE to close the file descriptor when done
280 * Sets whether the file descriptor of @stream shall be closed
281 * when the stream is closed.
286 g_unix_input_stream_set_close_fd (GUnixInputStream
*stream
,
289 g_return_if_fail (G_IS_UNIX_INPUT_STREAM (stream
));
291 close_fd
= close_fd
!= FALSE
;
292 if (stream
->priv
->close_fd
!= close_fd
)
294 stream
->priv
->close_fd
= close_fd
;
295 g_object_notify (G_OBJECT (stream
), "close-fd");
300 * g_unix_input_stream_get_close_fd:
301 * @stream: a #GUnixInputStream
303 * Returns whether the file descriptor of @stream will be
304 * closed when the stream is closed.
306 * Return value: %TRUE if the file descriptor is closed when done
311 g_unix_input_stream_get_close_fd (GUnixInputStream
*stream
)
313 g_return_val_if_fail (G_IS_UNIX_INPUT_STREAM (stream
), FALSE
);
315 return stream
->priv
->close_fd
;
319 * g_unix_input_stream_get_fd:
320 * @stream: a #GUnixInputStream
322 * Return the UNIX file descriptor that the stream reads from.
324 * Return value: The file descriptor of @stream
329 g_unix_input_stream_get_fd (GUnixInputStream
*stream
)
331 g_return_val_if_fail (G_IS_UNIX_INPUT_STREAM (stream
), -1);
333 return stream
->priv
->fd
;
337 g_unix_input_stream_read (GInputStream
*stream
,
340 GCancellable
*cancellable
,
343 GUnixInputStream
*unix_stream
;
349 unix_stream
= G_UNIX_INPUT_STREAM (stream
);
351 poll_fds
[0].fd
= unix_stream
->priv
->fd
;
352 poll_fds
[0].events
= G_IO_IN
;
353 if (unix_stream
->priv
->is_pipe_or_socket
&&
354 g_cancellable_make_pollfd (cancellable
, &poll_fds
[1]))
361 poll_fds
[0].revents
= poll_fds
[1].revents
= 0;
363 poll_ret
= g_poll (poll_fds
, nfds
, -1);
364 while (poll_ret
== -1 && errno
== EINTR
);
370 g_set_error (error
, G_IO_ERROR
,
371 g_io_error_from_errno (errsv
),
372 _("Error reading from file descriptor: %s"),
377 if (g_cancellable_set_error_if_cancelled (cancellable
, error
))
380 if (!poll_fds
[0].revents
)
383 res
= read (unix_stream
->priv
->fd
, buffer
, count
);
388 if (errsv
== EINTR
|| errsv
== EAGAIN
)
391 g_set_error (error
, G_IO_ERROR
,
392 g_io_error_from_errno (errsv
),
393 _("Error reading from file descriptor: %s"),
401 g_cancellable_release_fd (cancellable
);
406 g_unix_input_stream_close (GInputStream
*stream
,
407 GCancellable
*cancellable
,
410 GUnixInputStream
*unix_stream
;
413 unix_stream
= G_UNIX_INPUT_STREAM (stream
);
415 if (!unix_stream
->priv
->close_fd
)
418 /* This might block during the close. Doesn't seem to be a way to avoid it though. */
419 res
= close (unix_stream
->priv
->fd
);
424 g_set_error (error
, G_IO_ERROR
,
425 g_io_error_from_errno (errsv
),
426 _("Error closing file descriptor: %s"),
434 g_unix_input_stream_skip_async (GInputStream
*stream
,
437 GCancellable
*cancellable
,
438 GAsyncReadyCallback callback
,
441 g_warn_if_reached ();
442 /* TODO: Not implemented */
446 g_unix_input_stream_skip_finish (GInputStream
*stream
,
447 GAsyncResult
*result
,
450 g_warn_if_reached ();
452 /* TODO: Not implemented */
456 g_unix_input_stream_close_async (GInputStream
*stream
,
458 GCancellable
*cancellable
,
459 GAsyncReadyCallback callback
,
463 GError
*error
= NULL
;
465 task
= g_task_new (stream
, cancellable
, callback
, user_data
);
466 g_task_set_priority (task
, io_priority
);
468 if (g_unix_input_stream_close (stream
, cancellable
, &error
))
469 g_task_return_boolean (task
, TRUE
);
471 g_task_return_error (task
, error
);
472 g_object_unref (task
);
476 g_unix_input_stream_close_finish (GInputStream
*stream
,
477 GAsyncResult
*result
,
480 g_return_val_if_fail (g_task_is_valid (result
, stream
), FALSE
);
482 return g_task_propagate_boolean (G_TASK (result
), error
);
486 g_unix_input_stream_pollable_can_poll (GPollableInputStream
*stream
)
488 return G_UNIX_INPUT_STREAM (stream
)->priv
->is_pipe_or_socket
;
492 g_unix_input_stream_pollable_is_readable (GPollableInputStream
*stream
)
494 GUnixInputStream
*unix_stream
= G_UNIX_INPUT_STREAM (stream
);
498 poll_fd
.fd
= unix_stream
->priv
->fd
;
499 poll_fd
.events
= G_IO_IN
;
503 result
= g_poll (&poll_fd
, 1, 0);
504 while (result
== -1 && errno
== EINTR
);
506 return poll_fd
.revents
!= 0;
510 g_unix_input_stream_pollable_create_source (GPollableInputStream
*stream
,
511 GCancellable
*cancellable
)
513 GUnixInputStream
*unix_stream
= G_UNIX_INPUT_STREAM (stream
);
514 GSource
*inner_source
, *cancellable_source
, *pollable_source
;
516 pollable_source
= g_pollable_source_new (G_OBJECT (stream
));
518 inner_source
= g_unix_fd_source_new (unix_stream
->priv
->fd
, G_IO_IN
);
519 g_source_set_dummy_callback (inner_source
);
520 g_source_add_child_source (pollable_source
, inner_source
);
521 g_source_unref (inner_source
);
525 cancellable_source
= g_cancellable_source_new (cancellable
);
526 g_source_set_dummy_callback (cancellable_source
);
527 g_source_add_child_source (pollable_source
, cancellable_source
);
528 g_source_unref (cancellable_source
);
531 return pollable_source
;