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 November 13, 2014
  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 This flag is always checked, even
 132 if not present in the
 133 .Fa events
 134 bitmask.
 135 .El
 136 .Pp
 137 If
 138 .Fa timeout
 139 is neither zero nor INFTIM (-1), it specifies a maximum interval to
 140 wait for any file descriptor to become ready, in milliseconds.
 141 If
 142 .Fa timeout
 143 is INFTIM (-1), the poll blocks indefinitely.
 144 If
 145 .Fa timeout
 146 is zero, then
 147 .Fn poll
 148 will return without blocking.
 149 .Pp
 150 The
 151 .Fn ppoll
 152 system call, unlike
 153 .Fn poll ,
 154 is used to safely wait until either a set of file descriptors becomes
 155 ready or until a signal is caught.
 156 The
 157 .Fa fds
 158 and
 159 .Fa nfds
 160 arguments are identical to the analogous arguments of
 161 .Fn poll .
 162 The
 163 .Fa timeout
 164 argument in
 165 .Fn ppoll
 166 points to a
 167 .Vt "const struct timespec"
 168 which is defined in
 169 .In sys/timespec.h
 170 (shown below) rather than the
 171 .Vt "int timeout"
 172 used by
 173 .Fn poll .
 174 A null pointer may be passed to indicate that
 175 .Fn ppoll
 176 should wait indefinitely.
 177 Finally,
 178 .Fa newsigmask
 179 specifies a signal mask which is set while waiting for input.
 180 When
 181 .Fn ppoll
 182 returns, the original signal mask is restored.
 183 .Pp
 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. One of its components is negative or too large.
 237 .El
 238 .Sh SEE ALSO
 239 .Xr accept 2 ,
 240 .Xr connect 2 ,
 241 .Xr kqueue 2 ,
 242 .Xr pselect 2 ,
 243 .Xr read 2 ,
 244 .Xr recv 2 ,
 245 .Xr select 2 ,
 246 .Xr send 2 ,
 247 .Xr write 2
 248 .Sh STANDARDS
 249 The
 250 .Fn poll
 251 function conforms to
 252 .St -p1003.1-2001 .
 253 The
 254 .Fn ppoll
 255 is not specified by POSIX.
 256 .Sh HISTORY
 257 The
 258 .Fn poll
 259 function appeared in
 260 .At V .
 261 This manual page and the core of the implementation was taken from
 262 .Nx .
 263 The
 264 .Fn ppoll
 265 function first appeared in
 266 .Fx 11.0
 267 .Sh BUGS
 268 The distinction between some of the fields in the
 269 .Fa events
 270 and
 271 .Fa revents
 272 bitmasks is really not useful without STREAMS.
 273 The fields are
 274 defined for compatibility with existing software.