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