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