2 #include "run-command.h"
5 #include "argv-array.h"
7 void child_process_init(struct child_process
*child
)
9 memset(child
, 0, sizeof(*child
));
10 argv_array_init(&child
->args
);
11 argv_array_init(&child
->env_array
);
14 void child_process_clear(struct child_process
*child
)
16 argv_array_clear(&child
->args
);
17 argv_array_clear(&child
->env_array
);
20 struct child_to_clean
{
22 struct child_to_clean
*next
;
24 static struct child_to_clean
*children_to_clean
;
25 static int installed_child_cleanup_handler
;
27 static void cleanup_children(int sig
, int in_signal
)
29 while (children_to_clean
) {
30 struct child_to_clean
*p
= children_to_clean
;
31 children_to_clean
= p
->next
;
38 static void cleanup_children_on_signal(int sig
)
40 cleanup_children(sig
, 1);
45 static void cleanup_children_on_exit(void)
47 cleanup_children(SIGTERM
, 0);
50 static void mark_child_for_cleanup(pid_t pid
)
52 struct child_to_clean
*p
= xmalloc(sizeof(*p
));
54 p
->next
= children_to_clean
;
55 children_to_clean
= p
;
57 if (!installed_child_cleanup_handler
) {
58 atexit(cleanup_children_on_exit
);
59 sigchain_push_common(cleanup_children_on_signal
);
60 installed_child_cleanup_handler
= 1;
64 static void clear_child_for_cleanup(pid_t pid
)
66 struct child_to_clean
**pp
;
68 for (pp
= &children_to_clean
; *pp
; pp
= &(*pp
)->next
) {
69 struct child_to_clean
*clean_me
= *pp
;
71 if (clean_me
->pid
== pid
) {
79 static inline void close_pair(int fd
[2])
85 #ifndef GIT_WINDOWS_NATIVE
86 static inline void dup_devnull(int to
)
88 int fd
= open("/dev/null", O_RDWR
);
90 die_errno(_("open /dev/null failed"));
92 die_errno(_("dup2(%d,%d) failed"), fd
, to
);
97 static char *locate_in_PATH(const char *file
)
99 const char *p
= getenv("PATH");
100 struct strbuf buf
= STRBUF_INIT
;
106 const char *end
= strchrnul(p
, ':');
110 /* POSIX specifies an empty entry as the current directory. */
112 strbuf_add(&buf
, p
, end
- p
);
113 strbuf_addch(&buf
, '/');
115 strbuf_addstr(&buf
, file
);
117 if (!access(buf
.buf
, F_OK
))
118 return strbuf_detach(&buf
, NULL
);
125 strbuf_release(&buf
);
129 static int exists_in_PATH(const char *file
)
131 char *r
= locate_in_PATH(file
);
136 int sane_execvp(const char *file
, char * const argv
[])
138 if (!execvp(file
, argv
))
139 return 0; /* cannot happen ;-) */
142 * When a command can't be found because one of the directories
143 * listed in $PATH is unsearchable, execvp reports EACCES, but
144 * careful usability testing (read: analysis of occasional bug
145 * reports) reveals that "No such file or directory" is more
148 * We avoid commands with "/", because execvp will not do $PATH
149 * lookups in that case.
151 * The reassignment of EACCES to errno looks like a no-op below,
152 * but we need to protect against exists_in_PATH overwriting errno.
154 if (errno
== EACCES
&& !strchr(file
, '/'))
155 errno
= exists_in_PATH(file
) ? EACCES
: ENOENT
;
156 else if (errno
== ENOTDIR
&& !strchr(file
, '/'))
161 static const char **prepare_shell_cmd(const char **argv
)
166 for (argc
= 0; argv
[argc
]; argc
++)
167 ; /* just counting */
168 /* +1 for NULL, +3 for "sh -c" plus extra $0 */
169 nargv
= xmalloc(sizeof(*nargv
) * (argc
+ 1 + 3));
172 die("BUG: shell command is empty");
174 if (strcspn(argv
[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv
[0])) {
175 #ifndef GIT_WINDOWS_NATIVE
176 nargv
[nargc
++] = SHELL_PATH
;
178 nargv
[nargc
++] = "sh";
180 nargv
[nargc
++] = "-c";
183 nargv
[nargc
++] = argv
[0];
185 struct strbuf arg0
= STRBUF_INIT
;
186 strbuf_addf(&arg0
, "%s \"$@\"", argv
[0]);
187 nargv
[nargc
++] = strbuf_detach(&arg0
, NULL
);
191 for (argc
= 0; argv
[argc
]; argc
++)
192 nargv
[nargc
++] = argv
[argc
];
198 #ifndef GIT_WINDOWS_NATIVE
199 static int execv_shell_cmd(const char **argv
)
201 const char **nargv
= prepare_shell_cmd(argv
);
202 trace_argv_printf(nargv
, "trace: exec:");
203 sane_execvp(nargv
[0], (char **)nargv
);
209 #ifndef GIT_WINDOWS_NATIVE
210 static int child_notifier
= -1;
212 static void notify_parent(void)
215 * execvp failed. If possible, we'd like to let start_command
216 * know, so failures like ENOENT can be handled right away; but
217 * otherwise, finish_command will still report the error.
219 xwrite(child_notifier
, "", 1);
223 static inline void set_cloexec(int fd
)
225 int flags
= fcntl(fd
, F_GETFD
);
227 fcntl(fd
, F_SETFD
, flags
| FD_CLOEXEC
);
230 static int wait_or_whine(pid_t pid
, const char *argv0
, int in_signal
)
232 int status
, code
= -1;
234 int failed_errno
= 0;
236 while ((waiting
= waitpid(pid
, &status
, 0)) < 0 && errno
== EINTR
)
242 failed_errno
= errno
;
243 error("waitpid for %s failed: %s", argv0
, strerror(errno
));
244 } else if (waiting
!= pid
) {
245 error("waitpid is confused (%s)", argv0
);
246 } else if (WIFSIGNALED(status
)) {
247 code
= WTERMSIG(status
);
248 if (code
!= SIGINT
&& code
!= SIGQUIT
)
249 error("%s died of signal %d", argv0
, code
);
251 * This return value is chosen so that code & 0xff
252 * mimics the exit code that a POSIX shell would report for
253 * a program that died from this signal.
256 } else if (WIFEXITED(status
)) {
257 code
= WEXITSTATUS(status
);
259 * Convert special exit code when execvp failed.
263 failed_errno
= ENOENT
;
266 error("waitpid is confused (%s)", argv0
);
269 clear_child_for_cleanup(pid
);
271 errno
= failed_errno
;
275 int start_command(struct child_process
*cmd
)
277 int need_in
, need_out
, need_err
;
278 int fdin
[2], fdout
[2], fderr
[2];
283 cmd
->argv
= cmd
->args
.argv
;
285 cmd
->env
= cmd
->env_array
.argv
;
288 * In case of errors we must keep the promise to close FDs
289 * that have been passed in via ->in and ->out.
292 need_in
= !cmd
->no_stdin
&& cmd
->in
< 0;
294 if (pipe(fdin
) < 0) {
295 failed_errno
= errno
;
298 str
= "standard input";
304 need_out
= !cmd
->no_stdout
305 && !cmd
->stdout_to_stderr
308 if (pipe(fdout
) < 0) {
309 failed_errno
= errno
;
314 str
= "standard output";
320 need_err
= !cmd
->no_stderr
&& cmd
->err
< 0;
322 if (pipe(fderr
) < 0) {
323 failed_errno
= errno
;
332 str
= "standard error";
334 error("cannot create %s pipe for %s: %s",
335 str
, cmd
->argv
[0], strerror(failed_errno
));
336 child_process_clear(cmd
);
337 errno
= failed_errno
;
343 trace_argv_printf(cmd
->argv
, "trace: run_command:");
346 #ifndef GIT_WINDOWS_NATIVE
349 if (pipe(notify_pipe
))
350 notify_pipe
[0] = notify_pipe
[1] = -1;
353 failed_errno
= errno
;
356 * Redirect the channel to write syscall error messages to
357 * before redirecting the process's stderr so that all die()
358 * in subsequent call paths use the parent's stderr.
360 if (cmd
->no_stderr
|| need_err
) {
361 int child_err
= dup(2);
362 set_cloexec(child_err
);
363 set_error_handle(fdopen(child_err
, "w"));
366 close(notify_pipe
[0]);
367 set_cloexec(notify_pipe
[1]);
368 child_notifier
= notify_pipe
[1];
369 atexit(notify_parent
);
376 } else if (cmd
->in
) {
386 } else if (cmd
->err
> 1) {
393 else if (cmd
->stdout_to_stderr
)
398 } else if (cmd
->out
> 1) {
403 if (cmd
->dir
&& chdir(cmd
->dir
))
404 die_errno("exec '%s': cd to '%s' failed", cmd
->argv
[0],
407 for (; *cmd
->env
; cmd
->env
++) {
408 if (strchr(*cmd
->env
, '='))
409 putenv((char *)*cmd
->env
);
415 execv_git_cmd(cmd
->argv
);
416 else if (cmd
->use_shell
)
417 execv_shell_cmd(cmd
->argv
);
419 sane_execvp(cmd
->argv
[0], (char *const*) cmd
->argv
);
420 if (errno
== ENOENT
) {
421 if (!cmd
->silent_exec_failure
)
422 error("cannot run %s: %s", cmd
->argv
[0],
426 die_errno("cannot exec '%s'", cmd
->argv
[0]);
430 error("cannot fork() for %s: %s", cmd
->argv
[0],
432 else if (cmd
->clean_on_exit
)
433 mark_child_for_cleanup(cmd
->pid
);
436 * Wait for child's execvp. If the execvp succeeds (or if fork()
437 * failed), EOF is seen immediately by the parent. Otherwise, the
438 * child process sends a single byte.
439 * Note that use of this infrastructure is completely advisory,
440 * therefore, we keep error checks minimal.
442 close(notify_pipe
[1]);
443 if (read(notify_pipe
[0], ¬ify_pipe
[1], 1) == 1) {
445 * At this point we know that fork() succeeded, but execvp()
446 * failed. Errors have been reported to our stderr.
448 wait_or_whine(cmd
->pid
, cmd
->argv
[0], 0);
449 failed_errno
= errno
;
452 close(notify_pipe
[0]);
456 int fhin
= 0, fhout
= 1, fherr
= 2;
457 const char **sargv
= cmd
->argv
;
460 fhin
= open("/dev/null", O_RDWR
);
467 fherr
= open("/dev/null", O_RDWR
);
469 fherr
= dup(fderr
[1]);
470 else if (cmd
->err
> 2)
471 fherr
= dup(cmd
->err
);
474 fhout
= open("/dev/null", O_RDWR
);
475 else if (cmd
->stdout_to_stderr
)
478 fhout
= dup(fdout
[1]);
479 else if (cmd
->out
> 1)
480 fhout
= dup(cmd
->out
);
483 cmd
->argv
= prepare_git_cmd(cmd
->argv
);
484 else if (cmd
->use_shell
)
485 cmd
->argv
= prepare_shell_cmd(cmd
->argv
);
487 cmd
->pid
= mingw_spawnvpe(cmd
->argv
[0], cmd
->argv
, (char**) cmd
->env
,
488 cmd
->dir
, fhin
, fhout
, fherr
);
489 failed_errno
= errno
;
490 if (cmd
->pid
< 0 && (!cmd
->silent_exec_failure
|| errno
!= ENOENT
))
491 error("cannot spawn %s: %s", cmd
->argv
[0], strerror(errno
));
492 if (cmd
->clean_on_exit
&& cmd
->pid
>= 0)
493 mark_child_for_cleanup(cmd
->pid
);
521 child_process_clear(cmd
);
522 errno
= failed_errno
;
544 int finish_command(struct child_process
*cmd
)
546 int ret
= wait_or_whine(cmd
->pid
, cmd
->argv
[0], 0);
547 child_process_clear(cmd
);
551 int finish_command_in_signal(struct child_process
*cmd
)
553 return wait_or_whine(cmd
->pid
, cmd
->argv
[0], 1);
557 int run_command(struct child_process
*cmd
)
561 if (cmd
->out
< 0 || cmd
->err
< 0)
562 die("BUG: run_command with a pipe can cause deadlock");
564 code
= start_command(cmd
);
567 return finish_command(cmd
);
570 int run_command_v_opt(const char **argv
, int opt
)
572 return run_command_v_opt_cd_env(argv
, opt
, NULL
, NULL
);
575 int run_command_v_opt_cd_env(const char **argv
, int opt
, const char *dir
, const char *const *env
)
577 struct child_process cmd
= CHILD_PROCESS_INIT
;
579 cmd
.no_stdin
= opt
& RUN_COMMAND_NO_STDIN
? 1 : 0;
580 cmd
.git_cmd
= opt
& RUN_GIT_CMD
? 1 : 0;
581 cmd
.stdout_to_stderr
= opt
& RUN_COMMAND_STDOUT_TO_STDERR
? 1 : 0;
582 cmd
.silent_exec_failure
= opt
& RUN_SILENT_EXEC_FAILURE
? 1 : 0;
583 cmd
.use_shell
= opt
& RUN_USING_SHELL
? 1 : 0;
584 cmd
.clean_on_exit
= opt
& RUN_CLEAN_ON_EXIT
? 1 : 0;
587 return run_command(&cmd
);
591 static pthread_t main_thread
;
592 static int main_thread_set
;
593 static pthread_key_t async_key
;
594 static pthread_key_t async_die_counter
;
596 static void *run_thread(void *data
)
598 struct async
*async
= data
;
601 pthread_setspecific(async_key
, async
);
602 ret
= async
->proc(async
->proc_in
, async
->proc_out
, async
->data
);
606 static NORETURN
void die_async(const char *err
, va_list params
)
608 vreportf("fatal: ", err
, params
);
610 if (!pthread_equal(main_thread
, pthread_self())) {
611 struct async
*async
= pthread_getspecific(async_key
);
612 if (async
->proc_in
>= 0)
613 close(async
->proc_in
);
614 if (async
->proc_out
>= 0)
615 close(async
->proc_out
);
616 pthread_exit((void *)128);
622 static int async_die_is_recursing(void)
624 void *ret
= pthread_getspecific(async_die_counter
);
625 pthread_setspecific(async_die_counter
, (void *)1);
632 void (**handlers
)(void);
637 static int git_atexit_installed
;
639 static void git_atexit_dispatch(void)
643 for (i
=git_atexit_hdlrs
.nr
; i
; i
--)
644 git_atexit_hdlrs
.handlers
[i
-1]();
647 static void git_atexit_clear(void)
649 free(git_atexit_hdlrs
.handlers
);
650 memset(&git_atexit_hdlrs
, 0, sizeof(git_atexit_hdlrs
));
651 git_atexit_installed
= 0;
655 int git_atexit(void (*handler
)(void))
657 ALLOC_GROW(git_atexit_hdlrs
.handlers
, git_atexit_hdlrs
.nr
+ 1, git_atexit_hdlrs
.alloc
);
658 git_atexit_hdlrs
.handlers
[git_atexit_hdlrs
.nr
++] = handler
;
659 if (!git_atexit_installed
) {
660 if (atexit(&git_atexit_dispatch
))
662 git_atexit_installed
= 1;
666 #define atexit git_atexit
670 int start_async(struct async
*async
)
672 int need_in
, need_out
;
673 int fdin
[2], fdout
[2];
674 int proc_in
, proc_out
;
676 need_in
= async
->in
< 0;
678 if (pipe(fdin
) < 0) {
681 return error("cannot create pipe: %s", strerror(errno
));
686 need_out
= async
->out
< 0;
688 if (pipe(fdout
) < 0) {
693 return error("cannot create pipe: %s", strerror(errno
));
695 async
->out
= fdout
[0];
708 proc_out
= async
->out
;
713 /* Flush stdio before fork() to avoid cloning buffers */
717 if (async
->pid
< 0) {
718 error("fork (async) failed: %s", strerror(errno
));
727 exit(!!async
->proc(proc_in
, proc_out
, async
->data
));
730 mark_child_for_cleanup(async
->pid
);
742 if (!main_thread_set
) {
744 * We assume that the first time that start_async is called
745 * it is from the main thread.
748 main_thread
= pthread_self();
749 pthread_key_create(&async_key
, NULL
);
750 pthread_key_create(&async_die_counter
, NULL
);
751 set_die_routine(die_async
);
752 set_die_is_recursing_routine(async_die_is_recursing
);
756 set_cloexec(proc_in
);
758 set_cloexec(proc_out
);
759 async
->proc_in
= proc_in
;
760 async
->proc_out
= proc_out
;
762 int err
= pthread_create(&async
->tid
, NULL
, run_thread
, async
);
764 error("cannot create thread: %s", strerror(err
));
784 int finish_async(struct async
*async
)
787 return wait_or_whine(async
->pid
, "child process", 0);
789 void *ret
= (void *)(intptr_t)(-1);
791 if (pthread_join(async
->tid
, &ret
))
792 error("pthread_join failed");
793 return (int)(intptr_t)ret
;
797 const char *find_hook(const char *name
)
799 static struct strbuf path
= STRBUF_INIT
;
802 strbuf_git_path(&path
, "hooks/%s", name
);
803 if (access(path
.buf
, X_OK
) < 0)
808 int run_hook_ve(const char *const *env
, const char *name
, va_list args
)
810 struct child_process hook
= CHILD_PROCESS_INIT
;
817 argv_array_push(&hook
.args
, p
);
818 while ((p
= va_arg(args
, const char *)))
819 argv_array_push(&hook
.args
, p
);
822 hook
.stdout_to_stderr
= 1;
824 return run_command(&hook
);
827 int run_hook_le(const char *const *env
, const char *name
, ...)
832 va_start(args
, name
);
833 ret
= run_hook_ve(env
, name
, args
);
839 int capture_command(struct child_process
*cmd
, struct strbuf
*buf
, size_t hint
)
842 if (start_command(cmd
) < 0)
845 if (strbuf_read(buf
, cmd
->out
, hint
) < 0) {
847 finish_command(cmd
); /* throw away exit code */
852 return finish_command(cmd
);