Sync with maint
[git.git] / run-command.h
blobea73de309bc65c3d00bb34ad84824ba72d85cbfe
1 #ifndef RUN_COMMAND_H
2 #define RUN_COMMAND_H
4 #ifndef NO_PTHREADS
5 #include <pthread.h>
6 #endif
8 #include "argv-array.h"
10 struct child_process {
11 const char **argv;
12 struct argv_array args;
13 pid_t pid;
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
28 * .err: a writable FD, becomes child's stderr
29 * The specified FD is closed by start_command(), even in case
30 * of errors!
32 int in;
33 int out;
34 int err;
35 const char *dir;
36 const char *const *env;
37 unsigned no_stdin:1;
38 unsigned no_stdout:1;
39 unsigned no_stderr:1;
40 unsigned git_cmd:1; /* if this is to be git sub-command */
41 unsigned silent_exec_failure:1;
42 unsigned stdout_to_stderr:1;
43 unsigned use_shell:1;
44 unsigned clean_on_exit:1;
47 int start_command(struct child_process *);
48 int finish_command(struct child_process *);
49 int run_command(struct child_process *);
51 extern char *find_hook(const char *name);
52 LAST_ARG_MUST_BE_NULL
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);
56 LAST_ARG_MUST_BE_NULL
57 __attribute__((deprecated))
58 extern int run_hook_with_custom_index(const char *index_file, const char *name, ...);
60 #define RUN_COMMAND_NO_STDIN 1
61 #define RUN_GIT_CMD 2 /*If this is to be git sub-command */
62 #define RUN_COMMAND_STDOUT_TO_STDERR 4
63 #define RUN_SILENT_EXEC_FAILURE 8
64 #define RUN_USING_SHELL 16
65 #define RUN_CLEAN_ON_EXIT 32
66 int run_command_v_opt(const char **argv, int opt);
69 * env (the environment) is to be formatted like environ: "VAR=VALUE".
70 * To unset an environment variable use just "VAR".
72 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
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.
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.
82 struct async {
84 * proc reads from in; closes it before return
85 * proc writes to out; closes it before return
86 * returns 0 on success, non-zero on failure
88 int (*proc)(int in, int out, void *data);
89 void *data;
90 int in; /* caller writes here and closes it */
91 int out; /* caller reads from here and closes it */
92 #ifdef NO_PTHREADS
93 pid_t pid;
94 #else
95 pthread_t tid;
96 int proc_in;
97 int proc_out;
98 #endif
101 int start_async(struct async *async);
102 int finish_async(struct async *async);
104 #endif