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>
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));
180 GSpawnChildSetupFunc child_setup_func;
181 gpointer child_setup_data;
182 GArray *basic_fd_assignments;
183 GArray *needdup_fd_assignments;
187 unset_cloexec (int fd)
192 flags = fcntl (fd, F_GETFD, 0);
196 flags &= (~FD_CLOEXEC);
198 result = fcntl (fd, F_SETFD, flags);
199 while (result == -1 && errno == EINTR);
204 dupfd_cloexec (int parent_fd)
207 #ifdef F_DUPFD_CLOEXEC
209 fd = fcntl (parent_fd, F_DUPFD_CLOEXEC, 3);
210 while (fd == -1 && errno == EINTR);
212 /* OS X Snow Lion and earlier don't have F_DUPFD_CLOEXEC:
213 * https://bugzilla.gnome.org/show_bug.cgi?id=710962
217 fd = fcntl (parent_fd, F_DUPFD, 3);
218 while (fd == -1 && errno == EINTR);
219 flags = fcntl (fd, F_GETFD, 0);
224 result = fcntl (fd, F_SETFD, flags);
225 while (result == -1 && errno == EINTR);
232 * Based on code derived from
233 * gnome-terminal:src/terminal-screen.c:terminal_screen_child_setup(),
234 * used under the LGPLv2+ with permission from author.
237 child_setup (gpointer user_data)
239 ChildData *child_data = user_data;
243 /* We're on the child side now. "Rename" the file descriptors in
244 * child_data.fds[] to stdin/stdout/stderr.
246 * We don't close the originals. It's possible that the originals
247 * should not be closed and if they should be closed then they should
248 * have been created O_CLOEXEC.
250 for (i = 0; i < 3; i++)
251 if (child_data->fds[i] != -1 && child_data->fds[i] != i)
254 result = dup2 (child_data->fds[i], i);
255 while (result == -1 && errno == EINTR);
258 /* Basic fd assignments we can just unset FD_CLOEXEC */
259 if (child_data->basic_fd_assignments)
261 for (i = 0; i < child_data->basic_fd_assignments->len; i++)
263 gint fd = g_array_index (child_data->basic_fd_assignments, int, i);
269 /* If we're doing remapping fd assignments, we need to handle
270 * the case where the user has specified e.g.:
273 * We do this by duping the source fds temporarily.
275 if (child_data->needdup_fd_assignments)
277 for (i = 0; i < child_data->needdup_fd_assignments->len; i += 2)
279 gint parent_fd = g_array_index (child_data->needdup_fd_assignments, int, i);
282 new_parent_fd = dupfd_cloexec (parent_fd);
284 g_array_index (child_data->needdup_fd_assignments, int, i) = new_parent_fd;
286 for (i = 0; i < child_data->needdup_fd_assignments->len; i += 2)
288 gint parent_fd = g_array_index (child_data->needdup_fd_assignments, int, i);
289 gint child_fd = g_array_index (child_data->needdup_fd_assignments, int, i+1);
291 if (parent_fd == child_fd)
293 unset_cloexec (parent_fd);
298 result = dup2 (parent_fd, child_fd);
299 while (result == -1 && errno == EINTR);
300 (void) close (parent_fd);
305 if (child_data->child_setup_func)
306 child_data->child_setup_func (child_data->child_setup_data);
310 static GInputStream *
311 platform_input_stream_from_spawn_fd (gint fd)
317 return g_unix_input_stream_new (fd, TRUE);
319 return g_win32_input_stream_new_from_fd (fd, TRUE);
323 static GOutputStream *
324 platform_output_stream_from_spawn_fd (gint fd)
330 return g_unix_output_stream_new (fd, TRUE);
332 return g_win32_output_stream_new_from_fd (fd, TRUE);
338 unix_open_file (const char *filename,
344 my_fd = g_open (filename, mode | O_BINARY | O_CLOEXEC, 0666);
346 /* If we return -1 we should also set the error */
349 gint saved_errno = errno;
352 display_name = g_filename_display_name (filename);
353 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (saved_errno),
354 _("Error opening file '%s': %s"), display_name,
355 g_strerror (saved_errno));
356 g_free (display_name);
357 /* fall through... */
365 g_subprocess_set_property (GObject *object,
370 GSubprocess *self = G_SUBPROCESS (object);
375 self->flags = g_value_get_flags (value);
379 self->argv = g_value_dup_boxed (value);
383 g_assert_not_reached ();
388 g_subprocess_exited (GPid pid,
392 GSubprocess *self = user_data;
395 g_assert (self->pid == pid);
397 g_mutex_lock (&self->pending_waits_lock);
398 self->status = status;
399 tasks = self->pending_waits;
400 self->pending_waits = NULL;
402 g_mutex_unlock (&self->pending_waits_lock);
404 /* Signal anyone in g_subprocess_wait_async() to wake up now */
407 g_task_return_boolean (tasks->data, TRUE);
408 g_object_unref (tasks->data);
409 tasks = g_slist_delete_link (tasks, tasks);
412 g_spawn_close_pid (pid);
418 initable_init (GInitable *initable,
419 GCancellable *cancellable,
422 GSubprocess *self = G_SUBPROCESS (initable);
424 ChildData child_data = { { -1, -1, -1 }, 0 };
426 gint *pipe_ptrs[3] = { NULL, NULL, NULL };
427 gint pipe_fds[3] = { -1, -1, -1 };
428 gint close_fds[3] = { -1, -1, -1 };
429 GSpawnFlags spawn_flags = 0;
430 gboolean success = FALSE;
433 /* this is a programmer error */
434 if (!self->argv || !self->argv[0] || !self->argv[0][0])
437 if (g_cancellable_set_error_if_cancelled (cancellable, error))
440 /* We must setup the three fds that will end up in the child as stdin,
445 if (self->flags & G_SUBPROCESS_FLAGS_STDIN_INHERIT)
446 spawn_flags |= G_SPAWN_CHILD_INHERITS_STDIN;
447 else if (self->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE)
448 pipe_ptrs[0] = &pipe_fds[0];
450 else if (self->launcher)
452 if (self->launcher->stdin_fd != -1)
453 child_data.fds[0] = self->launcher->stdin_fd;
454 else if (self->launcher->stdin_path != NULL)
456 child_data.fds[0] = close_fds[0] = unix_open_file (self->launcher->stdin_path, O_RDONLY, error);
457 if (child_data.fds[0] == -1)
464 if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_SILENCE)
465 spawn_flags |= G_SPAWN_STDOUT_TO_DEV_NULL;
466 else if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_PIPE)
467 pipe_ptrs[1] = &pipe_fds[1];
469 else if (self->launcher)
471 if (self->launcher->stdout_fd != -1)
472 child_data.fds[1] = self->launcher->stdout_fd;
473 else if (self->launcher->stdout_path != NULL)
475 child_data.fds[1] = close_fds[1] = unix_open_file (self->launcher->stdout_path, O_CREAT | O_WRONLY, error);
476 if (child_data.fds[1] == -1)
482 /* Finally, stderr. */
483 if (self->flags & G_SUBPROCESS_FLAGS_STDERR_SILENCE)
484 spawn_flags |= G_SPAWN_STDERR_TO_DEV_NULL;
485 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_PIPE)
486 pipe_ptrs[2] = &pipe_fds[2];
488 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_MERGE)
489 /* This will work because stderr gets setup after stdout. */
490 child_data.fds[2] = 1;
491 else if (self->launcher)
493 if (self->launcher->stderr_fd != -1)
494 child_data.fds[2] = self->launcher->stderr_fd;
495 else if (self->launcher->stderr_path != NULL)
497 child_data.fds[2] = close_fds[2] = unix_open_file (self->launcher->stderr_path, O_CREAT | O_WRONLY, error);
498 if (child_data.fds[2] == -1)
507 child_data.basic_fd_assignments = self->launcher->basic_fd_assignments;
508 child_data.needdup_fd_assignments = self->launcher->needdup_fd_assignments;
512 /* argv0 has no '/' in it? We better do a PATH lookup. */
513 if (strchr (self->argv[0], G_DIR_SEPARATOR) == NULL)
515 if (self->launcher && self->launcher->path_from_envp)
516 spawn_flags |= G_SPAWN_SEARCH_PATH_FROM_ENVP;
518 spawn_flags |= G_SPAWN_SEARCH_PATH;
521 if (self->flags & G_SUBPROCESS_FLAGS_INHERIT_FDS)
522 spawn_flags |= G_SPAWN_LEAVE_DESCRIPTORS_OPEN;
524 spawn_flags |= G_SPAWN_DO_NOT_REAP_CHILD;
525 spawn_flags |= G_SPAWN_CLOEXEC_PIPES;
528 child_data.child_setup_func = self->launcher ? self->launcher->child_setup_func : NULL;
529 child_data.child_setup_data = self->launcher ? self->launcher->child_setup_user_data : NULL;
532 success = g_spawn_async_with_pipes (self->launcher ? self->launcher->cwd : NULL,
534 self->launcher ? self->launcher->envp : NULL,
537 child_setup, &child_data,
542 pipe_ptrs[0], pipe_ptrs[1], pipe_ptrs[2],
544 g_assert (success == (self->pid != 0));
551 identifier = (guint64) GetProcessId (self->pid);
553 identifier = (guint64) self->pid;
556 s = g_snprintf (self->identifier, sizeof self->identifier, "%"G_GUINT64_FORMAT, identifier);
557 g_assert (0 < s && s < sizeof self->identifier);
560 /* Start attempting to reap the child immediately */
563 GMainContext *worker_context;
566 worker_context = GLIB_PRIVATE_CALL (g_get_worker_context) ();
567 source = g_child_watch_source_new (self->pid);
568 g_source_set_callback (source, (GSourceFunc) g_subprocess_exited, g_object_ref (self), g_object_unref);
569 g_source_attach (source, worker_context);
570 g_source_unref (source);
576 /* we don't need this past init... */
577 self->launcher = NULL;
579 for (i = 0; i < 3; i++)
580 if (close_fds[i] != -1)
581 close (close_fds[i]);
583 self->stdin_pipe = platform_output_stream_from_spawn_fd (pipe_fds[0]);
584 self->stdout_pipe = platform_input_stream_from_spawn_fd (pipe_fds[1]);
585 self->stderr_pipe = platform_input_stream_from_spawn_fd (pipe_fds[2]);
591 g_subprocess_finalize (GObject *object)
593 GSubprocess *self = G_SUBPROCESS (object);
595 g_assert (self->pending_waits == NULL);
596 g_assert (self->pid == 0);
598 g_clear_object (&self->stdin_pipe);
599 g_clear_object (&self->stdout_pipe);
600 g_clear_object (&self->stderr_pipe);
601 g_strfreev (self->argv);
603 G_OBJECT_CLASS (g_subprocess_parent_class)->finalize (object);
607 g_subprocess_init (GSubprocess *self)
612 initable_iface_init (GInitableIface *initable_iface)
614 initable_iface->init = initable_init;
618 g_subprocess_class_init (GSubprocessClass *class)
620 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
622 gobject_class->finalize = g_subprocess_finalize;
623 gobject_class->set_property = g_subprocess_set_property;
625 g_object_class_install_property (gobject_class, PROP_FLAGS,
626 g_param_spec_flags ("flags", P_("Flags"), P_("Subprocess flags"),
627 G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |
628 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
629 g_object_class_install_property (gobject_class, PROP_ARGV,
630 g_param_spec_boxed ("argv", P_("Arguments"), P_("Argument vector"),
631 G_TYPE_STRV, G_PARAM_WRITABLE |
632 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
636 * g_subprocess_new: (skip)
637 * @flags: flags that define the behaviour of the subprocess
638 * @error: (allow-none): return location for an error, or %NULL
639 * @argv0: first commandline argument to pass to the subprocess,
640 * followed by more arguments, followed by %NULL
642 * Create a new process with the given flags and varargs argument
643 * list. By default, matching the g_spawn_async() defaults, the
644 * child's stdin will be set to the system null device, and
645 * stdout/stderr will be inherited from the parent. You can use
646 * @flags to control this behavior.
648 * The argument list must be terminated with %NULL.
650 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
656 g_subprocess_new (GSubprocessFlags flags,
666 g_return_val_if_fail (argv0 != NULL && argv0[0] != '\0', NULL);
667 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
669 args = g_ptr_array_new ();
671 va_start (ap, argv0);
672 g_ptr_array_add (args, (gchar *) argv0);
673 while ((arg = va_arg (ap, const gchar *)))
674 g_ptr_array_add (args, (gchar *) arg);
675 g_ptr_array_add (args, NULL);
677 result = g_subprocess_newv ((const gchar * const *) args->pdata, flags, error);
679 g_ptr_array_free (args, TRUE);
686 * @argv: commandline arguments for the subprocess
687 * @flags: flags that define the behaviour of the subprocess
688 * @error: (allow-none): return location for an error, or %NULL
690 * Create a new process with the given flags and argument list.
692 * The argument list is expected to be %NULL-terminated.
694 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
698 * Rename to: g_subprocess_new
701 g_subprocess_newv (const gchar * const *argv,
702 GSubprocessFlags flags,
705 g_return_val_if_fail (argv != NULL && argv[0] != NULL && argv[0][0] != '\0', NULL);
707 return g_initable_new (G_TYPE_SUBPROCESS, NULL, error,
714 g_subprocess_get_identifier (GSubprocess *subprocess)
716 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
719 return subprocess->identifier;
725 * g_subprocess_get_stdin_pipe:
726 * @subprocess: a #GSubprocess
728 * Gets the #GOutputStream that you can write to in order to give data
729 * to the stdin of @subprocess.
731 * The process must have been created with
732 * %G_SUBPROCESS_FLAGS_STDIN_PIPE.
734 * Returns: the stdout pipe
739 g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
741 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
742 g_return_val_if_fail (subprocess->stdin_pipe, NULL);
744 return subprocess->stdin_pipe;
748 * g_subprocess_get_stdout_pipe:
749 * @subprocess: a #GSubprocess
751 * Gets the #GInputStream from which to read the stdout output of
754 * The process must have been created with
755 * %G_SUBPROCESS_FLAGS_STDOUT_PIPE.
757 * Returns: the stdout pipe
762 g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
764 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
765 g_return_val_if_fail (subprocess->stdout_pipe, NULL);
767 return subprocess->stdout_pipe;
771 * g_subprocess_get_stderr_pipe:
772 * @subprocess: a #GSubprocess
774 * Gets the #GInputStream from which to read the stderr output of
777 * The process must have been created with
778 * %G_SUBPROCESS_FLAGS_STDERR_PIPE.
780 * Returns: the stderr pipe
785 g_subprocess_get_stderr_pipe (GSubprocess *subprocess)
787 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
788 g_return_val_if_fail (subprocess->stderr_pipe, NULL);
790 return subprocess->stderr_pipe;
794 g_subprocess_wait_cancelled (GCancellable *cancellable,
797 GTask *task = user_data;
800 self = g_task_get_source_object (task);
802 g_mutex_lock (&self->pending_waits_lock);
803 self->pending_waits = g_slist_remove (self->pending_waits, task);
804 g_mutex_unlock (&self->pending_waits_lock);
806 g_task_return_boolean (task, FALSE);
807 g_object_unref (task);
811 * g_subprocess_wait_async:
812 * @subprocess: a #GSubprocess
813 * @cancellable: a #GCancellable, or %NULL
814 * @callback: a #GAsyncReadyCallback to call when the operation is complete
815 * @user_data: user_data for @callback
817 * Wait for the subprocess to terminate.
819 * This is the asynchronous version of g_subprocess_wait().
824 g_subprocess_wait_async (GSubprocess *subprocess,
825 GCancellable *cancellable,
826 GAsyncReadyCallback callback,
831 task = g_task_new (subprocess, cancellable, callback, user_data);
833 g_mutex_lock (&subprocess->pending_waits_lock);
836 /* Only bother with cancellable if we're putting it in the list.
837 * If not, it's going to dispatch immediately anyway and we will
838 * see the cancellation in the _finish().
841 g_signal_connect_object (cancellable, "cancelled", G_CALLBACK (g_subprocess_wait_cancelled), task, 0);
843 subprocess->pending_waits = g_slist_prepend (subprocess->pending_waits, task);
846 g_mutex_unlock (&subprocess->pending_waits_lock);
848 /* If we still have task then it's because did_exit is already TRUE */
851 g_task_return_boolean (task, TRUE);
852 g_object_unref (task);
857 * g_subprocess_wait_finish:
858 * @subprocess: a #GSubprocess
859 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
860 * @error: a pointer to a %NULL #GError, or %NULL
862 * Collects the result of a previous call to
863 * g_subprocess_wait_async().
865 * Returns: %TRUE if successful, or %FALSE with @error set
870 g_subprocess_wait_finish (GSubprocess *subprocess,
871 GAsyncResult *result,
874 return g_task_propagate_boolean (G_TASK (result), error);
877 /* Some generic helpers for emulating synchronous operations using async
881 g_subprocess_sync_setup (void)
883 g_main_context_push_thread_default (g_main_context_new ());
887 g_subprocess_sync_done (GObject *source_object,
888 GAsyncResult *result,
891 GAsyncResult **result_ptr = user_data;
893 *result_ptr = g_object_ref (result);
897 g_subprocess_sync_complete (GAsyncResult **result)
899 GMainContext *context = g_main_context_get_thread_default ();
902 g_main_context_iteration (context, TRUE);
904 g_main_context_pop_thread_default (context);
905 g_main_context_unref (context);
910 * @subprocess: a #GSubprocess
911 * @cancellable: a #GCancellable
914 * Synchronously wait for the subprocess to terminate.
916 * After the process terminates you can query its exit status with
917 * functions such as g_subprocess_get_if_exited() and
918 * g_subprocess_get_exit_status().
920 * This function does not fail in the case of the subprocess having
921 * abnormal termination. See g_subprocess_wait_check() for that.
923 * Returns: %TRUE on success, %FALSE if @cancellable was cancelled
928 g_subprocess_wait (GSubprocess *subprocess,
929 GCancellable *cancellable,
932 GAsyncResult *result = NULL;
935 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
937 /* Synchronous waits are actually the 'more difficult' case because we
938 * need to deal with the possibility of cancellation. That more or
939 * less implies that we need a main context (to dispatch either of the
940 * possible reasons for the operation ending).
942 * So we make one and then do this async...
945 if (g_cancellable_set_error_if_cancelled (cancellable, error))
948 /* We can shortcut in the case that the process already quit (but only
949 * after we checked the cancellable).
951 if (subprocess->pid == 0)
954 /* Otherwise, we need to do this the long way... */
955 g_subprocess_sync_setup ();
956 g_subprocess_wait_async (subprocess, cancellable, g_subprocess_sync_done, &result);
957 g_subprocess_sync_complete (&result);
958 success = g_subprocess_wait_finish (subprocess, result, error);
959 g_object_unref (result);
965 * g_subprocess_wait_check:
966 * @subprocess: a #GSubprocess
967 * @cancellable: a #GCancellable
970 * Combines g_subprocess_wait() with g_spawn_check_exit_status().
972 * Returns: %TRUE on success, %FALSE if process exited abnormally, or
973 * @cancellable was cancelled
978 g_subprocess_wait_check (GSubprocess *subprocess,
979 GCancellable *cancellable,
982 return g_subprocess_wait (subprocess, cancellable, error) &&
983 g_spawn_check_exit_status (subprocess->status, error);
987 * g_subprocess_wait_check_async:
988 * @subprocess: a #GSubprocess
989 * @cancellable: a #GCancellable, or %NULL
990 * @callback: a #GAsyncReadyCallback to call when the operation is complete
991 * @user_data: user_data for @callback
993 * Combines g_subprocess_wait_async() with g_spawn_check_exit_status().
995 * This is the asynchronous version of g_subprocess_wait_check().
1000 g_subprocess_wait_check_async (GSubprocess *subprocess,
1001 GCancellable *cancellable,
1002 GAsyncReadyCallback callback,
1005 g_subprocess_wait_async (subprocess, cancellable, callback, user_data);
1009 * g_subprocess_wait_check_finish:
1010 * @subprocess: a #GSubprocess
1011 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
1012 * @error: a pointer to a %NULL #GError, or %NULL
1014 * Collects the result of a previous call to
1015 * g_subprocess_wait_check_async().
1017 * Returns: %TRUE if successful, or %FALSE with @error set
1022 g_subprocess_wait_check_finish (GSubprocess *subprocess,
1023 GAsyncResult *result,
1026 return g_subprocess_wait_finish (subprocess, result, error) &&
1027 g_spawn_check_exit_status (subprocess->status, error);
1033 GSubprocess *subprocess;
1038 g_subprocess_actually_send_signal (gpointer user_data)
1040 SignalRecord *signal_record = user_data;
1042 /* The pid is set to zero from the worker thread as well, so we don't
1043 * need to take a lock in order to prevent it from changing under us.
1045 if (signal_record->subprocess->pid)
1046 kill (signal_record->subprocess->pid, signal_record->signalnum);
1048 g_object_unref (signal_record->subprocess);
1050 g_slice_free (SignalRecord, signal_record);
1056 g_subprocess_dispatch_signal (GSubprocess *subprocess,
1059 SignalRecord signal_record = { g_object_ref (subprocess), signalnum };
1061 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1063 /* This MUST be a lower priority than the priority that the child
1064 * watch source uses in initable_init().
1066 * Reaping processes, reporting the results back to GSubprocess and
1067 * sending signals is all done in the glib worker thread. We cannot
1068 * have a kill() done after the reap and before the report without
1069 * risking killing a process that's no longer there so the kill()
1070 * needs to have the lower priority.
1072 * G_PRIORITY_HIGH_IDLE is lower priority than G_PRIORITY_DEFAULT.
1074 g_main_context_invoke_full (GLIB_PRIVATE_CALL (g_get_worker_context) (),
1075 G_PRIORITY_HIGH_IDLE,
1076 g_subprocess_actually_send_signal,
1077 g_slice_dup (SignalRecord, &signal_record),
1082 * g_subprocess_send_signal:
1083 * @subprocess: a #GSubprocess
1084 * @signal_num: the signal number to send
1086 * Sends the UNIX signal @signal_num to the subprocess, if it is still
1089 * This API is race-free. If the subprocess has terminated, it will not
1092 * This API is not available on Windows.
1097 g_subprocess_send_signal (GSubprocess *subprocess,
1100 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1102 g_subprocess_dispatch_signal (subprocess, signal_num);
1107 * g_subprocess_force_exit:
1108 * @subprocess: a #GSubprocess
1110 * Use an operating-system specific method to attempt an immediate,
1111 * forceful termination of the process. There is no mechanism to
1112 * determine whether or not the request itself was successful;
1113 * however, you can use g_subprocess_wait() to monitor the status of
1114 * the process after calling this function.
1116 * On Unix, this function sends %SIGKILL.
1121 g_subprocess_force_exit (GSubprocess *subprocess)
1123 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1126 g_subprocess_dispatch_signal (subprocess, SIGKILL);
1128 TerminateProcess (subprocess->pid, 1);
1133 * g_subprocess_get_status:
1134 * @subprocess: a #GSubprocess
1136 * Gets the raw status code of the process, as from waitpid().
1138 * This value has no particular meaning, but it can be used with the
1139 * macros defined by the system headers such as WIFEXITED. It can also
1140 * be used with g_spawn_check_exit_status().
1142 * It is more likely that you want to use g_subprocess_get_if_exited()
1143 * followed by g_subprocess_get_exit_status().
1145 * It is an error to call this function before g_subprocess_wait() has
1148 * Returns: the (meaningless) waitpid() exit status from the kernel
1153 g_subprocess_get_status (GSubprocess *subprocess)
1155 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1156 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1158 return subprocess->status;
1162 * g_subprocess_get_successful:
1163 * @subprocess: a #GSubprocess
1165 * Checks if the process was "successful". A process is considered
1166 * successful if it exited cleanly with an exit status of 0, either by
1167 * way of the exit() system call or return from main().
1169 * It is an error to call this function before g_subprocess_wait() has
1172 * Returns: %TRUE if the process exited cleanly with a exit status of 0
1177 g_subprocess_get_successful (GSubprocess *subprocess)
1179 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1180 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1183 return WIFEXITED (subprocess->status) && WEXITSTATUS (subprocess->status) == 0;
1185 return subprocess->status == 0;
1190 * g_subprocess_get_if_exited:
1191 * @subprocess: a #GSubprocess
1193 * Check if the given subprocess exited normally (ie: by way of exit()
1194 * or return from main()).
1196 * This is equivalent to the system WIFEXITED macro.
1198 * It is an error to call this function before g_subprocess_wait() has
1201 * Returns: %TRUE if the case of a normal exit
1206 g_subprocess_get_if_exited (GSubprocess *subprocess)
1208 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1209 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1212 return WIFEXITED (subprocess->status);
1219 * g_subprocess_get_exit_status:
1220 * @subprocess: a #GSubprocess
1222 * Check the exit status of the subprocess, given that it exited
1223 * normally. This is the value passed to the exit() system call or the
1224 * return value from main.
1226 * This is equivalent to the system WEXITSTATUS macro.
1228 * It is an error to call this function before g_subprocess_wait() and
1229 * unless g_subprocess_get_if_exited() returned %TRUE.
1231 * Returns: the exit status
1236 g_subprocess_get_exit_status (GSubprocess *subprocess)
1238 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 1);
1239 g_return_val_if_fail (subprocess->pid == 0, 1);
1242 g_return_val_if_fail (WIFEXITED (subprocess->status), 1);
1244 return WEXITSTATUS (subprocess->status);
1246 return subprocess->status;
1251 * g_subprocess_get_if_signaled:
1252 * @subprocess: a #GSubprocess
1254 * Check if the given subprocess terminated in response to a signal.
1256 * This is equivalent to the system WIFSIGNALED macro.
1258 * It is an error to call this function before g_subprocess_wait() has
1261 * Returns: %TRUE if the case of termination due to a signal
1266 g_subprocess_get_if_signaled (GSubprocess *subprocess)
1268 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1269 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1272 return WIFSIGNALED (subprocess->status);
1279 * g_subprocess_get_term_sig:
1280 * @subprocess: a #GSubprocess
1282 * Get the signal number that caused the subprocess to terminate, given
1283 * that it terminated due to a signal.
1285 * This is equivalent to the system WTERMSIG macro.
1287 * It is an error to call this function before g_subprocess_wait() and
1288 * unless g_subprocess_get_if_signaled() returned %TRUE.
1290 * Returns: the signal causing termination
1295 g_subprocess_get_term_sig (GSubprocess *subprocess)
1297 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 0);
1298 g_return_val_if_fail (subprocess->pid == 0, 0);
1301 g_return_val_if_fail (WIFSIGNALED (subprocess->status), 0);
1303 return WTERMSIG (subprocess->status);
1305 g_critical ("g_subprocess_get_term_sig() called on Windows, where "
1306 "g_subprocess_get_if_signaled() always returns FALSE...");
1313 g_subprocess_set_launcher (GSubprocess *subprocess,
1314 GSubprocessLauncher *launcher)
1316 subprocess->launcher = launcher;
1320 /* g_subprocess_communicate implementation below:
1322 * This is a tough problem. We have to watch 5 things at the same time:
1324 * - writing to stdin made progress
1325 * - reading from stdout made progress
1326 * - reading from stderr made progress
1327 * - process terminated
1328 * - cancellable being cancelled by caller
1330 * We use a GMainContext for all of these (either as async function
1331 * calls or as a GSource (in the case of the cancellable). That way at
1332 * least we don't have to worry about threading.
1334 * For the sync case we use the usual trick of creating a private main
1335 * context and iterating it until completion.
1337 * It's very possible that the process will dump a lot of data to stdout
1338 * just before it quits, so we can easily have data to read from stdout
1339 * and see the process has terminated at the same time. We want to make
1340 * sure that we read all of the data from the pipes first, though, so we
1341 * do IO operations at a higher priority than the wait operation (which
1342 * is at G_IO_PRIORITY_DEFAULT). Even in the case that we have to do
1343 * multiple reads to get this data, the pipe() will always be polling
1344 * as ready and with the async result for the read at a higher priority,
1345 * the main context will not dispatch the completion for the wait().
1347 * We keep our own private GCancellable. In the event that any of the
1348 * above suffers from an error condition (including the user cancelling
1349 * their cancellable) we immediately dispatch the GTask with the error
1350 * result and fire our cancellable to cleanup any pending operations.
1351 * In the case that the error is that the user's cancellable was fired,
1352 * it's vaguely wasteful to report an error because GTask will handle
1353 * this automatically, so we just return FALSE.
1355 * We let each pending sub-operation take a ref on the GTask of the
1356 * communicate operation. We have to be careful that we don't report
1357 * the task completion more than once, though, so we keep a flag for
1362 const gchar *stdin_data;
1368 GInputStream *stdin_buf;
1369 GMemoryOutputStream *stdout_buf;
1370 GMemoryOutputStream *stderr_buf;
1372 GCancellable *cancellable;
1373 GSource *cancellable_source;
1375 guint outstanding_ops;
1376 gboolean reported_error;
1380 g_subprocess_communicate_made_progress (GObject *source_object,
1381 GAsyncResult *result,
1384 CommunicateState *state;
1385 GSubprocess *subprocess;
1386 GError *error = NULL;
1390 g_assert (source_object != NULL);
1393 subprocess = g_task_get_source_object (task);
1394 state = g_task_get_task_data (task);
1395 source = source_object;
1397 state->outstanding_ops--;
1399 if (source == subprocess->stdin_pipe ||
1400 source == state->stdout_buf ||
1401 source == state->stderr_buf)
1403 if (!g_output_stream_splice_finish ((GOutputStream*)source, result, &error))
1406 if (source == state->stdout_buf ||
1407 source == state->stderr_buf)
1409 /* This is a memory stream, so it can't be cancelled or return
1414 gsize bytes_written;
1415 if (!g_output_stream_write_all (source, "\0", 1, &bytes_written,
1419 if (!g_output_stream_close (source, NULL, &error))
1423 else if (source == subprocess)
1425 (void) g_subprocess_wait_finish (subprocess, result, &error);
1428 g_assert_not_reached ();
1433 /* Only report the first error we see.
1435 * We might be seeing an error as a result of the cancellation
1436 * done when the process quits.
1438 if (!state->reported_error)
1440 state->reported_error = TRUE;
1441 g_cancellable_cancel (state->cancellable);
1442 g_task_return_error (task, error);
1445 g_error_free (error);
1447 else if (state->outstanding_ops == 0)
1449 g_task_return_boolean (task, TRUE);
1452 /* And drop the original ref */
1453 g_object_unref (task);
1457 g_subprocess_communicate_cancelled (gpointer user_data)
1459 CommunicateState *state = user_data;
1461 g_cancellable_cancel (state->cancellable);
1467 g_subprocess_communicate_state_free (gpointer data)
1469 CommunicateState *state = data;
1471 g_clear_object (&state->cancellable);
1472 g_clear_object (&state->stdin_buf);
1473 g_clear_object (&state->stdout_buf);
1474 g_clear_object (&state->stderr_buf);
1476 if (state->cancellable_source)
1478 if (!g_source_is_destroyed (state->cancellable_source))
1479 g_source_destroy (state->cancellable_source);
1480 g_source_unref (state->cancellable_source);
1483 g_slice_free (CommunicateState, state);
1486 static CommunicateState *
1487 g_subprocess_communicate_internal (GSubprocess *subprocess,
1490 GCancellable *cancellable,
1491 GAsyncReadyCallback callback,
1494 CommunicateState *state;
1497 task = g_task_new (subprocess, cancellable, callback, user_data);
1498 state = g_slice_new0 (CommunicateState);
1499 g_task_set_task_data (task, state, g_subprocess_communicate_state_free);
1501 state->cancellable = g_cancellable_new ();
1502 state->add_nul = add_nul;
1506 state->cancellable_source = g_cancellable_source_new (cancellable);
1507 /* No ref held here, but we unref the source from state's free function */
1508 g_source_set_callback (state->cancellable_source, g_subprocess_communicate_cancelled, state, NULL);
1509 g_source_attach (state->cancellable_source, g_main_context_get_thread_default ());
1512 if (subprocess->stdin_pipe)
1514 g_assert (stdin_buf != NULL);
1515 state->stdin_buf = g_memory_input_stream_new_from_bytes (stdin_buf);
1516 g_output_stream_splice_async (subprocess->stdin_pipe, (GInputStream*)state->stdin_buf,
1517 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE | G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
1518 G_PRIORITY_DEFAULT, state->cancellable,
1519 g_subprocess_communicate_made_progress, g_object_ref (task));
1520 state->outstanding_ops++;
1523 if (subprocess->stdout_pipe)
1525 state->stdout_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1526 g_output_stream_splice_async ((GOutputStream*)state->stdout_buf, subprocess->stdout_pipe,
1527 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1528 G_PRIORITY_DEFAULT, state->cancellable,
1529 g_subprocess_communicate_made_progress, g_object_ref (task));
1530 state->outstanding_ops++;
1533 if (subprocess->stderr_pipe)
1535 state->stderr_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1536 g_output_stream_splice_async ((GOutputStream*)state->stderr_buf, subprocess->stderr_pipe,
1537 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1538 G_PRIORITY_DEFAULT, state->cancellable,
1539 g_subprocess_communicate_made_progress, g_object_ref (task));
1540 state->outstanding_ops++;
1543 g_subprocess_wait_async (subprocess, state->cancellable,
1544 g_subprocess_communicate_made_progress, g_object_ref (task));
1545 state->outstanding_ops++;
1547 g_object_unref (task);
1552 * g_subprocess_communicate:
1553 * @subprocess: a #GSubprocess
1554 * @stdin_buf: data to send to the stdin of the subprocess, or %NULL
1555 * @cancellable: a #GCancellable
1556 * @stdout_buf: (out): data read from the subprocess stdout
1557 * @stderr_buf: (out): data read from the subprocess stderr
1558 * @error: a pointer to a %NULL #GError pointer, or %NULL
1560 * Communicate with the subprocess until it terminates, and all input
1561 * and output has been completed.
1563 * If @stdin is given, the subprocess must have been created with
1564 * %G_SUBPROCESS_FLAGS_STDIN_PIPE. The given data is fed to the
1565 * stdin of the subprocess and the pipe is closed (ie: EOF).
1567 * At the same time (as not to cause blocking when dealing with large
1568 * amounts of data), if %G_SUBPROCESS_FLAGS_STDOUT_PIPE or
1569 * %G_SUBPROCESS_FLAGS_STDERR_PIPE were used, reads from those
1570 * streams. The data that was read is returned in @stdout and/or
1573 * If the subprocess was created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1574 * @stdout_buf will contain the data read from stdout. Otherwise, for
1575 * subprocesses not created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1576 * @stdout_buf will be set to %NULL. Similar provisions apply to
1577 * @stderr_buf and %G_SUBPROCESS_FLAGS_STDERR_PIPE.
1579 * As usual, any output variable may be given as %NULL to ignore it.
1581 * If you desire the stdout and stderr data to be interleaved, create
1582 * the subprocess with %G_SUBPROCESS_FLAGS_STDOUT_PIPE and
1583 * %G_SUBPROCESS_FLAGS_STDERR_MERGE. The merged result will be returned
1584 * in @stdout_buf and @stderr_buf will be set to %NULL.
1586 * In case of any error (including cancellation), %FALSE will be
1587 * returned with @error set. Some or all of the stdin data may have
1588 * been written. Any stdout or stderr data that has been read will be
1589 * discarded. None of the out variables (aside from @error) will have
1590 * been set to anything in particular and should not be inspected.
1592 * In the case that %TRUE is returned, the subprocess has exited and the
1593 * exit status inspection APIs (eg: g_subprocess_get_if_exited(),
1594 * g_subprocess_get_exit_status()) may be used.
1596 * You should not attempt to use any of the subprocess pipes after
1597 * starting this function, since they may be left in strange states,
1598 * even if the operation was cancelled. You should especially not
1599 * attempt to interact with the pipes while the operation is in progress
1600 * (either from another thread or if using the asynchronous version).
1602 * Returns: %TRUE if successful
1607 g_subprocess_communicate (GSubprocess *subprocess,
1609 GCancellable *cancellable,
1610 GBytes **stdout_buf,
1611 GBytes **stderr_buf,
1614 GAsyncResult *result = NULL;
1617 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1618 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1619 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1620 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1622 g_subprocess_sync_setup ();
1623 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable,
1624 g_subprocess_sync_done, &result);
1625 g_subprocess_sync_complete (&result);
1626 success = g_subprocess_communicate_finish (subprocess, result, stdout_buf, stderr_buf, error);
1627 g_object_unref (result);
1633 * g_subprocess_communicate_async:
1635 * @stdin_buf: Input data
1636 * @cancellable: Cancellable
1637 * @callback: Callback
1638 * @user_data: User data
1640 * Asynchronous version of g_subprocess_communicate(). Complete
1641 * invocation with g_subprocess_communicate_finish().
1644 g_subprocess_communicate_async (GSubprocess *subprocess,
1646 GCancellable *cancellable,
1647 GAsyncReadyCallback callback,
1650 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1651 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1652 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1654 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable, callback, user_data);
1658 * g_subprocess_communicate_finish:
1661 * @stdout_buf: (out): Return location for stdout data
1662 * @stderr_buf: (out): Return location for stderr data
1665 * Complete an invocation of g_subprocess_communicate_async().
1668 g_subprocess_communicate_finish (GSubprocess *subprocess,
1669 GAsyncResult *result,
1670 GBytes **stdout_buf,
1671 GBytes **stderr_buf,
1675 CommunicateState *state;
1677 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1678 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1679 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1681 g_object_ref (result);
1683 state = g_task_get_task_data ((GTask*)result);
1684 success = g_task_propagate_boolean ((GTask*)result, error);
1689 *stdout_buf = g_memory_output_stream_steal_as_bytes (state->stdout_buf);
1691 *stderr_buf = g_memory_output_stream_steal_as_bytes (state->stderr_buf);
1694 g_object_unref (result);
1699 * g_subprocess_communicate_utf8:
1700 * @subprocess: a #GSubprocess
1701 * @stdin_buf: data to send to the stdin of the subprocess, or %NULL
1702 * @cancellable: a #GCancellable
1703 * @stdout_buf: (out): data read from the subprocess stdout
1704 * @stderr_buf: (out): data read from the subprocess stderr
1705 * @error: a pointer to a %NULL #GError pointer, or %NULL
1707 * Like g_subprocess_communicate(), but validates the output of the
1708 * process as UTF-8, and returns it as a regular NUL terminated string.
1711 g_subprocess_communicate_utf8 (GSubprocess *subprocess,
1712 const char *stdin_buf,
1713 GCancellable *cancellable,
1718 GAsyncResult *result = NULL;
1720 GBytes *stdin_bytes;
1722 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1723 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1724 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1725 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1727 stdin_bytes = g_bytes_new (stdin_buf, strlen (stdin_buf));
1729 g_subprocess_sync_setup ();
1730 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable,
1731 g_subprocess_sync_done, &result);
1732 g_subprocess_sync_complete (&result);
1733 success = g_subprocess_communicate_utf8_finish (subprocess, result, stdout_buf, stderr_buf, error);
1734 g_object_unref (result);
1736 g_bytes_unref (stdin_bytes);
1741 * g_subprocess_communicate_utf8_async:
1743 * @stdin_buf: Input data
1744 * @cancellable: Cancellable
1745 * @callback: Callback
1746 * @user_data: User data
1748 * Asynchronous version of g_subprocess_communicate_utf(). Complete
1749 * invocation with g_subprocess_communicate_utf8_finish().
1752 g_subprocess_communicate_utf8_async (GSubprocess *subprocess,
1753 const char *stdin_buf,
1754 GCancellable *cancellable,
1755 GAsyncReadyCallback callback,
1758 GBytes *stdin_bytes;
1760 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1761 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1762 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1764 stdin_bytes = g_bytes_new (stdin_buf, strlen (stdin_buf));
1765 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable, callback, user_data);
1766 g_bytes_unref (stdin_bytes);
1770 communicate_result_validate_utf8 (const char *stream_name,
1771 char **return_location,
1772 GMemoryOutputStream *buffer,
1775 if (return_location == NULL)
1781 *return_location = g_memory_output_stream_steal_data (buffer);
1782 if (!g_utf8_validate (*return_location, -1, &end))
1784 g_free (*return_location);
1785 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
1786 "Invalid UTF-8 in child %s at offset %lu",
1788 (unsigned long) (end - *return_location));
1793 *return_location = NULL;
1799 * g_subprocess_communicate_utf8_finish:
1802 * @stdout_buf: (out): Return location for stdout data
1803 * @stderr_buf: (out): Return location for stderr data
1806 * Complete an invocation of g_subprocess_communicate_utf8_async().
1809 g_subprocess_communicate_utf8_finish (GSubprocess *subprocess,
1810 GAsyncResult *result,
1815 gboolean ret = FALSE;
1816 CommunicateState *state;
1818 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1819 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1820 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1822 g_object_ref (result);
1824 state = g_task_get_task_data ((GTask*)result);
1825 if (!g_task_propagate_boolean ((GTask*)result, error))
1828 /* TODO - validate UTF-8 while streaming, rather than all at once.
1830 if (!communicate_result_validate_utf8 ("stdout", stdout_buf,
1834 if (!communicate_result_validate_utf8 ("stderr", stderr_buf,
1841 g_object_unref (result);