2 #include "run-command.h"
5 #include "argv-array.h"
8 # define SHELL_PATH "/bin/sh"
11 struct child_to_clean
{
13 struct child_to_clean
*next
;
15 static struct child_to_clean
*children_to_clean
;
16 static int installed_child_cleanup_handler
;
18 static void cleanup_children(int sig
)
20 while (children_to_clean
) {
21 struct child_to_clean
*p
= children_to_clean
;
22 children_to_clean
= p
->next
;
28 static void cleanup_children_on_signal(int sig
)
30 cleanup_children(sig
);
35 static void cleanup_children_on_exit(void)
37 cleanup_children(SIGTERM
);
40 static void mark_child_for_cleanup(pid_t pid
)
42 struct child_to_clean
*p
= xmalloc(sizeof(*p
));
44 p
->next
= children_to_clean
;
45 children_to_clean
= p
;
47 if (!installed_child_cleanup_handler
) {
48 atexit(cleanup_children_on_exit
);
49 sigchain_push_common(cleanup_children_on_signal
);
50 installed_child_cleanup_handler
= 1;
54 static void clear_child_for_cleanup(pid_t pid
)
56 struct child_to_clean
**pp
;
58 for (pp
= &children_to_clean
; *pp
; pp
= &(*pp
)->next
) {
59 struct child_to_clean
*clean_me
= *pp
;
61 if (clean_me
->pid
== pid
) {
69 static inline void close_pair(int fd
[2])
76 static inline void dup_devnull(int to
)
78 int fd
= open("/dev/null", O_RDWR
);
84 static char *locate_in_PATH(const char *file
)
86 const char *p
= getenv("PATH");
87 struct strbuf buf
= STRBUF_INIT
;
93 const char *end
= strchrnul(p
, ':');
97 /* POSIX specifies an empty entry as the current directory. */
99 strbuf_add(&buf
, p
, end
- p
);
100 strbuf_addch(&buf
, '/');
102 strbuf_addstr(&buf
, file
);
104 if (!access(buf
.buf
, F_OK
))
105 return strbuf_detach(&buf
, NULL
);
112 strbuf_release(&buf
);
116 static int exists_in_PATH(const char *file
)
118 char *r
= locate_in_PATH(file
);
123 int sane_execvp(const char *file
, char * const argv
[])
125 if (!execvp(file
, argv
))
126 return 0; /* cannot happen ;-) */
129 * When a command can't be found because one of the directories
130 * listed in $PATH is unsearchable, execvp reports EACCES, but
131 * careful usability testing (read: analysis of occasional bug
132 * reports) reveals that "No such file or directory" is more
135 * We avoid commands with "/", because execvp will not do $PATH
136 * lookups in that case.
138 * The reassignment of EACCES to errno looks like a no-op below,
139 * but we need to protect against exists_in_PATH overwriting errno.
141 if (errno
== EACCES
&& !strchr(file
, '/'))
142 errno
= exists_in_PATH(file
) ? EACCES
: ENOENT
;
143 else if (errno
== ENOTDIR
&& !strchr(file
, '/'))
148 static const char **prepare_shell_cmd(const char **argv
)
153 for (argc
= 0; argv
[argc
]; argc
++)
154 ; /* just counting */
155 /* +1 for NULL, +3 for "sh -c" plus extra $0 */
156 nargv
= xmalloc(sizeof(*nargv
) * (argc
+ 1 + 3));
159 die("BUG: shell command is empty");
161 if (strcspn(argv
[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv
[0])) {
163 nargv
[nargc
++] = SHELL_PATH
;
165 nargv
[nargc
++] = "sh";
167 nargv
[nargc
++] = "-c";
170 nargv
[nargc
++] = argv
[0];
172 struct strbuf arg0
= STRBUF_INIT
;
173 strbuf_addf(&arg0
, "%s \"$@\"", argv
[0]);
174 nargv
[nargc
++] = strbuf_detach(&arg0
, NULL
);
178 for (argc
= 0; argv
[argc
]; argc
++)
179 nargv
[nargc
++] = argv
[argc
];
186 static int execv_shell_cmd(const char **argv
)
188 const char **nargv
= prepare_shell_cmd(argv
);
189 trace_argv_printf(nargv
, "trace: exec:");
190 sane_execvp(nargv
[0], (char **)nargv
);
197 static int child_err
= 2;
198 static int child_notifier
= -1;
200 static void notify_parent(void)
203 * execvp failed. If possible, we'd like to let start_command
204 * know, so failures like ENOENT can be handled right away; but
205 * otherwise, finish_command will still report the error.
207 xwrite(child_notifier
, "", 1);
210 static NORETURN
void die_child(const char *err
, va_list params
)
212 vwritef(child_err
, "fatal: ", err
, params
);
216 static void error_child(const char *err
, va_list params
)
218 vwritef(child_err
, "error: ", err
, params
);
222 static inline void set_cloexec(int fd
)
224 int flags
= fcntl(fd
, F_GETFD
);
226 fcntl(fd
, F_SETFD
, flags
| FD_CLOEXEC
);
229 static int wait_or_whine(pid_t pid
, const char *argv0
)
231 int status
, code
= -1;
233 int failed_errno
= 0;
235 while ((waiting
= waitpid(pid
, &status
, 0)) < 0 && errno
== EINTR
)
239 failed_errno
= errno
;
240 error("waitpid for %s failed: %s", argv0
, strerror(errno
));
241 } else if (waiting
!= pid
) {
242 error("waitpid is confused (%s)", argv0
);
243 } else if (WIFSIGNALED(status
)) {
244 code
= WTERMSIG(status
);
245 if (code
!= SIGINT
&& code
!= SIGQUIT
)
246 error("%s died of signal %d", argv0
, code
);
248 * This return value is chosen so that code & 0xff
249 * mimics the exit code that a POSIX shell would report for
250 * a program that died from this signal.
253 } else if (WIFEXITED(status
)) {
254 code
= WEXITSTATUS(status
);
256 * Convert special exit code when execvp failed.
260 failed_errno
= ENOENT
;
263 error("waitpid is confused (%s)", argv0
);
266 clear_child_for_cleanup(pid
);
268 errno
= failed_errno
;
272 int start_command(struct child_process
*cmd
)
274 int need_in
, need_out
, need_err
;
275 int fdin
[2], fdout
[2], fderr
[2];
280 * In case of errors we must keep the promise to close FDs
281 * that have been passed in via ->in and ->out.
284 need_in
= !cmd
->no_stdin
&& cmd
->in
< 0;
286 if (pipe(fdin
) < 0) {
287 failed_errno
= errno
;
290 str
= "standard input";
296 need_out
= !cmd
->no_stdout
297 && !cmd
->stdout_to_stderr
300 if (pipe(fdout
) < 0) {
301 failed_errno
= errno
;
306 str
= "standard output";
312 need_err
= !cmd
->no_stderr
&& cmd
->err
< 0;
314 if (pipe(fderr
) < 0) {
315 failed_errno
= errno
;
324 str
= "standard error";
326 error("cannot create %s pipe for %s: %s",
327 str
, cmd
->argv
[0], strerror(failed_errno
));
328 errno
= failed_errno
;
334 trace_argv_printf(cmd
->argv
, "trace: run_command:");
340 if (pipe(notify_pipe
))
341 notify_pipe
[0] = notify_pipe
[1] = -1;
344 failed_errno
= errno
;
347 * Redirect the channel to write syscall error messages to
348 * before redirecting the process's stderr so that all die()
349 * in subsequent call paths use the parent's stderr.
351 if (cmd
->no_stderr
|| need_err
) {
353 set_cloexec(child_err
);
355 set_die_routine(die_child
);
356 set_error_routine(error_child
);
358 close(notify_pipe
[0]);
359 set_cloexec(notify_pipe
[1]);
360 child_notifier
= notify_pipe
[1];
361 atexit(notify_parent
);
368 } else if (cmd
->in
) {
378 } else if (cmd
->err
> 1) {
385 else if (cmd
->stdout_to_stderr
)
390 } else if (cmd
->out
> 1) {
395 if (cmd
->dir
&& chdir(cmd
->dir
))
396 die_errno("exec '%s': cd to '%s' failed", cmd
->argv
[0],
399 for (; *cmd
->env
; cmd
->env
++) {
400 if (strchr(*cmd
->env
, '='))
401 putenv((char *)*cmd
->env
);
407 execv_git_cmd(cmd
->argv
);
408 } else if (cmd
->use_shell
) {
409 execv_shell_cmd(cmd
->argv
);
411 sane_execvp(cmd
->argv
[0], (char *const*) cmd
->argv
);
413 if (errno
== ENOENT
) {
414 if (!cmd
->silent_exec_failure
)
415 error("cannot run %s: %s", cmd
->argv
[0],
419 die_errno("cannot exec '%s'", cmd
->argv
[0]);
423 error("cannot fork() for %s: %s", cmd
->argv
[0],
425 else if (cmd
->clean_on_exit
)
426 mark_child_for_cleanup(cmd
->pid
);
429 * Wait for child's execvp. If the execvp succeeds (or if fork()
430 * failed), EOF is seen immediately by the parent. Otherwise, the
431 * child process sends a single byte.
432 * Note that use of this infrastructure is completely advisory,
433 * therefore, we keep error checks minimal.
435 close(notify_pipe
[1]);
436 if (read(notify_pipe
[0], ¬ify_pipe
[1], 1) == 1) {
438 * At this point we know that fork() succeeded, but execvp()
439 * failed. Errors have been reported to our stderr.
441 wait_or_whine(cmd
->pid
, cmd
->argv
[0]);
442 failed_errno
= errno
;
445 close(notify_pipe
[0]);
450 int fhin
= 0, fhout
= 1, fherr
= 2;
451 const char **sargv
= cmd
->argv
;
454 fhin
= open("/dev/null", O_RDWR
);
461 fherr
= open("/dev/null", O_RDWR
);
463 fherr
= dup(fderr
[1]);
464 else if (cmd
->err
> 2)
465 fherr
= dup(cmd
->err
);
468 fhout
= open("/dev/null", O_RDWR
);
469 else if (cmd
->stdout_to_stderr
)
472 fhout
= dup(fdout
[1]);
473 else if (cmd
->out
> 1)
474 fhout
= dup(cmd
->out
);
477 cmd
->argv
= prepare_git_cmd(cmd
->argv
);
478 } else if (cmd
->use_shell
) {
479 cmd
->argv
= prepare_shell_cmd(cmd
->argv
);
482 cmd
->pid
= mingw_spawnvpe(cmd
->argv
[0], cmd
->argv
, (char**) cmd
->env
,
483 cmd
->dir
, fhin
, fhout
, fherr
);
484 failed_errno
= errno
;
485 if (cmd
->pid
< 0 && (!cmd
->silent_exec_failure
|| errno
!= ENOENT
))
486 error("cannot spawn %s: %s", cmd
->argv
[0], strerror(errno
));
487 if (cmd
->clean_on_exit
&& cmd
->pid
>= 0)
488 mark_child_for_cleanup(cmd
->pid
);
516 errno
= failed_errno
;
538 int finish_command(struct child_process
*cmd
)
540 return wait_or_whine(cmd
->pid
, cmd
->argv
[0]);
543 int run_command(struct child_process
*cmd
)
545 int code
= start_command(cmd
);
548 return finish_command(cmd
);
551 static void prepare_run_command_v_opt(struct child_process
*cmd
,
555 memset(cmd
, 0, sizeof(*cmd
));
557 cmd
->no_stdin
= opt
& RUN_COMMAND_NO_STDIN
? 1 : 0;
558 cmd
->git_cmd
= opt
& RUN_GIT_CMD
? 1 : 0;
559 cmd
->stdout_to_stderr
= opt
& RUN_COMMAND_STDOUT_TO_STDERR
? 1 : 0;
560 cmd
->silent_exec_failure
= opt
& RUN_SILENT_EXEC_FAILURE
? 1 : 0;
561 cmd
->use_shell
= opt
& RUN_USING_SHELL
? 1 : 0;
562 cmd
->clean_on_exit
= opt
& RUN_CLEAN_ON_EXIT
? 1 : 0;
565 int run_command_v_opt(const char **argv
, int opt
)
567 struct child_process cmd
;
568 prepare_run_command_v_opt(&cmd
, argv
, opt
);
569 return run_command(&cmd
);
572 int run_command_v_opt_cd_env(const char **argv
, int opt
, const char *dir
, const char *const *env
)
574 struct child_process cmd
;
575 prepare_run_command_v_opt(&cmd
, argv
, opt
);
578 return run_command(&cmd
);
582 static pthread_t main_thread
;
583 static int main_thread_set
;
584 static pthread_key_t async_key
;
585 static pthread_key_t async_die_counter
;
587 static void *run_thread(void *data
)
589 struct async
*async
= data
;
592 pthread_setspecific(async_key
, async
);
593 ret
= async
->proc(async
->proc_in
, async
->proc_out
, async
->data
);
597 static NORETURN
void die_async(const char *err
, va_list params
)
599 vreportf("fatal: ", err
, params
);
601 if (!pthread_equal(main_thread
, pthread_self())) {
602 struct async
*async
= pthread_getspecific(async_key
);
603 if (async
->proc_in
>= 0)
604 close(async
->proc_in
);
605 if (async
->proc_out
>= 0)
606 close(async
->proc_out
);
607 pthread_exit((void *)128);
613 static int async_die_is_recursing(void)
615 void *ret
= pthread_getspecific(async_die_counter
);
616 pthread_setspecific(async_die_counter
, (void *)1);
622 int start_async(struct async
*async
)
624 int need_in
, need_out
;
625 int fdin
[2], fdout
[2];
626 int proc_in
, proc_out
;
628 need_in
= async
->in
< 0;
630 if (pipe(fdin
) < 0) {
633 return error("cannot create pipe: %s", strerror(errno
));
638 need_out
= async
->out
< 0;
640 if (pipe(fdout
) < 0) {
645 return error("cannot create pipe: %s", strerror(errno
));
647 async
->out
= fdout
[0];
660 proc_out
= async
->out
;
665 /* Flush stdio before fork() to avoid cloning buffers */
669 if (async
->pid
< 0) {
670 error("fork (async) failed: %s", strerror(errno
));
678 exit(!!async
->proc(proc_in
, proc_out
, async
->data
));
681 mark_child_for_cleanup(async
->pid
);
693 if (!main_thread_set
) {
695 * We assume that the first time that start_async is called
696 * it is from the main thread.
699 main_thread
= pthread_self();
700 pthread_key_create(&async_key
, NULL
);
701 pthread_key_create(&async_die_counter
, NULL
);
702 set_die_routine(die_async
);
703 set_die_is_recursing_routine(async_die_is_recursing
);
707 set_cloexec(proc_in
);
709 set_cloexec(proc_out
);
710 async
->proc_in
= proc_in
;
711 async
->proc_out
= proc_out
;
713 int err
= pthread_create(&async
->tid
, NULL
, run_thread
, async
);
715 error("cannot create thread: %s", strerror(err
));
735 int finish_async(struct async
*async
)
738 return wait_or_whine(async
->pid
, "child process");
740 void *ret
= (void *)(intptr_t)(-1);
742 if (pthread_join(async
->tid
, &ret
))
743 error("pthread_join failed");
744 return (int)(intptr_t)ret
;
748 char *find_hook(const char *name
)
750 char *path
= git_path("hooks/%s", name
);
751 if (access(path
, X_OK
) < 0)
757 int run_hook(const char *index_file
, const char *name
, ...)
759 struct child_process hook
;
760 struct argv_array argv
= ARGV_ARRAY_INIT
;
761 const char *p
, *env
[2];
762 char index
[PATH_MAX
];
770 argv_array_push(&argv
, p
);
772 va_start(args
, name
);
773 while ((p
= va_arg(args
, const char *)))
774 argv_array_push(&argv
, p
);
777 memset(&hook
, 0, sizeof(hook
));
778 hook
.argv
= argv
.argv
;
780 hook
.stdout_to_stderr
= 1;
782 snprintf(index
, sizeof(index
), "GIT_INDEX_FILE=%s", index_file
);
788 ret
= run_command(&hook
);
789 argv_array_clear(&argv
);