]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
vlc_object_get_name, vlc_object_set_name: accessors
[vlc] / src / misc / objects.c
index fe051fd88992fe090b6aa5606637d25e9713e180..b97f5235f88cd5d0b7fba914bc5e3a9986c836ae 100644 (file)
 #include <vlc_common.h>
 
 #include "../libvlc.h"
-#include <vlc_vout.h>
 #include <vlc_aout.h>
 #include "audio_output/aout_internal.h"
 
-#include <vlc_access.h>
-#include <vlc_demux.h>
-#include <vlc_stream.h>
-
-#include <vlc_sout.h>
-#include "stream_output/stream_output.h"
-
 #include "vlc_interface.h"
 #include "vlc_codec.h"
-#include "vlc_filter.h"
 
 #include "variables.h"
 #ifndef WIN32
 # include <fcntl.h>
 # include <errno.h> /* ENOSYS */
 #endif
-#ifdef HAVE_SYS_EVENTFD_H
+
+#include <limits.h>
+#include <assert.h>
+
+#if defined (HAVE_SYS_EVENTFD_H)
 # include <sys/eventfd.h>
+# define HAVE_EVENTFD 1
 #endif
-#include <assert.h>
+
 
 /*****************************************************************************
  * Local prototypes
@@ -93,13 +89,6 @@ static void vlc_object_dump( vlc_object_t *p_this );
 /*****************************************************************************
  * Local structure lock
  *****************************************************************************/
-static void close_nocancel (int fd)
-{
-    int canc = vlc_savecancel ();
-    close (fd);
-    vlc_restorecancel (canc);
-}
-
 static void libvlc_lock (libvlc_int_t *p_libvlc)
 {
     vlc_mutex_lock (&(libvlc_priv (p_libvlc)->structure_lock));
@@ -134,7 +123,7 @@ void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
 
     p_priv->i_object_type = i_type;
     p_new->psz_object_type = psz_type;
-    p_new->psz_object_name = NULL;
+    p_priv->psz_name = NULL;
 
     p_new->b_die = false;
     p_new->b_error = false;
@@ -172,11 +161,7 @@ void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     p_priv->pp_children = NULL;
     p_priv->i_children = 0;
 
-    p_new->p_private = NULL;
-
     /* Initialize mutexes and condvars */
-    vlc_mutex_init( &p_priv->lock );
-    vlc_cond_init( &p_priv->wait );
     vlc_mutex_init( &p_priv->var_lock );
     vlc_cond_init( &p_priv->var_wait );
     p_priv->pipes[0] = p_priv->pipes[1] = -1;
@@ -219,22 +204,10 @@ void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 
     switch( i_type )
     {
-        case VLC_OBJECT_INTF:
-            i_size = sizeof(intf_thread_t);
-            psz_type = "interface";
-            break;
         case VLC_OBJECT_DECODER:
             i_size = sizeof(decoder_t);
             psz_type = "decoder";
             break;
-        case VLC_OBJECT_PACKETIZER:
-            i_size = sizeof(decoder_t);
-            psz_type = "packetizer";
-            break;
-        case VLC_OBJECT_ENCODER:
-            i_size = sizeof(encoder_t);
-            psz_type = "encoder";
-            break;
         case VLC_OBJECT_AOUT:
             i_size = sizeof(aout_instance_t);
             psz_type = "audio output";
@@ -263,7 +236,24 @@ void __vlc_object_set_destructor( vlc_object_t *p_this,
                                   vlc_destructor_t pf_destructor )
 {
     vlc_object_internals_t *p_priv = vlc_internals(p_this );
+
+    vlc_spin_lock( &p_priv->ref_spin );
     p_priv->pf_destructor = pf_destructor;
+    vlc_spin_unlock( &p_priv->ref_spin );
+}
+
+#undef vlc_object_set_name
+int vlc_object_set_name(vlc_object_t *obj, const char *name)
+{
+    vlc_object_internals_t *priv = vlc_internals(obj);
+
+    /* Object must be named before it is attached (or never) */
+    assert(obj->p_parent == NULL);
+    assert(priv->i_children == 0);
+
+    free(priv->psz_name);
+    priv->psz_name = name ? strdup(name) : NULL;
+    return (priv->psz_name || !name) ? VLC_SUCCESS : VLC_ENOMEM;
 }
 
 /**
@@ -306,11 +296,9 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 
     free( p_this->psz_header );
 
-    FREENULL( p_this->psz_object_name );
+    free( p_priv->psz_name );
 
     vlc_spin_destroy( &p_priv->ref_spin );
-    vlc_mutex_destroy( &p_priv->lock );
-    vlc_cond_destroy( &p_priv->wait );
     if( p_priv->pipes[1] != -1 && p_priv->pipes[1] != p_priv->pipes[0] )
         close( p_priv->pipes[1] );
     if( p_priv->pipes[0] != -1 )
@@ -322,23 +310,6 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 }
 
 
-/** Inter-object signaling */
-
-void __vlc_object_lock( vlc_object_t *obj )
-{
-    vlc_mutex_lock( &(vlc_internals(obj)->lock) );
-}
-
-void __vlc_object_unlock( vlc_object_t *obj )
-{
-    vlc_assert_locked( &(vlc_internals(obj)->lock) );
-    vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
-}
-void __vlc_object_assert_locked( vlc_object_t *obj )
-{
-    vlc_assert_locked( &(vlc_internals(obj)->lock) );
-}
-
 #ifdef WIN32
 # include <winsock2.h>
 # include <ws2tcpip.h>
@@ -392,6 +363,8 @@ error:
 #define close( a )       closesocket (a)
 #endif /* WIN32 */
 
+static vlc_mutex_t pipe_lock = VLC_STATIC_MUTEX;
+
 /**
  * Returns the readable end of a pipe that becomes readable once termination
  * of the object is requested (vlc_object_kill()).
@@ -408,14 +381,15 @@ int vlc_object_waitpipe( vlc_object_t *obj )
 {
     vlc_object_internals_t *internals = vlc_internals( obj );
 
-    vlc_object_lock (obj);
+    vlc_mutex_lock (&pipe_lock);
     if (internals->pipes[0] == -1)
     {
         /* This can only ever happen if someone killed us without locking: */
         assert (internals->pipes[1] == -1);
 
 #ifdef HAVE_EVENTFD
-        if ((internals->pipes[0] = eventfd (0, 0)) == -1)
+        internals->pipes[0] = internals->pipes[1] = eventfd (0, 0);
+        if (internals->pipes[0] == -1)
 #endif
         {
             if (pipe (internals->pipes))
@@ -428,43 +402,11 @@ int vlc_object_waitpipe( vlc_object_t *obj )
             write (internals->pipes[1], &(uint64_t){ 1 }, sizeof (uint64_t));
         }
     }
-    vlc_object_unlock (obj);
+    vlc_mutex_unlock (&pipe_lock);
     return internals->pipes[0];
 }
 
 
-/**
- * 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.
- */
-void __vlc_object_wait( vlc_object_t *obj )
-{
-    vlc_object_internals_t *priv = vlc_internals( obj );
-    vlc_assert_locked( &priv->lock);
-    vlc_cond_wait( &priv->wait, &priv->lock );
-}
-
-
-/**
- * Wakes up one thread waiting on the object. If no thread are (yet) waiting,
- * nothing happens.
- *
- * 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 )
-{
-    vlc_assert_locked (&(vlc_internals(obj)->lock));
-    vlc_cond_signal( &(vlc_internals(obj)->wait) );
-}
-
-
 /**
  * Requests termination of an object, cancels the object thread, and make the
  * object wait pipe (if it exists) readable. Not a cancellation point.
@@ -475,16 +417,15 @@ void __vlc_object_kill( vlc_object_t *p_this )
     int fd = -1;
 
     vlc_thread_cancel( p_this );
-    vlc_object_lock( p_this );
+    vlc_mutex_lock( &pipe_lock );
     if( !p_this->b_die )
     {
         fd = priv->pipes[1];
         p_this->b_die = true;
     }
 
-    vlc_cond_broadcast (&priv->wait);
     /* This also serves as a memory barrier toward vlc_object_alive(): */
-    vlc_object_unlock( p_this );
+    vlc_mutex_unlock( &pipe_lock );
 
     if (fd != -1)
     {
@@ -527,6 +468,14 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
     return p_found;
 }
 
+
+static int objnamecmp(const vlc_object_t *obj, const char *name)
+{
+    if (!vlc_object_get_name(obj))
+        return INT_MIN;
+    return strcmp( vlc_object_get_name(obj), name );
+}
+
 #undef vlc_object_find_name
 /**
  * Finds a named object and increment its reference count.
@@ -549,10 +498,11 @@ vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
 {
     vlc_object_t *p_found;
 
+    /* Reading psz_object_name from a separate inhibits thread-safety.
+     * Use a libvlc address variable instead for that sort of things! */
+    msg_Warn( p_this, "%s(%s) is not safe!", __func__, psz_name );
     /* 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 ) )
+    if( !(i_mode & FIND_STRICT) && !objnamecmp(p_this, psz_name) )
     {
         vlc_object_hold( p_this );
         return p_this;
@@ -639,8 +589,6 @@ 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
@@ -654,7 +602,7 @@ void __vlc_object_release( vlc_object_t *p_this )
                 fprintf( stderr,
                          "ERROR: leaking object (%p, type:%s, name:%s)\n",
                          leaked, leaked->psz_object_type,
-                         leaked->psz_object_name );
+                         vlc_object_get_name(leaked) );
                 /* Dump object to ease debugging */
                 vlc_object_dump( leaked );
                 fflush(stderr);
@@ -674,6 +622,9 @@ void __vlc_object_release( vlc_object_t *p_this )
         if (parent)
             /* Detach from parent to protect against FIND_CHILDREN */
             vlc_object_detach_unlocked (p_this);
+
+        /* We have no children */
+        assert (internals->i_children == 0);
     }
     libvlc_unlock (p_this->p_libvlc);
 
@@ -784,7 +735,7 @@ void __vlc_object_detach( vlc_object_t *p_this )
  * This function recursively looks for a given object type. i_mode can be one
  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
  *****************************************************************************/
-vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
+vlc_list_t * vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 {
     vlc_list_t *p_list;
     int i_count = 0;
@@ -793,7 +744,7 @@ 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 (p_this->p_libvlc, i_type, FIND_CHILD);
+        return vlc_list_find (VLC_OBJECT(p_this->p_libvlc), i_type, FIND_CHILD);
 
     case FIND_CHILD:
         libvlc_lock (p_this->p_libvlc);
@@ -1084,8 +1035,7 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
         p_tmp = p_this->p_parent;
         if( p_tmp )
         {
-            if( p_tmp->psz_object_name
-                && !strcmp( p_tmp->psz_object_name, psz_name ) )
+            if( !objnamecmp(p_tmp, psz_name) )
             {
                 vlc_object_hold( p_tmp );
                 return p_tmp;
@@ -1101,8 +1051,7 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
         for( i = vlc_internals( p_this )->i_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 ) )
+            if( !objnamecmp(p_tmp, psz_name ) )
             {
                 vlc_object_hold( p_tmp );
                 return p_tmp;
@@ -1134,9 +1083,10 @@ static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
 
     int canc = vlc_savecancel ();
     memset( &psz_name, 0, sizeof(psz_name) );
-    if( p_this->psz_object_name )
+    if( vlc_object_get_name(p_this) )
     {
-        snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
+        snprintf( psz_name, 49, " \"%s\"",
+                  vlc_object_get_name(p_this) );
         if( psz_name[48] )
             psz_name[48] = '\"';
     }