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