Use the event pipe in net_Read instead of an arbitrary timer
[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: %m");
92         return -1;
93     }
94
95     net_SetupSocket (fd);
96
97 #ifdef IPV6_V6ONLY
98     /*
99      * Accepts only IPv6 connections on IPv6 sockets.
100      * If possible, we should open two sockets, but it is not always possible.
101      */
102     if (family == AF_INET6)
103         setsockopt (fd, IPPROTO_IPV6, IPV6_V6ONLY, &(int){ 1 }, sizeof (int));
104 #endif
105
106 #if defined (WIN32) || defined (UNDER_CE)
107 # ifndef IPV6_PROTECTION_LEVEL
108 #  warning Please update your C library headers.
109 #  define IPV6_PROTECTION_LEVEL 23
110 #  define PROTECTION_LEVEL_UNRESTRICTED 10
111 # endif
112     if (family == AF_INET6)
113         setsockopt (fd, IPPROTO_IPV6, IPV6_PROTECTION_LEVEL,
114                     &(int){ PROTECTION_LEVEL_UNRESTRICTED }, sizeof (int));
115 #endif
116
117     return fd;
118 }
119
120
121 int *net_Listen (vlc_object_t *p_this, const char *psz_host,
122                  int i_port, int protocol)
123 {
124     struct addrinfo hints, *res;
125     int socktype = SOCK_DGRAM;
126
127     switch( protocol )
128     {
129         case IPPROTO_TCP:
130             socktype = SOCK_STREAM;
131             break;
132         case 33: /* DCCP */
133 #ifdef __linux__
134 # ifndef SOCK_DCCP
135 #  define SOCK_DCCP 6
136 # endif
137             socktype = SOCK_DCCP;
138 #endif
139             break;
140     }
141
142     memset (&hints, 0, sizeof( hints ));
143     /* Since we use port numbers rather than service names, the socket type
144      * does not really matter. */
145     hints.ai_socktype = SOCK_DGRAM;
146     hints.ai_flags = AI_PASSIVE;
147
148     msg_Dbg (p_this, "net: listening to %s port %d", psz_host, i_port);
149
150     int i_val = vlc_getaddrinfo (p_this, psz_host, i_port, &hints, &res);
151     if (i_val)
152     {
153         msg_Err (p_this, "Cannot resolve %s port %d : %s", psz_host, i_port,
154                  vlc_gai_strerror (i_val));
155         return NULL;
156     }
157
158     int *sockv = NULL;
159     unsigned sockc = 0;
160
161     for (struct addrinfo *ptr = res; ptr != NULL; ptr = ptr->ai_next)
162     {
163         int fd = net_Socket (p_this, ptr->ai_family, socktype, protocol);
164         if (fd == -1)
165         {
166             msg_Dbg (p_this, "socket error: %m");
167             continue;
168         }
169
170         /* Bind the socket */
171 #if defined (WIN32) || defined (UNDER_CE)
172         /*
173          * Under Win32 and for multicasting, we bind to INADDR_ANY.
174          * This is of course a severe bug, since the socket would logically
175          * receive unicast traffic, and multicast traffic of groups subscribed
176          * to via other sockets.
177          */
178         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen)
179          && (sizeof (struct sockaddr_storage) >= ptr->ai_addrlen))
180         {
181             // This works for IPv4 too - don't worry!
182             struct sockaddr_in6 dumb =
183             {
184                 .sin6_family = ptr->ai_addr->sa_family,
185                 .sin6_port =  ((struct sockaddr_in *)(ptr->ai_addr))->sin_port
186             };
187
188             bind (fd, (struct sockaddr *)&dumb, ptr->ai_addrlen);
189         }
190         else
191 #endif
192         if (bind (fd, ptr->ai_addr, ptr->ai_addrlen))
193         {
194             net_Close (fd);
195 #if !defined(WIN32) && !defined(UNDER_CE)
196             fd = rootwrap_bind (ptr->ai_family, ptr->ai_socktype,
197                                 protocol ?: ptr->ai_protocol, ptr->ai_addr,
198                                 ptr->ai_addrlen);
199             if (fd != -1)
200             {
201                 msg_Dbg (p_this, "got socket %d from rootwrap", fd);
202             }
203             else
204 #endif
205             {
206                 msg_Err (p_this, "socket bind error (%m)");
207                 continue;
208             }
209         }
210
211         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen))
212         {
213             if (net_Subscribe (p_this, fd, ptr->ai_addr, ptr->ai_addrlen))
214             {
215                 net_Close (fd);
216                 continue;
217             }
218         }
219
220         /* Listen */
221         switch (socktype)
222         {
223             case SOCK_STREAM:
224             case SOCK_RDM:
225             case SOCK_SEQPACKET:
226 #ifdef SOCK_DCCP
227             case SOCK_DCCP:
228 #endif
229                 if (listen (fd, INT_MAX))
230                 {
231                     msg_Err (p_this, "socket listen error (%m)");
232                     net_Close (fd);
233                     continue;
234                 }
235         }
236
237         int *nsockv = (int *)realloc (sockv, (sockc + 2) * sizeof (int));
238         if (nsockv != NULL)
239         {
240             nsockv[sockc++] = fd;
241             sockv = nsockv;
242         }
243         else
244             net_Close (fd);
245     }
246
247     vlc_freeaddrinfo (res);
248
249     if (sockv != NULL)
250         sockv[sockc] = -1;
251
252     return sockv;
253 }
254
255
256 /*****************************************************************************
257  * __net_Read:
258  *****************************************************************************
259  * Reads from a network socket.
260  * If waitall is true, then we repeat until we have read the right amount of
261  * data; in that case, a short count means EOF has been reached.
262  *****************************************************************************/
263 ssize_t
264 __net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
265             uint8_t *restrict p_buf, size_t i_buflen, vlc_bool_t waitall)
266 {
267     size_t i_total = 0;
268     struct pollfd ufd[2] = {
269         { .fd = fd, .events = POLLIN },
270         { .fd = -1, .events = POLLIN },
271     };
272
273     msg_Dbg (p_this, "reading socket %d", fd);
274     vlc_object_lock (p_this);
275     ufd[1].fd = vlc_object_waitpipe (p_this);
276
277     while (i_buflen > 0)
278     {
279         int val;
280
281         if (!vlc_object_alive (p_this))
282         {
283 #if defined(WIN32) || defined(UNDER_CE)
284             WSASetLastError (WSAEINTR);
285 #else
286             errno = EINTR;
287 #endif
288             goto error;
289         }
290         ufd[0].revents = ufd[1].revents = 0;
291
292         vlc_object_unlock (p_this);
293         val = poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1);
294         vlc_object_lock (p_this);
295
296         if (val < 0)
297             goto error;
298
299         if (ufd[1].revents)
300         {
301             msg_Dbg (p_this, "socket %d polling interrupted", fd);
302             vlc_object_wait (p_this);
303             msg_Dbg (p_this, "socket %d polling restarting", fd);
304             continue;
305         }
306
307         assert (ufd[0].revents);
308
309 #ifndef POLLRDHUP /* This is nice but non-portable */
310 # define POLLRDHUP 0
311 #endif
312         if (i_total > 0)
313         {
314             /* Errors (-1) and EOF (0) will be returned on next call,
315              * otherwise we'd "hide" the error from the caller, which is a
316              * bad idea™. */
317             if (ufd[0].revents & (POLLERR|POLLNVAL|POLLRDHUP))
318                 break;
319         }
320
321         ssize_t n;
322         if (vs != NULL)
323         {
324             n = vs->pf_recv (vs->p_sys, p_buf, i_buflen);
325         }
326         else
327         {
328 #ifdef WIN32
329             n = recv (fd, p_buf, i_buflen, 0);
330 #else
331             n = read (fd, p_buf, i_buflen);
332 #endif
333         }
334
335         if (n == -1)
336         {
337 #if defined(WIN32) || defined(UNDER_CE)
338             switch (WSAGetLastError ())
339             {
340                 case WSAEWOULDBLOCK:
341                 /* only happens with vs != NULL (TLS) - not really an error */
342                     continue;
343
344                 case WSAEMSGSIZE:
345                 /* For UDP only */
346                 /* On Win32, recv() fails if the datagram doesn't fit inside
347                  * the passed buffer, even though the buffer will be filled
348                  * with the first part of the datagram. */
349                     msg_Err (p_this, "Receive error: "
350                                      "Increase the mtu size (--mtu option)");
351                     n = i_buflen;
352                     break;
353
354                 default:
355                     goto error;
356             }
357 #else
358             /* spurious wake-up or TLS did not yield any actual data */
359             if (errno == EAGAIN)
360                 continue;
361             goto error;
362 #endif
363         }
364
365         if (n == 0)
366             /* For streams, this means end of file, and there will not be any
367              * further data ever on the stream. For datagram sockets, this
368              * means empty datagram, and there could be more data coming.
369              * However, it makes no sense to set <waitall> with datagrams in the
370              * first place.
371              */
372             break; // EOF
373
374         i_total += n;
375         p_buf += n;
376         i_buflen -= n;
377
378         if (!waitall)
379             break;
380     }
381
382     vlc_object_unlock (p_this);
383     msg_Dbg (p_this, "read %u bytes from socket %d", (unsigned)i_total, fd);
384     return i_total;
385
386 error:
387     msg_Err (p_this, "Read error: %m");
388
389     vlc_object_unlock (p_this);
390     return -1;
391 }
392
393
394 /* Write exact amount requested */
395 ssize_t __net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
396                      const uint8_t *p_data, size_t i_data )
397 {
398     size_t i_total = 0;
399
400     while( i_data > 0 )
401     {
402         if( p_this->b_die )
403             break;
404
405         struct pollfd ufd[1];
406         memset (ufd, 0, sizeof (ufd));
407         ufd[0].fd = fd;
408         ufd[0].events = POLLOUT;
409
410         int val = poll (ufd, 1, 500);
411         switch (val)
412         {
413             case -1:
414                msg_Err (p_this, "Write error: %m");
415                goto out;
416
417             case 0:
418                 continue;
419         }
420
421         if ((ufd[0].revents & (POLLERR|POLLNVAL|POLLHUP)) && (i_total > 0))
422             return i_total; // error will be dequeued separately on next call
423
424         if (p_vs != NULL)
425             val = p_vs->pf_send (p_vs->p_sys, p_data, i_data);
426         else
427 #ifdef WIN32
428             val = send (fd, p_data, i_data, 0);
429 #else
430             val = write (fd, p_data, i_data);
431 #endif
432
433         if (val == -1)
434         {
435             msg_Err (p_this, "Write error: %m");
436             break;
437         }
438
439         p_data += val;
440         i_data -= val;
441         i_total += val;
442     }
443
444 out:
445     if ((i_total > 0) || (i_data == 0))
446         return i_total;
447
448     return -1;
449 }
450
451 char *__net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
452 {
453     char *psz_line = NULL, *ptr = NULL;
454     size_t  i_line = 0, i_max = 0;
455
456
457     for( ;; )
458     {
459         if( i_line == i_max )
460         {
461             i_max += 1024;
462             psz_line = realloc( psz_line, i_max );
463             ptr = psz_line + i_line;
464         }
465
466         if( net_Read( p_this, fd, p_vs, (uint8_t *)ptr, 1, VLC_TRUE ) != 1 )
467         {
468             if( i_line == 0 )
469             {
470                 free( psz_line );
471                 return NULL;
472             }
473             break;
474         }
475
476         if ( *ptr == '\n' )
477             break;
478
479         i_line++;
480         ptr++;
481     }
482
483     *ptr-- = '\0';
484
485     if( ( ptr >= psz_line ) && ( *ptr == '\r' ) )
486         *ptr = '\0';
487
488     return psz_line;
489 }
490
491 ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
492                     const char *psz_fmt, ... )
493 {
494     int i_ret;
495     va_list args;
496     va_start( args, psz_fmt );
497     i_ret = net_vaPrintf( p_this, fd, p_vs, psz_fmt, args );
498     va_end( args );
499
500     return i_ret;
501 }
502
503 ssize_t __net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
504                         const char *psz_fmt, va_list args )
505 {
506     char    *psz;
507     int     i_size, i_ret;
508
509     i_size = vasprintf( &psz, psz_fmt, args );
510     i_ret = __net_Write( p_this, fd, p_vs, (uint8_t *)psz, i_size ) < i_size
511         ? -1 : i_size;
512     free( psz );
513
514     return i_ret;
515 }
516
517
518 /*****************************************************************************
519  * inet_pton replacement for obsolete and/or crap operating systems
520  *****************************************************************************/
521 #ifndef HAVE_INET_PTON
522 int inet_pton(int af, const char *src, void *dst)
523 {
524 # ifdef WIN32
525     /* As we already know, Microsoft always go its own way, so even if they do
526      * provide IPv6, they don't provide the API. */
527     struct sockaddr_storage addr;
528     int len = sizeof( addr );
529
530     /* Damn it, they didn't even put LPCSTR for the firs parameter!!! */
531 #ifdef UNICODE
532     wchar_t *workaround_for_ill_designed_api =
533         malloc( MAX_PATH * sizeof(wchar_t) );
534     mbstowcs( workaround_for_ill_designed_api, src, MAX_PATH );
535     workaround_for_ill_designed_api[MAX_PATH-1] = 0;
536 #else
537     char *workaround_for_ill_designed_api = strdup( src );
538 #endif
539
540     if( !WSAStringToAddress( workaround_for_ill_designed_api, af, NULL,
541                              (LPSOCKADDR)&addr, &len ) )
542     {
543         free( workaround_for_ill_designed_api );
544         return -1;
545     }
546     free( workaround_for_ill_designed_api );
547
548     switch( af )
549     {
550         case AF_INET6:
551             memcpy( dst, &((struct sockaddr_in6 *)&addr)->sin6_addr, 16 );
552             break;
553
554         case AF_INET:
555             memcpy( dst, &((struct sockaddr_in *)&addr)->sin_addr, 4 );
556             break;
557
558         default:
559             WSASetLastError( WSAEAFNOSUPPORT );
560             return -1;
561     }
562 # else
563     /* Assume IPv6 is not supported. */
564     /* Would be safer and more simpler to use inet_aton() but it is most
565      * likely not provided either. */
566     uint32_t ipv4;
567
568     if( af != AF_INET )
569     {
570         errno = EAFNOSUPPORT;
571         return -1;
572     }
573
574     ipv4 = inet_addr( src );
575     if( ipv4 == INADDR_NONE )
576         return -1;
577
578     memcpy( dst, &ipv4, 4 );
579 # endif /* WIN32 */
580     return 0;
581 }
582 #endif /* HAVE_INET_PTON */
583
584 #ifndef HAVE_INET_NTOP
585 #ifdef WIN32
586 const char *inet_ntop(int af, const void * src,
587                                char * dst, socklen_t cnt)
588 {
589     switch( af )
590     {
591 #ifdef AF_INET6
592         case AF_INET6:
593             {
594                 struct sockaddr_in6 addr;
595                 memset(&addr, 0, sizeof(addr));
596                 addr.sin6_family = AF_INET6;
597                 addr.sin6_addr = *((struct in6_addr*)src);
598                 if( 0 == WSAAddressToStringA((LPSOCKADDR)&addr,
599                                              sizeof(struct sockaddr_in6),
600                                              NULL, dst, &cnt) )
601                 {
602                     dst[cnt] = '\0';
603                     return dst;
604                 }
605                 errno = WSAGetLastError();
606                 return NULL;
607
608             }
609
610 #endif
611         case AF_INET:
612             {
613                 struct sockaddr_in addr;
614                 memset(&addr, 0, sizeof(addr));
615                 addr.sin_family = AF_INET;
616                 addr.sin_addr = *((struct in_addr*)src);
617                 if( 0 == WSAAddressToStringA((LPSOCKADDR)&addr,
618                                              sizeof(struct sockaddr_in),
619                                              NULL, dst, &cnt) )
620                 {
621                     dst[cnt] = '\0';
622                     return dst;
623                 }
624                 errno = WSAGetLastError();
625                 return NULL;
626
627             }
628     }
629     errno = EAFNOSUPPORT;
630     return NULL;
631 }
632 #endif
633 #endif