git-remote-hg: add the helper
[git/dscho.git] / run-command.c
bloba72581bd91cd25fa45b50162490f5f4e75137e91
1 #include "cache.h"
2 #include "run-command.h"
3 #include "exec_cmd.h"
4 #include "sigchain.h"
5 #include "argv-array.h"
7 #ifndef SHELL_PATH
8 # define SHELL_PATH "/bin/sh"
9 #endif
11 struct child_to_clean {
12         pid_t pid;
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;
23                 kill(p->pid, sig);
24                 free(p);
25         }
28 static void cleanup_children_on_signal(int sig)
30         cleanup_children(sig);
31         sigchain_pop(sig);
32         raise(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));
43         p->pid = pid;
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;
51         }
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) {
62                         *pp = clean_me->next;
63                         free(clean_me);
64                         return;
65                 }
66         }
69 static inline void close_pair(int fd[2])
71         close(fd[0]);
72         close(fd[1]);
75 #ifndef WIN32
76 static inline void dup_devnull(int to)
78         int fd = open("/dev/null", O_RDWR);
79         dup2(fd, to);
80         close(fd);
82 #endif
84 static char *locate_in_PATH(const char *file)
86         const char *p = getenv("PATH");
87         struct strbuf buf = STRBUF_INIT;
89         if (!p || !*p)
90                 return NULL;
92         while (1) {
93                 const char *end = strchrnul(p, ':');
95                 strbuf_reset(&buf);
97                 /* POSIX specifies an empty entry as the current directory. */
98                 if (end != p) {
99                         strbuf_add(&buf, p, end - p);
100                         strbuf_addch(&buf, '/');
101                 }
102                 strbuf_addstr(&buf, file);
104                 if (!access(buf.buf, F_OK))
105                         return strbuf_detach(&buf, NULL);
107                 if (!*end)
108                         break;
109                 p = end + 1;
110         }
112         strbuf_release(&buf);
113         return NULL;
116 static int exists_in_PATH(const char *file)
118         char *r = locate_in_PATH(file);
119         free(r);
120         return r != NULL;
123 int sane_execvp(const char *file, char * const argv[])
125         if (!execvp(file, argv))
126                 return 0; /* cannot happen ;-) */
128         /*
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
133          * intuitive.
134          *
135          * We avoid commands with "/", because execvp will not do $PATH
136          * lookups in that case.
137          *
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.
140          */
141         if (errno == EACCES && !strchr(file, '/'))
142                 errno = exists_in_PATH(file) ? EACCES : ENOENT;
143         else if (errno == ENOTDIR && !strchr(file, '/'))
144                 errno = ENOENT;
145         return -1;
148 static const char **prepare_shell_cmd(const char **argv)
150         int argc, nargc = 0;
151         const char **nargv;
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));
158         if (argc < 1)
159                 die("BUG: shell command is empty");
161         if (strcspn(argv[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv[0])) {
162 #ifndef WIN32
163                 nargv[nargc++] = SHELL_PATH;
164 #else
165                 nargv[nargc++] = "sh";
166 #endif
167                 nargv[nargc++] = "-c";
169                 if (argc < 2)
170                         nargv[nargc++] = argv[0];
171                 else {
172                         struct strbuf arg0 = STRBUF_INIT;
173                         strbuf_addf(&arg0, "%s \"$@\"", argv[0]);
174                         nargv[nargc++] = strbuf_detach(&arg0, NULL);
175                 }
176         }
178         for (argc = 0; argv[argc]; argc++)
179                 nargv[nargc++] = argv[argc];
180         nargv[nargc] = NULL;
182         return nargv;
185 #ifndef WIN32
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);
191         free(nargv);
192         return -1;
194 #endif
196 #ifndef WIN32
197 static int child_err = 2;
198 static int child_notifier = -1;
200 static void notify_parent(void)
202         /*
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.
206          */
207         xwrite(child_notifier, "", 1);
210 static NORETURN void die_child(const char *err, va_list params)
212         vwritef(child_err, "fatal: ", err, params);
213         exit(128);
216 static void error_child(const char *err, va_list params)
218         vwritef(child_err, "error: ", err, params);
220 #endif
222 static inline void set_cloexec(int fd)
224         int flags = fcntl(fd, F_GETFD);
225         if (flags >= 0)
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;
232         pid_t waiting;
233         int failed_errno = 0;
235         while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
236                 ;       /* nothing */
238         if (waiting < 0) {
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);
246                 /*
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.
250                  */
251                 code -= 128;
252         } else if (WIFEXITED(status)) {
253                 code = WEXITSTATUS(status);
254                 /*
255                  * Convert special exit code when execvp failed.
256                  */
257                 if (code == 127) {
258                         code = -1;
259                         failed_errno = ENOENT;
260                 }
261         } else {
262                 error("waitpid is confused (%s)", argv0);
263         }
265         clear_child_for_cleanup(pid);
267         errno = failed_errno;
268         return code;
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;
277         /*
278          * In case of errors we must keep the promise to close FDs
279          * that have been passed in via ->in and ->out.
280          */
282         need_in = !cmd->no_stdin && cmd->in < 0;
283         if (need_in) {
284                 if (pipe(fdin) < 0) {
285                         failed_errno = errno;
286                         if (cmd->out > 0)
287                                 close(cmd->out);
288                         goto fail_pipe;
289                 }
290                 cmd->in = fdin[1];
291         }
293         need_out = !cmd->no_stdout
294                 && !cmd->stdout_to_stderr
295                 && cmd->out < 0;
296         if (need_out) {
297                 if (pipe(fdout) < 0) {
298                         failed_errno = errno;
299                         if (need_in)
300                                 close_pair(fdin);
301                         else if (cmd->in)
302                                 close(cmd->in);
303                         goto fail_pipe;
304                 }
305                 cmd->out = fdout[0];
306         }
308         need_err = !cmd->no_stderr && cmd->err < 0;
309         if (need_err) {
310                 if (pipe(fderr) < 0) {
311                         failed_errno = errno;
312                         if (need_in)
313                                 close_pair(fdin);
314                         else if (cmd->in)
315                                 close(cmd->in);
316                         if (need_out)
317                                 close_pair(fdout);
318                         else if (cmd->out)
319                                 close(cmd->out);
320 fail_pipe:
321                         error("cannot create pipe for %s: %s",
322                                 cmd->argv[0], strerror(failed_errno));
323                         errno = failed_errno;
324                         return -1;
325                 }
326                 cmd->err = fderr[0];
327         }
329         trace_argv_printf(cmd->argv, "trace: run_command:");
330         fflush(NULL);
332 #ifndef WIN32
334         int notify_pipe[2];
335         if (pipe(notify_pipe))
336                 notify_pipe[0] = notify_pipe[1] = -1;
338         cmd->pid = fork();
339         if (!cmd->pid) {
340                 /*
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.
344                  */
345                 if (cmd->no_stderr || need_err) {
346                         child_err = dup(2);
347                         set_cloexec(child_err);
348                 }
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);
357                 if (cmd->no_stdin)
358                         dup_devnull(0);
359                 else if (need_in) {
360                         dup2(fdin[0], 0);
361                         close_pair(fdin);
362                 } else if (cmd->in) {
363                         dup2(cmd->in, 0);
364                         close(cmd->in);
365                 }
367                 if (cmd->no_stderr)
368                         dup_devnull(2);
369                 else if (need_err) {
370                         dup2(fderr[1], 2);
371                         close_pair(fderr);
372                 } else if (cmd->err > 1) {
373                         dup2(cmd->err, 2);
374                         close(cmd->err);
375                 }
377                 if (cmd->no_stdout)
378                         dup_devnull(1);
379                 else if (cmd->stdout_to_stderr)
380                         dup2(2, 1);
381                 else if (need_out) {
382                         dup2(fdout[1], 1);
383                         close_pair(fdout);
384                 } else if (cmd->out > 1) {
385                         dup2(cmd->out, 1);
386                         close(cmd->out);
387                 }
389                 if (cmd->dir && chdir(cmd->dir))
390                         die_errno("exec '%s': cd to '%s' failed", cmd->argv[0],
391                             cmd->dir);
392                 if (cmd->env) {
393                         for (; *cmd->env; cmd->env++) {
394                                 if (strchr(*cmd->env, '='))
395                                         putenv((char *)*cmd->env);
396                                 else
397                                         unsetenv(*cmd->env);
398                         }
399                 }
400                 if (cmd->preexec_cb) {
401                         /*
402                          * We cannot predict what the pre-exec callback does.
403                          * Forgo parent notification.
404                          */
405                         close(child_notifier);
406                         child_notifier = -1;
408                         cmd->preexec_cb();
409                 }
410                 if (cmd->git_cmd) {
411                         execv_git_cmd(cmd->argv);
412                 } else if (cmd->use_shell) {
413                         execv_shell_cmd(cmd->argv);
414                 } else {
415                         sane_execvp(cmd->argv[0], (char *const*) cmd->argv);
416                 }
417                 if (errno == ENOENT) {
418                         if (!cmd->silent_exec_failure)
419                                 error("cannot run %s: %s", cmd->argv[0],
420                                         strerror(ENOENT));
421                         exit(127);
422                 } else {
423                         die_errno("cannot exec '%s'", cmd->argv[0]);
424                 }
425         }
426         if (cmd->pid < 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);
432         /*
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.
438          */
439         close(notify_pipe[1]);
440         if (read(notify_pipe[0], &notify_pipe[1], 1) == 1) {
441                 /*
442                  * At this point we know that fork() succeeded, but execvp()
443                  * failed. Errors have been reported to our stderr.
444                  */
445                 wait_or_whine(cmd->pid, cmd->argv[0],
446                               cmd->silent_exec_failure);
447                 failed_errno = errno;
448                 cmd->pid = -1;
449         }
450         close(notify_pipe[0]);
453 #else
455         int fhin = 0, fhout = 1, fherr = 2;
456         const char **sargv = cmd->argv;
458         if (cmd->no_stdin)
459                 fhin = open("/dev/null", O_RDWR);
460         else if (need_in)
461                 fhin = dup(fdin[0]);
462         else if (cmd->in)
463                 fhin = dup(cmd->in);
465         if (cmd->no_stderr)
466                 fherr = open("/dev/null", O_RDWR);
467         else if (need_err)
468                 fherr = dup(fderr[1]);
469         else if (cmd->err > 2)
470                 fherr = dup(cmd->err);
472         if (cmd->no_stdout)
473                 fhout = open("/dev/null", O_RDWR);
474         else if (cmd->stdout_to_stderr)
475                 fhout = dup(fherr);
476         else if (need_out)
477                 fhout = dup(fdout[1]);
478         else if (cmd->out > 1)
479                 fhout = dup(cmd->out);
481         if (cmd->git_cmd) {
482                 cmd->argv = prepare_git_cmd(cmd->argv);
483         } else if (cmd->use_shell) {
484                 cmd->argv = prepare_shell_cmd(cmd->argv);
485         }
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);
495         if (cmd->git_cmd)
496                 free(cmd->argv);
498         cmd->argv = sargv;
499         if (fhin != 0)
500                 close(fhin);
501         if (fhout != 1)
502                 close(fhout);
503         if (fherr != 2)
504                 close(fherr);
506 #endif
508         if (cmd->pid < 0) {
509                 if (need_in)
510                         close_pair(fdin);
511                 else if (cmd->in)
512                         close(cmd->in);
513                 if (need_out)
514                         close_pair(fdout);
515                 else if (cmd->out)
516                         close(cmd->out);
517                 if (need_err)
518                         close_pair(fderr);
519                 else if (cmd->err)
520                         close(cmd->err);
521                 errno = failed_errno;
522                 return -1;
523         }
525         if (need_in)
526                 close(fdin[0]);
527         else if (cmd->in)
528                 close(cmd->in);
530         if (need_out)
531                 close(fdout[1]);
532         else if (cmd->out)
533                 close(cmd->out);
535         if (need_err)
536                 close(fderr[1]);
537         else if (cmd->err)
538                 close(cmd->err);
540         return 0;
543 int finish_command(struct child_process *cmd)
545         return wait_or_whine(cmd->pid, cmd->argv[0], cmd->silent_exec_failure);
548 int run_command(struct child_process *cmd)
550         int code = start_command(cmd);
551         if (code)
552                 return code;
553         return finish_command(cmd);
556 static void prepare_run_command_v_opt(struct child_process *cmd,
557                                       const char **argv,
558                                       int opt)
560         memset(cmd, 0, sizeof(*cmd));
561         cmd->argv = argv;
562         cmd->no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
563         cmd->git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
564         cmd->stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
565         cmd->silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
566         cmd->use_shell = opt & RUN_USING_SHELL ? 1 : 0;
567         cmd->clean_on_exit = opt & RUN_CLEAN_ON_EXIT ? 1 : 0;
570 int run_command_v_opt(const char **argv, int opt)
572         struct child_process cmd;
573         prepare_run_command_v_opt(&cmd, argv, opt);
574         return run_command(&cmd);
577 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
579         struct child_process cmd;
580         prepare_run_command_v_opt(&cmd, argv, opt);
581         cmd.dir = dir;
582         cmd.env = env;
583         return run_command(&cmd);
586 #ifndef NO_PTHREADS
587 static pthread_t main_thread;
588 static int main_thread_set;
589 static pthread_key_t async_key;
591 static void *run_thread(void *data)
593         struct async *async = data;
594         intptr_t ret;
596         pthread_setspecific(async_key, async);
597         ret = async->proc(async->proc_in, async->proc_out, async->data);
598         return (void *)ret;
601 static NORETURN void die_async(const char *err, va_list params)
603         vreportf("fatal: ", err, params);
605         if (!pthread_equal(main_thread, pthread_self())) {
606                 struct async *async = pthread_getspecific(async_key);
607                 if (async->proc_in >= 0)
608                         close(async->proc_in);
609                 if (async->proc_out >= 0)
610                         close(async->proc_out);
611                 pthread_exit((void *)128);
612         }
614         exit(128);
616 #endif
618 int start_async(struct async *async)
620         int need_in, need_out;
621         int fdin[2], fdout[2];
622         int proc_in, proc_out;
624         need_in = async->in < 0;
625         if (need_in) {
626                 if (pipe(fdin) < 0) {
627                         if (async->out > 0)
628                                 close(async->out);
629                         return error("cannot create pipe: %s", strerror(errno));
630                 }
631                 async->in = fdin[1];
632         }
634         need_out = async->out < 0;
635         if (need_out) {
636                 if (pipe(fdout) < 0) {
637                         if (need_in)
638                                 close_pair(fdin);
639                         else if (async->in)
640                                 close(async->in);
641                         return error("cannot create pipe: %s", strerror(errno));
642                 }
643                 async->out = fdout[0];
644         }
646         if (need_in)
647                 proc_in = fdin[0];
648         else if (async->in)
649                 proc_in = async->in;
650         else
651                 proc_in = -1;
653         if (need_out)
654                 proc_out = fdout[1];
655         else if (async->out)
656                 proc_out = async->out;
657         else
658                 proc_out = -1;
660 #ifdef NO_PTHREADS
661         /* Flush stdio before fork() to avoid cloning buffers */
662         fflush(NULL);
664         async->pid = fork();
665         if (async->pid < 0) {
666                 error("fork (async) failed: %s", strerror(errno));
667                 goto error;
668         }
669         if (!async->pid) {
670                 if (need_in)
671                         close(fdin[1]);
672                 if (need_out)
673                         close(fdout[0]);
674                 exit(!!async->proc(proc_in, proc_out, async->data));
675         }
677         mark_child_for_cleanup(async->pid);
679         if (need_in)
680                 close(fdin[0]);
681         else if (async->in)
682                 close(async->in);
684         if (need_out)
685                 close(fdout[1]);
686         else if (async->out)
687                 close(async->out);
688 #else
689         if (!main_thread_set) {
690                 /*
691                  * We assume that the first time that start_async is called
692                  * it is from the main thread.
693                  */
694                 main_thread_set = 1;
695                 main_thread = pthread_self();
696                 pthread_key_create(&async_key, NULL);
697                 set_die_routine(die_async);
698         }
700         if (proc_in >= 0)
701                 set_cloexec(proc_in);
702         if (proc_out >= 0)
703                 set_cloexec(proc_out);
704         async->proc_in = proc_in;
705         async->proc_out = proc_out;
706         {
707                 int err = pthread_create(&async->tid, NULL, run_thread, async);
708                 if (err) {
709                         error("cannot create thread: %s", strerror(err));
710                         goto error;
711                 }
712         }
713 #endif
714         return 0;
716 error:
717         if (need_in)
718                 close_pair(fdin);
719         else if (async->in)
720                 close(async->in);
722         if (need_out)
723                 close_pair(fdout);
724         else if (async->out)
725                 close(async->out);
726         return -1;
729 int finish_async(struct async *async)
731 #ifdef NO_PTHREADS
732         return wait_or_whine(async->pid, "child process", 0);
733 #else
734         void *ret = (void *)(intptr_t)(-1);
736         if (pthread_join(async->tid, &ret))
737                 error("pthread_join failed");
738         return (int)(intptr_t)ret;
739 #endif
742 int run_hook(const char *index_file, const char *name, ...)
744         struct child_process hook;
745         struct argv_array argv = ARGV_ARRAY_INIT;
746         const char *p, *env[2];
747         char index[PATH_MAX];
748         va_list args;
749         int ret;
751         if (access(git_path("hooks/%s", name), X_OK) < 0)
752                 return 0;
754         va_start(args, name);
755         argv_array_push(&argv, git_path("hooks/%s", name));
756         while ((p = va_arg(args, const char *)))
757                 argv_array_push(&argv, p);
758         va_end(args);
760         memset(&hook, 0, sizeof(hook));
761         hook.argv = argv.argv;
762         hook.no_stdin = 1;
763         hook.stdout_to_stderr = 1;
764         if (index_file) {
765                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
766                 env[0] = index;
767                 env[1] = NULL;
768                 hook.env = env;
769         }
771         ret = run_command(&hook);
772         argv_array_clear(&argv);
773         return ret;