1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2012, 2013 Red Hat, Inc.
4 * Copyright © 2012, 2013 Canonical Limited
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation; either version 2 of the licence or (at
9 * your option) any later version.
11 * See the included COPYING file for more information.
13 * Authors: Colin Walters <walters@verbum.org>
14 * Ryan Lortie <desrt@desrt.ca>
20 * @short_description: Child processes
21 * @see_also: #GSubprocessLauncher
23 * #GSubprocess allows the creation of and interaction with child
26 * Processes can be communicated with using standard GIO-style APIs (ie:
27 * #GInputStream, #GOutputStream). There are GIO-style APIs to wait for
28 * process termination (ie: cancellable and with an asynchronous
31 * There is an API to force a process to terminate, as well as a
32 * race-free API for sending UNIX signals to a subprocess.
34 * One major advantage that GIO brings over the core GLib library is
35 * comprehensive API for asynchronous I/O, such
36 * g_output_stream_splice_async(). This makes GSubprocess
37 * significantly more powerful and flexible than equivalent APIs in
38 * some other languages such as the <literal>subprocess.py</literal>
39 * included with Python. For example, using #GSubprocess one could
40 * create two child processes, reading standard output from the first,
41 * processing it, and writing to the input stream of the second, all
42 * without blocking the main loop.
44 * A powerful g_subprocess_communicate() API is provided similar to the
45 * <literal>communicate()</literal> method of
46 * <literal>subprocess.py</literal>. This enables very easy interaction
47 * with a subprocess that has been opened with pipes.
49 * #GSubprocess defaults to tight control over the file descriptors open
50 * in the child process, avoiding dangling-fd issues that are caused by
51 * a simple fork()/exec(). The only open file descriptors in the
52 * spawned process are ones that were explicitly specified by the
53 * #GSubprocess API (unless %G_SUBPROCESS_FLAGS_INHERIT_FDS was
56 * #GSubprocess will quickly reap all child processes as they exit,
57 * avoiding "zombie processes" remaining around for long periods of
58 * time. g_subprocess_wait() can be used to wait for this to happen,
59 * but it will happen even without the call being explicitly made.
61 * As a matter of principle, #GSubprocess has no API that accepts
62 * shell-style space-separated strings. It will, however, match the
63 * typical shell behaviour of searching the PATH for executables that do
64 * not contain a directory separator in their name.
66 * #GSubprocess attempts to have a very simple API for most uses (ie:
67 * spawning a subprocess with arguments and support for most typical
68 * kinds of input and output redirection). See g_subprocess_new(). The
69 * #GSubprocessLauncher API is provided for more complicated cases
70 * (advanced types of redirection, environment variable manipulation,
71 * change of working directory, child setup functions, etc).
73 * A typical use of #GSubprocess will involve calling
74 * g_subprocess_new(), followed by g_subprocess_wait() or
75 * g_subprocess_wait_sync(). After the process exits, the status can be
76 * checked using functions such as g_subprocess_get_if_exited() (which
77 * are similar to the familiar WIFEXITED-style POSIX macros).
84 #include "gsubprocess.h"
85 #include "gsubprocesslauncher-private.h"
86 #include "gasyncresult.h"
87 #include "giostream.h"
88 #include "gmemoryinputstream.h"
90 #include "glib-private.h"
94 #include <gio/gunixoutputstream.h>
95 #include <gio/gfiledescriptorbased.h>
96 #include <gio/gunixinputstream.h>
98 #include <glib-unix.h>
102 #define _WIN32_WINNT 0x0500
104 #include "giowin32-priv.h"
111 #define COMMUNICATE_READ_SIZE 4096
113 /* A GSubprocess can have two possible states: running and not.
115 * These two states are reflected by the value of 'pid'. If it is
116 * non-zero then the process is running, with that pid.
118 * When a GSubprocess is first created with g_object_new() it is not
119 * running. When it is finalized, it is also not running.
121 * During initable_init(), if the g_spawn() is successful then we
122 * immediately register a child watch and take an extra ref on the
123 * subprocess. That reference doesn't drop until the child has quit,
124 * which is why finalize can only happen in the non-running state. In
125 * the event that the g_spawn() failed we will still be finalizing a
126 * non-running GSubprocess (before returning from g_subprocess_new())
129 * We make extensive use of the glib worker thread to guarantee
130 * race-free operation. As with all child watches, glib calls waitpid()
131 * in the worker thread. It reports the child exiting to us via the
132 * worker thread (which means that we can do synchronous waits without
133 * running a separate loop). We also send signals to the child process
134 * via the worker thread so that we don't race with waitpid() and
135 * accidentally send a signal to an already-reaped child.
137 static void initable_iface_init (GInitableIface *initable_iface);
139 typedef GObjectClass GSubprocessClass;
145 /* only used during construction */
146 GSubprocessLauncher *launcher;
147 GSubprocessFlags flags;
150 /* state tracking variables */
151 gchar identifier[24];
156 GMutex pending_waits_lock;
157 GSList *pending_waits;
159 /* These are the streams created if a pipe is requested via flags. */
160 GOutputStream *stdin_pipe;
161 GInputStream *stdout_pipe;
162 GInputStream *stderr_pipe;
165 G_DEFINE_TYPE_WITH_CODE (GSubprocess, g_subprocess, G_TYPE_OBJECT,
166 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init));
179 GSpawnChildSetupFunc child_setup_func;
180 gpointer child_setup_data;
181 GArray *basic_fd_assignments;
182 GArray *needdup_fd_assignments;
186 unset_cloexec (int fd)
191 flags = fcntl (fd, F_GETFD, 0);
195 flags &= (~FD_CLOEXEC);
197 result = fcntl (fd, F_SETFD, flags);
198 while (result == -1 && errno == EINTR);
203 * Based on code derived from
204 * gnome-terminal:src/terminal-screen.c:terminal_screen_child_setup(),
205 * used under the LGPLv2+ with permission from author.
208 child_setup (gpointer user_data)
210 ChildData *child_data = user_data;
214 /* We're on the child side now. "Rename" the file descriptors in
215 * child_data.fds[] to stdin/stdout/stderr.
217 * We don't close the originals. It's possible that the originals
218 * should not be closed and if they should be closed then they should
219 * have been created O_CLOEXEC.
221 for (i = 0; i < 3; i++)
222 if (child_data->fds[i] != -1 && child_data->fds[i] != i)
225 result = dup2 (child_data->fds[i], i);
226 while (result == -1 && errno == EINTR);
229 /* Basic fd assignments we can just unset FD_CLOEXEC */
230 if (child_data->basic_fd_assignments)
232 for (i = 0; i < child_data->basic_fd_assignments->len; i++)
234 gint fd = g_array_index (child_data->basic_fd_assignments, int, i);
240 /* If we're doing remapping fd assignments, we need to handle
241 * the case where the user has specified e.g.:
244 * We do this by duping the source fds temporarily.
246 if (child_data->needdup_fd_assignments)
248 for (i = 0; i < child_data->needdup_fd_assignments->len; i += 2)
250 gint parent_fd = g_array_index (child_data->needdup_fd_assignments, int, i);
254 new_parent_fd = fcntl (parent_fd, F_DUPFD_CLOEXEC, 3);
255 while (parent_fd == -1 && errno == EINTR);
257 g_array_index (child_data->needdup_fd_assignments, int, i) = new_parent_fd;
259 for (i = 0; i < child_data->needdup_fd_assignments->len; i += 2)
261 gint parent_fd = g_array_index (child_data->needdup_fd_assignments, int, i);
262 gint child_fd = g_array_index (child_data->needdup_fd_assignments, int, i+1);
264 if (parent_fd == child_fd)
266 unset_cloexec (parent_fd);
271 result = dup2 (parent_fd, child_fd);
272 while (result == -1 && errno == EINTR);
273 (void) close (parent_fd);
278 if (child_data->child_setup_func)
279 child_data->child_setup_func (child_data->child_setup_data);
282 static GInputStream *
283 platform_input_stream_from_spawn_fd (gint fd)
289 return g_unix_input_stream_new (fd, TRUE);
291 return g_win32_input_stream_new_from_fd (fd, TRUE);
295 static GOutputStream *
296 platform_output_stream_from_spawn_fd (gint fd)
302 return g_unix_output_stream_new (fd, TRUE);
304 return g_win32_output_stream_new_from_fd (fd, TRUE);
310 unix_open_file (const char *filename,
316 my_fd = g_open (filename, mode | O_BINARY | O_CLOEXEC, 0666);
318 /* If we return -1 we should also set the error */
321 gint saved_errno = errno;
324 display_name = g_filename_display_name (filename);
325 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (saved_errno),
326 _("Error opening file '%s': %s"), display_name,
327 g_strerror (saved_errno));
328 g_free (display_name);
329 /* fall through... */
337 g_subprocess_set_property (GObject *object,
342 GSubprocess *self = G_SUBPROCESS (object);
347 self->flags = g_value_get_flags (value);
351 self->argv = g_value_dup_boxed (value);
355 g_assert_not_reached ();
360 g_subprocess_exited (GPid pid,
364 GSubprocess *self = user_data;
367 g_assert (self->pid == pid);
369 g_mutex_lock (&self->pending_waits_lock);
370 self->status = status;
371 tasks = self->pending_waits;
372 self->pending_waits = NULL;
374 g_mutex_unlock (&self->pending_waits_lock);
376 /* Signal anyone in g_subprocess_wait_async() to wake up now */
379 g_task_return_boolean (tasks->data, TRUE);
380 tasks = g_slist_delete_link (tasks, tasks);
383 g_spawn_close_pid (pid);
389 initable_init (GInitable *initable,
390 GCancellable *cancellable,
393 GSubprocess *self = G_SUBPROCESS (initable);
394 ChildData child_data = { { -1, -1, -1 }, 0 };
395 gint *pipe_ptrs[3] = { NULL, NULL, NULL };
396 gint pipe_fds[3] = { -1, -1, -1 };
397 gint close_fds[3] = { -1, -1, -1 };
398 GSpawnFlags spawn_flags = 0;
399 gboolean success = FALSE;
402 /* this is a programmer error */
403 if (!self->argv || !self->argv[0] || !self->argv[0][0])
406 if (g_cancellable_set_error_if_cancelled (cancellable, error))
409 /* We must setup the three fds that will end up in the child as stdin,
414 if (self->flags & G_SUBPROCESS_FLAGS_STDIN_INHERIT)
415 spawn_flags |= G_SPAWN_CHILD_INHERITS_STDIN;
416 else if (self->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE)
417 pipe_ptrs[0] = &pipe_fds[0];
419 else if (self->launcher)
421 if (self->launcher->stdin_fd != -1)
422 child_data.fds[0] = self->launcher->stdin_fd;
423 else if (self->launcher->stdin_path != NULL)
425 child_data.fds[0] = close_fds[0] = unix_open_file (self->launcher->stdin_path, O_RDONLY, error);
426 if (child_data.fds[0] == -1)
433 if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_SILENCE)
434 spawn_flags |= G_SPAWN_STDOUT_TO_DEV_NULL;
435 else if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_PIPE)
436 pipe_ptrs[1] = &pipe_fds[1];
438 else if (self->launcher)
440 if (self->launcher->stdout_fd != -1)
441 child_data.fds[1] = self->launcher->stdout_fd;
442 else if (self->launcher->stdout_path != NULL)
444 child_data.fds[1] = close_fds[1] = unix_open_file (self->launcher->stdout_path, O_CREAT | O_WRONLY, error);
445 if (child_data.fds[1] == -1)
451 /* Finally, stderr. */
452 if (self->flags & G_SUBPROCESS_FLAGS_STDERR_SILENCE)
453 spawn_flags |= G_SPAWN_STDERR_TO_DEV_NULL;
454 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_PIPE)
455 pipe_ptrs[2] = &pipe_fds[2];
456 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_MERGE)
457 /* This will work because stderr gets setup after stdout. */
458 child_data.fds[2] = 1;
460 else if (self->launcher)
462 if (self->launcher->stderr_fd != -1)
463 child_data.fds[2] = self->launcher->stderr_fd;
464 else if (self->launcher->stderr_path != NULL)
466 child_data.fds[2] = close_fds[2] = unix_open_file (self->launcher->stderr_path, O_CREAT | O_WRONLY, error);
467 if (child_data.fds[2] == -1)
476 child_data.basic_fd_assignments = self->launcher->basic_fd_assignments;
477 child_data.needdup_fd_assignments = self->launcher->needdup_fd_assignments;
481 /* argv0 has no '/' in it? We better do a PATH lookup. */
482 if (strchr (self->argv[0], G_DIR_SEPARATOR) == NULL)
484 if (self->launcher && self->launcher->path_from_envp)
485 spawn_flags |= G_SPAWN_SEARCH_PATH_FROM_ENVP;
487 spawn_flags |= G_SPAWN_SEARCH_PATH;
490 if (self->flags & G_SUBPROCESS_FLAGS_INHERIT_FDS)
491 spawn_flags |= G_SPAWN_LEAVE_DESCRIPTORS_OPEN;
493 spawn_flags |= G_SPAWN_DO_NOT_REAP_CHILD;
494 spawn_flags |= G_SPAWN_CLOEXEC_PIPES;
496 child_data.child_setup_func = self->launcher ? self->launcher->child_setup_func : NULL;
497 child_data.child_setup_data = self->launcher ? self->launcher->child_setup_user_data : NULL;
498 success = g_spawn_async_with_pipes (self->launcher ? self->launcher->cwd : NULL,
500 self->launcher ? self->launcher->envp : NULL,
502 child_setup, &child_data,
504 pipe_ptrs[0], pipe_ptrs[1], pipe_ptrs[2],
506 g_assert (success == (self->pid != 0));
513 identifier = (guint64) GetProcessId (self->pid);
515 identifier = (guint64) self->pid;
518 s = snprintf (self->identifier, sizeof self->identifier, "%"G_GUINT64_FORMAT, identifier);
519 g_assert (0 < s && s < sizeof self->identifier);
522 /* Start attempting to reap the child immediately */
525 GMainContext *worker_context;
528 worker_context = GLIB_PRIVATE_CALL (g_get_worker_context) ();
529 source = g_child_watch_source_new (self->pid);
530 g_source_set_callback (source, (GSourceFunc) g_subprocess_exited, g_object_ref (self), g_object_unref);
531 g_source_attach (source, worker_context);
532 g_source_unref (source);
536 /* we don't need this past init... */
537 self->launcher = NULL;
539 for (i = 0; i < 3; i++)
540 if (close_fds[i] != -1)
541 close (close_fds[i]);
543 self->stdin_pipe = platform_output_stream_from_spawn_fd (pipe_fds[0]);
544 self->stdout_pipe = platform_input_stream_from_spawn_fd (pipe_fds[1]);
545 self->stderr_pipe = platform_input_stream_from_spawn_fd (pipe_fds[2]);
551 g_subprocess_finalize (GObject *object)
553 GSubprocess *self = G_SUBPROCESS (object);
555 g_assert (self->pending_waits == NULL);
556 g_assert (self->pid == 0);
558 g_clear_object (&self->stdin_pipe);
559 g_clear_object (&self->stdout_pipe);
560 g_clear_object (&self->stderr_pipe);
563 G_OBJECT_CLASS (g_subprocess_parent_class)->finalize (object);
567 g_subprocess_init (GSubprocess *self)
572 initable_iface_init (GInitableIface *initable_iface)
574 initable_iface->init = initable_init;
578 g_subprocess_class_init (GSubprocessClass *class)
580 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
582 gobject_class->finalize = g_subprocess_finalize;
583 gobject_class->set_property = g_subprocess_set_property;
585 g_object_class_install_property (gobject_class, PROP_FLAGS,
586 g_param_spec_flags ("flags", P_("Flags"), P_("Subprocess flags"),
587 G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |
588 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
589 g_object_class_install_property (gobject_class, PROP_ARGV,
590 g_param_spec_boxed ("argv", P_("Arguments"), P_("Argument vector"),
591 G_TYPE_STRV, G_PARAM_WRITABLE |
592 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
596 * g_subprocess_new: (skip)
598 * Create a new process with the given flags and varargs argument list.
600 * The argument list must be terminated with %NULL.
602 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
608 g_subprocess_new (GSubprocessFlags flags,
618 g_return_val_if_fail (argv0 != NULL && argv0[0] != '\0', NULL);
619 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
621 args = g_ptr_array_new ();
623 va_start (ap, argv0);
624 g_ptr_array_add (args, (gchar *) argv0);
625 while ((arg = va_arg (ap, const gchar *)))
626 g_ptr_array_add (args, (gchar *) arg);
627 g_ptr_array_add (args, NULL);
629 result = g_subprocess_newv ((const gchar * const *) args->pdata, flags, error);
631 g_ptr_array_free (args, TRUE);
639 * Create a new process with the given flags and argument list.
641 * The argument list is expected to be %NULL-terminated.
643 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
647 * Rename to: g_subprocess_new
650 g_subprocess_newv (const gchar * const *argv,
651 GSubprocessFlags flags,
654 g_return_val_if_fail (argv != NULL && argv[0] != NULL && argv[0][0] != '\0', NULL);
656 return g_initable_new (G_TYPE_SUBPROCESS, NULL, error,
663 g_subprocess_get_identifier (GSubprocess *subprocess)
665 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
668 return subprocess->identifier;
674 * g_subprocess_get_stdin_pipe:
675 * @subprocess: a #GSubprocess
677 * Gets the #GOutputStream that you can write to in order to give data
678 * to the stdin of @subprocess.
680 * The process must have been created with
681 * %G_SUBPROCESS_FLAGS_STDIN_PIPE.
683 * Returns: the stdout pipe
688 g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
690 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
691 g_return_val_if_fail (subprocess->stdin_pipe, NULL);
693 return subprocess->stdin_pipe;
697 * g_subprocess_get_stdout_pipe:
698 * @subprocess: a #GSubprocess
700 * Gets the #GInputStream from which to read the stdout output of
703 * The process must have been created with
704 * %G_SUBPROCESS_FLAGS_STDOUT_PIPE.
706 * Returns: the stdout pipe
711 g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
713 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
714 g_return_val_if_fail (subprocess->stdout_pipe, NULL);
716 return subprocess->stdout_pipe;
720 * g_subprocess_get_stderr_pipe:
721 * @subprocess: a #GSubprocess
723 * Gets the #GInputStream from which to read the stderr output of
726 * The process must have been created with
727 * %G_SUBPROCESS_FLAGS_STDERR_PIPE.
729 * Returns: the stderr pipe
734 g_subprocess_get_stderr_pipe (GSubprocess *subprocess)
736 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
737 g_return_val_if_fail (subprocess->stderr_pipe, NULL);
739 return subprocess->stderr_pipe;
743 g_subprocess_wait_cancelled (GCancellable *cancellable,
746 GTask *task = user_data;
749 self = g_task_get_source_object (task);
751 g_mutex_lock (&self->pending_waits_lock);
752 self->pending_waits = g_slist_remove (self->pending_waits, task);
753 g_mutex_unlock (&self->pending_waits_lock);
755 g_task_return_boolean (task, FALSE);
756 g_object_unref (task);
760 * g_subprocess_wait_async:
761 * @subprocess: a #GSubprocess
762 * @cancellable: a #GCancellable, or %NULL
763 * @callback: a #GAsyncReadyCallback to call when the operation is complete
764 * @user_data: user_data for @callback
766 * Wait for the subprocess to terminate.
768 * This is the asynchronous version of g_subprocess_wait().
773 g_subprocess_wait_async (GSubprocess *subprocess,
774 GCancellable *cancellable,
775 GAsyncReadyCallback callback,
780 task = g_task_new (subprocess, cancellable, callback, user_data);
782 g_mutex_lock (&subprocess->pending_waits_lock);
785 /* Only bother with cancellable if we're putting it in the list.
786 * If not, it's going to dispatch immediately anyway and we will
787 * see the cancellation in the _finish().
790 g_signal_connect_object (cancellable, "cancelled", G_CALLBACK (g_subprocess_wait_cancelled), task, 0);
792 subprocess->pending_waits = g_slist_prepend (subprocess->pending_waits, task);
795 g_mutex_unlock (&subprocess->pending_waits_lock);
797 /* If we still have task then it's because did_exit is already TRUE */
800 g_task_return_boolean (task, TRUE);
801 g_object_unref (task);
806 * g_subprocess_wait_finish:
807 * @subprocess: a #GSubprocess
808 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
809 * @error: a pointer to a %NULL #GError, or %NULL
811 * Collects the result of a previous call to
812 * g_subprocess_wait_async().
814 * Returns: %TRUE if successful, or %FALSE with @error set
819 g_subprocess_wait_finish (GSubprocess *subprocess,
820 GAsyncResult *result,
823 return g_task_propagate_boolean (G_TASK (result), error);
826 /* Some generic helpers for emulating synchronous operations using async
830 g_subprocess_sync_setup (void)
832 g_main_context_push_thread_default (g_main_context_new ());
836 g_subprocess_sync_done (GObject *source_object,
837 GAsyncResult *result,
840 GAsyncResult **result_ptr = user_data;
842 *result_ptr = g_object_ref (result);
846 g_subprocess_sync_complete (GAsyncResult **result)
848 GMainContext *context = g_main_context_get_thread_default ();
851 g_main_context_iteration (context, TRUE);
853 g_main_context_pop_thread_default (context);
854 g_main_context_unref (context);
859 * @subprocess: a #GSubprocess
860 * @cancellable: a #GCancellable
863 * Synchronously wait for the subprocess to terminate.
865 * After the process terminates you can query its exit status with
866 * functions such as g_subprocess_get_if_exited() and
867 * g_subprocess_get_exit_status().
869 * This function does not fail in the case of the subprocess having
870 * abnormal termination. See g_subprocess_wait_check() for that.
872 * Returns: %TRUE on success, %FALSE if @cancellable was cancelled
877 g_subprocess_wait (GSubprocess *subprocess,
878 GCancellable *cancellable,
881 GAsyncResult *result = NULL;
884 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
886 /* Synchronous waits are actually the 'more difficult' case because we
887 * need to deal with the possibility of cancellation. That more or
888 * less implies that we need a main context (to dispatch either of the
889 * possible reasons for the operation ending).
891 * So we make one and then do this async...
894 if (g_cancellable_set_error_if_cancelled (cancellable, error))
897 /* We can shortcut in the case that the process already quit (but only
898 * after we checked the cancellable).
900 if (subprocess->pid == 0)
903 /* Otherwise, we need to do this the long way... */
904 g_subprocess_sync_setup ();
905 g_subprocess_wait_async (subprocess, cancellable, g_subprocess_sync_done, &result);
906 g_subprocess_sync_complete (&result);
907 success = g_subprocess_wait_finish (subprocess, result, error);
908 g_object_unref (result);
914 * g_subprocess_wait_check:
915 * @subprocess: a #GSubprocess
916 * @cancellable: a #GCancellable
919 * Combines g_subprocess_wait() with g_spawn_check_exit_status().
921 * Returns: %TRUE on success, %FALSE if process exited abnormally, or
922 * @cancellable was cancelled
927 g_subprocess_wait_check (GSubprocess *subprocess,
928 GCancellable *cancellable,
931 return g_subprocess_wait (subprocess, cancellable, error) &&
932 g_spawn_check_exit_status (subprocess->status, error);
936 * g_subprocess_wait_check_async:
937 * @subprocess: a #GSubprocess
938 * @cancellable: a #GCancellable, or %NULL
939 * @callback: a #GAsyncReadyCallback to call when the operation is complete
940 * @user_data: user_data for @callback
942 * Combines g_subprocess_wait_async() with g_spawn_check_exit_status().
944 * This is the asynchronous version of g_subprocess_wait_check().
949 g_subprocess_wait_check_async (GSubprocess *subprocess,
950 GCancellable *cancellable,
951 GAsyncReadyCallback callback,
954 g_subprocess_wait_async (subprocess, cancellable, callback, user_data);
958 * g_subprocess_wait_check_finish:
959 * @subprocess: a #GSubprocess
960 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
961 * @error: a pointer to a %NULL #GError, or %NULL
963 * Collects the result of a previous call to
964 * g_subprocess_wait_check_async().
966 * Returns: %TRUE if successful, or %FALSE with @error set
971 g_subprocess_wait_check_finish (GSubprocess *subprocess,
972 GAsyncResult *result,
975 return g_subprocess_wait_finish (subprocess, result, error) &&
976 g_spawn_check_exit_status (subprocess->status, error);
982 GSubprocess *subprocess;
987 g_subprocess_actually_send_signal (gpointer user_data)
989 SignalRecord *signal_record = user_data;
991 /* The pid is set to zero from the worker thread as well, so we don't
992 * need to take a lock in order to prevent it from changing under us.
994 if (signal_record->subprocess->pid)
995 kill (signal_record->subprocess->pid, signal_record->signalnum);
997 g_object_unref (signal_record->subprocess);
999 g_slice_free (SignalRecord, signal_record);
1005 g_subprocess_dispatch_signal (GSubprocess *subprocess,
1008 SignalRecord signal_record = { g_object_ref (subprocess), signalnum };
1010 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1012 /* This MUST be a lower priority than the priority that the child
1013 * watch source uses in initable_init().
1015 * Reaping processes, reporting the results back to GSubprocess and
1016 * sending signals is all done in the glib worker thread. We cannot
1017 * have a kill() done after the reap and before the report without
1018 * risking killing a process that's no longer there so the kill()
1019 * needs to have the lower priority.
1021 * G_PRIORITY_HIGH_IDLE is lower priority than G_PRIORITY_DEFAULT.
1023 g_main_context_invoke_full (GLIB_PRIVATE_CALL (g_get_worker_context) (),
1024 G_PRIORITY_HIGH_IDLE,
1025 g_subprocess_actually_send_signal,
1026 g_slice_dup (SignalRecord, &signal_record),
1031 * g_subprocess_send_signal:
1032 * @subprocess: a #GSubprocess
1033 * @signal_num: the signal number to send
1035 * Sends the UNIX signal @signal_num to the subprocess, if it is still
1038 * This API is race-free. If the subprocess has terminated, it will not
1041 * This API is not available on Windows.
1046 g_subprocess_send_signal (GSubprocess *subprocess,
1049 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1051 g_subprocess_dispatch_signal (subprocess, signal_num);
1056 * g_subprocess_force_exit:
1057 * @subprocess: a #GSubprocess
1059 * Use an operating-system specific method to attempt an immediate,
1060 * forceful termination of the process. There is no mechanism to
1061 * determine whether or not the request itself was successful;
1062 * however, you can use g_subprocess_wait() to monitor the status of
1063 * the process after calling this function.
1065 * On Unix, this function sends %SIGKILL.
1070 g_subprocess_force_exit (GSubprocess *subprocess)
1072 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1075 g_subprocess_dispatch_signal (subprocess, SIGKILL);
1077 TerminateProcess (subprocess->pid, 1);
1082 * g_subprocess_get_status:
1083 * @subprocess: a #GSubprocess
1085 * Gets the raw status code of the process, as from waitpid().
1087 * This value has no particular meaning, but it can be used with the
1088 * macros defined by the system headers such as WIFEXITED. It can also
1089 * be used with g_spawn_check_exit_status().
1091 * It is more likely that you want to use g_subprocess_get_if_exited()
1092 * followed by g_subprocess_get_exit_status().
1094 * It is an error to call this function before g_subprocess_wait() has
1097 * Returns: the (meaningless) waitpid() exit status from the kernel
1102 g_subprocess_get_status (GSubprocess *subprocess)
1104 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1105 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1107 return subprocess->status;
1111 * g_subprocess_get_successful:
1112 * @subprocess: a #GSubprocess
1114 * Checks if the process was "successful". A process is considered
1115 * successful if it exited cleanly with an exit status of 0, either by
1116 * way of the exit() system call or return from main().
1118 * It is an error to call this function before g_subprocess_wait() has
1121 * Returns: %TRUE if the process exited cleanly with a exit status of 0
1126 g_subprocess_get_successful (GSubprocess *subprocess)
1128 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1129 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1131 return WIFEXITED (subprocess->status) && WEXITSTATUS (subprocess->status) == 0;
1135 * g_subprocess_get_if_exited:
1136 * @subprocess: a #GSubprocess
1138 * Check if the given subprocess exited normally (ie: by way of exit()
1139 * or return from main()).
1141 * This is equivalent to the system WIFEXITED macro.
1143 * It is an error to call this function before g_subprocess_wait() has
1146 * Returns: %TRUE if the case of a normal exit
1151 g_subprocess_get_if_exited (GSubprocess *subprocess)
1153 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1154 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1156 return WIFEXITED (subprocess->status);
1160 * g_subprocess_get_exit_status:
1161 * @subprocess: a #GSubprocess
1163 * Check the exit status of the subprocess, given that it exited
1164 * normally. This is the value passed to the exit() system call or the
1165 * return value from main.
1167 * This is equivalent to the system WEXITSTATUS macro.
1169 * It is an error to call this function before g_subprocess_wait() and
1170 * unless g_subprocess_get_if_exited() returned %TRUE.
1172 * Returns: the exit status
1177 g_subprocess_get_exit_status (GSubprocess *subprocess)
1179 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 1);
1180 g_return_val_if_fail (subprocess->pid == 0, 1);
1181 g_return_val_if_fail (WIFEXITED (subprocess->status), 1);
1183 return WEXITSTATUS (subprocess->status);
1187 * g_subprocess_get_if_signaled:
1188 * @subprocess: a #GSubprocess
1190 * Check if the given subprocess terminated in response to a signal.
1192 * This is equivalent to the system WIFSIGNALED macro.
1194 * It is an error to call this function before g_subprocess_wait() has
1197 * Returns: %TRUE if the case of termination due to a signal
1202 g_subprocess_get_if_signaled (GSubprocess *subprocess)
1204 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1205 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1207 return WIFSIGNALED (subprocess->status);
1211 * g_subprocess_get_term_sig:
1212 * @subprocess: a #GSubprocess
1214 * Get the signal number that caused the subprocess to terminate, given
1215 * that it terminated due to a signal.
1217 * This is equivalent to the system WTERMSIG macro.
1219 * It is an error to call this function before g_subprocess_wait() and
1220 * unless g_subprocess_get_if_signaled() returned %TRUE.
1222 * Returns: the signal causing termination
1227 g_subprocess_get_term_sig (GSubprocess *subprocess)
1229 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 0);
1230 g_return_val_if_fail (subprocess->pid == 0, 0);
1231 g_return_val_if_fail (WIFSIGNALED (subprocess->status), 0);
1233 return WTERMSIG (subprocess->status);
1238 g_subprocess_set_launcher (GSubprocess *subprocess,
1239 GSubprocessLauncher *launcher)
1241 subprocess->launcher = launcher;
1245 /* g_subprocess_communicate implementation below:
1247 * This is a tough problem. We have to watch 5 things at the same time:
1249 * - writing to stdin made progress
1250 * - reading from stdout made progress
1251 * - reading from stderr made progress
1252 * - process terminated
1253 * - cancellable being cancelled by caller
1255 * We use a GMainContext for all of these (either as async function
1256 * calls or as a GSource (in the case of the cancellable). That way at
1257 * least we don't have to worry about threading.
1259 * For the sync case we use the usual trick of creating a private main
1260 * context and iterating it until completion.
1262 * It's very possible that the process will dump a lot of data to stdout
1263 * just before it quits, so we can easily have data to read from stdout
1264 * and see the process has terminated at the same time. We want to make
1265 * sure that we read all of the data from the pipes first, though, so we
1266 * do IO operations at a higher priority than the wait operation (which
1267 * is at G_IO_PRIORITY_DEFAULT). Even in the case that we have to do
1268 * multiple reads to get this data, the pipe() will always be polling
1269 * as ready and with the async result for the read at a higher priority,
1270 * the main context will not dispatch the completion for the wait().
1272 * We keep our own private GCancellable. In the event that any of the
1273 * above suffers from an error condition (including the user cancelling
1274 * their cancellable) we immediately dispatch the GTask with the error
1275 * result and fire our cancellable to cleanup any pending operations.
1276 * In the case that the error is that the user's cancellable was fired,
1277 * it's vaguely wasteful to report an error because GTask will handle
1278 * this automatically, so we just return FALSE.
1280 * We let each pending sub-operation take a ref on the GTask of the
1281 * communicate operation. We have to be careful that we don't report
1282 * the task completion more than once, though, so we keep a flag for
1287 const gchar *stdin_data;
1293 GInputStream *stdin_buf;
1294 GMemoryOutputStream *stdout_buf;
1295 GMemoryOutputStream *stderr_buf;
1297 GCancellable *cancellable;
1298 GSource *cancellable_source;
1300 guint outstanding_ops;
1301 gboolean reported_error;
1305 g_subprocess_communicate_made_progress (GObject *source_object,
1306 GAsyncResult *result,
1309 CommunicateState *state;
1310 GSubprocess *subprocess;
1311 GError *error = NULL;
1315 g_assert (source_object != NULL);
1318 subprocess = g_task_get_source_object (task);
1319 state = g_task_get_task_data (task);
1320 source = source_object;
1322 state->outstanding_ops--;
1324 if (source == subprocess->stdin_pipe ||
1325 source == state->stdout_buf ||
1326 source == state->stderr_buf)
1328 if (!g_output_stream_splice_finish ((GOutputStream*)source, result, &error))
1331 if (source == state->stdout_buf ||
1332 source == state->stderr_buf)
1334 /* This is a memory stream, so it can't be cancelled or return
1339 gsize bytes_written;
1340 if (!g_output_stream_write_all (source, "\0", 1, &bytes_written,
1344 if (!g_output_stream_close (source, NULL, &error))
1348 else if (source == subprocess)
1350 (void) g_subprocess_wait_finish (subprocess, result, &error);
1353 g_assert_not_reached ();
1358 /* Only report the first error we see.
1360 * We might be seeing an error as a result of the cancellation
1361 * done when the process quits.
1363 if (!state->reported_error)
1365 state->reported_error = TRUE;
1366 g_cancellable_cancel (state->cancellable);
1367 g_task_return_error (task, error);
1370 g_error_free (error);
1372 else if (state->outstanding_ops == 0)
1374 g_task_return_boolean (task, TRUE);
1377 /* And drop the original ref */
1378 g_object_unref (task);
1382 g_subprocess_communicate_cancelled (gpointer user_data)
1384 CommunicateState *state = user_data;
1386 g_cancellable_cancel (state->cancellable);
1392 g_subprocess_communicate_state_free (gpointer data)
1394 CommunicateState *state = data;
1396 g_clear_object (&state->stdin_buf);
1397 g_clear_object (&state->stdout_buf);
1398 g_clear_object (&state->stderr_buf);
1400 if (!g_source_is_destroyed (state->cancellable_source))
1401 g_source_destroy (state->cancellable_source);
1402 g_source_unref (state->cancellable_source);
1404 g_slice_free (CommunicateState, state);
1407 static CommunicateState *
1408 g_subprocess_communicate_internal (GSubprocess *subprocess,
1411 GCancellable *cancellable,
1412 GAsyncReadyCallback callback,
1415 CommunicateState *state;
1418 task = g_task_new (subprocess, cancellable, callback, user_data);
1419 state = g_slice_new0 (CommunicateState);
1420 g_task_set_task_data (task, state, g_subprocess_communicate_state_free);
1422 state->cancellable = g_cancellable_new ();
1423 state->add_nul = add_nul;
1427 state->cancellable_source = g_cancellable_source_new (cancellable);
1428 /* No ref held here, but we unref the source from state's free function */
1429 g_source_set_callback (state->cancellable_source, g_subprocess_communicate_cancelled, state, NULL);
1430 g_source_attach (state->cancellable_source, g_main_context_get_thread_default ());
1433 if (subprocess->stdin_pipe)
1435 g_assert (stdin_buf != NULL);
1436 state->stdin_buf = g_memory_input_stream_new_from_bytes (stdin_buf);
1437 g_output_stream_splice_async (subprocess->stdin_pipe, (GInputStream*)state->stdin_buf,
1438 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE | G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
1439 G_PRIORITY_DEFAULT, state->cancellable,
1440 g_subprocess_communicate_made_progress, g_object_ref (task));
1441 state->outstanding_ops++;
1444 if (subprocess->stdout_pipe)
1446 state->stdout_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1447 g_output_stream_splice_async ((GOutputStream*)state->stdout_buf, subprocess->stdout_pipe,
1448 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1449 G_PRIORITY_DEFAULT, state->cancellable,
1450 g_subprocess_communicate_made_progress, g_object_ref (task));
1451 state->outstanding_ops++;
1454 if (subprocess->stderr_pipe)
1456 state->stderr_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1457 g_output_stream_splice_async ((GOutputStream*)state->stderr_buf, subprocess->stderr_pipe,
1458 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1459 G_PRIORITY_DEFAULT, state->cancellable,
1460 g_subprocess_communicate_made_progress, g_object_ref (task));
1461 state->outstanding_ops++;
1464 g_subprocess_wait_async (subprocess, state->cancellable,
1465 g_subprocess_communicate_made_progress, g_object_ref (task));
1466 state->outstanding_ops++;
1472 * g_subprocess_communicate:
1473 * @subprocess: a #GSubprocess
1474 * @stdin_buf: data to send to the stdin of the subprocess, or %NULL
1475 * @cancellable: a #GCancellable
1476 * @stdout_buf: (out): data read from the subprocess stdout
1477 * @stderr_buf: (out): data read from the subprocess stderr
1478 * @error: a pointer to a %NULL #GError pointer, or %NULL
1480 * Communicate with the subprocess until it terminates, and all input
1481 * and output has been completed.
1483 * If @stdin is given, the subprocess must have been created with
1484 * %G_SUBPROCESS_FLAGS_STDIN_PIPE. The given data is fed to the
1485 * stdin of the subprocess and the pipe is closed (ie: EOF).
1487 * At the same time (as not to cause blocking when dealing with large
1488 * amounts of data), if %G_SUBPROCESS_FLAGS_STDOUT_PIPE or
1489 * %G_SUBPROCESS_FLAGS_STDERR_PIPE were used, reads from those
1490 * streams. The data that was read is returned in @stdout and/or
1493 * If the subprocess was created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1494 * @stdout_buf will contain the data read from stdout. Otherwise, for
1495 * subprocesses not created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1496 * @stdout_buf will be set to %NULL. Similar provisions apply to
1497 * @stderr_buf and %G_SUBPROCESS_FLAGS_STDERR_PIPE.
1499 * As usual, any output variable may be given as %NULL to ignore it.
1501 * If you desire the stdout and stderr data to be interleaved, create
1502 * the subprocess with %G_SUBPROCESS_FLAGS_STDOUT_PIPE and
1503 * %G_SUBPROCESS_FLAGS_STDERR_MERGE. The merged result will be returned
1504 * in @stdout_buf and @stderr_buf will be set to %NULL.
1506 * In case of any error (including cancellation), %FALSE will be
1507 * returned with @error set. Some or all of the stdin data may have
1508 * been written. Any stdout or stderr data that has been read will be
1509 * discarded. None of the out variables (aside from @error) will have
1510 * been set to anything in particular and should not be inspected.
1512 * In the case that %TRUE is returned, the subprocess has exited and the
1513 * exit status inspection APIs (eg: g_subprocess_get_if_exited(),
1514 * g_subprocess_get_exit_status()) may be used.
1516 * You should not attempt to use any of the subprocess pipes after
1517 * starting this function, since they may be left in strange states,
1518 * even if the operation was cancelled. You should especially not
1519 * attempt to interact with the pipes while the operation is in progress
1520 * (either from another thread or if using the asynchronous version).
1522 * Returns: %TRUE if successful
1527 g_subprocess_communicate (GSubprocess *subprocess,
1529 GCancellable *cancellable,
1530 GBytes **stdout_buf,
1531 GBytes **stderr_buf,
1534 GAsyncResult *result = NULL;
1537 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1538 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1539 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1540 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1542 g_subprocess_sync_setup ();
1543 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable,
1544 g_subprocess_sync_done, &result);
1545 g_subprocess_sync_complete (&result);
1546 success = g_subprocess_communicate_finish (subprocess, result, stdout_buf, stderr_buf, error);
1547 g_object_unref (result);
1553 * g_subprocess_communicate_async:
1555 * @stdin_buf: Input data
1556 * @cancellable: Cancellable
1557 * @callback: Callback
1558 * @user_data: User data
1560 * Asynchronous version of g_subprocess_communicate(). Complete
1561 * invocation with g_subprocess_communicate_finish().
1564 g_subprocess_communicate_async (GSubprocess *subprocess,
1566 GCancellable *cancellable,
1567 GAsyncReadyCallback callback,
1570 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1571 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1572 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1574 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable, callback, user_data);
1578 * g_subprocess_communicate_finish:
1581 * @stdout_buf: (out): Return location for stdout data
1582 * @stderr_buf: (out): Return location for stderr data
1585 * Complete an invocation of g_subprocess_communicate_async().
1588 g_subprocess_communicate_finish (GSubprocess *subprocess,
1589 GAsyncResult *result,
1590 GBytes **stdout_buf,
1591 GBytes **stderr_buf,
1595 CommunicateState *state;
1597 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1598 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1599 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1601 g_object_ref (result);
1603 state = g_task_get_task_data ((GTask*)result);
1604 success = g_task_propagate_boolean ((GTask*)result, error);
1609 *stdout_buf = g_memory_output_stream_steal_as_bytes (state->stdout_buf);
1611 *stderr_buf = g_memory_output_stream_steal_as_bytes (state->stderr_buf);
1614 g_object_unref (result);
1619 * g_subprocess_communicate_utf8:
1620 * @subprocess: a #GSubprocess
1621 * @stdin_buf: data to send to the stdin of the subprocess, or %NULL
1622 * @cancellable: a #GCancellable
1623 * @stdout_buf: (out): data read from the subprocess stdout
1624 * @stderr_buf: (out): data read from the subprocess stderr
1625 * @error: a pointer to a %NULL #GError pointer, or %NULL
1627 * Like g_subprocess_communicate(), but validates the output of the
1628 * process as UTF-8, and returns it as a regular NUL terminated string.
1631 g_subprocess_communicate_utf8 (GSubprocess *subprocess,
1632 const char *stdin_buf,
1633 GCancellable *cancellable,
1638 GAsyncResult *result = NULL;
1640 GBytes *stdin_bytes;
1642 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1643 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1644 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1645 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1647 stdin_bytes = g_bytes_new (stdin_buf, strlen (stdin_buf));
1649 g_subprocess_sync_setup ();
1650 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable,
1651 g_subprocess_sync_done, &result);
1652 g_subprocess_sync_complete (&result);
1653 success = g_subprocess_communicate_utf8_finish (subprocess, result, stdout_buf, stderr_buf, error);
1654 g_object_unref (result);
1656 g_bytes_unref (stdin_bytes);
1661 * g_subprocess_communicate_utf8_async:
1663 * @stdin_buf: Input data
1664 * @cancellable: Cancellable
1665 * @callback: Callback
1666 * @user_data: User data
1668 * Asynchronous version of g_subprocess_communicate_utf(). Complete
1669 * invocation with g_subprocess_communicate_utf8_finish().
1672 g_subprocess_communicate_utf8_async (GSubprocess *subprocess,
1673 const char *stdin_buf,
1674 GCancellable *cancellable,
1675 GAsyncReadyCallback callback,
1678 GBytes *stdin_bytes;
1680 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1681 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1682 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1684 stdin_bytes = g_bytes_new (stdin_buf, strlen (stdin_buf));
1685 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable, callback, user_data);
1686 g_bytes_unref (stdin_bytes);
1690 communicate_result_validate_utf8 (const char *stream_name,
1691 char **return_location,
1692 GMemoryOutputStream *buffer,
1695 if (return_location == NULL)
1701 *return_location = g_memory_output_stream_steal_data (buffer);
1702 if (!g_utf8_validate (*return_location, -1, &end))
1704 g_free (*return_location);
1705 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
1706 "Invalid UTF-8 in child %s at offset %lu",
1708 (unsigned long) (end - *return_location));
1713 *return_location = NULL;
1719 * g_subprocess_communicate_utf8_finish:
1722 * @stdout_buf: (out): Return location for stdout data
1723 * @stderr_buf: (out): Return location for stderr data
1726 * Complete an invocation of g_subprocess_communicate_utf8_async().
1729 g_subprocess_communicate_utf8_finish (GSubprocess *subprocess,
1730 GAsyncResult *result,
1735 gboolean ret = FALSE;
1736 CommunicateState *state;
1738 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1739 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1740 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1742 g_object_ref (result);
1744 state = g_task_get_task_data ((GTask*)result);
1745 if (!g_task_propagate_boolean ((GTask*)result, error))
1748 /* TODO - validate UTF-8 while streaming, rather than all at once.
1750 if (!communicate_result_validate_utf8 ("stdout", stdout_buf,
1754 if (!communicate_result_validate_utf8 ("stderr", stderr_buf,
1761 g_object_unref (result);