1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1997 Peter Wemm <peter@freebsd.org> 5 * 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. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 31 #ifndef _SYS_POLL_H_ 32 #define _SYS_POLL_H_ 33 34 #include <sys/cdefs.h> 35 36 /* 37 * This file is intended to be compatible with the traditional poll.h. 38 */ 39 40 typedef unsigned int nfds_t; 41 42 /* 43 * This structure is passed as an array to poll(2). 44 */ 45 struct pollfd { 46 int fd; /* which file descriptor to poll */ 47 short events; /* events we are interested in */ 48 short revents; /* events found on return */ 49 }; 50 51 /* 52 * Requestable events. If poll(2) finds any of these set, they are 53 * copied to revents on return. 54 * XXX Note that FreeBSD doesn't make much distinction between POLLPRI 55 * and POLLRDBAND since none of the file types have distinct priority 56 * bands - and only some have an urgent "mode". 57 * XXX Note POLLIN isn't really supported in true SVSV terms. Under SYSV 58 * POLLIN includes all of normal, band and urgent data. Most poll handlers 59 * on FreeBSD only treat it as "normal" data. 60 */ 61 #define POLLIN 0x0001 /* any readable data available */ 62 #define POLLPRI 0x0002 /* OOB/Urgent readable data */ 63 #define POLLOUT 0x0004 /* file descriptor is writeable */ 64 #define POLLRDNORM 0x0040 /* non-OOB/URG data available */ 65 #define POLLWRNORM POLLOUT /* no write type differentiation */ 66 #define POLLRDBAND 0x0080 /* OOB/Urgent readable data */ 67 #define POLLWRBAND 0x0100 /* OOB/Urgent data can be written */ 68 69 #if __BSD_VISIBLE 70 /* General FreeBSD extension (currently only supported for sockets): */ 71 #define POLLINIGNEOF 0x2000 /* like POLLIN, except ignore EOF */ 72 #define POLLRDHUP 0x4000 /* half shut down */ 73 #endif 74 75 /* 76 * These events are set if they occur regardless of whether they were 77 * requested. 78 */ 79 #define POLLERR 0x0008 /* some poll error occurred */ 80 #define POLLHUP 0x0010 /* file descriptor was "hung up" */ 81 #define POLLNVAL 0x0020 /* requested events "invalid" */ 82 83 #if __BSD_VISIBLE 84 85 #define POLLSTANDARD (POLLIN|POLLPRI|POLLOUT|POLLRDNORM|POLLRDBAND|\ 86 POLLWRBAND|POLLERR|POLLHUP|POLLNVAL) 87 88 /* 89 * Request that poll() wait forever. 90 * XXX in SYSV, this is defined in stropts.h, which is not included 91 * by poll.h. 92 */ 93 #define INFTIM (-1) 94 95 #endif 96 97 #ifndef _KERNEL 98 99 #if __BSD_VISIBLE 100 #include <sys/_types.h> 101 102 #include <sys/_sigset.h> 103 #include <sys/timespec.h> 104 105 #ifndef _SIGSET_T_DECLARED 106 #define _SIGSET_T_DECLARED 107 typedef __sigset_t sigset_t; 108 #endif 109 110 #endif 111 112 __BEGIN_DECLS 113 int poll(struct pollfd _pfd[], nfds_t _nfds, int _timeout); 114 #if __BSD_VISIBLE 115 int ppoll(struct pollfd _pfd[], nfds_t _nfds, 116 const struct timespec *__restrict _timeout, 117 const sigset_t *__restrict _newsigmask); 118 #endif 119 __END_DECLS 120 121 #endif /* !_KERNEL */ 122 123 #endif /* !_SYS_POLL_H_ */ 124