]> git.sesse.net Git - vlc/blobdiff - src/network/io.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / src / network / io.c
index 65af8f9cd73986a7d8e5bbfe50cedc2a21c95a78..2defe3188b5e3193328b0bc36019c3d21ab88ebb 100644 (file)
  * Preamble
  *****************************************************************************/
 
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
 
 #include <stdlib.h>
 #include <stdio.h>
@@ -40,9 +44,6 @@
 #ifdef HAVE_FCNTL_H
 #   include <fcntl.h>
 #endif
-#ifdef HAVE_SYS_TIME_H
-#    include <sys/time.h>
-#endif
 #ifdef HAVE_UNISTD_H
 #   include <unistd.h>
 #endif
 # define EAFNOSUPPORT WSAEAFNOSUPPORT
 #endif
 
-extern int rootwrap_bind (int family, int socktype, int protocol,
-                          const struct sockaddr *addr, size_t alen);
-
-int net_SetupSocket (int fd)
-{
-#if defined (WIN32) || defined (UNDER_CE)
-    ioctlsocket (fd, FIONBIO, &(unsigned long){ 1 });
-#else
-    fcntl (fd, F_SETFD, FD_CLOEXEC);
-    fcntl (fd, F_SETFL, fcntl (fd, F_GETFL, 0) | O_NONBLOCK);
+#ifdef HAVE_LINUX_DCCP_H
+/* TODO: use glibc instead of linux-kernel headers */
+# include <linux/dccp.h>
+# define SOL_DCCP 269
 #endif
 
-    setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &(int){ 1 }, sizeof (int));
-    return 0;
-}
+#include "libvlc.h" /* vlc_object_waitpipe */
 
+extern int rootwrap_bind (int family, int socktype, int protocol,
+                          const struct sockaddr *addr, size_t alen);
 
 int net_Socket (vlc_object_t *p_this, int family, int socktype,
                 int protocol)
 {
-    int fd = socket (family, socktype, protocol);
+    int fd = vlc_socket (family, socktype, protocol, true);
     if (fd == -1)
     {
         if (net_errno != EAFNOSUPPORT)
@@ -92,7 +87,7 @@ int net_Socket (vlc_object_t *p_this, int family, int socktype,
         return -1;
     }
 
-    net_SetupSocket (fd);
+    setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &(int){ 1 }, sizeof (int));
 
 #ifdef IPV6_V6ONLY
     /*
@@ -114,35 +109,31 @@ int net_Socket (vlc_object_t *p_this, int family, int socktype,
                     &(int){ PROTECTION_LEVEL_UNRESTRICTED }, sizeof (int));
 #endif
 
+#ifdef DCCP_SOCKOPT_SERVICE
+    if (socktype == SOL_DCCP)
+    {
+        char *dccps = var_CreateGetNonEmptyString (p_this, "dccp-service");
+        if (dccps != NULL)
+        {
+            setsockopt (fd, SOL_DCCP, DCCP_SOCKOPT_SERVICE, dccps,
+                        (strlen (dccps) + 3) & ~3);
+            free (dccps);
+        }
+    }
+#endif
+
     return fd;
 }
 
 
 int *net_Listen (vlc_object_t *p_this, const char *psz_host,
-                 int i_port, int protocol)
+                 int i_port, int type, int protocol)
 {
     struct addrinfo hints, *res;
-    int socktype = SOCK_DGRAM;
-
-    switch( protocol )
-    {
-        case IPPROTO_TCP:
-            socktype = SOCK_STREAM;
-            break;
-        case 33: /* DCCP */
-#ifdef __linux__
-# ifndef SOCK_DCCP
-#  define SOCK_DCCP 6
-# endif
-            socktype = SOCK_DCCP;
-#endif
-            break;
-    }
 
     memset (&hints, 0, sizeof( hints ));
-    /* Since we use port numbers rather than service names, the socket type
-     * does not really matter. */
-    hints.ai_socktype = SOCK_DGRAM;
+    hints.ai_socktype = type;
+    hints.ai_protocol = protocol;
     hints.ai_flags = AI_PASSIVE;
 
     msg_Dbg (p_this, "net: listening to %s port %d", psz_host, i_port);
@@ -151,7 +142,7 @@ int *net_Listen (vlc_object_t *p_this, const char *psz_host,
     if (i_val)
     {
         msg_Err (p_this, "Cannot resolve %s port %d : %s", psz_host, i_port,
-                 vlc_gai_strerror (i_val));
+                 gai_strerror (i_val));
         return NULL;
     }
 
@@ -160,7 +151,8 @@ int *net_Listen (vlc_object_t *p_this, const char *psz_host,
 
     for (struct addrinfo *ptr = res; ptr != NULL; ptr = ptr->ai_next)
     {
-        int fd = net_Socket (p_this, ptr->ai_family, socktype, protocol);
+        int fd = net_Socket (p_this, ptr->ai_family, ptr->ai_socktype,
+                             ptr->ai_protocol);
         if (fd == -1)
         {
             msg_Dbg (p_this, "socket error: %m");
@@ -194,8 +186,8 @@ int *net_Listen (vlc_object_t *p_this, const char *psz_host,
             net_Close (fd);
 #if !defined(WIN32) && !defined(UNDER_CE)
             fd = rootwrap_bind (ptr->ai_family, ptr->ai_socktype,
-                                protocol ?: ptr->ai_protocol, ptr->ai_addr,
-                                ptr->ai_addrlen);
+                                ptr->ai_protocol,
+                                ptr->ai_addr, ptr->ai_addrlen);
             if (fd != -1)
             {
                 msg_Dbg (p_this, "got socket %d from rootwrap", fd);
@@ -218,7 +210,7 @@ int *net_Listen (vlc_object_t *p_this, const char *psz_host,
         }
 
         /* Listen */
-        switch (socktype)
+        switch (ptr->ai_socktype)
         {
             case SOCK_STREAM:
             case SOCK_RDM:
@@ -244,7 +236,7 @@ int *net_Listen (vlc_object_t *p_this, const char *psz_host,
             net_Close (fd);
     }
 
-    vlc_freeaddrinfo (res);
+    freeaddrinfo (res);
 
     if (sockv != NULL)
         sockv[sockc] = -1;
@@ -252,49 +244,39 @@ int *net_Listen (vlc_object_t *p_this, const char *psz_host,
     return sockv;
 }
 
-
+#undef net_Read
 /*****************************************************************************
- * __net_Read:
+ * net_Read:
  *****************************************************************************
- * Read from a network socket
+ * Reads from a network socket. Cancellation point.
  * If waitall is true, then we repeat until we have read the right amount of
- * data; in that case, a short count means EOF has been reached.
+ * data; in that case, a short count means EOF has been reached or the VLC
+ * object has been signaled.
  *****************************************************************************/
 ssize_t
-__net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
-            uint8_t *restrict p_buf, size_t i_buflen, vlc_bool_t waitall)
+net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
+          void *restrict p_buf, size_t i_buflen, bool waitall)
 {
     size_t i_total = 0;
-    struct pollfd ufd[1];
-    ufd[0].fd = fd;
-    ufd[0].events = POLLIN;
+    struct pollfd ufd[2] = {
+        { .fd = fd,                           .events = POLLIN },
+        { .fd = vlc_object_waitpipe (p_this), .events = POLLIN },
+    };
 
+    if (ufd[1].fd == -1)
+        return -1; /* vlc_object_waitpipe() sets errno */
 
     while (i_buflen > 0)
     {
-        if( ( p_this->b_die ) || ( p_this->p_libvlc->b_die ) )
-        {
-#if defined(WIN32) || defined(UNDER_CE)
-            WSASetLastError (WSAEINTR);
-#else
-            errno = EINTR;
-#endif
-            goto error;
-        }
+        ufd[0].revents = ufd[1].revents = 0;
 
-        ufd[0].revents = 0;
-        /* TODO: don't use arbitrary timer just for b_die */
-        switch (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), 500))
+        if (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1) < 0)
         {
-            case -1:
+            if (errno != EINTR)
                 goto error;
-
-            case 0: // timeout
-                continue;
+            continue;
         }
 
-        assert (ufd[0].revents);
-
 #ifndef POLLRDHUP /* This is nice but non-portable */
 # define POLLRDHUP 0
 #endif
@@ -304,13 +286,33 @@ __net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
              * otherwise we'd "hide" the error from the caller, which is a
              * bad idea™. */
             if (ufd[0].revents & (POLLERR|POLLNVAL|POLLRDHUP))
-                return i_total;
+                break;
+            if (ufd[1].revents)
+                break;
         }
+        else
+        {
+            if (ufd[1].revents)
+            {
+                assert (p_this->b_die);
+                msg_Dbg (p_this, "socket %d polling interrupted", fd);
+#if defined(WIN32) || defined(UNDER_CE)
+                WSASetLastError (WSAEINTR);
+#else
+                errno = EINTR;
+#endif
+                goto silent;
+            }
+        }
+
+        assert (ufd[0].revents);
 
         ssize_t n;
         if (vs != NULL)
         {
+            int canc = vlc_savecancel ();
             n = vs->pf_recv (vs->p_sys, p_buf, i_buflen);
+            vlc_restorecancel (canc);
         }
         else
         {
@@ -327,6 +329,7 @@ __net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
             switch (WSAGetLastError ())
             {
                 case WSAEWOULDBLOCK:
+                case WSAEINTR:
                 /* only happens with vs != NULL (TLS) - not really an error */
                     continue;
 
@@ -339,16 +342,19 @@ __net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
                                      "Increase the mtu size (--mtu option)");
                     n = i_buflen;
                     break;
-
-                default:
-                    goto error;
             }
 #else
-            /* spurious wake-up or TLS did not yield any actual data */
-            if (errno == EAGAIN)
-                continue;
-            goto error;
+            switch (errno)
+            {
+                case EAGAIN: /* spurious wakeup or no TLS data */
+#if (EAGAIN != EWOULDBLOCK)
+                case EWOULDBLOCK:
+#endif
+                case EINTR:  /* asynchronous signal */
+                    continue;
+            }
 #endif
+            goto error;
         }
 
         if (n == 0)
@@ -361,49 +367,79 @@ __net_Read (vlc_object_t *restrict p_this, int fd, const v_socket_t *vs,
             break; // EOF
 
         i_total += n;
-        p_buf += n;
+        p_buf = (char *)p_buf + n;
         i_buflen -= n;
 
         if (!waitall)
             break;
     }
+
     return i_total;
 
 error:
     msg_Err (p_this, "Read error: %m");
-    return i_total ? (ssize_t)i_total : -1;
+silent:
+    return -1;
 }
 
-
-/* Write exact amount requested */
-ssize_t __net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
-                     const uint8_t *p_data, size_t i_data )
+#undef net_Write
+/**
+ * Writes data to a file descriptor.
+ * This blocks until all data is written or an error occurs.
+ *
+ * This function is a cancellation point if p_vs is NULL.
+ * This function is not cancellation-safe if p_vs is not NULL.
+ *
+ * @return the total number of bytes written, or -1 if an error occurs
+ * before any data is written.
+ */
+ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
+                   const void *restrict p_data, size_t i_data )
 {
     size_t i_total = 0;
+    struct pollfd ufd[2] = {
+        { .fd = fd,                           .events = POLLOUT },
+        { .fd = vlc_object_waitpipe (p_this), .events = POLLIN  },
+    };
+
+    if (unlikely(ufd[1].fd == -1))
+    {
+        vlc_testcancel ();
+        return -1;
+    }
 
     while( i_data > 0 )
     {
-        if( p_this->b_die )
-            break;
+        ssize_t val;
 
-        struct pollfd ufd[1];
-        memset (ufd, 0, sizeof (ufd));
-        ufd[0].fd = fd;
-        ufd[0].events = POLLOUT;
+        ufd[0].revents = ufd[1].revents = 0;
 
-        int val = poll (ufd, 1, 500);
-        switch (val)
+        if (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1) == -1)
         {
-            case -1:
-               msg_Err (p_this, "Write error: %m");
-               goto out;
-
-            case 0:
+            if (errno == EINTR)
                 continue;
+            msg_Err (p_this, "Polling error: %m");
+            return -1;
         }
 
-        if ((ufd[0].revents & (POLLERR|POLLNVAL|POLLHUP)) && (i_total > 0))
-            return i_total; // error will be dequeued separately on next call
+        if (i_total > 0)
+        {   /* If POLLHUP resp. POLLERR|POLLNVAL occurs while we have already
+             * read some data, it is important that we first return the number
+             * of bytes read, and then return 0 resp. -1 on the NEXT call. */
+            if (ufd[0].revents & (POLLHUP|POLLERR|POLLNVAL))
+                break;
+            if (ufd[1].revents) /* VLC object signaled */
+                break;
+        }
+        else
+        {
+            if (ufd[1].revents)
+            {
+                assert (p_this->b_die);
+                errno = EINTR;
+                goto error;
+            }
+        }
 
         if (p_vs != NULL)
             val = p_vs->pf_send (p_vs->p_sys, p_data, i_data);
@@ -416,23 +452,36 @@ ssize_t __net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
 
         if (val == -1)
         {
+            if (errno == EINTR)
+                continue;
             msg_Err (p_this, "Write error: %m");
             break;
         }
 
-        p_data += val;
+        p_data = (const char *)p_data + val;
         i_data -= val;
         i_total += val;
     }
 
-out:
+    if (unlikely(i_data == 0))
+        vlc_testcancel (); /* corner case */
+
     if ((i_total > 0) || (i_data == 0))
         return i_total;
 
+error:
     return -1;
 }
 
-char *__net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
+#undef net_Gets
+/**
+ * Reads a line from a file descriptor.
+ * This function is not thread-safe; the same file descriptor I/O cannot be
+ * read by another thread at the same time (although it can be written to).
+ *
+ * @return nul-terminated heap-allocated string, or NULL on I/O error.
+ */
+char *net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
 {
     char *psz_line = NULL, *ptr = NULL;
     size_t  i_line = 0, i_max = 0;
@@ -443,11 +492,11 @@ char *__net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
         if( i_line == i_max )
         {
             i_max += 1024;
-            psz_line = realloc( psz_line, i_max );
+            psz_line = xrealloc( psz_line, i_max );
             ptr = psz_line + i_line;
         }
 
-        if( net_Read( p_this, fd, p_vs, (uint8_t *)ptr, 1, VLC_TRUE ) != 1 )
+        if( net_Read( p_this, fd, p_vs, ptr, 1, true ) != 1 )
         {
             if( i_line == 0 )
             {
@@ -472,6 +521,7 @@ char *__net_Gets( vlc_object_t *p_this, int fd, const v_socket_t *p_vs )
     return psz_line;
 }
 
+#undef net_Printf
 ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
                     const char *psz_fmt, ... )
 {
@@ -484,134 +534,19 @@ ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
     return i_ret;
 }
 
-ssize_t __net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
-                        const char *psz_fmt, va_list args )
+#undef net_vaPrintf
+ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
+                      const char *psz_fmt, va_list args )
 {
     char    *psz;
-    int     i_size, i_ret;
+    int      i_ret;
 
-    i_size = vasprintf( &psz, psz_fmt, args );
-    i_ret = __net_Write( p_this, fd, p_vs, (uint8_t *)psz, i_size ) < i_size
+    int i_size = vasprintf( &psz, psz_fmt, args );
+    if( i_size == -1 )
+        return -1;
+    i_ret = net_Write( p_this, fd, p_vs, psz, i_size ) < i_size
         ? -1 : i_size;
     free( psz );
 
     return i_ret;
 }
-
-
-/*****************************************************************************
- * inet_pton replacement for obsolete and/or crap operating systems
- *****************************************************************************/
-#ifndef HAVE_INET_PTON
-int inet_pton(int af, const char *src, void *dst)
-{
-# ifdef WIN32
-    /* As we already know, Microsoft always go its own way, so even if they do
-     * provide IPv6, they don't provide the API. */
-    struct sockaddr_storage addr;
-    int len = sizeof( addr );
-
-    /* Damn it, they didn't even put LPCSTR for the firs parameter!!! */
-#ifdef UNICODE
-    wchar_t *workaround_for_ill_designed_api =
-        malloc( MAX_PATH * sizeof(wchar_t) );
-    mbstowcs( workaround_for_ill_designed_api, src, MAX_PATH );
-    workaround_for_ill_designed_api[MAX_PATH-1] = 0;
-#else
-    char *workaround_for_ill_designed_api = strdup( src );
-#endif
-
-    if( !WSAStringToAddress( workaround_for_ill_designed_api, af, NULL,
-                             (LPSOCKADDR)&addr, &len ) )
-    {
-        free( workaround_for_ill_designed_api );
-        return -1;
-    }
-    free( workaround_for_ill_designed_api );
-
-    switch( af )
-    {
-        case AF_INET6:
-            memcpy( dst, &((struct sockaddr_in6 *)&addr)->sin6_addr, 16 );
-            break;
-
-        case AF_INET:
-            memcpy( dst, &((struct sockaddr_in *)&addr)->sin_addr, 4 );
-            break;
-
-        default:
-            WSASetLastError( WSAEAFNOSUPPORT );
-            return -1;
-    }
-# else
-    /* Assume IPv6 is not supported. */
-    /* Would be safer and more simpler to use inet_aton() but it is most
-     * likely not provided either. */
-    uint32_t ipv4;
-
-    if( af != AF_INET )
-    {
-        errno = EAFNOSUPPORT;
-        return -1;
-    }
-
-    ipv4 = inet_addr( src );
-    if( ipv4 == INADDR_NONE )
-        return -1;
-
-    memcpy( dst, &ipv4, 4 );
-# endif /* WIN32 */
-    return 0;
-}
-#endif /* HAVE_INET_PTON */
-
-#ifndef HAVE_INET_NTOP
-#ifdef WIN32
-const char *inet_ntop(int af, const void * src,
-                               char * dst, socklen_t cnt)
-{
-    switch( af )
-    {
-#ifdef AF_INET6
-        case AF_INET6:
-            {
-                struct sockaddr_in6 addr;
-                memset(&addr, 0, sizeof(addr));
-                addr.sin6_family = AF_INET6;
-                addr.sin6_addr = *((struct in6_addr*)src);
-                if( 0 == WSAAddressToStringA((LPSOCKADDR)&addr,
-                                             sizeof(struct sockaddr_in6),
-                                             NULL, dst, &cnt) )
-                {
-                    dst[cnt] = '\0';
-                    return dst;
-                }
-                errno = WSAGetLastError();
-                return NULL;
-
-            }
-
-#endif
-        case AF_INET:
-            {
-                struct sockaddr_in addr;
-                memset(&addr, 0, sizeof(addr));
-                addr.sin_family = AF_INET;
-                addr.sin_addr = *((struct in_addr*)src);
-                if( 0 == WSAAddressToStringA((LPSOCKADDR)&addr,
-                                             sizeof(struct sockaddr_in),
-                                             NULL, dst, &cnt) )
-                {
-                    dst[cnt] = '\0';
-                    return dst;
-                }
-                errno = WSAGetLastError();
-                return NULL;
-
-            }
-    }
-    errno = EAFNOSUPPORT;
-    return NULL;
-}
-#endif
-#endif