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) || HAVE_LIBSIGSEGV
 121
 122 /* Storage for the alternate signal stack.  */
 123 static union
 124 {
 125   char buffer[SIGSTKSZ];
 126
 127   /* These other members are for proper alignment.  There's no
 128      standard way to guarantee stack alignment, but this seems enough
 129      in practice.  */
 130   long double ld;
 131   long l;
 132   void *p;
 133 } alternate_signal_stack;
 134
 135 static void
 136 null_action (int signo __attribute__ ((unused)))
 137 {
 138 }
 139
 140 #endif /* SIGALTSTACK || LIBSIGSEGV */
 141
 142 /* Only use libsigsegv if we need it; platforms like Solaris can
 143    detect stack overflow without the overhead of an external
 144    library.  */
 145 #if HAVE_LIBSIGSEGV && ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
 146
 147 /* Nonzero if general segv handler could not be installed.  */
 148 static volatile int segv_handler_missing;
 149
 150 /* Handle a segmentation violation and exit if it cannot be stack
 151    overflow.  This function is async-signal-safe.  */
 152
 153 static int segv_handler (void *address __attribute__ ((unused)),
 154                          int serious)
 155 {
 156 # if DEBUG
 157   {
 158     char buf[1024];
 159     sprintf (buf, "segv_handler serious=%d\n", serious);
 160     write (STDERR_FILENO, buf, strlen (buf));
 161   }
 162 # endif
 163
 164   /* If this fault is not serious, return 0 to let the stack overflow
 165      handler take a shot at it.  */
 166   if (!serious)
 167     return 0;
 168   die (SIGSEGV);
 169 }
 170
 171 /* Handle a segmentation violation that is likely to be a stack
 172    overflow and exit.  This function is async-signal-safe.  */
 173
 174 static void overflow_handler (int, stackoverflow_context_t)
 175   __attribute__ ((noreturn));
 176 static void
 177 overflow_handler (int emergency,
 178                   stackoverflow_context_t context __attribute__ ((unused)))
 179 {
 180 # if DEBUG
 181   {
 182     char buf[1024];
 183     sprintf (buf, "overflow_handler emergency=%d segv_handler_missing=%d\n",
 184              emergency, segv_handler_missing);
 185     write (STDERR_FILENO, buf, strlen (buf));
 186   }
 187 # endif
 188
 189   die ((!emergency || segv_handler_missing) ? 0 : SIGSEGV);
 190 }
 191
 192 int
 193 c_stack_action (void (*action) (int))
 194 {
 195   segv_action = action ? action : null_action;
 196   program_error_message = _("program error");
 197   stack_overflow_message = _("stack overflow");
 198
 199   /* Always install the overflow handler.  */
 200   if (stackoverflow_install_handler (overflow_handler,
 201                                      alternate_signal_stack.buffer,
 202                                      sizeof alternate_signal_stack.buffer))
 203     {
 204       errno = ENOTSUP;
 205       return -1;
 206     }
 207   /* Try installing a general handler; if it fails, then treat all
 208      segv as stack overflow.  */
 209   segv_handler_missing = sigsegv_install_handler (segv_handler);
 210   return 0;
 211 }
 212
 213 #elif HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK
 214
 215 /* Direction of the C runtime stack.  This function is
 216    async-signal-safe.  */
 217
 218 # if STACK_DIRECTION
 219 #  define find_stack_direction(ptr) STACK_DIRECTION
 220 # else
 221 static int
 222 find_stack_direction (char const *addr)
 223 {
 224   char dummy;
 225   return ! addr ? find_stack_direction (&dummy) : addr < &dummy ? 1 : -1;
 226 }
 227 # endif
 228
 229 # if SIGACTION_WORKS
 230
 231 /* Handle a segmentation violation and exit.  This function is
 232    async-signal-safe.  */
 233
 234 static void segv_handler (int, siginfo_t *, void *) __attribute__((noreturn));
 235 static void
 236 segv_handler (int signo, siginfo_t *info,
 237               void *context __attribute__ ((unused)))
 238 {
 239   /* Clear SIGNO if it seems to have been a stack overflow.  */
 240   if (0 < info->si_code)
 241     {
 242 #  if ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
 243       /* We can't easily determine whether it is a stack overflow; so
 244          assume that the rest of our program is perfect (!) and that
 245          this segmentation violation is a stack overflow.
 246
 247          Note that although both Linux and Solaris provide
 248          sigaltstack, SA_ONSTACK, and SA_SIGINFO, currently only
 249          Solaris satisfies the XSI heueristic.  This is because
 250          Solaris populates uc_stack with the details of the
 251          interrupted stack, while Linux populates it with the details
 252          of the current stack.  */
 253       signo = 0;
 254 #  else
 255       /* If the faulting address is within the stack, or within one
 256          page of the stack end, assume that it is a stack
 257          overflow.  */
 258       ucontext_t const *user_context = context;
 259       char const *stack_base = user_context->uc_stack.ss_sp;
 260       size_t stack_size = user_context->uc_stack.ss_size;
 261       char const *faulting_address = info->si_addr;
 262       size_t s = faulting_address - stack_base;
 263       size_t page_size = sysconf (_SC_PAGESIZE);
 264       if (find_stack_direction (NULL) < 0)
 265         s += page_size;
 266       if (s < stack_size + page_size)
 267         signo = 0;
 268
 269 #   if DEBUG
 270       {
 271         char buf[1024];
 272         sprintf (buf,
 273                  "segv_handler fault=%p base=%p size=%lx page=%lx signo=%d\n",
 274                  faulting_address, stack_base, (unsigned long) stack_size,
 275                  (unsigned long) page_size, signo);
 276         write (STDERR_FILENO, buf, strlen (buf));
 277       }
 278 #   endif
 279 #  endif
 280     }
 281
 282   die (signo);
 283 }
 284 # endif
 285
 286 int
 287 c_stack_action (void (*action) (int))
 288 {
 289   int r;
 290   stack_t st;
 291   struct sigaction act;
 292   st.ss_flags = 0;
 293   st.ss_sp = alternate_signal_stack.buffer;
 294   st.ss_size = sizeof alternate_signal_stack.buffer;
 295   r = sigaltstack (&st, NULL);
 296   if (r != 0)
 297     return r;
 298
 299   segv_action = action ? action : null_action;
 300   program_error_message = _("program error");
 301   stack_overflow_message = _("stack overflow");
 302
 303   sigemptyset (&act.sa_mask);
 304
 305 # if SIGACTION_WORKS
 306   /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER, but
 307      this is not true on Solaris 8 at least.  It doesn't hurt to use
 308      SA_NODEFER here, so leave it in.  */
 309   act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
 310   act.sa_sigaction = segv_handler;
 311 # else
 312   act.sa_flags = SA_NODEFER | SA_RESETHAND;
 313   act.sa_handler = die;
 314 # endif
 315
 316   return sigaction (SIGSEGV, &act, NULL);
 317 }
 318
 319 #else /* ! ((HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK) || HAVE_LIBSIGSEGV) */
 320
 321 int
 322 c_stack_action (void (*action) (int)  __attribute__ ((unused)))
 323 {
 324   errno = ENOTSUP;
 325   return -1;
 326 }
 327
 328 #endif