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
22 * @see_also: #GSubprocessLauncher
24 * #GSubprocess allows the creation of and interaction with child
27 * Processes can be communicated with using standard GIO-style APIs (ie:
28 * #GInputStream, #GOutputStream). There are GIO-style APIs to wait for
29 * process termination (ie: cancellable and with an asynchronous
32 * There is an API to force a process to terminate, as well as a
33 * race-free API for sending UNIX signals to a subprocess.
35 * One major advantage that GIO brings over the core GLib library is
36 * comprehensive API for asynchronous I/O, such
37 * g_output_stream_splice_async(). This makes GSubprocess
38 * significantly more powerful and flexible than equivalent APIs in
39 * some other languages such as the `subprocess.py`
40 * included with Python. For example, using #GSubprocess one could
41 * create two child processes, reading standard output from the first,
42 * processing it, and writing to the input stream of the second, all
43 * without blocking the main loop.
45 * A powerful g_subprocess_communicate() API is provided similar to the
46 * `communicate()` method of `subprocess.py`. This enables very easy
47 * interaction 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_async() or
75 * g_subprocess_wait(). 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"
114 #define HAVE_O_CLOEXEC 1
117 #define COMMUNICATE_READ_SIZE 4096
119 /* A GSubprocess can have two possible states: running and not.
121 * These two states are reflected by the value of 'pid'. If it is
122 * non-zero then the process is running, with that pid.
124 * When a GSubprocess is first created with g_object_new() it is not
125 * running. When it is finalized, it is also not running.
127 * During initable_init(), if the g_spawn() is successful then we
128 * immediately register a child watch and take an extra ref on the
129 * subprocess. That reference doesn't drop until the child has quit,
130 * which is why finalize can only happen in the non-running state. In
131 * the event that the g_spawn() failed we will still be finalizing a
132 * non-running GSubprocess (before returning from g_subprocess_new())
135 * We make extensive use of the glib worker thread to guarantee
136 * race-free operation. As with all child watches, glib calls waitpid()
137 * in the worker thread. It reports the child exiting to us via the
138 * worker thread (which means that we can do synchronous waits without
139 * running a separate loop). We also send signals to the child process
140 * via the worker thread so that we don't race with waitpid() and
141 * accidentally send a signal to an already-reaped child.
143 static void initable_iface_init (GInitableIface *initable_iface);
145 typedef GObjectClass GSubprocessClass;
151 /* only used during construction */
152 GSubprocessLauncher *launcher;
153 GSubprocessFlags flags;
156 /* state tracking variables */
157 gchar identifier[24];
162 GMutex pending_waits_lock;
163 GSList *pending_waits;
165 /* These are the streams created if a pipe is requested via flags. */
166 GOutputStream *stdin_pipe;
167 GInputStream *stdout_pipe;
168 GInputStream *stderr_pipe;
171 G_DEFINE_TYPE_WITH_CODE (GSubprocess, g_subprocess, G_TYPE_OBJECT,
172 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init));
186 GSpawnChildSetupFunc child_setup_func;
187 gpointer child_setup_data;
188 GArray *basic_fd_assignments;
189 GArray *needdup_fd_assignments;
193 unset_cloexec (int fd)
198 flags = fcntl (fd, F_GETFD, 0);
202 flags &= (~FD_CLOEXEC);
204 result = fcntl (fd, F_SETFD, flags);
205 while (result == -1 && errno == EINTR);
210 dupfd_cloexec (int parent_fd)
213 #ifdef F_DUPFD_CLOEXEC
215 fd = fcntl (parent_fd, F_DUPFD_CLOEXEC, 3);
216 while (fd == -1 && errno == EINTR);
218 /* OS X Snow Lion and earlier don't have F_DUPFD_CLOEXEC:
219 * https://bugzilla.gnome.org/show_bug.cgi?id=710962
223 fd = fcntl (parent_fd, F_DUPFD, 3);
224 while (fd == -1 && errno == EINTR);
225 flags = fcntl (fd, F_GETFD, 0);
230 result = fcntl (fd, F_SETFD, flags);
231 while (result == -1 && errno == EINTR);
238 * Based on code derived from
239 * gnome-terminal:src/terminal-screen.c:terminal_screen_child_setup(),
240 * used under the LGPLv2+ with permission from author.
243 child_setup (gpointer user_data)
245 ChildData *child_data = user_data;
249 /* We're on the child side now. "Rename" the file descriptors in
250 * child_data.fds[] to stdin/stdout/stderr.
252 * We don't close the originals. It's possible that the originals
253 * should not be closed and if they should be closed then they should
254 * have been created O_CLOEXEC.
256 for (i = 0; i < 3; i++)
257 if (child_data->fds[i] != -1 && child_data->fds[i] != i)
260 result = dup2 (child_data->fds[i], i);
261 while (result == -1 && errno == EINTR);
264 /* Basic fd assignments we can just unset FD_CLOEXEC */
265 if (child_data->basic_fd_assignments)
267 for (i = 0; i < child_data->basic_fd_assignments->len; i++)
269 gint fd = g_array_index (child_data->basic_fd_assignments, int, i);
275 /* If we're doing remapping fd assignments, we need to handle
276 * the case where the user has specified e.g.:
279 * We do this by duping the source fds temporarily.
281 if (child_data->needdup_fd_assignments)
283 for (i = 0; i < child_data->needdup_fd_assignments->len; i += 2)
285 gint parent_fd = g_array_index (child_data->needdup_fd_assignments, int, i);
288 new_parent_fd = dupfd_cloexec (parent_fd);
290 g_array_index (child_data->needdup_fd_assignments, int, i) = new_parent_fd;
292 for (i = 0; i < child_data->needdup_fd_assignments->len; i += 2)
294 gint parent_fd = g_array_index (child_data->needdup_fd_assignments, int, i);
295 gint child_fd = g_array_index (child_data->needdup_fd_assignments, int, i+1);
297 if (parent_fd == child_fd)
299 unset_cloexec (parent_fd);
304 result = dup2 (parent_fd, child_fd);
305 while (result == -1 && errno == EINTR);
306 (void) close (parent_fd);
311 if (child_data->child_setup_func)
312 child_data->child_setup_func (child_data->child_setup_data);
316 static GInputStream *
317 platform_input_stream_from_spawn_fd (gint fd)
323 return g_unix_input_stream_new (fd, TRUE);
325 return g_win32_input_stream_new_from_fd (fd, TRUE);
329 static GOutputStream *
330 platform_output_stream_from_spawn_fd (gint fd)
336 return g_unix_output_stream_new (fd, TRUE);
338 return g_win32_output_stream_new_from_fd (fd, TRUE);
344 unix_open_file (const char *filename,
350 my_fd = g_open (filename, mode | O_BINARY | O_CLOEXEC, 0666);
352 /* If we return -1 we should also set the error */
355 gint saved_errno = errno;
358 display_name = g_filename_display_name (filename);
359 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (saved_errno),
360 _("Error opening file '%s': %s"), display_name,
361 g_strerror (saved_errno));
362 g_free (display_name);
363 /* fall through... */
365 #ifndef HAVE_O_CLOEXEC
367 fcntl (my_fd, F_SETFD, FD_CLOEXEC);
375 g_subprocess_set_property (GObject *object,
380 GSubprocess *self = G_SUBPROCESS (object);
385 self->flags = g_value_get_flags (value);
389 self->argv = g_value_dup_boxed (value);
393 g_assert_not_reached ();
398 g_subprocess_exited (GPid pid,
402 GSubprocess *self = user_data;
405 g_assert (self->pid == pid);
407 g_mutex_lock (&self->pending_waits_lock);
408 self->status = status;
409 tasks = self->pending_waits;
410 self->pending_waits = NULL;
412 g_mutex_unlock (&self->pending_waits_lock);
414 /* Signal anyone in g_subprocess_wait_async() to wake up now */
417 g_task_return_boolean (tasks->data, TRUE);
418 g_object_unref (tasks->data);
419 tasks = g_slist_delete_link (tasks, tasks);
422 g_spawn_close_pid (pid);
428 initable_init (GInitable *initable,
429 GCancellable *cancellable,
432 GSubprocess *self = G_SUBPROCESS (initable);
434 ChildData child_data = { { -1, -1, -1 }, 0 };
436 gint *pipe_ptrs[3] = { NULL, NULL, NULL };
437 gint pipe_fds[3] = { -1, -1, -1 };
438 gint close_fds[3] = { -1, -1, -1 };
439 GSpawnFlags spawn_flags = 0;
440 gboolean success = FALSE;
443 /* this is a programmer error */
444 if (!self->argv || !self->argv[0] || !self->argv[0][0])
447 if (g_cancellable_set_error_if_cancelled (cancellable, error))
450 /* We must setup the three fds that will end up in the child as stdin,
455 if (self->flags & G_SUBPROCESS_FLAGS_STDIN_INHERIT)
456 spawn_flags |= G_SPAWN_CHILD_INHERITS_STDIN;
457 else if (self->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE)
458 pipe_ptrs[0] = &pipe_fds[0];
460 else if (self->launcher)
462 if (self->launcher->stdin_fd != -1)
463 child_data.fds[0] = self->launcher->stdin_fd;
464 else if (self->launcher->stdin_path != NULL)
466 child_data.fds[0] = close_fds[0] = unix_open_file (self->launcher->stdin_path, O_RDONLY, error);
467 if (child_data.fds[0] == -1)
474 if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_SILENCE)
475 spawn_flags |= G_SPAWN_STDOUT_TO_DEV_NULL;
476 else if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_PIPE)
477 pipe_ptrs[1] = &pipe_fds[1];
479 else if (self->launcher)
481 if (self->launcher->stdout_fd != -1)
482 child_data.fds[1] = self->launcher->stdout_fd;
483 else if (self->launcher->stdout_path != NULL)
485 child_data.fds[1] = close_fds[1] = unix_open_file (self->launcher->stdout_path, O_CREAT | O_WRONLY, error);
486 if (child_data.fds[1] == -1)
492 /* Finally, stderr. */
493 if (self->flags & G_SUBPROCESS_FLAGS_STDERR_SILENCE)
494 spawn_flags |= G_SPAWN_STDERR_TO_DEV_NULL;
495 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_PIPE)
496 pipe_ptrs[2] = &pipe_fds[2];
498 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_MERGE)
499 /* This will work because stderr gets setup after stdout. */
500 child_data.fds[2] = 1;
501 else if (self->launcher)
503 if (self->launcher->stderr_fd != -1)
504 child_data.fds[2] = self->launcher->stderr_fd;
505 else if (self->launcher->stderr_path != NULL)
507 child_data.fds[2] = close_fds[2] = unix_open_file (self->launcher->stderr_path, O_CREAT | O_WRONLY, error);
508 if (child_data.fds[2] == -1)
517 child_data.basic_fd_assignments = self->launcher->basic_fd_assignments;
518 child_data.needdup_fd_assignments = self->launcher->needdup_fd_assignments;
522 /* argv0 has no '/' in it? We better do a PATH lookup. */
523 if (strchr (self->argv[0], G_DIR_SEPARATOR) == NULL)
525 if (self->launcher && self->launcher->path_from_envp)
526 spawn_flags |= G_SPAWN_SEARCH_PATH_FROM_ENVP;
528 spawn_flags |= G_SPAWN_SEARCH_PATH;
531 if (self->flags & G_SUBPROCESS_FLAGS_INHERIT_FDS)
532 spawn_flags |= G_SPAWN_LEAVE_DESCRIPTORS_OPEN;
534 spawn_flags |= G_SPAWN_DO_NOT_REAP_CHILD;
535 spawn_flags |= G_SPAWN_CLOEXEC_PIPES;
538 child_data.child_setup_func = self->launcher ? self->launcher->child_setup_func : NULL;
539 child_data.child_setup_data = self->launcher ? self->launcher->child_setup_user_data : NULL;
542 success = g_spawn_async_with_pipes (self->launcher ? self->launcher->cwd : NULL,
544 self->launcher ? self->launcher->envp : NULL,
547 child_setup, &child_data,
552 pipe_ptrs[0], pipe_ptrs[1], pipe_ptrs[2],
554 g_assert (success == (self->pid != 0));
561 identifier = (guint64) GetProcessId (self->pid);
563 identifier = (guint64) self->pid;
566 s = g_snprintf (self->identifier, sizeof self->identifier, "%"G_GUINT64_FORMAT, identifier);
567 g_assert (0 < s && s < sizeof self->identifier);
570 /* Start attempting to reap the child immediately */
573 GMainContext *worker_context;
576 worker_context = GLIB_PRIVATE_CALL (g_get_worker_context) ();
577 source = g_child_watch_source_new (self->pid);
578 g_source_set_callback (source, (GSourceFunc) g_subprocess_exited, g_object_ref (self), g_object_unref);
579 g_source_attach (source, worker_context);
580 g_source_unref (source);
586 /* we don't need this past init... */
587 self->launcher = NULL;
589 for (i = 0; i < 3; i++)
590 if (close_fds[i] != -1)
591 close (close_fds[i]);
593 self->stdin_pipe = platform_output_stream_from_spawn_fd (pipe_fds[0]);
594 self->stdout_pipe = platform_input_stream_from_spawn_fd (pipe_fds[1]);
595 self->stderr_pipe = platform_input_stream_from_spawn_fd (pipe_fds[2]);
601 g_subprocess_finalize (GObject *object)
603 GSubprocess *self = G_SUBPROCESS (object);
605 g_assert (self->pending_waits == NULL);
606 g_assert (self->pid == 0);
608 g_clear_object (&self->stdin_pipe);
609 g_clear_object (&self->stdout_pipe);
610 g_clear_object (&self->stderr_pipe);
611 g_strfreev (self->argv);
613 g_mutex_clear (&self->pending_waits_lock);
615 G_OBJECT_CLASS (g_subprocess_parent_class)->finalize (object);
619 g_subprocess_init (GSubprocess *self)
621 g_mutex_init (&self->pending_waits_lock);
625 initable_iface_init (GInitableIface *initable_iface)
627 initable_iface->init = initable_init;
631 g_subprocess_class_init (GSubprocessClass *class)
633 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
635 gobject_class->finalize = g_subprocess_finalize;
636 gobject_class->set_property = g_subprocess_set_property;
638 g_object_class_install_property (gobject_class, PROP_FLAGS,
639 g_param_spec_flags ("flags", P_("Flags"), P_("Subprocess flags"),
640 G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |
641 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
642 g_object_class_install_property (gobject_class, PROP_ARGV,
643 g_param_spec_boxed ("argv", P_("Arguments"), P_("Argument vector"),
644 G_TYPE_STRV, G_PARAM_WRITABLE |
645 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
649 * g_subprocess_new: (skip)
650 * @flags: flags that define the behaviour of the subprocess
651 * @error: (allow-none): return location for an error, or %NULL
652 * @argv0: first commandline argument to pass to the subprocess,
653 * followed by more arguments, followed by %NULL
655 * Create a new process with the given flags and varargs argument
656 * list. By default, matching the g_spawn_async() defaults, the
657 * child's stdin will be set to the system null device, and
658 * stdout/stderr will be inherited from the parent. You can use
659 * @flags to control this behavior.
661 * The argument list must be terminated with %NULL.
663 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
669 g_subprocess_new (GSubprocessFlags flags,
679 g_return_val_if_fail (argv0 != NULL && argv0[0] != '\0', NULL);
680 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
682 args = g_ptr_array_new ();
684 va_start (ap, argv0);
685 g_ptr_array_add (args, (gchar *) argv0);
686 while ((arg = va_arg (ap, const gchar *)))
687 g_ptr_array_add (args, (gchar *) arg);
688 g_ptr_array_add (args, NULL);
690 result = g_subprocess_newv ((const gchar * const *) args->pdata, flags, error);
692 g_ptr_array_free (args, TRUE);
699 * @argv: (array zero-terminated=1) (element-type utf8): commandline arguments for the subprocess
700 * @flags: flags that define the behaviour of the subprocess
701 * @error: (allow-none): return location for an error, or %NULL
703 * Create a new process with the given flags and argument list.
705 * The argument list is expected to be %NULL-terminated.
707 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
711 * Rename to: g_subprocess_new
714 g_subprocess_newv (const gchar * const *argv,
715 GSubprocessFlags flags,
718 g_return_val_if_fail (argv != NULL && argv[0] != NULL && argv[0][0] != '\0', NULL);
720 return g_initable_new (G_TYPE_SUBPROCESS, NULL, error,
727 * g_subprocess_get_identifier:
728 * @subprocess: a #GSubprocess
730 * On UNIX, returns the process ID as a decimal string.
731 * On Windows, returns the result of GetProcessId() also as a string.
734 g_subprocess_get_identifier (GSubprocess *subprocess)
736 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
739 return subprocess->identifier;
745 * g_subprocess_get_stdin_pipe:
746 * @subprocess: a #GSubprocess
748 * Gets the #GOutputStream that you can write to in order to give data
749 * to the stdin of @subprocess.
751 * The process must have been created with
752 * %G_SUBPROCESS_FLAGS_STDIN_PIPE.
754 * Returns: (transfer none): the stdout pipe
759 g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
761 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
762 g_return_val_if_fail (subprocess->stdin_pipe, NULL);
764 return subprocess->stdin_pipe;
768 * g_subprocess_get_stdout_pipe:
769 * @subprocess: a #GSubprocess
771 * Gets the #GInputStream from which to read the stdout output of
774 * The process must have been created with
775 * %G_SUBPROCESS_FLAGS_STDOUT_PIPE.
777 * Returns: (transfer none): the stdout pipe
782 g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
784 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
785 g_return_val_if_fail (subprocess->stdout_pipe, NULL);
787 return subprocess->stdout_pipe;
791 * g_subprocess_get_stderr_pipe:
792 * @subprocess: a #GSubprocess
794 * Gets the #GInputStream from which to read the stderr output of
797 * The process must have been created with
798 * %G_SUBPROCESS_FLAGS_STDERR_PIPE.
800 * Returns: (transfer none): the stderr pipe
805 g_subprocess_get_stderr_pipe (GSubprocess *subprocess)
807 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
808 g_return_val_if_fail (subprocess->stderr_pipe, NULL);
810 return subprocess->stderr_pipe;
814 g_subprocess_wait_cancelled (GCancellable *cancellable,
817 GTask *task = user_data;
820 self = g_task_get_source_object (task);
822 g_mutex_lock (&self->pending_waits_lock);
823 self->pending_waits = g_slist_remove (self->pending_waits, task);
824 g_mutex_unlock (&self->pending_waits_lock);
826 g_task_return_boolean (task, FALSE);
827 g_object_unref (task);
831 * g_subprocess_wait_async:
832 * @subprocess: a #GSubprocess
833 * @cancellable: a #GCancellable, or %NULL
834 * @callback: a #GAsyncReadyCallback to call when the operation is complete
835 * @user_data: user_data for @callback
837 * Wait for the subprocess to terminate.
839 * This is the asynchronous version of g_subprocess_wait().
844 g_subprocess_wait_async (GSubprocess *subprocess,
845 GCancellable *cancellable,
846 GAsyncReadyCallback callback,
851 task = g_task_new (subprocess, cancellable, callback, user_data);
853 g_mutex_lock (&subprocess->pending_waits_lock);
856 /* Only bother with cancellable if we're putting it in the list.
857 * If not, it's going to dispatch immediately anyway and we will
858 * see the cancellation in the _finish().
861 g_signal_connect_object (cancellable, "cancelled", G_CALLBACK (g_subprocess_wait_cancelled), task, 0);
863 subprocess->pending_waits = g_slist_prepend (subprocess->pending_waits, task);
866 g_mutex_unlock (&subprocess->pending_waits_lock);
868 /* If we still have task then it's because did_exit is already TRUE */
871 g_task_return_boolean (task, TRUE);
872 g_object_unref (task);
877 * g_subprocess_wait_finish:
878 * @subprocess: a #GSubprocess
879 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
880 * @error: a pointer to a %NULL #GError, or %NULL
882 * Collects the result of a previous call to
883 * g_subprocess_wait_async().
885 * Returns: %TRUE if successful, or %FALSE with @error set
890 g_subprocess_wait_finish (GSubprocess *subprocess,
891 GAsyncResult *result,
894 return g_task_propagate_boolean (G_TASK (result), error);
897 /* Some generic helpers for emulating synchronous operations using async
901 g_subprocess_sync_setup (void)
903 g_main_context_push_thread_default (g_main_context_new ());
907 g_subprocess_sync_done (GObject *source_object,
908 GAsyncResult *result,
911 GAsyncResult **result_ptr = user_data;
913 *result_ptr = g_object_ref (result);
917 g_subprocess_sync_complete (GAsyncResult **result)
919 GMainContext *context = g_main_context_get_thread_default ();
922 g_main_context_iteration (context, TRUE);
924 g_main_context_pop_thread_default (context);
925 g_main_context_unref (context);
930 * @subprocess: a #GSubprocess
931 * @cancellable: a #GCancellable
934 * Synchronously wait for the subprocess to terminate.
936 * After the process terminates you can query its exit status with
937 * functions such as g_subprocess_get_if_exited() and
938 * g_subprocess_get_exit_status().
940 * This function does not fail in the case of the subprocess having
941 * abnormal termination. See g_subprocess_wait_check() for that.
943 * Returns: %TRUE on success, %FALSE if @cancellable was cancelled
948 g_subprocess_wait (GSubprocess *subprocess,
949 GCancellable *cancellable,
952 GAsyncResult *result = NULL;
955 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
957 /* Synchronous waits are actually the 'more difficult' case because we
958 * need to deal with the possibility of cancellation. That more or
959 * less implies that we need a main context (to dispatch either of the
960 * possible reasons for the operation ending).
962 * So we make one and then do this async...
965 if (g_cancellable_set_error_if_cancelled (cancellable, error))
968 /* We can shortcut in the case that the process already quit (but only
969 * after we checked the cancellable).
971 if (subprocess->pid == 0)
974 /* Otherwise, we need to do this the long way... */
975 g_subprocess_sync_setup ();
976 g_subprocess_wait_async (subprocess, cancellable, g_subprocess_sync_done, &result);
977 g_subprocess_sync_complete (&result);
978 success = g_subprocess_wait_finish (subprocess, result, error);
979 g_object_unref (result);
985 * g_subprocess_wait_check:
986 * @subprocess: a #GSubprocess
987 * @cancellable: a #GCancellable
990 * Combines g_subprocess_wait() with g_spawn_check_exit_status().
992 * Returns: %TRUE on success, %FALSE if process exited abnormally, or
993 * @cancellable was cancelled
998 g_subprocess_wait_check (GSubprocess *subprocess,
999 GCancellable *cancellable,
1002 return g_subprocess_wait (subprocess, cancellable, error) &&
1003 g_spawn_check_exit_status (subprocess->status, error);
1007 * g_subprocess_wait_check_async:
1008 * @subprocess: a #GSubprocess
1009 * @cancellable: a #GCancellable, or %NULL
1010 * @callback: a #GAsyncReadyCallback to call when the operation is complete
1011 * @user_data: user_data for @callback
1013 * Combines g_subprocess_wait_async() with g_spawn_check_exit_status().
1015 * This is the asynchronous version of g_subprocess_wait_check().
1020 g_subprocess_wait_check_async (GSubprocess *subprocess,
1021 GCancellable *cancellable,
1022 GAsyncReadyCallback callback,
1025 g_subprocess_wait_async (subprocess, cancellable, callback, user_data);
1029 * g_subprocess_wait_check_finish:
1030 * @subprocess: a #GSubprocess
1031 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
1032 * @error: a pointer to a %NULL #GError, or %NULL
1034 * Collects the result of a previous call to
1035 * g_subprocess_wait_check_async().
1037 * Returns: %TRUE if successful, or %FALSE with @error set
1042 g_subprocess_wait_check_finish (GSubprocess *subprocess,
1043 GAsyncResult *result,
1046 return g_subprocess_wait_finish (subprocess, result, error) &&
1047 g_spawn_check_exit_status (subprocess->status, error);
1053 GSubprocess *subprocess;
1058 g_subprocess_actually_send_signal (gpointer user_data)
1060 SignalRecord *signal_record = user_data;
1062 /* The pid is set to zero from the worker thread as well, so we don't
1063 * need to take a lock in order to prevent it from changing under us.
1065 if (signal_record->subprocess->pid)
1066 kill (signal_record->subprocess->pid, signal_record->signalnum);
1068 g_object_unref (signal_record->subprocess);
1070 g_slice_free (SignalRecord, signal_record);
1076 g_subprocess_dispatch_signal (GSubprocess *subprocess,
1079 SignalRecord signal_record = { g_object_ref (subprocess), signalnum };
1081 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1083 /* This MUST be a lower priority than the priority that the child
1084 * watch source uses in initable_init().
1086 * Reaping processes, reporting the results back to GSubprocess and
1087 * sending signals is all done in the glib worker thread. We cannot
1088 * have a kill() done after the reap and before the report without
1089 * risking killing a process that's no longer there so the kill()
1090 * needs to have the lower priority.
1092 * G_PRIORITY_HIGH_IDLE is lower priority than G_PRIORITY_DEFAULT.
1094 g_main_context_invoke_full (GLIB_PRIVATE_CALL (g_get_worker_context) (),
1095 G_PRIORITY_HIGH_IDLE,
1096 g_subprocess_actually_send_signal,
1097 g_slice_dup (SignalRecord, &signal_record),
1102 * g_subprocess_send_signal:
1103 * @subprocess: a #GSubprocess
1104 * @signal_num: the signal number to send
1106 * Sends the UNIX signal @signal_num to the subprocess, if it is still
1109 * This API is race-free. If the subprocess has terminated, it will not
1112 * This API is not available on Windows.
1117 g_subprocess_send_signal (GSubprocess *subprocess,
1120 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1122 g_subprocess_dispatch_signal (subprocess, signal_num);
1127 * g_subprocess_force_exit:
1128 * @subprocess: a #GSubprocess
1130 * Use an operating-system specific method to attempt an immediate,
1131 * forceful termination of the process. There is no mechanism to
1132 * determine whether or not the request itself was successful;
1133 * however, you can use g_subprocess_wait() to monitor the status of
1134 * the process after calling this function.
1136 * On Unix, this function sends %SIGKILL.
1141 g_subprocess_force_exit (GSubprocess *subprocess)
1143 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1146 g_subprocess_dispatch_signal (subprocess, SIGKILL);
1148 TerminateProcess (subprocess->pid, 1);
1153 * g_subprocess_get_status:
1154 * @subprocess: a #GSubprocess
1156 * Gets the raw status code of the process, as from waitpid().
1158 * This value has no particular meaning, but it can be used with the
1159 * macros defined by the system headers such as WIFEXITED. It can also
1160 * be used with g_spawn_check_exit_status().
1162 * It is more likely that you want to use g_subprocess_get_if_exited()
1163 * followed by g_subprocess_get_exit_status().
1165 * It is an error to call this function before g_subprocess_wait() has
1168 * Returns: the (meaningless) waitpid() exit status from the kernel
1173 g_subprocess_get_status (GSubprocess *subprocess)
1175 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1176 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1178 return subprocess->status;
1182 * g_subprocess_get_successful:
1183 * @subprocess: a #GSubprocess
1185 * Checks if the process was "successful". A process is considered
1186 * successful if it exited cleanly with an exit status of 0, either by
1187 * way of the exit() system call or return from main().
1189 * It is an error to call this function before g_subprocess_wait() has
1192 * Returns: %TRUE if the process exited cleanly with a exit status of 0
1197 g_subprocess_get_successful (GSubprocess *subprocess)
1199 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1200 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1203 return WIFEXITED (subprocess->status) && WEXITSTATUS (subprocess->status) == 0;
1205 return subprocess->status == 0;
1210 * g_subprocess_get_if_exited:
1211 * @subprocess: a #GSubprocess
1213 * Check if the given subprocess exited normally (ie: by way of exit()
1214 * or return from main()).
1216 * This is equivalent to the system WIFEXITED macro.
1218 * It is an error to call this function before g_subprocess_wait() has
1221 * Returns: %TRUE if the case of a normal exit
1226 g_subprocess_get_if_exited (GSubprocess *subprocess)
1228 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1229 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1232 return WIFEXITED (subprocess->status);
1239 * g_subprocess_get_exit_status:
1240 * @subprocess: a #GSubprocess
1242 * Check the exit status of the subprocess, given that it exited
1243 * normally. This is the value passed to the exit() system call or the
1244 * return value from main.
1246 * This is equivalent to the system WEXITSTATUS macro.
1248 * It is an error to call this function before g_subprocess_wait() and
1249 * unless g_subprocess_get_if_exited() returned %TRUE.
1251 * Returns: the exit status
1256 g_subprocess_get_exit_status (GSubprocess *subprocess)
1258 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 1);
1259 g_return_val_if_fail (subprocess->pid == 0, 1);
1262 g_return_val_if_fail (WIFEXITED (subprocess->status), 1);
1264 return WEXITSTATUS (subprocess->status);
1266 return subprocess->status;
1271 * g_subprocess_get_if_signaled:
1272 * @subprocess: a #GSubprocess
1274 * Check if the given subprocess terminated in response to a signal.
1276 * This is equivalent to the system WIFSIGNALED macro.
1278 * It is an error to call this function before g_subprocess_wait() has
1281 * Returns: %TRUE if the case of termination due to a signal
1286 g_subprocess_get_if_signaled (GSubprocess *subprocess)
1288 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1289 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1292 return WIFSIGNALED (subprocess->status);
1299 * g_subprocess_get_term_sig:
1300 * @subprocess: a #GSubprocess
1302 * Get the signal number that caused the subprocess to terminate, given
1303 * that it terminated due to a signal.
1305 * This is equivalent to the system WTERMSIG macro.
1307 * It is an error to call this function before g_subprocess_wait() and
1308 * unless g_subprocess_get_if_signaled() returned %TRUE.
1310 * Returns: the signal causing termination
1315 g_subprocess_get_term_sig (GSubprocess *subprocess)
1317 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 0);
1318 g_return_val_if_fail (subprocess->pid == 0, 0);
1321 g_return_val_if_fail (WIFSIGNALED (subprocess->status), 0);
1323 return WTERMSIG (subprocess->status);
1325 g_critical ("g_subprocess_get_term_sig() called on Windows, where "
1326 "g_subprocess_get_if_signaled() always returns FALSE...");
1333 g_subprocess_set_launcher (GSubprocess *subprocess,
1334 GSubprocessLauncher *launcher)
1336 subprocess->launcher = launcher;
1340 /* g_subprocess_communicate implementation below:
1342 * This is a tough problem. We have to watch 5 things at the same time:
1344 * - writing to stdin made progress
1345 * - reading from stdout made progress
1346 * - reading from stderr made progress
1347 * - process terminated
1348 * - cancellable being cancelled by caller
1350 * We use a GMainContext for all of these (either as async function
1351 * calls or as a GSource (in the case of the cancellable). That way at
1352 * least we don't have to worry about threading.
1354 * For the sync case we use the usual trick of creating a private main
1355 * context and iterating it until completion.
1357 * It's very possible that the process will dump a lot of data to stdout
1358 * just before it quits, so we can easily have data to read from stdout
1359 * and see the process has terminated at the same time. We want to make
1360 * sure that we read all of the data from the pipes first, though, so we
1361 * do IO operations at a higher priority than the wait operation (which
1362 * is at G_IO_PRIORITY_DEFAULT). Even in the case that we have to do
1363 * multiple reads to get this data, the pipe() will always be polling
1364 * as ready and with the async result for the read at a higher priority,
1365 * the main context will not dispatch the completion for the wait().
1367 * We keep our own private GCancellable. In the event that any of the
1368 * above suffers from an error condition (including the user cancelling
1369 * their cancellable) we immediately dispatch the GTask with the error
1370 * result and fire our cancellable to cleanup any pending operations.
1371 * In the case that the error is that the user's cancellable was fired,
1372 * it's vaguely wasteful to report an error because GTask will handle
1373 * this automatically, so we just return FALSE.
1375 * We let each pending sub-operation take a ref on the GTask of the
1376 * communicate operation. We have to be careful that we don't report
1377 * the task completion more than once, though, so we keep a flag for
1382 const gchar *stdin_data;
1388 GInputStream *stdin_buf;
1389 GMemoryOutputStream *stdout_buf;
1390 GMemoryOutputStream *stderr_buf;
1392 GCancellable *cancellable;
1393 GSource *cancellable_source;
1395 guint outstanding_ops;
1396 gboolean reported_error;
1400 g_subprocess_communicate_made_progress (GObject *source_object,
1401 GAsyncResult *result,
1404 CommunicateState *state;
1405 GSubprocess *subprocess;
1406 GError *error = NULL;
1410 g_assert (source_object != NULL);
1413 subprocess = g_task_get_source_object (task);
1414 state = g_task_get_task_data (task);
1415 source = source_object;
1417 state->outstanding_ops--;
1419 if (source == subprocess->stdin_pipe ||
1420 source == state->stdout_buf ||
1421 source == state->stderr_buf)
1423 if (g_output_stream_splice_finish ((GOutputStream*) source, result, &error) == -1)
1426 if (source == state->stdout_buf ||
1427 source == state->stderr_buf)
1429 /* This is a memory stream, so it can't be cancelled or return
1434 gsize bytes_written;
1435 if (!g_output_stream_write_all (source, "\0", 1, &bytes_written,
1439 if (!g_output_stream_close (source, NULL, &error))
1443 else if (source == subprocess)
1445 (void) g_subprocess_wait_finish (subprocess, result, &error);
1448 g_assert_not_reached ();
1453 /* Only report the first error we see.
1455 * We might be seeing an error as a result of the cancellation
1456 * done when the process quits.
1458 if (!state->reported_error)
1460 state->reported_error = TRUE;
1461 g_cancellable_cancel (state->cancellable);
1462 g_task_return_error (task, error);
1465 g_error_free (error);
1467 else if (state->outstanding_ops == 0)
1469 g_task_return_boolean (task, TRUE);
1472 /* And drop the original ref */
1473 g_object_unref (task);
1477 g_subprocess_communicate_cancelled (gpointer user_data)
1479 CommunicateState *state = user_data;
1481 g_cancellable_cancel (state->cancellable);
1487 g_subprocess_communicate_state_free (gpointer data)
1489 CommunicateState *state = data;
1491 g_clear_object (&state->cancellable);
1492 g_clear_object (&state->stdin_buf);
1493 g_clear_object (&state->stdout_buf);
1494 g_clear_object (&state->stderr_buf);
1496 if (state->cancellable_source)
1498 if (!g_source_is_destroyed (state->cancellable_source))
1499 g_source_destroy (state->cancellable_source);
1500 g_source_unref (state->cancellable_source);
1503 g_slice_free (CommunicateState, state);
1506 static CommunicateState *
1507 g_subprocess_communicate_internal (GSubprocess *subprocess,
1510 GCancellable *cancellable,
1511 GAsyncReadyCallback callback,
1514 CommunicateState *state;
1517 task = g_task_new (subprocess, cancellable, callback, user_data);
1518 state = g_slice_new0 (CommunicateState);
1519 g_task_set_task_data (task, state, g_subprocess_communicate_state_free);
1521 state->cancellable = g_cancellable_new ();
1522 state->add_nul = add_nul;
1526 state->cancellable_source = g_cancellable_source_new (cancellable);
1527 /* No ref held here, but we unref the source from state's free function */
1528 g_source_set_callback (state->cancellable_source, g_subprocess_communicate_cancelled, state, NULL);
1529 g_source_attach (state->cancellable_source, g_main_context_get_thread_default ());
1532 if (subprocess->stdin_pipe)
1534 g_assert (stdin_buf != NULL);
1535 state->stdin_buf = g_memory_input_stream_new_from_bytes (stdin_buf);
1536 g_output_stream_splice_async (subprocess->stdin_pipe, (GInputStream*)state->stdin_buf,
1537 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE | G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
1538 G_PRIORITY_DEFAULT, state->cancellable,
1539 g_subprocess_communicate_made_progress, g_object_ref (task));
1540 state->outstanding_ops++;
1543 if (subprocess->stdout_pipe)
1545 state->stdout_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1546 g_output_stream_splice_async ((GOutputStream*)state->stdout_buf, subprocess->stdout_pipe,
1547 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1548 G_PRIORITY_DEFAULT, state->cancellable,
1549 g_subprocess_communicate_made_progress, g_object_ref (task));
1550 state->outstanding_ops++;
1553 if (subprocess->stderr_pipe)
1555 state->stderr_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1556 g_output_stream_splice_async ((GOutputStream*)state->stderr_buf, subprocess->stderr_pipe,
1557 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1558 G_PRIORITY_DEFAULT, state->cancellable,
1559 g_subprocess_communicate_made_progress, g_object_ref (task));
1560 state->outstanding_ops++;
1563 g_subprocess_wait_async (subprocess, state->cancellable,
1564 g_subprocess_communicate_made_progress, g_object_ref (task));
1565 state->outstanding_ops++;
1567 g_object_unref (task);
1572 * g_subprocess_communicate:
1573 * @subprocess: a #GSubprocess
1574 * @stdin_buf: (allow-none): data to send to the stdin of the subprocess, or %NULL
1575 * @cancellable: a #GCancellable
1576 * @stdout_buf: (out): data read from the subprocess stdout
1577 * @stderr_buf: (out): data read from the subprocess stderr
1578 * @error: a pointer to a %NULL #GError pointer, or %NULL
1580 * Communicate with the subprocess until it terminates, and all input
1581 * and output has been completed.
1583 * If @stdin_buf is given, the subprocess must have been created with
1584 * %G_SUBPROCESS_FLAGS_STDIN_PIPE. The given data is fed to the
1585 * stdin of the subprocess and the pipe is closed (ie: EOF).
1587 * At the same time (as not to cause blocking when dealing with large
1588 * amounts of data), if %G_SUBPROCESS_FLAGS_STDOUT_PIPE or
1589 * %G_SUBPROCESS_FLAGS_STDERR_PIPE were used, reads from those
1590 * streams. The data that was read is returned in @stdout and/or
1593 * If the subprocess was created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1594 * @stdout_buf will contain the data read from stdout. Otherwise, for
1595 * subprocesses not created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1596 * @stdout_buf will be set to %NULL. Similar provisions apply to
1597 * @stderr_buf and %G_SUBPROCESS_FLAGS_STDERR_PIPE.
1599 * As usual, any output variable may be given as %NULL to ignore it.
1601 * If you desire the stdout and stderr data to be interleaved, create
1602 * the subprocess with %G_SUBPROCESS_FLAGS_STDOUT_PIPE and
1603 * %G_SUBPROCESS_FLAGS_STDERR_MERGE. The merged result will be returned
1604 * in @stdout_buf and @stderr_buf will be set to %NULL.
1606 * In case of any error (including cancellation), %FALSE will be
1607 * returned with @error set. Some or all of the stdin data may have
1608 * been written. Any stdout or stderr data that has been read will be
1609 * discarded. None of the out variables (aside from @error) will have
1610 * been set to anything in particular and should not be inspected.
1612 * In the case that %TRUE is returned, the subprocess has exited and the
1613 * exit status inspection APIs (eg: g_subprocess_get_if_exited(),
1614 * g_subprocess_get_exit_status()) may be used.
1616 * You should not attempt to use any of the subprocess pipes after
1617 * starting this function, since they may be left in strange states,
1618 * even if the operation was cancelled. You should especially not
1619 * attempt to interact with the pipes while the operation is in progress
1620 * (either from another thread or if using the asynchronous version).
1622 * Returns: %TRUE if successful
1627 g_subprocess_communicate (GSubprocess *subprocess,
1629 GCancellable *cancellable,
1630 GBytes **stdout_buf,
1631 GBytes **stderr_buf,
1634 GAsyncResult *result = NULL;
1637 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1638 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1639 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1640 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1642 g_subprocess_sync_setup ();
1643 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable,
1644 g_subprocess_sync_done, &result);
1645 g_subprocess_sync_complete (&result);
1646 success = g_subprocess_communicate_finish (subprocess, result, stdout_buf, stderr_buf, error);
1647 g_object_unref (result);
1653 * g_subprocess_communicate_async:
1655 * @stdin_buf: (allow-none): Input data, or %NULL
1656 * @cancellable: (allow-none): Cancellable
1657 * @callback: Callback
1658 * @user_data: User data
1660 * Asynchronous version of g_subprocess_communicate(). Complete
1661 * invocation with g_subprocess_communicate_finish().
1664 g_subprocess_communicate_async (GSubprocess *subprocess,
1666 GCancellable *cancellable,
1667 GAsyncReadyCallback callback,
1670 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1671 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1672 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1674 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable, callback, user_data);
1678 * g_subprocess_communicate_finish:
1681 * @stdout_buf: (out): Return location for stdout data
1682 * @stderr_buf: (out): Return location for stderr data
1685 * Complete an invocation of g_subprocess_communicate_async().
1688 g_subprocess_communicate_finish (GSubprocess *subprocess,
1689 GAsyncResult *result,
1690 GBytes **stdout_buf,
1691 GBytes **stderr_buf,
1695 CommunicateState *state;
1697 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1698 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1699 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1701 g_object_ref (result);
1703 state = g_task_get_task_data ((GTask*)result);
1704 success = g_task_propagate_boolean ((GTask*)result, error);
1709 *stdout_buf = g_memory_output_stream_steal_as_bytes (state->stdout_buf);
1711 *stderr_buf = g_memory_output_stream_steal_as_bytes (state->stderr_buf);
1714 g_object_unref (result);
1719 * g_subprocess_communicate_utf8:
1720 * @subprocess: a #GSubprocess
1721 * @stdin_buf: (allow-none): data to send to the stdin of the subprocess, or %NULL
1722 * @cancellable: a #GCancellable
1723 * @stdout_buf: (out): data read from the subprocess stdout
1724 * @stderr_buf: (out): data read from the subprocess stderr
1725 * @error: a pointer to a %NULL #GError pointer, or %NULL
1727 * Like g_subprocess_communicate(), but validates the output of the
1728 * process as UTF-8, and returns it as a regular NUL terminated string.
1731 g_subprocess_communicate_utf8 (GSubprocess *subprocess,
1732 const char *stdin_buf,
1733 GCancellable *cancellable,
1738 GAsyncResult *result = NULL;
1740 GBytes *stdin_bytes;
1741 size_t stdin_buf_len = 0;
1743 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1744 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1745 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1746 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1748 if (stdin_buf != NULL)
1749 stdin_buf_len = strlen (stdin_buf);
1750 stdin_bytes = g_bytes_new (stdin_buf, stdin_buf_len);
1752 g_subprocess_sync_setup ();
1753 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable,
1754 g_subprocess_sync_done, &result);
1755 g_subprocess_sync_complete (&result);
1756 success = g_subprocess_communicate_utf8_finish (subprocess, result, stdout_buf, stderr_buf, error);
1757 g_object_unref (result);
1759 g_bytes_unref (stdin_bytes);
1764 * g_subprocess_communicate_utf8_async:
1766 * @stdin_buf: (allow-none): Input data, or %NULL
1767 * @cancellable: Cancellable
1768 * @callback: Callback
1769 * @user_data: User data
1771 * Asynchronous version of g_subprocess_communicate_utf(). Complete
1772 * invocation with g_subprocess_communicate_utf8_finish().
1775 g_subprocess_communicate_utf8_async (GSubprocess *subprocess,
1776 const char *stdin_buf,
1777 GCancellable *cancellable,
1778 GAsyncReadyCallback callback,
1781 GBytes *stdin_bytes;
1782 size_t stdin_buf_len = 0;
1784 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1785 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1786 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1788 if (stdin_buf != NULL)
1789 stdin_buf_len = strlen (stdin_buf);
1790 stdin_bytes = g_bytes_new (stdin_buf, stdin_buf_len);
1792 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable, callback, user_data);
1794 g_bytes_unref (stdin_bytes);
1798 communicate_result_validate_utf8 (const char *stream_name,
1799 char **return_location,
1800 GMemoryOutputStream *buffer,
1803 if (return_location == NULL)
1809 *return_location = g_memory_output_stream_steal_data (buffer);
1810 if (!g_utf8_validate (*return_location, -1, &end))
1812 g_free (*return_location);
1813 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
1814 "Invalid UTF-8 in child %s at offset %lu",
1816 (unsigned long) (end - *return_location));
1821 *return_location = NULL;
1827 * g_subprocess_communicate_utf8_finish:
1830 * @stdout_buf: (out): Return location for stdout data
1831 * @stderr_buf: (out): Return location for stderr data
1834 * Complete an invocation of g_subprocess_communicate_utf8_async().
1837 g_subprocess_communicate_utf8_finish (GSubprocess *subprocess,
1838 GAsyncResult *result,
1843 gboolean ret = FALSE;
1844 CommunicateState *state;
1846 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1847 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1848 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1850 g_object_ref (result);
1852 state = g_task_get_task_data ((GTask*)result);
1853 if (!g_task_propagate_boolean ((GTask*)result, error))
1856 /* TODO - validate UTF-8 while streaming, rather than all at once.
1858 if (!communicate_result_validate_utf8 ("stdout", stdout_buf,
1862 if (!communicate_result_validate_utf8 ("stderr", stderr_buf,
1869 g_object_unref (result);