run_command: encode deadly signal number in the return value
[git/git.git] / run-command.h
CommitLineData
b1bf95bb
JW
1#ifndef RUN_COMMAND_H
2#define RUN_COMMAND_H
3
f1000898
SP
4struct child_process {
5 const char **argv;
ebcb5d16 6 pid_t pid;
c20181e3
JS
7 /*
8 * Using .in, .out, .err:
9 * - Specify 0 for no redirections (child inherits stdin, stdout,
10 * stderr from parent).
11 * - Specify -1 to have a pipe allocated as follows:
12 * .in: returns the writable pipe end; parent writes to it,
13 * the readable pipe end becomes child's stdin
14 * .out, .err: returns the readable pipe end; parent reads from
15 * it, the writable pipe end becomes child's stdout/stderr
16 * The caller of start_command() must close the returned FDs
17 * after it has completed reading from/writing to it!
18 * - Specify > 0 to set a channel to a particular FD as follows:
19 * .in: a readable FD, becomes child's stdin
20 * .out: a writable FD, becomes child's stdout/stderr
21 * .err > 0 not supported
22 * The specified FD is closed by start_command(), even in case
23 * of errors!
24 */
4919bf03 25 int in;
f4bba25b 26 int out;
f3b33f1d 27 int err;
1568fea0 28 const char *dir;
ee493148 29 const char *const *env;
f1000898 30 unsigned no_stdin:1;
e4507ae8 31 unsigned no_stdout:1;
b73a4397 32 unsigned no_stderr:1;
f1000898
SP
33 unsigned git_cmd:1; /* if this is to be git sub-command */
34 unsigned stdout_to_stderr:1;
ccf08bc3 35 void (*preexec_cb)(void);
f1000898
SP
36};
37
ebcb5d16
SP
38int start_command(struct child_process *);
39int finish_command(struct child_process *);
f1000898
SP
40int run_command(struct child_process *);
41
ae98a008
SB
42extern int run_hook(const char *index_file, const char *name, ...);
43
95d3c4f5 44#define RUN_COMMAND_NO_STDIN 1
77cb17e9 45#define RUN_GIT_CMD 2 /*If this is to be git sub-command */
cd83c74c 46#define RUN_COMMAND_STDOUT_TO_STDERR 4
9b0b5093 47int run_command_v_opt(const char **argv, int opt);
3427b375
AR
48
49/*
50 * env (the environment) is to be formatted like environ: "VAR=VALUE".
51 * To unset an environment variable use just "VAR".
52 */
ee493148 53int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
b1bf95bb 54
2d22c208
JS
55/*
56 * The purpose of the following functions is to feed a pipe by running
57 * a function asynchronously and providing output that the caller reads.
58 *
59 * It is expected that no synchronization and mutual exclusion between
60 * the caller and the feed function is necessary so that the function
61 * can run in a thread without interfering with the caller.
62 */
63struct async {
64 /*
65 * proc writes to fd and closes it;
66 * returns 0 on success, non-zero on failure
67 */
68 int (*proc)(int fd, void *data);
69 void *data;
70 int out; /* caller reads from here and closes it */
618ebe9f 71#ifndef __MINGW32__
2d22c208 72 pid_t pid;
618ebe9f
JS
73#else
74 HANDLE tid;
75 int fd_for_proc;
76#endif
2d22c208
JS
77};
78
79int start_async(struct async *async);
80int finish_async(struct async *async);
81
b1bf95bb 82#endif