lib/fatal-signal.c

   1 /* Emergency actions in case of a fatal signal.
   2    Copyright (C) 2003-2004, 2006 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2003.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19
  20 #ifdef HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 /* Specification.  */
  25 #include "fatal-signal.h"
  26
  27 #include <stdbool.h>
  28 #include <stdlib.h>
  29 #include <signal.h>
  30 #include <string.h>
  31 #include <unistd.h>
  32
  33 #include "xalloc.h"
  34
  35 #define SIZEOF(a) (sizeof(a) / sizeof(a[0]))
  36
  37
  38 /* ========================================================================= */
  39
  40
  41 /* The list of fatal signals.
  42    These are those signals whose default action is to terminate the process
  43    without a core dump, except
  44      SIGKILL - because it cannot be caught,
  45      SIGALRM SIGUSR1 SIGUSR2 SIGPOLL SIGIO SIGLOST - because applications
  46        often use them for their own purpose,
  47      SIGPROF SIGVTALRM - because they are used for profiling,
  48      SIGSTKFLT - because it is more similar to SIGFPE, SIGSEGV, SIGBUS,
  49      SIGSYS - because it is more similar to SIGABRT, SIGSEGV,
  50      SIGPWR - because it of too special use,
  51      SIGRTMIN...SIGRTMAX - because they are reserved for application use.
  52    plus
  53      SIGXCPU, SIGXFSZ - because they are quite similar to SIGTERM.  */
  54
  55 static int fatal_signals[] =
  56   {
  57     /* ISO C 99 signals.  */
  58 #ifdef SIGINT
  59     SIGINT,
  60 #endif
  61 #ifdef SIGTERM
  62     SIGTERM,
  63 #endif
  64     /* POSIX:2001 signals.  */
  65 #ifdef SIGHUP
  66     SIGHUP,
  67 #endif
  68 #ifdef SIGPIPE
  69     SIGPIPE,
  70 #endif
  71     /* BSD signals.  */
  72 #ifdef SIGXCPU
  73     SIGXCPU,
  74 #endif
  75 #ifdef SIGXFSZ
  76     SIGXFSZ,
  77 #endif
  78     0
  79   };
  80
  81 #define num_fatal_signals (SIZEOF (fatal_signals) - 1)
  82
  83 /* Eliminate signals whose signal handler is SIG_IGN.  */
  84
  85 static void
  86 init_fatal_signals (void)
  87 {
  88   static bool fatal_signals_initialized = false;
  89   if (!fatal_signals_initialized)
  90     {
  91 #if HAVE_SIGACTION
  92       size_t i;
  93
  94       for (i = 0; i < num_fatal_signals; i++)
  95         {
  96           struct sigaction action;
  97
  98           if (sigaction (fatal_signals[i], NULL, &action) >= 0
  99               && action.sa_handler == SIG_IGN)
 100             fatal_signals[i] = -1;
 101         }
 102 #endif
 103
 104       fatal_signals_initialized = true;
 105     }
 106 }
 107
 108
 109 /* ========================================================================= */
 110
 111
 112 typedef void (*action_t) (void);
 113
 114 /* Type of an entry in the actions array.
 115    The 'action' field is accessed from within the fatal_signal_handler(),
 116    therefore we mark it as 'volatile'.  */
 117 typedef struct
 118 {
 119   volatile action_t action;
 120 }
 121 actions_entry_t;
 122
 123 /* The registered cleanup actions.  */
 124 static actions_entry_t static_actions[32];
 125 static actions_entry_t * volatile actions = static_actions;
 126 static sig_atomic_t volatile actions_count = 0;
 127 static size_t actions_allocated = SIZEOF (static_actions);
 128
 129
 130 /* Uninstall the handlers.  */
 131 static inline void
 132 uninstall_handlers ()
 133 {
 134   size_t i;
 135
 136   for (i = 0; i < num_fatal_signals; i++)
 137     if (fatal_signals[i] >= 0)
 138       signal (fatal_signals[i], SIG_DFL);
 139 }
 140
 141
 142 /* The signal handler.  It gets called asynchronously.  */
 143 static void
 144 fatal_signal_handler (int sig)
 145 {
 146   for (;;)
 147     {
 148       /* Get the last registered cleanup action, in a reentrant way.  */
 149       action_t action;
 150       size_t n = actions_count;
 151       if (n == 0)
 152         break;
 153       n--;
 154       actions_count = n;
 155       action = actions[n].action;
 156       /* Execute the action.  */
 157       action ();
 158     }
 159
 160   /* Now execute the signal's default action.
 161      If signal() blocks the signal being delivered for the duration of the
 162      signal handler's execution, the re-raised signal is delivered when this
 163      handler returns; otherwise it is delivered already during raise().  */
 164   uninstall_handlers ();
 165 #if HAVE_RAISE
 166   raise (sig);
 167 #else
 168   kill (getpid (), sig);
 169 #endif
 170 }
 171
 172
 173 /* Install the handlers.  */
 174 static inline void
 175 install_handlers ()
 176 {
 177   size_t i;
 178
 179   for (i = 0; i < num_fatal_signals; i++)
 180     if (fatal_signals[i] >= 0)
 181       signal (fatal_signals[i], &fatal_signal_handler);
 182 }
 183
 184
 185 /* Register a cleanup function to be executed when a catchable fatal signal
 186    occurs.  */
 187 void
 188 at_fatal_signal (action_t action)
 189 {
 190   static bool cleanup_initialized = false;
 191   if (!cleanup_initialized)
 192     {
 193       init_fatal_signals ();
 194       install_handlers ();
 195       cleanup_initialized = true;
 196     }
 197
 198   if (actions_count == actions_allocated)
 199     {
 200       /* Extend the actions array.  Note that we cannot use xrealloc(),
 201          because then the cleanup() function could access an already
 202          deallocated array.  */
 203       actions_entry_t *old_actions = actions;
 204       size_t new_actions_allocated = 2 * actions_allocated;
 205       actions_entry_t *new_actions =
 206         xmalloc (new_actions_allocated * sizeof (actions_entry_t));
 207
 208       memcpy (new_actions, old_actions,
 209               actions_allocated * sizeof (actions_entry_t));
 210       actions = new_actions;
 211       actions_allocated = new_actions_allocated;
 212       /* Now we can free the old actions array.  */
 213       if (old_actions != static_actions)
 214         free (old_actions);
 215     }
 216   /* The two uses of 'volatile' in the types above (and ISO C 99 section
 217      5.1.2.3.(5)) ensure that we increment the actions_count only after
 218      the new action has been written to the memory location
 219      actions[actions_count].  */
 220   actions[actions_count].action = action;
 221   actions_count++;
 222 }
 223
 224
 225 /* ========================================================================= */
 226
 227
 228 #if HAVE_POSIX_SIGNALBLOCKING
 229
 230 static sigset_t fatal_signal_set;
 231
 232 static void
 233 init_fatal_signal_set ()
 234 {
 235   static bool fatal_signal_set_initialized = false;
 236   if (!fatal_signal_set_initialized)
 237     {
 238       size_t i;
 239
 240       init_fatal_signals ();
 241
 242       sigemptyset (&fatal_signal_set);
 243       for (i = 0; i < num_fatal_signals; i++)
 244         if (fatal_signals[i] >= 0)
 245           sigaddset (&fatal_signal_set, fatal_signals[i]);
 246
 247       fatal_signal_set_initialized = true;
 248     }
 249 }
 250
 251 /* Temporarily delay the catchable fatal signals.  */
 252 void
 253 block_fatal_signals ()
 254 {
 255   init_fatal_signal_set ();
 256   sigprocmask (SIG_BLOCK, &fatal_signal_set, NULL);
 257 }
 258
 259 /* Stop delaying the catchable fatal signals.  */
 260 void
 261 unblock_fatal_signals ()
 262 {
 263   init_fatal_signal_set ();
 264   sigprocmask (SIG_UNBLOCK, &fatal_signal_set, NULL);
 265 }
 266
 267 #else
 268
 269 /* Don't bother caring about the old systems which don't have POSIX signal
 270    blocking.  */
 271
 272 void
 273 block_fatal_signals ()
 274 {
 275 }
 276
 277 void
 278 unblock_fatal_signals ()
 279 {
 280 }
 281
 282 #endif