lib/libc/sys/poll.2

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