lib/libc/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$
  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 * restrict ss" "stack_t * restrict oss"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn sigaltstack
  57 system call
  58 allows users to define an alternate stack on which signals
  59 are to be processed.
  60 If
  61 .Fa ss
  62 is non-zero,
  63 it specifies a pointer to and the size of a
  64 .Em "signal stack"
  65 on which to deliver signals,
  66 and tells the system if the process is currently executing
  67 on that stack.
  68 When a signal's action indicates its handler
  69 should execute on the signal stack (specified with a
  70 .Xr sigaction 2
  71 system call), the system checks to see
  72 if the process is currently executing on that stack.
  73 If the process is not currently executing on the signal stack,
  74 the system arranges a switch to the signal stack for the
  75 duration of the signal handler's execution.
  76 .Pp
  77 If
  78 .Dv SS_DISABLE
  79 is set in
  80 .Fa ss_flags ,
  81 .Fa ss_sp
  82 and
  83 .Fa ss_size
  84 are ignored and the signal stack will be disabled.
  85 Trying to disable an active stack will cause
  86 .Fn sigaltstack
  87 to return -1 with
  88 .Va errno
  89 set to
  90 .Er EINVAL .
  91 A disabled stack will cause all signals to be
  92 taken on the regular user stack.
  93 If the stack is later re-enabled then all signals that were specified
  94 to be processed on an alternate stack will resume doing so.
  95 .Pp
  96 If
  97 .Fa oss
  98 is non-zero, the current signal stack state is returned.
  99 The
 100 .Fa ss_flags
 101 field will contain the value
 102 .Dv SS_ONSTACK
 103 if the process is currently on a signal stack and
 104 .Dv SS_DISABLE
 105 if the signal stack is currently disabled.
 106 .Sh NOTES
 107 The value
 108 .Dv SIGSTKSZ
 109 is defined to be the number of bytes/chars that would be used to cover
 110 the usual case when allocating an alternate stack area.
 111 The following code fragment is typically used to allocate an alternate stack.
 112 .Bd -literal -offset indent
 113 if ((sigstk.ss_sp = malloc(SIGSTKSZ)) == NULL)
 114         /* error return */
 115 sigstk.ss_size = SIGSTKSZ;
 116 sigstk.ss_flags = 0;
 117 if (sigaltstack(&sigstk,0) < 0)
 118         perror("sigaltstack");
 119 .Ed
 120 An alternative approach is provided for programs with signal handlers
 121 that require a specific amount of stack space other than the default size.
 122 The value
 123 .Dv MINSIGSTKSZ
 124 is defined to be the number of bytes/chars that is required by
 125 the operating system to implement the alternate stack feature.
 126 In computing an alternate stack size,
 127 programs should add
 128 .Dv MINSIGSTKSZ
 129 to their stack requirements to allow for the operating system overhead.
 130 .Pp
 131 Signal stacks are automatically adjusted for the direction of stack
 132 growth and alignment requirements.
 133 Signal stacks may or may not be protected by the hardware and
 134 are not ``grown'' automatically as is done for the normal stack.
 135 If the stack overflows and this space is not protected
 136 unpredictable results may occur.
 137 .Sh RETURN VALUES
 138 .Rv -std sigaltstack
 139 .Sh ERRORS
 140 The
 141 .Fn sigaltstack
 142 system call
 143 will fail and the signal stack context will remain unchanged
 144 if one of the following occurs.
 145 .Bl -tag -width Er
 146 .It Bq Er EFAULT
 147 Either
 148 .Fa ss
 149 or
 150 .Fa oss
 151 points to memory that is not a valid part of the process
 152 address space.
 153 .It Bq Er EINVAL
 154 An attempt was made to disable an active stack.
 155 .It Bq Er ENOMEM
 156 Size of alternate stack area is less than or equal to
 157 .Dv MINSIGSTKSZ .
 158 .El
 159 .Sh SEE ALSO
 160 .Xr sigaction 2 ,
 161 .Xr setjmp 3
 162 .Sh HISTORY
 163 The predecessor to
 164 .Fn sigaltstack ,
 165 the
 166 .Fn sigstack
 167 system call, appeared in
 168 .Bx 4.2 .