X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;ds=sidebyside;f=src%2Fmisc%2Fvariables.c;h=89ade8e803aec3b361a5f96212a1226794c8a10b;hb=19adcbe5be83ce12a07d83092503c3f4a622b3b6;hp=c97d8cdef451c75baf24d4c433ad3f56275a28ec;hpb=45e63d598008b1ec920bf629388efd08b95c2747;p=vlc diff --git a/src/misc/variables.c b/src/misc/variables.c index c97d8cdef4..89ade8e803 100644 --- a/src/misc/variables.c +++ b/src/misc/variables.c @@ -1,7 +1,7 @@ /***************************************************************************** * variables.c: routines for object variables handling ***************************************************************************** - * Copyright (C) 2002-2006 the VideoLAN team + * Copyright (C) 2002-2009 the VideoLAN team * $Id$ * * Authors: Samuel Hocevar @@ -29,11 +29,13 @@ #endif #include +#include #include "variables.h" #include "libvlc.h" -#include "vlc_interface.h" +#include +#include /***************************************************************************** * Private types @@ -67,7 +69,10 @@ static int CmpAddress( vlc_value_t v, vlc_value_t w ) { return v.p_address == w. * Local duplication functions, and local deallocation functions *****************************************************************************/ static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ } -static void DupString( vlc_value_t *p_val ) { if( p_val->psz_string ) p_val->psz_string = strdup( p_val->psz_string ); } +static void DupString( vlc_value_t *p_val ) +{ + p_val->psz_string = strdup( p_val->psz_string ? p_val->psz_string : "" ); +} static void DupList( vlc_value_t *p_val ) { @@ -135,6 +140,7 @@ static void FreeList( vlc_value_t *p_val ) } static const struct variable_ops_t +void_ops = { NULL, DupDummy, FreeDummy, }, addr_ops = { CmpAddress, DupDummy, FreeDummy, }, bool_ops = { CmpBool, DupDummy, FreeDummy, }, float_ops = { CmpFloat, DupDummy, FreeDummy, }, @@ -147,17 +153,50 @@ time_ops = { CmpTime, DupDummy, FreeDummy, }; /***************************************************************************** * Local prototypes *****************************************************************************/ -static int GetUnused ( vlc_object_t *, const char * ); -static uint32_t HashString ( const char * ); -static int Insert ( variable_t *, int, const char * ); -static int InsertInner ( variable_t *, int, uint32_t ); -static int Lookup ( variable_t *, int, const char * ); -static int LookupInner ( variable_t *, int, uint32_t ); +static void WaitUnused ( vlc_object_t *, variable_t * ); static void CheckValue ( variable_t *, vlc_value_t * ); -static int InheritValue( vlc_object_t *, const char *, vlc_value_t *, - int ); +static int TriggerCallback( vlc_object_t *, variable_t *, const char *, + vlc_value_t ); + +static int varcmp( const void *a, const void *b ) +{ + const variable_t *va = a, *vb = b; + + /* psz_name must be first */ + assert( va == (const void *)&va->psz_name ); + return strcmp( va->psz_name, vb->psz_name ); +} + +static variable_t *Lookup( vlc_object_t *obj, const char *psz_name ) +{ + vlc_object_internals_t *priv = vlc_internals( obj ); + variable_t **pp_var; + + vlc_assert_locked( &priv->var_lock ); + pp_var = tfind( &psz_name, &priv->var_root, varcmp ); + return (pp_var != NULL) ? *pp_var : NULL; +} + +static void Destroy( variable_t *p_var ) +{ + p_var->ops->pf_free( &p_var->val ); + if( p_var->choices.i_count ) + { + for( int i = 0 ; i < p_var->choices.i_count ; i++ ) + { + p_var->ops->pf_free( &p_var->choices.p_values[i] ); + free( p_var->choices_text.p_values[i].psz_string ); + } + free( p_var->choices.p_values ); + free( p_var->choices_text.p_values ); + } + free( p_var->psz_name ); + free( p_var->psz_text ); + free( p_var->p_entries ); + free( p_var ); +} /** * Initialize a vlc variable @@ -173,58 +212,17 @@ static int InheritValue( vlc_object_t *, const char *, vlc_value_t *, */ int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type ) { - int i_new; - variable_t *p_var; static vlc_list_t dummy_null_list = {0, NULL, NULL}; - vlc_object_internals_t *p_priv = vlc_internals( p_this ); + assert( p_this ); - vlc_mutex_lock( &p_priv->var_lock ); - - /* FIXME: if the variable already exists, we don't duplicate it. But we - * duplicate the lookups. It's not that serious, but if anyone finds some - * time to rework Insert() so that only one lookup has to be done, feel - * free to do so. */ - i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - - if( i_new >= 0 ) - { - /* If the types differ, variable creation failed. */ - if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type ) - { - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_EBADVAR; - } - - p_priv->p_vars[i_new].i_usage++; - if( i_type & VLC_VAR_ISCOMMAND ) - p_priv->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND; - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_SUCCESS; - } - - i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name ); - - if( (p_priv->i_vars & 15) == 15 ) - { - p_priv->p_vars = realloc( p_priv->p_vars, - (p_priv->i_vars+17) * sizeof(variable_t) ); - } - - memmove( p_priv->p_vars + i_new + 1, - p_priv->p_vars + i_new, - (p_priv->i_vars - i_new) * sizeof(variable_t) ); - - p_priv->i_vars++; - - p_var = &p_priv->p_vars[i_new]; - memset( p_var, 0, sizeof(*p_var) ); + variable_t *p_var = calloc( 1, sizeof( *p_var ) ); + if( p_var == NULL ) + return VLC_ENOMEM; - p_var->i_hash = HashString( psz_name ); p_var->psz_name = strdup( psz_name ); p_var->psz_text = NULL; p_var->i_type = i_type & ~VLC_VAR_DOINHERIT; - memset( &p_var->val, 0, sizeof(vlc_value_t) ); p_var->i_usage = 1; @@ -276,41 +274,58 @@ int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type ) p_var->ops = &list_ops; p_var->val.p_list = &dummy_null_list; break; + default: + p_var->ops = &void_ops; + break; } - /* Duplicate the default data we stored. */ - p_var->ops->pf_dup( &p_var->val ); - if( i_type & VLC_VAR_DOINHERIT ) { - vlc_value_t val; - - if( InheritValue( p_this, psz_name, &val, p_var->i_type ) - == VLC_SUCCESS ) + if( var_Inherit( p_this, psz_name, i_type, &p_var->val ) ) + msg_Err( p_this, "cannot inherit value for %s", psz_name ); + else if( i_type & VLC_VAR_HASCHOICE ) { - /* Free data if needed */ - p_var->ops->pf_free( &p_var->val ); - /* Set the variable */ - p_var->val = val; + /* We must add the inherited value to our choice list */ + p_var->i_default = 0; - if( i_type & VLC_VAR_HASCHOICE ) - { - /* We must add the inherited value to our choice list */ - p_var->i_default = 0; - - INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count, - 0, val ); - INSERT_ELEM( p_var->choices_text.p_values, - p_var->choices_text.i_count, 0, val ); - p_var->ops->pf_dup( &p_var->choices.p_values[0] ); - p_var->choices_text.p_values[0].psz_string = NULL; - } + INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count, + 0, p_var->val ); + INSERT_ELEM( p_var->choices_text.p_values, + p_var->choices_text.i_count, 0, p_var->val ); + p_var->ops->pf_dup( &p_var->choices.p_values[0] ); + p_var->choices_text.p_values[0].psz_string = NULL; } } + vlc_object_internals_t *p_priv = vlc_internals( p_this ); + variable_t **pp_var, *p_oldvar; + int ret = VLC_SUCCESS; + + vlc_mutex_lock( &p_priv->var_lock ); + + pp_var = tsearch( p_var, &p_priv->var_root, varcmp ); + if( unlikely(pp_var == NULL) ) + ret = VLC_ENOMEM; + else if( (p_oldvar = *pp_var) == p_var ) + p_var = NULL; + else if( unlikely((i_type ^ p_oldvar->i_type) & VLC_VAR_CLASS) ) + { /* If the types differ, variable creation failed. */ + msg_Err( p_this, "Variable '%s' (0x%04x) already exist " + "but with a different type (0x%04x)", + psz_name, p_oldvar->i_type, i_type ); + ret = VLC_EBADVAR; + } + else + { + p_oldvar->i_usage++; + p_oldvar->i_type |= i_type & (VLC_VAR_ISCOMMAND|VLC_VAR_HASCHOICE); + } vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_SUCCESS; + /* If we did not need to create a new variable, free everything... */ + if( p_var != NULL ) + Destroy( p_var ); + return ret; } /** @@ -324,67 +339,44 @@ int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type ) */ int __var_Destroy( vlc_object_t *p_this, const char *psz_name ) { - int i_var, i; variable_t *p_var; - vlc_object_internals_t *p_priv = vlc_internals( p_this ); - vlc_mutex_lock( &p_priv->var_lock ); + assert( p_this ); - i_var = GetUnused( p_this, psz_name ); - if( i_var < 0 ) - { - vlc_mutex_unlock( &p_priv->var_lock ); - return i_var; - } + vlc_object_internals_t *p_priv = vlc_internals( p_this ); - p_var = &p_priv->p_vars[i_var]; + vlc_mutex_lock( &p_priv->var_lock ); - if( p_var->i_usage > 1 ) + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) { - p_var->i_usage--; vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_SUCCESS; - } - - /* Free value if needed */ - p_var->ops->pf_free( &p_var->val ); - - /* Free choice list if needed */ - if( p_var->choices.i_count ) - { - for( i = 0 ; i < p_var->choices.i_count ; i++ ) - { - p_var->ops->pf_free( &p_var->choices.p_values[i] ); - free( p_var->choices_text.p_values[i].psz_string ); - } - free( p_var->choices.p_values ); - free( p_var->choices_text.p_values ); - } - - /* Free callbacks if needed */ - if( p_var->p_entries ) - { - free( p_var->p_entries ); + return VLC_ENOVAR; } - free( p_var->psz_name ); - free( p_var->psz_text ); + WaitUnused( p_this, p_var ); - memmove( p_priv->p_vars + i_var, - p_priv->p_vars + i_var + 1, - (p_priv->i_vars - i_var - 1) * sizeof(variable_t) ); + if( --p_var->i_usage == 0 ) + tdelete( p_var, &p_priv->var_root, varcmp ); + else + p_var = NULL; + vlc_mutex_unlock( &p_priv->var_lock ); - if( (p_priv->i_vars & 15) == 0 ) - { - p_priv->p_vars = realloc( p_priv->p_vars, - (p_priv->i_vars) * sizeof( variable_t ) ); - } + if( p_var != NULL ) + Destroy( p_var ); + return VLC_SUCCESS; +} - p_priv->i_vars--; +static void CleanupVar( void *var ) +{ + Destroy( var ); +} - vlc_mutex_unlock( &p_priv->var_lock ); +void var_DestroyAll( vlc_object_t *obj ) +{ + vlc_object_internals_t *priv = vlc_internals( obj ); - return VLC_SUCCESS; + tdestroy( priv->var_root, CleanupVar ); } /** @@ -399,23 +391,24 @@ int __var_Destroy( vlc_object_t *p_this, const char *psz_name ) int __var_Change( vlc_object_t *p_this, const char *psz_name, int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 ) { - int i_var, i; + int i; variable_t *p_var; vlc_value_t oldval; + vlc_value_t newval; + + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); vlc_mutex_lock( &p_priv->var_lock ); - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - - if( i_var < 0 ) + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) { vlc_mutex_unlock( &p_priv->var_lock ); return VLC_ENOVAR; } - p_var = &p_priv->p_vars[i_var]; - switch( i_action ) { case VLC_VAR_SETMIN: @@ -554,13 +547,14 @@ int __var_Change( vlc_object_t *p_this, const char *psz_name, break; case VLC_VAR_SETVALUE: /* Duplicate data if needed */ - p_var->ops->pf_dup( p_val ); + newval = *p_val; + p_var->ops->pf_dup( &newval ); /* Backup needed stuff */ oldval = p_var->val; /* Check boundaries and list */ - CheckValue( p_var, p_val ); + CheckValue( p_var, &newval ); /* Set the variable */ - p_var->val = *p_val; + p_var->val = newval; /* Free data if needed */ p_var->ops->pf_free( &oldval ); break; @@ -598,96 +592,17 @@ int __var_Change( vlc_object_t *p_this, const char *psz_name, } } break; - case VLC_VAR_FREELIST: - FreeList( p_val ); - if( p_val2 && p_val2->p_list ) - { - for( i = 0; i < p_val2->p_list->i_count; i++ ) - free( p_val2->p_list->p_values[i].psz_string ); - if( p_val2->p_list->i_count ) - { - free( p_val2->p_list->p_values ); - free( p_val2->p_list->pi_types ); - } - free( p_val2->p_list ); - } - break; case VLC_VAR_SETTEXT: free( p_var->psz_text ); if( p_val && p_val->psz_string ) p_var->psz_text = strdup( p_val->psz_string ); + else + p_var->psz_text = NULL; break; case VLC_VAR_GETTEXT: - p_val->psz_string = NULL; - if( p_var->psz_text ) - { - p_val->psz_string = strdup( p_var->psz_text ); - } + p_val->psz_string = p_var->psz_text ? strdup( p_var->psz_text ) + : NULL; break; - case VLC_VAR_INHERITVALUE: - { - vlc_value_t val; - - if( InheritValue( p_this, - p_val2 ? p_val2->psz_string : psz_name, - &val, p_var->i_type ) - == VLC_SUCCESS ) - { - /* Duplicate already done */ - - /* Backup needed stuff */ - oldval = p_var->val; - /* Check boundaries and list */ - CheckValue( p_var, &val ); - /* Set the variable */ - p_var->val = val; - /* Free data if needed */ - p_var->ops->pf_free( &oldval ); - } - - if( p_val ) - { - *p_val = p_var->val; - p_var->ops->pf_dup( p_val ); - } - } - break; - case VLC_VAR_TRIGGER_CALLBACKS: - { - /* Deal with callbacks. Tell we're in a callback, release the lock, - * call stored functions, retake the lock. */ - if( p_var->i_entries ) - { - int i_var; - int i_entries = p_var->i_entries; - callback_entry_t *p_entries = p_var->p_entries; - - p_var->b_incallback = true; - vlc_mutex_unlock( &p_priv->var_lock ); - - /* The real calls */ - for( ; i_entries-- ; ) - { - p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val, - p_entries[i_entries].p_data ); - } - - vlc_mutex_lock( &p_priv->var_lock ); - - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - if( i_var < 0 ) - { - msg_Err( p_this, "variable %s has disappeared", psz_name ); - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_ENOVAR; - } - - p_var = &p_priv->p_vars[i_var]; - p_var->b_incallback = false; - } - } - break; - case VLC_VAR_SETISCOMMAND: p_var->i_type |= VLC_VAR_ISCOMMAND; break; @@ -701,59 +616,122 @@ int __var_Change( vlc_object_t *p_this, const char *psz_name, return VLC_SUCCESS; } + /** - * Request a variable's type + * Perform a Get and Set on a variable * - * \return The variable type if it exists, or 0 if the - * variable could not be found. - * \see \ref var_type + * \param p_this: The object that hold the variable + * \param psz_name: the name of the variable + * \param i_action: the action to perform + * \param p_val: The action parameter + * \return vlc error codes */ -int __var_Type( vlc_object_t *p_this, const char *psz_name ) +int __var_GetAndSet( vlc_object_t *p_this, const char *psz_name, int i_action, + vlc_value_t val ) { - int i_var, i_type; + int i_ret; + variable_t *p_var; + vlc_value_t oldval; + + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); vlc_mutex_lock( &p_priv->var_lock ); + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) + { + vlc_mutex_unlock( &p_priv->var_lock ); + return VLC_ENOVAR; + } + + WaitUnused( p_this, p_var ); + + /* Duplicated data if needed */ + //p_var->ops->pf_dup( &val ); - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); + /* Backup needed stuff */ + oldval = p_var->val; - if( i_var < 0 ) + /* depending of the action requiered */ + switch( i_action ) { + case VLC_VAR_TOGGLE_BOOL: + assert( ( p_var->i_type & VLC_VAR_BOOL ) == VLC_VAR_BOOL ); + p_var->val.b_bool = !p_var->val.b_bool; + break; + case VLC_VAR_INTEGER_INCDEC: + assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER ); + p_var->val.i_int += val.i_int; + break; + default: vlc_mutex_unlock( &p_priv->var_lock ); - return 0; + return VLC_EGENERIC; } - i_type = p_priv->p_vars[i_var].i_type; + /* Check boundaries */ + CheckValue( p_var, &p_var->val ); + + /* Deal with callbacks.*/ + i_ret = TriggerCallback( p_this, p_var, psz_name, oldval ); vlc_mutex_unlock( &p_priv->var_lock ); - return i_type; + return i_ret; } + /** - * Set a variable's value + * Request a variable's type * - * \param p_this The object that hold the variable - * \param psz_name The name of the variable - * \param val the value to set + * \return The variable type if it exists, or 0 if the + * variable could not be found. + * \see \ref var_type */ -int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val ) +int __var_Type( vlc_object_t *p_this, const char *psz_name ) +{ + variable_t *p_var; + int i_type = 0; + + assert( p_this ); + + vlc_object_internals_t *p_priv = vlc_internals( p_this ); + + vlc_mutex_lock( &p_priv->var_lock ); + + p_var = Lookup( p_this, psz_name ); + if( p_var != NULL ) + i_type = p_var->i_type; + + vlc_mutex_unlock( &p_priv->var_lock ); + + return i_type; +} + +int var_SetChecked( vlc_object_t *p_this, const char *psz_name, + int expected_type, vlc_value_t val ) { - int i_var; + int i_ret = VLC_SUCCESS; variable_t *p_var; vlc_value_t oldval; + + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); vlc_mutex_lock( &p_priv->var_lock ); - i_var = GetUnused( p_this, psz_name ); - if( i_var < 0 ) + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) { vlc_mutex_unlock( &p_priv->var_lock ); - return i_var; + return VLC_ENOVAR; } - p_var = &p_priv->p_vars[i_var]; + assert( expected_type == 0 || + (p_var->i_type & VLC_VAR_CLASS) == expected_type ); + + WaitUnused( p_this, p_var ); /* Duplicate data if needed */ p_var->ops->pf_dup( &val ); @@ -767,103 +745,79 @@ int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val ) /* Set the variable */ p_var->val = val; - /* Deal with callbacks. Tell we're in a callback, release the lock, - * call stored functions, retake the lock. */ - if( p_var->i_entries ) - { - int i_var; - int i_entries = p_var->i_entries; - callback_entry_t *p_entries = p_var->p_entries; - - p_var->b_incallback = true; - vlc_mutex_unlock( &p_priv->var_lock ); - - /* The real calls */ - for( ; i_entries-- ; ) - { - p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val, - p_entries[i_entries].p_data ); - } - - vlc_mutex_lock( &p_priv->var_lock ); - - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - if( i_var < 0 ) - { - msg_Err( p_this, "variable %s has disappeared", psz_name ); - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_ENOVAR; - } - - p_var = &p_priv->p_vars[i_var]; - p_var->b_incallback = false; - } + /* Deal with callbacks */ + i_ret = TriggerCallback( p_this, p_var, psz_name, oldval ); /* Free data if needed */ p_var->ops->pf_free( &oldval ); vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_SUCCESS; + return i_ret; } + /** - * Get a variable's value + * Set a variable's value * - * \param p_this The object that holds the variable + * \param p_this The object that hold the variable * \param psz_name The name of the variable - * \param p_val Pointer to a vlc_value_t that will hold the variable's value - * after the function is finished + * \param val the value to set */ -int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val ) +int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val ) { - int i_var; - variable_t *p_var; + return var_SetChecked( p_this, psz_name, 0, val ); +} + +int var_GetChecked( vlc_object_t *p_this, const char *psz_name, + int expected_type, vlc_value_t *p_val ) +{ + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); + variable_t *p_var; + int err = VLC_SUCCESS; vlc_mutex_lock( &p_priv->var_lock ); - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - - if( i_var < 0 ) + p_var = Lookup( p_this, psz_name ); + if( p_var != NULL ) { - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_ENOVAR; - } + assert( expected_type == 0 || + (p_var->i_type & VLC_VAR_CLASS) == expected_type ); - p_var = &p_priv->p_vars[i_var]; + /* Really get the variable */ + *p_val = p_var->val; - /* Really get the variable */ - *p_val = p_var->val; +#ifndef NDEBUG + /* Alert if the type is VLC_VAR_VOID */ + if( ( p_var->i_type & VLC_VAR_TYPE ) == VLC_VAR_VOID ) + msg_Warn( p_this, "Calling var_GetVoid on the void variable '%s' (0x%04x)", psz_name, p_var->i_type ); +#endif - /* Duplicate value if needed */ - p_var->ops->pf_dup( p_val ); + /* Duplicate value if needed */ + p_var->ops->pf_dup( p_val ); + } + else + err = VLC_ENOVAR; vlc_mutex_unlock( &p_priv->var_lock ); - - return VLC_SUCCESS; + return err; } - -#undef var_AcquireMutex /** - * Finds a process-wide mutex, creates it if needed, and locks it. - * Unlock with vlc_mutex_unlock(). + * Get a variable's value + * + * \param p_this The object that holds the variable + * \param psz_name The name of the variable + * \param p_val Pointer to a vlc_value_t that will hold the variable's value + * after the function is finished */ -vlc_mutex_t *var_AcquireMutex( const char *name ) +int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val ) { - libvlc_global_data_t *p_global = vlc_global(); - vlc_value_t val; - - if( var_Create( p_global, name, VLC_VAR_MUTEX ) ) - return NULL; - - var_Get( p_global, name, &val ); - vlc_mutex_lock( val.p_address ); - return val.p_address; + return var_GetChecked( p_this, psz_name, 0, p_val ); } - /** * Register a callback in a variable * @@ -883,9 +837,11 @@ vlc_mutex_t *var_AcquireMutex( const char *name ) int __var_AddCallback( vlc_object_t *p_this, const char *psz_name, vlc_callback_t pf_callback, void *p_data ) { - int i_var; variable_t *p_var; callback_entry_t entry; + + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); entry.pf_callback = pf_callback; @@ -893,15 +849,18 @@ int __var_AddCallback( vlc_object_t *p_this, const char *psz_name, vlc_mutex_lock( &p_priv->var_lock ); - i_var = GetUnused( p_this, psz_name ); - if( i_var < 0 ) + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) { +#ifndef NDEBUG + msg_Warn( p_this, "Failed to add a callback to the non-existing " + "variable '%s'", psz_name ); +#endif vlc_mutex_unlock( &p_priv->var_lock ); - return i_var; + return VLC_ENOVAR; } - p_var = &p_priv->p_vars[i_var]; - + WaitUnused( p_this, p_var ); INSERT_ELEM( p_var->p_entries, p_var->i_entries, p_var->i_entries, @@ -921,20 +880,26 @@ int __var_AddCallback( vlc_object_t *p_this, const char *psz_name, int __var_DelCallback( vlc_object_t *p_this, const char *psz_name, vlc_callback_t pf_callback, void *p_data ) { - int i_entry, i_var; + int i_entry; variable_t *p_var; +#ifndef NDEBUG + bool b_found_similar = false; +#endif + + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); vlc_mutex_lock( &p_priv->var_lock ); - i_var = GetUnused( p_this, psz_name ); - if( i_var < 0 ) + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) { vlc_mutex_unlock( &p_priv->var_lock ); - return i_var; + return VLC_ENOVAR; } - p_var = &p_priv->p_vars[i_var]; + WaitUnused( p_this, p_var ); for( i_entry = p_var->i_entries ; i_entry-- ; ) { @@ -943,10 +908,20 @@ int __var_DelCallback( vlc_object_t *p_this, const char *psz_name, { break; } +#ifndef NDEBUG + else if( p_var->p_entries[i_entry].pf_callback == pf_callback ) + b_found_similar = true; +#endif } if( i_entry < 0 ) { +#ifndef NDEBUG + if( b_found_similar ) + fprintf( stderr, "Calling var_DelCallback for '%s' with the same " + "function but not the same data.", psz_name ); + assert( 0 ); +#endif vlc_mutex_unlock( &p_priv->var_lock ); return VLC_EGENERIC; } @@ -966,59 +941,30 @@ int __var_DelCallback( vlc_object_t *p_this, const char *psz_name, */ int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name ) { - int i_var; + int i_ret; variable_t *p_var; - vlc_value_t oldval; + + assert( p_this ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); vlc_mutex_lock( &p_priv->var_lock ); - i_var = GetUnused( p_this, psz_name ); - if( i_var < 0 ) + p_var = Lookup( p_this, psz_name ); + if( p_var == NULL ) { vlc_mutex_unlock( &p_priv->var_lock ); - return i_var; + return VLC_ENOVAR; } - p_var = &p_priv->p_vars[i_var]; - - /* Backup needed stuff */ - oldval = p_var->val; + WaitUnused( p_this, p_var ); /* Deal with callbacks. Tell we're in a callback, release the lock, * call stored functions, retake the lock. */ - if( p_var->i_entries ) - { - int i_var; - int i_entries = p_var->i_entries; - callback_entry_t *p_entries = p_var->p_entries; - - p_var->b_incallback = true; - vlc_mutex_unlock( &p_priv->var_lock ); - - /* The real calls */ - for( ; i_entries-- ; ) - { - p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval, - p_entries[i_entries].p_data ); - } - - vlc_mutex_lock( &p_priv->var_lock ); - - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - if( i_var < 0 ) - { - msg_Err( p_this, "variable %s has disappeared", psz_name ); - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_ENOVAR; - } - - p_var = &p_priv->p_vars[i_var]; - p_var->b_incallback = false; - } + i_ret = TriggerCallback( p_this, p_var, psz_name, p_var->val ); vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_SUCCESS; + return i_ret; } /** Parse a stringified option @@ -1088,10 +1034,11 @@ void var_OptionParse( vlc_object_t *p_obj, const char *psz_option, if( !trusted ) { module_config_t *p_config = config_FindConfig( p_obj, psz_name ); - if( !p_config->b_safe ) + if( !p_config || !p_config->b_safe ) { msg_Err( p_obj, "unsafe option \"%s\" has been ignored for " "security reasons", psz_name ); + free( psz_name ); return; } } @@ -1099,7 +1046,7 @@ void var_OptionParse( vlc_object_t *p_obj, const char *psz_option, /* Create the variable in the input object. * Children of the input object will be able to retreive this value * thanks to the inheritance property of the object variables. */ - var_Create( p_obj, psz_name, i_type ); + __var_Create( p_obj, psz_name, i_type ); switch( i_type ) { @@ -1112,7 +1059,7 @@ void var_OptionParse( vlc_object_t *p_obj, const char *psz_option, break; case VLC_VAR_FLOAT: - val.f_float = atof( psz_value ); + val.f_float = us_atof( psz_value ); break; case VLC_VAR_STRING: @@ -1156,7 +1103,11 @@ void var_OptionParse( vlc_object_t *p_obj, const char *psz_option, goto cleanup; } - var_Set( p_obj, psz_name, val ); + __var_Set( p_obj, psz_name, val ); + + /* If that's a list, remove all elements allocated */ + if( i_type == VLC_VAR_LIST ) + FreeList( &val ); cleanup: free( psz_name ); @@ -1165,201 +1116,17 @@ cleanup: /* Following functions are local */ -/***************************************************************************** - * GetUnused: find an unused variable from its name - ***************************************************************************** - * We do i_tries tries before giving up, just in case the variable is being - * modified and called from a callback. - *****************************************************************************/ -static int GetUnused( vlc_object_t *p_this, const char *psz_name ) +/** + * Waits until the variable is inactive (i.e. not executing a callback) + */ +static void WaitUnused( vlc_object_t *p_this, variable_t *p_var ) { - int i_var, i_tries = 0; vlc_object_internals_t *p_priv = vlc_internals( p_this ); - while( true ) - { - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); - if( i_var < 0 ) - { - return VLC_ENOVAR; - } - - if( ! p_priv->p_vars[i_var].b_incallback ) - { - return i_var; - } - - if( i_tries++ > 100 ) - { - msg_Err( p_this, "caught in a callback deadlock? ('%s')", psz_name ); - return VLC_ETIMEOUT; - } - - vlc_mutex_unlock( &p_priv->var_lock ); - msleep( THREAD_SLEEP ); - vlc_mutex_lock( &p_priv->var_lock ); - } -} - -/***************************************************************************** - * HashString: our cool hash function - ***************************************************************************** - * This function is not intended to be crypto-secure, we only want it to be - * fast and not suck too much. This one is pretty fast and did 0 collisions - * in wenglish's dictionary. - *****************************************************************************/ -static uint32_t HashString( const char *psz_string ) -{ - uint32_t i_hash = 0; - - while( *psz_string ) - { - i_hash += *psz_string++; - i_hash += i_hash << 10; - i_hash ^= i_hash >> 8; - } - - return i_hash; -} - -/***************************************************************************** - * Insert: find an empty slot to insert a new variable - ***************************************************************************** - * We use a recursive inner function indexed on the hash. This function does - * nothing in the rare cases where a collision may occur, see Lookup() - * to see how we handle them. - * XXX: does this really need to be written recursively? - *****************************************************************************/ -static int Insert( variable_t *p_vars, int i_count, const char *psz_name ) -{ - if( i_count == 0 ) - { - return 0; - } - - return InsertInner( p_vars, i_count, HashString( psz_name ) ); -} - -static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash ) -{ - int i_middle; - - if( i_hash <= p_vars[0].i_hash ) - { - return 0; - } - - if( i_hash >= p_vars[i_count - 1].i_hash ) - { - return i_count; - } - - i_middle = i_count / 2; - - /* We know that 0 < i_middle */ - if( i_hash < p_vars[i_middle].i_hash ) - { - return InsertInner( p_vars, i_middle, i_hash ); - } - - /* We know that i_middle + 1 < i_count */ - if( i_hash > p_vars[i_middle + 1].i_hash ) - { - return i_middle + 1 + InsertInner( p_vars + i_middle + 1, - i_count - i_middle - 1, - i_hash ); - } - - return i_middle + 1; -} - -/***************************************************************************** - * Lookup: find an existing variable given its name - ***************************************************************************** - * We use a recursive inner function indexed on the hash. Care is taken of - * possible hash collisions. - * XXX: does this really need to be written recursively? - *****************************************************************************/ -static int Lookup( variable_t *p_vars, int i_count, const char *psz_name ) -{ - uint32_t i_hash; - int i, i_pos; - - if( i_count == 0 ) - { - return -1; - } - - i_hash = HashString( psz_name ); - - i_pos = LookupInner( p_vars, i_count, i_hash ); - - /* Hash not found */ - if( i_hash != p_vars[i_pos].i_hash ) - { - return -1; - } - - /* Hash found, entry found */ - if( !strcmp( psz_name, p_vars[i_pos].psz_name ) ) - { - return i_pos; - } - - /* Hash collision! This should be very rare, but we cannot guarantee - * it will never happen. Just do an exhaustive search amongst all - * entries with the same hash. */ - for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- ) - { - if( !strcmp( psz_name, p_vars[i].psz_name ) ) - { - return i; - } - } - - for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ ) - { - if( !strcmp( psz_name, p_vars[i].psz_name ) ) - { - return i; - } - } - - /* Hash found, but entry not found */ - return -1; -} - -static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash ) -{ - int i_middle; - - if( i_hash <= p_vars[0].i_hash ) - { - return 0; - } - - if( i_hash >= p_vars[i_count-1].i_hash ) - { - return i_count - 1; - } - - i_middle = i_count / 2; - - /* We know that 0 < i_middle */ - if( i_hash < p_vars[i_middle].i_hash ) - { - return LookupInner( p_vars, i_middle, i_hash ); - } - - /* We know that i_middle + 1 < i_count */ - if( i_hash > p_vars[i_middle].i_hash ) - { - return i_middle + LookupInner( p_vars + i_middle, - i_count - i_middle, - i_hash ); - } - - return i_middle; + mutex_cleanup_push( &p_priv->var_lock ); + while( p_var->b_incallback ) + vlc_cond_wait( &p_priv->var_wait, &p_priv->var_lock ); + vlc_cleanup_pop( ); } /***************************************************************************** @@ -1376,7 +1143,7 @@ static void CheckValue ( variable_t *p_var, vlc_value_t *p_val ) { int i; - /* FIXME: the list is sorted, dude. Use something cleverer. */ + /* This list is not sorted so go throug it (this is a small list) */ for( i = p_var->choices.i_count ; i-- ; ) { if( p_var->ops->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 ) @@ -1444,24 +1211,23 @@ static void CheckValue ( variable_t *p_var, vlc_value_t *p_val ) } } -/***************************************************************************** - * InheritValue: try to inherit the value of this variable from the same one - * in our closest parent. - *****************************************************************************/ -static int InheritValue( vlc_object_t *p_this, const char *psz_name, - vlc_value_t *p_val, int i_type ) +/** + * Finds the value of a variable. If the specified object does not hold a + * variable with the specified name, try the parent object, and iterate until + * the top of the tree. If no match is found, the value is read from the + * configuration. + */ +int var_Inherit( vlc_object_t *p_this, const char *psz_name, int i_type, + vlc_value_t *p_val ) { - int i_var; - variable_t *p_var; - vlc_object_internals_t *p_priv; - - /* No need to take the structure lock, - * we are only looking for our parents */ + i_type &= VLC_VAR_CLASS; + for( vlc_object_t *obj = p_this; obj != NULL; obj = obj->p_parent ) + if( var_GetChecked( obj, psz_name, i_type, p_val ) == VLC_SUCCESS ) + return VLC_SUCCESS; - if( !p_this->p_parent && !p_this->p_libvlc ) + /* else take value from config */ + switch( i_type & VLC_VAR_CLASS ) { - switch( i_type & VLC_VAR_CLASS ) - { case VLC_VAR_STRING: p_val->psz_string = config_GetPsz( p_this, psz_name ); if( !p_val->psz_string ) p_val->psz_string = strdup(""); @@ -1505,45 +1271,51 @@ static int InheritValue( vlc_object_t *p_this, const char *psz_name, break; } default: + msg_Warn( p_this, "Could not inherit value for var %s " + "from config. Invalid Type", psz_name ); return VLC_ENOOBJ; - break; - } - - return VLC_SUCCESS; } + /*msg_Dbg( p_this, "Inherited value for var %s from config", psz_name );*/ + return VLC_SUCCESS; +} - if( !p_this->p_parent ) - p_priv = vlc_internals( p_this->p_libvlc ); - else - p_priv = vlc_internals( p_this->p_parent ); - - /* Look for the variable */ - vlc_mutex_lock( &p_priv->var_lock ); - i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name ); +/********************************************************************** + * Trigger the callbacks. + * Tell we're in a callback, release the lock, call stored functions, + * retake the lock. + **********************************************************************/ +static int TriggerCallback( vlc_object_t *p_this, variable_t *p_var, + const char *psz_name, vlc_value_t oldval ) +{ + assert( p_this ); - if( i_var >= 0 ) - { - /* We found it! */ - p_var = &p_priv->p_vars[i_var]; + int i_entries = p_var->i_entries; + if( i_entries == 0 ) + return VLC_SUCCESS; - /* Really get the variable */ - *p_val = p_var->val; + callback_entry_t *p_entries = p_var->p_entries; + vlc_object_internals_t *p_priv = vlc_internals( p_this ); - /* Duplicate value if needed */ - p_var->ops->pf_dup( p_val ); + assert( !p_var->b_incallback ); + p_var->b_incallback = true; + vlc_mutex_unlock( &p_priv->var_lock ); - vlc_mutex_unlock( &p_priv->var_lock ); - return VLC_SUCCESS; + /* The real calls */ + for( ; i_entries-- ; ) + { + p_entries[i_entries].pf_callback( p_this, psz_name, oldval, p_var->val, + p_entries[i_entries].p_data ); } - vlc_mutex_unlock( &p_priv->var_lock ); - - /* We're still not there */ + vlc_mutex_lock( &p_priv->var_lock ); + p_var->b_incallback = false; + vlc_cond_broadcast( &p_priv->var_wait ); - return InheritValue( p_this->p_parent, psz_name, p_val, i_type ); + return VLC_SUCCESS; } + /********************************************************************** * Execute a var command on an object identified by its name **********************************************************************/ @@ -1577,7 +1349,7 @@ int __var_Command( vlc_object_t *p_this, const char *psz_name, i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) ); break; case VLC_VAR_FLOAT: - i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) ); + i_ret = var_SetFloat( p_obj, psz_cmd, us_atof( psz_arg ) ); break; case VLC_VAR_STRING: i_ret = var_SetString( p_obj, psz_cmd, psz_arg ); @@ -1594,10 +1366,32 @@ int __var_Command( vlc_object_t *p_this, const char *psz_name, if( psz_msg ) { - *psz_msg = (char*)malloc( 80 ); - sprintf( *psz_msg, "%s on object %s returned %i (%s)", - psz_cmd, psz_name, i_ret, vlc_error( i_ret ) ); + if( asprintf( psz_msg, "%s on object %s returned %i (%s)", + psz_cmd, psz_name, i_ret, vlc_error( i_ret ) ) == -1) + *psz_msg = NULL; } return i_ret; } + + +/** + * Free a list and the associated strings + * @param p_val: the list variable + * @param p_val2: the variable associated or NULL + */ +void var_FreeList( vlc_value_t *p_val, vlc_value_t *p_val2 ) +{ + FreeList( p_val ); + if( p_val2 && p_val2->p_list ) + { + for( int i = 0; i < p_val2->p_list->i_count; i++ ) + free( p_val2->p_list->p_values[i].psz_string ); + if( p_val2->p_list->i_count ) + { + free( p_val2->p_list->p_values ); + free( p_val2->p_list->pi_types ); + } + free( p_val2->p_list ); + } +}