]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
Use a doubly-linked list for objects instead of a flat table
[vlc] / src / misc / objects.c
index 010d64df390d6b1bcf88dd9d415881232d0303e4..06177dc240ad8867592e6721b8168507ad04d5bc 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 );
@@ -141,8 +140,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
@@ -159,8 +157,8 @@ void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     p_priv->pf_destructor = NULL;
     p_priv->b_thread = false;
     p_new->p_parent = NULL;
-    p_new->pp_children = NULL;
-    p_new->i_children = 0;
+    p_priv->pp_children = NULL;
+    p_priv->i_children = 0;
 
     p_new->p_private = NULL;
 
@@ -171,12 +169,12 @@ 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);
     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 +319,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_this->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_this->i_children );
-
-        for( i = 0; i < p_this->i_children; i++ )
-        {
-            fprintf( stderr,
-                     "ERROR: Remaining children object "
-                     "(id:%i, type:%s, name:%s)\n",
-                     p_this->pp_children[i]->i_object_id,
-                     p_this->pp_children[i]->psz_object_type,
-                     p_this->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 +338,30 @@ 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 )
+        for( vlc_object_t *leaked = p_priv->next;
+             leaked != p_this;
+             leaked = vlc_internals (leaked)->next )
         {
-            int i;
-            for( i = 0; i < p_global->i_objects; i++ )
-            {
-                /* 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 );
-
-                /* Dump libvlc object to ease debugging */
-                vlc_object_dump( p_global->pp_objects[i] );
-
-                fflush(stderr);
-            }
+            /* We are leaking this object */
+            fprintf( stderr,
+                     "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
+                     leaked->i_object_id, leaked->psz_object_type,
+                     leaked->psz_object_name );
+            /* Dump libvlc object to ease debugging */
+            vlc_object_dump( leaked );
+            fflush(stderr);
+        }
 
+        if( p_priv->next != p_this )
+        {
             /* Dump libvlc 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 );
     }
 
@@ -652,8 +617,8 @@ void __vlc_object_kill( vlc_object_t *p_this )
     }
 
     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] );
+        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 );
@@ -661,54 +626,29 @@ 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 );
+            return obj;
         }
     }
 
@@ -734,34 +674,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;
 }
 
@@ -840,43 +767,53 @@ void __vlc_object_yield( vlc_object_t *p_this )
 void __vlc_object_release( vlc_object_t *p_this )
 {
     vlc_object_internals_t *internals = vlc_internals( p_this );
+    bool b_should_destroy;
 
     vlc_spin_lock( &internals->ref_spin );
     assert( internals->i_refcount > 0 );
 
-    if( --internals->i_refcount )
+    if( internals->i_refcount > 1 )
     {
         /* Fast path */
         /* There are still other references to the object */
+        internals->i_refcount--;
         vlc_spin_unlock( &internals->ref_spin );
         return;
     }
     vlc_spin_unlock( &internals->ref_spin );
 
-    /* Slow path : object destruction */
+    /* Slow path */
     /* Remember that we cannot hold the spin while waiting on the mutex */
     vlc_mutex_lock( &structure_lock );
+    /* Take the spin again. Note that another thread may have yielded the
+     * object in the (very short) mean time. */
+    vlc_spin_lock( &internals->ref_spin );
+    b_should_destroy = --internals->i_refcount == 0;
+    vlc_spin_unlock( &internals->ref_spin );
 
-    /* Remove the object from the table
-     * 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 );
+    if( b_should_destroy )
+    {
+        /* Remove the object from object list
+         * so that it cannot be encountered by vlc_object_get() */
+        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)
+        /* Detach from parent to protect against FIND_CHILDREN */
         vlc_object_detach_unlocked (p_this);
-    /* Detach from children to protect against FIND_PARENT */
-    for (int i = 0; i < p_this->i_children; i++)
-        p_this->pp_children[i]->p_parent = NULL;
+        /* Detach from children to protect against FIND_PARENT */
+        for (int i = 0; i < internals->i_children; i++)
+            internals->pp_children[i]->p_parent = NULL;
+    }
 
     vlc_mutex_unlock( &structure_lock );
 
-    vlc_object_destroy( p_this );
+    if( b_should_destroy )
+    {
+        free( internals->pp_children );
+        internals->pp_children = NULL;
+        internals->i_children = 0;
+        vlc_object_destroy( p_this );
+    }
 }
 
 /**
@@ -897,8 +834,9 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
     p_this->p_parent = p_parent;
 
     /* Attach the child to its parent */
-    INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
-                 p_parent->i_children, p_this );
+    vlc_object_internals_t *priv = vlc_internals( p_parent );
+    INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
+                 p_this );
 
     vlc_mutex_unlock( &structure_lock );
 }
@@ -906,37 +844,39 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 
 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
 {
-    assert (p_this->p_parent);
+    vlc_assert_locked (&structure_lock);
+
+    if (p_this->p_parent == NULL)
+        return;
+
+    vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
 
-    vlc_object_t *p_parent = p_this->p_parent;
     int i_index, i;
 
     /* Remove p_this's parent */
     p_this->p_parent = NULL;
 
     /* Remove all of p_parent's children which are p_this */
-    for( i_index = p_parent->i_children ; i_index-- ; )
+    for( i_index = priv->i_children ; i_index-- ; )
     {
-        if( p_parent->pp_children[i_index] == p_this )
+        if( priv->pp_children[i_index] == p_this )
         {
-            p_parent->i_children--;
-            for( i = i_index ; i < p_parent->i_children ; i++ )
-            {
-                p_parent->pp_children[i] = p_parent->pp_children[i+1];
-            }
+            priv->i_children--;
+            for( i = i_index ; i < priv->i_children ; i++ )
+                priv->pp_children[i] = priv->pp_children[i+1];
         }
     }
 
-    if( p_parent->i_children )
+    if( priv->i_children )
     {
-        p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
-                               p_parent->i_children * sizeof(vlc_object_t *) );
+        priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
+                               priv->i_children * sizeof(vlc_object_t *) );
     }
     else
     {
         /* Special case - don't realloc() to zero to avoid leaking */
-        free( p_parent->pp_children );
-        p_parent->pp_children = NULL;
+        free( priv->pp_children );
+        priv->pp_children = NULL;
     }
 }
 
@@ -952,15 +892,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 );
 }
 
@@ -981,7 +916,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 );
@@ -1010,6 +951,27 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
     return p_list;
 }
 
+/**
+ * Gets the list of children of an objects, and increment their reference
+ * count.
+ * @return a list (possibly empty) or NULL in case of error.
+ */
+vlc_list_t *__vlc_list_children( vlc_object_t *obj )
+{
+    vlc_list_t *l;
+    vlc_object_internals_t *priv = vlc_internals( obj );
+
+    vlc_mutex_lock( &structure_lock );
+    l = NewList( priv->i_children );
+    for (int i = 0; i < l->i_count; i++)
+    {
+        vlc_object_yield( priv->pp_children[i] );
+        l->p_values[i].p_object = priv->pp_children[i];
+    }
+    vlc_mutex_unlock( &structure_lock );
+    return l;
+}
+
 /*****************************************************************************
  * DumpCommand: print the current vlc structure
  *****************************************************************************
@@ -1020,21 +982,18 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 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
@@ -1209,46 +1168,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;
@@ -1273,15 +1192,15 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
         break;
 
     case FIND_CHILD:
-        for( i = p_this->i_children; i--; )
+        for( i = vlc_internals( p_this )->i_children; i--; )
         {
-            p_tmp = p_this->pp_children[i];
+            p_tmp = vlc_internals( p_this )->pp_children[i];
             if( p_tmp->i_object_type == i_type )
             {
                 vlc_object_yield( p_tmp );
                 return p_tmp;
             }
-            else if( p_tmp->i_children )
+            else if( vlc_internals( p_tmp )->i_children )
             {
                 p_tmp = FindObject( p_tmp, i_type, i_mode );
                 if( p_tmp )
@@ -1327,16 +1246,16 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
         break;
 
     case FIND_CHILD:
-        for( i = p_this->i_children; i--; )
+        for( i = vlc_internals( p_this )->i_children; i--; )
         {
-            p_tmp = p_this->pp_children[i];
+            p_tmp = vlc_internals( p_this )->pp_children[i];
             if( p_tmp->psz_object_name
                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
                 vlc_object_yield( p_tmp );
                 return p_tmp;
             }
-            else if( p_tmp->i_children )
+            else if( vlc_internals( p_tmp )->i_children )
             {
                 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
                 if( p_tmp )
@@ -1370,7 +1289,7 @@ static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
     }
 
     psz_children[0] = '\0';
-    switch( p_this->i_children )
+    switch( vlc_internals( p_this )->i_children )
     {
         case 0:
             break;
@@ -1378,7 +1297,8 @@ static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
             strcpy( psz_children, ", 1 child" );
             break;
         default:
-            snprintf( psz_children, 19, ", %i children", p_this->i_children );
+            snprintf( psz_children, 19, ", %i children",
+                      vlc_internals( p_this )->i_children );
             break;
     }
 
@@ -1418,7 +1338,7 @@ static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
         return;
     }
 
-    for( i = 0 ; i < p_this->i_children ; i++ )
+    for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
     {
         if( i_level )
         {
@@ -1430,7 +1350,7 @@ static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
             }
         }
 
-        if( i == p_this->i_children - 1 )
+        if( i == vlc_internals( p_this )->i_children - 1 )
         {
             psz_foo[i_level] = '`';
         }
@@ -1442,7 +1362,8 @@ static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
         psz_foo[i_level+1] = '-';
         psz_foo[i_level+2] = '\0';
 
-        DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
+        DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
+                       psz_foo );
     }
 }
 
@@ -1515,19 +1436,15 @@ static int CountChildren( vlc_object_t *p_this, int i_type )
     vlc_object_t *p_tmp;
     int i, i_count = 0;
 
-    for( i = 0; i < p_this->i_children; i++ )
+    for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
     {
-        p_tmp = p_this->pp_children[i];
+        p_tmp = vlc_internals( p_this )->pp_children[i];
 
         if( p_tmp->i_object_type == i_type )
         {
             i_count++;
         }
-
-        if( p_tmp->i_children )
-        {
-            i_count += CountChildren( p_tmp, i_type );
-        }
+        i_count += CountChildren( p_tmp, i_type );
     }
 
     return i_count;
@@ -1538,18 +1455,13 @@ static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
     vlc_object_t *p_tmp;
     int i;
 
-    for( i = 0; i < p_this->i_children; i++ )
+    for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
     {
-        p_tmp = p_this->pp_children[i];
+        p_tmp = vlc_internals( p_this )->pp_children[i];
 
         if( p_tmp->i_object_type == i_type )
-        {
             ListReplace( p_list, p_tmp, p_list->i_count++ );
-        }
 
-        if( p_tmp->i_children )
-        {
-            ListChildren( p_list, p_tmp, i_type );
-        }
+        ListChildren( p_list, p_tmp, i_type );
     }
 }