xref: /freebsd/lib/libsysdecode/sysdecode_sigcode.3 (revision 29fc4075e69fd27de0cded313ac6000165d99f8b)
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.\" $FreeBSD$
26.\"
27.Dd October 17, 2016
28.Dt sysdecode_sigcode 3
29.Os
30.Sh NAME
31.Nm sysdecode_sigcode
32.Nd lookup name of signal code
33.Sh LIBRARY
34.Lb libsysdecode
35.Sh SYNOPSIS
36.In sysdecode.h
37.Ft const char *
38.Fn sysdecode_sigcode "int signal" "int si_code"
39.Sh DESCRIPTION
40The
41.Fn sysdecode_sigcode
42function returns a text description of the
43.Fa si_code
44field of the
45.Vt siginfo_t
46object associated with an instance of signal
47.Fa sig .
48The text description contains the name of the C macro whose value matches
49.Fa si_code .
50General purpose signal codes such as
51.Dv SI_USER
52are handled as well as signal-specific codes for
53.Dv SIGBUS ,
54.Dv SIGCHLD ,
55.Dv SIGFPE ,
56.Dv SIGILL ,
57.Dv SIGSEGV
58and
59.Dv SIGTRAP .
60If
61.Fa si_code
62does not represent a known signal code,
63.Fn sysdecode_sigcode
64returns
65.Dv NULL .
66.Sh RETURN VALUES
67The
68.Fn sysdecode_sigcode
69function returns a pointer to a signal code description or
70.Dv NULL
71if
72.Fa si_code
73is not a known signal code.
74.Sh SEE ALSO
75.Xr sysdecode_sigbus_code 3 ,
76.Xr sysdecode_sigchld_code 3 ,
77.Xr sysdecode_sigfpe_code 3 ,
78.Xr sysdecode_sigill_code 3 ,
79.Xr sysdecode_sigsegv_code 3 ,
80.Xr sysdecode_sigtrap_code 3
81