xref: /freebsd/lib/libsysdecode/sysdecode_sigcode.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1*9289f547SJohn Baldwin.\"
2*9289f547SJohn Baldwin.\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
3*9289f547SJohn Baldwin.\"
4*9289f547SJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
5*9289f547SJohn Baldwin.\" modification, are permitted provided that the following conditions
6*9289f547SJohn Baldwin.\" are met:
7*9289f547SJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
8*9289f547SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
9*9289f547SJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
10*9289f547SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
11*9289f547SJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
12*9289f547SJohn Baldwin.\"
13*9289f547SJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*9289f547SJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*9289f547SJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*9289f547SJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*9289f547SJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*9289f547SJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*9289f547SJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*9289f547SJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*9289f547SJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*9289f547SJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*9289f547SJohn Baldwin.\" SUCH DAMAGE.
24*9289f547SJohn Baldwin.\"
25*9289f547SJohn Baldwin.Dd October 17, 2016
26*9289f547SJohn Baldwin.Dt sysdecode_sigcode 3
27*9289f547SJohn Baldwin.Os
28*9289f547SJohn Baldwin.Sh NAME
29*9289f547SJohn Baldwin.Nm sysdecode_sigcode
30*9289f547SJohn Baldwin.Nd lookup name of signal code
31*9289f547SJohn Baldwin.Sh LIBRARY
32*9289f547SJohn Baldwin.Lb libsysdecode
33*9289f547SJohn Baldwin.Sh SYNOPSIS
34*9289f547SJohn Baldwin.In sysdecode.h
35*9289f547SJohn Baldwin.Ft const char *
36*9289f547SJohn Baldwin.Fn sysdecode_sigcode "int signal" "int si_code"
37*9289f547SJohn Baldwin.Sh DESCRIPTION
38*9289f547SJohn BaldwinThe
39*9289f547SJohn Baldwin.Fn sysdecode_sigcode
40*9289f547SJohn Baldwinfunction returns a text description of the
41*9289f547SJohn Baldwin.Fa si_code
42*9289f547SJohn Baldwinfield of the
43*9289f547SJohn Baldwin.Vt siginfo_t
44*9289f547SJohn Baldwinobject associated with an instance of signal
45*9289f547SJohn Baldwin.Fa sig .
46*9289f547SJohn BaldwinThe text description contains the name of the C macro whose value matches
47*9289f547SJohn Baldwin.Fa si_code .
48*9289f547SJohn BaldwinGeneral purpose signal codes such as
49*9289f547SJohn Baldwin.Dv SI_USER
50*9289f547SJohn Baldwinare handled as well as signal-specific codes for
51*9289f547SJohn Baldwin.Dv SIGBUS ,
52*9289f547SJohn Baldwin.Dv SIGCHLD ,
53*9289f547SJohn Baldwin.Dv SIGFPE ,
54*9289f547SJohn Baldwin.Dv SIGILL ,
55*9289f547SJohn Baldwin.Dv SIGSEGV
56*9289f547SJohn Baldwinand
57*9289f547SJohn Baldwin.Dv SIGTRAP .
58*9289f547SJohn BaldwinIf
59*9289f547SJohn Baldwin.Fa si_code
60*9289f547SJohn Baldwindoes not represent a known signal code,
61*9289f547SJohn Baldwin.Fn sysdecode_sigcode
62*9289f547SJohn Baldwinreturns
63*9289f547SJohn Baldwin.Dv NULL .
64*9289f547SJohn Baldwin.Sh RETURN VALUES
65*9289f547SJohn BaldwinThe
66*9289f547SJohn Baldwin.Fn sysdecode_sigcode
67*9289f547SJohn Baldwinfunction returns a pointer to a signal code description or
68*9289f547SJohn Baldwin.Dv NULL
69*9289f547SJohn Baldwinif
70*9289f547SJohn Baldwin.Fa si_code
71*9289f547SJohn Baldwinis not a known signal code.
72*9289f547SJohn Baldwin.Sh SEE ALSO
73*9289f547SJohn Baldwin.Xr sysdecode_sigbus_code 3 ,
74*9289f547SJohn Baldwin.Xr sysdecode_sigchld_code 3 ,
75*9289f547SJohn Baldwin.Xr sysdecode_sigfpe_code 3 ,
76*9289f547SJohn Baldwin.Xr sysdecode_sigill_code 3 ,
77*9289f547SJohn Baldwin.Xr sysdecode_sigsegv_code 3 ,
78*9289f547SJohn Baldwin.Xr sysdecode_sigtrap_code 3
79