1 /* Stack overflow handling.
3 Copyright (C) 2002, 2004 Free Software Foundation, Inc.
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 2, or (at your option)
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.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 /* Written by Paul Eggert. */
23 A program that uses alloca, dynamic arrays, or large local
24 variables may extend the stack by more than a page at a time. If
25 so, when the stack overflows the operating system may not detect
26 the overflow until the program uses the array, and this module may
27 incorrectly report a program error instead of a stack overflow.
29 To avoid this problem, allocate only small objects on the stack; a
30 program should be OK if it limits single allocations to a page or
31 less. Allocate larger arrays in static storage, or on the heap
32 (e.g., with malloc). Yes, this is a pain, but we don't know of any
33 better solution that is portable.
35 No attempt has been made to deal with multithreaded applications. */
42 # if __GNUC__ < 3 || __STRICT_ANSI__
43 # define __attribute__(x)
48 #define _(msgid) gettext (msgid)
52 # define ENOTSUP EINVAL
55 # define EOVERFLOW EINVAL
59 #if ! HAVE_STACK_T && ! defined stack_t
60 typedef struct sigaltstack stack_t;
66 #if HAVE_SYS_RESOURCE_H
67 /* Include sys/time.h here, because...
68 SunOS-4.1.x <sys/resource.h> fails to include <sys/time.h>.
69 This gives "incomplete type" errors for ru_utime and tu_stime. */
71 # include <sys/time.h>
73 # include <sys/resource.h>
77 # include <ucontext.h>
84 # define STDERR_FILENO 2
94 extern char *program_name;
96 /* The user-specified action to take when a SEGV-related program error
97 or stack overflow occurs. */
98 static void (* volatile segv_action) (int);
100 /* Translated messages for program errors and stack overflow. Do not
101 translate them in the signal handler, since gettext is not
102 async-signal-safe. */
103 static char const * volatile program_error_message;
104 static char const * volatile stack_overflow_message;
106 /* Output an error message, then exit with status EXIT_FAILURE if it
107 appears to have been a stack overflow, or with a core dump
108 otherwise. This function is async-signal-safe. */
110 static void die (int) __attribute__ ((noreturn));
116 message = signo ? program_error_message : stack_overflow_message;
117 write (STDERR_FILENO, program_name, strlen (program_name));
118 write (STDERR_FILENO, ": ", 2);
119 write (STDERR_FILENO, message, strlen (message));
120 write (STDERR_FILENO, "\n", 1);
122 _exit (exit_failure);
123 kill (getpid (), signo);
127 #if HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK
129 /* Direction of the C runtime stack. This function is
130 async-signal-safe. */
133 # define find_stack_direction(ptr) STACK_DIRECTION
136 find_stack_direction (char const *addr)
139 return ! addr ? find_stack_direction (&dummy) : addr < &dummy ? 1 : -1;
143 /* Storage for the alternate signal stack. */
146 char buffer[SIGSTKSZ];
148 /* These other members are for proper alignment. There's no
149 standard way to guarantee stack alignment, but this seems enough
154 } alternate_signal_stack;
156 # if defined SA_ONSTACK && defined SA_SIGINFO && defined _SC_PAGESIZE
158 /* Handle a segmentation violation and exit. This function is
159 async-signal-safe. */
161 static void segv_handler (int, siginfo_t *, void *) __attribute__((noreturn));
163 segv_handler (int signo, siginfo_t *info,
164 void *context __attribute__ ((unused)))
166 /* Clear SIGNO if it seems to have been a stack overflow. */
167 if (0 < info->si_code)
169 # if ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
170 /* We can't easily determine whether it is a stack overflow; so
171 assume that the rest of our program is perfect (!) and that
172 this segmentation violation is a stack overflow. */
175 /* If the faulting address is within the stack, or within one
176 page of the stack end, assume that it is a stack
178 ucontext_t const *user_context = context;
179 char const *stack_base = user_context->uc_stack.ss_sp;
180 size_t stack_size = user_context->uc_stack.ss_size;
181 char const *faulting_address = info->si_addr;
182 size_t s = faulting_address - stack_base;
183 size_t page_size = sysconf (_SC_PAGESIZE);
184 if (find_stack_direction (0) < 0)
186 if (s < stack_size + page_size)
193 "segv_handler fault=%p base=%p size=%lx page=%lx signo=%d\n",
194 faulting_address, stack_base, (unsigned long) stack_size,
195 (unsigned long) page_size, signo);
196 write (STDERR_FILENO, buf, strlen (buf));
207 null_action (int signo __attribute__ ((unused)))
211 /* Set up ACTION so that it is invoked on C stack overflow. Return -1
212 (setting errno) if this cannot be done.
214 When ACTION is called, it is passed an argument equal to SIGSEGV
215 for a segmentation violation that does not appear related to stack
216 overflow, and is passed zero otherwise. On many platforms it is
217 hard to tell; when in doubt, zero is passed.
219 A null ACTION acts like an action that does nothing.
221 ACTION must be async-signal-safe. ACTION together with its callees
222 must not require more than SIGSTKSZ bytes of stack space. */
225 c_stack_action (void (*action) (int))
230 st.ss_sp = alternate_signal_stack.buffer;
231 st.ss_size = sizeof alternate_signal_stack.buffer;
232 r = sigaltstack (&st, 0);
236 segv_action = action ? action : null_action;
237 program_error_message = _("program error");
238 stack_overflow_message = _("stack overflow");
241 # if ! (defined SA_ONSTACK && defined SA_SIGINFO && defined _SC_PAGESIZE)
242 return signal (SIGSEGV, die) == SIG_ERR ? -1 : 0;
244 struct sigaction act;
245 sigemptyset (&act.sa_mask);
247 /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER, but
248 this is not true on Solaris 8 at least. It doesn't hurt to use
249 SA_NODEFER here, so leave it in. */
250 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
252 act.sa_sigaction = segv_handler;
254 return sigaction (SIGSEGV, &act, 0);
259 #else /* ! (HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK) */
262 c_stack_action (void (*action) (int) __attribute__ ((unused)))
274 int volatile exit_failure;
281 return *p + recurse (array);
287 main (int argc __attribute__ ((unused)), char **argv)
289 program_name = argv[0];
291 "The last output line should contain \"stack overflow\".\n");
292 if (c_stack_action (0) == 0)
293 return recurse ("\1");
294 perror ("c_stack_action");
302 compile-command: "gcc -DDEBUG -DHAVE_CONFIG_H -I.. -g -O -Wall -W c-stack.c"