177 lines
5.6 KiB
Groff
177 lines
5.6 KiB
Groff
.\" $NetBSD: sigaltstack.2,v 1.15 2002/02/08 01:28:22 ross Exp $
|
|
.\"
|
|
.\" Copyright (c) 1983, 1991, 1992, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)sigaltstack.2 8.2 (Berkeley) 5/1/95
|
|
.\"
|
|
.Dd May 1, 1995
|
|
.Dt SIGALTSTACK 2
|
|
.Os
|
|
.Sh NAME
|
|
.Nm sigaltstack
|
|
.Nd set and/or get signal stack context
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.Fd #include \*[Lt]signal.h\*[Gt]
|
|
.Pp
|
|
.Bd -literal
|
|
typedef struct sigaltstack {
|
|
void *ss_sp;
|
|
size_t ss_size;
|
|
int ss_flags;
|
|
} stack_t;
|
|
.Ed
|
|
.Ft int
|
|
.Fn sigaltstack "const stack_t *ss" "stack_t *oss"
|
|
.Sh DESCRIPTION
|
|
.Fn sigaltstack
|
|
allows users to define an alternative stack on which signals
|
|
are to be processed.
|
|
If
|
|
.Fa ss
|
|
is non-zero,
|
|
it specifies a pointer to and the size of a
|
|
.Em "signal stack"
|
|
on which to deliver signals,
|
|
and tells the system if the process is currently executing
|
|
on that stack.
|
|
When a signal's action indicates its handler
|
|
should execute on the signal stack (specified with a
|
|
.Xr sigaction 2
|
|
call), the system checks to see
|
|
if the process is currently executing on that stack.
|
|
If the process is not currently executing on the signal stack,
|
|
the system arranges a switch to the signal stack for the
|
|
duration of the signal handler's execution.
|
|
.Pp
|
|
If
|
|
.Dv SS_DISABLE
|
|
is set in
|
|
.Fa ss_flags ,
|
|
.Fa ss_sp
|
|
and
|
|
.Fa ss_size
|
|
are ignored and the signal stack will be disabled.
|
|
Trying to disable an active stack will cause
|
|
.Nm
|
|
to return -1 with
|
|
.Va errno
|
|
set to
|
|
.Er EINVAL .
|
|
A disabled stack will cause all signals to be
|
|
taken on the regular user stack.
|
|
If the stack is later re-enabled then all signals that were specified
|
|
to be processed on an alternative stack will resume doing so.
|
|
.Pp
|
|
If
|
|
.Fa oss
|
|
is non-zero, the current signal stack state is returned.
|
|
The
|
|
.Fa ss_flags
|
|
field will contain the value
|
|
.Dv SS_ONSTACK
|
|
if the process is currently on a signal stack and
|
|
.Dv SS_DISABLE
|
|
if the signal stack is currently disabled.
|
|
.Sh NOTES
|
|
The value
|
|
.Dv SIGSTKSZ
|
|
is defined to be the number of bytes/chars that would be used to cover
|
|
the usual case when allocating an alternative stack area.
|
|
The following code fragment is typically used to allocate an alternative stack.
|
|
.Bd -literal -offset indent
|
|
if ((sigstk.ss_sp = malloc(SIGSTKSZ)) == NULL)
|
|
/* error return */
|
|
sigstk.ss_size = SIGSTKSZ;
|
|
sigstk.ss_flags = 0;
|
|
if (sigaltstack(\*[Am]sigstk,0) \*[Lt] 0)
|
|
perror("sigaltstack");
|
|
.Ed
|
|
.Pp
|
|
An alternative approach is provided for programs with signal handlers
|
|
that require a specific amount of stack space other than the default size.
|
|
The value
|
|
.Dv MINSIGSTKSZ
|
|
is defined to be the number of bytes/chars that is required by
|
|
the operating system to implement the alternative stack feature.
|
|
In computing an alternative stack size,
|
|
programs should add
|
|
.Dv MINSIGSTKSZ
|
|
to their stack requirements to allow for the operating system overhead.
|
|
.Pp
|
|
Signal stacks are automatically adjusted for the direction of stack
|
|
growth and alignment requirements.
|
|
Signal stacks may or may not be protected by the hardware and
|
|
are not ``grown'' automatically as is done for the normal stack.
|
|
If the stack overflows and this space is not protected
|
|
unpredictable results may occur.
|
|
.Sh RETURN VALUES
|
|
Upon successful completion, a value of 0 is returned.
|
|
Otherwise, a value of -1 is returned and
|
|
.Va errno
|
|
is set to indicate the error.
|
|
.Sh ERRORS
|
|
.Fn sigaltstack
|
|
will fail and the signal stack context will remain unchanged
|
|
if one of the following occurs.
|
|
.Bl -tag -width Er
|
|
.It Bq Er EFAULT
|
|
Either
|
|
.Fa ss
|
|
or
|
|
.Fa oss
|
|
points to memory that is not a valid part of the process
|
|
address space.
|
|
.It Bq Er EINVAL
|
|
An attempt was made to disable an active stack.
|
|
.It Bq Er ENOMEM
|
|
Size of alternative stack area is less than or equal to
|
|
.Dv MINSIGSTKSZ .
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr sigaction 2 ,
|
|
.Xr setjmp 3 ,
|
|
.Xr signal 7
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn sigaltstack
|
|
function conforms to
|
|
.St -xpg4.2 .
|
|
.Sh HISTORY
|
|
The predecessor to
|
|
.Nm sigaltstack ,
|
|
the
|
|
.Fn sigstack
|
|
system call, appeared in
|
|
.Bx 4.2 .
|