xref: /freebsd/lib/libsysdecode/sysdecode_kevent.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1*ffb66079SJohn Baldwin.\"
2*ffb66079SJohn Baldwin.\" Copyright (c) 2017 John Baldwin <jhb@FreeBSD.org>
3*ffb66079SJohn Baldwin.\"
4*ffb66079SJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
5*ffb66079SJohn Baldwin.\" modification, are permitted provided that the following conditions
6*ffb66079SJohn Baldwin.\" are met:
7*ffb66079SJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
8*ffb66079SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
9*ffb66079SJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
10*ffb66079SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
11*ffb66079SJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
12*ffb66079SJohn Baldwin.\"
13*ffb66079SJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*ffb66079SJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*ffb66079SJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*ffb66079SJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*ffb66079SJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*ffb66079SJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*ffb66079SJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*ffb66079SJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*ffb66079SJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*ffb66079SJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*ffb66079SJohn Baldwin.\" SUCH DAMAGE.
24*ffb66079SJohn Baldwin.\"
25*ffb66079SJohn Baldwin.Dd November 24, 2017
26*ffb66079SJohn Baldwin.Dt sysdecode_kevent 3
27*ffb66079SJohn Baldwin.Os
28*ffb66079SJohn Baldwin.Sh NAME
29*ffb66079SJohn Baldwin.Nm sysdecode_kevent ,
30*ffb66079SJohn Baldwin.Nm sysdecode_kevent_fflags ,
31*ffb66079SJohn Baldwin.Nm sysdecode_kevent_filter ,
32*ffb66079SJohn Baldwin.Nm sysdecode_kevent_flags
33*ffb66079SJohn Baldwin.Nd output description of kevent structure fields
34*ffb66079SJohn Baldwin.Sh LIBRARY
35*ffb66079SJohn Baldwin.Lb libsysdecode
36*ffb66079SJohn Baldwin.Sh SYNOPSIS
37*ffb66079SJohn Baldwin.In sysdecode.h
38*ffb66079SJohn Baldwin.Ft void
39*ffb66079SJohn Baldwin.Fn sysdecode_kevent_fflags "FILE *fp" "short filter" "int fflags" "int base"
40*ffb66079SJohn Baldwin.Ft bool
41*ffb66079SJohn Baldwin.Fn sysdecode_kevent_flags "FILE *fp" "int flags" "int *rem"
42*ffb66079SJohn Baldwin.Ft const char *
43*ffb66079SJohn Baldwin.Fn sysdecode_kevent_filter "int filter"
44*ffb66079SJohn Baldwin.Sh DESCRIPTION
45*ffb66079SJohn BaldwinThese functions provide text descriptions of
46*ffb66079SJohn Baldwin.Vt struct kevent
47*ffb66079SJohn Baldwinfields.
48*ffb66079SJohn Baldwin.Pp
49*ffb66079SJohn BaldwinThe
50*ffb66079SJohn Baldwin.Fn sysdecode_kevent_fflags
51*ffb66079SJohn Baldwinfunction outputs a text description of the
52*ffb66079SJohn Baldwin.Fa fflags
53*ffb66079SJohn Baldwinmember of a
54*ffb66079SJohn Baldwin.Vt struct kevent
55*ffb66079SJohn Baldwinto the stream
56*ffb66079SJohn Baldwin.Fa fp .
57*ffb66079SJohn BaldwinFor the
58*ffb66079SJohn Baldwin.Dv EVFILT_READ ,
59*ffb66079SJohn Baldwin.Dv EVFILT_WRITE ,
60*ffb66079SJohn Baldwin.Dv EVFILT_VNODE ,
61*ffb66079SJohn Baldwin.Dv EVFILT_PROC ,
62*ffb66079SJohn Baldwin.Dv EVFILT_PROCDESC ,
63*ffb66079SJohn Baldwin.Dv EVFILT_TIMER ,
64*ffb66079SJohn Baldwinand
65*ffb66079SJohn Baldwin.Dv EVFILT_USER
66*ffb66079SJohn Baldwinfilters,
67*ffb66079SJohn Baldwin.Fn sysdecode_kevent_fflags
68*ffb66079SJohn Baldwinoutputs a bitmask of filter-specific
69*ffb66079SJohn Baldwin.Dv NOTE_*
70*ffb66079SJohn Baldwinflags as documented in
71*ffb66079SJohn Baldwin.Xr kevent 2 .
72*ffb66079SJohn BaldwinFor other values of
73*ffb66079SJohn Baldwin.Fa filter ,
74*ffb66079SJohn Baldwinthe value of
75*ffb66079SJohn Baldwin.Fa fflags
76*ffb66079SJohn Baldwinis output in the indicated
77*ffb66079SJohn Baldwin.Fa base
78*ffb66079SJohn Baldwin.Pq one of 8, 10, or 16 .
79*ffb66079SJohn Baldwin.Pp
80*ffb66079SJohn BaldwinThe
81*ffb66079SJohn Baldwin.Fn sysdecode_kevent_filter
82*ffb66079SJohn Baldwinfunction returns a text description of the
83*ffb66079SJohn Baldwin.Fa filter
84*ffb66079SJohn Baldwinmember of a
85*ffb66079SJohn Baldwin.Vt struct kevent .
86*ffb66079SJohn Baldwin.Dv NULL
87*ffb66079SJohn Baldwinis returned if the
88*ffb66079SJohn Baldwin.Fa filter
89*ffb66079SJohn Baldwinvalue is unknown.
90*ffb66079SJohn Baldwin.Pp
91*ffb66079SJohn BaldwinThe
92*ffb66079SJohn Baldwin.Fn sysdecode_kevent_flags
93*ffb66079SJohn Baldwinfunction outputs a text description of the
94*ffb66079SJohn Baldwin.Fa flags
95*ffb66079SJohn Baldwinmember of a
96*ffb66079SJohn Baldwin.Vt struct kevent
97*ffb66079SJohn Baldwinto the stream
98*ffb66079SJohn Baldwin.Fa fp .
99*ffb66079SJohn BaldwinThis function uses the same calling convention and formatting as the other
100*ffb66079SJohn Baldwinfunctions described in
101*ffb66079SJohn Baldwin.Xr sysdecode_mask 3 .
102*ffb66079SJohn Baldwin.Sh RETURN VALUES
103*ffb66079SJohn BaldwinThe
104*ffb66079SJohn Baldwin.Nm sysdecode_kevent_filter
105*ffb66079SJohn Baldwinfunction returns the name of a filter or
106*ffb66079SJohn Baldwin.Dv NULL if the filter value is unknown.
107*ffb66079SJohn Baldwin.Pp
108*ffb66079SJohn BaldwinThe
109*ffb66079SJohn Baldwin.Nm sysdecode_kevent_flags
110*ffb66079SJohn Baldwinfunction returns
111*ffb66079SJohn Baldwin.Dv true
112*ffb66079SJohn Baldwinif any flags in the
113*ffb66079SJohn Baldwin.Fa flags
114*ffb66079SJohn Baldwinfield were decoded and
115*ffb66079SJohn Baldwin.Dv false
116*ffb66079SJohn Baldwinif no flags were decoded.
117*ffb66079SJohn Baldwin.Sh SEE ALSO
118*ffb66079SJohn Baldwin.Xr sysdecode 3 ,
119*ffb66079SJohn Baldwin.Xr sysdecode_enum 3 ,
120*ffb66079SJohn Baldwin.Xr sysdecode_mask 3
121