1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2012 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>
18 * SECTION:gsubprocesslauncher
19 * @title: GSubprocess Launcher
20 * @short_description: Environment options for launching a child process
23 * This class contains a set of options for launching child processes,
24 * such as where its standard input and output will be directed, the
25 * argument list, the environment, and more.
27 * While the #GSubprocess class has high level functions covering
28 * popular cases, use of this class allows access to more advanced
29 * options. It can also be used to launch multiple subprocesses with
30 * a similar configuration.
35 #define ALL_STDIN_FLAGS (G_SUBPROCESS_FLAGS_STDIN_PIPE | \
36 G_SUBPROCESS_FLAGS_STDIN_INHERIT)
37 #define ALL_STDOUT_FLAGS (G_SUBPROCESS_FLAGS_STDOUT_PIPE | \
38 G_SUBPROCESS_FLAGS_STDOUT_SILENCE)
39 #define ALL_STDERR_FLAGS (G_SUBPROCESS_FLAGS_STDERR_PIPE | \
40 G_SUBPROCESS_FLAGS_STDERR_SILENCE | \
41 G_SUBPROCESS_FLAGS_STDERR_MERGE)
45 #include "gsubprocesslauncher-private.h"
46 #include "gioenumtypes.h"
47 #include "gsubprocess.h"
48 #include "ginitable.h"
55 typedef GObjectClass GSubprocessLauncherClass;
57 G_DEFINE_TYPE (GSubprocessLauncher, g_subprocess_launcher, G_TYPE_OBJECT);
60 verify_disposition (const gchar *stream_name,
61 GSubprocessFlags filtered_flags,
63 const gchar *filename)
69 else if (((filtered_flags - 1) & filtered_flags) == 0)
72 n_bits = 2; /* ...or more */
74 if (n_bits + (fd >= 0) + (filename != NULL) > 1)
78 err = g_string_new (NULL);
84 class = g_type_class_peek (G_TYPE_SUBPROCESS_FLAGS);
85 while ((value = g_flags_get_first_value (class, filtered_flags)))
87 g_string_append_printf (err, " %s", value->value_name);
88 filtered_flags &= value->value;
91 g_type_class_unref (class);
95 g_string_append_printf (err, " g_subprocess_launcher_take_%s_fd()", stream_name);
98 g_string_append_printf (err, " g_subprocess_launcher_set_%s_file_path()", stream_name);
100 g_critical ("You may specify at most one disposition for the %s stream, but you specified:%s.",
101 stream_name, err->str);
102 g_string_free (err, TRUE);
111 verify_flags (GSubprocessFlags flags)
113 return verify_disposition ("stdin", flags & ALL_STDIN_FLAGS, -1, NULL) &&
114 verify_disposition ("stdout", flags & ALL_STDOUT_FLAGS, -1, NULL) &&
115 verify_disposition ("stderr", flags & ALL_STDERR_FLAGS, -1, NULL);
119 g_subprocess_launcher_set_property (GObject *object, guint prop_id,
120 const GValue *value, GParamSpec *pspec)
122 GSubprocessLauncher *launcher = G_SUBPROCESS_LAUNCHER (object);
124 g_assert (prop_id == 1);
126 if (verify_flags (g_value_get_flags (value)))
127 launcher->flags = g_value_get_flags (value);
131 g_subprocess_launcher_finalize (GObject *object)
133 GSubprocessLauncher *self = G_SUBPROCESS_LAUNCHER (object);
138 g_free (self->stdin_path);
139 g_free (self->stdout_path);
140 g_free (self->stderr_path);
142 if (self->stdin_fd != -1)
143 close (self->stdin_fd);
145 if (self->stdout_fd != -1)
146 close (self->stdout_fd);
148 if (self->stderr_fd != -1)
149 close (self->stderr_fd);
151 if (self->basic_fd_assignments)
153 for (i = 0; i < self->basic_fd_assignments->len; i++)
154 (void) close (g_array_index (self->basic_fd_assignments, int, i));
155 g_array_unref (self->basic_fd_assignments);
157 if (self->needdup_fd_assignments)
159 for (i = 0; i < self->needdup_fd_assignments->len; i += 2)
160 (void) close (g_array_index (self->needdup_fd_assignments, int, i));
161 g_array_unref (self->needdup_fd_assignments);
164 if (self->child_setup_destroy_notify)
165 (* self->child_setup_destroy_notify) (self->child_setup_user_data);
168 g_strfreev (self->envp);
171 G_OBJECT_CLASS (g_subprocess_launcher_parent_class)->finalize (object);
175 g_subprocess_launcher_init (GSubprocessLauncher *self)
177 self->envp = g_get_environ ();
181 self->stdout_fd = -1;
182 self->stderr_fd = -1;
183 self->basic_fd_assignments = g_array_new (FALSE, 0, sizeof (int));
184 self->needdup_fd_assignments = g_array_new (FALSE, 0, sizeof (int));
189 g_subprocess_launcher_class_init (GSubprocessLauncherClass *class)
191 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
193 gobject_class->set_property = g_subprocess_launcher_set_property;
194 gobject_class->finalize = g_subprocess_launcher_finalize;
196 g_object_class_install_property (gobject_class, 1,
197 g_param_spec_flags ("flags", "Flags", "GSubprocessFlags for launched processes",
198 G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |
199 G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY));
203 * g_subprocess_launcher_new:
204 * @flags: #GSubprocessFlags
206 * Creates a new #GSubprocessLauncher.
208 * The launcher is created with the default options. A copy of the
209 * environment of the calling process is made at the time of this call
210 * and will be used as the environment that the process is launched in.
214 GSubprocessLauncher *
215 g_subprocess_launcher_new (GSubprocessFlags flags)
217 if (!verify_flags (flags))
220 return g_object_new (G_TYPE_SUBPROCESS_LAUNCHER,
226 * g_subprocess_launcher_set_environ:
227 * @self: a #GSubprocess
228 * @env: (array zero-terminated=1): the replacement environment
230 * Replace the entire environment of processes launched from this
231 * launcher with the given 'environ' variable.
233 * Typically you will build this variable by using g_listenv() to copy
234 * the process 'environ' and using the functions g_environ_setenv(),
235 * g_environ_unsetenv(), etc.
237 * As an alternative, you can use g_subprocess_launcher_setenv(),
238 * g_subprocess_launcher_unsetenv(), etc.
240 * On UNIX, all strings in this array can be arbitrary byte strings.
241 * On Windows, they should be in UTF-8.
246 g_subprocess_launcher_set_environ (GSubprocessLauncher *self,
249 g_strfreev (self->envp);
250 self->envp = g_strdupv (env);
254 * g_subprocess_launcher_setenv:
255 * @self: a #GSubprocess
256 * @variable: the environment variable to set, must not contain '='
257 * @value: the new value for the variable
258 * @overwrite: whether to change the variable if it already exists
260 * Sets the environment variable @variable in the environment of
261 * processes launched from this launcher.
263 * On UNIX, both the variable's name and value can be arbitrary byte
264 * strings, except that the variable's name cannot contain '='.
265 * On Windows, they should be in UTF-8.
270 g_subprocess_launcher_setenv (GSubprocessLauncher *self,
271 const gchar *variable,
275 self->envp = g_environ_setenv (self->envp, variable, value, overwrite);
279 * g_subprocess_launcher_unsetenv:
280 * @self: a #GSubprocess
281 * @variable: the environment variable to unset, must not contain '='
283 * Removes the environment variable @variable from the environment of
284 * processes launched from this launcher.
286 * On UNIX, the variable's name can be an arbitrary byte string not
287 * containing '='. On Windows, it should be in UTF-8.
292 g_subprocess_launcher_unsetenv (GSubprocessLauncher *self,
293 const gchar *variable)
295 self->envp = g_environ_unsetenv (self->envp, variable);
299 * g_subprocess_launcher_getenv:
300 * @self: a #GSubprocess
301 * @variable: the environment variable to get
303 * Returns the value of the environment variable @variable in the
304 * environment of processes launched from this launcher.
306 * On UNIX, the returned string can be an arbitrary byte string.
307 * On Windows, it will be UTF-8.
309 * Returns: the value of the environment variable, %NULL if unset
314 g_subprocess_launcher_getenv (GSubprocessLauncher *self,
315 const gchar *variable)
317 return g_environ_getenv (self->envp, variable);
321 * g_subprocess_launcher_set_cwd:
322 * @self: a #GSubprocess
323 * @cwd: (type filename): the cwd for launched processes
325 * Sets the current working directory that processes will be launched
328 * By default processes are launched with the current working directory
329 * of the launching process at the time of launch.
334 g_subprocess_launcher_set_cwd (GSubprocessLauncher *self,
338 self->cwd = g_strdup (cwd);
342 * g_subprocess_launcher_set_flags:
343 * @self: a #GSubprocessLauncher
344 * @flags: #GSubprocessFlags
346 * Sets the flags on the launcher.
348 * The default flags are %G_SUBPROCESS_FLAGS_NONE.
350 * You may not set flags that specify conflicting options for how to
351 * handle a particular stdio stream (eg: specifying both
352 * %G_SUBPROCESS_FLAGS_STDIN_PIPE and
353 * %G_SUBPROCESS_FLAGS_STDIN_INHERIT).
355 * You may also not set a flag that conflicts with a previous call to a
356 * function like g_subprocess_launcher_set_stdin_file_path() or
357 * g_subprocess_launcher_take_stdout_fd().
362 g_subprocess_launcher_set_flags (GSubprocessLauncher *self,
363 GSubprocessFlags flags)
365 const gchar *stdin_path = NULL, *stdout_path = NULL, *stderr_path = NULL;
366 gint stdin_fd = -1, stdout_fd = -1, stderr_fd = -1;
369 stdin_fd = self->stdin_fd;
370 stdout_fd = self->stdout_fd;
371 stderr_fd = self->stderr_fd;
372 stdin_path = self->stdin_path;
373 stdout_path = self->stdout_path;
374 stderr_path = self->stderr_path;
377 if (verify_disposition ("stdin", flags & ALL_STDIN_FLAGS, stdin_fd, stdin_path) &&
378 verify_disposition ("stdout", flags & ALL_STDOUT_FLAGS, stdout_fd, stdout_path) &&
379 verify_disposition ("stderr", flags & ALL_STDERR_FLAGS, stderr_fd, stderr_path))
385 assign_fd (gint *fd_ptr, gint fd)
397 flags = fcntl (fd, F_GETFD);
398 if (~flags & FD_CLOEXEC)
399 fcntl (fd, F_SETFD, flags | FD_CLOEXEC);
404 * g_subprocess_launcher_set_stdin_file_path:
405 * @self: a #GSubprocessLauncher
406 * @path: (type filename) (nullable: a filename or %NULL
408 * Sets the file path to use as the stdin for spawned processes.
410 * If @path is %NULL then any previously given path is unset.
412 * The file must exist or spawning the process will fail.
414 * You may not set a stdin file path if a stdin fd is already set or if
415 * the launcher flags contain any flags directing stdin elsewhere.
417 * This feature is only available on UNIX.
422 g_subprocess_launcher_set_stdin_file_path (GSubprocessLauncher *self,
425 if (verify_disposition ("stdin", self->flags & ALL_STDIN_FLAGS, self->stdin_fd, path))
427 g_free (self->stdin_path);
428 self->stdin_path = g_strdup (path);
433 * g_subprocess_launcher_take_stdin_fd:
434 * @self: a #GSubprocessLauncher
435 * @fd: a file descriptor, or -1
437 * Sets the file descriptor to use as the stdin for spawned processes.
439 * If @fd is -1 then any previously given fd is unset.
441 * Note that if your intention is to have the stdin of the calling
442 * process inherited by the child then %G_SUBPROCESS_FLAGS_STDIN_INHERIT
443 * is a better way to go about doing that.
445 * The passed @fd is noted but will not be touched in the current
446 * process. It is therefore necessary that it be kept open by the
447 * caller until the subprocess is spawned. The file descriptor will
448 * also not be explicitly closed on the child side, so it must be marked
449 * O_CLOEXEC if that's what you want.
451 * You may not set a stdin fd if a stdin file path is already set or if
452 * the launcher flags contain any flags directing stdin elsewhere.
454 * This feature is only available on UNIX.
459 g_subprocess_launcher_take_stdin_fd (GSubprocessLauncher *self,
462 if (verify_disposition ("stdin", self->flags & ALL_STDIN_FLAGS, fd, self->stdin_path))
463 assign_fd (&self->stdin_fd, fd);
467 * g_subprocess_launcher_set_stdout_file_path:
468 * @self: a #GSubprocessLauncher
469 * @path: (type filename) (nullable): a filename or %NULL
471 * Sets the file path to use as the stdout for spawned processes.
473 * If @path is %NULL then any previously given path is unset.
475 * The file will be created or truncated when the process is spawned, as
476 * would be the case if using '>' at the shell.
478 * You may not set a stdout file path if a stdout fd is already set or
479 * if the launcher flags contain any flags directing stdout elsewhere.
481 * This feature is only available on UNIX.
486 g_subprocess_launcher_set_stdout_file_path (GSubprocessLauncher *self,
489 if (verify_disposition ("stdout", self->flags & ALL_STDOUT_FLAGS, self->stdout_fd, path))
491 g_free (self->stdout_path);
492 self->stdout_path = g_strdup (path);
497 * g_subprocess_launcher_take_stdout_fd:
498 * @self: a #GSubprocessLauncher
499 * @fd: a file descriptor, or -1
501 * Sets the file descriptor to use as the stdout for spawned processes.
503 * If @fd is -1 then any previously given fd is unset.
505 * Note that the default behaviour is to pass stdout through to the
506 * stdout of the parent process.
508 * The passed @fd is noted but will not be touched in the current
509 * process. It is therefore necessary that it be kept open by the
510 * caller until the subprocess is spawned. The file descriptor will
511 * also not be explicitly closed on the child side, so it must be marked
512 * O_CLOEXEC if that's what you want.
514 * You may not set a stdout fd if a stdout file path is already set or
515 * if the launcher flags contain any flags directing stdout elsewhere.
517 * This feature is only available on UNIX.
522 g_subprocess_launcher_take_stdout_fd (GSubprocessLauncher *self,
525 if (verify_disposition ("stdout", self->flags & ALL_STDOUT_FLAGS, fd, self->stdout_path))
526 assign_fd (&self->stdout_fd, fd);
530 * g_subprocess_launcher_set_stderr_file_path:
531 * @self: a #GSubprocessLauncher
532 * @path: (type filename) (nullable): a filename or %NULL
534 * Sets the file path to use as the stderr for spawned processes.
536 * If @path is %NULL then any previously given path is unset.
538 * The file will be created or truncated when the process is spawned, as
539 * would be the case if using '2>' at the shell.
541 * If you want to send both stdout and stderr to the same file then use
542 * %G_SUBPROCESS_FLAGS_STDERR_MERGE.
544 * You may not set a stderr file path if a stderr fd is already set or
545 * if the launcher flags contain any flags directing stderr elsewhere.
547 * This feature is only available on UNIX.
552 g_subprocess_launcher_set_stderr_file_path (GSubprocessLauncher *self,
555 if (verify_disposition ("stderr", self->flags & ALL_STDERR_FLAGS, self->stderr_fd, path))
557 g_free (self->stderr_path);
558 self->stderr_path = g_strdup (path);
563 * g_subprocess_launcher_take_stderr_fd:
564 * @self: a #GSubprocessLauncher
565 * @fd: a file descriptor, or -1
567 * Sets the file descriptor to use as the stderr for spawned processes.
569 * If @fd is -1 then any previously given fd is unset.
571 * Note that the default behaviour is to pass stderr through to the
572 * stderr of the parent process.
574 * The passed @fd belongs to the #GSubprocessLauncher. It will be
575 * automatically closed when the launcher is finalized. The file
576 * descriptor will also be closed on the child side when executing the
579 * You may not set a stderr fd if a stderr file path is already set or
580 * if the launcher flags contain any flags directing stderr elsewhere.
582 * This feature is only available on UNIX.
587 g_subprocess_launcher_take_stderr_fd (GSubprocessLauncher *self,
590 if (verify_disposition ("stderr", self->flags & ALL_STDERR_FLAGS, fd, self->stderr_path))
591 assign_fd (&self->stderr_fd, fd);
595 * g_subprocess_launcher_take_fd:
596 * @self: a #GSubprocessLauncher
597 * @source_fd: File descriptor in parent process
598 * @target_fd: Target descriptor for child process
600 * Transfer an arbitrary file descriptor from parent process to the
601 * child. This function takes "ownership" of the fd; it will be closed
602 * in the parent when @self is freed.
604 * By default, all file descriptors from the parent will be closed.
605 * This function allows you to create (for example) a custom pipe() or
606 * socketpair() before launching the process, and choose the target
607 * descriptor in the child.
609 * An example use case is GNUPG, which has a command line argument
610 * --passphrase-fd providing a file descriptor number where it expects
611 * the passphrase to be written.
614 g_subprocess_launcher_take_fd (GSubprocessLauncher *self,
618 if (source_fd == target_fd)
620 g_array_append_val (self->basic_fd_assignments, source_fd);
624 g_array_append_val (self->needdup_fd_assignments, source_fd);
625 g_array_append_val (self->needdup_fd_assignments, target_fd);
630 * g_subprocess_launcher_set_child_setup:
631 * @self: a #GSubprocessLauncher
632 * @child_setup: a #GSpawnChildSetupFunc to use as the child setup function
633 * @user_data: user data for @child_setup
634 * @destroy_notify: a #GDestroyNotify for @user_data
636 * Sets up a child setup function.
638 * The child setup function will be called after fork() but before
639 * exec() on the child's side.
641 * @destroy_notify will not be automatically called on the child's side
642 * of the fork(). It will only be called when the last reference on the
643 * #GSubprocessLauncher is dropped or when a new child setup function is
646 * %NULL can be given as @child_setup to disable the functionality.
648 * Child setup functions are only available on UNIX.
653 g_subprocess_launcher_set_child_setup (GSubprocessLauncher *self,
654 GSpawnChildSetupFunc child_setup,
656 GDestroyNotify destroy_notify)
658 if (self->child_setup_destroy_notify)
659 (* self->child_setup_destroy_notify) (self->child_setup_user_data);
661 self->child_setup_func = child_setup;
662 self->child_setup_user_data = user_data;
663 self->child_setup_destroy_notify = destroy_notify;
668 * g_subprocess_launcher_spawn:
669 * @self: a #GSubprocessLauncher
671 * @argv0: Command line arguments
672 * @...: Continued arguments, %NULL terminated
674 * Creates a #GSubprocess given a provided varargs list of arguments.
677 * Returns: (transfer full): A new #GSubprocess, or %NULL on error (and @error will be set)
680 g_subprocess_launcher_spawn (GSubprocessLauncher *launcher,
690 g_return_val_if_fail (argv0 != NULL && argv0[0] != '\0', NULL);
691 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
693 args = g_ptr_array_new ();
695 va_start (ap, argv0);
696 g_ptr_array_add (args, (gchar *) argv0);
697 while ((arg = va_arg (ap, const gchar *)))
698 g_ptr_array_add (args, (gchar *) arg);
700 g_ptr_array_add (args, NULL);
703 result = g_subprocess_launcher_spawnv (launcher, (const gchar * const *) args->pdata, error);
705 g_ptr_array_free (args, TRUE);
712 * g_subprocess_launcher_spawnv:
713 * @self: a #GSubprocessLauncher
714 * @argv: (array zero-terminated=1) (element-type utf8): Command line arguments
717 * Creates a #GSubprocess given a provided array of arguments.
720 * Returns: (transfer full): A new #GSubprocess, or %NULL on error (and @error will be set)
723 g_subprocess_launcher_spawnv (GSubprocessLauncher *launcher,
724 const gchar * const *argv,
727 GSubprocess *subprocess;
729 g_return_val_if_fail (argv != NULL && argv[0] != NULL && argv[0][0] != '\0', NULL);
731 subprocess = g_object_new (G_TYPE_SUBPROCESS,
733 "flags", launcher->flags,
735 g_subprocess_set_launcher (subprocess, launcher);
737 if (!g_initable_init (G_INITABLE (subprocess), NULL, error))
739 g_object_unref (subprocess);