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