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