components/libsigsegv/man3/sigsegv_install_handler.3
author Mike Sullivan <Mike.Sullivan@Oracle.COM>
Mon, 11 Mar 2013 10:38:09 -0700
branchs11-update
changeset 2520 ceec631e74d1
parent 181 87e11e685b1f
child 5826 9c90e4a8156c
permissions -rw-r--r--
Close of build 10.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 sigsegv_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
sigsegv_install_handler, sigsegv_deinstall_handler - Install and deinstall a global SIGSEGV 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 \fBsigsegv_install_handler\fR (\fIsigsegv_handler_t handler\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    33
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    34
void \fBsigsegv_deinstall_handler\fR (\fIvoid\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    35
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    36
.SH DESCRIPTION
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    37
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    38
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    39
Pageable virtual memory is usually done in the operating system's kernel. This library helps in implementing the others.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    40
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    41
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    42
Installing a page fault handler is usually more efficient than doing access checks in software at every access, because it's effectively the hardware (the MMU) which checks whether a page is present or not.
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
Note that if you use system calls (like read()) to write into write-protected pages, the system will react by returning -1 and setting errno to EFAULT, instead of signalling SIGSEGV and restarting the system call. In this case, the program has to do what the SIGSEGV handler would do, and then restart the read() operation.
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
\fBSigsegv_install_handler\fR installs a global SIGSEGV handler. This should be called once only, and it ignores any previously installed SIGSEGV handler.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    49
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    50
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    51
\fBSigsegv_deinstall_handler\fR deinstalls the global SIGSEGV handler. This goes back to the state where no SIGSEGV handler is installed.
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
.SH OPERANDS
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    54
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    55
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    56
typedef int (*\fBsigsegv_handler_t\fR) (\fIvoid* fault_address\fR,
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    57
.RS +34
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    58
\fIint serious\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    59
.RE
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
\fISigsegv_handler_t\fR is the type of a global SIGSEGV handler.The fault address is passed as argument. The access type (read access or write access) is not passed; your handler has to know itself how to distinguish these two cases. The second argument is 0, meaning it could also be a stack overflow, or 1, meaning the handler should seriously try to fix the fault. The return value should be nonzero if the handler has done its job and no other handler should be called, or 0 if the handler declines responsibility for the given address.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    62
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    63
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    64
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 marked 'volatile'.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    65
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    66
.SH EXIT STATUS
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    67
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    68
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    69
If success, sigsegv_install_handler returns 0, or -1 if the system doesn't support catching SIGSEGV.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    70
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    71
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    72
.SH SEE ALSO
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    73
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    74
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    75
\fBattributes\fR(5), \fBsigsegv\fR(3), \fBstandards\fR(5)