lib/libc/sys/ioctl.2

   1 .\"     $NetBSD: ioctl.2,v 1.23 2010/12/19 22:19:27 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)ioctl.2     8.2 (Berkeley) 12/11/93
  31 .\"
  32 .Dd December 19, 2010
  33 .Dt IOCTL 2
  34 .Os
  35 .Sh NAME
  36 .Nm ioctl
  37 .Nd control device
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/ioctl.h
  42 .Ft int
  43 .Fn ioctl "int d" "unsigned long request" "..."
  44 .Sh DESCRIPTION
  45 The
  46 .Fn ioctl
  47 function manipulates the underlying device parameters of special files.
  48 In particular, many operating
  49 characteristics of character special files (e.g. terminals)
  50 may be controlled with
  51 .Fn ioctl
  52 requests.
  53 The argument
  54 .Fa d
  55 must be an open file descriptor.
  56 .Pp
  57 An
  58 .Fn ioctl
  59 .Fa request
  60 has encoded in it whether the argument is an
  61 .Dq in ,
  62 .Dq out ,
  63 or
  64 .Dq inout
  65 parameter, and the size of the first variadic argument
  66 in bytes.
  67 Note that there can be only one variadic argument but cannot be represented as
  68 a
  69 .Ft "void *"
  70 argument in the prototype because this would require a cast to pass integral
  71 types without warnings.
  72 Macros and defines used in specifying an
  73 .Fn ioctl
  74 .Fa request
  75 are located in the header
  76 .In sys/ioctl.h .
  77 .Sh GENERIC IOCTLS
  78 Some ioctls are applicable to any file descriptor.
  79 These include:
  80 .Bl -tag -width "xxxxxx"
  81 .It Dv FIOCLEX
  82 Set close-on-exec flag.
  83 The file will be closed when
  84 .Xr exec 3
  85 is invoked
  86 (This is equivalent to
  87 .Fn fcntl
  88 .Dv F_SETFD
  89 .Dv FD_CLOEXEC
  90 and the
  91 .Fn fcntl
  92 form should be preferred).
  93 .It Dv FIONCLEX
  94 Clear close-on-exec flag.
  95 The file will remain open across
  96 .Xr exec 3
  97 (This is equivalent to
  98 .Fn fcntl
  99 .Dv F_SETFD
 100 .Dv 0
 101 and the
 102 .Fn fcntl
 103 form should be preferred).
 104 .El
 105 .Pp
 106 Some generic ioctls are not implemented for all types of file
 107 descriptors.
 108 These include:
 109 .Bl -tag -width "xxxxxx"
 110 .It Dv FIONREAD "int"
 111 Get the number of bytes that are immediately available for reading.
 112 .It Dv FIONWRITE "int"
 113 Get the number of bytes in the descriptor's send queue.
 114 These bytes are data which has been written to the descriptor but
 115 which are being held by the kernel for further processing.
 116 The nature of the required processing depends on the underlying device.
 117 For tty devices, these bytes are typically queued for delivery
 118 to the tty hardware.
 119 For TCP sockets, these bytes have not yet been acknowledged by the
 120 other side of the connection.
 121 For files, this operation always returns zero as files do not have
 122 send queues.
 123 .It Dv FIONSPACE "int"
 124 Get the free space in the descriptor's send queue.
 125 This value is the size of the send queue minus the number of bytes
 126 being held in the queue.
 127 Note: while this value represents the number of bytes that may be
 128 added to the queue, other resource limitations may cause a write
 129 not larger than the send queue's space to be blocked.
 130 One such limitation would be a lack of network buffers for a write
 131 to a network connection.
 132 .It Dv FIONBIO "int"
 133 Set non-blocking I/O mode if the argument is non-zero.
 134 In non-blocking mode,
 135 .Xr read 2
 136 or
 137 .Xr write 2
 138 calls return
 139 .Dv \-1
 140 and set
 141 .Va errno
 142 to
 143 .Er EAGAIN
 144 immediately when no data is available
 145 (This is equivalent to
 146 .Fn fcntl
 147 .Dv F_SETFL
 148 .Dv O_NONBLOCK
 149 and the
 150 .Fn fcntl
 151 form should be preferred).
 152 .It Dv FIOASYNC "int"
 153 Set asynchronous I/O mode if the argument is non-zero
 154 (This is equivalent to
 155 .Fn fcntl
 156 .Dv F_SETFL
 157 .Dv O_ASYNC
 158 and the
 159 .Fn fcntl
 160 form should be preferred).
 161 In asynchronous mode, the process or process group specified by
 162 .Dv FIOSETOWN
 163 will start receiving
 164 .Dv SIGIO
 165 signals when data is available.
 166 The
 167 .Dv SIGIO
 168 signal will be delivered when data is available on the file
 169 descriptor.
 170 .It Dv FIOSETOWN, FIOGETOWN "int"
 171 Set/get the process or the process group (if negative) that should receive
 172 .Dv SIGIO
 173 signals when data is available
 174 (This is equivalent to
 175 .Fn fcntl
 176 .Dv F_SETOWN
 177 .Ft pid_t
 178 and the
 179 .Ft fcntl
 180 form should be preferred).
 181 .El
 182 .Sh RETURN VALUES
 183 If an error has occurred, a value of \-1 is returned and
 184 .Va errno
 185 is set to indicate the error.
 186 .Sh ERRORS
 187 .Fn ioctl
 188 will fail if:
 189 .Bl -tag -width Er
 190 .It Bq Er EBADF
 191 .Fa d
 192 is not a valid descriptor.
 193 .It Bq Er EFAULT
 194 .Fa argp
 195 points outside the process's allocated address space.
 196 .It Bq Er EINVAL
 197 .Fa request
 198 or
 199 .Fa argp
 200 is not valid.
 201 .It Bq Er ENOTTY
 202 .Fa d
 203 is not associated with a character
 204 special device; or
 205 the specified request does not apply to the kind
 206 of object that the descriptor
 207 .Fa d
 208 references.
 209 .El
 210 .Sh SEE ALSO
 211 .Xr mt 1 ,
 212 .Xr execve 2 ,
 213 .Xr fcntl 2 ,
 214 .Xr intro 4 ,
 215 .Xr tty 4
 216 .Sh HISTORY
 217 An
 218 .Fn ioctl
 219 function call appeared in
 220 .At v7 .