Josef Weidendorfer | b1bf95b | 2005-07-31 21:17:43 +0200 | [diff] [blame] | 1 | #ifndef RUN_COMMAND_H |
| 2 | #define RUN_COMMAND_H |
| 3 | |
Johannes Sixt | f6b6098 | 2010-03-09 21:00:36 +0100 | [diff] [blame] | 4 | #ifndef NO_PTHREADS |
Johannes Sixt | 200a76b | 2010-03-06 16:40:42 +0100 | [diff] [blame] | 5 | #include <pthread.h> |
| 6 | #endif |
| 7 | |
Jeff King | c460c0e | 2014-05-15 04:33:26 -0400 | [diff] [blame] | 8 | #include "argv-array.h" |
| 9 | |
Shawn O. Pearce | f100089 | 2007-03-10 03:28:00 -0500 | [diff] [blame] | 10 | struct child_process { |
| 11 | const char **argv; |
Jeff King | c460c0e | 2014-05-15 04:33:26 -0400 | [diff] [blame] | 12 | struct argv_array args; |
René Scharfe | 19a583d | 2014-10-19 13:13:55 +0200 | [diff] [blame] | 13 | struct argv_array env_array; |
Shawn O. Pearce | ebcb5d1 | 2007-03-10 03:28:05 -0500 | [diff] [blame] | 14 | pid_t pid; |
Johannes Sixt | c20181e | 2008-02-21 23:42:56 +0100 | [diff] [blame] | 15 | /* |
| 16 | * Using .in, .out, .err: |
| 17 | * - Specify 0 for no redirections (child inherits stdin, stdout, |
| 18 | * stderr from parent). |
| 19 | * - Specify -1 to have a pipe allocated as follows: |
| 20 | * .in: returns the writable pipe end; parent writes to it, |
| 21 | * the readable pipe end becomes child's stdin |
| 22 | * .out, .err: returns the readable pipe end; parent reads from |
| 23 | * it, the writable pipe end becomes child's stdout/stderr |
| 24 | * The caller of start_command() must close the returned FDs |
| 25 | * after it has completed reading from/writing to it! |
| 26 | * - Specify > 0 to set a channel to a particular FD as follows: |
| 27 | * .in: a readable FD, becomes child's stdin |
| 28 | * .out: a writable FD, becomes child's stdout/stderr |
Shawn O. Pearce | 4f41b61 | 2010-02-05 12:57:37 -0800 | [diff] [blame] | 29 | * .err: a writable FD, becomes child's stderr |
Johannes Sixt | c20181e | 2008-02-21 23:42:56 +0100 | [diff] [blame] | 30 | * The specified FD is closed by start_command(), even in case |
| 31 | * of errors! |
| 32 | */ |
Shawn O. Pearce | 4919bf0 | 2007-03-10 03:28:08 -0500 | [diff] [blame] | 33 | int in; |
Shawn O. Pearce | f4bba25 | 2007-03-12 14:37:45 -0400 | [diff] [blame] | 34 | int out; |
Johannes Sixt | f3b33f1 | 2007-10-19 21:47:58 +0200 | [diff] [blame] | 35 | int err; |
Alex Riesen | 1568fea | 2007-05-22 23:48:23 +0200 | [diff] [blame] | 36 | const char *dir; |
Alex Riesen | ee49314 | 2007-05-22 23:48:47 +0200 | [diff] [blame] | 37 | const char *const *env; |
Shawn O. Pearce | f100089 | 2007-03-10 03:28:00 -0500 | [diff] [blame] | 38 | unsigned no_stdin:1; |
Shawn O. Pearce | e4507ae | 2007-03-12 14:37:55 -0400 | [diff] [blame] | 39 | unsigned no_stdout:1; |
Shawn O. Pearce | b73a439 | 2007-11-11 02:29:37 -0500 | [diff] [blame] | 40 | unsigned no_stderr:1; |
Shawn O. Pearce | f100089 | 2007-03-10 03:28:00 -0500 | [diff] [blame] | 41 | unsigned git_cmd:1; /* if this is to be git sub-command */ |
Johannes Sixt | c024beb | 2009-07-04 21:26:42 +0200 | [diff] [blame] | 42 | unsigned silent_exec_failure:1; |
Shawn O. Pearce | f100089 | 2007-03-10 03:28:00 -0500 | [diff] [blame] | 43 | unsigned stdout_to_stderr:1; |
Jeff King | 8dba1e6 | 2009-12-30 05:53:16 -0500 | [diff] [blame] | 44 | unsigned use_shell:1; |
Jeff King | afe19ff | 2012-01-07 12:42:43 +0100 | [diff] [blame] | 45 | unsigned clean_on_exit:1; |
Shawn O. Pearce | f100089 | 2007-03-10 03:28:00 -0500 | [diff] [blame] | 46 | }; |
| 47 | |
René Scharfe | 19a583d | 2014-10-19 13:13:55 +0200 | [diff] [blame] | 48 | #define CHILD_PROCESS_INIT { NULL, ARGV_ARRAY_INIT, ARGV_ARRAY_INIT } |
René Scharfe | 483bbd4 | 2014-08-19 21:10:48 +0200 | [diff] [blame] | 49 | void child_process_init(struct child_process *); |
René Scharfe | d318027 | 2014-08-19 21:09:35 +0200 | [diff] [blame] | 50 | |
Shawn O. Pearce | ebcb5d1 | 2007-03-10 03:28:05 -0500 | [diff] [blame] | 51 | int start_command(struct child_process *); |
| 52 | int finish_command(struct child_process *); |
Shawn O. Pearce | f100089 | 2007-03-10 03:28:00 -0500 | [diff] [blame] | 53 | int run_command(struct child_process *); |
| 54 | |
Nguyễn Thái Ngọc Duy | dcf6926 | 2014-11-30 15:24:27 +0700 | [diff] [blame] | 55 | extern const char *find_hook(const char *name); |
Ramsay Jones | 9fe3edc | 2013-07-18 21:02:12 +0100 | [diff] [blame] | 56 | LAST_ARG_MUST_BE_NULL |
Benoit Pierre | 15048f8 | 2014-03-18 11:00:53 +0100 | [diff] [blame] | 57 | extern int run_hook_le(const char *const *env, const char *name, ...); |
| 58 | extern int run_hook_ve(const char *const *env, const char *name, va_list args); |
| 59 | |
Shawn O. Pearce | 95d3c4f | 2006-12-30 21:55:22 -0500 | [diff] [blame] | 60 | #define RUN_COMMAND_NO_STDIN 1 |
Michal Ostrowski | 77cb17e | 2006-01-10 21:12:17 -0500 | [diff] [blame] | 61 | #define RUN_GIT_CMD 2 /*If this is to be git sub-command */ |
Shawn O. Pearce | cd83c74 | 2006-12-30 21:55:19 -0500 | [diff] [blame] | 62 | #define RUN_COMMAND_STDOUT_TO_STDERR 4 |
Johannes Sixt | c024beb | 2009-07-04 21:26:42 +0200 | [diff] [blame] | 63 | #define RUN_SILENT_EXEC_FAILURE 8 |
Jeff King | 8dba1e6 | 2009-12-30 05:53:16 -0500 | [diff] [blame] | 64 | #define RUN_USING_SHELL 16 |
Clemens Buchacher | 10c6cdd | 2012-01-08 21:41:09 +0100 | [diff] [blame] | 65 | #define RUN_CLEAN_ON_EXIT 32 |
Shawn O. Pearce | 9b0b509 | 2006-12-30 21:55:15 -0500 | [diff] [blame] | 66 | int run_command_v_opt(const char **argv, int opt); |
Alex Riesen | 3427b37 | 2007-05-23 22:21:39 +0200 | [diff] [blame] | 67 | |
| 68 | /* |
| 69 | * env (the environment) is to be formatted like environ: "VAR=VALUE". |
| 70 | * To unset an environment variable use just "VAR". |
| 71 | */ |
Alex Riesen | ee49314 | 2007-05-22 23:48:47 +0200 | [diff] [blame] | 72 | int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env); |
Josef Weidendorfer | b1bf95b | 2005-07-31 21:17:43 +0200 | [diff] [blame] | 73 | |
Jeff King | 911ec99 | 2015-03-22 23:53:43 -0400 | [diff] [blame] | 74 | /** |
| 75 | * Execute the given command, capturing its stdout in the given strbuf. |
| 76 | * Returns -1 if starting the command fails or reading fails, and otherwise |
| 77 | * returns the exit code of the command. The output collected in the |
| 78 | * buffer is kept even if the command returns a non-zero exit. The hint field |
| 79 | * gives a starting size for the strbuf allocation. |
| 80 | * |
| 81 | * The fields of "cmd" should be set up as they would for a normal run_command |
| 82 | * invocation. But note that there is no need to set cmd->out; the function |
| 83 | * sets it up for the caller. |
| 84 | */ |
| 85 | int capture_command(struct child_process *cmd, struct strbuf *buf, size_t hint); |
| 86 | |
Johannes Sixt | 2d22c20 | 2007-10-19 21:48:00 +0200 | [diff] [blame] | 87 | /* |
| 88 | * The purpose of the following functions is to feed a pipe by running |
| 89 | * a function asynchronously and providing output that the caller reads. |
| 90 | * |
| 91 | * It is expected that no synchronization and mutual exclusion between |
| 92 | * the caller and the feed function is necessary so that the function |
| 93 | * can run in a thread without interfering with the caller. |
| 94 | */ |
| 95 | struct async { |
| 96 | /* |
Erik Faye-Lund | ae6a560 | 2010-02-05 12:57:38 -0800 | [diff] [blame] | 97 | * proc reads from in; closes it before return |
| 98 | * proc writes to out; closes it before return |
Johannes Sixt | 2d22c20 | 2007-10-19 21:48:00 +0200 | [diff] [blame] | 99 | * returns 0 on success, non-zero on failure |
| 100 | */ |
Erik Faye-Lund | ae6a560 | 2010-02-05 12:57:38 -0800 | [diff] [blame] | 101 | int (*proc)(int in, int out, void *data); |
Johannes Sixt | 2d22c20 | 2007-10-19 21:48:00 +0200 | [diff] [blame] | 102 | void *data; |
Erik Faye-Lund | ae6a560 | 2010-02-05 12:57:38 -0800 | [diff] [blame] | 103 | int in; /* caller writes here and closes it */ |
Johannes Sixt | 2d22c20 | 2007-10-19 21:48:00 +0200 | [diff] [blame] | 104 | int out; /* caller reads from here and closes it */ |
Johannes Sixt | f6b6098 | 2010-03-09 21:00:36 +0100 | [diff] [blame] | 105 | #ifdef NO_PTHREADS |
Johannes Sixt | 2d22c20 | 2007-10-19 21:48:00 +0200 | [diff] [blame] | 106 | pid_t pid; |
Johannes Sixt | 618ebe9 | 2007-12-08 22:19:14 +0100 | [diff] [blame] | 107 | #else |
Johannes Sixt | 200a76b | 2010-03-06 16:40:42 +0100 | [diff] [blame] | 108 | pthread_t tid; |
Erik Faye-Lund | ae6a560 | 2010-02-05 12:57:38 -0800 | [diff] [blame] | 109 | int proc_in; |
| 110 | int proc_out; |
Johannes Sixt | 618ebe9 | 2007-12-08 22:19:14 +0100 | [diff] [blame] | 111 | #endif |
Johannes Sixt | 2d22c20 | 2007-10-19 21:48:00 +0200 | [diff] [blame] | 112 | }; |
| 113 | |
| 114 | int start_async(struct async *async); |
| 115 | int finish_async(struct async *async); |
| 116 | |
Josef Weidendorfer | b1bf95b | 2005-07-31 21:17:43 +0200 | [diff] [blame] | 117 | #endif |