* objects.c: vlc_object_t handling
*****************************************************************************
* Copyright (C) 2004-2008 the VideoLAN team
+ * Copyright (C) 2006-2010 Rémi Denis-Courmont
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
#if defined (HAVE_SYS_EVENTFD_H)
# include <sys/eventfd.h>
+# ifndef EFD_CLOEXEC
+# define EFD_CLOEXEC 0
+# warning EFD_CLOEXEC missing. Consider updating libc.
+# endif
#endif
vlc_value_t, vlc_value_t, void * );
static vlc_object_t * FindParent ( vlc_object_t *, int );
-static vlc_object_t * FindChild ( vlc_object_t *, int );
+static vlc_object_t * FindChild ( vlc_object_internals_t *, int );
static vlc_object_t * FindParentName( vlc_object_t *, const char * );
-static vlc_object_t * FindChildName ( vlc_object_t *, const char * );
-static void PrintObject ( vlc_object_t *, const char * );
-static void DumpStructure ( vlc_object_t *, int, char * );
+static vlc_object_t * FindChildName ( vlc_object_internals_t *, const char * );
+static void PrintObject( vlc_object_internals_t *, const char * );
+static void DumpStructure( vlc_object_internals_t *, unsigned, char * );
static vlc_list_t * NewList ( int );
-static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
-/*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
-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);
vlc_mutex_unlock (&(libvlc_priv (p_libvlc)->structure_lock));
}
-void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
- int i_type, const char *psz_type )
+#undef vlc_custom_create
+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;
p_priv->psz_name = NULL;
p_new->b_die = false;
- p_new->b_error = false;
p_new->b_force = false;
p_new->psz_header = NULL;
p_priv->pf_destructor = NULL;
p_priv->b_thread = false;
p_new->p_parent = NULL;
- p_priv->pp_children = NULL;
- p_priv->i_children = 0;
+ p_priv->first = NULL;
+#ifndef NDEBUG
+ p_priv->old_parent = NULL;
+#endif
/* Initialize mutexes and condvars */
vlc_mutex_init( &p_priv->var_lock );
return p_new;
}
-
+#undef vlc_object_create
/**
* Allocates and initializes a vlc object.
*
- * @param i_type known object type (all of them are negative integer values),
- * or object byte size (always positive).
+ * @param i_size object byte size
*
* @return the new object, or NULL on error.
*/
-void * __vlc_object_create( vlc_object_t *p_this, int i_type )
+void *vlc_object_create( vlc_object_t *p_this, size_t i_size )
{
- const char * psz_type;
- size_t i_size;
-
- switch( i_type )
- {
- case VLC_OBJECT_DECODER:
- i_size = sizeof(decoder_t);
- psz_type = "decoder";
- break;
- case VLC_OBJECT_AOUT:
- i_size = sizeof(aout_instance_t);
- psz_type = "audio output";
- break;
- default:
- assert( i_type > 0 ); /* unknown type?! */
- i_size = i_type;
- i_type = VLC_OBJECT_GENERIC;
- psz_type = "generic";
- break;
- }
-
- return vlc_custom_create( p_this, i_size, i_type, psz_type );
+ return vlc_custom_create( p_this, i_size, VLC_OBJECT_GENERIC, "generic" );
}
-
+#undef vlc_object_set_destructor
/**
****************************************************************************
* Set the destructor of a vlc object
* 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 )
+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 );
/* This can only ever happen if someone killed us without locking: */
assert (internals->pipes[1] == -1);
+ /* pipe() is not a cancellation point, but write() is and eventfd() is
+ * unspecified (not in POSIX). */
+ int canc = vlc_savecancel ();
#if defined (HAVE_SYS_EVENTFD_H)
- internals->pipes[0] = internals->pipes[1] = eventfd (0, 0);
+ internals->pipes[0] = internals->pipes[1] = eventfd (0, EFD_CLOEXEC);
if (internals->pipes[0] == -1)
#endif
{
msg_Dbg (obj, "waitpipe: object already dying");
write (internals->pipes[1], &(uint64_t){ 1 }, sizeof (uint64_t));
}
+ vlc_restorecancel (canc);
}
vlc_mutex_unlock (&pipe_lock);
return internals->pipes[0];
}
-
+#undef vlc_object_kill
/**
* Requests termination of an object, cancels the object thread, and make the
* object wait pipe (if it exists) readable. Not a cancellation point.
*/
-void __vlc_object_kill( vlc_object_t *p_this )
+void vlc_object_kill( vlc_object_t *p_this )
{
vlc_object_internals_t *priv = vlc_internals( p_this );
int fd = -1;
}
}
-
+#undef vlc_object_find
/*****************************************************************************
* find a typed object and increment its refcount
*****************************************************************************
* This function recursively looks for a given object type. i_mode can be one
* of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
*****************************************************************************/
-void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
+void * vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
{
vlc_object_t *p_found;
/* Otherwise, recursively look for the object */
if (i_mode == FIND_ANYWHERE)
- return vlc_object_find (p_this->p_libvlc, i_type, FIND_CHILD);
+ return vlc_object_find (VLC_OBJECT(p_this->p_libvlc), i_type, FIND_CHILD);
switch (i_type)
{
p_found = FindParent (p_this, i_type);
break;
case FIND_CHILD:
- p_found = FindChild (p_this, i_type);
+ p_found = FindChild (vlc_internals (p_this), i_type);
break;
default:
assert (0);
FIND_CHILD);
libvlc_lock (p_this->p_libvlc);
+ vlc_mutex_lock (&name_lock);
switch (i_mode)
{
case FIND_PARENT:
p_found = FindParentName (p_this, psz_name);
break;
case FIND_CHILD:
- p_found = FindChildName (p_this, psz_name);
+ p_found = FindChildName (vlc_internals (p_this), psz_name);
break;
default:
assert (0);
}
+ vlc_mutex_unlock (&name_lock);
libvlc_unlock (p_this->p_libvlc);
return p_found;
}
+#undef vlc_object_hold
/**
* Increment an object reference counter.
*/
-void * __vlc_object_hold( vlc_object_t *p_this )
+void * vlc_object_hold( vlc_object_t *p_this )
{
vlc_object_internals_t *internals = vlc_internals( p_this );
return p_this;
}
+#undef vlc_object_release
/*****************************************************************************
* Decrement an object refcount
* And destroy the object if its refcount reach zero.
*****************************************************************************/
-void __vlc_object_release( 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;
vlc_object_detach_unlocked (p_this);
/* We have no children */
- assert (internals->i_children == 0);
+ assert (internals->first == NULL);
}
libvlc_unlock (p_this->p_libvlc);
}
}
+#undef vlc_object_attach
/**
****************************************************************************
* attach object to a parent object
* This function sets p_this as a child of p_parent, and p_parent as a parent
* of p_this. This link can be undone using vlc_object_detach.
*****************************************************************************/
-void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
+void vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
{
if( !p_this ) return;
+ vlc_object_internals_t *pap = vlc_internals (p_parent);
+ vlc_object_internals_t *priv = vlc_internals (p_this);
+ vlc_object_t *p_old_parent;
+
+ priv->prev = NULL;
vlc_object_hold (p_parent);
libvlc_lock (p_this->p_libvlc);
+#ifndef NDEBUG
+ /* Reparenting an object carries a risk of invalid access to the parent,
+ * from another thread. This can happen when inheriting a variable, or
+ * through any direct access to vlc_object_t.p_parent. Also, reparenting
+ * brings a functional bug, whereby the reparented object uses incorrect
+ * old values for inherited variables (as the new parent may have different
+ * variable values, especially if it is an input).
+ * Note that the old parent may be already destroyed.
+ * So its pointer must not be dereferenced.
+ */
+ if (priv->old_parent)
+ msg_Info (p_this, "Reparenting an object is dangerous (%p -> %p)!",
+ priv->old_parent, p_parent);
+#endif
+
+ p_old_parent = p_this->p_parent;
+ if (p_old_parent)
+ vlc_object_detach_unlocked (p_this);
/* Attach the parent to its child */
- assert (!p_this->p_parent);
p_this->p_parent = p_parent;
/* Attach the child to its parent */
- vlc_object_internals_t *priv = vlc_internals( p_parent );
- INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
- p_this );
+ priv->next = pap->first;
+ if (priv->next != NULL)
+ priv->next->prev = priv;
+ pap->first = priv;
libvlc_unlock (p_this->p_libvlc);
+
+ if (p_old_parent)
+ vlc_object_release (p_old_parent);
}
static void vlc_object_detach_unlocked (vlc_object_t *p_this)
{
- if (p_this->p_parent == NULL)
- return;
+ assert (p_this->p_parent != NULL);
- vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
+ vlc_object_internals_t *pap = vlc_internals (p_this->p_parent);
+ vlc_object_internals_t *priv = vlc_internals (p_this);
- int i_index, i;
+ /* Unlink */
+ if (priv->prev != NULL)
+ priv->prev->next = priv->next;
+ else
+ pap->first = priv->next;
+ if (priv->next != NULL)
+ priv->next->prev = priv->prev;
/* Remove p_this's parent */
+#ifndef NDEBUG
+ priv->old_parent = p_this->p_parent;
+#endif
p_this->p_parent = NULL;
-
- /* Remove all of p_parent's children which are p_this */
- for( i_index = priv->i_children ; i_index-- ; )
- {
- 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];
- }
- }
-
- if( priv->i_children )
- {
- 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
- {
- /* Special case - don't realloc() to zero to avoid leaking */
- free( priv->pp_children );
- priv->pp_children = NULL;
- }
}
-
+#undef vlc_object_detach
/**
****************************************************************************
* detach object from its parent
*****************************************************************************
* This function removes all links between an object and its parent.
*****************************************************************************/
-void __vlc_object_detach( vlc_object_t *p_this )
+void vlc_object_detach( vlc_object_t *p_this )
{
vlc_object_t *p_parent;
if( !p_this ) return;
vlc_object_release (p_parent);
}
+#undef vlc_list_children
/**
* 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 *vlc_list_children( vlc_object_t *obj )
{
vlc_list_t *l;
- vlc_object_internals_t *priv = vlc_internals( obj );
+ vlc_object_internals_t *priv;
+ unsigned count = 0;
libvlc_lock (obj->p_libvlc);
- l = NewList( priv->i_children );
- for (int i = 0; i < l->i_count; i++)
+ for (priv = vlc_internals (obj)->first; priv; priv = priv->next)
+ count++;
+ l = NewList (count);
+ if (likely(l != NULL))
{
- vlc_object_hold( priv->pp_children[i] );
- l->p_values[i].p_object = priv->pp_children[i];
+ unsigned i = 0;
+
+ for (priv = vlc_internals (obj)->first; priv; priv = priv->next)
+ l->p_values[i++].p_object = vlc_object_hold (vlc_externals (priv));
}
libvlc_unlock (obj->p_libvlc);
return l;
MYCASE( VARIABLE, "variable" );
MYCASE( FLOAT, "float" );
MYCASE( TIME, "time" );
+ MYCASE( COORDS, "coords" );
MYCASE( ADDRESS, "address" );
MYCASE( MUTEX, "mutex" );
MYCASE( LIST, "list" );
case VLC_VAR_TIME:
printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
break;
+ case VLC_VAR_COORDS:
+ printf( ": %"PRId32"x%"PRId32,
+ p_var->val.coords.x, p_var->val.coords.y );
+ break;
case VLC_VAR_ADDRESS:
printf( ": %p", p_var->val.p_address );
break;
p_object = VLC_OBJECT(p_this->p_libvlc);
psz_foo[0] = '|';
- DumpStructure( p_object, 0, psz_foo );
+ DumpStructure( vlc_internals(p_object), 0, psz_foo );
}
else if( *psz_cmd == 'v' )
{
if( !p_object )
p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
- PrintObject( p_object, "" );
+ PrintObject( vlc_internals(p_object), "" );
vlc_mutex_lock( &vlc_internals( p_object )->var_lock );
if( vlc_internals( p_object )->var_root == NULL )
puts( " `-o No variables" );
parent != NULL;
parent = parent->p_parent)
{
- if (!objnamecmp (parent, name))
+ const char *objname = vlc_internals (parent)->psz_name;
+ if (objname && !strcmp (objname, name))
return vlc_object_hold (parent);
}
return NULL;
}
-static vlc_object_t *FindChild (vlc_object_t *p_this, int i_type)
+static vlc_object_t *FindChild (vlc_object_internals_t *priv, int i_type)
{
- for (int i = vlc_internals( p_this )->i_children; i--; )
+ for (priv = priv->first; priv != NULL; priv = priv->next)
{
- vlc_object_t *child = vlc_internals (p_this)->pp_children[i];
- if (vlc_internals (child)->i_object_type == i_type)
- return vlc_object_hold (child);
+ if (priv->i_object_type == i_type)
+ return vlc_object_hold (vlc_externals (priv));
- child = FindChild (child, i_type);
- if (child != NULL)
- return child;
+ vlc_object_t *found = FindChild (priv, i_type);
+ if (found != NULL)
+ return found;
}
return NULL;
}
-static vlc_object_t *FindChildName (vlc_object_t *p_this, const char *name)
+static vlc_object_t *FindChildName (vlc_object_internals_t *priv,
+ const char *name)
{
- for (int i = vlc_internals( p_this )->i_children; i--; )
+ for (priv = priv->first; priv != NULL; priv = priv->next)
{
- vlc_object_t *child = vlc_internals (p_this)->pp_children[i];
- if (!objnamecmp (child, name))
- return vlc_object_hold (child);
+ if (priv->psz_name && !strcmp (priv->psz_name, name))
+ return vlc_object_hold (vlc_externals (priv));
- child = FindChildName (child, name);
- if (child != NULL)
- return child;
+ vlc_object_t *found = FindChildName (priv, name);
+ if (found != NULL)
+ return found;
}
return NULL;
}
-static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
+static void PrintObject( vlc_object_internals_t *priv,
+ const char *psz_prefix )
{
- char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
- psz_parent[20];
+ char psz_refcount[20], psz_thread[30], psz_name[50], psz_parent[20];
int canc = vlc_savecancel ();
memset( &psz_name, 0, sizeof(psz_name) );
- char *name = vlc_object_get_name(p_this);
- if( name )
+
+ vlc_mutex_lock (&name_lock);
+ if (priv->psz_name != NULL)
{
- snprintf( psz_name, 49, " \"%s\"", name );
- free( name );
+ snprintf( psz_name, 49, " \"%s\"", priv->psz_name );
if( psz_name[48] )
psz_name[48] = '\"';
}
-
- psz_children[0] = '\0';
- switch( vlc_internals( p_this )->i_children )
- {
- case 0:
- break;
- case 1:
- strcpy( psz_children, ", 1 child" );
- break;
- default:
- snprintf( psz_children, 19, ", %i children",
- vlc_internals( p_this )->i_children );
- break;
- }
+ vlc_mutex_unlock (&name_lock);
psz_refcount[0] = '\0';
- if( vlc_internals( p_this )->i_refcount > 0 )
- snprintf( psz_refcount, 19, ", refcount %u",
- vlc_internals( p_this )->i_refcount );
+ if( priv->i_refcount > 0 )
+ snprintf( psz_refcount, 19, ", %u refs", priv->i_refcount );
psz_thread[0] = '\0';
- if( vlc_internals( p_this )->b_thread )
+ if( priv->b_thread )
snprintf( psz_thread, 29, " (thread %lu)",
- (unsigned long)vlc_internals( p_this )->thread_id );
+ (unsigned long)priv->thread_id );
psz_parent[0] = '\0';
- if( p_this->p_parent )
- snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
-
- 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 );
+ /* FIXME: need structure lock!!! */
+ if( vlc_externals(priv)->p_parent )
+ snprintf( psz_parent, 19, ", parent %p",
+ vlc_externals(priv)->p_parent );
+
+ printf( " %so %p %s%s%s%s%s\n", psz_prefix,
+ vlc_externals(priv), vlc_externals(priv)->psz_object_type,
+ psz_name, psz_thread, psz_refcount, psz_parent );
vlc_restorecancel (canc);
}
-static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
+static void DumpStructure (vlc_object_internals_t *priv, unsigned i_level,
+ char *psz_foo)
{
- int i;
char i_back = psz_foo[i_level];
psz_foo[i_level] = '\0';
- PrintObject( p_this, psz_foo );
+ PrintObject (priv, psz_foo);
psz_foo[i_level] = i_back;
if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
{
- msg_Warn( p_this, "structure tree is too deep" );
+ msg_Warn( vlc_externals(priv), "structure tree is too deep" );
return;
}
- for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
+ for (priv = priv->first; priv != NULL; priv = priv->next)
{
if( i_level )
{
}
}
- if( i == vlc_internals( p_this )->i_children - 1 )
- {
- psz_foo[i_level] = '`';
- }
- else
- {
- psz_foo[i_level] = '|';
- }
-
+ psz_foo[i_level] = priv->next ? '|' : '`';
psz_foo[i_level+1] = '-';
psz_foo[i_level+2] = '\0';
- DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
- psz_foo );
+ DumpStructure (priv, i_level + 2, psz_foo);
}
}
return p_list;
}
-
-static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
- int i_index )
-{
- if( p_list == NULL || i_index >= p_list->i_count )
- {
- return;
- }
-
- vlc_object_hold( p_object );
-
- p_list->p_values[i_index].p_object = p_object;
-
- return;
-}
-
-/*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
-{
- if( p_list == NULL )
- {
- return;
- }
-
- p_list->p_values = realloc_or_free( p_list->p_values,
- (p_list->i_count + 1) * sizeof( vlc_value_t ) );
- if( p_list->p_values == NULL )
- {
- p_list->i_count = 0;
- return;
- }
-
- vlc_object_hold( p_object );
-
- p_list->p_values[p_list->i_count].p_object = p_object;
- p_list->i_count++;
-
- return;
-}*/
-
-static int CountChildren( vlc_object_t *p_this, int i_type )
-{
- vlc_object_t *p_tmp;
- int i, i_count = 0;
-
- for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
- {
- p_tmp = vlc_internals( p_this )->pp_children[i];
-
- if( vlc_internals( p_tmp )->i_object_type == i_type )
- {
- i_count++;
- }
- i_count += CountChildren( p_tmp, i_type );
- }
-
- return i_count;
-}
-
-static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
-{
- vlc_object_t *p_tmp;
- int i;
-
- for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
- {
- p_tmp = vlc_internals( p_this )->pp_children[i];
-
- if( vlc_internals( p_tmp )->i_object_type == i_type )
- ListReplace( p_list, p_tmp, p_list->i_count++ );
-
- ListChildren( p_list, p_tmp, i_type );
- }
-}
projects / vlc / blobdiff