* 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, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: Alexander Larsson <alexl@redhat.com>
*/
#include <glib.h>
#include <glib/gstdio.h>
+#include <glib/glib-unix.h>
#include "gioerror.h"
#include "gunixoutputstream.h"
#include "gcancellable.h"
#include "gsimpleasyncresult.h"
#include "gasynchelper.h"
+#include "gfiledescriptorbased.h"
#include "glibintl.h"
* @include: gio/gunixoutputstream.h
* @see_also: #GOutputStream
*
- * #GUnixOutputStream implements #GOutputStream for writing to a
- * UNIX file descriptor, including asynchronous operations. The file
- * descriptor must be selectable, so it doesn't work with opened files.
+ * #GUnixOutputStream implements #GOutputStream for writing to a UNIX
+ * file descriptor, including asynchronous operations. (If the file
+ * descriptor refers to a socket or pipe, this will use poll() to do
+ * asynchronous I/O. If it refers to a regular file, it will fall back
+ * to doing asynchronous I/O in another thread.)
*
- * Note that <filename><gio/gunixoutputstream.h></filename> belongs
- * to the UNIX-specific GIO interfaces, thus you have to use the
- * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
+ * Note that `<gio/gunixoutputstream.h>` belongs to the UNIX-specific GIO
+ * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file
+ * when using it.
*/
enum {
PROP_CLOSE_FD
};
-G_DEFINE_TYPE (GUnixOutputStream, g_unix_output_stream, G_TYPE_OUTPUT_STREAM);
-
-
struct _GUnixOutputStreamPrivate {
int fd;
- gboolean close_fd;
+ guint close_fd : 1;
+ guint is_pipe_or_socket : 1;
};
+static void g_unix_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface);
+static void g_unix_output_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (GUnixOutputStream, g_unix_output_stream, G_TYPE_OUTPUT_STREAM,
+ G_ADD_PRIVATE (GUnixOutputStream)
+ G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM,
+ g_unix_output_stream_pollable_iface_init)
+ G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED,
+ g_unix_output_stream_file_descriptor_based_iface_init)
+ )
+
static void g_unix_output_stream_set_property (GObject *object,
guint prop_id,
const GValue *value,
static gboolean g_unix_output_stream_close (GOutputStream *stream,
GCancellable *cancellable,
GError **error);
-static void g_unix_output_stream_write_async (GOutputStream *stream,
- const void *buffer,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data);
-static gssize g_unix_output_stream_write_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error);
static void g_unix_output_stream_close_async (GOutputStream *stream,
int io_priority,
GCancellable *cancellable,
GAsyncResult *result,
GError **error);
-
-static void
-g_unix_output_stream_finalize (GObject *object)
-{
- G_OBJECT_CLASS (g_unix_output_stream_parent_class)->finalize (object);
-}
+static gboolean g_unix_output_stream_pollable_can_poll (GPollableOutputStream *stream);
+static gboolean g_unix_output_stream_pollable_is_writable (GPollableOutputStream *stream);
+static GSource *g_unix_output_stream_pollable_create_source (GPollableOutputStream *stream,
+ GCancellable *cancellable);
static void
g_unix_output_stream_class_init (GUnixOutputStreamClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
GOutputStreamClass *stream_class = G_OUTPUT_STREAM_CLASS (klass);
-
- g_type_class_add_private (klass, sizeof (GUnixOutputStreamPrivate));
gobject_class->get_property = g_unix_output_stream_get_property;
gobject_class->set_property = g_unix_output_stream_set_property;
- gobject_class->finalize = g_unix_output_stream_finalize;
stream_class->write_fn = g_unix_output_stream_write;
stream_class->close_fn = g_unix_output_stream_close;
- stream_class->write_async = g_unix_output_stream_write_async;
- stream_class->write_finish = g_unix_output_stream_write_finish;
stream_class->close_async = g_unix_output_stream_close_async;
stream_class->close_finish = g_unix_output_stream_close_finish;
}
static void
+g_unix_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface)
+{
+ iface->can_poll = g_unix_output_stream_pollable_can_poll;
+ iface->is_writable = g_unix_output_stream_pollable_is_writable;
+ iface->create_source = g_unix_output_stream_pollable_create_source;
+}
+
+static void
+g_unix_output_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface)
+{
+ iface->get_fd = (int (*) (GFileDescriptorBased *))g_unix_output_stream_get_fd;
+}
+
+static void
g_unix_output_stream_set_property (GObject *object,
guint prop_id,
const GValue *value,
{
case PROP_FD:
unix_stream->priv->fd = g_value_get_int (value);
+ if (lseek (unix_stream->priv->fd, 0, SEEK_CUR) == -1 && errno == ESPIPE)
+ unix_stream->priv->is_pipe_or_socket = TRUE;
+ else
+ unix_stream->priv->is_pipe_or_socket = FALSE;
break;
case PROP_CLOSE_FD:
unix_stream->priv->close_fd = g_value_get_boolean (value);
static void
g_unix_output_stream_init (GUnixOutputStream *unix_stream)
{
- unix_stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (unix_stream,
- G_TYPE_UNIX_OUTPUT_STREAM,
- GUnixOutputStreamPrivate);
-
+ unix_stream->priv = g_unix_output_stream_get_instance_private (unix_stream);
unix_stream->priv->fd = -1;
unix_stream->priv->close_fd = TRUE;
}
* Returns whether the file descriptor of @stream will be
* closed when the stream is closed.
*
- * Return value: %TRUE if the file descriptor is closed when done
+ * Returns: %TRUE if the file descriptor is closed when done
*
* Since: 2.20
*/
*
* Return the UNIX file descriptor that the stream writes to.
*
- * Return value: The file descriptor of @stream
+ * Returns: The file descriptor of @stream
*
* Since: 2.20
*/
GError **error)
{
GUnixOutputStream *unix_stream;
- gssize res;
+ gssize res = -1;
GPollFD poll_fds[2];
+ int nfds;
int poll_ret;
unix_stream = G_UNIX_OUTPUT_STREAM (stream);
- if (g_cancellable_make_pollfd (cancellable, &poll_fds[1]))
+ poll_fds[0].fd = unix_stream->priv->fd;
+ poll_fds[0].events = G_IO_OUT;
+
+ if (unix_stream->priv->is_pipe_or_socket &&
+ g_cancellable_make_pollfd (cancellable, &poll_fds[1]))
+ nfds = 2;
+ else
+ nfds = 1;
+
+ while (1)
{
- poll_fds[0].fd = unix_stream->priv->fd;
- poll_fds[0].events = G_IO_OUT;
+ poll_fds[0].revents = poll_fds[1].revents = 0;
do
- poll_ret = g_poll (poll_fds, 2, -1);
+ poll_ret = g_poll (poll_fds, nfds, -1);
while (poll_ret == -1 && errno == EINTR);
- g_cancellable_release_fd (cancellable);
-
+
if (poll_ret == -1)
{
int errsv = errno;
g_set_error (error, G_IO_ERROR,
g_io_error_from_errno (errsv),
- _("Error writing to unix: %s"),
+ _("Error writing to file descriptor: %s"),
g_strerror (errsv));
- return -1;
+ break;
}
- }
-
- while (1)
- {
+
if (g_cancellable_set_error_if_cancelled (cancellable, error))
- return -1;
+ break;
+
+ if (!poll_fds[0].revents)
+ continue;
res = write (unix_stream->priv->fd, buffer, count);
if (res == -1)
{
int errsv = errno;
- if (errsv == EINTR)
+ if (errsv == EINTR || errsv == EAGAIN)
continue;
-
+
g_set_error (error, G_IO_ERROR,
g_io_error_from_errno (errsv),
- _("Error writing to unix: %s"),
+ _("Error writing to file descriptor: %s"),
g_strerror (errsv));
}
-
+
break;
}
-
+
+ if (nfds == 2)
+ g_cancellable_release_fd (cancellable);
return res;
}
if (!unix_stream->priv->close_fd)
return TRUE;
- while (1)
+ /* This might block during the close. Doesn't seem to be a way to avoid it though. */
+ res = close (unix_stream->priv->fd);
+ if (res == -1)
{
- /* This might block during the close. Doesn't seem to be a way to avoid it though. */
- res = close (unix_stream->priv->fd);
- if (res == -1)
- {
- int errsv = errno;
+ int errsv = errno;
- g_set_error (error, G_IO_ERROR,
- g_io_error_from_errno (errsv),
- _("Error closing unix: %s"),
- g_strerror (errsv));
- }
- break;
+ g_set_error (error, G_IO_ERROR,
+ g_io_error_from_errno (errsv),
+ _("Error closing file descriptor: %s"),
+ g_strerror (errsv));
}
return res != -1;
}
-typedef struct {
- gsize count;
- const void *buffer;
- GAsyncReadyCallback callback;
- gpointer user_data;
- GCancellable *cancellable;
- GUnixOutputStream *stream;
-} WriteAsyncData;
-
-static gboolean
-write_async_cb (WriteAsyncData *data,
- GIOCondition condition,
- int fd)
-{
- GSimpleAsyncResult *simple;
- GError *error = NULL;
- gssize count_written;
-
- while (1)
- {
- if (g_cancellable_set_error_if_cancelled (data->cancellable, &error))
- {
- count_written = -1;
- break;
- }
-
- count_written = write (data->stream->priv->fd, data->buffer, data->count);
- if (count_written == -1)
- {
- int errsv = errno;
-
- if (errsv == EINTR)
- continue;
-
- g_set_error (&error, G_IO_ERROR,
- g_io_error_from_errno (errsv),
- _("Error writing to unix: %s"),
- g_strerror (errsv));
- }
- break;
- }
-
- simple = g_simple_async_result_new (G_OBJECT (data->stream),
- data->callback,
- data->user_data,
- g_unix_output_stream_write_async);
-
- g_simple_async_result_set_op_res_gssize (simple, count_written);
-
- if (count_written == -1)
- {
- g_simple_async_result_set_from_error (simple, error);
- g_error_free (error);
- }
-
- /* Complete immediately, not in idle, since we're already in a mainloop callout */
- g_simple_async_result_complete (simple);
- g_object_unref (simple);
-
- return FALSE;
-}
-
static void
-g_unix_output_stream_write_async (GOutputStream *stream,
- const void *buffer,
- gsize count,
+g_unix_output_stream_close_async (GOutputStream *stream,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
- GSource *source;
- GUnixOutputStream *unix_stream;
- WriteAsyncData *data;
+ GTask *task;
+ GError *error = NULL;
- unix_stream = G_UNIX_OUTPUT_STREAM (stream);
+ task = g_task_new (stream, cancellable, callback, user_data);
+ g_task_set_priority (task, io_priority);
- data = g_new0 (WriteAsyncData, 1);
- data->count = count;
- data->buffer = buffer;
- data->callback = callback;
- data->user_data = user_data;
- data->cancellable = cancellable;
- data->stream = unix_stream;
-
- source = _g_fd_source_new (unix_stream->priv->fd,
- G_IO_OUT,
- cancellable);
- g_source_set_name (source, "GUnixOutputStream");
-
- g_source_set_callback (source, (GSourceFunc)write_async_cb, data, g_free);
- g_source_attach (source, g_main_context_get_thread_default ());
-
- g_source_unref (source);
+ if (g_unix_output_stream_close (stream, cancellable, &error))
+ g_task_return_boolean (task, TRUE);
+ else
+ g_task_return_error (task, error);
+ g_object_unref (task);
}
-static gssize
-g_unix_output_stream_write_finish (GOutputStream *stream,
+static gboolean
+g_unix_output_stream_close_finish (GOutputStream *stream,
GAsyncResult *result,
GError **error)
{
- GSimpleAsyncResult *simple;
- gssize nwritten;
+ g_return_val_if_fail (g_task_is_valid (result, stream), FALSE);
- simple = G_SIMPLE_ASYNC_RESULT (result);
- g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_unix_output_stream_write_async);
-
- nwritten = g_simple_async_result_get_op_res_gssize (simple);
- return nwritten;
+ return g_task_propagate_boolean (G_TASK (result), error);
}
-typedef struct {
- GOutputStream *stream;
- GAsyncReadyCallback callback;
- gpointer user_data;
-} CloseAsyncData;
-
static gboolean
-close_async_cb (CloseAsyncData *data)
+g_unix_output_stream_pollable_can_poll (GPollableOutputStream *stream)
{
- GUnixOutputStream *unix_stream;
- GSimpleAsyncResult *simple;
- GError *error = NULL;
- gboolean result;
- int res;
-
- unix_stream = G_UNIX_OUTPUT_STREAM (data->stream);
+ return G_UNIX_OUTPUT_STREAM (stream)->priv->is_pipe_or_socket;
+}
- if (!unix_stream->priv->close_fd)
- {
- result = TRUE;
- goto out;
- }
-
- while (1)
- {
- res = close (unix_stream->priv->fd);
- if (res == -1)
- {
- int errsv = errno;
+static gboolean
+g_unix_output_stream_pollable_is_writable (GPollableOutputStream *stream)
+{
+ GUnixOutputStream *unix_stream = G_UNIX_OUTPUT_STREAM (stream);
+ GPollFD poll_fd;
+ gint result;
- g_set_error (&error, G_IO_ERROR,
- g_io_error_from_errno (errsv),
- _("Error closing unix: %s"),
- g_strerror (errsv));
- }
- break;
- }
-
- result = res != -1;
-
- out:
- simple = g_simple_async_result_new (G_OBJECT (data->stream),
- data->callback,
- data->user_data,
- g_unix_output_stream_close_async);
+ poll_fd.fd = unix_stream->priv->fd;
+ poll_fd.events = G_IO_OUT;
+ poll_fd.revents = 0;
- if (!result)
- {
- g_simple_async_result_set_from_error (simple, error);
- g_error_free (error);
- }
+ do
+ result = g_poll (&poll_fd, 1, 0);
+ while (result == -1 && errno == EINTR);
- /* Complete immediately, not in idle, since we're already in a mainloop callout */
- g_simple_async_result_complete (simple);
- g_object_unref (simple);
-
- return FALSE;
+ return poll_fd.revents != 0;
}
-static void
-g_unix_output_stream_close_async (GOutputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+static GSource *
+g_unix_output_stream_pollable_create_source (GPollableOutputStream *stream,
+ GCancellable *cancellable)
{
- GSource *idle;
- CloseAsyncData *data;
+ GUnixOutputStream *unix_stream = G_UNIX_OUTPUT_STREAM (stream);
+ GSource *inner_source, *cancellable_source, *pollable_source;
- data = g_new0 (CloseAsyncData, 1);
+ pollable_source = g_pollable_source_new (G_OBJECT (stream));
- data->stream = stream;
- data->callback = callback;
- data->user_data = user_data;
-
- idle = g_idle_source_new ();
- g_source_set_callback (idle, (GSourceFunc)close_async_cb, data, g_free);
- g_source_attach (idle, g_main_context_get_thread_default ());
- g_source_unref (idle);
-}
+ inner_source = g_unix_fd_source_new (unix_stream->priv->fd, G_IO_OUT);
+ g_source_set_dummy_callback (inner_source);
+ g_source_add_child_source (pollable_source, inner_source);
+ g_source_unref (inner_source);
-static gboolean
-g_unix_output_stream_close_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
-{
- /* Failures handled in generic close_finish code */
- return TRUE;
+ if (cancellable)
+ {
+ cancellable_source = g_cancellable_source_new (cancellable);
+ g_source_set_dummy_callback (cancellable_source);
+ g_source_add_child_source (pollable_source, cancellable_source);
+ g_source_unref (cancellable_source);
+ }
+
+ return pollable_source;
}
projects / platform / upstream / glib.git / blobdiff