lib/c-stack.c

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