1 /* gspawn.c - Process launching
3 * Copyright 2000 Red Hat, Inc.
4 * g_execvpe implementation based on GNU libc execvp:
5 * Copyright 1991, 92, 95, 96, 97, 98, 99 Free Software Foundation, Inc.
7 * GLib is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2 of the
10 * License, or (at your option) any later version.
12 * GLib is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with GLib; see the file COPYING.LIB. If not, write
19 * to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
26 #include <sys/types.h>
34 #ifdef HAVE_SYS_SELECT_H
35 #include <sys/select.h>
36 #endif /* HAVE_SYS_SELECT_H */
43 /* With solaris threads, fork() duplicates all threads, which
44 * a) could cause unexpected side-effects, and b) is expensive.
45 * Once we remove support for solaris threads, the FORK1 #define
48 #ifdef G_THREADS_IMPL_SOLARIS
49 #define FORK1() fork1()
51 #define FORK1() fork()
54 static gint g_execute (const gchar *file,
57 gboolean search_path);
59 static gboolean make_pipe (gint p[2],
61 static gboolean fork_exec_with_pipes (gboolean intermediate_child,
62 const gchar *working_directory,
65 gboolean close_descriptors,
67 gboolean stdout_to_null,
68 gboolean stderr_to_null,
69 gboolean child_inherits_stdin,
70 gboolean file_and_argv_zero,
71 GSpawnChildSetupFunc child_setup,
75 gint *standard_output,
80 g_spawn_error_quark (void)
82 static GQuark quark = 0;
84 quark = g_quark_from_static_string ("g-exec-error-quark");
90 * @working_directory: child's current working directory, or %NULL to inherit parent's
91 * @argv: child's argument vector
92 * @envp: child's environment, or %NULL to inherit parent's
93 * @flags: flags from #GSpawnFlags
94 * @child_setup: function to run in the child just before exec()
95 * @user_data: user data for @child_setup
96 * @child_pid: return location for child process ID, or %NULL
97 * @error: return location for error
99 * See g_spawn_async_with_pipes() for a full description; this function
100 * simply calls the g_spawn_async_with_pipes() without any pipes.
102 * Return value: %TRUE on success, %FALSE if error is set
105 g_spawn_async (const gchar *working_directory,
109 GSpawnChildSetupFunc child_setup,
114 g_return_val_if_fail (argv != NULL, FALSE);
116 return g_spawn_async_with_pipes (working_directory,
126 /* Avoids a danger in threaded situations (calling close()
127 * on a file descriptor twice, and another thread has
128 * re-opened it since the first close)
131 close_and_invalidate (gint *fd)
148 READ_FAILED = 0, /* FALSE */
154 read_data (GString *str,
163 bytes = read (fd, buf, 4096);
169 g_string_append_len (str, buf, bytes);
172 else if (bytes < 0 && errno == EINTR)
179 _("Failed to read data from child process (%s)"),
190 * @working_directory: child's current working directory, or %NULL to inherit parent's
191 * @argv: child's argument vector
192 * @envp: child's environment, or %NULL to inherit parent's
193 * @flags: flags from #GSpawnFlags
194 * @child_setup: function to run in the child just before exec()
195 * @user_data: user data for @child_setup
196 * @standard_output: return location for child output
197 * @standard_error: return location for child error messages
198 * @exit_status: return location for child exit status, as returned by waitpid()
199 * @error: return location for error
201 * Executes a child synchronously (waits for the child to exit before returning).
202 * All output from the child is stored in @standard_output and @standard_error,
203 * if those parameters are non-%NULL. If @exit_status is non-%NULL, the exit
204 * status of the child is stored there as it would be returned by
205 * waitpid(); standard UNIX macros such as WIFEXITED() and WEXITSTATUS()
206 * must be used to evaluate the exit status. If an error occurs, no data is
207 * returned in @standard_output, @standard_error, or @exit_status.
209 * This function calls g_spawn_async_with_pipes() internally; see that
210 * function for full details on the other parameters and details on
211 * how these functions work on Windows.
213 * Return value: %TRUE on success, %FALSE if an error was set.
216 g_spawn_sync (const gchar *working_directory,
220 GSpawnChildSetupFunc child_setup,
222 gchar **standard_output,
223 gchar **standard_error,
232 GString *outstr = NULL;
233 GString *errstr = NULL;
237 g_return_val_if_fail (argv != NULL, FALSE);
238 g_return_val_if_fail (!(flags & G_SPAWN_DO_NOT_REAP_CHILD), FALSE);
239 g_return_val_if_fail (standard_output == NULL ||
240 !(flags & G_SPAWN_STDOUT_TO_DEV_NULL), FALSE);
241 g_return_val_if_fail (standard_error == NULL ||
242 !(flags & G_SPAWN_STDERR_TO_DEV_NULL), FALSE);
244 /* Just to ensure segfaults if callers try to use
245 * these when an error is reported.
248 *standard_output = NULL;
251 *standard_error = NULL;
253 if (!fork_exec_with_pipes (FALSE,
257 !(flags & G_SPAWN_LEAVE_DESCRIPTORS_OPEN),
258 (flags & G_SPAWN_SEARCH_PATH) != 0,
259 (flags & G_SPAWN_STDOUT_TO_DEV_NULL) != 0,
260 (flags & G_SPAWN_STDERR_TO_DEV_NULL) != 0,
261 (flags & G_SPAWN_CHILD_INHERITS_STDIN) != 0,
262 (flags & G_SPAWN_FILE_AND_ARGV_ZERO) != 0,
267 standard_output ? &outpipe : NULL,
268 standard_error ? &errpipe : NULL,
272 /* Read data from child. */
278 outstr = g_string_new (NULL);
283 errstr = g_string_new (NULL);
286 /* Read data until we get EOF on both pipes. */
295 FD_SET (outpipe, &fds);
297 FD_SET (errpipe, &fds);
299 ret = select (MAX (outpipe, errpipe) + 1,
302 NULL /* no timeout */);
304 if (ret < 0 && errno != EINTR)
311 _("Unexpected error in select() reading data from a child process (%s)"),
317 if (outpipe >= 0 && FD_ISSET (outpipe, &fds))
319 switch (read_data (outstr, outpipe, error))
325 close_and_invalidate (&outpipe);
336 if (errpipe >= 0 && FD_ISSET (errpipe, &fds))
338 switch (read_data (errstr, errpipe, error))
344 close_and_invalidate (&errpipe);
356 /* These should only be open still if we had an error. */
359 close_and_invalidate (&outpipe);
361 close_and_invalidate (&errpipe);
363 /* Wait for child to exit, even if we have
368 ret = waitpid (pid, &status, 0);
374 else if (errno == ECHILD)
378 g_warning ("In call to g_spawn_sync(), exit status of a child process was requested but SIGCHLD action was set to SIG_IGN and ECHILD was received by waitpid(), so exit status can't be returned. This is a bug in the program calling g_spawn_sync(); either don't request the exit status, or don't set the SIGCHLD action.");
382 /* We don't need the exit status. */
387 if (!failed) /* avoid error pileups */
394 _("Unexpected error in waitpid() (%s)"),
403 g_string_free (outstr, TRUE);
405 g_string_free (errstr, TRUE);
412 *exit_status = status;
415 *standard_output = g_string_free (outstr, FALSE);
418 *standard_error = g_string_free (errstr, FALSE);
425 * g_spawn_async_with_pipes:
426 * @working_directory: child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding
427 * @argv: child's argument vector, in the GLib file name encoding
428 * @envp: child's environment, or %NULL to inherit parent's, in the GLib file name encoding
429 * @flags: flags from #GSpawnFlags
430 * @child_setup: function to run in the child just before exec()
431 * @user_data: user data for @child_setup
432 * @child_pid: return location for child process ID, or %NULL
433 * @standard_input: return location for file descriptor to write to child's stdin, or %NULL
434 * @standard_output: return location for file descriptor to read child's stdout, or %NULL
435 * @standard_error: return location for file descriptor to read child's stderr, or %NULL
436 * @error: return location for error
438 * Executes a child program asynchronously (your program will not
439 * block waiting for the child to exit). The child program is
440 * specified by the only argument that must be provided, @argv. @argv
441 * should be a %NULL-terminated array of strings, to be passed as the
442 * argument vector for the child. The first string in @argv is of
443 * course the name of the program to execute. By default, the name of
444 * the program must be a full path; the <envar>PATH</envar> shell variable
445 * will only be searched if you pass the %G_SPAWN_SEARCH_PATH flag.
447 * On Windows, note that all the string or string vector arguments to
448 * this function and the other g_spawn*() functions are in UTF-8, the
449 * GLib file name encoding. Unicode characters that are not part of
450 * the system codepage passed in argument vectors will be correctly
451 * available in the spawned program only if it uses wide character API
452 * to retrieve its command line. For C programs built with Microsoft's
453 * tools it is enough to make the program have a wmain() instead of
454 * main(). wmain() has a wide character argument vector as parameter.
456 * At least currently, mingw doesn't support wmain(), so if you use
457 * mingw to develop the spawned program, it will have to call the
458 * undocumented function __wgetmainargs() to get the wide character
459 * argument vector and environment. See gspawn-win32-helper.c in the
460 * GLib sources or init.c in the mingw runtime sources for a prototype
461 * for that function. Alternatively, you can retrieve the Win32 system
462 * level wide character command line passed to the spawned program
463 * using the GetCommandLineW() function.
465 * On Windows the low-level child process creation API
466 * <function>CreateProcess()</function> doesn't use argument vectors,
467 * but a command line. The C runtime library's
468 * <function>spawn*()</function> family of functions (which
469 * g_spawn_async_with_pipes() eventually calls) paste the argument
470 * vector elements together into a command line, and the C runtime startup code
471 * does a corresponding reconstruction of an argument vector from the
472 * command line, to be passed to main(). Complications arise when you have
473 * argument vector elements that contain spaces of double quotes. The
474 * <function>spawn*()</function> functions don't do any quoting or
475 * escaping, but on the other hand the startup code does do unquoting
476 * and unescaping in order to enable receiving arguments with embedded
477 * spaces or double quotes. To work around this asymmetry,
478 * g_spawn_async_with_pipes() will do quoting and escaping on argument
479 * vector elements that need it before calling the C runtime
482 * @envp is a %NULL-terminated array of strings, where each string
483 * has the form <literal>KEY=VALUE</literal>. This will become
484 * the child's environment. If @envp is %NULL, the child inherits its
485 * parent's environment.
487 * @flags should be the bitwise OR of any flags you want to affect the
488 * function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that
489 * the child will not automatically be reaped; you must use a
490 * #GChildWatch source to be notified about the death of the child
491 * process. Eventually you must call g_spawn_close_pid() on the
492 * @child_pid, in order to free resources which may be associated
493 * with the child process. (On Unix, using a #GChildWatch source is
494 * equivalent to calling waitpid() or handling the %SIGCHLD signal
495 * manually. On Windows, calling g_spawn_close_pid() is equivalent
496 * to calling CloseHandle() on the process handle returned in
499 * %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file
500 * descriptors will be inherited by the child; otherwise all
501 * descriptors except stdin/stdout/stderr will be closed before
502 * calling exec() in the child. %G_SPAWN_SEARCH_PATH
503 * means that <literal>argv[0]</literal> need not be an absolute path, it
504 * will be looked for in the user's <envar>PATH</envar>.
505 * %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will
506 * be discarded, instead of going to the same location as the parent's
507 * standard output. If you use this flag, @standard_output must be %NULL.
508 * %G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error
509 * will be discarded, instead of going to the same location as the parent's
510 * standard error. If you use this flag, @standard_error must be %NULL.
511 * %G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's
512 * standard input (by default, the child's standard input is attached to
513 * /dev/null). If you use this flag, @standard_input must be %NULL.
514 * %G_SPAWN_FILE_AND_ARGV_ZERO means that the first element of @argv is
515 * the file to execute, while the remaining elements are the
516 * actual argument vector to pass to the file. Normally
517 * g_spawn_async_with_pipes() uses @argv[0] as the file to execute, and
518 * passes all of @argv to the child.
520 * @child_setup and @user_data are a function and user data. On POSIX
521 * platforms, the function is called in the child after GLib has
522 * performed all the setup it plans to perform (including creating
523 * pipes, closing file descriptors, etc.) but before calling
524 * exec(). That is, @child_setup is called just
525 * before calling exec() in the child. Obviously
526 * actions taken in this function will only affect the child, not the
527 * parent. On Windows, there is no separate fork() and exec()
528 * functionality. Child processes are created and run with
529 * a single API call, CreateProcess(). @child_setup is
530 * called in the parent process just before creating the child
531 * process. You should carefully consider what you do in @child_setup
532 * if you intend your software to be portable to Windows.
534 * If non-%NULL, @child_pid will on Unix be filled with the child's
535 * process ID. You can use the process ID to send signals to the
536 * child, or to waitpid() if you specified the
537 * %G_SPAWN_DO_NOT_REAP_CHILD flag. On Windows, @child_pid will be
538 * filled with a handle to the child process only if you specified the
539 * %G_SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child
540 * process using the Win32 API, for example wait for its termination
541 * with the <function>WaitFor*()</function> functions, or examine its
542 * exit code with GetExitCodeProcess(). You should close the handle
543 * with CloseHandle() or g_spawn_close_pid() when you no longer need it.
545 * If non-%NULL, the @standard_input, @standard_output, @standard_error
546 * locations will be filled with file descriptors for writing to the child's
547 * standard input or reading from its standard output or standard error.
548 * The caller of g_spawn_async_with_pipes() must close these file descriptors
549 * when they are no longer in use. If these parameters are %NULL, the corresponding
550 * pipe won't be created.
552 * If @standard_input is NULL, the child's standard input is attached to /dev/null
553 * unless %G_SPAWN_CHILD_INHERITS_STDIN is set.
555 * If @standard_error is NULL, the child's standard error goes to the same location
556 * as the parent's standard error unless %G_SPAWN_STDERR_TO_DEV_NULL is set.
558 * If @standard_output is NULL, the child's standard output goes to the same location
559 * as the parent's standard output unless %G_SPAWN_STDOUT_TO_DEV_NULL is set.
561 * @error can be %NULL to ignore errors, or non-%NULL to report errors.
562 * If an error is set, the function returns %FALSE. Errors
563 * are reported even if they occur in the child (for example if the
564 * executable in <literal>argv[0]</literal> is not found). Typically
565 * the <literal>message</literal> field of returned errors should be displayed
566 * to users. Possible errors are those from the #G_SPAWN_ERROR domain.
568 * If an error occurs, @child_pid, @standard_input, @standard_output,
569 * and @standard_error will not be filled with valid values.
571 * If @child_pid is not %NULL and an error does not occur then the returned
572 * pid must be closed using g_spawn_close_pid().
574 * Return value: %TRUE on success, %FALSE if an error was set
577 g_spawn_async_with_pipes (const gchar *working_directory,
581 GSpawnChildSetupFunc child_setup,
584 gint *standard_input,
585 gint *standard_output,
586 gint *standard_error,
589 g_return_val_if_fail (argv != NULL, FALSE);
590 g_return_val_if_fail (standard_output == NULL ||
591 !(flags & G_SPAWN_STDOUT_TO_DEV_NULL), FALSE);
592 g_return_val_if_fail (standard_error == NULL ||
593 !(flags & G_SPAWN_STDERR_TO_DEV_NULL), FALSE);
594 /* can't inherit stdin if we have an input pipe. */
595 g_return_val_if_fail (standard_input == NULL ||
596 !(flags & G_SPAWN_CHILD_INHERITS_STDIN), FALSE);
598 return fork_exec_with_pipes (!(flags & G_SPAWN_DO_NOT_REAP_CHILD),
602 !(flags & G_SPAWN_LEAVE_DESCRIPTORS_OPEN),
603 (flags & G_SPAWN_SEARCH_PATH) != 0,
604 (flags & G_SPAWN_STDOUT_TO_DEV_NULL) != 0,
605 (flags & G_SPAWN_STDERR_TO_DEV_NULL) != 0,
606 (flags & G_SPAWN_CHILD_INHERITS_STDIN) != 0,
607 (flags & G_SPAWN_FILE_AND_ARGV_ZERO) != 0,
618 * g_spawn_command_line_sync:
619 * @command_line: a command line
620 * @standard_output: return location for child output
621 * @standard_error: return location for child errors
622 * @exit_status: return location for child exit status, as returned by waitpid()
623 * @error: return location for errors
625 * A simple version of g_spawn_sync() with little-used parameters
626 * removed, taking a command line instead of an argument vector. See
627 * g_spawn_sync() for full details. @command_line will be parsed by
628 * g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag
629 * is enabled. Note that %G_SPAWN_SEARCH_PATH can have security
630 * implications, so consider using g_spawn_sync() directly if
631 * appropriate. Possible errors are those from g_spawn_sync() and those
632 * from g_shell_parse_argv().
634 * If @exit_status is non-%NULL, the exit status of the child is stored there as
635 * it would be returned by waitpid(); standard UNIX macros such as WIFEXITED()
636 * and WEXITSTATUS() must be used to evaluate the exit status.
638 * On Windows, please note the implications of g_shell_parse_argv()
639 * parsing @command_line. Parsing is done according to Unix shell rules, not
640 * Windows command interpreter rules.
641 * Space is a separator, and backslashes are
642 * special. Thus you cannot simply pass a @command_line containing
643 * canonical Windows paths, like "c:\\program files\\app\\app.exe", as
644 * the backslashes will be eaten, and the space will act as a
645 * separator. You need to enclose such paths with single quotes, like
646 * "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'".
648 * Return value: %TRUE on success, %FALSE if an error was set
651 g_spawn_command_line_sync (const gchar *command_line,
652 gchar **standard_output,
653 gchar **standard_error,
660 g_return_val_if_fail (command_line != NULL, FALSE);
662 if (!g_shell_parse_argv (command_line,
667 retval = g_spawn_sync (NULL,
683 * g_spawn_command_line_async:
684 * @command_line: a command line
685 * @error: return location for errors
687 * A simple version of g_spawn_async() that parses a command line with
688 * g_shell_parse_argv() and passes it to g_spawn_async(). Runs a
689 * command line in the background. Unlike g_spawn_async(), the
690 * %G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note
691 * that %G_SPAWN_SEARCH_PATH can have security implications, so
692 * consider using g_spawn_async() directly if appropriate. Possible
693 * errors are those from g_shell_parse_argv() and g_spawn_async().
695 * The same concerns on Windows apply as for g_spawn_command_line_sync().
697 * Return value: %TRUE on success, %FALSE if error is set.
700 g_spawn_command_line_async (const gchar *command_line,
706 g_return_val_if_fail (command_line != NULL, FALSE);
708 if (!g_shell_parse_argv (command_line,
713 retval = g_spawn_async (NULL,
727 exec_err_to_g_error (gint en)
733 return G_SPAWN_ERROR_ACCES;
739 return G_SPAWN_ERROR_PERM;
745 return G_SPAWN_ERROR_2BIG;
751 return G_SPAWN_ERROR_NOEXEC;
757 return G_SPAWN_ERROR_NAMETOOLONG;
763 return G_SPAWN_ERROR_NOENT;
769 return G_SPAWN_ERROR_NOMEM;
775 return G_SPAWN_ERROR_NOTDIR;
781 return G_SPAWN_ERROR_LOOP;
787 return G_SPAWN_ERROR_TXTBUSY;
793 return G_SPAWN_ERROR_IO;
799 return G_SPAWN_ERROR_NFILE;
805 return G_SPAWN_ERROR_MFILE;
811 return G_SPAWN_ERROR_INVAL;
817 return G_SPAWN_ERROR_ISDIR;
823 return G_SPAWN_ERROR_LIBBAD;
828 return G_SPAWN_ERROR_FAILED;
834 write_all (gint fd, gconstpointer vbuf, gsize to_write)
836 gchar *buf = (gchar *) vbuf;
840 gssize count = write (fd, buf, to_write);
857 write_err_and_exit (gint fd, gint msg)
861 write_all (fd, &msg, sizeof(msg));
862 write_all (fd, &en, sizeof(en));
868 set_cloexec (gint fd)
870 fcntl (fd, F_SETFD, FD_CLOEXEC);
874 sane_dup2 (gint fd1, gint fd2)
879 ret = dup2 (fd1, fd2);
880 if (ret < 0 && errno == EINTR)
895 do_exec (gint child_err_report_fd,
899 const gchar *working_directory,
902 gboolean close_descriptors,
903 gboolean search_path,
904 gboolean stdout_to_null,
905 gboolean stderr_to_null,
906 gboolean child_inherits_stdin,
907 gboolean file_and_argv_zero,
908 GSpawnChildSetupFunc child_setup,
911 if (working_directory && chdir (working_directory) < 0)
912 write_err_and_exit (child_err_report_fd,
915 /* Close all file descriptors but stdin stdout and stderr as
916 * soon as we exec. Note that this includes
917 * child_err_report_fd, which keeps the parent from blocking
918 * forever on the other end of that pipe.
920 if (close_descriptors)
925 open_max = sysconf (_SC_OPEN_MAX);
926 for (i = 3; i < open_max; i++)
931 /* We need to do child_err_report_fd anyway */
932 set_cloexec (child_err_report_fd);
935 /* Redirect pipes as required */
939 /* dup2 can't actually fail here I don't think */
941 if (sane_dup2 (stdin_fd, 0) < 0)
942 write_err_and_exit (child_err_report_fd,
945 /* ignore this if it doesn't work */
946 close_and_invalidate (&stdin_fd);
948 else if (!child_inherits_stdin)
950 /* Keep process from blocking on a read of stdin */
951 gint read_null = open ("/dev/null", O_RDONLY);
952 sane_dup2 (read_null, 0);
953 close_and_invalidate (&read_null);
958 /* dup2 can't actually fail here I don't think */
960 if (sane_dup2 (stdout_fd, 1) < 0)
961 write_err_and_exit (child_err_report_fd,
964 /* ignore this if it doesn't work */
965 close_and_invalidate (&stdout_fd);
967 else if (stdout_to_null)
969 gint write_null = open ("/dev/null", O_WRONLY);
970 sane_dup2 (write_null, 1);
971 close_and_invalidate (&write_null);
976 /* dup2 can't actually fail here I don't think */
978 if (sane_dup2 (stderr_fd, 2) < 0)
979 write_err_and_exit (child_err_report_fd,
982 /* ignore this if it doesn't work */
983 close_and_invalidate (&stderr_fd);
985 else if (stderr_to_null)
987 gint write_null = open ("/dev/null", O_WRONLY);
988 sane_dup2 (write_null, 2);
989 close_and_invalidate (&write_null);
992 /* Call user function just before we exec */
995 (* child_setup) (user_data);
999 file_and_argv_zero ? argv + 1 : argv,
1003 write_err_and_exit (child_err_report_fd,
1020 if (bytes >= sizeof(gint)*2)
1021 break; /* give up, who knows what happened, should not be
1027 ((gchar*)buf) + bytes,
1028 sizeof(gint) * n_ints_in_buf - bytes);
1029 if (chunk < 0 && errno == EINTR)
1034 /* Some weird shit happened, bail out */
1038 G_SPAWN_ERROR_FAILED,
1039 _("Failed to read from child pipe (%s)"),
1040 g_strerror (errno));
1044 else if (chunk == 0)
1046 else /* chunk > 0 */
1050 *n_ints_read = (gint)(bytes / sizeof(gint));
1056 fork_exec_with_pipes (gboolean intermediate_child,
1057 const gchar *working_directory,
1060 gboolean close_descriptors,
1061 gboolean search_path,
1062 gboolean stdout_to_null,
1063 gboolean stderr_to_null,
1064 gboolean child_inherits_stdin,
1065 gboolean file_and_argv_zero,
1066 GSpawnChildSetupFunc child_setup,
1069 gint *standard_input,
1070 gint *standard_output,
1071 gint *standard_error,
1075 gint stdin_pipe[2] = { -1, -1 };
1076 gint stdout_pipe[2] = { -1, -1 };
1077 gint stderr_pipe[2] = { -1, -1 };
1078 gint child_err_report_pipe[2] = { -1, -1 };
1079 gint child_pid_report_pipe[2] = { -1, -1 };
1082 if (!make_pipe (child_err_report_pipe, error))
1085 if (intermediate_child && !make_pipe (child_pid_report_pipe, error))
1086 goto cleanup_and_fail;
1088 if (standard_input && !make_pipe (stdin_pipe, error))
1089 goto cleanup_and_fail;
1091 if (standard_output && !make_pipe (stdout_pipe, error))
1092 goto cleanup_and_fail;
1094 if (standard_error && !make_pipe (stderr_pipe, error))
1095 goto cleanup_and_fail;
1104 _("Failed to fork (%s)"),
1105 g_strerror (errno));
1107 goto cleanup_and_fail;
1111 /* Immediate child. This may or may not be the child that
1112 * actually execs the new process.
1115 /* Be sure we crash if the parent exits
1116 * and we write to the err_report_pipe
1118 signal (SIGPIPE, SIG_DFL);
1120 /* Close the parent's end of the pipes;
1121 * not needed in the close_descriptors case,
1124 close_and_invalidate (&child_err_report_pipe[0]);
1125 close_and_invalidate (&child_pid_report_pipe[0]);
1126 close_and_invalidate (&stdin_pipe[1]);
1127 close_and_invalidate (&stdout_pipe[0]);
1128 close_and_invalidate (&stderr_pipe[0]);
1130 if (intermediate_child)
1132 /* We need to fork an intermediate child that launches the
1133 * final child. The purpose of the intermediate child
1134 * is to exit, so we can waitpid() it immediately.
1135 * Then the grandchild will not become a zombie.
1137 GPid grandchild_pid;
1139 grandchild_pid = FORK1 ();
1141 if (grandchild_pid < 0)
1143 /* report -1 as child PID */
1144 write_all (child_pid_report_pipe[1], &grandchild_pid,
1145 sizeof(grandchild_pid));
1147 write_err_and_exit (child_err_report_pipe[1],
1150 else if (grandchild_pid == 0)
1152 do_exec (child_err_report_pipe[1],
1163 child_inherits_stdin,
1170 write_all (child_pid_report_pipe[1], &grandchild_pid, sizeof(grandchild_pid));
1171 close_and_invalidate (&child_pid_report_pipe[1]);
1178 /* Just run the child.
1181 do_exec (child_err_report_pipe[1],
1192 child_inherits_stdin,
1205 /* Close the uncared-about ends of the pipes */
1206 close_and_invalidate (&child_err_report_pipe[1]);
1207 close_and_invalidate (&child_pid_report_pipe[1]);
1208 close_and_invalidate (&stdin_pipe[0]);
1209 close_and_invalidate (&stdout_pipe[1]);
1210 close_and_invalidate (&stderr_pipe[1]);
1212 /* If we had an intermediate child, reap it */
1213 if (intermediate_child)
1216 if (waitpid (pid, &status, 0) < 0)
1220 else if (errno == ECHILD)
1221 ; /* do nothing, child already reaped */
1223 g_warning ("waitpid() should not fail in "
1224 "'fork_exec_with_pipes'");
1229 if (!read_ints (child_err_report_pipe[0],
1232 goto cleanup_and_fail;
1236 /* Error from the child. */
1240 case CHILD_CHDIR_FAILED:
1243 G_SPAWN_ERROR_CHDIR,
1244 _("Failed to change to directory '%s' (%s)"),
1246 g_strerror (buf[1]));
1250 case CHILD_EXEC_FAILED:
1253 exec_err_to_g_error (buf[1]),
1254 _("Failed to execute child process \"%s\" (%s)"),
1256 g_strerror (buf[1]));
1260 case CHILD_DUP2_FAILED:
1263 G_SPAWN_ERROR_FAILED,
1264 _("Failed to redirect output or input of child process (%s)"),
1265 g_strerror (buf[1]));
1269 case CHILD_FORK_FAILED:
1273 _("Failed to fork child process (%s)"),
1274 g_strerror (buf[1]));
1280 G_SPAWN_ERROR_FAILED,
1281 _("Unknown error executing child process \"%s\""),
1286 goto cleanup_and_fail;
1289 /* Get child pid from intermediate child pipe. */
1290 if (intermediate_child)
1294 if (!read_ints (child_pid_report_pipe[0],
1295 buf, 1, &n_ints, error))
1296 goto cleanup_and_fail;
1302 G_SPAWN_ERROR_FAILED,
1303 _("Failed to read enough data from child pid pipe (%s)"),
1304 g_strerror (errno));
1305 goto cleanup_and_fail;
1309 /* we have the child pid */
1314 /* Success against all odds! return the information */
1315 close_and_invalidate (&child_err_report_pipe[0]);
1316 close_and_invalidate (&child_pid_report_pipe[0]);
1322 *standard_input = stdin_pipe[1];
1323 if (standard_output)
1324 *standard_output = stdout_pipe[0];
1326 *standard_error = stderr_pipe[0];
1333 /* There was an error from the Child, reap the child to avoid it being
1340 if (waitpid (pid, NULL, 0) < 0)
1344 else if (errno == ECHILD)
1345 ; /* do nothing, child already reaped */
1347 g_warning ("waitpid() should not fail in "
1348 "'fork_exec_with_pipes'");
1352 close_and_invalidate (&child_err_report_pipe[0]);
1353 close_and_invalidate (&child_err_report_pipe[1]);
1354 close_and_invalidate (&child_pid_report_pipe[0]);
1355 close_and_invalidate (&child_pid_report_pipe[1]);
1356 close_and_invalidate (&stdin_pipe[0]);
1357 close_and_invalidate (&stdin_pipe[1]);
1358 close_and_invalidate (&stdout_pipe[0]);
1359 close_and_invalidate (&stdout_pipe[1]);
1360 close_and_invalidate (&stderr_pipe[0]);
1361 close_and_invalidate (&stderr_pipe[1]);
1367 make_pipe (gint p[2],
1374 G_SPAWN_ERROR_FAILED,
1375 _("Failed to create pipe for communicating with child process (%s)"),
1376 g_strerror (errno));
1383 /* Based on execvp from GNU C Library */
1386 script_execute (const gchar *file,
1389 gboolean search_path)
1391 /* Count the arguments. */
1396 /* Construct an argument list for the shell. */
1400 new_argv = g_new0 (gchar*, argc + 2); /* /bin/sh and NULL */
1402 new_argv[0] = (char *) "/bin/sh";
1403 new_argv[1] = (char *) file;
1406 new_argv[argc + 1] = argv[argc];
1410 /* Execute the shell. */
1412 execve (new_argv[0], new_argv, envp);
1414 execv (new_argv[0], new_argv);
1421 my_strchrnul (const gchar *str, gchar c)
1423 gchar *p = (gchar*) str;
1424 while (*p && (*p != c))
1431 g_execute (const gchar *file,
1434 gboolean search_path)
1438 /* We check the simple case first. */
1443 if (!search_path || strchr (file, '/') != NULL)
1445 /* Don't search when it contains a slash. */
1447 execve (file, argv, envp);
1451 if (errno == ENOEXEC)
1452 script_execute (file, argv, envp, FALSE);
1456 gboolean got_eacces = 0;
1457 const gchar *path, *p;
1458 gchar *name, *freeme;
1462 path = g_getenv ("PATH");
1465 /* There is no `PATH' in the environment. The default
1466 * search path in libc is the current directory followed by
1467 * the path `confstr' returns for `_CS_PATH'.
1470 /* In GLib we put . last, for security, and don't use the
1471 * unportable confstr(); UNIX98 does not actually specify
1472 * what to search if PATH is unset. POSIX may, dunno.
1475 path = "/bin:/usr/bin:.";
1478 len = strlen (file) + 1;
1479 pathlen = strlen (path);
1480 freeme = name = g_malloc (pathlen + len + 1);
1482 /* Copy the file name at the top, including '\0' */
1483 memcpy (name + pathlen + 1, file, len);
1484 name = name + pathlen;
1485 /* And add the slash before the filename */
1494 p = my_strchrnul (path, ':');
1497 /* Two adjacent colons, or a colon at the beginning or the end
1498 * of `PATH' means to search the current directory.
1502 startp = memcpy (name - (p - path), path, p - path);
1504 /* Try to execute this name. If it works, execv will not return. */
1506 execve (startp, argv, envp);
1508 execv (startp, argv);
1510 if (errno == ENOEXEC)
1511 script_execute (startp, argv, envp, search_path);
1516 /* Record the we got a `Permission denied' error. If we end
1517 * up finding no executable we can use, we want to diagnose
1518 * that we did find one but were denied access.
1531 /* Those errors indicate the file is missing or not executable
1532 * by us, in which case we want to just try the next path
1538 /* Some other error means we found an executable file, but
1539 * something went wrong executing it; return the error to our
1546 while (*p++ != '\0');
1548 /* We tried every element and none of them worked. */
1550 /* At least one failure was due to permissions, so report that
1558 /* Return the error from the last attempt (probably ENOENT). */
1563 * g_spawn_close_pid:
1564 * @pid: The process identifier to close
1566 * On some platforms, notably WIN32, the #GPid type represents a resource
1567 * which must be closed to prevent resource leaking. g_spawn_close_pid()
1568 * is provided for this purpose. It should be used on all platforms, even
1569 * though it doesn't do anything under UNIX.
1572 g_spawn_close_pid (GPid pid)
1576 #define __G_SPAWN_C__
1577 #include "galiasdef.c"