]> git.sesse.net Git - vlc/blob - src/network/io.c
Twolame: fix copyright header, and remove unnecessary includes
[vlc] / 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 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <vlc_common.h>
36
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <limits.h>
40
41 #include <errno.h>
42 #include <assert.h>
43
44 #ifdef HAVE_FCNTL_H
45 #   include <fcntl.h>
46 #endif
47 #ifdef HAVE_UNISTD_H
48 #   include <unistd.h>
49 #endif
50 #ifdef HAVE_POLL
51 #   include <poll.h>
52 #endif
53
54 #include <vlc_network.h>
55
56 #ifndef INADDR_ANY
57 #   define INADDR_ANY  0x00000000
58 #endif
59 #ifndef INADDR_NONE
60 #   define INADDR_NONE 0xFFFFFFFF
61 #endif
62
63 #if defined(WIN32) || defined(UNDER_CE)
64 # undef EAFNOSUPPORT
65 # define EAFNOSUPPORT WSAEAFNOSUPPORT
66 #endif
67
68 #ifdef HAVE_LINUX_DCCP_H
69 /* TODO: use glibc instead of linux-kernel headers */
70 # include <linux/dccp.h>
71 # define SOL_DCCP 269
72 #endif
73
74 #include "libvlc.h" /* vlc_object_waitpipe */
75
76 extern int rootwrap_bind (int family, int socktype, int protocol,
77                           const struct sockaddr *addr, size_t alen);
78
79 int net_Socket (vlc_object_t *p_this, int family, int socktype,
80                 int protocol)
81 {
82     int fd = vlc_socket (family, socktype, protocol, true);
83     if (fd == -1)
84     {
85         if (net_errno != EAFNOSUPPORT)
86             msg_Err (p_this, "cannot create socket: %m");
87         return -1;
88     }
89
90     setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &(int){ 1 }, sizeof (int));
91
92 #ifdef IPV6_V6ONLY
93     /*
94      * Accepts only IPv6 connections on IPv6 sockets.
95      * If possible, we should open two sockets, but it is not always possible.
96      */
97     if (family == AF_INET6)
98         setsockopt (fd, IPPROTO_IPV6, IPV6_V6ONLY, &(int){ 1 }, sizeof (int));
99 #endif
100
101 #if defined (WIN32) || defined (UNDER_CE)
102 # ifndef IPV6_PROTECTION_LEVEL
103 #  warning Please update your C library headers.
104 #  define IPV6_PROTECTION_LEVEL 23
105 #  define PROTECTION_LEVEL_UNRESTRICTED 10
106 # endif
107     if (family == AF_INET6)
108         setsockopt (fd, IPPROTO_IPV6, IPV6_PROTECTION_LEVEL,
109                     &(int){ PROTECTION_LEVEL_UNRESTRICTED }, sizeof (int));
110 #endif
111
112 #ifdef DCCP_SOCKOPT_SERVICE
113     if (socktype == SOL_DCCP)
114     {
115         char *dccps = var_InheritString (p_this, "dccp-service");
116         if (dccps != NULL)
117         {
118             setsockopt (fd, SOL_DCCP, DCCP_SOCKOPT_SERVICE, dccps,
119                         (strlen (dccps) + 3) & ~3);
120             free (dccps);
121         }
122     }
123 #endif
124
125     return fd;
126 }
127
128
129 int *net_Listen (vlc_object_t *p_this, const char *psz_host,
130                  int i_port, int type, int protocol)
131 {
132     struct addrinfo hints, *res;
133
134     memset (&hints, 0, sizeof( hints ));
135     hints.ai_socktype = type;
136     hints.ai_protocol = protocol;
137     hints.ai_flags = AI_PASSIVE;
138
139     msg_Dbg (p_this, "net: listening to %s port %d",
140              (psz_host != NULL) ? psz_host : "*", i_port);
141
142     int i_val = vlc_getaddrinfo (p_this, psz_host, i_port, &hints, &res);
143     if (i_val)
144     {
145         msg_Err (p_this, "Cannot resolve %s port %d : %s",
146                  (psz_host != NULL) ? psz_host : "", i_port,
147                  gai_strerror (i_val));
148         return NULL;
149     }
150
151     int *sockv = NULL;
152     unsigned sockc = 0;
153
154     for (struct addrinfo *ptr = res; ptr != NULL; ptr = ptr->ai_next)
155     {
156         int fd = net_Socket (p_this, ptr->ai_family, ptr->ai_socktype,
157                              ptr->ai_protocol);
158         if (fd == -1)
159         {
160             msg_Dbg (p_this, "socket error: %m");
161             continue;
162         }
163
164         /* Bind the socket */
165 #if defined (WIN32) || defined (UNDER_CE)
166         /*
167          * Under Win32 and for multicasting, we bind to INADDR_ANY.
168          * This is of course a severe bug, since the socket would logically
169          * receive unicast traffic, and multicast traffic of groups subscribed
170          * to via other sockets.
171          */
172         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen)
173          && (sizeof (struct sockaddr_storage) >= ptr->ai_addrlen))
174         {
175             // This works for IPv4 too - don't worry!
176             struct sockaddr_in6 dumb =
177             {
178                 .sin6_family = ptr->ai_addr->sa_family,
179                 .sin6_port =  ((struct sockaddr_in *)(ptr->ai_addr))->sin_port
180             };
181
182             bind (fd, (struct sockaddr *)&dumb, ptr->ai_addrlen);
183         }
184         else
185 #endif
186         if (bind (fd, ptr->ai_addr, ptr->ai_addrlen))
187         {
188             net_Close (fd);
189 #if !defined(WIN32) && !defined(UNDER_CE)
190             fd = rootwrap_bind (ptr->ai_family, ptr->ai_socktype,
191                                 ptr->ai_protocol,
192                                 ptr->ai_addr, ptr->ai_addrlen);
193             if (fd != -1)
194             {
195                 msg_Dbg (p_this, "got socket %d from rootwrap", fd);
196             }
197             else
198 #endif
199             {
200                 msg_Err (p_this, "socket bind error (%m)");
201                 continue;
202             }
203         }
204
205         if (net_SockAddrIsMulticast (ptr->ai_addr, ptr->ai_addrlen))
206         {
207             if (net_Subscribe (p_this, fd, ptr->ai_addr, ptr->ai_addrlen))
208             {
209                 net_Close (fd);
210                 continue;
211             }
212         }
213
214         /* Listen */
215         switch (ptr->ai_socktype)
216         {
217             case SOCK_STREAM:
218             case SOCK_RDM:
219             case SOCK_SEQPACKET:
220 #ifdef SOCK_DCCP
221             case SOCK_DCCP:
222 #endif
223                 if (listen (fd, INT_MAX))
224                 {
225                     msg_Err (p_this, "socket listen error (%m)");
226                     net_Close (fd);
227                     continue;
228                 }
229         }
230
231         int *nsockv = (int *)realloc (sockv, (sockc + 2) * sizeof (int));
232         if (nsockv != NULL)
233         {
234             nsockv[sockc++] = fd;
235             sockv = nsockv;
236         }
237         else
238             net_Close (fd);
239     }
240
241     freeaddrinfo (res);
242
243     if (sockv != NULL)
244         sockv[sockc] = -1;
245
246     return sockv;
247 }
248
249 #undef net_Read
250 /*****************************************************************************
251  * net_Read:
252  *****************************************************************************
253  * Reads from a network socket. Cancellation point.
254  * If waitall is true, then we repeat until we have read the right amount of
255  * data; in that case, a short count means EOF has been reached or the VLC
256  * object has been signaled.
257  *****************************************************************************/
258 ssize_t
259 net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
260           void *restrict p_buf, size_t i_buflen, bool waitall)
261 {
262     size_t i_total = 0;
263     struct pollfd ufd[2] = {
264         { .fd = fd,                           .events = POLLIN },
265         { .fd = vlc_object_waitpipe (p_this), .events = POLLIN },
266     };
267
268     if (ufd[1].fd == -1)
269         return -1; /* vlc_object_waitpipe() sets errno */
270
271     while (i_buflen > 0)
272     {
273         ufd[0].revents = ufd[1].revents = 0;
274
275         if (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1) < 0)
276         {
277             if (errno != EINTR)
278                 goto error;
279             continue;
280         }
281
282 #ifndef POLLRDHUP /* This is nice but non-portable */
283 # define POLLRDHUP 0
284 #endif
285         if (i_total > 0)
286         {
287             /* Errors (-1) and EOF (0) will be returned on next call,
288              * otherwise we'd "hide" the error from the caller, which is a
289              * bad idea™. */
290             if (ufd[0].revents & (POLLERR|POLLNVAL|POLLRDHUP))
291                 break;
292             if (ufd[1].revents)
293                 break;
294         }
295         else
296         {
297             if (ufd[1].revents)
298             {
299                 assert (p_this->b_die);
300                 msg_Dbg (p_this, "socket %d polling interrupted", fd);
301 #if defined(WIN32) || defined(UNDER_CE)
302                 WSASetLastError (WSAEINTR);
303 #else
304                 errno = EINTR;
305 #endif
306                 goto silent;
307             }
308         }
309
310         assert (ufd[0].revents);
311
312         ssize_t n;
313         if (vs != NULL)
314         {
315             int canc = vlc_savecancel ();
316             n = vs->pf_recv (vs->p_sys, p_buf, i_buflen);
317             vlc_restorecancel (canc);
318         }
319         else
320         {
321 #ifdef WIN32
322             n = recv (fd, p_buf, i_buflen, 0);
323 #else
324             n = read (fd, p_buf, i_buflen);
325 #endif
326         }
327
328         if (n == -1)
329         {
330 #if defined(WIN32) || defined(UNDER_CE)
331             switch (WSAGetLastError ())
332             {
333                 case WSAEWOULDBLOCK:
334                 case WSAEINTR:
335                 /* only happens with vs != NULL (TLS) - not really an error */
336                     continue;
337
338                 case WSAEMSGSIZE:
339                 /* For UDP only */
340                 /* On Win32, recv() fails if the datagram doesn't fit inside
341                  * the passed buffer, even though the buffer will be filled
342                  * with the first part of the datagram. */
343                     msg_Err (p_this, "Receive error: "
344                                      "Increase the mtu size (--mtu option)");
345                     n = i_buflen;
346                     break;
347             }
348 #else
349             switch (errno)
350             {
351                 case EAGAIN: /* spurious wakeup or no TLS data */
352 #if (EAGAIN != EWOULDBLOCK)
353                 case EWOULDBLOCK:
354 #endif
355                 case EINTR:  /* asynchronous signal */
356                     continue;
357             }
358 #endif
359             goto error;
360         }
361
362         if (n == 0)
363             /* For streams, this means end of file, and there will not be any
364              * further data ever on the stream. For datagram sockets, this
365              * means empty datagram, and there could be more data coming.
366              * However, it makes no sense to set <waitall> with datagrams in the
367              * first place.
368              */
369             break; // EOF
370
371         i_total += n;
372         p_buf = (char *)p_buf + n;
373         i_buflen -= n;
374
375         if (!waitall)
376             break;
377     }
378
379     return i_total;
380
381 error:
382     msg_Err (p_this, "Read error: %m");
383 silent:
384     return -1;
385 }
386
387 #undef net_Write
388 /**
389  * Writes data to a file descriptor.
390  * This blocks until all data is written or an error occurs.
391  *
392  * This function is a cancellation point if p_vs is NULL.
393  * This function is not cancellation-safe if p_vs is not NULL.
394  *
395  * @return the total number of bytes written, or -1 if an error occurs
396  * before any data is written.
397  */
398 ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
399                    const void *restrict p_data, size_t i_data )
400 {
401     size_t i_total = 0;
402     struct pollfd ufd[2] = {
403         { .fd = fd,                           .events = POLLOUT },
404         { .fd = vlc_object_waitpipe (p_this), .events = POLLIN  },
405     };
406
407     if (unlikely(ufd[1].fd == -1))
408     {
409         vlc_testcancel ();
410         return -1;
411     }
412
413     while( i_data > 0 )
414     {
415         ssize_t val;
416
417         ufd[0].revents = ufd[1].revents = 0;
418
419         if (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1) == -1)
420         {
421             if (errno == EINTR)
422                 continue;
423             msg_Err (p_this, "Polling error: %m");
424             return -1;
425         }
426
427         if (i_total > 0)
428         {   /* If POLLHUP resp. POLLERR|POLLNVAL occurs while we have already
429              * read some data, it is important that we first return the number
430              * of bytes read, and then return 0 resp. -1 on the NEXT call. */
431             if (ufd[0].revents & (POLLHUP|POLLERR|POLLNVAL))
432                 break;
433             if (ufd[1].revents) /* VLC object signaled */
434                 break;
435         }
436         else
437         {
438             if (ufd[1].revents)
439             {
440                 assert (p_this->b_die);
441                 errno = EINTR;
442                 goto error;
443             }
444         }
445
446         if (p_vs != NULL)
447             val = p_vs->pf_send (p_vs->p_sys, p_data, i_data);
448         else
449 #ifdef WIN32
450             val = send (fd, p_data, i_data, 0);
451 #else
452             val = write (fd, p_data, i_data);
453 #endif
454
455         if (val == -1)
456         {
457             if (errno == EINTR)
458                 continue;
459             msg_Err (p_this, "Write error: %m");
460             break;
461         }
462
463         p_data = (const char *)p_data + val;
464         i_data -= val;
465         i_total += val;
466     }
467
468     if (unlikely(i_data == 0))
469         vlc_testcancel (); /* corner case */
470
471     if ((i_total > 0) || (i_data == 0))
472         return i_total;
473
474 error:
475     return -1;
476 }
477
478 #undef net_Gets
479 /**
480  * Reads a line from a file descriptor.
481  * This function is not thread-safe; the same file descriptor I/O cannot be
482  * read by another thread at the same time (although it can be written to).
483  *
484  * @return nul-terminated heap-allocated string, or NULL on I/O error.
485  */
486 char *net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
487 {
488     char *psz_line = NULL, *ptr = NULL;
489     size_t  i_line = 0, i_max = 0;
490
491
492     for( ;; )
493     {
494         if( i_line == i_max )
495         {
496             i_max += 1024;
497             psz_line = xrealloc( psz_line, i_max );
498             ptr = psz_line + i_line;
499         }
500
501         if( net_Read( p_this, fd, p_vs, ptr, 1, true ) != 1 )
502         {
503             if( i_line == 0 )
504             {
505                 free( psz_line );
506                 return NULL;
507             }
508             break;
509         }
510
511         if ( *ptr == '\n' )
512             break;
513
514         i_line++;
515         ptr++;
516     }
517
518     *ptr-- = '\0';
519
520     if( ( ptr >= psz_line ) && ( *ptr == '\r' ) )
521         *ptr = '\0';
522
523     return psz_line;
524 }
525
526 #undef net_Printf
527 ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
528                     const char *psz_fmt, ... )
529 {
530     int i_ret;
531     va_list args;
532     va_start( args, psz_fmt );
533     i_ret = net_vaPrintf( p_this, fd, p_vs, psz_fmt, args );
534     va_end( args );
535
536     return i_ret;
537 }
538
539 #undef net_vaPrintf
540 ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
541                       const char *psz_fmt, va_list args )
542 {
543     char    *psz;
544     int      i_ret;
545
546     int i_size = vasprintf( &psz, psz_fmt, args );
547     if( i_size == -1 )
548         return -1;
549     i_ret = net_Write( p_this, fd, p_vs, psz, i_size ) < i_size
550         ? -1 : i_size;
551     free( psz );
552
553     return i_ret;
554 }