Poll: cleanup #includes
[vlc.git] / src / network / poll.c
1 /*****************************************************************************
2  * poll.c: I/O event multiplexing
3  *****************************************************************************
4  * Copyright © 2007 Rémi Denis-Courmont
5  * $Id$
6  *
7  * Author: Rémi Denis-Courmont
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #ifdef HAVE_POLL
29 #include <stdlib.h>
30
31 struct pollfd;
32
33 int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout)
34 {
35     (void)fds; (void)nfds; (void)timeout;
36     abort ();
37 }
38 #else /* !HAVE_POLL */
39
40 #include <vlc_common.h>
41 #include <string.h>
42 #include <stdlib.h>
43 #include <vlc_network.h>
44
45 int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout)
46 {
47     fd_set rdset, wrset, exset;
48     struct timeval tv = { 0, 0 };
49     int val = -1;
50
51     FD_ZERO (&rdset);
52     FD_ZERO (&wrset);
53     FD_ZERO (&exset);
54     for (unsigned i = 0; i < nfds; i++)
55     {
56         int fd = fds[i].fd;
57         if (val < fd)
58             val = fd;
59
60         /* With POSIX, FD_SET & FD_ISSET are not defined if fd is negative or
61          * bigger or equal than FD_SETSIZE. That is one of the reasons why VLC
62          * uses poll() rather than select(). Most POSIX systems implement
63          * fd_set has a bit field with no sanity checks. This is especially bad
64          * on systems (such as BSD) that have no process open files limit by
65          * default, such that it is quite feasible to get fd >= FD_SETSIZE.
66          * The next instructions will result in a buffer overflow if run on
67          * a POSIX system, and the later FD_ISSET will do undefined memory
68          * access.
69          *
70          * With Winsock, fd_set is a table of integers. This is awfully slow.
71          * However, FD_SET and FD_ISSET silently and safely discard
72          * overflows. If it happens we will loose socket events. Note that
73          * most (if not all) Winsock SOCKET handles are actually bigger than
74          * FD_SETSIZE in terms of absolute value - they are not POSIX file
75          * descriptors. From Vista, there is a much nicer WSAPoll(), but Mingw
76          * is yet to support it.
77          *
78          * With BeOS, the situation is unknown (FIXME: document).
79          */
80         if (fds[i].events & POLLIN)
81             FD_SET (fd, &rdset);
82         if (fds[i].events & POLLOUT)
83             FD_SET (fd, &wrset);
84         if (fds[i].events & POLLPRI)
85             FD_SET (fd, &exset);
86     }
87
88     if (timeout >= 0)
89     {
90         div_t d = div (timeout, 1000);
91         tv.tv_sec = d.quot;
92         tv.tv_usec = d.rem * 1000;
93     }
94
95     val = select (val + 1, &rdset, &wrset, &exset,
96                   (timeout >= 0) ? &tv : NULL);
97     if (val == -1)
98         return -1;
99
100     for (unsigned i = 0; i < nfds; i++)
101     {
102         int fd = fds[i].fd;
103         fds[i].revents = (FD_ISSET (fd, &rdset) ? POLLIN : 0)
104                        | (FD_ISSET (fd, &wrset) ? POLLOUT : 0)
105                        | (FD_ISSET (fd, &exset) ? POLLPRI : 0);
106     }
107     return val;
108 }
109 #endif /* !HAVE_POLL */