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