]> git.sesse.net Git - vlc/blob - src/network/udp.c
- Port net_OpenUDP to the agnostic network core
[vlc] / src / network / udp.c
1 /*****************************************************************************
2  * udp.c:
3  *****************************************************************************
4  * Copyright (C) 2004-2006 the VideoLAN team
5  * Copyright © 2006 Rémi Denis-Courmont
6  *
7  * $Id$
8  *
9  * Authors: Laurent Aimar <fenrir@videolan.org>
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 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <stdlib.h>
31 #include <vlc/vlc.h>
32
33 #include <errno.h>
34 #include <assert.h>
35
36 #ifdef HAVE_SYS_TIME_H
37 #    include <sys/time.h>
38 #endif
39
40 #include "network.h"
41
42 #ifdef WIN32
43 #   if defined(UNDER_CE)
44 #       undef IP_MULTICAST_TTL
45 #       define IP_MULTICAST_TTL 3
46 #       undef IP_ADD_MEMBERSHIP
47 #       define IP_ADD_MEMBERSHIP 5
48 #   endif
49 #   define EAFNOSUPPORT WSAEAFNOSUPPORT
50 #   define if_nametoindex( str ) atoi( str )
51 #else
52 #   include <unistd.h>
53 #   ifdef HAVE_NET_IF_H
54 #       include <net/if.h>
55 #   endif
56 #endif
57
58 #ifndef SOL_IP
59 # define SOL_IP IPPROTO_IP
60 #endif
61 #ifndef SOL_IPV6
62 # define SOL_IPV6 IPPROTO_IPV6
63 #endif
64 #ifndef IPPROTO_IPV6
65 # define IPPROTO_IPV6 41
66 #endif
67
68 extern int net_Socket( vlc_object_t *p_this, int i_family, int i_socktype,
69                        int i_protocol );
70
71
72 /*
73  * XXX: I am too lazy to put all these dual functions in “next generation”
74  * network plugins.
75  */
76
77 static int net_SetMcastHopLimit( vlc_object_t *p_this,
78                                  int fd, int family, int hlim )
79 {
80     int proto, cmd;
81
82     /* There is some confusion in the world whether IP_MULTICAST_TTL 
83      * takes a byte or an int as an argument.
84      * BSD seems to indicate byte so we are going with that and use
85      * int as a fallback to be safe */
86     switch( family )
87     {
88 #ifdef IP_MULTICAST_TTL
89         case AF_INET:
90             proto = SOL_IP;
91             cmd = IP_MULTICAST_TTL;
92             break;
93 #endif
94
95 #ifdef IPV6_MULTICAST_HOPS
96         case AF_INET6:
97             proto = SOL_IPV6;
98             cmd = IPV6_MULTICAST_HOPS;
99             break;
100 #endif
101
102         default:
103             msg_Warn( p_this, "%s", strerror( EAFNOSUPPORT ) );
104             return VLC_EGENERIC;
105     }
106
107     if( setsockopt( fd, proto, cmd, &hlim, sizeof( hlim ) ) < 0 )
108     {
109         /* BSD compatibility */
110         unsigned char buf;
111
112         buf = (unsigned char)(( hlim > 255 ) ? 255 : hlim);
113         if( setsockopt( fd, proto, cmd, &buf, sizeof( buf ) ) )
114             return VLC_EGENERIC;
115     }
116
117     return VLC_SUCCESS;
118 }
119
120
121 static int net_SetMcastOutIface (int fd, int family, int scope)
122 {
123     switch (family)
124     {
125 #ifdef IPV6_MULTICAST_IF
126         case AF_INET6:
127             return setsockopt (fd, SOL_IPV6, IPV6_MULTICAST_IF,
128                                &scope, sizeof (scope));
129 #endif
130
131 #ifdef __linux__
132         case AF_INET:
133         {
134             struct ip_mreqn req = { .imr_ifindex = scope };
135
136             return setsockopt (fd, SOL_IP, IP_MULTICAST_IF, &req,
137                                sizeof (req));
138         }
139 #endif
140     }
141
142     errno = EAFNOSUPPORT;
143     return -1;
144 }
145
146
147 static inline int net_SetMcastOutIPv4 (int fd, struct in_addr ipv4)
148 {
149 #ifdef IP_MULTICAST_IF
150     return setsockopt( fd, SOL_IP, IP_MULTICAST_IF, &ipv4, sizeof (ipv4));
151 #else
152     errno = EAFNOSUPPORT;
153     return -1;
154 #endif
155 }
156
157
158 static int net_SetMcastOut (vlc_object_t *p_this, int fd, int family,
159                             const char *iface, const char *addr)
160 {
161     if (iface != NULL)
162     {
163         int scope = if_nametoindex (iface);
164         if (scope == 0)
165         {
166             msg_Err (p_this, "invalid multicast interface: %s", iface);
167             return -1;
168         }
169
170         if (net_SetMcastOutIface (fd, family, scope) == 0)
171             return 0;
172
173         msg_Err (p_this, "%s: %s", iface, net_strerror (net_errno));
174     }
175
176     if (addr != NULL)
177     {
178         if (family == AF_INET)
179         {
180             struct in_addr ipv4;
181             if (inet_pton (AF_INET, addr, &ipv4) <= 0)
182             {
183                 msg_Err (p_this, "invalid IPv4 address for multicast: %s",
184                          addr);
185                 return -1;
186             }
187
188             if (net_SetMcastOutIPv4 (fd, ipv4) == 0)
189                 return 0;
190
191             msg_Err (p_this, "%s: %s", addr, net_strerror (net_errno));
192         }
193     }
194
195     return -1;
196 }
197
198
199 /**
200  * Old-style any-source multicast join.
201  * In use on Windows XP/2003 and older.
202  */
203 static int
204 net_IPv4Join (vlc_object_t *obj, int fd,
205               const struct sockaddr_in *src, const struct sockaddr_in *grp)
206 {
207 #ifdef IP_ADD_MEMBERSHIP
208     union
209     {
210         struct ip_mreq gr4;
211 # ifdef IP_ADD_SOURCE_MEMBERSHIP
212         struct ip_mreq_source gsr4;
213 # endif
214     } opt;
215     int cmd;
216     struct in_addr id;
217     socklen_t optlen;
218
219     /* Multicast interface IPv4 address */
220     char *iface = var_CreateGetString (obj, "miface-addr");
221     if (iface != NULL)
222     {
223         if ((*iface)
224          && (inet_pton (AF_INET, iface, &id) <= 0))
225         {
226             msg_Err (obj, "invalid multicast interface address %s", iface);
227             free (iface);
228             goto error;
229         }
230     }
231
232     memset (&opt, 0, sizeof (opt));
233     if (src != NULL)
234     {
235 # ifdef IP_ADD_SOURCE_MEMBERSHIP
236         cmd = IP_ADD_SOURCE_MEMBERSHIP;
237         opt.gsr4.imr_multiaddr = grp->sin_addr;
238         opt.gsr4.imr_sourceaddr = src->sin_addr;
239         opt.gsr4.imr_interface = id;
240         optlen = sizeof (opt.gsr4);
241 # else
242         errno = ENOSYS;
243         goto error;
244 # endif
245     }
246     else
247     {
248         cmd = IP_ADD_MEMBERSHIP;
249         opt.gr4.imr_multiaddr = grp->sin_addr;
250         opt.gr4.imr_interface = id;
251         optlen = sizeof (opt.gr4);
252     }
253
254     msg_Dbg (obj, "IP_ADD_%sMEMBERSHIP multicast request",
255              (src != NULL) ? "SOURCE_" : "");
256
257     if (setsockopt (fd, SOL_IP, cmd, &opt, optlen) == 0)
258         return 0;
259
260 error:
261 #endif
262
263     msg_Err (obj, "cannot join IPv4 multicast group (%s)",
264              net_strerror (net_errno));
265     return -1;
266 }
267
268
269 static int
270 net_IPv6Join (vlc_object_t *obj, int fd, const struct sockaddr_in6 *src)
271 {
272 #ifdef IPV6_JOIN_GROUP
273     struct ipv6_mreq gr6;
274     memset (&gr6, 0, sizeof (gr6));
275     gr6.ipv6mr_interface = src->sin6_scope_id;
276     memcpy (&gr6.ipv6mr_multiaddr, &src->sin6_addr, 16);
277
278     msg_Dbg (obj, "IPV6_JOIN_GROUP multicast request");
279
280     if (!setsockopt (fd, IPPROTO_IPV6, IPV6_JOIN_GROUP, &gr6, sizeof (gr6)))
281         return 0;
282 #else
283     errno = ENOSYS;
284 #endif
285
286     msg_Err (obj, "cannot join IPv6 any-source multicast group (%s)",
287              net_strerror (net_errno));
288     return -1;
289 }
290
291
292 #if defined (WIN32) && !defined (MCAST_JOIN_SOURCE_GROUP)
293 /*
294  * I hate manual definitions: Error-prone. Portability hell.
295  * Developers shall use UP-TO-DATE compilers. Full point.
296  * If you remove the warning, you remove the whole ifndef.
297  */
298 #  warning Your C headers are out-of-date. Please update.
299
300 /* Most (all?) Mingw32 versions in use are yet to pick up Vista stuff */
301 #  define MCAST_JOIN_SOURCE_GROUP 45 /* from <ws2ipdef.h> */
302 struct group_source_req
303 {
304     uint32_t gsr_interface;
305     struct sockaddr_storage gsr_group;
306     struct sockaddr_storage gsr_source;
307 };
308 # endif
309
310 /**
311  * IP-agnostic multicast join,
312  * with fallback to old APIs, and fallback from SSM to ASM.
313  */
314 static int
315 net_SourceSubscribe (vlc_object_t *obj, int fd,
316                      const struct sockaddr *src, socklen_t srclen,
317                      const struct sockaddr *grp, socklen_t grplen)
318 {
319     /* Agnostic ASM/SSM multicast join */
320 #ifdef MCAST_JOIN_SOURCE_GROUP
321     union
322     {
323         struct group_req gr;
324         struct group_source_req gsr;
325     } opt;
326     socklen_t optlen;
327     int level, iid = 0;
328     vlc_bool_t ssm = VLC_TRUE;
329
330     if (src == NULL)
331         ssm = VLC_FALSE;
332
333     memset (&opt, 0, sizeof (opt));
334
335     char *iface = var_CreateGetString (obj, "miface");
336     if (iface != NULL)
337     {
338         if (*iface)
339         {
340             iid = if_nametoindex (iface);
341             if (iid == 0)
342             {
343                 msg_Err (obj, "invalid multicast interface: %s", iface);
344                 free (iface);
345                 return -1;
346             }
347         }
348         free (iface);
349     }
350
351     switch (grp->sa_family)
352     {
353         case AF_INET6:
354             level = SOL_IPV6;
355             if (ssm
356              && memcmp (&((const struct sockaddr_in6 *)src)->sin6_addr,
357                         &in6addr_any, sizeof (in6addr_any)) == 0)
358                 ssm = VLC_FALSE;
359
360             if (((const struct sockaddr_in6 *)src)->sin6_scope_id)
361                 iid = ((const struct sockaddr_in6 *)src)->sin6_scope_id;
362             break;
363
364         case AF_INET:
365             level = SOL_IP;
366             if (ssm
367              && ((const struct sockaddr_in *)src)->sin_addr.s_addr
368                   == INADDR_ANY)
369                 ssm = VLC_FALSE;
370             break;
371
372         default:
373             errno = EAFNOSUPPORT;
374             return -1;
375     }
376
377     if (ssm)
378     {
379         if ((grplen > sizeof (opt.gsr.gsr_group))
380          || (srclen > sizeof (opt.gsr.gsr_source)))
381             return -1;
382
383         opt.gsr.gsr_interface = iid;
384         memcpy (&opt.gsr.gsr_source, src, srclen);
385         memcpy (&opt.gsr.gsr_group,  grp, grplen);
386         optlen = sizeof (opt.gsr);
387     }
388     else
389     {
390         if (grplen > sizeof (opt.gr.gr_group))
391             return -1;
392
393         opt.gr.gr_interface = iid;
394         memcpy (&opt.gr.gr_group, grp, grplen);
395         optlen = sizeof (opt.gr);
396     }
397
398     msg_Dbg (obj, "Multicast %sgroup join request", ssm ? "source " : "");
399
400     if (setsockopt (fd, level,
401                     ssm ? MCAST_JOIN_SOURCE_GROUP : MCAST_JOIN_GROUP,
402                     (void *)&opt, optlen) == 0)
403         return 0;
404 #endif
405
406     /* Fallback to IPv-specific APIs */
407     if (ssm && (src->sa_family != grp->sa_family))
408         return -1;
409
410     switch (grp->sa_family)
411     {
412         case AF_INET:
413             if ((grplen < sizeof (struct sockaddr_in))
414              || (ssm && (srclen < sizeof (struct sockaddr_in))))
415                 return -1;
416
417             if (net_IPv4Join (obj, fd, (const struct sockaddr_in *)src,
418                               (const struct sockaddr_in *)grp) == 0)
419                 return 0;
420             break;
421
422 #ifdef AF_INET6
423         case AF_INET6:
424             if ((grplen < sizeof (struct sockaddr_in6))
425              || (ssm && (srclen < sizeof (struct sockaddr_in6))))
426                 return -1;
427
428             /* We don't provide IPv6-specific SSM at the moment.
429              * It seems all the OSes with IPv6 SSM have the new API anyway. */
430
431             if (net_IPv6Join (obj, fd, (const struct sockaddr_in6 *)grp) == 0)
432                 return 0;
433             break;
434 #endif
435     }
436
437     msg_Err (obj, "Multicast group join error (%s)",
438              net_strerror (net_errno));
439
440     if (ssm)
441     {
442         msg_Warn (obj, "Trying ASM instead of SSM...");
443         return net_Subscribe (obj, fd, grp, grplen);
444     }
445
446     msg_Err (obj, "Multicast not supported");
447     return -1;
448 }
449
450
451 int net_Subscribe (vlc_object_t *obj, int fd,
452                    const struct sockaddr *addr, socklen_t addrlen)
453 {
454     return net_SourceSubscribe (obj, fd, NULL, 0, addr, addrlen);
455 }
456
457
458 int net_SetDSCP( int fd, uint8_t dscp )
459 {
460     struct sockaddr_storage addr;
461     if( getsockname( fd, (struct sockaddr *)&addr, &(socklen_t){ sizeof (addr) }) )
462         return -1;
463
464     int level, cmd;
465
466     switch( addr.ss_family )
467     {
468 #ifdef IPV6_TCLASS
469         case AF_INET6:
470             level = SOL_IPV6;
471             cmd = IPV6_TCLASS;
472             break;
473 #endif
474
475         case AF_INET:
476             level = SOL_IP;
477             cmd = IP_TOS;
478             break;
479
480         default:
481 #ifdef ENOPROTOOPT
482             errno = ENOPROTOOPT;
483 #endif
484             return -1;
485     }
486
487     return setsockopt( fd, level, cmd, &(int){ dscp }, sizeof (int));
488 }
489
490
491 /*****************************************************************************
492  * __net_ConnectUDP:
493  *****************************************************************************
494  * Open a UDP socket to send data to a defined destination, with an optional
495  * hop limit.
496  *****************************************************************************/
497 int __net_ConnectUDP( vlc_object_t *p_this, const char *psz_host, int i_port,
498                       int i_hlim )
499 {
500     struct addrinfo hints, *res, *ptr;
501     int             i_val, i_handle = -1;
502     vlc_bool_t      b_unreach = VLC_FALSE;
503
504     if( i_port == 0 )
505         i_port = 1234; /* historical VLC thing */
506
507     if( i_hlim < 1 )
508         i_hlim = var_CreateGetInteger( p_this, "ttl" );
509
510     memset( &hints, 0, sizeof( hints ) );
511     hints.ai_socktype = SOCK_DGRAM;
512
513     msg_Dbg( p_this, "net: connecting to %s port %d", psz_host, i_port );
514
515     i_val = vlc_getaddrinfo( p_this, psz_host, i_port, &hints, &res );
516     if( i_val )
517     {
518         msg_Err( p_this, "cannot resolve %s port %d : %s", psz_host, i_port,
519                  vlc_gai_strerror( i_val ) );
520         return -1;
521     }
522
523     for( ptr = res; ptr != NULL; ptr = ptr->ai_next )
524     {
525         char *str;
526         int fd = net_Socket (p_this, ptr->ai_family, ptr->ai_socktype,
527                              ptr->ai_protocol);
528         if (fd == -1)
529             continue;
530
531 #if !defined( SYS_BEOS )
532         /* Increase the receive buffer size to 1/2MB (8Mb/s during 1/2s)
533         * to avoid packet loss caused by scheduling problems */
534         setsockopt (fd, SOL_SOCKET, SO_RCVBUF, &(int){ 0x80000 }, sizeof (int));
535         setsockopt (fd, SOL_SOCKET, SO_SNDBUF, &(int){ 0x80000 }, sizeof (int));
536
537         /* Allow broadcast sending */
538         setsockopt (fd, SOL_SOCKET, SO_BROADCAST, &(int){ 1 }, sizeof (int));
539 #endif
540
541         if( i_hlim > 0 )
542             net_SetMcastHopLimit( p_this, fd, ptr->ai_family, i_hlim );
543
544         str = var_CreateGetString (p_this, "miface");
545         if (str != NULL)
546         {
547             if (*str)
548                 net_SetMcastOut (p_this, fd, ptr->ai_family, str, NULL);
549             free (str);
550         }
551
552         str = var_CreateGetString (p_this, "miface-addr");
553         if (str != NULL)
554         {
555             if (*str)
556                 net_SetMcastOut (p_this, fd, ptr->ai_family, NULL, str);
557             free (str);
558         }
559
560         net_SetDSCP (fd, var_CreateGetInteger (p_this, "dscp"));
561
562         if( connect( fd, ptr->ai_addr, ptr->ai_addrlen ) == 0 )
563         {
564             /* success */
565             i_handle = fd;
566             break;
567         }
568
569 #if defined( WIN32 ) || defined( UNDER_CE )
570         if( WSAGetLastError () == WSAENETUNREACH )
571 #else
572         if( errno == ENETUNREACH )
573 #endif
574             b_unreach = VLC_TRUE;
575         else
576         {
577             msg_Warn( p_this, "%s port %d : %s", psz_host, i_port,
578                       strerror( errno ) );
579             net_Close( fd );
580             continue;
581         }
582     }
583
584     vlc_freeaddrinfo( res );
585
586     if( i_handle == -1 )
587     {
588         if( b_unreach )
589             msg_Err( p_this, "Host %s port %d is unreachable", psz_host,
590                      i_port );
591         return -1;
592     }
593
594     return i_handle;
595 }
596
597
598 /*****************************************************************************
599  * __net_OpenUDP:
600  *****************************************************************************
601  * Open a UDP connection and return a handle
602  *****************************************************************************/
603 int __net_OpenUDP( vlc_object_t *obj, const char *psz_bind, int i_bind,
604                    const char *psz_server, int i_server )
605 {
606     struct addrinfo hints, *loc, *rem;
607     int val;
608
609     msg_Dbg( obj, "net: connecting to '[%s]:%d@[%s]:%d'",
610              psz_server, i_server, psz_bind, i_bind );
611
612     memset (&hints, 0, sizeof (hints));
613     hints.ai_socktype = SOCK_DGRAM;
614     hints.ai_protocol = IPPROTO_UDP;
615     hints.ai_flags = AI_PASSIVE;
616
617     val = vlc_getaddrinfo (obj, psz_server, i_server, &hints, &rem);
618     if (val)
619     {
620         msg_Err (obj, "cannot resolve %s port %d : %s", psz_bind, i_bind,
621                  vlc_gai_strerror (val));
622         return -1;
623     }
624
625     val = vlc_getaddrinfo (obj, psz_bind, i_bind, &hints, &loc);
626     if (val)
627     {
628         msg_Err (obj, "cannot resolve %s port %d : %s", psz_bind, i_bind,
629                  vlc_gai_strerror (val));
630         vlc_freeaddrinfo (rem);
631         return -1;
632     }
633
634     for (struct addrinfo *ptr = loc; ptr != NULL; ptr = ptr->ai_next)
635     {
636         int fd = net_Socket (obj, ptr->ai_family, ptr->ai_socktype,
637                              ptr->ai_protocol);
638         if (fd == -1)
639             continue; // usually, address family not supported
640
641 #ifdef SO_REUSEPORT
642         setsockopt (fd, SOL_SOCKET, SO_REUSEPORT, &(int){ 1 }, sizeof (int));
643 #endif
644
645 #ifdef SO_RCVBUF
646         /* Increase the receive buffer size to 1/2MB (8Mb/s during 1/2s)
647          * to avoid packet loss caused in case of scheduling hiccups */
648         setsockopt (fd, SOL_SOCKET, SO_RCVBUF,
649                     (void *)&(int){ 0x80000 }, sizeof (int));
650         setsockopt (fd, SOL_SOCKET, SO_SNDBUF,
651                     (void *)&(int){ 0x80000 }, sizeof (int));
652 #endif
653
654 #if defined (WIN32) || defined (UNDER_CE)
655         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen)
656          && (sizeof (struct sockaddr_storage) >= ptr->ai_addrlen))
657         {
658             // This works for IPv4 too - don't worry!
659             struct sockaddr_in6 dumb =
660             {
661                 .sin6_family = ptr->ai_addr->sa_family,
662                 .sin6_port =  ((struct sockaddr_in *)(ptr->ai_addr))->sin_port
663             };
664
665             bind (fd, (struct sockaddr *)&dumb, ptr->ai_addrlen);
666         }
667         else
668 #endif
669         if (bind (fd, ptr->ai_addr, ptr->ai_addrlen))
670         {
671             net_Close (fd);
672             continue;
673         }
674
675         struct addrinfo *ptr2;
676         for (ptr2 = rem; ptr2 != NULL; ptr2 = ptr2->ai_next)
677         {
678             if ((ptr2->ai_family != ptr->ai_family)
679              || (ptr2->ai_socktype != ptr->ai_socktype)
680              || (ptr2->ai_protocol != ptr->ai_protocol))
681                 continue;
682
683             if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen))
684             {
685                 if (net_SourceSubscribe (obj, fd,
686                                          ptr2->ai_addr, ptr2->ai_addrlen,
687                                          ptr->ai_addr, ptr->ai_addrlen) == 0)
688                     break;
689             }
690             else
691             {
692                 if (connect (fd, ptr2->ai_addr, ptr2->ai_addrlen) == 0)
693                     break;
694             }
695         }
696
697         if (ptr2 == NULL)
698         {
699             msg_Err (obj, "cannot connect to %s port %d: %s",
700                      psz_server, i_server, net_strerror (net_errno));
701             close (fd);
702             continue;
703         }
704
705         return fd;
706     }
707
708     return -1;
709 }