Minor code factorization
[vlc.git] / src / network / io.c
1 /*****************************************************************************
2  * io.c: network I/O functions
3  *****************************************************************************
4  * Copyright (C) 2004-2005, 2007 the VideoLAN team
5  * Copyright © 2005-2006 Rémi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Laurent Aimar <fenrir@videolan.org>
9  *          Rémi Denis-Courmont <rem # videolan.org>
10  *          Christophe Mutricy <xtophe at videolan dot 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
31 #include <vlc/vlc.h>
32
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <limits.h>
36
37 #include <errno.h>
38 #include <assert.h>
39
40 #ifdef HAVE_FCNTL_H
41 #   include <fcntl.h>
42 #endif
43 #ifdef HAVE_SYS_TIME_H
44 #    include <sys/time.h>
45 #endif
46 #ifdef HAVE_UNISTD_H
47 #   include <unistd.h>
48 #endif
49 #ifdef HAVE_POLL
50 #   include <poll.h>
51 #endif
52
53 #include <vlc_network.h>
54
55 #ifndef INADDR_ANY
56 #   define INADDR_ANY  0x00000000
57 #endif
58 #ifndef INADDR_NONE
59 #   define INADDR_NONE 0xFFFFFFFF
60 #endif
61
62 #if defined(WIN32) || defined(UNDER_CE)
63 # undef EAFNOSUPPORT
64 # define EAFNOSUPPORT WSAEAFNOSUPPORT
65 #endif
66
67 extern int rootwrap_bind (int family, int socktype, int protocol,
68                           const struct sockaddr *addr, size_t alen);
69
70 int net_SetupSocket (int fd)
71 {
72 #if defined (WIN32) || defined (UNDER_CE)
73     ioctlsocket (fd, FIONBIO, &(unsigned long){ 1 });
74 #else
75     fcntl (fd, F_SETFD, FD_CLOEXEC);
76     fcntl (fd, F_SETFL, fcntl (fd, F_GETFL, 0) | O_NONBLOCK);
77 #endif
78
79     setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &(int){ 1 }, sizeof (int));
80     return 0;
81 }
82
83
84 int net_Socket (vlc_object_t *p_this, int family, int socktype,
85                 int protocol)
86 {
87     int fd = socket (family, socktype, protocol);
88     if (fd == -1)
89     {
90         if (net_errno != EAFNOSUPPORT)
91             msg_Err (p_this, "cannot create socket: %s",
92                      net_strerror (net_errno));
93         return -1;
94     }
95
96     net_SetupSocket (fd);
97
98 #ifdef IPV6_V6ONLY
99     /*
100      * Accepts only IPv6 connections on IPv6 sockets
101      * (and open an IPv4 socket later as well if needed).
102      * Only Linux and FreeBSD can map IPv4 connections on IPv6 sockets,
103      * so this allows for more uniform handling across platforms. Besides,
104      * it makes sure that IPv4 addresses will be printed as w.x.y.z rather
105      * than ::ffff:w.x.y.z
106      */
107     if (family == AF_INET6)
108         setsockopt (fd, IPPROTO_IPV6, IPV6_V6ONLY, &(int){ 1 }, sizeof (int));
109 #endif
110
111 #if defined (WIN32) || defined (UNDER_CE)
112 # ifndef IPV6_PROTECTION_LEVEL
113 #  warning Please update your C library headers.
114 #  define IPV6_PROTECTION_LEVEL 23
115 #  define PROTECTION_LEVEL_UNRESTRICTED 10
116 # endif
117     if (family == AF_INET6)
118         setsockopt (fd, IPPROTO_IPV6, IPV6_PROTECTION_LEVEL,
119                     &(int){ PROTECTION_LEVEL_UNRESTRICTED }, sizeof (int));
120 #endif
121
122     return fd;
123 }
124
125
126 int *net_Listen (vlc_object_t *p_this, const char *psz_host,
127                  int i_port, int family, int socktype, int protocol)
128 {
129     struct addrinfo hints, *res;
130
131     memset (&hints, 0, sizeof( hints ));
132     hints.ai_family = family;
133     hints.ai_socktype = socktype;
134     hints.ai_flags = AI_PASSIVE;
135
136     msg_Dbg (p_this, "net: listening to %s port %d", psz_host, i_port);
137
138     int i_val = vlc_getaddrinfo (p_this, psz_host, i_port, &hints, &res);
139     if (i_val)
140     {
141         msg_Err (p_this, "Cannot resolve %s port %d : %s", psz_host, i_port,
142                  vlc_gai_strerror (i_val));
143         return NULL;
144     }
145
146     int *sockv = NULL;
147     unsigned sockc = 0;
148
149     for (struct addrinfo *ptr = res; ptr != NULL; ptr = ptr->ai_next)
150     {
151         int fd = net_Socket (p_this, ptr->ai_family, ptr->ai_socktype,
152                              protocol ?: ptr->ai_protocol);
153         if (fd == -1)
154         {
155             msg_Dbg (p_this, "socket error: %s", net_strerror (net_errno));
156             continue;
157         }
158
159         /* Bind the socket */
160 #if defined (WIN32) || defined (UNDER_CE)
161         /*
162          * Under Win32 and for multicasting, we bind to INADDR_ANY.
163          * This is of course a severe bug, since the socket would logically
164          * receive unicast traffic, and multicast traffic of groups subscribed
165          * to via other sockets.
166          */
167         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen)
168          && (sizeof (struct sockaddr_storage) >= ptr->ai_addrlen))
169         {
170             // This works for IPv4 too - don't worry!
171             struct sockaddr_in6 dumb =
172             {
173                 .sin6_family = ptr->ai_addr->sa_family,
174                 .sin6_port =  ((struct sockaddr_in *)(ptr->ai_addr))->sin_port
175             };
176
177             bind (fd, (struct sockaddr *)&dumb, ptr->ai_addrlen);
178         }
179         else
180 #endif
181         if (bind (fd, ptr->ai_addr, ptr->ai_addrlen))
182         {
183             int saved_errno = net_errno;
184
185             net_Close (fd);
186 #if !defined(WIN32) && !defined(UNDER_CE)
187             fd = rootwrap_bind (ptr->ai_family, ptr->ai_socktype,
188                                 protocol ?: ptr->ai_protocol, ptr->ai_addr,
189                                 ptr->ai_addrlen);
190             if (fd != -1)
191             {
192                 msg_Dbg (p_this, "got socket %d from rootwrap", fd);
193             }
194             else
195 #endif
196             {
197                 msg_Err (p_this, "socket bind error (%s)",
198                          net_strerror( saved_errno ) );
199                 continue;
200             }
201         }
202
203         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen))
204         {
205             if (net_Subscribe (p_this, fd, ptr->ai_addr, ptr->ai_addrlen))
206             {
207                 net_Close (fd);
208                 continue;
209             }
210         }
211
212         /* Listen */
213         switch (ptr->ai_socktype)
214         {
215             case SOCK_STREAM:
216             case SOCK_RDM:
217             case SOCK_SEQPACKET:
218                 if (listen (fd, INT_MAX))
219                 {
220                     msg_Err (p_this, "socket listen error (%s)",
221                             net_strerror (net_errno));
222                     net_Close (fd);
223                     continue;
224                 }
225         }
226
227         int *nsockv = (int *)realloc (sockv, (sockc + 2) * sizeof (int));
228         if (nsockv != NULL)
229         {
230             nsockv[sockc++] = fd;
231             sockv = nsockv;
232         }
233         else
234             net_Close (fd);
235     }
236
237     vlc_freeaddrinfo (res);
238
239     if (sockv != NULL)
240         sockv[sockc] = -1;
241
242     return sockv;
243 }
244
245
246 int net_ListenSingle (vlc_object_t *obj, const char *host, int port,
247                       int family, int socktype, int protocol)
248 {
249     int *fdv = net_Listen (obj, host, port, family, socktype, protocol);
250     if (fdv == NULL)
251         return -1;
252
253     for (unsigned i = 1; fdv[i] != -1; i++)
254     {
255         msg_Warn (obj, "Multiple sockets opened. Dropping extra ones!");
256         net_Close (fdv[i]);
257     }
258
259     int fd = fdv[0];
260     assert (fd != -1);
261
262     free (fdv);
263     return fd;
264 }
265
266
267
268 /*****************************************************************************
269  * __net_Close:
270  *****************************************************************************
271  * Close a network handle
272  *****************************************************************************/
273 void net_Close (int fd)
274 {
275 #ifdef UNDER_CE
276     CloseHandle ((HANDLE)fd);
277 #elif defined (WIN32)
278     closesocket (fd);
279 #else
280     (void)close (fd);
281 #endif
282 }
283
284
285 static ssize_t
286 net_ReadInner( vlc_object_t *restrict p_this, unsigned fdc, const int *fdv,
287                const v_socket_t *const *restrict vsv,
288                uint8_t *restrict p_buf, size_t i_buflen,
289                vlc_bool_t dontwait, vlc_bool_t waitall )
290 {
291     size_t i_total = 0;
292
293     while (i_buflen > 0)
294     {
295         unsigned i;
296         ssize_t n;
297         struct pollfd ufd[fdc];
298
299         int delay_ms = dontwait ? 0 : 500;
300         if (p_this->b_die)
301         {
302             errno = EINTR;
303             goto error;
304         }
305
306         memset (ufd, 0, sizeof (ufd));
307
308         for( i = 0; i < fdc; i++ )
309         {
310             ufd[i].fd = fdv[i];
311             ufd[i].events = POLLIN;
312         }
313
314         n = poll( ufd, fdc, delay_ms );
315         if( n == -1 )
316             goto error;
317
318         assert ((unsigned)n <= fdc);
319
320         if (n == 0) // timeout
321             continue;
322
323         for (i = 0;; i++)
324         {
325             if ((i_total > 0) && (ufd[i].revents & POLLERR))
326                 return i_total; // error will be dequeued on next run
327
328             if ((ufd[i].revents & POLLIN) == 0)
329                 continue;
330
331             fdc = 1;
332             fdv += i;
333             vsv += i;
334             break;
335         }
336
337         if( (*vsv) != NULL )
338         {
339             n = (*vsv)->pf_recv( (*vsv)->p_sys, p_buf, i_buflen );
340         }
341         else
342         {
343 #if defined(WIN32) || defined(UNDER_CE)
344             n = recv( *fdv, p_buf, i_buflen, 0 );
345 #else
346             n = read( *fdv, p_buf, i_buflen );
347 #endif
348         }
349
350         if( n == -1 )
351         {
352 #if defined(WIN32) || defined(UNDER_CE)
353             switch( WSAGetLastError() )
354             {
355                 case WSAEWOULDBLOCK:
356                 /* only happens with vs != NULL (SSL) - not really an error */
357                     continue;
358
359                 case WSAEMSGSIZE:
360                 /* For UDP only */
361                 /* On Win32, recv() fails if the datagram doesn't fit inside
362                  * the passed buffer, even though the buffer will be filled
363                  * with the first part of the datagram. */
364                     msg_Err( p_this, "Receive error: "
365                                      "Increase the mtu size (--mtu option)" );
366                     n = i_buflen;
367                     break;
368
369                 default:
370                     goto error;
371             }
372 #else
373             if( errno == EAGAIN ) /* spurious wake-up (sucks if fdc > 1) */
374                 continue;
375             goto error;
376 #endif
377         }
378
379         if (n == 0) // EOF
380             break;
381
382         i_total += n;
383         p_buf += n;
384         i_buflen -= n;
385
386         if (dontwait || !waitall)
387             break;
388     }
389     return i_total;
390
391 error:
392     msg_Err( p_this, "Read error: %s", net_strerror (net_errno) );
393     return i_total ? (ssize_t)i_total : -1;
394 }
395
396
397 /*****************************************************************************
398  * __net_Read:
399  *****************************************************************************
400  * Read from a network socket
401  * If b_retry is true, then we repeat until we have read the right amount of
402  * data; in that case, a short count means EOF has been reached.
403  *****************************************************************************/
404 ssize_t __net_Read( vlc_object_t *restrict p_this, int fd,
405                     const v_socket_t *restrict p_vs,
406                     uint8_t *restrict buf, size_t len, vlc_bool_t b_retry )
407 {
408     return net_ReadInner( p_this, 1, &(int){ fd },
409                           &(const v_socket_t *){ p_vs },
410                           buf, len, VLC_FALSE, b_retry );
411 }
412
413
414 /*****************************************************************************
415  * __net_ReadNonBlock:
416  *****************************************************************************
417  * Read from a network socket, non blocking mode.
418  * This function should only be used after a poll() (or select(), but you
419  * should use poll instead of select()) invocation to avoid busy loops.
420  *****************************************************************************/
421 ssize_t __net_ReadNonBlock( vlc_object_t *restrict p_this, int fd,
422                             const v_socket_t *restrict p_vs,
423                             uint8_t *restrict buf, size_t len )
424 {
425     return net_ReadInner (p_this, 1, &(int){ fd },
426                           &(const v_socket_t *){ p_vs },
427                           buf, len, VLC_TRUE, VLC_FALSE);
428 }
429
430
431 /*****************************************************************************
432  * __net_Select:
433  *****************************************************************************
434  * Read from several sockets. Takes data from the first socket that has some.
435  *****************************************************************************/
436 ssize_t __net_Select( vlc_object_t *restrict p_this,
437                       const int *restrict fds, int nfd,
438                       uint8_t *restrict buf, size_t len )
439 {
440     const v_socket_t *vsv[nfd];
441     memset( vsv, 0, sizeof (vsv) );
442
443     return net_ReadInner( p_this, nfd, fds, vsv,
444                           buf, len, VLC_FALSE, VLC_FALSE );
445 }
446
447
448 /* Write exact amount requested */
449 ssize_t __net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
450                      const uint8_t *p_data, size_t i_data )
451 {
452     size_t i_total = 0;
453
454     while( i_data > 0 )
455     {
456         if( p_this->b_die )
457             break;
458
459         struct pollfd ufd[1];
460         memset (ufd, 0, sizeof (ufd));
461         ufd[0].fd = fd;
462         ufd[0].events = POLLOUT;
463
464         int val = poll (ufd, 1, 500);
465         switch (val)
466         {
467             case -1:
468                msg_Err (p_this, "Write error: %s", net_strerror (net_errno));
469                goto out;
470
471             case 0:
472                 continue;
473         }
474
475         if ((ufd[0].revents & POLLERR) && (i_total > 0))
476             return i_total; // error will be dequeued separately on next call
477
478         if (p_vs != NULL)
479             val = p_vs->pf_send (p_vs->p_sys, p_data, i_data);
480         else
481 #if defined(WIN32) || defined(UNDER_CE)
482             val = send (fd, p_data, i_data, 0);
483 #else
484             val = write (fd, p_data, i_data);
485 #endif
486
487         if (val == -1)
488         {
489             msg_Err (p_this, "Write error: %s", net_strerror (net_errno));
490             break;
491         }
492         if (val == 0)
493             return i_total;
494
495         p_data += val;
496         i_data -= val;
497         i_total += val;
498     }
499
500 out:
501     if ((i_total > 0) || (i_data == 0))
502         return i_total;
503
504     return -1;
505 }
506
507 char *__net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
508 {
509     char *psz_line = NULL, *ptr = NULL;
510     size_t  i_line = 0, i_max = 0;
511
512
513     for( ;; )
514     {
515         if( i_line == i_max )
516         {
517             i_max += 1024;
518             psz_line = realloc( psz_line, i_max );
519             ptr = psz_line + i_line;
520         }
521
522         if( net_Read( p_this, fd, p_vs, (uint8_t *)ptr, 1, VLC_TRUE ) != 1 )
523         {
524             if( i_line == 0 )
525             {
526                 free( psz_line );
527                 return NULL;
528             }
529             break;
530         }
531
532         if ( *ptr == '\n' )
533             break;
534
535         i_line++;
536         ptr++;
537     }
538
539     *ptr-- = '\0';
540
541     if( ( ptr >= psz_line ) && ( *ptr == '\r' ) )
542         *ptr = '\0';
543
544     return psz_line;
545 }
546
547 ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
548                     const char *psz_fmt, ... )
549 {
550     int i_ret;
551     va_list args;
552     va_start( args, psz_fmt );
553     i_ret = net_vaPrintf( p_this, fd, p_vs, psz_fmt, args );
554     va_end( args );
555
556     return i_ret;
557 }
558
559 ssize_t __net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
560                         const char *psz_fmt, va_list args )
561 {
562     char    *psz;
563     int     i_size, i_ret;
564
565     i_size = vasprintf( &psz, psz_fmt, args );
566     i_ret = __net_Write( p_this, fd, p_vs, (uint8_t *)psz, i_size ) < i_size
567         ? -1 : i_size;
568     free( psz );
569
570     return i_ret;
571 }
572
573
574 /*****************************************************************************
575  * inet_pton replacement for obsolete and/or crap operating systems
576  *****************************************************************************/
577 #ifndef HAVE_INET_PTON
578 int inet_pton(int af, const char *src, void *dst)
579 {
580 # ifdef WIN32
581     /* As we already know, Microsoft always go its own way, so even if they do
582      * provide IPv6, they don't provide the API. */
583     struct sockaddr_storage addr;
584     int len = sizeof( addr );
585
586     /* Damn it, they didn't even put LPCSTR for the firs parameter!!! */
587 #ifdef UNICODE
588     wchar_t *workaround_for_ill_designed_api =
589         malloc( MAX_PATH * sizeof(wchar_t) );
590     mbstowcs( workaround_for_ill_designed_api, src, MAX_PATH );
591     workaround_for_ill_designed_api[MAX_PATH-1] = 0;
592 #else
593     char *workaround_for_ill_designed_api = strdup( src );
594 #endif
595
596     if( !WSAStringToAddress( workaround_for_ill_designed_api, af, NULL,
597                              (LPSOCKADDR)&addr, &len ) )
598     {
599         free( workaround_for_ill_designed_api );
600         return -1;
601     }
602     free( workaround_for_ill_designed_api );
603
604     switch( af )
605     {
606         case AF_INET6:
607             memcpy( dst, &((struct sockaddr_in6 *)&addr)->sin6_addr, 16 );
608             break;
609
610         case AF_INET:
611             memcpy( dst, &((struct sockaddr_in *)&addr)->sin_addr, 4 );
612             break;
613
614         default:
615             WSASetLastError( WSAEAFNOSUPPORT );
616             return -1;
617     }
618 # else
619     /* Assume IPv6 is not supported. */
620     /* Would be safer and more simpler to use inet_aton() but it is most
621      * likely not provided either. */
622     uint32_t ipv4;
623
624     if( af != AF_INET )
625     {
626         errno = EAFNOSUPPORT;
627         return -1;
628     }
629
630     ipv4 = inet_addr( src );
631     if( ipv4 == INADDR_NONE )
632         return -1;
633
634     memcpy( dst, &ipv4, 4 );
635 # endif /* WIN32 */
636     return 0;
637 }
638 #endif /* HAVE_INET_PTON */
639
640 #ifndef HAVE_INET_NTOP
641 #ifdef WIN32
642 const char *inet_ntop(int af, const void * src,
643                                char * dst, socklen_t cnt)
644 {
645     switch( af )
646     {
647 #ifdef AF_INET6
648         case AF_INET6:
649             {
650                 struct sockaddr_in6 addr;
651                 memset(&addr, 0, sizeof(addr));
652                 addr.sin6_family = AF_INET6;
653                 addr.sin6_addr = *((struct in6_addr*)src);
654                 if( 0 == WSAAddressToStringA((LPSOCKADDR)&addr, 
655                                              sizeof(struct sockaddr_in6), 
656                                              NULL, dst, &cnt) )
657                 {
658                     dst[cnt] = '\0';
659                     return dst;
660                 }
661                 errno = WSAGetLastError();
662                 return NULL;
663
664             }
665
666 #endif
667         case AF_INET:
668             {
669                 struct sockaddr_in addr;
670                 memset(&addr, 0, sizeof(addr));
671                 addr.sin_family = AF_INET;
672                 addr.sin_addr = *((struct in_addr*)src);
673                 if( 0 == WSAAddressToStringA((LPSOCKADDR)&addr,
674                                              sizeof(struct sockaddr_in),
675                                              NULL, dst, &cnt) )
676                 {
677                     dst[cnt] = '\0';
678                     return dst;
679                 }
680                 errno = WSAGetLastError();
681                 return NULL;
682
683             }
684     }
685     errno = EAFNOSUPPORT;
686     return NULL;
687 }
688 #endif
689 #endif