Andrew's git - gitweb.git/blob

   1#ifndef RUN_COMMAND_H
   2#define RUN_COMMAND_H
   3
   4#ifndef NO_PTHREADS
   5#include <pthread.h>
   6#endif
   7
   8struct child_process {
   9        const char **argv;
  10        pid_t pid;
  11        /*
  12         * Using .in, .out, .err:
  13         * - Specify 0 for no redirections (child inherits stdin, stdout,
  14         *   stderr from parent).
  15         * - Specify -1 to have a pipe allocated as follows:
  16         *     .in: returns the writable pipe end; parent writes to it,
  17         *          the readable pipe end becomes child's stdin
  18         *     .out, .err: returns the readable pipe end; parent reads from
  19         *          it, the writable pipe end becomes child's stdout/stderr
  20         *   The caller of start_command() must close the returned FDs
  21         *   after it has completed reading from/writing to it!
  22         * - Specify > 0 to set a channel to a particular FD as follows:
  23         *     .in: a readable FD, becomes child's stdin
  24         *     .out: a writable FD, becomes child's stdout/stderr
  25         *     .err: a writable FD, becomes child's stderr
  26         *   The specified FD is closed by start_command(), even in case
  27         *   of errors!
  28         */
  29        int in;
  30        int out;
  31        int err;
  32        const char *dir;
  33        const char *const *env;
  34        unsigned no_stdin:1;
  35        unsigned no_stdout:1;
  36        unsigned no_stderr:1;
  37        unsigned git_cmd:1; /* if this is to be git sub-command */
  38        unsigned silent_exec_failure:1;
  39        unsigned stdout_to_stderr:1;
  40        unsigned use_shell:1;
  41        unsigned clean_on_exit:1;
  42};
  43
  44int start_command(struct child_process *);
  45int finish_command(struct child_process *);
  46int run_command(struct child_process *);
  47
  48extern char *find_hook(const char *name);
  49LAST_ARG_MUST_BE_NULL
  50extern int run_hook(const char *index_file, const char *name, ...);
  51
  52#define RUN_COMMAND_NO_STDIN 1
  53#define RUN_GIT_CMD          2  /*If this is to be git sub-command */
  54#define RUN_COMMAND_STDOUT_TO_STDERR 4
  55#define RUN_SILENT_EXEC_FAILURE 8
  56#define RUN_USING_SHELL 16
  57#define RUN_CLEAN_ON_EXIT 32
  58int run_command_v_opt(const char **argv, int opt);
  59
  60/*
  61 * env (the environment) is to be formatted like environ: "VAR=VALUE".
  62 * To unset an environment variable use just "VAR".
  63 */
  64int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
  65
  66/*
  67 * The purpose of the following functions is to feed a pipe by running
  68 * a function asynchronously and providing output that the caller reads.
  69 *
  70 * It is expected that no synchronization and mutual exclusion between
  71 * the caller and the feed function is necessary so that the function
  72 * can run in a thread without interfering with the caller.
  73 */
  74struct async {
  75        /*
  76         * proc reads from in; closes it before return
  77         * proc writes to out; closes it before return
  78         * returns 0 on success, non-zero on failure
  79         */
  80        int (*proc)(int in, int out, void *data);
  81        void *data;
  82        int in;         /* caller writes here and closes it */
  83        int out;        /* caller reads from here and closes it */
  84#ifdef NO_PTHREADS
  85        pid_t pid;
  86#else
  87        pthread_t tid;
  88        int proc_in;
  89        int proc_out;
  90#endif
  91};
  92
  93int start_async(struct async *async);
  94int finish_async(struct async *async);
  95
  96#endif