]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
s/pl_Yield/pl_Hold/
[vlc] / src / misc / objects.c
index 58140dd3c8bf8e82ec4f4c02b9d0e81b821c1682..1aae3109a3e22fedfe102641b48790e846e40e41 100644 (file)
@@ -83,12 +83,12 @@ 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);
+static void vlc_object_dump( vlc_object_t *p_this );
 
 /*****************************************************************************
  * Local structure lock
  *****************************************************************************/
 static vlc_mutex_t structure_lock;
-static unsigned    object_counter = 0;
 
 static void close_nocancel (int fd)
 {
@@ -125,7 +125,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_new->b_force = false;
 
     p_new->psz_header = NULL;
@@ -142,25 +141,20 @@ void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         return NULL;
     }
 
-    libvlc_global_data_t *p_libvlc_global;
     if( p_this == NULL )
     {
-        /* Only the global root object is created out of the blue */
-        p_libvlc_global = (libvlc_global_data_t *)p_new;
-        p_new->p_libvlc = NULL;
-
-        object_counter = 0; /* reset */
-        p_priv->next = p_priv->prev = p_new;
-        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;
         else
-            p_new->p_libvlc = p_this->p_libvlc;
+        {
+            p_new->p_libvlc = NULL;
+            vlc_mutex_init( &structure_lock );
+        }
+
+        p_this = p_priv->next = p_priv->prev = p_new;
     }
+    else
+        p_new->p_libvlc = p_this->p_libvlc;
 
     vlc_spin_init( &p_priv->ref_spin );
     p_priv->i_refcount = 1;
@@ -174,17 +168,16 @@ void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
 
     /* Initialize mutexes and condvars */
     vlc_mutex_init( &p_priv->lock );
-    vlc_cond_init( p_new, &p_priv->wait );
+    vlc_cond_init( &p_priv->wait );
     vlc_mutex_init( &p_priv->var_lock );
     vlc_spin_init( &p_priv->spin );
     p_priv->pipes[0] = p_priv->pipes[1] = -1;
 
-    p_priv->next = VLC_OBJECT (p_libvlc_global);
+    p_priv->next = p_this;
     vlc_mutex_lock( &structure_lock );
-    p_priv->prev = vlc_internals (p_libvlc_global)->prev;
-    vlc_internals (p_libvlc_global)->prev = p_new;
+    p_priv->prev = vlc_internals (p_this)->prev;
+    vlc_internals (p_this)->prev = p_new;
     vlc_internals (p_priv->prev)->next = p_new;
-    p_new->i_object_id = object_counter++; /* fetch THEN increment */
     vlc_mutex_unlock( &structure_lock );
 
     if( i_type == VLC_OBJECT_LIBVLC )
@@ -242,10 +235,6 @@ void * __vlc_object_create( vlc_object_t *p_this, int i_type )
             i_size = sizeof( vout_thread_t );
             psz_type = "opengl";
             break;
-        case VLC_OBJECT_ANNOUNCE:
-            i_size = sizeof( announce_handler_t );
-            psz_type = "announce";
-            break;
         default:
             assert( i_type > 0 ); /* unknown type?! */
             i_size = i_type;
@@ -313,48 +302,11 @@ static void vlc_object_destroy( vlc_object_t *p_this )
     free( p_this->psz_header );
 
     if( p_this->p_libvlc == NULL )
-    {
-#ifndef NDEBUG
-        libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
-
-        assert( p_global == vlc_global() );
-        /* Test for leaks */
-        if (p_priv->next != p_this)
-        {
-            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",
-                         leaked->i_object_id, leaked->psz_object_type,
-                         leaked->psz_object_name );
-                /* Dump libvlc object to ease debugging */
-                vlc_object_dump( leaked );
-                fflush(stderr);
-                leaked = vlc_internals (leaked)->next;
-            }
-            while (leaked != first);
-
-            /* 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. */
         vlc_mutex_destroy( &structure_lock );
-    }
 
     FREENULL( p_this->psz_object_name );
 
-#if defined(WIN32) || defined(UNDER_CE)
-    /* if object has an associated thread, close it now */
-    if( p_priv->thread_id )
-       CloseHandle(p_priv->thread_id);
-#endif
-
     vlc_spin_destroy( &p_priv->ref_spin );
     vlc_mutex_destroy( &p_priv->lock );
     vlc_cond_destroy( &p_priv->wait );
@@ -499,16 +451,14 @@ int __vlc_object_waitpipe( vlc_object_t *obj )
 
 
 /**
- * Waits for the object to be signaled (using vlc_object_signal()).
- * It is assumed that the caller has locked the object. This function will
- * unlock the object, and lock it again before returning.
- * If the object was signaled before the caller locked the object, it is
- * undefined whether the signal will be lost or will wake the process.
+ * Suspends until another thread calls vlc_object_signal_unlocked().
+ * The thread may be woken up earlier due to limitations of the underlying
+ * implementation.
+ *
+ * In new code, please use vlc_cond_wait() instead.
  *
  * This function is a cancellation point. In case of cancellation, the object
  * will be in locked state.
- *
- * @return true if the object is dying and should terminate.
  */
 void __vlc_object_wait( vlc_object_t *obj )
 {
@@ -519,29 +469,11 @@ void __vlc_object_wait( vlc_object_t *obj )
 
 
 /**
- * Waits for the object to be signaled (using vlc_object_signal()), or for
- * a timer to expire. It is asserted that the caller holds the object lock.
- *
- * This function is a cancellation point. In case of cancellation, the object
- * will be in locked state.
+ * Wakes up one thread waiting on the object. If no thread are (yet) waiting,
+ * nothing happens.
  *
- * @return 0 if the object was signaled before the timer expiration, or
- * ETIMEDOUT if the timer expired without any signal.
- */
-int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
-{
-    vlc_object_internals_t *priv = vlc_internals( obj );
-    vlc_assert_locked( &priv->lock);
-    return vlc_cond_timedwait( &priv->wait, &priv->lock, deadline );
-}
-
-
-/**
- * Signals an object for which the lock is held.
- * At least one thread currently sleeping in vlc_object_wait() or
- * vlc_object_timedwait() will wake up, assuming that there is at least one
- * such thread in the first place. Otherwise, it is undefined whether the
- * signal will be lost or will wake up one or more thread later.
+ * Please do not use this function in new code as we are trying to untangle
+ * objects and threads. Use vlc_cond_wait() instead.
  */
 void __vlc_object_signal_unlocked( vlc_object_t *obj )
 {
@@ -574,53 +506,13 @@ void __vlc_object_kill( vlc_object_t *p_this )
         close_nocancel (fd);
     }
 
-    vlc_object_signal_unlocked( p_this );
+    vlc_cond_broadcast (&priv->wait);
     /* This also serves as a memory barrier toward vlc_object_alive(): */
     vlc_object_unlock( p_this );
 }
 
 
-/**
- * Find an object given its ID.
- *
- * 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 )
-{
-    libvlc_global_data_t *p_libvlc_global = vlc_global();
-    vlc_object_t *obj = NULL;
-#ifndef NDEBUG
-    int canc = vlc_savecancel ();
-    fprintf (stderr, "Use of deprecated vlc_object_get(%d)\n", i_id);
-    vlc_restorecancel (canc);
-#endif
-    vlc_mutex_lock( &structure_lock );
-
-    for( obj = vlc_internals (p_libvlc_global)->next;
-         obj != VLC_OBJECT (p_libvlc_global);
-         obj = vlc_internals (obj)->next )
-    {
-        if( obj->i_object_id == i_id )
-        {
-            vlc_object_yield( obj );
-            goto out;
-        }
-    }
-    obj = NULL;
-#ifndef NDEBUG
-    fprintf (stderr, "Object %d does not exist\n", i_id);
-#endif
-out:
-    vlc_mutex_unlock( &structure_lock );
-    return obj;
-}
-
-/**
- ****************************************************************************
+/*****************************************************************************
  * find a typed object and increment its refcount
  *****************************************************************************
  * This function recursively looks for a given object type. i_mode can be one
@@ -633,7 +525,7 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
     /* 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_object_yield( p_this );
+        vlc_object_hold( p_this );
         return p_this;
     }
 
@@ -643,7 +535,7 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 #ifndef NDEBUG
         if (i_type == VLC_OBJECT_PLAYLIST)
            msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
-                     "instead of pl_Yield()");
+                     "instead of pl_Hold()");
 #endif
         return vlc_object_find (p_this->p_libvlc, i_type,
                                 (i_mode & ~0x000f)|FIND_CHILD);
@@ -655,15 +547,25 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
     return p_found;
 }
 
+#undef vlc_object_find_name
 /**
- ****************************************************************************
- * find a named object and increment its refcount
- *****************************************************************************
- * This function recursively looks for a given object name. i_mode can be one
- * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
- *****************************************************************************/
-void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
-                               int i_mode )
+ * Finds a named object and increment its reference count.
+ * Beware that objects found in this manner can be "owned" by another thread,
+ * be of _any_ type, and be attached to any module (if any). With such an
+ * object reference, you can set or get object variables, emit log messages,
+ * and read write-once object parameters (psz_object_type, etc).
+ * You CANNOT cast the object to a more specific object type, and you
+ * definitely cannot invoke object type-specific callbacks with this.
+ *
+ * @param p_this object to search from
+ * @param psz_name name of the object to search for
+ * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
+ *
+ * @return a matching object (must be released by the caller),
+ * or NULL on error.
+ */
+vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
+                                    const char *psz_name, int i_mode )
 {
     vlc_object_t *p_found;
 
@@ -672,7 +574,7 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
         && p_this->psz_object_name
         && !strcmp( p_this->psz_object_name, psz_name ) )
     {
-        vlc_object_yield( p_this );
+        vlc_object_hold( p_this );
         return p_this;
     }
 
@@ -711,7 +613,7 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 /**
  * Increment an object reference counter.
  */
-void __vlc_object_yield( vlc_object_t *p_this )
+void * __vlc_object_hold( vlc_object_t *p_this )
 {
     vlc_object_internals_t *internals = vlc_internals( p_this );
 
@@ -721,6 +623,7 @@ void __vlc_object_yield( vlc_object_t *p_this )
     /* Increment the counter */
     internals->i_refcount++;
     vlc_spin_unlock( &internals->ref_spin );
+    return p_this;
 }
 
 /*****************************************************************************
@@ -730,6 +633,7 @@ 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 );
+    vlc_object_t *parent = NULL;
     bool b_should_destroy;
 
     vlc_spin_lock( &internals->ref_spin );
@@ -756,30 +660,53 @@ void __vlc_object_release( vlc_object_t *p_this )
 
     if( b_should_destroy )
     {
+        /* We have no children */
+        assert (internals->i_children == 0);
+        parent = p_this->p_parent;
+
+#ifndef NDEBUG
+        if( VLC_OBJECT(p_this->p_libvlc) == p_this )
+        {
+            /* Test for leaks */
+            vlc_object_t *leaked = internals->next;
+            while( leaked != p_this )
+            {
+                /* We are leaking this object */
+                fprintf( stderr,
+                         "ERROR: leaking object (%p, type:%s, name:%s)\n",
+                         leaked, leaked->psz_object_type,
+                         leaked->psz_object_name );
+                /* Dump object to ease debugging */
+                vlc_object_dump( leaked );
+                fflush(stderr);
+                leaked = vlc_internals (leaked)->next;
+            }
+
+            if( internals->next != p_this )
+                /* Dump libvlc object to ease debugging */
+                vlc_object_dump( p_this );
+        }
+#endif
         /* 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 */
-        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;
+        if (parent)
+            /* Detach from parent to protect against FIND_CHILDREN */
+            vlc_object_detach_unlocked (p_this);
     }
-
     vlc_mutex_unlock( &structure_lock );
 
     if( b_should_destroy )
     {
         int canc;
 
-        free( internals->pp_children );
-        internals->pp_children = NULL;
-        internals->i_children = 0;
         canc = vlc_savecancel ();
         vlc_object_destroy( p_this );
         vlc_restorecancel (canc);
+        if (parent)
+            vlc_object_release (parent);
     }
 }
 
@@ -794,6 +721,7 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 {
     if( !p_this ) return;
 
+    vlc_object_hold (p_parent);
     vlc_mutex_lock( &structure_lock );
 
     /* Attach the parent to its child */
@@ -836,8 +764,11 @@ static void vlc_object_detach_unlocked (vlc_object_t *p_this)
 
     if( priv->i_children )
     {
-        priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
-                               priv->i_children * sizeof(vlc_object_t *) );
+        vlc_object_t **pp_children = (vlc_object_t **)
+            realloc( priv->pp_children,
+                     priv->i_children * sizeof(vlc_object_t *) );
+        if( pp_children )
+            priv->pp_children = pp_children;
     }
     else
     {
@@ -856,14 +787,17 @@ static void vlc_object_detach_unlocked (vlc_object_t *p_this)
  *****************************************************************************/
 void __vlc_object_detach( vlc_object_t *p_this )
 {
+    vlc_object_t *p_parent;
     if( !p_this ) return;
 
     vlc_mutex_lock( &structure_lock );
-    if( !p_this->p_parent )
-        msg_Err( p_this, "object is not attached" );
-    else
+    p_parent = p_this->p_parent;
+    if (p_parent)
         vlc_object_detach_unlocked( p_this );
     vlc_mutex_unlock( &structure_lock );
+
+    if (p_parent)
+        vlc_object_release (p_parent);
 }
 
 
@@ -887,7 +821,7 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
          * 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,
+            return vlc_list_find ((vlc_object_t *)p_module_bank,
                                   i_type, FIND_CHILD);
         return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
 
@@ -933,7 +867,7 @@ vlc_list_t *__vlc_list_children( vlc_object_t *obj )
     l = NewList( priv->i_children );
     for (int i = 0; i < l->i_count; i++)
     {
-        vlc_object_yield( priv->pp_children[i] );
+        vlc_object_hold( priv->pp_children[i] );
         l->p_values[i].p_object = priv->pp_children[i];
     }
     vlc_mutex_unlock( &structure_lock );
@@ -950,10 +884,12 @@ 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_int_t *p_libvlc = p_this->p_libvlc;
+
     (void)oldval; (void)p_data;
     if( *psz_cmd == 'l' )
     {
-        vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
+        vlc_object_t *cur = VLC_OBJECT (p_libvlc);
 
         vlc_mutex_lock( &structure_lock );
         do
@@ -961,7 +897,7 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
             PrintObject (cur, "");
             cur = vlc_internals (cur)->next;
         }
-        while (cur != root);
+        while (cur != VLC_OBJECT(p_libvlc));
         vlc_mutex_unlock( &structure_lock );
     }
     else
@@ -972,13 +908,9 @@ 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( i_id );
-            else
-                /* try using the object's name to find it */
-                p_object = vlc_object_find_name( p_this, newval.psz_string,
-                                                 FIND_ANYWHERE );
-
+            /* try using the object's name to find it */
+            p_object = vlc_object_find_name( p_this, newval.psz_string,
+                                             FIND_ANYWHERE );
             if( !p_object )
             {
                 return VLC_ENOOBJ;
@@ -992,7 +924,7 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
             char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
 
             if( !p_object )
-                p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
+                p_object = VLC_OBJECT(p_this->p_libvlc);
 
             psz_foo[0] = '|';
             DumpStructure( p_object, 0, psz_foo );
@@ -1047,7 +979,7 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
                     printf( ", command" );
                 if( p_var->i_entries )
                     printf( ", %d callbacks", p_var->i_entries );
-                switch( p_var->i_type & 0x00f0 )
+                switch( p_var->i_type & VLC_VAR_CLASS )
                 {
                     case VLC_VAR_VOID:
                     case VLC_VAR_MUTEX:
@@ -1111,13 +1043,13 @@ void vlc_list_release( vlc_list_t *p_list )
 /*****************************************************************************
  * dump an object. (Debug function)
  *****************************************************************************/
-void __vlc_object_dump( vlc_object_t *p_this )
+static void vlc_object_dump( vlc_object_t *p_this )
 {
-    vlc_mutex_lock( &structure_lock );
     char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
     psz_foo[0] = '|';
+
+    vlc_assert_locked( &structure_lock );
     DumpStructure( p_this, 0, psz_foo );
-    vlc_mutex_unlock( &structure_lock );
 }
 
 /* Following functions are local */
@@ -1135,7 +1067,7 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
         {
             if( p_tmp->i_object_type == i_type )
             {
-                vlc_object_yield( p_tmp );
+                vlc_object_hold( p_tmp );
                 return p_tmp;
             }
             else
@@ -1151,7 +1083,7 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
             p_tmp = vlc_internals( p_this )->pp_children[i];
             if( p_tmp->i_object_type == i_type )
             {
-                vlc_object_yield( p_tmp );
+                vlc_object_hold( p_tmp );
                 return p_tmp;
             }
             else if( vlc_internals( p_tmp )->i_children )
@@ -1189,7 +1121,7 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
             if( p_tmp->psz_object_name
                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
-                vlc_object_yield( p_tmp );
+                vlc_object_hold( p_tmp );
                 return p_tmp;
             }
             else
@@ -1206,7 +1138,7 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
             if( p_tmp->psz_object_name
                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
-                vlc_object_yield( p_tmp );
+                vlc_object_hold( p_tmp );
                 return p_tmp;
             }
             else if( vlc_internals( p_tmp )->i_children )
@@ -1269,10 +1201,10 @@ static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
 
     psz_parent[0] = '\0';
     if( p_this->p_parent )
-        snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
+        snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
 
-    printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
-            p_this->i_object_id, p_this->psz_object_type,
+    printf( " %so %p %s%s%s%s%s%s\n", psz_prefix,
+            p_this, p_this->psz_object_type,
             psz_name, psz_thread, psz_refcount, psz_children,
             psz_parent );
     vlc_restorecancel (canc);
@@ -1357,7 +1289,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    vlc_object_yield( p_object );
+    vlc_object_hold( p_object );
 
     p_list->p_values[i_index].p_object = p_object;
 
@@ -1379,7 +1311,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    vlc_object_yield( p_object );
+    vlc_object_hold( p_object );
 
     p_list->p_values[p_list->i_count].p_object = p_object;
     p_list->i_count++;