lib/libsysdecode/sysdecode_enum.3

   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 September 3, 2017
  29 .Dt sysdecode_enum 3
  30 .Os
  31 .Sh NAME
  32 .Nm sysdecode_enum ,
  33 .Nm sysdecode_acltype ,
  34 .Nm sysdecode_atfd ,
  35 .Nm sysdecode_extattrnamespace ,
  36 .Nm sysdecode_fadvice ,
  37 .Nm sysdecode_fcntl_cmd ,
  38 .Nm sysdecode_getfsstat_mode ,
  39 .Nm sysdecode_getrusage_who ,
  40 .Nm sysdecode_idtype ,
  41 .Nm sysdecode_ipproto ,
  42 .Nm sysdecode_kldsym_cmd ,
  43 .Nm sysdecode_kldunload_flags ,
  44 .Nm sysdecode_lio_listio_mode ,
  45 .Nm sysdecode_madvice ,
  46 .Nm sysdecode_minherit_flags ,
  47 .Nm sysdecode_msgctl_cmd ,
  48 .Nm sysdecode_nfssvc_flags ,
  49 .Nm sysdecode_pathconf_name ,
  50 .Nm sysdecode_prio_which ,
  51 .Nm sysdecode_procctl_cmd ,
  52 .Nm sysdecode_ptrace_request ,
  53 .Nm sysdecode_rlimit ,
  54 .Nm sysdecode_rtprio_function ,
  55 .Nm sysdecode_scheduler_policy ,
  56 .Nm sysdecode_semctl_cmd ,
  57 .Nm sysdecode_shmctl_cmd ,
  58 .Nm sysdecode_shutdown_how ,
  59 .Nm sysdecode_sigbus_code ,
  60 .Nm sysdecode_sigchld_code ,
  61 .Nm sysdecode_sigfpe_code ,
  62 .Nm sysdecode_sigill_code ,
  63 .Nm sysdecode_signal ,
  64 .Nm sysdecode_sigprocmask_how ,
  65 .Nm sysdecode_sigsegv_code ,
  66 .Nm sysdecode_sigtrap_code ,
  67 .Nm sysdecode_sockaddr_family ,
  68 .Nm sysdecode_socketdomain ,
  69 .Nm sysdecode_sockettype ,
  70 .Nm sysdecode_sockopt_level ,
  71 .Nm sysdecode_sysarch_number ,
  72 .Nm sysdecode_umtx_op ,
  73 .Nm sysdecode_vmresult ,
  74 .Nm sysdecode_whence
  75 .Nd lookup name of various enumerated values
  76 .Sh LIBRARY
  77 .Lb libsysdecode
  78 .Sh SYNOPSIS
  79 .In sys/types.h
  80 .In stdbool.h
  81 .In sysdecode.h
  82 .Ft const char *
  83 .Fn sysdecode_acltype "int type"
  84 .Ft const char *
  85 .Fn sysdecode_atfd "int fd"
  86 .Ft const char *
  87 .Fn sysdecode_extattrnamespace "int namespace"
  88 .Ft const char *
  89 .Fn sysdecode_fadvice "int advice"
  90 .Ft const char *
  91 .Fn sysdecode_fcntl_cmd "int cmd"
  92 .Ft const char *
  93 .Fn sysdecode_getfsstat_mode "int mode"
  94 .Ft const char *
  95 .Fn sysdecode_getrusage_who "int who"
  96 .Ft const char *
  97 .Fn sysdecode_idtype "int idtype"
  98 .Ft const char *
  99 .Fn sysdecode_ipproto "int protocol"
 100 .Ft const char *
 101 .Fn sysdecode_kldsym_cmd "int cmd"
 102 .Ft const char *
 103 .Fn sysdecode_kldunload_flags "int flags"
 104 .Ft const char *
 105 .Fn sysdecode_lio_listio_mode "int mode"
 106 .Ft const char *
 107 .Fn sysdecode_madvice "int advice"
 108 .Ft const char *
 109 .Fn sysdecode_minherit_flags "int inherit"
 110 .Ft const char *
 111 .Fn sysdecode_msgctl_cmd "int cmd"
 112 .Ft const char *
 113 .Fn sysdecode_nfssvc_flags "int flags"
 114 .Ft const char *
 115 .Fn sysdecode_pathconf_name "int name"
 116 .Ft const char *
 117 .Fn sysdecode_prio_which "int which"
 118 .Ft const char *
 119 .Fn sysdecode_procctl_cmd "int cmd"
 120 .Ft const char *
 121 .Fn sysdecode_ptrace_request "int request"
 122 .Ft const char *
 123 .Fn sysdecode_rlimit "int resource"
 124 .Ft const char *
 125 .Fn sysdecode_rtprio_function "int function"
 126 .Ft const char *
 127 .Fn sysdecode_scheduler_policy "int policy"
 128 .Ft const char *
 129 .Fn sysdecode_semctl_cmd "int cmd"
 130 .Ft const char *
 131 .Fn sysdecode_shmctl_cmd "int cmd"
 132 .Ft const char *
 133 .Fn sysdecode_shutdown_how "int how"
 134 .Ft const char *
 135 .Fn sysdecode_sigbus_code "int si_code"
 136 .Ft const char *
 137 .Fn sysdecode_sigchld_code "int si_code"
 138 .Ft const char *
 139 .Fn sysdecode_sigfpe_code "int si_code"
 140 .Ft const char *
 141 .Fn sysdecode_sigill_code "int si_code"
 142 .Ft const char *
 143 .Fn sysdecode_signal "int sig"
 144 .Ft const char *
 145 .Fn sysdecode_sigprocmask_how "int how"
 146 .Ft const char *
 147 .Fn sysdecode_sigsegv_code "int si_code"
 148 .Ft const char *
 149 .Fn sysdecode_sigtrap_code "int si_code"
 150 .Ft const char *
 151 .Fn sysdecode_sockaddr_family "int sa_family"
 152 .Ft const char *
 153 .Fn sysdecode_socketdomain "int domain"
 154 .Ft const char *
 155 .Fn sysdecode_sockettype "int type"
 156 .Ft const char *
 157 .Fn sysdecode_sockopt_level "int level"
 158 .Ft const char *
 159 .Fn sysdecode_sysarch_number "int number"
 160 .Ft const char *
 161 .Fn sysdecode_umtx_op "int op"
 162 .Ft const char *
 163 .Fn sysdecode_vmresult "int result"
 164 .Ft const char *
 165 .Fn sysdecode_whence "int whence"
 166 .Sh DESCRIPTION
 167 The
 168 .Nm
 169 functions return a text description of an integer value.
 170 The text description matches the name of a C macro with the same value as the
 171 sole function argument.
 172 .Dv NULL
 173 is returned if there is no matching C macro name.
 174 .Pp
 175 Most of these functions decode an argument passed to a system call:
 176 .Bl -column "Fn sysdecode_extattrnamespace" "Xr sched_setscheduler 2"
 177 .It Sy Function Ta Sy System Call Ta Sy Argument
 178 .It Fn sysdecode_acltype Ta Xr acl_get_file 3 Ta Fa type
 179 .It Fn sysdecode_atfd Ta Xr openat 2 Ta Fa fd
 180 .It Fn sysdecode_extattrnamespace Ta Xr extattr_get_fd 2 Ta Fa attrnamespace
 181 .It Fn sysdecode_fadvice Ta Xr posix_fadvise 2 Ta Fa advice
 182 .It Fn sysdecode_fcntl_cmd Ta Xr fcntl 2 Ta Fa cmd
 183 .It Fn sysdecode_getfsstat_mode Ta Xr getfsstat 2 Ta Fa mode
 184 .It Fn sysdecode_idtype Ta
 185 .Xr procctl 2 ,
 186 .Xr waitid 2
 187 .Ta Fa idtype
 188 .It Fn sysdecode_kldsym_cmd Ta Xr kldsym 2 Ta Fa cmd
 189 .It Fn sysdecode_kldunload_flags Ta Xr kldunloadf 2 Ta Fa flags
 190 .It Fn sysdecode_lio_listio_mode Ta Xr lio_listio 2 Ta Fa mode
 191 .It Fn sysdecode_madvice Ta Xr madvise 2 Ta Fa advice
 192 .It Fn sysdecode_minherit_inherit Ta Xr minherit 2 Ta Fa inherit
 193 .It Fn sysdecode_msgctl_cmd Ta Xr msgctl 2 Ta Fa cmd
 194 .It Fn sysdecode_nfssvc_flags Ta Xr nfssvc 2 Ta Fa flags
 195 .It Fn sysdecode_pathconf_name Ta Xr pathconf 2 Ta Fa name
 196 .It Fn sysdecode_prio_which Ta Xr getpriority 2 Ta Fa which
 197 .It Fn sysdecode_procctl_cmd Ta Xr procctl 2 Ta Fa cmd
 198 .It Fn sysdecode_ptrace_request Ta Xr ptrace 2 Ta Fa request
 199 .It Fn sysdecode_rlimit Ta Xr getrlimit 2 Ta Fa resource
 200 .It Fn sysdecode_rtprio_function Ta Xr rtprio 2 Ta Fa function
 201 .It Fn sysdecode_getrusage_who Ta Xr getrusage 2 Ta Fa who
 202 .It Fn sysdecode_scheduler_policy Ta Xr sched_setscheduler 2 Ta Fa policy
 203 .It Fn sysdecode_semctl_cmd Ta Xr semctl 2 Ta Fa cmd
 204 .It Fn sysdecode_shmctl_cmd Ta Xr shmctl 2 Ta Fa cmd
 205 .It Fn sysdecode_shutdown_how Ta Xr shutdown 2 Ta Fa how
 206 .It Fn sysdecode_sigprocmask_how Ta Xr sigprocmask 2 Ta Fa how
 207 .It Fn sysdecode_sockopt_level Ta Xr getsockopt 2 Ta Fa level
 208 .It Fn sysdecode_sysarch_number Ta Xr sysarch 2 Ta Fa number
 209 .It Fn sysdecode_umtx_op Ta Xr _umtx_op 2 Ta Fa op
 210 .It Fn sysdecode_whence Ta Xr lseek 2 Ta Fa whence
 211 .El
 212 .Pp
 213 These functions decode signal-specific signal codes stored in the
 214 .Fa si_code
 215 field of the
 216 .Vt siginfo_t
 217 object associated with an instance of signal:
 218 .Bl -column "Fn sysdecode_sigchld_code"
 219 .It Sy Function Ta Sy Signal
 220 .It Fn sysdecode_sigbus_code Ta Dv SIGBUS
 221 .It Fn sysdecode_sigchld_code Ta Dv SIGCHLD
 222 .It Fn sysdecode_sigfpe_code Ta Dv SIGFPE
 223 .It Fn sysdecode_sigill_code Ta Dv SIGILL
 224 .It Fn sysdecode_sigsegv_code Ta Dv SIGSEGV
 225 .It Fn sysdecode_sigtrap_code Ta Dv SIGBTRAP
 226 .El
 227 .Pp
 228 Other functions decode the values described below:
 229 .Bl -tag -width "Fn sysdecode_sockaddr_family"
 230 .It Fn sysdecode_ipproto
 231 An IP protocol.
 232 .It Fn sysdecode_signal
 233 A process signal.
 234 .It Fn sysdecode_sockaddr_family
 235 A socket address family.
 236 .It Fn sysdecode_socketdomain
 237 A socket domain.
 238 .It Fn sysdecode_vmresult
 239 The return value of a function in the virtual memory subsystem of the kernel
 240 indicating the status of the associated request.
 241 .El
 242 .Sh RETURN VALUES
 243 The
 244 .Nm
 245 functions return the name of a matching C macro or
 246 .Dv NULL
 247 if no matching C macro was found.
 248 .Sh SEE ALSO
 249 .Xr sysdecode 3 ,
 250 .Xr sysdecode_mask 3 ,
 251 .Xr sysdecode_sigcode 3