2 .\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
30 .Nm sysdecode_accessmode ,
31 .Nm sysdecode_atflags ,
32 .Nm sysdecode_capfcntlrights ,
33 .Nm sysdecode_close_range_flags ,
34 .Nm sysdecode_fcntl_fileflags ,
35 .Nm sysdecode_fileflags ,
36 .Nm sysdecode_filemode ,
37 .Nm sysdecode_flock_operation ,
38 .Nm sysdecode_mlockall_flags ,
39 .Nm sysdecode_mmap_flags ,
40 .Nm sysdecode_mmap_prot ,
41 .Nm sysdecode_mount_flags ,
42 .Nm sysdecode_msg_flags ,
43 .Nm sysdecode_msync_flags ,
44 .Nm sysdecode_open_flags ,
45 .Nm sysdecode_pipe2_flags ,
46 .Nm sysdecode_pollfd_events ,
47 .Nm sysdecode_reboot_howto ,
48 .Nm sysdecode_rfork_flags ,
49 .Nm sysdecode_semget_flags ,
50 .Nm sysdecode_sendfile_flags ,
51 .Nm sysdecode_shmat_flags ,
52 .Nm sysdecode_sctp_nxt_flags ,
53 .Nm sysdecode_sctp_rcv_flags ,
54 .Nm sysdecode_sctp_snd_flags ,
55 .Nm sysdecode_socket_type ,
56 .Nm sysdecode_thr_create_flags ,
57 .Nm sysdecode_umtx_cvwait_flags ,
58 .Nm sysdecode_umtx_rwlock_flags ,
59 .Nm sysdecode_vmprot ,
60 .Nm sysdecode_wait4_options ,
61 .Nm sysdecode_wait6_options
62 .Nd print name of various bitmask values
68 .Fn sysdecode_access_mode "FILE *fp" "int mode" "int *rem"
70 .Fn sysdecode_atflags "FILE *fp" "int flags" "int *rem"
72 .Fn sysdecode_cap_fcntlrights "FILE *fp" "uint32_t rights" "uint32_t *rem"
74 .Fn sysdecode_close_range_flags "FILE *fp" "int flags" "int *rem"
76 .Fn sysdecode_fcntl_fileflags "FILE *fp" "int flags" "int *rem"
78 .Fn sysdecode_fileflags "FILE *fp" "fflags_t flags" "fflags_t *rem"
80 .Fn sysdecode_filemode "FILE *fp" "int mode" "int *rem"
82 .Fn sysdecode_flock_operation "FILE *fp" "int operation" "int *rem"
84 .Fn sysdecode_mlockall_flags "FILE *fp" "int flags" "int *rem"
86 .Fn sysdecode_mmap_flags "FILE *fp" "int flags" "int *rem"
88 .Fn sysdecode_mmap_prot "FILE *fp" "int prot" "int *rem"
90 .Fn sysdecode_mount_flags "FILE *fp" "int flags" "int *rem"
92 .Fn sysdecode_msg_flags "FILE *fp" "int flags" "int *rem"
94 .Fn sysdecode_msync_flags "FILE *fp" "int flags" "int *rem"
96 .Fn sysdecode_open_flags "FILE *fp" "int flags" "int *rem"
98 .Fn sysdecode_pipe2_flags "FILE *fp" "int flags" "int *rem"
100 .Fn sysdecode_pollfd_events "FILE *fp" "int flags" "int *rem"
102 .Fn sysdecode_reboot_howto "FILE *fp" "int howto" "int *rem"
104 .Fn sysdecode_rfork_flags "FILE *fp" "int flags" "int *rem"
106 .Fn sysdecode_sctp_nxt_flags "FILE *fp" "int flags" "int *rem"
108 .Fn sysdecode_sctp_rcv_flags "FILE *fp" "int flags" "int *rem"
110 .Fn sysdecode_sctp_snd_flags "FILE *fp" "int flags" "int *rem"
112 .Fn sysdecode_semget_flags "FILE *fp" "int flags" "int *rem"
114 .Fn sysdecode_sendfile_flags "FILE *fp" "int flags" "int *rem"
116 .Fn sysdecode_shmat_flags "FILE *fp" "int flags" "int *rem"
118 .Fn sysdecode_socket_type "FILE *fp" "int type" "int *rem"
120 .Fn sysdecode_thr_create_flags "FILE *fp" "int flags" "int *rem"
122 .Fn sysdecode_umtx_cvwait_flags "FILE *fp" "u_long flags" "u_long *rem"
124 .Fn sysdecode_umtx_rwlock_flags "FILE *fp" "u_long flags" "u_long *rem"
126 .Fn sysdecode_vmprot "FILE *fp" "int type" "int *rem"
128 .Fn sysdecode_wait4_options "FILE *fp" "int options" "int *rem"
130 .Fn sysdecode_wait6_options "FILE *fp" "int options" "int *rem"
134 functions are used to generate a text description of an integer value
135 built from a mask of bitfields.
136 The text description lists the C macros for field values joined by pipe
138 characters matching the format used in C source code.
139 Most of the values decoded by these functions are passed as arguments to
141 though some of these values are used internally in the kernel.
143 Each function writes the text description to
145 The second argument should contain the integer value to be decoded.
148 argument is set to the value of any bits that were not decoded
149 .Pq bit fields that do not have a corresponding C macro .
153 if the caller does not need this value.
154 Each function returns
156 if any bit fields in the value were decoded and
158 if no bit fields were decoded.
160 Most of these functions decode an argument passed to a system call:
161 .Bl -column "Fn sysdecode_flock_operation" "Xr cap_fcntls_limit 2"
162 .It Sy Function Ta Sy System Call Ta Sy Argument
163 .It Fn sysdecode_access_mode Ta Xr access 2 Ta Fa mode
164 .It Fn sysdecode_atflags Ta Xr chflagsat 2 , Xr fstatat 2 Ta Fa atflag , Fa flag
165 .It Fn sysdecode_cap_fcntlrights Ta Xr cap_fcntls_limit 2 Ta Fa fcntlrights
166 .It Fn sysdecode_fileflags Ta Xr chflags 2 Ta Fa flags
167 .It Fn sysdecode_filemode Ta Xr chmod 2 , Xr open 2 Ta mode
168 .It Fn sysdecode_flock_operation Ta Xr flock 2 Ta Fa operation
169 .It Fn sysdecode_mlockall_flags Ta Xr mlockall 2 Ta Fa flags
170 .It Fn sysdecode_mmap_flags Ta Xr mmap 2 Ta Fa flags
171 .It Fn sysdecode_mmap_prot Ta Xr mmap 2 Ta Fa prot
172 .It Fn sysdecode_mount_flags Ta Xr mount 2 Ta Fa flags
173 .It Fn sysdecode_msg_flags Ta Xr recv 2 , Xr send 2 Ta Fa flags
174 .It Fn sysdecode_msync_flags Ta Xr msync 2 Ta Fa flags
175 .It Fn sysdecode_open_flags Ta Xr open 2 Ta Fa flags
176 .It Fn sysdecode_pipe2_flags Ta Xr pipe2 Ta Fa flags
177 .It Fn sysdecode_reboot_howto Ta Xr reboot 2 Ta Fa howto
178 .It Fn sysdecode_rfork_flags Ta Xr rfork 2 Ta Fa flags
179 .It Fn sysdecode_semget_flags Ta Xr semget 2 Ta Fa flags
180 .It Fn sysdecode_sendfile_flags Ta Xr sendfile 2 Ta Fa flags
181 .It Fn sysdecode_shmat_flags Ta Xr shmat 2 Ta Fa flags
182 .It Fn sysdecode_socket_type Ta Xr socket 2 Ta Fa type
183 .It Fn sysdecode_thr_create_flags Ta Xr thr_create 2 Ta Fa flags
184 .It Fn sysdecode_wait4_options Ta Xr wait4 2 Ta Fa options
185 .It Fn sysdecode_wait6_options Ta Xr wait6 2 Ta Fa options
188 Other functions decode the values described below:
189 .Bl -tag -width ".Fn sysdecode_umtx_cvwait_flags"
190 .It Fn sysdecode_fcntl_fileflags
191 The file flags used with the
197 .It Fn sysdecode_pollfd_events
204 .It Fn sysdecode_sctp_nxt_flags
208 .Vt struct sctp_nxtinfo .
209 .It Fn sysdecode_sctp_rcv_flags
213 .Vt struct sctp_rcvinfo .
214 .It Fn sysdecode_sctp_snd_flags
218 .Vt struct sctp_sndinfo .
219 .It Fn sysdecode_umtx_cvwait_flags
227 .It Fn sysdecode_umtx_rwlock_flags
233 .Dv UMTX_OP_RW_RDLOCK
235 .It Fn sysdecode_vmprot
236 The memory protection flags stored in
245 if any bit fields in the value were decoded and
247 if no bit fields were decoded.