lib/fatal-signal.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 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 #include <config.h>
  17 #include "fatal-signal.h"
  18 #include <assert.h>
  19 #include <errno.h>
  20 #include <signal.h>
  21 #include <stdbool.h>
  22 #include <stdio.h>
  23 #include <stdint.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27 #include "poll-loop.h"
  28 #include "shash.h"
  29 #include "sset.h"
  30 #include "signals.h"
  31 #include "socket-util.h"
  32 #include "util.h"
  33 #include "vlog.h"
  34
  35 #include "type-props.h"
  36
  37 #ifndef SIG_ATOMIC_MAX
  38 #define SIG_ATOMIC_MAX TYPE_MAXIMUM(sig_atomic_t)
  39 #endif
  40
  41 VLOG_DEFINE_THIS_MODULE(fatal_signal);
  42
  43 /* Signals to catch. */
  44 static const int fatal_signals[] = { SIGTERM, SIGINT, SIGHUP, SIGALRM };
  45
  46 /* Signals to catch as a sigset_t. */
  47 static sigset_t fatal_signal_set;
  48
  49 /* Hooks to call upon catching a signal */
  50 struct hook {
  51     void (*hook_cb)(void *aux);
  52     void (*cancel_cb)(void *aux);
  53     void *aux;
  54     bool run_at_exit;
  55 };
  56 #define MAX_HOOKS 32
  57 static struct hook hooks[MAX_HOOKS];
  58 static size_t n_hooks;
  59
  60 static int signal_fds[2];
  61 static volatile sig_atomic_t stored_sig_nr = SIG_ATOMIC_MAX;
  62
  63 static void fatal_signal_init(void);
  64 static void atexit_handler(void);
  65 static void call_hooks(int sig_nr);
  66
  67 static void
  68 fatal_signal_init(void)
  69 {
  70     static bool inited = false;
  71
  72     if (!inited) {
  73         size_t i;
  74
  75         inited = true;
  76
  77         xpipe(signal_fds);
  78         set_nonblocking(signal_fds[0]);
  79         set_nonblocking(signal_fds[1]);
  80
  81         sigemptyset(&fatal_signal_set);
  82         for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) {
  83             int sig_nr = fatal_signals[i];
  84             struct sigaction old_sa;
  85
  86             sigaddset(&fatal_signal_set, sig_nr);
  87             xsigaction(sig_nr, NULL, &old_sa);
  88             if (old_sa.sa_handler == SIG_DFL
  89                 && signal(sig_nr, fatal_signal_handler) == SIG_ERR) {
  90                 VLOG_FATAL("signal failed (%s)", strerror(errno));
  91             }
  92         }
  93         atexit(atexit_handler);
  94     }
  95 }
  96
  97 /* Registers 'hook_cb' to be called when a process termination signal is
  98  * raised.  If 'run_at_exit' is true, 'hook_cb' is also called during normal
  99  * process termination, e.g. when exit() is called or when main() returns.
 100  *
 101  * 'hook_cb' is not called immediately from the signal handler but rather the
 102  * next time the poll loop iterates, so it is freed from the usual restrictions
 103  * on signal handler functions.
 104  *
 105  * If the current process forks, fatal_signal_fork() may be called to clear the
 106  * parent process's fatal signal hooks, so that 'hook_cb' is only called when
 107  * the child terminates, not when the parent does.  When fatal_signal_fork() is
 108  * called, it calls the 'cancel_cb' function if it is nonnull, passing 'aux',
 109  * to notify that the hook has been canceled.  This allows the hook to free
 110  * memory, etc. */
 111 void
 112 fatal_signal_add_hook(void (*hook_cb)(void *aux), void (*cancel_cb)(void *aux),
 113                       void *aux, bool run_at_exit)
 114 {
 115     fatal_signal_init();
 116
 117     assert(n_hooks < MAX_HOOKS);
 118     hooks[n_hooks].hook_cb = hook_cb;
 119     hooks[n_hooks].cancel_cb = cancel_cb;
 120     hooks[n_hooks].aux = aux;
 121     hooks[n_hooks].run_at_exit = run_at_exit;
 122     n_hooks++;
 123 }
 124
 125 /* Handles fatal signal number 'sig_nr'.
 126  *
 127  * Ordinarily this is the actual signal handler.  When other code needs to
 128  * handle one of our signals, however, it can register for that signal and, if
 129  * and when necessary, call this function to do fatal signal processing for it
 130  * and terminate the process.  Currently only timeval.c does this, for SIGALRM.
 131  * (It is not important whether the other code sets up its signal handler
 132  * before or after this file, because this file will only set up a signal
 133  * handler in the case where the signal has its default handling.)  */
 134 void
 135 fatal_signal_handler(int sig_nr)
 136 {
 137     ignore(write(signal_fds[1], "", 1));
 138     stored_sig_nr = sig_nr;
 139 }
 140
 141 /* Check whether a fatal signal has occurred and, if so, call the fatal signal
 142  * hooks and exit.
 143  *
 144  * This function is called automatically by poll_block(), but specialized
 145  * programs that may not always call poll_block() on a regular basis should
 146  * also call it periodically.  (Therefore, any function with "block" in its
 147  * name should call fatal_signal_run() each time it is called, either directly
 148  * or through poll_block(), because such functions can only used by specialized
 149  * programs that can afford to block outside their main loop around
 150  * poll_block().)
 151  */
 152 void
 153 fatal_signal_run(void)
 154 {
 155     int sig_nr;
 156
 157     fatal_signal_init();
 158
 159     sig_nr = stored_sig_nr;
 160     if (sig_nr != SIG_ATOMIC_MAX) {
 161         call_hooks(sig_nr);
 162
 163         /* Re-raise the signal with the default handling so that the program
 164          * termination status reflects that we were killed by this signal */
 165         signal(sig_nr, SIG_DFL);
 166         raise(sig_nr);
 167     }
 168 }
 169
 170 void
 171 fatal_signal_wait(void)
 172 {
 173     fatal_signal_init();
 174     poll_fd_wait(signal_fds[0], POLLIN);
 175 }
 176
 177 static void
 178 atexit_handler(void)
 179 {
 180     call_hooks(0);
 181 }
 182
 183 static void
 184 call_hooks(int sig_nr)
 185 {
 186     static volatile sig_atomic_t recurse = 0;
 187     if (!recurse) {
 188         size_t i;
 189
 190         recurse = 1;
 191
 192         for (i = 0; i < n_hooks; i++) {
 193             struct hook *h = &hooks[i];
 194             if (sig_nr || h->run_at_exit) {
 195                 h->hook_cb(h->aux);
 196             }
 197         }
 198     }
 199 }
 200 \f
 201 /* Files to delete on exit. */
 202 static struct sset files = SSET_INITIALIZER(&files);
 203
 204 /* Has a hook function been registered with fatal_signal_add_hook() (and not
 205  * cleared by fatal_signal_fork())? */
 206 static bool added_hook;
 207
 208 static void unlink_files(void *aux);
 209 static void cancel_files(void *aux);
 210 static void do_unlink_files(void);
 211
 212 /* Registers 'file' to be unlinked when the program terminates via exit() or a
 213  * fatal signal. */
 214 void
 215 fatal_signal_add_file_to_unlink(const char *file)
 216 {
 217     if (!added_hook) {
 218         added_hook = true;
 219         fatal_signal_add_hook(unlink_files, cancel_files, NULL, true);
 220     }
 221
 222     sset_add(&files, file);
 223 }
 224
 225 /* Unregisters 'file' from being unlinked when the program terminates via
 226  * exit() or a fatal signal. */
 227 void
 228 fatal_signal_remove_file_to_unlink(const char *file)
 229 {
 230     sset_find_and_delete(&files, file);
 231 }
 232
 233 /* Like fatal_signal_remove_file_to_unlink(), but also unlinks 'file'.
 234  * Returns 0 if successful, otherwise a positive errno value. */
 235 int
 236 fatal_signal_unlink_file_now(const char *file)
 237 {
 238     int error = unlink(file) ? errno : 0;
 239     if (error) {
 240         VLOG_WARN("could not unlink \"%s\" (%s)", file, strerror(error));
 241     }
 242
 243     fatal_signal_remove_file_to_unlink(file);
 244
 245     return error;
 246 }
 247
 248 static void
 249 unlink_files(void *aux OVS_UNUSED)
 250 {
 251     do_unlink_files();
 252 }
 253
 254 static void
 255 cancel_files(void *aux OVS_UNUSED)
 256 {
 257     sset_clear(&files);
 258     added_hook = false;
 259 }
 260
 261 static void
 262 do_unlink_files(void)
 263 {
 264     const char *file;
 265
 266     SSET_FOR_EACH (file, &files) {
 267         unlink(file);
 268     }
 269 }
 270 \f
 271 /* Clears all of the fatal signal hooks without executing them.  If any of the
 272  * hooks passed a 'cancel_cb' function to fatal_signal_add_hook(), then those
 273  * functions will be called, allowing them to free resources, etc.
 274  *
 275  * Following a fork, one of the resulting processes can call this function to
 276  * allow it to terminate without calling the hooks registered before calling
 277  * this function.  New hooks registered after calling this function will take
 278  * effect normally. */
 279 void
 280 fatal_signal_fork(void)
 281 {
 282     size_t i;
 283
 284     for (i = 0; i < n_hooks; i++) {
 285         struct hook *h = &hooks[i];
 286         if (h->cancel_cb) {
 287             h->cancel_cb(h->aux);
 288         }
 289     }
 290     n_hooks = 0;
 291
 292     /* Raise any signals that we have already received with the default
 293      * handler. */
 294     if (stored_sig_nr != SIG_ATOMIC_MAX) {
 295         raise(stored_sig_nr);
 296     }
 297 }