X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fmisc%2Fmessages.c;h=4ef2b281191ecbe8558631fe56f331135a5a3fdf;hb=df7e8cf916417f2c609571c4aa8e2bbb1b92ea07;hp=ba936149e901d40e87ccc8f673edd76eebc49567;hpb=6ea07c2e90f8d1acd116301be8de0f82938c6e6e;p=vlc diff --git a/src/misc/messages.c b/src/misc/messages.c index ba936149e9..4ef2b28119 100644 --- a/src/misc/messages.c +++ b/src/misc/messages.c @@ -35,11 +35,11 @@ #include #include /* va_list for BSD */ - -#ifdef HAVE_FCNTL_H -# include /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */ +#ifdef __APPLE__ +# include +#elif HAVE_LOCALE_H +# include #endif - #include /* errno */ #ifdef WIN32 @@ -61,6 +61,13 @@ typedef struct char * psz_message; } msg_context_t; +static void cleanup_msg_context (void *data) +{ + msg_context_t *ctx = data; + free (ctx->psz_message); + free (ctx); +} + static vlc_threadvar_t msg_context; static uintptr_t banks = 0; @@ -75,185 +82,200 @@ static uintptr_t banks = 0; # define vlc_va_copy(dest,src) (dest)=(src) #endif -#define QUEUE priv->msg_bank +static inline msg_bank_t *libvlc_bank (libvlc_int_t *inst) +{ + return (libvlc_priv (inst))->msg_bank; +} /***************************************************************************** * Local prototypes *****************************************************************************/ -static void QueueMsg ( vlc_object_t *, int, const char *, - const char *, va_list ); -static void FlushMsg ( msg_bank_t * ); static void PrintMsg ( vlc_object_t *, msg_item_t * ); static vlc_mutex_t msg_stack_lock = VLC_STATIC_MUTEX; +/** + * Store all data required by messages interfaces. + */ +struct msg_bank_t +{ + /** Message queue lock */ + vlc_rwlock_t lock; + + /* Subscribers */ + int i_sub; + msg_subscription_t **pp_sub; + + locale_t locale; /**< C locale for error messages */ + vlc_dictionary_t enabled_objects; ///< Enabled objects + bool all_objects_enabled; ///< Should we print all objects? +}; + /** * Initialize messages queues * This function initializes all message queues */ -void msg_Create (libvlc_int_t *p_libvlc) +msg_bank_t *msg_Create (void) { - libvlc_priv_t *priv = libvlc_priv (p_libvlc); - vlc_mutex_init( &QUEUE.lock ); - vlc_dictionary_init( &priv->msg_enabled_objects, 0 ); - priv->msg_all_objects_enabled = true; - - QUEUE.b_overflow = false; - QUEUE.i_start = 0; - QUEUE.i_stop = 0; - QUEUE.i_sub = 0; - QUEUE.pp_sub = 0; - -#ifdef UNDER_CE - QUEUE.logfile = - CreateFile( L"vlc-log.txt", GENERIC_WRITE, - FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, - CREATE_ALWAYS, 0, NULL ); - SetFilePointer( QUEUE.logfile, 0, NULL, FILE_END ); -#endif + msg_bank_t *bank = malloc (sizeof (*bank)); + + vlc_rwlock_init (&bank->lock); + vlc_dictionary_init (&bank->enabled_objects, 0); + bank->all_objects_enabled = true; + + bank->i_sub = 0; + bank->pp_sub = NULL; + + /* C locale to get error messages in English in the logs */ + bank->locale = newlocale (LC_MESSAGES_MASK, "C", (locale_t)0); vlc_mutex_lock( &msg_stack_lock ); if( banks++ == 0 ) - vlc_threadvar_create( &msg_context, NULL ); + vlc_threadvar_create( &msg_context, cleanup_msg_context ); vlc_mutex_unlock( &msg_stack_lock ); + return bank; } -/** - * Flush all message queues - */ -void msg_Flush (libvlc_int_t *p_libvlc) -{ - libvlc_priv_t *priv = libvlc_priv (p_libvlc); - vlc_mutex_lock( &QUEUE.lock ); - FlushMsg( &QUEUE ); - vlc_mutex_unlock( &QUEUE.lock ); -} - - /** * Object Printing selection */ static void const * kObjectPrintingEnabled = &kObjectPrintingEnabled; static void const * kObjectPrintingDisabled = &kObjectPrintingDisabled; -void __msg_EnableObjectPrinting (vlc_object_t *p_this, char * psz_object) +#undef msg_EnableObjectPrinting +void msg_EnableObjectPrinting (vlc_object_t *obj, const char * psz_object) { - libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc); - vlc_mutex_lock( &QUEUE.lock ); + msg_bank_t *bank = libvlc_bank (obj->p_libvlc); + + vlc_rwlock_wrlock (&bank->lock); if( !strcmp(psz_object, "all") ) - priv->msg_all_objects_enabled = true; + bank->all_objects_enabled = true; else - vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingEnabled ); - vlc_mutex_unlock( &QUEUE.lock ); + vlc_dictionary_insert (&bank->enabled_objects, psz_object, + (void *)kObjectPrintingEnabled); + vlc_rwlock_unlock (&bank->lock); } -void __msg_DisableObjectPrinting (vlc_object_t *p_this, char * psz_object) +#undef msg_DisableObjectPrinting +void msg_DisableObjectPrinting (vlc_object_t *obj, const char * psz_object) { - libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc); - vlc_mutex_lock( &QUEUE.lock ); + msg_bank_t *bank = libvlc_bank (obj->p_libvlc); + + vlc_rwlock_wrlock (&bank->lock); if( !strcmp(psz_object, "all") ) - priv->msg_all_objects_enabled = false; + bank->all_objects_enabled = false; else - vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingDisabled ); - vlc_mutex_unlock( &QUEUE.lock ); + vlc_dictionary_insert (&bank->enabled_objects, psz_object, + (void *)kObjectPrintingDisabled); + vlc_rwlock_unlock (&bank->lock); } /** * Destroy the message queues * * This functions prints all messages remaining in the queues, - * then frees all the allocated ressources + * then frees all the allocated resources * No other messages interface functions should be called after this one. */ -void msg_Destroy (libvlc_int_t *p_libvlc) +void msg_Destroy (msg_bank_t *bank) { - libvlc_priv_t *priv = libvlc_priv (p_libvlc); - - if( QUEUE.i_sub ) - msg_Err( p_libvlc, "stale interface subscribers" ); - - FlushMsg( &QUEUE ); + if (unlikely(bank->i_sub != 0)) + fputs ("stale interface subscribers (LibVLC might crash)\n", stderr); vlc_mutex_lock( &msg_stack_lock ); + assert(banks > 0); if( --banks == 0 ) vlc_threadvar_delete( &msg_context ); vlc_mutex_unlock( &msg_stack_lock ); -#ifdef UNDER_CE - CloseHandle( QUEUE.logfile ); -#endif + if (bank->locale != (locale_t)0) + freelocale (bank->locale); - vlc_dictionary_clear( &priv->msg_enabled_objects, NULL, NULL ); + vlc_dictionary_clear (&bank->enabled_objects, NULL, NULL); - /* Destroy lock */ - vlc_mutex_destroy( &QUEUE.lock ); + vlc_rwlock_destroy (&bank->lock); + free (bank); } +struct msg_subscription_t +{ + libvlc_int_t *instance; + msg_callback_t func; + msg_cb_data_t *opaque; +}; + /** - * Subscribe to a message queue. + * Subscribe to the message queue. + * Whenever a message is emitted, a callback will be called. + * Callback invocation are serialized within a subscription. + * + * @param instance LibVLC instance to get messages from + * @param cb callback function + * @param opaque data for the callback function + * @return a subscription pointer, or NULL in case of failure */ -msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this ) +msg_subscription_t *msg_Subscribe (libvlc_int_t *instance, msg_callback_t cb, + msg_cb_data_t *opaque) { - libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc); - msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) ); - - if (p_sub == NULL) + msg_subscription_t *sub = malloc (sizeof (*sub)); + if (sub == NULL) return NULL; - vlc_mutex_lock( &QUEUE.lock ); - - TAB_APPEND( QUEUE.i_sub, QUEUE.pp_sub, p_sub ); - - p_sub->i_start = QUEUE.i_start; - p_sub->pi_stop = &QUEUE.i_stop; - p_sub->p_msg = QUEUE.msg; - p_sub->p_lock = &QUEUE.lock; + sub->instance = instance; + sub->func = cb; + sub->opaque = opaque; - vlc_mutex_unlock( &QUEUE.lock ); + msg_bank_t *bank = libvlc_bank (instance); + vlc_rwlock_wrlock (&bank->lock); + TAB_APPEND (bank->i_sub, bank->pp_sub, sub); + vlc_rwlock_unlock (&bank->lock); - return p_sub; + return sub; } /** - * Unsubscribe from a message queue. + * Unsubscribe from the message queue. + * This function waits for the message callback to return if needed. */ -void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub ) +void msg_Unsubscribe (msg_subscription_t *sub) { - libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc); + msg_bank_t *bank = libvlc_bank (sub->instance); - vlc_mutex_lock( &QUEUE.lock ); - for( int j = 0 ; j< QUEUE.i_sub ; j++ ) - { - if( QUEUE.pp_sub[j] == p_sub ) - { - REMOVE_ELEM( QUEUE.pp_sub, QUEUE.i_sub, j ); - free( p_sub ); - } - } - vlc_mutex_unlock( &QUEUE.lock ); + vlc_rwlock_wrlock (&bank->lock); + TAB_REMOVE (bank->i_sub, bank->pp_sub, sub); + vlc_rwlock_unlock (&bank->lock); + free (sub); } /***************************************************************************** - * __msg_*: print a message + * msg_*: print a message ***************************************************************************** * These functions queue a message for later printing. *****************************************************************************/ -void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module, +void msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module, const char *psz_format, ... ) { va_list args; va_start( args, psz_format ); - QueueMsg( p_this, i_type, psz_module, psz_format, args ); + msg_GenericVa (p_this, i_type, psz_module, psz_format, args); va_end( args ); } -void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module, - const char *psz_format, va_list args ) +/** + * Destroys a message. + */ +static void msg_Free (gc_object_t *gc) { - QueueMsg( p_this, i_type, psz_module, psz_format, args ); + msg_item_t *msg = vlc_priv (gc, msg_item_t); + + free (msg->psz_module); + free (msg->psz_msg); + free (msg->psz_header); + free (msg); } +#undef msg_GenericVa /** * Add a message to a queue * @@ -262,28 +284,25 @@ void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module, * is full). If the message can't be converted to string in memory, it issues * a warning. */ -static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module, - const char *psz_format, va_list _args ) +void msg_GenericVa (vlc_object_t *p_this, int i_type, + const char *psz_module, + const char *psz_format, va_list _args) { - assert (p_this); - libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc); - int i_header_size; /* Size of the additionnal header */ + size_t i_header_size; /* Size of the additionnal header */ vlc_object_t *p_obj; char * psz_str = NULL; /* formatted message string */ char * psz_header = NULL; va_list args; - msg_item_t * p_item = NULL; /* pointer to message */ - msg_item_t item; /* message in case of a full queue */ - msg_bank_t *p_queue; -#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS) - int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE; -#endif + assert (p_this); if( p_this->i_flags & OBJECT_FLAGS_QUIET || (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) ) return; + msg_bank_t *bank = libvlc_bank (p_this->p_libvlc); + locale_t locale = uselocale (bank->locale); + #ifndef __GLIBC__ /* Expand %m to strerror(errno) - only once */ char buf[strlen( psz_format ) + 2001], *ptr; @@ -341,14 +360,10 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module, #endif /* Convert message to string */ -#if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS ) vlc_va_copy( args, _args ); if( vasprintf( &psz_str, psz_format, args ) == -1 ) psz_str = NULL; va_end( args ); -#else - psz_str = (char*) malloc( i_size ); -#endif if( psz_str == NULL ) { @@ -373,8 +388,19 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module, va_end( args ); fputs( "\n", stderr ); vlc_restorecancel (canc); + uselocale (locale); return; } + uselocale (locale); + + msg_item_t * p_item = malloc (sizeof (*p_item)); + if (p_item == NULL) + return; /* Uho! */ + + vlc_gc_init (p_item, msg_Free); + p_item->psz_module = p_item->psz_msg = p_item->psz_header = NULL; + + i_header_size = 0; p_obj = p_this; @@ -387,13 +413,13 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module, if( psz_header ) { psz_old = strdup( psz_header ); - psz_header = (char*)realloc( psz_header, i_header_size ); + psz_header = xrealloc( psz_header, i_header_size ); snprintf( psz_header, i_header_size , "[%s] %s", p_obj->psz_header, psz_old ); } else { - psz_header = (char *)malloc( i_header_size ); + psz_header = xmalloc( i_header_size ); snprintf( psz_header, i_header_size, "[%s]", p_obj->psz_header ); } @@ -402,64 +428,6 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module, p_obj = p_obj->p_parent; } -#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS) - vlc_va_copy( args, _args ); - vsnprintf( psz_str, i_size, psz_format, args ); - va_end( args ); - psz_str[ i_size - 1 ] = 0; /* Just in case */ -#endif - - p_queue = &QUEUE; - vlc_mutex_lock( &p_queue->lock ); - - /* Check there is room in the queue for our message */ - if( p_queue->b_overflow ) - { - FlushMsg( p_queue ); - - if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 ) - { - /* Still in overflow mode, print from a dummy item */ - p_item = &item; - } - else - { - /* Pheeew, at last, there is room in the queue! */ - p_queue->b_overflow = false; - } - } - else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 ) - { - FlushMsg( p_queue ); - - if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 ) - { - p_queue->b_overflow = true; - - /* Put the overflow message in the queue */ - p_item = p_queue->msg + p_queue->i_stop; - p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE; - - p_item->i_type = VLC_MSG_WARN; - p_item->i_object_id = (uintptr_t)p_this; - p_item->psz_object_type = p_this->psz_object_type; - p_item->psz_module = strdup( "message" ); - p_item->psz_msg = strdup( "message queue overflowed" ); - p_item->psz_header = NULL; - - PrintMsg( p_this, p_item ); - /* We print from a dummy item */ - p_item = &item; - } - } - - if( !p_queue->b_overflow ) - { - /* Put the message in the queue */ - p_item = p_queue->msg + p_queue->i_stop; - p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE; - } - /* Fill message information fields */ p_item->i_type = i_type; p_item->i_object_id = (uintptr_t)p_this; @@ -470,59 +438,14 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module, PrintMsg( p_this, p_item ); - if( p_queue->b_overflow ) - { - free( p_item->psz_module ); - free( p_item->psz_msg ); - free( p_item->psz_header ); - } - - vlc_mutex_unlock ( &p_queue->lock ); -} - -/* following functions are local */ - -/***************************************************************************** - * FlushMsg - ***************************************************************************** - * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since - * this function does not check the lock. - *****************************************************************************/ -static void FlushMsg ( msg_bank_t *p_queue ) -{ - int i_index, i_start, i_stop; - - /* Get the maximum message index that can be freed */ - i_stop = p_queue->i_stop; - - /* Check until which value we can free messages */ - for( i_index = 0; i_index < p_queue->i_sub; i_index++ ) - { - i_start = p_queue->pp_sub[ i_index ]->i_start; - - /* If this subscriber is late, we don't free messages before - * his i_start value, otherwise he'll miss messages */ - if( ( i_start < i_stop - && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) ) - || ( i_stop < i_start - && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) ) - { - i_stop = i_start; - } - } - - /* Free message data */ - for( i_index = p_queue->i_start; - i_index != i_stop; - i_index = (i_index+1) % VLC_MSG_QSIZE ) + vlc_rwlock_rdlock (&bank->lock); + for (int i = 0; i < bank->i_sub; i++) { - free( p_queue->msg[i_index].psz_msg ); - free( p_queue->msg[i_index].psz_module ); - free( p_queue->msg[i_index].psz_header ); + msg_subscription_t *sub = bank->pp_sub[i]; + sub->func (sub->opaque, p_item, 0); } - - /* Update the new start value */ - p_queue->i_start = i_index; + vlc_rwlock_unlock (&bank->lock); + msg_Release (p_item); } /***************************************************************************** @@ -539,13 +462,11 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item ) # define WHITE COL(0) # define GRAY "\033[0m" -#ifdef UNDER_CE - int i_dummy; -#endif static const char ppsz_type[4][9] = { "", " error", " warning", " debug" }; static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY }; const char *psz_object; libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc); + msg_bank_t *bank = priv->msg_bank; int i_type = p_item->i_type; switch( i_type ) @@ -565,38 +486,25 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item ) } psz_object = p_item->psz_object_type; - void * val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects, - p_item->psz_module ); + void * val = vlc_dictionary_value_for_key (&bank->enabled_objects, + p_item->psz_module); if( val == kObjectPrintingDisabled ) return; if( val == kObjectPrintingEnabled ) /* Allowed */; else { - val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects, - psz_object ); + val = vlc_dictionary_value_for_key (&bank->enabled_objects, + psz_object); if( val == kObjectPrintingDisabled ) return; if( val == kObjectPrintingEnabled ) /* Allowed */; - else if( !priv->msg_all_objects_enabled ) + else if( !bank->all_objects_enabled ) return; } int canc = vlc_savecancel (); -#ifdef UNDER_CE -# define CE_WRITE(str) WriteFile( QUEUE.logfile, \ - str, strlen(str), &i_dummy, NULL ); - CE_WRITE( p_item->psz_module ); - CE_WRITE( " " ); - CE_WRITE( psz_object ); - CE_WRITE( ppsz_type[i_type] ); - CE_WRITE( ": " ); - CE_WRITE( p_item->psz_msg ); - CE_WRITE( "\r\n" ); - FlushFileBuffers( QUEUE.logfile ); - -#else /* Send the message to stderr */ utf8_fprintf( stderr, "[%s%p%s] %s%s%s %s%s: %s%s%s\n", priv->b_color ? GREEN : "", @@ -610,33 +518,26 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item ) p_item->psz_msg, priv->b_color ? GRAY : "" ); -# if defined(WIN32) +#ifdef WIN32 fflush( stderr ); -# endif - vlc_restorecancel (canc); #endif + vlc_restorecancel (canc); } static msg_context_t* GetContext(void) { - msg_context_t *p_ctx = vlc_threadvar_get( &msg_context ); + msg_context_t *p_ctx = vlc_threadvar_get( msg_context ); if( p_ctx == NULL ) { - MALLOC_NULL( p_ctx, msg_context_t ); + p_ctx = malloc( sizeof( msg_context_t ) ); + if( !p_ctx ) + return NULL; p_ctx->psz_message = NULL; - vlc_threadvar_set( &msg_context, p_ctx ); + vlc_threadvar_set( msg_context, p_ctx ); } return p_ctx; } -void msg_StackDestroy (void *data) -{ - msg_context_t *p_ctx = data; - - free (p_ctx->psz_message); - free (p_ctx); -} - void msg_StackSet( int i_code, const char *psz_message, ... ) { va_list ap;