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