lib/libcr/sys/sigaltstack.2

   1 .\" Copyright (c) 1983, 1991, 1992, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)sigaltstack.2       8.2 (Berkeley) 5/1/95
  33 .\" $FreeBSD: src/lib/libc/sys/sigaltstack.2,v 1.11.2.7 2002/09/15 00:32:41 archie Exp $
  34 .\"
  35 .Dd May 1, 1995
  36 .Dt SIGALTSTACK 2
  37 .Os
  38 .Sh NAME
  39 .Nm sigaltstack
  40 .Nd set and/or get signal stack context
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In signal.h
  45 .Bd -literal
  46 typedef struct sigaltstack {
  47         char    *ss_sp;
  48         size_t  ss_size;
  49         int     ss_flags;
  50 } stack_t;
  51 .Ed
  52 .Ft int
  53 .Fn sigaltstack "const stack_t *ss" "stack_t *oss"
  54 .Sh DESCRIPTION
  55 .Fn Sigaltstack
  56 allows users to define an alternate stack on which signals
  57 are to be processed.
  58 If
  59 .Fa ss
  60 is non-zero,
  61 it specifies a pointer to and the size of a
  62 .Em "signal stack"
  63 on which to deliver signals,
  64 and tells the system if the process is currently executing
  65 on that stack.
  66 When a signal's action indicates its handler
  67 should execute on the signal stack (specified with a
  68 .Xr sigaction 2
  69 call), the system checks to see
  70 if the process is currently executing on that stack.
  71 If the process is not currently executing on the signal stack,
  72 the system arranges a switch to the signal stack for the
  73 duration of the signal handler's execution.
  74 .Pp
  75 If
  76 .Dv SS_DISABLE
  77 is set in
  78 .Fa ss_flags ,
  79 .Fa ss_sp
  80 and
  81 .Fa ss_size
  82 are ignored and the signal stack will be disabled.
  83 Trying to disable an active stack will cause
  84 .Fn sigaltstack
  85 to return -1 with
  86 .Va errno
  87 set to
  88 .Er EINVAL .
  89 A disabled stack will cause all signals to be
  90 taken on the regular user stack.
  91 If the stack is later re-enabled then all signals that were specified
  92 to be processed on an alternate stack will resume doing so.
  93 .Pp
  94 If
  95 .Fa oss
  96 is non-zero, the current signal stack state is returned.
  97 The
  98 .Fa ss_flags
  99 field will contain the value
 100 .Dv SS_ONSTACK
 101 if the process is currently on a signal stack and
 102 .Dv SS_DISABLE
 103 if the signal stack is currently disabled.
 104 .Sh NOTES
 105 The value
 106 .Dv SIGSTKSZ
 107 is defined to be the number of bytes/chars that would be used to cover
 108 the usual case when allocating an alternate stack area.
 109 The following code fragment is typically used to allocate an alternate stack.
 110 .Bd -literal -offset indent
 111 if ((sigstk.ss_sp = malloc(SIGSTKSZ)) == NULL)
 112         /* error return */
 113 sigstk.ss_size = SIGSTKSZ;
 114 sigstk.ss_flags = 0;
 115 if (sigaltstack(&sigstk,0) < 0)
 116         perror("sigaltstack");
 117 .Ed
 118 An alternative approach is provided for programs with signal handlers
 119 that require a specific amount of stack space other than the default size.
 120 The value
 121 .Dv MINSIGSTKSZ
 122 is defined to be the number of bytes/chars that is required by
 123 the operating system to implement the alternate stack feature.
 124 In computing an alternate stack size,
 125 programs should add
 126 .Dv MINSIGSTKSZ
 127 to their stack requirements to allow for the operating system overhead.
 128 .Pp
 129 Signal stacks are automatically adjusted for the direction of stack
 130 growth and alignment requirements.
 131 Signal stacks may or may not be protected by the hardware and
 132 are not ``grown'' automatically as is done for the normal stack.
 133 If the stack overflows and this space is not protected
 134 unpredictable results may occur.
 135 .Sh RETURN VALUES
 136 .Rv -std sigaltstack
 137 .Sh ERRORS
 138 .Fn Sigaltstack
 139 will fail and the signal stack context will remain unchanged
 140 if one of the following occurs.
 141 .Bl -tag -width Er
 142 .It Bq Er EFAULT
 143 Either
 144 .Fa ss
 145 or
 146 .Fa oss
 147 points to memory that is not a valid part of the process
 148 address space.
 149 .It Bq Er EINVAL
 150 An attempt was made to disable an active stack.
 151 .It Bq Er ENOMEM
 152 Size of alternate stack area is less than or equal to
 153 .Dv MINSIGSTKSZ .
 154 .El
 155 .Sh SEE ALSO
 156 .Xr sigaction 2 ,
 157 .Xr setjmp 3
 158 .Sh HISTORY
 159 The predecessor to
 160 .Fn sigaltstack ,
 161 the
 162 .Fn sigstack
 163 system call, appeared in
 164 .Bx 4.2 .