2 #include "run-command.h"
4 #include "argv-array.h"
6 static inline void close_pair(int fd[2])
13 static inline void dup_devnull(int to)
15 int fd = open("/dev/null", O_RDWR);
21 static const char **prepare_shell_cmd(const char **argv)
26 for (argc = 0; argv[argc]; argc++)
28 /* +1 for NULL, +3 for "sh -c" plus extra $0 */
29 nargv = xmalloc(sizeof(*nargv) * (argc + 1 + 3));
32 die("BUG: shell command is empty");
34 if (strcspn(argv[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv[0])) {
35 nargv[nargc++] = "sh";
36 nargv[nargc++] = "-c";
39 nargv[nargc++] = argv[0];
41 struct strbuf arg0 = STRBUF_INIT;
42 strbuf_addf(&arg0, "%s \"$@\"", argv[0]);
43 nargv[nargc++] = strbuf_detach(&arg0, NULL);
47 for (argc = 0; argv[argc]; argc++)
48 nargv[nargc++] = argv[argc];
55 static int execv_shell_cmd(const char **argv)
57 const char **nargv = prepare_shell_cmd(argv);
58 trace_argv_printf(nargv, "trace: exec:");
59 execvp(nargv[0], (char **)nargv);
66 static int child_err = 2;
67 static int child_notifier = -1;
69 static void notify_parent(void)
72 * execvp failed. If possible, we'd like to let start_command
73 * know, so failures like ENOENT can be handled right away; but
74 * otherwise, finish_command will still report the error.
76 xwrite(child_notifier, "", 1);
79 static NORETURN void die_child(const char *err, va_list params)
81 vwritef(child_err, "fatal: ", err, params);
85 static void error_child(const char *err, va_list params)
87 vwritef(child_err, "error: ", err, params);
91 static inline void set_cloexec(int fd)
93 int flags = fcntl(fd, F_GETFD);
95 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
98 static int wait_or_whine(pid_t pid, const char *argv0, int silent_exec_failure)
100 int status, code = -1;
102 int failed_errno = 0;
104 while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
108 failed_errno = errno;
109 error("waitpid for %s failed: %s", argv0, strerror(errno));
110 } else if (waiting != pid) {
111 error("waitpid is confused (%s)", argv0);
112 } else if (WIFSIGNALED(status)) {
113 code = WTERMSIG(status);
114 error("%s died of signal %d", argv0, code);
116 * This return value is chosen so that code & 0xff
117 * mimics the exit code that a POSIX shell would report for
118 * a program that died from this signal.
121 } else if (WIFEXITED(status)) {
122 code = WEXITSTATUS(status);
124 * Convert special exit code when execvp failed.
128 failed_errno = ENOENT;
131 error("waitpid is confused (%s)", argv0);
133 errno = failed_errno;
137 int start_command(struct child_process *cmd)
139 int need_in, need_out, need_err;
140 int fdin[2], fdout[2], fderr[2];
141 int failed_errno = failed_errno;
144 * In case of errors we must keep the promise to close FDs
145 * that have been passed in via ->in and ->out.
148 need_in = !cmd->no_stdin && cmd->in < 0;
150 if (pipe(fdin) < 0) {
151 failed_errno = errno;
159 need_out = !cmd->no_stdout
160 && !cmd->stdout_to_stderr
163 if (pipe(fdout) < 0) {
164 failed_errno = errno;
174 need_err = !cmd->no_stderr && cmd->err < 0;
176 if (pipe(fderr) < 0) {
177 failed_errno = errno;
187 error("cannot create pipe for %s: %s",
188 cmd->argv[0], strerror(failed_errno));
189 errno = failed_errno;
195 trace_argv_printf(cmd->argv, "trace: run_command:");
201 if (pipe(notify_pipe))
202 notify_pipe[0] = notify_pipe[1] = -1;
207 * Redirect the channel to write syscall error messages to
208 * before redirecting the process's stderr so that all die()
209 * in subsequent call paths use the parent's stderr.
211 if (cmd->no_stderr || need_err) {
213 set_cloexec(child_err);
215 set_die_routine(die_child);
216 set_error_routine(error_child);
218 close(notify_pipe[0]);
219 set_cloexec(notify_pipe[1]);
220 child_notifier = notify_pipe[1];
221 atexit(notify_parent);
228 } else if (cmd->in) {
238 } else if (cmd->err > 1) {
245 else if (cmd->stdout_to_stderr)
250 } else if (cmd->out > 1) {
255 if (cmd->dir && chdir(cmd->dir))
256 die_errno("exec '%s': cd to '%s' failed", cmd->argv[0],
259 for (; *cmd->env; cmd->env++) {
260 if (strchr(*cmd->env, '='))
261 putenv((char *)*cmd->env);
266 if (cmd->preexec_cb) {
268 * We cannot predict what the pre-exec callback does.
269 * Forgo parent notification.
271 close(child_notifier);
277 execv_git_cmd(cmd->argv);
278 } else if (cmd->use_shell) {
279 execv_shell_cmd(cmd->argv);
281 execvp(cmd->argv[0], (char *const*) cmd->argv);
283 if (errno == ENOENT) {
284 if (!cmd->silent_exec_failure)
285 error("cannot run %s: %s", cmd->argv[0],
289 die_errno("cannot exec '%s'", cmd->argv[0]);
293 error("cannot fork() for %s: %s", cmd->argv[0],
294 strerror(failed_errno = errno));
297 * Wait for child's execvp. If the execvp succeeds (or if fork()
298 * failed), EOF is seen immediately by the parent. Otherwise, the
299 * child process sends a single byte.
300 * Note that use of this infrastructure is completely advisory,
301 * therefore, we keep error checks minimal.
303 close(notify_pipe[1]);
304 if (read(notify_pipe[0], ¬ify_pipe[1], 1) == 1) {
306 * At this point we know that fork() succeeded, but execvp()
307 * failed. Errors have been reported to our stderr.
309 wait_or_whine(cmd->pid, cmd->argv[0],
310 cmd->silent_exec_failure);
311 failed_errno = errno;
314 close(notify_pipe[0]);
318 int fhin = 0, fhout = 1, fherr = 2;
319 const char **sargv = cmd->argv;
320 char **env = environ;
323 fhin = open("/dev/null", O_RDWR);
330 fherr = open("/dev/null", O_RDWR);
332 fherr = dup(fderr[1]);
333 else if (cmd->err > 2)
334 fherr = dup(cmd->err);
337 fhout = open("/dev/null", O_RDWR);
338 else if (cmd->stdout_to_stderr)
341 fhout = dup(fdout[1]);
342 else if (cmd->out > 1)
343 fhout = dup(cmd->out);
346 env = make_augmented_environ(cmd->env);
349 cmd->argv = prepare_git_cmd(cmd->argv);
350 } else if (cmd->use_shell) {
351 cmd->argv = prepare_shell_cmd(cmd->argv);
354 cmd->pid = mingw_spawnvpe(cmd->argv[0], cmd->argv, env, cmd->dir,
356 failed_errno = errno;
357 if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
358 error("cannot spawn %s: %s", cmd->argv[0], strerror(errno));
388 errno = failed_errno;
410 int finish_command(struct child_process *cmd)
412 return wait_or_whine(cmd->pid, cmd->argv[0], cmd->silent_exec_failure);
415 int run_command(struct child_process *cmd)
417 int code = start_command(cmd);
420 return finish_command(cmd);
423 static void prepare_run_command_v_opt(struct child_process *cmd,
427 memset(cmd, 0, sizeof(*cmd));
429 cmd->no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
430 cmd->git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
431 cmd->stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
432 cmd->silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
433 cmd->use_shell = opt & RUN_USING_SHELL ? 1 : 0;
436 int run_command_v_opt(const char **argv, int opt)
438 struct child_process cmd;
439 prepare_run_command_v_opt(&cmd, argv, opt);
440 return run_command(&cmd);
443 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
445 struct child_process cmd;
446 prepare_run_command_v_opt(&cmd, argv, opt);
449 return run_command(&cmd);
453 static pthread_t main_thread;
454 static int main_thread_set;
455 static pthread_key_t async_key;
457 static void *run_thread(void *data)
459 struct async *async = data;
462 pthread_setspecific(async_key, async);
463 ret = async->proc(async->proc_in, async->proc_out, async->data);
467 static NORETURN void die_async(const char *err, va_list params)
469 vreportf("fatal: ", err, params);
471 if (!pthread_equal(main_thread, pthread_self())) {
472 struct async *async = pthread_getspecific(async_key);
473 if (async->proc_in >= 0)
474 close(async->proc_in);
475 if (async->proc_out >= 0)
476 close(async->proc_out);
477 pthread_exit((void *)128);
484 int start_async(struct async *async)
486 int need_in, need_out;
487 int fdin[2], fdout[2];
488 int proc_in, proc_out;
490 need_in = async->in < 0;
492 if (pipe(fdin) < 0) {
495 return error("cannot create pipe: %s", strerror(errno));
500 need_out = async->out < 0;
502 if (pipe(fdout) < 0) {
507 return error("cannot create pipe: %s", strerror(errno));
509 async->out = fdout[0];
522 proc_out = async->out;
527 /* Flush stdio before fork() to avoid cloning buffers */
531 if (async->pid < 0) {
532 error("fork (async) failed: %s", strerror(errno));
540 exit(!!async->proc(proc_in, proc_out, async->data));
553 if (!main_thread_set) {
555 * We assume that the first time that start_async is called
556 * it is from the main thread.
559 main_thread = pthread_self();
560 pthread_key_create(&async_key, NULL);
561 set_die_routine(die_async);
565 set_cloexec(proc_in);
567 set_cloexec(proc_out);
568 async->proc_in = proc_in;
569 async->proc_out = proc_out;
571 int err = pthread_create(&async->tid, NULL, run_thread, async);
573 error("cannot create thread: %s", strerror(err));
593 int finish_async(struct async *async)
596 return wait_or_whine(async->pid, "child process", 0);
598 void *ret = (void *)(intptr_t)(-1);
600 if (pthread_join(async->tid, &ret))
601 error("pthread_join failed");
602 return (int)(intptr_t)ret;
606 int run_hook(const char *index_file, const char *name, ...)
608 struct child_process hook;
609 struct argv_array argv = ARGV_ARRAY_INIT;
610 const char *p, *env[2];
611 char index[PATH_MAX];
615 if (access(git_path("hooks/%s", name), X_OK) < 0)
618 va_start(args, name);
619 argv_array_push(&argv, git_path("hooks/%s", name));
620 while ((p = va_arg(args, const char *)))
621 argv_array_push(&argv, p);
624 memset(&hook, 0, sizeof(hook));
625 hook.argv = argv.argv;
627 hook.stdout_to_stderr = 1;
629 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
635 ret = run_command(&hook);
636 argv_array_clear(&argv);