]> git.sesse.net Git - vlc/blob - include/vlc_network.h
Return VLC_ENOMEM when malloc fails.
[vlc] / include / vlc_network.h
1 /*****************************************************************************
2  * vlc_network.h: interface to communicate with network plug-ins
3  *****************************************************************************
4  * Copyright (C) 2002-2005 the VideoLAN team
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
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 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 General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #if !defined( __LIBVLC__ )
28   #error You are not libvlc or one of its plugins. You cannot include this file
29 #endif
30
31 #ifndef __VLC_NETWORK_H
32 # define __VLC_NETWORK_H
33
34 #if defined( WIN32 )
35 #   if !defined(UNDER_CE)
36 #       define _NO_OLDNAMES 1
37 #       include <io.h>
38 #   endif
39 #   include <winsock2.h>
40 #   include <ws2tcpip.h>
41 #   define ENETUNREACH WSAENETUNREACH
42 #   define net_errno (WSAGetLastError())
43 extern const char *net_strerror( int val );
44
45 struct iovec
46 {
47     void  *iov_base;
48     size_t iov_len;
49 };
50
51 struct msghdr
52 {
53     void         *msg_name;
54     size_t        msg_namelen;
55     struct iovec *msg_iov;
56     size_t        msg_iovlen;
57     void         *msg_control;
58     size_t        msg_controllen;
59     int           msg_flags;
60 };
61
62 VLC_EXPORT( ssize_t, vlc_sendmsg, ( int, struct msghdr *, int ) );
63 VLC_EXPORT( ssize_t, vlc_recvmsg, ( int, struct msghdr *, int ) );
64 #define sendmsg vlc_sendmsg
65 #define recvmsg vlc_recvmsg
66
67 #   ifndef IPV6_V6ONLY
68 #       define IPV6_V6ONLY 27
69 #   endif
70 #else
71 #   include <sys/socket.h>
72 #   ifdef HAVE_NETINET_IN_H
73 #      include <netinet/in.h>
74 #   endif
75 #   ifdef HAVE_ARPA_INET_H
76 #      include <arpa/inet.h>
77 #   elif defined( SYS_BEOS )
78 #      include <net/netdb.h>
79 #   endif
80 #   include <netdb.h>
81 #   define net_errno errno
82 #endif
83
84 # ifdef __cplusplus
85 extern "C" {
86 # endif
87
88 /* Portable networking layer communication */
89 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
90 int net_SetupSocket (int fd);
91
92 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
93 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
94
95 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
96
97 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
98 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
99
100 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
101 {
102     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
103 }
104
105
106 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
107
108 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
109 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
110
111 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
112 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
113
114 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
115 {
116     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
117 }
118
119 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
120 VLC_EXPORT( int, __net_OpenDgram, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int family, int proto ) );
121
122 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
123 {
124     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
125 }
126
127 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
128
129 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
130                    socklen_t addrlen);
131
132 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
133
134 /* Functions to read from or write to the networking layer */
135 struct virtual_socket_t
136 {
137     void *p_sys;
138     int (*pf_recv) ( void *, void *, int );
139     int (*pf_send) ( void *, const void *, int );
140 };
141
142 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
143 VLC_EXPORT( ssize_t, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, size_t i_data, bool b_retry ) );
144
145 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
146 VLC_EXPORT( ssize_t, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, size_t i_data ) );
147
148 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
149 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
150
151 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
152
153 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
154 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
155
156
157 #ifndef HAVE_INET_PTON
158 /* only in core, so no need for C++ extern "C" */
159     VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
160 #endif
161
162 #ifndef HAVE_INET_NTOP
163 #ifdef WIN32
164 /* only in core, so no need for C++ extern "C" */
165     VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
166                                           char *dst, socklen_t cnt) );
167 #endif
168 #endif
169
170 #ifndef HAVE_POLL
171 enum
172 {
173     POLLIN=1,
174     POLLOUT=2,
175     POLLPRI=4,
176     POLLERR=8,  // unsupported stub
177     POLLHUP=16, // unsupported stub
178     POLLNVAL=32 // unsupported stub
179 };
180
181 struct pollfd
182 {
183     int fd;
184     int events;
185     int revents;
186 };
187
188   VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
189 #endif
190
191 #ifdef WIN32
192 /* Microsoft: same semantic, same value, different name... go figure */
193 # define SHUT_RD SD_RECEIVE
194 # define SHUT_WR SD_SEND
195 # define SHUT_RDWR SD_BOTH
196 # define net_Close( fd ) closesocket ((SOCKET)fd)
197 #else
198 #ifdef HAVE_UNISTD_H
199 #include <unistd.h>
200 #endif
201 # define net_Close( fd ) (void)close (fd)
202 #endif
203
204 /* Portable network names/addresses resolution layer */
205
206 /* GAI error codes */
207 # ifndef EAI_BADFLAGS
208 #  define EAI_BADFLAGS -1
209 # endif
210 # ifndef EAI_NONAME
211 #  define EAI_NONAME -2
212 # endif
213 # ifndef EAI_AGAIN
214 #  define EAI_AGAIN -3
215 # endif
216 # ifndef EAI_FAIL
217 #  define EAI_FAIL -4
218 # endif
219 # ifndef EAI_NODATA
220 #  define EAI_NODATA -5
221 # endif
222 # ifndef EAI_FAMILY
223 #  define EAI_FAMILY -6
224 # endif
225 # ifndef EAI_SOCKTYPE
226 #  define EAI_SOCKTYPE -7
227 # endif
228 # ifndef EAI_SERVICE
229 #  define EAI_SERVICE -8
230 # endif
231 # ifndef EAI_ADDRFAMILY
232 #  define EAI_ADDRFAMILY -9
233 # endif
234 # ifndef EAI_MEMORY
235 #  define EAI_MEMORY -10
236 # endif
237 #ifndef EAI_OVERFLOW
238 #  define EAI_OVERFLOW -11
239 #endif
240 # ifndef EAI_SYSTEM
241 #  define EAI_SYSTEM -12
242 # endif
243
244
245 # ifndef NI_MAXHOST
246 #  define NI_MAXHOST 1025
247 #  define NI_MAXSERV 32
248 # endif
249 # define NI_MAXNUMERICHOST 64
250
251 # ifndef NI_NUMERICHOST
252 #  define NI_NUMERICHOST 0x01
253 #  define NI_NUMERICSERV 0x02
254 #  define NI_NOFQDN      0x04
255 #  define NI_NAMEREQD    0x08
256 #  define NI_DGRAM       0x10
257 # endif
258
259 # ifndef HAVE_STRUCT_ADDRINFO
260 struct addrinfo
261 {
262     int ai_flags;
263     int ai_family;
264     int ai_socktype;
265     int ai_protocol;
266     size_t ai_addrlen;
267     struct sockaddr *ai_addr;
268     char *ai_canonname;
269     struct addrinfo *ai_next;
270 };
271 #  define AI_PASSIVE     1
272 #  define AI_CANONNAME   2
273 #  define AI_NUMERICHOST 4
274 # endif /* if !HAVE_STRUCT_ADDRINFO */
275
276 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
277 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
278 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
279 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
280
281
282 static inline bool
283 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
284 {
285     switch (addr->sa_family)
286     {
287 #ifdef IN_MULTICAST
288         case AF_INET:
289         {
290             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
291             if ((size_t)len < sizeof (*v4))
292                 return false;
293             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
294         }
295 #endif
296
297 #ifdef IN6_IS_ADDR_MULTICAST
298         case AF_INET6:
299         {
300             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
301             if ((size_t)len < sizeof (*v6))
302                 return false;
303             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
304         }
305 #endif
306     }
307
308     return false;
309 }
310
311
312 static inline int net_GetSockAddress( int fd, char *address, int *port )
313 {
314     struct sockaddr_storage addr;
315     socklen_t addrlen = sizeof( addr );
316
317     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
318         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
319                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
320         ? VLC_EGENERIC : 0;
321 }
322
323 static inline int net_GetPeerAddress( int fd, char *address, int *port )
324 {
325     struct sockaddr_storage addr;
326     socklen_t addrlen = sizeof( addr );
327
328     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
329         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
330                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
331         ? VLC_EGENERIC : 0;
332 }
333
334 static inline uint16_t net_GetPort (const struct sockaddr *addr)
335 {
336     switch (addr->sa_family)
337     {
338 #ifdef AF_INET6
339         case AF_INET6:
340             return ((const struct sockaddr_in6 *)addr)->sin6_port;
341 #endif
342         case AF_INET:
343             return ((const struct sockaddr_in *)addr)->sin_port;
344     }
345     return 0;
346 }
347
348 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
349 {
350     switch (addr->sa_family)
351     {
352 #ifdef AF_INET6
353         case AF_INET6:
354             ((struct sockaddr_in6 *)addr)->sin6_port = port;
355         break;
356 #endif
357         case AF_INET:
358             ((struct sockaddr_in *)addr)->sin_port = port;
359         break;
360     }
361 }
362 # ifdef __cplusplus
363 }
364 # endif
365
366 #endif