e14b776d266c1bd10ee8cba693653459f4537ed1
[openvswitch] / 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  *
57  * If 'name' is null, then program_name followed by ".pid" is used. */
58 void
59 set_pidfile(const char *name)
60 {
61     free(pidfile);
62     pidfile = (!name ? xasprintf("%s/%s.pid", RUNDIR, program_name)
63                : *name == '/' ? xstrdup(name)
64                : xasprintf("%s/%s", RUNDIR, name));
65 }
66
67 /* Sets up a following call to daemonize() to detach from the foreground
68  * session, running this process in the background.  */
69 void
70 set_detach(void)
71 {
72     detach = true;
73 }
74
75 /* If a pidfile has been configured, creates it and stores 'pid' in it.  It is
76  * the caller's responsibility to make sure that the pidfile will eventually
77  * be deleted. */
78 static void
79 make_pidfile(pid_t pid)
80 {
81     if (pidfile) {
82         FILE *file;
83
84         file = fopen(pidfile, "w");
85         if (file) {
86             fprintf(file, "%ld\n", (long int) pid);
87             fclose(file);
88         } else {
89             VLOG_ERR("failed to create \"%s\": %s", pidfile, strerror(errno));
90         }
91         free(pidfile);
92         pidfile = NULL;
93     }
94 }
95
96 /* If configured with set_pidfile() or set_detach(), creates the pid file and
97  * detaches from the foreground session.  */
98 void
99 daemonize(void)
100 {
101     if (detach) {
102         pid_t pid;
103
104         /* Fork and exit from the parent. */
105         pid = fork();
106         if (pid < 0) {
107             fatal(errno, "could not fork");
108         } else if (pid) {
109             fatal_signal_fork();
110             make_pidfile(pid);
111             exit(0);
112         }
113
114         if (pidfile) {
115             fatal_signal_add_file_to_unlink(pidfile);
116         }
117         setsid();
118         chdir("/");
119     } else {
120         if (pidfile) {
121             fatal_signal_add_file_to_unlink(pidfile);
122         }
123         make_pidfile(getpid());
124     }
125 }
126