author | John Beck <John.Beck@Oracle.COM> |
Fri, 09 Sep 2016 13:08:45 -0700 | |
changeset 6889 | 83e26eb7e42b |
parent 5826 | 9c90e4a8156c |
permissions | -rw-r--r-- |
95
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
1 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
2 |
.\" CDDL HEADER START |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
3 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
4 |
.\" The contents of this file are subject to the terms of the |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
5 |
.\" Common Development and Distribution License (the "License"). |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
6 |
.\" You may not use this file except in compliance with the License. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
7 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
8 |
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
9 |
.\" or http://www.opensolaris.org/os/licensing. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
10 |
.\" See the License for the specific language governing permissions |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
11 |
.\" and limitations under the License. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
12 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
13 |
.\" When distributing Covered Code, include this CDDL HEADER in each |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
14 |
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
15 |
.\" If applicable, add the following below this CDDL HEADER, with the |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
16 |
.\" fields enclosed by brackets "[]" replaced with your own identifying |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
17 |
.\" information: Portions Copyright [yyyy] [name of copyright owner] |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
18 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
19 |
.\" CDDL HEADER END |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
20 |
.\" |
181
87e11e685b1f
7003927 userland should postprocess packaged files
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents:
95
diff
changeset
|
21 |
.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved. |
95
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
22 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
23 |
.\" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
24 |
.TH stackoverflow_install_handler 3 "13 Jan 2009" "SunOS 5.11" |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
25 |
.SH NAME |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
26 |
stackoverflow_install_handler, stackoverflow_deinstall_handler \- Installs and deinstall a stack overflow handler |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
27 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
28 |
.SH SYNOPSIS |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
29 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
30 |
#include <\fBsigsegv.h\fR> |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
31 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
32 |
int \fBstackoverflow_install_handler\fR (\fIstackoverflow_handler_t\fR |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
33 |
.RS +26 |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
34 |
\fIhandler\fR, \fIvoid* extra_stack\fR, |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
35 |
.RE |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
36 |
.RS +26 |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
37 |
\fIunsigned long extra_stack_size\fR); |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
38 |
.RE |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
39 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
40 |
void \fBstackoverflow_deinstall_handler\fR (\fIvoid\fR); |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
41 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
42 |
.SH DESCRIPTION |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
43 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
44 |
.LP |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
45 |
In some applications, the \fBstack\fR \fBoverflow\fR \fBhandler\fR performs some cleanup or notifies the user and then immediately terminates the application. In other applications, the \fBstack\fR \fBoverflow\fR \fBhandler\fR longjmps back to a central point in the application. This library supports both uses. In the second case, the handler must ensure to restore the normal signal mask (because many signals are blocked while the handler is executed), and must also call \fBsigsegv_leave_handler()\fR to transfer control; then only it can longjmp away. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
46 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
47 |
.LP |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
48 |
The handler is run at a moment when nothing about the global state of the program is known. Therefore it cannot use facilities that manipulate global variables or locks. In particular, it cannot use malloc(); use mmap() Instead. It cannot use fopen(); use open() instead. Etc. All global variables that are accessed by the handler should be mark |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
49 |
'volatile'. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
50 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
51 |
.SH OPERANDS |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
52 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
53 |
.LP |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
54 |
typedef void (*\fBstackoverflow_handler_t\fR) (\fIint emergency\fR, |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
55 |
.RS +28 |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
56 |
\fIstackoverflow_context_t scp\fR); |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
57 |
.RE |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
58 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
59 |
\fIStackoverflow_handler_t\fR is the type of a stack overflow handler. Such a handler should perform a longjmp call in order to reduce the amount of stack needed. It must not return.The \fIemergency\fR argument is 0 when the stack could be repared, or 1 if the application should better save its state and exit now. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
60 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
61 |
.LP |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
62 |
The \fIextra_stack\fR argument is a pointer to a preallocated area used as a stack for executing the handler. It is typically allocated by use of `alloca' during `main'. Its size should be sufficiently large. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
63 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
64 |
.LP |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
65 |
The \fIextra_stack_size\fR is the size of the extra_stack argument. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
66 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
67 |
.SH EXIT STATUS |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
68 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
69 |
.LP |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
70 |
If success, \fBstackoverflow_install_handler()\fR returns 0 on success, or -1 if the system doesn't support catching stack overflow. |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
71 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
72 |
|
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
73 |
.SH SEE ALSO |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
74 |
.sp |
bc205fa4b512
7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff
changeset
|
75 |
.LP |
5826
9c90e4a8156c
23137909 Userland man page normalization work
Rich Burridge <rich.burridge@oracle.com>
parents:
181
diff
changeset
|
76 |
\fBattributes\fR(7), \fBsigsegv\fR(3), \fBstandards\fR(7) |