lib/c-stack.c

   1 /* Stack overflow handling.
   2
   3    Copyright (C) 2002, 2004, 2006, 2008 Free Software Foundation, Inc.
   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 3 of the License, or
   8    (at your option) 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, see <http://www.gnu.org/licenses/>.  */
  17
  18 /* Written by Paul Eggert.  */
  19
  20 /* NOTES:
  21
  22    A program that uses alloca, dynamic arrays, or large local
  23    variables may extend the stack by more than a page at a time.  If
  24    so, when the stack overflows the operating system may not detect
  25    the overflow until the program uses the array, and this module may
  26    incorrectly report a program error instead of a stack overflow.
  27
  28    To avoid this problem, allocate only small objects on the stack; a
  29    program should be OK if it limits single allocations to a page or
  30    less.  Allocate larger arrays in static storage, or on the heap
  31    (e.g., with malloc).  Yes, this is a pain, but we don't know of any
  32    better solution that is portable.
  33
  34    No attempt has been made to deal with multithreaded applications.  */
  35
  36 #include <config.h>
  37
  38 #ifndef __attribute__
  39 # if __GNUC__ < 3
  40 #  define __attribute__(x)
  41 # endif
  42 #endif
  43
  44 #include "gettext.h"
  45 #define _(msgid) gettext (msgid)
  46
  47 #include <errno.h>
  48 #ifndef ENOTSUP
  49 # define ENOTSUP EINVAL
  50 #endif
  51
  52 #include <signal.h>
  53 #if ! HAVE_STACK_T && ! defined stack_t
  54 typedef struct sigaltstack stack_t;
  55 #endif
  56 #ifndef SIGSTKSZ
  57 # define SIGSTKSZ 16384
  58 #endif
  59
  60 #include <stdlib.h>
  61 #include <string.h>
  62
  63 /* Posix 2001 declares ucontext_t in <ucontext.h>, Posix 200x in
  64    <signal.h>.  */
  65 #if HAVE_UCONTEXT_H
  66 # include <ucontext.h>
  67 #endif
  68
  69 #include <unistd.h>
  70 #ifndef STDERR_FILENO
  71 # define STDERR_FILENO 2
  72 #endif
  73
  74 #if HAVE_LIBSIGSEGV
  75 # include <sigsegv.h>
  76 #endif
  77
  78 #include "c-stack.h"
  79 #include "exitfail.h"
  80
  81 #if defined SA_ONSTACK && defined SA_SIGINFO
  82 # define SIGACTION_WORKS 1
  83 #else
  84 # define SIGACTION_WORKS 0
  85 #endif
  86
  87 extern char *program_name;
  88
  89 /* The user-specified action to take when a SEGV-related program error
  90    or stack overflow occurs.  */
  91 static void (* volatile segv_action) (int);
  92
  93 /* Translated messages for program errors and stack overflow.  Do not
  94    translate them in the signal handler, since gettext is not
  95    async-signal-safe.  */
  96 static char const * volatile program_error_message;
  97 static char const * volatile stack_overflow_message;
  98
  99 /* Output an error message, then exit with status EXIT_FAILURE if it
 100    appears to have been a stack overflow, or with a core dump
 101    otherwise.  This function is async-signal-safe.  */
 102
 103 static void die (int) __attribute__ ((noreturn));
 104 static void
 105 die (int signo)
 106 {
 107   char const *message;
 108   segv_action (signo);
 109   message = signo ? program_error_message : stack_overflow_message;
 110   write (STDERR_FILENO, program_name, strlen (program_name));
 111   write (STDERR_FILENO, ": ", 2);
 112   write (STDERR_FILENO, message, strlen (message));
 113   write (STDERR_FILENO, "\n", 1);
 114   if (! signo)
 115     _exit (exit_failure);
 116   raise (signo);
 117   abort ();
 118 }
 119
 120 #if (HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK \
 121      && HAVE_STACK_OVERFLOW_HANDLING) || HAVE_LIBSIGSEGV
 122
 123 /* Storage for the alternate signal stack.  */
 124 static union
 125 {
 126   char buffer[SIGSTKSZ];
 127
 128   /* These other members are for proper alignment.  There's no
 129      standard way to guarantee stack alignment, but this seems enough
 130      in practice.  */
 131   long double ld;
 132   long l;
 133   void *p;
 134 } alternate_signal_stack;
 135
 136 static void
 137 null_action (int signo __attribute__ ((unused)))
 138 {
 139 }
 140
 141 #endif /* SIGALTSTACK || LIBSIGSEGV */
 142
 143 /* Only use libsigsegv if we need it; platforms like Solaris can
 144    detect stack overflow without the overhead of an external
 145    library.  */
 146 #if HAVE_LIBSIGSEGV && ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
 147
 148 /* Nonzero if general segv handler could not be installed.  */
 149 static volatile int segv_handler_missing;
 150
 151 /* Handle a segmentation violation and exit if it cannot be stack
 152    overflow.  This function is async-signal-safe.  */
 153
 154 static int segv_handler (void *address __attribute__ ((unused)),
 155                          int serious)
 156 {
 157 # if DEBUG
 158   {
 159     char buf[1024];
 160     sprintf (buf, "segv_handler serious=%d\n", serious);
 161     write (STDERR_FILENO, buf, strlen (buf));
 162   }
 163 # endif
 164
 165   /* If this fault is not serious, return 0 to let the stack overflow
 166      handler take a shot at it.  */
 167   if (!serious)
 168     return 0;
 169   die (SIGSEGV);
 170 }
 171
 172 /* Handle a segmentation violation that is likely to be a stack
 173    overflow and exit.  This function is async-signal-safe.  */
 174
 175 static void overflow_handler (int, stackoverflow_context_t)
 176   __attribute__ ((noreturn));
 177 static void
 178 overflow_handler (int emergency,
 179                   stackoverflow_context_t context __attribute__ ((unused)))
 180 {
 181 # if DEBUG
 182   {
 183     char buf[1024];
 184     sprintf (buf, "overflow_handler emergency=%d segv_handler_missing=%d\n",
 185              emergency, segv_handler_missing);
 186     write (STDERR_FILENO, buf, strlen (buf));
 187   }
 188 # endif
 189
 190   die ((!emergency || segv_handler_missing) ? 0 : SIGSEGV);
 191 }
 192
 193 int
 194 c_stack_action (void (*action) (int))
 195 {
 196   segv_action = action ? action : null_action;
 197   program_error_message = _("program error");
 198   stack_overflow_message = _("stack overflow");
 199
 200   /* Always install the overflow handler.  */
 201   if (stackoverflow_install_handler (overflow_handler,
 202                                      alternate_signal_stack.buffer,
 203                                      sizeof alternate_signal_stack.buffer))
 204     {
 205       errno = ENOTSUP;
 206       return -1;
 207     }
 208   /* Try installing a general handler; if it fails, then treat all
 209      segv as stack overflow.  */
 210   segv_handler_missing = sigsegv_install_handler (segv_handler);
 211   return 0;
 212 }
 213
 214 #elif HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK && HAVE_STACK_OVERFLOW_HANDLING
 215
 216 /* Direction of the C runtime stack.  This function is
 217    async-signal-safe.  */
 218
 219 # if STACK_DIRECTION
 220 #  define find_stack_direction(ptr) STACK_DIRECTION
 221 # else
 222 static int
 223 find_stack_direction (char const *addr)
 224 {
 225   char dummy;
 226   return ! addr ? find_stack_direction (&dummy) : addr < &dummy ? 1 : -1;
 227 }
 228 # endif
 229
 230 # if SIGACTION_WORKS
 231
 232 /* Handle a segmentation violation and exit.  This function is
 233    async-signal-safe.  */
 234
 235 static void segv_handler (int, siginfo_t *, void *) __attribute__((noreturn));
 236 static void
 237 segv_handler (int signo, siginfo_t *info,
 238               void *context __attribute__ ((unused)))
 239 {
 240   /* Clear SIGNO if it seems to have been a stack overflow.  */
 241   if (0 < info->si_code)
 242     {
 243 #  if ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
 244       /* We can't easily determine whether it is a stack overflow; so
 245          assume that the rest of our program is perfect (!) and that
 246          this segmentation violation is a stack overflow.
 247
 248          Note that although both Linux and Solaris provide
 249          sigaltstack, SA_ONSTACK, and SA_SIGINFO, currently only
 250          Solaris satisfies the XSI heueristic.  This is because
 251          Solaris populates uc_stack with the details of the
 252          interrupted stack, while Linux populates it with the details
 253          of the current stack.  */
 254       signo = 0;
 255 #  else
 256       /* If the faulting address is within the stack, or within one
 257          page of the stack end, assume that it is a stack
 258          overflow.  */
 259       ucontext_t const *user_context = context;
 260       char const *stack_base = user_context->uc_stack.ss_sp;
 261       size_t stack_size = user_context->uc_stack.ss_size;
 262       char const *faulting_address = info->si_addr;
 263       size_t s = faulting_address - stack_base;
 264       size_t page_size = sysconf (_SC_PAGESIZE);
 265       if (find_stack_direction (NULL) < 0)
 266         s += page_size;
 267       if (s < stack_size + page_size)
 268         signo = 0;
 269
 270 #   if DEBUG
 271       {
 272         char buf[1024];
 273         sprintf (buf,
 274                  "segv_handler fault=%p base=%p size=%lx page=%lx signo=%d\n",
 275                  faulting_address, stack_base, (unsigned long) stack_size,
 276                  (unsigned long) page_size, signo);
 277         write (STDERR_FILENO, buf, strlen (buf));
 278       }
 279 #   endif
 280 #  endif
 281     }
 282
 283   die (signo);
 284 }
 285 # endif
 286
 287 int
 288 c_stack_action (void (*action) (int))
 289 {
 290   int r;
 291   stack_t st;
 292   struct sigaction act;
 293   st.ss_flags = 0;
 294 # if SIGALTSTACK_SS_REVERSED
 295   /* Irix mistakenly treats ss_sp as the upper bound, rather than
 296      lower bound, of the alternate stack.  */
 297   st.ss_sp = alternate_signal_stack.buffer + SIGSTKSZ - sizeof (void *);
 298   st.ss_size = sizeof alternate_signal_stack.buffer - sizeof (void *);
 299 # else
 300   st.ss_sp = alternate_signal_stack.buffer;
 301   st.ss_size = sizeof alternate_signal_stack.buffer;
 302 # endif
 303   r = sigaltstack (&st, NULL);
 304   if (r != 0)
 305     return r;
 306
 307   segv_action = action ? action : null_action;
 308   program_error_message = _("program error");
 309   stack_overflow_message = _("stack overflow");
 310
 311   sigemptyset (&act.sa_mask);
 312
 313 # if SIGACTION_WORKS
 314   /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER, but
 315      this is not true on Solaris 8 at least.  It doesn't hurt to use
 316      SA_NODEFER here, so leave it in.  */
 317   act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
 318   act.sa_sigaction = segv_handler;
 319 # else
 320   act.sa_flags = SA_NODEFER | SA_RESETHAND;
 321   act.sa_handler = die;
 322 # endif
 323
 324   return sigaction (SIGSEGV, &act, NULL);
 325 }
 326
 327 #else /* ! ((HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK
 328              && HAVE_STACK_OVERFLOW_HANDLING) || HAVE_LIBSIGSEGV) */
 329
 330 int
 331 c_stack_action (void (*action) (int)  __attribute__ ((unused)))
 332 {
 333   errno = ENOTSUP;
 334   return -1;
 335 }
 336
 337 #endif