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: src/lib/libc/gen/signal.3,v 1.17.2.9 2003/03/13 18:05:37 trhodes Exp $
  34 .\" $DragonFly: src/lib/libc/gen/signal.3,v 1.4 2004/03/11 12:28:50 hmp Exp $
  35 .\"
  36 .Dd April 19, 1994
  37 .Dt SIGNAL 3
  38 .Os
  39 .Sh NAME
  40 .Nm signal
  41 .Nd simplified software signal facilities
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In signal.h
  46 .\" The following is Quite Ugly, but syntactically correct.  Don't try to
  47 .\" fix it.
  48 .Ft void \*(lp*
  49 .Fn signal "int sig" "void \*(lp*func\*(rp\*(lpint\*(rp\*(rp\*(rp\*(lpint"
  50 .Pp
  51 or in
  52 .Dx Ns 's
  53 equivalent but easier to read typedef'd version:
  54 .Ft typedef "void \*(lp*sig_t\*(rp \*(lpint\*(rp" ;
  55 .Ft sig_t
  56 .Fn signal "int sig" "sig_t func"
  57 .Sh DESCRIPTION
  58 This
  59 .Fn signal
  60 facility
  61 is a simplified interface to the more general
  62 .Xr sigaction 2
  63 facility.
  64 .Pp
  65 Signals allow the manipulation of a process from outside its
  66 domain as well as allowing the process to manipulate itself or
  67 copies of itself (children). There are two general types of signals:
  68 those that cause termination of a process and those that do not.
  69 Signals which cause termination of a program might result from
  70 an irrecoverable error or might be the result of a user at a terminal
  71 typing the `interrupt' character.
  72 Signals are used when a process is stopped because it wishes to access
  73 its control terminal while in the background (see
  74 .Xr tty 4 ) .
  75 Signals are optionally generated
  76 when a process resumes after being stopped,
  77 when the status of child processes changes,
  78 or when input is ready at the control terminal.
  79 Most signals result in the termination of the process receiving them
  80 if no action
  81 is taken; some signals instead cause the process receiving them
  82 to be stopped, or are simply discarded if the process has not
  83 requested otherwise.
  84 Except for the
  85 .Dv SIGKILL
  86 and
  87 .Dv SIGSTOP
  88 signals, the
  89 .Fn signal
  90 function allows for a signal to be caught, to be ignored, or to generate
  91 an interrupt.
  92 These signals are defined in the file
  93 .Aq Pa signal.h :
  94 .Bl -column SIGVTALARMXX "create core imagexxx"
  95 .It Sy "Name    Default Action  Description"
  96 .It Dv SIGHUP Ta "terminate process" Ta "terminal line hangup"
  97 .It Dv SIGINT Ta "terminate process" Ta "interrupt program"
  98 .It Dv SIGQUIT Ta "create core image" Ta "quit program"
  99 .It Dv SIGILL Ta "create core image" Ta "illegal instruction"
 100 .It Dv SIGTRAP Ta "create core image" Ta "trace trap"
 101 .It Dv SIGABRT Ta "create core image" Ta "abort program"
 102 (formerly
 103 .Dv SIGIOT )
 104 .It Dv SIGEMT Ta "create core image" Ta "emulate instruction executed"
 105 .It Dv SIGFPE Ta "create core image" Ta "floating-point exception"
 106 .It Dv SIGKILL Ta "terminate process" Ta "kill program"
 107 .It Dv SIGBUS Ta "create core image" Ta "bus error"
 108 .It Dv SIGSEGV Ta "create core image" Ta "segmentation violation"
 109 .It Dv SIGSYS Ta "create core image" Ta "non-existent system call invoked"
 110 .It Dv SIGPIPE Ta "terminate process" Ta "write on a pipe with no reader"
 111 .It Dv SIGALRM Ta "terminate process" Ta "real-time timer expired"
 112 .It Dv SIGTERM Ta "terminate process" Ta "software termination signal"
 113 .It Dv SIGURG Ta "discard signal" Ta "urgent condition present on socket"
 114 .It Dv SIGSTOP Ta "stop process" Ta "stop (cannot be caught or ignored)"
 115 .It Dv SIGTSTP Ta "stop process" Ta "stop signal generated from keyboard"
 116 .It Dv SIGCONT Ta "discard signal" Ta "continue after stop"
 117 .It Dv SIGCHLD Ta "discard signal" Ta "child status has changed"
 118 .It Dv SIGTTIN Ta "stop process" Ta "background read attempted from control terminal"
 119 .It Dv SIGTTOU Ta "stop process" Ta "background write attempted to control terminal"
 120 .It Dv SIGIO Ta "discard signal" Ta Tn "I/O"
 121 is possible on a descriptor (see
 122 .Xr fcntl 2 )
 123 .It Dv SIGXCPU Ta "terminate process" Ta "cpu time limit exceeded (see"
 124 .Xr setrlimit 2 )
 125 .It Dv SIGXFSZ Ta "terminate process" Ta "file size limit exceeded (see"
 126 .Xr setrlimit 2 )
 127 .It Dv SIGVTALRM Ta "terminate process" Ta "virtual time alarm (see"
 128 .Xr setitimer 2 )
 129 .It Dv SIGPROF Ta "terminate process" Ta "profiling timer alarm (see"
 130 .Xr setitimer 2 )
 131 .It Dv SIGWINCH Ta "discard signal" Ta "Window size change"
 132 .It Dv SIGINFO Ta "discard signal" Ta "status request from keyboard"
 133 .It Dv SIGUSR1 Ta "terminate process" Ta "User defined signal 1"
 134 .It Dv SIGUSR2 Ta "terminate process" Ta "User defined signal 2"
 135 .It Dv SIGCKPT Ta "checkpoint process" Ta "Checkpoint"
 136 .It Dv SIGCKPTEXIT Ta "terminate process" Ta "Checkpoint and exit"
 137 .El
 138 .Pp
 139 The
 140 .Fa sig
 141 argument specifies which signal was received.
 142 The
 143 .Fa func
 144 procedure allows a user to choose the action upon receipt of a signal.
 145 To set the default action of the signal to occur as listed above,
 146 .Fa func
 147 should be
 148 .Dv SIG_DFL .
 149 A
 150 .Dv SIG_DFL
 151 resets the default action.
 152 To ignore the signal
 153 .Fa func
 154 should be
 155 .Dv SIG_IGN .
 156 This will cause subsequent instances of the signal to be ignored
 157 and pending instances to be discarded.
 158 If
 159 .Dv SIG_IGN
 160 is not used,
 161 further occurrences of the signal are
 162 automatically blocked and
 163 .Fa func
 164 is called.
 165 .Pp
 166 The handled signal is unblocked when the
 167 function returns and
 168 the process continues from where it left off when the signal occurred.
 169 .Bf -symbolic
 170 Unlike previous signal facilities, the handler
 171 func() remains installed after a signal has been delivered.
 172 .Ef
 173 .Pp
 174 For some system calls, if a signal is caught while the call is
 175 executing and the call is prematurely terminated,
 176 the call is automatically restarted.
 177 (The handler is installed using the
 178 .Dv SA_RESTART
 179 flag with
 180 .Xr sigaction 2 . )
 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 See
 208 .Xr sigaction 2
 209 for a list of functions
 210 that are considered safe for use in signal handlers.
 211 .Sh RETURN VALUES
 212 The previous action is returned on a successful call.
 213 Otherwise, SIG_ERR is returned and  the global variable
 214 .Va errno
 215 is set to indicate the error.
 216 .Sh ERRORS
 217 The
 218 .Fn signal
 219 function
 220 will fail and no action will take place if one of the
 221 following occur:
 222 .Bl -tag -width Er
 223 .It Bq Er EINVAL
 224 The
 225 .Fa sig
 226 argument
 227 is not a valid signal number.
 228 .It Bq Er EINVAL
 229 An attempt is made to ignore or supply a handler for
 230 .Dv SIGKILL
 231 or
 232 .Ev SIGSTOP .
 233 .El
 234 .Sh SEE ALSO
 235 .Xr kill 1 ,
 236 .Xr kill 2 ,
 237 .Xr ptrace 2 ,
 238 .Xr sigaction 2 ,
 239 .Xr sigaltstack 2 ,
 240 .Xr sigprocmask 2 ,
 241 .Xr sigsuspend 2 ,
 242 .Xr fpsetmask 3 ,
 243 .Xr setjmp 3 ,
 244 .Xr siginterrupt 3 ,
 245 .Xr tty 4
 246 .Sh HISTORY
 247 This
 248 .Fn signal
 249 facility appeared in
 250 .Bx 4.0 .