share/man/man3/siginfo.3

   1 .\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
   2 .\" 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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd July 28, 2020
  31 .Dt SIGINFO 3
  32 .Os
  33 .Sh NAME
  34 .Nm siginfo
  35 .Nd "signal generation information"
  36 .Sh SYNOPSIS
  37 .In signal.h
  38 .Sh DESCRIPTION
  39 A process may request signal information when it is catching a signal.
  40 The information specifies why the system generated that signal.
  41 To request signal information in a signal handler, the user can set
  42 .Dv SA_SIGINFO
  43 in
  44 .Va sa_flags
  45 before
  46 .Xr sigaction 2
  47 is called,
  48 otherwise the user can use
  49 .Xr sigwaitinfo 2
  50 and
  51 .Xr sigtimedwait 2
  52 to get signal information.
  53 In either case, the system returns the information in a structure of type
  54 .Vt siginfo_t ,
  55 which includes the following information:
  56 .Bl -column ".Vt union signal" ".Va si_overrun"
  57 .It Sy Type Ta Sy Member Ta Sy Description
  58 .It Vt int Ta Va si_signo Ta
  59 signal number
  60 .It Vt int Ta Va si_errno Ta
  61 error number
  62 .It Vt int Ta Va si_code Ta
  63 signal code
  64 .It Vt union sigval Ta Va si_value Ta
  65 signal value
  66 .It Vt pid_t Ta Va si_pid Ta
  67 sending process ID
  68 .It Vt uid_t Ta Va si_uid Ta
  69 sending process's real user ID
  70 .It Vt void Ta Va *si_addr Ta
  71 virtual address
  72 .It Vt int Ta Va si_status Ta
  73 exit value or signal
  74 .It Vt long Ta Va si_band Ta
  75 band event for
  76 .Dv SIGPOLL
  77 .It Vt int Ta Va si_trapno Ta
  78 machine trap code
  79 .It Vt int Ta Va si_timerid Ta
  80 .Tn POSIX
  81 timer ID
  82 .It Vt int Ta Va si_overrun Ta
  83 .Tn POSIX
  84 timer overrun count
  85 .It Vt int Ta Va si_mqd Ta
  86 .Tn POSIX
  87 message queue ID
  88 .El
  89 .Pp
  90 The
  91 .Va si_signo
  92 member contains the signal number.
  93 .Pp
  94 The
  95 .Va si_errno
  96 member contains an error number defined in the file
  97 .In errno.h .
  98 .Pp
  99 The
 100 .Va si_code
 101 member contains a code which describes the cause of the signal.
 102 The macros specified in the
 103 .Sy Code
 104 column of the following table are defined
 105 for use as values of
 106 .Va si_code
 107 that are signal-specific or non-signal-specific reasons why the signal was
 108 generated:
 109 .Bl -column ".Dv SIGPOLL" ".Dv CLD_CONTINUED"
 110 .It Sy Signal Ta Sy Code Ta Sy Reason
 111 .It Dv SIGILL Ta Dv ILL_ILLOPC Ta
 112 illegal opcode
 113 .It Ta Dv ILL_ILLOPN Ta
 114 illegal operand
 115 .It Ta Dv ILL_ILLADR Ta
 116 illegal addressing mode
 117 .It Ta Dv ILL_ILLTRP Ta
 118 illegal trap
 119 .It Ta Dv ILL_PRVOPC Ta
 120 illegal privileged opcode
 121 .It Ta Dv ILL_PRVREG Ta
 122 illegal privileged register
 123 .It Ta Dv ILL_COPROC Ta
 124 coprocessor error
 125 .It Ta Dv ILL_BADSTK Ta
 126 internal stack error
 127 .It Dv SIGFPE Ta Dv FPE_INTDIV Ta
 128 integer divide by zero
 129 .It Ta Dv FPE_INTOVF Ta
 130 integer overflow
 131 .It Ta Dv FPE_FLTDIV Ta
 132 floating-point divide by zero
 133 .It Ta Dv FPE_FLTOVF Ta
 134 floating-point overflow
 135 .It Ta Dv FPE_FLTUND Ta
 136 floating-point underflow
 137 .It Ta Dv FPE_FLTRES Ta
 138 floating-point inexact result
 139 .It Ta Dv FPE_FLTINV Ta
 140 invalid floating-point operation
 141 .It Ta Dv FPE_FLTSUB Ta
 142 subscript out of range
 143 .It Dv SIGSEGV Ta Dv SEGV_MAPERR Ta
 144 address not mapped to object
 145 .It Ta Dv SEGV_ACCERR Ta
 146 invalid permissions for mapped object
 147 .It Dv SIGBUS Ta Dv BUS_ADRALN Ta
 148 invalid address alignment
 149 .It Ta Dv BUS_ADRERR Ta
 150 nonexistent physical address
 151 .It Ta Dv BUS_OBJERR Ta
 152 object-specific hardware error
 153 .It Ta Dv BUS_OOMERR Ta
 154 cannot alloc a page to map at fault
 155 .It Dv SIGTRAP Ta Dv TRAP_BRKPT Ta
 156 process breakpoint
 157 .It Ta Dv TRAP_TRACE Ta
 158 process trace trap
 159 .It Ta Dv TRAP_DTRACE Ta
 160 DTrace induced trap
 161 .It Ta Dv TRAP_CAP Ta
 162 capabilities protective trap
 163 .It Dv SIGCHLD Ta Dv CLD_EXITED Ta
 164 child has exited
 165 .It Ta Dv CLD_KILLED Ta
 166 child has terminated abnormally and did not create a core file
 167 .It Ta Dv CLD_DUMPED Ta
 168 child has terminated abnormally and created a core file
 169 .It Ta Dv CLD_TRAPPED Ta
 170 traced child has trapped
 171 .It Ta Dv CLD_STOPPED Ta
 172 child has stopped
 173 .It Ta Dv CLD_CONTINUED Ta
 174 stopped child has continued
 175 .It Dv SIGPOLL Ta Dv POLL_IN Ta
 176 data input available
 177 .It Ta Dv POLL_OUT Ta
 178 output buffers available
 179 .It Ta Dv POLL_MSG Ta
 180 input message available
 181 .It Ta Dv POLL_ERR Ta
 182 I/O error
 183 .It Ta Dv POLL_PRI Ta
 184 high priority input available
 185 .It Ta Dv POLL_HUP Ta
 186 device disconnected
 187 .It Any Ta Dv SI_NOINFO Ta
 188 Only the
 189 .Va si_signo
 190 member is meaningful; the value of all other members is unspecified.
 191 .It Ta Dv SI_USER Ta
 192 signal sent by
 193 .Xr kill 2
 194 .It Ta Dv SI_QUEUE Ta
 195 signal sent by
 196 .Xr sigqueue 2
 197 .It Ta Dv SI_TIMER Ta
 198 signal generated by expiration of a timer set by
 199 .Xr timer_settime 2
 200 .It Ta Dv SI_ASYNCIO Ta
 201 signal generated by completion of an asynchronous I/O request
 202 .It Ta Dv SI_MESGQ Ta
 203 signal generated by arrival of a message on an empty message queue
 204 .It Ta Dv SI_KERNEL Ta
 205 signal generated by miscellaneous parts of the kernel
 206 .It Ta Dv SI_LWP Ta
 207 signal sent by
 208 .Xr pthread_kill 3
 209 .El
 210 .Pp
 211 For synchronous signals,
 212 .Va si_addr
 213 is generally set to the address of the faulting instruction.
 214 However, synchronous signals raised by a faulting memory access such as
 215 .Dv SIGSEGV
 216 and
 217 .Dv SIGBUS
 218 may report the address of the faulting memory access (if available) in
 219 .Va si_addr
 220 instead.
 221 .Pp
 222 Sychronous signals set
 223 .Va si_trapno
 224 to a machine-dependent trap number.
 225 .Pp
 226 In addition, the following signal-specific information is available:
 227 .Bl -column ".Dv SIGPOLL" ".Dv CLD_CONTINUED"
 228 .It Sy Signal Ta Sy Member Ta Sy Value
 229 .It Dv SIGCHLD Ta Va si_pid Ta
 230 child process ID
 231 .It Ta Va si_status Ta
 232 exit value or signal; if
 233 .Va si_code
 234 is equal to
 235 .Dv CLD_EXITED ,
 236 then it is equal to the exit value of the child process, otherwise,
 237 it is equal to a signal that caused the child process to change state.
 238 .It Ta Va si_uid Ta "real user ID of the process that sent the signal"
 239 .It Dv SIGPOLL Ta Va si_band Ta "band event for"
 240 .Dv POLL_IN , POLL_OUT ,
 241 or
 242 .Dv POLL_MSG
 243 .El
 244 .Pp
 245 Finally, the following code-specific information is available:
 246 .Bl -column ".Dv SI_ASYNCIO" ".Va si_overrun"
 247 .It Sy Code Ta Sy Member Ta Sy Value
 248 .It Dv SI_USER Ta Va si_pid Ta
 249 the process ID that sent the signal
 250 .It Ta Va si_uid Ta
 251 real user ID of the process that sent the signal
 252 .It Dv SI_QUEUE Ta Va si_value Ta
 253 the value passed to
 254 .Xr sigqueue 2
 255 system call
 256 .It Ta Va si_pid Ta
 257 the process ID that sent the signal
 258 .It Ta Va si_uid Ta
 259 real user ID of the process that sent the signal
 260 .It Dv SI_TIMER Ta Va si_value Ta
 261 the value passed to
 262 .Xr timer_create 2
 263 system call
 264 .It Ta Va si_timerid Ta
 265 the timer ID returned by
 266 .Xr timer_create 2
 267 system call
 268 .It Ta Va si_overrun Ta
 269 timer overrun count corresponding to the signal
 270 .It Ta Va si_errno Ta
 271 If timer overrun will be
 272 .Brq Dv DELAYTIMER_MAX ,
 273 an error code defined in
 274 .In errno.h
 275 is set
 276 .It Dv SI_ASYNCIO Ta Va si_value Ta
 277 the value passed to aio system calls
 278 .It Dv SI_MESGQ Ta Va si_value Ta
 279 the value passed to
 280 .Xr mq_notify 2
 281 system call
 282 .It Ta Va si_mqd Ta
 283 the ID of the message queue which generated the signal
 284 .It Dv SI_LWP Ta Va si_pid Ta
 285 the process ID that sent the signal
 286 .It Ta Va si_uid Ta
 287 real user ID of the process that sent the signal
 288 .El
 289 .Sh NOTES
 290 Currently, the kernel never generates the
 291 .Dv SIGPOLL
 292 signal.
 293 .Dv SIGCHLD
 294 signal is queued when a process changed its status or exited.
 295 .Tn POSIX
 296 Realtime Extensions like aio, timer, and message queue also queue
 297 signals.
 298 Signals with code
 299 .Dv SI_USER ,
 300 .Dv SI_KERNEL
 301 or
 302 .Dv SI_LWP
 303 are only queued if there are sufficient resources;
 304 otherwise,
 305 .Dv SI_NOINFO
 306 results.
 307 For some hardware architectures, the exact value of
 308 .Va si_addr
 309 might not be available.
 310 .Sh SEE ALSO
 311 .Xr aio_read 2 ,
 312 .Xr kill 2 ,
 313 .Xr mq_notify 2 ,
 314 .Xr sigaction 2 ,
 315 .Xr sigqueue 2 ,
 316 .Xr sigwaitinfo 2 ,
 317 .Xr timer_create 2 ,
 318 .Xr timer_settime 2 ,
 319 .Xr waitpid 2 ,
 320 .Xr pthread_kill 3
 321 .Sh STANDARDS
 322 The
 323 .Vt siginfo_t
 324 type conforms to
 325 .St -p1003.1-2004 .
 326 .Sh HISTORY
 327 Full support for
 328 .Tn POSIX
 329 signal information first appeared in
 330 .Fx 7.0 .
 331 The codes
 332 .Dv SI_USER
 333 and
 334 .Dv SI_KERNEL
 335 can be generated as of
 336 .Fx 8.1 .
 337 The code
 338 .Dv SI_LWP
 339 can be generated as of
 340 .Fx 9.0 .
 341 .Sh AUTHORS
 342 This manual page was written by
 343 .An David Xu Aq Mt davidxu@FreeBSD.org .