lib/daemon.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "daemon.h"
  36 #include <errno.h>
  37 #include <fcntl.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include <unistd.h>
  41 #include "fatal-signal.h"
  42 #include "dirs.h"
  43 #include "util.h"
  44
  45 #define THIS_MODULE VLM_daemon
  46 #include "vlog.h"
  47
  48 /* Should we run in the background? */
  49 static bool detach;
  50
  51 /* Name of pidfile (null if none). */
  52 static char *pidfile;
  53
  54 /* Create pidfile even if one already exists and is locked? */
  55 static bool force;
  56
  57 /* Returns the file name that would be used for a pidfile if 'name' were
  58  * provided to set_pidfile().  The caller must free the returned string. */
  59 char *
  60 make_pidfile_name(const char *name)
  61 {
  62     return (!name ? xasprintf("%s/%s.pid", ofp_rundir, program_name)
  63             : *name == '/' ? xstrdup(name)
  64             : xasprintf("%s/%s", ofp_rundir, name));
  65 }
  66
  67 /* Sets up a following call to daemonize() to create a pidfile named 'name'.
  68  * If 'name' begins with '/', then it is treated as an absolute path.
  69  * Otherwise, it is taken relative to RUNDIR, which is $(prefix)/var/run by
  70  * default.
  71  *
  72  * If 'name' is null, then program_name followed by ".pid" is used. */
  73 void
  74 set_pidfile(const char *name)
  75 {
  76     free(pidfile);
  77     pidfile = make_pidfile_name(name);
  78 }
  79
  80 /* Returns an absolute path to the configured pidfile, or a null pointer if no
  81  * pidfile is configured.  The caller must not modify or free the returned
  82  * string. */
  83 const char *
  84 get_pidfile(void)
  85 {
  86     return pidfile;
  87 }
  88
  89 /* Normally, die_if_already_running() will terminate the program with a message
  90  * if a locked pidfile already exists.  If this function is called,
  91  * die_if_already_running() will merely log a warning. */
  92 void
  93 ignore_existing_pidfile(void)
  94 {
  95     force = true;
  96 }
  97
  98 /* Sets up a following call to daemonize() to detach from the foreground
  99  * session, running this process in the background.  */
 100 void
 101 set_detach(void)
 102 {
 103     detach = true;
 104 }
 105
 106 /* If a pidfile has been configured and that pidfile already exists and is
 107  * locked by a running process, returns the pid of the running process.
 108  * Otherwise, returns 0. */
 109 static pid_t
 110 already_running(void)
 111 {
 112     pid_t pid = 0;
 113     if (pidfile) {
 114         int fd = open(pidfile, O_RDWR);
 115         if (fd >= 0) {
 116             struct flock lck;
 117             lck.l_type = F_WRLCK;
 118             lck.l_whence = SEEK_SET;
 119             lck.l_start = 0;
 120             lck.l_len = 0;
 121             if (fcntl(fd, F_GETLK, &lck) != -1 && lck.l_type != F_UNLCK) {
 122                 pid = lck.l_pid;
 123             }
 124             close(fd);
 125         }
 126     }
 127     return pid;
 128 }
 129
 130 /* If a locked pidfile exists, issue a warning message and, unless
 131  * ignore_existing_pidfile() has been called, terminate the program. */
 132 void
 133 die_if_already_running(void)
 134 {
 135     pid_t pid = already_running();
 136     if (pid) {
 137         if (!force) {
 138             ofp_fatal(0, "%s: already running as pid %ld",
 139                       get_pidfile(), (long int) pid);
 140         } else {
 141             VLOG_WARN("%s: %s already running as pid %ld",
 142                       get_pidfile(), program_name, (long int) pid);
 143         }
 144     }
 145 }
 146
 147 /* If a pidfile has been configured, creates it and stores the running process'
 148  * pid init.  Ensures that the pidfile will be deleted when the process
 149  * exits. */
 150 static void
 151 make_pidfile(void)
 152 {
 153     if (pidfile) {
 154         /* Create pidfile via temporary file, so that observers never see an
 155          * empty pidfile or an unlocked pidfile. */
 156         long int pid = getpid();
 157         char *tmpfile;
 158         int fd;
 159
 160         tmpfile = xasprintf("%s.tmp%ld", pidfile, pid);
 161         fatal_signal_add_file_to_unlink(tmpfile);
 162         fd = open(tmpfile, O_CREAT | O_WRONLY | O_TRUNC, 0666);
 163         if (fd >= 0) {
 164             struct flock lck;
 165             lck.l_type = F_WRLCK;
 166             lck.l_whence = SEEK_SET;
 167             lck.l_start = 0;
 168             lck.l_len = 0;
 169             if (fcntl(fd, F_SETLK, &lck) != -1) {
 170                 char *text = xasprintf("%ld\n", pid);
 171                 if (write(fd, text, strlen(text)) == strlen(text)) {
 172                     fatal_signal_add_file_to_unlink(pidfile);
 173                     if (rename(tmpfile, pidfile) < 0) {
 174                         VLOG_ERR("failed to rename \"%s\" to \"%s\": %s",
 175                                  tmpfile, pidfile, strerror(errno));
 176                         fatal_signal_remove_file_to_unlink(pidfile);
 177                         close(fd);
 178                     } else {
 179                         /* Keep 'fd' open to retain the lock. */
 180                     }
 181                 } else {
 182                     VLOG_ERR("%s: write failed: %s", tmpfile, strerror(errno));
 183                     close(fd);
 184                 }
 185             } else {
 186                 VLOG_ERR("%s: fcntl failed: %s", tmpfile, strerror(errno));
 187                 close(fd);
 188             }
 189         } else {
 190             VLOG_ERR("%s: create failed: %s", tmpfile, strerror(errno));
 191         }
 192         fatal_signal_remove_file_to_unlink(tmpfile);
 193         free(tmpfile);
 194     }
 195     free(pidfile);
 196     pidfile = NULL;
 197 }
 198
 199 /* If configured with set_pidfile() or set_detach(), creates the pid file and
 200  * detaches from the foreground session.  */
 201 void
 202 daemonize(void)
 203 {
 204     if (detach) {
 205         char c = 0;
 206         int fds[2];
 207         if (pipe(fds) < 0) {
 208             ofp_fatal(errno, "pipe failed");
 209         }
 210
 211         switch (fork()) {
 212         default:
 213             /* Parent process: wait for child to create pidfile, then exit. */
 214             close(fds[1]);
 215             fatal_signal_fork();
 216             read(fds[0], &c, 1);
 217             exit(0);
 218
 219         case 0:
 220             /* Child process. */
 221             close(fds[0]);
 222             make_pidfile();
 223             write(fds[1], &c, 1);
 224             close(fds[1]);
 225             setsid();
 226             chdir("/");
 227             break;
 228
 229         case -1:
 230             /* Error. */
 231             ofp_fatal(errno, "could not fork");
 232             break;
 233         }
 234     } else {
 235         make_pidfile();
 236     }
 237 }
 238
 239 void
 240 daemon_usage(void)
 241 {
 242     printf(
 243         "\nDaemon options:\n"
 244         "  -D, --detach            run in background as daemon\n"
 245         "  -P, --pidfile[=FILE]    create pidfile (default: %s/%s.pid)\n"
 246         "  -f, --force             with -P, start even if already running\n",
 247         ofp_rundir, program_name);
 248 }
 249
 250 /* Opens and reads a PID from 'pidfile'.  Returns the nonnegative PID if
 251  * successful, otherwise a negative errno value. */
 252 pid_t
 253 read_pidfile(const char *pidfile)
 254 {
 255     char line[128];
 256     struct flock lck;
 257     FILE *file;
 258     int error;
 259
 260     file = fopen(pidfile, "r");
 261     if (!file) {
 262         error = errno;
 263         VLOG_WARN("%s: open: %s", pidfile, strerror(error));
 264         goto error;
 265     }
 266
 267     lck.l_type = F_WRLCK;
 268     lck.l_whence = SEEK_SET;
 269     lck.l_start = 0;
 270     lck.l_len = 0;
 271     if (fcntl(fileno(file), F_GETLK, &lck)) {
 272         error = errno;
 273         VLOG_WARN("%s: fcntl: %s", pidfile, strerror(error));
 274         goto error;
 275     }
 276
 277     if (!fgets(line, sizeof line, file)) {
 278         error = errno;
 279         VLOG_WARN("%s: read: %s", pidfile, strerror(error));
 280         goto error;
 281     }
 282
 283     if (lck.l_pid != strtoul(line, NULL, 10)) {
 284         error = ESRCH;
 285         VLOG_WARN("l_pid (%ld) != %s pid (%s)",
 286                    (long int) lck.l_pid, pidfile, line);
 287         goto error;
 288     }
 289
 290     fclose(file);
 291     return lck.l_pid;
 292
 293 error:
 294     fclose(file);
 295     return -error;
 296 }