lib/libc/gen/signal.3

   1 .\" Copyright (c) 1980, 1991, 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 .\"     @(#)signal.3    8.3 (Berkeley) 4/19/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 7, 2004
  36 .Dt SIGNAL 3
  37 .Os
  38 .Sh NAME
  39 .Nm signal
  40 .Nd simplified software signal facilities
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In signal.h
  45 .\" XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX
  46 .\" The prototype for signal(3) cannot be cleanly marked up in -mdoc
  47 .\" without the following lower-level tweak.
  48 .nr in-synopsis-section 0
  49 .Pp
  50 .Ft "void \*(lp*" Ns
  51 .Fo signal
  52 .Fa "int sig"
  53 .Fa "void \*(lp*func\*(rp\*(lpint\*(rp"
  54 .Fc Ns
  55 .Ft "\*(rp\*(lpint\*(rp" ;
  56 .Pp
  57 .nr in-synopsis-section 1
  58 .\" XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX XXX
  59 or in
  60 .Fx Ap s
  61 equivalent but easier to read typedef'd version:
  62 .Ft typedef "void \*(lp*sig_t\*(rp \*(lpint\*(rp" ;
  63 .Ft sig_t
  64 .Fn signal "int sig" "sig_t func"
  65 .Sh DESCRIPTION
  66 This
  67 .Fn signal
  68 facility
  69 is a simplified interface to the more general
  70 .Xr sigaction 2
  71 facility.
  72 .Pp
  73 Signals allow the manipulation of a process from outside its
  74 domain as well as allowing the process to manipulate itself or
  75 copies of itself (children).
  76 There are two general types of signals:
  77 those that cause termination of a process and those that do not.
  78 Signals which cause termination of a program might result from
  79 an irrecoverable error or might be the result of a user at a terminal
  80 typing the `interrupt' character.
  81 Signals are used when a process is stopped because it wishes to access
  82 its control terminal while in the background (see
  83 .Xr tty 4 ) .
  84 Signals are optionally generated
  85 when a process resumes after being stopped,
  86 when the status of child processes changes,
  87 or when input is ready at the control terminal.
  88 Most signals result in the termination of the process receiving them
  89 if no action
  90 is taken; some signals instead cause the process receiving them
  91 to be stopped, or are simply discarded if the process has not
  92 requested otherwise.
  93 Except for the
  94 .Dv SIGKILL
  95 and
  96 .Dv SIGSTOP
  97 signals, the
  98 .Fn signal
  99 function allows for a signal to be caught, to be ignored, or to generate
 100 an interrupt.
 101 These signals are defined in the file
 102 .In signal.h :
 103 .Bl -column No ".Dv SIGVTALRM" "create core image"
 104 .It Sy "No      Name    Default Action  Description"
 105 .It 1 Ta Dv SIGHUP Ta "terminate process" Ta "terminal line hangup"
 106 .It 2 Ta Dv SIGINT Ta "terminate process" Ta "interrupt program"
 107 .It 3 Ta Dv SIGQUIT Ta "create core image" Ta "quit program"
 108 .It 4 Ta Dv SIGILL Ta "create core image" Ta "illegal instruction"
 109 .It 5 Ta Dv SIGTRAP Ta "create core image" Ta "trace trap"
 110 .It 6 Ta Dv SIGABRT Ta "create core image" Ta "abort program"
 111 (formerly
 112 .Dv SIGIOT )
 113 .It 7 Ta Dv SIGEMT Ta "create core image" Ta "emulate instruction executed"
 114 .It 8 Ta Dv SIGFPE Ta "create core image" Ta "floating-point exception"
 115 .It 9 Ta Dv SIGKILL Ta "terminate process" Ta "kill program"
 116 .It 10 Ta Dv SIGBUS Ta "create core image" Ta "bus error"
 117 .It 11 Ta Dv SIGSEGV Ta "create core image" Ta "segmentation violation"
 118 .It 12 Ta Dv SIGSYS Ta "create core image" Ta "non-existent system call invoked"
 119 .It 13 Ta Dv SIGPIPE Ta "terminate process" Ta "write on a pipe with no reader"
 120 .It 14 Ta Dv SIGALRM Ta "terminate process" Ta "real-time timer expired"
 121 .It 15 Ta Dv SIGTERM Ta "terminate process" Ta "software termination signal"
 122 .It 16 Ta Dv SIGURG Ta "discard signal" Ta "urgent condition present on socket"
 123 .It 17 Ta Dv SIGSTOP Ta "stop process" Ta "stop (cannot be caught or ignored)"
 124 .It 18 Ta Dv SIGTSTP Ta "stop process" Ta "stop signal generated from keyboard"
 125 .It 19 Ta Dv SIGCONT Ta "discard signal" Ta "continue after stop"
 126 .It 20 Ta Dv SIGCHLD Ta "discard signal" Ta "child status has changed"
 127 .It 21 Ta Dv SIGTTIN Ta "stop process" Ta "background read attempted from"
 128 control terminal
 129 .It 22 Ta Dv SIGTTOU Ta "stop process" Ta "background write attempted to"
 130 control terminal
 131 .It 23 Ta Dv SIGIO Ta "discard signal" Ta Tn "I/O"
 132 is possible on a descriptor (see
 133 .Xr fcntl 2 )
 134 .It 24 Ta Dv SIGXCPU Ta "terminate process" Ta "cpu time limit exceeded (see"
 135 .Xr setrlimit 2 )
 136 .It 25 Ta Dv SIGXFSZ Ta "terminate process" Ta "file size limit exceeded (see"
 137 .Xr setrlimit 2 )
 138 .It 26 Ta Dv SIGVTALRM Ta "terminate process" Ta "virtual time alarm (see"
 139 .Xr setitimer 2 )
 140 .It 27 Ta Dv SIGPROF Ta "terminate process" Ta "profiling timer alarm (see"
 141 .Xr setitimer 2 )
 142 .It 28 Ta Dv SIGWINCH Ta "discard signal" Ta "Window size change"
 143 .It 29 Ta Dv SIGINFO Ta "discard signal" Ta "status request from keyboard"
 144 .It 30 Ta Dv SIGUSR1 Ta "terminate process" Ta "User defined signal 1"
 145 .It 31 Ta Dv SIGUSR2 Ta "terminate process" Ta "User defined signal 2"
 146 .It 32 Ta Dv SIGTHR Ta "terminate process" Ta "thread interrupt"
 147 .El
 148 .Pp
 149 The
 150 .Fa sig
 151 argument specifies which signal was received.
 152 The
 153 .Fa func
 154 procedure allows a user to choose the action upon receipt of a signal.
 155 To set the default action of the signal to occur as listed above,
 156 .Fa func
 157 should be
 158 .Dv SIG_DFL .
 159 A
 160 .Dv SIG_DFL
 161 resets the default action.
 162 To ignore the signal
 163 .Fa func
 164 should be
 165 .Dv SIG_IGN .
 166 This will cause subsequent instances of the signal to be ignored
 167 and pending instances to be discarded.
 168 If
 169 .Dv SIG_IGN
 170 is not used,
 171 further occurrences of the signal are
 172 automatically blocked and
 173 .Fa func
 174 is called.
 175 .Pp
 176 The handled signal is unblocked when the
 177 function returns and
 178 the process continues from where it left off when the signal occurred.
 179 .Bf -symbolic
 180 Unlike previous signal facilities, the handler
 181 func() remains installed after a signal has been delivered.
 182 .Ef
 183 .Pp
 184 For some system calls, if a signal is caught while the call is
 185 executing and the call is prematurely terminated,
 186 the call is automatically restarted.
 187 (The handler is installed using the
 188 .Dv SA_RESTART
 189 flag with
 190 .Xr sigaction 2 . )
 191 The affected system calls include
 192 .Xr read 2 ,
 193 .Xr write 2 ,
 194 .Xr sendto 2 ,
 195 .Xr recvfrom 2 ,
 196 .Xr sendmsg 2
 197 and
 198 .Xr recvmsg 2
 199 on a communications channel or a low speed device
 200 and during a
 201 .Xr ioctl 2
 202 or
 203 .Xr wait 2 .
 204 However, calls that have already committed are not restarted,
 205 but instead return a partial success (for example, a short read count).
 206 These semantics could be changed with
 207 .Xr siginterrupt 3 .
 208 .Pp
 209 When a process which has installed signal handlers forks,
 210 the child process inherits the signals.
 211 All caught signals may be reset to their default action by a call
 212 to the
 213 .Xr execve 2
 214 function;
 215 ignored signals remain ignored.
 216 .Pp
 217 If a process explicitly specifies
 218 .Dv SIG_IGN
 219 as the action for the signal
 220 .Dv SIGCHLD ,
 221 the system will not create zombie processes when children
 222 of the calling process exit.
 223 As a consequence, the system will discard the exit status
 224 from the child processes.
 225 If the calling process subsequently issues a call to
 226 .Xr wait 2
 227 or equivalent, it will block until all of the calling process's
 228 children terminate, and then return a value of \-1 with
 229 .Va errno
 230 set to
 231 .Er ECHILD .
 232 .Pp
 233 See
 234 .Xr sigaction 2
 235 for a list of functions
 236 that are considered safe for use in signal handlers.
 237 .Sh RETURN VALUES
 238 The previous action is returned on a successful call.
 239 Otherwise, SIG_ERR is returned and the global variable
 240 .Va errno
 241 is set to indicate the error.
 242 .Sh ERRORS
 243 The
 244 .Fn signal
 245 function
 246 will fail and no action will take place if one of the
 247 following occur:
 248 .Bl -tag -width Er
 249 .It Bq Er EINVAL
 250 The
 251 .Fa sig
 252 argument
 253 is not a valid signal number.
 254 .It Bq Er EINVAL
 255 An attempt is made to ignore or supply a handler for
 256 .Dv SIGKILL
 257 or
 258 .Dv SIGSTOP .
 259 .El
 260 .Sh SEE ALSO
 261 .Xr kill 1 ,
 262 .Xr kill 2 ,
 263 .Xr ptrace 2 ,
 264 .Xr sigaction 2 ,
 265 .Xr sigaltstack 2 ,
 266 .Xr sigprocmask 2 ,
 267 .Xr sigsuspend 2 ,
 268 .Xr wait 2 ,
 269 .Xr fpsetmask 3 ,
 270 .Xr setjmp 3 ,
 271 .Xr siginterrupt 3 ,
 272 .Xr tty 4
 273 .Sh HISTORY
 274 The
 275 .Nm
 276 facility appeared in
 277 .Bx 4.0 .
 278 The option to avoid the creation of child zombies through ignoring
 279 .Dv SIGCHLD
 280 appeared in
 281 .Fx 5.0 .