lib/libc/sys/poll.2

   1 .\"     $NetBSD: poll.2,v 1.3 1996/09/07 21:53:08 mycroft Exp $
   2 .\" $FreeBSD$
   3 .\"
   4 .\" Copyright (c) 1996 Charles M. Hannum.  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. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by Charles M. Hannum.
  17 .\" 4. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd February 27, 2019
  32 .Dt POLL 2
  33 .Os
  34 .Sh NAME
  35 .Nm poll
  36 .Nd synchronous I/O multiplexing
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In poll.h
  41 .Ft int
  42 .Fn poll "struct pollfd fds[]" "nfds_t nfds" "int timeout"
  43 .Ft int
  44 .Fo ppoll
  45 .Fa "struct pollfd fds[]"
  46 .Fa "nfds_t nfds"
  47 .Fa "const struct timespec * restrict timeout"
  48 .Fa "const sigset_t * restrict newsigmask"
  49 .Fc
  50 .Sh DESCRIPTION
  51 The
  52 .Fn poll
  53 system call
  54 examines a set of file descriptors to see if some of them are ready for
  55 I/O.
  56 The
  57 .Fa fds
  58 argument is a pointer to an array of pollfd structures as defined in
  59 .In poll.h
  60 (shown below).
  61 The
  62 .Fa nfds
  63 argument determines the size of the
  64 .Fa fds
  65 array.
  66 .Bd -literal
  67 struct pollfd {
  68     int    fd;       /* file descriptor */
  69     short  events;   /* events to look for */
  70     short  revents;  /* events returned */
  71 };
  72 .Ed
  73 .Pp
  74 The fields of
  75 .Fa struct pollfd
  76 are as follows:
  77 .Bl -tag -width XXXrevents
  78 .It fd
  79 File descriptor to poll.
  80 If fd is equal to -1 then
  81 .Fa revents
  82 is cleared (set to zero), and that pollfd is not checked.
  83 .It events
  84 Events to poll for.
  85 (See below.)
  86 .It revents
  87 Events which may occur.
  88 (See below.)
  89 .El
  90 .Pp
  91 The event bitmasks in
  92 .Fa events
  93 and
  94 .Fa revents
  95 have the following bits:
  96 .Bl -tag -width XXXPOLLWRNORM
  97 .It POLLIN
  98 Data other than high priority data may be read without blocking.
  99 .It POLLRDNORM
 100 Normal data may be read without blocking.
 101 .It POLLRDBAND
 102 Data with a non-zero priority may be read without blocking.
 103 .It POLLPRI
 104 High priority data may be read without blocking.
 105 .It POLLOUT
 106 .It POLLWRNORM
 107 Normal data may be written without blocking.
 108 .It POLLWRBAND
 109 Data with a non-zero priority may be written without blocking.
 110 .It POLLERR
 111 An exceptional condition has occurred on the device or socket.
 112 This
 113 flag is always checked, even if not present in the
 114 .Fa events
 115 bitmask.
 116 .It POLLHUP
 117 The device or socket has been disconnected.
 118 This flag is always
 119 checked, even if not present in the
 120 .Fa events
 121 bitmask.
 122 Note that
 123 POLLHUP
 124 and
 125 POLLOUT
 126 should never be present in the
 127 .Fa revents
 128 bitmask at the same time.
 129 .It POLLNVAL
 130 The file descriptor is not open,
 131 or in capability mode the file descriptor has insufficient rights.
 132 This flag is always checked, even
 133 if not present in the
 134 .Fa events
 135 bitmask.
 136 .El
 137 .Pp
 138 If
 139 .Fa timeout
 140 is neither zero nor INFTIM (-1), it specifies a maximum interval to
 141 wait for any file descriptor to become ready, in milliseconds.
 142 If
 143 .Fa timeout
 144 is INFTIM (-1), the poll blocks indefinitely.
 145 If
 146 .Fa timeout
 147 is zero, then
 148 .Fn poll
 149 will return without blocking.
 150 .Pp
 151 The
 152 .Fn ppoll
 153 system call, unlike
 154 .Fn poll ,
 155 is used to safely wait until either a set of file descriptors becomes
 156 ready or until a signal is caught.
 157 The
 158 .Fa fds
 159 and
 160 .Fa nfds
 161 arguments are identical to the analogous arguments of
 162 .Fn poll .
 163 The
 164 .Fa timeout
 165 argument in
 166 .Fn ppoll
 167 points to a
 168 .Vt "const struct timespec"
 169 which is defined in
 170 .In sys/timespec.h
 171 (shown below) rather than the
 172 .Vt "int timeout"
 173 used by
 174 .Fn poll .
 175 A null pointer may be passed to indicate that
 176 .Fn ppoll
 177 should wait indefinitely.
 178 Finally,
 179 .Fa newsigmask
 180 specifies a signal mask which is set while waiting for input.
 181 When
 182 .Fn ppoll
 183 returns, the original signal mask is restored.
 184 .Bd -literal
 185 struct timespec {
 186         time_t  tv_sec;         /* seconds */
 187         long    tv_nsec;        /* and nanoseconds */
 188 };
 189 .Ed
 190 .Sh RETURN VALUES
 191 The
 192 .Fn poll
 193 system call
 194 returns the number of descriptors that are ready for I/O, or -1 if an
 195 error occurred.
 196 If the time limit expires,
 197 .Fn poll
 198 returns 0.
 199 If
 200 .Fn poll
 201 returns with an error,
 202 including one due to an interrupted system call,
 203 the
 204 .Fa fds
 205 array will be unmodified.
 206 .Sh COMPATIBILITY
 207 This implementation differs from the historical one in that a given
 208 file descriptor may not cause
 209 .Fn poll
 210 to return with an error.
 211 In cases where this would have happened in
 212 the historical implementation (e.g.\& trying to poll a
 213 .Xr revoke 2 Ns ed
 214 descriptor), this implementation instead copies the
 215 .Fa events
 216 bitmask to the
 217 .Fa revents
 218 bitmask.
 219 Attempting to perform I/O on this descriptor will then
 220 return an error.
 221 This behaviour is believed to be more useful.
 222 .Sh ERRORS
 223 An error return from
 224 .Fn poll
 225 indicates:
 226 .Bl -tag -width Er
 227 .It Bq Er EFAULT
 228 The
 229 .Fa fds
 230 argument
 231 points outside the process's allocated address space.
 232 .It Bq Er EINTR
 233 A signal was delivered before the time limit expired and
 234 before any of the selected events occurred.
 235 .It Bq Er EINVAL
 236 The specified time limit is invalid.
 237 One of its components is negative or too large.
 238 .It Bq Er EINVAL
 239 The number of pollfd structures specified by
 240 .Fa nfds
 241 exceeds the system tunable
 242 .Va kern.maxfilesperproc
 243 and
 244 .Dv FD_SETSIZE .
 245 .El
 246 .Sh SEE ALSO
 247 .Xr accept 2 ,
 248 .Xr connect 2 ,
 249 .Xr kqueue 2 ,
 250 .Xr pselect 2 ,
 251 .Xr read 2 ,
 252 .Xr recv 2 ,
 253 .Xr select 2 ,
 254 .Xr send 2 ,
 255 .Xr write 2
 256 .Sh STANDARDS
 257 The
 258 .Fn poll
 259 function conforms to
 260 .St -p1003.1-2001 .
 261 The
 262 .Fn ppoll
 263 is not specified by POSIX.
 264 .Sh HISTORY
 265 The
 266 .Fn poll
 267 function appeared in
 268 .At V .
 269 This manual page and the core of the implementation was taken from
 270 .Nx .
 271 The
 272 .Fn ppoll
 273 function first appeared in
 274 .Fx 11.0
 275 .Sh BUGS
 276 The distinction between some of the fields in the
 277 .Fa events
 278 and
 279 .Fa revents
 280 bitmasks is really not useful without STREAMS.
 281 The fields are
 282 defined for compatibility with existing software.