2 #include "run-command.h"
6 #include "thread-utils.h"
8 #include "string-list.h"
14 void child_process_init(struct child_process
*child
)
16 struct child_process blank
= CHILD_PROCESS_INIT
;
17 memcpy(child
, &blank
, sizeof(*child
));
20 void child_process_clear(struct child_process
*child
)
22 strvec_clear(&child
->args
);
23 strvec_clear(&child
->env_array
);
26 struct child_to_clean
{
28 struct child_process
*process
;
29 struct child_to_clean
*next
;
31 static struct child_to_clean
*children_to_clean
;
32 static int installed_child_cleanup_handler
;
34 static void cleanup_children(int sig
, int in_signal
)
36 struct child_to_clean
*children_to_wait_for
= NULL
;
38 while (children_to_clean
) {
39 struct child_to_clean
*p
= children_to_clean
;
40 children_to_clean
= p
->next
;
42 if (p
->process
&& !in_signal
) {
43 struct child_process
*process
= p
->process
;
44 if (process
->clean_on_exit_handler
) {
46 "trace: run_command: running exit handler for pid %"
47 PRIuMAX
, (uintmax_t)p
->pid
49 process
->clean_on_exit_handler(process
);
55 if (p
->process
&& p
->process
->wait_after_clean
) {
56 p
->next
= children_to_wait_for
;
57 children_to_wait_for
= p
;
64 while (children_to_wait_for
) {
65 struct child_to_clean
*p
= children_to_wait_for
;
66 children_to_wait_for
= p
->next
;
68 while (waitpid(p
->pid
, NULL
, 0) < 0 && errno
== EINTR
)
69 ; /* spin waiting for process exit or error */
76 static void cleanup_children_on_signal(int sig
)
78 cleanup_children(sig
, 1);
83 static void cleanup_children_on_exit(void)
85 cleanup_children(SIGTERM
, 0);
88 static void mark_child_for_cleanup(pid_t pid
, struct child_process
*process
)
90 struct child_to_clean
*p
= xmalloc(sizeof(*p
));
93 p
->next
= children_to_clean
;
94 children_to_clean
= p
;
96 if (!installed_child_cleanup_handler
) {
97 atexit(cleanup_children_on_exit
);
98 sigchain_push_common(cleanup_children_on_signal
);
99 installed_child_cleanup_handler
= 1;
103 static void clear_child_for_cleanup(pid_t pid
)
105 struct child_to_clean
**pp
;
107 for (pp
= &children_to_clean
; *pp
; pp
= &(*pp
)->next
) {
108 struct child_to_clean
*clean_me
= *pp
;
110 if (clean_me
->pid
== pid
) {
111 *pp
= clean_me
->next
;
118 static inline void close_pair(int fd
[2])
124 int is_executable(const char *name
)
128 if (stat(name
, &st
) || /* stat, not lstat */
129 !S_ISREG(st
.st_mode
))
132 #if defined(GIT_WINDOWS_NATIVE)
134 * On Windows there is no executable bit. The file extension
135 * indicates whether it can be run as an executable, and Git
136 * has special-handling to detect scripts and launch them
137 * through the indicated script interpreter. We test for the
138 * file extension first because virus scanners may make
139 * it quite expensive to open many files.
141 if (ends_with(name
, ".exe"))
146 * Now that we know it does not have an executable extension,
147 * peek into the file instead.
151 int fd
= open(name
, O_RDONLY
);
152 st
.st_mode
&= ~S_IXUSR
;
154 n
= read(fd
, buf
, 2);
156 /* look for a she-bang */
157 if (!strcmp(buf
, "#!"))
158 st
.st_mode
|= S_IXUSR
;
163 return st
.st_mode
& S_IXUSR
;
167 * Search $PATH for a command. This emulates the path search that
168 * execvp would perform, without actually executing the command so it
169 * can be used before fork() to prepare to run a command using
170 * execve() or after execvp() to diagnose why it failed.
172 * The caller should ensure that file contains no directory
175 * Returns the path to the command, as found in $PATH or NULL if the
176 * command could not be found. The caller inherits ownership of the memory
177 * used to store the resultant path.
179 * This should not be used on Windows, where the $PATH search rules
180 * are more complicated (e.g., a search for "foo" should find
183 static char *locate_in_PATH(const char *file
)
185 const char *p
= getenv("PATH");
186 struct strbuf buf
= STRBUF_INIT
;
192 const char *end
= strchrnul(p
, ':');
196 /* POSIX specifies an empty entry as the current directory. */
198 strbuf_add(&buf
, p
, end
- p
);
199 strbuf_addch(&buf
, '/');
201 strbuf_addstr(&buf
, file
);
203 if (is_executable(buf
.buf
))
204 return strbuf_detach(&buf
, NULL
);
211 strbuf_release(&buf
);
215 int exists_in_PATH(const char *command
)
217 char *r
= locate_in_PATH(command
);
218 int found
= r
!= NULL
;
223 int sane_execvp(const char *file
, char * const argv
[])
225 #ifndef GIT_WINDOWS_NATIVE
227 * execvp() doesn't return, so we all we can do is tell trace2
228 * what we are about to do and let it leave a hint in the log
229 * (unless of course the execvp() fails).
231 * we skip this for Windows because the compat layer already
232 * has to emulate the execvp() call anyway.
234 int exec_id
= trace2_exec(file
, (const char **)argv
);
237 if (!execvp(file
, argv
))
238 return 0; /* cannot happen ;-) */
240 #ifndef GIT_WINDOWS_NATIVE
243 trace2_exec_result(exec_id
, ec
);
249 * When a command can't be found because one of the directories
250 * listed in $PATH is unsearchable, execvp reports EACCES, but
251 * careful usability testing (read: analysis of occasional bug
252 * reports) reveals that "No such file or directory" is more
255 * We avoid commands with "/", because execvp will not do $PATH
256 * lookups in that case.
258 * The reassignment of EACCES to errno looks like a no-op below,
259 * but we need to protect against exists_in_PATH overwriting errno.
261 if (errno
== EACCES
&& !strchr(file
, '/'))
262 errno
= exists_in_PATH(file
) ? EACCES
: ENOENT
;
263 else if (errno
== ENOTDIR
&& !strchr(file
, '/'))
268 static const char **prepare_shell_cmd(struct strvec
*out
, const char **argv
)
271 BUG("shell command is empty");
273 if (strcspn(argv
[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv
[0])) {
274 #ifndef GIT_WINDOWS_NATIVE
275 strvec_push(out
, SHELL_PATH
);
277 strvec_push(out
, "sh");
279 strvec_push(out
, "-c");
282 * If we have no extra arguments, we do not even need to
283 * bother with the "$@" magic.
286 strvec_push(out
, argv
[0]);
288 strvec_pushf(out
, "%s \"$@\"", argv
[0]);
291 strvec_pushv(out
, argv
);
295 #ifndef GIT_WINDOWS_NATIVE
296 static int child_notifier
= -1;
302 CHILD_ERR_SIGPROCMASK
,
309 enum child_errcode err
;
310 int syserr
; /* errno */
313 static void child_die(enum child_errcode err
)
315 struct child_err buf
;
320 /* write(2) on buf smaller than PIPE_BUF (min 512) is atomic: */
321 xwrite(child_notifier
, &buf
, sizeof(buf
));
325 static void child_dup2(int fd
, int to
)
327 if (dup2(fd
, to
) < 0)
328 child_die(CHILD_ERR_DUP2
);
331 static void child_close(int fd
)
334 child_die(CHILD_ERR_CLOSE
);
337 static void child_close_pair(int fd
[2])
344 * parent will make it look like the child spewed a fatal error and died
345 * this is needed to prevent changes to t0061.
347 static void fake_fatal(const char *err
, va_list params
)
349 vreportf("fatal: ", err
, params
);
352 static void child_error_fn(const char *err
, va_list params
)
354 const char msg
[] = "error() should not be called in child\n";
355 xwrite(2, msg
, sizeof(msg
) - 1);
358 static void child_warn_fn(const char *err
, va_list params
)
360 const char msg
[] = "warn() should not be called in child\n";
361 xwrite(2, msg
, sizeof(msg
) - 1);
364 static void NORETURN
child_die_fn(const char *err
, va_list params
)
366 const char msg
[] = "die() should not be called in child\n";
367 xwrite(2, msg
, sizeof(msg
) - 1);
371 /* this runs in the parent process */
372 static void child_err_spew(struct child_process
*cmd
, struct child_err
*cerr
)
374 static void (*old_errfn
)(const char *err
, va_list params
);
376 old_errfn
= get_error_routine();
377 set_error_routine(fake_fatal
);
378 errno
= cerr
->syserr
;
381 case CHILD_ERR_CHDIR
:
382 error_errno("exec '%s': cd to '%s' failed",
383 cmd
->argv
[0], cmd
->dir
);
386 error_errno("dup2() in child failed");
388 case CHILD_ERR_CLOSE
:
389 error_errno("close() in child failed");
391 case CHILD_ERR_SIGPROCMASK
:
392 error_errno("sigprocmask failed restoring signals");
394 case CHILD_ERR_ENOENT
:
395 error_errno("cannot run %s", cmd
->argv
[0]);
397 case CHILD_ERR_SILENT
:
399 case CHILD_ERR_ERRNO
:
400 error_errno("cannot exec '%s'", cmd
->argv
[0]);
403 set_error_routine(old_errfn
);
406 static int prepare_cmd(struct strvec
*out
, const struct child_process
*cmd
)
409 BUG("command is empty");
412 * Add SHELL_PATH so in the event exec fails with ENOEXEC we can
413 * attempt to interpret the command with 'sh'.
415 strvec_push(out
, SHELL_PATH
);
418 prepare_git_cmd(out
, cmd
->argv
);
419 } else if (cmd
->use_shell
) {
420 prepare_shell_cmd(out
, cmd
->argv
);
422 strvec_pushv(out
, cmd
->argv
);
426 * If there are no dir separator characters in the command then perform
427 * a path lookup and use the resolved path as the command to exec. If
428 * there are dir separator characters, we have exec attempt to invoke
429 * the command directly.
431 if (!has_dir_sep(out
->v
[1])) {
432 char *program
= locate_in_PATH(out
->v
[1]);
434 free((char *)out
->v
[1]);
446 static char **prep_childenv(const char *const *deltaenv
)
448 extern char **environ
;
450 struct string_list env
= STRING_LIST_INIT_DUP
;
451 struct strbuf key
= STRBUF_INIT
;
452 const char *const *p
;
455 /* Construct a sorted string list consisting of the current environ */
456 for (p
= (const char *const *) environ
; p
&& *p
; p
++) {
457 const char *equals
= strchr(*p
, '=');
461 strbuf_add(&key
, *p
, equals
- *p
);
462 string_list_append(&env
, key
.buf
)->util
= (void *) *p
;
464 string_list_append(&env
, *p
)->util
= (void *) *p
;
467 string_list_sort(&env
);
469 /* Merge in 'deltaenv' with the current environ */
470 for (p
= deltaenv
; p
&& *p
; p
++) {
471 const char *equals
= strchr(*p
, '=');
474 /* ('key=value'), insert or replace entry */
476 strbuf_add(&key
, *p
, equals
- *p
);
477 string_list_insert(&env
, key
.buf
)->util
= (void *) *p
;
479 /* otherwise ('key') remove existing entry */
480 string_list_remove(&env
, *p
, 0);
484 /* Create an array of 'char *' to be used as the childenv */
485 ALLOC_ARRAY(childenv
, env
.nr
+ 1);
486 for (i
= 0; i
< env
.nr
; i
++)
487 childenv
[i
] = env
.items
[i
].util
;
488 childenv
[env
.nr
] = NULL
;
490 string_list_clear(&env
, 0);
491 strbuf_release(&key
);
495 struct atfork_state
{
502 #define CHECK_BUG(err, msg) \
506 BUG("%s: %s", msg, strerror(e)); \
509 static void atfork_prepare(struct atfork_state
*as
)
513 if (sigfillset(&all
))
514 die_errno("sigfillset");
516 if (sigprocmask(SIG_SETMASK
, &all
, &as
->old
))
517 die_errno("sigprocmask");
519 CHECK_BUG(pthread_sigmask(SIG_SETMASK
, &all
, &as
->old
),
520 "blocking all signals");
521 CHECK_BUG(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE
, &as
->cs
),
522 "disabling cancellation");
526 static void atfork_parent(struct atfork_state
*as
)
529 if (sigprocmask(SIG_SETMASK
, &as
->old
, NULL
))
530 die_errno("sigprocmask");
532 CHECK_BUG(pthread_setcancelstate(as
->cs
, NULL
),
533 "re-enabling cancellation");
534 CHECK_BUG(pthread_sigmask(SIG_SETMASK
, &as
->old
, NULL
),
535 "restoring signal mask");
538 #endif /* GIT_WINDOWS_NATIVE */
540 static inline void set_cloexec(int fd
)
542 int flags
= fcntl(fd
, F_GETFD
);
544 fcntl(fd
, F_SETFD
, flags
| FD_CLOEXEC
);
547 static int wait_or_whine(pid_t pid
, const char *argv0
, int in_signal
)
549 int status
, code
= -1;
551 int failed_errno
= 0;
553 while ((waiting
= waitpid(pid
, &status
, 0)) < 0 && errno
== EINTR
)
557 failed_errno
= errno
;
559 error_errno("waitpid for %s failed", argv0
);
560 } else if (waiting
!= pid
) {
562 error("waitpid is confused (%s)", argv0
);
563 } else if (WIFSIGNALED(status
)) {
564 code
= WTERMSIG(status
);
565 if (!in_signal
&& code
!= SIGINT
&& code
!= SIGQUIT
&& code
!= SIGPIPE
)
566 error("%s died of signal %d", argv0
, code
);
568 * This return value is chosen so that code & 0xff
569 * mimics the exit code that a POSIX shell would report for
570 * a program that died from this signal.
573 } else if (WIFEXITED(status
)) {
574 code
= WEXITSTATUS(status
);
577 error("waitpid is confused (%s)", argv0
);
581 clear_child_for_cleanup(pid
);
583 errno
= failed_errno
;
587 static void trace_add_env(struct strbuf
*dst
, const char *const *deltaenv
)
589 struct string_list envs
= STRING_LIST_INIT_DUP
;
590 const char *const *e
;
592 int printed_unset
= 0;
594 /* Last one wins, see run-command.c:prep_childenv() for context */
595 for (e
= deltaenv
; e
&& *e
; e
++) {
596 struct strbuf key
= STRBUF_INIT
;
597 char *equals
= strchr(*e
, '=');
600 strbuf_add(&key
, *e
, equals
- *e
);
601 string_list_insert(&envs
, key
.buf
)->util
= equals
+ 1;
603 string_list_insert(&envs
, *e
)->util
= NULL
;
605 strbuf_release(&key
);
608 /* "unset X Y...;" */
609 for (i
= 0; i
< envs
.nr
; i
++) {
610 const char *var
= envs
.items
[i
].string
;
611 const char *val
= envs
.items
[i
].util
;
613 if (val
|| !getenv(var
))
616 if (!printed_unset
) {
617 strbuf_addstr(dst
, " unset");
620 strbuf_addf(dst
, " %s", var
);
623 strbuf_addch(dst
, ';');
625 /* ... followed by "A=B C=D ..." */
626 for (i
= 0; i
< envs
.nr
; i
++) {
627 const char *var
= envs
.items
[i
].string
;
628 const char *val
= envs
.items
[i
].util
;
634 oldval
= getenv(var
);
635 if (oldval
&& !strcmp(val
, oldval
))
638 strbuf_addf(dst
, " %s=", var
);
639 sq_quote_buf_pretty(dst
, val
);
641 string_list_clear(&envs
, 0);
644 static void trace_run_command(const struct child_process
*cp
)
646 struct strbuf buf
= STRBUF_INIT
;
648 if (!trace_want(&trace_default_key
))
651 strbuf_addstr(&buf
, "trace: run_command:");
653 strbuf_addstr(&buf
, " cd ");
654 sq_quote_buf_pretty(&buf
, cp
->dir
);
655 strbuf_addch(&buf
, ';');
658 * The caller is responsible for initializing cp->env from
659 * cp->env_array if needed. We only check one place.
662 trace_add_env(&buf
, cp
->env
);
664 strbuf_addstr(&buf
, " git");
665 sq_quote_argv_pretty(&buf
, cp
->argv
);
667 trace_printf("%s", buf
.buf
);
668 strbuf_release(&buf
);
671 int start_command(struct child_process
*cmd
)
673 int need_in
, need_out
, need_err
;
674 int fdin
[2], fdout
[2], fderr
[2];
679 cmd
->argv
= cmd
->args
.v
;
681 cmd
->env
= cmd
->env_array
.v
;
684 * In case of errors we must keep the promise to close FDs
685 * that have been passed in via ->in and ->out.
688 need_in
= !cmd
->no_stdin
&& cmd
->in
< 0;
690 if (pipe(fdin
) < 0) {
691 failed_errno
= errno
;
694 str
= "standard input";
700 need_out
= !cmd
->no_stdout
701 && !cmd
->stdout_to_stderr
704 if (pipe(fdout
) < 0) {
705 failed_errno
= errno
;
710 str
= "standard output";
716 need_err
= !cmd
->no_stderr
&& cmd
->err
< 0;
718 if (pipe(fderr
) < 0) {
719 failed_errno
= errno
;
728 str
= "standard error";
730 error("cannot create %s pipe for %s: %s",
731 str
, cmd
->argv
[0], strerror(failed_errno
));
732 child_process_clear(cmd
);
733 errno
= failed_errno
;
739 trace2_child_start(cmd
);
740 trace_run_command(cmd
);
744 if (cmd
->close_object_store
)
745 close_object_store(the_repository
->objects
);
747 #ifndef GIT_WINDOWS_NATIVE
752 struct strvec argv
= STRVEC_INIT
;
753 struct child_err cerr
;
754 struct atfork_state as
;
756 if (prepare_cmd(&argv
, cmd
) < 0) {
757 failed_errno
= errno
;
759 if (!cmd
->silent_exec_failure
)
760 error_errno("cannot run %s", cmd
->argv
[0]);
764 if (pipe(notify_pipe
))
765 notify_pipe
[0] = notify_pipe
[1] = -1;
767 if (cmd
->no_stdin
|| cmd
->no_stdout
|| cmd
->no_stderr
) {
768 null_fd
= xopen("/dev/null", O_RDWR
| O_CLOEXEC
);
769 set_cloexec(null_fd
);
772 childenv
= prep_childenv(cmd
->env
);
776 * NOTE: In order to prevent deadlocking when using threads special
777 * care should be taken with the function calls made in between the
778 * fork() and exec() calls. No calls should be made to functions which
779 * require acquiring a lock (e.g. malloc) as the lock could have been
780 * held by another thread at the time of forking, causing the lock to
781 * never be released in the child process. This means only
782 * Async-Signal-Safe functions are permitted in the child.
785 failed_errno
= errno
;
789 * Ensure the default die/error/warn routines do not get
790 * called, they can take stdio locks and malloc.
792 set_die_routine(child_die_fn
);
793 set_error_routine(child_error_fn
);
794 set_warn_routine(child_warn_fn
);
796 close(notify_pipe
[0]);
797 set_cloexec(notify_pipe
[1]);
798 child_notifier
= notify_pipe
[1];
801 child_dup2(null_fd
, 0);
803 child_dup2(fdin
[0], 0);
804 child_close_pair(fdin
);
805 } else if (cmd
->in
) {
806 child_dup2(cmd
->in
, 0);
807 child_close(cmd
->in
);
811 child_dup2(null_fd
, 2);
813 child_dup2(fderr
[1], 2);
814 child_close_pair(fderr
);
815 } else if (cmd
->err
> 1) {
816 child_dup2(cmd
->err
, 2);
817 child_close(cmd
->err
);
821 child_dup2(null_fd
, 1);
822 else if (cmd
->stdout_to_stderr
)
825 child_dup2(fdout
[1], 1);
826 child_close_pair(fdout
);
827 } else if (cmd
->out
> 1) {
828 child_dup2(cmd
->out
, 1);
829 child_close(cmd
->out
);
832 if (cmd
->dir
&& chdir(cmd
->dir
))
833 child_die(CHILD_ERR_CHDIR
);
836 * restore default signal handlers here, in case
837 * we catch a signal right before execve below
839 for (sig
= 1; sig
< NSIG
; sig
++) {
840 /* ignored signals get reset to SIG_DFL on execve */
841 if (signal(sig
, SIG_DFL
) == SIG_IGN
)
842 signal(sig
, SIG_IGN
);
845 if (sigprocmask(SIG_SETMASK
, &as
.old
, NULL
) != 0)
846 child_die(CHILD_ERR_SIGPROCMASK
);
849 * Attempt to exec using the command and arguments starting at
850 * argv.argv[1]. argv.argv[0] contains SHELL_PATH which will
851 * be used in the event exec failed with ENOEXEC at which point
852 * we will try to interpret the command using 'sh'.
854 execve(argv
.v
[1], (char *const *) argv
.v
+ 1,
855 (char *const *) childenv
);
856 if (errno
== ENOEXEC
)
857 execve(argv
.v
[0], (char *const *) argv
.v
,
858 (char *const *) childenv
);
860 if (errno
== ENOENT
) {
861 if (cmd
->silent_exec_failure
)
862 child_die(CHILD_ERR_SILENT
);
863 child_die(CHILD_ERR_ENOENT
);
865 child_die(CHILD_ERR_ERRNO
);
870 error_errno("cannot fork() for %s", cmd
->argv
[0]);
871 else if (cmd
->clean_on_exit
)
872 mark_child_for_cleanup(cmd
->pid
, cmd
);
875 * Wait for child's exec. If the exec succeeds (or if fork()
876 * failed), EOF is seen immediately by the parent. Otherwise, the
877 * child process sends a child_err struct.
878 * Note that use of this infrastructure is completely advisory,
879 * therefore, we keep error checks minimal.
881 close(notify_pipe
[1]);
882 if (xread(notify_pipe
[0], &cerr
, sizeof(cerr
)) == sizeof(cerr
)) {
884 * At this point we know that fork() succeeded, but exec()
885 * failed. Errors have been reported to our stderr.
887 wait_or_whine(cmd
->pid
, cmd
->argv
[0], 0);
888 child_err_spew(cmd
, &cerr
);
889 failed_errno
= errno
;
892 close(notify_pipe
[0]);
903 int fhin
= 0, fhout
= 1, fherr
= 2;
904 const char **sargv
= cmd
->argv
;
905 struct strvec nargv
= STRVEC_INIT
;
908 fhin
= open("/dev/null", O_RDWR
);
915 fherr
= open("/dev/null", O_RDWR
);
917 fherr
= dup(fderr
[1]);
918 else if (cmd
->err
> 2)
919 fherr
= dup(cmd
->err
);
922 fhout
= open("/dev/null", O_RDWR
);
923 else if (cmd
->stdout_to_stderr
)
926 fhout
= dup(fdout
[1]);
927 else if (cmd
->out
> 1)
928 fhout
= dup(cmd
->out
);
931 cmd
->argv
= prepare_git_cmd(&nargv
, cmd
->argv
);
932 else if (cmd
->use_shell
)
933 cmd
->argv
= prepare_shell_cmd(&nargv
, cmd
->argv
);
935 cmd
->pid
= mingw_spawnvpe(cmd
->argv
[0], cmd
->argv
, (char**) cmd
->env
,
936 cmd
->dir
, fhin
, fhout
, fherr
);
937 failed_errno
= errno
;
938 if (cmd
->pid
< 0 && (!cmd
->silent_exec_failure
|| errno
!= ENOENT
))
939 error_errno("cannot spawn %s", cmd
->argv
[0]);
940 if (cmd
->clean_on_exit
&& cmd
->pid
>= 0)
941 mark_child_for_cleanup(cmd
->pid
, cmd
);
943 strvec_clear(&nargv
);
955 trace2_child_exit(cmd
, -1);
969 child_process_clear(cmd
);
970 errno
= failed_errno
;
992 int finish_command(struct child_process
*cmd
)
994 int ret
= wait_or_whine(cmd
->pid
, cmd
->argv
[0], 0);
995 trace2_child_exit(cmd
, ret
);
996 child_process_clear(cmd
);
997 invalidate_lstat_cache();
1001 int finish_command_in_signal(struct child_process
*cmd
)
1003 int ret
= wait_or_whine(cmd
->pid
, cmd
->argv
[0], 1);
1004 trace2_child_exit(cmd
, ret
);
1009 int run_command(struct child_process
*cmd
)
1013 if (cmd
->out
< 0 || cmd
->err
< 0)
1014 BUG("run_command with a pipe can cause deadlock");
1016 code
= start_command(cmd
);
1019 return finish_command(cmd
);
1022 int run_command_v_opt(const char **argv
, int opt
)
1024 return run_command_v_opt_cd_env(argv
, opt
, NULL
, NULL
);
1027 int run_command_v_opt_tr2(const char **argv
, int opt
, const char *tr2_class
)
1029 return run_command_v_opt_cd_env_tr2(argv
, opt
, NULL
, NULL
, tr2_class
);
1032 int run_command_v_opt_cd_env(const char **argv
, int opt
, const char *dir
, const char *const *env
)
1034 return run_command_v_opt_cd_env_tr2(argv
, opt
, dir
, env
, NULL
);
1037 int run_command_v_opt_cd_env_tr2(const char **argv
, int opt
, const char *dir
,
1038 const char *const *env
, const char *tr2_class
)
1040 struct child_process cmd
= CHILD_PROCESS_INIT
;
1042 cmd
.no_stdin
= opt
& RUN_COMMAND_NO_STDIN
? 1 : 0;
1043 cmd
.git_cmd
= opt
& RUN_GIT_CMD
? 1 : 0;
1044 cmd
.stdout_to_stderr
= opt
& RUN_COMMAND_STDOUT_TO_STDERR
? 1 : 0;
1045 cmd
.silent_exec_failure
= opt
& RUN_SILENT_EXEC_FAILURE
? 1 : 0;
1046 cmd
.use_shell
= opt
& RUN_USING_SHELL
? 1 : 0;
1047 cmd
.clean_on_exit
= opt
& RUN_CLEAN_ON_EXIT
? 1 : 0;
1048 cmd
.wait_after_clean
= opt
& RUN_WAIT_AFTER_CLEAN
? 1 : 0;
1049 cmd
.close_object_store
= opt
& RUN_CLOSE_OBJECT_STORE
? 1 : 0;
1052 cmd
.trace2_child_class
= tr2_class
;
1053 return run_command(&cmd
);
1057 static pthread_t main_thread
;
1058 static int main_thread_set
;
1059 static pthread_key_t async_key
;
1060 static pthread_key_t async_die_counter
;
1062 static void *run_thread(void *data
)
1064 struct async
*async
= data
;
1067 if (async
->isolate_sigpipe
) {
1070 sigaddset(&mask
, SIGPIPE
);
1071 if (pthread_sigmask(SIG_BLOCK
, &mask
, NULL
) < 0) {
1072 ret
= error("unable to block SIGPIPE in async thread");
1077 pthread_setspecific(async_key
, async
);
1078 ret
= async
->proc(async
->proc_in
, async
->proc_out
, async
->data
);
1082 static NORETURN
void die_async(const char *err
, va_list params
)
1084 vreportf("fatal: ", err
, params
);
1087 struct async
*async
= pthread_getspecific(async_key
);
1088 if (async
->proc_in
>= 0)
1089 close(async
->proc_in
);
1090 if (async
->proc_out
>= 0)
1091 close(async
->proc_out
);
1092 pthread_exit((void *)128);
1098 static int async_die_is_recursing(void)
1100 void *ret
= pthread_getspecific(async_die_counter
);
1101 pthread_setspecific(async_die_counter
, &async_die_counter
); /* set to any non-NULL valid pointer */
1107 if (!main_thread_set
)
1108 return 0; /* no asyncs started yet */
1109 return !pthread_equal(main_thread
, pthread_self());
1112 static void NORETURN
async_exit(int code
)
1114 pthread_exit((void *)(intptr_t)code
);
1120 void (**handlers
)(void);
1125 static int git_atexit_installed
;
1127 static void git_atexit_dispatch(void)
1131 for (i
=git_atexit_hdlrs
.nr
; i
; i
--)
1132 git_atexit_hdlrs
.handlers
[i
-1]();
1135 static void git_atexit_clear(void)
1137 free(git_atexit_hdlrs
.handlers
);
1138 memset(&git_atexit_hdlrs
, 0, sizeof(git_atexit_hdlrs
));
1139 git_atexit_installed
= 0;
1143 int git_atexit(void (*handler
)(void))
1145 ALLOC_GROW(git_atexit_hdlrs
.handlers
, git_atexit_hdlrs
.nr
+ 1, git_atexit_hdlrs
.alloc
);
1146 git_atexit_hdlrs
.handlers
[git_atexit_hdlrs
.nr
++] = handler
;
1147 if (!git_atexit_installed
) {
1148 if (atexit(&git_atexit_dispatch
))
1150 git_atexit_installed
= 1;
1154 #define atexit git_atexit
1156 static int process_is_async
;
1159 return process_is_async
;
1162 static void NORETURN
async_exit(int code
)
1169 void check_pipe(int err
)
1175 signal(SIGPIPE
, SIG_DFL
);
1177 /* Should never happen, but just in case... */
1182 int start_async(struct async
*async
)
1184 int need_in
, need_out
;
1185 int fdin
[2], fdout
[2];
1186 int proc_in
, proc_out
;
1188 need_in
= async
->in
< 0;
1190 if (pipe(fdin
) < 0) {
1193 return error_errno("cannot create pipe");
1195 async
->in
= fdin
[1];
1198 need_out
= async
->out
< 0;
1200 if (pipe(fdout
) < 0) {
1205 return error_errno("cannot create pipe");
1207 async
->out
= fdout
[0];
1213 proc_in
= async
->in
;
1218 proc_out
= fdout
[1];
1219 else if (async
->out
)
1220 proc_out
= async
->out
;
1225 /* Flush stdio before fork() to avoid cloning buffers */
1228 async
->pid
= fork();
1229 if (async
->pid
< 0) {
1230 error_errno("fork (async) failed");
1239 process_is_async
= 1;
1240 exit(!!async
->proc(proc_in
, proc_out
, async
->data
));
1243 mark_child_for_cleanup(async
->pid
, NULL
);
1252 else if (async
->out
)
1255 if (!main_thread_set
) {
1257 * We assume that the first time that start_async is called
1258 * it is from the main thread.
1260 main_thread_set
= 1;
1261 main_thread
= pthread_self();
1262 pthread_key_create(&async_key
, NULL
);
1263 pthread_key_create(&async_die_counter
, NULL
);
1264 set_die_routine(die_async
);
1265 set_die_is_recursing_routine(async_die_is_recursing
);
1269 set_cloexec(proc_in
);
1271 set_cloexec(proc_out
);
1272 async
->proc_in
= proc_in
;
1273 async
->proc_out
= proc_out
;
1275 int err
= pthread_create(&async
->tid
, NULL
, run_thread
, async
);
1277 error(_("cannot create async thread: %s"), strerror(err
));
1292 else if (async
->out
)
1297 int finish_async(struct async
*async
)
1300 int ret
= wait_or_whine(async
->pid
, "child process", 0);
1302 invalidate_lstat_cache();
1306 void *ret
= (void *)(intptr_t)(-1);
1308 if (pthread_join(async
->tid
, &ret
))
1309 error("pthread_join failed");
1310 invalidate_lstat_cache();
1311 return (int)(intptr_t)ret
;
1316 int async_with_fork(void)
1325 int run_hook_ve(const char *const *env
, const char *name
, va_list args
)
1327 struct child_process hook
= CHILD_PROCESS_INIT
;
1330 p
= find_hook(name
);
1334 strvec_push(&hook
.args
, p
);
1335 while ((p
= va_arg(args
, const char *)))
1336 strvec_push(&hook
.args
, p
);
1339 hook
.stdout_to_stderr
= 1;
1340 hook
.trace2_hook_name
= name
;
1342 return run_command(&hook
);
1345 int run_hook_le(const char *const *env
, const char *name
, ...)
1350 va_start(args
, name
);
1351 ret
= run_hook_ve(env
, name
, args
);
1358 /* initialized by caller */
1360 int type
; /* POLLOUT or POLLIN */
1372 /* returned by pump_io */
1373 int error
; /* 0 for success, otherwise errno */
1379 static int pump_io_round(struct io_pump
*slots
, int nr
, struct pollfd
*pfd
)
1384 for (i
= 0; i
< nr
; i
++) {
1385 struct io_pump
*io
= &slots
[i
];
1388 pfd
[pollsize
].fd
= io
->fd
;
1389 pfd
[pollsize
].events
= io
->type
;
1390 io
->pfd
= &pfd
[pollsize
++];
1396 if (poll(pfd
, pollsize
, -1) < 0) {
1399 die_errno("poll failed");
1402 for (i
= 0; i
< nr
; i
++) {
1403 struct io_pump
*io
= &slots
[i
];
1408 if (!(io
->pfd
->revents
& (POLLOUT
|POLLIN
|POLLHUP
|POLLERR
|POLLNVAL
)))
1411 if (io
->type
== POLLOUT
) {
1412 ssize_t len
= xwrite(io
->fd
,
1413 io
->u
.out
.buf
, io
->u
.out
.len
);
1419 io
->u
.out
.buf
+= len
;
1420 io
->u
.out
.len
-= len
;
1421 if (!io
->u
.out
.len
) {
1428 if (io
->type
== POLLIN
) {
1429 ssize_t len
= strbuf_read_once(io
->u
.in
.buf
,
1430 io
->fd
, io
->u
.in
.hint
);
1443 static int pump_io(struct io_pump
*slots
, int nr
)
1448 for (i
= 0; i
< nr
; i
++)
1451 ALLOC_ARRAY(pfd
, nr
);
1452 while (pump_io_round(slots
, nr
, pfd
))
1456 /* There may be multiple errno values, so just pick the first. */
1457 for (i
= 0; i
< nr
; i
++) {
1458 if (slots
[i
].error
) {
1459 errno
= slots
[i
].error
;
1467 int pipe_command(struct child_process
*cmd
,
1468 const char *in
, size_t in_len
,
1469 struct strbuf
*out
, size_t out_hint
,
1470 struct strbuf
*err
, size_t err_hint
)
1472 struct io_pump io
[3];
1482 if (start_command(cmd
) < 0)
1486 io
[nr
].fd
= cmd
->in
;
1487 io
[nr
].type
= POLLOUT
;
1488 io
[nr
].u
.out
.buf
= in
;
1489 io
[nr
].u
.out
.len
= in_len
;
1493 io
[nr
].fd
= cmd
->out
;
1494 io
[nr
].type
= POLLIN
;
1495 io
[nr
].u
.in
.buf
= out
;
1496 io
[nr
].u
.in
.hint
= out_hint
;
1500 io
[nr
].fd
= cmd
->err
;
1501 io
[nr
].type
= POLLIN
;
1502 io
[nr
].u
.in
.buf
= err
;
1503 io
[nr
].u
.in
.hint
= err_hint
;
1507 if (pump_io(io
, nr
) < 0) {
1508 finish_command(cmd
); /* throw away exit code */
1512 return finish_command(cmd
);
1518 GIT_CP_WAIT_CLEANUP
,
1521 struct parallel_processes
{
1527 get_next_task_fn get_next_task
;
1528 start_failure_fn start_failure
;
1529 task_finished_fn task_finished
;
1532 enum child_state state
;
1533 struct child_process process
;
1538 * The struct pollfd is logically part of *children,
1539 * but the system call expects it as its own array.
1543 unsigned shutdown
: 1;
1546 struct strbuf buffered_output
; /* of finished children */
1549 static int default_start_failure(struct strbuf
*out
,
1556 static int default_task_finished(int result
,
1564 static void kill_children(struct parallel_processes
*pp
, int signo
)
1566 int i
, n
= pp
->max_processes
;
1568 for (i
= 0; i
< n
; i
++)
1569 if (pp
->children
[i
].state
== GIT_CP_WORKING
)
1570 kill(pp
->children
[i
].process
.pid
, signo
);
1573 static struct parallel_processes
*pp_for_signal
;
1575 static void handle_children_on_signal(int signo
)
1577 kill_children(pp_for_signal
, signo
);
1578 sigchain_pop(signo
);
1582 static void pp_init(struct parallel_processes
*pp
,
1584 get_next_task_fn get_next_task
,
1585 start_failure_fn start_failure
,
1586 task_finished_fn task_finished
,
1594 pp
->max_processes
= n
;
1596 trace_printf("run_processes_parallel: preparing to run up to %d tasks", n
);
1600 BUG("you need to specify a get_next_task function");
1601 pp
->get_next_task
= get_next_task
;
1603 pp
->start_failure
= start_failure
? start_failure
: default_start_failure
;
1604 pp
->task_finished
= task_finished
? task_finished
: default_task_finished
;
1606 pp
->nr_processes
= 0;
1607 pp
->output_owner
= 0;
1609 CALLOC_ARRAY(pp
->children
, n
);
1610 CALLOC_ARRAY(pp
->pfd
, n
);
1611 strbuf_init(&pp
->buffered_output
, 0);
1613 for (i
= 0; i
< n
; i
++) {
1614 strbuf_init(&pp
->children
[i
].err
, 0);
1615 child_process_init(&pp
->children
[i
].process
);
1616 pp
->pfd
[i
].events
= POLLIN
| POLLHUP
;
1621 sigchain_push_common(handle_children_on_signal
);
1624 static void pp_cleanup(struct parallel_processes
*pp
)
1628 trace_printf("run_processes_parallel: done");
1629 for (i
= 0; i
< pp
->max_processes
; i
++) {
1630 strbuf_release(&pp
->children
[i
].err
);
1631 child_process_clear(&pp
->children
[i
].process
);
1638 * When get_next_task added messages to the buffer in its last
1639 * iteration, the buffered output is non empty.
1641 strbuf_write(&pp
->buffered_output
, stderr
);
1642 strbuf_release(&pp
->buffered_output
);
1644 sigchain_pop_common();
1648 * 0 if a new task was started.
1649 * 1 if no new jobs was started (get_next_task ran out of work, non critical
1650 * problem with starting a new command)
1651 * <0 no new job was started, user wishes to shutdown early. Use negative code
1652 * to signal the children.
1654 static int pp_start_one(struct parallel_processes
*pp
)
1658 for (i
= 0; i
< pp
->max_processes
; i
++)
1659 if (pp
->children
[i
].state
== GIT_CP_FREE
)
1661 if (i
== pp
->max_processes
)
1662 BUG("bookkeeping is hard");
1664 code
= pp
->get_next_task(&pp
->children
[i
].process
,
1665 &pp
->children
[i
].err
,
1667 &pp
->children
[i
].data
);
1669 strbuf_addbuf(&pp
->buffered_output
, &pp
->children
[i
].err
);
1670 strbuf_reset(&pp
->children
[i
].err
);
1673 pp
->children
[i
].process
.err
= -1;
1674 pp
->children
[i
].process
.stdout_to_stderr
= 1;
1675 pp
->children
[i
].process
.no_stdin
= 1;
1677 if (start_command(&pp
->children
[i
].process
)) {
1678 code
= pp
->start_failure(&pp
->children
[i
].err
,
1680 pp
->children
[i
].data
);
1681 strbuf_addbuf(&pp
->buffered_output
, &pp
->children
[i
].err
);
1682 strbuf_reset(&pp
->children
[i
].err
);
1689 pp
->children
[i
].state
= GIT_CP_WORKING
;
1690 pp
->pfd
[i
].fd
= pp
->children
[i
].process
.err
;
1694 static void pp_buffer_stderr(struct parallel_processes
*pp
, int output_timeout
)
1698 while ((i
= poll(pp
->pfd
, pp
->max_processes
, output_timeout
)) < 0) {
1705 /* Buffer output from all pipes. */
1706 for (i
= 0; i
< pp
->max_processes
; i
++) {
1707 if (pp
->children
[i
].state
== GIT_CP_WORKING
&&
1708 pp
->pfd
[i
].revents
& (POLLIN
| POLLHUP
)) {
1709 int n
= strbuf_read_once(&pp
->children
[i
].err
,
1710 pp
->children
[i
].process
.err
, 0);
1712 close(pp
->children
[i
].process
.err
);
1713 pp
->children
[i
].state
= GIT_CP_WAIT_CLEANUP
;
1715 if (errno
!= EAGAIN
)
1721 static void pp_output(struct parallel_processes
*pp
)
1723 int i
= pp
->output_owner
;
1724 if (pp
->children
[i
].state
== GIT_CP_WORKING
&&
1725 pp
->children
[i
].err
.len
) {
1726 strbuf_write(&pp
->children
[i
].err
, stderr
);
1727 strbuf_reset(&pp
->children
[i
].err
);
1731 static int pp_collect_finished(struct parallel_processes
*pp
)
1734 int n
= pp
->max_processes
;
1737 while (pp
->nr_processes
> 0) {
1738 for (i
= 0; i
< pp
->max_processes
; i
++)
1739 if (pp
->children
[i
].state
== GIT_CP_WAIT_CLEANUP
)
1741 if (i
== pp
->max_processes
)
1744 code
= finish_command(&pp
->children
[i
].process
);
1746 code
= pp
->task_finished(code
,
1747 &pp
->children
[i
].err
, pp
->data
,
1748 pp
->children
[i
].data
);
1756 pp
->children
[i
].state
= GIT_CP_FREE
;
1758 child_process_init(&pp
->children
[i
].process
);
1760 if (i
!= pp
->output_owner
) {
1761 strbuf_addbuf(&pp
->buffered_output
, &pp
->children
[i
].err
);
1762 strbuf_reset(&pp
->children
[i
].err
);
1764 strbuf_write(&pp
->children
[i
].err
, stderr
);
1765 strbuf_reset(&pp
->children
[i
].err
);
1767 /* Output all other finished child processes */
1768 strbuf_write(&pp
->buffered_output
, stderr
);
1769 strbuf_reset(&pp
->buffered_output
);
1772 * Pick next process to output live.
1774 * For now we pick it randomly by doing a round
1775 * robin. Later we may want to pick the one with
1776 * the most output or the longest or shortest
1777 * running process time.
1779 for (i
= 0; i
< n
; i
++)
1780 if (pp
->children
[(pp
->output_owner
+ i
) % n
].state
== GIT_CP_WORKING
)
1782 pp
->output_owner
= (pp
->output_owner
+ i
) % n
;
1788 int run_processes_parallel(int n
,
1789 get_next_task_fn get_next_task
,
1790 start_failure_fn start_failure
,
1791 task_finished_fn task_finished
,
1795 int output_timeout
= 100;
1797 struct parallel_processes pp
;
1799 pp_init(&pp
, n
, get_next_task
, start_failure
, task_finished
, pp_cb
);
1802 i
< spawn_cap
&& !pp
.shutdown
&&
1803 pp
.nr_processes
< pp
.max_processes
;
1805 code
= pp_start_one(&pp
);
1810 kill_children(&pp
, -code
);
1814 if (!pp
.nr_processes
)
1816 pp_buffer_stderr(&pp
, output_timeout
);
1818 code
= pp_collect_finished(&pp
);
1822 kill_children(&pp
, -code
);
1830 int run_processes_parallel_tr2(int n
, get_next_task_fn get_next_task
,
1831 start_failure_fn start_failure
,
1832 task_finished_fn task_finished
, void *pp_cb
,
1833 const char *tr2_category
, const char *tr2_label
)
1837 trace2_region_enter_printf(tr2_category
, tr2_label
, NULL
, "max:%d",
1838 ((n
< 1) ? online_cpus() : n
));
1840 result
= run_processes_parallel(n
, get_next_task
, start_failure
,
1841 task_finished
, pp_cb
);
1843 trace2_region_leave(tr2_category
, tr2_label
, NULL
);
1848 int run_auto_maintenance(int quiet
)
1851 struct child_process maint
= CHILD_PROCESS_INIT
;
1853 if (!git_config_get_bool("maintenance.auto", &enabled
) &&
1858 maint
.close_object_store
= 1;
1859 strvec_pushl(&maint
.args
, "maintenance", "run", "--auto", NULL
);
1860 strvec_push(&maint
.args
, quiet
? "--quiet" : "--no-quiet");
1862 return run_command(&maint
);
1865 void prepare_other_repo_env(struct strvec
*env_array
, const char *new_git_dir
)
1867 const char * const *var
;
1869 for (var
= local_repo_env
; *var
; var
++) {
1870 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
) &&
1871 strcmp(*var
, CONFIG_COUNT_ENVIRONMENT
))
1872 strvec_push(env_array
, *var
);
1874 strvec_pushf(env_array
, "%s=%s", GIT_DIR_ENVIRONMENT
, new_git_dir
);
1877 enum start_bg_result
start_bg_command(struct child_process
*cmd
,
1878 start_bg_wait_cb
*wait_cb
,
1880 unsigned int timeout_sec
)
1882 enum start_bg_result sbgr
= SBGR_ERROR
;
1889 * We do not allow clean-on-exit because the child process
1890 * should persist in the background and possibly/probably
1891 * after this process exits. So we don't want to kill the
1892 * child during our atexit routine.
1894 if (cmd
->clean_on_exit
)
1895 BUG("start_bg_command() does not allow non-zero clean_on_exit");
1897 if (!cmd
->trace2_child_class
)
1898 cmd
->trace2_child_class
= "background";
1900 ret
= start_command(cmd
);
1903 * We assume that if `start_command()` fails, we
1904 * either get a complete `trace2_child_start() /
1905 * trace2_child_exit()` pair or it fails before the
1906 * `trace2_child_start()` is emitted, so we do not
1907 * need to worry about it here.
1909 * We also assume that `start_command()` does not add
1910 * us to the cleanup list. And that it calls
1911 * calls `child_process_clear()`.
1918 time_limit
+= timeout_sec
;
1921 pid_seen
= waitpid(cmd
->pid
, &wait_status
, WNOHANG
);
1925 * The child is currently running. Ask the callback
1926 * if the child is ready to do work or whether we
1927 * should keep waiting for it to boot up.
1929 ret
= (*wait_cb
)(cmd
, cb_data
);
1932 * The child is running and "ready".
1934 trace2_child_ready(cmd
, "ready");
1937 } else if (ret
> 0) {
1939 * The callback said to give it more time to boot up
1940 * (subject to our timeout limit).
1945 if (now
< time_limit
)
1949 * Our timeout has expired. We don't try to
1950 * kill the child, but rather let it continue
1951 * (hopefully) trying to startup.
1953 trace2_child_ready(cmd
, "timeout");
1954 sbgr
= SBGR_TIMEOUT
;
1958 * The cb gave up on this child. It is still running,
1959 * but our cb got an error trying to probe it.
1961 trace2_child_ready(cmd
, "error");
1962 sbgr
= SBGR_CB_ERROR
;
1967 else if (pid_seen
== cmd
->pid
) {
1968 int child_code
= -1;
1971 * The child started, but exited or was terminated
1972 * before becoming "ready".
1974 * We try to match the behavior of `wait_or_whine()`
1975 * WRT the handling of WIFSIGNALED() and WIFEXITED()
1976 * and convert the child's status to a return code for
1977 * tracing purposes and emit the `trace2_child_exit()`
1980 * We do not want the wait_or_whine() error message
1981 * because we will be called by client-side library
1984 if (WIFEXITED(wait_status
))
1985 child_code
= WEXITSTATUS(wait_status
);
1986 else if (WIFSIGNALED(wait_status
))
1987 child_code
= WTERMSIG(wait_status
) + 128;
1988 trace2_child_exit(cmd
, child_code
);
1994 else if (pid_seen
< 0 && errno
== EINTR
)
1997 trace2_child_exit(cmd
, -1);
2001 child_process_clear(cmd
);
2002 invalidate_lstat_cache();