/*****************************************************************************
* objects.c: vlc_object_t handling
*****************************************************************************
- * Copyright (C) 2004-2007 the VideoLAN team
+ * Copyright (C) 2004-2008 the VideoLAN team
* $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
#include <vlc_sout.h>
#include "stream_output/stream_output.h"
-#include "vlc_playlist.h"
#include "vlc_interface.h"
#include "vlc_codec.h"
#include "vlc_filter.h"
-#include "vlc_httpd.h"
-#include "vlc_vlm.h"
-#include "input/vlm_internal.h"
-#include "vlc_vod.h"
-#include "vlc_tls.h"
-#include "vlc_xml.h"
-#include "vlc_osd.h"
-#include "vlc_meta.h"
-
#include "variables.h"
#ifndef WIN32
# include <unistd.h>
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 *, vlc_bool_t );
static vlc_list_t * NewList ( int );
static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
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_detach_unlocked (vlc_object_t *p_this);
+
/*****************************************************************************
* Local structure lock
*****************************************************************************/
-static vlc_mutex_t structure_lock;
-static vlc_object_internals_t global_internals;
+static vlc_mutex_t structure_lock;
+static vlc_threadvar_t thread_object;
-vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
- int i_type, const char *psz_type )
+void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
+ int i_type, const char *psz_type )
{
vlc_object_t *p_new;
vlc_object_internals_t *p_priv;
- if( i_type == VLC_OBJECT_GLOBAL )
- {
- p_new = p_this;
- p_priv = &global_internals;
- memset( p_priv, 0, sizeof( *p_priv ) );
- }
- else
- {
- p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
- if( p_priv == NULL )
- return NULL;
+ /* NOTE:
+ * VLC objects are laid out as follow:
+ * - first the LibVLC-private per-object data,
+ * - then VLC_COMMON members from vlc_object_t,
+ * - finally, the type-specific data (if any).
+ *
+ * This function initializes the LibVLC and common data,
+ * and zeroes the rest.
+ */
+ p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
+ if( p_priv == NULL )
+ return NULL;
- p_new = (vlc_object_t *)(p_priv + 1);
- }
+ assert (i_size >= sizeof (vlc_object_t));
+ p_new = (vlc_object_t *)(p_priv + 1);
- p_new->p_internals = p_priv;
p_new->i_object_type = i_type;
p_new->psz_object_type = psz_type;
-
p_new->psz_object_name = NULL;
- p_new->b_die = VLC_FALSE;
- p_new->b_error = VLC_FALSE;
- p_new->b_dead = VLC_FALSE;
- p_priv->b_attached = VLC_FALSE;
- p_new->b_force = VLC_FALSE;
+ 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;
- if( p_this->i_flags & OBJECT_FLAGS_NODBG )
- p_new->i_flags |= OBJECT_FLAGS_NODBG;
- if( p_this->i_flags & OBJECT_FLAGS_QUIET )
- p_new->i_flags |= OBJECT_FLAGS_QUIET;
- if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
- p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
+ if (p_this)
+ p_new->i_flags = p_this->i_flags
+ & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
if( !p_priv->p_vars )
{
- if( i_type != VLC_OBJECT_GLOBAL )
- free( p_priv );
+ free( p_priv );
return NULL;
}
- if( i_type == VLC_OBJECT_GLOBAL )
+ libvlc_global_data_t *p_libvlc_global;
+ if( p_this == NULL )
{
- /* 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;
+ /* 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;
p_libvlc_global->i_counter = 0;
- p_new->i_object_id = 0;
-
- 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_priv->b_attached = VLC_TRUE;
+ p_priv->next = p_priv->prev = p_new;
+ vlc_mutex_init( &structure_lock );
}
else
{
- libvlc_global_data_t *p_libvlc_global = vlc_global();
+ p_libvlc_global = vlc_global();
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 );
-
- p_libvlc_global->i_counter++;
- 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 );
}
- p_priv->i_refcount = 0;
+ vlc_spin_init( &p_priv->ref_spin );
+ p_priv->i_refcount = 1;
+ 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;
/* Initialize mutexes and condvars */
- vlc_mutex_init( p_new, &p_new->object_lock );
+ vlc_mutex_init( &p_new->object_lock );
vlc_cond_init( p_new, &p_new->object_wait );
- vlc_mutex_init( p_new, &p_priv->var_lock );
+ vlc_mutex_init( &p_priv->var_lock );
vlc_spin_init( &p_priv->spin );
p_priv->pipes[0] = p_priv->pipes[1] = -1;
- if( i_type == VLC_OBJECT_GLOBAL )
- {
- vlc_mutex_init( p_new, &structure_lock );
- }
+ p_priv->next = VLC_OBJECT (p_libvlc_global);
+#if defined (NDEBUG)
+ /* ... */
+#elif defined (LIBVLC_USE_PTRHEAD)
+ p_priv->creator_id = pthread_self ();
+#elif defined (WIN32)
+ p_priv->creator_id = GetCurrentThreadId ();
+#endif
+ 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++;
+ vlc_mutex_unlock( &structure_lock );
if( i_type == VLC_OBJECT_LIBVLC )
{
switch( i_type )
{
- case VLC_OBJECT_GLOBAL:
- i_size = sizeof(libvlc_global_data_t);
- psz_type = "global";
- break;
case VLC_OBJECT_LIBVLC:
i_size = sizeof(libvlc_int_t);
psz_type = "libvlc";
i_size = sizeof(intf_thread_t);
psz_type = "dialogs";
break;
- case VLC_OBJECT_PLAYLIST:
- i_size = sizeof(playlist_t);
- psz_type = "playlist";
- break;
- case VLC_OBJECT_SD:
- i_size = sizeof(services_discovery_t);
- psz_type = "services discovery";
- break;
- case VLC_OBJECT_INPUT:
- i_size = sizeof(input_thread_t);
- psz_type = "input";
- break;
case VLC_OBJECT_DEMUX:
i_size = sizeof(demux_t);
psz_type = "demux";
i_size = sizeof(vout_thread_t);
psz_type = "video output";
break;
- case VLC_OBJECT_SPU:
- i_size = sizeof(spu_t);
- psz_type = "subpicture";
- break;
case VLC_OBJECT_AOUT:
i_size = sizeof(aout_instance_t);
psz_type = "audio output";
i_size = sizeof(sout_instance_t);
psz_type = "stream output";
break;
- case VLC_OBJECT_VLM:
- i_size = sizeof( vlm_t );
- psz_type = "vlm dameon";
- break;
- case VLC_OBJECT_VOD:
- i_size = sizeof( vod_t );
- psz_type = "vod server";
- break;
- case VLC_OBJECT_XML:
- i_size = sizeof( xml_t );
- psz_type = "xml";
- break;
case VLC_OBJECT_OPENGL:
i_size = sizeof( vout_thread_t );
psz_type = "opengl";
i_size = sizeof( announce_handler_t );
psz_type = "announce";
break;
- case VLC_OBJECT_META_ENGINE:
- i_size = sizeof( meta_engine_t );
- psz_type = "meta engine";
- break;
- case VLC_OBJECT_OSDMENU:
- i_size = sizeof( osd_menu_t );
- psz_type = "osd menu";
+ case VLC_OBJECT_INTERACTION:
+ i_size = sizeof( interaction_t );
+ psz_type = "interaction";
break;
default:
i_size = i_type > (int)sizeof(vlc_object_t)
/**
****************************************************************************
- * Destroy a vlc object
+ * Set the destructor of a vlc object
+ *
+ * This function sets the destructor of the vlc object. It will be called
+ * when the object is destroyed when the its refcount reaches 0.
+ * (It is called by the internal function vlc_object_destroy())
+ *****************************************************************************/
+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 );
+ p_priv->pf_destructor = pf_destructor;
+}
+
+/**
+ ****************************************************************************
+ * Destroy a vlc object (Internal)
*
* This function destroys an object that has been previously allocated with
* vlc_object_create. The object's refcount must be zero and it must not be
* attached to other objects in any way.
*****************************************************************************/
-void __vlc_object_destroy( vlc_object_t *p_this )
+static void vlc_object_destroy( vlc_object_t *p_this )
{
vlc_object_internals_t *p_priv = vlc_internals( p_this );
- int i_delay = 0;
-
- if( p_this->i_children )
- {
- msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
- p_this->i_object_id, p_this->psz_object_name );
- return;
- }
- if( p_this->p_parent )
- {
- msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
- p_this->i_object_id, p_this->psz_object_name );
- return;
- }
+ /* Objects are always detached beforehand */
+ assert( !p_this->p_parent );
- while( p_priv->i_refcount > 0 )
- {
- i_delay++;
+ /* Send a kill to the object's thread if applicable */
+ vlc_object_kill( p_this );
- /* Don't warn immediately ... 100ms seems OK */
- if( i_delay == 2 )
- {
- msg_Warn( p_this,
- "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 %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 )
- {
- msg_Err( p_this,
- "waited too long, cancelling destruction (id=%d,type=%d)",
- p_this->i_object_id, p_this->i_object_type );
- return;
- }
+ /* If we are running on a thread, wait until it ends */
+ if( p_priv->b_thread )
+ vlc_thread_join( p_this );
- msleep( 100000 );
- }
+ /* Call the custom "subclass" destructor */
+ if( p_priv->pf_destructor )
+ p_priv->pf_destructor( p_this );
/* Destroy the associated variables, starting from the end so that
* no memmove calls have to be done. */
free( p_priv->p_vars );
vlc_mutex_destroy( &p_priv->var_lock );
- if( p_this->psz_header ) free( p_this->psz_header );
+ free( p_this->psz_header );
- if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
+ if( p_this->p_libvlc == NULL )
{
libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
- /* We are the global object ... no need to lock. */
- free( p_global->pp_objects );
- p_global->pp_objects = NULL;
- p_global->i_objects--;
- vlc_mutex_destroy( &structure_lock );
- }
- else
- {
- libvlc_global_data_t *p_libvlc_global = vlc_global();
- int i_index;
-
- vlc_mutex_lock( &structure_lock );
+#ifndef NDEBUG
+ 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);
- /* 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 );
+ /* Dump global object to ease debugging */
+ vlc_object_dump( p_this );
+ /* Strongly abort, cause we want these to be fixed */
+ abort();
+ }
+#endif
- vlc_mutex_unlock( &structure_lock );
+ /* 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.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 );
- if( p_priv->pipes[0] != -1 )
- close( p_priv->pipes[0] );
if( p_priv->pipes[1] != -1 )
close( p_priv->pipes[1] );
+ if( p_priv->pipes[0] != -1 )
+ close( p_priv->pipes[0] );
- /* global is not dynamically allocated by vlc_object_create */
- if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
- free( p_priv );
+ free( p_priv );
}
goto error;
closesocket (l);
- shutdown (a, 0);
- shutdown (c, 1);
+ //shutdown (a, 0);
+ //shutdown (c, 1);
fd[0] = c;
fd[1] = a;
return 0;
#endif /* WIN32 */
/**
- * 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.
+ * Returns the readable end of a pipe that becomes readable once termination
+ * of the object is requested (vlc_object_kill()).
+ * This can be used to wake-up out of a select() or poll() event loop, such
+ * typically when doing network I/O.
*
* 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.
+ * DO NOT read the pipe nor close it yourself. Ever.
*
- * @param obj object that would be signaled
+ * @param obj object that would be "killed"
* @return a readable pipe descriptor, or -1 on error.
*/
int __vlc_object_waitpipe( vlc_object_t *obj )
{
int pfd[2] = { -1, -1 };
- struct vlc_object_internals_t *internals = obj->p_internals;
- vlc_bool_t race = VLC_FALSE, signaled = VLC_FALSE;
+ vlc_object_internals_t *internals = vlc_internals( obj );
+ bool killed = false;
vlc_spin_lock (&internals->spin);
if (internals->pipes[0] == -1)
return -1;
vlc_spin_lock (&internals->spin);
- signaled = internals->b_signaled;
if (internals->pipes[0] == -1)
{
internals->pipes[0] = pfd[0];
internals->pipes[1] = pfd[1];
+ pfd[0] = pfd[1] = -1;
}
- else
- race = VLC_TRUE;
+ killed = obj->b_die;
}
vlc_spin_unlock (&internals->spin);
- if (race)
- { /* Race condition: two threads call pipe() - unlikely */
- close (pfd[0]);
- close (pfd[1]);
+ if (killed)
+ {
+ /* Race condition: vlc_object_kill() already invoked! */
+ int fd;
+
+ vlc_spin_lock (&internals->spin);
+ fd = internals->pipes[1];
+ internals->pipes[1] = -1;
+ vlc_spin_unlock (&internals->spin);
+
+ msg_Dbg (obj, "waitpipe: object already dying");
+ if (fd != -1)
+ close (fd);
}
- if (signaled)
- /* Race condition: lc_object_signal() already invoked! */
- while (write (internals->pipes[1], &(char){ 0 }, 1) < 0);
+ /* Race condition: two threads call pipe() - unlikely */
+ if (pfd[0] != -1)
+ close (pfd[0]);
+ if (pfd[1] != -1)
+ close (pfd[1]);
return internals->pipes[0];
}
*
* @return true if the object is dying and should terminate.
*/
-vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
+bool __vlc_object_wait( vlc_object_t *obj )
{
- int fd;
-
vlc_assert_locked( &obj->object_lock );
-
- fd = obj->p_internals->pipes[0];
- if (fd != -1)
- {
- while (read (fd, &(char){ 0 }, 1) < 0);
- return obj->b_die;
- }
-
vlc_cond_wait( &obj->object_wait, &obj->object_lock );
- obj->p_internals->b_signaled = VLC_FALSE;
return obj->b_die;
}
*
* @return true iff the object has not been killed yet
*/
-vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
+bool __vlc_object_alive( vlc_object_t *obj )
{
vlc_assert_locked( &obj->object_lock );
return !obj->b_die;
*/
void __vlc_object_signal_unlocked( vlc_object_t *obj )
{
- struct vlc_object_internals_t *internals = obj->p_internals;
- int fd;
-
vlc_assert_locked (&obj->object_lock);
-
- vlc_spin_lock (&internals->spin);
- fd = internals->pipes[1];
- internals->b_signaled = VLC_TRUE;
- vlc_spin_unlock (&internals->spin);
-
- if( fd != -1 )
- while( write( fd, &(char){ 0 }, 1 ) < 0 );
-
vlc_cond_signal( &obj->object_wait );
}
*/
void __vlc_object_kill( vlc_object_t *p_this )
{
+ vlc_object_internals_t *internals = vlc_internals( p_this );
+ int fd;
+
vlc_mutex_lock( &p_this->object_lock );
- p_this->b_die = VLC_TRUE;
+ p_this->b_die = true;
+
+ vlc_spin_lock (&internals->spin);
+ fd = internals->pipes[1];
+ internals->pipes[1] = -1;
+ vlc_spin_unlock (&internals->spin);
+
+ if( fd != -1 )
+ {
+ msg_Dbg (p_this, "waitpipe: object killed");
+ close (fd);
+ }
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 );
/**
- * 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 )
- {
- 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_mutex_unlock( &structure_lock );
- pp_objects[i_middle+1]->p_internals->i_refcount++;
- return pp_objects[i_middle+1];
- }
- break;
- }
- }
- else
- {
- vlc_mutex_unlock( &structure_lock );
- pp_objects[i_middle]->p_internals->i_refcount++;
- return pp_objects[i_middle];
- }
-
- if( i_max == 0 )
+ if( obj->i_object_id == i_id )
{
- /* this means that i_max == i_middle, and since we have already
- * tested pp_objects[i_middle]), p_found is properly set. */
- break;
+ vlc_object_yield( obj );
+ goto out;
}
}
+ obj = NULL;
+out:
vlc_mutex_unlock( &structure_lock );
- return NULL;
+ return obj;
}
/**
{
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 )
{
- p_this->p_internals->i_refcount++;
- vlc_mutex_unlock( &structure_lock );
+ vlc_object_yield( p_this );
return p_this;
}
/* 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;
}
{
vlc_object_t *p_found;
- vlc_mutex_lock( &structure_lock );
-
/* 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 ) )
{
- p_this->p_internals->i_refcount++;
- 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 )
{
}
/**
- ****************************************************************************
- * increment an object refcount
- *****************************************************************************/
+ * Increment an object reference counter.
+ */
void __vlc_object_yield( vlc_object_t *p_this )
{
- vlc_mutex_lock( &structure_lock );
- 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--;
+ vlc_object_internals_t *internals = vlc_internals( p_this );
+
+ vlc_spin_lock( &internals->ref_spin );
+ /* Avoid obvious freed object uses */
+ assert( internals->i_refcount > 0 );
+ /* Increment the counter */
+ 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_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 );
+
+ /* Slow path */
+ /* Remember that we cannot hold the spin while waiting on the mutex */
vlc_mutex_lock( &structure_lock );
- Release( p_this );
+ /* 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 )
+ {
+ /* 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;
+ }
+
vlc_mutex_unlock( &structure_lock );
+
+ if( b_should_destroy )
+ {
+ free( internals->pp_children );
+ internals->pp_children = NULL;
+ internals->i_children = 0;
+ vlc_object_destroy( p_this );
+ }
}
/**
vlc_mutex_lock( &structure_lock );
/* 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 );
+ vlc_object_internals_t *priv = vlc_internals( p_parent );
+ INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
+ p_this );
+
+ /* Kill the object if parent is already dead.
+ * Note: We should surely lock parent here, but that would
+ * create quite a few dead lock case. Hopefully, it
+ * is perfectly safe to do it that way. We only risk
+ * receiving kill event twice. But given current API
+ * it is ok. */
+ if( p_this->p_parent->b_die )
+ vlc_object_kill( p_this );
+
+ vlc_mutex_unlock( &structure_lock );
+}
+
+
+static void vlc_object_detach_unlocked (vlc_object_t *p_this)
+{
+ vlc_assert_locked (&structure_lock);
+
+ if (p_this->p_parent == NULL)
+ return;
+
+ vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
+
+ int i_index, i;
+
+ /* Remove p_this's parent */
+ p_this->p_parent = NULL;
- /* Climb up the tree to see whether we are connected with the root */
- if( p_parent->p_internals->b_attached )
+ /* Remove all of p_parent's children which are p_this */
+ for( i_index = priv->i_children ; i_index-- ; )
{
- SetAttachment( p_this, VLC_TRUE );
+ if( priv->pp_children[i_index] == p_this )
+ {
+ priv->i_children--;
+ for( i = i_index ; i < priv->i_children ; i++ )
+ priv->pp_children[i] = priv->pp_children[i+1];
+ }
}
- vlc_mutex_unlock( &structure_lock );
+ if( priv->i_children )
+ {
+ 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( priv->pp_children );
+ priv->pp_children = NULL;
+ }
}
+
/**
****************************************************************************
* detach object from its parent
vlc_mutex_lock( &structure_lock );
if( !p_this->p_parent )
- {
msg_Err( p_this, "object is not attached" );
- vlc_mutex_unlock( &structure_lock );
- return;
- }
-
- /* Climb up the tree to see whether we are connected with the root */
- if( p_this->p_parent->p_internals->b_attached )
- {
- SetAttachment( p_this, VLC_FALSE );
- }
-
- DetachObject( p_this );
+ else
+ vlc_object_detach_unlocked( p_this );
vlc_mutex_unlock( &structure_lock );
- p_this = NULL;
}
+
/**
****************************************************************************
* find a list typed objects and increment their refcount
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( (*pp_current)->p_internals->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( (*pp_current)->p_internals->b_attached
- && (*pp_current)->i_object_type == i_type )
- {
- ListReplace( p_list, *pp_current, i_index );
- if( i_index < i_count ) i_index++;
- }
- }
- break;
+ /* 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 );
i_count = CountChildren( p_this, i_type );
p_list = NewList( i_count );
/* Check allocation was successful */
if( p_list->i_count != i_count )
{
+ vlc_mutex_unlock( &structure_lock );
msg_Err( p_this, "list allocation failed!" );
p_list->i_count = 0;
break;
p_list->i_count = 0;
ListChildren( p_list, p_this, i_type );
+ vlc_mutex_unlock( &structure_lock );
break;
default:
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_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
*****************************************************************************
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;
+ vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
- pp_current = p_libvlc_global->pp_objects;
- pp_end = pp_current + p_libvlc_global->i_objects;
-
- for( ; pp_current < pp_end ; pp_current++ )
+ vlc_mutex_lock( &structure_lock );
+ do
{
- if( (*pp_current)->p_internals->b_attached )
- {
- PrintObject( *pp_current, "" );
- }
- else
- {
- printf( " o %.8i %s (not attached)\n",
- (*pp_current)->i_object_id,
- (*pp_current)->psz_object_type );
- }
+ PrintObject (cur, "");
+ cur = vlc_internals (cur)->next;
}
-
+ while (cur != root);
vlc_mutex_unlock( &structure_lock );
}
else
PrintObject( p_object, "" );
- if( !p_object->p_internals->i_vars )
+ if( !vlc_internals( p_object )->i_vars )
printf( " `-o No variables\n" );
- for( i = 0; i < p_object->p_internals->i_vars; i++ )
+ for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
{
- variable_t *p_var = p_object->p_internals->p_vars + i;
+ variable_t *p_var = vlc_internals( p_object )->p_vars + i;
const char *psz_type = "unknown";
switch( p_var->i_type & VLC_VAR_TYPE )
#undef MYCASE
}
printf( " %c-o \"%s\" (%s",
- i + 1 == p_object->p_internals->i_vars ? '`' : '|',
+ i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
p_var->psz_name, psz_type );
if( p_var->psz_text )
printf( ", %s", p_var->psz_text );
printf( ": %f", p_var->val.f_float );
break;
case VLC_VAR_TIME:
- printf( ": " I64Fi, (int64_t)p_var->val.i_time );
+ printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
break;
case VLC_VAR_ADDRESS:
printf( ": %p", p_var->val.p_address );
{
int i_index;
- vlc_mutex_lock( &structure_lock );
for( i_index = 0; i_index < p_list->i_count; i_index++ )
{
- Release( p_list->p_values[i_index].p_object );
+ vlc_object_release( p_list->p_values[i_index].p_object );
}
- vlc_mutex_unlock( &structure_lock );
free( p_list->p_values );
free( p_list );
}
-/* 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.
+ * dump an object. (Debug function)
*****************************************************************************/
-static int FindIndex( vlc_object_t *p_this,
- vlc_object_t **pp_objects, int i_count )
+void __vlc_object_dump( vlc_object_t *p_this )
{
- 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 );
- }
+ vlc_mutex_lock( &structure_lock );
+ char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
+ psz_foo[0] = '|';
+ DumpStructure( p_this, 0, psz_foo );
+ vlc_mutex_unlock( &structure_lock );
}
+/* Following functions are local */
+
static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
{
int i;
{
if( p_tmp->i_object_type == i_type )
{
- p_tmp->p_internals->i_refcount++;
+ vlc_object_yield( p_tmp );
return p_tmp;
}
else
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 )
{
- p_tmp->p_internals->i_refcount++;
+ 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 )
if( p_tmp->psz_object_name
&& !strcmp( p_tmp->psz_object_name, psz_name ) )
{
- p_tmp->p_internals->i_refcount++;
+ vlc_object_yield( p_tmp );
return p_tmp;
}
else
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 ) )
{
- p_tmp->p_internals->i_refcount++;
+ 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 )
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, vlc_bool_t b_attached )
-{
- int i_index;
-
- for( i_index = p_this->i_children ; i_index-- ; )
- {
- SetAttachment( p_this->pp_children[i_index], b_attached );
- }
-
- p_this->p_internals->b_attached = b_attached;
-}
static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
{
char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
psz_parent[20];
- psz_name[0] = '\0';
+ memset( &psz_name, 0, sizeof(psz_name) );
if( p_this->psz_object_name )
{
snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
}
psz_children[0] = '\0';
- switch( p_this->i_children )
+ switch( vlc_internals( p_this )->i_children )
{
case 0:
break;
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;
}
psz_refcount[0] = '\0';
- if( p_this->p_internals->i_refcount > 0 )
+ if( vlc_internals( p_this )->i_refcount > 0 )
snprintf( psz_refcount, 19, ", refcount %u",
- p_this->p_internals->i_refcount );
+ vlc_internals( p_this )->i_refcount );
psz_thread[0] = '\0';
- 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
+ if( vlc_internals( p_this )->b_thread )
+ snprintf( psz_thread, 29, " (thread %lu)",
+ (unsigned long)vlc_internals( p_this )->thread_id );
psz_parent[0] = '\0';
if( p_this->p_parent )
return;
}
- for( i = 0 ; i < p_this->i_children ; i++ )
+ for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
{
if( i_level )
{
}
}
- if( i == p_this->i_children - 1 )
+ if( i == vlc_internals( p_this )->i_children - 1 )
{
psz_foo[i_level] = '`';
}
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 );
}
}
return;
}
- p_object->p_internals->i_refcount++;
+ vlc_object_yield( p_object );
p_list->p_values[i_index].p_object = p_object;
return;
}
- p_object->p_internals->i_refcount++;
+ vlc_object_yield( p_object );
p_list->p_values[p_list->i_count].p_object = p_object;
p_list->i_count++;
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;
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 );
}
}
+
+#ifndef NDEBUG
+# ifdef __GLIBC__
+# include <execinfo.h>
+# endif
+
+void vlc_refcheck (vlc_object_t *obj)
+{
+ static unsigned errors = 0;
+ if (errors > 100)
+ return;
+
+ /* Anyone can use the root object (though it should not exist) */
+ if (obj == VLC_OBJECT (vlc_global ()))
+ return;
+
+ /* Anyone can use its libvlc instance object */
+ if (obj == VLC_OBJECT (obj->p_libvlc))
+ return;
+
+ /* The thread that created the object holds the initial reference */
+ vlc_object_internals_t *priv = vlc_internals (obj);
+#if defined (LIBVLC_USE_PTHREAD)
+ if (pthread_equal (priv->creator_id, pthread_self ()))
+#elif defined WIN32
+ if (priv->creator_id == GetCurrentThreadId ())
+#else
+ if (0)
+#endif
+ return;
+
+ /* A thread can use its own object without reference! */
+ vlc_object_t *caller = vlc_threadobj ();
+ if (caller == obj)
+ return;
+
+ /* The calling thread is younger than the object.
+ * Access could be valid through cross-thread synchronization;
+ * we would need better accounting. */
+ if (caller && (caller->i_object_id > obj->i_object_id))
+ return;
+
+ int refs;
+ vlc_spin_lock (&priv->ref_spin);
+ refs = priv->i_refcount;
+ vlc_spin_unlock (&priv->ref_spin);
+
+ /* Object has more than one reference.
+ * The current thread could be holding a valid reference. */
+ if (refs > 1)
+ return;
+
+ fprintf (stderr, "The %s %s thread object is accessing...\n"
+ "the %s %s object in a suspicous manner.\n",
+ caller && caller->psz_object_name
+ ? caller->psz_object_name : "unnamed",
+ caller ? caller->psz_object_type : "main",
+ obj->psz_object_name ? obj->psz_object_name : "unnamed",
+ obj->psz_object_type);
+ fflush (stderr);
+
+#ifdef __GLIBC__
+ void *stack[20];
+ int stackdepth = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
+ backtrace_symbols_fd (stack, stackdepth, 2);
+#endif
+
+ if (++errors == 100)
+ fprintf (stderr, "Too many reference errors!\n");
+}
+#endif
projects / vlc / blobdiff