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