]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
_pipe is not selectable on Windows, so return -1
[vlc] / src / misc / objects.c
index 794898e0b9af0d8b1acffeb9735dad4171b0206e..98a4062018c9fbb7015bcc58feff05addae9420a 100644 (file)
  *****************************************************************************/
 #include <vlc/vlc.h>
 
-#ifdef HAVE_STDLIB_H
-#   include <stdlib.h>                                          /* realloc() */
-#endif
-
 #include "../libvlc.h"
 #include <vlc_vout.h>
 #include <vlc_aout.h>
 #include "vlc_meta.h"
 
 #include "variables.h"
+#ifndef WIN32
+# include <unistd.h>
+#else
+# include <io.h>
+# include <fcntl.h>
+#endif
 
 /*****************************************************************************
  * Local prototypes
@@ -120,12 +122,11 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     p_new->b_die = VLC_FALSE;
     p_new->b_error = VLC_FALSE;
     p_new->b_dead = VLC_FALSE;
-    p_new->b_attached = VLC_FALSE;
+    p_priv->b_attached = VLC_FALSE;
     p_new->b_force = VLC_FALSE;
 
     p_new->psz_header = NULL;
 
-    p_new->i_flags = 0;
     if( p_this->i_flags & OBJECT_FLAGS_NODBG )
         p_new->i_flags |= OBJECT_FLAGS_NODBG;
     if( p_this->i_flags & OBJECT_FLAGS_QUIET )
@@ -133,10 +134,9 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
         p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
 
-    p_new->i_vars = 0;
-    p_new->p_vars = (variable_t *)malloc( 16 * sizeof( variable_t ) );
+    p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
 
-    if( !p_new->p_vars )
+    if( !p_priv->p_vars )
     {
         if( i_type != VLC_OBJECT_GLOBAL )
             free( p_priv );
@@ -147,7 +147,6 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     {
         /* If i_type is global, then p_new is actually p_libvlc_global */
         libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
-        p_new->p_libvlc_global = p_new;
         p_new->p_libvlc = NULL;
 
         p_libvlc_global->i_counter = 0;
@@ -156,14 +155,20 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         p_libvlc_global->i_objects = 1;
         p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
         p_libvlc_global->pp_objects[0] = p_new;
-        p_new->b_attached = VLC_TRUE;
+        p_priv->b_attached = VLC_TRUE;
     }
     else
     {
         libvlc_global_data_t *p_libvlc_global = vlc_global();
-        p_new->p_libvlc_global = VLC_OBJECT (p_libvlc_global);
-        p_new->p_libvlc = ( i_type == VLC_OBJECT_LIBVLC ) ? (libvlc_int_t*)p_new
-                                                       : p_this->p_libvlc;
+        if( i_type == VLC_OBJECT_LIBVLC )
+        {
+            p_new->p_libvlc = (libvlc_int_t*)p_new;
+            p_priv->b_attached = VLC_TRUE;
+        }
+        else
+        {
+            p_new->p_libvlc = p_this->p_libvlc;
+        }
 
         vlc_mutex_lock( &structure_lock );
 
@@ -178,7 +183,7 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
         vlc_mutex_unlock( &structure_lock );
     }
 
-    p_new->i_refcount = 0;
+    p_priv->i_refcount = 0;
     p_new->p_parent = NULL;
     p_new->pp_children = NULL;
     p_new->i_children = 0;
@@ -188,12 +193,16 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     /* Initialize mutexes and condvars */
     vlc_mutex_init( p_new, &p_new->object_lock );
     vlc_cond_init( p_new, &p_new->object_wait );
-    vlc_mutex_init( p_new, &p_new->var_lock );
+    vlc_mutex_init( p_new, &p_priv->var_lock );
+    p_priv->pipes[0] = p_priv->pipes[1] = -1;
 
     if( i_type == VLC_OBJECT_GLOBAL )
     {
         vlc_mutex_init( p_new, &structure_lock );
+    }
 
+    if( i_type == VLC_OBJECT_LIBVLC )
+    {
         var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
         var_AddCallback( p_new, "list", DumpCommand, NULL );
         var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
@@ -297,10 +306,6 @@ void * __vlc_object_create( vlc_object_t *p_this, int i_type )
             i_size = sizeof( vod_t );
             psz_type = "vod server";
             break;
-        case VLC_OBJECT_TLS:
-            i_size = sizeof( tls_t );
-            psz_type = "tls";
-            break;
         case VLC_OBJECT_XML:
             i_size = sizeof( xml_t );
             psz_type = "xml";
@@ -360,7 +365,7 @@ void __vlc_object_destroy( vlc_object_t *p_this )
         return;
     }
 
-    while( p_this->i_refcount )
+    while( p_priv->i_refcount > 0 )
     {
         i_delay++;
 
@@ -368,15 +373,15 @@ void __vlc_object_destroy( vlc_object_t *p_this )
         if( i_delay == 2 )
         {
             msg_Warn( p_this,
-                  "refcount is %i, delaying before deletion (id=%d,type=%d)",
-                  p_this->i_refcount, p_this->i_object_id,
+                  "refcount is %u, delaying before deletion (id=%d,type=%d)",
+                  p_priv->i_refcount, p_this->i_object_id,
                   p_this->i_object_type );
         }
         else if( i_delay == 10 )
         {
             msg_Err( p_this,
-                  "refcount is %i, delaying again (id=%d,type=%d)",
-                  p_this->i_refcount, p_this->i_object_id,
+                  "refcount is %u, delaying again (id=%d,type=%d)",
+                  p_priv->i_refcount, p_this->i_object_id,
                   p_this->i_object_type );
         }
         else if( i_delay == 20 )
@@ -392,13 +397,13 @@ void __vlc_object_destroy( vlc_object_t *p_this )
 
     /* Destroy the associated variables, starting from the end so that
      * no memmove calls have to be done. */
-    while( p_this->i_vars )
+    while( p_priv->i_vars )
     {
-        var_Destroy( p_this, p_this->p_vars[p_this->i_vars - 1].psz_name );
+        var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
     }
 
-    free( p_this->p_vars );
-    vlc_mutex_destroy( &p_this->var_lock );
+    free( p_priv->p_vars );
+    vlc_mutex_destroy( &p_priv->var_lock );
 
     if( p_this->psz_header ) free( p_this->psz_header );
 
@@ -429,8 +434,18 @@ void __vlc_object_destroy( vlc_object_t *p_this )
         vlc_mutex_unlock( &structure_lock );
     }
 
+#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);
+#endif
+
     vlc_mutex_destroy( &p_this->object_lock );
     vlc_cond_destroy( &p_this->object_wait );
+    if( p_priv->pipes[0] != -1 )
+        close( p_priv->pipes[0] );
+    if( p_priv->pipes[1] != -1 )
+        close( p_priv->pipes[1] );
 
     /* global is not dynamically allocated by vlc_object_create */
     if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
@@ -438,28 +453,170 @@ void __vlc_object_destroy( vlc_object_t *p_this )
 }
 
 
-void __vlc_object_kill( vlc_object_t *p_this )
+/** Inter-object signaling */
+
+void __vlc_object_lock( vlc_object_t *obj )
 {
-    vlc_mutex_lock( &p_this->object_lock );
-    p_this->b_die = VLC_TRUE;
-    vlc_mutex_unlock( &p_this->object_lock );
+    vlc_mutex_lock( &obj->object_lock );
+}
+
+void __vlc_object_unlock( vlc_object_t *obj )
+{
+    vlc_assert_locked( &obj->object_lock );
+    vlc_mutex_unlock( &obj->object_lock );
+}
+
+/**
+ * Returns the readable end of a pipe that becomes readable whenever
+ * an object is signaled. This can be used to wait for VLC object events
+ * inside select(), poll() loops or frameworks providing an event loop.
+ *
+ * Note that the pipe will remain the same for the lifetime of the object.
+ * DO NOT close it yourself. Ever.
+ *
+ * DO NOT try to read from the pipe either: call vlc_object_wait() instead.
+ * Assuming the pipe is readable, vlc_object_wait() will not block.
+ * Also note that, as with vlc_object_wait(), there may be spurious wakeups.
+ *
+ * @param obj object that would be signaled (object lock MUST hold)
+ * @return a readable pipe descriptor, or -1 on error.
+ */
+int vlc_object_waitpipe( vlc_object_t *obj )
+{
+    int *pipes = obj->p_internals->pipes;
+    vlc_assert_locked( &obj->object_lock );
+
+    if( pipes[1] == -1 )
+    {
+        /* This can only ever happen if someone killed us without locking */
+        assert( pipes[0] == -1 );
+
+#ifndef WIN32
+        if( pipe( pipes ) )
+#endif
+            return -1;
+    }
+
+    return pipes[0];
+}
+
+
+/**
+ * Waits for the object to be signaled (using vlc_object_signal()).
+ * If the object already has a signal pending, this function will return
+ * immediately. It is asserted that the caller holds the object lock.
+ *
+ * @return true if the object is dying and should terminate.
+ */
+vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
+{
+    vlc_assert_locked( &obj->object_lock );
+
+    int fd = obj->p_internals->pipes[0];
+    if( fd != -1 )
+    {
+        if( read( fd, &(char){ 0 }, 1 ) == 0 )
+        {
+            close( fd );
+            obj->p_internals->pipes[1] = -1;
+        }
+        return obj->b_die;
+    }
+
+    vlc_cond_wait( &obj->object_wait, &obj->object_lock );
+    return obj->b_die;
+}
+
+
+/**
+ * Waits for the object to be signaled (using vlc_object_signal()), or for
+ * a timer to expire.
+ * If the object already has a signal pending, this function will return
+ * immediately. It is asserted that the caller holds the object lock.
+ *
+ * @return negative if the object is dying and should terminate,
+ * positive if the the object has been signaled but is not dying,
+ * 0 if timeout has been reached.
+ */
+int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
+{
+    int v;
+
+    vlc_assert_locked( &obj->object_lock );
+    v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
+    if( v == 0 ) /* signaled */
+        return obj->b_die ? -1 : 1;
+    return 0;
+}
+
+
+/**
+ * Checks whether an object has been "killed".
+ * The object lock must be held.
+ *
+ * Typical code for an object thread could be:
+ *
+   vlc_object_lock (self);
+   ...initialization...
+   while (vlc_object_alive (self))
+   {
+       ...preprocessing...
+
+       if (vlc_object_wait (self))
+           continue;
+
+       ...postprocessing...
+   }
+   ...deinitialization...
+   vlc_object_unlock (self);
+ *
+ *
+ * @return true iff the object has not been killed yet
+ */
+vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
+{
+    vlc_assert_locked( &obj->object_lock );
+    return !obj->b_die;
 }
 
 
-vlc_bool_t __vlc_object_dying_unlocked( vlc_object_t *p_this )
+/**
+ * Signals an object for which the lock is held.
+ */
+void __vlc_object_signal_unlocked( vlc_object_t *obj )
 {
-    vlc_assert_locked( &p_this->object_lock );
-    return p_this->b_die;
+    vlc_assert_locked( &obj->object_lock );
+
+    int fd = obj->p_internals->pipes[1];
+    if( fd != -1 )
+        while( write( fd, &(char){ 0 }, 1 ) < 0 );
+
+    vlc_cond_signal( &obj->object_wait );
 }
 
 
-vlc_bool_t __vlc_object_dying( vlc_object_t *p_this )
+/**
+ * Requests termination of an object.
+ * If the object is LibVLC, also request to terminate all its children.
+ */
+void __vlc_object_kill( vlc_object_t *p_this )
 {
-     vlc_bool_t b;
-     vlc_mutex_lock( &p_this->object_lock );
-     b = __vlc_object_dying_unlocked( p_this );
-     vlc_mutex_unlock( &p_this->object_lock );
-     return b;
+    vlc_mutex_lock( &p_this->object_lock );
+    p_this->b_die = VLC_TRUE;
+
+    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] );
+
+    int fd = p_this->p_internals->pipes[1];
+    if( fd != -1 )
+    {
+        close( fd ); /* closing a pipe makes it readable too */
+        p_this->p_internals->pipes[1] = -1;
+    }
+
+    vlc_object_signal_unlocked( p_this );
+    vlc_mutex_unlock( &p_this->object_lock );
 }
 
 
@@ -501,7 +658,7 @@ void * __vlc_object_get( vlc_object_t *p_this, int i_id )
                 if( pp_objects[i_middle+1]->i_object_id == i_id )
                 {
                     vlc_mutex_unlock( &structure_lock );
-                    pp_objects[i_middle+1]->i_refcount++;
+                    pp_objects[i_middle+1]->p_internals->i_refcount++;
                     return pp_objects[i_middle+1];
                 }
                 break;
@@ -510,7 +667,7 @@ void * __vlc_object_get( vlc_object_t *p_this, int i_id )
         else
         {
             vlc_mutex_unlock( &structure_lock );
-            pp_objects[i_middle]->i_refcount++;
+            pp_objects[i_middle]->p_internals->i_refcount++;
             return pp_objects[i_middle];
         }
 
@@ -542,7 +699,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 )
     {
-        p_this->i_refcount++;
+        p_this->p_internals->i_refcount++;
         vlc_mutex_unlock( &structure_lock );
         return p_this;
     }
@@ -595,7 +752,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 ) )
     {
-        p_this->i_refcount++;
+        p_this->p_internals->i_refcount++;
         vlc_mutex_unlock( &structure_lock );
         return p_this;
     }
@@ -637,18 +794,23 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 void __vlc_object_yield( vlc_object_t *p_this )
 {
     vlc_mutex_lock( &structure_lock );
-    p_this->i_refcount++;
+    p_this->p_internals->i_refcount++;
     vlc_mutex_unlock( &structure_lock );
 }
 
-/**
- ****************************************************************************
+static inline void Release( vlc_object_t *obj )
+{
+    assert( obj->p_internals->i_refcount > 0 );
+    obj->p_internals->i_refcount--;
+}
+
+/*****************************************************************************
  * decrement an object refcount
  *****************************************************************************/
 void __vlc_object_release( vlc_object_t *p_this )
 {
     vlc_mutex_lock( &structure_lock );
-    p_this->i_refcount--;
+    Release( p_this );
     vlc_mutex_unlock( &structure_lock );
 }
 
@@ -673,7 +835,7 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
                  p_parent->i_children, p_this );
 
     /* Climb up the tree to see whether we are connected with the root */
-    if( p_parent->b_attached )
+    if( p_parent->p_internals->b_attached )
     {
         SetAttachment( p_this, VLC_TRUE );
     }
@@ -700,7 +862,7 @@ void __vlc_object_detach( vlc_object_t *p_this )
     }
 
     /* Climb up the tree to see whether we are connected with the root */
-    if( p_this->p_parent->b_attached )
+    if( p_this->p_parent->p_internals->b_attached )
     {
         SetAttachment( p_this, VLC_FALSE );
     }
@@ -735,7 +897,7 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 
         for( ; pp_current < pp_end ; pp_current++ )
         {
-            if( (*pp_current)->b_attached
+            if( (*pp_current)->p_internals->b_attached
                  && (*pp_current)->i_object_type == i_type )
             {
                 i_count++;
@@ -747,7 +909,7 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 
         for( ; pp_current < pp_end ; pp_current++ )
         {
-            if( (*pp_current)->b_attached
+            if( (*pp_current)->p_internals->b_attached
                  && (*pp_current)->i_object_type == i_type )
             {
                 ListReplace( p_list, *pp_current, i_index );
@@ -807,7 +969,7 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
 
         for( ; pp_current < pp_end ; pp_current++ )
         {
-            if( (*pp_current)->b_attached )
+            if( (*pp_current)->p_internals->b_attached )
             {
                 PrintObject( *pp_current, "" );
             }
@@ -879,11 +1041,11 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
 
             PrintObject( p_object, "" );
 
-            if( !p_object->i_vars )
+            if( !p_object->p_internals->i_vars )
                 printf( " `-o No variables\n" );
-            for( i = 0; i < p_object->i_vars; i++ )
+            for( i = 0; i < p_object->p_internals->i_vars; i++ )
             {
-                variable_t *p_var = p_object->p_vars + i;
+                variable_t *p_var = p_object->p_internals->p_vars + i;
 
                 const char *psz_type = "unknown";
                 switch( p_var->i_type & VLC_VAR_TYPE )
@@ -909,7 +1071,7 @@ static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
 #undef MYCASE
                 }
                 printf( " %c-o \"%s\" (%s",
-                        i + 1 == p_object->i_vars ? '`' : '|',
+                        i + 1 == p_object->p_internals->i_vars ? '`' : '|',
                         p_var->psz_name, psz_type );
                 if( p_var->psz_text )
                     printf( ", %s", p_var->psz_text );
@@ -973,7 +1135,7 @@ void vlc_list_release( vlc_list_t *p_list )
     vlc_mutex_lock( &structure_lock );
     for( i_index = 0; i_index < p_list->i_count; i_index++ )
     {
-        p_list->p_values[i_index].p_object->i_refcount--;
+        Release( p_list->p_values[i_index].p_object );
     }
     vlc_mutex_unlock( &structure_lock );
 
@@ -1036,7 +1198,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 )
             {
-                p_tmp->i_refcount++;
+                p_tmp->p_internals->i_refcount++;
                 return p_tmp;
             }
             else
@@ -1052,7 +1214,7 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
             p_tmp = p_this->pp_children[i];
             if( p_tmp->i_object_type == i_type )
             {
-                p_tmp->i_refcount++;
+                p_tmp->p_internals->i_refcount++;
                 return p_tmp;
             }
             else if( p_tmp->i_children )
@@ -1090,7 +1252,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 ) )
             {
-                p_tmp->i_refcount++;
+                p_tmp->p_internals->i_refcount++;
                 return p_tmp;
             }
             else
@@ -1107,7 +1269,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 ) )
             {
-                p_tmp->i_refcount++;
+                p_tmp->p_internals->i_refcount++;
                 return p_tmp;
             }
             else if( p_tmp->i_children )
@@ -1177,7 +1339,7 @@ static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
         SetAttachment( p_this->pp_children[i_index], b_attached );
     }
 
-    p_this->b_attached = b_attached;
+    p_this->p_internals->b_attached = b_attached;
 }
 
 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
@@ -1207,12 +1369,18 @@ static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
     }
 
     psz_refcount[0] = '\0';
-    if( p_this->i_refcount )
-        snprintf( psz_refcount, 19, ", refcount %i", p_this->i_refcount );
+    if( p_this->p_internals->i_refcount > 0 )
+        snprintf( psz_refcount, 19, ", refcount %u",
+                  p_this->p_internals->i_refcount );
 
     psz_thread[0] = '\0';
-    if( p_this->b_thread )
-        snprintf( psz_thread, 29, " (thread %d)", (int)p_this->thread_id );
+    if( p_this->p_internals->b_thread )
+        snprintf( psz_thread, 29, " (thread %u)",
+#if defined(WIN32) || defined(UNDER_CE)
+                  (unsigned)p_this->p_internals->thread_id.id );
+#else
+                  (unsigned)p_this->p_internals->thread_id );
+#endif
 
     psz_parent[0] = '\0';
     if( p_this->p_parent )
@@ -1302,7 +1470,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    p_object->i_refcount++;
+    p_object->p_internals->i_refcount++;
 
     p_list->p_values[i_index].p_object = p_object;
 
@@ -1324,7 +1492,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    p_object->i_refcount++;
+    p_object->p_internals->i_refcount++;
 
     p_list->p_values[p_list->i_count].p_object = p_object;
     p_list->i_count++;