2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
28 #include "dynamic-string.h"
29 #include "fatal-signal.h"
31 #include "ovs-thread.h"
32 #include "poll-loop.h"
34 #include "socket-util.h"
38 VLOG_DEFINE_THIS_MODULE(process);
40 COVERAGE_DEFINE(process_start);
52 /* Pipe used to signal child termination. */
56 static struct list all_processes = LIST_INITIALIZER(&all_processes);
58 static void sigchld_handler(int signr OVS_UNUSED);
60 /* Initializes the process subsystem (if it is not already initialized). Calls
61 * exit() if initialization fails.
63 * This function may not be called after creating any additional threads.
65 * Calling this function is optional; it will be called automatically by
66 * process_start() if necessary. Calling it explicitly allows the client to
67 * prevent the process from exiting at an unexpected time. */
75 assert_single_threaded();
81 /* Create notification pipe. */
82 xpipe_nonblocking(fds);
84 /* Set up child termination signal handler. */
85 memset(&sa, 0, sizeof sa);
86 sa.sa_handler = sigchld_handler;
87 sigemptyset(&sa.sa_mask);
88 sa.sa_flags = SA_NOCLDSTOP | SA_RESTART;
89 xsigaction(SIGCHLD, &sa, NULL);
94 process_escape_args(char **argv)
96 struct ds ds = DS_EMPTY_INITIALIZER;
98 for (argp = argv; *argp; argp++) {
99 const char *arg = *argp;
102 ds_put_char(&ds, ' ');
104 if (arg[strcspn(arg, " \t\r\n\v\\\'\"")]) {
105 ds_put_char(&ds, '"');
106 for (p = arg; *p; p++) {
107 if (*p == '\\' || *p == '\"') {
108 ds_put_char(&ds, '\\');
110 ds_put_char(&ds, *p);
112 ds_put_char(&ds, '"');
114 ds_put_cstr(&ds, arg);
120 /* Prepare to start a process whose command-line arguments are given by the
121 * null-terminated 'argv' array. Returns 0 if successful, otherwise a
122 * positive errno value. */
124 process_prestart(char **argv)
130 /* Log the process to be started. */
131 if (VLOG_IS_DBG_ENABLED()) {
132 char *args = process_escape_args(argv);
133 VLOG_DBG("starting subprocess: %s", args);
137 /* execvp() will search PATH too, but the error in that case is more
138 * obscure, since it is only reported post-fork. */
139 binary = process_search_path(argv[0]);
141 VLOG_ERR("%s not found in PATH", argv[0]);
149 /* Creates and returns a new struct process with the specified 'name' and
151 static struct process *
152 process_register(const char *name, pid_t pid)
157 p = xzalloc(sizeof *p);
159 slash = strrchr(name, '/');
160 p->name = xstrdup(slash ? slash + 1 : name);
163 list_push_back(&all_processes, &p->node);
170 rlim_is_finite(rlim_t limit)
172 if (limit == RLIM_INFINITY) {
176 #ifdef RLIM_SAVED_CUR /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
177 if (limit == RLIM_SAVED_CUR) {
182 #ifdef RLIM_SAVED_MAX /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
183 if (limit == RLIM_SAVED_MAX) {
191 /* Returns the maximum valid FD value, plus 1. */
199 if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
200 max_fds = r.rlim_cur;
202 VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
211 /* Starts a subprocess with the arguments in the null-terminated argv[] array.
212 * argv[0] is used as the name of the process. Searches the PATH environment
213 * variable to find the program to execute.
215 * This function may not be called after creating any additional threads.
217 * All file descriptors are closed before executing the subprocess, except for
220 * Returns 0 if successful, otherwise a positive errno value indicating the
221 * error. If successful, '*pp' is assigned a new struct process that may be
222 * used to query the process's status. On failure, '*pp' is set to NULL. */
224 process_start(char **argv, struct process **pp)
230 assert_single_threaded();
233 COVERAGE_INC(process_start);
234 error = process_prestart(argv);
241 VLOG_WARN("fork failed: %s", ovs_strerror(errno));
244 /* Running in parent process. */
245 *pp = process_register(argv[0], pid);
248 /* Running in child process. */
249 int fd_max = get_max_fds();
253 for (fd = 3; fd < fd_max; fd++) {
256 execvp(argv[0], argv);
257 fprintf(stderr, "execvp(\"%s\") failed: %s\n",
258 argv[0], ovs_strerror(errno));
267 /* Destroys process 'p'. */
269 process_destroy(struct process *p)
272 list_remove(&p->node);
278 /* Sends signal 'signr' to process 'p'. Returns 0 if successful, otherwise a
279 * positive errno value. */
281 process_kill(const struct process *p, int signr)
284 return (p->exited ? ESRCH
285 : !kill(p->pid, signr) ? 0
292 /* Returns the pid of process 'p'. */
294 process_pid(const struct process *p)
299 /* Returns the name of process 'p' (the name passed to process_start() with any
300 * leading directories stripped). */
302 process_name(const struct process *p)
307 /* Returns true if process 'p' has exited, false otherwise. */
309 process_exited(struct process *p)
314 /* Returns process 'p''s exit status, as reported by waitpid(2).
315 * process_status(p) may be called only after process_exited(p) has returned
318 process_status(const struct process *p)
320 ovs_assert(p->exited);
324 /* Given 'status', which is a process status in the form reported by waitpid(2)
325 * and returned by process_status(), returns a string describing how the
326 * process terminated. The caller is responsible for freeing the string when
327 * it is no longer needed. */
329 process_status_msg(int status)
331 struct ds ds = DS_EMPTY_INITIALIZER;
333 if (WIFEXITED(status)) {
334 ds_put_format(&ds, "exit status %d", WEXITSTATUS(status));
335 } else if (WIFSIGNALED(status)) {
336 char namebuf[SIGNAL_NAME_BUFSIZE];
338 ds_put_format(&ds, "killed (%s)",
339 signal_name(WTERMSIG(status), namebuf, sizeof namebuf));
340 } else if (WIFSTOPPED(status)) {
341 char namebuf[SIGNAL_NAME_BUFSIZE];
343 ds_put_format(&ds, "stopped (%s)",
344 signal_name(WSTOPSIG(status), namebuf, sizeof namebuf));
346 ds_put_format(&ds, "terminated abnormally (%x)", status);
348 if (WCOREDUMP(status)) {
349 ds_put_cstr(&ds, ", core dumped");
352 ds_put_cstr(&ds, "function not supported.");
357 /* Executes periodic maintenance activities required by the process module. */
362 char buf[_POSIX_PIPE_BUF];
364 if (!list_is_empty(&all_processes) && read(fds[0], buf, sizeof buf) > 0) {
367 LIST_FOR_EACH (p, node, &all_processes) {
371 retval = waitpid(p->pid, &status, WNOHANG);
372 } while (retval == -1 && errno == EINTR);
373 if (retval == p->pid) {
376 } else if (retval < 0) {
377 VLOG_WARN("waitpid: %s", ovs_strerror(errno));
388 /* Causes the next call to poll_block() to wake up when process 'p' has
391 process_wait(struct process *p)
395 poll_immediate_wake();
397 poll_fd_wait(fds[0], POLLIN);
405 process_search_path(const char *name)
407 char *save_ptr = NULL;
411 if (strchr(name, '/') || !getenv("PATH")) {
412 return stat(name, &s) == 0 ? xstrdup(name) : NULL;
415 path = xstrdup(getenv("PATH"));
416 for (dir = strtok_r(path, ":", &save_ptr); dir;
417 dir = strtok_r(NULL, ":", &save_ptr)) {
418 char *file = xasprintf("%s/%s", dir, name);
419 if (stat(file, &s) == 0) {
430 sigchld_handler(int signr OVS_UNUSED)
432 ignore(write(fds[1], "", 1));