2 * Copyright (c) 2008, 2009 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
29 #include "dynamic-string.h"
30 #include "fatal-signal.h"
32 #include "poll-loop.h"
33 #include "socket-util.h"
36 #define THIS_MODULE VLM_process
44 /* Modified by signal handler. */
49 /* Pipe used to signal child termination. */
53 static struct list all_processes = LIST_INITIALIZER(&all_processes);
55 static bool sigchld_is_blocked(void);
56 static void block_sigchld(sigset_t *);
57 static void unblock_sigchld(const sigset_t *);
58 static void sigchld_handler(int signr UNUSED);
59 static bool is_member(int x, const int *array, size_t);
61 /* Initializes the process subsystem (if it is not already initialized). Calls
62 * exit() if initialization fails.
64 * Calling this function is optional; it will be called automatically by
65 * process_start() if necessary. Calling it explicitly allows the client to
66 * prevent the process from exiting at an unexpected time. */
78 /* Create notification pipe. */
80 ovs_fatal(errno, "could not create pipe");
82 set_nonblocking(fds[0]);
83 set_nonblocking(fds[1]);
85 /* Set up child termination signal handler. */
86 memset(&sa, 0, sizeof sa);
87 sa.sa_handler = sigchld_handler;
88 sigemptyset(&sa.sa_mask);
89 sa.sa_flags = SA_NOCLDSTOP | SA_RESTART;
90 if (sigaction(SIGCHLD, &sa, NULL)) {
91 ovs_fatal(errno, "sigaction(SIGCHLD) failed");
96 process_escape_args(char **argv)
98 struct ds ds = DS_EMPTY_INITIALIZER;
100 for (argp = argv; *argp; argp++) {
101 const char *arg = *argp;
104 ds_put_char(&ds, ' ');
106 if (arg[strcspn(arg, " \t\r\n\v\\")]) {
107 ds_put_char(&ds, '"');
108 for (p = arg; *p; p++) {
109 if (*p == '\\' || *p == '\"') {
110 ds_put_char(&ds, '\\');
112 ds_put_char(&ds, *p);
114 ds_put_char(&ds, '"');
116 ds_put_cstr(&ds, arg);
122 /* Prepare to start a process whose command-line arguments are given by the
123 * null-terminated 'argv' array. Returns 0 if successful, otherwise a
124 * positive errno value. */
126 process_prestart(char **argv)
132 /* Log the process to be started. */
133 if (VLOG_IS_DBG_ENABLED()) {
134 char *args = process_escape_args(argv);
135 VLOG_DBG("starting subprocess: %s", args);
139 /* execvp() will search PATH too, but the error in that case is more
140 * obscure, since it is only reported post-fork. */
141 binary = process_search_path(argv[0]);
143 VLOG_ERR("%s not found in PATH", argv[0]);
151 /* Creates and returns a new struct process with the specified 'name' and
154 * This is racy unless SIGCHLD is blocked (and has been blocked since before
155 * the fork()) that created the subprocess. */
156 static struct process *
157 process_register(const char *name, pid_t pid)
162 assert(sigchld_is_blocked());
164 p = xzalloc(sizeof *p);
166 slash = strrchr(name, '/');
167 p->name = xstrdup(slash ? slash + 1 : name);
170 list_push_back(&all_processes, &p->node);
175 /* Starts a subprocess with the arguments in the null-terminated argv[] array.
176 * argv[0] is used as the name of the process. Searches the PATH environment
177 * variable to find the program to execute.
179 * All file descriptors are closed before executing the subprocess, except for
180 * fds 0, 1, and 2 and the 'n_keep_fds' fds listed in 'keep_fds'. Also, any of
181 * the 'n_null_fds' fds listed in 'null_fds' are replaced by /dev/null.
183 * Returns 0 if successful, otherwise a positive errno value indicating the
184 * error. If successful, '*pp' is assigned a new struct process that may be
185 * used to query the process's status. On failure, '*pp' is set to NULL. */
187 process_start(char **argv,
188 const int keep_fds[], size_t n_keep_fds,
189 const int null_fds[], size_t n_null_fds,
197 COVERAGE_INC(process_start);
198 error = process_prestart(argv);
203 block_sigchld(&oldsigs);
204 fatal_signal_block();
207 fatal_signal_unblock();
208 unblock_sigchld(&oldsigs);
209 VLOG_WARN("fork failed: %s", strerror(errno));
212 /* Running in parent process. */
213 *pp = process_register(argv[0], pid);
214 fatal_signal_unblock();
215 unblock_sigchld(&oldsigs);
218 /* Running in child process. */
219 int fd_max = get_max_fds();
223 fatal_signal_unblock();
224 unblock_sigchld(&oldsigs);
225 for (fd = 0; fd < fd_max; fd++) {
226 if (is_member(fd, null_fds, n_null_fds)) {
227 /* We can't use get_null_fd() here because we might have
228 * already closed its fd. */
229 int nullfd = open("/dev/null", O_RDWR);
232 } else if (fd >= 3 && !is_member(fd, keep_fds, n_keep_fds)) {
236 execvp(argv[0], argv);
237 fprintf(stderr, "execvp(\"%s\") failed: %s\n",
238 argv[0], strerror(errno));
243 /* Destroys process 'p'. */
245 process_destroy(struct process *p)
250 block_sigchld(&oldsigs);
251 list_remove(&p->node);
252 unblock_sigchld(&oldsigs);
259 /* Sends signal 'signr' to process 'p'. Returns 0 if successful, otherwise a
260 * positive errno value. */
262 process_kill(const struct process *p, int signr)
264 return (p->exited ? ESRCH
265 : !kill(p->pid, signr) ? 0
269 /* Returns the pid of process 'p'. */
271 process_pid(const struct process *p)
276 /* Returns the name of process 'p' (the name passed to process_start() with any
277 * leading directories stripped). */
279 process_name(const struct process *p)
284 /* Returns true if process 'p' has exited, false otherwise. */
286 process_exited(struct process *p)
291 char buf[_POSIX_PIPE_BUF];
292 ignore(read(fds[0], buf, sizeof buf));
297 /* Returns process 'p''s exit status, as reported by waitpid(2).
298 * process_status(p) may be called only after process_exited(p) has returned
301 process_status(const struct process *p)
308 process_run(char **argv,
309 const int keep_fds[], size_t n_keep_fds,
310 const int null_fds[], size_t n_null_fds,
316 COVERAGE_INC(process_run);
317 retval = process_start(argv, keep_fds, n_keep_fds, null_fds, n_null_fds,
324 while (!process_exited(p)) {
328 *status = process_status(p);
333 /* Given 'status', which is a process status in the form reported by waitpid(2)
334 * and returned by process_status(), returns a string describing how the
335 * process terminated. The caller is responsible for freeing the string when
336 * it is no longer needed. */
338 process_status_msg(int status)
340 struct ds ds = DS_EMPTY_INITIALIZER;
341 if (WIFEXITED(status)) {
342 ds_put_format(&ds, "exit status %d", WEXITSTATUS(status));
343 } else if (WIFSIGNALED(status) || WIFSTOPPED(status)) {
344 int signr = WIFSIGNALED(status) ? WTERMSIG(status) : WSTOPSIG(status);
345 const char *name = NULL;
346 #ifdef HAVE_STRSIGNAL
347 name = strsignal(signr);
349 ds_put_format(&ds, "%s by signal %d",
350 WIFSIGNALED(status) ? "killed" : "stopped", signr);
352 ds_put_format(&ds, " (%s)", name);
355 ds_put_format(&ds, "terminated abnormally (%x)", status);
357 if (WCOREDUMP(status)) {
358 ds_put_cstr(&ds, ", core dumped");
363 /* Causes the next call to poll_block() to wake up when process 'p' has
366 process_wait(struct process *p)
369 poll_immediate_wake();
371 poll_fd_wait(fds[0], POLLIN);
376 process_search_path(const char *name)
378 char *save_ptr = NULL;
382 if (strchr(name, '/') || !getenv("PATH")) {
383 return stat(name, &s) == 0 ? xstrdup(name) : NULL;
386 path = xstrdup(getenv("PATH"));
387 for (dir = strtok_r(path, ":", &save_ptr); dir;
388 dir = strtok_r(NULL, ":", &save_ptr)) {
389 char *file = xasprintf("%s/%s", dir, name);
390 if (stat(file, &s) == 0) {
400 /* process_run_capture() and supporting functions. */
408 stream_open(struct stream *s)
412 VLOG_WARN("failed to create pipe: %s", strerror(errno));
415 set_nonblocking(s->fds[0]);
420 stream_read(struct stream *s)
433 error = read_fully(s->fds[0], buffer, sizeof buffer, &n);
434 ds_put_buffer(&s->log, buffer, n);
436 if (error == EAGAIN || error == EWOULDBLOCK) {
440 VLOG_WARN("error reading subprocess pipe: %s",
445 } else if (s->log.length > PROCESS_MAX_CAPTURE) {
446 VLOG_WARN("subprocess output overflowed %d-byte buffer",
447 PROCESS_MAX_CAPTURE);
456 stream_wait(struct stream *s)
458 if (s->fds[0] >= 0) {
459 poll_fd_wait(s->fds[0], POLLIN);
464 stream_close(struct stream *s)
467 if (s->fds[0] >= 0) {
470 if (s->fds[1] >= 0) {
475 /* Starts the process whose arguments are given in the null-terminated array
476 * 'argv' and waits for it to exit. On success returns 0 and stores the
477 * process exit value (suitable for passing to process_status_msg()) in
478 * '*status'. On failure, returns a positive errno value and stores 0 in
481 * If 'stdout_log' is nonnull, then the subprocess's output to stdout (up to a
482 * limit of PROCESS_MAX_CAPTURE bytes) is captured in a memory buffer, which
483 * when this function returns 0 is stored as a null-terminated string in
484 * '*stdout_log'. The caller is responsible for freeing '*stdout_log' (by
485 * passing it to free()). When this function returns an error, '*stdout_log'
488 * If 'stderr_log' is nonnull, then it is treated like 'stdout_log' except
489 * that it captures the subprocess's output to stderr. */
491 process_run_capture(char **argv, char **stdout_log, char **stderr_log,
494 struct stream s_stdout, s_stderr;
499 COVERAGE_INC(process_run_capture);
507 error = process_prestart(argv);
512 error = stream_open(&s_stdout);
517 error = stream_open(&s_stderr);
519 stream_close(&s_stdout);
523 block_sigchld(&oldsigs);
524 fatal_signal_block();
529 fatal_signal_unblock();
530 unblock_sigchld(&oldsigs);
531 VLOG_WARN("fork failed: %s", strerror(error));
533 stream_close(&s_stdout);
534 stream_close(&s_stderr);
538 /* Running in parent process. */
541 p = process_register(argv[0], pid);
542 fatal_signal_unblock();
543 unblock_sigchld(&oldsigs);
545 close(s_stdout.fds[1]);
546 close(s_stderr.fds[1]);
547 while (!process_exited(p)) {
548 stream_read(&s_stdout);
549 stream_read(&s_stderr);
551 stream_wait(&s_stdout);
552 stream_wait(&s_stderr);
556 stream_read(&s_stdout);
557 stream_read(&s_stderr);
560 *stdout_log = ds_steal_cstr(&s_stdout.log);
563 *stderr_log = ds_steal_cstr(&s_stderr.log);
566 stream_close(&s_stdout);
567 stream_close(&s_stderr);
569 *status = process_status(p);
573 /* Running in child process. */
578 fatal_signal_unblock();
579 unblock_sigchld(&oldsigs);
581 dup2(get_null_fd(), 0);
582 dup2(s_stdout.fds[1], 1);
583 dup2(s_stderr.fds[1], 2);
585 max_fds = get_max_fds();
586 for (i = 3; i < max_fds; i++) {
590 execvp(argv[0], argv);
591 fprintf(stderr, "execvp(\"%s\") failed: %s\n",
592 argv[0], strerror(errno));
598 sigchld_handler(int signr UNUSED)
602 COVERAGE_INC(process_sigchld);
603 LIST_FOR_EACH (p, struct process, node, &all_processes) {
607 retval = waitpid(p->pid, &status, WNOHANG);
608 } while (retval == -1 && errno == EINTR);
609 if (retval == p->pid) {
612 } else if (retval < 0) {
613 /* XXX We want to log something but we're in a signal
620 ignore(write(fds[1], "", 1));
624 is_member(int x, const int *array, size_t n)
628 for (i = 0; i < n; i++) {
637 sigchld_is_blocked(void)
640 if (sigprocmask(SIG_SETMASK, NULL, &sigs)) {
641 ovs_fatal(errno, "sigprocmask");
643 return sigismember(&sigs, SIGCHLD);
647 block_sigchld(sigset_t *oldsigs)
650 sigemptyset(&sigchld);
651 sigaddset(&sigchld, SIGCHLD);
652 if (sigprocmask(SIG_BLOCK, &sigchld, oldsigs)) {
653 ovs_fatal(errno, "sigprocmask");
658 unblock_sigchld(const sigset_t *oldsigs)
660 if (sigprocmask(SIG_SETMASK, oldsigs, NULL)) {
661 ovs_fatal(errno, "sigprocmask");