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