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