lib/libsysdecode/sysdecode_mask.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 January 2, 2017
  29 .Dt sysdecode_mask 3
  30 .Os
  31 .Sh NAME
  32 .Nm sysdecode_mask ,
  33 .Nm sysdecode_accessmode ,
  34 .Nm sysdecode_capfcntlrights ,
  35 .Nm sysdecode_fcntl_fileflags ,
  36 .Nm sysdecode_fileflags ,
  37 .Nm sysdecode_filemode ,
  38 .Nm sysdecode_flock_operation ,
  39 .Nm sysdecode_mlockall_flags ,
  40 .Nm sysdecode_mmap_flags ,
  41 .Nm sysdecode_mmap_prot ,
  42 .Nm sysdecode_mount_flags ,
  43 .Nm sysdecode_msg_flags ,
  44 .Nm sysdecode_msync_flags ,
  45 .Nm sysdecode_open_flags ,
  46 .Nm sysdecode_pipe2_flags ,
  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_socket_type ,
  53 .Nm sysdecode_thr_create_flags ,
  54 .Nm sysdecode_umtx_cvwait_flags ,
  55 .Nm sysdecode_umtx_rwlock_flags ,
  56 .Nm sysdecode_vmprot ,
  57 .Nm sysdecode_wait4_options ,
  58 .Nm sysdecode_wait6_options
  59 .Nd print name of various bitmask values
  60 .Sh LIBRARY
  61 .Lb libsysdecode
  62 .Sh SYNOPSIS
  63 .In sys/types.h
  64 .In stdbool.h
  65 .In sysdecode.h
  66 .Ft bool
  67 .Fn sysdecode_access_mode "FILE *fp" "int mode" "int *rem"
  68 .Ft bool
  69 .Fn sysdecode_cap_fcntlrights "FILE *fp" "uint32_t rights" "uint32_t *rem"
  70 .Ft bool
  71 .Fn sysdecode_fcntl_fileflags "FILE *fp" "int flags" "int *rem"
  72 .Ft bool
  73 .Fn sysdecode_fileflags "FILE *fp" "fflags_t flags" "fflags_t *rem"
  74 .Ft bool
  75 .Fn sysdecode_filemode "FILE *fp" "int mode" "int *rem"
  76 .Ft bool
  77 .Fn sysdecode_flock_operation "FILE *fp" "int operation" "int *rem"
  78 .Ft bool
  79 .Fn sysdecode_mlockall_flags "FILE *fp" "int flags" "int *rem"
  80 .Ft bool
  81 .Fn sysdecode_mmap_flags "FILE *fp" "int flags" "int *rem"
  82 .Ft bool
  83 .Fn sysdecode_mmap_prot "FILE *fp" "int prot" "int *rem"
  84 .Ft bool
  85 .Fn sysdecode_mount_flags "FILE *fp" "int flags" "int *rem"
  86 .Ft bool
  87 .Fn sysdecode_msg_flags "FILE *fp" "int flags" "int *rem"
  88 .Ft bool
  89 .Fn sysdecode_msync_flags "FILE *fp" "int flags" "int *rem"
  90 .Ft bool
  91 .Fn sysdecode_open_flags "FILE *fp" "int flags" "int *rem"
  92 .Ft bool
  93 .Fn sysdecode_pipe2_flags "FILE *fp" "int flags" "int *rem"
  94 .Ft bool
  95 .Fn sysdecode_reboot_howto "FILE *fp" "int howto" "int *rem"
  96 .Ft bool
  97 .Fn sysdecode_rfork_flags "FILE *fp" "int flags" "int *rem"
  98 .Ft bool
  99 .Fn sysdecode_semget_flags "FILE *fp" "int flags" "int *rem"
 100 .Ft bool
 101 .Fn sysdecode_sendfile_flags "FILE *fp" "int flags" "int *rem"
 102 .Ft bool
 103 .Fn sysdecode_shmat_flags "FILE *fp" "int flags" "int *rem"
 104 .Ft bool
 105 .Fn sysdecode_socket_type "FILE *fp" "int type" "int *rem"
 106 .Ft bool
 107 .Fn sysdecode_thr_create_flags "FILE *fp" "int flags" "int *rem"
 108 .Ft bool
 109 .Fn sysdecode_umtx_cvwait_flags "FILE *fp" "u_long flags" "u_long *rem"
 110 .Ft bool
 111 .Fn sysdecode_umtx_rwlock_flags "FILE *fp" "u_long flags" "u_long *rem"
 112 .Ft bool
 113 .Fn sysdecode_vmprot "FILE *fp" "int type" "int *rem"
 114 .Ft bool
 115 .Fn sysdecode_wait4_options "FILE *fp" "int options" "int *rem"
 116 .Ft bool
 117 .Fn sysdecode_wait6_options "FILE *fp" "int options" "int *rem"
 118 .Sh DESCRIPTION
 119 The
 120 .Nm
 121 functions are used to generate a text description of an integer value
 122 built from a mask of bitfields.
 123 The text description lists the C macros for field values joined by pipe
 124 .Sq |
 125 characters matching the format used in C source code.
 126 Most of the values decoded by these functions are passed as arguments to
 127 system calls,
 128 though some of these values are used internally in the kernel.
 129 .Pp
 130 Each function writes the text description to
 131 .Fa fp .
 132 The second argument should contain the integer value to be decoded.
 133 The
 134 .Fa rem
 135 argument is set to the value of any bits that were not decoded
 136 .Pq bit fields that do not have a corresponding C macro .
 137 .Fa rem
 138 may be set to
 139 .Dv NULL
 140 if the caller does not need this value.
 141 Each function returns
 142 .Dv true
 143 if any bit fields in the value were decoded and
 144 .Dv false
 145 if no bit fields were decoded.
 146 .Pp
 147 Most of these functions decode an argument passed to a system call:
 148 .Bl -column "Fn sysdecode_flock_operation" "Xr cap_fcntls_limit 2"
 149 .It Sy Function Ta Sy System Call Ta Sy Argument
 150 .It Fn sysdecode_access_mode Ta Xr access 2 Ta Fa mode
 151 .It Fn sysdecode_cap_fcntlrights Ta Xr cap_fcntls_limit 2 Ta Fa fcntlrights
 152 .It Fn sysdecode_fileflags Ta Xr chflags 2 Ta Fa flags
 153 .It Fn sysdecode_filemode Ta Xr chmod 2 , Xr open 2 Ta mode
 154 .It Fn sysdecode_flock_operation Ta Xr flock 2 Ta Fa operation
 155 .It Fn sysdecode_mlockall_flags Ta Xr mlockall 2 Ta Fa flags
 156 .It Fn sysdecode_mmap_flags Ta Xr mmap 2 Ta Fa flags
 157 .It Fn sysdecode_mmap_prot Ta Xr mmap 2 Ta Fa prot
 158 .It Fn sysdecode_mount_flags Ta Xr mount 2 Ta Fa flags
 159 .It Fn sysdecode_msg_flags Ta Xr recv 2 , Xr send 2 Ta Fa flags
 160 .It Fn sysdecode_msync_flags Ta Xr msync 2 Ta Fa flags
 161 .It Fn sysdecode_open_flags Ta Xr open 2 Ta Fa flags
 162 .It Fn sysdecode_pipe2_flags Ta Xr pipe2 Ta Fa flags
 163 .It Fn sysdecode_reboot_howto Ta Xr reboot 2 Ta Fa howto
 164 .It Fn sysdecode_rfork_flags Ta Xr rfork 2 Ta Fa flags
 165 .It Fn sysdecode_semget_flags Ta Xr semget 2 Ta Fa flags
 166 .It Fn sysdecode_sendfile_flags Ta Xr sendfile 2 Ta Fa flags
 167 .It Fn sysdecode_shmat_flags Ta Xr shmat 2 Ta Fa flags
 168 .It Fn sysdecode_socket_type Ta Xr socket 2 Ta Fa type
 169 .It Fn sysdecode_thr_create_flags Ta Xr thr_create 2 Ta Fa flags
 170 .It Fn sysdecode_wait4_options Ta Xr wait4 2 Ta Fa options
 171 .It Fn sysdecode_wait6_options Ta Xr wait6 2 Ta Fa options
 172 .El
 173 .Pp
 174 Other functions decode the values described below:
 175 .Bl -tag -width ".Fn sysdecode_umtx_cvwait_flags"
 176 .It Fn sysdecode_fcntl_fileflags
 177 The file flags used with the
 178 .Dv F_GETFL
 179 and
 180 .Dv F_SETFL
 181 .Xr fcntl 2
 182 commands.
 183 .It Fn sysdecode_umtx_cvwait_flags
 184 The
 185 .Fa val
 186 argument to
 187 .Xr _umtx_op 2
 188 for
 189 .Dv UMTX_OP_CV_WAIT
 190 operations.
 191 .It Fn sysdecode_umtx_rwlock_flags
 192 The
 193 .Fa val
 194 argument to
 195 .Xr _umtx_op 2
 196 for
 197 .Dv UMTX_OP_RW_RDLOCK
 198 operations.
 199 .It Fn sysdecode_vmprot
 200 The memory protection flags stored in
 201 .Vt vm_prot_t
 202 variables.
 203 .El
 204 .Sh RETURN VALUES
 205 The
 206 .Nm
 207 functions return
 208 .Dv true
 209 if any bit fields in the value were decoded and
 210 .Dv false
 211 if no bit fields were decoded.
 212 .Sh SEE ALSO
 213 .Xr sysdecode 3 ,
 214 .Xr sysdecode_enum 3