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