Simplify shutdown() portability
[vlc.git] / 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) && defined(sockaddr_storage)
36 #       undef sockaddr_storage
37 #   endif
38 #   if defined(UNDER_CE)
39 #       define HAVE_STRUCT_ADDRINFO
40 #   else
41 #       define _NO_OLDNAMES 1
42 #       include <io.h>
43 #   endif
44 #   include <winsock2.h>
45 #   include <ws2tcpip.h>
46 #   define ENETUNREACH WSAENETUNREACH
47 #   define net_errno (WSAGetLastError())
48 extern const char *net_strerror( int val );
49 #else
50 #   if HAVE_SYS_SOCKET_H
51 #      include <sys/socket.h>
52 #   endif
53 #   if HAVE_NETINET_IN_H
54 #      include <netinet/in.h>
55 #   endif
56 #   if HAVE_ARPA_INET_H
57 #      include <arpa/inet.h>
58 #   elif defined( SYS_BEOS )
59 #      include <net/netdb.h>
60 #   endif
61 #   include <netdb.h>
62 #   define net_errno errno
63 #   define net_strerror strerror
64 #endif
65
66 # ifdef __cplusplus
67 extern "C" {
68 # endif
69
70 /* Portable networking layer communication */
71 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
72 int net_SetupSocket (int fd);
73
74 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
75 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
76
77 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
78 VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
79
80 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
81 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
82
83 static inline int *__net_ListenTCP (vlc_object_t *obj, const char *host, int port)
84 {
85     return net_Listen (obj, host, port, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
86 }
87
88 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
89 {
90     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
91 }
92
93 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
94 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
95
96 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
97 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
98
99 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
100 {
101     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
102 }
103
104 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
105 {
106     return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
107 }
108
109 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
110 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 ) );
111
112 VLC_EXPORT( void, net_Close, ( int fd ) );
113 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
114
115 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
116 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
117                    socklen_t addrlen);
118
119 /* Functions to read from or write to the networking layer */
120 struct virtual_socket_t
121 {
122     void *p_sys;
123     int (*pf_recv) ( void *, void *, int );
124     int (*pf_send) ( void *, const void *, int );
125 };
126
127 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
128 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, vlc_bool_t b_retry ) );
129
130 #define net_Select(a,b,c,d,e) __net_Select(VLC_OBJECT(a),b,c,d,e)
131 VLC_EXPORT( ssize_t, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, int i_fd, uint8_t *p_data, size_t i_data ) );
132
133 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
134 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 ) );
135
136 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
137 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
138
139 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
140
141 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
142 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
143
144
145 #ifndef HAVE_INET_PTON
146 /* only in core, so no need for C++ extern "C" */
147 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
148 #endif
149
150 #ifndef HAVE_INET_NTOP
151 #ifdef WIN32
152 /* only in core, so no need for C++ extern "C" */
153 VLC_EXPORT (const char *, inet_ntop, (int af, const void *src, 
154                                       char *dst, socklen_t cnt) );
155 #endif
156 #endif
157
158 #ifndef HAVE_POLL
159 enum
160 {
161     POLLIN=1,
162     POLLOUT=2,
163     POLLPRI=4,
164     POLLERR=8,  // unsupported stub
165     POLLHUP=16, // unsupported stub
166     POLLNVAL=32 // unsupported stub
167 };
168
169 struct pollfd
170 {
171     int fd;
172     int events;
173     int revents;
174 };
175
176 int poll (struct pollfd *fds, unsigned nfds, int timeout);
177 #endif
178
179 #ifdef WIN32
180 /* Microsoft: same semantic, same value, different name... go figure */
181 # define SHUT_RD SD_RECEIVE
182 # define SHUT_WR SD_SEND
183 # define SHUT_BOTH
184 # define net_Close( fd ) closesocket ((SOCKET)fd)
185 #else
186 # define net_Close( fd ) close (fd)
187 #endif
188
189 /* Portable network names/addresses resolution layer */
190
191 /* GAI error codes */
192 # ifndef EAI_BADFLAGS
193 #  define EAI_BADFLAGS -1
194 # endif
195 # ifndef EAI_NONAME
196 #  define EAI_NONAME -2
197 # endif
198 # ifndef EAI_AGAIN
199 #  define EAI_AGAIN -3
200 # endif
201 # ifndef EAI_FAIL
202 #  define EAI_FAIL -4
203 # endif
204 # ifndef EAI_NODATA
205 #  define EAI_NODATA -5
206 # endif
207 # ifndef EAI_FAMILY
208 #  define EAI_FAMILY -6
209 # endif
210 # ifndef EAI_SOCKTYPE
211 #  define EAI_SOCKTYPE -7
212 # endif
213 # ifndef EAI_SERVICE
214 #  define EAI_SERVICE -8
215 # endif
216 # ifndef EAI_ADDRFAMILY
217 #  define EAI_ADDRFAMILY -9
218 # endif
219 # ifndef EAI_MEMORY
220 #  define EAI_MEMORY -10
221 # endif
222 # ifndef EAI_SYSTEM
223 #  define EAI_SYSTEM -11
224 # endif
225
226
227 # ifndef NI_MAXHOST
228 #  define NI_MAXHOST 1025
229 #  define NI_MAXSERV 32
230 # endif
231 # define NI_MAXNUMERICHOST 64
232
233 # ifndef NI_NUMERICHOST
234 #  define NI_NUMERICHOST 0x01
235 #  define NI_NUMERICSERV 0x02
236 #  define NI_NOFQDN      0x04
237 #  define NI_NAMEREQD    0x08
238 #  define NI_DGRAM       0x10
239 # endif
240
241 # ifndef HAVE_STRUCT_ADDRINFO
242 struct addrinfo
243 {
244     int ai_flags;
245     int ai_family;
246     int ai_socktype;
247     int ai_protocol;
248     size_t ai_addrlen;
249     struct sockaddr *ai_addr;
250     char *ai_canonname;
251     struct addrinfo *ai_next;
252 };
253 #  define AI_PASSIVE     1
254 #  define AI_CANONNAME   2
255 #  define AI_NUMERICHOST 4
256 # endif /* if !HAVE_STRUCT_ADDRINFO */
257
258 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
259 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
260 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
261 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
262
263
264 static inline vlc_bool_t
265 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
266 {
267     switch (addr->sa_family)
268     {
269 #ifdef IN_MULTICAST
270         case AF_INET:
271         {
272             struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
273             if ((size_t)len < sizeof (*v4))
274                 return VLC_FALSE;
275             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
276         }
277 #endif
278
279 #ifdef IN6_IS_ADDR_MULTICAST
280         case AF_INET6:
281         {
282             struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
283             if ((size_t)len < sizeof (*v6))
284                 return VLC_FALSE;
285             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
286         }
287 #endif
288     }
289
290     return VLC_FALSE;
291 }
292
293
294
295 /**
296  * net_AddressIsMulticast
297  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
298  * or the address is not a valid address.
299  */
300 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
301 {
302     struct addrinfo hints, *res;
303
304     memset (&hints, 0, sizeof (hints));
305     hints.ai_socktype = SOCK_DGRAM; /* UDP */
306     hints.ai_flags = AI_NUMERICHOST;
307
308     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
309                              &hints, &res);
310     if (i)
311     {
312         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
313                  psz_addr, vlc_gai_strerror (i));
314         return VLC_FALSE;
315     }
316
317     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
318     vlc_freeaddrinfo (res);
319     return b;
320 }
321
322 static inline int net_GetSockAddress( int fd, char *address, int *port )
323 {
324     struct sockaddr_storage addr;
325     socklen_t addrlen = sizeof( addr );
326
327     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
328         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
329                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
330         ? VLC_EGENERIC : 0;
331 }
332
333 static inline int net_GetPeerAddress( int fd, char *address, int *port )
334 {
335     struct sockaddr_storage addr;
336     socklen_t addrlen = sizeof( addr );
337
338     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
339         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
340                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
341         ? VLC_EGENERIC : 0;
342 }
343
344 static inline uint16_t net_GetPort (const struct sockaddr *addr)
345 {
346     switch (addr->sa_family)
347     {
348 #ifdef AF_INET6
349         case AF_INET6:
350             return ((const struct sockaddr_in6 *)addr)->sin6_port;
351 #endif
352         case AF_INET:
353             return ((const struct sockaddr_in *)addr)->sin_port;
354     }
355     return 0;
356 }
357
358 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
359 {
360     switch (addr->sa_family)
361     {
362 #ifdef AF_INET6
363         case AF_INET6:
364             ((struct sockaddr_in6 *)addr)->sin6_port = port;
365             break;
366 #endif
367         case AF_INET:
368             ((struct sockaddr_in *)addr)->sin_port = port;
369             break;
370     }
371 }
372 # ifdef __cplusplus
373 }
374 # endif
375
376 #endif