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
  57 #include <stdlib.h>
  58 #include <string.h>
  59
  60 #if HAVE_SYS_RESOURCE_H
  61 /* Include sys/time.h here, because...
  62    SunOS-4.1.x <sys/resource.h> fails to include <sys/time.h>.
  63    This gives "incomplete type" errors for ru_utime and tu_stime.  */
  64 # if HAVE_SYS_TIME_H
  65 #  include <sys/time.h>
  66 # endif
  67 # include <sys/resource.h>
  68 #endif
  69
  70 #if HAVE_UCONTEXT_H
  71 # include <ucontext.h>
  72 #endif
  73
  74 #include <unistd.h>
  75 #ifndef STDERR_FILENO
  76 # define STDERR_FILENO 2
  77 #endif
  78
  79 #if DEBUG
  80 # include <stdio.h>
  81 #endif
  82
  83 #include "c-stack.h"
  84 #include "exitfail.h"
  85
  86 #if (HAVE_STRUCT_SIGACTION_SA_SIGACTION && defined SA_NODEFER \
  87      && defined SA_ONSTACK && defined SA_RESETHAND && defined SA_SIGINFO)
  88 # define SIGACTION_WORKS 1
  89 #else
  90 # define SIGACTION_WORKS 0
  91 #endif
  92
  93 extern char *program_name;
  94
  95 /* The user-specified action to take when a SEGV-related program error
  96    or stack overflow occurs.  */
  97 static void (* volatile segv_action) (int);
  98
  99 /* Translated messages for program errors and stack overflow.  Do not
 100    translate them in the signal handler, since gettext is not
 101    async-signal-safe.  */
 102 static char const * volatile program_error_message;
 103 static char const * volatile stack_overflow_message;
 104
 105 /* Output an error message, then exit with status EXIT_FAILURE if it
 106    appears to have been a stack overflow, or with a core dump
 107    otherwise.  This function is async-signal-safe.  */
 108
 109 static void die (int) __attribute__ ((noreturn));
 110 static void
 111 die (int signo)
 112 {
 113   char const *message;
 114   segv_action (signo);
 115   message = signo ? program_error_message : stack_overflow_message;
 116   write (STDERR_FILENO, program_name, strlen (program_name));
 117   write (STDERR_FILENO, ": ", 2);
 118   write (STDERR_FILENO, message, strlen (message));
 119   write (STDERR_FILENO, "\n", 1);
 120   if (! signo)
 121     _exit (exit_failure);
 122   raise (signo);
 123   abort ();
 124 }
 125
 126 #if HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK
 127
 128 /* Direction of the C runtime stack.  This function is
 129    async-signal-safe.  */
 130
 131 # if STACK_DIRECTION
 132 #  define find_stack_direction(ptr) STACK_DIRECTION
 133 # else
 134 static int
 135 find_stack_direction (char const *addr)
 136 {
 137   char dummy;
 138   return ! addr ? find_stack_direction (&dummy) : addr < &dummy ? 1 : -1;
 139 }
 140 # endif
 141
 142 /* Storage for the alternate signal stack.  */
 143 static union
 144 {
 145   char buffer[SIGSTKSZ];
 146
 147   /* These other members are for proper alignment.  There's no
 148      standard way to guarantee stack alignment, but this seems enough
 149      in practice.  */
 150   long double ld;
 151   long l;
 152   void *p;
 153 } alternate_signal_stack;
 154
 155 # if SIGACTION_WORKS
 156
 157 /* Handle a segmentation violation and exit.  This function is
 158    async-signal-safe.  */
 159
 160 static void segv_handler (int, siginfo_t *, void *) __attribute__((noreturn));
 161 static void
 162 segv_handler (int signo, siginfo_t *info,
 163               void *context __attribute__ ((unused)))
 164 {
 165   /* Clear SIGNO if it seems to have been a stack overflow.  */
 166   if (0 < info->si_code)
 167     {
 168 #  if ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
 169       /* We can't easily determine whether it is a stack overflow; so
 170          assume that the rest of our program is perfect (!) and that
 171          this segmentation violation is a stack overflow.  */
 172       signo = 0;
 173 #  else
 174       /* If the faulting address is within the stack, or within one
 175          page of the stack end, assume that it is a stack
 176          overflow.  */
 177       ucontext_t const *user_context = context;
 178       char const *stack_base = user_context->uc_stack.ss_sp;
 179       size_t stack_size = user_context->uc_stack.ss_size;
 180       char const *faulting_address = info->si_addr;
 181       size_t s = faulting_address - stack_base;
 182       size_t page_size = sysconf (_SC_PAGESIZE);
 183       if (find_stack_direction (0) < 0)
 184         s += page_size;
 185       if (s < stack_size + page_size)
 186         signo = 0;
 187
 188 #   if DEBUG
 189       {
 190         char buf[1024];
 191         sprintf (buf,
 192                  "segv_handler fault=%p base=%p size=%lx page=%lx signo=%d\n",
 193                  faulting_address, stack_base, (unsigned long) stack_size,
 194                  (unsigned long) page_size, signo);
 195         write (STDERR_FILENO, buf, strlen (buf));
 196       }
 197 #   endif
 198 #  endif
 199     }
 200
 201   die (signo);
 202 }
 203 # endif
 204
 205 static void
 206 null_action (int signo __attribute__ ((unused)))
 207 {
 208 }
 209
 210 /* Set up ACTION so that it is invoked on C stack overflow.  Return -1
 211    (setting errno) if this cannot be done.
 212
 213    When ACTION is called, it is passed an argument equal to SIGSEGV
 214    for a segmentation violation that does not appear related to stack
 215    overflow, and is passed zero otherwise.  On many platforms it is
 216    hard to tell; when in doubt, zero is passed.
 217
 218    A null ACTION acts like an action that does nothing.
 219
 220    ACTION must be async-signal-safe.  ACTION together with its callees
 221    must not require more than SIGSTKSZ bytes of stack space.  */
 222
 223 int
 224 c_stack_action (void (*action) (int))
 225 {
 226   int r;
 227   stack_t st;
 228   st.ss_flags = 0;
 229   st.ss_sp = alternate_signal_stack.buffer;
 230   st.ss_size = sizeof alternate_signal_stack.buffer;
 231   r = sigaltstack (&st, 0);
 232   if (r != 0)
 233     return r;
 234
 235   segv_action = action ? action : null_action;
 236   program_error_message = _("program error");
 237   stack_overflow_message = _("stack overflow");
 238
 239   {
 240 # if SIGACTION_WORKS
 241     struct sigaction act;
 242     sigemptyset (&act.sa_mask);
 243
 244     /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER, but
 245        this is not true on Solaris 8 at least.  It doesn't hurt to use
 246        SA_NODEFER here, so leave it in.  */
 247     act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
 248
 249     act.sa_sigaction = segv_handler;
 250
 251     return sigaction (SIGSEGV, &act, 0);
 252 # else
 253     return signal (SIGSEGV, die) == SIG_ERR ? -1 : 0;
 254 # endif
 255   }
 256 }
 257
 258 #else /* ! (HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK) */
 259
 260 int
 261 c_stack_action (void (*action) (int)  __attribute__ ((unused)))
 262 {
 263   errno = ENOTSUP;
 264   return -1;
 265 }
 266
 267 #endif
 268
 269 \f
 270
 271 #if DEBUG
 272
 273 int volatile exit_failure;
 274
 275 static long
 276 recurse (char *p)
 277 {
 278   char array[500];
 279   array[0] = 1;
 280   return *p + recurse (array);
 281 }
 282
 283 char *program_name;
 284
 285 int
 286 main (int argc __attribute__ ((unused)), char **argv)
 287 {
 288   program_name = argv[0];
 289   fprintf (stderr,
 290            "The last output line should contain \"stack overflow\".\n");
 291   if (c_stack_action (0) == 0)
 292     return recurse ("\1");
 293   perror ("c_stack_action");
 294   return 1;
 295 }
 296
 297 #endif /* DEBUG */
 298 \f
 299 /*
 300 Local Variables:
 301 compile-command: "gcc -DDEBUG -g -O -Wall -W c-stack.c"
 302 End:
 303 */