lib/libsysdecode/sysdecode_kevent.3

   1 .\"
   2 .\" Copyright (c) 2017 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 November 24, 2017
  28 .Dt sysdecode_kevent 3
  29 .Os
  30 .Sh NAME
  31 .Nm sysdecode_kevent ,
  32 .Nm sysdecode_kevent_fflags ,
  33 .Nm sysdecode_kevent_filter ,
  34 .Nm sysdecode_kevent_flags
  35 .Nd output description of kevent structure fields
  36 .Sh LIBRARY
  37 .Lb libsysdecode
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In stdbool.h
  41 .In stdio.h
  42 .In sysdecode.h
  43 .Ft void
  44 .Fn sysdecode_kevent_fflags "FILE *fp" "short filter" "int fflags" "int base"
  45 .Ft bool
  46 .Fn sysdecode_kevent_flags "FILE *fp" "int flags" "int *rem"
  47 .Ft const char *
  48 .Fn sysdecode_kevent_filter "int filter"
  49 .Sh DESCRIPTION
  50 These functions provide text descriptions of
  51 .Vt struct kevent
  52 fields.
  53 .Pp
  54 The
  55 .Fn sysdecode_kevent_fflags
  56 function outputs a text description of the
  57 .Fa fflags
  58 member of a
  59 .Vt struct kevent
  60 to the stream
  61 .Fa fp .
  62 For the
  63 .Dv EVFILT_READ ,
  64 .Dv EVFILT_WRITE ,
  65 .Dv EVFILT_VNODE ,
  66 .Dv EVFILT_PROC ,
  67 .Dv EVFILT_PROCDESC ,
  68 .Dv EVFILT_TIMER ,
  69 and
  70 .Dv EVFILT_USER
  71 filters,
  72 .Fn sysdecode_kevent_fflags
  73 outputs a bitmask of filter-specific
  74 .Dv NOTE_*
  75 flags as documented in
  76 .Xr kevent 2 .
  77 For other values of
  78 .Fa filter ,
  79 the value of
  80 .Fa fflags
  81 is output in the indicated
  82 .Fa base
  83 .Pq one of 8, 10, or 16 .
  84 .Pp
  85 The
  86 .Fn sysdecode_kevent_filter
  87 function returns a text description of the
  88 .Fa filter
  89 member of a
  90 .Vt struct kevent .
  91 .Dv NULL
  92 is returned if the
  93 .Fa filter
  94 value is unknown.
  95 .Pp
  96 The
  97 .Fn sysdecode_kevent_flags
  98 function outputs a text description of the
  99 .Fa flags
 100 member of a
 101 .Vt struct kevent
 102 to the stream
 103 .Fa fp .
 104 This function uses the same calling convention and formatting as the other
 105 functions described in
 106 .Xr sysdecode_mask 3 .
 107 .Sh RETURN VALUES
 108 The
 109 .Nm sysdecode_kevent_filter
 110 function returns the name of a filter or
 111 .Dv NULL if the filter value is unknown.
 112 .Pp
 113 The
 114 .Nm sysdecode_kevent_flags
 115 function returns
 116 .Dv true
 117 if any flags in the
 118 .Fa flags
 119 field were decoded and
 120 .Dv false
 121 if no flags were decoded.
 122 .Sh SEE ALSO
 123 .Xr sysdecode 3 ,
 124 .Xr sysdecode_enum 3 ,
 125 .Xr sysdecode_mask 3