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