run-command.c

   1 #include "cache.h"
   2 #include "run-command.h"
   3 #include "exec_cmd.h"
   4
   5 static inline void close_pair(int fd[2])
   6 {
   7         close(fd[0]);
   8         close(fd[1]);
   9 }
  10
  11 static inline void dup_devnull(int to)
  12 {
  13         int fd = open("/dev/null", O_RDWR);
  14         dup2(fd, to);
  15         close(fd);
  16 }
  17
  18 int start_command(struct child_process *cmd)
  19 {
  20         int need_in, need_out, need_err;
  21         int fdin[2], fdout[2], fderr[2];
  22         int failed_errno = failed_errno;
  23
  24         /*
  25          * In case of errors we must keep the promise to close FDs
  26          * that have been passed in via ->in and ->out.
  27          */
  28
  29         need_in = !cmd->no_stdin && cmd->in < 0;
  30         if (need_in) {
  31                 if (pipe(fdin) < 0) {
  32                         failed_errno = errno;
  33                         if (cmd->out > 0)
  34                                 close(cmd->out);
  35                         goto fail_pipe;
  36                 }
  37                 cmd->in = fdin[1];
  38         }
  39
  40         need_out = !cmd->no_stdout
  41                 && !cmd->stdout_to_stderr
  42                 && cmd->out < 0;
  43         if (need_out) {
  44                 if (pipe(fdout) < 0) {
  45                         failed_errno = errno;
  46                         if (need_in)
  47                                 close_pair(fdin);
  48                         else if (cmd->in)
  49                                 close(cmd->in);
  50                         goto fail_pipe;
  51                 }
  52                 cmd->out = fdout[0];
  53         }
  54
  55         need_err = !cmd->no_stderr && cmd->err < 0;
  56         if (need_err) {
  57                 if (pipe(fderr) < 0) {
  58                         failed_errno = errno;
  59                         if (need_in)
  60                                 close_pair(fdin);
  61                         else if (cmd->in)
  62                                 close(cmd->in);
  63                         if (need_out)
  64                                 close_pair(fdout);
  65                         else if (cmd->out)
  66                                 close(cmd->out);
  67 fail_pipe:
  68                         error("cannot create pipe for %s: %s",
  69                                 cmd->argv[0], strerror(failed_errno));
  70                         errno = failed_errno;
  71                         return -1;
  72                 }
  73                 cmd->err = fderr[0];
  74         }
  75
  76         trace_argv_printf(cmd->argv, "trace: run_command:");
  77
  78 #ifndef __MINGW32__
  79         fflush(NULL);
  80         cmd->pid = fork();
  81         if (!cmd->pid) {
  82                 if (cmd->no_stdin)
  83                         dup_devnull(0);
  84                 else if (need_in) {
  85                         dup2(fdin[0], 0);
  86                         close_pair(fdin);
  87                 } else if (cmd->in) {
  88                         dup2(cmd->in, 0);
  89                         close(cmd->in);
  90                 }
  91
  92                 if (cmd->no_stderr)
  93                         dup_devnull(2);
  94                 else if (need_err) {
  95                         dup2(fderr[1], 2);
  96                         close_pair(fderr);
  97                 }
  98
  99                 if (cmd->no_stdout)
 100                         dup_devnull(1);
 101                 else if (cmd->stdout_to_stderr)
 102                         dup2(2, 1);
 103                 else if (need_out) {
 104                         dup2(fdout[1], 1);
 105                         close_pair(fdout);
 106                 } else if (cmd->out > 1) {
 107                         dup2(cmd->out, 1);
 108                         close(cmd->out);
 109                 }
 110
 111                 if (cmd->dir && chdir(cmd->dir))
 112                         die_errno("exec '%s': cd to '%s' failed", cmd->argv[0],
 113                             cmd->dir);
 114                 if (cmd->env) {
 115                         for (; *cmd->env; cmd->env++) {
 116                                 if (strchr(*cmd->env, '='))
 117                                         putenv((char *)*cmd->env);
 118                                 else
 119                                         unsetenv(*cmd->env);
 120                         }
 121                 }
 122                 if (cmd->preexec_cb)
 123                         cmd->preexec_cb();
 124                 if (cmd->git_cmd) {
 125                         execv_git_cmd(cmd->argv);
 126                 } else {
 127                         execvp(cmd->argv[0], (char *const*) cmd->argv);
 128                 }
 129                 trace_printf("trace: exec '%s' failed: %s\n", cmd->argv[0],
 130                                 strerror(errno));
 131                 exit(127);
 132         }
 133         if (cmd->pid < 0)
 134                 error("cannot fork() for %s: %s", cmd->argv[0],
 135                         strerror(failed_errno = errno));
 136 #else
 137         int s0 = -1, s1 = -1, s2 = -1;  /* backups of stdin, stdout, stderr */
 138         const char **sargv = cmd->argv;
 139         char **env = environ;
 140
 141         if (cmd->no_stdin) {
 142                 s0 = dup(0);
 143                 dup_devnull(0);
 144         } else if (need_in) {
 145                 s0 = dup(0);
 146                 dup2(fdin[0], 0);
 147         } else if (cmd->in) {
 148                 s0 = dup(0);
 149                 dup2(cmd->in, 0);
 150         }
 151
 152         if (cmd->no_stderr) {
 153                 s2 = dup(2);
 154                 dup_devnull(2);
 155         } else if (need_err) {
 156                 s2 = dup(2);
 157                 dup2(fderr[1], 2);
 158         }
 159
 160         if (cmd->no_stdout) {
 161                 s1 = dup(1);
 162                 dup_devnull(1);
 163         } else if (cmd->stdout_to_stderr) {
 164                 s1 = dup(1);
 165                 dup2(2, 1);
 166         } else if (need_out) {
 167                 s1 = dup(1);
 168                 dup2(fdout[1], 1);
 169         } else if (cmd->out > 1) {
 170                 s1 = dup(1);
 171                 dup2(cmd->out, 1);
 172         }
 173
 174         if (cmd->dir)
 175                 die("chdir in start_command() not implemented");
 176         if (cmd->env) {
 177                 env = copy_environ();
 178                 for (; *cmd->env; cmd->env++)
 179                         env = env_setenv(env, *cmd->env);
 180         }
 181
 182         if (cmd->git_cmd) {
 183                 cmd->argv = prepare_git_cmd(cmd->argv);
 184         }
 185
 186         cmd->pid = mingw_spawnvpe(cmd->argv[0], cmd->argv, env);
 187         failed_errno = errno;
 188         if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT))
 189                 error("cannot spawn %s: %s", cmd->argv[0], strerror(errno));
 190
 191         if (cmd->env)
 192                 free_environ(env);
 193         if (cmd->git_cmd)
 194                 free(cmd->argv);
 195
 196         cmd->argv = sargv;
 197         if (s0 >= 0)
 198                 dup2(s0, 0), close(s0);
 199         if (s1 >= 0)
 200                 dup2(s1, 1), close(s1);
 201         if (s2 >= 0)
 202                 dup2(s2, 2), close(s2);
 203 #endif
 204
 205         if (cmd->pid < 0) {
 206                 if (need_in)
 207                         close_pair(fdin);
 208                 else if (cmd->in)
 209                         close(cmd->in);
 210                 if (need_out)
 211                         close_pair(fdout);
 212                 else if (cmd->out)
 213                         close(cmd->out);
 214                 if (need_err)
 215                         close_pair(fderr);
 216                 errno = failed_errno;
 217                 return -1;
 218         }
 219
 220         if (need_in)
 221                 close(fdin[0]);
 222         else if (cmd->in)
 223                 close(cmd->in);
 224
 225         if (need_out)
 226                 close(fdout[1]);
 227         else if (cmd->out)
 228                 close(cmd->out);
 229
 230         if (need_err)
 231                 close(fderr[1]);
 232
 233         return 0;
 234 }
 235
 236 static int wait_or_whine(pid_t pid, const char *argv0, int silent_exec_failure)
 237 {
 238         int status, code = -1;
 239         pid_t waiting;
 240         int failed_errno = 0;
 241
 242         while ((waiting = waitpid(pid, &status, 0)) < 0 && errno == EINTR)
 243                 ;       /* nothing */
 244
 245         if (waiting < 0) {
 246                 failed_errno = errno;
 247                 error("waitpid for %s failed: %s", argv0, strerror(errno));
 248         } else if (waiting != pid) {
 249                 error("waitpid is confused (%s)", argv0);
 250         } else if (WIFSIGNALED(status)) {
 251                 code = WTERMSIG(status);
 252                 error("%s died of signal %d", argv0, code);
 253                 /*
 254                  * This return value is chosen so that code & 0xff
 255                  * mimics the exit code that a POSIX shell would report for
 256                  * a program that died from this signal.
 257                  */
 258                 code -= 128;
 259         } else if (WIFEXITED(status)) {
 260                 code = WEXITSTATUS(status);
 261                 /*
 262                  * Convert special exit code when execvp failed.
 263                  */
 264                 if (code == 127) {
 265                         code = -1;
 266                         failed_errno = ENOENT;
 267                         if (!silent_exec_failure)
 268                                 error("cannot run %s: %s", argv0,
 269                                         strerror(ENOENT));
 270                 }
 271         } else {
 272                 error("waitpid is confused (%s)", argv0);
 273         }
 274         errno = failed_errno;
 275         return code;
 276 }
 277
 278 int finish_command(struct child_process *cmd)
 279 {
 280         return wait_or_whine(cmd->pid, cmd->argv[0], cmd->silent_exec_failure);
 281 }
 282
 283 int run_command(struct child_process *cmd)
 284 {
 285         int code = start_command(cmd);
 286         if (code)
 287                 return code;
 288         return finish_command(cmd);
 289 }
 290
 291 static void prepare_run_command_v_opt(struct child_process *cmd,
 292                                       const char **argv,
 293                                       int opt)
 294 {
 295         memset(cmd, 0, sizeof(*cmd));
 296         cmd->argv = argv;
 297         cmd->no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
 298         cmd->git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
 299         cmd->stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
 300         cmd->silent_exec_failure = opt & RUN_SILENT_EXEC_FAILURE ? 1 : 0;
 301 }
 302
 303 int run_command_v_opt(const char **argv, int opt)
 304 {
 305         struct child_process cmd;
 306         prepare_run_command_v_opt(&cmd, argv, opt);
 307         return run_command(&cmd);
 308 }
 309
 310 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
 311 {
 312         struct child_process cmd;
 313         prepare_run_command_v_opt(&cmd, argv, opt);
 314         cmd.dir = dir;
 315         cmd.env = env;
 316         return run_command(&cmd);
 317 }
 318
 319 #ifdef __MINGW32__
 320 static __stdcall unsigned run_thread(void *data)
 321 {
 322         struct async *async = data;
 323         return async->proc(async->fd_for_proc, async->data);
 324 }
 325 #endif
 326
 327 int start_async(struct async *async)
 328 {
 329         int pipe_out[2];
 330
 331         if (pipe(pipe_out) < 0)
 332                 return error("cannot create pipe: %s", strerror(errno));
 333         async->out = pipe_out[0];
 334
 335 #ifndef __MINGW32__
 336         /* Flush stdio before fork() to avoid cloning buffers */
 337         fflush(NULL);
 338
 339         async->pid = fork();
 340         if (async->pid < 0) {
 341                 error("fork (async) failed: %s", strerror(errno));
 342                 close_pair(pipe_out);
 343                 return -1;
 344         }
 345         if (!async->pid) {
 346                 close(pipe_out[0]);
 347                 exit(!!async->proc(pipe_out[1], async->data));
 348         }
 349         close(pipe_out[1]);
 350 #else
 351         async->fd_for_proc = pipe_out[1];
 352         async->tid = (HANDLE) _beginthreadex(NULL, 0, run_thread, async, 0, NULL);
 353         if (!async->tid) {
 354                 error("cannot create thread: %s", strerror(errno));
 355                 close_pair(pipe_out);
 356                 return -1;
 357         }
 358 #endif
 359         return 0;
 360 }
 361
 362 int finish_async(struct async *async)
 363 {
 364 #ifndef __MINGW32__
 365         int ret = wait_or_whine(async->pid, "child process", 0);
 366 #else
 367         DWORD ret = 0;
 368         if (WaitForSingleObject(async->tid, INFINITE) != WAIT_OBJECT_0)
 369                 ret = error("waiting for thread failed: %lu", GetLastError());
 370         else if (!GetExitCodeThread(async->tid, &ret))
 371                 ret = error("cannot get thread exit code: %lu", GetLastError());
 372         CloseHandle(async->tid);
 373 #endif
 374         return ret;
 375 }
 376
 377 int run_hook(const char *index_file, const char *name, ...)
 378 {
 379         struct child_process hook;
 380         const char **argv = NULL, *env[2];
 381         char index[PATH_MAX];
 382         va_list args;
 383         int ret;
 384         size_t i = 0, alloc = 0;
 385
 386         if (access(git_path("hooks/%s", name), X_OK) < 0)
 387                 return 0;
 388
 389         va_start(args, name);
 390         ALLOC_GROW(argv, i + 1, alloc);
 391         argv[i++] = git_path("hooks/%s", name);
 392         while (argv[i-1]) {
 393                 ALLOC_GROW(argv, i + 1, alloc);
 394                 argv[i++] = va_arg(args, const char *);
 395         }
 396         va_end(args);
 397
 398         memset(&hook, 0, sizeof(hook));
 399         hook.argv = argv;
 400         hook.no_stdin = 1;
 401         hook.stdout_to_stderr = 1;
 402         if (index_file) {
 403                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 404                 env[0] = index;
 405                 env[1] = NULL;
 406                 hook.env = env;
 407         }
 408
 409         ret = run_command(&hook);
 410         free(argv);
 411         return ret;
 412 }