1 #define USE_THE_REPOSITORY_VARIABLE
2 #define DISABLE_SIGN_COMPARE_WARNINGS
4 #include "git-compat-util.h"
5 #include "run-command.h"
6 #include "environment.h"
12 #include "thread-utils.h"
14 #include "string-list.h"
20 #include "compat/nonblock.h"
22 void child_process_init(struct child_process
*child
)
24 struct child_process blank
= CHILD_PROCESS_INIT
;
25 memcpy(child
, &blank
, sizeof(*child
));
28 void child_process_clear(struct child_process
*child
)
30 strvec_clear(&child
->args
);
31 strvec_clear(&child
->env
);
34 struct child_to_clean
{
36 struct child_process
*process
;
37 struct child_to_clean
*next
;
39 static struct child_to_clean
*children_to_clean
;
40 static int installed_child_cleanup_handler
;
42 static void cleanup_children(int sig
, int in_signal
)
44 struct child_to_clean
*children_to_wait_for
= NULL
;
46 while (children_to_clean
) {
47 struct child_to_clean
*p
= children_to_clean
;
48 children_to_clean
= p
->next
;
50 if (p
->process
&& !in_signal
) {
51 struct child_process
*process
= p
->process
;
52 if (process
->clean_on_exit_handler
) {
54 "trace: run_command: running exit handler for pid %"
55 PRIuMAX
, (uintmax_t)p
->pid
57 process
->clean_on_exit_handler(process
);
63 if (p
->process
&& p
->process
->wait_after_clean
) {
64 p
->next
= children_to_wait_for
;
65 children_to_wait_for
= p
;
72 while (children_to_wait_for
) {
73 struct child_to_clean
*p
= children_to_wait_for
;
74 children_to_wait_for
= p
->next
;
76 while (waitpid(p
->pid
, NULL
, 0) < 0 && errno
== EINTR
)
77 ; /* spin waiting for process exit or error */
84 static void cleanup_children_on_signal(int sig
)
86 cleanup_children(sig
, 1);
91 static void cleanup_children_on_exit(void)
93 cleanup_children(SIGTERM
, 0);
96 static void mark_child_for_cleanup(pid_t pid
, struct child_process
*process
)
98 struct child_to_clean
*p
= xmalloc(sizeof(*p
));
100 p
->process
= process
;
101 p
->next
= children_to_clean
;
102 children_to_clean
= p
;
104 if (!installed_child_cleanup_handler
) {
105 atexit(cleanup_children_on_exit
);
106 sigchain_push_common(cleanup_children_on_signal
);
107 installed_child_cleanup_handler
= 1;
111 static void clear_child_for_cleanup(pid_t pid
)
113 struct child_to_clean
**pp
;
115 for (pp
= &children_to_clean
; *pp
; pp
= &(*pp
)->next
) {
116 struct child_to_clean
*clean_me
= *pp
;
118 if (clean_me
->pid
== pid
) {
119 *pp
= clean_me
->next
;
126 static inline void close_pair(int fd
[2])
132 int is_executable(const char *name
)
136 if (stat(name
, &st
) || /* stat, not lstat */
137 !S_ISREG(st
.st_mode
))
140 #if defined(GIT_WINDOWS_NATIVE)
142 * On Windows there is no executable bit. The file extension
143 * indicates whether it can be run as an executable, and Git
144 * has special-handling to detect scripts and launch them
145 * through the indicated script interpreter. We test for the
146 * file extension first because virus scanners may make
147 * it quite expensive to open many files.
149 if (ends_with(name
, ".exe"))
154 * Now that we know it does not have an executable extension,
155 * peek into the file instead.
159 int fd
= open(name
, O_RDONLY
);
160 st
.st_mode
&= ~S_IXUSR
;
162 n
= read(fd
, buf
, 2);
164 /* look for a she-bang */
165 if (!strcmp(buf
, "#!"))
166 st
.st_mode
|= S_IXUSR
;
171 return st
.st_mode
& S_IXUSR
;
174 #ifndef locate_in_PATH
176 * Search $PATH for a command. This emulates the path search that
177 * execvp would perform, without actually executing the command so it
178 * can be used before fork() to prepare to run a command using
179 * execve() or after execvp() to diagnose why it failed.
181 * The caller should ensure that file contains no directory
184 * Returns the path to the command, as found in $PATH or NULL if the
185 * command could not be found. The caller inherits ownership of the memory
186 * used to store the resultant path.
188 * This should not be used on Windows, where the $PATH search rules
189 * are more complicated (e.g., a search for "foo" should find
192 static char *locate_in_PATH(const char *file
)
194 const char *p
= getenv("PATH");
195 struct strbuf buf
= STRBUF_INIT
;
201 const char *end
= strchrnul(p
, ':');
205 /* POSIX specifies an empty entry as the current directory. */
207 strbuf_add(&buf
, p
, end
- p
);
208 strbuf_addch(&buf
, '/');
210 strbuf_addstr(&buf
, file
);
212 if (is_executable(buf
.buf
))
213 return strbuf_detach(&buf
, NULL
);
220 strbuf_release(&buf
);
225 int exists_in_PATH(const char *command
)
227 char *r
= locate_in_PATH(command
);
228 int found
= r
!= NULL
;
233 int sane_execvp(const char *file
, char * const argv
[])
235 #ifndef GIT_WINDOWS_NATIVE
237 * execvp() doesn't return, so we all we can do is tell trace2
238 * what we are about to do and let it leave a hint in the log
239 * (unless of course the execvp() fails).
241 * we skip this for Windows because the compat layer already
242 * has to emulate the execvp() call anyway.
244 int exec_id
= trace2_exec(file
, (const char **)argv
);
247 if (!execvp(file
, argv
))
248 return 0; /* cannot happen ;-) */
250 #ifndef GIT_WINDOWS_NATIVE
253 trace2_exec_result(exec_id
, ec
);
259 * When a command can't be found because one of the directories
260 * listed in $PATH is unsearchable, execvp reports EACCES, but
261 * careful usability testing (read: analysis of occasional bug
262 * reports) reveals that "No such file or directory" is more
265 * We avoid commands with "/", because execvp will not do $PATH
266 * lookups in that case.
268 * The reassignment of EACCES to errno looks like a no-op below,
269 * but we need to protect against exists_in_PATH overwriting errno.
271 if (errno
== EACCES
&& !strchr(file
, '/'))
272 errno
= exists_in_PATH(file
) ? EACCES
: ENOENT
;
273 else if (errno
== ENOTDIR
&& !strchr(file
, '/'))
278 char *git_shell_path(void)
280 #ifndef GIT_WINDOWS_NATIVE
281 return xstrdup(SHELL_PATH
);
283 char *p
= locate_in_PATH("sh");
289 static const char **prepare_shell_cmd(struct strvec
*out
, const char **argv
)
292 BUG("shell command is empty");
294 if (strcspn(argv
[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv
[0])) {
295 strvec_push_nodup(out
, git_shell_path());
296 strvec_push(out
, "-c");
299 * If we have no extra arguments, we do not even need to
300 * bother with the "$@" magic.
303 strvec_push(out
, argv
[0]);
305 strvec_pushf(out
, "%s \"$@\"", argv
[0]);
308 strvec_pushv(out
, argv
);
312 #ifndef GIT_WINDOWS_NATIVE
313 static int child_notifier
= -1;
319 CHILD_ERR_SIGPROCMASK
,
325 enum child_errcode err
;
326 int syserr
; /* errno */
329 static void child_die(enum child_errcode err
)
331 struct child_err buf
;
336 /* write(2) on buf smaller than PIPE_BUF (min 512) is atomic: */
337 xwrite(child_notifier
, &buf
, sizeof(buf
));
341 static void child_dup2(int fd
, int to
)
343 if (dup2(fd
, to
) < 0)
344 child_die(CHILD_ERR_DUP2
);
347 static void child_close(int fd
)
350 child_die(CHILD_ERR_CLOSE
);
353 static void child_close_pair(int fd
[2])
359 static void child_error_fn(const char *err UNUSED
, va_list params UNUSED
)
361 const char msg
[] = "error() should not be called in child\n";
362 xwrite(2, msg
, sizeof(msg
) - 1);
365 static void child_warn_fn(const char *err UNUSED
, va_list params UNUSED
)
367 const char msg
[] = "warn() should not be called in child\n";
368 xwrite(2, msg
, sizeof(msg
) - 1);
371 static void NORETURN
child_die_fn(const char *err UNUSED
, va_list params UNUSED
)
373 const char msg
[] = "die() should not be called in child\n";
374 xwrite(2, msg
, sizeof(msg
) - 1);
378 /* this runs in the parent process */
379 static void child_err_spew(struct child_process
*cmd
, struct child_err
*cerr
)
381 static void (*old_errfn
)(const char *err
, va_list params
);
382 report_fn die_message_routine
= get_die_message_routine();
384 old_errfn
= get_error_routine();
385 set_error_routine(die_message_routine
);
386 errno
= cerr
->syserr
;
389 case CHILD_ERR_CHDIR
:
390 error_errno("exec '%s': cd to '%s' failed",
391 cmd
->args
.v
[0], cmd
->dir
);
394 error_errno("dup2() in child failed");
396 case CHILD_ERR_CLOSE
:
397 error_errno("close() in child failed");
399 case CHILD_ERR_SIGPROCMASK
:
400 error_errno("sigprocmask failed restoring signals");
402 case CHILD_ERR_SILENT
:
404 case CHILD_ERR_ERRNO
:
405 error_errno("cannot exec '%s'", cmd
->args
.v
[0]);
408 set_error_routine(old_errfn
);
411 static int prepare_cmd(struct strvec
*out
, const struct child_process
*cmd
)
414 BUG("command is empty");
417 * Add SHELL_PATH so in the event exec fails with ENOEXEC we can
418 * attempt to interpret the command with 'sh'.
420 strvec_push(out
, SHELL_PATH
);
423 prepare_git_cmd(out
, cmd
->args
.v
);
424 } else if (cmd
->use_shell
) {
425 prepare_shell_cmd(out
, cmd
->args
.v
);
427 strvec_pushv(out
, cmd
->args
.v
);
431 * If there are no dir separator characters in the command then perform
432 * a path lookup and use the resolved path as the command to exec. If
433 * there are dir separator characters, we have exec attempt to invoke
434 * the command directly.
436 if (!has_dir_sep(out
->v
[1])) {
437 char *program
= locate_in_PATH(out
->v
[1]);
439 free((char *)out
->v
[1]);
451 static char **prep_childenv(const char *const *deltaenv
)
453 extern char **environ
;
455 struct string_list env
= STRING_LIST_INIT_DUP
;
456 struct strbuf key
= STRBUF_INIT
;
457 const char *const *p
;
460 /* Construct a sorted string list consisting of the current environ */
461 for (p
= (const char *const *) environ
; p
&& *p
; p
++) {
462 const char *equals
= strchr(*p
, '=');
466 strbuf_add(&key
, *p
, equals
- *p
);
467 string_list_append(&env
, key
.buf
)->util
= (void *) *p
;
469 string_list_append(&env
, *p
)->util
= (void *) *p
;
472 string_list_sort(&env
);
474 /* Merge in 'deltaenv' with the current environ */
475 for (p
= deltaenv
; p
&& *p
; p
++) {
476 const char *equals
= strchr(*p
, '=');
479 /* ('key=value'), insert or replace entry */
481 strbuf_add(&key
, *p
, equals
- *p
);
482 string_list_insert(&env
, key
.buf
)->util
= (void *) *p
;
484 /* otherwise ('key') remove existing entry */
485 string_list_remove(&env
, *p
, 0);
489 /* Create an array of 'char *' to be used as the childenv */
490 ALLOC_ARRAY(childenv
, env
.nr
+ 1);
491 for (i
= 0; i
< env
.nr
; i
++)
492 childenv
[i
] = env
.items
[i
].util
;
493 childenv
[env
.nr
] = NULL
;
495 string_list_clear(&env
, 0);
496 strbuf_release(&key
);
500 struct atfork_state
{
507 #define CHECK_BUG(err, msg) \
511 BUG("%s: %s", msg, strerror(e)); \
514 static void atfork_prepare(struct atfork_state
*as
)
519 * POSIX says sigfillset() can fail, but an overly clever
520 * compiler can see through the header files and decide
521 * it cannot fail on a particular platform it is compiling for,
522 * triggering -Wunreachable-code false positive.
524 if (NOT_CONSTANT(sigfillset(&all
)))
525 die_errno("sigfillset");
527 if (sigprocmask(SIG_SETMASK
, &all
, &as
->old
))
528 die_errno("sigprocmask");
530 CHECK_BUG(pthread_sigmask(SIG_SETMASK
, &all
, &as
->old
),
531 "blocking all signals");
532 CHECK_BUG(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE
, &as
->cs
),
533 "disabling cancellation");
537 static void atfork_parent(struct atfork_state
*as
)
540 if (sigprocmask(SIG_SETMASK
, &as
->old
, NULL
))
541 die_errno("sigprocmask");
543 CHECK_BUG(pthread_setcancelstate(as
->cs
, NULL
),
544 "re-enabling cancellation");
545 CHECK_BUG(pthread_sigmask(SIG_SETMASK
, &as
->old
, NULL
),
546 "restoring signal mask");
549 #endif /* GIT_WINDOWS_NATIVE */
551 static inline void set_cloexec(int fd
)
553 int flags
= fcntl(fd
, F_GETFD
);
555 fcntl(fd
, F_SETFD
, flags
| FD_CLOEXEC
);
558 static int wait_or_whine(pid_t pid
, const char *argv0
, int in_signal
)
560 int status
, code
= -1;
562 int failed_errno
= 0;
564 while ((waiting
= waitpid(pid
, &status
, 0)) < 0 && errno
== EINTR
)
568 failed_errno
= errno
;
570 error_errno("waitpid for %s failed", argv0
);
571 } else if (waiting
!= pid
) {
573 error("waitpid is confused (%s)", argv0
);
574 } else if (WIFSIGNALED(status
)) {
575 code
= WTERMSIG(status
);
576 if (!in_signal
&& code
!= SIGINT
&& code
!= SIGQUIT
&& code
!= SIGPIPE
)
577 error("%s died of signal %d", argv0
, code
);
579 * This return value is chosen so that code & 0xff
580 * mimics the exit code that a POSIX shell would report for
581 * a program that died from this signal.
584 } else if (WIFEXITED(status
)) {
585 code
= WEXITSTATUS(status
);
588 error("waitpid is confused (%s)", argv0
);
592 clear_child_for_cleanup(pid
);
594 errno
= failed_errno
;
598 static void trace_add_env(struct strbuf
*dst
, const char *const *deltaenv
)
600 struct string_list envs
= STRING_LIST_INIT_DUP
;
601 const char *const *e
;
603 int printed_unset
= 0;
605 /* Last one wins, see run-command.c:prep_childenv() for context */
606 for (e
= deltaenv
; e
&& *e
; e
++) {
607 struct strbuf key
= STRBUF_INIT
;
608 char *equals
= strchr(*e
, '=');
611 strbuf_add(&key
, *e
, equals
- *e
);
612 string_list_insert(&envs
, key
.buf
)->util
= equals
+ 1;
614 string_list_insert(&envs
, *e
)->util
= NULL
;
616 strbuf_release(&key
);
619 /* "unset X Y...;" */
620 for (i
= 0; i
< envs
.nr
; i
++) {
621 const char *var
= envs
.items
[i
].string
;
622 const char *val
= envs
.items
[i
].util
;
624 if (val
|| !getenv(var
))
627 if (!printed_unset
) {
628 strbuf_addstr(dst
, " unset");
631 strbuf_addf(dst
, " %s", var
);
634 strbuf_addch(dst
, ';');
636 /* ... followed by "A=B C=D ..." */
637 for (i
= 0; i
< envs
.nr
; i
++) {
638 const char *var
= envs
.items
[i
].string
;
639 const char *val
= envs
.items
[i
].util
;
645 oldval
= getenv(var
);
646 if (oldval
&& !strcmp(val
, oldval
))
649 strbuf_addf(dst
, " %s=", var
);
650 sq_quote_buf_pretty(dst
, val
);
652 string_list_clear(&envs
, 0);
655 static void trace_run_command(const struct child_process
*cp
)
657 struct strbuf buf
= STRBUF_INIT
;
659 if (!trace_want(&trace_default_key
))
662 strbuf_addstr(&buf
, "trace: run_command:");
664 strbuf_addstr(&buf
, " cd ");
665 sq_quote_buf_pretty(&buf
, cp
->dir
);
666 strbuf_addch(&buf
, ';');
668 trace_add_env(&buf
, cp
->env
.v
);
670 strbuf_addstr(&buf
, " git");
671 sq_quote_argv_pretty(&buf
, cp
->args
.v
);
673 trace_printf("%s", buf
.buf
);
674 strbuf_release(&buf
);
677 int start_command(struct child_process
*cmd
)
679 int need_in
, need_out
, need_err
;
680 int fdin
[2], fdout
[2], fderr
[2];
685 * In case of errors we must keep the promise to close FDs
686 * that have been passed in via ->in and ->out.
689 need_in
= !cmd
->no_stdin
&& cmd
->in
< 0;
691 if (pipe(fdin
) < 0) {
692 failed_errno
= errno
;
695 str
= "standard input";
701 need_out
= !cmd
->no_stdout
702 && !cmd
->stdout_to_stderr
705 if (pipe(fdout
) < 0) {
706 failed_errno
= errno
;
711 str
= "standard output";
717 need_err
= !cmd
->no_stderr
&& cmd
->err
< 0;
719 if (pipe(fderr
) < 0) {
720 failed_errno
= errno
;
729 str
= "standard error";
731 error("cannot create %s pipe for %s: %s",
732 str
, cmd
->args
.v
[0], strerror(failed_errno
));
733 child_process_clear(cmd
);
734 errno
= failed_errno
;
740 trace2_child_start(cmd
);
741 trace_run_command(cmd
);
745 if (cmd
->close_object_store
)
746 close_object_store(the_repository
->objects
);
748 #ifndef GIT_WINDOWS_NATIVE
753 struct strvec argv
= STRVEC_INIT
;
754 struct child_err cerr
;
755 struct atfork_state as
;
757 if (prepare_cmd(&argv
, cmd
) < 0) {
758 failed_errno
= errno
;
760 if (!cmd
->silent_exec_failure
)
761 error_errno("cannot run %s", cmd
->args
.v
[0]);
765 trace_argv_printf(&argv
.v
[1], "trace: start_command:");
767 if (pipe(notify_pipe
))
768 notify_pipe
[0] = notify_pipe
[1] = -1;
770 if (cmd
->no_stdin
|| cmd
->no_stdout
|| cmd
->no_stderr
) {
771 null_fd
= xopen("/dev/null", O_RDWR
| O_CLOEXEC
);
772 set_cloexec(null_fd
);
775 childenv
= prep_childenv(cmd
->env
.v
);
779 * NOTE: In order to prevent deadlocking when using threads special
780 * care should be taken with the function calls made in between the
781 * fork() and exec() calls. No calls should be made to functions which
782 * require acquiring a lock (e.g. malloc) as the lock could have been
783 * held by another thread at the time of forking, causing the lock to
784 * never be released in the child process. This means only
785 * Async-Signal-Safe functions are permitted in the child.
788 failed_errno
= errno
;
792 * Ensure the default die/error/warn routines do not get
793 * called, they can take stdio locks and malloc.
795 set_die_routine(child_die_fn
);
796 set_error_routine(child_error_fn
);
797 set_warn_routine(child_warn_fn
);
799 close(notify_pipe
[0]);
800 set_cloexec(notify_pipe
[1]);
801 child_notifier
= notify_pipe
[1];
804 child_dup2(null_fd
, 0);
806 child_dup2(fdin
[0], 0);
807 child_close_pair(fdin
);
808 } else if (cmd
->in
) {
809 child_dup2(cmd
->in
, 0);
810 child_close(cmd
->in
);
814 child_dup2(null_fd
, 2);
816 child_dup2(fderr
[1], 2);
817 child_close_pair(fderr
);
818 } else if (cmd
->err
> 1) {
819 child_dup2(cmd
->err
, 2);
820 child_close(cmd
->err
);
824 child_dup2(null_fd
, 1);
825 else if (cmd
->stdout_to_stderr
)
828 child_dup2(fdout
[1], 1);
829 child_close_pair(fdout
);
830 } else if (cmd
->out
> 1) {
831 child_dup2(cmd
->out
, 1);
832 child_close(cmd
->out
);
835 if (cmd
->dir
&& chdir(cmd
->dir
))
836 child_die(CHILD_ERR_CHDIR
);
839 * restore default signal handlers here, in case
840 * we catch a signal right before execve below
842 for (sig
= 1; sig
< NSIG
; sig
++) {
843 /* ignored signals get reset to SIG_DFL on execve */
844 if (signal(sig
, SIG_DFL
) == SIG_IGN
)
845 signal(sig
, SIG_IGN
);
848 if (sigprocmask(SIG_SETMASK
, &as
.old
, NULL
) != 0)
849 child_die(CHILD_ERR_SIGPROCMASK
);
852 * Attempt to exec using the command and arguments starting at
853 * argv.argv[1]. argv.argv[0] contains SHELL_PATH which will
854 * be used in the event exec failed with ENOEXEC at which point
855 * we will try to interpret the command using 'sh'.
857 execve(argv
.v
[1], (char *const *) argv
.v
+ 1,
858 (char *const *) childenv
);
859 if (errno
== ENOEXEC
)
860 execve(argv
.v
[0], (char *const *) argv
.v
,
861 (char *const *) childenv
);
863 if (cmd
->silent_exec_failure
&& errno
== ENOENT
)
864 child_die(CHILD_ERR_SILENT
);
865 child_die(CHILD_ERR_ERRNO
);
869 error_errno("cannot fork() for %s", cmd
->args
.v
[0]);
870 else if (cmd
->clean_on_exit
)
871 mark_child_for_cleanup(cmd
->pid
, cmd
);
874 * Wait for child's exec. If the exec succeeds (or if fork()
875 * failed), EOF is seen immediately by the parent. Otherwise, the
876 * child process sends a child_err struct.
877 * Note that use of this infrastructure is completely advisory,
878 * therefore, we keep error checks minimal.
880 close(notify_pipe
[1]);
881 if (xread(notify_pipe
[0], &cerr
, sizeof(cerr
)) == sizeof(cerr
)) {
883 * At this point we know that fork() succeeded, but exec()
884 * failed. Errors have been reported to our stderr.
886 wait_or_whine(cmd
->pid
, cmd
->args
.v
[0], 0);
887 child_err_spew(cmd
, &cerr
);
888 failed_errno
= errno
;
891 close(notify_pipe
[0]);
902 int fhin
= 0, fhout
= 1, fherr
= 2;
903 const char **sargv
= cmd
->args
.v
;
904 struct strvec nargv
= STRVEC_INIT
;
907 fhin
= open("/dev/null", O_RDWR
);
914 fherr
= open("/dev/null", O_RDWR
);
916 fherr
= dup(fderr
[1]);
917 else if (cmd
->err
> 2)
918 fherr
= dup(cmd
->err
);
921 fhout
= open("/dev/null", O_RDWR
);
922 else if (cmd
->stdout_to_stderr
)
925 fhout
= dup(fdout
[1]);
926 else if (cmd
->out
> 1)
927 fhout
= dup(cmd
->out
);
930 cmd
->args
.v
= prepare_git_cmd(&nargv
, sargv
);
931 else if (cmd
->use_shell
)
932 cmd
->args
.v
= prepare_shell_cmd(&nargv
, sargv
);
934 trace_argv_printf(cmd
->args
.v
, "trace: start_command:");
935 cmd
->pid
= mingw_spawnvpe(cmd
->args
.v
[0], cmd
->args
.v
,
937 cmd
->dir
, fhin
, fhout
, fherr
);
938 failed_errno
= errno
;
939 if (cmd
->pid
< 0 && (!cmd
->silent_exec_failure
|| errno
!= ENOENT
))
940 error_errno("cannot spawn %s", cmd
->args
.v
[0]);
941 if (cmd
->clean_on_exit
&& cmd
->pid
>= 0)
942 mark_child_for_cleanup(cmd
->pid
, cmd
);
944 strvec_clear(&nargv
);
956 trace2_child_exit(cmd
, -1);
970 child_process_clear(cmd
);
971 errno
= failed_errno
;
993 int finish_command(struct child_process
*cmd
)
995 int ret
= wait_or_whine(cmd
->pid
, cmd
->args
.v
[0], 0);
996 trace2_child_exit(cmd
, ret
);
997 child_process_clear(cmd
);
998 invalidate_lstat_cache();
1002 int finish_command_in_signal(struct child_process
*cmd
)
1004 int ret
= wait_or_whine(cmd
->pid
, cmd
->args
.v
[0], 1);
1006 trace2_child_exit(cmd
, ret
);
1011 int run_command(struct child_process
*cmd
)
1015 if (cmd
->out
< 0 || cmd
->err
< 0)
1016 BUG("run_command with a pipe can cause deadlock");
1018 code
= start_command(cmd
);
1021 return finish_command(cmd
);
1025 static pthread_t main_thread
;
1026 static int main_thread_set
;
1027 static pthread_key_t async_key
;
1028 static pthread_key_t async_die_counter
;
1030 static void *run_thread(void *data
)
1032 struct async
*async
= data
;
1035 if (async
->isolate_sigpipe
) {
1038 sigaddset(&mask
, SIGPIPE
);
1039 if (pthread_sigmask(SIG_BLOCK
, &mask
, NULL
)) {
1040 ret
= error("unable to block SIGPIPE in async thread");
1045 pthread_setspecific(async_key
, async
);
1046 ret
= async
->proc(async
->proc_in
, async
->proc_out
, async
->data
);
1050 static NORETURN
void die_async(const char *err
, va_list params
)
1052 report_fn die_message_fn
= get_die_message_routine();
1054 die_message_fn(err
, params
);
1057 struct async
*async
= pthread_getspecific(async_key
);
1058 if (async
->proc_in
>= 0)
1059 close(async
->proc_in
);
1060 if (async
->proc_out
>= 0)
1061 close(async
->proc_out
);
1062 pthread_exit((void *)128);
1068 static int async_die_is_recursing(void)
1070 void *ret
= pthread_getspecific(async_die_counter
);
1071 pthread_setspecific(async_die_counter
, &async_die_counter
); /* set to any non-NULL valid pointer */
1077 if (!main_thread_set
)
1078 return 0; /* no asyncs started yet */
1079 return !pthread_equal(main_thread
, pthread_self());
1082 static void NORETURN
async_exit(int code
)
1084 pthread_exit((void *)(intptr_t)code
);
1090 void (**handlers
)(void);
1095 static int git_atexit_installed
;
1097 static void git_atexit_dispatch(void)
1101 for (i
=git_atexit_hdlrs
.nr
; i
; i
--)
1102 git_atexit_hdlrs
.handlers
[i
-1]();
1105 static void git_atexit_clear(void)
1107 free(git_atexit_hdlrs
.handlers
);
1108 memset(&git_atexit_hdlrs
, 0, sizeof(git_atexit_hdlrs
));
1109 git_atexit_installed
= 0;
1113 int git_atexit(void (*handler
)(void))
1115 ALLOC_GROW(git_atexit_hdlrs
.handlers
, git_atexit_hdlrs
.nr
+ 1, git_atexit_hdlrs
.alloc
);
1116 git_atexit_hdlrs
.handlers
[git_atexit_hdlrs
.nr
++] = handler
;
1117 if (!git_atexit_installed
) {
1118 if (atexit(&git_atexit_dispatch
))
1120 git_atexit_installed
= 1;
1124 #define atexit git_atexit
1126 static int process_is_async
;
1129 return process_is_async
;
1132 static void NORETURN
async_exit(int code
)
1139 void check_pipe(int err
)
1145 signal(SIGPIPE
, SIG_DFL
);
1147 /* Should never happen, but just in case... */
1152 int start_async(struct async
*async
)
1154 int need_in
, need_out
;
1155 int fdin
[2], fdout
[2];
1156 int proc_in
, proc_out
;
1158 need_in
= async
->in
< 0;
1160 if (pipe(fdin
) < 0) {
1163 return error_errno("cannot create pipe");
1165 async
->in
= fdin
[1];
1168 need_out
= async
->out
< 0;
1170 if (pipe(fdout
) < 0) {
1175 return error_errno("cannot create pipe");
1177 async
->out
= fdout
[0];
1183 proc_in
= async
->in
;
1188 proc_out
= fdout
[1];
1189 else if (async
->out
)
1190 proc_out
= async
->out
;
1195 /* Flush stdio before fork() to avoid cloning buffers */
1198 async
->pid
= fork();
1199 if (async
->pid
< 0) {
1200 error_errno("fork (async) failed");
1209 process_is_async
= 1;
1210 exit(!!async
->proc(proc_in
, proc_out
, async
->data
));
1213 mark_child_for_cleanup(async
->pid
, NULL
);
1222 else if (async
->out
)
1225 if (!main_thread_set
) {
1227 * We assume that the first time that start_async is called
1228 * it is from the main thread.
1230 main_thread_set
= 1;
1231 main_thread
= pthread_self();
1232 pthread_key_create(&async_key
, NULL
);
1233 pthread_key_create(&async_die_counter
, NULL
);
1234 set_die_routine(die_async
);
1235 set_die_is_recursing_routine(async_die_is_recursing
);
1239 set_cloexec(proc_in
);
1241 set_cloexec(proc_out
);
1242 async
->proc_in
= proc_in
;
1243 async
->proc_out
= proc_out
;
1245 int err
= pthread_create(&async
->tid
, NULL
, run_thread
, async
);
1247 error(_("cannot create async thread: %s"), strerror(err
));
1262 else if (async
->out
)
1267 int finish_async(struct async
*async
)
1270 int ret
= wait_or_whine(async
->pid
, "child process", 0);
1272 invalidate_lstat_cache();
1276 void *ret
= (void *)(intptr_t)(-1);
1278 if (pthread_join(async
->tid
, &ret
))
1279 error("pthread_join failed");
1280 invalidate_lstat_cache();
1281 return (int)(intptr_t)ret
;
1286 int async_with_fork(void)
1296 /* initialized by caller */
1298 int type
; /* POLLOUT or POLLIN */
1310 /* returned by pump_io */
1311 int error
; /* 0 for success, otherwise errno */
1317 static int pump_io_round(struct io_pump
*slots
, int nr
, struct pollfd
*pfd
)
1322 for (i
= 0; i
< nr
; i
++) {
1323 struct io_pump
*io
= &slots
[i
];
1326 pfd
[pollsize
].fd
= io
->fd
;
1327 pfd
[pollsize
].events
= io
->type
;
1328 io
->pfd
= &pfd
[pollsize
++];
1334 if (poll(pfd
, pollsize
, -1) < 0) {
1337 die_errno("poll failed");
1340 for (i
= 0; i
< nr
; i
++) {
1341 struct io_pump
*io
= &slots
[i
];
1346 if (!(io
->pfd
->revents
& (POLLOUT
|POLLIN
|POLLHUP
|POLLERR
|POLLNVAL
)))
1349 if (io
->type
== POLLOUT
) {
1353 * Don't use xwrite() here. It loops forever on EAGAIN,
1354 * and we're in our own poll() loop here.
1356 * Note that we lose xwrite()'s handling of MAX_IO_SIZE
1357 * and EINTR, so we have to implement those ourselves.
1359 len
= write(io
->fd
, io
->u
.out
.buf
,
1360 io
->u
.out
.len
<= MAX_IO_SIZE
?
1361 io
->u
.out
.len
: MAX_IO_SIZE
);
1363 if (errno
!= EINTR
&& errno
!= EAGAIN
&&
1370 io
->u
.out
.buf
+= len
;
1371 io
->u
.out
.len
-= len
;
1372 if (!io
->u
.out
.len
) {
1379 if (io
->type
== POLLIN
) {
1380 ssize_t len
= strbuf_read_once(io
->u
.in
.buf
,
1381 io
->fd
, io
->u
.in
.hint
);
1394 static int pump_io(struct io_pump
*slots
, int nr
)
1399 for (i
= 0; i
< nr
; i
++)
1402 ALLOC_ARRAY(pfd
, nr
);
1403 while (pump_io_round(slots
, nr
, pfd
))
1407 /* There may be multiple errno values, so just pick the first. */
1408 for (i
= 0; i
< nr
; i
++) {
1409 if (slots
[i
].error
) {
1410 errno
= slots
[i
].error
;
1418 int pipe_command(struct child_process
*cmd
,
1419 const char *in
, size_t in_len
,
1420 struct strbuf
*out
, size_t out_hint
,
1421 struct strbuf
*err
, size_t err_hint
)
1423 struct io_pump io
[3];
1433 if (start_command(cmd
) < 0)
1437 if (enable_pipe_nonblock(cmd
->in
) < 0) {
1438 error_errno("unable to make pipe non-blocking");
1446 io
[nr
].fd
= cmd
->in
;
1447 io
[nr
].type
= POLLOUT
;
1448 io
[nr
].u
.out
.buf
= in
;
1449 io
[nr
].u
.out
.len
= in_len
;
1453 io
[nr
].fd
= cmd
->out
;
1454 io
[nr
].type
= POLLIN
;
1455 io
[nr
].u
.in
.buf
= out
;
1456 io
[nr
].u
.in
.hint
= out_hint
;
1460 io
[nr
].fd
= cmd
->err
;
1461 io
[nr
].type
= POLLIN
;
1462 io
[nr
].u
.in
.buf
= err
;
1463 io
[nr
].u
.in
.hint
= err_hint
;
1467 if (pump_io(io
, nr
) < 0) {
1468 finish_command(cmd
); /* throw away exit code */
1472 return finish_command(cmd
);
1478 GIT_CP_WAIT_CLEANUP
,
1481 struct parallel_processes
{
1482 size_t nr_processes
;
1485 enum child_state state
;
1486 struct child_process process
;
1491 * The struct pollfd is logically part of *children,
1492 * but the system call expects it as its own array.
1496 unsigned shutdown
: 1;
1498 size_t output_owner
;
1499 struct strbuf buffered_output
; /* of finished children */
1502 struct parallel_processes_for_signal
{
1503 const struct run_process_parallel_opts
*opts
;
1504 const struct parallel_processes
*pp
;
1507 static void kill_children(const struct parallel_processes
*pp
,
1508 const struct run_process_parallel_opts
*opts
,
1511 for (size_t i
= 0; i
< opts
->processes
; i
++)
1512 if (pp
->children
[i
].state
== GIT_CP_WORKING
)
1513 kill(pp
->children
[i
].process
.pid
, signo
);
1516 static void kill_children_signal(const struct parallel_processes_for_signal
*pp_sig
,
1519 kill_children(pp_sig
->pp
, pp_sig
->opts
, signo
);
1522 static struct parallel_processes_for_signal
*pp_for_signal
;
1524 static void handle_children_on_signal(int signo
)
1526 kill_children_signal(pp_for_signal
, signo
);
1527 sigchain_pop(signo
);
1531 static void pp_init(struct parallel_processes
*pp
,
1532 const struct run_process_parallel_opts
*opts
,
1533 struct parallel_processes_for_signal
*pp_sig
)
1535 const size_t n
= opts
->processes
;
1538 BUG("you must provide a non-zero number of processes!");
1540 trace_printf("run_processes_parallel: preparing to run up to %"PRIuMAX
" tasks",
1543 if (!opts
->get_next_task
)
1544 BUG("you need to specify a get_next_task function");
1546 CALLOC_ARRAY(pp
->children
, n
);
1548 CALLOC_ARRAY(pp
->pfd
, n
);
1550 for (size_t i
= 0; i
< n
; i
++) {
1551 strbuf_init(&pp
->children
[i
].err
, 0);
1552 child_process_init(&pp
->children
[i
].process
);
1554 pp
->pfd
[i
].events
= POLLIN
| POLLHUP
;
1560 pp_sig
->opts
= opts
;
1561 pp_for_signal
= pp_sig
;
1562 sigchain_push_common(handle_children_on_signal
);
1565 static void pp_cleanup(struct parallel_processes
*pp
,
1566 const struct run_process_parallel_opts
*opts
)
1568 trace_printf("run_processes_parallel: done");
1569 for (size_t i
= 0; i
< opts
->processes
; i
++) {
1570 strbuf_release(&pp
->children
[i
].err
);
1571 child_process_clear(&pp
->children
[i
].process
);
1578 * When get_next_task added messages to the buffer in its last
1579 * iteration, the buffered output is non empty.
1581 strbuf_write(&pp
->buffered_output
, stderr
);
1582 strbuf_release(&pp
->buffered_output
);
1584 sigchain_pop_common();
1588 * 0 if a new task was started.
1589 * 1 if no new jobs was started (get_next_task ran out of work, non critical
1590 * problem with starting a new command)
1591 * <0 no new job was started, user wishes to shutdown early. Use negative code
1592 * to signal the children.
1594 static int pp_start_one(struct parallel_processes
*pp
,
1595 const struct run_process_parallel_opts
*opts
)
1600 for (i
= 0; i
< opts
->processes
; i
++)
1601 if (pp
->children
[i
].state
== GIT_CP_FREE
)
1603 if (i
== opts
->processes
)
1604 BUG("bookkeeping is hard");
1607 * By default, do not inherit stdin from the parent process - otherwise,
1608 * all children would share stdin! Users may overwrite this to provide
1609 * something to the child's stdin by having their 'get_next_task'
1610 * callback assign 0 to .no_stdin and an appropriate integer to .in.
1612 pp
->children
[i
].process
.no_stdin
= 1;
1614 code
= opts
->get_next_task(&pp
->children
[i
].process
,
1615 opts
->ungroup
? NULL
: &pp
->children
[i
].err
,
1617 &pp
->children
[i
].data
);
1619 if (!opts
->ungroup
) {
1620 strbuf_addbuf(&pp
->buffered_output
, &pp
->children
[i
].err
);
1621 strbuf_reset(&pp
->children
[i
].err
);
1625 if (!opts
->ungroup
) {
1626 pp
->children
[i
].process
.err
= -1;
1627 pp
->children
[i
].process
.stdout_to_stderr
= 1;
1630 if (start_command(&pp
->children
[i
].process
)) {
1631 if (opts
->start_failure
)
1632 code
= opts
->start_failure(opts
->ungroup
? NULL
:
1633 &pp
->children
[i
].err
,
1635 pp
->children
[i
].data
);
1639 if (!opts
->ungroup
) {
1640 strbuf_addbuf(&pp
->buffered_output
, &pp
->children
[i
].err
);
1641 strbuf_reset(&pp
->children
[i
].err
);
1649 pp
->children
[i
].state
= GIT_CP_WORKING
;
1651 pp
->pfd
[i
].fd
= pp
->children
[i
].process
.err
;
1655 static void pp_buffer_stderr(struct parallel_processes
*pp
,
1656 const struct run_process_parallel_opts
*opts
,
1659 while (poll(pp
->pfd
, opts
->processes
, output_timeout
) < 0) {
1662 pp_cleanup(pp
, opts
);
1666 /* Buffer output from all pipes. */
1667 for (size_t i
= 0; i
< opts
->processes
; i
++) {
1668 if (pp
->children
[i
].state
== GIT_CP_WORKING
&&
1669 pp
->pfd
[i
].revents
& (POLLIN
| POLLHUP
)) {
1670 int n
= strbuf_read_once(&pp
->children
[i
].err
,
1671 pp
->children
[i
].process
.err
, 0);
1673 close(pp
->children
[i
].process
.err
);
1674 pp
->children
[i
].state
= GIT_CP_WAIT_CLEANUP
;
1676 if (errno
!= EAGAIN
)
1682 static void pp_output(const struct parallel_processes
*pp
)
1684 size_t i
= pp
->output_owner
;
1686 if (pp
->children
[i
].state
== GIT_CP_WORKING
&&
1687 pp
->children
[i
].err
.len
) {
1688 strbuf_write(&pp
->children
[i
].err
, stderr
);
1689 strbuf_reset(&pp
->children
[i
].err
);
1693 static int pp_collect_finished(struct parallel_processes
*pp
,
1694 const struct run_process_parallel_opts
*opts
)
1700 while (pp
->nr_processes
> 0) {
1701 for (i
= 0; i
< opts
->processes
; i
++)
1702 if (pp
->children
[i
].state
== GIT_CP_WAIT_CLEANUP
)
1704 if (i
== opts
->processes
)
1707 code
= finish_command(&pp
->children
[i
].process
);
1709 if (opts
->task_finished
)
1710 code
= opts
->task_finished(code
, opts
->ungroup
? NULL
:
1711 &pp
->children
[i
].err
, opts
->data
,
1712 pp
->children
[i
].data
);
1722 pp
->children
[i
].state
= GIT_CP_FREE
;
1725 child_process_init(&pp
->children
[i
].process
);
1727 if (opts
->ungroup
) {
1728 ; /* no strbuf_*() work to do here */
1729 } else if (i
!= pp
->output_owner
) {
1730 strbuf_addbuf(&pp
->buffered_output
, &pp
->children
[i
].err
);
1731 strbuf_reset(&pp
->children
[i
].err
);
1733 const size_t n
= opts
->processes
;
1735 strbuf_write(&pp
->children
[i
].err
, stderr
);
1736 strbuf_reset(&pp
->children
[i
].err
);
1738 /* Output all other finished child processes */
1739 strbuf_write(&pp
->buffered_output
, stderr
);
1740 strbuf_reset(&pp
->buffered_output
);
1743 * Pick next process to output live.
1745 * For now we pick it randomly by doing a round
1746 * robin. Later we may want to pick the one with
1747 * the most output or the longest or shortest
1748 * running process time.
1750 for (i
= 0; i
< n
; i
++)
1751 if (pp
->children
[(pp
->output_owner
+ i
) % n
].state
== GIT_CP_WORKING
)
1753 pp
->output_owner
= (pp
->output_owner
+ i
) % n
;
1759 void run_processes_parallel(const struct run_process_parallel_opts
*opts
)
1762 int output_timeout
= 100;
1764 struct parallel_processes_for_signal pp_sig
;
1765 struct parallel_processes pp
= {
1766 .buffered_output
= STRBUF_INIT
,
1769 const char *tr2_category
= opts
->tr2_category
;
1770 const char *tr2_label
= opts
->tr2_label
;
1771 const int do_trace2
= tr2_category
&& tr2_label
;
1774 trace2_region_enter_printf(tr2_category
, tr2_label
, NULL
,
1776 (uintmax_t)opts
->processes
);
1778 pp_init(&pp
, opts
, &pp_sig
);
1781 i
< spawn_cap
&& !pp
.shutdown
&&
1782 pp
.nr_processes
< opts
->processes
;
1784 code
= pp_start_one(&pp
, opts
);
1789 kill_children(&pp
, opts
, -code
);
1793 if (!pp
.nr_processes
)
1795 if (opts
->ungroup
) {
1796 for (size_t i
= 0; i
< opts
->processes
; i
++)
1797 pp
.children
[i
].state
= GIT_CP_WAIT_CLEANUP
;
1799 pp_buffer_stderr(&pp
, opts
, output_timeout
);
1802 code
= pp_collect_finished(&pp
, opts
);
1806 kill_children(&pp
, opts
,-code
);
1810 pp_cleanup(&pp
, opts
);
1813 trace2_region_leave(tr2_category
, tr2_label
, NULL
);
1816 int prepare_auto_maintenance(int quiet
, struct child_process
*maint
)
1818 int enabled
, auto_detach
;
1820 if (!git_config_get_bool("maintenance.auto", &enabled
) &&
1825 * When `maintenance.autoDetach` isn't set, then we fall back to
1826 * honoring `gc.autoDetach`. This is somewhat weird, but required to
1827 * retain behaviour from when we used to run git-gc(1) here.
1829 if (git_config_get_bool("maintenance.autodetach", &auto_detach
) &&
1830 git_config_get_bool("gc.autodetach", &auto_detach
))
1834 maint
->close_object_store
= 1;
1835 strvec_pushl(&maint
->args
, "maintenance", "run", "--auto", NULL
);
1836 strvec_push(&maint
->args
, quiet
? "--quiet" : "--no-quiet");
1837 strvec_push(&maint
->args
, auto_detach
? "--detach" : "--no-detach");
1842 int run_auto_maintenance(int quiet
)
1844 struct child_process maint
= CHILD_PROCESS_INIT
;
1845 if (!prepare_auto_maintenance(quiet
, &maint
))
1847 return run_command(&maint
);
1850 void prepare_other_repo_env(struct strvec
*env
, const char *new_git_dir
)
1852 const char * const *var
;
1854 for (var
= local_repo_env
; *var
; var
++) {
1855 if (strcmp(*var
, CONFIG_DATA_ENVIRONMENT
) &&
1856 strcmp(*var
, CONFIG_COUNT_ENVIRONMENT
))
1857 strvec_push(env
, *var
);
1859 strvec_pushf(env
, "%s=%s", GIT_DIR_ENVIRONMENT
, new_git_dir
);
1862 enum start_bg_result
start_bg_command(struct child_process
*cmd
,
1863 start_bg_wait_cb
*wait_cb
,
1865 unsigned int timeout_sec
)
1867 enum start_bg_result sbgr
= SBGR_ERROR
;
1874 * We do not allow clean-on-exit because the child process
1875 * should persist in the background and possibly/probably
1876 * after this process exits. So we don't want to kill the
1877 * child during our atexit routine.
1879 if (cmd
->clean_on_exit
)
1880 BUG("start_bg_command() does not allow non-zero clean_on_exit");
1882 if (!cmd
->trace2_child_class
)
1883 cmd
->trace2_child_class
= "background";
1885 ret
= start_command(cmd
);
1888 * We assume that if `start_command()` fails, we
1889 * either get a complete `trace2_child_start() /
1890 * trace2_child_exit()` pair or it fails before the
1891 * `trace2_child_start()` is emitted, so we do not
1892 * need to worry about it here.
1894 * We also assume that `start_command()` does not add
1895 * us to the cleanup list. And that it calls
1896 * `child_process_clear()`.
1903 time_limit
+= timeout_sec
;
1906 pid_seen
= waitpid(cmd
->pid
, &wait_status
, WNOHANG
);
1910 * The child is currently running. Ask the callback
1911 * if the child is ready to do work or whether we
1912 * should keep waiting for it to boot up.
1914 ret
= (*wait_cb
)(cmd
, cb_data
);
1917 * The child is running and "ready".
1919 trace2_child_ready(cmd
, "ready");
1922 } else if (ret
> 0) {
1924 * The callback said to give it more time to boot up
1925 * (subject to our timeout limit).
1930 if (now
< time_limit
)
1934 * Our timeout has expired. We don't try to
1935 * kill the child, but rather let it continue
1936 * (hopefully) trying to startup.
1938 trace2_child_ready(cmd
, "timeout");
1939 sbgr
= SBGR_TIMEOUT
;
1943 * The cb gave up on this child. It is still running,
1944 * but our cb got an error trying to probe it.
1946 trace2_child_ready(cmd
, "error");
1947 sbgr
= SBGR_CB_ERROR
;
1952 else if (pid_seen
== cmd
->pid
) {
1953 int child_code
= -1;
1956 * The child started, but exited or was terminated
1957 * before becoming "ready".
1959 * We try to match the behavior of `wait_or_whine()`
1960 * WRT the handling of WIFSIGNALED() and WIFEXITED()
1961 * and convert the child's status to a return code for
1962 * tracing purposes and emit the `trace2_child_exit()`
1965 * We do not want the wait_or_whine() error message
1966 * because we will be called by client-side library
1969 if (WIFEXITED(wait_status
))
1970 child_code
= WEXITSTATUS(wait_status
);
1971 else if (WIFSIGNALED(wait_status
))
1972 child_code
= WTERMSIG(wait_status
) + 128;
1973 trace2_child_exit(cmd
, child_code
);
1979 else if (pid_seen
< 0 && errno
== EINTR
)
1982 trace2_child_exit(cmd
, -1);
1986 child_process_clear(cmd
);
1987 invalidate_lstat_cache();