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