1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2012, 2013 Red Hat, Inc.
4 * Copyright © 2012, 2013 Canonical Limited
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at 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))
182 static GInputStream *
183 platform_input_stream_from_spawn_fd (gint fd)
189 return g_unix_input_stream_new (fd, TRUE);
191 return g_win32_input_stream_new_from_fd (fd, TRUE);
195 static GOutputStream *
196 platform_output_stream_from_spawn_fd (gint fd)
202 return g_unix_output_stream_new (fd, TRUE);
204 return g_win32_output_stream_new_from_fd (fd, TRUE);
210 unix_open_file (const char *filename,
216 my_fd = g_open (filename, mode | O_BINARY | O_CLOEXEC, 0666);
218 /* If we return -1 we should also set the error */
221 gint saved_errno = errno;
224 display_name = g_filename_display_name (filename);
225 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (saved_errno),
226 _("Error opening file “%s”: %s"), display_name,
227 g_strerror (saved_errno));
228 g_free (display_name);
229 /* fall through... */
231 #ifndef HAVE_O_CLOEXEC
233 fcntl (my_fd, F_SETFD, FD_CLOEXEC);
241 g_subprocess_set_property (GObject *object,
246 GSubprocess *self = G_SUBPROCESS (object);
251 self->flags = g_value_get_flags (value);
255 self->argv = g_value_dup_boxed (value);
259 g_assert_not_reached ();
264 g_subprocess_exited (GPid pid,
268 GSubprocess *self = user_data;
271 g_assert (self->pid == pid);
273 g_mutex_lock (&self->pending_waits_lock);
274 self->status = status;
275 tasks = self->pending_waits;
276 self->pending_waits = NULL;
278 g_mutex_unlock (&self->pending_waits_lock);
280 /* Signal anyone in g_subprocess_wait_async() to wake up now */
283 g_task_return_boolean (tasks->data, TRUE);
284 g_object_unref (tasks->data);
285 tasks = g_slist_delete_link (tasks, tasks);
288 g_spawn_close_pid (pid);
294 initable_init (GInitable *initable,
295 GCancellable *cancellable,
298 GSubprocess *self = G_SUBPROCESS (initable);
299 gint *pipe_ptrs[3] = { NULL, NULL, NULL };
300 gint pipe_fds[3] = { -1, -1, -1 };
301 gint close_fds[3] = { -1, -1, -1 };
303 gint stdin_fd = -1, stdout_fd = -1, stderr_fd = -1;
305 GSpawnFlags spawn_flags = 0;
306 gboolean success = FALSE;
309 /* this is a programmer error */
310 if (!self->argv || !self->argv[0] || !self->argv[0][0])
313 if (g_cancellable_set_error_if_cancelled (cancellable, error))
316 /* We must setup the three fds that will end up in the child as stdin,
321 if (self->flags & G_SUBPROCESS_FLAGS_STDIN_INHERIT)
322 spawn_flags |= G_SPAWN_CHILD_INHERITS_STDIN;
323 else if (self->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE)
324 pipe_ptrs[0] = &pipe_fds[0];
326 else if (self->launcher)
328 if (self->launcher->stdin_fd != -1)
329 stdin_fd = self->launcher->stdin_fd;
330 else if (self->launcher->stdin_path != NULL)
332 stdin_fd = close_fds[0] = unix_open_file (self->launcher->stdin_path, O_RDONLY, error);
340 if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_SILENCE)
341 spawn_flags |= G_SPAWN_STDOUT_TO_DEV_NULL;
342 else if (self->flags & G_SUBPROCESS_FLAGS_STDOUT_PIPE)
343 pipe_ptrs[1] = &pipe_fds[1];
345 else if (self->launcher)
347 if (self->launcher->stdout_fd != -1)
348 stdout_fd = self->launcher->stdout_fd;
349 else if (self->launcher->stdout_path != NULL)
351 stdout_fd = close_fds[1] = unix_open_file (self->launcher->stdout_path, O_CREAT | O_WRONLY, error);
358 /* Finally, stderr. */
359 if (self->flags & G_SUBPROCESS_FLAGS_STDERR_SILENCE)
360 spawn_flags |= G_SPAWN_STDERR_TO_DEV_NULL;
361 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_PIPE)
362 pipe_ptrs[2] = &pipe_fds[2];
364 else if (self->flags & G_SUBPROCESS_FLAGS_STDERR_MERGE)
365 /* This will work because stderr gets set up after stdout. */
367 else if (self->launcher)
369 if (self->launcher->stderr_fd != -1)
370 stderr_fd = self->launcher->stderr_fd;
371 else if (self->launcher->stderr_path != NULL)
373 stderr_fd = close_fds[2] = unix_open_file (self->launcher->stderr_path, O_CREAT | O_WRONLY, error);
380 /* argv0 has no '/' in it? We better do a PATH lookup. */
381 if (strchr (self->argv[0], G_DIR_SEPARATOR) == NULL)
383 if (self->launcher && self->launcher->path_from_envp)
384 spawn_flags |= G_SPAWN_SEARCH_PATH_FROM_ENVP;
386 spawn_flags |= G_SPAWN_SEARCH_PATH;
389 if (self->flags & G_SUBPROCESS_FLAGS_INHERIT_FDS)
390 spawn_flags |= G_SPAWN_LEAVE_DESCRIPTORS_OPEN;
392 spawn_flags |= G_SPAWN_DO_NOT_REAP_CHILD;
393 spawn_flags |= G_SPAWN_CLOEXEC_PIPES;
395 success = g_spawn_async_with_pipes_and_fds (self->launcher ? self->launcher->cwd : NULL,
396 (const gchar * const *) self->argv,
397 (const gchar * const *) (self->launcher ? self->launcher->envp : NULL),
400 self->launcher ? self->launcher->child_setup_func : NULL,
401 self->launcher ? self->launcher->child_setup_user_data : NULL,
402 stdin_fd, stdout_fd, stderr_fd,
403 self->launcher ? (const gint *) self->launcher->source_fds->data : NULL,
404 self->launcher ? (const gint *) self->launcher->target_fds->data : NULL,
405 self->launcher ? self->launcher->source_fds->len : 0,
412 pipe_ptrs[0], pipe_ptrs[1], pipe_ptrs[2],
414 g_assert (success == (self->pid != 0));
418 gint s G_GNUC_UNUSED /* when compiling with G_DISABLE_ASSERT */;
421 identifier = (guint64) GetProcessId (self->pid);
423 identifier = (guint64) self->pid;
426 s = g_snprintf (self->identifier, sizeof self->identifier, "%"G_GUINT64_FORMAT, identifier);
427 g_assert (0 < s && (gsize) s < sizeof self->identifier);
430 /* Start attempting to reap the child immediately */
433 GMainContext *worker_context;
436 worker_context = GLIB_PRIVATE_CALL (g_get_worker_context) ();
437 source = g_child_watch_source_new (self->pid);
438 g_source_set_callback (source, (GSourceFunc) g_subprocess_exited, g_object_ref (self), g_object_unref);
439 g_source_attach (source, worker_context);
440 g_source_unref (source);
446 /* we don't need this past init... */
447 self->launcher = NULL;
449 for (i = 0; i < 3; i++)
450 if (close_fds[i] != -1)
451 close (close_fds[i]);
453 self->stdin_pipe = platform_output_stream_from_spawn_fd (pipe_fds[0]);
454 self->stdout_pipe = platform_input_stream_from_spawn_fd (pipe_fds[1]);
455 self->stderr_pipe = platform_input_stream_from_spawn_fd (pipe_fds[2]);
461 g_subprocess_finalize (GObject *object)
463 GSubprocess *self = G_SUBPROCESS (object);
465 g_assert (self->pending_waits == NULL);
466 g_assert (self->pid == 0);
468 g_clear_object (&self->stdin_pipe);
469 g_clear_object (&self->stdout_pipe);
470 g_clear_object (&self->stderr_pipe);
471 g_strfreev (self->argv);
473 g_mutex_clear (&self->pending_waits_lock);
475 G_OBJECT_CLASS (g_subprocess_parent_class)->finalize (object);
479 g_subprocess_init (GSubprocess *self)
481 g_mutex_init (&self->pending_waits_lock);
485 initable_iface_init (GInitableIface *initable_iface)
487 initable_iface->init = initable_init;
491 g_subprocess_class_init (GSubprocessClass *class)
493 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
495 gobject_class->finalize = g_subprocess_finalize;
496 gobject_class->set_property = g_subprocess_set_property;
498 g_object_class_install_property (gobject_class, PROP_FLAGS,
499 g_param_spec_flags ("flags", P_("Flags"), P_("Subprocess flags"),
500 G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |
501 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
502 g_object_class_install_property (gobject_class, PROP_ARGV,
503 g_param_spec_boxed ("argv", P_("Arguments"), P_("Argument vector"),
504 G_TYPE_STRV, G_PARAM_WRITABLE |
505 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
509 * g_subprocess_new: (skip)
510 * @flags: flags that define the behaviour of the subprocess
511 * @error: (nullable): return location for an error, or %NULL
512 * @argv0: first commandline argument to pass to the subprocess
513 * @...: more commandline arguments, followed by %NULL
515 * Create a new process with the given flags and varargs argument
516 * list. By default, matching the g_spawn_async() defaults, the
517 * child's stdin will be set to the system null device, and
518 * stdout/stderr will be inherited from the parent. You can use
519 * @flags to control this behavior.
521 * The argument list must be terminated with %NULL.
523 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
529 g_subprocess_new (GSubprocessFlags flags,
539 g_return_val_if_fail (argv0 != NULL && argv0[0] != '\0', NULL);
540 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
542 args = g_ptr_array_new ();
544 va_start (ap, argv0);
545 g_ptr_array_add (args, (gchar *) argv0);
546 while ((arg = va_arg (ap, const gchar *)))
547 g_ptr_array_add (args, (gchar *) arg);
548 g_ptr_array_add (args, NULL);
551 result = g_subprocess_newv ((const gchar * const *) args->pdata, flags, error);
553 g_ptr_array_free (args, TRUE);
559 * g_subprocess_newv: (rename-to g_subprocess_new)
560 * @argv: (array zero-terminated=1) (element-type filename): commandline arguments for the subprocess
561 * @flags: flags that define the behaviour of the subprocess
562 * @error: (nullable): return location for an error, or %NULL
564 * Create a new process with the given flags and argument list.
566 * The argument list is expected to be %NULL-terminated.
568 * Returns: A newly created #GSubprocess, or %NULL on error (and @error
574 g_subprocess_newv (const gchar * const *argv,
575 GSubprocessFlags flags,
578 g_return_val_if_fail (argv != NULL && argv[0] != NULL && argv[0][0] != '\0', NULL);
580 return g_initable_new (G_TYPE_SUBPROCESS, NULL, error,
587 * g_subprocess_get_identifier:
588 * @subprocess: a #GSubprocess
590 * On UNIX, returns the process ID as a decimal string.
591 * On Windows, returns the result of GetProcessId() also as a string.
592 * If the subprocess has terminated, this will return %NULL.
594 * Returns: (nullable): the subprocess identifier, or %NULL if the subprocess
599 g_subprocess_get_identifier (GSubprocess *subprocess)
601 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
604 return subprocess->identifier;
610 * g_subprocess_get_stdin_pipe:
611 * @subprocess: a #GSubprocess
613 * Gets the #GOutputStream that you can write to in order to give data
614 * to the stdin of @subprocess.
616 * The process must have been created with %G_SUBPROCESS_FLAGS_STDIN_PIPE and
617 * not %G_SUBPROCESS_FLAGS_STDIN_INHERIT, otherwise %NULL will be returned.
619 * Returns: (nullable) (transfer none): the stdout pipe
624 g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
626 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
628 return subprocess->stdin_pipe;
632 * g_subprocess_get_stdout_pipe:
633 * @subprocess: a #GSubprocess
635 * Gets the #GInputStream from which to read the stdout output of
638 * The process must have been created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
639 * otherwise %NULL will be returned.
641 * Returns: (nullable) (transfer none): the stdout pipe
646 g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
648 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
650 return subprocess->stdout_pipe;
654 * g_subprocess_get_stderr_pipe:
655 * @subprocess: a #GSubprocess
657 * Gets the #GInputStream from which to read the stderr output of
660 * The process must have been created with %G_SUBPROCESS_FLAGS_STDERR_PIPE,
661 * otherwise %NULL will be returned.
663 * Returns: (nullable) (transfer none): the stderr pipe
668 g_subprocess_get_stderr_pipe (GSubprocess *subprocess)
670 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
672 return subprocess->stderr_pipe;
675 /* Remove the first list element containing @data, and return %TRUE. If no
676 * such element is found, return %FALSE. */
678 slist_remove_if_present (GSList **list,
683 for (l = *list, prev = NULL; l != NULL; prev = l, l = prev->next)
688 prev->next = l->next;
702 g_subprocess_wait_cancelled (GCancellable *cancellable,
705 GTask *task = user_data;
707 gboolean task_was_pending;
709 self = g_task_get_source_object (task);
711 g_mutex_lock (&self->pending_waits_lock);
712 task_was_pending = slist_remove_if_present (&self->pending_waits, task);
713 g_mutex_unlock (&self->pending_waits_lock);
715 if (task_was_pending)
717 g_task_return_boolean (task, FALSE);
718 g_object_unref (task); /* ref from pending_waits */
723 * g_subprocess_wait_async:
724 * @subprocess: a #GSubprocess
725 * @cancellable: a #GCancellable, or %NULL
726 * @callback: a #GAsyncReadyCallback to call when the operation is complete
727 * @user_data: user_data for @callback
729 * Wait for the subprocess to terminate.
731 * This is the asynchronous version of g_subprocess_wait().
736 g_subprocess_wait_async (GSubprocess *subprocess,
737 GCancellable *cancellable,
738 GAsyncReadyCallback callback,
743 task = g_task_new (subprocess, cancellable, callback, user_data);
744 g_task_set_source_tag (task, g_subprocess_wait_async);
746 g_mutex_lock (&subprocess->pending_waits_lock);
749 /* Only bother with cancellable if we're putting it in the list.
750 * If not, it's going to dispatch immediately anyway and we will
751 * see the cancellation in the _finish().
754 g_signal_connect_object (cancellable, "cancelled", G_CALLBACK (g_subprocess_wait_cancelled), task, 0);
756 subprocess->pending_waits = g_slist_prepend (subprocess->pending_waits, task);
759 g_mutex_unlock (&subprocess->pending_waits_lock);
761 /* If we still have task then it's because did_exit is already TRUE */
764 g_task_return_boolean (task, TRUE);
765 g_object_unref (task);
770 * g_subprocess_wait_finish:
771 * @subprocess: a #GSubprocess
772 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
773 * @error: a pointer to a %NULL #GError, or %NULL
775 * Collects the result of a previous call to
776 * g_subprocess_wait_async().
778 * Returns: %TRUE if successful, or %FALSE with @error set
783 g_subprocess_wait_finish (GSubprocess *subprocess,
784 GAsyncResult *result,
787 return g_task_propagate_boolean (G_TASK (result), error);
790 /* Some generic helpers for emulating synchronous operations using async
794 g_subprocess_sync_setup (void)
796 g_main_context_push_thread_default (g_main_context_new ());
800 g_subprocess_sync_done (GObject *source_object,
801 GAsyncResult *result,
804 GAsyncResult **result_ptr = user_data;
806 *result_ptr = g_object_ref (result);
810 g_subprocess_sync_complete (GAsyncResult **result)
812 GMainContext *context = g_main_context_get_thread_default ();
815 g_main_context_iteration (context, TRUE);
817 g_main_context_pop_thread_default (context);
818 g_main_context_unref (context);
823 * @subprocess: a #GSubprocess
824 * @cancellable: a #GCancellable
827 * Synchronously wait for the subprocess to terminate.
829 * After the process terminates you can query its exit status with
830 * functions such as g_subprocess_get_if_exited() and
831 * g_subprocess_get_exit_status().
833 * This function does not fail in the case of the subprocess having
834 * abnormal termination. See g_subprocess_wait_check() for that.
836 * Cancelling @cancellable doesn't kill the subprocess. Call
837 * g_subprocess_force_exit() if it is desirable.
839 * Returns: %TRUE on success, %FALSE if @cancellable was cancelled
844 g_subprocess_wait (GSubprocess *subprocess,
845 GCancellable *cancellable,
848 GAsyncResult *result = NULL;
851 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
853 /* Synchronous waits are actually the 'more difficult' case because we
854 * need to deal with the possibility of cancellation. That more or
855 * less implies that we need a main context (to dispatch either of the
856 * possible reasons for the operation ending).
858 * So we make one and then do this async...
861 if (g_cancellable_set_error_if_cancelled (cancellable, error))
864 /* We can shortcut in the case that the process already quit (but only
865 * after we checked the cancellable).
867 if (subprocess->pid == 0)
870 /* Otherwise, we need to do this the long way... */
871 g_subprocess_sync_setup ();
872 g_subprocess_wait_async (subprocess, cancellable, g_subprocess_sync_done, &result);
873 g_subprocess_sync_complete (&result);
874 success = g_subprocess_wait_finish (subprocess, result, error);
875 g_object_unref (result);
881 * g_subprocess_wait_check:
882 * @subprocess: a #GSubprocess
883 * @cancellable: a #GCancellable
886 * Combines g_subprocess_wait() with g_spawn_check_exit_status().
888 * Returns: %TRUE on success, %FALSE if process exited abnormally, or
889 * @cancellable was cancelled
894 g_subprocess_wait_check (GSubprocess *subprocess,
895 GCancellable *cancellable,
898 return g_subprocess_wait (subprocess, cancellable, error) &&
899 g_spawn_check_exit_status (subprocess->status, error);
903 * g_subprocess_wait_check_async:
904 * @subprocess: a #GSubprocess
905 * @cancellable: a #GCancellable, or %NULL
906 * @callback: a #GAsyncReadyCallback to call when the operation is complete
907 * @user_data: user_data for @callback
909 * Combines g_subprocess_wait_async() with g_spawn_check_exit_status().
911 * This is the asynchronous version of g_subprocess_wait_check().
916 g_subprocess_wait_check_async (GSubprocess *subprocess,
917 GCancellable *cancellable,
918 GAsyncReadyCallback callback,
921 g_subprocess_wait_async (subprocess, cancellable, callback, user_data);
925 * g_subprocess_wait_check_finish:
926 * @subprocess: a #GSubprocess
927 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
928 * @error: a pointer to a %NULL #GError, or %NULL
930 * Collects the result of a previous call to
931 * g_subprocess_wait_check_async().
933 * Returns: %TRUE if successful, or %FALSE with @error set
938 g_subprocess_wait_check_finish (GSubprocess *subprocess,
939 GAsyncResult *result,
942 return g_subprocess_wait_finish (subprocess, result, error) &&
943 g_spawn_check_exit_status (subprocess->status, error);
949 GSubprocess *subprocess;
954 g_subprocess_actually_send_signal (gpointer user_data)
956 SignalRecord *signal_record = user_data;
958 /* The pid is set to zero from the worker thread as well, so we don't
959 * need to take a lock in order to prevent it from changing under us.
961 if (signal_record->subprocess->pid)
962 kill (signal_record->subprocess->pid, signal_record->signalnum);
964 g_object_unref (signal_record->subprocess);
966 g_slice_free (SignalRecord, signal_record);
972 g_subprocess_dispatch_signal (GSubprocess *subprocess,
975 SignalRecord signal_record = { g_object_ref (subprocess), signalnum };
977 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
979 /* This MUST be a lower priority than the priority that the child
980 * watch source uses in initable_init().
982 * Reaping processes, reporting the results back to GSubprocess and
983 * sending signals is all done in the glib worker thread. We cannot
984 * have a kill() done after the reap and before the report without
985 * risking killing a process that's no longer there so the kill()
986 * needs to have the lower priority.
988 * G_PRIORITY_HIGH_IDLE is lower priority than G_PRIORITY_DEFAULT.
990 g_main_context_invoke_full (GLIB_PRIVATE_CALL (g_get_worker_context) (),
991 G_PRIORITY_HIGH_IDLE,
992 g_subprocess_actually_send_signal,
993 g_slice_dup (SignalRecord, &signal_record),
998 * g_subprocess_send_signal:
999 * @subprocess: a #GSubprocess
1000 * @signal_num: the signal number to send
1002 * Sends the UNIX signal @signal_num to the subprocess, if it is still
1005 * This API is race-free. If the subprocess has terminated, it will not
1008 * This API is not available on Windows.
1013 g_subprocess_send_signal (GSubprocess *subprocess,
1016 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1018 g_subprocess_dispatch_signal (subprocess, signal_num);
1023 * g_subprocess_force_exit:
1024 * @subprocess: a #GSubprocess
1026 * Use an operating-system specific method to attempt an immediate,
1027 * forceful termination of the process. There is no mechanism to
1028 * determine whether or not the request itself was successful;
1029 * however, you can use g_subprocess_wait() to monitor the status of
1030 * the process after calling this function.
1032 * On Unix, this function sends %SIGKILL.
1037 g_subprocess_force_exit (GSubprocess *subprocess)
1039 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1042 g_subprocess_dispatch_signal (subprocess, SIGKILL);
1044 TerminateProcess (subprocess->pid, 1);
1049 * g_subprocess_get_status:
1050 * @subprocess: a #GSubprocess
1052 * Gets the raw status code of the process, as from waitpid().
1054 * This value has no particular meaning, but it can be used with the
1055 * macros defined by the system headers such as WIFEXITED. It can also
1056 * be used with g_spawn_check_exit_status().
1058 * It is more likely that you want to use g_subprocess_get_if_exited()
1059 * followed by g_subprocess_get_exit_status().
1061 * It is an error to call this function before g_subprocess_wait() has
1064 * Returns: the (meaningless) waitpid() exit status from the kernel
1069 g_subprocess_get_status (GSubprocess *subprocess)
1071 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1072 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1074 return subprocess->status;
1078 * g_subprocess_get_successful:
1079 * @subprocess: a #GSubprocess
1081 * Checks if the process was "successful". A process is considered
1082 * successful if it exited cleanly with an exit status of 0, either by
1083 * way of the exit() system call or return from main().
1085 * It is an error to call this function before g_subprocess_wait() has
1088 * Returns: %TRUE if the process exited cleanly with a exit status of 0
1093 g_subprocess_get_successful (GSubprocess *subprocess)
1095 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1096 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1099 return WIFEXITED (subprocess->status) && WEXITSTATUS (subprocess->status) == 0;
1101 return subprocess->status == 0;
1106 * g_subprocess_get_if_exited:
1107 * @subprocess: a #GSubprocess
1109 * Check if the given subprocess exited normally (ie: by way of exit()
1110 * or return from main()).
1112 * This is equivalent to the system WIFEXITED macro.
1114 * It is an error to call this function before g_subprocess_wait() has
1117 * Returns: %TRUE if the case of a normal exit
1122 g_subprocess_get_if_exited (GSubprocess *subprocess)
1124 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1125 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1128 return WIFEXITED (subprocess->status);
1135 * g_subprocess_get_exit_status:
1136 * @subprocess: a #GSubprocess
1138 * Check the exit status of the subprocess, given that it exited
1139 * normally. This is the value passed to the exit() system call or the
1140 * return value from main.
1142 * This is equivalent to the system WEXITSTATUS macro.
1144 * It is an error to call this function before g_subprocess_wait() and
1145 * unless g_subprocess_get_if_exited() returned %TRUE.
1147 * Returns: the exit status
1152 g_subprocess_get_exit_status (GSubprocess *subprocess)
1154 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 1);
1155 g_return_val_if_fail (subprocess->pid == 0, 1);
1158 g_return_val_if_fail (WIFEXITED (subprocess->status), 1);
1160 return WEXITSTATUS (subprocess->status);
1162 return subprocess->status;
1167 * g_subprocess_get_if_signaled:
1168 * @subprocess: a #GSubprocess
1170 * Check if the given subprocess terminated in response to a signal.
1172 * This is equivalent to the system WIFSIGNALED macro.
1174 * It is an error to call this function before g_subprocess_wait() has
1177 * Returns: %TRUE if the case of termination due to a signal
1182 g_subprocess_get_if_signaled (GSubprocess *subprocess)
1184 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1185 g_return_val_if_fail (subprocess->pid == 0, FALSE);
1188 return WIFSIGNALED (subprocess->status);
1195 * g_subprocess_get_term_sig:
1196 * @subprocess: a #GSubprocess
1198 * Get the signal number that caused the subprocess to terminate, given
1199 * that it terminated due to a signal.
1201 * This is equivalent to the system WTERMSIG macro.
1203 * It is an error to call this function before g_subprocess_wait() and
1204 * unless g_subprocess_get_if_signaled() returned %TRUE.
1206 * Returns: the signal causing termination
1211 g_subprocess_get_term_sig (GSubprocess *subprocess)
1213 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 0);
1214 g_return_val_if_fail (subprocess->pid == 0, 0);
1217 g_return_val_if_fail (WIFSIGNALED (subprocess->status), 0);
1219 return WTERMSIG (subprocess->status);
1221 g_critical ("g_subprocess_get_term_sig() called on Windows, where "
1222 "g_subprocess_get_if_signaled() always returns FALSE...");
1229 g_subprocess_set_launcher (GSubprocess *subprocess,
1230 GSubprocessLauncher *launcher)
1232 subprocess->launcher = launcher;
1236 /* g_subprocess_communicate implementation below:
1238 * This is a tough problem. We have to watch 5 things at the same time:
1240 * - writing to stdin made progress
1241 * - reading from stdout made progress
1242 * - reading from stderr made progress
1243 * - process terminated
1244 * - cancellable being cancelled by caller
1246 * We use a GMainContext for all of these (either as async function
1247 * calls or as a GSource (in the case of the cancellable). That way at
1248 * least we don't have to worry about threading.
1250 * For the sync case we use the usual trick of creating a private main
1251 * context and iterating it until completion.
1253 * It's very possible that the process will dump a lot of data to stdout
1254 * just before it quits, so we can easily have data to read from stdout
1255 * and see the process has terminated at the same time. We want to make
1256 * sure that we read all of the data from the pipes first, though, so we
1257 * do IO operations at a higher priority than the wait operation (which
1258 * is at G_IO_PRIORITY_DEFAULT). Even in the case that we have to do
1259 * multiple reads to get this data, the pipe() will always be polling
1260 * as ready and with the async result for the read at a higher priority,
1261 * the main context will not dispatch the completion for the wait().
1263 * We keep our own private GCancellable. In the event that any of the
1264 * above suffers from an error condition (including the user cancelling
1265 * their cancellable) we immediately dispatch the GTask with the error
1266 * result and fire our cancellable to cleanup any pending operations.
1267 * In the case that the error is that the user's cancellable was fired,
1268 * it's vaguely wasteful to report an error because GTask will handle
1269 * this automatically, so we just return FALSE.
1271 * We let each pending sub-operation take a ref on the GTask of the
1272 * communicate operation. We have to be careful that we don't report
1273 * the task completion more than once, though, so we keep a flag for
1278 const gchar *stdin_data;
1284 GInputStream *stdin_buf;
1285 GMemoryOutputStream *stdout_buf;
1286 GMemoryOutputStream *stderr_buf;
1288 GCancellable *cancellable;
1289 GSource *cancellable_source;
1291 guint outstanding_ops;
1292 gboolean reported_error;
1296 g_subprocess_communicate_made_progress (GObject *source_object,
1297 GAsyncResult *result,
1300 CommunicateState *state;
1301 GSubprocess *subprocess;
1302 GError *error = NULL;
1306 g_assert (source_object != NULL);
1309 subprocess = g_task_get_source_object (task);
1310 state = g_task_get_task_data (task);
1311 source = source_object;
1313 state->outstanding_ops--;
1315 if (source == subprocess->stdin_pipe ||
1316 source == state->stdout_buf ||
1317 source == state->stderr_buf)
1319 if (g_output_stream_splice_finish ((GOutputStream*) source, result, &error) == -1)
1322 if (source == state->stdout_buf ||
1323 source == state->stderr_buf)
1325 /* This is a memory stream, so it can't be cancelled or return
1330 gsize bytes_written;
1331 if (!g_output_stream_write_all (source, "\0", 1, &bytes_written,
1335 if (!g_output_stream_close (source, NULL, &error))
1339 else if (source == subprocess)
1341 (void) g_subprocess_wait_finish (subprocess, result, &error);
1344 g_assert_not_reached ();
1349 /* Only report the first error we see.
1351 * We might be seeing an error as a result of the cancellation
1352 * done when the process quits.
1354 if (!state->reported_error)
1356 state->reported_error = TRUE;
1357 g_cancellable_cancel (state->cancellable);
1358 g_task_return_error (task, error);
1361 g_error_free (error);
1363 else if (state->outstanding_ops == 0)
1365 g_task_return_boolean (task, TRUE);
1368 /* And drop the original ref */
1369 g_object_unref (task);
1373 g_subprocess_communicate_cancelled (GCancellable *cancellable,
1376 CommunicateState *state = user_data;
1378 g_cancellable_cancel (state->cancellable);
1384 g_subprocess_communicate_state_free (gpointer data)
1386 CommunicateState *state = data;
1388 g_clear_object (&state->cancellable);
1389 g_clear_object (&state->stdin_buf);
1390 g_clear_object (&state->stdout_buf);
1391 g_clear_object (&state->stderr_buf);
1393 if (state->cancellable_source)
1395 g_source_destroy (state->cancellable_source);
1396 g_source_unref (state->cancellable_source);
1399 g_slice_free (CommunicateState, state);
1402 static CommunicateState *
1403 g_subprocess_communicate_internal (GSubprocess *subprocess,
1406 GCancellable *cancellable,
1407 GAsyncReadyCallback callback,
1410 CommunicateState *state;
1413 task = g_task_new (subprocess, cancellable, callback, user_data);
1414 g_task_set_source_tag (task, g_subprocess_communicate_internal);
1416 state = g_slice_new0 (CommunicateState);
1417 g_task_set_task_data (task, state, g_subprocess_communicate_state_free);
1419 state->cancellable = g_cancellable_new ();
1420 state->add_nul = add_nul;
1424 state->cancellable_source = g_cancellable_source_new (cancellable);
1425 /* No ref held here, but we unref the source from state's free function */
1426 g_source_set_callback (state->cancellable_source,
1427 G_SOURCE_FUNC (g_subprocess_communicate_cancelled),
1429 g_source_attach (state->cancellable_source, g_main_context_get_thread_default ());
1432 if (subprocess->stdin_pipe)
1434 g_assert (stdin_buf != NULL);
1437 /* We're doing async writes to the pipe, and the async write mechanism assumes
1438 * that streams polling as writable do SOME progress (possibly partial) and then
1439 * stop, but never block.
1441 * However, for blocking pipes, unix will return writable if there is *any* space left
1442 * but still block until the full buffer size is available before returning from write.
1443 * So, to avoid async blocking on the main loop we make this non-blocking here.
1445 * It should be safe to change the fd because we're the only user at this point as
1446 * per the g_subprocess_communicate() docs, and all the code called by this function
1447 * properly handles non-blocking fds.
1449 g_unix_set_fd_nonblocking (g_unix_output_stream_get_fd (G_UNIX_OUTPUT_STREAM (subprocess->stdin_pipe)), TRUE, NULL);
1452 state->stdin_buf = g_memory_input_stream_new_from_bytes (stdin_buf);
1453 g_output_stream_splice_async (subprocess->stdin_pipe, (GInputStream*)state->stdin_buf,
1454 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE | G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
1455 G_PRIORITY_DEFAULT, state->cancellable,
1456 g_subprocess_communicate_made_progress, g_object_ref (task));
1457 state->outstanding_ops++;
1460 if (subprocess->stdout_pipe)
1462 state->stdout_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1463 g_output_stream_splice_async ((GOutputStream*)state->stdout_buf, subprocess->stdout_pipe,
1464 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1465 G_PRIORITY_DEFAULT, state->cancellable,
1466 g_subprocess_communicate_made_progress, g_object_ref (task));
1467 state->outstanding_ops++;
1470 if (subprocess->stderr_pipe)
1472 state->stderr_buf = (GMemoryOutputStream*)g_memory_output_stream_new_resizable ();
1473 g_output_stream_splice_async ((GOutputStream*)state->stderr_buf, subprocess->stderr_pipe,
1474 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE,
1475 G_PRIORITY_DEFAULT, state->cancellable,
1476 g_subprocess_communicate_made_progress, g_object_ref (task));
1477 state->outstanding_ops++;
1480 g_subprocess_wait_async (subprocess, state->cancellable,
1481 g_subprocess_communicate_made_progress, g_object_ref (task));
1482 state->outstanding_ops++;
1484 g_object_unref (task);
1489 * g_subprocess_communicate:
1490 * @subprocess: a #GSubprocess
1491 * @stdin_buf: (nullable): data to send to the stdin of the subprocess, or %NULL
1492 * @cancellable: a #GCancellable
1493 * @stdout_buf: (out) (nullable) (optional) (transfer full): data read from the subprocess stdout
1494 * @stderr_buf: (out) (nullable) (optional) (transfer full): data read from the subprocess stderr
1495 * @error: a pointer to a %NULL #GError pointer, or %NULL
1497 * Communicate with the subprocess until it terminates, and all input
1498 * and output has been completed.
1500 * If @stdin_buf is given, the subprocess must have been created with
1501 * %G_SUBPROCESS_FLAGS_STDIN_PIPE. The given data is fed to the
1502 * stdin of the subprocess and the pipe is closed (ie: EOF).
1504 * At the same time (as not to cause blocking when dealing with large
1505 * amounts of data), if %G_SUBPROCESS_FLAGS_STDOUT_PIPE or
1506 * %G_SUBPROCESS_FLAGS_STDERR_PIPE were used, reads from those
1507 * streams. The data that was read is returned in @stdout and/or
1510 * If the subprocess was created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1511 * @stdout_buf will contain the data read from stdout. Otherwise, for
1512 * subprocesses not created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
1513 * @stdout_buf will be set to %NULL. Similar provisions apply to
1514 * @stderr_buf and %G_SUBPROCESS_FLAGS_STDERR_PIPE.
1516 * As usual, any output variable may be given as %NULL to ignore it.
1518 * If you desire the stdout and stderr data to be interleaved, create
1519 * the subprocess with %G_SUBPROCESS_FLAGS_STDOUT_PIPE and
1520 * %G_SUBPROCESS_FLAGS_STDERR_MERGE. The merged result will be returned
1521 * in @stdout_buf and @stderr_buf will be set to %NULL.
1523 * In case of any error (including cancellation), %FALSE will be
1524 * returned with @error set. Some or all of the stdin data may have
1525 * been written. Any stdout or stderr data that has been read will be
1526 * discarded. None of the out variables (aside from @error) will have
1527 * been set to anything in particular and should not be inspected.
1529 * In the case that %TRUE is returned, the subprocess has exited and the
1530 * exit status inspection APIs (eg: g_subprocess_get_if_exited(),
1531 * g_subprocess_get_exit_status()) may be used.
1533 * You should not attempt to use any of the subprocess pipes after
1534 * starting this function, since they may be left in strange states,
1535 * even if the operation was cancelled. You should especially not
1536 * attempt to interact with the pipes while the operation is in progress
1537 * (either from another thread or if using the asynchronous version).
1539 * Returns: %TRUE if successful
1544 g_subprocess_communicate (GSubprocess *subprocess,
1546 GCancellable *cancellable,
1547 GBytes **stdout_buf,
1548 GBytes **stderr_buf,
1551 GAsyncResult *result = NULL;
1554 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1555 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1556 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1557 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1559 g_subprocess_sync_setup ();
1560 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable,
1561 g_subprocess_sync_done, &result);
1562 g_subprocess_sync_complete (&result);
1563 success = g_subprocess_communicate_finish (subprocess, result, stdout_buf, stderr_buf, error);
1564 g_object_unref (result);
1570 * g_subprocess_communicate_async:
1572 * @stdin_buf: (nullable): Input data, or %NULL
1573 * @cancellable: (nullable): Cancellable
1574 * @callback: Callback
1575 * @user_data: User data
1577 * Asynchronous version of g_subprocess_communicate(). Complete
1578 * invocation with g_subprocess_communicate_finish().
1581 g_subprocess_communicate_async (GSubprocess *subprocess,
1583 GCancellable *cancellable,
1584 GAsyncReadyCallback callback,
1587 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1588 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1589 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1591 g_subprocess_communicate_internal (subprocess, FALSE, stdin_buf, cancellable, callback, user_data);
1595 * g_subprocess_communicate_finish:
1598 * @stdout_buf: (out) (nullable) (optional) (transfer full): Return location for stdout data
1599 * @stderr_buf: (out) (nullable) (optional) (transfer full): Return location for stderr data
1602 * Complete an invocation of g_subprocess_communicate_async().
1605 g_subprocess_communicate_finish (GSubprocess *subprocess,
1606 GAsyncResult *result,
1607 GBytes **stdout_buf,
1608 GBytes **stderr_buf,
1612 CommunicateState *state;
1614 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1615 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1616 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1618 g_object_ref (result);
1620 state = g_task_get_task_data ((GTask*)result);
1621 success = g_task_propagate_boolean ((GTask*)result, error);
1626 *stdout_buf = (state->stdout_buf != NULL) ? g_memory_output_stream_steal_as_bytes (state->stdout_buf) : NULL;
1628 *stderr_buf = (state->stderr_buf != NULL) ? g_memory_output_stream_steal_as_bytes (state->stderr_buf) : NULL;
1631 g_object_unref (result);
1636 * g_subprocess_communicate_utf8:
1637 * @subprocess: a #GSubprocess
1638 * @stdin_buf: (nullable): data to send to the stdin of the subprocess, or %NULL
1639 * @cancellable: a #GCancellable
1640 * @stdout_buf: (out) (nullable) (optional) (transfer full): data read from the subprocess stdout
1641 * @stderr_buf: (out) (nullable) (optional) (transfer full): data read from the subprocess stderr
1642 * @error: a pointer to a %NULL #GError pointer, or %NULL
1644 * Like g_subprocess_communicate(), but validates the output of the
1645 * process as UTF-8, and returns it as a regular NUL terminated string.
1647 * On error, @stdout_buf and @stderr_buf will be set to undefined values and
1648 * should not be used.
1651 g_subprocess_communicate_utf8 (GSubprocess *subprocess,
1652 const char *stdin_buf,
1653 GCancellable *cancellable,
1658 GAsyncResult *result = NULL;
1660 GBytes *stdin_bytes;
1661 size_t stdin_buf_len = 0;
1663 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1664 g_return_val_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE), FALSE);
1665 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
1666 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1668 if (stdin_buf != NULL)
1669 stdin_buf_len = strlen (stdin_buf);
1670 stdin_bytes = g_bytes_new (stdin_buf, stdin_buf_len);
1672 g_subprocess_sync_setup ();
1673 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable,
1674 g_subprocess_sync_done, &result);
1675 g_subprocess_sync_complete (&result);
1676 success = g_subprocess_communicate_utf8_finish (subprocess, result, stdout_buf, stderr_buf, error);
1677 g_object_unref (result);
1679 g_bytes_unref (stdin_bytes);
1684 * g_subprocess_communicate_utf8_async:
1686 * @stdin_buf: (nullable): Input data, or %NULL
1687 * @cancellable: Cancellable
1688 * @callback: Callback
1689 * @user_data: User data
1691 * Asynchronous version of g_subprocess_communicate_utf8(). Complete
1692 * invocation with g_subprocess_communicate_utf8_finish().
1695 g_subprocess_communicate_utf8_async (GSubprocess *subprocess,
1696 const char *stdin_buf,
1697 GCancellable *cancellable,
1698 GAsyncReadyCallback callback,
1701 GBytes *stdin_bytes;
1702 size_t stdin_buf_len = 0;
1704 g_return_if_fail (G_IS_SUBPROCESS (subprocess));
1705 g_return_if_fail (stdin_buf == NULL || (subprocess->flags & G_SUBPROCESS_FLAGS_STDIN_PIPE));
1706 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1708 if (stdin_buf != NULL)
1709 stdin_buf_len = strlen (stdin_buf);
1710 stdin_bytes = g_bytes_new (stdin_buf, stdin_buf_len);
1712 g_subprocess_communicate_internal (subprocess, TRUE, stdin_bytes, cancellable, callback, user_data);
1714 g_bytes_unref (stdin_bytes);
1718 communicate_result_validate_utf8 (const char *stream_name,
1719 char **return_location,
1720 GMemoryOutputStream *buffer,
1723 if (return_location == NULL)
1729 *return_location = g_memory_output_stream_steal_data (buffer);
1730 if (!g_utf8_validate (*return_location, -1, &end))
1732 g_free (*return_location);
1733 *return_location = NULL;
1734 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
1735 "Invalid UTF-8 in child %s at offset %lu",
1737 (unsigned long) (end - *return_location));
1742 *return_location = NULL;
1748 * g_subprocess_communicate_utf8_finish:
1751 * @stdout_buf: (out) (nullable) (optional) (transfer full): Return location for stdout data
1752 * @stderr_buf: (out) (nullable) (optional) (transfer full): Return location for stderr data
1755 * Complete an invocation of g_subprocess_communicate_utf8_async().
1758 g_subprocess_communicate_utf8_finish (GSubprocess *subprocess,
1759 GAsyncResult *result,
1764 gboolean ret = FALSE;
1765 CommunicateState *state;
1766 gchar *local_stdout_buf = NULL, *local_stderr_buf = NULL;
1768 g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
1769 g_return_val_if_fail (g_task_is_valid (result, subprocess), FALSE);
1770 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1772 g_object_ref (result);
1774 state = g_task_get_task_data ((GTask*)result);
1775 if (!g_task_propagate_boolean ((GTask*)result, error))
1778 /* TODO - validate UTF-8 while streaming, rather than all at once.
1780 if (!communicate_result_validate_utf8 ("stdout", &local_stdout_buf,
1784 if (!communicate_result_validate_utf8 ("stderr", &local_stderr_buf,
1791 g_object_unref (result);
1793 if (ret && stdout_buf != NULL)
1794 *stdout_buf = g_steal_pointer (&local_stdout_buf);
1795 if (ret && stderr_buf != NULL)
1796 *stderr_buf = g_steal_pointer (&local_stderr_buf);
1798 g_free (local_stderr_buf);
1799 g_free (local_stdout_buf);