xref: /curl/lib/select.h (revision 374d178f)
1 #ifndef HEADER_CURL_SELECT_H
2 #define HEADER_CURL_SELECT_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 
27 #include "curl_setup.h"
28 
29 #ifdef HAVE_POLL_H
30 #include <poll.h>
31 #elif defined(HAVE_SYS_POLL_H)
32 #include <sys/poll.h>
33 #endif
34 
35 /*
36  * Definition of pollfd struct and constants for platforms lacking them.
37  */
38 
39 #if !defined(HAVE_SYS_POLL_H) && \
40     !defined(HAVE_POLL_H) && \
41     !defined(POLLIN)
42 
43 #define POLLIN      0x01
44 #define POLLPRI     0x02
45 #define POLLOUT     0x04
46 #define POLLERR     0x08
47 #define POLLHUP     0x10
48 #define POLLNVAL    0x20
49 
50 struct pollfd
51 {
52     curl_socket_t fd;
53     short   events;
54     short   revents;
55 };
56 
57 #endif
58 
59 #ifndef POLLRDNORM
60 #define POLLRDNORM POLLIN
61 #endif
62 
63 #ifndef POLLWRNORM
64 #define POLLWRNORM POLLOUT
65 #endif
66 
67 #ifndef POLLRDBAND
68 #define POLLRDBAND POLLPRI
69 #endif
70 
71 /* there are three CSELECT defines that are defined in the public header that
72    are exposed to users, but this *IN2 bit is only ever used internally and
73    therefore defined here */
74 #define CURL_CSELECT_IN2 (CURL_CSELECT_ERR << 1)
75 
76 int Curl_socket_check(curl_socket_t readfd, curl_socket_t readfd2,
77                       curl_socket_t writefd,
78                       timediff_t timeout_ms);
79 #define SOCKET_READABLE(x,z) \
80   Curl_socket_check(x, CURL_SOCKET_BAD, CURL_SOCKET_BAD, z)
81 #define SOCKET_WRITABLE(x,z) \
82   Curl_socket_check(CURL_SOCKET_BAD, CURL_SOCKET_BAD, x, z)
83 
84 int Curl_poll(struct pollfd ufds[], unsigned int nfds, timediff_t timeout_ms);
85 int Curl_wait_ms(timediff_t timeout_ms);
86 
87 /*
88    With Winsock the valid range is [0..INVALID_SOCKET-1] according to
89    https://docs.microsoft.com/en-us/windows/win32/winsock/socket-data-type-2
90 */
91 #ifdef USE_WINSOCK
92 #define VALID_SOCK(s) ((s) < INVALID_SOCKET)
93 #define FDSET_SOCK(x) 1
94 #define VERIFY_SOCK(x) do { \
95   if(!VALID_SOCK(x)) { \
96     SET_SOCKERRNO(WSAEINVAL); \
97     return -1; \
98   } \
99 } while(0)
100 #else
101 #define VALID_SOCK(s) ((s) >= 0)
102 
103 /* If the socket is small enough to get set or read from an fdset */
104 #define FDSET_SOCK(s) ((s) < FD_SETSIZE)
105 
106 #define VERIFY_SOCK(x) do {                     \
107     if(!VALID_SOCK(x) || !FDSET_SOCK(x)) {      \
108       SET_SOCKERRNO(EINVAL);                    \
109       return -1;                                \
110     }                                           \
111   } while(0)
112 #endif
113 
114 struct curl_pollfds {
115   struct pollfd *pfds;
116   unsigned int n;
117   unsigned int count;
118   BIT(allocated_pfds);
119 };
120 
121 void Curl_pollfds_init(struct curl_pollfds *cpfds,
122                        struct pollfd *static_pfds,
123                        unsigned int static_count);
124 
125 void Curl_pollfds_cleanup(struct curl_pollfds *cpfds);
126 
127 CURLcode Curl_pollfds_add_ps(struct curl_pollfds *cpfds,
128                              struct easy_pollset *ps);
129 
130 CURLcode Curl_pollfds_add_sock(struct curl_pollfds *cpfds,
131                                curl_socket_t sock, short events);
132 
133 struct curl_waitfds {
134   struct curl_waitfd *wfds;
135   unsigned int n;
136   unsigned int count;
137 };
138 
139 void Curl_waitfds_init(struct curl_waitfds *cwfds,
140                        struct curl_waitfd *static_wfds,
141                        unsigned int static_count);
142 
143 CURLcode Curl_waitfds_add_ps(struct curl_waitfds *cwfds,
144                              struct easy_pollset *ps);
145 
146 
147 #endif /* HEADER_CURL_SELECT_H */
148