git.sesse.net Git - vlc/blob - src/network/io.c

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