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 *****************************************************************************/
33 #include <stdarg.h> /* va_list for BSD */
36 # include <fcntl.h> /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
39 #include <errno.h> /* errno */
42 # include <unistd.h> /* close(), write() */
47 #include <vlc_charset.h>
49 /*****************************************************************************
51 *****************************************************************************/
52 #if defined(HAVE_VA_COPY)
53 # define vlc_va_copy(dest,src) va_copy(dest,src)
54 #elif defined(HAVE___VA_COPY)
55 # define vlc_va_copy(dest,src) __va_copy(dest,src)
57 # define vlc_va_copy(dest,src) (dest)=(src)
60 #define QUEUE(i) p_this->p_libvlc->msg_bank.queues[i]
61 #define LOCK_BANK vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
62 #define UNLOCK_BANK vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
64 /*****************************************************************************
66 *****************************************************************************/
67 static void QueueMsg ( vlc_object_t *, int, int , const char *,
68 const char *, va_list );
69 static void FlushMsg ( msg_queue_t * );
70 static void PrintMsg ( vlc_object_t *, msg_item_t * );
73 * Initialize messages queues
74 * This function initializes all message queues
76 void __msg_Create( vlc_object_t *p_this )
79 vlc_mutex_init( p_this, &(p_this->p_libvlc->msg_bank.lock) );
81 for( i = 0; i < 2; i++ )
83 vlc_mutex_init( p_this, &QUEUE(i).lock );
84 QUEUE(i).b_overflow = VLC_FALSE;
93 QUEUE(MSG_QUEUE_NORMAL).logfile =
94 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
95 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
96 CREATE_ALWAYS, 0, NULL );
97 SetFilePointer( QUEUE(MSG_QUEUE_NORMAL).logfile, 0, NULL, FILE_END );
102 * Flush all message queues
104 void __msg_Flush( vlc_object_t *p_this )
107 for( i = 0 ; i < NB_QUEUES ; i++ )
109 vlc_mutex_lock( &QUEUE(i).lock );
110 FlushMsg( &QUEUE(i) );
111 vlc_mutex_unlock( &QUEUE(i).lock );
116 * Destroy the message queues
118 * This functions prints all messages remaining in the queues,
119 * then frees all the allocated ressources
120 * No other messages interface functions should be called after this one.
122 void __msg_Destroy( vlc_object_t *p_this )
125 for( i = NB_QUEUES -1 ; i >= 0; i-- )
128 msg_Err( p_this, "stale interface subscribers" );
130 FlushMsg( &QUEUE(i) );
133 if( i == MSG_QUEUE_NORMAL )
134 CloseHandle( QUEUE(MSG_QUEUE_NORMAL).logfile );
137 vlc_mutex_destroy( &QUEUE(i).lock );
139 vlc_mutex_destroy( &(p_this->p_libvlc->msg_bank.lock) );
143 * Subscribe to a message queue.
145 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this, int i )
147 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
149 assert( i < NB_QUEUES );
152 vlc_mutex_lock( &QUEUE(i).lock );
154 TAB_APPEND( QUEUE(i).i_sub, QUEUE(i).pp_sub, p_sub );
156 p_sub->i_start = QUEUE(i).i_start;
157 p_sub->pi_stop = &QUEUE(i).i_stop;
158 p_sub->p_msg = QUEUE(i).msg;
159 p_sub->p_lock = &QUEUE(i).lock;
161 vlc_mutex_unlock( &QUEUE(i).lock );
168 * Unsubscribe from a message queue.
170 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
175 for( i = 0 ; i< NB_QUEUES ; i++ )
177 vlc_mutex_lock( &QUEUE(i).lock );
178 for( j = 0 ; j< QUEUE(i).i_sub ; j++ )
180 if( QUEUE(i).pp_sub[j] == p_sub )
182 REMOVE_ELEM( QUEUE(i).pp_sub, QUEUE(i).i_sub, j );
183 if( p_sub ) free( p_sub );
186 vlc_mutex_unlock( & QUEUE(i).lock );
191 const char *msg_GetObjectTypeName(int i_object_type )
193 switch( i_object_type )
195 case VLC_OBJECT_GLOBAL: return "global";
196 case VLC_OBJECT_LIBVLC: return "libvlc";
197 case VLC_OBJECT_MODULE: return "module";
198 case VLC_OBJECT_INTF: return "interface";
199 case VLC_OBJECT_PLAYLIST: return "playlist";
200 case VLC_OBJECT_ITEM: return "item";
201 case VLC_OBJECT_INPUT: return "input";
202 case VLC_OBJECT_DECODER: return "decoder";
203 case VLC_OBJECT_PACKETIZER: return "packetizer";
204 case VLC_OBJECT_ENCODER: return "encoder";
205 case VLC_OBJECT_VOUT: return "video output";
206 case VLC_OBJECT_AOUT: return "audio output";
207 case VLC_OBJECT_SOUT: return "stream output";
208 case VLC_OBJECT_HTTPD: return "http server";
209 case VLC_OBJECT_HTTPD_HOST: return "http server";
210 case VLC_OBJECT_DIALOGS: return "dialogs provider";
211 case VLC_OBJECT_VLM: return "vlm";
212 case VLC_OBJECT_ANNOUNCE: return "announce handler";
213 case VLC_OBJECT_DEMUX: return "demuxer";
214 case VLC_OBJECT_ACCESS: return "access";
215 case VLC_OBJECT_META_ENGINE: return "meta engine";
216 default: return "private";
220 /*****************************************************************************
221 * __msg_*: print a message
222 *****************************************************************************
223 * These functions queue a message for later printing.
224 *****************************************************************************/
225 void __msg_Generic( vlc_object_t *p_this, int i_queue, int i_type,
226 const char *psz_module,
227 const char *psz_format, ... )
231 va_start( args, psz_format );
232 QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
236 void __msg_GenericVa( vlc_object_t *p_this, int i_queue,
237 int i_type, const char *psz_module,
238 const char *psz_format, va_list args )
240 QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
243 /* Generic functions used when variadic macros are not available. */
244 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
245 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
248 va_start( args, psz_format ); \
249 QueueMsg( (vlc_object_t *)p_this,MSG_QUEUE_NORMAL, FN_TYPE, "unknown", \
250 psz_format, args ); \
255 * Output an informational message.
256 * \note Do not use this for debug messages
259 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
261 * Output an error message.
263 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
265 * Output a waring message
267 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
269 * Output a debug message
271 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
274 * Add a message to a queue
276 * This function provides basic functionnalities to other msg_* functions.
277 * It adds a message to a queue (after having printed all stored messages if it
278 * is full). If the message can't be converted to string in memory, it issues
281 static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
282 const char *psz_module,
283 const char *psz_format, va_list _args )
285 int i_header_size; /* Size of the additionnal header */
287 char * psz_str = NULL; /* formatted message string */
288 char * psz_header = NULL;
290 msg_item_t * p_item = NULL; /* pointer to message */
291 msg_item_t item; /* message in case of a full queue */
292 msg_queue_t *p_queue;
294 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
295 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
298 if( p_this == NULL || p_this->i_flags & OBJECT_FLAGS_QUIET ||
299 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
305 /* Expand %m to strerror(errno) - only once */
306 char buf[strlen( psz_format ) + 2001], *ptr;
307 strcpy( buf, psz_format );
308 ptr = psz_format = buf;
312 ptr = strchr( ptr, '%' );
322 strerror_r( errno, errbuf, 1001 );
324 int sockerr = WSAGetLastError( );
327 strncpy( errbuf, net_strerror( sockerr ), 1001 );
328 WSASetLastError( sockerr );
331 strncpy( errbuf, strerror( errno ), 1001 );
335 /* Escape '%' from the error string */
336 for( char *percent = strchr( errbuf, '%' );
338 percent = strchr( percent + 2, '%' ) )
340 memmove( percent + 1, percent, strlen( percent ) + 1 );
343 errlen = strlen( errbuf );
344 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
345 memcpy( ptr, errbuf, errlen );
346 break; /* Only once, so we don't overflow */
349 /* Looks for conversion specifier... */
352 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
354 ptr++; /* ...and skip it */
358 /* Convert message to string */
359 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
360 vlc_va_copy( args, _args );
361 if( vasprintf( &psz_str, psz_format, args ) == -1 )
365 psz_str = (char*) malloc( i_size );
368 if( psz_str == NULL )
370 fputs( "main warning: no memory to store message): ", stderr );
371 vlc_va_copy( args, _args );
372 /* We should use utf8_vfprintf - but it calls malloc()... */
373 vfprintf( stderr, psz_format, args );
375 fputs( "\n", stderr );
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]",
401 if( psz_old ) free( psz_old );
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 */
412 assert( i_queue < NB_QUEUES );
414 p_queue = &QUEUE(i_queue) ;
415 vlc_mutex_lock( &p_queue->lock );
417 /* Check there is room in the queue for our message */
418 if( p_queue->b_overflow )
422 if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 )
424 /* Still in overflow mode, print from a dummy item */
429 /* Pheeew, at last, there is room in the queue! */
430 p_queue->b_overflow = VLC_FALSE;
433 else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
437 if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
439 p_queue->b_overflow = VLC_TRUE;
441 if( p_queue->i_id == MSG_QUEUE_NORMAL )
443 /* Put the overflow message in the queue */
444 p_item = p_queue->msg + p_queue->i_stop;
445 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
447 p_item->i_type = VLC_MSG_WARN;
448 p_item->i_object_id = p_this->i_object_id;
449 p_item->i_object_type = p_this->i_object_type;
450 p_item->psz_module = strdup( "message" );
451 p_item->psz_msg = strdup( "message queue overflowed" );
452 p_item->psz_header = NULL;
454 PrintMsg( p_this, p_item );
455 /* We print from a dummy item */
461 if( !p_queue->b_overflow )
463 /* Put the message in the queue */
464 p_item = p_queue->msg + p_queue->i_stop;
465 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
468 /* Fill message information fields */
469 p_item->i_type = i_type;
470 p_item->i_object_id = p_this->i_object_id;
471 p_item->i_object_type = p_this->i_object_type;
472 p_item->psz_module = strdup( psz_module );
473 p_item->psz_msg = psz_str;
474 p_item->psz_header = psz_header;
476 if( p_queue->i_id == MSG_QUEUE_NORMAL )
477 PrintMsg( p_this, p_item );
479 if( p_queue->b_overflow )
481 if( p_item->psz_module )
482 free( p_item->psz_module );
483 if( p_item->psz_msg )
484 free( p_item->psz_msg );
485 if( p_item->psz_header )
486 free( p_item->psz_header );
489 vlc_mutex_unlock ( &p_queue->lock );
493 /* following functions are local */
495 /*****************************************************************************
497 *****************************************************************************
498 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
499 * this function does not check the lock.
500 *****************************************************************************/
501 static void FlushMsg ( msg_queue_t *p_queue )
503 int i_index, i_start, i_stop;
505 /* Get the maximum message index that can be freed */
506 i_stop = p_queue->i_stop;
508 /* Check until which value we can free messages */
509 for( i_index = 0; i_index < p_queue->i_sub; i_index++ )
511 i_start = p_queue->pp_sub[ i_index ]->i_start;
513 /* If this subscriber is late, we don't free messages before
514 * his i_start value, otherwise he'll miss messages */
515 if( ( i_start < i_stop
516 && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) )
517 || ( i_stop < i_start
518 && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) )
524 /* Free message data */
525 for( i_index = p_queue->i_start;
527 i_index = (i_index+1) % VLC_MSG_QSIZE )
529 if( p_queue->msg[i_index].psz_msg )
530 free( p_queue->msg[i_index].psz_msg );
531 if( p_queue->msg[i_index].psz_module )
532 free( p_queue->msg[i_index].psz_module );
533 if( p_queue->msg[i_index].psz_header )
534 free( p_queue->msg[i_index].psz_header );
537 /* Update the new start value */
538 p_queue->i_start = i_index;
541 /*****************************************************************************
542 * PrintMsg: output a standard message item to stderr
543 *****************************************************************************
544 * Print a message to stderr, with colour formatting if needed.
545 *****************************************************************************/
546 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
548 # define COL(x) "\033[" #x ";1m"
550 # define GREEN COL(32)
551 # define YELLOW COL(33)
552 # define WHITE COL(37)
553 # define GRAY "\033[0m"
558 static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
559 static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
560 const char *psz_object;
561 int i_type = p_item->i_type;
566 if( p_this->p_libvlc->i_verbose < 0 ) return;
569 if( p_this->p_libvlc->i_verbose < 0 ) return;
572 if( p_this->p_libvlc->i_verbose < 1 ) return;
575 if( p_this->p_libvlc->i_verbose < 2 ) return;
579 psz_object = msg_GetObjectTypeName(p_item->i_object_type);
582 # define CE_WRITE(str) WriteFile( QUEUE(MSG_QUEUE_NORMAL).logfile, \
583 str, strlen(str), &i_dummy, NULL );
584 CE_WRITE( p_item->psz_module );
586 CE_WRITE( psz_object );
587 CE_WRITE( ppsz_type[i_type] );
589 CE_WRITE( p_item->psz_msg );
591 FlushFileBuffers( QUEUE(MSG_QUEUE_NORMAL).logfile );
594 /* Send the message to stderr */
595 if( p_this->p_libvlc->b_color )
597 if( p_item->psz_header )
599 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s %s%s: %s%s" GRAY
601 p_item->i_object_id, p_item->psz_header,
602 p_item->psz_module, psz_object,
603 ppsz_type[i_type], ppsz_color[i_type],
608 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
609 p_item->i_object_id, p_item->psz_module, psz_object,
610 ppsz_type[i_type], ppsz_color[i_type],
616 if( p_item->psz_header )
618 utf8_fprintf( stderr, "[%.8i] %s %s %s%s: %s\n", p_item->i_object_id,
619 p_item->psz_header, p_item->psz_module,
620 psz_object, ppsz_type[i_type], p_item->psz_msg );
624 utf8_fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
625 p_item->psz_module, psz_object, ppsz_type[i_type],
636 static msg_context_t* GetContext(void)
638 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context_global_key );
641 MALLOC_NULL( p_ctx, msg_context_t );
642 p_ctx->psz_message = NULL;
643 vlc_threadvar_set( &msg_context_global_key, p_ctx );
648 void msg_StackSet( int i_code, const char *psz_message, ... )
651 msg_context_t *p_ctx = GetContext();
654 va_start( ap, psz_message );
655 free( p_ctx->psz_message );
657 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
658 p_ctx->psz_message = NULL;
661 p_ctx->i_code = i_code;
664 void msg_StackAdd( const char *psz_message, ... )
668 msg_context_t *p_ctx = GetContext();
671 va_start( ap, psz_message );
672 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
676 if( !p_ctx->psz_message )
677 p_ctx->psz_message = psz_tmp;
680 char *psz_old = malloc( strlen( p_ctx->psz_message ) + 1 );
681 memcpy( psz_old, p_ctx->psz_message, strlen( p_ctx->psz_message ) + 1 );
682 p_ctx->psz_message = realloc( p_ctx->psz_message,
683 strlen( p_ctx->psz_message ) +
685 strlen( psz_tmp ) + 3 );
686 sprintf( p_ctx->psz_message, "%s: %s", psz_tmp, psz_old );
687 free( psz_tmp ); free( psz_old );
691 const char* msg_StackMsg( void )
693 msg_context_t *p_ctx = GetContext();
695 return p_ctx->psz_message;