Documentation/git-submodule.txt: Add Description section
[git/dkf.git] / run-command.c
blob6e29fdf9e2968900d21ea48b992f292204621f19
1 #include "cache.h"
2 #include "run-command.h"
3 #include "exec_cmd.h"
5 static inline void close_pair(int fd[2])
7 close(fd[0]);
8 close(fd[1]);
11 static inline void dup_devnull(int to)
13 int fd = open("/dev/null", O_RDWR);
14 dup2(fd, to);
15 close(fd);
18 int start_command(struct child_process *cmd)
20 int need_in, need_out, need_err;
21 int fdin[2], fdout[2], fderr[2];
24 * In case of errors we must keep the promise to close FDs
25 * that have been passed in via ->in and ->out.
28 need_in = !cmd->no_stdin && cmd->in < 0;
29 if (need_in) {
30 if (pipe(fdin) < 0) {
31 if (cmd->out > 0)
32 close(cmd->out);
33 return -ERR_RUN_COMMAND_PIPE;
35 cmd->in = fdin[1];
38 need_out = !cmd->no_stdout
39 && !cmd->stdout_to_stderr
40 && cmd->out < 0;
41 if (need_out) {
42 if (pipe(fdout) < 0) {
43 if (need_in)
44 close_pair(fdin);
45 else if (cmd->in)
46 close(cmd->in);
47 return -ERR_RUN_COMMAND_PIPE;
49 cmd->out = fdout[0];
52 need_err = !cmd->no_stderr && cmd->err < 0;
53 if (need_err) {
54 if (pipe(fderr) < 0) {
55 if (need_in)
56 close_pair(fdin);
57 else if (cmd->in)
58 close(cmd->in);
59 if (need_out)
60 close_pair(fdout);
61 else if (cmd->out)
62 close(cmd->out);
63 return -ERR_RUN_COMMAND_PIPE;
65 cmd->err = fderr[0];
68 trace_argv_printf(cmd->argv, "trace: run_command:");
70 #ifndef __MINGW32__
71 cmd->pid = fork();
72 if (!cmd->pid) {
73 if (cmd->no_stdin)
74 dup_devnull(0);
75 else if (need_in) {
76 dup2(fdin[0], 0);
77 close_pair(fdin);
78 } else if (cmd->in) {
79 dup2(cmd->in, 0);
80 close(cmd->in);
83 if (cmd->no_stderr)
84 dup_devnull(2);
85 else if (need_err) {
86 dup2(fderr[1], 2);
87 close_pair(fderr);
90 if (cmd->no_stdout)
91 dup_devnull(1);
92 else if (cmd->stdout_to_stderr)
93 dup2(2, 1);
94 else if (need_out) {
95 dup2(fdout[1], 1);
96 close_pair(fdout);
97 } else if (cmd->out > 1) {
98 dup2(cmd->out, 1);
99 close(cmd->out);
102 if (cmd->dir && chdir(cmd->dir))
103 die("exec %s: cd to %s failed (%s)", cmd->argv[0],
104 cmd->dir, strerror(errno));
105 if (cmd->env) {
106 for (; *cmd->env; cmd->env++) {
107 if (strchr(*cmd->env, '='))
108 putenv((char*)*cmd->env);
109 else
110 unsetenv(*cmd->env);
113 if (cmd->git_cmd) {
114 execv_git_cmd(cmd->argv);
115 } else {
116 execvp(cmd->argv[0], (char *const*) cmd->argv);
118 die("exec %s failed.", cmd->argv[0]);
120 #else
121 int s0 = -1, s1 = -1, s2 = -1; /* backups of stdin, stdout, stderr */
122 const char *sargv0 = cmd->argv[0];
123 char **env = environ;
124 struct strbuf git_cmd;
126 if (cmd->no_stdin) {
127 s0 = dup(0);
128 dup_devnull(0);
129 } else if (need_in) {
130 s0 = dup(0);
131 dup2(fdin[0], 0);
132 } else if (cmd->in) {
133 s0 = dup(0);
134 dup2(cmd->in, 0);
137 if (cmd->no_stderr) {
138 s2 = dup(2);
139 dup_devnull(2);
140 } else if (need_err) {
141 s2 = dup(2);
142 dup2(fderr[1], 2);
145 if (cmd->no_stdout) {
146 s1 = dup(1);
147 dup_devnull(1);
148 } else if (cmd->stdout_to_stderr) {
149 s1 = dup(1);
150 dup2(2, 1);
151 } else if (need_out) {
152 s1 = dup(1);
153 dup2(fdout[1], 1);
154 } else if (cmd->out > 1) {
155 s1 = dup(1);
156 dup2(cmd->out, 1);
159 if (cmd->dir)
160 die("chdir in start_command() not implemented");
161 if (cmd->env) {
162 env = copy_environ();
163 for (; *cmd->env; cmd->env++)
164 env = env_setenv(env, *cmd->env);
167 if (cmd->git_cmd) {
168 strbuf_init(&git_cmd, 0);
169 strbuf_addf(&git_cmd, "git-%s", cmd->argv[0]);
170 cmd->argv[0] = git_cmd.buf;
173 cmd->pid = mingw_spawnvpe(cmd->argv[0], cmd->argv, env);
175 if (cmd->env)
176 free_environ(env);
177 if (cmd->git_cmd)
178 strbuf_release(&git_cmd);
180 cmd->argv[0] = sargv0;
181 if (s0 >= 0)
182 dup2(s0, 0), close(s0);
183 if (s1 >= 0)
184 dup2(s1, 1), close(s1);
185 if (s2 >= 0)
186 dup2(s2, 2), close(s2);
187 #endif
189 if (cmd->pid < 0) {
190 if (need_in)
191 close_pair(fdin);
192 else if (cmd->in)
193 close(cmd->in);
194 if (need_out)
195 close_pair(fdout);
196 else if (cmd->out)
197 close(cmd->out);
198 if (need_err)
199 close_pair(fderr);
200 return -ERR_RUN_COMMAND_FORK;
203 if (need_in)
204 close(fdin[0]);
205 else if (cmd->in)
206 close(cmd->in);
208 if (need_out)
209 close(fdout[1]);
210 else if (cmd->out)
211 close(cmd->out);
213 if (need_err)
214 close(fderr[1]);
216 return 0;
219 static int wait_or_whine(pid_t pid)
221 for (;;) {
222 int status, code;
223 pid_t waiting = waitpid(pid, &status, 0);
225 if (waiting < 0) {
226 if (errno == EINTR)
227 continue;
228 error("waitpid failed (%s)", strerror(errno));
229 return -ERR_RUN_COMMAND_WAITPID;
231 if (waiting != pid)
232 return -ERR_RUN_COMMAND_WAITPID_WRONG_PID;
233 if (WIFSIGNALED(status))
234 return -ERR_RUN_COMMAND_WAITPID_SIGNAL;
236 if (!WIFEXITED(status))
237 return -ERR_RUN_COMMAND_WAITPID_NOEXIT;
238 code = WEXITSTATUS(status);
239 if (code)
240 return -code;
241 return 0;
245 int finish_command(struct child_process *cmd)
247 return wait_or_whine(cmd->pid);
250 int run_command(struct child_process *cmd)
252 int code = start_command(cmd);
253 if (code)
254 return code;
255 return finish_command(cmd);
258 static void prepare_run_command_v_opt(struct child_process *cmd,
259 const char **argv,
260 int opt)
262 memset(cmd, 0, sizeof(*cmd));
263 cmd->argv = argv;
264 cmd->no_stdin = opt & RUN_COMMAND_NO_STDIN ? 1 : 0;
265 cmd->git_cmd = opt & RUN_GIT_CMD ? 1 : 0;
266 cmd->stdout_to_stderr = opt & RUN_COMMAND_STDOUT_TO_STDERR ? 1 : 0;
269 int run_command_v_opt(const char **argv, int opt)
271 struct child_process cmd;
272 prepare_run_command_v_opt(&cmd, argv, opt);
273 return run_command(&cmd);
276 int run_command_v_opt_cd(const char **argv, int opt, const char *dir)
278 struct child_process cmd;
279 prepare_run_command_v_opt(&cmd, argv, opt);
280 cmd.dir = dir;
281 return run_command(&cmd);
284 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env)
286 struct child_process cmd;
287 prepare_run_command_v_opt(&cmd, argv, opt);
288 cmd.dir = dir;
289 cmd.env = env;
290 return run_command(&cmd);
293 #ifdef __MINGW32__
294 static __stdcall unsigned run_thread(void *data)
296 struct async *async = data;
297 return async->proc(async->fd_for_proc, async->data);
299 #endif
301 int start_async(struct async *async)
303 int pipe_out[2];
305 if (pipe(pipe_out) < 0)
306 return error("cannot create pipe: %s", strerror(errno));
307 async->out = pipe_out[0];
309 #ifndef __MINGW32__
310 async->pid = fork();
311 if (async->pid < 0) {
312 error("fork (async) failed: %s", strerror(errno));
313 close_pair(pipe_out);
314 return -1;
316 if (!async->pid) {
317 close(pipe_out[0]);
318 exit(!!async->proc(pipe_out[1], async->data));
320 close(pipe_out[1]);
321 #else
322 async->fd_for_proc = pipe_out[1];
323 async->tid = (HANDLE) _beginthreadex(NULL, 0, run_thread, async, 0, NULL);
324 if (!async->tid) {
325 error("cannot create thread: %s", strerror(errno));
326 close_pair(pipe_out);
327 return -1;
329 #endif
330 return 0;
333 int finish_async(struct async *async)
335 #ifndef __MINGW32__
336 int ret = 0;
338 if (wait_or_whine(async->pid))
339 ret = error("waitpid (async) failed");
340 #else
341 DWORD ret = 0;
342 if (WaitForSingleObject(async->tid, INFINITE) != WAIT_OBJECT_0)
343 ret = error("waiting for thread failed: %lu", GetLastError());
344 else if (!GetExitCodeThread(async->tid, &ret))
345 ret = error("cannot get thread exit code: %lu", GetLastError());
346 CloseHandle(async->tid);
347 #endif
348 return ret;