]> git.ipfire.org Git - thirdparty/git.git/blame - run-command.c
run-command.c: don't copy "data" to "struct parallel_processes"
[thirdparty/git.git] / run-command.c
CommitLineData
b1bf95bb
JW
1#include "cache.h"
2#include "run-command.h"
d807c4a0 3#include "exec-cmd.h"
afe19ff7 4#include "sigchain.h"
dbbcd44f 5#include "strvec.h"
c553c72e
SB
6#include "thread-utils.h"
7#include "strbuf.h"
f805a00a 8#include "string-list.h"
e73dd786 9#include "quote.h"
1942d483 10#include "config.h"
28d04e1e 11#include "packfile.h"
5e3aba33 12#include "hook.h"
716c1f64 13#include "compat/nonblock.h"
b1bf95bb 14
483bbd4e
RS
15void child_process_init(struct child_process *child)
16{
5726a6b4
ÆAB
17 struct child_process blank = CHILD_PROCESS_INIT;
18 memcpy(child, &blank, sizeof(*child));
483bbd4e
RS
19}
20
2d71608e
RS
21void child_process_clear(struct child_process *child)
22{
c972bf4c 23 strvec_clear(&child->args);
29fda24d 24 strvec_clear(&child->env);
2d71608e
RS
25}
26
afe19ff7
JK
27struct child_to_clean {
28 pid_t pid;
ac2fbaa6 29 struct child_process *process;
afe19ff7
JK
30 struct child_to_clean *next;
31};
32static struct child_to_clean *children_to_clean;
33static int installed_child_cleanup_handler;
34
507d7804 35static void cleanup_children(int sig, int in_signal)
afe19ff7 36{
46df6906
JK
37 struct child_to_clean *children_to_wait_for = NULL;
38
afe19ff7
JK
39 while (children_to_clean) {
40 struct child_to_clean *p = children_to_clean;
41 children_to_clean = p->next;
ac2fbaa6
LS
42
43 if (p->process && !in_signal) {
44 struct child_process *process = p->process;
45 if (process->clean_on_exit_handler) {
46 trace_printf(
47 "trace: run_command: running exit handler for pid %"
48 PRIuMAX, (uintmax_t)p->pid
49 );
50 process->clean_on_exit_handler(process);
51 }
52 }
53
afe19ff7 54 kill(p->pid, sig);
46df6906 55
7b91929b 56 if (p->process && p->process->wait_after_clean) {
46df6906
JK
57 p->next = children_to_wait_for;
58 children_to_wait_for = p;
59 } else {
60 if (!in_signal)
61 free(p);
62 }
63 }
64
65 while (children_to_wait_for) {
66 struct child_to_clean *p = children_to_wait_for;
67 children_to_wait_for = p->next;
68
69 while (waitpid(p->pid, NULL, 0) < 0 && errno == EINTR)
70 ; /* spin waiting for process exit or error */
71
507d7804
TI
72 if (!in_signal)
73 free(p);
afe19ff7
JK
74 }
75}
76
77static void cleanup_children_on_signal(int sig)
78{
507d7804 79 cleanup_children(sig, 1);
afe19ff7
JK
80 sigchain_pop(sig);
81 raise(sig);
82}
83
84static void cleanup_children_on_exit(void)
85{
507d7804 86 cleanup_children(SIGTERM, 0);
afe19ff7
JK
87}
88
ac2fbaa6 89static void mark_child_for_cleanup(pid_t pid, struct child_process *process)
afe19ff7
JK
90{
91 struct child_to_clean *p = xmalloc(sizeof(*p));
92 p->pid = pid;
ac2fbaa6 93 p->process = process;
afe19ff7
JK
94 p->next = children_to_clean;
95 children_to_clean = p;
96
97 if (!installed_child_cleanup_handler) {
98 atexit(cleanup_children_on_exit);
99 sigchain_push_common(cleanup_children_on_signal);
100 installed_child_cleanup_handler = 1;
101 }
102}
103
104static void clear_child_for_cleanup(pid_t pid)
105{
bdee397d 106 struct child_to_clean **pp;
afe19ff7 107
bdee397d
DG
108 for (pp = &children_to_clean; *pp; pp = &(*pp)->next) {
109 struct child_to_clean *clean_me = *pp;
110
111 if (clean_me->pid == pid) {
112 *pp = clean_me->next;
113 free(clean_me);
afe19ff7
JK
114 return;
115 }
116 }
117}
118
9dc09c76
SP
119static inline void close_pair(int fd[2])
120{
121 close(fd[0]);
122 close(fd[1]);
123}
124
38124a40
BW
125int is_executable(const char *name)
126{
127 struct stat st;
128
129 if (stat(name, &st) || /* stat, not lstat */
130 !S_ISREG(st.st_mode))
131 return 0;
132
133#if defined(GIT_WINDOWS_NATIVE)
134 /*
135 * On Windows there is no executable bit. The file extension
136 * indicates whether it can be run as an executable, and Git
137 * has special-handling to detect scripts and launch them
138 * through the indicated script interpreter. We test for the
139 * file extension first because virus scanners may make
140 * it quite expensive to open many files.
141 */
142 if (ends_with(name, ".exe"))
143 return S_IXUSR;
144
145{
146 /*
147 * Now that we know it does not have an executable extension,
148 * peek into the file instead.
149 */
150 char buf[3] = { 0 };
151 int n;
152 int fd = open(name, O_RDONLY);
153 st.st_mode &= ~S_IXUSR;
154 if (fd >= 0) {
155 n = read(fd, buf, 2);
156 if (n == 2)
157 /* look for a she-bang */
158 if (!strcmp(buf, "#!"))
159 st.st_mode |= S_IXUSR;
160 close(fd);
161 }
162}
163#endif
164 return st.st_mode & S_IXUSR;
165}
166
94028310
BW
167/*
168 * Search $PATH for a command. This emulates the path search that
169 * execvp would perform, without actually executing the command so it
170 * can be used before fork() to prepare to run a command using
171 * execve() or after execvp() to diagnose why it failed.
172 *
173 * The caller should ensure that file contains no directory
174 * separators.
175 *
176 * Returns the path to the command, as found in $PATH or NULL if the
177 * command could not be found. The caller inherits ownership of the memory
178 * used to store the resultant path.
179 *
180 * This should not be used on Windows, where the $PATH search rules
181 * are more complicated (e.g., a search for "foo" should find
182 * "foo.exe").
183 */
38f865c2
JK
184static char *locate_in_PATH(const char *file)
185{
186 const char *p = getenv("PATH");
187 struct strbuf buf = STRBUF_INIT;
188
189 if (!p || !*p)
190 return NULL;
191
192 while (1) {
193 const char *end = strchrnul(p, ':');
194
195 strbuf_reset(&buf);
196
197 /* POSIX specifies an empty entry as the current directory. */
198 if (end != p) {
199 strbuf_add(&buf, p, end - p);
200 strbuf_addch(&buf, '/');
201 }
202 strbuf_addstr(&buf, file);
203
94028310 204 if (is_executable(buf.buf))
38f865c2
JK
205 return strbuf_detach(&buf, NULL);
206
207 if (!*end)
208 break;
209 p = end + 1;
210 }
211
212 strbuf_release(&buf);
213 return NULL;
214}
215
3f36e6f3 216int exists_in_PATH(const char *command)
38f865c2 217{
3f36e6f3 218 char *r = locate_in_PATH(command);
63ab08fb 219 int found = r != NULL;
38f865c2 220 free(r);
63ab08fb 221 return found;
38f865c2
JK
222}
223
224int sane_execvp(const char *file, char * const argv[])
225{
ee4512ed
JH
226#ifndef GIT_WINDOWS_NATIVE
227 /*
228 * execvp() doesn't return, so we all we can do is tell trace2
229 * what we are about to do and let it leave a hint in the log
230 * (unless of course the execvp() fails).
231 *
232 * we skip this for Windows because the compat layer already
233 * has to emulate the execvp() call anyway.
234 */
235 int exec_id = trace2_exec(file, (const char **)argv);
236#endif
237
38f865c2
JK
238 if (!execvp(file, argv))
239 return 0; /* cannot happen ;-) */
240
ee4512ed
JH
241#ifndef GIT_WINDOWS_NATIVE
242 {
243 int ec = errno;
244 trace2_exec_result(exec_id, ec);
245 errno = ec;
246 }
247#endif
248
38f865c2
JK
249 /*
250 * When a command can't be found because one of the directories
251 * listed in $PATH is unsearchable, execvp reports EACCES, but
252 * careful usability testing (read: analysis of occasional bug
253 * reports) reveals that "No such file or directory" is more
254 * intuitive.
255 *
256 * We avoid commands with "/", because execvp will not do $PATH
257 * lookups in that case.
258 *
259 * The reassignment of EACCES to errno looks like a no-op below,
260 * but we need to protect against exists_in_PATH overwriting errno.
261 */
262 if (errno == EACCES && !strchr(file, '/'))
263 errno = exists_in_PATH(file) ? EACCES : ENOENT;
a7855083
JH
264 else if (errno == ENOTDIR && !strchr(file, '/'))
265 errno = ENOENT;
38f865c2
JK
266 return -1;
267}
268
c972bf4c 269static const char **prepare_shell_cmd(struct strvec *out, const char **argv)
8dba1e63 270{
20574f55 271 if (!argv[0])
033abf97 272 BUG("shell command is empty");
8dba1e63 273
f445644f 274 if (strcspn(argv[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv[0])) {
380395d0 275#ifndef GIT_WINDOWS_NATIVE
c972bf4c 276 strvec_push(out, SHELL_PATH);
77629754 277#else
c972bf4c 278 strvec_push(out, "sh");
77629754 279#endif
c972bf4c 280 strvec_push(out, "-c");
8dba1e63 281
20574f55
JK
282 /*
283 * If we have no extra arguments, we do not even need to
284 * bother with the "$@" magic.
285 */
286 if (!argv[1])
c972bf4c 287 strvec_push(out, argv[0]);
20574f55 288 else
c972bf4c 289 strvec_pushf(out, "%s \"$@\"", argv[0]);
20574f55 290 }
8dba1e63 291
c972bf4c 292 strvec_pushv(out, argv);
d70a9eb6 293 return out->v;
8dba1e63
JK
294}
295
380395d0 296#ifndef GIT_WINDOWS_NATIVE
2b541bf8
JS
297static int child_notifier = -1;
298
79319b19
BW
299enum child_errcode {
300 CHILD_ERR_CHDIR,
53fa6753
BW
301 CHILD_ERR_DUP2,
302 CHILD_ERR_CLOSE,
45afb1ca 303 CHILD_ERR_SIGPROCMASK,
79319b19
BW
304 CHILD_ERR_ENOENT,
305 CHILD_ERR_SILENT,
306 CHILD_ERR_ERRNO
307};
308
309struct child_err {
310 enum child_errcode err;
311 int syserr; /* errno */
312};
313
314static void child_die(enum child_errcode err)
2b541bf8 315{
79319b19
BW
316 struct child_err buf;
317
318 buf.err = err;
319 buf.syserr = errno;
320
321 /* write(2) on buf smaller than PIPE_BUF (min 512) is atomic: */
322 xwrite(child_notifier, &buf, sizeof(buf));
323 _exit(1);
324}
325
53fa6753
BW
326static void child_dup2(int fd, int to)
327{
328 if (dup2(fd, to) < 0)
329 child_die(CHILD_ERR_DUP2);
330}
331
332static void child_close(int fd)
333{
334 if (close(fd))
335 child_die(CHILD_ERR_CLOSE);
336}
337
338static void child_close_pair(int fd[2])
339{
340 child_close(fd[0]);
341 child_close(fd[1]);
342}
343
79319b19
BW
344static void child_error_fn(const char *err, va_list params)
345{
346 const char msg[] = "error() should not be called in child\n";
347 xwrite(2, msg, sizeof(msg) - 1);
348}
349
350static void child_warn_fn(const char *err, va_list params)
351{
352 const char msg[] = "warn() should not be called in child\n";
353 xwrite(2, msg, sizeof(msg) - 1);
354}
355
356static void NORETURN child_die_fn(const char *err, va_list params)
357{
358 const char msg[] = "die() should not be called in child\n";
359 xwrite(2, msg, sizeof(msg) - 1);
360 _exit(2);
361}
362
363/* this runs in the parent process */
364static void child_err_spew(struct child_process *cmd, struct child_err *cerr)
365{
366 static void (*old_errfn)(const char *err, va_list params);
e081a7c3 367 report_fn die_message_routine = get_die_message_routine();
79319b19
BW
368
369 old_errfn = get_error_routine();
e081a7c3 370 set_error_routine(die_message_routine);
79319b19
BW
371 errno = cerr->syserr;
372
373 switch (cerr->err) {
374 case CHILD_ERR_CHDIR:
375 error_errno("exec '%s': cd to '%s' failed",
d3b21597 376 cmd->args.v[0], cmd->dir);
79319b19 377 break;
53fa6753
BW
378 case CHILD_ERR_DUP2:
379 error_errno("dup2() in child failed");
380 break;
381 case CHILD_ERR_CLOSE:
382 error_errno("close() in child failed");
383 break;
45afb1ca
EW
384 case CHILD_ERR_SIGPROCMASK:
385 error_errno("sigprocmask failed restoring signals");
386 break;
79319b19 387 case CHILD_ERR_ENOENT:
d3b21597 388 error_errno("cannot run %s", cmd->args.v[0]);
79319b19
BW
389 break;
390 case CHILD_ERR_SILENT:
391 break;
392 case CHILD_ERR_ERRNO:
d3b21597 393 error_errno("cannot exec '%s'", cmd->args.v[0]);
79319b19
BW
394 break;
395 }
396 set_error_routine(old_errfn);
2b541bf8 397}
3967e25b 398
c972bf4c 399static int prepare_cmd(struct strvec *out, const struct child_process *cmd)
3967e25b 400{
d3b21597 401 if (!cmd->args.v[0])
033abf97 402 BUG("command is empty");
3967e25b 403
e3a43446
BW
404 /*
405 * Add SHELL_PATH so in the event exec fails with ENOEXEC we can
406 * attempt to interpret the command with 'sh'.
407 */
c972bf4c 408 strvec_push(out, SHELL_PATH);
e3a43446 409
3967e25b 410 if (cmd->git_cmd) {
d3b21597 411 prepare_git_cmd(out, cmd->args.v);
3967e25b 412 } else if (cmd->use_shell) {
d3b21597 413 prepare_shell_cmd(out, cmd->args.v);
3967e25b 414 } else {
d3b21597 415 strvec_pushv(out, cmd->args.v);
3967e25b 416 }
e3a43446
BW
417
418 /*
05ac8582
AK
419 * If there are no dir separator characters in the command then perform
420 * a path lookup and use the resolved path as the command to exec. If
421 * there are dir separator characters, we have exec attempt to invoke
422 * the command directly.
e3a43446 423 */
d70a9eb6
JK
424 if (!has_dir_sep(out->v[1])) {
425 char *program = locate_in_PATH(out->v[1]);
e3a43446 426 if (program) {
d70a9eb6
JK
427 free((char *)out->v[1]);
428 out->v[1] = program;
321fd823 429 } else {
c972bf4c 430 strvec_clear(out);
321fd823
JK
431 errno = ENOENT;
432 return -1;
e3a43446
BW
433 }
434 }
321fd823
JK
435
436 return 0;
3967e25b 437}
ae25394b
BW
438
439static char **prep_childenv(const char *const *deltaenv)
440{
441 extern char **environ;
442 char **childenv;
443 struct string_list env = STRING_LIST_INIT_DUP;
444 struct strbuf key = STRBUF_INIT;
445 const char *const *p;
446 int i;
447
448 /* Construct a sorted string list consisting of the current environ */
449 for (p = (const char *const *) environ; p && *p; p++) {
450 const char *equals = strchr(*p, '=');
451
452 if (equals) {
453 strbuf_reset(&key);
454 strbuf_add(&key, *p, equals - *p);
455 string_list_append(&env, key.buf)->util = (void *) *p;
456 } else {
457 string_list_append(&env, *p)->util = (void *) *p;
458 }
459 }
460 string_list_sort(&env);
461
462 /* Merge in 'deltaenv' with the current environ */
463 for (p = deltaenv; p && *p; p++) {
464 const char *equals = strchr(*p, '=');
465
466 if (equals) {
467 /* ('key=value'), insert or replace entry */
468 strbuf_reset(&key);
469 strbuf_add(&key, *p, equals - *p);
470 string_list_insert(&env, key.buf)->util = (void *) *p;
471 } else {
472 /* otherwise ('key') remove existing entry */
473 string_list_remove(&env, *p, 0);
474 }
475 }
476
477 /* Create an array of 'char *' to be used as the childenv */
0e187d75 478 ALLOC_ARRAY(childenv, env.nr + 1);
ae25394b
BW
479 for (i = 0; i < env.nr; i++)
480 childenv[i] = env.items[i].util;
481 childenv[env.nr] = NULL;
482
483 string_list_clear(&env, 0);
484 strbuf_release(&key);
485 return childenv;
486}
45afb1ca
EW
487
488struct atfork_state {
489#ifndef NO_PTHREADS
490 int cs;
491#endif
492 sigset_t old;
493};
494
dde74d73
JS
495#define CHECK_BUG(err, msg) \
496 do { \
497 int e = (err); \
498 if (e) \
499 BUG("%s: %s", msg, strerror(e)); \
500 } while(0)
45afb1ca
EW
501
502static void atfork_prepare(struct atfork_state *as)
503{
504 sigset_t all;
505
506 if (sigfillset(&all))
507 die_errno("sigfillset");
508#ifdef NO_PTHREADS
509 if (sigprocmask(SIG_SETMASK, &all, &as->old))
510 die_errno("sigprocmask");
511#else
dde74d73 512 CHECK_BUG(pthread_sigmask(SIG_SETMASK, &all, &as->old),
45afb1ca 513 "blocking all signals");
dde74d73 514 CHECK_BUG(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &as->cs),
45afb1ca
EW
515 "disabling cancellation");
516#endif
517}
518
519static void atfork_parent(struct atfork_state *as)
520{
521#ifdef NO_PTHREADS
522 if (sigprocmask(SIG_SETMASK, &as->old, NULL))
523 die_errno("sigprocmask");
524#else
dde74d73 525 CHECK_BUG(pthread_setcancelstate(as->cs, NULL),
45afb1ca 526 "re-enabling cancellation");
dde74d73 527 CHECK_BUG(pthread_sigmask(SIG_SETMASK, &as->old, NULL),
45afb1ca 528 "restoring signal mask");
200a76b7 529#endif
45afb1ca
EW
530}
531#endif /* GIT_WINDOWS_NATIVE */
a5487ddf
JS
532
533static inline void set_cloexec(int fd)
534{
535 int flags = fcntl(fd, F_GETFD);
536 if (flags >= 0)
537 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
538}
a5487ddf 539
507d7804 540static int wait_or_whine(pid_t pid, const char *argv0, int in_signal)
ab0b41da
JS
541{
542 int status, code = -1;
543 pid_t waiting;
544 int failed_errno = 0;
545
546 while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
547 ; /* nothing */
548
549 if (waiting < 0) {
550 failed_errno = errno;
96bfb2d8
JK
551 if (!in_signal)
552 error_errno("waitpid for %s failed", argv0);
ab0b41da 553 } else if (waiting != pid) {
96bfb2d8
JK
554 if (!in_signal)
555 error("waitpid is confused (%s)", argv0);
ab0b41da
JS
556 } else if (WIFSIGNALED(status)) {
557 code = WTERMSIG(status);
96bfb2d8 558 if (!in_signal && code != SIGINT && code != SIGQUIT && code != SIGPIPE)
a2767c5c 559 error("%s died of signal %d", argv0, code);
ab0b41da
JS
560 /*
561 * This return value is chosen so that code & 0xff
562 * mimics the exit code that a POSIX shell would report for
563 * a program that died from this signal.
564 */
709ca730 565 code += 128;
ab0b41da
JS
566 } else if (WIFEXITED(status)) {
567 code = WEXITSTATUS(status);
ab0b41da 568 } else {
96bfb2d8
JK
569 if (!in_signal)
570 error("waitpid is confused (%s)", argv0);
ab0b41da 571 }
afe19ff7 572
96bfb2d8
JK
573 if (!in_signal)
574 clear_child_for_cleanup(pid);
afe19ff7 575
ab0b41da
JS
576 errno = failed_errno;
577 return code;
578}
579
c61a975d
NTND
580static void trace_add_env(struct strbuf *dst, const char *const *deltaenv)
581{
582 struct string_list envs = STRING_LIST_INIT_DUP;
583 const char *const *e;
584 int i;
585 int printed_unset = 0;
586
587 /* Last one wins, see run-command.c:prep_childenv() for context */
588 for (e = deltaenv; e && *e; e++) {
589 struct strbuf key = STRBUF_INIT;
590 char *equals = strchr(*e, '=');
591
592 if (equals) {
593 strbuf_add(&key, *e, equals - *e);
594 string_list_insert(&envs, key.buf)->util = equals + 1;
595 } else {
596 string_list_insert(&envs, *e)->util = NULL;
597 }
598 strbuf_release(&key);
599 }
600
601 /* "unset X Y...;" */
602 for (i = 0; i < envs.nr; i++) {
603 const char *var = envs.items[i].string;
604 const char *val = envs.items[i].util;
605
606 if (val || !getenv(var))
607 continue;
608
609 if (!printed_unset) {
610 strbuf_addstr(dst, " unset");
611 printed_unset = 1;
612 }
613 strbuf_addf(dst, " %s", var);
614 }
615 if (printed_unset)
616 strbuf_addch(dst, ';');
617
618 /* ... followed by "A=B C=D ..." */
619 for (i = 0; i < envs.nr; i++) {
620 const char *var = envs.items[i].string;
621 const char *val = envs.items[i].util;
622 const char *oldval;
623
624 if (!val)
625 continue;
626
627 oldval = getenv(var);
628 if (oldval && !strcmp(val, oldval))
629 continue;
630
631 strbuf_addf(dst, " %s=", var);
632 sq_quote_buf_pretty(dst, val);
633 }
634 string_list_clear(&envs, 0);
635}
636
e73dd786
NTND
637static void trace_run_command(const struct child_process *cp)
638{
639 struct strbuf buf = STRBUF_INIT;
640
641 if (!trace_want(&trace_default_key))
642 return;
643
248f66ed 644 strbuf_addstr(&buf, "trace: run_command:");
090a0927
NTND
645 if (cp->dir) {
646 strbuf_addstr(&buf, " cd ");
647 sq_quote_buf_pretty(&buf, cp->dir);
648 strbuf_addch(&buf, ';');
649 }
29fda24d 650 trace_add_env(&buf, cp->env.v);
21dfc5e0
NTND
651 if (cp->git_cmd)
652 strbuf_addstr(&buf, " git");
d3b21597 653 sq_quote_argv_pretty(&buf, cp->args.v);
e73dd786
NTND
654
655 trace_printf("%s", buf.buf);
656 strbuf_release(&buf);
657}
658
ebcb5d16 659int start_command(struct child_process *cmd)
b1bf95bb 660{
f3b33f1d
JS
661 int need_in, need_out, need_err;
662 int fdin[2], fdout[2], fderr[2];
25043d8a 663 int failed_errno;
939296c4 664 char *str;
4919bf03 665
c20181e3
JS
666 /*
667 * In case of errors we must keep the promise to close FDs
668 * that have been passed in via ->in and ->out.
669 */
670
e4507ae8 671 need_in = !cmd->no_stdin && cmd->in < 0;
4919bf03 672 if (need_in) {
c20181e3 673 if (pipe(fdin) < 0) {
0ac77ec3 674 failed_errno = errno;
c20181e3
JS
675 if (cmd->out > 0)
676 close(cmd->out);
939296c4 677 str = "standard input";
0ac77ec3 678 goto fail_pipe;
c20181e3 679 }
4919bf03 680 cmd->in = fdin[1];
4919bf03
SP
681 }
682
e4507ae8
SP
683 need_out = !cmd->no_stdout
684 && !cmd->stdout_to_stderr
685 && cmd->out < 0;
f4bba25b
SP
686 if (need_out) {
687 if (pipe(fdout) < 0) {
0ac77ec3 688 failed_errno = errno;
f4bba25b
SP
689 if (need_in)
690 close_pair(fdin);
c20181e3
JS
691 else if (cmd->in)
692 close(cmd->in);
939296c4 693 str = "standard output";
0ac77ec3 694 goto fail_pipe;
f4bba25b
SP
695 }
696 cmd->out = fdout[0];
f4bba25b
SP
697 }
698
b73a4397 699 need_err = !cmd->no_stderr && cmd->err < 0;
f3b33f1d
JS
700 if (need_err) {
701 if (pipe(fderr) < 0) {
0ac77ec3 702 failed_errno = errno;
f3b33f1d
JS
703 if (need_in)
704 close_pair(fdin);
c20181e3
JS
705 else if (cmd->in)
706 close(cmd->in);
f3b33f1d
JS
707 if (need_out)
708 close_pair(fdout);
c20181e3
JS
709 else if (cmd->out)
710 close(cmd->out);
939296c4 711 str = "standard error";
0ac77ec3 712fail_pipe:
939296c4 713 error("cannot create %s pipe for %s: %s",
d3b21597 714 str, cmd->args.v[0], strerror(failed_errno));
2d71608e 715 child_process_clear(cmd);
0ac77ec3
JS
716 errno = failed_errno;
717 return -1;
f3b33f1d
JS
718 }
719 cmd->err = fderr[0];
720 }
721
ee4512ed 722 trace2_child_start(cmd);
e73dd786
NTND
723 trace_run_command(cmd);
724
13af8cbd 725 fflush(NULL);
8852f5d7 726
28d04e1e
JS
727 if (cmd->close_object_store)
728 close_object_store(the_repository->objects);
729
380395d0 730#ifndef GIT_WINDOWS_NATIVE
2b541bf8
JS
731{
732 int notify_pipe[2];
db015a28 733 int null_fd = -1;
ae25394b 734 char **childenv;
c972bf4c 735 struct strvec argv = STRVEC_INIT;
79319b19 736 struct child_err cerr;
45afb1ca 737 struct atfork_state as;
3967e25b 738
321fd823
JK
739 if (prepare_cmd(&argv, cmd) < 0) {
740 failed_errno = errno;
741 cmd->pid = -1;
e5a329a2 742 if (!cmd->silent_exec_failure)
d3b21597 743 error_errno("cannot run %s", cmd->args.v[0]);
321fd823
JK
744 goto end_of_spawn;
745 }
746
2b541bf8
JS
747 if (pipe(notify_pipe))
748 notify_pipe[0] = notify_pipe[1] = -1;
749
db015a28 750 if (cmd->no_stdin || cmd->no_stdout || cmd->no_stderr) {
66e905b7 751 null_fd = xopen("/dev/null", O_RDWR | O_CLOEXEC);
db015a28
BW
752 set_cloexec(null_fd);
753 }
754
29fda24d 755 childenv = prep_childenv(cmd->env.v);
45afb1ca 756 atfork_prepare(&as);
3967e25b 757
e503cd6e
BW
758 /*
759 * NOTE: In order to prevent deadlocking when using threads special
760 * care should be taken with the function calls made in between the
761 * fork() and exec() calls. No calls should be made to functions which
762 * require acquiring a lock (e.g. malloc) as the lock could have been
763 * held by another thread at the time of forking, causing the lock to
764 * never be released in the child process. This means only
765 * Async-Signal-Safe functions are permitted in the child.
766 */
ebcb5d16 767 cmd->pid = fork();
25043d8a 768 failed_errno = errno;
ebcb5d16 769 if (!cmd->pid) {
45afb1ca 770 int sig;
a5487ddf 771 /*
79319b19
BW
772 * Ensure the default die/error/warn routines do not get
773 * called, they can take stdio locks and malloc.
a5487ddf 774 */
79319b19
BW
775 set_die_routine(child_die_fn);
776 set_error_routine(child_error_fn);
777 set_warn_routine(child_warn_fn);
a5487ddf 778
2b541bf8
JS
779 close(notify_pipe[0]);
780 set_cloexec(notify_pipe[1]);
781 child_notifier = notify_pipe[1];
2b541bf8 782
e4507ae8 783 if (cmd->no_stdin)
53fa6753 784 child_dup2(null_fd, 0);
e4507ae8 785 else if (need_in) {
53fa6753
BW
786 child_dup2(fdin[0], 0);
787 child_close_pair(fdin);
4919bf03 788 } else if (cmd->in) {
53fa6753
BW
789 child_dup2(cmd->in, 0);
790 child_close(cmd->in);
95d3c4f5 791 }
4919bf03 792
ce2cf27a 793 if (cmd->no_stderr)
53fa6753 794 child_dup2(null_fd, 2);
ce2cf27a 795 else if (need_err) {
53fa6753
BW
796 child_dup2(fderr[1], 2);
797 child_close_pair(fderr);
4f41b611 798 } else if (cmd->err > 1) {
53fa6753
BW
799 child_dup2(cmd->err, 2);
800 child_close(cmd->err);
ce2cf27a
CC
801 }
802
e4507ae8 803 if (cmd->no_stdout)
53fa6753 804 child_dup2(null_fd, 1);
e4507ae8 805 else if (cmd->stdout_to_stderr)
53fa6753 806 child_dup2(2, 1);
f4bba25b 807 else if (need_out) {
53fa6753
BW
808 child_dup2(fdout[1], 1);
809 child_close_pair(fdout);
f4bba25b 810 } else if (cmd->out > 1) {
53fa6753
BW
811 child_dup2(cmd->out, 1);
812 child_close(cmd->out);
f4bba25b
SP
813 }
814
1568fea0 815 if (cmd->dir && chdir(cmd->dir))
79319b19 816 child_die(CHILD_ERR_CHDIR);
3967e25b 817
45afb1ca
EW
818 /*
819 * restore default signal handlers here, in case
820 * we catch a signal right before execve below
821 */
822 for (sig = 1; sig < NSIG; sig++) {
823 /* ignored signals get reset to SIG_DFL on execve */
824 if (signal(sig, SIG_DFL) == SIG_IGN)
825 signal(sig, SIG_IGN);
826 }
827
828 if (sigprocmask(SIG_SETMASK, &as.old, NULL) != 0)
829 child_die(CHILD_ERR_SIGPROCMASK);
830
e3a43446
BW
831 /*
832 * Attempt to exec using the command and arguments starting at
833 * argv.argv[1]. argv.argv[0] contains SHELL_PATH which will
834 * be used in the event exec failed with ENOEXEC at which point
835 * we will try to interpret the command using 'sh'.
836 */
d70a9eb6 837 execve(argv.v[1], (char *const *) argv.v + 1,
ae25394b 838 (char *const *) childenv);
e3a43446 839 if (errno == ENOEXEC)
d70a9eb6 840 execve(argv.v[0], (char *const *) argv.v,
ae25394b 841 (char *const *) childenv);
3967e25b 842
fc1b56f0 843 if (errno == ENOENT) {
79319b19
BW
844 if (cmd->silent_exec_failure)
845 child_die(CHILD_ERR_SILENT);
846 child_die(CHILD_ERR_ENOENT);
fc1b56f0 847 } else {
79319b19 848 child_die(CHILD_ERR_ERRNO);
fc1b56f0 849 }
b1bf95bb 850 }
45afb1ca 851 atfork_parent(&as);
0ac77ec3 852 if (cmd->pid < 0)
d3b21597 853 error_errno("cannot fork() for %s", cmd->args.v[0]);
afe19ff7 854 else if (cmd->clean_on_exit)
ac2fbaa6 855 mark_child_for_cleanup(cmd->pid, cmd);
2b541bf8
JS
856
857 /*
3967e25b 858 * Wait for child's exec. If the exec succeeds (or if fork()
2b541bf8 859 * failed), EOF is seen immediately by the parent. Otherwise, the
79319b19 860 * child process sends a child_err struct.
2b541bf8
JS
861 * Note that use of this infrastructure is completely advisory,
862 * therefore, we keep error checks minimal.
863 */
864 close(notify_pipe[1]);
79319b19 865 if (xread(notify_pipe[0], &cerr, sizeof(cerr)) == sizeof(cerr)) {
2b541bf8 866 /*
3967e25b 867 * At this point we know that fork() succeeded, but exec()
2b541bf8
JS
868 * failed. Errors have been reported to our stderr.
869 */
d3b21597 870 wait_or_whine(cmd->pid, cmd->args.v[0], 0);
79319b19 871 child_err_spew(cmd, &cerr);
2b541bf8
JS
872 failed_errno = errno;
873 cmd->pid = -1;
874 }
875 close(notify_pipe[0]);
3967e25b 876
db015a28
BW
877 if (null_fd >= 0)
878 close(null_fd);
c972bf4c 879 strvec_clear(&argv);
ae25394b 880 free(childenv);
2b541bf8 881}
321fd823
JK
882end_of_spawn:
883
ba26f296 884#else
0d30ad71 885{
75301f90 886 int fhin = 0, fhout = 1, fherr = 2;
d3b21597 887 const char **sargv = cmd->args.v;
c972bf4c 888 struct strvec nargv = STRVEC_INIT;
ba26f296 889
75301f90
JS
890 if (cmd->no_stdin)
891 fhin = open("/dev/null", O_RDWR);
892 else if (need_in)
893 fhin = dup(fdin[0]);
894 else if (cmd->in)
895 fhin = dup(cmd->in);
896
897 if (cmd->no_stderr)
898 fherr = open("/dev/null", O_RDWR);
899 else if (need_err)
900 fherr = dup(fderr[1]);
76d44c8c
JH
901 else if (cmd->err > 2)
902 fherr = dup(cmd->err);
75301f90
JS
903
904 if (cmd->no_stdout)
905 fhout = open("/dev/null", O_RDWR);
906 else if (cmd->stdout_to_stderr)
907 fhout = dup(fherr);
908 else if (need_out)
909 fhout = dup(fdout[1]);
910 else if (cmd->out > 1)
911 fhout = dup(cmd->out);
ba26f296 912
5a50085c 913 if (cmd->git_cmd)
d3b21597 914 cmd->args.v = prepare_git_cmd(&nargv, sargv);
5a50085c 915 else if (cmd->use_shell)
d3b21597 916 cmd->args.v = prepare_shell_cmd(&nargv, sargv);
ba26f296 917
29fda24d
ÆAB
918 cmd->pid = mingw_spawnvpe(cmd->args.v[0], cmd->args.v,
919 (char**) cmd->env.v,
920 cmd->dir, fhin, fhout, fherr);
0ac77ec3 921 failed_errno = errno;
c024beb5 922 if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
d3b21597 923 error_errno("cannot spawn %s", cmd->args.v[0]);
afe19ff7 924 if (cmd->clean_on_exit && cmd->pid >= 0)
ac2fbaa6 925 mark_child_for_cleanup(cmd->pid, cmd);
ba26f296 926
c972bf4c 927 strvec_clear(&nargv);
d3b21597 928 cmd->args.v = sargv;
75301f90
JS
929 if (fhin != 0)
930 close(fhin);
931 if (fhout != 1)
932 close(fhout);
933 if (fherr != 2)
934 close(fherr);
0d30ad71 935}
ba26f296
JS
936#endif
937
938 if (cmd->pid < 0) {
ee4512ed
JH
939 trace2_child_exit(cmd, -1);
940
ba26f296
JS
941 if (need_in)
942 close_pair(fdin);
943 else if (cmd->in)
944 close(cmd->in);
945 if (need_out)
946 close_pair(fdout);
947 else if (cmd->out)
948 close(cmd->out);
949 if (need_err)
950 close_pair(fderr);
fc012c28
D
951 else if (cmd->err)
952 close(cmd->err);
2d71608e 953 child_process_clear(cmd);
0ac77ec3
JS
954 errno = failed_errno;
955 return -1;
ba26f296 956 }
4919bf03
SP
957
958 if (need_in)
959 close(fdin[0]);
960 else if (cmd->in)
961 close(cmd->in);
962
f4bba25b
SP
963 if (need_out)
964 close(fdout[1]);
c20181e3 965 else if (cmd->out)
f4bba25b
SP
966 close(cmd->out);
967
f3b33f1d
JS
968 if (need_err)
969 close(fderr[1]);
4f41b611
SP
970 else if (cmd->err)
971 close(cmd->err);
f3b33f1d 972
ebcb5d16
SP
973 return 0;
974}
975
2d22c208
JS
976int finish_command(struct child_process *cmd)
977{
d3b21597 978 int ret = wait_or_whine(cmd->pid, cmd->args.v[0], 0);
ee4512ed 979 trace2_child_exit(cmd, ret);
2d71608e 980 child_process_clear(cmd);
0d58fef5 981 invalidate_lstat_cache();
c460c0ec 982 return ret;
2d22c208
JS
983}
984
507d7804
TI
985int finish_command_in_signal(struct child_process *cmd)
986{
d3b21597 987 int ret = wait_or_whine(cmd->pid, cmd->args.v[0], 1);
ce3986bb
JS
988 if (ret != -1)
989 trace2_child_exit(cmd, ret);
ee4512ed 990 return ret;
507d7804
TI
991}
992
993
ebcb5d16
SP
994int run_command(struct child_process *cmd)
995{
c29b3962
JK
996 int code;
997
998 if (cmd->out < 0 || cmd->err < 0)
033abf97 999 BUG("run_command with a pipe can cause deadlock");
c29b3962
JK
1000
1001 code = start_command(cmd);
ebcb5d16
SP
1002 if (code)
1003 return code;
1004 return finish_command(cmd);
1005}
1006
f1000898
SP
1007int run_command_v_opt(const char **argv, int opt)
1008{
41e9bad7 1009 return run_command_v_opt_cd_env(argv, opt, NULL, NULL);
1568fea0
AR
1010}
1011
ee4512ed
JH
1012int run_command_v_opt_tr2(const char **argv, int opt, const char *tr2_class)
1013{
1014 return run_command_v_opt_cd_env_tr2(argv, opt, NULL, NULL, tr2_class);
1015}
1016
ee493148 1017int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
ee4512ed
JH
1018{
1019 return run_command_v_opt_cd_env_tr2(argv, opt, dir, env, NULL);
1020}
1021
1022int run_command_v_opt_cd_env_tr2(const char **argv, int opt, const char *dir,
1023 const char *const *env, const char *tr2_class)
ee493148 1024{
1f87293d 1025 struct child_process cmd = CHILD_PROCESS_INIT;
6def0ff8 1026 strvec_pushv(&cmd.args, argv);
1f87293d
RS
1027 cmd.no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
1028 cmd.git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
1029 cmd.stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
1030 cmd.silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
1031 cmd.use_shell = opt & RUN_USING_SHELL ? 1 : 0;
1032 cmd.clean_on_exit = opt & RUN_CLEAN_ON_EXIT ? 1 : 0;
e662df7e 1033 cmd.wait_after_clean = opt & RUN_WAIT_AFTER_CLEAN ? 1 : 0;
28d04e1e 1034 cmd.close_object_store = opt & RUN_CLOSE_OBJECT_STORE ? 1 : 0;
ee493148 1035 cmd.dir = dir;
c7c4bdec 1036 if (env)
29fda24d 1037 strvec_pushv(&cmd.env, (const char **)env);
ee4512ed 1038 cmd.trace2_child_class = tr2_class;
ee493148
AR
1039 return run_command(&cmd);
1040}
2d22c208 1041
f6b60983 1042#ifndef NO_PTHREADS
0ea1c89b
JS
1043static pthread_t main_thread;
1044static int main_thread_set;
1045static pthread_key_t async_key;
1ece66bc 1046static pthread_key_t async_die_counter;
0ea1c89b 1047
200a76b7 1048static void *run_thread(void *data)
618ebe9f
JS
1049{
1050 struct async *async = data;
f6b60983 1051 intptr_t ret;
0ea1c89b 1052
c792d7b6
JK
1053 if (async->isolate_sigpipe) {
1054 sigset_t mask;
1055 sigemptyset(&mask);
1056 sigaddset(&mask, SIGPIPE);
1057 if (pthread_sigmask(SIG_BLOCK, &mask, NULL) < 0) {
1058 ret = error("unable to block SIGPIPE in async thread");
1059 return (void *)ret;
1060 }
1061 }
1062
0ea1c89b 1063 pthread_setspecific(async_key, async);
f6b60983 1064 ret = async->proc(async->proc_in, async->proc_out, async->data);
200a76b7 1065 return (void *)ret;
618ebe9f 1066}
0ea1c89b
JS
1067
1068static NORETURN void die_async(const char *err, va_list params)
1069{
e081a7c3
ÆAB
1070 report_fn die_message_fn = get_die_message_routine();
1071
1072 die_message_fn(err, params);
0ea1c89b 1073
661a8cf4 1074 if (in_async()) {
0ea1c89b
JS
1075 struct async *async = pthread_getspecific(async_key);
1076 if (async->proc_in >= 0)
1077 close(async->proc_in);
1078 if (async->proc_out >= 0)
1079 close(async->proc_out);
1080 pthread_exit((void *)128);
1081 }
1082
1083 exit(128);
618ebe9f 1084}
1ece66bc
JK
1085
1086static int async_die_is_recursing(void)
1087{
1088 void *ret = pthread_getspecific(async_die_counter);
4b540cf9 1089 pthread_setspecific(async_die_counter, &async_die_counter); /* set to any non-NULL valid pointer */
1ece66bc
JK
1090 return ret != NULL;
1091}
1092
661a8cf4
JK
1093int in_async(void)
1094{
1095 if (!main_thread_set)
1096 return 0; /* no asyncs started yet */
1097 return !pthread_equal(main_thread, pthread_self());
1098}
1099
b992fe10 1100static void NORETURN async_exit(int code)
9658846c
JK
1101{
1102 pthread_exit((void *)(intptr_t)code);
1103}
1104
0f4b6db3
EB
1105#else
1106
1107static struct {
1108 void (**handlers)(void);
1109 size_t nr;
1110 size_t alloc;
1111} git_atexit_hdlrs;
1112
1113static int git_atexit_installed;
1114
6066a7ea 1115static void git_atexit_dispatch(void)
0f4b6db3
EB
1116{
1117 size_t i;
1118
1119 for (i=git_atexit_hdlrs.nr ; i ; i--)
1120 git_atexit_hdlrs.handlers[i-1]();
1121}
1122
6066a7ea 1123static void git_atexit_clear(void)
0f4b6db3
EB
1124{
1125 free(git_atexit_hdlrs.handlers);
1126 memset(&git_atexit_hdlrs, 0, sizeof(git_atexit_hdlrs));
1127 git_atexit_installed = 0;
1128}
1129
1130#undef atexit
1131int git_atexit(void (*handler)(void))
1132{
1133 ALLOC_GROW(git_atexit_hdlrs.handlers, git_atexit_hdlrs.nr + 1, git_atexit_hdlrs.alloc);
1134 git_atexit_hdlrs.handlers[git_atexit_hdlrs.nr++] = handler;
1135 if (!git_atexit_installed) {
1136 if (atexit(&git_atexit_dispatch))
1137 return -1;
1138 git_atexit_installed = 1;
1139 }
1140 return 0;
1141}
1142#define atexit git_atexit
1143
661a8cf4
JK
1144static int process_is_async;
1145int in_async(void)
1146{
1147 return process_is_async;
1148}
1149
b992fe10 1150static void NORETURN async_exit(int code)
9658846c
JK
1151{
1152 exit(code);
1153}
1154
618ebe9f
JS
1155#endif
1156
b992fe10
LS
1157void check_pipe(int err)
1158{
1159 if (err == EPIPE) {
1160 if (in_async())
1161 async_exit(141);
1162
1163 signal(SIGPIPE, SIG_DFL);
1164 raise(SIGPIPE);
1165 /* Should never happen, but just in case... */
1166 exit(141);
1167 }
1168}
1169
2d22c208
JS
1170int start_async(struct async *async)
1171{
ae6a5609
EFL
1172 int need_in, need_out;
1173 int fdin[2], fdout[2];
1174 int proc_in, proc_out;
2d22c208 1175
ae6a5609
EFL
1176 need_in = async->in < 0;
1177 if (need_in) {
1178 if (pipe(fdin) < 0) {
1179 if (async->out > 0)
1180 close(async->out);
fbcb0e06 1181 return error_errno("cannot create pipe");
ae6a5609
EFL
1182 }
1183 async->in = fdin[1];
1184 }
1185
1186 need_out = async->out < 0;
1187 if (need_out) {
1188 if (pipe(fdout) < 0) {
1189 if (need_in)
1190 close_pair(fdin);
1191 else if (async->in)
1192 close(async->in);
fbcb0e06 1193 return error_errno("cannot create pipe");
ae6a5609
EFL
1194 }
1195 async->out = fdout[0];
1196 }
1197
1198 if (need_in)
1199 proc_in = fdin[0];
1200 else if (async->in)
1201 proc_in = async->in;
1202 else
1203 proc_in = -1;
1204
1205 if (need_out)
1206 proc_out = fdout[1];
1207 else if (async->out)
1208 proc_out = async->out;
1209 else
1210 proc_out = -1;
2d22c208 1211
f6b60983 1212#ifdef NO_PTHREADS
2c3766f0
AM
1213 /* Flush stdio before fork() to avoid cloning buffers */
1214 fflush(NULL);
1215
2d22c208
JS
1216 async->pid = fork();
1217 if (async->pid < 0) {
fbcb0e06 1218 error_errno("fork (async) failed");
ae6a5609 1219 goto error;
2d22c208
JS
1220 }
1221 if (!async->pid) {
ae6a5609
EFL
1222 if (need_in)
1223 close(fdin[1]);
1224 if (need_out)
1225 close(fdout[0]);
0f4b6db3 1226 git_atexit_clear();
661a8cf4 1227 process_is_async = 1;
ae6a5609 1228 exit(!!async->proc(proc_in, proc_out, async->data));
2d22c208 1229 }
ae6a5609 1230
ac2fbaa6 1231 mark_child_for_cleanup(async->pid, NULL);
afe19ff7 1232
ae6a5609
EFL
1233 if (need_in)
1234 close(fdin[0]);
1235 else if (async->in)
1236 close(async->in);
1237
1238 if (need_out)
1239 close(fdout[1]);
1240 else if (async->out)
1241 close(async->out);
618ebe9f 1242#else
0ea1c89b
JS
1243 if (!main_thread_set) {
1244 /*
1245 * We assume that the first time that start_async is called
1246 * it is from the main thread.
1247 */
1248 main_thread_set = 1;
1249 main_thread = pthread_self();
1250 pthread_key_create(&async_key, NULL);
1ece66bc 1251 pthread_key_create(&async_die_counter, NULL);
0ea1c89b 1252 set_die_routine(die_async);
1ece66bc 1253 set_die_is_recursing_routine(async_die_is_recursing);
0ea1c89b
JS
1254 }
1255
200a76b7
JS
1256 if (proc_in >= 0)
1257 set_cloexec(proc_in);
1258 if (proc_out >= 0)
1259 set_cloexec(proc_out);
ae6a5609
EFL
1260 async->proc_in = proc_in;
1261 async->proc_out = proc_out;
200a76b7
JS
1262 {
1263 int err = pthread_create(&async->tid, NULL, run_thread, async);
1264 if (err) {
2179045f 1265 error(_("cannot create async thread: %s"), strerror(err));
200a76b7
JS
1266 goto error;
1267 }
618ebe9f
JS
1268 }
1269#endif
2d22c208 1270 return 0;
ae6a5609
EFL
1271
1272error:
1273 if (need_in)
1274 close_pair(fdin);
1275 else if (async->in)
1276 close(async->in);
1277
1278 if (need_out)
1279 close_pair(fdout);
1280 else if (async->out)
1281 close(async->out);
1282 return -1;
2d22c208
JS
1283}
1284
1285int finish_async(struct async *async)
1286{
f6b60983 1287#ifdef NO_PTHREADS
0d58fef5
JS
1288 int ret = wait_or_whine(async->pid, "child process", 0);
1289
1290 invalidate_lstat_cache();
1291
1292 return ret;
618ebe9f 1293#else
200a76b7
JS
1294 void *ret = (void *)(intptr_t)(-1);
1295
1296 if (pthread_join(async->tid, &ret))
1297 error("pthread_join failed");
0d58fef5 1298 invalidate_lstat_cache();
200a76b7 1299 return (int)(intptr_t)ret;
0d58fef5 1300
618ebe9f 1301#endif
2d22c208 1302}
ae98a008 1303
c0e40a2d
NTND
1304int async_with_fork(void)
1305{
1306#ifdef NO_PTHREADS
1307 return 1;
1308#else
1309 return 0;
1310#endif
1311}
1312
96335bcf
JK
1313struct io_pump {
1314 /* initialized by caller */
1315 int fd;
1316 int type; /* POLLOUT or POLLIN */
1317 union {
1318 struct {
1319 const char *buf;
1320 size_t len;
1321 } out;
1322 struct {
1323 struct strbuf *buf;
1324 size_t hint;
1325 } in;
1326 } u;
1327
1328 /* returned by pump_io */
1329 int error; /* 0 for success, otherwise errno */
1330
1331 /* internal use */
1332 struct pollfd *pfd;
1333};
1334
1335static int pump_io_round(struct io_pump *slots, int nr, struct pollfd *pfd)
1336{
1337 int pollsize = 0;
1338 int i;
1339
1340 for (i = 0; i < nr; i++) {
1341 struct io_pump *io = &slots[i];
1342 if (io->fd < 0)
1343 continue;
1344 pfd[pollsize].fd = io->fd;
1345 pfd[pollsize].events = io->type;
1346 io->pfd = &pfd[pollsize++];
1347 }
1348
1349 if (!pollsize)
1350 return 0;
1351
1352 if (poll(pfd, pollsize, -1) < 0) {
1353 if (errno == EINTR)
1354 return 1;
1355 die_errno("poll failed");
1356 }
1357
1358 for (i = 0; i < nr; i++) {
1359 struct io_pump *io = &slots[i];
1360
1361 if (io->fd < 0)
1362 continue;
1363
1364 if (!(io->pfd->revents & (POLLOUT|POLLIN|POLLHUP|POLLERR|POLLNVAL)))
1365 continue;
1366
1367 if (io->type == POLLOUT) {
14eab817
JK
1368 ssize_t len;
1369
1370 /*
1371 * Don't use xwrite() here. It loops forever on EAGAIN,
1372 * and we're in our own poll() loop here.
1373 *
1374 * Note that we lose xwrite()'s handling of MAX_IO_SIZE
1375 * and EINTR, so we have to implement those ourselves.
1376 */
1377 len = write(io->fd, io->u.out.buf,
1378 io->u.out.len <= MAX_IO_SIZE ?
1379 io->u.out.len : MAX_IO_SIZE);
96335bcf 1380 if (len < 0) {
c6d3cce6
JK
1381 if (errno != EINTR && errno != EAGAIN &&
1382 errno != ENOSPC) {
14eab817
JK
1383 io->error = errno;
1384 close(io->fd);
1385 io->fd = -1;
1386 }
96335bcf
JK
1387 } else {
1388 io->u.out.buf += len;
1389 io->u.out.len -= len;
1390 if (!io->u.out.len) {
1391 close(io->fd);
1392 io->fd = -1;
1393 }
1394 }
1395 }
1396
1397 if (io->type == POLLIN) {
1398 ssize_t len = strbuf_read_once(io->u.in.buf,
1399 io->fd, io->u.in.hint);
1400 if (len < 0)
1401 io->error = errno;
1402 if (len <= 0) {
1403 close(io->fd);
1404 io->fd = -1;
1405 }
1406 }
1407 }
1408
1409 return 1;
1410}
1411
1412static int pump_io(struct io_pump *slots, int nr)
911ec99b 1413{
96335bcf
JK
1414 struct pollfd *pfd;
1415 int i;
1416
1417 for (i = 0; i < nr; i++)
1418 slots[i].error = 0;
1419
1420 ALLOC_ARRAY(pfd, nr);
1421 while (pump_io_round(slots, nr, pfd))
1422 ; /* nothing */
1423 free(pfd);
1424
1425 /* There may be multiple errno values, so just pick the first. */
1426 for (i = 0; i < nr; i++) {
1427 if (slots[i].error) {
1428 errno = slots[i].error;
1429 return -1;
1430 }
1431 }
1432 return 0;
1433}
1434
1435
1436int pipe_command(struct child_process *cmd,
1437 const char *in, size_t in_len,
1438 struct strbuf *out, size_t out_hint,
1439 struct strbuf *err, size_t err_hint)
1440{
1441 struct io_pump io[3];
1442 int nr = 0;
1443
1444 if (in)
1445 cmd->in = -1;
1446 if (out)
1447 cmd->out = -1;
1448 if (err)
1449 cmd->err = -1;
1450
911ec99b
JK
1451 if (start_command(cmd) < 0)
1452 return -1;
1453
96335bcf 1454 if (in) {
716c1f64
JK
1455 if (enable_pipe_nonblock(cmd->in) < 0) {
1456 error_errno("unable to make pipe non-blocking");
1457 close(cmd->in);
1458 if (out)
1459 close(cmd->out);
1460 if (err)
1461 close(cmd->err);
1462 return -1;
1463 }
96335bcf
JK
1464 io[nr].fd = cmd->in;
1465 io[nr].type = POLLOUT;
1466 io[nr].u.out.buf = in;
1467 io[nr].u.out.len = in_len;
1468 nr++;
1469 }
1470 if (out) {
1471 io[nr].fd = cmd->out;
1472 io[nr].type = POLLIN;
1473 io[nr].u.in.buf = out;
1474 io[nr].u.in.hint = out_hint;
1475 nr++;
1476 }
1477 if (err) {
1478 io[nr].fd = cmd->err;
1479 io[nr].type = POLLIN;
1480 io[nr].u.in.buf = err;
1481 io[nr].u.in.hint = err_hint;
1482 nr++;
1483 }
1484
1485 if (pump_io(io, nr) < 0) {
911ec99b
JK
1486 finish_command(cmd); /* throw away exit code */
1487 return -1;
1488 }
1489
911ec99b
JK
1490 return finish_command(cmd);
1491}
c553c72e
SB
1492
1493enum child_state {
1494 GIT_CP_FREE,
1495 GIT_CP_WORKING,
1496 GIT_CP_WAIT_CLEANUP,
1497};
1498
1499struct parallel_processes {
c333e6f3 1500 const size_t max_processes;
6a48b428 1501 size_t nr_processes;
c553c72e 1502
c553c72e
SB
1503 struct {
1504 enum child_state state;
1505 struct child_process process;
1506 struct strbuf err;
1507 void *data;
1508 } *children;
1509 /*
1510 * The struct pollfd is logically part of *children,
1511 * but the system call expects it as its own array.
1512 */
1513 struct pollfd *pfd;
1514
1515 unsigned shutdown : 1;
1516
6a48b428 1517 size_t output_owner;
c553c72e
SB
1518 struct strbuf buffered_output; /* of finished children */
1519};
1520
e39c9de8 1521static void kill_children(const struct parallel_processes *pp, int signo)
c553c72e 1522{
6a48b428 1523 for (size_t i = 0; i < pp->max_processes; i++)
c553c72e
SB
1524 if (pp->children[i].state == GIT_CP_WORKING)
1525 kill(pp->children[i].process.pid, signo);
1526}
1527
1528static struct parallel_processes *pp_for_signal;
1529
1530static void handle_children_on_signal(int signo)
1531{
1532 kill_children(pp_for_signal, signo);
1533 sigchain_pop(signo);
1534 raise(signo);
1535}
1536
1537static void pp_init(struct parallel_processes *pp,
6e5ba0ba 1538 const struct run_process_parallel_opts *opts)
c553c72e 1539{
6e5ba0ba 1540 const size_t n = opts->processes;
c333e6f3 1541
51243f9f
ÆAB
1542 if (!n)
1543 BUG("you must provide a non-zero number of processes!");
c553c72e 1544
6a48b428
ÆAB
1545 trace_printf("run_processes_parallel: preparing to run up to %"PRIuMAX" tasks",
1546 (uintmax_t)n);
c553c72e 1547
fa93951d 1548 if (!opts->get_next_task)
033abf97 1549 BUG("you need to specify a get_next_task function");
c553c72e 1550
ca56dadb 1551 CALLOC_ARRAY(pp->children, n);
357f8e6e 1552 if (!opts->ungroup)
fd3aaf53 1553 CALLOC_ARRAY(pp->pfd, n);
c553c72e 1554
6a48b428 1555 for (size_t i = 0; i < n; i++) {
c553c72e
SB
1556 strbuf_init(&pp->children[i].err, 0);
1557 child_process_init(&pp->children[i].process);
fd3aaf53
ÆAB
1558 if (pp->pfd) {
1559 pp->pfd[i].events = POLLIN | POLLHUP;
1560 pp->pfd[i].fd = -1;
1561 }
c553c72e
SB
1562 }
1563
1564 pp_for_signal = pp;
1565 sigchain_push_common(handle_children_on_signal);
1566}
1567
1568static void pp_cleanup(struct parallel_processes *pp)
1569{
c553c72e 1570 trace_printf("run_processes_parallel: done");
6a48b428 1571 for (size_t i = 0; i < pp->max_processes; i++) {
c553c72e
SB
1572 strbuf_release(&pp->children[i].err);
1573 child_process_clear(&pp->children[i].process);
1574 }
1575
1576 free(pp->children);
1577 free(pp->pfd);
1578
1579 /*
1580 * When get_next_task added messages to the buffer in its last
1581 * iteration, the buffered output is non empty.
1582 */
2dac9b56 1583 strbuf_write(&pp->buffered_output, stderr);
c553c72e
SB
1584 strbuf_release(&pp->buffered_output);
1585
1586 sigchain_pop_common();
1587}
1588
1589/* returns
1590 * 0 if a new task was started.
1591 * 1 if no new jobs was started (get_next_task ran out of work, non critical
1592 * problem with starting a new command)
1593 * <0 no new job was started, user wishes to shutdown early. Use negative code
1594 * to signal the children.
1595 */
fa93951d
ÆAB
1596static int pp_start_one(struct parallel_processes *pp,
1597 const struct run_process_parallel_opts *opts)
c553c72e 1598{
6a48b428
ÆAB
1599 size_t i;
1600 int code;
c553c72e
SB
1601
1602 for (i = 0; i < pp->max_processes; i++)
1603 if (pp->children[i].state == GIT_CP_FREE)
1604 break;
1605 if (i == pp->max_processes)
033abf97 1606 BUG("bookkeeping is hard");
c553c72e 1607
fa93951d 1608 code = opts->get_next_task(&pp->children[i].process,
357f8e6e 1609 opts->ungroup ? NULL : &pp->children[i].err,
2aa8d225 1610 opts->data,
fa93951d 1611 &pp->children[i].data);
c553c72e 1612 if (!code) {
357f8e6e 1613 if (!opts->ungroup) {
fd3aaf53
ÆAB
1614 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1615 strbuf_reset(&pp->children[i].err);
1616 }
c553c72e
SB
1617 return 1;
1618 }
357f8e6e 1619 if (!opts->ungroup) {
fd3aaf53
ÆAB
1620 pp->children[i].process.err = -1;
1621 pp->children[i].process.stdout_to_stderr = 1;
1622 }
c553c72e
SB
1623 pp->children[i].process.no_stdin = 1;
1624
1625 if (start_command(&pp->children[i].process)) {
fa93951d 1626 if (opts->start_failure)
357f8e6e 1627 code = opts->start_failure(opts->ungroup ? NULL :
fa93951d 1628 &pp->children[i].err,
2aa8d225 1629 opts->data,
fa93951d
ÆAB
1630 pp->children[i].data);
1631 else
1632 code = 0;
1633
357f8e6e 1634 if (!opts->ungroup) {
fd3aaf53
ÆAB
1635 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1636 strbuf_reset(&pp->children[i].err);
1637 }
c553c72e
SB
1638 if (code)
1639 pp->shutdown = 1;
1640 return code;
1641 }
1642
1643 pp->nr_processes++;
1644 pp->children[i].state = GIT_CP_WORKING;
fd3aaf53
ÆAB
1645 if (pp->pfd)
1646 pp->pfd[i].fd = pp->children[i].process.err;
c553c72e
SB
1647 return 0;
1648}
1649
1650static void pp_buffer_stderr(struct parallel_processes *pp, int output_timeout)
1651{
1652 int i;
1653
1654 while ((i = poll(pp->pfd, pp->max_processes, output_timeout)) < 0) {
1655 if (errno == EINTR)
1656 continue;
1657 pp_cleanup(pp);
1658 die_errno("poll");
1659 }
1660
1661 /* Buffer output from all pipes. */
6a48b428 1662 for (size_t i = 0; i < pp->max_processes; i++) {
c553c72e
SB
1663 if (pp->children[i].state == GIT_CP_WORKING &&
1664 pp->pfd[i].revents & (POLLIN | POLLHUP)) {
1665 int n = strbuf_read_once(&pp->children[i].err,
1666 pp->children[i].process.err, 0);
1667 if (n == 0) {
1668 close(pp->children[i].process.err);
1669 pp->children[i].state = GIT_CP_WAIT_CLEANUP;
1670 } else if (n < 0)
1671 if (errno != EAGAIN)
1672 die_errno("read");
1673 }
1674 }
1675}
1676
e39c9de8 1677static void pp_output(const struct parallel_processes *pp)
c553c72e 1678{
6a48b428 1679 size_t i = pp->output_owner;
fd3aaf53 1680
c553c72e
SB
1681 if (pp->children[i].state == GIT_CP_WORKING &&
1682 pp->children[i].err.len) {
2dac9b56 1683 strbuf_write(&pp->children[i].err, stderr);
c553c72e
SB
1684 strbuf_reset(&pp->children[i].err);
1685 }
1686}
1687
fa93951d
ÆAB
1688static int pp_collect_finished(struct parallel_processes *pp,
1689 const struct run_process_parallel_opts *opts)
c553c72e 1690{
6a48b428
ÆAB
1691 int code;
1692 size_t i, n = pp->max_processes;
c553c72e
SB
1693 int result = 0;
1694
1695 while (pp->nr_processes > 0) {
1696 for (i = 0; i < pp->max_processes; i++)
1697 if (pp->children[i].state == GIT_CP_WAIT_CLEANUP)
1698 break;
1699 if (i == pp->max_processes)
1700 break;
1701
1702 code = finish_command(&pp->children[i].process);
1703
fa93951d 1704 if (opts->task_finished)
357f8e6e 1705 code = opts->task_finished(code, opts->ungroup ? NULL :
2aa8d225 1706 &pp->children[i].err, opts->data,
fa93951d
ÆAB
1707 pp->children[i].data);
1708 else
1709 code = 0;
c553c72e
SB
1710
1711 if (code)
1712 result = code;
1713 if (code < 0)
1714 break;
1715
1716 pp->nr_processes--;
1717 pp->children[i].state = GIT_CP_FREE;
fd3aaf53
ÆAB
1718 if (pp->pfd)
1719 pp->pfd[i].fd = -1;
c553c72e
SB
1720 child_process_init(&pp->children[i].process);
1721
357f8e6e 1722 if (opts->ungroup) {
fd3aaf53
ÆAB
1723 ; /* no strbuf_*() work to do here */
1724 } else if (i != pp->output_owner) {
c553c72e
SB
1725 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1726 strbuf_reset(&pp->children[i].err);
1727 } else {
2dac9b56 1728 strbuf_write(&pp->children[i].err, stderr);
c553c72e
SB
1729 strbuf_reset(&pp->children[i].err);
1730
1731 /* Output all other finished child processes */
2dac9b56 1732 strbuf_write(&pp->buffered_output, stderr);
c553c72e
SB
1733 strbuf_reset(&pp->buffered_output);
1734
1735 /*
1736 * Pick next process to output live.
1737 * NEEDSWORK:
1738 * For now we pick it randomly by doing a round
1739 * robin. Later we may want to pick the one with
1740 * the most output or the longest or shortest
1741 * running process time.
1742 */
1743 for (i = 0; i < n; i++)
1744 if (pp->children[(pp->output_owner + i) % n].state == GIT_CP_WORKING)
1745 break;
1746 pp->output_owner = (pp->output_owner + i) % n;
1747 }
1748 }
1749 return result;
1750}
1751
6e5ba0ba 1752void run_processes_parallel(const struct run_process_parallel_opts *opts)
c553c72e
SB
1753{
1754 int i, code;
1755 int output_timeout = 100;
1756 int spawn_cap = 4;
c333e6f3 1757 struct parallel_processes pp = {
6e5ba0ba 1758 .max_processes = opts->processes,
c333e6f3 1759 .buffered_output = STRBUF_INIT,
c333e6f3 1760 };
6e5ba0ba
ÆAB
1761 /* options */
1762 const char *tr2_category = opts->tr2_category;
1763 const char *tr2_label = opts->tr2_label;
1764 const int do_trace2 = tr2_category && tr2_label;
c553c72e 1765
6e5ba0ba
ÆAB
1766 if (do_trace2)
1767 trace2_region_enter_printf(tr2_category, tr2_label, NULL,
1768 "max:%d", opts->processes);
fd3aaf53 1769
6e5ba0ba 1770 pp_init(&pp, opts);
c553c72e
SB
1771 while (1) {
1772 for (i = 0;
1773 i < spawn_cap && !pp.shutdown &&
1774 pp.nr_processes < pp.max_processes;
1775 i++) {
fa93951d 1776 code = pp_start_one(&pp, opts);
c553c72e
SB
1777 if (!code)
1778 continue;
1779 if (code < 0) {
1780 pp.shutdown = 1;
1781 kill_children(&pp, -code);
1782 }
1783 break;
1784 }
1785 if (!pp.nr_processes)
1786 break;
6e5ba0ba 1787 if (opts->ungroup) {
6a48b428 1788 for (size_t i = 0; i < pp.max_processes; i++)
fd3aaf53
ÆAB
1789 pp.children[i].state = GIT_CP_WAIT_CLEANUP;
1790 } else {
1791 pp_buffer_stderr(&pp, output_timeout);
1792 pp_output(&pp);
1793 }
fa93951d 1794 code = pp_collect_finished(&pp, opts);
c553c72e
SB
1795 if (code) {
1796 pp.shutdown = 1;
1797 if (code < 0)
1798 kill_children(&pp, -code);
1799 }
1800 }
1801
1802 pp_cleanup(&pp);
6e5ba0ba
ÆAB
1803
1804 if (do_trace2)
1805 trace2_region_leave(tr2_category, tr2_label, NULL);
c553c72e 1806}
ee4512ed 1807
a95ce124 1808int run_auto_maintenance(int quiet)
850b6ede 1809{
1942d483 1810 int enabled;
a95ce124 1811 struct child_process maint = CHILD_PROCESS_INIT;
850b6ede 1812
1942d483
DS
1813 if (!git_config_get_bool("maintenance.auto", &enabled) &&
1814 !enabled)
1815 return 0;
1816
a95ce124 1817 maint.git_cmd = 1;
5a22a334 1818 maint.close_object_store = 1;
a95ce124
DS
1819 strvec_pushl(&maint.args, "maintenance", "run", "--auto", NULL);
1820 strvec_push(&maint.args, quiet ? "--quiet" : "--no-quiet");
1821
1822 return run_command(&maint);
850b6ede 1823}
d1fa9435 1824
b3193252 1825void prepare_other_repo_env(struct strvec *env, const char *new_git_dir)
d1fa9435
JT
1826{
1827 const char * const *var;
1828
1829 for (var = local_repo_env; *var; var++) {
1830 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT) &&
1831 strcmp(*var, CONFIG_COUNT_ENVIRONMENT))
b3193252 1832 strvec_push(env, *var);
d1fa9435 1833 }
b3193252 1834 strvec_pushf(env, "%s=%s", GIT_DIR_ENVIRONMENT, new_git_dir);
d1fa9435 1835}
fdb13226
JH
1836
1837enum start_bg_result start_bg_command(struct child_process *cmd,
1838 start_bg_wait_cb *wait_cb,
1839 void *cb_data,
1840 unsigned int timeout_sec)
1841{
1842 enum start_bg_result sbgr = SBGR_ERROR;
1843 int ret;
1844 int wait_status;
1845 pid_t pid_seen;
1846 time_t time_limit;
1847
1848 /*
1849 * We do not allow clean-on-exit because the child process
1850 * should persist in the background and possibly/probably
1851 * after this process exits. So we don't want to kill the
1852 * child during our atexit routine.
1853 */
1854 if (cmd->clean_on_exit)
1855 BUG("start_bg_command() does not allow non-zero clean_on_exit");
1856
1857 if (!cmd->trace2_child_class)
1858 cmd->trace2_child_class = "background";
1859
1860 ret = start_command(cmd);
1861 if (ret) {
1862 /*
1863 * We assume that if `start_command()` fails, we
1864 * either get a complete `trace2_child_start() /
1865 * trace2_child_exit()` pair or it fails before the
1866 * `trace2_child_start()` is emitted, so we do not
1867 * need to worry about it here.
1868 *
1869 * We also assume that `start_command()` does not add
1870 * us to the cleanup list. And that it calls
1871 * calls `child_process_clear()`.
1872 */
1873 sbgr = SBGR_ERROR;
1874 goto done;
1875 }
1876
1877 time(&time_limit);
1878 time_limit += timeout_sec;
1879
1880wait:
1881 pid_seen = waitpid(cmd->pid, &wait_status, WNOHANG);
1882
1883 if (!pid_seen) {
1884 /*
1885 * The child is currently running. Ask the callback
1886 * if the child is ready to do work or whether we
1887 * should keep waiting for it to boot up.
1888 */
1889 ret = (*wait_cb)(cmd, cb_data);
1890 if (!ret) {
1891 /*
1892 * The child is running and "ready".
1893 */
1894 trace2_child_ready(cmd, "ready");
1895 sbgr = SBGR_READY;
1896 goto done;
1897 } else if (ret > 0) {
1898 /*
1899 * The callback said to give it more time to boot up
1900 * (subject to our timeout limit).
1901 */
1902 time_t now;
1903
1904 time(&now);
1905 if (now < time_limit)
1906 goto wait;
1907
1908 /*
1909 * Our timeout has expired. We don't try to
1910 * kill the child, but rather let it continue
1911 * (hopefully) trying to startup.
1912 */
1913 trace2_child_ready(cmd, "timeout");
1914 sbgr = SBGR_TIMEOUT;
1915 goto done;
1916 } else {
1917 /*
1918 * The cb gave up on this child. It is still running,
1919 * but our cb got an error trying to probe it.
1920 */
1921 trace2_child_ready(cmd, "error");
1922 sbgr = SBGR_CB_ERROR;
1923 goto done;
1924 }
1925 }
1926
1927 else if (pid_seen == cmd->pid) {
1928 int child_code = -1;
1929
1930 /*
1931 * The child started, but exited or was terminated
1932 * before becoming "ready".
1933 *
1934 * We try to match the behavior of `wait_or_whine()`
1935 * WRT the handling of WIFSIGNALED() and WIFEXITED()
1936 * and convert the child's status to a return code for
1937 * tracing purposes and emit the `trace2_child_exit()`
1938 * event.
1939 *
1940 * We do not want the wait_or_whine() error message
1941 * because we will be called by client-side library
1942 * routines.
1943 */
1944 if (WIFEXITED(wait_status))
1945 child_code = WEXITSTATUS(wait_status);
1946 else if (WIFSIGNALED(wait_status))
1947 child_code = WTERMSIG(wait_status) + 128;
1948 trace2_child_exit(cmd, child_code);
1949
1950 sbgr = SBGR_DIED;
1951 goto done;
1952 }
1953
1954 else if (pid_seen < 0 && errno == EINTR)
1955 goto wait;
1956
1957 trace2_child_exit(cmd, -1);
1958 sbgr = SBGR_ERROR;
1959
1960done:
1961 child_process_clear(cmd);
1962 invalidate_lstat_cache();
1963 return sbgr;
1964}