run-command.h

   1 #ifndef RUN_COMMAND_H
   2 #define RUN_COMMAND_H
   3
   4 #ifndef NO_PTHREADS
   5 #include <pthread.h>
   6 #endif
   7
   8 struct 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
  44 int start_command(struct child_process *);
  45 int finish_command(struct child_process *);
  46 int run_command(struct child_process *);
  47
  48 extern char *find_hook(const char *name);
  49 LAST_ARG_MUST_BE_NULL
  50 extern int run_hook_le(const char *const *env, const char *name, ...);
  51 extern int run_hook_ve(const char *const *env, const char *name, va_list args);
  52
  53 LAST_ARG_MUST_BE_NULL
  54 __attribute__((deprecated))
  55 extern int run_hook_with_custom_index(const char *index_file, const char *name, ...);
  56
  57 #define RUN_COMMAND_NO_STDIN 1
  58 #define RUN_GIT_CMD          2  /*If this is to be git sub-command */
  59 #define RUN_COMMAND_STDOUT_TO_STDERR 4
  60 #define RUN_SILENT_EXEC_FAILURE 8
  61 #define RUN_USING_SHELL 16
  62 #define RUN_CLEAN_ON_EXIT 32
  63 int run_command_v_opt(const char **argv, int opt);
  64
  65 /*
  66  * env (the environment) is to be formatted like environ: "VAR=VALUE".
  67  * To unset an environment variable use just "VAR".
  68  */
  69 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
  70
  71 /*
  72  * The purpose of the following functions is to feed a pipe by running
  73  * a function asynchronously and providing output that the caller reads.
  74  *
  75  * It is expected that no synchronization and mutual exclusion between
  76  * the caller and the feed function is necessary so that the function
  77  * can run in a thread without interfering with the caller.
  78  */
  79 struct async {
  80         /*
  81          * proc reads from in; closes it before return
  82          * proc writes to out; closes it before return
  83          * returns 0 on success, non-zero on failure
  84          */
  85         int (*proc)(int in, int out, void *data);
  86         void *data;
  87         int in;         /* caller writes here and closes it */
  88         int out;        /* caller reads from here and closes it */
  89 #ifdef NO_PTHREADS
  90         pid_t pid;
  91 #else
  92         pthread_t tid;
  93         int proc_in;
  94         int proc_out;
  95 #endif
  96 };
  97
  98 int start_async(struct async *async);
  99 int finish_async(struct async *async);
 100
 101 #endif