ewah: support platforms that require aligned reads
[git] / run-command.c
1 #include "cache.h"
2 #include "run-command.h"
3 #include "exec_cmd.h"
4 #include "sigchain.h"
5 #include "argv-array.h"
6
7 #ifndef SHELL_PATH
8 # define SHELL_PATH "/bin/sh"
9 #endif
10
11 struct child_to_clean {
12         pid_t pid;
13         struct child_to_clean *next;
14 };
15 static struct child_to_clean *children_to_clean;
16 static int installed_child_cleanup_handler;
17
18 static void cleanup_children(int sig)
19 {
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         }
26 }
27
28 static void cleanup_children_on_signal(int sig)
29 {
30         cleanup_children(sig);
31         sigchain_pop(sig);
32         raise(sig);
33 }
34
35 static void cleanup_children_on_exit(void)
36 {
37         cleanup_children(SIGTERM);
38 }
39
40 static void mark_child_for_cleanup(pid_t pid)
41 {
42         struct child_to_clean *p = xmalloc(sizeof(*p));
43         p->pid = pid;
44         p->next = children_to_clean;
45         children_to_clean = p;
46
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         }
52 }
53
54 static void clear_child_for_cleanup(pid_t pid)
55 {
56         struct child_to_clean **pp;
57
58         for (pp = &children_to_clean; *pp; pp = &(*pp)->next) {
59                 struct child_to_clean *clean_me = *pp;
60
61                 if (clean_me->pid == pid) {
62                         *pp = clean_me->next;
63                         free(clean_me);
64                         return;
65                 }
66         }
67 }
68
69 static inline void close_pair(int fd[2])
70 {
71         close(fd[0]);
72         close(fd[1]);
73 }
74
75 #ifndef GIT_WINDOWS_NATIVE
76 static inline void dup_devnull(int to)
77 {
78         int fd = open("/dev/null", O_RDWR);
79         if (fd < 0)
80                 die_errno(_("open /dev/null failed"));
81         if (dup2(fd, to) < 0)
82                 die_errno(_("dup2(%d,%d) failed"), fd, to);
83         close(fd);
84 }
85 #endif
86
87 static char *locate_in_PATH(const char *file)
88 {
89         const char *p = getenv("PATH");
90         struct strbuf buf = STRBUF_INIT;
91
92         if (!p || !*p)
93                 return NULL;
94
95         while (1) {
96                 const char *end = strchrnul(p, ':');
97
98                 strbuf_reset(&buf);
99
100                 /* POSIX specifies an empty entry as the current directory. */
101                 if (end != p) {
102                         strbuf_add(&buf, p, end - p);
103                         strbuf_addch(&buf, '/');
104                 }
105                 strbuf_addstr(&buf, file);
106
107                 if (!access(buf.buf, F_OK))
108                         return strbuf_detach(&buf, NULL);
109
110                 if (!*end)
111                         break;
112                 p = end + 1;
113         }
114
115         strbuf_release(&buf);
116         return NULL;
117 }
118
119 static int exists_in_PATH(const char *file)
120 {
121         char *r = locate_in_PATH(file);
122         free(r);
123         return r != NULL;
124 }
125
126 int sane_execvp(const char *file, char * const argv[])
127 {
128         if (!execvp(file, argv))
129                 return 0; /* cannot happen ;-) */
130
131         /*
132          * When a command can't be found because one of the directories
133          * listed in $PATH is unsearchable, execvp reports EACCES, but
134          * careful usability testing (read: analysis of occasional bug
135          * reports) reveals that "No such file or directory" is more
136          * intuitive.
137          *
138          * We avoid commands with "/", because execvp will not do $PATH
139          * lookups in that case.
140          *
141          * The reassignment of EACCES to errno looks like a no-op below,
142          * but we need to protect against exists_in_PATH overwriting errno.
143          */
144         if (errno == EACCES && !strchr(file, '/'))
145                 errno = exists_in_PATH(file) ? EACCES : ENOENT;
146         else if (errno == ENOTDIR && !strchr(file, '/'))
147                 errno = ENOENT;
148         return -1;
149 }
150
151 static const char **prepare_shell_cmd(const char **argv)
152 {
153         int argc, nargc = 0;
154         const char **nargv;
155
156         for (argc = 0; argv[argc]; argc++)
157                 ; /* just counting */
158         /* +1 for NULL, +3 for "sh -c" plus extra $0 */
159         nargv = xmalloc(sizeof(*nargv) * (argc + 1 + 3));
160
161         if (argc < 1)
162                 die("BUG: shell command is empty");
163
164         if (strcspn(argv[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv[0])) {
165 #ifndef GIT_WINDOWS_NATIVE
166                 nargv[nargc++] = SHELL_PATH;
167 #else
168                 nargv[nargc++] = "sh";
169 #endif
170                 nargv[nargc++] = "-c";
171
172                 if (argc < 2)
173                         nargv[nargc++] = argv[0];
174                 else {
175                         struct strbuf arg0 = STRBUF_INIT;
176                         strbuf_addf(&arg0, "%s \"$@\"", argv[0]);
177                         nargv[nargc++] = strbuf_detach(&arg0, NULL);
178                 }
179         }
180
181         for (argc = 0; argv[argc]; argc++)
182                 nargv[nargc++] = argv[argc];
183         nargv[nargc] = NULL;
184
185         return nargv;
186 }
187
188 #ifndef GIT_WINDOWS_NATIVE
189 static int execv_shell_cmd(const char **argv)
190 {
191         const char **nargv = prepare_shell_cmd(argv);
192         trace_argv_printf(nargv, "trace: exec:");
193         sane_execvp(nargv[0], (char **)nargv);
194         free(nargv);
195         return -1;
196 }
197 #endif
198
199 #ifndef GIT_WINDOWS_NATIVE
200 static int child_err = 2;
201 static int child_notifier = -1;
202
203 static void notify_parent(void)
204 {
205         /*
206          * execvp failed.  If possible, we'd like to let start_command
207          * know, so failures like ENOENT can be handled right away; but
208          * otherwise, finish_command will still report the error.
209          */
210         xwrite(child_notifier, "", 1);
211 }
212
213 static NORETURN void die_child(const char *err, va_list params)
214 {
215         vwritef(child_err, "fatal: ", err, params);
216         exit(128);
217 }
218
219 static void error_child(const char *err, va_list params)
220 {
221         vwritef(child_err, "error: ", err, params);
222 }
223 #endif
224
225 static inline void set_cloexec(int fd)
226 {
227         int flags = fcntl(fd, F_GETFD);
228         if (flags >= 0)
229                 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
230 }
231
232 static int wait_or_whine(pid_t pid, const char *argv0)
233 {
234         int status, code = -1;
235         pid_t waiting;
236         int failed_errno = 0;
237
238         while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
239                 ;       /* nothing */
240
241         if (waiting < 0) {
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);
250                 /*
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.
254                  */
255                 code += 128;
256         } else if (WIFEXITED(status)) {
257                 code = WEXITSTATUS(status);
258                 /*
259                  * Convert special exit code when execvp failed.
260                  */
261                 if (code == 127) {
262                         code = -1;
263                         failed_errno = ENOENT;
264                 }
265         } else {
266                 error("waitpid is confused (%s)", argv0);
267         }
268
269         clear_child_for_cleanup(pid);
270
271         errno = failed_errno;
272         return code;
273 }
274
275 int start_command(struct child_process *cmd)
276 {
277         int need_in, need_out, need_err;
278         int fdin[2], fdout[2], fderr[2];
279         int failed_errno;
280         char *str;
281
282         /*
283          * In case of errors we must keep the promise to close FDs
284          * that have been passed in via ->in and ->out.
285          */
286
287         need_in = !cmd->no_stdin && cmd->in < 0;
288         if (need_in) {
289                 if (pipe(fdin) < 0) {
290                         failed_errno = errno;
291                         if (cmd->out > 0)
292                                 close(cmd->out);
293                         str = "standard input";
294                         goto fail_pipe;
295                 }
296                 cmd->in = fdin[1];
297         }
298
299         need_out = !cmd->no_stdout
300                 && !cmd->stdout_to_stderr
301                 && cmd->out < 0;
302         if (need_out) {
303                 if (pipe(fdout) < 0) {
304                         failed_errno = errno;
305                         if (need_in)
306                                 close_pair(fdin);
307                         else if (cmd->in)
308                                 close(cmd->in);
309                         str = "standard output";
310                         goto fail_pipe;
311                 }
312                 cmd->out = fdout[0];
313         }
314
315         need_err = !cmd->no_stderr && cmd->err < 0;
316         if (need_err) {
317                 if (pipe(fderr) < 0) {
318                         failed_errno = errno;
319                         if (need_in)
320                                 close_pair(fdin);
321                         else if (cmd->in)
322                                 close(cmd->in);
323                         if (need_out)
324                                 close_pair(fdout);
325                         else if (cmd->out)
326                                 close(cmd->out);
327                         str = "standard error";
328 fail_pipe:
329                         error("cannot create %s pipe for %s: %s",
330                                 str, cmd->argv[0], strerror(failed_errno));
331                         errno = failed_errno;
332                         return -1;
333                 }
334                 cmd->err = fderr[0];
335         }
336
337         trace_argv_printf(cmd->argv, "trace: run_command:");
338         fflush(NULL);
339
340 #ifndef GIT_WINDOWS_NATIVE
341 {
342         int notify_pipe[2];
343         if (pipe(notify_pipe))
344                 notify_pipe[0] = notify_pipe[1] = -1;
345
346         cmd->pid = fork();
347         failed_errno = errno;
348         if (!cmd->pid) {
349                 /*
350                  * Redirect the channel to write syscall error messages to
351                  * before redirecting the process's stderr so that all die()
352                  * in subsequent call paths use the parent's stderr.
353                  */
354                 if (cmd->no_stderr || need_err) {
355                         child_err = dup(2);
356                         set_cloexec(child_err);
357                 }
358                 set_die_routine(die_child);
359                 set_error_routine(error_child);
360
361                 close(notify_pipe[0]);
362                 set_cloexec(notify_pipe[1]);
363                 child_notifier = notify_pipe[1];
364                 atexit(notify_parent);
365
366                 if (cmd->no_stdin)
367                         dup_devnull(0);
368                 else if (need_in) {
369                         dup2(fdin[0], 0);
370                         close_pair(fdin);
371                 } else if (cmd->in) {
372                         dup2(cmd->in, 0);
373                         close(cmd->in);
374                 }
375
376                 if (cmd->no_stderr)
377                         dup_devnull(2);
378                 else if (need_err) {
379                         dup2(fderr[1], 2);
380                         close_pair(fderr);
381                 } else if (cmd->err > 1) {
382                         dup2(cmd->err, 2);
383                         close(cmd->err);
384                 }
385
386                 if (cmd->no_stdout)
387                         dup_devnull(1);
388                 else if (cmd->stdout_to_stderr)
389                         dup2(2, 1);
390                 else if (need_out) {
391                         dup2(fdout[1], 1);
392                         close_pair(fdout);
393                 } else if (cmd->out > 1) {
394                         dup2(cmd->out, 1);
395                         close(cmd->out);
396                 }
397
398                 if (cmd->dir && chdir(cmd->dir))
399                         die_errno("exec '%s': cd to '%s' failed", cmd->argv[0],
400                             cmd->dir);
401                 if (cmd->env) {
402                         for (; *cmd->env; cmd->env++) {
403                                 if (strchr(*cmd->env, '='))
404                                         putenv((char *)*cmd->env);
405                                 else
406                                         unsetenv(*cmd->env);
407                         }
408                 }
409                 if (cmd->git_cmd) {
410                         execv_git_cmd(cmd->argv);
411                 } else if (cmd->use_shell) {
412                         execv_shell_cmd(cmd->argv);
413                 } else {
414                         sane_execvp(cmd->argv[0], (char *const*) cmd->argv);
415                 }
416                 if (errno == ENOENT) {
417                         if (!cmd->silent_exec_failure)
418                                 error("cannot run %s: %s", cmd->argv[0],
419                                         strerror(ENOENT));
420                         exit(127);
421                 } else {
422                         die_errno("cannot exec '%s'", cmd->argv[0]);
423                 }
424         }
425         if (cmd->pid < 0)
426                 error("cannot fork() for %s: %s", cmd->argv[0],
427                         strerror(errno));
428         else if (cmd->clean_on_exit)
429                 mark_child_for_cleanup(cmd->pid);
430
431         /*
432          * Wait for child's execvp. If the execvp succeeds (or if fork()
433          * failed), EOF is seen immediately by the parent. Otherwise, the
434          * child process sends a single byte.
435          * Note that use of this infrastructure is completely advisory,
436          * therefore, we keep error checks minimal.
437          */
438         close(notify_pipe[1]);
439         if (read(notify_pipe[0], &notify_pipe[1], 1) == 1) {
440                 /*
441                  * At this point we know that fork() succeeded, but execvp()
442                  * failed. Errors have been reported to our stderr.
443                  */
444                 wait_or_whine(cmd->pid, cmd->argv[0]);
445                 failed_errno = errno;
446                 cmd->pid = -1;
447         }
448         close(notify_pipe[0]);
449
450 }
451 #else
452 {
453         int fhin = 0, fhout = 1, fherr = 2;
454         const char **sargv = cmd->argv;
455         char **env = environ;
456
457         if (cmd->no_stdin)
458                 fhin = open("/dev/null", O_RDWR);
459         else if (need_in)
460                 fhin = dup(fdin[0]);
461         else if (cmd->in)
462                 fhin = dup(cmd->in);
463
464         if (cmd->no_stderr)
465                 fherr = open("/dev/null", O_RDWR);
466         else if (need_err)
467                 fherr = dup(fderr[1]);
468         else if (cmd->err > 2)
469                 fherr = dup(cmd->err);
470
471         if (cmd->no_stdout)
472                 fhout = open("/dev/null", O_RDWR);
473         else if (cmd->stdout_to_stderr)
474                 fhout = dup(fherr);
475         else if (need_out)
476                 fhout = dup(fdout[1]);
477         else if (cmd->out > 1)
478                 fhout = dup(cmd->out);
479
480         if (cmd->env)
481                 env = make_augmented_environ(cmd->env);
482
483         if (cmd->git_cmd) {
484                 cmd->argv = prepare_git_cmd(cmd->argv);
485         } else if (cmd->use_shell) {
486                 cmd->argv = prepare_shell_cmd(cmd->argv);
487         }
488
489         cmd->pid = mingw_spawnvpe(cmd->argv[0], cmd->argv, env, cmd->dir,
490                                   fhin, fhout, fherr);
491         failed_errno = errno;
492         if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
493                 error("cannot spawn %s: %s", cmd->argv[0], strerror(errno));
494         if (cmd->clean_on_exit && cmd->pid >= 0)
495                 mark_child_for_cleanup(cmd->pid);
496
497         if (cmd->env)
498                 free_environ(env);
499         if (cmd->git_cmd)
500                 free(cmd->argv);
501
502         cmd->argv = sargv;
503         if (fhin != 0)
504                 close(fhin);
505         if (fhout != 1)
506                 close(fhout);
507         if (fherr != 2)
508                 close(fherr);
509 }
510 #endif
511
512         if (cmd->pid < 0) {
513                 if (need_in)
514                         close_pair(fdin);
515                 else if (cmd->in)
516                         close(cmd->in);
517                 if (need_out)
518                         close_pair(fdout);
519                 else if (cmd->out)
520                         close(cmd->out);
521                 if (need_err)
522                         close_pair(fderr);
523                 else if (cmd->err)
524                         close(cmd->err);
525                 errno = failed_errno;
526                 return -1;
527         }
528
529         if (need_in)
530                 close(fdin[0]);
531         else if (cmd->in)
532                 close(cmd->in);
533
534         if (need_out)
535                 close(fdout[1]);
536         else if (cmd->out)
537                 close(cmd->out);
538
539         if (need_err)
540                 close(fderr[1]);
541         else if (cmd->err)
542                 close(cmd->err);
543
544         return 0;
545 }
546
547 int finish_command(struct child_process *cmd)
548 {
549         return wait_or_whine(cmd->pid, cmd->argv[0]);
550 }
551
552 int run_command(struct child_process *cmd)
553 {
554         int code = start_command(cmd);
555         if (code)
556                 return code;
557         return finish_command(cmd);
558 }
559
560 static void prepare_run_command_v_opt(struct child_process *cmd,
561                                       const char **argv,
562                                       int opt)
563 {
564         memset(cmd, 0, sizeof(*cmd));
565         cmd->argv = argv;
566         cmd->no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
567         cmd->git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
568         cmd->stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
569         cmd->silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
570         cmd->use_shell = opt & RUN_USING_SHELL ? 1 : 0;
571         cmd->clean_on_exit = opt & RUN_CLEAN_ON_EXIT ? 1 : 0;
572 }
573
574 int run_command_v_opt(const char **argv, int opt)
575 {
576         struct child_process cmd;
577         prepare_run_command_v_opt(&cmd, argv, opt);
578         return run_command(&cmd);
579 }
580
581 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
582 {
583         struct child_process cmd;
584         prepare_run_command_v_opt(&cmd, argv, opt);
585         cmd.dir = dir;
586         cmd.env = env;
587         return run_command(&cmd);
588 }
589
590 #ifndef NO_PTHREADS
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;
595
596 static void *run_thread(void *data)
597 {
598         struct async *async = data;
599         intptr_t ret;
600
601         pthread_setspecific(async_key, async);
602         ret = async->proc(async->proc_in, async->proc_out, async->data);
603         return (void *)ret;
604 }
605
606 static NORETURN void die_async(const char *err, va_list params)
607 {
608         vreportf("fatal: ", err, params);
609
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);
617         }
618
619         exit(128);
620 }
621
622 static int async_die_is_recursing(void)
623 {
624         void *ret = pthread_getspecific(async_die_counter);
625         pthread_setspecific(async_die_counter, (void *)1);
626         return ret != NULL;
627 }
628
629 #endif
630
631 int start_async(struct async *async)
632 {
633         int need_in, need_out;
634         int fdin[2], fdout[2];
635         int proc_in, proc_out;
636
637         need_in = async->in < 0;
638         if (need_in) {
639                 if (pipe(fdin) < 0) {
640                         if (async->out > 0)
641                                 close(async->out);
642                         return error("cannot create pipe: %s", strerror(errno));
643                 }
644                 async->in = fdin[1];
645         }
646
647         need_out = async->out < 0;
648         if (need_out) {
649                 if (pipe(fdout) < 0) {
650                         if (need_in)
651                                 close_pair(fdin);
652                         else if (async->in)
653                                 close(async->in);
654                         return error("cannot create pipe: %s", strerror(errno));
655                 }
656                 async->out = fdout[0];
657         }
658
659         if (need_in)
660                 proc_in = fdin[0];
661         else if (async->in)
662                 proc_in = async->in;
663         else
664                 proc_in = -1;
665
666         if (need_out)
667                 proc_out = fdout[1];
668         else if (async->out)
669                 proc_out = async->out;
670         else
671                 proc_out = -1;
672
673 #ifdef NO_PTHREADS
674         /* Flush stdio before fork() to avoid cloning buffers */
675         fflush(NULL);
676
677         async->pid = fork();
678         if (async->pid < 0) {
679                 error("fork (async) failed: %s", strerror(errno));
680                 goto error;
681         }
682         if (!async->pid) {
683                 if (need_in)
684                         close(fdin[1]);
685                 if (need_out)
686                         close(fdout[0]);
687                 exit(!!async->proc(proc_in, proc_out, async->data));
688         }
689
690         mark_child_for_cleanup(async->pid);
691
692         if (need_in)
693                 close(fdin[0]);
694         else if (async->in)
695                 close(async->in);
696
697         if (need_out)
698                 close(fdout[1]);
699         else if (async->out)
700                 close(async->out);
701 #else
702         if (!main_thread_set) {
703                 /*
704                  * We assume that the first time that start_async is called
705                  * it is from the main thread.
706                  */
707                 main_thread_set = 1;
708                 main_thread = pthread_self();
709                 pthread_key_create(&async_key, NULL);
710                 pthread_key_create(&async_die_counter, NULL);
711                 set_die_routine(die_async);
712                 set_die_is_recursing_routine(async_die_is_recursing);
713         }
714
715         if (proc_in >= 0)
716                 set_cloexec(proc_in);
717         if (proc_out >= 0)
718                 set_cloexec(proc_out);
719         async->proc_in = proc_in;
720         async->proc_out = proc_out;
721         {
722                 int err = pthread_create(&async->tid, NULL, run_thread, async);
723                 if (err) {
724                         error("cannot create thread: %s", strerror(err));
725                         goto error;
726                 }
727         }
728 #endif
729         return 0;
730
731 error:
732         if (need_in)
733                 close_pair(fdin);
734         else if (async->in)
735                 close(async->in);
736
737         if (need_out)
738                 close_pair(fdout);
739         else if (async->out)
740                 close(async->out);
741         return -1;
742 }
743
744 int finish_async(struct async *async)
745 {
746 #ifdef NO_PTHREADS
747         return wait_or_whine(async->pid, "child process");
748 #else
749         void *ret = (void *)(intptr_t)(-1);
750
751         if (pthread_join(async->tid, &ret))
752                 error("pthread_join failed");
753         return (int)(intptr_t)ret;
754 #endif
755 }
756
757 char *find_hook(const char *name)
758 {
759         char *path = git_path("hooks/%s", name);
760         if (access(path, X_OK) < 0)
761                 path = NULL;
762
763         return path;
764 }
765
766 int run_hook(const char *index_file, const char *name, ...)
767 {
768         struct child_process hook;
769         struct argv_array argv = ARGV_ARRAY_INIT;
770         const char *p, *env[2];
771         char index[PATH_MAX];
772         va_list args;
773         int ret;
774
775         p = find_hook(name);
776         if (!p)
777                 return 0;
778
779         argv_array_push(&argv, p);
780
781         va_start(args, name);
782         while ((p = va_arg(args, const char *)))
783                 argv_array_push(&argv, p);
784         va_end(args);
785
786         memset(&hook, 0, sizeof(hook));
787         hook.argv = argv.argv;
788         hook.no_stdin = 1;
789         hook.stdout_to_stderr = 1;
790         if (index_file) {
791                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
792                 env[0] = index;
793                 env[1] = NULL;
794                 hook.env = env;
795         }
796
797         ret = run_command(&hook);
798         argv_array_clear(&argv);
799         return ret;
800 }