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, int silent_exec_failure)
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 error("%s died of signal %d", argv0, code);
247 * This return value is chosen so that code & 0xff
248 * mimics the exit code that a POSIX shell would report for
249 * a program that died from this signal.
252 } else if (WIFEXITED(status)) {
253 code = WEXITSTATUS(status);
255 * Convert special exit code when execvp failed.
259 failed_errno = ENOENT;
262 error("waitpid is confused (%s)", argv0);
265 clear_child_for_cleanup(pid);
267 errno = failed_errno;
271 int start_command(struct child_process *cmd)
273 int need_in, need_out, need_err;
274 int fdin[2], fdout[2], fderr[2];
275 int failed_errno = failed_errno;
278 * In case of errors we must keep the promise to close FDs
279 * that have been passed in via ->in and ->out.
282 need_in = !cmd->no_stdin && cmd->in < 0;
284 if (pipe(fdin) < 0) {
285 failed_errno = errno;
293 need_out = !cmd->no_stdout
294 && !cmd->stdout_to_stderr
297 if (pipe(fdout) < 0) {
298 failed_errno = errno;
308 need_err = !cmd->no_stderr && cmd->err < 0;
310 if (pipe(fderr) < 0) {
311 failed_errno = errno;
321 error("cannot create pipe for %s: %s",
322 cmd->argv[0], strerror(failed_errno));
323 errno = failed_errno;
329 trace_argv_printf(cmd->argv, "trace: run_command:");
335 if (pipe(notify_pipe))
336 notify_pipe[0] = notify_pipe[1] = -1;
341 * Redirect the channel to write syscall error messages to
342 * before redirecting the process's stderr so that all die()
343 * in subsequent call paths use the parent's stderr.
345 if (cmd->no_stderr || need_err) {
347 set_cloexec(child_err);
349 set_die_routine(die_child);
350 set_error_routine(error_child);
352 close(notify_pipe[0]);
353 set_cloexec(notify_pipe[1]);
354 child_notifier = notify_pipe[1];
355 atexit(notify_parent);
362 } else if (cmd->in) {
372 } else if (cmd->err > 1) {
379 else if (cmd->stdout_to_stderr)
384 } else if (cmd->out > 1) {
389 if (cmd->dir && chdir(cmd->dir))
390 die_errno("exec '%s': cd to '%s' failed", cmd->argv[0],
393 for (; *cmd->env; cmd->env++) {
394 if (strchr(*cmd->env, '='))
395 putenv((char *)*cmd->env);
400 if (cmd->preexec_cb) {
402 * We cannot predict what the pre-exec callback does.
403 * Forgo parent notification.
405 close(child_notifier);
411 execv_git_cmd(cmd->argv);
412 } else if (cmd->use_shell) {
413 execv_shell_cmd(cmd->argv);
415 sane_execvp(cmd->argv[0], (char *const*) cmd->argv);
417 if (errno == ENOENT) {
418 if (!cmd->silent_exec_failure)
419 error("cannot run %s: %s", cmd->argv[0],
423 die_errno("cannot exec '%s'", cmd->argv[0]);
427 error("cannot fork() for %s: %s", cmd->argv[0],
428 strerror(failed_errno = errno));
429 else if (cmd->clean_on_exit)
430 mark_child_for_cleanup(cmd->pid);
433 * Wait for child's execvp. If the execvp succeeds (or if fork()
434 * failed), EOF is seen immediately by the parent. Otherwise, the
435 * child process sends a single byte.
436 * Note that use of this infrastructure is completely advisory,
437 * therefore, we keep error checks minimal.
439 close(notify_pipe[1]);
440 if (read(notify_pipe[0], ¬ify_pipe[1], 1) == 1) {
442 * At this point we know that fork() succeeded, but execvp()
443 * failed. Errors have been reported to our stderr.
445 wait_or_whine(cmd->pid, cmd->argv[0],
446 cmd->silent_exec_failure);
447 failed_errno = errno;
450 close(notify_pipe[0]);
455 int fhin = 0, fhout = 1, fherr = 2;
456 const char **sargv = cmd->argv;
457 char **env = environ;
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 env = make_augmented_environ(cmd->env);
486 cmd->argv = prepare_git_cmd(cmd->argv);
487 } else if (cmd->use_shell) {
488 cmd->argv = prepare_shell_cmd(cmd->argv);
491 cmd->pid = mingw_spawnvpe(cmd->argv[0], cmd->argv, env, cmd->dir,
493 failed_errno = errno;
494 if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
495 error("cannot spawn %s: %s", cmd->argv[0], strerror(errno));
496 if (cmd->clean_on_exit && cmd->pid >= 0)
497 mark_child_for_cleanup(cmd->pid);
527 errno = failed_errno;
549 int finish_command(struct child_process *cmd)
551 return wait_or_whine(cmd->pid, cmd->argv[0], cmd->silent_exec_failure);
554 int run_command(struct child_process *cmd)
556 int code = start_command(cmd);
559 return finish_command(cmd);
562 static void prepare_run_command_v_opt(struct child_process *cmd,
566 memset(cmd, 0, sizeof(*cmd));
568 cmd->no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
569 cmd->git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
570 cmd->stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
571 cmd->silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
572 cmd->use_shell = opt & RUN_USING_SHELL ? 1 : 0;
573 cmd->clean_on_exit = opt & RUN_CLEAN_ON_EXIT ? 1 : 0;
576 int run_command_v_opt(const char **argv, int opt)
578 struct child_process cmd;
579 prepare_run_command_v_opt(&cmd, argv, opt);
580 return run_command(&cmd);
583 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
585 struct child_process cmd;
586 prepare_run_command_v_opt(&cmd, argv, opt);
589 return run_command(&cmd);
593 static pthread_t main_thread;
594 static int main_thread_set;
595 static pthread_key_t async_key;
597 static void *run_thread(void *data)
599 struct async *async = data;
602 pthread_setspecific(async_key, async);
603 ret = async->proc(async->proc_in, async->proc_out, async->data);
607 static NORETURN void die_async(const char *err, va_list params)
609 vreportf("fatal: ", err, params);
611 if (!pthread_equal(main_thread, pthread_self())) {
612 struct async *async = pthread_getspecific(async_key);
613 if (async->proc_in >= 0)
614 close(async->proc_in);
615 if (async->proc_out >= 0)
616 close(async->proc_out);
617 pthread_exit((void *)128);
624 int start_async(struct async *async)
626 int need_in, need_out;
627 int fdin[2], fdout[2];
628 int proc_in, proc_out;
630 need_in = async->in < 0;
632 if (pipe(fdin) < 0) {
635 return error("cannot create pipe: %s", strerror(errno));
640 need_out = async->out < 0;
642 if (pipe(fdout) < 0) {
647 return error("cannot create pipe: %s", strerror(errno));
649 async->out = fdout[0];
662 proc_out = async->out;
667 /* Flush stdio before fork() to avoid cloning buffers */
671 if (async->pid < 0) {
672 error("fork (async) failed: %s", strerror(errno));
680 exit(!!async->proc(proc_in, proc_out, async->data));
683 mark_child_for_cleanup(async->pid);
695 if (!main_thread_set) {
697 * We assume that the first time that start_async is called
698 * it is from the main thread.
701 main_thread = pthread_self();
702 pthread_key_create(&async_key, NULL);
703 set_die_routine(die_async);
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", 0);
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 int run_hook(const char *index_file, const char *name, ...)
750 struct child_process hook;
751 struct argv_array argv = ARGV_ARRAY_INIT;
752 const char *p, *env[2];
753 char index[PATH_MAX];
757 if (access(git_path("hooks/%s", name), X_OK) < 0)
760 va_start(args, name);
761 argv_array_push(&argv, git_path("hooks/%s", name));
762 while ((p = va_arg(args, const char *)))
763 argv_array_push(&argv, p);
766 memset(&hook, 0, sizeof(hook));
767 hook.argv = argv.argv;
769 hook.stdout_to_stderr = 1;
771 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
777 ret = run_command(&hook);
778 argv_array_clear(&argv);