2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; version 2 of the License.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 * GNU General Public License for more details.
11 * You should have received a copy of the GNU General Public License
12 * along with this program; if not, write to the Free Software
13 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <process/process.h>
23 #include <talloc/talloc.h>
24 #include <waiter/waiter.h>
28 struct waitset *waitset;
29 struct list async_list;
31 struct waiter *sigchld_waiter;
35 /* Internal data type for process handling
37 * Allocation: these structures may have multiple references:
38 * - from the original ctx pointer
39 * - due to inclusion in async_list
40 * - due to a currently-registered waiter
45 /* prevent talloc_free(process) from working */
48 struct process process;
49 struct list_item async_list;
51 struct waiter *stdout_waiter;
56 static struct procset *procset;
58 static struct process_info *get_info(struct process *process)
60 return container_of(process, struct process_info, process);
63 struct process *procinfo_get_process(struct process_info *procinfo)
65 return &procinfo->process;
68 /* Read as much as possible into the currently-allocated stdout buffer, and
69 * possibly realloc it for the next read
70 * If the line pointer is not NULL, it is set to the start of the latest
74 * > 0 on success (even though no bytes may have been read)
75 * 0 on EOF (no error, but no more reads can be performed)
78 static int process_read_stdout_once(struct process_info *procinfo, char **line)
80 struct process *process = &procinfo->process;
83 assert(process->keep_stdout);
85 fd = procinfo->stdout_pipe[0];
87 max_len = procinfo->stdout_buf_len - process->stdout_len - 1;
89 rc = read(fd, process->stdout_buf + process->stdout_len, max_len);
95 pb_log("%s: read failed: %s\n", __func__, strerror(errno));
100 *line = process->stdout_buf + process->stdout_len;
102 process->stdout_len += rc;
103 if (process->stdout_len == procinfo->stdout_buf_len - 1) {
104 procinfo->stdout_buf_len *= 2;
105 process->stdout_buf = talloc_realloc(procinfo,
106 process->stdout_buf, char,
107 procinfo->stdout_buf_len);
113 static int process_setup_stdout_pipe(struct process_info *procinfo)
117 if (!procinfo->process.keep_stdout)
120 procinfo->stdout_buf_len = 4096;
121 procinfo->process.stdout_len = 0;
122 procinfo->process.stdout_buf = talloc_array(procinfo, char,
123 procinfo->stdout_buf_len);
125 rc = pipe(procinfo->stdout_pipe);
127 pb_log("pipe failed");
133 static void process_setup_stdout_parent(struct process_info *procinfo)
135 if (!procinfo->process.keep_stdout)
138 close(procinfo->stdout_pipe[1]);
141 static void process_setup_stdout_child(struct process_info *procinfo)
143 int log = fileno(pb_log_get_stream());
145 if (procinfo->process.keep_stdout)
146 dup2(procinfo->stdout_pipe[1], STDOUT_FILENO);
148 dup2(log, STDOUT_FILENO);
150 if (procinfo->process.keep_stdout && procinfo->process.add_stderr)
151 dup2(procinfo->stdout_pipe[1], STDERR_FILENO);
153 dup2(log, STDERR_FILENO);
156 static void process_finish_stdout(struct process_info *procinfo)
158 close(procinfo->stdout_pipe[0]);
159 procinfo->process.stdout_buf[procinfo->process.stdout_len] = '\0';
162 static int process_read_stdout(struct process_info *procinfo)
166 if (!procinfo->process.keep_stdout)
170 rc = process_read_stdout_once(procinfo, NULL);
173 process_finish_stdout(procinfo);
175 return rc < 0 ? rc : 0;
178 static int process_stdout_cb(void *arg)
180 struct process_info *procinfo = arg;
183 rc = process_read_stdout_once(procinfo, NULL);
185 /* if we're going to signal to the waitset that we're done (ie, non-zero
186 * return value), then the waiters will remove us, so we drop the
189 talloc_unlink(procset, procinfo);
190 procinfo->stdout_waiter = NULL;
199 int process_stdout_custom(struct process_info *procinfo, char **line)
203 rc = process_read_stdout_once(procinfo, line);
205 /* if we're going to signal to the waitset that we're done (ie, non-zero
206 * return value), then the waiters will remove us, so we drop the
209 talloc_unlink(procset, procinfo);
210 procinfo->stdout_waiter = NULL;
219 static void sigchld_sigaction(int signo, siginfo_t *info,
220 void *arg __attribute__((unused)))
225 if (signo != SIGCHLD)
230 rc = write(procset->sigchld_pipe[1], &pid, sizeof(pid));
231 if (rc != sizeof(pid))
232 pb_log("%s: write failed: %s\n", __func__, strerror(errno));
235 static int sigchld_pipe_event(void *arg)
237 struct process_info *procinfo;
238 struct procset *procset = arg;
239 struct process *process;
242 rc = read(procset->sigchld_pipe[0], &pid, sizeof(pid));
243 if (rc != sizeof(pid))
247 list_for_each_entry(&procset->async_list, procinfo, async_list) {
248 if (procinfo->process.pid == pid) {
249 process = &procinfo->process;
254 /* We'll receive SIGCHLD for synchronous processes too; just ignore */
258 rc = waitpid(process->pid, &process->exit_status, WNOHANG);
260 /* if the process is still running, ignore the event. We leave
261 * the process in async_list so we can manage the final signal */
265 /* ensure we have all of the child's stdout */
266 process_read_stdout(procinfo);
268 if (process->exit_cb)
269 process->exit_cb(process);
271 list_remove(&procinfo->async_list);
272 talloc_unlink(procset, procinfo);
277 static int process_fini(void *p)
279 struct procset *procset = p;
282 memset(&sa, 0, sizeof(sa));
283 sa.sa_handler = SIG_DFL;
285 sigaction(SIGCHLD, &sa, NULL);
287 waiter_remove(procset->sigchld_waiter);
289 close(procset->sigchld_pipe[0]);
290 close(procset->sigchld_pipe[1]);
294 struct procset *process_init(void *ctx, struct waitset *set, bool dry_run)
299 procset = talloc(ctx, struct procset);
300 procset->waitset = set;
301 procset->dry_run = dry_run;
302 list_init(&procset->async_list);
304 rc = pipe(procset->sigchld_pipe);
306 pb_log("%s: pipe() failed: %s\n", __func__, strerror(errno));
310 procset->sigchld_waiter = waiter_register_io(set,
311 procset->sigchld_pipe[0], WAIT_IN,
312 sigchld_pipe_event, procset);
313 if (!procset->sigchld_waiter)
316 memset(&sa, 0, sizeof(sa));
317 sa.sa_sigaction = sigchld_sigaction;
318 sa.sa_flags = SA_SIGINFO | SA_NOCLDSTOP;
320 rc = sigaction(SIGCHLD, &sa, NULL);
322 pb_log("%s: sigaction() failed: %s\n", __func__,
327 talloc_set_destructor(procset, process_fini);
332 waiter_remove(procset->sigchld_waiter);
334 close(procset->sigchld_pipe[0]);
335 close(procset->sigchld_pipe[1]);
337 talloc_free(procset);
341 struct process *process_create(void *ctx)
343 struct process_info *info = talloc_zero(ctx, struct process_info);
344 info->orig_ctx = ctx;
345 return &info->process;
348 void process_release(struct process *process)
350 struct process_info *info = get_info(process);
351 talloc_unlink(info->orig_ctx, info);
354 static int process_run_common(struct process_info *procinfo)
356 struct process *process = &procinfo->process;
362 logmsg = talloc_asprintf(procinfo, " exe: %s\n argv:", process->path);
363 for (i = 0, arg = process->argv[i]; arg; i++, arg = process->argv[i])
364 logmsg = talloc_asprintf_append(logmsg, " '%s'", arg);
366 pb_log("Running command:\n%s\n", logmsg);
368 rc = process_setup_stdout_pipe(procinfo);
374 pb_log("%s: fork failed: %s\n", __func__, strerror(errno));
379 process_setup_stdout_child(procinfo);
380 if (procset->dry_run)
382 execvp(process->path, (char * const *)process->argv);
386 process_setup_stdout_parent(procinfo);
392 int process_run_sync(struct process *process)
394 struct process_info *procinfo = get_info(process);
397 rc = process_run_common(procinfo);
401 process_read_stdout(procinfo);
404 rc = waitpid(process->pid, &process->exit_status, 0);
410 pb_log("%s: waitpid failed: %s\n", __func__, strerror(errno));
417 int process_run_async(struct process *process)
419 struct process_info *procinfo = get_info(process);
423 rc = process_run_common(procinfo);
427 if (process->keep_stdout) {
428 stdout_cb = process->stdout_cb ?: process_stdout_cb;
429 procinfo->stdout_waiter = waiter_register_io(procset->waitset,
430 procinfo->stdout_pipe[0],
431 WAIT_IN, stdout_cb, procinfo);
432 talloc_reference(procset, procinfo);
435 list_add(&procset->async_list, &procinfo->async_list);
436 talloc_reference(procset, procinfo);
441 void process_stop_async(struct process *process)
443 pb_debug("process: sending SIGTERM to pid %d\n", process->pid);
444 kill(process->pid, SIGTERM);
447 int process_run_simple_argv(void *ctx, const char *argv[])
449 struct process *process;
452 process = process_create(ctx);
454 process->path = argv[0];
455 process->argv = argv;
457 rc = process_run_sync(process);
460 rc = process->exit_status;
462 process_release(process);
467 int process_run_simple(void *ctx, const char *name, ...)
469 int rc, i, n_argv = 1;
474 while (va_arg(ap, char *))
478 argv = talloc_array(ctx, const char *, n_argv + 1);
482 for (i = 1; i < n_argv; i++)
483 argv[i] = va_arg(ap, const char *);
488 rc = process_run_simple_argv(ctx, argv);
495 bool process_exit_ok(struct process *process)
497 return WIFEXITED(process->exit_status) &&
498 WEXITSTATUS(process->exit_status) == 0;