run-command.h

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