]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
vlc_list_children: list children _safely_
[vlc] / src / misc / objects.c
index 97db4e128dee83fd9c99a263b9d605f1f6a7c051..851f1bdcd1a8caddfbb8cde0bc4f51b7d3d0eeaa 100644 (file)
 #endif
 #include <assert.h>
 
-/*****************************************************************************
- * Constants
- *****************************************************************************/
-
-const vlc_destructor_t kVLCDestructor = NULL;
-
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
@@ -76,11 +70,9 @@ static int  DumpCommand( vlc_object_t *, char const *,
 
 static vlc_object_t * FindObject    ( vlc_object_t *, int, int );
 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
-static void           DetachObject  ( vlc_object_t * );
 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 void           SetAttachment ( vlc_object_t *, bool );
 
 static vlc_list_t   * NewList       ( int );
 static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
@@ -89,7 +81,7 @@ 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 );
-static void vlc_object_yield_locked( vlc_object_t *p_this );
+static void vlc_object_detach_unlocked (vlc_object_t *p_this);
 
 /*****************************************************************************
  * Local structure lock
@@ -125,7 +117,6 @@ void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     p_new->b_die = false;
     p_new->b_error = false;
     p_new->b_dead = false;
-    p_priv->b_attached = false;
     p_new->b_force = false;
 
     p_new->psz_header = NULL;
@@ -152,34 +143,20 @@ void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         p_libvlc_global->i_counter = 0;
         p_libvlc_global->i_objects = 0;
         p_libvlc_global->pp_objects = NULL;
-        p_priv->b_attached = true;
         vlc_mutex_init( &structure_lock );
     }
     else
     {
         p_libvlc_global = vlc_global();
         if( i_type == VLC_OBJECT_LIBVLC )
-        {
             p_new->p_libvlc = (libvlc_int_t*)p_new;
-            p_priv->b_attached = true;
-        }
         else
-        {
             p_new->p_libvlc = p_this->p_libvlc;
-        }
     }
 
-    vlc_mutex_lock( &structure_lock );
-    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 );
-
+    vlc_spin_init( &p_priv->ref_spin );
     p_priv->i_refcount = 1;
-    p_priv->pf_destructor = kVLCDestructor;
+    p_priv->pf_destructor = NULL;
     p_priv->b_thread = false;
     p_new->p_parent = NULL;
     p_new->pp_children = NULL;
@@ -194,6 +171,14 @@ 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;
 
+    vlc_mutex_lock( &structure_lock );
+    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 )
     {
         var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
@@ -322,9 +307,8 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 {
     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 
-    /* Automatically detach the object from its parents */
-    if( p_this->p_parent ) vlc_object_detach( p_this );
-
+    /* Objects are always detached beforehand */
+    assert( !p_this->p_parent );
 
     /* Send a kill to the object's thread if applicable */
     vlc_object_kill( p_this );
@@ -420,10 +404,11 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 
 #if defined(WIN32) || defined(UNDER_CE)
     /* if object has an associated thread, close it now */
-    if( p_priv->thread_id.hThread )
-       CloseHandle(p_priv->thread_id.hThread);
+    if( p_priv->thread_id )
+       CloseHandle(p_priv->thread_id);
 #endif
 
+    vlc_spin_destroy( &p_priv->ref_spin );
     vlc_mutex_destroy( &p_this->object_lock );
     vlc_cond_destroy( &p_this->object_wait );
     vlc_spin_destroy( &p_priv->spin );
@@ -686,6 +671,7 @@ 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 );
 
@@ -710,33 +696,24 @@ void * vlc_object_get( int i_id )
             else
             {
                 /* This happens when there are only two remaining objects */
-                if( pp_objects[i_middle+1]->i_object_id == i_id
-                    && vlc_internals( pp_objects[i_middle+1] )->i_refcount > 0 )
+                if( pp_objects[i_middle+1]->i_object_id == i_id )
                 {
-                    vlc_object_yield_locked( pp_objects[i_middle+1] );
-                    vlc_mutex_unlock( &structure_lock );
-                    return pp_objects[i_middle+1];
+                    vlc_object_yield( pp_objects[i_middle+1] );
+                    obj = pp_objects[i_middle+1];
                 }
                 break;
             }
         }
-        else if( vlc_internals( pp_objects[i_middle] )->i_refcount > 0 )
-        {
-            vlc_object_yield_locked( pp_objects[i_middle] );
-            vlc_mutex_unlock( &structure_lock );
-            return pp_objects[i_middle];
-        }
-
-        if( i_max == 0 )
+        else
         {
-            /* this means that i_max == i_middle, and since we have already
-             * tested pp_objects[i_middle]), p_found is properly set. */
+            vlc_object_yield( pp_objects[i_middle] );
+            obj = pp_objects[i_middle];
             break;
         }
     }
 
     vlc_mutex_unlock( &structure_lock );
-    return NULL;
+    return obj;
 }
 
 /**
@@ -750,17 +727,15 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 {
     vlc_object_t *p_found;
 
-    vlc_mutex_lock( &structure_lock );
-
     /* If we are of the requested type ourselves, don't look further */
-    if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type
-        && vlc_internals( p_this )->i_refcount > 0 )
+    if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
     {
-        vlc_object_yield_locked( p_this );
-        vlc_mutex_unlock( &structure_lock );
+        vlc_object_yield( p_this );
         return p_this;
     }
 
+    vlc_mutex_lock( &structure_lock );
+
     /* Otherwise, recursively look for the object */
     if( (i_mode & 0x000f) == FIND_ANYWHERE )
     {
@@ -802,22 +777,17 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 {
     vlc_object_t *p_found;
 
-    vlc_mutex_lock( &structure_lock );
-
-    /* Avoid obvious freed object uses */
-    assert( vlc_internals( p_this )->i_refcount > 0 );
-
     /* If have the requested name ourselves, don't look further */
     if( !(i_mode & FIND_STRICT)
         && p_this->psz_object_name
-        && !strcmp( p_this->psz_object_name, psz_name )
-        && vlc_internals( p_this )->i_refcount > 0 )
+        && !strcmp( p_this->psz_object_name, psz_name ) )
     {
-        vlc_object_yield_locked( p_this );
-        vlc_mutex_unlock( &structure_lock );
+        vlc_object_yield( p_this );
         return p_this;
     }
 
+    vlc_mutex_lock( &structure_lock );
+
     /* Otherwise, recursively look for the object */
     if( (i_mode & 0x000f) == FIND_ANYWHERE )
     {
@@ -849,58 +819,69 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 }
 
 /**
- ****************************************************************************
- * increment an object refcount
- *****************************************************************************/
-
-/* When the structure_lock is locked */
-static void vlc_object_yield_locked( vlc_object_t *p_this )
+ * Increment an object reference counter.
+ */
+void __vlc_object_yield( vlc_object_t *p_this )
 {
-    vlc_assert_locked (&structure_lock);
+    vlc_object_internals_t *internals = vlc_internals( p_this );
 
+    vlc_spin_lock( &internals->ref_spin );
     /* Avoid obvious freed object uses */
-    assert( vlc_internals( p_this )->i_refcount > 0 );
-
+    assert( internals->i_refcount > 0 );
     /* Increment the counter */
-    vlc_internals( p_this )->i_refcount++;
-}
-
-/* Public function */
-void __vlc_object_yield( vlc_object_t *p_this )
-{
-    vlc_mutex_lock( &structure_lock );
-    vlc_object_yield_locked( p_this );
-    vlc_mutex_unlock( &structure_lock );
+    internals->i_refcount++;
+    vlc_spin_unlock( &internals->ref_spin );
 }
 
-
 /*****************************************************************************
  * decrement an object refcount
  * And destroy the object if its refcount reach zero.
  *****************************************************************************/
 void __vlc_object_release( vlc_object_t *p_this )
 {
+    vlc_object_internals_t *internals = vlc_internals( p_this );
     bool b_should_destroy;
 
-    vlc_mutex_lock( &structure_lock );
+    vlc_spin_lock( &internals->ref_spin );
+    assert( internals->i_refcount > 0 );
+
+    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 );
 
-    assert( vlc_internals( p_this )->i_refcount > 0 );
-    vlc_internals( p_this )->i_refcount--;
-    b_should_destroy = (vlc_internals( p_this )->i_refcount == 0);
+    /* 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 );
 
     if( b_should_destroy )
     {
-        /* Make sure this object can't be obtained via vlc_find_object now that
-         * it is freed */
+        /* 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;
 
-        /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
-         * useless to try and recover anything if pp_objects gets smashed. */
         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 );
+
+        /* Detach from parent to protect against FIND_CHILDREN */
+        if (p_this->p_parent)
+            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;
     }
 
     vlc_mutex_unlock( &structure_lock );
@@ -922,25 +903,55 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 
     vlc_mutex_lock( &structure_lock );
 
-    /* Avoid obvious freed object uses */
-    assert( vlc_internals( p_this )->i_refcount > 0 );
-
     /* Attach the parent to its child */
+    assert (!p_this->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 );
 
-    /* Climb up the tree to see whether we are connected with the root */
-    if( vlc_internals( p_parent )->b_attached )
+    vlc_mutex_unlock( &structure_lock );
+}
+
+
+static void vlc_object_detach_unlocked (vlc_object_t *p_this)
+{
+    assert (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-- ; )
     {
-        SetAttachment( p_this, true );
+        if( p_parent->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];
+            }
+        }
     }
 
-    vlc_mutex_unlock( &structure_lock );
+    if( p_parent->i_children )
+    {
+        p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
+                               p_parent->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;
+    }
 }
 
+
 /**
  ****************************************************************************
  * detach object from its parent
@@ -960,17 +971,11 @@ void __vlc_object_detach( vlc_object_t *p_this )
         return;
     }
 
-    /* Climb up the tree to see whether we are connected with the root */
-    if( vlc_internals( p_this->p_parent )->b_attached )
-    {
-        SetAttachment( p_this, false );
-    }
-
-    DetachObject( p_this );
+    vlc_object_detach_unlocked( p_this );
     vlc_mutex_unlock( &structure_lock );
-    p_this = NULL;
 }
 
+
 /**
  ****************************************************************************
  * find a list typed objects and increment their refcount
@@ -981,43 +986,16 @@ void __vlc_object_detach( vlc_object_t *p_this )
 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 {
     vlc_list_t *p_list;
-    vlc_object_t **pp_current, **pp_end;
-    int i_count = 0, i_index = 0;
-    libvlc_global_data_t *p_libvlc_global = vlc_global();
-
-    vlc_mutex_lock( &structure_lock );
+    int i_count = 0;
 
     /* Look for the objects */
     switch( i_mode & 0x000f )
     {
     case FIND_ANYWHERE:
-        pp_current = p_libvlc_global->pp_objects;
-        pp_end = pp_current + p_libvlc_global->i_objects;
-
-        for( ; pp_current < pp_end ; pp_current++ )
-        {
-            if( vlc_internals(*pp_current)->b_attached
-                 && (*pp_current)->i_object_type == i_type )
-            {
-                i_count++;
-            }
-        }
-
-        p_list = NewList( i_count );
-        pp_current = p_libvlc_global->pp_objects;
-
-        for( ; pp_current < pp_end ; pp_current++ )
-        {
-            if( vlc_internals(*pp_current)->b_attached
-                 && (*pp_current)->i_object_type == i_type )
-            {
-                ListReplace( p_list, *pp_current, i_index );
-                if( i_index < i_count ) i_index++;
-            }
-        }
-    break;
+        return vlc_list_find (vlc_global (), i_type, FIND_CHILD);
 
     case FIND_CHILD:
+        vlc_mutex_lock( &structure_lock );
         i_count = CountChildren( p_this, i_type );
         p_list = NewList( i_count );
 
@@ -1031,6 +1009,7 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 
         p_list->i_count = 0;
         ListChildren( p_list, p_this, i_type );
+        vlc_mutex_unlock( &structure_lock );
         break;
 
     default:
@@ -1039,11 +1018,29 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
         break;
     }
 
-    vlc_mutex_unlock( &structure_lock );
-
     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_mutex_lock( &structure_lock );
+    l = NewList( obj->i_children );
+    for (int i = 0; i < l->i_count; i++)
+    {
+        vlc_object_yield( obj->pp_children[i] );
+        l->p_values[i].p_object = obj->pp_children[i];
+    }
+    vlc_mutex_unlock( &structure_lock );
+    return l;
+}
+
 /*****************************************************************************
  * DumpCommand: print the current vlc structure
  *****************************************************************************
@@ -1067,18 +1064,7 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
         pp_end = pp_current + p_libvlc_global->i_objects;
 
         for( ; pp_current < pp_end ; pp_current++ )
-        {
-            if( vlc_internals(*pp_current)->b_attached )
-            {
-                PrintObject( *pp_current, "" );
-            }
-            else
-            {
-                printf( " o %.8i %s (not attached)\n",
-                        (*pp_current)->i_object_id,
-                        (*pp_current)->psz_object_type );
-            }
-        }
+            PrintObject( *pp_current, "" );
 
         vlc_mutex_unlock( &structure_lock );
     }
@@ -1305,10 +1291,9 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
         p_tmp = p_this->p_parent;
         if( p_tmp )
         {
-            if( p_tmp->i_object_type == i_type
-                && vlc_internals( p_tmp )->i_refcount > 0 )
+            if( p_tmp->i_object_type == i_type )
             {
-                vlc_object_yield_locked( p_tmp );
+                vlc_object_yield( p_tmp );
                 return p_tmp;
             }
             else
@@ -1322,10 +1307,9 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
         for( i = p_this->i_children; i--; )
         {
             p_tmp = p_this->pp_children[i];
-            if( p_tmp->i_object_type == i_type
-                && vlc_internals( p_tmp )->i_refcount > 0 )
+            if( p_tmp->i_object_type == i_type )
             {
-                vlc_object_yield_locked( p_tmp );
+                vlc_object_yield( p_tmp );
                 return p_tmp;
             }
             else if( p_tmp->i_children )
@@ -1361,10 +1345,9 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
         if( p_tmp )
         {
             if( p_tmp->psz_object_name
-                && !strcmp( p_tmp->psz_object_name, psz_name )
-                && vlc_internals( p_tmp )->i_refcount > 0 )
+                && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
-                vlc_object_yield_locked( p_tmp );
+                vlc_object_yield( p_tmp );
                 return p_tmp;
             }
             else
@@ -1379,10 +1362,9 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
         {
             p_tmp = p_this->pp_children[i];
             if( p_tmp->psz_object_name
-                && !strcmp( p_tmp->psz_object_name, psz_name )
-                && vlc_internals( p_tmp )->i_refcount > 0 )
+                && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
-                vlc_object_yield_locked( p_tmp );
+                vlc_object_yield( p_tmp );
                 return p_tmp;
             }
             else if( p_tmp->i_children )
@@ -1404,56 +1386,6 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
     return NULL;
 }
 
-static void DetachObject( vlc_object_t *p_this )
-{
-    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-- ; )
-    {
-        if( p_parent->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];
-            }
-        }
-    }
-
-    if( p_parent->i_children )
-    {
-        p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
-                               p_parent->i_children * sizeof(vlc_object_t *) );
-    }
-    else
-    {
-        free( p_parent->pp_children );
-        p_parent->pp_children = NULL;
-    }
-}
-
-/*****************************************************************************
- * SetAttachment: recursively set the b_attached flag of a subtree.
- *****************************************************************************
- * This function is used by the attach and detach functions to propagate
- * the b_attached flag in a subtree.
- *****************************************************************************/
-static void SetAttachment( vlc_object_t *p_this, bool b_attached )
-{
-    int i_index;
-
-    for( i_index = p_this->i_children ; i_index-- ; )
-    {
-        SetAttachment( p_this->pp_children[i_index], b_attached );
-    }
-
-    vlc_internals( p_this )->b_attached = b_attached;
-}
 
 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
 {
@@ -1488,12 +1420,8 @@ static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
 
     psz_thread[0] = '\0';
     if( vlc_internals( p_this )->b_thread )
-        snprintf( psz_thread, 29, " (thread %u)",
-#if defined(WIN32) || defined(UNDER_CE)
-                  (unsigned)vlc_internals( p_this )->thread_id.id );
-#else
-                  (unsigned)vlc_internals( p_this )->thread_id );
-#endif
+        snprintf( psz_thread, 29, " (thread %lu)",
+                  (unsigned long)vlc_internals( p_this )->thread_id );
 
     psz_parent[0] = '\0';
     if( p_this->p_parent )
@@ -1583,7 +1511,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    vlc_object_yield_locked( p_object );
+    vlc_object_yield( p_object );
 
     p_list->p_values[i_index].p_object = p_object;
 
@@ -1605,7 +1533,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    vlc_object_yield_locked( p_object );
+    vlc_object_yield( p_object );
 
     p_list->p_values[p_list->i_count].p_object = p_object;
     p_list->i_count++;