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 <stdlib.h>
  38 #include <string.h>
  39 #include <unistd.h>
  40 #include "fatal-signal.h"
  41 #include "util.h"
  42
  43 #define THIS_MODULE VLM_daemon
  44 #include "vlog.h"
  45
  46 /* Should we run in the background? */
  47 static bool detach;
  48
  49 /* Name of pidfile (null if none). */
  50 static char *pidfile;
  51
  52 /* Sets up a following call to daemonize() to create a pidfile named 'name'.
  53  * If 'name' begins with '/', then it is treated as an absolute path.
  54  * Otherwise, it is taken relative to RUNDIR, which is $(prefix)/var/run by
  55  * default. */
  56 void
  57 set_pidfile(const char *name)
  58 {
  59     free(pidfile);
  60     pidfile = *name == '/' ? xstrdup(name) : xasprintf("%s/%s", RUNDIR, name);
  61 }
  62
  63 /* Sets up a following call to daemonize() to detach from the foreground
  64  * session, running this process in the background.  */
  65 void
  66 set_detach(void)
  67 {
  68     detach = true;
  69 }
  70
  71 /* If a pidfile has been configured, creates it and stores 'pid' in it.  It is
  72  * the caller's responsibility to make sure that the pidfile will eventually
  73  * be deleted. */
  74 static void
  75 make_pidfile(pid_t pid)
  76 {
  77     if (pidfile) {
  78         FILE *file;
  79
  80         file = fopen(pidfile, "w");
  81         if (file) {
  82             fprintf(file, "%ld\n", (long int) pid);
  83             fclose(file);
  84         } else {
  85             VLOG_ERR("failed to create \"%s\": %s", pidfile, strerror(errno));
  86         }
  87         free(pidfile);
  88         pidfile = NULL;
  89     }
  90 }
  91
  92 /* If configured with set_pidfile() or set_detach(), creates the pid file and
  93  * detaches from the foreground session.  */
  94 void
  95 daemonize(void)
  96 {
  97     if (detach) {
  98         pid_t pid;
  99
 100         /* Fork and exit from the parent. */
 101         pid = fork();
 102         if (pid < 0) {
 103             fatal(errno, "could not fork");
 104         } else if (pid) {
 105             fatal_signal_fork();
 106             make_pidfile(pid);
 107             exit(0);
 108         }
 109
 110         if (pidfile) {
 111             fatal_signal_add_file_to_unlink(pidfile);
 112         }
 113         setsid();
 114         chdir("/");
 115     } else {
 116         if (pidfile) {
 117             fatal_signal_add_file_to_unlink(pidfile);
 118         }
 119         make_pidfile(getpid());
 120     }
 121 }
 122