ofproto-dpif: Factor out VLAN splinter flow adjustment into new function.
[openvswitch] / lib / daemon.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include "daemon.h"
19 #include <assert.h>
20 #include <errno.h>
21 #include <fcntl.h>
22 #include <signal.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <sys/resource.h>
26 #include <sys/wait.h>
27 #include <sys/stat.h>
28 #include <unistd.h>
29 #include "command-line.h"
30 #include "fatal-signal.h"
31 #include "dirs.h"
32 #include "lockfile.h"
33 #include "process.h"
34 #include "socket-util.h"
35 #include "timeval.h"
36 #include "util.h"
37 #include "vlog.h"
38
39 VLOG_DEFINE_THIS_MODULE(daemon);
40
41 /* --detach: Should we run in the background? */
42 static bool detach;
43
44 /* --pidfile: Name of pidfile (null if none). */
45 static char *pidfile;
46
47 /* Device and inode of pidfile, so we can avoid reopening it. */
48 static dev_t pidfile_dev;
49 static ino_t pidfile_ino;
50
51 /* --overwrite-pidfile: Create pidfile even if one already exists and is
52    locked? */
53 static bool overwrite_pidfile;
54
55 /* --no-chdir: Should we chdir to "/"? */
56 static bool chdir_ = true;
57
58 /* File descriptor used by daemonize_start() and daemonize_complete(). */
59 static int daemonize_fd = -1;
60
61 /* --monitor: Should a supervisory process monitor the daemon and restart it if
62  * it dies due to an error signal? */
63 static bool monitor;
64
65 /* For each of the standard file descriptors, whether to replace it by
66  * /dev/null (if false) or keep it for the daemon to use (if true). */
67 static bool save_fds[3];
68
69 static void check_already_running(void);
70 static int lock_pidfile(FILE *, int command);
71
72 /* Returns the file name that would be used for a pidfile if 'name' were
73  * provided to set_pidfile().  The caller must free the returned string. */
74 char *
75 make_pidfile_name(const char *name)
76 {
77     return (!name
78             ? xasprintf("%s/%s.pid", ovs_rundir(), program_name)
79             : abs_file_name(ovs_rundir(), name));
80 }
81
82 /* Sets up a following call to daemonize() to create a pidfile named 'name'.
83  * If 'name' begins with '/', then it is treated as an absolute path.
84  * Otherwise, it is taken relative to RUNDIR, which is $(prefix)/var/run by
85  * default.
86  *
87  * If 'name' is null, then program_name followed by ".pid" is used. */
88 void
89 set_pidfile(const char *name)
90 {
91     free(pidfile);
92     pidfile = make_pidfile_name(name);
93 }
94
95 /* Returns an absolute path to the configured pidfile, or a null pointer if no
96  * pidfile is configured.  The caller must not modify or free the returned
97  * string. */
98 const char *
99 get_pidfile(void)
100 {
101     return pidfile;
102 }
103
104 /* Sets that we do not chdir to "/". */
105 void
106 set_no_chdir(void)
107 {
108     chdir_ = false;
109 }
110
111 /* Will we chdir to "/" as part of daemonizing? */
112 bool
113 is_chdir_enabled(void)
114 {
115     return chdir_;
116 }
117
118 /* Normally, daemonize() or damonize_start() will terminate the program with a
119  * message if a locked pidfile already exists.  If this function is called, an
120  * existing pidfile will be replaced, with a warning. */
121 void
122 ignore_existing_pidfile(void)
123 {
124     overwrite_pidfile = true;
125 }
126
127 /* Sets up a following call to daemonize() to detach from the foreground
128  * session, running this process in the background.  */
129 void
130 set_detach(void)
131 {
132     detach = true;
133 }
134
135 /* Will daemonize() really detach? */
136 bool
137 get_detach(void)
138 {
139     return detach;
140 }
141
142 /* Sets up a following call to daemonize() to fork a supervisory process to
143  * monitor the daemon and restart it if it dies due to an error signal.  */
144 void
145 daemon_set_monitor(void)
146 {
147     monitor = true;
148 }
149
150 /* A daemon doesn't normally have any use for the file descriptors for stdin,
151  * stdout, and stderr after it detaches.  To keep these file descriptors from
152  * e.g. holding an SSH session open, by default detaching replaces each of
153  * these file descriptors by /dev/null.  But a few daemons expect the user to
154  * redirect stdout or stderr to a file, in which case it is desirable to keep
155  * these file descriptors.  This function, therefore, disables replacing 'fd'
156  * by /dev/null when the daemon detaches. */
157 void
158 daemon_save_fd(int fd)
159 {
160     assert(fd == STDIN_FILENO || fd == STDOUT_FILENO || fd == STDERR_FILENO);
161     save_fds[fd] = true;
162 }
163
164 /* If a pidfile has been configured, creates it and stores the running
165  * process's pid in it.  Ensures that the pidfile will be deleted when the
166  * process exits. */
167 static void
168 make_pidfile(void)
169 {
170     long int pid = getpid();
171     struct stat s;
172     char *tmpfile;
173     FILE *file;
174     int error;
175
176     /* Create a temporary pidfile. */
177     tmpfile = xasprintf("%s.tmp%ld", pidfile, pid);
178     fatal_signal_add_file_to_unlink(tmpfile);
179     file = fopen(tmpfile, "w+");
180     if (!file) {
181         VLOG_FATAL("%s: create failed (%s)", tmpfile, strerror(errno));
182     }
183
184     if (fstat(fileno(file), &s) == -1) {
185         VLOG_FATAL("%s: fstat failed (%s)", tmpfile, strerror(errno));
186     }
187
188     fprintf(file, "%ld\n", pid);
189     if (fflush(file) == EOF) {
190         VLOG_FATAL("%s: write failed (%s)", tmpfile, strerror(errno));
191     }
192
193     error = lock_pidfile(file, F_SETLK);
194     if (error) {
195         VLOG_FATAL("%s: fcntl(F_SETLK) failed (%s)", tmpfile, strerror(error));
196     }
197
198     /* Rename or link it to the correct name. */
199     if (overwrite_pidfile) {
200         if (rename(tmpfile, pidfile) < 0) {
201             VLOG_FATAL("failed to rename \"%s\" to \"%s\" (%s)",
202                        tmpfile, pidfile, strerror(errno));
203         }
204     } else {
205         do {
206             error = link(tmpfile, pidfile) == -1 ? errno : 0;
207             if (error == EEXIST) {
208                 check_already_running();
209             }
210         } while (error == EINTR || error == EEXIST);
211         if (error) {
212             VLOG_FATAL("failed to link \"%s\" as \"%s\" (%s)",
213                        tmpfile, pidfile, strerror(error));
214         }
215     }
216
217     /* Ensure that the pidfile will get deleted on exit. */
218     fatal_signal_add_file_to_unlink(pidfile);
219
220     /* Delete the temporary pidfile if it still exists. */
221     if (!overwrite_pidfile) {
222         error = fatal_signal_unlink_file_now(tmpfile);
223         if (error) {
224             VLOG_FATAL("%s: unlink failed (%s)", tmpfile, strerror(error));
225         }
226     }
227
228     /* Clean up.
229      *
230      * We don't close 'file' because its file descriptor must remain open to
231      * hold the lock. */
232     pidfile_dev = s.st_dev;
233     pidfile_ino = s.st_ino;
234     free(tmpfile);
235     free(pidfile);
236     pidfile = NULL;
237 }
238
239 /* If configured with set_pidfile() or set_detach(), creates the pid file and
240  * detaches from the foreground session.  */
241 void
242 daemonize(void)
243 {
244     daemonize_start();
245     daemonize_complete();
246 }
247
248 static pid_t
249 fork_and_wait_for_startup(int *fdp)
250 {
251     int fds[2];
252     pid_t pid;
253
254     xpipe(fds);
255
256     pid = fork();
257     if (pid > 0) {
258         /* Running in parent process. */
259         size_t bytes_read;
260         char c;
261
262         close(fds[1]);
263         fatal_signal_fork();
264         if (read_fully(fds[0], &c, 1, &bytes_read) != 0) {
265             int retval;
266             int status;
267
268             do {
269                 retval = waitpid(pid, &status, 0);
270             } while (retval == -1 && errno == EINTR);
271
272             if (retval == pid) {
273                 if (WIFEXITED(status) && WEXITSTATUS(status)) {
274                     /* Child exited with an error.  Convey the same error
275                      * to our parent process as a courtesy. */
276                     exit(WEXITSTATUS(status));
277                 } else {
278                     char *status_msg = process_status_msg(status);
279                     VLOG_FATAL("fork child died before signaling startup (%s)",
280                                status_msg);
281                 }
282             } else if (retval < 0) {
283                 VLOG_FATAL("waitpid failed (%s)", strerror(errno));
284             } else {
285                 NOT_REACHED();
286             }
287         }
288         close(fds[0]);
289         *fdp = -1;
290     } else if (!pid) {
291         /* Running in child process. */
292         close(fds[0]);
293         time_postfork();
294         lockfile_postfork();
295         *fdp = fds[1];
296     } else {
297         VLOG_FATAL("fork failed (%s)", strerror(errno));
298     }
299
300     return pid;
301 }
302
303 static void
304 fork_notify_startup(int fd)
305 {
306     if (fd != -1) {
307         size_t bytes_written;
308         int error;
309
310         error = write_fully(fd, "", 1, &bytes_written);
311         if (error) {
312             VLOG_FATAL("pipe write failed (%s)", strerror(error));
313         }
314
315         close(fd);
316     }
317 }
318
319 static bool
320 should_restart(int status)
321 {
322     if (WIFSIGNALED(status)) {
323         static const int error_signals[] = {
324             SIGABRT, SIGALRM, SIGBUS, SIGFPE, SIGILL, SIGPIPE, SIGSEGV,
325             SIGXCPU, SIGXFSZ
326         };
327
328         size_t i;
329
330         for (i = 0; i < ARRAY_SIZE(error_signals); i++) {
331             if (error_signals[i] == WTERMSIG(status)) {
332                 return true;
333             }
334         }
335     }
336     return false;
337 }
338
339 static void
340 monitor_daemon(pid_t daemon_pid)
341 {
342     /* XXX Should log daemon's stderr output at startup time. */
343     const char *saved_program_name;
344     time_t last_restart;
345     char *status_msg;
346     int crashes;
347
348     saved_program_name = program_name;
349     program_name = xasprintf("monitor(%s)", program_name);
350     status_msg = xstrdup("healthy");
351     last_restart = TIME_MIN;
352     crashes = 0;
353     for (;;) {
354         int retval;
355         int status;
356
357         proctitle_set("%s: monitoring pid %lu (%s)",
358                       saved_program_name, (unsigned long int) daemon_pid,
359                       status_msg);
360
361         do {
362             retval = waitpid(daemon_pid, &status, 0);
363         } while (retval == -1 && errno == EINTR);
364
365         if (retval == -1) {
366             VLOG_FATAL("waitpid failed (%s)", strerror(errno));
367         } else if (retval == daemon_pid) {
368             char *s = process_status_msg(status);
369             if (should_restart(status)) {
370                 free(status_msg);
371                 status_msg = xasprintf("%d crashes: pid %lu died, %s",
372                                        ++crashes,
373                                        (unsigned long int) daemon_pid, s);
374                 free(s);
375
376                 if (WCOREDUMP(status)) {
377                     /* Disable further core dumps to save disk space. */
378                     struct rlimit r;
379
380                     r.rlim_cur = 0;
381                     r.rlim_max = 0;
382                     if (setrlimit(RLIMIT_CORE, &r) == -1) {
383                         VLOG_WARN("failed to disable core dumps: %s",
384                                   strerror(errno));
385                     }
386                 }
387
388                 /* Throttle restarts to no more than once every 10 seconds. */
389                 if (time(NULL) < last_restart + 10) {
390                     VLOG_WARN("%s, waiting until 10 seconds since last "
391                               "restart", status_msg);
392                     for (;;) {
393                         time_t now = time(NULL);
394                         time_t wakeup = last_restart + 10;
395                         if (now >= wakeup) {
396                             break;
397                         }
398                         sleep(wakeup - now);
399                     }
400                 }
401                 last_restart = time(NULL);
402
403                 VLOG_ERR("%s, restarting", status_msg);
404                 daemon_pid = fork_and_wait_for_startup(&daemonize_fd);
405                 if (!daemon_pid) {
406                     break;
407                 }
408             } else {
409                 VLOG_INFO("pid %lu died, %s, exiting",
410                           (unsigned long int) daemon_pid, s);
411                 free(s);
412                 exit(0);
413             }
414         }
415     }
416     free(status_msg);
417
418     /* Running in new daemon process. */
419     proctitle_restore();
420     free((char *) program_name);
421     program_name = saved_program_name;
422 }
423
424 /* Close standard file descriptors (except any that the client has requested we
425  * leave open by calling daemon_save_fd()).  If we're started from e.g. an SSH
426  * session, then this keeps us from holding that session open artificially. */
427 static void
428 close_standard_fds(void)
429 {
430     int null_fd = get_null_fd();
431     if (null_fd >= 0) {
432         int fd;
433
434         for (fd = 0; fd < 3; fd++) {
435             if (!save_fds[fd]) {
436                 dup2(null_fd, fd);
437             }
438         }
439     }
440
441     /* Disable logging to stderr to avoid wasting CPU time. */
442     vlog_set_levels(NULL, VLF_CONSOLE, VLL_OFF);
443 }
444
445 /* If daemonization is configured, then starts daemonization, by forking and
446  * returning in the child process.  The parent process hangs around until the
447  * child lets it know either that it completed startup successfully (by calling
448  * daemon_complete()) or that it failed to start up (by exiting with a nonzero
449  * exit code). */
450 void
451 daemonize_start(void)
452 {
453     daemonize_fd = -1;
454
455     if (detach) {
456         if (fork_and_wait_for_startup(&daemonize_fd) > 0) {
457             /* Running in parent process. */
458             exit(0);
459         }
460         /* Running in daemon or monitor process. */
461     }
462
463     if (monitor) {
464         int saved_daemonize_fd = daemonize_fd;
465         pid_t daemon_pid;
466
467         daemon_pid = fork_and_wait_for_startup(&daemonize_fd);
468         if (daemon_pid > 0) {
469             /* Running in monitor process. */
470             fork_notify_startup(saved_daemonize_fd);
471             close_standard_fds();
472             monitor_daemon(daemon_pid);
473         }
474         /* Running in daemon process. */
475     }
476
477     if (pidfile) {
478         make_pidfile();
479     }
480
481     /* Make sure that the unixctl commands for vlog get registered in a
482      * daemon, even before the first log message. */
483     vlog_init();
484 }
485
486 /* If daemonization is configured, then this function notifies the parent
487  * process that the child process has completed startup successfully.
488  *
489  * Calling this function more than once has no additional effect. */
490 void
491 daemonize_complete(void)
492 {
493     fork_notify_startup(daemonize_fd);
494     daemonize_fd = -1;
495
496     if (detach) {
497         setsid();
498         if (chdir_) {
499             ignore(chdir("/"));
500         }
501         close_standard_fds();
502         detach = false;
503     }
504 }
505
506 void
507 daemon_usage(void)
508 {
509     printf(
510         "\nDaemon options:\n"
511         "  --detach                run in background as daemon\n"
512         "  --no-chdir              do not chdir to '/'\n"
513         "  --pidfile[=FILE]        create pidfile (default: %s/%s.pid)\n"
514         "  --overwrite-pidfile     with --pidfile, start even if already "
515                                    "running\n",
516         ovs_rundir(), program_name);
517 }
518
519 static int
520 lock_pidfile__(FILE *file, int command, struct flock *lck)
521 {
522     int error;
523
524     lck->l_type = F_WRLCK;
525     lck->l_whence = SEEK_SET;
526     lck->l_start = 0;
527     lck->l_len = 0;
528     lck->l_pid = 0;
529
530     do {
531         error = fcntl(fileno(file), command, lck) == -1 ? errno : 0;
532     } while (error == EINTR);
533     return error;
534 }
535
536 static int
537 lock_pidfile(FILE *file, int command)
538 {
539     struct flock lck;
540
541     return lock_pidfile__(file, command, &lck);
542 }
543
544 static pid_t
545 read_pidfile__(const char *pidfile, bool delete_if_stale)
546 {
547     struct stat s, s2;
548     struct flock lck;
549     char line[128];
550     FILE *file;
551     int error;
552
553     if ((pidfile_ino || pidfile_dev)
554         && !stat(pidfile, &s)
555         && s.st_ino == pidfile_ino && s.st_dev == pidfile_dev) {
556         /* It's our own pidfile.  We can't afford to open it, because closing
557          * *any* fd for a file that a process has locked also releases all the
558          * locks on that file.
559          *
560          * Fortunately, we know the associated pid anyhow: */
561         return getpid();
562     }
563
564     file = fopen(pidfile, "r+");
565     if (!file) {
566         if (errno == ENOENT && delete_if_stale) {
567             return 0;
568         }
569         error = errno;
570         VLOG_WARN("%s: open: %s", pidfile, strerror(error));
571         goto error;
572     }
573
574     error = lock_pidfile__(file, F_GETLK, &lck);
575     if (error) {
576         VLOG_WARN("%s: fcntl: %s", pidfile, strerror(error));
577         goto error;
578     }
579     if (lck.l_type == F_UNLCK) {
580         /* pidfile exists but it isn't locked by anyone.  We need to delete it
581          * so that a new pidfile can go in its place.  But just calling
582          * unlink(pidfile) makes a nasty race: what if someone else unlinks it
583          * before we do and then replaces it by a valid pidfile?  We'd unlink
584          * their valid pidfile.  We do a little dance to avoid the race, by
585          * locking the invalid pidfile.  Only one process can have the invalid
586          * pidfile locked, and only that process has the right to unlink it. */
587         if (!delete_if_stale) {
588             error = ESRCH;
589             VLOG_DBG("%s: pid file is stale", pidfile);
590             goto error;
591         }
592
593         /* Get the lock. */
594         error = lock_pidfile(file, F_SETLK);
595         if (error) {
596             /* We lost a race with someone else doing the same thing. */
597             VLOG_WARN("%s: lost race to lock pidfile", pidfile);
598             goto error;
599         }
600
601         /* Is the file we have locked still named 'pidfile'? */
602         if (stat(pidfile, &s) || fstat(fileno(file), &s2)
603             || s.st_ino != s2.st_ino || s.st_dev != s2.st_dev) {
604             /* No.  We lost a race with someone else who got the lock before
605              * us, deleted the pidfile, and closed it (releasing the lock). */
606             error = EALREADY;
607             VLOG_WARN("%s: lost race to delete pidfile", pidfile);
608             goto error;
609         }
610
611         /* We won the right to delete the stale pidfile. */
612         if (unlink(pidfile)) {
613             error = errno;
614             VLOG_WARN("%s: failed to delete stale pidfile (%s)",
615                       pidfile, strerror(error));
616             goto error;
617         }
618         VLOG_DBG("%s: deleted stale pidfile", pidfile);
619         fclose(file);
620         return 0;
621     }
622
623     if (!fgets(line, sizeof line, file)) {
624         if (ferror(file)) {
625             error = errno;
626             VLOG_WARN("%s: read: %s", pidfile, strerror(error));
627         } else {
628             error = ESRCH;
629             VLOG_WARN("%s: read: unexpected end of file", pidfile);
630         }
631         goto error;
632     }
633
634     if (lck.l_pid != strtoul(line, NULL, 10)) {
635         /* The process that has the pidfile locked is not the process that
636          * created it.  It must be stale, with the process that has it locked
637          * preparing to delete it. */
638         error = ESRCH;
639         VLOG_WARN("%s: stale pidfile for pid %s being deleted by pid %ld",
640                   pidfile, line, (long int) lck.l_pid);
641         goto error;
642     }
643
644     fclose(file);
645     return lck.l_pid;
646
647 error:
648     if (file) {
649         fclose(file);
650     }
651     return -error;
652 }
653
654 /* Opens and reads a PID from 'pidfile'.  Returns the positive PID if
655  * successful, otherwise a negative errno value. */
656 pid_t
657 read_pidfile(const char *pidfile)
658 {
659     return read_pidfile__(pidfile, false);
660 }
661
662 /* Checks whether a process with the given 'pidfile' is already running and,
663  * if so, aborts.  If 'pidfile' is stale, deletes it. */
664 static void
665 check_already_running(void)
666 {
667     long int pid = read_pidfile__(pidfile, true);
668     if (pid > 0) {
669         VLOG_FATAL("%s: already running as pid %ld, aborting", pidfile, pid);
670     } else if (pid < 0) {
671         VLOG_FATAL("%s: pidfile check failed (%s), aborting",
672                    pidfile, strerror(-pid));
673     }
674 }