]>
git.proxmox.com Git - ovs.git/blob - lib/process.c
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 "poll-loop.h"
33 #include "socket-util.h"
37 VLOG_DEFINE_THIS_MODULE(process
);
39 COVERAGE_DEFINE(process_sigchld
);
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 * Calling this function is optional; it will be called automatically by
64 * process_start() if necessary. Calling it explicitly allows the client to
65 * prevent the process from exiting at an unexpected time. */
77 /* Create notification pipe. */
78 xpipe_nonblocking(fds
);
80 /* Set up child termination signal handler. */
81 memset(&sa
, 0, sizeof sa
);
82 sa
.sa_handler
= sigchld_handler
;
83 sigemptyset(&sa
.sa_mask
);
84 sa
.sa_flags
= SA_NOCLDSTOP
| SA_RESTART
;
85 xsigaction(SIGCHLD
, &sa
, NULL
);
89 process_escape_args(char **argv
)
91 struct ds ds
= DS_EMPTY_INITIALIZER
;
93 for (argp
= argv
; *argp
; argp
++) {
94 const char *arg
= *argp
;
97 ds_put_char(&ds
, ' ');
99 if (arg
[strcspn(arg
, " \t\r\n\v\\\'\"")]) {
100 ds_put_char(&ds
, '"');
101 for (p
= arg
; *p
; p
++) {
102 if (*p
== '\\' || *p
== '\"') {
103 ds_put_char(&ds
, '\\');
105 ds_put_char(&ds
, *p
);
107 ds_put_char(&ds
, '"');
109 ds_put_cstr(&ds
, arg
);
115 /* Prepare to start a process whose command-line arguments are given by the
116 * null-terminated 'argv' array. Returns 0 if successful, otherwise a
117 * positive errno value. */
119 process_prestart(char **argv
)
125 /* Log the process to be started. */
126 if (VLOG_IS_DBG_ENABLED()) {
127 char *args
= process_escape_args(argv
);
128 VLOG_DBG("starting subprocess: %s", args
);
132 /* execvp() will search PATH too, but the error in that case is more
133 * obscure, since it is only reported post-fork. */
134 binary
= process_search_path(argv
[0]);
136 VLOG_ERR("%s not found in PATH", argv
[0]);
144 /* Creates and returns a new struct process with the specified 'name' and
146 static struct process
*
147 process_register(const char *name
, pid_t pid
)
152 p
= xzalloc(sizeof *p
);
154 slash
= strrchr(name
, '/');
155 p
->name
= xstrdup(slash
? slash
+ 1 : name
);
158 list_push_back(&all_processes
, &p
->node
);
163 /* Starts a subprocess with the arguments in the null-terminated argv[] array.
164 * argv[0] is used as the name of the process. Searches the PATH environment
165 * variable to find the program to execute.
167 * All file descriptors are closed before executing the subprocess, except for
170 * Returns 0 if successful, otherwise a positive errno value indicating the
171 * error. If successful, '*pp' is assigned a new struct process that may be
172 * used to query the process's status. On failure, '*pp' is set to NULL. */
174 process_start(char **argv
, struct process
**pp
)
180 COVERAGE_INC(process_start
);
181 error
= process_prestart(argv
);
188 VLOG_WARN("fork failed: %s", strerror(errno
));
191 /* Running in parent process. */
192 *pp
= process_register(argv
[0], pid
);
195 /* Running in child process. */
196 int fd_max
= get_max_fds();
200 for (fd
= 3; fd
< fd_max
; fd
++) {
203 execvp(argv
[0], argv
);
204 fprintf(stderr
, "execvp(\"%s\") failed: %s\n",
205 argv
[0], strerror(errno
));
210 /* Destroys process 'p'. */
212 process_destroy(struct process
*p
)
215 list_remove(&p
->node
);
221 /* Sends signal 'signr' to process 'p'. Returns 0 if successful, otherwise a
222 * positive errno value. */
224 process_kill(const struct process
*p
, int signr
)
226 return (p
->exited
? ESRCH
227 : !kill(p
->pid
, signr
) ? 0
231 /* Returns the pid of process 'p'. */
233 process_pid(const struct process
*p
)
238 /* Returns the name of process 'p' (the name passed to process_start() with any
239 * leading directories stripped). */
241 process_name(const struct process
*p
)
246 /* Returns true if process 'p' has exited, false otherwise. */
248 process_exited(struct process
*p
)
253 /* Returns process 'p''s exit status, as reported by waitpid(2).
254 * process_status(p) may be called only after process_exited(p) has returned
257 process_status(const struct process
*p
)
259 ovs_assert(p
->exited
);
263 /* Given 'status', which is a process status in the form reported by waitpid(2)
264 * and returned by process_status(), returns a string describing how the
265 * process terminated. The caller is responsible for freeing the string when
266 * it is no longer needed. */
268 process_status_msg(int status
)
270 struct ds ds
= DS_EMPTY_INITIALIZER
;
271 if (WIFEXITED(status
)) {
272 ds_put_format(&ds
, "exit status %d", WEXITSTATUS(status
));
273 } else if (WIFSIGNALED(status
)) {
274 char namebuf
[SIGNAL_NAME_BUFSIZE
];
276 ds_put_format(&ds
, "killed (%s)",
277 signal_name(WTERMSIG(status
), namebuf
, sizeof namebuf
));
278 } else if (WIFSTOPPED(status
)) {
279 char namebuf
[SIGNAL_NAME_BUFSIZE
];
281 ds_put_format(&ds
, "stopped (%s)",
282 signal_name(WSTOPSIG(status
), namebuf
, sizeof namebuf
));
284 ds_put_format(&ds
, "terminated abnormally (%x)", status
);
286 if (WCOREDUMP(status
)) {
287 ds_put_cstr(&ds
, ", core dumped");
292 /* Executes periodic maintenance activities required by the process module. */
296 char buf
[_POSIX_PIPE_BUF
];
298 if (!list_is_empty(&all_processes
) && read(fds
[0], buf
, sizeof buf
) > 0) {
301 LIST_FOR_EACH (p
, node
, &all_processes
) {
305 retval
= waitpid(p
->pid
, &status
, WNOHANG
);
306 } while (retval
== -1 && errno
== EINTR
);
307 if (retval
== p
->pid
) {
310 } else if (retval
< 0) {
311 VLOG_WARN("waitpid: %s", strerror(errno
));
321 /* Causes the next call to poll_block() to wake up when process 'p' has
324 process_wait(struct process
*p
)
327 poll_immediate_wake();
329 poll_fd_wait(fds
[0], POLLIN
);
334 process_search_path(const char *name
)
336 char *save_ptr
= NULL
;
340 if (strchr(name
, '/') || !getenv("PATH")) {
341 return stat(name
, &s
) == 0 ? xstrdup(name
) : NULL
;
344 path
= xstrdup(getenv("PATH"));
345 for (dir
= strtok_r(path
, ":", &save_ptr
); dir
;
346 dir
= strtok_r(NULL
, ":", &save_ptr
)) {
347 char *file
= xasprintf("%s/%s", dir
, name
);
348 if (stat(file
, &s
) == 0) {
359 sigchld_handler(int signr OVS_UNUSED
)
361 ignore(write(fds
[1], "", 1));