git.oblomov.eu Git - git/blob - run-command.c

   1 #include "cache.h"
   2 #include "run-command.h"
   3 #include "exec-cmd.h"
   4 #include "sigchain.h"
   5 #include "strvec.h"
   6 #include "thread-utils.h"
   7 #include "strbuf.h"
   8 #include "string-list.h"
   9 #include "quote.h"
  10
  11 void child_process_init(struct child_process *child)
  12 {
  13         memset(child, 0, sizeof(*child));
  14         strvec_init(&child->args);
  15         strvec_init(&child->env_array);
  16 }
  17
  18 void child_process_clear(struct child_process *child)
  19 {
  20         strvec_clear(&child->args);
  21         strvec_clear(&child->env_array);
  22 }
  23
  24 struct child_to_clean {
  25         pid_t pid;
  26         struct child_process *process;
  27         struct child_to_clean *next;
  28 };
  29 static struct child_to_clean *children_to_clean;
  30 static int installed_child_cleanup_handler;
  31
  32 static void cleanup_children(int sig, int in_signal)
  33 {
  34         struct child_to_clean *children_to_wait_for = NULL;
  35
  36         while (children_to_clean) {
  37                 struct child_to_clean *p = children_to_clean;
  38                 children_to_clean = p->next;
  39
  40                 if (p->process && !in_signal) {
  41                         struct child_process *process = p->process;
  42                         if (process->clean_on_exit_handler) {
  43                                 trace_printf(
  44                                         "trace: run_command: running exit handler for pid %"
  45                                         PRIuMAX, (uintmax_t)p->pid
  46                                 );
  47                                 process->clean_on_exit_handler(process);
  48                         }
  49                 }
  50
  51                 kill(p->pid, sig);
  52
  53                 if (p->process && p->process->wait_after_clean) {
  54                         p->next = children_to_wait_for;
  55                         children_to_wait_for = p;
  56                 } else {
  57                         if (!in_signal)
  58                                 free(p);
  59                 }
  60         }
  61
  62         while (children_to_wait_for) {
  63                 struct child_to_clean *p = children_to_wait_for;
  64                 children_to_wait_for = p->next;
  65
  66                 while (waitpid(p->pid, NULL, 0) < 0 && errno == EINTR)
  67                         ; /* spin waiting for process exit or error */
  68
  69                 if (!in_signal)
  70                         free(p);
  71         }
  72 }
  73
  74 static void cleanup_children_on_signal(int sig)
  75 {
  76         cleanup_children(sig, 1);
  77         sigchain_pop(sig);
  78         raise(sig);
  79 }
  80
  81 static void cleanup_children_on_exit(void)
  82 {
  83         cleanup_children(SIGTERM, 0);
  84 }
  85
  86 static void mark_child_for_cleanup(pid_t pid, struct child_process *process)
  87 {
  88         struct child_to_clean *p = xmalloc(sizeof(*p));
  89         p->pid = pid;
  90         p->process = process;
  91         p->next = children_to_clean;
  92         children_to_clean = p;
  93
  94         if (!installed_child_cleanup_handler) {
  95                 atexit(cleanup_children_on_exit);
  96                 sigchain_push_common(cleanup_children_on_signal);
  97                 installed_child_cleanup_handler = 1;
  98         }
  99 }
 100
 101 static void clear_child_for_cleanup(pid_t pid)
 102 {
 103         struct child_to_clean **pp;
 104
 105         for (pp = &children_to_clean; *pp; pp = &(*pp)->next) {
 106                 struct child_to_clean *clean_me = *pp;
 107
 108                 if (clean_me->pid == pid) {
 109                         *pp = clean_me->next;
 110                         free(clean_me);
 111                         return;
 112                 }
 113         }
 114 }
 115
 116 static inline void close_pair(int fd[2])
 117 {
 118         close(fd[0]);
 119         close(fd[1]);
 120 }
 121
 122 int is_executable(const char *name)
 123 {
 124         struct stat st;
 125
 126         if (stat(name, &st) || /* stat, not lstat */
 127             !S_ISREG(st.st_mode))
 128                 return 0;
 129
 130 #if defined(GIT_WINDOWS_NATIVE)
 131         /*
 132          * On Windows there is no executable bit. The file extension
 133          * indicates whether it can be run as an executable, and Git
 134          * has special-handling to detect scripts and launch them
 135          * through the indicated script interpreter. We test for the
 136          * file extension first because virus scanners may make
 137          * it quite expensive to open many files.
 138          */
 139         if (ends_with(name, ".exe"))
 140                 return S_IXUSR;
 141
 142 {
 143         /*
 144          * Now that we know it does not have an executable extension,
 145          * peek into the file instead.
 146          */
 147         char buf[3] = { 0 };
 148         int n;
 149         int fd = open(name, O_RDONLY);
 150         st.st_mode &= ~S_IXUSR;
 151         if (fd >= 0) {
 152                 n = read(fd, buf, 2);
 153                 if (n == 2)
 154                         /* look for a she-bang */
 155                         if (!strcmp(buf, "#!"))
 156                                 st.st_mode |= S_IXUSR;
 157                 close(fd);
 158         }
 159 }
 160 #endif
 161         return st.st_mode & S_IXUSR;
 162 }
 163
 164 /*
 165  * Search $PATH for a command.  This emulates the path search that
 166  * execvp would perform, without actually executing the command so it
 167  * can be used before fork() to prepare to run a command using
 168  * execve() or after execvp() to diagnose why it failed.
 169  *
 170  * The caller should ensure that file contains no directory
 171  * separators.
 172  *
 173  * Returns the path to the command, as found in $PATH or NULL if the
 174  * command could not be found.  The caller inherits ownership of the memory
 175  * used to store the resultant path.
 176  *
 177  * This should not be used on Windows, where the $PATH search rules
 178  * are more complicated (e.g., a search for "foo" should find
 179  * "foo.exe").
 180  */
 181 static char *locate_in_PATH(const char *file)
 182 {
 183         const char *p = getenv("PATH");
 184         struct strbuf buf = STRBUF_INIT;
 185
 186         if (!p || !*p)
 187                 return NULL;
 188
 189         while (1) {
 190                 const char *end = strchrnul(p, ':');
 191
 192                 strbuf_reset(&buf);
 193
 194                 /* POSIX specifies an empty entry as the current directory. */
 195                 if (end != p) {
 196                         strbuf_add(&buf, p, end - p);
 197                         strbuf_addch(&buf, '/');
 198                 }
 199                 strbuf_addstr(&buf, file);
 200
 201                 if (is_executable(buf.buf))
 202                         return strbuf_detach(&buf, NULL);
 203
 204                 if (!*end)
 205                         break;
 206                 p = end + 1;
 207         }
 208
 209         strbuf_release(&buf);
 210         return NULL;
 211 }
 212
 213 static int exists_in_PATH(const char *file)
 214 {
 215         char *r = locate_in_PATH(file);
 216         int found = r != NULL;
 217         free(r);
 218         return found;
 219 }
 220
 221 int sane_execvp(const char *file, char * const argv[])
 222 {
 223 #ifndef GIT_WINDOWS_NATIVE
 224         /*
 225          * execvp() doesn't return, so we all we can do is tell trace2
 226          * what we are about to do and let it leave a hint in the log
 227          * (unless of course the execvp() fails).
 228          *
 229          * we skip this for Windows because the compat layer already
 230          * has to emulate the execvp() call anyway.
 231          */
 232         int exec_id = trace2_exec(file, (const char **)argv);
 233 #endif
 234
 235         if (!execvp(file, argv))
 236                 return 0; /* cannot happen ;-) */
 237
 238 #ifndef GIT_WINDOWS_NATIVE
 239         {
 240                 int ec = errno;
 241                 trace2_exec_result(exec_id, ec);
 242                 errno = ec;
 243         }
 244 #endif
 245
 246         /*
 247          * When a command can't be found because one of the directories
 248          * listed in $PATH is unsearchable, execvp reports EACCES, but
 249          * careful usability testing (read: analysis of occasional bug
 250          * reports) reveals that "No such file or directory" is more
 251          * intuitive.
 252          *
 253          * We avoid commands with "/", because execvp will not do $PATH
 254          * lookups in that case.
 255          *
 256          * The reassignment of EACCES to errno looks like a no-op below,
 257          * but we need to protect against exists_in_PATH overwriting errno.
 258          */
 259         if (errno == EACCES && !strchr(file, '/'))
 260                 errno = exists_in_PATH(file) ? EACCES : ENOENT;
 261         else if (errno == ENOTDIR && !strchr(file, '/'))
 262                 errno = ENOENT;
 263         return -1;
 264 }
 265
 266 static const char **prepare_shell_cmd(struct strvec *out, const char **argv)
 267 {
 268         if (!argv[0])
 269                 BUG("shell command is empty");
 270
 271         if (strcspn(argv[0], "|&;<>()$`\\\"' \t\n*?[#~=%") != strlen(argv[0])) {
 272 #ifndef GIT_WINDOWS_NATIVE
 273                 strvec_push(out, SHELL_PATH);
 274 #else
 275                 strvec_push(out, "sh");
 276 #endif
 277                 strvec_push(out, "-c");
 278
 279                 /*
 280                  * If we have no extra arguments, we do not even need to
 281                  * bother with the "$@" magic.
 282                  */
 283                 if (!argv[1])
 284                         strvec_push(out, argv[0]);
 285                 else
 286                         strvec_pushf(out, "%s \"$@\"", argv[0]);
 287         }
 288
 289         strvec_pushv(out, argv);
 290         return out->v;
 291 }
 292
 293 #ifndef GIT_WINDOWS_NATIVE
 294 static int child_notifier = -1;
 295
 296 enum child_errcode {
 297         CHILD_ERR_CHDIR,
 298         CHILD_ERR_DUP2,
 299         CHILD_ERR_CLOSE,
 300         CHILD_ERR_SIGPROCMASK,
 301         CHILD_ERR_ENOENT,
 302         CHILD_ERR_SILENT,
 303         CHILD_ERR_ERRNO
 304 };
 305
 306 struct child_err {
 307         enum child_errcode err;
 308         int syserr; /* errno */
 309 };
 310
 311 static void child_die(enum child_errcode err)
 312 {
 313         struct child_err buf;
 314
 315         buf.err = err;
 316         buf.syserr = errno;
 317
 318         /* write(2) on buf smaller than PIPE_BUF (min 512) is atomic: */
 319         xwrite(child_notifier, &buf, sizeof(buf));
 320         _exit(1);
 321 }
 322
 323 static void child_dup2(int fd, int to)
 324 {
 325         if (dup2(fd, to) < 0)
 326                 child_die(CHILD_ERR_DUP2);
 327 }
 328
 329 static void child_close(int fd)
 330 {
 331         if (close(fd))
 332                 child_die(CHILD_ERR_CLOSE);
 333 }
 334
 335 static void child_close_pair(int fd[2])
 336 {
 337         child_close(fd[0]);
 338         child_close(fd[1]);
 339 }
 340
 341 /*
 342  * parent will make it look like the child spewed a fatal error and died
 343  * this is needed to prevent changes to t0061.
 344  */
 345 static void fake_fatal(const char *err, va_list params)
 346 {
 347         vreportf("fatal: ", err, params);
 348 }
 349
 350 static void child_error_fn(const char *err, va_list params)
 351 {
 352         const char msg[] = "error() should not be called in child\n";
 353         xwrite(2, msg, sizeof(msg) - 1);
 354 }
 355
 356 static void child_warn_fn(const char *err, va_list params)
 357 {
 358         const char msg[] = "warn() should not be called in child\n";
 359         xwrite(2, msg, sizeof(msg) - 1);
 360 }
 361
 362 static void NORETURN child_die_fn(const char *err, va_list params)
 363 {
 364         const char msg[] = "die() should not be called in child\n";
 365         xwrite(2, msg, sizeof(msg) - 1);
 366         _exit(2);
 367 }
 368
 369 /* this runs in the parent process */
 370 static void child_err_spew(struct child_process *cmd, struct child_err *cerr)
 371 {
 372         static void (*old_errfn)(const char *err, va_list params);
 373
 374         old_errfn = get_error_routine();
 375         set_error_routine(fake_fatal);
 376         errno = cerr->syserr;
 377
 378         switch (cerr->err) {
 379         case CHILD_ERR_CHDIR:
 380                 error_errno("exec '%s': cd to '%s' failed",
 381                             cmd->argv[0], cmd->dir);
 382                 break;
 383         case CHILD_ERR_DUP2:
 384                 error_errno("dup2() in child failed");
 385                 break;
 386         case CHILD_ERR_CLOSE:
 387                 error_errno("close() in child failed");
 388                 break;
 389         case CHILD_ERR_SIGPROCMASK:
 390                 error_errno("sigprocmask failed restoring signals");
 391                 break;
 392         case CHILD_ERR_ENOENT:
 393                 error_errno("cannot run %s", cmd->argv[0]);
 394                 break;
 395         case CHILD_ERR_SILENT:
 396                 break;
 397         case CHILD_ERR_ERRNO:
 398                 error_errno("cannot exec '%s'", cmd->argv[0]);
 399                 break;
 400         }
 401         set_error_routine(old_errfn);
 402 }
 403
 404 static int prepare_cmd(struct strvec *out, const struct child_process *cmd)
 405 {
 406         if (!cmd->argv[0])
 407                 BUG("command is empty");
 408
 409         /*
 410          * Add SHELL_PATH so in the event exec fails with ENOEXEC we can
 411          * attempt to interpret the command with 'sh'.
 412          */
 413         strvec_push(out, SHELL_PATH);
 414
 415         if (cmd->git_cmd) {
 416                 prepare_git_cmd(out, cmd->argv);
 417         } else if (cmd->use_shell) {
 418                 prepare_shell_cmd(out, cmd->argv);
 419         } else {
 420                 strvec_pushv(out, cmd->argv);
 421         }
 422
 423         /*
 424          * If there are no dir separator characters in the command then perform
 425          * a path lookup and use the resolved path as the command to exec. If
 426          * there are dir separator characters, we have exec attempt to invoke
 427          * the command directly.
 428          */
 429         if (!has_dir_sep(out->v[1])) {
 430                 char *program = locate_in_PATH(out->v[1]);
 431                 if (program) {
 432                         free((char *)out->v[1]);
 433                         out->v[1] = program;
 434                 } else {
 435                         strvec_clear(out);
 436                         errno = ENOENT;
 437                         return -1;
 438                 }
 439         }
 440
 441         return 0;
 442 }
 443
 444 static char **prep_childenv(const char *const *deltaenv)
 445 {
 446         extern char **environ;
 447         char **childenv;
 448         struct string_list env = STRING_LIST_INIT_DUP;
 449         struct strbuf key = STRBUF_INIT;
 450         const char *const *p;
 451         int i;
 452
 453         /* Construct a sorted string list consisting of the current environ */
 454         for (p = (const char *const *) environ; p && *p; p++) {
 455                 const char *equals = strchr(*p, '=');
 456
 457                 if (equals) {
 458                         strbuf_reset(&key);
 459                         strbuf_add(&key, *p, equals - *p);
 460                         string_list_append(&env, key.buf)->util = (void *) *p;
 461                 } else {
 462                         string_list_append(&env, *p)->util = (void *) *p;
 463                 }
 464         }
 465         string_list_sort(&env);
 466
 467         /* Merge in 'deltaenv' with the current environ */
 468         for (p = deltaenv; p && *p; p++) {
 469                 const char *equals = strchr(*p, '=');
 470
 471                 if (equals) {
 472                         /* ('key=value'), insert or replace entry */
 473                         strbuf_reset(&key);
 474                         strbuf_add(&key, *p, equals - *p);
 475                         string_list_insert(&env, key.buf)->util = (void *) *p;
 476                 } else {
 477                         /* otherwise ('key') remove existing entry */
 478                         string_list_remove(&env, *p, 0);
 479                 }
 480         }
 481
 482         /* Create an array of 'char *' to be used as the childenv */
 483         ALLOC_ARRAY(childenv, env.nr + 1);
 484         for (i = 0; i < env.nr; i++)
 485                 childenv[i] = env.items[i].util;
 486         childenv[env.nr] = NULL;
 487
 488         string_list_clear(&env, 0);
 489         strbuf_release(&key);
 490         return childenv;
 491 }
 492
 493 struct atfork_state {
 494 #ifndef NO_PTHREADS
 495         int cs;
 496 #endif
 497         sigset_t old;
 498 };
 499
 500 #define CHECK_BUG(err, msg) \
 501         do { \
 502                 int e = (err); \
 503                 if (e) \
 504                         BUG("%s: %s", msg, strerror(e)); \
 505         } while(0)
 506
 507 static void atfork_prepare(struct atfork_state *as)
 508 {
 509         sigset_t all;
 510
 511         if (sigfillset(&all))
 512                 die_errno("sigfillset");
 513 #ifdef NO_PTHREADS
 514         if (sigprocmask(SIG_SETMASK, &all, &as->old))
 515                 die_errno("sigprocmask");
 516 #else
 517         CHECK_BUG(pthread_sigmask(SIG_SETMASK, &all, &as->old),
 518                 "blocking all signals");
 519         CHECK_BUG(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &as->cs),
 520                 "disabling cancellation");
 521 #endif
 522 }
 523
 524 static void atfork_parent(struct atfork_state *as)
 525 {
 526 #ifdef NO_PTHREADS
 527         if (sigprocmask(SIG_SETMASK, &as->old, NULL))
 528                 die_errno("sigprocmask");
 529 #else
 530         CHECK_BUG(pthread_setcancelstate(as->cs, NULL),
 531                 "re-enabling cancellation");
 532         CHECK_BUG(pthread_sigmask(SIG_SETMASK, &as->old, NULL),
 533                 "restoring signal mask");
 534 #endif
 535 }
 536 #endif /* GIT_WINDOWS_NATIVE */
 537
 538 static inline void set_cloexec(int fd)
 539 {
 540         int flags = fcntl(fd, F_GETFD);
 541         if (flags >= 0)
 542                 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
 543 }
 544
 545 static int wait_or_whine(pid_t pid, const char *argv0, int in_signal)
 546 {
 547         int status, code = -1;
 548         pid_t waiting;
 549         int failed_errno = 0;
 550
 551         while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
 552                 ;       /* nothing */
 553         if (in_signal)
 554                 return 0;
 555
 556         if (waiting < 0) {
 557                 failed_errno = errno;
 558                 error_errno("waitpid for %s failed", argv0);
 559         } else if (waiting != pid) {
 560                 error("waitpid is confused (%s)", argv0);
 561         } else if (WIFSIGNALED(status)) {
 562                 code = WTERMSIG(status);
 563                 if (code != SIGINT && code != SIGQUIT && code != SIGPIPE)
 564                         error("%s died of signal %d", argv0, code);
 565                 /*
 566                  * This return value is chosen so that code & 0xff
 567                  * mimics the exit code that a POSIX shell would report for
 568                  * a program that died from this signal.
 569                  */
 570                 code += 128;
 571         } else if (WIFEXITED(status)) {
 572                 code = WEXITSTATUS(status);
 573         } else {
 574                 error("waitpid is confused (%s)", argv0);
 575         }
 576
 577         clear_child_for_cleanup(pid);
 578
 579         errno = failed_errno;
 580         return code;
 581 }
 582
 583 static void trace_add_env(struct strbuf *dst, const char *const *deltaenv)
 584 {
 585         struct string_list envs = STRING_LIST_INIT_DUP;
 586         const char *const *e;
 587         int i;
 588         int printed_unset = 0;
 589
 590         /* Last one wins, see run-command.c:prep_childenv() for context */
 591         for (e = deltaenv; e && *e; e++) {
 592                 struct strbuf key = STRBUF_INIT;
 593                 char *equals = strchr(*e, '=');
 594
 595                 if (equals) {
 596                         strbuf_add(&key, *e, equals - *e);
 597                         string_list_insert(&envs, key.buf)->util = equals + 1;
 598                 } else {
 599                         string_list_insert(&envs, *e)->util = NULL;
 600                 }
 601                 strbuf_release(&key);
 602         }
 603
 604         /* "unset X Y...;" */
 605         for (i = 0; i < envs.nr; i++) {
 606                 const char *var = envs.items[i].string;
 607                 const char *val = envs.items[i].util;
 608
 609                 if (val || !getenv(var))
 610                         continue;
 611
 612                 if (!printed_unset) {
 613                         strbuf_addstr(dst, " unset");
 614                         printed_unset = 1;
 615                 }
 616                 strbuf_addf(dst, " %s", var);
 617         }
 618         if (printed_unset)
 619                 strbuf_addch(dst, ';');
 620
 621         /* ... followed by "A=B C=D ..." */
 622         for (i = 0; i < envs.nr; i++) {
 623                 const char *var = envs.items[i].string;
 624                 const char *val = envs.items[i].util;
 625                 const char *oldval;
 626
 627                 if (!val)
 628                         continue;
 629
 630                 oldval = getenv(var);
 631                 if (oldval && !strcmp(val, oldval))
 632                         continue;
 633
 634                 strbuf_addf(dst, " %s=", var);
 635                 sq_quote_buf_pretty(dst, val);
 636         }
 637         string_list_clear(&envs, 0);
 638 }
 639
 640 static void trace_run_command(const struct child_process *cp)
 641 {
 642         struct strbuf buf = STRBUF_INIT;
 643
 644         if (!trace_want(&trace_default_key))
 645                 return;
 646
 647         strbuf_addstr(&buf, "trace: run_command:");
 648         if (cp->dir) {
 649                 strbuf_addstr(&buf, " cd ");
 650                 sq_quote_buf_pretty(&buf, cp->dir);
 651                 strbuf_addch(&buf, ';');
 652         }
 653         /*
 654          * The caller is responsible for initializing cp->env from
 655          * cp->env_array if needed. We only check one place.
 656          */
 657         if (cp->env)
 658                 trace_add_env(&buf, cp->env);
 659         if (cp->git_cmd)
 660                 strbuf_addstr(&buf, " git");
 661         sq_quote_argv_pretty(&buf, cp->argv);
 662
 663         trace_printf("%s", buf.buf);
 664         strbuf_release(&buf);
 665 }
 666
 667 int start_command(struct child_process *cmd)
 668 {
 669         int need_in, need_out, need_err;
 670         int fdin[2], fdout[2], fderr[2];
 671         int failed_errno;
 672         char *str;
 673
 674         if (!cmd->argv)
 675                 cmd->argv = cmd->args.v;
 676         if (!cmd->env)
 677                 cmd->env = cmd->env_array.v;
 678
 679         /*
 680          * In case of errors we must keep the promise to close FDs
 681          * that have been passed in via ->in and ->out.
 682          */
 683
 684         need_in = !cmd->no_stdin && cmd->in < 0;
 685         if (need_in) {
 686                 if (pipe(fdin) < 0) {
 687                         failed_errno = errno;
 688                         if (cmd->out > 0)
 689                                 close(cmd->out);
 690                         str = "standard input";
 691                         goto fail_pipe;
 692                 }
 693                 cmd->in = fdin[1];
 694         }
 695
 696         need_out = !cmd->no_stdout
 697                 && !cmd->stdout_to_stderr
 698                 && cmd->out < 0;
 699         if (need_out) {
 700                 if (pipe(fdout) < 0) {
 701                         failed_errno = errno;
 702                         if (need_in)
 703                                 close_pair(fdin);
 704                         else if (cmd->in)
 705                                 close(cmd->in);
 706                         str = "standard output";
 707                         goto fail_pipe;
 708                 }
 709                 cmd->out = fdout[0];
 710         }
 711
 712         need_err = !cmd->no_stderr && cmd->err < 0;
 713         if (need_err) {
 714                 if (pipe(fderr) < 0) {
 715                         failed_errno = errno;
 716                         if (need_in)
 717                                 close_pair(fdin);
 718                         else if (cmd->in)
 719                                 close(cmd->in);
 720                         if (need_out)
 721                                 close_pair(fdout);
 722                         else if (cmd->out)
 723                                 close(cmd->out);
 724                         str = "standard error";
 725 fail_pipe:
 726                         error("cannot create %s pipe for %s: %s",
 727                                 str, cmd->argv[0], strerror(failed_errno));
 728                         child_process_clear(cmd);
 729                         errno = failed_errno;
 730                         return -1;
 731                 }
 732                 cmd->err = fderr[0];
 733         }
 734
 735         trace2_child_start(cmd);
 736         trace_run_command(cmd);
 737
 738         fflush(NULL);
 739
 740 #ifndef GIT_WINDOWS_NATIVE
 741 {
 742         int notify_pipe[2];
 743         int null_fd = -1;
 744         char **childenv;
 745         struct strvec argv = STRVEC_INIT;
 746         struct child_err cerr;
 747         struct atfork_state as;
 748
 749         if (prepare_cmd(&argv, cmd) < 0) {
 750                 failed_errno = errno;
 751                 cmd->pid = -1;
 752                 if (!cmd->silent_exec_failure)
 753                         error_errno("cannot run %s", cmd->argv[0]);
 754                 goto end_of_spawn;
 755         }
 756
 757         if (pipe(notify_pipe))
 758                 notify_pipe[0] = notify_pipe[1] = -1;
 759
 760         if (cmd->no_stdin || cmd->no_stdout || cmd->no_stderr) {
 761                 null_fd = open("/dev/null", O_RDWR | O_CLOEXEC);
 762                 if (null_fd < 0)
 763                         die_errno(_("open /dev/null failed"));
 764                 set_cloexec(null_fd);
 765         }
 766
 767         childenv = prep_childenv(cmd->env);
 768         atfork_prepare(&as);
 769
 770         /*
 771          * NOTE: In order to prevent deadlocking when using threads special
 772          * care should be taken with the function calls made in between the
 773          * fork() and exec() calls.  No calls should be made to functions which
 774          * require acquiring a lock (e.g. malloc) as the lock could have been
 775          * held by another thread at the time of forking, causing the lock to
 776          * never be released in the child process.  This means only
 777          * Async-Signal-Safe functions are permitted in the child.
 778          */
 779         cmd->pid = fork();
 780         failed_errno = errno;
 781         if (!cmd->pid) {
 782                 int sig;
 783                 /*
 784                  * Ensure the default die/error/warn routines do not get
 785                  * called, they can take stdio locks and malloc.
 786                  */
 787                 set_die_routine(child_die_fn);
 788                 set_error_routine(child_error_fn);
 789                 set_warn_routine(child_warn_fn);
 790
 791                 close(notify_pipe[0]);
 792                 set_cloexec(notify_pipe[1]);
 793                 child_notifier = notify_pipe[1];
 794
 795                 if (cmd->no_stdin)
 796                         child_dup2(null_fd, 0);
 797                 else if (need_in) {
 798                         child_dup2(fdin[0], 0);
 799                         child_close_pair(fdin);
 800                 } else if (cmd->in) {
 801                         child_dup2(cmd->in, 0);
 802                         child_close(cmd->in);
 803                 }
 804
 805                 if (cmd->no_stderr)
 806                         child_dup2(null_fd, 2);
 807                 else if (need_err) {
 808                         child_dup2(fderr[1], 2);
 809                         child_close_pair(fderr);
 810                 } else if (cmd->err > 1) {
 811                         child_dup2(cmd->err, 2);
 812                         child_close(cmd->err);
 813                 }
 814
 815                 if (cmd->no_stdout)
 816                         child_dup2(null_fd, 1);
 817                 else if (cmd->stdout_to_stderr)
 818                         child_dup2(2, 1);
 819                 else if (need_out) {
 820                         child_dup2(fdout[1], 1);
 821                         child_close_pair(fdout);
 822                 } else if (cmd->out > 1) {
 823                         child_dup2(cmd->out, 1);
 824                         child_close(cmd->out);
 825                 }
 826
 827                 if (cmd->dir && chdir(cmd->dir))
 828                         child_die(CHILD_ERR_CHDIR);
 829
 830                 /*
 831                  * restore default signal handlers here, in case
 832                  * we catch a signal right before execve below
 833                  */
 834                 for (sig = 1; sig < NSIG; sig++) {
 835                         /* ignored signals get reset to SIG_DFL on execve */
 836                         if (signal(sig, SIG_DFL) == SIG_IGN)
 837                                 signal(sig, SIG_IGN);
 838                 }
 839
 840                 if (sigprocmask(SIG_SETMASK, &as.old, NULL) != 0)
 841                         child_die(CHILD_ERR_SIGPROCMASK);
 842
 843                 /*
 844                  * Attempt to exec using the command and arguments starting at
 845                  * argv.argv[1].  argv.argv[0] contains SHELL_PATH which will
 846                  * be used in the event exec failed with ENOEXEC at which point
 847                  * we will try to interpret the command using 'sh'.
 848                  */
 849                 execve(argv.v[1], (char *const *) argv.v + 1,
 850                        (char *const *) childenv);
 851                 if (errno == ENOEXEC)
 852                         execve(argv.v[0], (char *const *) argv.v,
 853                                (char *const *) childenv);
 854
 855                 if (errno == ENOENT) {
 856                         if (cmd->silent_exec_failure)
 857                                 child_die(CHILD_ERR_SILENT);
 858                         child_die(CHILD_ERR_ENOENT);
 859                 } else {
 860                         child_die(CHILD_ERR_ERRNO);
 861                 }
 862         }
 863         atfork_parent(&as);
 864         if (cmd->pid < 0)
 865                 error_errno("cannot fork() for %s", cmd->argv[0]);
 866         else if (cmd->clean_on_exit)
 867                 mark_child_for_cleanup(cmd->pid, cmd);
 868
 869         /*
 870          * Wait for child's exec. If the exec succeeds (or if fork()
 871          * failed), EOF is seen immediately by the parent. Otherwise, the
 872          * child process sends a child_err struct.
 873          * Note that use of this infrastructure is completely advisory,
 874          * therefore, we keep error checks minimal.
 875          */
 876         close(notify_pipe[1]);
 877         if (xread(notify_pipe[0], &cerr, sizeof(cerr)) == sizeof(cerr)) {
 878                 /*
 879                  * At this point we know that fork() succeeded, but exec()
 880                  * failed. Errors have been reported to our stderr.
 881                  */
 882                 wait_or_whine(cmd->pid, cmd->argv[0], 0);
 883                 child_err_spew(cmd, &cerr);
 884                 failed_errno = errno;
 885                 cmd->pid = -1;
 886         }
 887         close(notify_pipe[0]);
 888
 889         if (null_fd >= 0)
 890                 close(null_fd);
 891         strvec_clear(&argv);
 892         free(childenv);
 893 }
 894 end_of_spawn:
 895
 896 #else
 897 {
 898         int fhin = 0, fhout = 1, fherr = 2;
 899         const char **sargv = cmd->argv;
 900         struct strvec nargv = STRVEC_INIT;
 901
 902         if (cmd->no_stdin)
 903                 fhin = open("/dev/null", O_RDWR);
 904         else if (need_in)
 905                 fhin = dup(fdin[0]);
 906         else if (cmd->in)
 907                 fhin = dup(cmd->in);
 908
 909         if (cmd->no_stderr)
 910                 fherr = open("/dev/null", O_RDWR);
 911         else if (need_err)
 912                 fherr = dup(fderr[1]);
 913         else if (cmd->err > 2)
 914                 fherr = dup(cmd->err);
 915
 916         if (cmd->no_stdout)
 917                 fhout = open("/dev/null", O_RDWR);
 918         else if (cmd->stdout_to_stderr)
 919                 fhout = dup(fherr);
 920         else if (need_out)
 921                 fhout = dup(fdout[1]);
 922         else if (cmd->out > 1)
 923                 fhout = dup(cmd->out);
 924
 925         if (cmd->git_cmd)
 926                 cmd->argv = prepare_git_cmd(&nargv, cmd->argv);
 927         else if (cmd->use_shell)
 928                 cmd->argv = prepare_shell_cmd(&nargv, cmd->argv);
 929
 930         cmd->pid = mingw_spawnvpe(cmd->argv[0], cmd->argv, (char**) cmd->env,
 931                         cmd->dir, fhin, fhout, fherr);
 932         failed_errno = errno;
 933         if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
 934                 error_errno("cannot spawn %s", cmd->argv[0]);
 935         if (cmd->clean_on_exit && cmd->pid >= 0)
 936                 mark_child_for_cleanup(cmd->pid, cmd);
 937
 938         strvec_clear(&nargv);
 939         cmd->argv = sargv;
 940         if (fhin != 0)
 941                 close(fhin);
 942         if (fhout != 1)
 943                 close(fhout);
 944         if (fherr != 2)
 945                 close(fherr);
 946 }
 947 #endif
 948
 949         if (cmd->pid < 0) {
 950                 trace2_child_exit(cmd, -1);
 951
 952                 if (need_in)
 953                         close_pair(fdin);
 954                 else if (cmd->in)
 955                         close(cmd->in);
 956                 if (need_out)
 957                         close_pair(fdout);
 958                 else if (cmd->out)
 959                         close(cmd->out);
 960                 if (need_err)
 961                         close_pair(fderr);
 962                 else if (cmd->err)
 963                         close(cmd->err);
 964                 child_process_clear(cmd);
 965                 errno = failed_errno;
 966                 return -1;
 967         }
 968
 969         if (need_in)
 970                 close(fdin[0]);
 971         else if (cmd->in)
 972                 close(cmd->in);
 973
 974         if (need_out)
 975                 close(fdout[1]);
 976         else if (cmd->out)
 977                 close(cmd->out);
 978
 979         if (need_err)
 980                 close(fderr[1]);
 981         else if (cmd->err)
 982                 close(cmd->err);
 983
 984         return 0;
 985 }
 986
 987 int finish_command(struct child_process *cmd)
 988 {
 989         int ret = wait_or_whine(cmd->pid, cmd->argv[0], 0);
 990         trace2_child_exit(cmd, ret);
 991         child_process_clear(cmd);
 992         invalidate_lstat_cache();
 993         return ret;
 994 }
 995
 996 int finish_command_in_signal(struct child_process *cmd)
 997 {
 998         int ret = wait_or_whine(cmd->pid, cmd->argv[0], 1);
 999         trace2_child_exit(cmd, ret);
1000         return ret;
1001 }
1002
1003
1004 int run_command(struct child_process *cmd)
1005 {
1006         int code;
1007
1008         if (cmd->out < 0 || cmd->err < 0)
1009                 BUG("run_command with a pipe can cause deadlock");
1010
1011         code = start_command(cmd);
1012         if (code)
1013                 return code;
1014         return finish_command(cmd);
1015 }
1016
1017 int run_command_v_opt(const char **argv, int opt)
1018 {
1019         return run_command_v_opt_cd_env(argv, opt, NULL, NULL);
1020 }
1021
1022 int run_command_v_opt_tr2(const char **argv, int opt, const char *tr2_class)
1023 {
1024         return run_command_v_opt_cd_env_tr2(argv, opt, NULL, NULL, tr2_class);
1025 }
1026
1027 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
1028 {
1029         return run_command_v_opt_cd_env_tr2(argv, opt, dir, env, NULL);
1030 }
1031
1032 int run_command_v_opt_cd_env_tr2(const char **argv, int opt, const char *dir,
1033                                  const char *const *env, const char *tr2_class)
1034 {
1035         struct child_process cmd = CHILD_PROCESS_INIT;
1036         cmd.argv = argv;
1037         cmd.no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
1038         cmd.git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
1039         cmd.stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
1040         cmd.silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
1041         cmd.use_shell = opt & RUN_USING_SHELL ? 1 : 0;
1042         cmd.clean_on_exit = opt & RUN_CLEAN_ON_EXIT ? 1 : 0;
1043         cmd.wait_after_clean = opt & RUN_WAIT_AFTER_CLEAN ? 1 : 0;
1044         cmd.dir = dir;
1045         cmd.env = env;
1046         cmd.trace2_child_class = tr2_class;
1047         return run_command(&cmd);
1048 }
1049
1050 #ifndef NO_PTHREADS
1051 static pthread_t main_thread;
1052 static int main_thread_set;
1053 static pthread_key_t async_key;
1054 static pthread_key_t async_die_counter;
1055
1056 static void *run_thread(void *data)
1057 {
1058         struct async *async = data;
1059         intptr_t ret;
1060
1061         if (async->isolate_sigpipe) {
1062                 sigset_t mask;
1063                 sigemptyset(&mask);
1064                 sigaddset(&mask, SIGPIPE);
1065                 if (pthread_sigmask(SIG_BLOCK, &mask, NULL) < 0) {
1066                         ret = error("unable to block SIGPIPE in async thread");
1067                         return (void *)ret;
1068                 }
1069         }
1070
1071         pthread_setspecific(async_key, async);
1072         ret = async->proc(async->proc_in, async->proc_out, async->data);
1073         return (void *)ret;
1074 }
1075
1076 static NORETURN void die_async(const char *err, va_list params)
1077 {
1078         vreportf("fatal: ", err, params);
1079
1080         if (in_async()) {
1081                 struct async *async = pthread_getspecific(async_key);
1082                 if (async->proc_in >= 0)
1083                         close(async->proc_in);
1084                 if (async->proc_out >= 0)
1085                         close(async->proc_out);
1086                 pthread_exit((void *)128);
1087         }
1088
1089         exit(128);
1090 }
1091
1092 static int async_die_is_recursing(void)
1093 {
1094         void *ret = pthread_getspecific(async_die_counter);
1095         pthread_setspecific(async_die_counter, (void *)1);
1096         return ret != NULL;
1097 }
1098
1099 int in_async(void)
1100 {
1101         if (!main_thread_set)
1102                 return 0; /* no asyncs started yet */
1103         return !pthread_equal(main_thread, pthread_self());
1104 }
1105
1106 static void NORETURN async_exit(int code)
1107 {
1108         pthread_exit((void *)(intptr_t)code);
1109 }
1110
1111 #else
1112
1113 static struct {
1114         void (**handlers)(void);
1115         size_t nr;
1116         size_t alloc;
1117 } git_atexit_hdlrs;
1118
1119 static int git_atexit_installed;
1120
1121 static void git_atexit_dispatch(void)
1122 {
1123         size_t i;
1124
1125         for (i=git_atexit_hdlrs.nr ; i ; i--)
1126                 git_atexit_hdlrs.handlers[i-1]();
1127 }
1128
1129 static void git_atexit_clear(void)
1130 {
1131         free(git_atexit_hdlrs.handlers);
1132         memset(&git_atexit_hdlrs, 0, sizeof(git_atexit_hdlrs));
1133         git_atexit_installed = 0;
1134 }
1135
1136 #undef atexit
1137 int git_atexit(void (*handler)(void))
1138 {
1139         ALLOC_GROW(git_atexit_hdlrs.handlers, git_atexit_hdlrs.nr + 1, git_atexit_hdlrs.alloc);
1140         git_atexit_hdlrs.handlers[git_atexit_hdlrs.nr++] = handler;
1141         if (!git_atexit_installed) {
1142                 if (atexit(&git_atexit_dispatch))
1143                         return -1;
1144                 git_atexit_installed = 1;
1145         }
1146         return 0;
1147 }
1148 #define atexit git_atexit
1149
1150 static int process_is_async;
1151 int in_async(void)
1152 {
1153         return process_is_async;
1154 }
1155
1156 static void NORETURN async_exit(int code)
1157 {
1158         exit(code);
1159 }
1160
1161 #endif
1162
1163 void check_pipe(int err)
1164 {
1165         if (err == EPIPE) {
1166                 if (in_async())
1167                         async_exit(141);
1168
1169                 signal(SIGPIPE, SIG_DFL);
1170                 raise(SIGPIPE);
1171                 /* Should never happen, but just in case... */
1172                 exit(141);
1173         }
1174 }
1175
1176 int start_async(struct async *async)
1177 {
1178         int need_in, need_out;
1179         int fdin[2], fdout[2];
1180         int proc_in, proc_out;
1181
1182         need_in = async->in < 0;
1183         if (need_in) {
1184                 if (pipe(fdin) < 0) {
1185                         if (async->out > 0)
1186                                 close(async->out);
1187                         return error_errno("cannot create pipe");
1188                 }
1189                 async->in = fdin[1];
1190         }
1191
1192         need_out = async->out < 0;
1193         if (need_out) {
1194                 if (pipe(fdout) < 0) {
1195                         if (need_in)
1196                                 close_pair(fdin);
1197                         else if (async->in)
1198                                 close(async->in);
1199                         return error_errno("cannot create pipe");
1200                 }
1201                 async->out = fdout[0];
1202         }
1203
1204         if (need_in)
1205                 proc_in = fdin[0];
1206         else if (async->in)
1207                 proc_in = async->in;
1208         else
1209                 proc_in = -1;
1210
1211         if (need_out)
1212                 proc_out = fdout[1];
1213         else if (async->out)
1214                 proc_out = async->out;
1215         else
1216                 proc_out = -1;
1217
1218 #ifdef NO_PTHREADS
1219         /* Flush stdio before fork() to avoid cloning buffers */
1220         fflush(NULL);
1221
1222         async->pid = fork();
1223         if (async->pid < 0) {
1224                 error_errno("fork (async) failed");
1225                 goto error;
1226         }
1227         if (!async->pid) {
1228                 if (need_in)
1229                         close(fdin[1]);
1230                 if (need_out)
1231                         close(fdout[0]);
1232                 git_atexit_clear();
1233                 process_is_async = 1;
1234                 exit(!!async->proc(proc_in, proc_out, async->data));
1235         }
1236
1237         mark_child_for_cleanup(async->pid, NULL);
1238
1239         if (need_in)
1240                 close(fdin[0]);
1241         else if (async->in)
1242                 close(async->in);
1243
1244         if (need_out)
1245                 close(fdout[1]);
1246         else if (async->out)
1247                 close(async->out);
1248 #else
1249         if (!main_thread_set) {
1250                 /*
1251                  * We assume that the first time that start_async is called
1252                  * it is from the main thread.
1253                  */
1254                 main_thread_set = 1;
1255                 main_thread = pthread_self();
1256                 pthread_key_create(&async_key, NULL);
1257                 pthread_key_create(&async_die_counter, NULL);
1258                 set_die_routine(die_async);
1259                 set_die_is_recursing_routine(async_die_is_recursing);
1260         }
1261
1262         if (proc_in >= 0)
1263                 set_cloexec(proc_in);
1264         if (proc_out >= 0)
1265                 set_cloexec(proc_out);
1266         async->proc_in = proc_in;
1267         async->proc_out = proc_out;
1268         {
1269                 int err = pthread_create(&async->tid, NULL, run_thread, async);
1270                 if (err) {
1271                         error(_("cannot create async thread: %s"), strerror(err));
1272                         goto error;
1273                 }
1274         }
1275 #endif
1276         return 0;
1277
1278 error:
1279         if (need_in)
1280                 close_pair(fdin);
1281         else if (async->in)
1282                 close(async->in);
1283
1284         if (need_out)
1285                 close_pair(fdout);
1286         else if (async->out)
1287                 close(async->out);
1288         return -1;
1289 }
1290
1291 int finish_async(struct async *async)
1292 {
1293 #ifdef NO_PTHREADS
1294         int ret = wait_or_whine(async->pid, "child process", 0);
1295
1296         invalidate_lstat_cache();
1297
1298         return ret;
1299 #else
1300         void *ret = (void *)(intptr_t)(-1);
1301
1302         if (pthread_join(async->tid, &ret))
1303                 error("pthread_join failed");
1304         invalidate_lstat_cache();
1305         return (int)(intptr_t)ret;
1306
1307 #endif
1308 }
1309
1310 int async_with_fork(void)
1311 {
1312 #ifdef NO_PTHREADS
1313         return 1;
1314 #else
1315         return 0;
1316 #endif
1317 }
1318
1319 const char *find_hook(const char *name)
1320 {
1321         static struct strbuf path = STRBUF_INIT;
1322
1323         strbuf_reset(&path);
1324         strbuf_git_path(&path, "hooks/%s", name);
1325         if (access(path.buf, X_OK) < 0) {
1326                 int err = errno;
1327
1328 #ifdef STRIP_EXTENSION
1329                 strbuf_addstr(&path, STRIP_EXTENSION);
1330                 if (access(path.buf, X_OK) >= 0)
1331                         return path.buf;
1332                 if (errno == EACCES)
1333                         err = errno;
1334 #endif
1335
1336                 if (err == EACCES && advice_ignored_hook) {
1337                         static struct string_list advise_given = STRING_LIST_INIT_DUP;
1338
1339                         if (!string_list_lookup(&advise_given, name)) {
1340                                 string_list_insert(&advise_given, name);
1341                                 advise(_("The '%s' hook was ignored because "
1342                                          "it's not set as executable.\n"
1343                                          "You can disable this warning with "
1344                                          "`git config advice.ignoredHook false`."),
1345                                        path.buf);
1346                         }
1347                 }
1348                 return NULL;
1349         }
1350         return path.buf;
1351 }
1352
1353 int run_hook_ve(const char *const *env, const char *name, va_list args)
1354 {
1355         struct child_process hook = CHILD_PROCESS_INIT;
1356         const char *p;
1357
1358         p = find_hook(name);
1359         if (!p)
1360                 return 0;
1361
1362         strvec_push(&hook.args, p);
1363         while ((p = va_arg(args, const char *)))
1364                 strvec_push(&hook.args, p);
1365         hook.env = env;
1366         hook.no_stdin = 1;
1367         hook.stdout_to_stderr = 1;
1368         hook.trace2_hook_name = name;
1369
1370         return run_command(&hook);
1371 }
1372
1373 int run_hook_le(const char *const *env, const char *name, ...)
1374 {
1375         va_list args;
1376         int ret;
1377
1378         va_start(args, name);
1379         ret = run_hook_ve(env, name, args);
1380         va_end(args);
1381
1382         return ret;
1383 }
1384
1385 struct io_pump {
1386         /* initialized by caller */
1387         int fd;
1388         int type; /* POLLOUT or POLLIN */
1389         union {
1390                 struct {
1391                         const char *buf;
1392                         size_t len;
1393                 } out;
1394                 struct {
1395                         struct strbuf *buf;
1396                         size_t hint;
1397                 } in;
1398         } u;
1399
1400         /* returned by pump_io */
1401         int error; /* 0 for success, otherwise errno */
1402
1403         /* internal use */
1404         struct pollfd *pfd;
1405 };
1406
1407 static int pump_io_round(struct io_pump *slots, int nr, struct pollfd *pfd)
1408 {
1409         int pollsize = 0;
1410         int i;
1411
1412         for (i = 0; i < nr; i++) {
1413                 struct io_pump *io = &slots[i];
1414                 if (io->fd < 0)
1415                         continue;
1416                 pfd[pollsize].fd = io->fd;
1417                 pfd[pollsize].events = io->type;
1418                 io->pfd = &pfd[pollsize++];
1419         }
1420
1421         if (!pollsize)
1422                 return 0;
1423
1424         if (poll(pfd, pollsize, -1) < 0) {
1425                 if (errno == EINTR)
1426                         return 1;
1427                 die_errno("poll failed");
1428         }
1429
1430         for (i = 0; i < nr; i++) {
1431                 struct io_pump *io = &slots[i];
1432
1433                 if (io->fd < 0)
1434                         continue;
1435
1436                 if (!(io->pfd->revents & (POLLOUT|POLLIN|POLLHUP|POLLERR|POLLNVAL)))
1437                         continue;
1438
1439                 if (io->type == POLLOUT) {
1440                         ssize_t len = xwrite(io->fd,
1441                                              io->u.out.buf, io->u.out.len);
1442                         if (len < 0) {
1443                                 io->error = errno;
1444                                 close(io->fd);
1445                                 io->fd = -1;
1446                         } else {
1447                                 io->u.out.buf += len;
1448                                 io->u.out.len -= len;
1449                                 if (!io->u.out.len) {
1450                                         close(io->fd);
1451                                         io->fd = -1;
1452                                 }
1453                         }
1454                 }
1455
1456                 if (io->type == POLLIN) {
1457                         ssize_t len = strbuf_read_once(io->u.in.buf,
1458                                                        io->fd, io->u.in.hint);
1459                         if (len < 0)
1460                                 io->error = errno;
1461                         if (len <= 0) {
1462                                 close(io->fd);
1463                                 io->fd = -1;
1464                         }
1465                 }
1466         }
1467
1468         return 1;
1469 }
1470
1471 static int pump_io(struct io_pump *slots, int nr)
1472 {
1473         struct pollfd *pfd;
1474         int i;
1475
1476         for (i = 0; i < nr; i++)
1477                 slots[i].error = 0;
1478
1479         ALLOC_ARRAY(pfd, nr);
1480         while (pump_io_round(slots, nr, pfd))
1481                 ; /* nothing */
1482         free(pfd);
1483
1484         /* There may be multiple errno values, so just pick the first. */
1485         for (i = 0; i < nr; i++) {
1486                 if (slots[i].error) {
1487                         errno = slots[i].error;
1488                         return -1;
1489                 }
1490         }
1491         return 0;
1492 }
1493
1494
1495 int pipe_command(struct child_process *cmd,
1496                  const char *in, size_t in_len,
1497                  struct strbuf *out, size_t out_hint,
1498                  struct strbuf *err, size_t err_hint)
1499 {
1500         struct io_pump io[3];
1501         int nr = 0;
1502
1503         if (in)
1504                 cmd->in = -1;
1505         if (out)
1506                 cmd->out = -1;
1507         if (err)
1508                 cmd->err = -1;
1509
1510         if (start_command(cmd) < 0)
1511                 return -1;
1512
1513         if (in) {
1514                 io[nr].fd = cmd->in;
1515                 io[nr].type = POLLOUT;
1516                 io[nr].u.out.buf = in;
1517                 io[nr].u.out.len = in_len;
1518                 nr++;
1519         }
1520         if (out) {
1521                 io[nr].fd = cmd->out;
1522                 io[nr].type = POLLIN;
1523                 io[nr].u.in.buf = out;
1524                 io[nr].u.in.hint = out_hint;
1525                 nr++;
1526         }
1527         if (err) {
1528                 io[nr].fd = cmd->err;
1529                 io[nr].type = POLLIN;
1530                 io[nr].u.in.buf = err;
1531                 io[nr].u.in.hint = err_hint;
1532                 nr++;
1533         }
1534
1535         if (pump_io(io, nr) < 0) {
1536                 finish_command(cmd); /* throw away exit code */
1537                 return -1;
1538         }
1539
1540         return finish_command(cmd);
1541 }
1542
1543 enum child_state {
1544         GIT_CP_FREE,
1545         GIT_CP_WORKING,
1546         GIT_CP_WAIT_CLEANUP,
1547 };
1548
1549 struct parallel_processes {
1550         void *data;
1551
1552         int max_processes;
1553         int nr_processes;
1554
1555         get_next_task_fn get_next_task;
1556         start_failure_fn start_failure;
1557         task_finished_fn task_finished;
1558
1559         struct {
1560                 enum child_state state;
1561                 struct child_process process;
1562                 struct strbuf err;
1563                 void *data;
1564         } *children;
1565         /*
1566          * The struct pollfd is logically part of *children,
1567          * but the system call expects it as its own array.
1568          */
1569         struct pollfd *pfd;
1570
1571         unsigned shutdown : 1;
1572
1573         int output_owner;
1574         struct strbuf buffered_output; /* of finished children */
1575 };
1576
1577 static int default_start_failure(struct strbuf *out,
1578                                  void *pp_cb,
1579                                  void *pp_task_cb)
1580 {
1581         return 0;
1582 }
1583
1584 static int default_task_finished(int result,
1585                                  struct strbuf *out,
1586                                  void *pp_cb,
1587                                  void *pp_task_cb)
1588 {
1589         return 0;
1590 }
1591
1592 static void kill_children(struct parallel_processes *pp, int signo)
1593 {
1594         int i, n = pp->max_processes;
1595
1596         for (i = 0; i < n; i++)
1597                 if (pp->children[i].state == GIT_CP_WORKING)
1598                         kill(pp->children[i].process.pid, signo);
1599 }
1600
1601 static struct parallel_processes *pp_for_signal;
1602
1603 static void handle_children_on_signal(int signo)
1604 {
1605         kill_children(pp_for_signal, signo);
1606         sigchain_pop(signo);
1607         raise(signo);
1608 }
1609
1610 static void pp_init(struct parallel_processes *pp,
1611                     int n,
1612                     get_next_task_fn get_next_task,
1613                     start_failure_fn start_failure,
1614                     task_finished_fn task_finished,
1615                     void *data)
1616 {
1617         int i;
1618
1619         if (n < 1)
1620                 n = online_cpus();
1621
1622         pp->max_processes = n;
1623
1624         trace_printf("run_processes_parallel: preparing to run up to %d tasks", n);
1625
1626         pp->data = data;
1627         if (!get_next_task)
1628                 BUG("you need to specify a get_next_task function");
1629         pp->get_next_task = get_next_task;
1630
1631         pp->start_failure = start_failure ? start_failure : default_start_failure;
1632         pp->task_finished = task_finished ? task_finished : default_task_finished;
1633
1634         pp->nr_processes = 0;
1635         pp->output_owner = 0;
1636         pp->shutdown = 0;
1637         pp->children = xcalloc(n, sizeof(*pp->children));
1638         pp->pfd = xcalloc(n, sizeof(*pp->pfd));
1639         strbuf_init(&pp->buffered_output, 0);
1640
1641         for (i = 0; i < n; i++) {
1642                 strbuf_init(&pp->children[i].err, 0);
1643                 child_process_init(&pp->children[i].process);
1644                 pp->pfd[i].events = POLLIN | POLLHUP;
1645                 pp->pfd[i].fd = -1;
1646         }
1647
1648         pp_for_signal = pp;
1649         sigchain_push_common(handle_children_on_signal);
1650 }
1651
1652 static void pp_cleanup(struct parallel_processes *pp)
1653 {
1654         int i;
1655
1656         trace_printf("run_processes_parallel: done");
1657         for (i = 0; i < pp->max_processes; i++) {
1658                 strbuf_release(&pp->children[i].err);
1659                 child_process_clear(&pp->children[i].process);
1660         }
1661
1662         free(pp->children);
1663         free(pp->pfd);
1664
1665         /*
1666          * When get_next_task added messages to the buffer in its last
1667          * iteration, the buffered output is non empty.
1668          */
1669         strbuf_write(&pp->buffered_output, stderr);
1670         strbuf_release(&pp->buffered_output);
1671
1672         sigchain_pop_common();
1673 }
1674
1675 /* returns
1676  *  0 if a new task was started.
1677  *  1 if no new jobs was started (get_next_task ran out of work, non critical
1678  *    problem with starting a new command)
1679  * <0 no new job was started, user wishes to shutdown early. Use negative code
1680  *    to signal the children.
1681  */
1682 static int pp_start_one(struct parallel_processes *pp)
1683 {
1684         int i, code;
1685
1686         for (i = 0; i < pp->max_processes; i++)
1687                 if (pp->children[i].state == GIT_CP_FREE)
1688                         break;
1689         if (i == pp->max_processes)
1690                 BUG("bookkeeping is hard");
1691
1692         code = pp->get_next_task(&pp->children[i].process,
1693                                  &pp->children[i].err,
1694                                  pp->data,
1695                                  &pp->children[i].data);
1696         if (!code) {
1697                 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1698                 strbuf_reset(&pp->children[i].err);
1699                 return 1;
1700         }
1701         pp->children[i].process.err = -1;
1702         pp->children[i].process.stdout_to_stderr = 1;
1703         pp->children[i].process.no_stdin = 1;
1704
1705         if (start_command(&pp->children[i].process)) {
1706                 code = pp->start_failure(&pp->children[i].err,
1707                                          pp->data,
1708                                          pp->children[i].data);
1709                 strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1710                 strbuf_reset(&pp->children[i].err);
1711                 if (code)
1712                         pp->shutdown = 1;
1713                 return code;
1714         }
1715
1716         pp->nr_processes++;
1717         pp->children[i].state = GIT_CP_WORKING;
1718         pp->pfd[i].fd = pp->children[i].process.err;
1719         return 0;
1720 }
1721
1722 static void pp_buffer_stderr(struct parallel_processes *pp, int output_timeout)
1723 {
1724         int i;
1725
1726         while ((i = poll(pp->pfd, pp->max_processes, output_timeout)) < 0) {
1727                 if (errno == EINTR)
1728                         continue;
1729                 pp_cleanup(pp);
1730                 die_errno("poll");
1731         }
1732
1733         /* Buffer output from all pipes. */
1734         for (i = 0; i < pp->max_processes; i++) {
1735                 if (pp->children[i].state == GIT_CP_WORKING &&
1736                     pp->pfd[i].revents & (POLLIN | POLLHUP)) {
1737                         int n = strbuf_read_once(&pp->children[i].err,
1738                                                  pp->children[i].process.err, 0);
1739                         if (n == 0) {
1740                                 close(pp->children[i].process.err);
1741                                 pp->children[i].state = GIT_CP_WAIT_CLEANUP;
1742                         } else if (n < 0)
1743                                 if (errno != EAGAIN)
1744                                         die_errno("read");
1745                 }
1746         }
1747 }
1748
1749 static void pp_output(struct parallel_processes *pp)
1750 {
1751         int i = pp->output_owner;
1752         if (pp->children[i].state == GIT_CP_WORKING &&
1753             pp->children[i].err.len) {
1754                 strbuf_write(&pp->children[i].err, stderr);
1755                 strbuf_reset(&pp->children[i].err);
1756         }
1757 }
1758
1759 static int pp_collect_finished(struct parallel_processes *pp)
1760 {
1761         int i, code;
1762         int n = pp->max_processes;
1763         int result = 0;
1764
1765         while (pp->nr_processes > 0) {
1766                 for (i = 0; i < pp->max_processes; i++)
1767                         if (pp->children[i].state == GIT_CP_WAIT_CLEANUP)
1768                                 break;
1769                 if (i == pp->max_processes)
1770                         break;
1771
1772                 code = finish_command(&pp->children[i].process);
1773
1774                 code = pp->task_finished(code,
1775                                          &pp->children[i].err, pp->data,
1776                                          pp->children[i].data);
1777
1778                 if (code)
1779                         result = code;
1780                 if (code < 0)
1781                         break;
1782
1783                 pp->nr_processes--;
1784                 pp->children[i].state = GIT_CP_FREE;
1785                 pp->pfd[i].fd = -1;
1786                 child_process_init(&pp->children[i].process);
1787
1788                 if (i != pp->output_owner) {
1789                         strbuf_addbuf(&pp->buffered_output, &pp->children[i].err);
1790                         strbuf_reset(&pp->children[i].err);
1791                 } else {
1792                         strbuf_write(&pp->children[i].err, stderr);
1793                         strbuf_reset(&pp->children[i].err);
1794
1795                         /* Output all other finished child processes */
1796                         strbuf_write(&pp->buffered_output, stderr);
1797                         strbuf_reset(&pp->buffered_output);
1798
1799                         /*
1800                          * Pick next process to output live.
1801                          * NEEDSWORK:
1802                          * For now we pick it randomly by doing a round
1803                          * robin. Later we may want to pick the one with
1804                          * the most output or the longest or shortest
1805                          * running process time.
1806                          */
1807                         for (i = 0; i < n; i++)
1808                                 if (pp->children[(pp->output_owner + i) % n].state == GIT_CP_WORKING)
1809                                         break;
1810                         pp->output_owner = (pp->output_owner + i) % n;
1811                 }
1812         }
1813         return result;
1814 }
1815
1816 int run_processes_parallel(int n,
1817                            get_next_task_fn get_next_task,
1818                            start_failure_fn start_failure,
1819                            task_finished_fn task_finished,
1820                            void *pp_cb)
1821 {
1822         int i, code;
1823         int output_timeout = 100;
1824         int spawn_cap = 4;
1825         struct parallel_processes pp;
1826
1827         pp_init(&pp, n, get_next_task, start_failure, task_finished, pp_cb);
1828         while (1) {
1829                 for (i = 0;
1830                     i < spawn_cap && !pp.shutdown &&
1831                     pp.nr_processes < pp.max_processes;
1832                     i++) {
1833                         code = pp_start_one(&pp);
1834                         if (!code)
1835                                 continue;
1836                         if (code < 0) {
1837                                 pp.shutdown = 1;
1838                                 kill_children(&pp, -code);
1839                         }
1840                         break;
1841                 }
1842                 if (!pp.nr_processes)
1843                         break;
1844                 pp_buffer_stderr(&pp, output_timeout);
1845                 pp_output(&pp);
1846                 code = pp_collect_finished(&pp);
1847                 if (code) {
1848                         pp.shutdown = 1;
1849                         if (code < 0)
1850                                 kill_children(&pp, -code);
1851                 }
1852         }
1853
1854         pp_cleanup(&pp);
1855         return 0;
1856 }
1857
1858 int run_processes_parallel_tr2(int n, get_next_task_fn get_next_task,
1859                                start_failure_fn start_failure,
1860                                task_finished_fn task_finished, void *pp_cb,
1861                                const char *tr2_category, const char *tr2_label)
1862 {
1863         int result;
1864
1865         trace2_region_enter_printf(tr2_category, tr2_label, NULL, "max:%d",
1866                                    ((n < 1) ? online_cpus() : n));
1867
1868         result = run_processes_parallel(n, get_next_task, start_failure,
1869                                         task_finished, pp_cb);
1870
1871         trace2_region_leave(tr2_category, tr2_label, NULL);
1872
1873         return result;
1874 }
1875
1876 int run_auto_maintenance(int quiet)
1877 {
1878         struct child_process maint = CHILD_PROCESS_INIT;
1879
1880         maint.git_cmd = 1;
1881         strvec_pushl(&maint.args, "maintenance", "run", "--auto", NULL);
1882         strvec_push(&maint.args, quiet ? "--quiet" : "--no-quiet");
1883
1884         return run_command(&maint);
1885 }