lib/fatal-signal.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 #include <config.h>
  34 #include "fatal-signal.h"
  35 #include <assert.h>
  36 #include <errno.h>
  37 #include <signal.h>
  38 #include <stdbool.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include <unistd.h>
  43 #include "util.h"
  44
  45 /* Signals to catch. */
  46 static const int fatal_signals[] = { SIGTERM, SIGINT, SIGHUP, SIGALRM };
  47
  48 /* Signals to catch as a sigset_t. */
  49 static sigset_t fatal_signal_set;
  50
  51 /* Hooks to call upon catching a signal */
  52 struct hook {
  53     void (*func)(void *aux);
  54     void *aux;
  55 };
  56 #define MAX_HOOKS 32
  57 static struct hook hooks[MAX_HOOKS];
  58 static size_t n_hooks;
  59
  60 /* Number of nesting signal blockers. */
  61 static int block_level = 0;
  62
  63 /* Signal mask saved by outermost signal blocker. */
  64 static sigset_t saved_signal_mask;
  65
  66 static void call_sigprocmask(int how, sigset_t* new_set, sigset_t* old_set);
  67
  68 /* Registers 'hook' to be called when a process termination signal is
  69  * raised. */
  70 void
  71 fatal_signal_add_hook(void (*func)(void *aux), void *aux)
  72 {
  73     fatal_signal_block();
  74     assert(n_hooks < MAX_HOOKS);
  75     hooks[n_hooks].func = func;
  76     hooks[n_hooks].aux = aux;
  77     n_hooks++;
  78     fatal_signal_unblock();
  79 }
  80
  81 /* Blocks program termination signals until fatal_signal_unblock() is called.
  82  * May be called multiple times with nesting; if so, fatal_signal_unblock()
  83  * must be called the same number of times to unblock signals.
  84  *
  85  * This is needed while adjusting a data structure that will be accessed by a
  86  * fatal signal hook, so that the hook is not invoked while the data structure
  87  * is in an inconsistent state. */
  88 void
  89 fatal_signal_block()
  90 {
  91     static bool inited = false;
  92     if (!inited) {
  93         size_t i;
  94
  95         inited = true;
  96         sigemptyset(&fatal_signal_set);
  97         for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) {
  98             int sig_nr = fatal_signals[i];
  99             struct sigaction old_sa;
 100
 101             sigaddset(&fatal_signal_set, sig_nr);
 102             if (sigaction(sig_nr, NULL, &old_sa)) {
 103                 fatal(errno, "sigaction");
 104             }
 105             if (old_sa.sa_handler == SIG_DFL
 106                 && signal(sig_nr, fatal_signal_handler) == SIG_ERR) {
 107                 fatal(errno, "signal");
 108             }
 109         }
 110     }
 111
 112     if (++block_level == 1) {
 113         call_sigprocmask(SIG_BLOCK, &fatal_signal_set, &saved_signal_mask);
 114     }
 115 }
 116
 117 /* Unblocks program termination signals blocked by fatal_signal_block() is
 118  * called.  If multiple calls to fatal_signal_block() are nested,
 119  * fatal_signal_unblock() must be called the same number of times to unblock
 120  * signals. */
 121 void
 122 fatal_signal_unblock()
 123 {
 124     assert(block_level > 0);
 125     if (--block_level == 0) {
 126         call_sigprocmask(SIG_SETMASK, &saved_signal_mask, NULL);
 127     }
 128 }
 129
 130 /* Handles fatal signal number 'sig_nr'.
 131  *
 132  * Ordinarily this is the actual signal handler.  When other code needs to
 133  * handle one of our signals, however, it can register for that signal and, if
 134  * and when necessary, call this function to do fatal signal processing for it
 135  * and terminate the process.  Currently only timeval.c does this, for SIGALRM.
 136  * (It is not important whether the other code sets up its signal handler
 137  * before or after this file, because this file will only set up a signal
 138  * handler in the case where the signal has its default handling.)  */
 139 void
 140 fatal_signal_handler(int sig_nr)
 141 {
 142     volatile sig_atomic_t recurse = 0;
 143     if (!recurse) {
 144         size_t i;
 145
 146         recurse = 1;
 147
 148         /* Call all the hooks. */
 149         for (i = 0; i < n_hooks; i++) {
 150             hooks[i].func(hooks[i].aux);
 151         }
 152     }
 153
 154     /* Re-raise the signal with the default handling so that the program
 155      * termination status reflects that we were killed by this signal */
 156     signal(sig_nr, SIG_DFL);
 157     raise(sig_nr);
 158 }
 159 \f
 160 static char **files;
 161 static size_t n_files, max_files;
 162 static bool disabled;
 163
 164 static void unlink_files(void *aux);
 165 static void do_unlink_files(void);
 166
 167 /* Registers 'file' to be unlinked when the program terminates via exit() or a
 168  * fatal signal. */
 169 void
 170 fatal_signal_add_file_to_unlink(const char *file)
 171 {
 172     static bool added_hook = false;
 173     if (!added_hook) {
 174         added_hook = true;
 175         fatal_signal_add_hook(unlink_files, NULL);
 176         atexit(do_unlink_files);
 177     }
 178
 179     fatal_signal_block();
 180     if (n_files >= max_files) {
 181         max_files = max_files * 2 + 1;
 182         files = xrealloc(files, sizeof *files * max_files);
 183     }
 184     files[n_files++] = xstrdup(file);
 185     fatal_signal_unblock();
 186 }
 187
 188 /* Unregisters 'file' from being unlinked when the program terminates via
 189  * exit() or a fatal signal. */
 190 void
 191 fatal_signal_remove_file_to_unlink(const char *file)
 192 {
 193     size_t i;
 194
 195     fatal_signal_block();
 196     for (i = 0; i < n_files; i++) {
 197         if (!strcmp(files[i], file)) {
 198             free(files[i]);
 199             files[i] = files[--n_files];
 200             break;
 201         }
 202     }
 203     fatal_signal_unblock();
 204 }
 205
 206 static void
 207 unlink_files(void *aux UNUSED)
 208 {
 209     do_unlink_files();
 210 }
 211
 212 static void
 213 do_unlink_files(void)
 214 {
 215     if (!disabled) {
 216         size_t i;
 217
 218         for (i = 0; i < n_files; i++) {
 219             unlink(files[i]);
 220         }
 221     }
 222 }
 223 \f
 224 /* Disables the fatal signal hook mechanism.  Following a fork, one of the
 225  * resulting processes can call this function to allow it to terminate without
 226  * triggering fatal signal processing or removing files.  Fatal signal
 227  * processing is still enabled in the other process. */
 228 void
 229 fatal_signal_fork(void)
 230 {
 231     size_t i;
 232
 233     disabled = true;
 234
 235     for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) {
 236         int sig_nr = fatal_signals[i];
 237         if (signal(sig_nr, SIG_DFL) == SIG_IGN) {
 238             signal(sig_nr, SIG_IGN);
 239         }
 240     }
 241 }
 242 \f
 243 static void
 244 call_sigprocmask(int how, sigset_t* new_set, sigset_t* old_set)
 245 {
 246     int error = sigprocmask(how, new_set, old_set);
 247     if (error) {
 248         fprintf(stderr, "sigprocmask: %s\n", strerror(errno));
 249     }
 250 }