]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
Print backtrace in vlc_pthread_fatal
[vlc] / src / misc / objects.c
index 4afc08c83d4be6bf108b67713120ade78efd0503..e717aaf04fc263c1aa29d07ee885c2aa305ceb08 100644 (file)
@@ -72,7 +72,6 @@ static vlc_object_t * FindObject    ( vlc_object_t *, int, int );
 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
 static void           PrintObject   ( vlc_object_t *, const char * );
 static void           DumpStructure ( vlc_object_t *, int, char * );
-static int            FindIndex     ( vlc_object_t *, vlc_object_t **, int );
 
 static vlc_list_t   * NewList       ( int );
 static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
@@ -86,7 +85,8 @@ static void vlc_object_detach_unlocked (vlc_object_t *p_this);
 /*****************************************************************************
  * Local structure lock
  *****************************************************************************/
-static vlc_mutex_t    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 )
@@ -141,8 +141,7 @@ void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         p_new->p_libvlc = NULL;
 
         p_libvlc_global->i_counter = 0;
-        p_libvlc_global->i_objects = 0;
-        p_libvlc_global->pp_objects = NULL;
+        p_priv->next = p_priv->prev = p_new;
         vlc_mutex_init( &structure_lock );
     }
     else
@@ -171,12 +170,19 @@ void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     vlc_spin_init( &p_priv->spin );
     p_priv->pipes[0] = p_priv->pipes[1] = -1;
 
+    p_priv->next = VLC_OBJECT (p_libvlc_global);
+#if defined (NDEBUG)
+    /* ... */
+#elif defined (LIBVLC_USE_PTRHEAD)
+    p_priv->creator_id = pthread_self ();
+#elif defined (WIN32)
+    p_priv->creator_id = GetCurrentThreadId ();
+#endif
     vlc_mutex_lock( &structure_lock );
+    p_priv->prev = vlc_internals (p_libvlc_global)->prev;
+    vlc_internals (p_libvlc_global)->prev = p_new;
+    vlc_internals (p_priv->prev)->next = p_new;
     p_new->i_object_id = p_libvlc_global->i_counter++;
-    /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
-     * useless to try and recover anything if pp_objects gets smashed. */
-    TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
-                p_new );
     vlc_mutex_unlock( &structure_lock );
 
     if( i_type == VLC_OBJECT_LIBVLC )
@@ -321,33 +327,6 @@ static void vlc_object_destroy( vlc_object_t *p_this )
     if( p_priv->pf_destructor )
         p_priv->pf_destructor( p_this );
 
-    /* Sanity checks */
-    if( p_priv->i_children )
-    {
-        int i;
-
-        fprintf( stderr,
-                 "ERROR: cannot delete object (%i, %s) with %d children\n",
-                 p_this->i_object_id, p_this->psz_object_name,
-                 p_priv->i_children );
-
-        for( i = 0; i < p_priv->i_children; i++ )
-        {
-            fprintf( stderr,
-                     "ERROR: Remaining children object "
-                     "(id:%i, type:%s, name:%s)\n",
-                     p_priv->pp_children[i]->i_object_id,
-                     p_priv->pp_children[i]->psz_object_type,
-                     p_priv->pp_children[i]->psz_object_name );
-        }
-        fflush(stderr);
-
-        /* Dump libvlc object to ease debugging */
-        vlc_object_dump( p_this->p_libvlc );
-
-        abort();
-    }
-
     /* Destroy the associated variables, starting from the end so that
      * no memmove calls have to be done. */
     while( p_priv->i_vars )
@@ -367,36 +346,31 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 #ifndef NDEBUG
         assert( p_global == vlc_global() );
         /* Test for leaks */
-        if( p_global->i_objects > 0 )
+        if (p_priv->next != p_this)
         {
-            int i;
-            for( i = 0; i < p_global->i_objects; i++ )
+            vlc_object_t *leaked = p_priv->next, *first = leaked;
+            do
             {
                 /* We are leaking this object */
                 fprintf( stderr,
                          "ERROR: 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 );
-
+                         leaked->i_object_id, leaked->psz_object_type,
+                         leaked->psz_object_name );
                 /* Dump libvlc object to ease debugging */
-                vlc_object_dump( p_global->pp_objects[i] );
-
+                vlc_object_dump( leaked );
                 fflush(stderr);
+                leaked = vlc_internals (leaked)->next;
             }
+            while (leaked != first);
 
-            /* Dump libvlc object to ease debugging */
+            /* Dump global object to ease debugging */
             vlc_object_dump( p_this );
-
             /* Strongly abort, cause we want these to be fixed */
             abort();
         }
 #endif
 
         /* We are the global object ... no need to lock. */
-        free( p_global->pp_objects );
-        p_global->pp_objects = NULL;
-
         vlc_mutex_destroy( &structure_lock );
     }
 
@@ -661,57 +635,34 @@ void __vlc_object_kill( vlc_object_t *p_this )
 
 
 /**
- * find an object given its ID
+ * Find an object given its ID.
  *
- * 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).
- *****************************************************************************/
+ * This function looks for the object whose i_object_id field is i_id.
+ * This function is slow, and often used to hide bugs. Do not use it.
+ * If you need to retain reference to an object, yield the object pointer with
+ * vlc_object_yield(), use the pointer as your reference, and call
+ * vlc_object_release() when you're done.
+ */
 void * vlc_object_get( int i_id )
 {
-    int i_max, i_middle;
-    vlc_object_t **pp_objects;
     libvlc_global_data_t *p_libvlc_global = vlc_global();
     vlc_object_t *obj = NULL;
 
     vlc_mutex_lock( &structure_lock );
 
-    pp_objects = p_libvlc_global->pp_objects;
-
-    /* Perform our dichotomy */
-    for( i_max = p_libvlc_global->i_objects - 1 ; ; )
+    for( obj = vlc_internals (p_libvlc_global)->next;
+         obj != VLC_OBJECT (p_libvlc_global);
+         obj = vlc_internals (obj)->next )
     {
-        i_middle = i_max / 2;
-
-        if( pp_objects[i_middle]->i_object_id > i_id )
+        if( obj->i_object_id == i_id )
         {
-            i_max = i_middle;
-        }
-        else if( pp_objects[i_middle]->i_object_id < i_id )
-        {
-            if( i_middle )
-            {
-                pp_objects += i_middle;
-                i_max -= i_middle;
-            }
-            else
-            {
-                /* This happens when there are only two remaining objects */
-                if( pp_objects[i_middle+1]->i_object_id == i_id )
-                {
-                    vlc_object_yield( pp_objects[i_middle+1] );
-                    obj = pp_objects[i_middle+1];
-                }
-                break;
-            }
-        }
-        else
-        {
-            vlc_object_yield( pp_objects[i_middle] );
-            obj = pp_objects[i_middle];
-            break;
+            vlc_object_yield( obj );
+            goto out;
         }
     }
+    obj = NULL;
 
+out:
     vlc_mutex_unlock( &structure_lock );
     return obj;
 }
@@ -734,34 +685,21 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
         return p_this;
     }
 
-    vlc_mutex_lock( &structure_lock );
-
     /* Otherwise, recursively look for the object */
-    if( (i_mode & 0x000f) == FIND_ANYWHERE )
-    {
-        vlc_object_t *p_root = p_this;
-
-        /* Find the root */
-        while( p_root->p_parent != NULL &&
-               p_root != VLC_OBJECT( p_this->p_libvlc ) )
-        {
-            p_root = p_root->p_parent;
-        }
-
-        p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
-        if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
-        {
-            p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
-                                  i_type, (i_mode & ~0x000f)|FIND_CHILD );
-        }
-    }
-    else
+    if ((i_mode & 0x000f) == FIND_ANYWHERE)
     {
-        p_found = FindObject( p_this, i_type, i_mode );
+#ifndef NDEBUG
+        if (i_type == VLC_OBJECT_PLAYLIST)
+           msg_Warn (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
+                      "instead of pl_Yield()");
+#endif
+        return vlc_object_find (p_this->p_libvlc, i_type,
+                                (i_mode & ~0x000f)|FIND_CHILD);
     }
 
+    vlc_mutex_lock( &structure_lock );
+    p_found = FindObject( p_this, i_type, i_mode );
     vlc_mutex_unlock( &structure_lock );
-
     return p_found;
 }
 
@@ -866,19 +804,13 @@ void __vlc_object_release( vlc_object_t *p_this )
 
     if( b_should_destroy )
     {
-        /* Remove the object from the table
+        /* Remove the object from object list
          * so that it cannot be encountered by vlc_object_get() */
-        libvlc_global_data_t *p_libvlc_global = vlc_global();
-        int i_index;
-
-        i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
-                             p_libvlc_global->i_objects );
-        REMOVE_ELEM( p_libvlc_global->pp_objects,
-                     p_libvlc_global->i_objects, i_index );
+        vlc_internals (internals->next)->prev = internals->prev;
+        vlc_internals (internals->prev)->next = internals->next;
 
         /* Detach from parent to protect against FIND_CHILDREN */
-        if (p_this->p_parent)
-            vlc_object_detach_unlocked (p_this);
+        vlc_object_detach_unlocked (p_this);
         /* Detach from children to protect against FIND_PARENT */
         for (int i = 0; i < internals->i_children; i++)
             internals->pp_children[i]->p_parent = NULL;
@@ -887,7 +819,12 @@ void __vlc_object_release( vlc_object_t *p_this )
     vlc_mutex_unlock( &structure_lock );
 
     if( b_should_destroy )
+    {
+        free( internals->pp_children );
+        internals->pp_children = NULL;
+        internals->i_children = 0;
         vlc_object_destroy( p_this );
+    }
 }
 
 /**
@@ -912,6 +849,15 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
     INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
                  p_this );
 
+    /* Kill the object if parent is already dead.
+     * Note: We should surely lock parent here, but that would
+     * create quite a few dead lock case. Hopefully, it
+     * is perfectly safe to do it that way. We only risk
+     * receiving kill event twice. But given current API
+     * it is ok. */
+    if( p_this->p_parent->b_die )
+        vlc_object_kill( p_this );
+
     vlc_mutex_unlock( &structure_lock );
 }
 
@@ -966,15 +912,10 @@ void __vlc_object_detach( vlc_object_t *p_this )
     if( !p_this ) return;
 
     vlc_mutex_lock( &structure_lock );
-
     if( !p_this->p_parent )
-    {
         msg_Err( p_this, "object is not attached" );
-        vlc_mutex_unlock( &structure_lock );
-        return;
-    }
-
-    vlc_object_detach_unlocked( p_this );
+    else
+        vlc_object_detach_unlocked( p_this );
     vlc_mutex_unlock( &structure_lock );
 }
 
@@ -995,7 +936,13 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
     switch( i_mode & 0x000f )
     {
     case FIND_ANYWHERE:
-        return vlc_list_find (vlc_global (), i_type, FIND_CHILD);
+        /* Modules should probably not be object, and the module should perhaps
+         * not be shared across LibVLC instances. In the mean time, this ugly
+         * hack is brought to you by Courmisch. */
+        if (i_type == VLC_OBJECT_MODULE)
+            return vlc_list_find ((vlc_object_t *)vlc_global ()->p_module_bank,
+                                  i_type, FIND_CHILD);
+        return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
 
     case FIND_CHILD:
         vlc_mutex_lock( &structure_lock );
@@ -1005,6 +952,7 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
         /* Check allocation was successful */
         if( p_list->i_count != i_count )
         {
+            vlc_mutex_unlock( &structure_lock );
             msg_Err( p_this, "list allocation failed!" );
             p_list->i_count = 0;
             break;
@@ -1055,21 +1003,18 @@ vlc_list_t *__vlc_list_children( vlc_object_t *obj )
 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
-    libvlc_global_data_t *p_libvlc_global = vlc_global();
-
     (void)oldval; (void)p_data;
     if( *psz_cmd == 'l' )
     {
-        vlc_mutex_lock( &structure_lock );
-
-        vlc_object_t **pp_current, **pp_end;
-
-        pp_current = p_libvlc_global->pp_objects;
-        pp_end = pp_current + p_libvlc_global->i_objects;
-
-        for( ; pp_current < pp_end ; pp_current++ )
-            PrintObject( *pp_current, "" );
+        vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root; 
 
+        vlc_mutex_lock( &structure_lock );
+        do
+        {
+            PrintObject (cur, "");
+            cur = vlc_internals (cur)->next;
+        }
+        while (cur != root);
         vlc_mutex_unlock( &structure_lock );
     }
     else
@@ -1244,46 +1189,6 @@ void __vlc_object_dump( vlc_object_t *p_this )
 
 /* Following functions are local */
 
-/*****************************************************************************
- * FindIndex: find the index of an object in an array of objects
- *****************************************************************************
- * This function assumes that p_this can be found in pp_objects. It will not
- * crash if p_this cannot be found, but will return a wrong value. It is your
- * duty to check the return value if you are not certain that the object could
- * be found for sure.
- *****************************************************************************/
-static int FindIndex( vlc_object_t *p_this,
-                      vlc_object_t **pp_objects, int i_count )
-{
-    int i_middle = i_count / 2;
-
-    if( i_count == 0 )
-    {
-        return 0;
-    }
-
-    if( pp_objects[i_middle] == p_this )
-    {
-        return i_middle;
-    }
-
-    if( i_count == 1 )
-    {
-        return 0;
-    }
-
-    /* We take advantage of the sorted array */
-    if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
-    {
-        return i_middle + FindIndex( p_this, pp_objects + i_middle,
-                                             i_count - i_middle );
-    }
-    else
-    {
-        return FindIndex( p_this, pp_objects, i_middle );
-    }
-}
-
 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
 {
     int i;
@@ -1581,3 +1486,74 @@ static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
         ListChildren( p_list, p_tmp, i_type );
     }
 }
+
+#ifndef NDEBUG
+# ifdef __GLIBC__
+#  include <execinfo.h>
+# endif
+
+void vlc_refcheck (vlc_object_t *obj)
+{
+    static unsigned errors = 0;
+    if (errors > 100)
+        return;
+
+    /* Anyone can use the root object (though it should not exist) */
+    if (obj == VLC_OBJECT (vlc_global ()))
+        return;
+
+    /* Anyone can use its libvlc instance object */
+    if (obj == VLC_OBJECT (obj->p_libvlc))
+        return;
+
+    /* The thread that created the object holds the initial reference */
+    vlc_object_internals_t *priv = vlc_internals (obj);
+#if defined (LIBVLC_USE_PTHREAD)
+    if (pthread_equal (priv->creator_id, pthread_self ()))
+#elif defined WIN32
+    if (priv->creator_id == GetCurrentThreadId ())
+#else
+    if (0)
+#endif
+        return;
+
+    /* A thread can use its own object without reference! */
+    vlc_object_t *caller = vlc_threadobj ();
+    if (caller == obj)
+        return;
+
+    /* 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;
+
+    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;
+
+    fprintf (stderr, "The %s %s thread object is accessing...\n"
+             "the %s %s object in a suspicous manner.\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);
+    fflush (stderr);
+
+#ifdef __GLIBC__
+    void *stack[20];
+    int stackdepth = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
+    backtrace_symbols_fd (stack, stackdepth, 2);
+#endif
+
+    if (++errors == 100)
+        fprintf (stderr, "Too many reference errors!\n");
+}
+#endif