1 /*
2 +----------------------------------------------------------------------+
3 | PHP Version 7 |
4 +----------------------------------------------------------------------+
5 | Copyright (c) 1997-2018 The PHP Group |
6 +----------------------------------------------------------------------+
7 | This source file is subject to version 3.01 of the PHP license, |
8 | that is bundled with this package in the file LICENSE, and is |
9 | available through the world-wide-web at the following url: |
10 | http://www.php.net/license/3_01.txt |
11 | If you did not receive a copy of the PHP license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@php.net so we can mail you a copy immediately. |
14 +----------------------------------------------------------------------+
15 | Author: Stig Venaas <venaas@uninett.no> |
16 +----------------------------------------------------------------------+
17 */
18
19 #ifndef _PHP_NETWORK_H
20 #define _PHP_NETWORK_H
21
22 #include <php.h>
23
24 #ifdef PHP_WIN32
25 # include "win32/inet.h"
26 #else
27 # undef closesocket
28 # define closesocket close
29 # include <netinet/tcp.h>
30 #endif
31
32 #ifndef HAVE_SHUTDOWN
33 #undef shutdown
34 #define shutdown(s,n) /* nothing */
35 #endif
36
37 #ifdef PHP_WIN32
38 # ifdef EWOULDBLOCK
39 # undef EWOULDBLOCK
40 # endif
41 # ifdef EINPROGRESS
42 # undef EINPROGRESS
43 # endif
44 # define EWOULDBLOCK WSAEWOULDBLOCK
45 # define EINPROGRESS WSAEWOULDBLOCK
46 # define fsync _commit
47 # define ftruncate(a, b) chsize(a, b)
48 #endif /* defined(PHP_WIN32) */
49
50 #ifndef EWOULDBLOCK
51 # define EWOULDBLOCK EAGAIN
52 #endif
53
54 #ifdef PHP_WIN32
55 #define php_socket_errno() WSAGetLastError()
56 #else
57 #define php_socket_errno() errno
58 #endif
59
60 /* like strerror, but caller must efree the returned string,
61 * unless buf is not NULL.
62 * Also works sensibly for win32 */
63 BEGIN_EXTERN_C()
64 PHPAPI char *php_socket_strerror(long err, char *buf, size_t bufsize);
65 PHPAPI zend_string *php_socket_error_str(long err);
66 END_EXTERN_C()
67
68 #ifdef HAVE_NETINET_IN_H
69 # include <netinet/in.h>
70 #endif
71
72 #ifdef HAVE_SYS_SOCKET_H
73 #include <sys/socket.h>
74 #endif
75
76 #ifdef HAVE_GETHOSTBYNAME_R
77 #include <netdb.h>
78 #endif
79
80 /* These are here, rather than with the win32 counterparts above,
81 * since <sys/socket.h> defines them. */
82 #ifndef SHUT_RD
83 # define SHUT_RD 0
84 # define SHUT_WR 1
85 # define SHUT_RDWR 2
86 #endif
87
88 #ifdef HAVE_SYS_TIME_H
89 #include <sys/time.h>
90 #endif
91
92 #ifdef HAVE_STDDEF_H
93 #include <stddef.h>
94 #endif
95
96 #ifdef PHP_WIN32
97 typedef SOCKET php_socket_t;
98 #else
99 typedef int php_socket_t;
100 #endif
101
102 #ifdef PHP_WIN32
103 # define SOCK_ERR INVALID_SOCKET
104 # define SOCK_CONN_ERR SOCKET_ERROR
105 # define SOCK_RECV_ERR SOCKET_ERROR
106 #else
107 # define SOCK_ERR -1
108 # define SOCK_CONN_ERR -1
109 # define SOCK_RECV_ERR -1
110 #endif
111
112 #define STREAM_SOCKOP_NONE (1 << 0)
113 #define STREAM_SOCKOP_SO_REUSEPORT (1 << 1)
114 #define STREAM_SOCKOP_SO_BROADCAST (1 << 2)
115 #define STREAM_SOCKOP_IPV6_V6ONLY (1 << 3)
116 #define STREAM_SOCKOP_IPV6_V6ONLY_ENABLED (1 << 4)
117 #define STREAM_SOCKOP_TCP_NODELAY (1 << 5)
118
119
120 /* uncomment this to debug poll(2) emulation on systems that have poll(2) */
121 /* #define PHP_USE_POLL_2_EMULATION 1 */
122
123 #if defined(HAVE_POLL)
124 # if defined(HAVE_POLL_H)
125 # include <poll.h>
126 # elif defined(HAVE_SYS_POLL_H)
127 # include <sys/poll.h>
128 # endif
129 typedef struct pollfd php_pollfd;
130 #else
131 typedef struct _php_pollfd {
132 php_socket_t fd;
133 short events;
134 short revents;
135 } php_pollfd;
136
137 PHPAPI int php_poll2(php_pollfd *ufds, unsigned int nfds, int timeout);
138
139 #ifndef POLLIN
140 # define POLLIN 0x0001 /* There is data to read */
141 # define POLLPRI 0x0002 /* There is urgent data to read */
142 # define POLLOUT 0x0004 /* Writing now will not block */
143 # define POLLERR 0x0008 /* Error condition */
144 # define POLLHUP 0x0010 /* Hung up */
145 # define POLLNVAL 0x0020 /* Invalid request: fd not open */
146 #endif
147
148 # ifndef PHP_USE_POLL_2_EMULATION
149 # define PHP_USE_POLL_2_EMULATION 1
150 # endif
151 #endif
152
153 #define PHP_POLLREADABLE (POLLIN|POLLERR|POLLHUP)
154
155 #ifndef PHP_USE_POLL_2_EMULATION
156 # define php_poll2(ufds, nfds, timeout) poll(ufds, nfds, timeout)
157 #endif
158
159 /* timeval-to-timeout (for poll(2)) */
php_tvtoto(struct timeval * timeouttv)160 static inline int php_tvtoto(struct timeval *timeouttv)
161 {
162 if (timeouttv) {
163 return (timeouttv->tv_sec * 1000) + (timeouttv->tv_usec / 1000);
164 }
165 return -1;
166 }
167
168 /* hybrid select(2)/poll(2) for a single descriptor.
169 * timeouttv follows same rules as select(2), but is reduced to millisecond accuracy.
170 * Returns 0 on timeout, -1 on error, or the event mask (ala poll(2)).
171 */
php_pollfd_for(php_socket_t fd,int events,struct timeval * timeouttv)172 static inline int php_pollfd_for(php_socket_t fd, int events, struct timeval *timeouttv)
173 {
174 php_pollfd p;
175 int n;
176
177 p.fd = fd;
178 p.events = events;
179 p.revents = 0;
180
181 n = php_poll2(&p, 1, php_tvtoto(timeouttv));
182
183 if (n > 0) {
184 return p.revents;
185 }
186
187 return n;
188 }
189
php_pollfd_for_ms(php_socket_t fd,int events,int timeout)190 static inline int php_pollfd_for_ms(php_socket_t fd, int events, int timeout)
191 {
192 php_pollfd p;
193 int n;
194
195 p.fd = fd;
196 p.events = events;
197 p.revents = 0;
198
199 n = php_poll2(&p, 1, timeout);
200
201 if (n > 0) {
202 return p.revents;
203 }
204
205 return n;
206 }
207
208 /* emit warning and suggestion for unsafe select(2) usage */
209 PHPAPI void _php_emit_fd_setsize_warning(int max_fd);
210
211 #ifdef PHP_WIN32
212 /* it is safe to FD_SET too many fd's under win32; the macro will simply ignore
213 * descriptors that go beyond the default FD_SETSIZE */
214 # define PHP_SAFE_FD_SET(fd, set) FD_SET(fd, set)
215 # define PHP_SAFE_FD_CLR(fd, set) FD_CLR(fd, set)
216 # define PHP_SAFE_FD_ISSET(fd, set) FD_ISSET(fd, set)
217 # define PHP_SAFE_MAX_FD(m, n) do { if (n + 1 >= FD_SETSIZE) { _php_emit_fd_setsize_warning(n); }} while(0)
218 #else
219 # define PHP_SAFE_FD_SET(fd, set) do { if (fd < FD_SETSIZE) FD_SET(fd, set); } while(0)
220 # define PHP_SAFE_FD_CLR(fd, set) do { if (fd < FD_SETSIZE) FD_CLR(fd, set); } while(0)
221 # define PHP_SAFE_FD_ISSET(fd, set) ((fd < FD_SETSIZE) && FD_ISSET(fd, set))
222 # define PHP_SAFE_MAX_FD(m, n) do { if (m >= FD_SETSIZE) { _php_emit_fd_setsize_warning(m); m = FD_SETSIZE - 1; }} while(0)
223 #endif
224
225
226 #define PHP_SOCK_CHUNK_SIZE 8192
227
228 #ifdef HAVE_SOCKADDR_STORAGE
229 typedef struct sockaddr_storage php_sockaddr_storage;
230 #else
231 typedef struct {
232 #ifdef HAVE_SOCKADDR_SA_LEN
233 unsigned char ss_len;
234 unsigned char ss_family;
235 #else
236 unsigned short ss_family;
237 #endif
238 char info[126];
239 } php_sockaddr_storage;
240 #endif
241
242 BEGIN_EXTERN_C()
243 PHPAPI int php_network_getaddresses(const char *host, int socktype, struct sockaddr ***sal, zend_string **error_string);
244 PHPAPI void php_network_freeaddresses(struct sockaddr **sal);
245
246 PHPAPI php_socket_t php_network_connect_socket_to_host(const char *host, unsigned short port,
247 int socktype, int asynchronous, struct timeval *timeout, zend_string **error_string,
248 int *error_code, char *bindto, unsigned short bindport, long sockopts
249 );
250
251 PHPAPI int php_network_connect_socket(php_socket_t sockfd,
252 const struct sockaddr *addr,
253 socklen_t addrlen,
254 int asynchronous,
255 struct timeval *timeout,
256 zend_string **error_string,
257 int *error_code);
258
259 #define php_connect_nonb(sock, addr, addrlen, timeout) \
260 php_network_connect_socket((sock), (addr), (addrlen), 0, (timeout), NULL, NULL)
261
262 PHPAPI php_socket_t php_network_bind_socket_to_local_addr(const char *host, unsigned port,
263 int socktype, long sockopts, zend_string **error_string, int *error_code
264 );
265
266 PHPAPI php_socket_t php_network_accept_incoming(php_socket_t srvsock,
267 zend_string **textaddr,
268 struct sockaddr **addr,
269 socklen_t *addrlen,
270 struct timeval *timeout,
271 zend_string **error_string,
272 int *error_code,
273 int tcp_nodelay
274 );
275
276 PHPAPI int php_network_get_sock_name(php_socket_t sock,
277 zend_string **textaddr,
278 struct sockaddr **addr,
279 socklen_t *addrlen
280 );
281
282 PHPAPI int php_network_get_peer_name(php_socket_t sock,
283 zend_string **textaddr,
284 struct sockaddr **addr,
285 socklen_t *addrlen
286 );
287
288 PHPAPI void php_any_addr(int family, php_sockaddr_storage *addr, unsigned short port);
289 PHPAPI int php_sockaddr_size(php_sockaddr_storage *addr);
290 END_EXTERN_C()
291
292 struct _php_netstream_data_t {
293 php_socket_t socket;
294 char is_blocked;
295 struct timeval timeout;
296 char timeout_event;
297 size_t ownsize;
298 };
299 typedef struct _php_netstream_data_t php_netstream_data_t;
300 PHPAPI extern const php_stream_ops php_stream_socket_ops;
301 extern const php_stream_ops php_stream_generic_socket_ops;
302 #define PHP_STREAM_IS_SOCKET (&php_stream_socket_ops)
303
304 BEGIN_EXTERN_C()
305 PHPAPI php_stream *_php_stream_sock_open_from_socket(php_socket_t socket, const char *persistent_id STREAMS_DC );
306 /* open a connection to a host using php_hostconnect and return a stream */
307 PHPAPI php_stream *_php_stream_sock_open_host(const char *host, unsigned short port,
308 int socktype, struct timeval *timeout, const char *persistent_id STREAMS_DC);
309 PHPAPI void php_network_populate_name_from_sockaddr(
310 /* input address */
311 struct sockaddr *sa, socklen_t sl,
312 /* output readable address */
313 zend_string **textaddr,
314 /* output address */
315 struct sockaddr **addr,
316 socklen_t *addrlen
317 );
318
319 PHPAPI int php_network_parse_network_address_with_port(const char *addr,
320 zend_long addrlen, struct sockaddr *sa, socklen_t *sl);
321
322 PHPAPI struct hostent* php_network_gethostbyname(char *name);
323
324 PHPAPI int php_set_sock_blocking(php_socket_t socketd, int block);
325 END_EXTERN_C()
326
327 #define php_stream_sock_open_from_socket(socket, persistent) _php_stream_sock_open_from_socket((socket), (persistent) STREAMS_CC)
328 #define php_stream_sock_open_host(host, port, socktype, timeout, persistent) _php_stream_sock_open_host((host), (port), (socktype), (timeout), (persistent) STREAMS_CC)
329
330 /* {{{ memory debug */
331 #define php_stream_sock_open_from_socket_rel(socket, persistent) _php_stream_sock_open_from_socket((socket), (persistent) STREAMS_REL_CC)
332 #define php_stream_sock_open_host_rel(host, port, socktype, timeout, persistent) _php_stream_sock_open_host((host), (port), (socktype), (timeout), (persistent) STREAMS_REL_CC)
333 #define php_stream_sock_open_unix_rel(path, pathlen, persistent, timeval) _php_stream_sock_open_unix((path), (pathlen), (persistent), (timeval) STREAMS_REL_CC)
334
335 /* }}} */
336
337 #ifndef MAXFQDNLEN
338 #define MAXFQDNLEN 255
339 #endif
340
341 #endif /* _PHP_NETWORK_H */
342
343 /*
344 * Local variables:
345 * tab-width: 4
346 * c-basic-offset: 4
347 * End:
348 * vim600: sw=4 ts=4 fdm=marker
349 * vim<600: sw=4 ts=4
350 */
351