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.queue
79 #define LOCK_BANK vlc_mutex_lock( &priv->msg_bank.lock );
80 #define UNLOCK_BANK vlc_mutex_unlock( &priv->msg_bank.lock );
82 /*****************************************************************************
84 *****************************************************************************/
85 static void QueueMsg ( vlc_object_t *, int, const char *,
86 const char *, va_list );
87 static void FlushMsg ( msg_queue_t * );
88 static void PrintMsg ( vlc_object_t *, msg_item_t * );
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( &priv->msg_bank.lock );
98 vlc_mutex_init( &QUEUE.lock );
99 QUEUE.b_overflow = false;
107 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
108 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
109 CREATE_ALWAYS, 0, NULL );
110 SetFilePointer( QUEUE.logfile, 0, NULL, FILE_END );
113 vlc_mutex_t *lock = var_AcquireMutex( "msg-stack" );
115 vlc_threadvar_create( &msg_context, NULL );
116 vlc_mutex_unlock( lock );
120 * Flush all message queues
122 void msg_Flush (libvlc_int_t *p_libvlc)
124 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
125 vlc_mutex_lock( &QUEUE.lock );
127 vlc_mutex_unlock( &QUEUE.lock );
131 * Destroy the message queues
133 * This functions prints all messages remaining in the queues,
134 * then frees all the allocated ressources
135 * No other messages interface functions should be called after this one.
137 void msg_Destroy (libvlc_int_t *p_libvlc)
139 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
142 msg_Err( p_libvlc, "stale interface subscribers" );
146 vlc_mutex_t *lock = var_AcquireMutex( "msg-stack" );
148 vlc_threadvar_delete( &msg_context );
149 vlc_mutex_unlock( lock );
152 CloseHandle( QUEUE.logfile );
155 vlc_mutex_destroy( &QUEUE.lock );
156 vlc_mutex_destroy( &priv->msg_bank.lock);
160 * Subscribe to a message queue.
162 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
164 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
165 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
171 vlc_mutex_lock( &QUEUE.lock );
173 TAB_APPEND( QUEUE.i_sub, QUEUE.pp_sub, p_sub );
175 p_sub->i_start = QUEUE.i_start;
176 p_sub->pi_stop = &QUEUE.i_stop;
177 p_sub->p_msg = QUEUE.msg;
178 p_sub->p_lock = &QUEUE.lock;
180 vlc_mutex_unlock( &QUEUE.lock );
187 * Unsubscribe from a message queue.
189 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
191 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
194 vlc_mutex_lock( &QUEUE.lock );
195 for( int j = 0 ; j< QUEUE.i_sub ; j++ )
197 if( QUEUE.pp_sub[j] == p_sub )
199 REMOVE_ELEM( QUEUE.pp_sub, QUEUE.i_sub, j );
203 vlc_mutex_unlock( &QUEUE.lock );
207 /*****************************************************************************
208 * __msg_*: print a message
209 *****************************************************************************
210 * These functions queue a message for later printing.
211 *****************************************************************************/
212 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
213 const char *psz_format, ... )
217 va_start( args, psz_format );
218 QueueMsg( p_this, i_type, psz_module, psz_format, args );
222 void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
223 const char *psz_format, va_list args )
225 QueueMsg( p_this, i_type, psz_module, psz_format, args );
228 /* Generic functions used when variadic macros are not available. */
229 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
230 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
233 va_start( args, psz_format ); \
234 QueueMsg( p_this, FN_TYPE, "unknown", psz_format, args ); \
239 * Output an informational message.
240 * \note Do not use this for debug messages
243 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
245 * Output an error message.
247 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
249 * Output a waring message
251 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
253 * Output a debug message
255 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
258 * Add a message to a queue
260 * This function provides basic functionnalities to other msg_* functions.
261 * It adds a message to a queue (after having printed all stored messages if it
262 * is full). If the message can't be converted to string in memory, it issues
265 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
266 const char *psz_format, va_list _args )
269 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
270 int i_header_size; /* Size of the additionnal header */
272 char * psz_str = NULL; /* formatted message string */
273 char * psz_header = NULL;
275 msg_item_t * p_item = NULL; /* pointer to message */
276 msg_item_t item; /* message in case of a full queue */
277 msg_queue_t *p_queue;
279 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
280 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
283 if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
284 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
288 /* Expand %m to strerror(errno) - only once */
289 char buf[strlen( psz_format ) + 2001], *ptr;
290 strcpy( buf, psz_format );
292 psz_format = (const char*) buf;
296 ptr = strchr( ptr, '%' );
306 strerror_r( errno, errbuf, 1001 );
308 int sockerr = WSAGetLastError( );
311 strncpy( errbuf, net_strerror( sockerr ), 1001 );
312 WSASetLastError( sockerr );
315 || (strcmp ("Unknown network stack error", errbuf) == 0))
316 strncpy( errbuf, strerror( errno ), 1001 );
320 /* Escape '%' from the error string */
321 for( char *percent = strchr( errbuf, '%' );
323 percent = strchr( percent + 2, '%' ) )
325 memmove( percent + 1, percent, strlen( percent ) + 1 );
328 errlen = strlen( errbuf );
329 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
330 memcpy( ptr, errbuf, errlen );
331 break; /* Only once, so we don't overflow */
334 /* Looks for conversion specifier... */
337 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
339 ptr++; /* ...and skip it */
343 /* Convert message to string */
344 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
345 vlc_va_copy( args, _args );
346 if( vasprintf( &psz_str, psz_format, args ) == -1 )
350 psz_str = (char*) malloc( i_size );
353 if( psz_str == NULL )
355 int canc = vlc_savecancel (); /* Do not print half of a message... */
357 fprintf( stderr, "main warning: can't store message (%m): " );
361 /* we're not using GLIBC, so we are sure that the error description
362 * will be stored in the buffer we provide to strerror_r() */
363 strerror_r( errno, psz_err, 1001 );
365 strncpy( psz_err, strerror( errno ), 1001 );
367 psz_err[1000] = '\0';
368 fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
370 vlc_va_copy( args, _args );
371 /* We should use utf8_vfprintf - but it calls malloc()... */
372 vfprintf( stderr, psz_format, args );
374 fputs( "\n", stderr );
375 vlc_restorecancel (canc);
381 while( p_obj != NULL )
383 char *psz_old = NULL;
384 if( p_obj->psz_header )
386 i_header_size += strlen( p_obj->psz_header ) + 4;
389 psz_old = strdup( psz_header );
390 psz_header = (char*)realloc( psz_header, i_header_size );
391 snprintf( psz_header, i_header_size , "[%s] %s",
392 p_obj->psz_header, psz_old );
396 psz_header = (char *)malloc( i_header_size );
397 snprintf( psz_header, i_header_size, "[%s]",
402 p_obj = p_obj->p_parent;
405 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
406 vlc_va_copy( args, _args );
407 vsnprintf( psz_str, i_size, psz_format, args );
409 psz_str[ i_size - 1 ] = 0; /* Just in case */
414 vlc_mutex_lock( &p_queue->lock );
416 /* Check there is room in the queue for our message */
417 if( p_queue->b_overflow )
421 if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 )
423 /* Still in overflow mode, print from a dummy item */
428 /* Pheeew, at last, there is room in the queue! */
429 p_queue->b_overflow = false;
432 else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
436 if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
438 p_queue->b_overflow = true;
440 /* Put the overflow message in the queue */
441 p_item = p_queue->msg + p_queue->i_stop;
442 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
444 p_item->i_type = VLC_MSG_WARN;
445 p_item->i_object_id = p_this->i_object_id;
446 p_item->psz_object_type = p_this->psz_object_type;
447 p_item->psz_module = strdup( "message" );
448 p_item->psz_msg = strdup( "message queue overflowed" );
449 p_item->psz_header = NULL;
451 PrintMsg( p_this, p_item );
452 /* We print from a dummy item */
457 if( !p_queue->b_overflow )
459 /* Put the message in the queue */
460 p_item = p_queue->msg + p_queue->i_stop;
461 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
464 /* Fill message information fields */
465 p_item->i_type = i_type;
466 p_item->i_object_id = p_this->i_object_id;
467 p_item->psz_object_type = p_this->psz_object_type;
468 p_item->psz_module = strdup( psz_module );
469 p_item->psz_msg = psz_str;
470 p_item->psz_header = psz_header;
472 PrintMsg( p_this, p_item );
474 if( p_queue->b_overflow )
476 free( p_item->psz_module );
477 free( p_item->psz_msg );
478 free( p_item->psz_header );
481 vlc_mutex_unlock ( &p_queue->lock );
485 /* following functions are local */
487 /*****************************************************************************
489 *****************************************************************************
490 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
491 * this function does not check the lock.
492 *****************************************************************************/
493 static void FlushMsg ( msg_queue_t *p_queue )
495 int i_index, i_start, i_stop;
497 /* Get the maximum message index that can be freed */
498 i_stop = p_queue->i_stop;
500 /* Check until which value we can free messages */
501 for( i_index = 0; i_index < p_queue->i_sub; i_index++ )
503 i_start = p_queue->pp_sub[ i_index ]->i_start;
505 /* If this subscriber is late, we don't free messages before
506 * his i_start value, otherwise he'll miss messages */
507 if( ( i_start < i_stop
508 && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) )
509 || ( i_stop < i_start
510 && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) )
516 /* Free message data */
517 for( i_index = p_queue->i_start;
519 i_index = (i_index+1) % VLC_MSG_QSIZE )
521 free( p_queue->msg[i_index].psz_msg );
522 free( p_queue->msg[i_index].psz_module );
523 free( p_queue->msg[i_index].psz_header );
526 /* Update the new start value */
527 p_queue->i_start = i_index;
530 /*****************************************************************************
531 * PrintMsg: output a standard message item to stderr
532 *****************************************************************************
533 * Print a message to stderr, with colour formatting if needed.
534 *****************************************************************************/
535 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
537 # define COL(x) "\033[" #x ";1m"
539 # define GREEN COL(32)
540 # define YELLOW COL(33)
541 # define WHITE COL(0)
542 # define GRAY "\033[0m"
547 static const char ppsz_type[4][9] = { "", " error", " warning", " debug" };
548 static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY };
549 const char *psz_object;
550 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
551 int i_type = p_item->i_type;
556 if( priv->i_verbose < 0 ) return;
559 if( priv->i_verbose < 0 ) return;
562 if( priv->i_verbose < 1 ) return;
565 if( priv->i_verbose < 2 ) return;
569 psz_object = p_item->psz_object_type;
571 int canc = vlc_savecancel ();
573 # define CE_WRITE(str) WriteFile( QUEUE.logfile, \
574 str, strlen(str), &i_dummy, NULL );
575 CE_WRITE( p_item->psz_module );
577 CE_WRITE( psz_object );
578 CE_WRITE( ppsz_type[i_type] );
580 CE_WRITE( p_item->psz_msg );
582 FlushFileBuffers( QUEUE.logfile );
585 /* Send the message to stderr */
588 if( p_item->psz_header )
590 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s %s%s: %s%s" GRAY
592 p_item->i_object_id, p_item->psz_header,
593 p_item->psz_module, psz_object,
594 ppsz_type[i_type], ppsz_color[i_type],
599 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
600 p_item->i_object_id, p_item->psz_module, psz_object,
601 ppsz_type[i_type], ppsz_color[i_type],
607 if( p_item->psz_header )
609 utf8_fprintf( stderr, "[%.8i] %s %s %s%s: %s\n", p_item->i_object_id,
610 p_item->psz_header, p_item->psz_module,
611 psz_object, ppsz_type[i_type], p_item->psz_msg );
615 utf8_fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
616 p_item->psz_module, psz_object, ppsz_type[i_type],
624 vlc_restorecancel (canc);
628 static msg_context_t* GetContext(void)
630 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context );
633 MALLOC_NULL( p_ctx, msg_context_t );
634 p_ctx->psz_message = NULL;
635 vlc_threadvar_set( &msg_context, p_ctx );
640 void msg_StackDestroy (void *data)
642 msg_context_t *p_ctx = data;
644 free (p_ctx->psz_message);
648 void msg_StackSet( int i_code, const char *psz_message, ... )
651 msg_context_t *p_ctx = GetContext();
655 free( p_ctx->psz_message );
657 va_start( ap, psz_message );
658 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
659 p_ctx->psz_message = NULL;
662 p_ctx->i_code = i_code;
665 void msg_StackAdd( const char *psz_message, ... )
669 msg_context_t *p_ctx = GetContext();
674 va_start( ap, psz_message );
675 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
679 if( !p_ctx->psz_message )
680 p_ctx->psz_message = psz_tmp;
684 if( asprintf( &psz_new, "%s: %s", psz_tmp, p_ctx->psz_message ) == -1 )
687 free( p_ctx->psz_message );
688 p_ctx->psz_message = psz_new;
693 const char* msg_StackMsg( void )
695 msg_context_t *p_ctx = GetContext();
697 return p_ctx->psz_message;