f6f9050effd9df1f7c1ffd4b4f2d0b293295d2de
[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 #include <vlc_common.h>
29 #include <vlc_network.h>
30
31 #ifdef HAVE_POLL
32 struct pollfd;
33
34 int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout)
35 {
36     (void)fds; (void)nfds; (void)timeout;
37     abort ();
38 }
39 #else /* !HAVE_POLL */
40 #include <string.h>
41 #include <stdlib.h>
42 #include <vlc_network.h>
43
44 int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout)
45 {
46     fd_set rdset, wrset, exset;
47     struct timeval tv = { 0, 0 };
48     int val = -1;
49
50     FD_ZERO (&rdset);
51     FD_ZERO (&wrset);
52     FD_ZERO (&exset);
53     for (unsigned i = 0; i < nfds; i++)
54     {
55         int fd = fds[i].fd;
56         if (val < fd)
57             val = fd;
58
59         /* With POSIX, FD_SET & FD_ISSET are not defined if fd is negative or
60          * bigger or equal than FD_SETSIZE. That is one of the reasons why VLC
61          * uses poll() rather than select(). Most POSIX systems implement
62          * fd_set has a bit field with no sanity checks. This is especially bad
63          * on systems (such as BSD) that have no process open files limit by
64          * default, such that it is quite feasible to get fd >= FD_SETSIZE.
65          * The next instructions will result in a buffer overflow if run on
66          * a POSIX system, and the later FD_ISSET will do undefined memory
67          * access.
68          *
69          * With Winsock, fd_set is a table of integers. This is awfully slow.
70          * However, FD_SET and FD_ISSET silently and safely discard
71          * overflows. If it happens we will loose socket events. Note that
72          * most (if not all) Winsock SOCKET handles are actually bigger than
73          * FD_SETSIZE in terms of absolute value - they are not POSIX file
74          * descriptors. From Vista, there is a much nicer WSAPoll(), but Mingw
75          * is yet to support it.
76          *
77          * With BeOS, the situation is unknown (FIXME: document).
78          */
79         if (fds[i].events & POLLIN)
80             FD_SET (fd, &rdset);
81         if (fds[i].events & POLLOUT)
82             FD_SET (fd, &wrset);
83         if (fds[i].events & POLLPRI)
84             FD_SET (fd, &exset);
85     }
86
87     if (timeout >= 0)
88     {
89         div_t d = div (timeout, 1000);
90         tv.tv_sec = d.quot;
91         tv.tv_usec = d.rem * 1000;
92     }
93
94     val = select (val + 1, &rdset, &wrset, &exset,
95                   (timeout >= 0) ? &tv : NULL);
96     if (val == -1)
97         return -1;
98
99     for (unsigned i = 0; i < nfds; i++)
100     {
101         int fd = fds[i].fd;
102         fds[i].revents = (FD_ISSET (fd, &rdset) ? POLLIN : 0)
103                        | (FD_ISSET (fd, &wrset) ? POLLOUT : 0)
104                        | (FD_ISSET (fd, &exset) ? POLLPRI : 0);
105     }
106     return val;
107 }
108 #endif /* !HAVE_POLL */