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