sys/sys/poll.h

   1 /*-
   2  * Copyright (c) 1997 Peter Wemm <peter@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/sys/sys/poll.h,v 1.6.2.1 2000/08/21 12:25:58 sheldonh Exp $
  29  * $DragonFly: src/sys/sys/poll.h,v 1.5 2003/11/22 19:30:57 asmodai Exp $
  30  */
  31
  32 #ifndef _SYS_POLL_H_
  33 #define _SYS_POLL_H_
  34
  35 /*
  36  * This file is intended to be compatible with the traditional poll.h.
  37  */
  38
  39 /*
  40  * This structure is passed as an array to poll(2).
  41  */
  42 struct pollfd {
  43         int     fd;             /* which file descriptor to poll */
  44         short   events;         /* events we are interested in */
  45         short   revents;        /* events found on return */
  46 };
  47
  48 /*
  49  * Requestable events.  If poll(2) finds any of these set, they are
  50  * copied to revents on return.
  51  * XXX Note that FreeBSD doesn't make much distinction between POLLPRI
  52  * and POLLRDBAND since none of the file types have distinct priority
  53  * bands - and only some have an urgent "mode".
  54  * XXX Note POLLIN isn't really supported in true SVSV terms.  Under SYSV
  55  * POLLIN includes all of normal, band and urgent data.  Most poll handlers
  56  * on FreeBSD only treat it as "normal" data.
  57  */
  58 #define POLLIN          0x0001          /* any readable data available */
  59 #define POLLPRI         0x0002          /* OOB/Urgent readable data */
  60 #define POLLOUT         0x0004          /* file descriptor is writeable */
  61 #define POLLRDNORM      0x0040          /* non-OOB/URG data available */
  62 #define POLLWRNORM      POLLOUT         /* no write type differentiation */
  63 #define POLLRDBAND      0x0080          /* OOB/Urgent readable data */
  64 #define POLLWRBAND      0x0100          /* OOB/Urgent data can be written */
  65
  66 /*
  67  * FreeBSD extension.
  68  */
  69 #define POLLINIGNEOF    0x2000          /* POLLIN, except ignore EOF */
  70
  71 /*
  72  * FreeBSD extensions: polling on a regular file might return one
  73  * of these events (currently only supported on UFS).
  74  */
  75 #define POLLEXTEND      0x0200          /* file may have been extended */
  76 #define POLLATTRIB      0x0400          /* file attributes may have changed */
  77 #define POLLNLINK       0x0800          /* (un)link/rename may have happened */
  78 #define POLLWRITE       0x1000          /* file's contents may have changed */
  79
  80 /*
  81  * These events are set if they occur regardless of whether they were
  82  * requested.
  83  */
  84 #define POLLERR         0x0008          /* some poll error occurred */
  85 #define POLLHUP         0x0010          /* file descriptor was "hung up" */
  86 #define POLLNVAL        0x0020          /* requested events "invalid" */
  87
  88 #define POLLSTANDARD    (POLLIN|POLLPRI|POLLOUT|POLLRDNORM|POLLRDBAND|\
  89                          POLLWRBAND|POLLERR|POLLHUP|POLLNVAL)
  90
  91 /*
  92  * Request that poll() wait forever.
  93  * XXX in SYSV, this is defined in stropts.h, which is not included
  94  * by poll.h.
  95  */
  96 #define INFTIM          (-1)
  97
  98 #ifndef _KERNEL
  99
 100 #include <sys/cdefs.h>
 101
 102 __BEGIN_DECLS
 103 /*
 104  * XXX logically, poll() should be declared in <poll.h>, but SVR4 at
 105  * least has it here in <sys/poll.h>.
 106  * XXX poll() has "unsigned long" nfds on SVR4, not unsigned as on the
 107  * other BSDs.
 108  */
 109 int     poll (struct pollfd *_pfd, unsigned int _nfds, int _timeout);
 110 __END_DECLS
 111
 112 #endif /* !_KERNEL */
 113
 114 #endif /* !_SYS_POLL_H_ */