components/libsigsegv/man3/sigsegv_register.3
author Mike Sullivan <Mike.Sullivan@Oracle.COM>
Wed, 29 Aug 2012 11:05:56 -0700
changeset 957 255465c5756f
parent 181 87e11e685b1f
child 5826 9c90e4a8156c
permissions -rw-r--r--
Close of build 04.
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_register 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_init, sigsegv_register, sigsegv_unregister, sigsegv_dispatch \- LOCAL SIGSEGV HANDLERS
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    27
.SH SYNOPSIS
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    28
#include <\fBsigsegv.h\fR>
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
void \fBsigsegv_init\fR (\fIsigsegv_dispatcher* dispatcher\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
void* \fBsigsegv_register\fR (\fIsigsegv_dispatcher* dispatcher\fR,
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    33
.RS +24
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    34
\fIvoid* address\fR, \fIunsigned long len\fR,
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    35
\fIsigsegv_area_handler_t handler\fR,
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    36
\fIvoid* handler_arg\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    37
.RE
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    38
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    39
void \fBsigsegv_unregister\fR (\fIsigsegv_dispatcher* dispatcher\fR,
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    40
.RS +25
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    41
\fIvoid* ticket\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    42
.RE
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
int \fBsigsegv_dispatch\fR (\fIsigsegv_dispatcher* dispatcher\fR,
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    45
.RS +22
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    46
\fIvoid* fault_address\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    47
.RE
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    48
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    49
.SH DESCRIPTION
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
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    52
The set of functions permit to define different \fBSIGSEGV\fR policies on different address ranges.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    53
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    54
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    55
\fBSigsegv_init\fR initializes a sigsegv_dispatcher structure.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    56
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    57
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    58
\fBSigsegv_register\fR adds a local SIGSEGV handler to a sigsegv_dispatcher structure. It will cover the interval [address..address+len-1]. Returns a "ticket" that can be used to remove the handler later.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    59
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    60
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    61
\fBSigsegv_unregister\fR removes a local SIGSEGV handler.
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
\fBSigsegv_dispatch\fR call the local SIGSEGV handler responsible for the given fault address. Return the handler's return value. 0 means that no handler has been found, or that a handler was found but declined responsibility.
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
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    67
.SH OPERANDS
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
typedef struct \fBsigsegv_dispatcher\fR {
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    71
.RS +5
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    72
void* tree;
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    73
.RE
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    74
}sigsegv_dispatcher;
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    75
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    76
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    77
\fISigsegv_dispatcher\fR represents a table of memory areas (address range intervals), with an local SIGSEGV handler for each.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    78
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    79
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    80
The \fIaddress\fR represents the address of the memory area, and the \fIlen\fR represents the length of the memory area.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    81
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    82
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    83
typedef int (*\fBsigsegv_area_handler_t\fR) (\fIvoid* fault_address,\fR
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    84
.RS +39
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    85
\fIvoid* user_arg\fR);
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    86
.RE
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    87
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    88
\fIsigsegv_area_handler_t\fR is the type of a local SIGSEGV handler. The fault address is passed as argument. The second argument is fixed arbitrary user data. 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
    89
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    90
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    91
The \fIhandler_arg\fR is the second argument of the \fBsigsegv_area_handler_t\fR.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    92
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    93
.SH EXIT STATUS
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    94
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    95
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    96
Sigsegv_dispatcher returns the handler's return value. 0 means that no handler has been found, or that a handler was found but declined responsibility.
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    97
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    98
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    99
.SH SEE ALSO
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
   100
.sp
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
   101
.LP
bc205fa4b512 7017999 migrate libsigsegv to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
   102
\fBattributes\fR(5), \fBsigsegv\fR(3), \fBstandards\fR(5)