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
**last
, *p
;
58 last
= &children_to_clean
;
59 for (p
= children_to_clean
; p
; p
= p
->next
) {
68 static inline void close_pair(int fd
[2])
75 static inline void dup_devnull(int to
)
77 int fd
= open("/dev/null", O_RDWR
);
83 static char *locate_in_PATH(const char *file
)
85 const char *p
= getenv("PATH");
86 struct strbuf buf
= STRBUF_INIT
;
92 const char *end
= strchrnul(p
, ':');
96 /* POSIX specifies an empty entry as the current directory. */
98 strbuf_add(&buf
, p
, end
- p
);
99 strbuf_addch(&buf
, '/');
101 strbuf_addstr(&buf
, file
);
103 if (!access(buf
.buf
, F_OK
))
104 return strbuf_detach(&buf
, NULL
);
111 strbuf_release(&buf
);
115 static int exists_in_PATH(const char *file
)
117 char *r
= locate_in_PATH(file
);
122 int sane_execvp(const char *file
, char * const argv
[])
124 if (!execvp(file
, argv
))
125 return 0; /* cannot happen ;-) */
128 * When a command can't be found because one of the directories
129 * listed in $PATH is unsearchable, execvp reports EACCES, but
130 * careful usability testing (read: analysis of occasional bug
131 * reports) reveals that "No such file or directory" is more
134 * We avoid commands with "/", because execvp will not do $PATH
135 * lookups in that case.
137 * The reassignment of EACCES to errno looks like a no-op below,
138 * but we need to protect against exists_in_PATH overwriting errno.
140 if (errno
== EACCES
&& !strchr(file
, '/'))
141 errno
= exists_in_PATH(file
) ? EACCES
: ENOENT
;
145 static const char **prepare_shell_cmd(const char **argv
)
150 for (argc
= 0; argv
[argc
]; argc
++)
151 ; /* just counting */
152 /* +1 for NULL, +3 for "sh -c" plus extra $0 */
153 nargv
= xmalloc(sizeof(*nargv
) * (argc
+ 1 + 3));
156 die("BUG: shell command is empty");
158 if (strcspn(argv
[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv
[0])) {
160 nargv
[nargc
++] = SHELL_PATH
;
162 nargv
[nargc
++] = "sh";
164 nargv
[nargc
++] = "-c";
167 nargv
[nargc
++] = argv
[0];
169 struct strbuf arg0
= STRBUF_INIT
;
170 strbuf_addf(&arg0
, "%s \"$@\"", argv
[0]);
171 nargv
[nargc
++] = strbuf_detach(&arg0
, NULL
);
175 for (argc
= 0; argv
[argc
]; argc
++)
176 nargv
[nargc
++] = argv
[argc
];
183 static int execv_shell_cmd(const char **argv
)
185 const char **nargv
= prepare_shell_cmd(argv
);
186 trace_argv_printf(nargv
, "trace: exec:");
187 sane_execvp(nargv
[0], (char **)nargv
);
194 static int child_err
= 2;
195 static int child_notifier
= -1;
197 static void notify_parent(void)
200 * execvp failed. If possible, we'd like to let start_command
201 * know, so failures like ENOENT can be handled right away; but
202 * otherwise, finish_command will still report the error.
204 xwrite(child_notifier
, "", 1);
207 static NORETURN
void die_child(const char *err
, va_list params
)
209 vwritef(child_err
, "fatal: ", err
, params
);
213 static void error_child(const char *err
, va_list params
)
215 vwritef(child_err
, "error: ", err
, params
);
219 static inline void set_cloexec(int fd
)
221 int flags
= fcntl(fd
, F_GETFD
);
223 fcntl(fd
, F_SETFD
, flags
| FD_CLOEXEC
);
226 static int wait_or_whine(pid_t pid
, const char *argv0
, int silent_exec_failure
)
228 int status
, code
= -1;
230 int failed_errno
= 0;
232 while ((waiting
= waitpid(pid
, &status
, 0)) < 0 && errno
== EINTR
)
236 failed_errno
= errno
;
237 error("waitpid for %s failed: %s", argv0
, strerror(errno
));
238 } else if (waiting
!= pid
) {
239 error("waitpid is confused (%s)", argv0
);
240 } else if (WIFSIGNALED(status
)) {
241 code
= WTERMSIG(status
);
242 error("%s died of signal %d", argv0
, code
);
244 * This return value is chosen so that code & 0xff
245 * mimics the exit code that a POSIX shell would report for
246 * a program that died from this signal.
249 } else if (WIFEXITED(status
)) {
250 code
= WEXITSTATUS(status
);
252 * Convert special exit code when execvp failed.
256 failed_errno
= ENOENT
;
259 error("waitpid is confused (%s)", argv0
);
262 clear_child_for_cleanup(pid
);
264 errno
= failed_errno
;
268 int start_command(struct child_process
*cmd
)
270 int need_in
, need_out
, need_err
;
271 int fdin
[2], fdout
[2], fderr
[2];
272 int failed_errno
= failed_errno
;
275 * In case of errors we must keep the promise to close FDs
276 * that have been passed in via ->in and ->out.
279 need_in
= !cmd
->no_stdin
&& cmd
->in
< 0;
281 if (pipe(fdin
) < 0) {
282 failed_errno
= errno
;
290 need_out
= !cmd
->no_stdout
291 && !cmd
->stdout_to_stderr
294 if (pipe(fdout
) < 0) {
295 failed_errno
= errno
;
305 need_err
= !cmd
->no_stderr
&& cmd
->err
< 0;
307 if (pipe(fderr
) < 0) {
308 failed_errno
= errno
;
318 error("cannot create pipe for %s: %s",
319 cmd
->argv
[0], strerror(failed_errno
));
320 errno
= failed_errno
;
326 trace_argv_printf(cmd
->argv
, "trace: run_command:");
332 if (pipe(notify_pipe
))
333 notify_pipe
[0] = notify_pipe
[1] = -1;
338 * Redirect the channel to write syscall error messages to
339 * before redirecting the process's stderr so that all die()
340 * in subsequent call paths use the parent's stderr.
342 if (cmd
->no_stderr
|| need_err
) {
344 set_cloexec(child_err
);
346 set_die_routine(die_child
);
347 set_error_routine(error_child
);
349 close(notify_pipe
[0]);
350 set_cloexec(notify_pipe
[1]);
351 child_notifier
= notify_pipe
[1];
352 atexit(notify_parent
);
359 } else if (cmd
->in
) {
369 } else if (cmd
->err
> 1) {
376 else if (cmd
->stdout_to_stderr
)
381 } else if (cmd
->out
> 1) {
386 if (cmd
->dir
&& chdir(cmd
->dir
))
387 die_errno("exec '%s': cd to '%s' failed", cmd
->argv
[0],
390 for (; *cmd
->env
; cmd
->env
++) {
391 if (strchr(*cmd
->env
, '='))
392 putenv((char *)*cmd
->env
);
397 if (cmd
->preexec_cb
) {
399 * We cannot predict what the pre-exec callback does.
400 * Forgo parent notification.
402 close(child_notifier
);
408 execv_git_cmd(cmd
->argv
);
409 } else if (cmd
->use_shell
) {
410 execv_shell_cmd(cmd
->argv
);
412 sane_execvp(cmd
->argv
[0], (char *const*) cmd
->argv
);
414 if (errno
== ENOENT
) {
415 if (!cmd
->silent_exec_failure
)
416 error("cannot run %s: %s", cmd
->argv
[0],
420 die_errno("cannot exec '%s'", cmd
->argv
[0]);
424 error("cannot fork() for %s: %s", cmd
->argv
[0],
425 strerror(failed_errno
= errno
));
426 else if (cmd
->clean_on_exit
)
427 mark_child_for_cleanup(cmd
->pid
);
430 * Wait for child's execvp. If the execvp succeeds (or if fork()
431 * failed), EOF is seen immediately by the parent. Otherwise, the
432 * child process sends a single byte.
433 * Note that use of this infrastructure is completely advisory,
434 * therefore, we keep error checks minimal.
436 close(notify_pipe
[1]);
437 if (read(notify_pipe
[0], ¬ify_pipe
[1], 1) == 1) {
439 * At this point we know that fork() succeeded, but execvp()
440 * failed. Errors have been reported to our stderr.
442 wait_or_whine(cmd
->pid
, cmd
->argv
[0],
443 cmd
->silent_exec_failure
);
444 failed_errno
= errno
;
447 close(notify_pipe
[0]);
452 int fhin
= 0, fhout
= 1, fherr
= 2;
453 const char **sargv
= cmd
->argv
;
454 char **env
= environ
;
457 fhin
= open("/dev/null", O_RDWR
);
464 fherr
= open("/dev/null", O_RDWR
);
466 fherr
= dup(fderr
[1]);
467 else if (cmd
->err
> 2)
468 fherr
= dup(cmd
->err
);
471 fhout
= open("/dev/null", O_RDWR
);
472 else if (cmd
->stdout_to_stderr
)
475 fhout
= dup(fdout
[1]);
476 else if (cmd
->out
> 1)
477 fhout
= dup(cmd
->out
);
480 env
= make_augmented_environ(cmd
->env
);
483 cmd
->argv
= prepare_git_cmd(cmd
->argv
);
484 } else if (cmd
->use_shell
) {
485 cmd
->argv
= prepare_shell_cmd(cmd
->argv
);
488 cmd
->pid
= mingw_spawnvpe(cmd
->argv
[0], cmd
->argv
, env
, cmd
->dir
,
490 failed_errno
= errno
;
491 if (cmd
->pid
< 0 && (!cmd
->silent_exec_failure
|| errno
!= ENOENT
))
492 error("cannot spawn %s: %s", cmd
->argv
[0], strerror(errno
));
493 if (cmd
->clean_on_exit
&& cmd
->pid
>= 0)
494 mark_child_for_cleanup(cmd
->pid
);
524 errno
= failed_errno
;
546 int finish_command(struct child_process
*cmd
)
548 return wait_or_whine(cmd
->pid
, cmd
->argv
[0], cmd
->silent_exec_failure
);
551 int run_command(struct child_process
*cmd
)
553 int code
= start_command(cmd
);
556 return finish_command(cmd
);
559 static void prepare_run_command_v_opt(struct child_process
*cmd
,
563 memset(cmd
, 0, sizeof(*cmd
));
565 cmd
->no_stdin
= opt
& RUN_COMMAND_NO_STDIN
? 1 : 0;
566 cmd
->git_cmd
= opt
& RUN_GIT_CMD
? 1 : 0;
567 cmd
->stdout_to_stderr
= opt
& RUN_COMMAND_STDOUT_TO_STDERR
? 1 : 0;
568 cmd
->silent_exec_failure
= opt
& RUN_SILENT_EXEC_FAILURE
? 1 : 0;
569 cmd
->use_shell
= opt
& RUN_USING_SHELL
? 1 : 0;
570 cmd
->clean_on_exit
= opt
& RUN_CLEAN_ON_EXIT
? 1 : 0;
573 int run_command_v_opt(const char **argv
, int opt
)
575 struct child_process cmd
;
576 prepare_run_command_v_opt(&cmd
, argv
, opt
);
577 return run_command(&cmd
);
580 int run_command_v_opt_cd_env(const char **argv
, int opt
, const char *dir
, const char *const *env
)
582 struct child_process cmd
;
583 prepare_run_command_v_opt(&cmd
, argv
, opt
);
586 return run_command(&cmd
);
590 static pthread_t main_thread
;
591 static int main_thread_set
;
592 static pthread_key_t async_key
;
594 static void *run_thread(void *data
)
596 struct async
*async
= data
;
599 pthread_setspecific(async_key
, async
);
600 ret
= async
->proc(async
->proc_in
, async
->proc_out
, async
->data
);
604 static NORETURN
void die_async(const char *err
, va_list params
)
606 vreportf("fatal: ", err
, params
);
608 if (!pthread_equal(main_thread
, pthread_self())) {
609 struct async
*async
= pthread_getspecific(async_key
);
610 if (async
->proc_in
>= 0)
611 close(async
->proc_in
);
612 if (async
->proc_out
>= 0)
613 close(async
->proc_out
);
614 pthread_exit((void *)128);
621 int start_async(struct async
*async
)
623 int need_in
, need_out
;
624 int fdin
[2], fdout
[2];
625 int proc_in
, proc_out
;
627 need_in
= async
->in
< 0;
629 if (pipe(fdin
) < 0) {
632 return error("cannot create pipe: %s", strerror(errno
));
637 need_out
= async
->out
< 0;
639 if (pipe(fdout
) < 0) {
644 return error("cannot create pipe: %s", strerror(errno
));
646 async
->out
= fdout
[0];
659 proc_out
= async
->out
;
664 /* Flush stdio before fork() to avoid cloning buffers */
668 if (async
->pid
< 0) {
669 error("fork (async) failed: %s", strerror(errno
));
677 exit(!!async
->proc(proc_in
, proc_out
, async
->data
));
680 mark_child_for_cleanup(async
->pid
);
692 if (!main_thread_set
) {
694 * We assume that the first time that start_async is called
695 * it is from the main thread.
698 main_thread
= pthread_self();
699 pthread_key_create(&async_key
, NULL
);
700 set_die_routine(die_async
);
704 set_cloexec(proc_in
);
706 set_cloexec(proc_out
);
707 async
->proc_in
= proc_in
;
708 async
->proc_out
= proc_out
;
710 int err
= pthread_create(&async
->tid
, NULL
, run_thread
, async
);
712 error("cannot create thread: %s", strerror(err
));
732 int finish_async(struct async
*async
)
735 return wait_or_whine(async
->pid
, "child process", 0);
737 void *ret
= (void *)(intptr_t)(-1);
739 if (pthread_join(async
->tid
, &ret
))
740 error("pthread_join failed");
741 return (int)(intptr_t)ret
;
745 int run_hook(const char *index_file
, const char *name
, ...)
747 struct child_process hook
;
748 struct argv_array argv
= ARGV_ARRAY_INIT
;
749 const char *p
, *env
[2];
750 char index
[PATH_MAX
];
754 if (access(git_path("hooks/%s", name
), X_OK
) < 0)
757 va_start(args
, name
);
758 argv_array_push(&argv
, git_path("hooks/%s", name
));
759 while ((p
= va_arg(args
, const char *)))
760 argv_array_push(&argv
, p
);
763 memset(&hook
, 0, sizeof(hook
));
764 hook
.argv
= argv
.argv
;
766 hook
.stdout_to_stderr
= 1;
768 snprintf(index
, sizeof(index
), "GIT_INDEX_FILE=%s", index_file
);
774 ret
= run_command(&hook
);
775 argv_array_clear(&argv
);