]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/daemon.c
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.
24 #include "fatal-signal.h"
30 #define THIS_MODULE VLM_daemon
33 /* Should we run in the background? */
36 /* Name of pidfile (null if none). */
39 /* Create pidfile even if one already exists and is locked? */
40 static bool overwrite_pidfile
;
42 /* Should we chdir to "/". */
43 static bool chdir_
= true;
45 /* Returns the file name that would be used for a pidfile if 'name' were
46 * provided to set_pidfile(). The caller must free the returned string. */
48 make_pidfile_name(const char *name
)
50 return (!name
? xasprintf("%s/%s.pid", ovs_rundir
, program_name
)
51 : *name
== '/' ? xstrdup(name
)
52 : xasprintf("%s/%s", ovs_rundir
, name
));
55 /* Sets up a following call to daemonize() to create a pidfile named 'name'.
56 * If 'name' begins with '/', then it is treated as an absolute path.
57 * Otherwise, it is taken relative to RUNDIR, which is $(prefix)/var/run by
60 * If 'name' is null, then program_name followed by ".pid" is used. */
62 set_pidfile(const char *name
)
65 pidfile
= make_pidfile_name(name
);
68 /* Returns an absolute path to the configured pidfile, or a null pointer if no
69 * pidfile is configured. The caller must not modify or free the returned
77 /* Sets that we do not chdir to "/". */
84 /* Will we chdir to "/" as part of daemonizing? */
86 is_chdir_enabled(void)
91 /* Normally, die_if_already_running() will terminate the program with a message
92 * if a locked pidfile already exists. If this function is called,
93 * die_if_already_running() will merely log a warning. */
95 ignore_existing_pidfile(void)
97 overwrite_pidfile
= true;
100 /* Sets up a following call to daemonize() to detach from the foreground
101 * session, running this process in the background. */
108 /* Will daemonize() really detach? */
115 /* If a pidfile has been configured and that pidfile already exists and is
116 * locked by a running process, returns the pid of the running process.
117 * Otherwise, returns 0. */
119 already_running(void)
123 int fd
= open(pidfile
, O_RDWR
);
126 lck
.l_type
= F_WRLCK
;
127 lck
.l_whence
= SEEK_SET
;
130 if (fcntl(fd
, F_GETLK
, &lck
) != -1 && lck
.l_type
!= F_UNLCK
) {
139 /* If a locked pidfile exists, issue a warning message and, unless
140 * ignore_existing_pidfile() has been called, terminate the program. */
142 die_if_already_running(void)
144 pid_t pid
= already_running();
146 if (!overwrite_pidfile
) {
147 ovs_fatal(0, "%s: already running as pid %ld",
148 get_pidfile(), (long int) pid
);
150 VLOG_WARN("%s: %s already running as pid %ld",
151 get_pidfile(), program_name
, (long int) pid
);
156 /* If a pidfile has been configured, creates it and stores the running process'
157 * pid init. Ensures that the pidfile will be deleted when the process
163 /* Create pidfile via temporary file, so that observers never see an
164 * empty pidfile or an unlocked pidfile. */
165 long int pid
= getpid();
169 tmpfile
= xasprintf("%s.tmp%ld", pidfile
, pid
);
170 fatal_signal_add_file_to_unlink(tmpfile
);
171 fd
= open(tmpfile
, O_CREAT
| O_WRONLY
| O_TRUNC
, 0666);
174 lck
.l_type
= F_WRLCK
;
175 lck
.l_whence
= SEEK_SET
;
178 if (fcntl(fd
, F_SETLK
, &lck
) != -1) {
179 char *text
= xasprintf("%ld\n", pid
);
180 if (write(fd
, text
, strlen(text
)) == strlen(text
)) {
181 fatal_signal_add_file_to_unlink(pidfile
);
182 if (rename(tmpfile
, pidfile
) < 0) {
183 VLOG_ERR("failed to rename \"%s\" to \"%s\": %s",
184 tmpfile
, pidfile
, strerror(errno
));
185 fatal_signal_remove_file_to_unlink(pidfile
);
188 /* Keep 'fd' open to retain the lock. */
192 VLOG_ERR("%s: write failed: %s", tmpfile
, strerror(errno
));
196 VLOG_ERR("%s: fcntl failed: %s", tmpfile
, strerror(errno
));
200 VLOG_ERR("%s: create failed: %s", tmpfile
, strerror(errno
));
202 fatal_signal_remove_file_to_unlink(tmpfile
);
209 /* If configured with set_pidfile() or set_detach(), creates the pid file and
210 * detaches from the foreground session. */
218 ovs_fatal(errno
, "pipe failed");
223 /* Parent process: wait for child to create pidfile, then exit. */
226 if (read(fds
[0], &c
, 1) != 1) {
227 ovs_fatal(errno
, "daemon child failed to signal startup");
235 write(fds
[1], &c
, 1);
247 ovs_fatal(errno
, "could not fork");
259 "\nDaemon options:\n"
260 " --detach run in background as daemon\n"
261 " --no-chdir do not chdir to '/'\n"
262 " --pidfile[=FILE] create pidfile (default: %s/%s.pid)\n"
263 " --overwrite-pidfile with --pidfile, start even if already "
265 ovs_rundir
, program_name
);
268 /* Opens and reads a PID from 'pidfile'. Returns the nonnegative PID if
269 * successful, otherwise a negative errno value. */
271 read_pidfile(const char *pidfile
)
278 file
= fopen(pidfile
, "r");
281 VLOG_WARN("%s: open: %s", pidfile
, strerror(error
));
285 lck
.l_type
= F_WRLCK
;
286 lck
.l_whence
= SEEK_SET
;
289 if (fcntl(fileno(file
), F_GETLK
, &lck
)) {
291 VLOG_WARN("%s: fcntl: %s", pidfile
, strerror(error
));
294 if (lck
.l_type
== F_UNLCK
) {
296 VLOG_WARN("%s: pid file is not locked", pidfile
);
300 if (!fgets(line
, sizeof line
, file
)) {
303 VLOG_WARN("%s: read: %s", pidfile
, strerror(error
));
306 VLOG_WARN("%s: read: unexpected end of file", pidfile
);
311 if (lck
.l_pid
!= strtoul(line
, NULL
, 10)) {
313 VLOG_WARN("l_pid (%ld) != %s pid (%s)",
314 (long int) lck
.l_pid
, pidfile
, line
);