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