]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
Look for reference leaks. I found none, though.
[vlc] / src / misc / objects.c
index 4830eda23a3121f87ce06731e819b69081063827..e8e0ff07b6a429afb473d2f464f48d16c81025f9 100644 (file)
@@ -2,7 +2,6 @@
  * objects.c: vlc_object_t handling
  *****************************************************************************
  * Copyright (C) 2004-2008 the VideoLAN team
- * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
@@ -34,7 +33,7 @@
 # include "config.h"
 #endif
 
-#include <vlc/vlc.h>
+#include <vlc_common.h>
 
 #include "../libvlc.h"
 #include <vlc_vout.h>
@@ -82,11 +81,20 @@ static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
 static void vlc_object_destroy( vlc_object_t *p_this );
 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
 
+#ifndef NDEBUG
+static vlc_threadvar_t held_objects;
+typedef struct held_list_t
+{
+    struct held_list_t *next;
+    vlc_object_t *obj;
+} held_list_t;
+static void held_objects_destroy (void *);
+#endif
+
 /*****************************************************************************
  * Local structure lock
  *****************************************************************************/
 static vlc_mutex_t     structure_lock;
-static vlc_threadvar_t thread_object;
 
 void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
                          int i_type, const char *psz_type )
@@ -143,6 +151,10 @@ void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         p_libvlc_global->i_counter = 0;
         p_priv->next = p_priv->prev = p_new;
         vlc_mutex_init( &structure_lock );
+#ifndef NDEBUG
+        /* TODO: use the destruction callback to track ref leaks */
+        vlc_threadvar_create( &held_objects, held_objects_destroy );
+#endif
     }
     else
     {
@@ -372,6 +384,10 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 
         /* We are the global object ... no need to lock. */
         vlc_mutex_destroy( &structure_lock );
+#ifndef NDEBUG
+        held_objects_destroy( vlc_threadvar_get( &held_objects ) );
+        vlc_threadvar_delete( &held_objects );
+#endif
     }
 
     FREENULL( p_this->psz_object_name );
@@ -621,12 +637,16 @@ void __vlc_object_kill( vlc_object_t *p_this )
         close (fd);
     }
 
-    if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
-        for( int i = 0; i < internals->i_children ; i++ )
-            vlc_object_kill( internals->pp_children[i] );
-
     vlc_object_signal_unlocked( p_this );
     vlc_mutex_unlock( &p_this->object_lock );
+
+    if (p_this->i_object_type == VLC_OBJECT_LIBVLC)
+    {
+        vlc_list_t *children = vlc_list_children (p_this);
+        for (int i = 0; i < children->i_count; i++)
+            vlc_object_kill (children->p_values[i].p_object);
+        vlc_list_release (children);
+    }
 }
 
 
@@ -775,6 +795,16 @@ void __vlc_object_yield( vlc_object_t *p_this )
     /* Increment the counter */
     internals->i_refcount++;
     vlc_spin_unlock( &internals->ref_spin );
+#ifndef NDEBUG
+    /* Update the list of referenced objects */
+    /* Using TLS, so no need to lock */
+    /* The following line may leak memory if a thread leaks objects. */
+    held_list_t *newhead = malloc (sizeof (*newhead));
+    held_list_t *oldhead = vlc_threadvar_get (&held_objects);
+    newhead->next = oldhead;
+    newhead->obj = p_this;
+    vlc_threadvar_set (&held_objects, newhead);
+#endif
 }
 
 /*****************************************************************************
@@ -786,6 +816,27 @@ void __vlc_object_release( vlc_object_t *p_this )
     vlc_object_internals_t *internals = vlc_internals( p_this );
     bool b_should_destroy;
 
+#ifndef NDEBUG
+    /* Update the list of referenced objects */
+    /* Using TLS, so no need to lock */
+    for (held_list_t *hlcur = vlc_threadvar_get (&held_objects),
+                     *hlprev = NULL;
+         hlcur != NULL;
+         hlprev = hlcur, hlcur = hlcur->next)
+    {
+        if (hlcur->obj == p_this)
+        {
+            if (hlprev == NULL)
+                vlc_threadvar_set (&held_objects, hlcur->next);
+            else
+                hlprev->next = hlcur->next;
+            free (hlcur);
+            break;
+        }
+    }
+    /* TODO: what if releasing without references? */
+#endif
+
     vlc_spin_lock( &internals->ref_spin );
     assert( internals->i_refcount > 0 );
 
@@ -1507,29 +1558,29 @@ void vlc_refcheck (vlc_object_t *obj)
 #endif
         return;
 
-    /* A thread can use its own object without reference! */
+    /* A thread can use its own object without references! */
     vlc_object_t *caller = vlc_threadobj ();
     if (caller == obj)
         return;
-
+#if 0
     /* The calling thread is younger than the object.
      * Access could be valid through cross-thread synchronization;
      * we would need better accounting. */
     if (caller && (caller->i_object_id > obj->i_object_id))
         return;
-
+#endif
     int refs;
     vlc_spin_lock (&priv->ref_spin);
     refs = priv->i_refcount;
     vlc_spin_unlock (&priv->ref_spin);
 
-    /* Object has more than one reference.
-     * The current thread could be holding a valid reference. */
-    if (refs > 1)
-        return;
+    for (held_list_t *hlcur = vlc_threadvar_get (&held_objects);
+         hlcur != NULL; hlcur = hlcur->next)
+        if (hlcur->obj == obj)
+            return;
 
     fprintf (stderr, "The %s %s thread object is accessing...\n"
-             "the %s %s object in a suspicous manner.\n",
+             "the %s %s object without references.\n",
              caller && caller->psz_object_name
                      ? caller->psz_object_name : "unnamed",
              caller ? caller->psz_object_type : "main",
@@ -1546,4 +1597,26 @@ void vlc_refcheck (vlc_object_t *obj)
     if (++errors == 100)
         fprintf (stderr, "Too many reference errors!\n");
 }
+
+static void held_objects_destroy (void *data)
+{
+    held_list_t *hl = vlc_threadvar_get (&held_objects);
+    vlc_object_t *caller = vlc_threadobj ();
+
+    while (hl != NULL)
+    {
+        held_list_t *buf = hl->next;
+        vlc_object_t *obj = hl->obj;
+
+        fprintf (stderr, "The %s %s thread object leaked a reference to...\n"
+                         "the %s %s object.\n",
+                 caller && caller->psz_object_name
+                     ? caller->psz_object_name : "unnamed",
+                 caller ? caller->psz_object_type : "main",
+                 obj->psz_object_name ? obj->psz_object_name : "unnamed",
+                 obj->psz_object_type);
+        free (hl);
+        hl = buf;
+    }
+}
 #endif