start_command(), .in/.out/.err = -1: Callers must close the file descriptor
[git/git.git] / run-command.h
CommitLineData
b1bf95bb
JW
1#ifndef RUN_COMMAND_H
2#define RUN_COMMAND_H
3
b1bf95bb
JW
4enum {
5 ERR_RUN_COMMAND_FORK = 10000,
6 ERR_RUN_COMMAND_EXEC,
4919bf03 7 ERR_RUN_COMMAND_PIPE,
b1bf95bb
JW
8 ERR_RUN_COMMAND_WAITPID,
9 ERR_RUN_COMMAND_WAITPID_WRONG_PID,
10 ERR_RUN_COMMAND_WAITPID_SIGNAL,
11 ERR_RUN_COMMAND_WAITPID_NOEXIT,
12};
13
f1000898
SP
14struct child_process {
15 const char **argv;
ebcb5d16 16 pid_t pid;
4919bf03 17 int in;
f4bba25b 18 int out;
f3b33f1d 19 int err;
1568fea0 20 const char *dir;
ee493148 21 const char *const *env;
f1000898 22 unsigned no_stdin:1;
e4507ae8 23 unsigned no_stdout:1;
b73a4397 24 unsigned no_stderr:1;
f1000898
SP
25 unsigned git_cmd:1; /* if this is to be git sub-command */
26 unsigned stdout_to_stderr:1;
27};
28
ebcb5d16
SP
29int start_command(struct child_process *);
30int finish_command(struct child_process *);
f1000898
SP
31int run_command(struct child_process *);
32
95d3c4f5 33#define RUN_COMMAND_NO_STDIN 1
77cb17e9 34#define RUN_GIT_CMD 2 /*If this is to be git sub-command */
cd83c74c 35#define RUN_COMMAND_STDOUT_TO_STDERR 4
9b0b5093 36int run_command_v_opt(const char **argv, int opt);
1568fea0 37int run_command_v_opt_cd(const char **argv, int opt, const char *dir);
3427b375
AR
38
39/*
40 * env (the environment) is to be formatted like environ: "VAR=VALUE".
41 * To unset an environment variable use just "VAR".
42 */
ee493148 43int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
b1bf95bb 44
2d22c208
JS
45/*
46 * The purpose of the following functions is to feed a pipe by running
47 * a function asynchronously and providing output that the caller reads.
48 *
49 * It is expected that no synchronization and mutual exclusion between
50 * the caller and the feed function is necessary so that the function
51 * can run in a thread without interfering with the caller.
52 */
53struct async {
54 /*
55 * proc writes to fd and closes it;
56 * returns 0 on success, non-zero on failure
57 */
58 int (*proc)(int fd, void *data);
59 void *data;
60 int out; /* caller reads from here and closes it */
61 pid_t pid;
62};
63
64int start_async(struct async *async);
65int finish_async(struct async *async);
66
b1bf95bb 67#endif