1 /* Stack overflow handling.
3 Copyright (C) 2002, 2004, 2006, 2008-2018 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 <https://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)
50 #if ! HAVE_STACK_T && ! defined stack_t
51 typedef struct sigaltstack stack_t
;
54 # define SIGSTKSZ 16384
55 #elif HAVE_LIBSIGSEGV && SIGSTKSZ < 16384
56 /* libsigsegv 2.6 through 2.8 have a bug where some architectures use
57 more than the Linux default of an 8k alternate stack when deciding
58 if a fault was caused by stack overflow. */
60 # define SIGSTKSZ 16384
66 /* Posix 2001 declares ucontext_t in <ucontext.h>, Posix 200x in
69 # include <ucontext.h>
80 #include "ignore-value.h"
81 #include "getprogname.h"
83 #if defined SA_ONSTACK && defined SA_SIGINFO
84 # define SIGINFO_WORKS 1
86 # define SIGINFO_WORKS 0
92 /* The user-specified action to take when a SEGV-related program error
93 or stack overflow occurs. */
94 static void (* volatile segv_action
) (int);
96 /* Translated messages for program errors and stack overflow. Do not
97 translate them in the signal handler, since gettext is not
99 static char const * volatile program_error_message
;
100 static char const * volatile stack_overflow_message
;
102 #if ((HAVE_LIBSIGSEGV && ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC) \
103 || (HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK \
104 && HAVE_STACK_OVERFLOW_HANDLING))
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 _Noreturn
void
114 #if !SIGINFO_WORKS && !HAVE_LIBSIGSEGV
115 /* We can't easily determine whether it is a stack overflow; so
116 assume that the rest of our program is perfect (!) and that
117 this segmentation violation is a stack overflow. */
119 #endif /* !SIGINFO_WORKS && !HAVE_LIBSIGSEGV */
121 message
= signo
? program_error_message
: stack_overflow_message
;
122 ignore_value (write (STDERR_FILENO
, getprogname (), strlen (getprogname ())));
123 ignore_value (write (STDERR_FILENO
, ": ", 2));
124 ignore_value (write (STDERR_FILENO
, message
, strlen (message
)));
125 ignore_value (write (STDERR_FILENO
, "\n", 1));
127 _exit (exit_failure
);
133 #if (HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK \
134 && HAVE_STACK_OVERFLOW_HANDLING) || HAVE_LIBSIGSEGV
136 /* Storage for the alternate signal stack. */
139 char buffer
[SIGSTKSZ
];
141 /* These other members are for proper alignment. There's no
142 standard way to guarantee stack alignment, but this seems enough
147 } alternate_signal_stack
;
150 null_action (int signo
__attribute__ ((unused
)))
154 #endif /* SIGALTSTACK || LIBSIGSEGV */
156 /* Only use libsigsegv if we need it; platforms like Solaris can
157 detect stack overflow without the overhead of an external
159 #if HAVE_LIBSIGSEGV && ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
161 /* Nonzero if general segv handler could not be installed. */
162 static volatile int segv_handler_missing
;
164 /* Handle a segmentation violation and exit if it cannot be stack
165 overflow. This function is async-signal-safe. */
167 static int segv_handler (void *address
__attribute__ ((unused
)),
173 sprintf (buf
, "segv_handler serious=%d\n", serious
);
174 write (STDERR_FILENO
, buf
, strlen (buf
));
178 /* If this fault is not serious, return 0 to let the stack overflow
179 handler take a shot at it. */
185 /* Handle a segmentation violation that is likely to be a stack
186 overflow and exit. This function is async-signal-safe. */
188 static _Noreturn
void
189 overflow_handler (int emergency
,
190 stackoverflow_context_t context
__attribute__ ((unused
)))
195 sprintf (buf
, "overflow_handler emergency=%d segv_handler_missing=%d\n",
196 emergency
, segv_handler_missing
);
197 write (STDERR_FILENO
, buf
, strlen (buf
));
201 die ((!emergency
|| segv_handler_missing
) ? 0 : SIGSEGV
);
205 c_stack_action (void (*action
) (int))
207 segv_action
= action
? action
: null_action
;
208 program_error_message
= _("program error");
209 stack_overflow_message
= _("stack overflow");
211 /* Always install the overflow handler. */
212 if (stackoverflow_install_handler (overflow_handler
,
213 alternate_signal_stack
.buffer
,
214 sizeof alternate_signal_stack
.buffer
))
219 /* Try installing a general handler; if it fails, then treat all
220 segv as stack overflow. */
221 segv_handler_missing
= sigsegv_install_handler (segv_handler
);
225 #elif HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK && HAVE_STACK_OVERFLOW_HANDLING
229 /* Handle a segmentation violation and exit. This function is
230 async-signal-safe. */
232 static _Noreturn
void
233 segv_handler (int signo
, siginfo_t
*info
,
234 void *context
__attribute__ ((unused
)))
236 /* Clear SIGNO if it seems to have been a stack overflow. */
237 # if ! HAVE_XSI_STACK_OVERFLOW_HEURISTIC
238 /* We can't easily determine whether it is a stack overflow; so
239 assume that the rest of our program is perfect (!) and that
240 this segmentation violation is a stack overflow.
242 Note that although both Linux and Solaris provide
243 sigaltstack, SA_ONSTACK, and SA_SIGINFO, currently only
244 Solaris satisfies the XSI heuristic. This is because
245 Solaris populates uc_stack with the details of the
246 interrupted stack, while Linux populates it with the details
247 of the current stack. */
250 if (0 < info
->si_code
)
252 /* If the faulting address is within the stack, or within one
253 page of the stack, assume that it is a stack overflow. */
254 ucontext_t
const *user_context
= context
;
255 char const *stack_base
= user_context
->uc_stack
.ss_sp
;
256 size_t stack_size
= user_context
->uc_stack
.ss_size
;
257 char const *faulting_address
= info
->si_addr
;
258 size_t page_size
= sysconf (_SC_PAGESIZE
);
259 size_t s
= faulting_address
- stack_base
+ page_size
;
260 if (s
< stack_size
+ 2 * page_size
)
267 "segv_handler fault=%p base=%p size=%lx page=%lx signo=%d\n",
268 faulting_address
, stack_base
, (unsigned long) stack_size
,
269 (unsigned long) page_size
, signo
);
270 write (STDERR_FILENO
, buf
, strlen (buf
));
281 c_stack_action (void (*action
) (int))
285 struct sigaction act
;
287 # if SIGALTSTACK_SS_REVERSED
288 /* Irix mistakenly treats ss_sp as the upper bound, rather than
289 lower bound, of the alternate stack. */
290 st
.ss_sp
= alternate_signal_stack
.buffer
+ SIGSTKSZ
- sizeof (void *);
291 st
.ss_size
= sizeof alternate_signal_stack
.buffer
- sizeof (void *);
293 st
.ss_sp
= alternate_signal_stack
.buffer
;
294 st
.ss_size
= sizeof alternate_signal_stack
.buffer
;
296 r
= sigaltstack (&st
, NULL
);
300 segv_action
= action
? action
: null_action
;
301 program_error_message
= _("program error");
302 stack_overflow_message
= _("stack overflow");
304 sigemptyset (&act
.sa_mask
);
307 /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER, but
308 this is not true on Solaris 8 at least. It doesn't hurt to use
309 SA_NODEFER here, so leave it in. */
310 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
311 act
.sa_sigaction
= segv_handler
;
313 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
314 act
.sa_handler
= die
;
317 # if FAULT_YIELDS_SIGBUS
318 if (sigaction (SIGBUS
, &act
, NULL
) < 0)
321 return sigaction (SIGSEGV
, &act
, NULL
);
324 #else /* ! ((HAVE_SIGALTSTACK && HAVE_DECL_SIGALTSTACK
325 && HAVE_STACK_OVERFLOW_HANDLING) || HAVE_LIBSIGSEGV) */
328 c_stack_action (void (*action
) (int) __attribute__ ((unused
)))