1 /* Stack overflow handling.
3 Copyright (C) 2002, 2004, 2006, 2008 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 3 of the License, or
8 (at your option) any later version.
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, see <http://www.gnu.org/licenses/>. */
18 /* Written by Paul Eggert. */
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.
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.
34 No attempt has been made to deal with multithreaded applications. */
40 # define __attribute__(x)
45 #define _(msgid) gettext (msgid)
49 # define ENOTSUP EINVAL
52 # define EOVERFLOW EINVAL
56 #if ! HAVE_STACK_T && ! defined stack_t
57 typedef struct sigaltstack stack_t;
63 #if HAVE_SYS_RESOURCE_H
64 /* Include sys/time.h here, because...
65 SunOS-4.1.x <sys/resource.h> fails to include <sys/time.h>.
66 This gives "incomplete type" errors for ru_utime and tu_stime. */
68 # include <sys/time.h>
70 # include <sys/resource.h>
74 # include <ucontext.h>
79 # define STDERR_FILENO 2
89 #if (HAVE_STRUCT_SIGACTION_SA_SIGACTION && defined SA_NODEFER \
90 && defined SA_ONSTACK && defined SA_RESETHAND && defined SA_SIGINFO)
91 # define SIGACTION_WORKS 1
93 # define SIGACTION_WORKS 0
96 extern char *program_name;
98 /* The user-specified action to take when a SEGV-related program error
99 or stack overflow occurs. */
100 static void (* volatile segv_action) (int);
102 /* Translated messages for program errors and stack overflow. Do not
103 translate them in the signal handler, since gettext is not
104 async-signal-safe. */
105 static char const * volatile program_error_message;
106 static char const * volatile stack_overflow_message;
108 /* Output an error message, then exit with status EXIT_FAILURE if it
109 appears to have been a stack overflow, or with a core dump
110 otherwise. This function is async-signal-safe. */
112 static void die (int) __attribute__ ((noreturn));
118 message = signo ? program_error_message : stack_overflow_message;
119 write (STDERR_FILENO, program_name, strlen (program_name));
120 write (STDERR_FILENO, ": ", 2);
121 write (STDERR_FILENO, message, strlen (message));
122 write (STDERR_FILENO, "\n", 1);
124 _exit (exit_failure);
125 kill (getpid (), signo);
129 #if HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK
131 /* Direction of the C runtime stack. This function is
132 async-signal-safe. */
135 # define find_stack_direction(ptr) STACK_DIRECTION
138 find_stack_direction (char const *addr)
141 return ! addr ? find_stack_direction (&dummy) : addr < &dummy ? 1 : -1;
145 /* Storage for the alternate signal stack. */
148 char buffer[SIGSTKSZ];
150 /* These other members are for proper alignment. There's no
151 standard way to guarantee stack alignment, but this seems enough
156 } alternate_signal_stack;
160 /* Handle a segmentation violation and exit. This function is
161 async-signal-safe. */
163 static void segv_handler (int, siginfo_t *, void *) __attribute__((noreturn));
165 segv_handler (int signo, siginfo_t *info,
166 void *context __attribute__ ((unused)))
168 /* Clear SIGNO if it seems to have been a stack overflow. */
169 if (0 < info->si_code)
171 # if ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
172 /* We can't easily determine whether it is a stack overflow; so
173 assume that the rest of our program is perfect (!) and that
174 this segmentation violation is a stack overflow. */
177 /* If the faulting address is within the stack, or within one
178 page of the stack end, assume that it is a stack
180 ucontext_t const *user_context = context;
181 char const *stack_base = user_context->uc_stack.ss_sp;
182 size_t stack_size = user_context->uc_stack.ss_size;
183 char const *faulting_address = info->si_addr;
184 size_t s = faulting_address - stack_base;
185 size_t page_size = sysconf (_SC_PAGESIZE);
186 if (find_stack_direction (0) < 0)
188 if (s < stack_size + page_size)
195 "segv_handler fault=%p base=%p size=%lx page=%lx signo=%d\n",
196 faulting_address, stack_base, (unsigned long) stack_size,
197 (unsigned long) page_size, signo);
198 write (STDERR_FILENO, buf, strlen (buf));
209 null_action (int signo __attribute__ ((unused)))
213 /* Set up ACTION so that it is invoked on C stack overflow. Return -1
214 (setting errno) if this cannot be done.
216 When ACTION is called, it is passed an argument equal to SIGSEGV
217 for a segmentation violation that does not appear related to stack
218 overflow, and is passed zero otherwise. On many platforms it is
219 hard to tell; when in doubt, zero is passed.
221 A null ACTION acts like an action that does nothing.
223 ACTION must be async-signal-safe. ACTION together with its callees
224 must not require more than SIGSTKSZ bytes of stack space. */
227 c_stack_action (void (*action) (int))
232 st.ss_sp = alternate_signal_stack.buffer;
233 st.ss_size = sizeof alternate_signal_stack.buffer;
234 r = sigaltstack (&st, 0);
238 segv_action = action ? action : null_action;
239 program_error_message = _("program error");
240 stack_overflow_message = _("stack overflow");
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);
256 return signal (SIGSEGV, die) == SIG_ERR ? -1 : 0;
261 #else /* ! (HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK) */
264 c_stack_action (void (*action) (int) __attribute__ ((unused)))
276 int volatile exit_failure;
283 return *p + recurse (array);
289 main (int argc __attribute__ ((unused)), char **argv)
291 program_name = argv[0];
293 "The last output line should contain \"stack overflow\".\n");
294 if (c_stack_action (0) == 0)
295 return recurse ("\1");
296 perror ("c_stack_action");
304 compile-command: "gcc -DDEBUG -g -O -Wall -W c-stack.c"