run-command.h

   1 #ifndef RUN_COMMAND_H
   2 #define RUN_COMMAND_H
   3
   4 enum {
   5         ERR_RUN_COMMAND_FORK = 10000,
   6         ERR_RUN_COMMAND_EXEC,
   7         ERR_RUN_COMMAND_PIPE,
   8         ERR_RUN_COMMAND_WAITPID,
   9         ERR_RUN_COMMAND_WAITPID_WRONG_PID,
  10         ERR_RUN_COMMAND_WAITPID_SIGNAL,
  11         ERR_RUN_COMMAND_WAITPID_NOEXIT,
  12 };
  13
  14 struct child_process {
  15         const char **argv;
  16         pid_t pid;
  17         int in;
  18         int out;
  19         int err;
  20         const char *dir;
  21         const char *const *env;
  22         unsigned no_stdin:1;
  23         unsigned no_stdout:1;
  24         unsigned no_stderr:1;
  25         unsigned git_cmd:1; /* if this is to be git sub-command */
  26         unsigned stdout_to_stderr:1;
  27 };
  28
  29 int start_command(struct child_process *);
  30 int finish_command(struct child_process *);
  31 int run_command(struct child_process *);
  32
  33 #define RUN_COMMAND_NO_STDIN 1
  34 #define RUN_GIT_CMD          2  /*If this is to be git sub-command */
  35 #define RUN_COMMAND_STDOUT_TO_STDERR 4
  36 int run_command_v_opt(const char **argv, int opt);
  37 int run_command_v_opt_cd(const char **argv, int opt, const char *dir);
  38
  39 /*
  40  * env (the environment) is to be formatted like environ: "VAR=VALUE".
  41  * To unset an environment variable use just "VAR".
  42  */
  43 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
  44
  45 /*
  46  * The purpose of the following functions is to feed a pipe by running
  47  * a function asynchronously and providing output that the caller reads.
  48  *
  49  * It is expected that no synchronization and mutual exclusion between
  50  * the caller and the feed function is necessary so that the function
  51  * can run in a thread without interfering with the caller.
  52  */
  53 struct async {
  54         /*
  55          * proc writes to fd and closes it;
  56          * returns 0 on success, non-zero on failure
  57          */
  58         int (*proc)(int fd, void *data);
  59         void *data;
  60         int out;        /* caller reads from here and closes it */
  61         pid_t pid;
  62 };
  63
  64 int start_async(struct async *async);
  65 int finish_async(struct async *async);
  66
  67 #endif