- Use the new vlc_getaddrinfo API
[vlc.git] / modules / misc / network / ipv4.c
1 /*****************************************************************************
2  * ipv4.c: IPv4 network abstraction layer
3  *****************************************************************************
4  * Copyright (C) 2001-2005 VideoLAN
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *          Mathias Kretschmer <mathias@research.att.com>
9  *          Alexis de Lattre <alexis@via.ecp.fr>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #include <stdlib.h>
30 #include <string.h>
31
32 #include <vlc/vlc.h>
33 #include <errno.h>
34
35 #ifdef HAVE_SYS_TYPES_H
36 #   include <sys/types.h>
37 #endif
38 #ifdef HAVE_SYS_STAT_H
39 #   include <sys/stat.h>
40 #endif
41 #ifdef HAVE_FCNTL_H
42 #   include <fcntl.h>
43 #endif
44
45 #ifdef HAVE_UNISTD_H
46 #   include <unistd.h>
47 #endif
48
49 #if defined(WIN32) || defined(UNDER_CE)
50 #   if defined(UNDER_CE) && defined(sockaddr_storage)
51 #       undef sockaddr_storage
52 #   endif
53 #   include <winsock2.h>
54 #   include <ws2tcpip.h>
55 #   define close closesocket
56 #   if defined(UNDER_CE)
57 #       undef IP_MULTICAST_TTL
58 #       define IP_MULTICAST_TTL 3
59 #       undef IP_ADD_MEMBERSHIP
60 #       define IP_ADD_MEMBERSHIP 5
61 #   endif
62 #else
63 #   include <netdb.h>                                         /* hostent ... */
64 #   include <sys/socket.h>
65 #   include <netinet/in.h>
66 #   ifdef HAVE_ARPA_INET_H
67 #       include <arpa/inet.h>                    /* inet_ntoa(), inet_aton() */
68 #   endif
69 #endif
70
71 #include "network.h"
72
73 #ifndef INADDR_ANY
74 #   define INADDR_ANY  0x00000000
75 #endif
76 #ifndef INADDR_NONE
77 #   define INADDR_NONE 0xFFFFFFFF
78 #endif
79 #ifndef IN_MULTICAST
80 #   define IN_MULTICAST(a) IN_CLASSD(a)
81 #endif
82 #ifndef PF_INET
83 #    define PF_INET AF_INET                                          /* BeOS */
84 #endif
85
86
87 /*****************************************************************************
88  * Local prototypes
89  *****************************************************************************/
90 static int NetOpen( vlc_object_t * );
91
92 /*****************************************************************************
93  * Module descriptor
94  *****************************************************************************/
95 #define MIFACE_TEXT N_("Multicast output interface")
96 #define MIFACE_LONGTEXT N_( \
97     "Indicate here the multicast output interface. " \
98     "This overrides the routing table.")
99
100 vlc_module_begin();
101     set_description( _("IPv4 network abstraction layer") );
102     set_capability( "network", 50 );
103     set_callbacks( NetOpen, NULL );
104     add_string( "miface-addr", NULL, NULL, MIFACE_TEXT, MIFACE_LONGTEXT, VLC_TRUE );
105 vlc_module_end();
106
107 /*****************************************************************************
108  * BuildAddr: utility function to build a struct sockaddr_in
109  *****************************************************************************/
110 static int BuildAddr( struct sockaddr_in * p_socket,
111                       const char * psz_address, int i_port )
112 {
113     /* Reset struct */
114     memset( p_socket, 0, sizeof( struct sockaddr_in ) );
115     p_socket->sin_family = AF_INET;                                /* family */
116     p_socket->sin_port = htons( (uint16_t)i_port );
117     if( !*psz_address )
118     {
119         p_socket->sin_addr.s_addr = INADDR_ANY;
120     }
121     else
122     {
123         struct hostent    * p_hostent;
124
125         /* Try to convert address directly from in_addr - this will work if
126          * psz_address is dotted decimal. */
127 #ifdef HAVE_ARPA_INET_H
128         if( !inet_aton( psz_address, &p_socket->sin_addr ) )
129 #else
130         p_socket->sin_addr.s_addr = inet_addr( psz_address );
131         if( p_socket->sin_addr.s_addr == INADDR_NONE )
132 #endif
133         {
134             /* We have a fqdn, try to find its address */
135             if ( (p_hostent = gethostbyname( psz_address )) == NULL )
136             {
137                 return( -1 );
138             }
139
140             /* Copy the first address of the host in the socket address */
141             memcpy( &p_socket->sin_addr, p_hostent->h_addr_list[0],
142                      p_hostent->h_length );
143         }
144     }
145     return( 0 );
146 }
147
148 /*****************************************************************************
149  * OpenUDP: open a UDP socket
150  *****************************************************************************
151  * psz_bind_addr, i_bind_port : address and port used for the bind()
152  *   system call. If psz_bind_addr == "", the socket is bound to
153  *   INADDR_ANY and broadcast reception is enabled. If i_bind_port == 0,
154  *   1234 is used. If psz_bind_addr is a multicast (class D) address,
155  *   join the multicast group.
156  * psz_server_addr, i_server_port : address and port used for the connect()
157  *   system call. It can avoid receiving packets from unauthorized IPs.
158  *   Its use leads to great confusion and is currently discouraged.
159  * This function returns -1 in case of error.
160  *****************************************************************************/
161 static int OpenUDP( vlc_object_t * p_this, network_socket_t * p_socket )
162 {
163     char * psz_bind_addr = p_socket->psz_bind_addr;
164     int i_bind_port = p_socket->i_bind_port;
165     char * psz_server_addr = p_socket->psz_server_addr;
166     int i_server_port = p_socket->i_server_port;
167
168     int i_handle, i_opt;
169     socklen_t i_opt_size;
170     struct sockaddr_in sock;
171     vlc_value_t val;
172
173     /* If IP_ADD_SOURCE_MEMBERSHIP is not defined in the headers
174        (because it's not in glibc for example), we have to define the
175        headers required for IGMPv3 here */
176 #ifndef IP_ADD_SOURCE_MEMBERSHIP
177     #define IP_ADD_SOURCE_MEMBERSHIP  39
178     struct ip_mreq_source {
179         struct in_addr  imr_multiaddr;
180         struct in_addr  imr_interface;
181         struct in_addr  imr_sourceaddr;
182      };
183 #endif
184
185     /* Open a SOCK_DGRAM (UDP) socket, in the AF_INET domain, automatic (0)
186      * protocol */
187     if( (i_handle = socket( AF_INET, SOCK_DGRAM, 0 )) == -1 )
188     {
189 #if defined(WIN32) || defined(UNDER_CE)
190         msg_Warn( p_this, "cannot create socket (%i)", WSAGetLastError() );
191 #else
192         msg_Warn( p_this, "cannot create socket (%s)", strerror(errno) );
193 #endif
194         return( -1 );
195     }
196
197     /* We may want to reuse an already used socket */
198     i_opt = 1;
199     if( setsockopt( i_handle, SOL_SOCKET, SO_REUSEADDR,
200                     (void *) &i_opt, sizeof( i_opt ) ) == -1 )
201     {
202 #if defined(WIN32) || defined(UNDER_CE)
203         msg_Warn( p_this, "cannot configure socket (SO_REUSEADDR: %i)",
204                   WSAGetLastError() );
205 #else
206         msg_Warn( p_this, "cannot configure socket (SO_REUSEADDR: %s)",
207                           strerror(errno));
208 #endif
209         close( i_handle );
210         return( -1 );
211     }
212
213 #ifdef SO_REUSEPORT
214     i_opt = 1;
215     if( setsockopt( i_handle, SOL_SOCKET, SO_REUSEPORT,
216                     (void *) &i_opt, sizeof( i_opt ) ) == -1 )
217     {
218         msg_Warn( p_this, "cannot configure socket (SO_REUSEPORT)" );
219     }
220 #endif
221
222     /* Increase the receive buffer size to 1/2MB (8Mb/s during 1/2s) to avoid
223      * packet loss caused by scheduling problems */
224     i_opt = 0x80000;
225 #if !defined( SYS_BEOS )
226     if( setsockopt( i_handle, SOL_SOCKET, SO_RCVBUF, (void *) &i_opt, sizeof( i_opt ) ) == -1 )
227     {
228 #if defined(WIN32) || defined(UNDER_CE)
229         msg_Dbg( p_this, "cannot configure socket (SO_RCVBUF: %i)",
230                  WSAGetLastError() );
231 #else
232         msg_Dbg( p_this, "cannot configure socket (SO_RCVBUF: %s)",
233                           strerror(errno));
234 #endif
235     }
236 #endif
237
238 #if !defined( SYS_BEOS )
239     /* Check if we really got what we have asked for, because Linux, etc.
240      * will silently limit the max buffer size to net.core.rmem_max which
241      * is typically only 65535 bytes */
242     i_opt = 0;
243     i_opt_size = sizeof( i_opt );
244     if( getsockopt( i_handle, SOL_SOCKET, SO_RCVBUF, (void*) &i_opt, &i_opt_size ) == -1 )
245     {
246 #if defined(WIN32) || defined(UNDER_CE)
247         msg_Warn( p_this, "cannot query socket (SO_RCVBUF: %i)",
248                   WSAGetLastError() );
249 #else
250         msg_Warn( p_this, "cannot query socket (SO_RCVBUF: %s)",
251                           strerror(errno) );
252 #endif
253     }
254     else if( i_opt < 0x80000 )
255     {
256         msg_Dbg( p_this, "socket buffer size is 0x%x instead of 0x%x",
257                          i_opt, 0x80000 );
258     }
259 #endif
260
261
262     /* Build the local socket */
263
264 #if defined( WIN32 ) || defined( UNDER_CE )
265     /* Under Win32 and for multicasting, we bind to INADDR_ANY,
266      * so let's call BuildAddr with "" instead of psz_bind_addr */
267     if( BuildAddr( &sock, IN_MULTICAST( ntohl( inet_addr(psz_bind_addr) ) ) ?
268                    "" : psz_bind_addr, i_bind_port ) == -1 )
269 #else
270     if( BuildAddr( &sock, psz_bind_addr, i_bind_port ) == -1 )
271 #endif
272     {
273         msg_Dbg( p_this, "could not build local address" );
274         close( i_handle );
275         return( -1 );
276     }
277
278     /* Bind it */
279     if( bind( i_handle, (struct sockaddr *)&sock, sizeof( sock ) ) < 0 )
280     {
281 #if defined(WIN32) || defined(UNDER_CE)
282         msg_Warn( p_this, "cannot bind socket (%i)", WSAGetLastError() );
283 #else
284         msg_Warn( p_this, "cannot bind socket (%s)", strerror(errno) );
285 #endif
286         close( i_handle );
287         return( -1 );
288     }
289
290 #if defined( WIN32 ) || defined( UNDER_CE )
291     /* Restore the sock struct so we can spare a few #ifdef WIN32 later on */
292     if( IN_MULTICAST( ntohl( inet_addr(psz_bind_addr) ) ) )
293     {
294         if ( BuildAddr( &sock, psz_bind_addr, i_bind_port ) == -1 )
295         {
296             msg_Dbg( p_this, "could not build local address" );
297             close( i_handle );
298             return( -1 );
299         }
300     }
301 #endif
302
303 #if !defined( SYS_BEOS )
304     /* Allow broadcast reception if we bound on INADDR_ANY */
305     if( !*psz_bind_addr )
306     {
307         i_opt = 1;
308         if( setsockopt( i_handle, SOL_SOCKET, SO_BROADCAST, (void*) &i_opt, sizeof( i_opt ) ) == -1 )
309         {
310 #if defined(WIN32) || defined(UNDER_CE)
311             msg_Warn( p_this, "cannot configure socket (SO_BROADCAST: %i)",
312                       WSAGetLastError() );
313 #else
314             msg_Warn( p_this, "cannot configure socket (SO_BROADCAST: %s)",
315                        strerror(errno) );
316 #endif
317         }
318     }
319 #endif
320
321 #if !defined( SYS_BEOS )
322     /* Join the multicast group if the socket is a multicast address */
323     if( IN_MULTICAST( ntohl(sock.sin_addr.s_addr) ) )
324     {
325         /* Determine interface to be used for multicast */
326         char * psz_if_addr = config_GetPsz( p_this, "iface-addr" );
327
328         /* If we have a source address, we use IP_ADD_SOURCE_MEMBERSHIP
329            so that IGMPv3 aware OSes running on IGMPv3 aware networks
330            will do an IGMPv3 query on the network */
331         if( *psz_server_addr )
332         {
333             struct ip_mreq_source imr;
334
335             imr.imr_multiaddr.s_addr = sock.sin_addr.s_addr;
336             imr.imr_sourceaddr.s_addr = inet_addr(psz_server_addr);
337
338             if( psz_if_addr != NULL && *psz_if_addr
339                 && inet_addr(psz_if_addr) != INADDR_NONE )
340             {
341                 imr.imr_interface.s_addr = inet_addr(psz_if_addr);
342             }
343             else
344             {
345                 imr.imr_interface.s_addr = INADDR_ANY;
346             }
347             if( psz_if_addr != NULL ) free( psz_if_addr );
348
349             msg_Dbg( p_this, "IP_ADD_SOURCE_MEMBERSHIP multicast request" );
350             /* Join Multicast group with source filter */
351             if( setsockopt( i_handle, IPPROTO_IP, IP_ADD_SOURCE_MEMBERSHIP,
352                          (char*)&imr,
353                          sizeof(struct ip_mreq_source) ) == -1 )
354             {
355 #if defined(WIN32) || defined(UNDER_CE)
356                 msg_Err( p_this, "failed to join IP multicast group (%i)",
357                          WSAGetLastError() );
358 #else
359                 msg_Err( p_this, "failed to join IP multicast group (%s)",
360                                   strerror(errno) );
361 #endif
362                 msg_Err( p_this, "are you sure your OS supports IGMPv3?" );
363                 close( i_handle );
364                 return( -1 );
365             }
366          }
367          /* If there is no source address, we use IP_ADD_MEMBERSHIP */
368          else
369          {
370              struct ip_mreq imr;
371
372              imr.imr_multiaddr.s_addr = sock.sin_addr.s_addr;
373              if( psz_if_addr != NULL && *psz_if_addr
374                 && inet_addr(psz_if_addr) != INADDR_NONE )
375             {
376                 imr.imr_interface.s_addr = inet_addr(psz_if_addr);
377             }
378             else
379             {
380                 imr.imr_interface.s_addr = INADDR_ANY;
381             }
382             if( psz_if_addr != NULL ) free( psz_if_addr );
383
384             msg_Dbg( p_this, "IP_ADD_MEMBERSHIP multicast request" );
385             /* Join Multicast group without source filter */
386             if( setsockopt( i_handle, IPPROTO_IP, IP_ADD_MEMBERSHIP,
387                             (char*)&imr, sizeof(struct ip_mreq) ) == -1 )
388             {
389 #if defined(WIN32) || defined(UNDER_CE)
390                 msg_Err( p_this, "failed to join IP multicast group (%i)",
391                          WSAGetLastError() );
392 #else
393                 msg_Err( p_this, "failed to join IP multicast group (%s)",
394                                   strerror(errno) );
395 #endif
396                 close( i_handle );
397                 return( -1 );
398             }
399          }
400     }
401 #endif
402
403     if( *psz_server_addr )
404     {
405         /* Build socket for remote connection */
406         if ( BuildAddr( &sock, psz_server_addr, i_server_port ) == -1 )
407         {
408             msg_Warn( p_this, "cannot build remote address" );
409             close( i_handle );
410             return( -1 );
411         }
412
413         /* Connect the socket */
414         if( connect( i_handle, (struct sockaddr *) &sock,
415                      sizeof( sock ) ) == (-1) )
416         {
417 #if defined(WIN32) || defined(UNDER_CE)
418             msg_Warn( p_this, "cannot connect socket (%i)", WSAGetLastError());
419 #else
420             msg_Warn( p_this, "cannot connect socket (%s)", strerror(errno) );
421 #endif
422             close( i_handle );
423             return( -1 );
424         }
425
426 #if !defined( SYS_BEOS )
427         if( IN_MULTICAST( ntohl(inet_addr(psz_server_addr) ) ) )
428         {
429             /* set the time-to-live */
430             int i_ttl = p_socket->i_ttl;
431             unsigned char ttl;
432             
433             /* set the multicast interface */
434             char * psz_mif_addr = config_GetPsz( p_this, "miface-addr" );
435             if( psz_mif_addr )
436             {
437                 struct in_addr intf;
438                 intf.s_addr = inet_addr(psz_mif_addr);
439                 free( psz_mif_addr  );
440
441                 if( setsockopt( i_handle, IPPROTO_IP, IP_MULTICAST_IF,
442                                 &intf, sizeof( intf ) ) < 0 )
443                 {
444                     msg_Dbg( p_this, "failed to set multicast interface (%s).", strerror(errno) );
445                     close( i_handle );
446                     return ( -1 );
447                 }
448             }
449
450             if( i_ttl < 1 )
451             {
452                 if( var_Get( p_this, "ttl", &val ) != VLC_SUCCESS )
453                 {
454                     var_Create( p_this, "ttl",
455                                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
456                     var_Get( p_this, "ttl", &val );
457                 }
458                 i_ttl = val.i_int;
459             }
460             if( i_ttl < 1 ) i_ttl = 1;
461             ttl = (unsigned char) i_ttl;
462
463             /* There is some confusion in the world whether IP_MULTICAST_TTL 
464              * takes a byte or an int as an argument.
465              * BSD seems to indicate byte so we are going with that and use
466              * int as a fallback to be safe */
467             if( setsockopt( i_handle, IPPROTO_IP, IP_MULTICAST_TTL,
468                             &ttl, sizeof( ttl ) ) < 0 )
469             {
470                 msg_Dbg( p_this, "failed to set ttl (%s). Let's try it "
471                          "the integer way.", strerror(errno) );
472                 if( setsockopt( i_handle, IPPROTO_IP, IP_MULTICAST_TTL,
473                                 &i_ttl, sizeof( i_ttl ) ) <0 )
474                 {
475                     msg_Err( p_this, "failed to set ttl (%s)",
476                              strerror(errno) );
477                     close( i_handle );
478                     return( -1 );
479                 }
480             }
481         }
482 #endif
483     }
484
485     p_socket->i_handle = i_handle;
486
487     if( var_Get( p_this, "mtu", &val ) != VLC_SUCCESS )
488     {
489         var_Create( p_this, "mtu", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
490         var_Get( p_this, "mtu", &val );
491     }
492     p_socket->i_mtu = val.i_int;
493     return( 0 );
494 }
495
496 /*****************************************************************************
497  * NetOpen: wrapper around OpenUDP, ListenTCP and OpenTCP
498  *****************************************************************************/
499 static int NetOpen( vlc_object_t * p_this )
500 {
501     network_socket_t * p_socket = p_this->p_private;
502
503     return OpenUDP( p_this, p_socket );
504 }