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