]>
Commit | Line | Data |
---|---|---|
b1bf95bb JW |
1 | #ifndef RUN_COMMAND_H |
2 | #define RUN_COMMAND_H | |
3 | ||
f6b60983 | 4 | #ifndef NO_PTHREADS |
200a76b7 JS |
5 | #include <pthread.h> |
6 | #endif | |
7 | ||
c460c0ec JK |
8 | #include "argv-array.h" |
9 | ||
f1000898 SP |
10 | struct child_process { |
11 | const char **argv; | |
c460c0ec | 12 | struct argv_array args; |
19a583dc | 13 | struct argv_array env_array; |
ebcb5d16 | 14 | pid_t pid; |
c20181e3 JS |
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 | |
4f41b611 | 29 | * .err: a writable FD, becomes child's stderr |
c20181e3 JS |
30 | * The specified FD is closed by start_command(), even in case |
31 | * of errors! | |
32 | */ | |
4919bf03 | 33 | int in; |
f4bba25b | 34 | int out; |
f3b33f1d | 35 | int err; |
1568fea0 | 36 | const char *dir; |
ee493148 | 37 | const char *const *env; |
f1000898 | 38 | unsigned no_stdin:1; |
e4507ae8 | 39 | unsigned no_stdout:1; |
b73a4397 | 40 | unsigned no_stderr:1; |
f1000898 | 41 | unsigned git_cmd:1; /* if this is to be git sub-command */ |
c024beb5 | 42 | unsigned silent_exec_failure:1; |
f1000898 | 43 | unsigned stdout_to_stderr:1; |
8dba1e63 | 44 | unsigned use_shell:1; |
afe19ff7 | 45 | unsigned clean_on_exit:1; |
46df6906 | 46 | unsigned wait_after_clean:1; |
ac2fbaa6 LS |
47 | void (*clean_on_exit_handler)(struct child_process *process); |
48 | void *clean_on_exit_handler_cbdata; | |
f1000898 SP |
49 | }; |
50 | ||
19a583dc | 51 | #define CHILD_PROCESS_INIT { NULL, ARGV_ARRAY_INIT, ARGV_ARRAY_INIT } |
483bbd4e | 52 | void child_process_init(struct child_process *); |
2d71608e | 53 | void child_process_clear(struct child_process *); |
d3180279 | 54 | |
ebcb5d16 SP |
55 | int start_command(struct child_process *); |
56 | int finish_command(struct child_process *); | |
507d7804 | 57 | int finish_command_in_signal(struct child_process *); |
f1000898 SP |
58 | int run_command(struct child_process *); |
59 | ||
03f2c773 JK |
60 | /* |
61 | * Returns the path to the hook file, or NULL if the hook is missing | |
62 | * or disabled. Note that this points to static storage that will be | |
63 | * overwritten by further calls to find_hook and run_hook_*. | |
64 | */ | |
dcf69262 | 65 | extern const char *find_hook(const char *name); |
9fe3edc4 | 66 | LAST_ARG_MUST_BE_NULL |
15048f8a BP |
67 | extern int run_hook_le(const char *const *env, const char *name, ...); |
68 | extern int run_hook_ve(const char *const *env, const char *name, va_list args); | |
69 | ||
95d3c4f5 | 70 | #define RUN_COMMAND_NO_STDIN 1 |
77cb17e9 | 71 | #define RUN_GIT_CMD 2 /*If this is to be git sub-command */ |
cd83c74c | 72 | #define RUN_COMMAND_STDOUT_TO_STDERR 4 |
c024beb5 | 73 | #define RUN_SILENT_EXEC_FAILURE 8 |
8dba1e63 | 74 | #define RUN_USING_SHELL 16 |
10c6cddd | 75 | #define RUN_CLEAN_ON_EXIT 32 |
9b0b5093 | 76 | int run_command_v_opt(const char **argv, int opt); |
3427b375 AR |
77 | |
78 | /* | |
79 | * env (the environment) is to be formatted like environ: "VAR=VALUE". | |
80 | * To unset an environment variable use just "VAR". | |
81 | */ | |
ee493148 | 82 | int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env); |
b1bf95bb | 83 | |
911ec99b | 84 | /** |
96335bcf JK |
85 | * Execute the given command, sending "in" to its stdin, and capturing its |
86 | * stdout and stderr in the "out" and "err" strbufs. Any of the three may | |
87 | * be NULL to skip processing. | |
88 | * | |
911ec99b | 89 | * Returns -1 if starting the command fails or reading fails, and otherwise |
96335bcf JK |
90 | * returns the exit code of the command. Any output collected in the |
91 | * buffers is kept even if the command returns a non-zero exit. The hint fields | |
92 | * gives starting sizes for the strbuf allocations. | |
911ec99b JK |
93 | * |
94 | * The fields of "cmd" should be set up as they would for a normal run_command | |
96335bcf JK |
95 | * invocation. But note that there is no need to set the in, out, or err |
96 | * fields; pipe_command handles that automatically. | |
97 | */ | |
98 | int pipe_command(struct child_process *cmd, | |
99 | const char *in, size_t in_len, | |
100 | struct strbuf *out, size_t out_hint, | |
101 | struct strbuf *err, size_t err_hint); | |
102 | ||
103 | /** | |
104 | * Convenience wrapper around pipe_command for the common case | |
105 | * of capturing only stdout. | |
911ec99b | 106 | */ |
96335bcf JK |
107 | static inline int capture_command(struct child_process *cmd, |
108 | struct strbuf *out, | |
109 | size_t hint) | |
110 | { | |
111 | return pipe_command(cmd, NULL, 0, out, hint, NULL, 0); | |
112 | } | |
911ec99b | 113 | |
2d22c208 JS |
114 | /* |
115 | * The purpose of the following functions is to feed a pipe by running | |
116 | * a function asynchronously and providing output that the caller reads. | |
117 | * | |
118 | * It is expected that no synchronization and mutual exclusion between | |
119 | * the caller and the feed function is necessary so that the function | |
120 | * can run in a thread without interfering with the caller. | |
121 | */ | |
122 | struct async { | |
123 | /* | |
ae6a5609 EFL |
124 | * proc reads from in; closes it before return |
125 | * proc writes to out; closes it before return | |
2d22c208 JS |
126 | * returns 0 on success, non-zero on failure |
127 | */ | |
ae6a5609 | 128 | int (*proc)(int in, int out, void *data); |
2d22c208 | 129 | void *data; |
ae6a5609 | 130 | int in; /* caller writes here and closes it */ |
2d22c208 | 131 | int out; /* caller reads from here and closes it */ |
f6b60983 | 132 | #ifdef NO_PTHREADS |
2d22c208 | 133 | pid_t pid; |
618ebe9f | 134 | #else |
200a76b7 | 135 | pthread_t tid; |
ae6a5609 EFL |
136 | int proc_in; |
137 | int proc_out; | |
618ebe9f | 138 | #endif |
c792d7b6 | 139 | int isolate_sigpipe; |
2d22c208 JS |
140 | }; |
141 | ||
142 | int start_async(struct async *async); | |
143 | int finish_async(struct async *async); | |
661a8cf4 | 144 | int in_async(void); |
b992fe10 | 145 | void check_pipe(int err); |
2d22c208 | 146 | |
c553c72e SB |
147 | /** |
148 | * This callback should initialize the child process and preload the | |
149 | * error channel if desired. The preloading of is useful if you want to | |
150 | * have a message printed directly before the output of the child process. | |
151 | * pp_cb is the callback cookie as passed to run_processes_parallel. | |
152 | * You can store a child process specific callback cookie in pp_task_cb. | |
153 | * | |
154 | * Even after returning 0 to indicate that there are no more processes, | |
155 | * this function will be called again until there are no more running | |
156 | * child processes. | |
157 | * | |
158 | * Return 1 if the next child is ready to run. | |
159 | * Return 0 if there are currently no more tasks to be processed. | |
160 | * To send a signal to other child processes for abortion, | |
161 | * return the negative signal number. | |
162 | */ | |
163 | typedef int (*get_next_task_fn)(struct child_process *cp, | |
aa710494 | 164 | struct strbuf *out, |
c553c72e SB |
165 | void *pp_cb, |
166 | void **pp_task_cb); | |
167 | ||
168 | /** | |
169 | * This callback is called whenever there are problems starting | |
170 | * a new process. | |
171 | * | |
172 | * You must not write to stdout or stderr in this function. Add your | |
aa710494 | 173 | * message to the strbuf out instead, which will be printed without |
c553c72e SB |
174 | * messing up the output of the other parallel processes. |
175 | * | |
176 | * pp_cb is the callback cookie as passed into run_processes_parallel, | |
177 | * pp_task_cb is the callback cookie as passed into get_next_task_fn. | |
178 | * | |
179 | * Return 0 to continue the parallel processing. To abort return non zero. | |
180 | * To send a signal to other child processes for abortion, return | |
181 | * the negative signal number. | |
182 | */ | |
aa710494 | 183 | typedef int (*start_failure_fn)(struct strbuf *out, |
c553c72e SB |
184 | void *pp_cb, |
185 | void *pp_task_cb); | |
186 | ||
187 | /** | |
188 | * This callback is called on every child process that finished processing. | |
189 | * | |
190 | * You must not write to stdout or stderr in this function. Add your | |
aa710494 | 191 | * message to the strbuf out instead, which will be printed without |
c553c72e SB |
192 | * messing up the output of the other parallel processes. |
193 | * | |
194 | * pp_cb is the callback cookie as passed into run_processes_parallel, | |
195 | * pp_task_cb is the callback cookie as passed into get_next_task_fn. | |
196 | * | |
197 | * Return 0 to continue the parallel processing. To abort return non zero. | |
198 | * To send a signal to other child processes for abortion, return | |
199 | * the negative signal number. | |
200 | */ | |
201 | typedef int (*task_finished_fn)(int result, | |
aa710494 | 202 | struct strbuf *out, |
c553c72e SB |
203 | void *pp_cb, |
204 | void *pp_task_cb); | |
205 | ||
206 | /** | |
207 | * Runs up to n processes at the same time. Whenever a process can be | |
208 | * started, the callback get_next_task_fn is called to obtain the data | |
209 | * required to start another child process. | |
210 | * | |
211 | * The children started via this function run in parallel. Their output | |
212 | * (both stdout and stderr) is routed to stderr in a manner that output | |
213 | * from different tasks does not interleave. | |
214 | * | |
2a73b3da SB |
215 | * start_failure_fn and task_finished_fn can be NULL to omit any |
216 | * special handling. | |
c553c72e SB |
217 | */ |
218 | int run_processes_parallel(int n, | |
219 | get_next_task_fn, | |
220 | start_failure_fn, | |
221 | task_finished_fn, | |
222 | void *pp_cb); | |
223 | ||
b1bf95bb | 224 | #endif |