arm_neon: Fix a minor typo in a comment
[vlc.git] / include / vlc_network.h
1 /*****************************************************************************
2  * vlc_network.h: interface to communicate with network plug-ins
3  *****************************************************************************
4  * Copyright (C) 2002-2005 VLC authors and VideoLAN
5  * Copyright © 2006-2007 Rémi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
9  *          Laurent Aimar <fenrir@via.ecp.fr>
10  *          Rémi Denis-Courmont <rem # videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifndef VLC_NETWORK_H
28 # define VLC_NETWORK_H
29
30 /**
31  * \file
32  * This file defines interface to communicate with network plug-ins
33  */
34
35 #if defined( _WIN32 )
36 #   define _NO_OLDNAMES 1
37 #   include <io.h>
38 #   include <winsock2.h>
39 #   include <ws2tcpip.h>
40 #   define net_errno (WSAGetLastError())
41 extern const char *net_strerror( int val );
42
43 struct iovec
44 {
45     void  *iov_base;
46     size_t iov_len;
47 };
48
49 struct msghdr
50 {
51     void         *msg_name;
52     size_t        msg_namelen;
53     struct iovec *msg_iov;
54     size_t        msg_iovlen;
55     void         *msg_control;
56     size_t        msg_controllen;
57     int           msg_flags;
58 };
59
60 #   ifndef IPV6_V6ONLY
61 #       define IPV6_V6ONLY 27
62 #   endif
63 #else
64 #   include <sys/types.h>
65 #   include <unistd.h>
66 #   include <sys/socket.h>
67 #   include <netinet/in.h>
68 #   include <netdb.h>
69 #   define net_errno errno
70 #endif
71
72 #if defined( __SYMBIAN32__ )
73 #   undef AF_INET6
74 #   undef IN6_IS_ADDR_MULTICAST
75 #   undef IPV6_V6ONLY
76 #   undef IPV6_MULTICAST_HOPS
77 #   undef IPV6_MULTICAST_IF
78 #   undef IPV6_TCLASS
79 #   undef IPV6_JOIN_GROUP
80 #endif
81
82 VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
83
84 struct sockaddr;
85 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
86
87 # ifdef __cplusplus
88 extern "C" {
89 # endif
90
91 /* Portable networking layer communication */
92 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
93
94 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
95 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
96
97 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
98
99 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
100                                           SOCK_STREAM, IPPROTO_TCP)
101
102 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
103 {
104     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
105 }
106 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
107
108 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
109
110 VLC_API int net_Accept( vlc_object_t *, int * );
111 #define net_Accept(a, b) \
112         net_Accept(VLC_OBJECT(a), b)
113
114 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
115 #define net_ConnectDgram(a, b, c, d, e ) \
116         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
117
118 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
119 {
120     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
121 }
122
123 VLC_API int net_OpenDgram( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int proto );
124 #define net_OpenDgram( a, b, c, d, e, g ) \
125         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
126
127 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
128 {
129     return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
130 }
131
132 VLC_API void net_ListenClose( int *fd );
133
134 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
135                    socklen_t addrlen);
136
137 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
138
139 /* Functions to read from or write to the networking layer */
140 struct virtual_socket_t
141 {
142     void *p_sys;
143     int (*pf_recv) ( void *, void *, size_t );
144     int (*pf_send) ( void *, const void *, size_t );
145 };
146
147 VLC_API ssize_t net_Read( vlc_object_t *p_this, int fd, const v_socket_t *, void *p_data, size_t i_data, bool b_retry );
148 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
149 VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data );
150 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
151 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
152 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
153
154
155 VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) VLC_FORMAT( 4, 5 );
156 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
157 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
158 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
159
160 #ifdef _WIN32
161 /* Microsoft: same semantic, same value, different name... go figure */
162 # define SHUT_RD SD_RECEIVE
163 # define SHUT_WR SD_SEND
164 # define SHUT_RDWR SD_BOTH
165 # define net_Close( fd ) closesocket ((SOCKET)fd)
166 #else
167 # ifdef __OS2__
168 #  define SHUT_RD    0
169 #  define SHUT_WR    1
170 #  define SHUT_RDWR  2
171 # endif
172 # define net_Close( fd ) (void)close (fd)
173 #endif
174
175 /* Portable network names/addresses resolution layer */
176
177 /* GAI error codes */
178 # ifndef EAI_BADFLAGS
179 #  define EAI_BADFLAGS -1
180 # endif
181 # ifndef EAI_NONAME
182 #  define EAI_NONAME -2
183 # endif
184 # ifndef EAI_AGAIN
185 #  define EAI_AGAIN -3
186 # endif
187 # ifndef EAI_FAIL
188 #  define EAI_FAIL -4
189 # endif
190 # ifndef EAI_NODATA
191 #  define EAI_NODATA -5
192 # endif
193 # ifndef EAI_FAMILY
194 #  define EAI_FAMILY -6
195 # endif
196 # ifndef EAI_SOCKTYPE
197 #  define EAI_SOCKTYPE -7
198 # endif
199 # ifndef EAI_SERVICE
200 #  define EAI_SERVICE -8
201 # endif
202 # ifndef EAI_ADDRFAMILY
203 #  define EAI_ADDRFAMILY -9
204 # endif
205 # ifndef EAI_MEMORY
206 #  define EAI_MEMORY -10
207 # endif
208 #ifndef EAI_OVERFLOW
209 #  define EAI_OVERFLOW -11
210 #endif
211 # ifndef EAI_SYSTEM
212 #  define EAI_SYSTEM -12
213 # endif
214
215
216 # ifndef NI_MAXHOST
217 #  define NI_MAXHOST 1025
218 #  define NI_MAXSERV 32
219 # endif
220 # define NI_MAXNUMERICHOST 64
221
222 #ifndef AI_NUMERICSERV
223 # define AI_NUMERICSERV 0
224 #endif
225 #ifndef AI_IDN
226 # define AI_IDN 0 /* GNU/libc extension */
227 #endif
228
229 #ifdef _WIN32
230 # undef gai_strerror
231 # define gai_strerror gai_strerrorA
232 #endif
233
234 #ifdef __OS2__
235 # ifndef NI_NUMERICHOST
236 #  define NI_NUMERICHOST 0x01
237 #  define NI_NUMERICSERV 0x02
238 #  define NI_NOFQDN      0x04
239 #  define NI_NAMEREQD    0x08
240 #  define NI_DGRAM       0x10
241 # endif
242
243 struct addrinfo
244 {
245     int ai_flags;
246     int ai_family;
247     int ai_socktype;
248     int ai_protocol;
249     size_t ai_addrlen;
250     struct sockaddr *ai_addr;
251     char *ai_canonname;
252     struct addrinfo *ai_next;
253 };
254
255 # define AI_PASSIVE     1
256 # define AI_CANONNAME   2
257 # define AI_NUMERICHOST 4
258
259 VLC_API const char *gai_strerror( int errnum );
260
261 VLC_API int  getaddrinfo ( const char *, const char *,
262                            const struct addrinfo *, struct addrinfo ** );
263 VLC_API void freeaddrinfo( struct addrinfo * );
264 VLC_API int  getnameinfo ( const struct sockaddr *, socklen_t,
265                            char *, int, char *, int, int );
266 #endif
267
268 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
269 VLC_API int vlc_getaddrinfo (const char *, unsigned,
270                              const struct addrinfo *, struct addrinfo **);
271
272
273 #ifdef __OS2__
274 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
275 struct in6_addr
276 {
277     uint8_t s6_addr[16];
278 };
279
280 struct sockaddr_in6
281 {
282     uint8_t         sin6_len;
283     uint8_t         sin6_family;
284     uint16_t        sin6_port;
285     uint32_t        sin6_flowinfo;
286     struct in6_addr sin6_addr;
287     uint32_t        sin6_scope_id;
288 };
289
290 # define IN6_IS_ADDR_MULTICAST(a)   (((__const uint8_t *) (a))[0] == 0xff)
291
292 static const struct in6_addr in6addr_any =
293     { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
294 #endif
295
296 static inline bool
297 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
298 {
299     switch (addr->sa_family)
300     {
301 #ifdef IN_MULTICAST
302         case AF_INET:
303         {
304             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
305             if ((size_t)len < sizeof (*v4))
306                 return false;
307             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
308         }
309 #endif
310
311 #ifdef IN6_IS_ADDR_MULTICAST
312         case AF_INET6:
313         {
314             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
315             if ((size_t)len < sizeof (*v6))
316                 return false;
317             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
318         }
319 #endif
320     }
321
322     return false;
323 }
324
325
326 static inline int net_GetSockAddress( int fd, char *address, int *port )
327 {
328     struct sockaddr_storage addr;
329     socklen_t addrlen = sizeof( addr );
330
331     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
332         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
333                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
334         ? VLC_EGENERIC : 0;
335 }
336
337 static inline int net_GetPeerAddress( int fd, char *address, int *port )
338 {
339     struct sockaddr_storage addr;
340     socklen_t addrlen = sizeof( addr );
341
342     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
343         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
344                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
345         ? VLC_EGENERIC : 0;
346 }
347
348 static inline uint16_t net_GetPort (const struct sockaddr *addr)
349 {
350     switch (addr->sa_family)
351     {
352 #ifdef AF_INET6
353         case AF_INET6:
354             return ((const struct sockaddr_in6 *)addr)->sin6_port;
355 #endif
356         case AF_INET:
357             return ((const struct sockaddr_in *)addr)->sin_port;
358     }
359     return 0;
360 }
361
362 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
363 {
364     switch (addr->sa_family)
365     {
366 #ifdef AF_INET6
367         case AF_INET6:
368             ((struct sockaddr_in6 *)addr)->sin6_port = port;
369         break;
370 #endif
371         case AF_INET:
372             ((struct sockaddr_in *)addr)->sin_port = port;
373         break;
374     }
375 }
376
377 VLC_API char *vlc_getProxyUrl(const char *);
378
379 # ifdef __cplusplus
380 }
381 # endif
382
383 #endif