1 /*****************************************************************************
2 * messages.c: messages interface
3 * This library provides an interface to the message queue to be used by other
4 * modules, especially intf modules. See vlc_config.h for output configuration.
5 *****************************************************************************
6 * Copyright (C) 1998-2005 the VideoLAN team
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 * Samuel Hocevar <sam@zoy.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
35 #include <vlc_common.h>
37 #include <stdarg.h> /* va_list for BSD */
40 # include <fcntl.h> /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
43 #include <errno.h> /* errno */
46 # include <vlc_network.h> /* 'net_strerror' and 'WSAGetLastError' */
50 # include <unistd.h> /* close(), write() */
55 #include <vlc_charset.h>
56 #include "../libvlc.h"
64 static vlc_threadvar_t msg_context;
65 static uintptr_t banks = 0;
67 /*****************************************************************************
69 *****************************************************************************/
70 #if defined(HAVE_VA_COPY)
71 # define vlc_va_copy(dest,src) va_copy(dest,src)
72 #elif defined(HAVE___VA_COPY)
73 # define vlc_va_copy(dest,src) __va_copy(dest,src)
75 # define vlc_va_copy(dest,src) (dest)=(src)
78 #define QUEUE priv->msg_bank
80 /*****************************************************************************
82 *****************************************************************************/
83 static void QueueMsg ( vlc_object_t *, int, const char *,
84 const char *, va_list );
85 static void FlushMsg ( msg_bank_t * );
86 static void PrintMsg ( vlc_object_t *, msg_item_t * );
88 static vlc_mutex_t msg_stack_lock = VLC_STATIC_MUTEX;
91 * Initialize messages queues
92 * This function initializes all message queues
94 void msg_Create (libvlc_int_t *p_libvlc)
96 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
97 vlc_mutex_init( &QUEUE.lock );
98 vlc_dictionary_init( &priv->msg_enabled_objects, 0 );
99 priv->msg_all_objects_enabled = true;
101 QUEUE.b_overflow = false;
109 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
110 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
111 CREATE_ALWAYS, 0, NULL );
112 SetFilePointer( QUEUE.logfile, 0, NULL, FILE_END );
115 vlc_mutex_lock( &msg_stack_lock );
117 vlc_threadvar_create( &msg_context, NULL );
118 vlc_mutex_unlock( &msg_stack_lock );
122 * Flush all message queues
124 void msg_Flush (libvlc_int_t *p_libvlc)
126 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
127 vlc_mutex_lock( &QUEUE.lock );
129 vlc_mutex_unlock( &QUEUE.lock );
134 * Object Printing selection
136 static void const * kObjectPrintingEnabled = (void *) 1;
137 static void const * kObjectPrintingDisabled = (void *) -1;
139 void __msg_EnableObjectPrinting (vlc_object_t *p_this, char * psz_object)
141 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
142 vlc_mutex_lock( &QUEUE.lock );
143 if( !strcmp(psz_object, "all") )
144 priv->msg_all_objects_enabled = true;
146 vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingEnabled );
147 vlc_mutex_unlock( &QUEUE.lock );
150 void __msg_DisableObjectPrinting (vlc_object_t *p_this, char * psz_object)
152 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
153 vlc_mutex_lock( &QUEUE.lock );
154 if( !strcmp(psz_object, "all") )
155 priv->msg_all_objects_enabled = false;
157 vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingDisabled );
158 vlc_mutex_unlock( &QUEUE.lock );
162 * Destroy the message queues
164 * This functions prints all messages remaining in the queues,
165 * then frees all the allocated ressources
166 * No other messages interface functions should be called after this one.
168 void msg_Destroy (libvlc_int_t *p_libvlc)
170 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
173 msg_Err( p_libvlc, "stale interface subscribers" );
177 vlc_mutex_lock( &msg_stack_lock );
179 vlc_threadvar_delete( &msg_context );
180 vlc_mutex_unlock( &msg_stack_lock );
183 CloseHandle( QUEUE.logfile );
186 vlc_dictionary_clear( &priv->msg_enabled_objects, NULL, NULL );
189 vlc_mutex_destroy( &QUEUE.lock );
193 * Subscribe to a message queue.
195 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
197 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
198 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
203 vlc_mutex_lock( &QUEUE.lock );
205 TAB_APPEND( QUEUE.i_sub, QUEUE.pp_sub, p_sub );
207 p_sub->i_start = QUEUE.i_start;
208 p_sub->pi_stop = &QUEUE.i_stop;
209 p_sub->p_msg = QUEUE.msg;
210 p_sub->p_lock = &QUEUE.lock;
212 vlc_mutex_unlock( &QUEUE.lock );
218 * Unsubscribe from a message queue.
220 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
222 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
224 vlc_mutex_lock( &QUEUE.lock );
225 for( int j = 0 ; j< QUEUE.i_sub ; j++ )
227 if( QUEUE.pp_sub[j] == p_sub )
229 REMOVE_ELEM( QUEUE.pp_sub, QUEUE.i_sub, j );
233 vlc_mutex_unlock( &QUEUE.lock );
236 /*****************************************************************************
237 * __msg_*: print a message
238 *****************************************************************************
239 * These functions queue a message for later printing.
240 *****************************************************************************/
241 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
242 const char *psz_format, ... )
246 va_start( args, psz_format );
247 QueueMsg( p_this, i_type, psz_module, psz_format, args );
251 void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
252 const char *psz_format, va_list args )
254 QueueMsg( p_this, i_type, psz_module, psz_format, args );
257 /* Generic functions used when variadic macros are not available. */
258 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
259 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
262 va_start( args, psz_format ); \
263 QueueMsg( p_this, FN_TYPE, "unknown", psz_format, args ); \
268 * Output an informational message.
269 * \note Do not use this for debug messages
272 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
274 * Output an error message.
276 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
278 * Output a waring message
280 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
282 * Output a debug message
284 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
287 * Add a message to a queue
289 * This function provides basic functionnalities to other msg_* functions.
290 * It adds a message to a queue (after having printed all stored messages if it
291 * is full). If the message can't be converted to string in memory, it issues
294 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
295 const char *psz_format, va_list _args )
298 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
299 int i_header_size; /* Size of the additionnal header */
301 char * psz_str = NULL; /* formatted message string */
302 char * psz_header = NULL;
304 msg_item_t * p_item = NULL; /* pointer to message */
305 msg_item_t item; /* message in case of a full queue */
308 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
309 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
312 if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
313 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
317 /* Expand %m to strerror(errno) - only once */
318 char buf[strlen( psz_format ) + 2001], *ptr;
319 strcpy( buf, psz_format );
321 psz_format = (const char*) buf;
325 ptr = strchr( ptr, '%' );
335 strerror_r( errno, errbuf, 1001 );
337 int sockerr = WSAGetLastError( );
340 strncpy( errbuf, net_strerror( sockerr ), 1001 );
341 WSASetLastError( sockerr );
344 || (strcmp ("Unknown network stack error", errbuf) == 0))
345 strncpy( errbuf, strerror( errno ), 1001 );
349 /* Escape '%' from the error string */
350 for( char *percent = strchr( errbuf, '%' );
352 percent = strchr( percent + 2, '%' ) )
354 memmove( percent + 1, percent, strlen( percent ) + 1 );
357 errlen = strlen( errbuf );
358 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
359 memcpy( ptr, errbuf, errlen );
360 break; /* Only once, so we don't overflow */
363 /* Looks for conversion specifier... */
366 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
368 ptr++; /* ...and skip it */
372 /* Convert message to string */
373 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
374 vlc_va_copy( args, _args );
375 if( vasprintf( &psz_str, psz_format, args ) == -1 )
379 psz_str = (char*) malloc( i_size );
382 if( psz_str == NULL )
384 int canc = vlc_savecancel (); /* Do not print half of a message... */
386 fprintf( stderr, "main warning: can't store message (%m): " );
390 /* we're not using GLIBC, so we are sure that the error description
391 * will be stored in the buffer we provide to strerror_r() */
392 strerror_r( errno, psz_err, 1001 );
394 strncpy( psz_err, strerror( errno ), 1001 );
396 psz_err[1000] = '\0';
397 fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
399 vlc_va_copy( args, _args );
400 /* We should use utf8_vfprintf - but it calls malloc()... */
401 vfprintf( stderr, psz_format, args );
403 fputs( "\n", stderr );
404 vlc_restorecancel (canc);
410 while( p_obj != NULL )
412 char *psz_old = NULL;
413 if( p_obj->psz_header )
415 i_header_size += strlen( p_obj->psz_header ) + 4;
418 psz_old = strdup( psz_header );
419 psz_header = (char*)realloc( psz_header, i_header_size );
420 snprintf( psz_header, i_header_size , "[%s] %s",
421 p_obj->psz_header, psz_old );
425 psz_header = (char *)malloc( i_header_size );
426 snprintf( psz_header, i_header_size, "[%s]",
431 p_obj = p_obj->p_parent;
434 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
435 vlc_va_copy( args, _args );
436 vsnprintf( psz_str, i_size, psz_format, args );
438 psz_str[ i_size - 1 ] = 0; /* Just in case */
442 vlc_mutex_lock( &p_queue->lock );
444 /* Check there is room in the queue for our message */
445 if( p_queue->b_overflow )
449 if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 )
451 /* Still in overflow mode, print from a dummy item */
456 /* Pheeew, at last, there is room in the queue! */
457 p_queue->b_overflow = false;
460 else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
464 if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
466 p_queue->b_overflow = true;
468 /* Put the overflow message in the queue */
469 p_item = p_queue->msg + p_queue->i_stop;
470 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
472 p_item->i_type = VLC_MSG_WARN;
473 p_item->i_object_id = (uintptr_t)p_this;
474 p_item->psz_object_type = p_this->psz_object_type;
475 p_item->psz_module = strdup( "message" );
476 p_item->psz_msg = strdup( "message queue overflowed" );
477 p_item->psz_header = NULL;
479 PrintMsg( p_this, p_item );
480 /* We print from a dummy item */
485 if( !p_queue->b_overflow )
487 /* Put the message in the queue */
488 p_item = p_queue->msg + p_queue->i_stop;
489 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
492 /* Fill message information fields */
493 p_item->i_type = i_type;
494 p_item->i_object_id = (uintptr_t)p_this;
495 p_item->psz_object_type = p_this->psz_object_type;
496 p_item->psz_module = strdup( psz_module );
497 p_item->psz_msg = psz_str;
498 p_item->psz_header = psz_header;
500 PrintMsg( p_this, p_item );
502 if( p_queue->b_overflow )
504 free( p_item->psz_module );
505 free( p_item->psz_msg );
506 free( p_item->psz_header );
509 vlc_mutex_unlock ( &p_queue->lock );
512 /* following functions are local */
514 /*****************************************************************************
516 *****************************************************************************
517 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
518 * this function does not check the lock.
519 *****************************************************************************/
520 static void FlushMsg ( msg_bank_t *p_queue )
522 int i_index, i_start, i_stop;
524 /* Get the maximum message index that can be freed */
525 i_stop = p_queue->i_stop;
527 /* Check until which value we can free messages */
528 for( i_index = 0; i_index < p_queue->i_sub; i_index++ )
530 i_start = p_queue->pp_sub[ i_index ]->i_start;
532 /* If this subscriber is late, we don't free messages before
533 * his i_start value, otherwise he'll miss messages */
534 if( ( i_start < i_stop
535 && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) )
536 || ( i_stop < i_start
537 && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) )
543 /* Free message data */
544 for( i_index = p_queue->i_start;
546 i_index = (i_index+1) % VLC_MSG_QSIZE )
548 free( p_queue->msg[i_index].psz_msg );
549 free( p_queue->msg[i_index].psz_module );
550 free( p_queue->msg[i_index].psz_header );
553 /* Update the new start value */
554 p_queue->i_start = i_index;
557 /*****************************************************************************
558 * PrintMsg: output a standard message item to stderr
559 *****************************************************************************
560 * Print a message to stderr, with colour formatting if needed.
561 *****************************************************************************/
562 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
564 # define COL(x) "\033[" #x ";1m"
566 # define GREEN COL(32)
567 # define YELLOW COL(33)
568 # define WHITE COL(0)
569 # define GRAY "\033[0m"
574 static const char ppsz_type[4][9] = { "", " error", " warning", " debug" };
575 static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY };
576 const char *psz_object;
577 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
578 int i_type = p_item->i_type;
583 if( priv->i_verbose < 0 ) return;
586 if( priv->i_verbose < 0 ) return;
589 if( priv->i_verbose < 1 ) return;
592 if( priv->i_verbose < 2 ) return;
596 psz_object = p_item->psz_object_type;
597 void * val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
598 p_item->psz_module );
599 if( val == kObjectPrintingDisabled )
601 if( val == kObjectPrintingEnabled )
605 val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
607 if( val == kObjectPrintingDisabled )
609 if( val == kObjectPrintingEnabled )
611 else if( !priv->msg_all_objects_enabled )
615 int canc = vlc_savecancel ();
617 # define CE_WRITE(str) WriteFile( QUEUE.logfile, \
618 str, strlen(str), &i_dummy, NULL );
619 CE_WRITE( p_item->psz_module );
621 CE_WRITE( psz_object );
622 CE_WRITE( ppsz_type[i_type] );
624 CE_WRITE( p_item->psz_msg );
626 FlushFileBuffers( QUEUE.logfile );
629 /* Send the message to stderr */
630 utf8_fprintf( stderr, "[%s%p%s] %s%s%s %s%s: %s%s%s\n",
631 priv->b_color ? GREEN : "",
632 (void *)p_item->i_object_id,
633 priv->b_color ? GRAY : "",
634 p_item->psz_header ? p_item->psz_header : "",
635 p_item->psz_header ? " " : "",
636 p_item->psz_module, psz_object,
638 priv->b_color ? ppsz_color[i_type] : "",
640 priv->b_color ? GRAY : "" );
645 vlc_restorecancel (canc);
649 static msg_context_t* GetContext(void)
651 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context );
654 MALLOC_NULL( p_ctx, msg_context_t );
655 p_ctx->psz_message = NULL;
656 vlc_threadvar_set( &msg_context, p_ctx );
661 void msg_StackDestroy (void *data)
663 msg_context_t *p_ctx = data;
665 free (p_ctx->psz_message);
669 void msg_StackSet( int i_code, const char *psz_message, ... )
672 msg_context_t *p_ctx = GetContext();
676 free( p_ctx->psz_message );
678 va_start( ap, psz_message );
679 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
680 p_ctx->psz_message = NULL;
683 p_ctx->i_code = i_code;
686 void msg_StackAdd( const char *psz_message, ... )
690 msg_context_t *p_ctx = GetContext();
695 va_start( ap, psz_message );
696 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
700 if( !p_ctx->psz_message )
701 p_ctx->psz_message = psz_tmp;
705 if( asprintf( &psz_new, "%s: %s", psz_tmp, p_ctx->psz_message ) == -1 )
708 free( p_ctx->psz_message );
709 p_ctx->psz_message = psz_new;
714 const char* msg_StackMsg( void )
716 msg_context_t *p_ctx = GetContext();
718 return p_ctx->psz_message;