lib/libsysdecode/sysdecode_fcntl_arg.3

   1 .\"
   2 .\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd November 24, 2017
  28 .Dt sysdecode_fcntl_arg 3
  29 .Os
  30 .Sh NAME
  31 .Nm sysdecode_fcntl_arg ,
  32 .Nm sysdecode_fcntl_arg_p
  33 .Nd output description of fcntl argument
  34 .Sh LIBRARY
  35 .Lb libsysdecode
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In stdbool.h
  39 .In stdio.h
  40 .In sysdecode.h
  41 .Ft void
  42 .Fn sysdecode_fcntl_arg "FILE *fp" "int cmd" "uintptr_t arg" "int base"
  43 .Ft bool
  44 .Fn sysdecode_fcntl_arg_p "int cmd"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn sysdecode_fcntl_arg
  48 function outputs a text description of the optional
  49 .Fa arg
  50 argument to
  51 .Xr fcntl 2
  52 to the stream
  53 .Fa fp .
  54 The type and format of
  55 .Fa arg
  56 are determined by
  57 .Fa cmd :
  58 .Bl -column ".Dv F_SETLKW" "Vt struct flock *"
  59 .It Sy Command Ta Fa arg Sy Type Ta Sy Output Format
  60 .It
  61 .It Dv F_SETFD Ta Vt int Ta
  62 .Dq FD_CLOEXEC
  63 or the value of
  64 .Fa arg
  65 in the indicated
  66 .Fa base
  67 .Pq one of 8, 10, or 16 .
  68 .It
  69 .It Dv F_SETFL Ta Vt int Ta
  70 File flags as output by
  71 .Xr sysdecode_fcntl_fileflags 3
  72 with any unknown or remaining bits output in hexadecimal.
  73 .It
  74 .It Dv F_GETLK Ta Vt struct flock * Ta
  75 .It Dv F_SETLK Ta Vt struct flock * Ta
  76 .It Dv F_SETLKW Ta Vt struct flock * Ta
  77 The value of
  78 .Fa arg
  79 using the
  80 .Dq %p
  81 conversion specification.
  82 .It
  83 .It Others Ta Vt int Ta
  84 The value of
  85 .Fa arg
  86 in the indicated
  87 .Fa base
  88 .Pq one of 8, 10, or 16 .
  89 .El
  90 .Pp
  91 The
  92 .Fn sysdecode_fcntl_arg_p
  93 function can be used to determine if a
  94 .Xr fcntl 2
  95 command uses the optional third argument to
  96 .Xr fcntl 2 .
  97 The function returns
  98 .Dv true
  99 if
 100 .Fa cmd
 101 accepts a third argument to
 102 .Xr fcntl 2
 103 and
 104 .Dv false
 105 if it does not.
 106 .Sh RETURN VALUES
 107 The
 108 .Nm sysdecode_fcntl_arg_p
 109 function returns
 110 .Dv true
 111 if
 112 .Fa cmd
 113 accepts a third argument to
 114 .Xr fcntl 2
 115 and
 116 .Dv false
 117 if it does not.
 118 .Sh SEE ALSO
 119 .Xr sysdecode 3 ,
 120 .Xr sysdecode_fcntl_cmd 3 ,
 121 .Xr sysdecode_fcntl_fileflags 3