xref: /freebsd/lib/libsysdecode/sysdecode_sigcode.3 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1.\"
2.\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd October 17, 2016
26.Dt sysdecode_sigcode 3
27.Os
28.Sh NAME
29.Nm sysdecode_sigcode
30.Nd lookup name of signal code
31.Sh LIBRARY
32.Lb libsysdecode
33.Sh SYNOPSIS
34.In sysdecode.h
35.Ft const char *
36.Fn sysdecode_sigcode "int signal" "int si_code"
37.Sh DESCRIPTION
38The
39.Fn sysdecode_sigcode
40function returns a text description of the
41.Fa si_code
42field of the
43.Vt siginfo_t
44object associated with an instance of signal
45.Fa sig .
46The text description contains the name of the C macro whose value matches
47.Fa si_code .
48General purpose signal codes such as
49.Dv SI_USER
50are handled as well as signal-specific codes for
51.Dv SIGBUS ,
52.Dv SIGCHLD ,
53.Dv SIGFPE ,
54.Dv SIGILL ,
55.Dv SIGSEGV
56and
57.Dv SIGTRAP .
58If
59.Fa si_code
60does not represent a known signal code,
61.Fn sysdecode_sigcode
62returns
63.Dv NULL .
64.Sh RETURN VALUES
65The
66.Fn sysdecode_sigcode
67function returns a pointer to a signal code description or
68.Dv NULL
69if
70.Fa si_code
71is not a known signal code.
72.Sh SEE ALSO
73.Xr sysdecode_sigbus_code 3 ,
74.Xr sysdecode_sigchld_code 3 ,
75.Xr sysdecode_sigfpe_code 3 ,
76.Xr sysdecode_sigill_code 3 ,
77.Xr sysdecode_sigsegv_code 3 ,
78.Xr sysdecode_sigtrap_code 3
79