]> git.sesse.net Git - vlc/blobdiff - modules/services_discovery/sap.c
Fix a memory leak
[vlc] / modules / services_discovery / sap.c
index 0866b99a02e79821f7429b6e6dfd7f945df40fbc..317f02afd9d3e6b84ec27db0bfa19d88ed843685 100644 (file)
 /*****************************************************************************
  * Includes
  *****************************************************************************/
-#define _GNU_SOURCE
-#include <stdlib.h>                                      /* malloc(), free() */
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
 
 #include <vlc/vlc.h>
+#include <assert.h>
+
 #include <vlc_playlist.h>
 #include <vlc_demux.h>
 
 #ifdef HAVE_SYS_TIME_H
 #    include <sys/time.h>
 #endif
+#ifdef HAVE_POLL
+# include <poll.h>
+#endif
 
 #ifdef HAVE_ZLIB_H
 #   include <zlib.h>
 #endif
 
+#ifndef WIN32
+#   include <net/if.h>
+#endif
+
 /************************************************************************
  * Macros and definitions
  ************************************************************************/
 #define SAP_V4_LINK_ADDRESS     "224.0.0.255"
 #define ADD_SESSION 1
 
-#define SAP_V6_1 "FF0"
-/* Scope is inserted between them */
-#define SAP_V6_2 "::2:7FFE"
-/* See RFC3513 for list of valid scopes */
-/* FIXME: find a way to listen to link-local scope */
-static const char ipv6_scopes[] = "1456789ABCDE";
-
-
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
@@ -85,12 +87,10 @@ static const char ipv6_scopes[] = "1456789ABCDE";
                               "can specify a specific address." )
 #define SAP_IPV4_TEXT N_( "IPv4 SAP" )
 #define SAP_IPV4_LONGTEXT N_( \
-      "Listen to IPv4 announcements " \
-      "on the standard address." )
+      "Listen to IPv4 announcements on the standard addresses." )
 #define SAP_IPV6_TEXT N_( "IPv6 SAP" )
 #define SAP_IPV6_LONGTEXT N_( \
-      "Listen to IPv6 announcements " \
-      "on the standard addresses." )
+      "Listen to IPv6 announcements on the standard addresses." )
 #define SAP_SCOPE_TEXT N_( "IPv6 SAP scope" )
 #define SAP_SCOPE_LONGTEXT N_( \
        "Scope for IPv6 announcements (default is 8)." )
@@ -151,7 +151,7 @@ vlc_module_begin();
     set_callbacks( Open, Close );
 
     add_submodule();
-        set_description( _("SDP file parser for UDP") );
+        set_description( _("SDP Descriptions parser") );
         add_shortcut( "sdp" );
         set_capability( "demux2", 51 );
         set_callbacks( OpenDemux, CloseDemux );
@@ -217,6 +217,8 @@ struct attribute_t
 struct sap_announce_t
 {
     mtime_t i_last;
+    mtime_t i_period;
+    uint8_t i_period_trust;
 
     uint16_t    i_hash;
     uint32_t    i_source[4];
@@ -225,8 +227,6 @@ struct sap_announce_t
     sdp_t       *p_sdp;
 
     int i_input_id;
-    int i_item_id_cat;
-    int i_item_id_one;
 };
 
 struct services_discovery_sys_t
@@ -235,10 +235,6 @@ struct services_discovery_sys_t
     int i_fd;
     int *pi_fd;
 
-    /* playlist node */
-    playlist_item_t *p_node_cat;
-    playlist_item_t *p_node_one;
-
     /* Table of announces */
     int i_announces;
     struct sap_announce_t **pp_announces;
@@ -285,6 +281,11 @@ struct demux_sys_t
     static int Decompress( const unsigned char *psz_src, unsigned char **_dst, int i_len );
     static void FreeSDP( sdp_t *p_sdp );
 
+static inline int min_int( int a, int b )
+{
+    return a > b ? b : a;
+}
+
 /*****************************************************************************
  * Open: initialize and create stuff
  *****************************************************************************/
@@ -293,6 +294,8 @@ static int Open( vlc_object_t *p_this )
     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
     services_discovery_sys_t *p_sys  = (services_discovery_sys_t *)
                                 malloc( sizeof( services_discovery_sys_t ) );
+    if( !p_sys )
+        return VLC_ENOMEM;
 
     p_sys->i_timeout = var_CreateGetInteger( p_sd, "sap-timeout" );
 
@@ -313,16 +316,11 @@ static int Open( vlc_object_t *p_this )
 #endif
 
     /* Cache sap_timeshift value */
-    p_sys->b_timeshift = var_CreateGetInteger( p_sd, "sap-timeshift" )
-            ? VLC_TRUE : VLC_FALSE;
+    p_sys->b_timeshift = var_CreateGetInteger( p_sd, "sap-timeshift" );
 
-    /* Create our playlist node */
-    pl_Yield( p_sd );
+    /* Set our name */
+    services_discovery_SetLocalizedName( p_sd, _("SAP") );
 
-    playlist_NodesPairCreate( pl_Get( p_sd ), _("SAP sessions"),
-                              &p_sys->p_node_cat, &p_sys->p_node_one,
-                              VLC_TRUE );
-    p_sys->p_node_cat->p_input->b_prefers_tree = VLC_TRUE;
     p_sys->i_announces = 0;
     p_sys->pp_announces = NULL;
 
@@ -335,11 +333,11 @@ static int Open( vlc_object_t *p_this )
 static int OpenDemux( vlc_object_t *p_this )
 {
     demux_t *p_demux = (demux_t *)p_this;
-    uint8_t *p_peek;
-    int i_max_sdp = 1024;
-    int i_sdp = 0;
+    const uint8_t *p_peek;
     char *psz_sdp = NULL;
     sdp_t *p_sdp = NULL;
+    int errval = VLC_EGENERIC;
+    size_t i_len;
 
     if( !var_CreateGetInteger( p_demux, "sap-parse" ) )
     {
@@ -347,44 +345,40 @@ static int OpenDemux( vlc_object_t *p_this )
         return VLC_EGENERIC;
     }
 
-    /* Probe for SDP */
-    if( p_demux->s )
-    {
-        if( stream_Peek( p_demux->s, &p_peek, 7 ) < 7 ) return VLC_EGENERIC;
+    assert( p_demux->s ); /* this is NOT an access_demux */
 
-        if( strncmp( (char*)p_peek, "v=0\r\n", 5 ) &&
-            strncmp( (char*)p_peek, "v=0\n", 4 ) &&
-            ( p_peek[0] < 'a' || p_peek[0] > 'z' || p_peek[1] != '=' ) )
-        {
-            return VLC_EGENERIC;
-        }
-    }
+    /* Probe for SDP */
+    if( stream_Peek( p_demux->s, &p_peek, 7 ) < 7 )
+        return VLC_EGENERIC;
 
-    psz_sdp = (char *)malloc( i_max_sdp );
-    if( !psz_sdp ) return VLC_EGENERIC;
+    if( memcmp( p_peek, "v=0\r\no=", 7 ) && memcmp( p_peek, "v=0\no=", 6 ) )
+        return VLC_EGENERIC;
 
     /* Gather the complete sdp file */
-    for( ;; )
+    for( i_len = 0, psz_sdp = NULL; i_len < 65536; )
     {
-        int i_read = stream_Read( p_demux->s,
-                                  &psz_sdp[i_sdp], i_max_sdp - i_sdp - 1 );
-
-        if( i_read < 0 )
+        const int i_read_max = 1024;
+        char *psz_sdp_new = realloc( psz_sdp, i_len + i_read_max );
+        size_t i_read;
+        if( psz_sdp_new == NULL )
         {
-            msg_Err( p_demux, "failed to read SDP" );
+            errval = VLC_ENOMEM;
             goto error;
         }
+        psz_sdp = psz_sdp_new;
 
-        i_sdp += i_read;
-
-        if( i_read < i_max_sdp - i_sdp - 1 )
+        i_read = stream_Read( p_demux->s, &psz_sdp[i_len], i_read_max );
+        if( (int)i_read < 0 )
         {
-            psz_sdp[i_sdp] = '\0';
-            break;
+            msg_Err( p_demux, "cannot read SDP" );
+            goto error;
         }
+        i_len += i_read;
+
+        psz_sdp[i_len] = '\0';
 
-        i_max_sdp += 1000;
-        psz_sdp = (char *)realloc( psz_sdp, i_max_sdp );
+        if( (int)i_read < i_read_max )
+            break; // EOF
     }
 
     p_sdp = ParseSDP( VLC_OBJECT(p_demux), psz_sdp );
@@ -417,7 +411,7 @@ error:
     FREENULL( psz_sdp );
     if( p_sdp ) FreeSDP( p_sdp ); p_sdp = NULL;
     stream_Seek( p_demux->s, 0 );
-    return VLC_EGENERIC;
+    return errval;
 }
 
 /*****************************************************************************
@@ -449,11 +443,6 @@ static void Close( vlc_object_t *p_this )
     }
     FREENULL( p_sys->pp_announces );
 
-    playlist_NodeDelete( pl_Get(p_sd), p_sys->p_node_cat, VLC_TRUE,
-                         VLC_TRUE );
-    playlist_NodeDelete( pl_Get(p_sd), p_sys->p_node_one, VLC_TRUE,
-                         VLC_TRUE );
-    pl_Release( p_sd );
     free( p_sys );
 }
 
@@ -481,6 +470,7 @@ static void Run( services_discovery_t *p_sd )
 {
     char *psz_addr;
     int i;
+    int timeout = -1;
 
     /* Braindead Winsock DNS resolver will get stuck over 2 seconds per failed
      * DNS queries, even if the DNS server returns an error with milliseconds.
@@ -497,12 +487,50 @@ static void Run( services_discovery_t *p_sd )
     }
     if( var_CreateGetInteger( p_sd, "sap-ipv6" ) )
     {
-        char psz_address[] = SAP_V6_1"0"SAP_V6_2;
-        const char *c_scope;
+        char psz_address[NI_MAXNUMERICHOST] = "ff02::2:7ffe%";
+
+#ifndef WIN32
+        struct if_nameindex *l = if_nameindex ();
+        if (l != NULL)
+        {
+            char *ptr = strchr (psz_address, '%') + 1;
+            for (unsigned i = 0; l[i].if_index; i++)
+            {
+                strcpy (ptr, l[i].if_name);
+                InitSocket (p_sd, psz_address, SAP_PORT);
+            }
+            if_freenameindex (l);
+        }
+#else
+        /* this is the Winsock2 equivalant of SIOCGIFCONF on BSD stacks,
+           which if_nameindex uses internally anyway */
+
+        // first create a dummy socket to pin down the protocol family
+        SOCKET s = socket(PF_INET6, SOCK_DGRAM, IPPROTO_UDP);
+        if( s != INVALID_SOCKET )
+        {
+            INTERFACE_INFO ifaces[10]; // Assume there will be no more than 10 IP interfaces
+            size_t len = sizeof(ifaces);
+
+            if( SOCKET_ERROR != WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0, &ifaces, len, &len, NULL, NULL) )
+            {
+                unsigned ifcount = len/sizeof(INTERFACE_INFO);
+                char *ptr = strchr (psz_address, '%') + 1;
+                for(unsigned i = 1; i<=ifcount; ++i )
+                {
+                    // append link-local zone identifier
+                    sprintf(ptr, "%d", i);
+                }
+            }
+            closesocket(s);
+        }
+#endif
+        *strchr (psz_address, '%') = '\0';
 
-        for( c_scope = ipv6_scopes; *c_scope; c_scope++ )
+        static const char ipv6_scopes[] = "1456789ABCDE";
+        for (const char *c_scope = ipv6_scopes; *c_scope; c_scope++)
         {
-            psz_address[sizeof(SAP_V6_1) - 1] = *c_scope;
+            psz_address[3] = *c_scope;
             InitSocket( p_sd, psz_address, SAP_PORT );
         }
     }
@@ -520,42 +548,98 @@ static void Run( services_discovery_t *p_sd )
         return;
     }
 
+    vlc_object_lock( p_sd );
+
     /* read SAP packets */
-    while( !p_sd->b_die )
+    while( vlc_object_alive( p_sd ) )
     {
-        int i_read;
-        uint8_t p_buffer[MAX_SAP_BUFFER+1];
+        unsigned n = p_sd->p_sys->i_fd;
+        struct pollfd ufd[n+1];
 
-        i_read = net_Select( p_sd, p_sd->p_sys->pi_fd,
-                             p_sd->p_sys->i_fd, p_buffer,
-                             MAX_SAP_BUFFER );
+        for (unsigned i = 0; i < n; i++)
+        {
+            ufd[i].fd = p_sd->p_sys->pi_fd[i];
+            ufd[i].events = POLLIN;
+            ufd[i].revents = 0;
+        }
 
-        /* Check for items that need deletion */
-        for( i = 0; i < p_sd->p_sys->i_announces; i++ )
+        /* Make sure we track vlc_object_signal() */
+        ufd[n].fd = vlc_object_waitpipe( p_sd );
+        ufd[n].events = POLLIN | POLLHUP;
+        ufd[n].revents = 0;
+
+        if( ufd[n].fd == -1 )
         {
-            mtime_t i_timeout = ( mtime_t ) 1000000 * p_sd->p_sys->i_timeout;
+            /* On windows, fd will be -1, as we can't select on a pipe()-ed
+             * fildes. Because we have no other solution to track that
+             * object is killed, we make sure the timeout won't be to long. */
+            if( timeout > 1000 || timeout == -1 )
+                timeout = 1000;
+        }
 
-            if( mdate() - p_sd->p_sys->pp_announces[i]->i_last > i_timeout )
+        vlc_object_unlock( p_sd );
+
+        if (poll (ufd, n+1, timeout) > 0)
+        {
+            for (unsigned i = 0; i < n; i++)
             {
-                RemoveAnnounce( p_sd, p_sd->p_sys->pp_announces[i] );
+                if (ufd[i].revents)
+                {
+                    uint8_t p_buffer[MAX_SAP_BUFFER+1];
+                    ssize_t i_read;
+
+                    i_read = net_Read (p_sd, ufd[i].fd, NULL, p_buffer,
+                                       MAX_SAP_BUFFER, VLC_FALSE);
+                    if (i_read < 0)
+                        msg_Warn (p_sd, "receive error: %m");
+                    if (i_read > 6)
+                    {
+                        /* Parse the packet */
+                        p_buffer[i_read] = '\0';
+                        ParseSAP (p_sd, p_buffer, i_read);
+                    }
+                }
             }
         }
 
-        /* Minimum length is > 6 */
-        if( i_read <= 6 )
+        mtime_t now = mdate();
+
+        /* A 1 hour timeout correspong to the RFC Implicit timeout.
+         * This timeout is tuned in the following loop. */
+        timeout = 1000 * 60 * 60;
+
+        /* Check for items that need deletion */
+        for( i = 0; i < p_sd->p_sys->i_announces; i++ )
         {
-            if( i_read < 0 )
+            mtime_t i_timeout = ( mtime_t ) 1000000 * p_sd->p_sys->i_timeout;
+            sap_announce_t * p_announce = p_sd->p_sys->pp_announces[i];
+            mtime_t i_last_period = now - p_announce->i_last;
+
+            /* Remove the annoucement, if the last announcement was 1 hour ago
+             * or if the last packet emitted was 3 times the average time
+             * between two packets */
+            if( ( p_announce->i_period_trust > 5 && i_last_period > 3 * p_announce->i_period ) ||
+                i_last_period > i_timeout )
             {
-                msg_Warn( p_sd, "socket read error" );
+                RemoveAnnounce( p_sd, p_announce );
+            }
+            else
+            {
+                /* Compute next timeout */
+                if( p_announce->i_period_trust > 5 )
+                    timeout = min_int((3 * p_announce->i_period - i_last_period) / 1000, timeout);
+                timeout = min_int((i_timeout - i_last_period)/1000, timeout);
             }
-            continue;
         }
 
-        p_buffer[i_read] = '\0';
+        if( !p_sd->p_sys->i_announces )
+            timeout = -1; /* We can safely poll indefinitly. */
+        else if( timeout < 200 )
+            timeout = 200; /* Don't wakeup too fast. */
 
-        /* Parse the packet */
-        ParseSAP( p_sd, p_buffer, i_read );
+        vlc_object_lock( p_sd );
     }
+    vlc_object_unlock( p_sd );
 }
 
 /**********************************************************************
@@ -578,13 +662,13 @@ static int Demux( demux_t *p_demux )
         return VLC_EGENERIC;
     }
 
-    p_parent_input = input_GetItem(p_input);
+    p_parent_input = input_GetItem( p_input );
+
+    input_item_SetURI( p_parent_input, p_sdp->psz_uri );
+    input_item_SetName( p_parent_input, p_sdp->psz_sessionname );
 
     vlc_mutex_lock( &p_parent_input->lock );
-    FREENULL( p_parent_input->psz_uri );
-    p_parent_input->psz_uri = strdup( p_sdp->psz_uri );
-    FREENULL( p_parent_input->psz_name );
-    p_parent_input->psz_name = strdup( p_sdp->psz_sessionname );
+
     p_parent_input->i_type = ITEM_TYPE_NET;
 
     if( p_playlist->status.p_item &&
@@ -603,6 +687,7 @@ static int Demux( demux_t *p_demux )
 
 static int Control( demux_t *p_demux, int i_query, va_list args )
 {
+    VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
     return VLC_EGENERIC;
 }
 
@@ -726,17 +811,30 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
 
     for( i = 0 ; i< p_sd->p_sys->i_announces ; i++ )
     {
+        sap_announce_t * p_announce = p_sd->p_sys->pp_announces[i];
         /* FIXME: slow */
         /* FIXME: we create a new announce each time the sdp changes */
-        if( IsSameSession( p_sd->p_sys->pp_announces[i]->p_sdp, p_sdp ) )
+        if( IsSameSession( p_announce->p_sdp, p_sdp ) )
         {
-            if( b_need_delete )
-            {
-                RemoveAnnounce( p_sd, p_sd->p_sys->pp_announces[i]);
-            }
-            else
+            /* We don't support delete announcement as they can easily
+             * Be used to highjack an announcement by a third party.
+             * Intead we cleverly implement Implicit Announcement removal.
+             *
+             * if( b_need_delete )
+             *    RemoveAnnounce( p_sd, p_sd->p_sys->pp_announces[i]);
+             * else
+             */
+
+            if( !b_need_delete )
             {
-                p_sd->p_sys->pp_announces[i]->i_last = mdate();
+                /* No need to go after six, as we start to trust the
+                 * average period at six */
+                if( p_announce->i_period_trust <= 5 )
+                    p_announce->i_period_trust++;
+
+                /* Compute the average period */
+                p_announce->i_period = (p_announce->i_period + (mdate() - p_announce->i_last)) / 2;
+                p_announce->i_last = mdate();
             }
             FreeSDP( p_sdp ); p_sdp = NULL;
             return VLC_SUCCESS;
@@ -753,7 +851,6 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
                                 sdp_t *p_sdp )
 {
     input_item_t *p_input;
-    playlist_item_t     *p_item, *p_child;
     const char *psz_value;
     sap_announce_t *p_sap = (sap_announce_t *)malloc(
                                         sizeof(sap_announce_t ) );
@@ -764,6 +861,8 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     p_sys = p_sd->p_sys;
 
     p_sap->i_last = mdate();
+    p_sap->i_period = 0;
+    p_sap->i_period_trust = 0;
     p_sap->i_hash = i_hash;
     p_sap->p_sdp = p_sdp;
 
@@ -785,12 +884,13 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     psz_value = GetAttribute( p_sap->p_sdp->pp_attributes, p_sap->p_sdp->i_attributes, "tool" );
     if( psz_value != NULL )
     {
-        input_ItemAddInfo( p_input, _("Session"),_("Tool"), psz_value );
+        input_ItemAddInfo( p_input, _("Session"), _("Tool"), "%s",
+                           psz_value );
     }
     if( strcmp( p_sdp->username, "-" ) )
     {
-        input_ItemAddInfo( p_input, _("Session"),
-                                _("User"), p_sdp->username );
+        input_ItemAddInfo( p_input, _("Session"), _("User"), "%s",
+                           p_sdp->username );
     }
 
     /* Handle group */
@@ -799,37 +899,10 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     else
         psz_value = GetAttribute( p_sap->p_sdp->pp_attributes, p_sap->p_sdp->i_attributes, "x-plgroup" );
 
-    if( psz_value != NULL )
-    {
-        p_child = playlist_ChildSearchName( p_sys->p_node_cat, psz_value );
-
-        if( p_child == NULL )
-        {
-            p_child = playlist_NodeCreate( pl_Get( p_sd ), psz_value,
-                                           p_sys->p_node_cat, 0 );
-            p_child->i_flags &= ~PLAYLIST_SKIP_FLAG;
-        }
-    }
-    else
-    {
-        p_child = p_sys->p_node_cat;
-    }
-
-    p_item = playlist_NodeAddInput( pl_Get( p_sd ), p_input, p_child,
-                                    PLAYLIST_APPEND, PLAYLIST_END, VLC_FALSE );
-    p_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
-    p_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
-    p_sap->i_item_id_cat = p_item->i_id;
-
-    p_item = playlist_NodeAddInput( pl_Get( p_sd ), p_input,
-                        p_sys->p_node_one, PLAYLIST_APPEND, PLAYLIST_END,
-                        VLC_FALSE );
-    p_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
-    p_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
-    p_sap->i_item_id_one = p_item->i_id;
+    services_discovery_AddItem( p_sd, p_input, psz_value /* category name */ );
 
     TAB_APPEND( p_sys->i_announces, p_sys->pp_announces, p_sap );
-
+    vlc_gc_decref( p_input );
     return p_sap;
 }
 
@@ -884,7 +957,7 @@ static int ParseConnection( vlc_object_t *p_obj, sdp_t *p_sdp )
     if (strchr (psz_uri + 1, ':'))
     {
         host = psz_uri;
-        psz_uri[strlen (psz_uri)] = ']';
+        strcat (psz_uri, "]");
     }
     else
         host = psz_uri + 1;
@@ -898,15 +971,19 @@ static int ParseConnection( vlc_object_t *p_obj, sdp_t *p_sdp )
     if (subtype == NULL)
     {
         msg_Dbg (p_obj, "missing SDP media subtype: %s", sdp_proto);
-        p_sdp->i_media_type = 0;
+        free (sdp_proto);
+        return VLC_EGENERIC;
     }
     else
     {
         *subtype++ = '\0';
-        p_sdp->i_media_type = atoi (subtype);
+        /* FIXME: check for multiple payload types in RTP/AVP case.
+         * FIXME: check for "mpeg" subtype in raw udp case. */
+        if (!strcasecmp (sdp_proto, "udp"))
+            p_sdp->i_media_type = 33;
+        else
+            p_sdp->i_media_type = atoi (subtype);
     }
-    if (p_sdp->i_media_type == 0)
-         p_sdp->i_media_type = 33;
 
     /* RTP protocol, nul, VLC shortcut, nul, flags byte as follow:
      * 0x1: Connection-Oriented media. */
@@ -972,7 +1049,7 @@ static int ParseConnection( vlc_object_t *p_obj, sdp_t *p_sdp )
                         psz_source_ip) == 2)
             {
                 /* According to RFC4570, FQDNs can be used for source-filters,
-                * but -seriously- this is impractical */
+                 * but -seriously- this is impractical */
                 switch (ipv)
                 {
 #ifdef AF_INET6