t/lib-unicode-nfc-nfd: helper prereqs for testing unicode nfc/nfd
[alt-git.git] / run-command.c
bloba8501e38cebe50f6a1fefb6d31d92ce049b96ac3
1 #include "cache.h"
2 #include "run-command.h"
3 #include "exec-cmd.h"
4 #include "sigchain.h"
5 #include "strvec.h"
6 #include "thread-utils.h"
7 #include "strbuf.h"
8 #include "string-list.h"
9 #include "quote.h"
10 #include "config.h"
11 #include "packfile.h"
12 #include "hook.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 {
27 pid_t pid;
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) {
45 trace_printf(
46 "trace: run_command: running exit handler for pid %"
47 PRIuMAX, (uintmax_t)p->pid
49 process->clean_on_exit_handler(process);
53 kill(p->pid, sig);
55 if (p->process && p->process->wait_after_clean) {
56 p->next = children_to_wait_for;
57 children_to_wait_for = p;
58 } else {
59 if (!in_signal)
60 free(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 */
71 if (!in_signal)
72 free(p);
76 static void cleanup_children_on_signal(int sig)
78 cleanup_children(sig, 1);
79 sigchain_pop(sig);
80 raise(sig);
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));
91 p->pid = pid;
92 p->process = process;
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;
112 free(clean_me);
113 return;
118 static inline void close_pair(int fd[2])
120 close(fd[0]);
121 close(fd[1]);
124 int is_executable(const char *name)
126 struct stat st;
128 if (stat(name, &st) || /* stat, not lstat */
129 !S_ISREG(st.st_mode))
130 return 0;
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"))
142 return S_IXUSR;
146 * Now that we know it does not have an executable extension,
147 * peek into the file instead.
149 char buf[3] = { 0 };
150 int n;
151 int fd = open(name, O_RDONLY);
152 st.st_mode &= ~S_IXUSR;
153 if (fd >= 0) {
154 n = read(fd, buf, 2);
155 if (n == 2)
156 /* look for a she-bang */
157 if (!strcmp(buf, "#!"))
158 st.st_mode |= S_IXUSR;
159 close(fd);
162 #endif
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
173 * separators.
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
181 * "foo.exe").
183 static char *locate_in_PATH(const char *file)
185 const char *p = getenv("PATH");
186 struct strbuf buf = STRBUF_INIT;
188 if (!p || !*p)
189 return NULL;
191 while (1) {
192 const char *end = strchrnul(p, ':');
194 strbuf_reset(&buf);
196 /* POSIX specifies an empty entry as the current directory. */
197 if (end != p) {
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);
206 if (!*end)
207 break;
208 p = end + 1;
211 strbuf_release(&buf);
212 return NULL;
215 int exists_in_PATH(const char *command)
217 char *r = locate_in_PATH(command);
218 int found = r != NULL;
219 free(r);
220 return found;
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);
235 #endif
237 if (!execvp(file, argv))
238 return 0; /* cannot happen ;-) */
240 #ifndef GIT_WINDOWS_NATIVE
242 int ec = errno;
243 trace2_exec_result(exec_id, ec);
244 errno = ec;
246 #endif
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
253 * intuitive.
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, '/'))
264 errno = ENOENT;
265 return -1;
268 static const char **prepare_shell_cmd(struct strvec *out, const char **argv)
270 if (!argv[0])
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);
276 #else
277 strvec_push(out, "sh");
278 #endif
279 strvec_push(out, "-c");
282 * If we have no extra arguments, we do not even need to
283 * bother with the "$@" magic.
285 if (!argv[1])
286 strvec_push(out, argv[0]);
287 else
288 strvec_pushf(out, "%s \"$@\"", argv[0]);
291 strvec_pushv(out, argv);
292 return out->v;
295 #ifndef GIT_WINDOWS_NATIVE
296 static int child_notifier = -1;
298 enum child_errcode {
299 CHILD_ERR_CHDIR,
300 CHILD_ERR_DUP2,
301 CHILD_ERR_CLOSE,
302 CHILD_ERR_SIGPROCMASK,
303 CHILD_ERR_ENOENT,
304 CHILD_ERR_SILENT,
305 CHILD_ERR_ERRNO
308 struct child_err {
309 enum child_errcode err;
310 int syserr; /* errno */
313 static void child_die(enum child_errcode err)
315 struct child_err buf;
317 buf.err = err;
318 buf.syserr = errno;
320 /* write(2) on buf smaller than PIPE_BUF (min 512) is atomic: */
321 xwrite(child_notifier, &buf, sizeof(buf));
322 _exit(1);
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)
333 if (close(fd))
334 child_die(CHILD_ERR_CLOSE);
337 static void child_close_pair(int fd[2])
339 child_close(fd[0]);
340 child_close(fd[1]);
343 static void child_error_fn(const char *err, va_list params)
345 const char msg[] = "error() should not be called in child\n";
346 xwrite(2, msg, sizeof(msg) - 1);
349 static void child_warn_fn(const char *err, va_list params)
351 const char msg[] = "warn() should not be called in child\n";
352 xwrite(2, msg, sizeof(msg) - 1);
355 static void NORETURN child_die_fn(const char *err, va_list params)
357 const char msg[] = "die() should not be called in child\n";
358 xwrite(2, msg, sizeof(msg) - 1);
359 _exit(2);
362 /* this runs in the parent process */
363 static void child_err_spew(struct child_process *cmd, struct child_err *cerr)
365 static void (*old_errfn)(const char *err, va_list params);
366 report_fn die_message_routine = get_die_message_routine();
368 old_errfn = get_error_routine();
369 set_error_routine(die_message_routine);
370 errno = cerr->syserr;
372 switch (cerr->err) {
373 case CHILD_ERR_CHDIR:
374 error_errno("exec '%s': cd to '%s' failed",
375 cmd->args.v[0], cmd->dir);
376 break;
377 case CHILD_ERR_DUP2:
378 error_errno("dup2() in child failed");
379 break;
380 case CHILD_ERR_CLOSE:
381 error_errno("close() in child failed");
382 break;
383 case CHILD_ERR_SIGPROCMASK:
384 error_errno("sigprocmask failed restoring signals");
385 break;
386 case CHILD_ERR_ENOENT:
387 error_errno("cannot run %s", cmd->args.v[0]);
388 break;
389 case CHILD_ERR_SILENT:
390 break;
391 case CHILD_ERR_ERRNO:
392 error_errno("cannot exec '%s'", cmd->args.v[0]);
393 break;
395 set_error_routine(old_errfn);
398 static int prepare_cmd(struct strvec *out, const struct child_process *cmd)
400 if (!cmd->args.v[0])
401 BUG("command is empty");
404 * Add SHELL_PATH so in the event exec fails with ENOEXEC we can
405 * attempt to interpret the command with 'sh'.
407 strvec_push(out, SHELL_PATH);
409 if (cmd->git_cmd) {
410 prepare_git_cmd(out, cmd->args.v);
411 } else if (cmd->use_shell) {
412 prepare_shell_cmd(out, cmd->args.v);
413 } else {
414 strvec_pushv(out, cmd->args.v);
418 * If there are no dir separator characters in the command then perform
419 * a path lookup and use the resolved path as the command to exec. If
420 * there are dir separator characters, we have exec attempt to invoke
421 * the command directly.
423 if (!has_dir_sep(out->v[1])) {
424 char *program = locate_in_PATH(out->v[1]);
425 if (program) {
426 free((char *)out->v[1]);
427 out->v[1] = program;
428 } else {
429 strvec_clear(out);
430 errno = ENOENT;
431 return -1;
435 return 0;
438 static char **prep_childenv(const char *const *deltaenv)
440 extern char **environ;
441 char **childenv;
442 struct string_list env = STRING_LIST_INIT_DUP;
443 struct strbuf key = STRBUF_INIT;
444 const char *const *p;
445 int i;
447 /* Construct a sorted string list consisting of the current environ */
448 for (p = (const char *const *) environ; p && *p; p++) {
449 const char *equals = strchr(*p, '=');
451 if (equals) {
452 strbuf_reset(&key);
453 strbuf_add(&key, *p, equals - *p);
454 string_list_append(&env, key.buf)->util = (void *) *p;
455 } else {
456 string_list_append(&env, *p)->util = (void *) *p;
459 string_list_sort(&env);
461 /* Merge in 'deltaenv' with the current environ */
462 for (p = deltaenv; p && *p; p++) {
463 const char *equals = strchr(*p, '=');
465 if (equals) {
466 /* ('key=value'), insert or replace entry */
467 strbuf_reset(&key);
468 strbuf_add(&key, *p, equals - *p);
469 string_list_insert(&env, key.buf)->util = (void *) *p;
470 } else {
471 /* otherwise ('key') remove existing entry */
472 string_list_remove(&env, *p, 0);
476 /* Create an array of 'char *' to be used as the childenv */
477 ALLOC_ARRAY(childenv, env.nr + 1);
478 for (i = 0; i < env.nr; i++)
479 childenv[i] = env.items[i].util;
480 childenv[env.nr] = NULL;
482 string_list_clear(&env, 0);
483 strbuf_release(&key);
484 return childenv;
487 struct atfork_state {
488 #ifndef NO_PTHREADS
489 int cs;
490 #endif
491 sigset_t old;
494 #define CHECK_BUG(err, msg) \
495 do { \
496 int e = (err); \
497 if (e) \
498 BUG("%s: %s", msg, strerror(e)); \
499 } while(0)
501 static void atfork_prepare(struct atfork_state *as)
503 sigset_t all;
505 if (sigfillset(&all))
506 die_errno("sigfillset");
507 #ifdef NO_PTHREADS
508 if (sigprocmask(SIG_SETMASK, &all, &as->old))
509 die_errno("sigprocmask");
510 #else
511 CHECK_BUG(pthread_sigmask(SIG_SETMASK, &all, &as->old),
512 "blocking all signals");
513 CHECK_BUG(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &as->cs),
514 "disabling cancellation");
515 #endif
518 static void atfork_parent(struct atfork_state *as)
520 #ifdef NO_PTHREADS
521 if (sigprocmask(SIG_SETMASK, &as->old, NULL))
522 die_errno("sigprocmask");
523 #else
524 CHECK_BUG(pthread_setcancelstate(as->cs, NULL),
525 "re-enabling cancellation");
526 CHECK_BUG(pthread_sigmask(SIG_SETMASK, &as->old, NULL),
527 "restoring signal mask");
528 #endif
530 #endif /* GIT_WINDOWS_NATIVE */
532 static inline void set_cloexec(int fd)
534 int flags = fcntl(fd, F_GETFD);
535 if (flags >= 0)
536 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
539 static int wait_or_whine(pid_t pid, const char *argv0, int in_signal)
541 int status, code = -1;
542 pid_t waiting;
543 int failed_errno = 0;
545 while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
546 ; /* nothing */
548 if (waiting < 0) {
549 failed_errno = errno;
550 if (!in_signal)
551 error_errno("waitpid for %s failed", argv0);
552 } else if (waiting != pid) {
553 if (!in_signal)
554 error("waitpid is confused (%s)", argv0);
555 } else if (WIFSIGNALED(status)) {
556 code = WTERMSIG(status);
557 if (!in_signal && code != SIGINT && code != SIGQUIT && code != SIGPIPE)
558 error("%s died of signal %d", argv0, code);
560 * This return value is chosen so that code & 0xff
561 * mimics the exit code that a POSIX shell would report for
562 * a program that died from this signal.
564 code += 128;
565 } else if (WIFEXITED(status)) {
566 code = WEXITSTATUS(status);
567 } else {
568 if (!in_signal)
569 error("waitpid is confused (%s)", argv0);
572 if (!in_signal)
573 clear_child_for_cleanup(pid);
575 errno = failed_errno;
576 return code;
579 static void trace_add_env(struct strbuf *dst, const char *const *deltaenv)
581 struct string_list envs = STRING_LIST_INIT_DUP;
582 const char *const *e;
583 int i;
584 int printed_unset = 0;
586 /* Last one wins, see run-command.c:prep_childenv() for context */
587 for (e = deltaenv; e && *e; e++) {
588 struct strbuf key = STRBUF_INIT;
589 char *equals = strchr(*e, '=');
591 if (equals) {
592 strbuf_add(&key, *e, equals - *e);
593 string_list_insert(&envs, key.buf)->util = equals + 1;
594 } else {
595 string_list_insert(&envs, *e)->util = NULL;
597 strbuf_release(&key);
600 /* "unset X Y...;" */
601 for (i = 0; i < envs.nr; i++) {
602 const char *var = envs.items[i].string;
603 const char *val = envs.items[i].util;
605 if (val || !getenv(var))
606 continue;
608 if (!printed_unset) {
609 strbuf_addstr(dst, " unset");
610 printed_unset = 1;
612 strbuf_addf(dst, " %s", var);
614 if (printed_unset)
615 strbuf_addch(dst, ';');
617 /* ... followed by "A=B C=D ..." */
618 for (i = 0; i < envs.nr; i++) {
619 const char *var = envs.items[i].string;
620 const char *val = envs.items[i].util;
621 const char *oldval;
623 if (!val)
624 continue;
626 oldval = getenv(var);
627 if (oldval && !strcmp(val, oldval))
628 continue;
630 strbuf_addf(dst, " %s=", var);
631 sq_quote_buf_pretty(dst, val);
633 string_list_clear(&envs, 0);
636 static void trace_run_command(const struct child_process *cp)
638 struct strbuf buf = STRBUF_INIT;
640 if (!trace_want(&trace_default_key))
641 return;
643 strbuf_addstr(&buf, "trace: run_command:");
644 if (cp->dir) {
645 strbuf_addstr(&buf, " cd ");
646 sq_quote_buf_pretty(&buf, cp->dir);
647 strbuf_addch(&buf, ';');
649 trace_add_env(&buf, cp->env_array.v);
650 if (cp->git_cmd)
651 strbuf_addstr(&buf, " git");
652 sq_quote_argv_pretty(&buf, cp->args.v);
654 trace_printf("%s", buf.buf);
655 strbuf_release(&buf);
658 int start_command(struct child_process *cmd)
660 int need_in, need_out, need_err;
661 int fdin[2], fdout[2], fderr[2];
662 int failed_errno;
663 char *str;
666 * In case of errors we must keep the promise to close FDs
667 * that have been passed in via ->in and ->out.
670 need_in = !cmd->no_stdin && cmd->in < 0;
671 if (need_in) {
672 if (pipe(fdin) < 0) {
673 failed_errno = errno;
674 if (cmd->out > 0)
675 close(cmd->out);
676 str = "standard input";
677 goto fail_pipe;
679 cmd->in = fdin[1];
682 need_out = !cmd->no_stdout
683 && !cmd->stdout_to_stderr
684 && cmd->out < 0;
685 if (need_out) {
686 if (pipe(fdout) < 0) {
687 failed_errno = errno;
688 if (need_in)
689 close_pair(fdin);
690 else if (cmd->in)
691 close(cmd->in);
692 str = "standard output";
693 goto fail_pipe;
695 cmd->out = fdout[0];
698 need_err = !cmd->no_stderr && cmd->err < 0;
699 if (need_err) {
700 if (pipe(fderr) < 0) {
701 failed_errno = errno;
702 if (need_in)
703 close_pair(fdin);
704 else if (cmd->in)
705 close(cmd->in);
706 if (need_out)
707 close_pair(fdout);
708 else if (cmd->out)
709 close(cmd->out);
710 str = "standard error";
711 fail_pipe:
712 error("cannot create %s pipe for %s: %s",
713 str, cmd->args.v[0], strerror(failed_errno));
714 child_process_clear(cmd);
715 errno = failed_errno;
716 return -1;
718 cmd->err = fderr[0];
721 trace2_child_start(cmd);
722 trace_run_command(cmd);
724 fflush(NULL);
726 if (cmd->close_object_store)
727 close_object_store(the_repository->objects);
729 #ifndef GIT_WINDOWS_NATIVE
731 int notify_pipe[2];
732 int null_fd = -1;
733 char **childenv;
734 struct strvec argv = STRVEC_INIT;
735 struct child_err cerr;
736 struct atfork_state as;
738 if (prepare_cmd(&argv, cmd) < 0) {
739 failed_errno = errno;
740 cmd->pid = -1;
741 if (!cmd->silent_exec_failure)
742 error_errno("cannot run %s", cmd->args.v[0]);
743 goto end_of_spawn;
746 if (pipe(notify_pipe))
747 notify_pipe[0] = notify_pipe[1] = -1;
749 if (cmd->no_stdin || cmd->no_stdout || cmd->no_stderr) {
750 null_fd = xopen("/dev/null", O_RDWR | O_CLOEXEC);
751 set_cloexec(null_fd);
754 childenv = prep_childenv(cmd->env_array.v);
755 atfork_prepare(&as);
758 * NOTE: In order to prevent deadlocking when using threads special
759 * care should be taken with the function calls made in between the
760 * fork() and exec() calls. No calls should be made to functions which
761 * require acquiring a lock (e.g. malloc) as the lock could have been
762 * held by another thread at the time of forking, causing the lock to
763 * never be released in the child process. This means only
764 * Async-Signal-Safe functions are permitted in the child.
766 cmd->pid = fork();
767 failed_errno = errno;
768 if (!cmd->pid) {
769 int sig;
771 * Ensure the default die/error/warn routines do not get
772 * called, they can take stdio locks and malloc.
774 set_die_routine(child_die_fn);
775 set_error_routine(child_error_fn);
776 set_warn_routine(child_warn_fn);
778 close(notify_pipe[0]);
779 set_cloexec(notify_pipe[1]);
780 child_notifier = notify_pipe[1];
782 if (cmd->no_stdin)
783 child_dup2(null_fd, 0);
784 else if (need_in) {
785 child_dup2(fdin[0], 0);
786 child_close_pair(fdin);
787 } else if (cmd->in) {
788 child_dup2(cmd->in, 0);
789 child_close(cmd->in);
792 if (cmd->no_stderr)
793 child_dup2(null_fd, 2);
794 else if (need_err) {
795 child_dup2(fderr[1], 2);
796 child_close_pair(fderr);
797 } else if (cmd->err > 1) {
798 child_dup2(cmd->err, 2);
799 child_close(cmd->err);
802 if (cmd->no_stdout)
803 child_dup2(null_fd, 1);
804 else if (cmd->stdout_to_stderr)
805 child_dup2(2, 1);
806 else if (need_out) {
807 child_dup2(fdout[1], 1);
808 child_close_pair(fdout);
809 } else if (cmd->out > 1) {
810 child_dup2(cmd->out, 1);
811 child_close(cmd->out);
814 if (cmd->dir && chdir(cmd->dir))
815 child_die(CHILD_ERR_CHDIR);
818 * restore default signal handlers here, in case
819 * we catch a signal right before execve below
821 for (sig = 1; sig < NSIG; sig++) {
822 /* ignored signals get reset to SIG_DFL on execve */
823 if (signal(sig, SIG_DFL) == SIG_IGN)
824 signal(sig, SIG_IGN);
827 if (sigprocmask(SIG_SETMASK, &as.old, NULL) != 0)
828 child_die(CHILD_ERR_SIGPROCMASK);
831 * Attempt to exec using the command and arguments starting at
832 * argv.argv[1]. argv.argv[0] contains SHELL_PATH which will
833 * be used in the event exec failed with ENOEXEC at which point
834 * we will try to interpret the command using 'sh'.
836 execve(argv.v[1], (char *const *) argv.v + 1,
837 (char *const *) childenv);
838 if (errno == ENOEXEC)
839 execve(argv.v[0], (char *const *) argv.v,
840 (char *const *) childenv);
842 if (errno == ENOENT) {
843 if (cmd->silent_exec_failure)
844 child_die(CHILD_ERR_SILENT);
845 child_die(CHILD_ERR_ENOENT);
846 } else {
847 child_die(CHILD_ERR_ERRNO);
850 atfork_parent(&as);
851 if (cmd->pid < 0)
852 error_errno("cannot fork() for %s", cmd->args.v[0]);
853 else if (cmd->clean_on_exit)
854 mark_child_for_cleanup(cmd->pid, cmd);
857 * Wait for child's exec. If the exec succeeds (or if fork()
858 * failed), EOF is seen immediately by the parent. Otherwise, the
859 * child process sends a child_err struct.
860 * Note that use of this infrastructure is completely advisory,
861 * therefore, we keep error checks minimal.
863 close(notify_pipe[1]);
864 if (xread(notify_pipe[0], &cerr, sizeof(cerr)) == sizeof(cerr)) {
866 * At this point we know that fork() succeeded, but exec()
867 * failed. Errors have been reported to our stderr.
869 wait_or_whine(cmd->pid, cmd->args.v[0], 0);
870 child_err_spew(cmd, &cerr);
871 failed_errno = errno;
872 cmd->pid = -1;
874 close(notify_pipe[0]);
876 if (null_fd >= 0)
877 close(null_fd);
878 strvec_clear(&argv);
879 free(childenv);
881 end_of_spawn:
883 #else
885 int fhin = 0, fhout = 1, fherr = 2;
886 const char **sargv = cmd->args.v;
887 struct strvec nargv = STRVEC_INIT;
889 if (cmd->no_stdin)
890 fhin = open("/dev/null", O_RDWR);
891 else if (need_in)
892 fhin = dup(fdin[0]);
893 else if (cmd->in)
894 fhin = dup(cmd->in);
896 if (cmd->no_stderr)
897 fherr = open("/dev/null", O_RDWR);
898 else if (need_err)
899 fherr = dup(fderr[1]);
900 else if (cmd->err > 2)
901 fherr = dup(cmd->err);
903 if (cmd->no_stdout)
904 fhout = open("/dev/null", O_RDWR);
905 else if (cmd->stdout_to_stderr)
906 fhout = dup(fherr);
907 else if (need_out)
908 fhout = dup(fdout[1]);
909 else if (cmd->out > 1)
910 fhout = dup(cmd->out);
912 if (cmd->git_cmd)
913 cmd->args.v = prepare_git_cmd(&nargv, sargv);
914 else if (cmd->use_shell)
915 cmd->args.v = prepare_shell_cmd(&nargv, sargv);
917 cmd->pid = mingw_spawnvpe(cmd->args.v[0], cmd->args.v, (char**) cmd->env_array.v,
918 cmd->dir, fhin, fhout, fherr);
919 failed_errno = errno;
920 if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
921 error_errno("cannot spawn %s", cmd->args.v[0]);
922 if (cmd->clean_on_exit && cmd->pid >= 0)
923 mark_child_for_cleanup(cmd->pid, cmd);
925 strvec_clear(&nargv);
926 cmd->args.v = sargv;
927 if (fhin != 0)
928 close(fhin);
929 if (fhout != 1)
930 close(fhout);
931 if (fherr != 2)
932 close(fherr);
934 #endif
936 if (cmd->pid < 0) {
937 trace2_child_exit(cmd, -1);
939 if (need_in)
940 close_pair(fdin);
941 else if (cmd->in)
942 close(cmd->in);
943 if (need_out)
944 close_pair(fdout);
945 else if (cmd->out)
946 close(cmd->out);
947 if (need_err)
948 close_pair(fderr);
949 else if (cmd->err)
950 close(cmd->err);
951 child_process_clear(cmd);
952 errno = failed_errno;
953 return -1;
956 if (need_in)
957 close(fdin[0]);
958 else if (cmd->in)
959 close(cmd->in);
961 if (need_out)
962 close(fdout[1]);
963 else if (cmd->out)
964 close(cmd->out);
966 if (need_err)
967 close(fderr[1]);
968 else if (cmd->err)
969 close(cmd->err);
971 return 0;
974 int finish_command(struct child_process *cmd)
976 int ret = wait_or_whine(cmd->pid, cmd->args.v[0], 0);
977 trace2_child_exit(cmd, ret);
978 child_process_clear(cmd);
979 invalidate_lstat_cache();
980 return ret;
983 int finish_command_in_signal(struct child_process *cmd)
985 int ret = wait_or_whine(cmd->pid, cmd->args.v[0], 1);
986 trace2_child_exit(cmd, ret);
987 return ret;
991 int run_command(struct child_process *cmd)
993 int code;
995 if (cmd->out < 0 || cmd->err < 0)
996 BUG("run_command with a pipe can cause deadlock");
998 code = start_command(cmd);
999 if (code)
1000 return code;
1001 return finish_command(cmd);
1004 int run_command_v_opt(const char **argv, int opt)
1006 return run_command_v_opt_cd_env(argv, opt, NULL, NULL);
1009 int run_command_v_opt_tr2(const char **argv, int opt, const char *tr2_class)
1011 return run_command_v_opt_cd_env_tr2(argv, opt, NULL, NULL, tr2_class);
1014 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
1016 return run_command_v_opt_cd_env_tr2(argv, opt, dir, env, NULL);
1019 int run_command_v_opt_cd_env_tr2(const char **argv, int opt, const char *dir,
1020 const char *const *env, const char *tr2_class)
1022 struct child_process cmd = CHILD_PROCESS_INIT;
1023 strvec_pushv(&cmd.args, argv);
1024 cmd.no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
1025 cmd.git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
1026 cmd.stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
1027 cmd.silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
1028 cmd.use_shell = opt & RUN_USING_SHELL ? 1 : 0;
1029 cmd.clean_on_exit = opt & RUN_CLEAN_ON_EXIT ? 1 : 0;
1030 cmd.wait_after_clean = opt & RUN_WAIT_AFTER_CLEAN ? 1 : 0;
1031 cmd.close_object_store = opt & RUN_CLOSE_OBJECT_STORE ? 1 : 0;
1032 cmd.dir = dir;
1033 if (env)
1034 strvec_pushv(&cmd.env_array, (const char **)env);
1035 cmd.trace2_child_class = tr2_class;
1036 return run_command(&cmd);
1039 #ifndef NO_PTHREADS
1040 static pthread_t main_thread;
1041 static int main_thread_set;
1042 static pthread_key_t async_key;
1043 static pthread_key_t async_die_counter;
1045 static void *run_thread(void *data)
1047 struct async *async = data;
1048 intptr_t ret;
1050 if (async->isolate_sigpipe) {
1051 sigset_t mask;
1052 sigemptyset(&mask);
1053 sigaddset(&mask, SIGPIPE);
1054 if (pthread_sigmask(SIG_BLOCK, &mask, NULL) < 0) {
1055 ret = error("unable to block SIGPIPE in async thread");
1056 return (void *)ret;
1060 pthread_setspecific(async_key, async);
1061 ret = async->proc(async->proc_in, async->proc_out, async->data);
1062 return (void *)ret;
1065 static NORETURN void die_async(const char *err, va_list params)
1067 report_fn die_message_fn = get_die_message_routine();
1069 die_message_fn(err, params);
1071 if (in_async()) {
1072 struct async *async = pthread_getspecific(async_key);
1073 if (async->proc_in >= 0)
1074 close(async->proc_in);
1075 if (async->proc_out >= 0)
1076 close(async->proc_out);
1077 pthread_exit((void *)128);
1080 exit(128);
1083 static int async_die_is_recursing(void)
1085 void *ret = pthread_getspecific(async_die_counter);
1086 pthread_setspecific(async_die_counter, &async_die_counter); /* set to any non-NULL valid pointer */
1087 return ret != NULL;
1090 int in_async(void)
1092 if (!main_thread_set)
1093 return 0; /* no asyncs started yet */
1094 return !pthread_equal(main_thread, pthread_self());
1097 static void NORETURN async_exit(int code)
1099 pthread_exit((void *)(intptr_t)code);
1102 #else
1104 static struct {
1105 void (**handlers)(void);
1106 size_t nr;
1107 size_t alloc;
1108 } git_atexit_hdlrs;
1110 static int git_atexit_installed;
1112 static void git_atexit_dispatch(void)
1114 size_t i;
1116 for (i=git_atexit_hdlrs.nr ; i ; i--)
1117 git_atexit_hdlrs.handlers[i-1]();
1120 static void git_atexit_clear(void)
1122 free(git_atexit_hdlrs.handlers);
1123 memset(&git_atexit_hdlrs, 0, sizeof(git_atexit_hdlrs));
1124 git_atexit_installed = 0;
1127 #undef atexit
1128 int git_atexit(void (*handler)(void))
1130 ALLOC_GROW(git_atexit_hdlrs.handlers, git_atexit_hdlrs.nr + 1, git_atexit_hdlrs.alloc);
1131 git_atexit_hdlrs.handlers[git_atexit_hdlrs.nr++] = handler;
1132 if (!git_atexit_installed) {
1133 if (atexit(&git_atexit_dispatch))
1134 return -1;
1135 git_atexit_installed = 1;
1137 return 0;
1139 #define atexit git_atexit
1141 static int process_is_async;
1142 int in_async(void)
1144 return process_is_async;
1147 static void NORETURN async_exit(int code)
1149 exit(code);
1152 #endif
1154 void check_pipe(int err)
1156 if (err == EPIPE) {
1157 if (in_async())
1158 async_exit(141);
1160 signal(SIGPIPE, SIG_DFL);
1161 raise(SIGPIPE);
1162 /* Should never happen, but just in case... */
1163 exit(141);
1167 int start_async(struct async *async)
1169 int need_in, need_out;
1170 int fdin[2], fdout[2];
1171 int proc_in, proc_out;
1173 need_in = async->in < 0;
1174 if (need_in) {
1175 if (pipe(fdin) < 0) {
1176 if (async->out > 0)
1177 close(async->out);
1178 return error_errno("cannot create pipe");
1180 async->in = fdin[1];
1183 need_out = async->out < 0;
1184 if (need_out) {
1185 if (pipe(fdout) < 0) {
1186 if (need_in)
1187 close_pair(fdin);
1188 else if (async->in)
1189 close(async->in);
1190 return error_errno("cannot create pipe");
1192 async->out = fdout[0];
1195 if (need_in)
1196 proc_in = fdin[0];
1197 else if (async->in)
1198 proc_in = async->in;
1199 else
1200 proc_in = -1;
1202 if (need_out)
1203 proc_out = fdout[1];
1204 else if (async->out)
1205 proc_out = async->out;
1206 else
1207 proc_out = -1;
1209 #ifdef NO_PTHREADS
1210 /* Flush stdio before fork() to avoid cloning buffers */
1211 fflush(NULL);
1213 async->pid = fork();
1214 if (async->pid < 0) {
1215 error_errno("fork (async) failed");
1216 goto error;
1218 if (!async->pid) {
1219 if (need_in)
1220 close(fdin[1]);
1221 if (need_out)
1222 close(fdout[0]);
1223 git_atexit_clear();
1224 process_is_async = 1;
1225 exit(!!async->proc(proc_in, proc_out, async->data));
1228 mark_child_for_cleanup(async->pid, NULL);
1230 if (need_in)
1231 close(fdin[0]);
1232 else if (async->in)
1233 close(async->in);
1235 if (need_out)
1236 close(fdout[1]);
1237 else if (async->out)
1238 close(async->out);
1239 #else
1240 if (!main_thread_set) {
1242 * We assume that the first time that start_async is called
1243 * it is from the main thread.
1245 main_thread_set = 1;
1246 main_thread = pthread_self();
1247 pthread_key_create(&async_key, NULL);
1248 pthread_key_create(&async_die_counter, NULL);
1249 set_die_routine(die_async);
1250 set_die_is_recursing_routine(async_die_is_recursing);
1253 if (proc_in >= 0)
1254 set_cloexec(proc_in);
1255 if (proc_out >= 0)
1256 set_cloexec(proc_out);
1257 async->proc_in = proc_in;
1258 async->proc_out = proc_out;
1260 int err = pthread_create(&async->tid, NULL, run_thread, async);
1261 if (err) {
1262 error(_("cannot create async thread: %s"), strerror(err));
1263 goto error;
1266 #endif
1267 return 0;
1269 error:
1270 if (need_in)
1271 close_pair(fdin);
1272 else if (async->in)
1273 close(async->in);
1275 if (need_out)
1276 close_pair(fdout);
1277 else if (async->out)
1278 close(async->out);
1279 return -1;
1282 int finish_async(struct async *async)
1284 #ifdef NO_PTHREADS
1285 int ret = wait_or_whine(async->pid, "child process", 0);
1287 invalidate_lstat_cache();
1289 return ret;
1290 #else
1291 void *ret = (void *)(intptr_t)(-1);
1293 if (pthread_join(async->tid, &ret))
1294 error("pthread_join failed");
1295 invalidate_lstat_cache();
1296 return (int)(intptr_t)ret;
1298 #endif
1301 int async_with_fork(void)
1303 #ifdef NO_PTHREADS
1304 return 1;
1305 #else
1306 return 0;
1307 #endif
1310 struct io_pump {
1311 /* initialized by caller */
1312 int fd;
1313 int type; /* POLLOUT or POLLIN */
1314 union {
1315 struct {
1316 const char *buf;
1317 size_t len;
1318 } out;
1319 struct {
1320 struct strbuf *buf;
1321 size_t hint;
1322 } in;
1323 } u;
1325 /* returned by pump_io */
1326 int error; /* 0 for success, otherwise errno */
1328 /* internal use */
1329 struct pollfd *pfd;
1332 static int pump_io_round(struct io_pump *slots, int nr, struct pollfd *pfd)
1334 int pollsize = 0;
1335 int i;
1337 for (i = 0; i < nr; i++) {
1338 struct io_pump *io = &slots[i];
1339 if (io->fd < 0)
1340 continue;
1341 pfd[pollsize].fd = io->fd;
1342 pfd[pollsize].events = io->type;
1343 io->pfd = &pfd[pollsize++];
1346 if (!pollsize)
1347 return 0;
1349 if (poll(pfd, pollsize, -1) < 0) {
1350 if (errno == EINTR)
1351 return 1;
1352 die_errno("poll failed");
1355 for (i = 0; i < nr; i++) {
1356 struct io_pump *io = &slots[i];
1358 if (io->fd < 0)
1359 continue;
1361 if (!(io->pfd->revents & (POLLOUT|POLLIN|POLLHUP|POLLERR|POLLNVAL)))
1362 continue;
1364 if (io->type == POLLOUT) {
1365 ssize_t len = xwrite(io->fd,
1366 io->u.out.buf, io->u.out.len);
1367 if (len < 0) {
1368 io->error = errno;
1369 close(io->fd);
1370 io->fd = -1;
1371 } else {
1372 io->u.out.buf += len;
1373 io->u.out.len -= len;
1374 if (!io->u.out.len) {
1375 close(io->fd);
1376 io->fd = -1;
1381 if (io->type == POLLIN) {
1382 ssize_t len = strbuf_read_once(io->u.in.buf,
1383 io->fd, io->u.in.hint);
1384 if (len < 0)
1385 io->error = errno;
1386 if (len <= 0) {
1387 close(io->fd);
1388 io->fd = -1;
1393 return 1;
1396 static int pump_io(struct io_pump *slots, int nr)
1398 struct pollfd *pfd;
1399 int i;
1401 for (i = 0; i < nr; i++)
1402 slots[i].error = 0;
1404 ALLOC_ARRAY(pfd, nr);
1405 while (pump_io_round(slots, nr, pfd))
1406 ; /* nothing */
1407 free(pfd);
1409 /* There may be multiple errno values, so just pick the first. */
1410 for (i = 0; i < nr; i++) {
1411 if (slots[i].error) {
1412 errno = slots[i].error;
1413 return -1;
1416 return 0;
1420 int pipe_command(struct child_process *cmd,
1421 const char *in, size_t in_len,
1422 struct strbuf *out, size_t out_hint,
1423 struct strbuf *err, size_t err_hint)
1425 struct io_pump io[3];
1426 int nr = 0;
1428 if (in)
1429 cmd->in = -1;
1430 if (out)
1431 cmd->out = -1;
1432 if (err)
1433 cmd->err = -1;
1435 if (start_command(cmd) < 0)
1436 return -1;
1438 if (in) {
1439 io[nr].fd = cmd->in;
1440 io[nr].type = POLLOUT;
1441 io[nr].u.out.buf = in;
1442 io[nr].u.out.len = in_len;
1443 nr++;
1445 if (out) {
1446 io[nr].fd = cmd->out;
1447 io[nr].type = POLLIN;
1448 io[nr].u.in.buf = out;
1449 io[nr].u.in.hint = out_hint;
1450 nr++;
1452 if (err) {
1453 io[nr].fd = cmd->err;
1454 io[nr].type = POLLIN;
1455 io[nr].u.in.buf = err;
1456 io[nr].u.in.hint = err_hint;
1457 nr++;
1460 if (pump_io(io, nr) < 0) {
1461 finish_command(cmd); /* throw away exit code */
1462 return -1;
1465 return finish_command(cmd);
1468 enum child_state {
1469 GIT_CP_FREE,
1470 GIT_CP_WORKING,
1471 GIT_CP_WAIT_CLEANUP,
1474 struct parallel_processes {
1475 void *data;
1477 int max_processes;
1478 int nr_processes;
1480 get_next_task_fn get_next_task;
1481 start_failure_fn start_failure;
1482 task_finished_fn task_finished;
1484 struct {
1485 enum child_state state;
1486 struct child_process process;
1487 struct strbuf err;
1488 void *data;
1489 } *children;
1491 * The struct pollfd is logically part of *children,
1492 * but the system call expects it as its own array.
1494 struct pollfd *pfd;
1496 unsigned shutdown : 1;
1498 int output_owner;
1499 struct strbuf buffered_output; /* of finished children */
1502 static int default_start_failure(struct strbuf *out,
1503 void *pp_cb,
1504 void *pp_task_cb)
1506 return 0;
1509 static int default_task_finished(int result,
1510 struct strbuf *out,
1511 void *pp_cb,
1512 void *pp_task_cb)
1514 return 0;
1517 static void kill_children(struct parallel_processes *pp, int signo)
1519 int i, n = pp->max_processes;
1521 for (i = 0; i < n; i++)
1522 if (pp->children[i].state == GIT_CP_WORKING)
1523 kill(pp->children[i].process.pid, signo);
1526 static struct parallel_processes *pp_for_signal;
1528 static void handle_children_on_signal(int signo)
1530 kill_children(pp_for_signal, signo);
1531 sigchain_pop(signo);
1532 raise(signo);
1535 static void pp_init(struct parallel_processes *pp,
1536 int n,
1537 get_next_task_fn get_next_task,
1538 start_failure_fn start_failure,
1539 task_finished_fn task_finished,
1540 void *data)
1542 int i;
1544 if (n < 1)
1545 n = online_cpus();
1547 pp->max_processes = n;
1549 trace_printf("run_processes_parallel: preparing to run up to %d tasks", n);
1551 pp->data = data;
1552 if (!get_next_task)
1553 BUG("you need to specify a get_next_task function");
1554 pp->get_next_task = get_next_task;
1556 pp->start_failure = start_failure ? start_failure : default_start_failure;
1557 pp->task_finished = task_finished ? task_finished : default_task_finished;
1559 pp->nr_processes = 0;
1560 pp->output_owner = 0;
1561 pp->shutdown = 0;
1562 CALLOC_ARRAY(pp->children, n);
1563 CALLOC_ARRAY(pp->pfd, n);
1564 strbuf_init(&pp->buffered_output, 0);
1566 for (i = 0; i < n; i++) {
1567 strbuf_init(&pp->children[i].err, 0);
1568 child_process_init(&pp->children[i].process);
1569 pp->pfd[i].events = POLLIN | POLLHUP;
1570 pp->pfd[i].fd = -1;
1573 pp_for_signal = pp;
1574 sigchain_push_common(handle_children_on_signal);
1577 static void pp_cleanup(struct parallel_processes *pp)
1579 int i;
1581 trace_printf("run_processes_parallel: done");
1582 for (i = 0; i < pp->max_processes; i++) {
1583 strbuf_release(&pp->children[i].err);
1584 child_process_clear(&pp->children[i].process);
1587 free(pp->children);
1588 free(pp->pfd);
1591 * When get_next_task added messages to the buffer in its last
1592 * iteration, the buffered output is non empty.
1594 strbuf_write(&pp->buffered_output, stderr);
1595 strbuf_release(&pp->buffered_output);
1597 sigchain_pop_common();
1600 /* returns
1601 * 0 if a new task was started.
1602 * 1 if no new jobs was started (get_next_task ran out of work, non critical
1603 * problem with starting a new command)
1604 * <0 no new job was started, user wishes to shutdown early. Use negative code
1605 * to signal the children.
1607 static int pp_start_one(struct parallel_processes *pp)
1609 int i, code;
1611 for (i = 0; i < pp->max_processes; i++)
1612 if (pp->children[i].state == GIT_CP_FREE)
1613 break;
1614 if (i == pp->max_processes)
1615 BUG("bookkeeping is hard");
1617 code = pp->get_next_task(&pp->children[i].process,
1618 &pp->children[i].err,
1619 pp->data,
1620 &pp->children[i].data);
1621 if (!code) {
1622 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1623 strbuf_reset(&pp->children[i].err);
1624 return 1;
1626 pp->children[i].process.err = -1;
1627 pp->children[i].process.stdout_to_stderr = 1;
1628 pp->children[i].process.no_stdin = 1;
1630 if (start_command(&pp->children[i].process)) {
1631 code = pp->start_failure(&pp->children[i].err,
1632 pp->data,
1633 pp->children[i].data);
1634 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1635 strbuf_reset(&pp->children[i].err);
1636 if (code)
1637 pp->shutdown = 1;
1638 return code;
1641 pp->nr_processes++;
1642 pp->children[i].state = GIT_CP_WORKING;
1643 pp->pfd[i].fd = pp->children[i].process.err;
1644 return 0;
1647 static void pp_buffer_stderr(struct parallel_processes *pp, int output_timeout)
1649 int i;
1651 while ((i = poll(pp->pfd, pp->max_processes, output_timeout)) < 0) {
1652 if (errno == EINTR)
1653 continue;
1654 pp_cleanup(pp);
1655 die_errno("poll");
1658 /* Buffer output from all pipes. */
1659 for (i = 0; i < pp->max_processes; i++) {
1660 if (pp->children[i].state == GIT_CP_WORKING &&
1661 pp->pfd[i].revents & (POLLIN | POLLHUP)) {
1662 int n = strbuf_read_once(&pp->children[i].err,
1663 pp->children[i].process.err, 0);
1664 if (n == 0) {
1665 close(pp->children[i].process.err);
1666 pp->children[i].state = GIT_CP_WAIT_CLEANUP;
1667 } else if (n < 0)
1668 if (errno != EAGAIN)
1669 die_errno("read");
1674 static void pp_output(struct parallel_processes *pp)
1676 int i = pp->output_owner;
1677 if (pp->children[i].state == GIT_CP_WORKING &&
1678 pp->children[i].err.len) {
1679 strbuf_write(&pp->children[i].err, stderr);
1680 strbuf_reset(&pp->children[i].err);
1684 static int pp_collect_finished(struct parallel_processes *pp)
1686 int i, code;
1687 int n = pp->max_processes;
1688 int result = 0;
1690 while (pp->nr_processes > 0) {
1691 for (i = 0; i < pp->max_processes; i++)
1692 if (pp->children[i].state == GIT_CP_WAIT_CLEANUP)
1693 break;
1694 if (i == pp->max_processes)
1695 break;
1697 code = finish_command(&pp->children[i].process);
1699 code = pp->task_finished(code,
1700 &pp->children[i].err, pp->data,
1701 pp->children[i].data);
1703 if (code)
1704 result = code;
1705 if (code < 0)
1706 break;
1708 pp->nr_processes--;
1709 pp->children[i].state = GIT_CP_FREE;
1710 pp->pfd[i].fd = -1;
1711 child_process_init(&pp->children[i].process);
1713 if (i != pp->output_owner) {
1714 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1715 strbuf_reset(&pp->children[i].err);
1716 } else {
1717 strbuf_write(&pp->children[i].err, stderr);
1718 strbuf_reset(&pp->children[i].err);
1720 /* Output all other finished child processes */
1721 strbuf_write(&pp->buffered_output, stderr);
1722 strbuf_reset(&pp->buffered_output);
1725 * Pick next process to output live.
1726 * NEEDSWORK:
1727 * For now we pick it randomly by doing a round
1728 * robin. Later we may want to pick the one with
1729 * the most output or the longest or shortest
1730 * running process time.
1732 for (i = 0; i < n; i++)
1733 if (pp->children[(pp->output_owner + i) % n].state == GIT_CP_WORKING)
1734 break;
1735 pp->output_owner = (pp->output_owner + i) % n;
1738 return result;
1741 int run_processes_parallel(int n,
1742 get_next_task_fn get_next_task,
1743 start_failure_fn start_failure,
1744 task_finished_fn task_finished,
1745 void *pp_cb)
1747 int i, code;
1748 int output_timeout = 100;
1749 int spawn_cap = 4;
1750 struct parallel_processes pp;
1752 pp_init(&pp, n, get_next_task, start_failure, task_finished, pp_cb);
1753 while (1) {
1754 for (i = 0;
1755 i < spawn_cap && !pp.shutdown &&
1756 pp.nr_processes < pp.max_processes;
1757 i++) {
1758 code = pp_start_one(&pp);
1759 if (!code)
1760 continue;
1761 if (code < 0) {
1762 pp.shutdown = 1;
1763 kill_children(&pp, -code);
1765 break;
1767 if (!pp.nr_processes)
1768 break;
1769 pp_buffer_stderr(&pp, output_timeout);
1770 pp_output(&pp);
1771 code = pp_collect_finished(&pp);
1772 if (code) {
1773 pp.shutdown = 1;
1774 if (code < 0)
1775 kill_children(&pp, -code);
1779 pp_cleanup(&pp);
1780 return 0;
1783 int run_processes_parallel_tr2(int n, get_next_task_fn get_next_task,
1784 start_failure_fn start_failure,
1785 task_finished_fn task_finished, void *pp_cb,
1786 const char *tr2_category, const char *tr2_label)
1788 int result;
1790 trace2_region_enter_printf(tr2_category, tr2_label, NULL, "max:%d",
1791 ((n < 1) ? online_cpus() : n));
1793 result = run_processes_parallel(n, get_next_task, start_failure,
1794 task_finished, pp_cb);
1796 trace2_region_leave(tr2_category, tr2_label, NULL);
1798 return result;
1801 int run_auto_maintenance(int quiet)
1803 int enabled;
1804 struct child_process maint = CHILD_PROCESS_INIT;
1806 if (!git_config_get_bool("maintenance.auto", &enabled) &&
1807 !enabled)
1808 return 0;
1810 maint.git_cmd = 1;
1811 maint.close_object_store = 1;
1812 strvec_pushl(&maint.args, "maintenance", "run", "--auto", NULL);
1813 strvec_push(&maint.args, quiet ? "--quiet" : "--no-quiet");
1815 return run_command(&maint);
1818 void prepare_other_repo_env(struct strvec *env_array, const char *new_git_dir)
1820 const char * const *var;
1822 for (var = local_repo_env; *var; var++) {
1823 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT) &&
1824 strcmp(*var, CONFIG_COUNT_ENVIRONMENT))
1825 strvec_push(env_array, *var);
1827 strvec_pushf(env_array, "%s=%s", GIT_DIR_ENVIRONMENT, new_git_dir);
1830 enum start_bg_result start_bg_command(struct child_process *cmd,
1831 start_bg_wait_cb *wait_cb,
1832 void *cb_data,
1833 unsigned int timeout_sec)
1835 enum start_bg_result sbgr = SBGR_ERROR;
1836 int ret;
1837 int wait_status;
1838 pid_t pid_seen;
1839 time_t time_limit;
1842 * We do not allow clean-on-exit because the child process
1843 * should persist in the background and possibly/probably
1844 * after this process exits. So we don't want to kill the
1845 * child during our atexit routine.
1847 if (cmd->clean_on_exit)
1848 BUG("start_bg_command() does not allow non-zero clean_on_exit");
1850 if (!cmd->trace2_child_class)
1851 cmd->trace2_child_class = "background";
1853 ret = start_command(cmd);
1854 if (ret) {
1856 * We assume that if `start_command()` fails, we
1857 * either get a complete `trace2_child_start() /
1858 * trace2_child_exit()` pair or it fails before the
1859 * `trace2_child_start()` is emitted, so we do not
1860 * need to worry about it here.
1862 * We also assume that `start_command()` does not add
1863 * us to the cleanup list. And that it calls
1864 * calls `child_process_clear()`.
1866 sbgr = SBGR_ERROR;
1867 goto done;
1870 time(&time_limit);
1871 time_limit += timeout_sec;
1873 wait:
1874 pid_seen = waitpid(cmd->pid, &wait_status, WNOHANG);
1876 if (!pid_seen) {
1878 * The child is currently running. Ask the callback
1879 * if the child is ready to do work or whether we
1880 * should keep waiting for it to boot up.
1882 ret = (*wait_cb)(cmd, cb_data);
1883 if (!ret) {
1885 * The child is running and "ready".
1887 trace2_child_ready(cmd, "ready");
1888 sbgr = SBGR_READY;
1889 goto done;
1890 } else if (ret > 0) {
1892 * The callback said to give it more time to boot up
1893 * (subject to our timeout limit).
1895 time_t now;
1897 time(&now);
1898 if (now < time_limit)
1899 goto wait;
1902 * Our timeout has expired. We don't try to
1903 * kill the child, but rather let it continue
1904 * (hopefully) trying to startup.
1906 trace2_child_ready(cmd, "timeout");
1907 sbgr = SBGR_TIMEOUT;
1908 goto done;
1909 } else {
1911 * The cb gave up on this child. It is still running,
1912 * but our cb got an error trying to probe it.
1914 trace2_child_ready(cmd, "error");
1915 sbgr = SBGR_CB_ERROR;
1916 goto done;
1920 else if (pid_seen == cmd->pid) {
1921 int child_code = -1;
1924 * The child started, but exited or was terminated
1925 * before becoming "ready".
1927 * We try to match the behavior of `wait_or_whine()`
1928 * WRT the handling of WIFSIGNALED() and WIFEXITED()
1929 * and convert the child's status to a return code for
1930 * tracing purposes and emit the `trace2_child_exit()`
1931 * event.
1933 * We do not want the wait_or_whine() error message
1934 * because we will be called by client-side library
1935 * routines.
1937 if (WIFEXITED(wait_status))
1938 child_code = WEXITSTATUS(wait_status);
1939 else if (WIFSIGNALED(wait_status))
1940 child_code = WTERMSIG(wait_status) + 128;
1941 trace2_child_exit(cmd, child_code);
1943 sbgr = SBGR_DIED;
1944 goto done;
1947 else if (pid_seen < 0 && errno == EINTR)
1948 goto wait;
1950 trace2_child_exit(cmd, -1);
1951 sbgr = SBGR_ERROR;
1953 done:
1954 child_process_clear(cmd);
1955 invalidate_lstat_cache();
1956 return sbgr;