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