]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
misc/objects.c: Don't rely on vlc_object_destroy() to destroy objects, but expects...
[vlc] / src / misc / objects.c
index 79a64d203bc75c6ce5f5e25531631491a2c6ca12..b191ee447b851578bf17a77708726fe69ad79c19 100644 (file)
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
 #include <vlc/vlc.h>
 
 #include "../libvlc.h"
@@ -64,7 +68,9 @@
 #else
 # include <io.h>
 # include <fcntl.h>
+# include <errno.h> /* ENOSYS */
 #endif
+#include <assert.h>
 
 /*****************************************************************************
  * Local prototypes
@@ -86,6 +92,8 @@ static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
 static int            CountChildren ( vlc_object_t *, int );
 static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
 
+static void vlc_object_destroy( vlc_object_t *p_this );
+
 /*****************************************************************************
  * Local structure lock
  *****************************************************************************/
@@ -183,7 +191,7 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         vlc_mutex_unlock( &structure_lock );
     }
 
-    p_priv->i_refcount = 0;
+    p_priv->i_refcount = 1;
     p_new->p_parent = NULL;
     p_new->pp_children = NULL;
     p_new->i_children = 0;
@@ -194,6 +202,7 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     vlc_mutex_init( p_new, &p_new->object_lock );
     vlc_cond_init( p_new, &p_new->object_wait );
     vlc_mutex_init( p_new, &p_priv->var_lock );
+    vlc_spin_init( &p_priv->spin );
     p_priv->pipes[0] = p_priv->pipes[1] = -1;
 
     if( i_type == VLC_OBJECT_GLOBAL )
@@ -340,31 +349,54 @@ void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 
 /**
  ****************************************************************************
- * Destroy a vlc object
+ * Destroy a vlc object (Internal)
  *
  * This function destroys an object that has been previously allocated with
  * vlc_object_create. The object's refcount must be zero and it must not be
  * attached to other objects in any way.
  *****************************************************************************/
-void __vlc_object_destroy( vlc_object_t *p_this )
+static void vlc_object_destroy( vlc_object_t *p_this )
 {
     vlc_object_internals_t *p_priv = vlc_internals( p_this );
-    int i_delay = 0;
+
+    /* FIXME: ugly hack - we cannot use the message queue after
+         * msg_Destroy(). */
+    vlc_object_t *logger = p_this;
+    if( p_this->p_libvlc == p_this )
+        logger = NULL;
 
     if( p_this->i_children )
     {
-        msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
+<<<<<<< .mine
+        fprintf( stderr,
+                  "ERROR: cannot delete object (%i, %s) with children\n",
+                  p_this->i_object_id, p_this->psz_object_name );
+        fflush(stderr);
+        abort();
+=======
+        msg_Err( logger, "cannot delete object (%i, %s) with children" ,
                  p_this->i_object_id, p_this->psz_object_name );
         return;
+>>>>>>> .r25344
     }
 
     if( p_this->p_parent )
     {
-        msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
+<<<<<<< .mine
+        fprintf( stderr,
+                  "ERROR: cannot delete object (%i, %s) with a parent\n",
+                  p_this->i_object_id, p_this->psz_object_name );
+        fflush(stderr);
+        abort();
+=======
+        msg_Err( logger, "cannot delete object (%i, %s) with a parent",
                  p_this->i_object_id, p_this->psz_object_name );
         return;
+>>>>>>> .r25344
     }
 
+<<<<<<< .mine
+=======
     while( p_priv->i_refcount > 0 )
     {
         i_delay++;
@@ -372,21 +404,21 @@ void __vlc_object_destroy( vlc_object_t *p_this )
         /* Don't warn immediately ... 100ms seems OK */
         if( i_delay == 2 )
         {
-            msg_Warn( p_this,
+            msg_Warn( logger,
                   "refcount is %u, delaying before deletion (id=%d,type=%d)",
                   p_priv->i_refcount, p_this->i_object_id,
                   p_this->i_object_type );
         }
         else if( i_delay == 10 )
         {
-            msg_Err( p_this,
+            msg_Err( logger,
                   "refcount is %u, delaying again (id=%d,type=%d)",
                   p_priv->i_refcount, p_this->i_object_id,
                   p_this->i_object_type );
         }
         else if( i_delay == 20 )
         {
-            msg_Err( p_this,
+            msg_Err( logger,
                   "waited too long, cancelling destruction (id=%d,type=%d)",
                   p_this->i_object_id, p_this->i_object_type );
             return;
@@ -395,6 +427,7 @@ void __vlc_object_destroy( vlc_object_t *p_this )
         msleep( 100000 );
     }
 
+>>>>>>> .r25344
     /* Destroy the associated variables, starting from the end so that
      * no memmove calls have to be done. */
     while( p_priv->i_vars )
@@ -410,10 +443,34 @@ void __vlc_object_destroy( vlc_object_t *p_this )
     if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
     {
         libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
+
+        /* Remove ourselves */
+        int i_index = FindIndex( p_this, p_global->pp_objects,
+                             p_global->i_objects );
+        REMOVE_ELEM( p_global->pp_objects,
+                     p_global->i_objects, i_index );
+
+        /* Test for leaks */
+        if( p_global->i_objects > 0 )
+        {
+            int i;
+            for( i = 0; i < p_global->i_objects; i++ )
+            {
+                /* We are leaking this object */
+                fprintf( stderr,
+                      "ERROR: We are leaking object (id:%i, type:%s, name:%s)\n",
+                      p_global->pp_objects[i]->i_object_id,
+                      p_global->pp_objects[i]->psz_object_type,
+                      p_global->pp_objects[i]->psz_object_name );
+                fflush(stderr);
+            }
+            /* Strongly abort, cause we want these to be fixed */
+            abort();
+        }
+
         /* We are the global object ... no need to lock. */
         free( p_global->pp_objects );
         p_global->pp_objects = NULL;
-        p_global->i_objects--;
 
         vlc_mutex_destroy( &structure_lock );
     }
@@ -442,10 +499,11 @@ void __vlc_object_destroy( vlc_object_t *p_this )
 
     vlc_mutex_destroy( &p_this->object_lock );
     vlc_cond_destroy( &p_this->object_wait );
-    if( p_priv->pipes[0] != -1 )
-        close( p_priv->pipes[0] );
+    vlc_spin_destroy( &p_priv->spin );
     if( p_priv->pipes[1] != -1 )
         close( p_priv->pipes[1] );
+    if( p_priv->pipes[0] != -1 )
+        close( p_priv->pipes[0] );
 
     /* global is not dynamically allocated by vlc_object_create */
     if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
@@ -466,40 +524,120 @@ void __vlc_object_unlock( vlc_object_t *obj )
     vlc_mutex_unlock( &obj->object_lock );
 }
 
+#ifdef WIN32
+# include <winsock2.h>
+# include <ws2tcpip.h>
+
+/**
+ * select()-able pipes emulated using Winsock
+ */
+static int pipe (int fd[2])
+{
+    SOCKADDR_IN addr;
+    int addrlen = sizeof (addr);
+
+    SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
+           c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
+    if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
+        goto error;
+
+    memset (&addr, 0, sizeof (addr));
+    addr.sin_family = AF_INET;
+    addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
+    if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
+     || getsockname (l, (PSOCKADDR)&addr, &addrlen)
+     || listen (l, 1)
+     || connect (c, (PSOCKADDR)&addr, addrlen))
+        goto error;
+
+    a = accept (l, NULL, NULL);
+    if (a == INVALID_SOCKET)
+        goto error;
+
+    closesocket (l);
+    //shutdown (a, 0);
+    //shutdown (c, 1);
+    fd[0] = c;
+    fd[1] = a;
+    return 0;
+
+error:
+    if (l != INVALID_SOCKET)
+        closesocket (l);
+    if (c != INVALID_SOCKET)
+        closesocket (c);
+    return -1;
+}
+
+#undef  read
+#define read( a, b, c )  recv (a, b, c, 0)
+#undef  write
+#define write( a, b, c ) send (a, b, c, 0)
+#undef  close
+#define close( a )       closesocket (a)
+#endif /* WIN32 */
+
 /**
- * Returns the readable end of a pipe that becomes readable whenever
- * an object is signaled. This can be used to wait for VLC object events
- * inside select(), poll() loops or frameworks providing an event loop.
+ * Returns the readable end of a pipe that becomes readable once termination
+ * of the object is requested (vlc_object_kill()).
+ * This can be used to wake-up out of a select() or poll() event loop, such
+ * typically when doing network I/O.
  *
  * Note that the pipe will remain the same for the lifetime of the object.
- * DO NOT close it yourself. Ever.
+ * DO NOT read the pipe nor close it yourself. Ever.
  *
- * DO NOT try to read from the pipe either: call vlc_object_wait() instead.
- * Assuming the pipe is readable, vlc_object_wait() will not block.
- * Also note that, as with vlc_object_wait(), there may be spurious wakeups.
- *
- * @param obj object that would be signaled (object lock MUST hold)
+ * @param obj object that would be "killed"
  * @return a readable pipe descriptor, or -1 on error.
  */
-int vlc_object_waitpipe( vlc_object_t *obj )
+int __vlc_object_waitpipe( vlc_object_t *obj )
 {
-    int *pipes = obj->p_internals->pipes;
-    vlc_assert_locked( &obj->object_lock );
+    int pfd[2] = { -1, -1 };
+    struct vlc_object_internals_t *internals = obj->p_internals;
+    vlc_bool_t killed = VLC_FALSE;
 
-    if( pipes[1] == -1 )
+    vlc_spin_lock (&internals->spin);
+    if (internals->pipes[0] == -1)
     {
-        /* This can only ever happen if someone killed us without locking */
-        assert( pipes[0] == -1 );
+        /* This can only ever happen if someone killed us without locking: */
+        assert (internals->pipes[1] == -1);
+        vlc_spin_unlock (&internals->spin);
 
-#ifndef WIN32
-        if( pipe( pipes ) )
-#else
-        if( _pipe( pipes, 1, _O_BINARY ) )
-#endif
+        if (pipe (pfd))
             return -1;
+
+        vlc_spin_lock (&internals->spin);
+        if (internals->pipes[0] == -1)
+        {
+            internals->pipes[0] = pfd[0];
+            internals->pipes[1] = pfd[1];
+            pfd[0] = pfd[1] = -1;
+        }
+        killed = obj->b_die;
+    }
+    vlc_spin_unlock (&internals->spin);
+
+    if (killed)
+    {
+        /* Race condition: vlc_object_kill() already invoked! */
+        int fd;
+
+        vlc_spin_lock (&internals->spin);
+        fd = internals->pipes[1];
+        internals->pipes[1] = -1;
+        vlc_spin_unlock (&internals->spin);
+
+        msg_Dbg (obj, "waitpipe: object already dying");
+        if (fd != -1)
+            close (fd);
     }
 
-    return pipes[0];
+    /* Race condition: two threads call pipe() - unlikely */
+    if (pfd[0] != -1)
+        close (pfd[0]);
+    if (pfd[1] != -1)
+        close (pfd[1]);
+
+    return internals->pipes[0];
 }
 
 
@@ -513,18 +651,6 @@ int vlc_object_waitpipe( vlc_object_t *obj )
 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
 {
     vlc_assert_locked( &obj->object_lock );
-
-    int fd = obj->p_internals->pipes[0];
-    if( fd != -1 )
-    {
-        if( read( fd, &(char){ 0 }, 1 ) == 0 )
-        {
-            close( fd );
-            obj->p_internals->pipes[1] = -1;
-        }
-        return obj->b_die;
-    }
-
     vlc_cond_wait( &obj->object_wait, &obj->object_lock );
     return obj->b_die;
 }
@@ -553,16 +679,41 @@ int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
 
 
 /**
- * Signals an object for which the lock is held.
+ * Checks whether an object has been "killed".
+ * The object lock must be held.
+ *
+ * Typical code for an object thread could be:
+ *
+   vlc_object_lock (self);
+   ...initialization...
+   while (vlc_object_alive (self))
+   {
+       ...preprocessing...
+
+       if (vlc_object_wait (self))
+           continue;
+
+       ...postprocessing...
+   }
+   ...deinitialization...
+   vlc_object_unlock (self);
+ *
+ *
+ * @return true iff the object has not been killed yet
  */
-void __vlc_object_signal_unlocked( vlc_object_t *obj )
+vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
 {
     vlc_assert_locked( &obj->object_lock );
+    return !obj->b_die;
+}
 
-    int fd = obj->p_internals->pipes[1];
-    if( fd != -1 )
-        while( write( fd, &(char){ 0 }, 1 ) < 0 );
 
+/**
+ * Signals an object for which the lock is held.
+ */
+void __vlc_object_signal_unlocked( vlc_object_t *obj )
+{
+    vlc_assert_locked (&obj->object_lock);
     vlc_cond_signal( &obj->object_wait );
 }
 
@@ -573,20 +724,27 @@ void __vlc_object_signal_unlocked( vlc_object_t *obj )
  */
 void __vlc_object_kill( vlc_object_t *p_this )
 {
+    struct vlc_object_internals_t *internals = p_this->p_internals;
+    int fd;
+
     vlc_mutex_lock( &p_this->object_lock );
     p_this->b_die = VLC_TRUE;
 
-    if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
-        for( int i = 0; i < p_this->i_children ; i++ )
-            vlc_object_kill( p_this->pp_children[i] );
+    vlc_spin_lock (&internals->spin);
+    fd = internals->pipes[1];
+    internals->pipes[1] = -1;
+    vlc_spin_unlock (&internals->spin);
 
-    int fd = p_this->p_internals->pipes[1];
     if( fd != -1 )
     {
-        close( fd ); /* closing a pipe makes it readable too */
-        p_this->p_internals->pipes[1] = -1;
+        msg_Dbg (p_this, "waitpipe: object killed");
+        close (fd);
     }
 
+    if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
+        for( int i = 0; i < p_this->i_children ; i++ )
+            vlc_object_kill( p_this->pp_children[i] );
+
     vlc_object_signal_unlocked( p_this );
     vlc_mutex_unlock( &p_this->object_lock );
 }
@@ -598,7 +756,7 @@ void __vlc_object_kill( vlc_object_t *p_this )
  * This function looks for the object whose i_object_id field is i_id. We
  * use a dichotomy so that lookups are in log2(n).
  *****************************************************************************/
-void * __vlc_object_get( vlc_object_t *p_this, int i_id )
+void * vlc_object_get( int i_id )
 {
     int i_max, i_middle;
     vlc_object_t **pp_objects;
@@ -770,20 +928,37 @@ void __vlc_object_yield( vlc_object_t *p_this )
     vlc_mutex_unlock( &structure_lock );
 }
 
-static inline void Release( vlc_object_t *obj )
-{
-    assert( obj->p_internals->i_refcount > 0 );
-    obj->p_internals->i_refcount--;
-}
-
 /*****************************************************************************
  * decrement an object refcount
+ * And destroy the object if its refcount reach zero.
  *****************************************************************************/
 void __vlc_object_release( vlc_object_t *p_this )
 {
+    vlc_bool_t b_should_destroy;
+
     vlc_mutex_lock( &structure_lock );
-    Release( p_this );
+
+    assert( p_this->p_internals->i_refcount > 0 );
+    p_this->p_internals->i_refcount--;
+    b_should_destroy = (p_this->p_internals->i_refcount == 0);
+
     vlc_mutex_unlock( &structure_lock );
+
+    if( b_should_destroy )
+        vlc_object_destroy( p_this );
+}
+
+/* Version without the lock */
+static void vlc_object_release_locked( vlc_object_t *p_this )
+{
+    vlc_bool_t b_should_destroy;
+
+    assert( p_this->p_internals->i_refcount > 0 );
+    p_this->p_internals->i_refcount--;
+    b_should_destroy = (p_this->p_internals->i_refcount == 0);
+
+    if( b_should_destroy )
+        vlc_object_destroy( p_this );
 }
 
 /**
@@ -964,11 +1139,11 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
             char *end;
             int i_id = strtol( newval.psz_string, &end, 0 );
             if( end != newval.psz_string )
-                p_object = vlc_object_get( p_this, i_id );
+                p_object = vlc_object_get( i_id );
             else
             {
                 /* try using the object's name to find it */
-                vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
+                vlc_object_t *p_libvlc = vlc_object_get( 1 );
                 if( p_libvlc )
                 {
                     /* Look in p_libvlc's children tree */
@@ -1107,7 +1282,7 @@ void vlc_list_release( vlc_list_t *p_list )
     vlc_mutex_lock( &structure_lock );
     for( i_index = 0; i_index < p_list->i_count; i_index++ )
     {
-        Release( p_list->p_values[i_index].p_object );
+        vlc_object_release_locked( p_list->p_values[i_index].p_object );
     }
     vlc_mutex_unlock( &structure_lock );