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 *****************************************************************************/
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 <unistd.h> /* close(), write() */
51 #include <vlc_charset.h>
53 /*****************************************************************************
55 *****************************************************************************/
56 #if defined(HAVE_VA_COPY)
57 # define vlc_va_copy(dest,src) va_copy(dest,src)
58 #elif defined(HAVE___VA_COPY)
59 # define vlc_va_copy(dest,src) __va_copy(dest,src)
61 # define vlc_va_copy(dest,src) (dest)=(src)
64 #define QUEUE(i) p_this->p_libvlc->msg_bank.queues[i]
65 #define LOCK_BANK vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
66 #define UNLOCK_BANK vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
68 /*****************************************************************************
70 *****************************************************************************/
71 static void QueueMsg ( vlc_object_t *, int, int , const char *,
72 const char *, va_list );
73 static void FlushMsg ( msg_queue_t * );
74 static void PrintMsg ( vlc_object_t *, msg_item_t * );
77 * Initialize messages queues
78 * This function initializes all message queues
80 void __msg_Create( vlc_object_t *p_this )
83 vlc_mutex_init( (vlc_object_t *)NULL,
84 &(p_this->p_libvlc->msg_bank.lock) );
86 for( i = 0; i < 2; i++ )
88 vlc_mutex_init( (vlc_object_t *)NULL, &QUEUE(i).lock );
89 QUEUE(i).b_overflow = VLC_FALSE;
98 QUEUE(MSG_QUEUE_NORMAL).logfile =
99 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
100 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
101 CREATE_ALWAYS, 0, NULL );
102 SetFilePointer( QUEUE(MSG_QUEUE_NORMAL).logfile, 0, NULL, FILE_END );
107 * Flush all message queues
109 void __msg_Flush( vlc_object_t *p_this )
112 for( i = 0 ; i < NB_QUEUES ; i++ )
114 vlc_mutex_lock( &QUEUE(i).lock );
115 FlushMsg( &QUEUE(i) );
116 vlc_mutex_unlock( &QUEUE(i).lock );
121 * Destroy the message queues
123 * This functions prints all messages remaining in the queues,
124 * then frees all the allocated ressources
125 * No other messages interface functions should be called after this one.
127 void __msg_Destroy( vlc_object_t *p_this )
130 for( i = NB_QUEUES -1 ; i >= 0; i-- )
133 msg_Err( p_this, "stale interface subscribers" );
135 FlushMsg( &QUEUE(i) );
138 if( i == MSG_QUEUE_NORMAL )
139 CloseHandle( QUEUE(MSG_QUEUE_NORMAL).logfile );
142 vlc_mutex_destroy( &QUEUE(i).lock );
144 vlc_mutex_destroy( &(p_this->p_libvlc->msg_bank.lock) );
148 * Subscribe to a message queue.
150 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this, int i )
152 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
154 assert( i < NB_QUEUES );
157 vlc_mutex_lock( &QUEUE(i).lock );
159 TAB_APPEND( QUEUE(i).i_sub, QUEUE(i).pp_sub, p_sub );
161 p_sub->i_start = QUEUE(i).i_start;
162 p_sub->pi_stop = &QUEUE(i).i_stop;
163 p_sub->p_msg = QUEUE(i).msg;
164 p_sub->p_lock = &QUEUE(i).lock;
166 vlc_mutex_unlock( &QUEUE(i).lock );
173 * Unsubscribe from a message queue.
175 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
180 for( i = 0 ; i< NB_QUEUES ; i++ )
182 vlc_mutex_lock( &QUEUE(i).lock );
183 for( j = 0 ; j< QUEUE(i).i_sub ; j++ )
185 if( QUEUE(i).pp_sub[j] == p_sub )
187 REMOVE_ELEM( QUEUE(i).pp_sub, QUEUE(i).i_sub, j );
188 if( p_sub ) free( p_sub );
191 vlc_mutex_unlock( & QUEUE(i).lock );
196 const char *msg_GetObjectTypeName(int i_object_type )
198 switch( i_object_type )
200 case VLC_OBJECT_GLOBAL: return "global";
201 case VLC_OBJECT_LIBVLC: return "libvlc";
202 case VLC_OBJECT_MODULE: return "module";
203 case VLC_OBJECT_INTF: return "interface";
204 case VLC_OBJECT_PLAYLIST: return "playlist";
205 case VLC_OBJECT_ITEM: return "item";
206 case VLC_OBJECT_INPUT: return "input";
207 case VLC_OBJECT_DECODER: return "decoder";
208 case VLC_OBJECT_PACKETIZER: return "packetizer";
209 case VLC_OBJECT_ENCODER: return "encoder";
210 case VLC_OBJECT_VOUT: return "video output";
211 case VLC_OBJECT_AOUT: return "audio output";
212 case VLC_OBJECT_SOUT: return "stream output";
213 case VLC_OBJECT_HTTPD: return "http server";
214 case VLC_OBJECT_HTTPD_HOST: return "http server";
215 case VLC_OBJECT_DIALOGS: return "dialogs provider";
216 case VLC_OBJECT_VLM: return "vlm";
217 case VLC_OBJECT_ANNOUNCE: return "announce handler";
218 case VLC_OBJECT_DEMUX: return "demuxer";
219 case VLC_OBJECT_ACCESS: return "access";
220 case VLC_OBJECT_META_ENGINE: return "meta engine";
221 default: return "private";
225 /*****************************************************************************
226 * __msg_*: print a message
227 *****************************************************************************
228 * These functions queue a message for later printing.
229 *****************************************************************************/
230 void __msg_Generic( vlc_object_t *p_this, int i_queue, int i_type,
231 const char *psz_module,
232 const char *psz_format, ... )
236 va_start( args, psz_format );
237 QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
241 void __msg_GenericVa( vlc_object_t *p_this, int i_queue,
242 int i_type, const char *psz_module,
243 const char *psz_format, va_list args )
245 QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
248 /* Generic functions used when variadic macros are not available. */
249 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
250 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
253 va_start( args, psz_format ); \
254 QueueMsg( p_this,MSG_QUEUE_NORMAL, FN_TYPE, "unknown", \
255 psz_format, args ); \
260 * Output an informational message.
261 * \note Do not use this for debug messages
264 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
266 * Output an error message.
268 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
270 * Output a waring message
272 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
274 * Output a debug message
276 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
279 * Add a message to a queue
281 * This function provides basic functionnalities to other msg_* functions.
282 * It adds a message to a queue (after having printed all stored messages if it
283 * is full). If the message can't be converted to string in memory, it issues
286 static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
287 const char *psz_module,
288 const char *psz_format, va_list _args )
290 int i_header_size; /* Size of the additionnal header */
292 char * psz_str = NULL; /* formatted message string */
293 char * psz_header = NULL;
295 msg_item_t * p_item = NULL; /* pointer to message */
296 msg_item_t item; /* message in case of a full queue */
297 msg_queue_t *p_queue;
299 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
300 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
306 if( i_type == VLC_MSG_DBG )
309 utf8_vfprintf( stderr, psz_format, _args );
310 fputc ('\n', stderr);
314 if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
315 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
319 /* Expand %m to strerror(errno) - only once */
320 char buf[strlen( psz_format ) + 2001], *ptr;
321 strcpy( buf, psz_format );
323 psz_format = (const char*) buf;
327 ptr = strchr( ptr, '%' );
337 strerror_r( errno, errbuf, 1001 );
339 int sockerr = WSAGetLastError( );
342 strncpy( errbuf, net_strerror( sockerr ), 1001 );
343 WSASetLastError( sockerr );
346 || (strcmp ("Unknown network stack error", errbuf) == 0))
347 strncpy( errbuf, strerror( errno ), 1001 );
351 /* Escape '%' from the error string */
352 for( char *percent = strchr( errbuf, '%' );
354 percent = strchr( percent + 2, '%' ) )
356 memmove( percent + 1, percent, strlen( percent ) + 1 );
359 errlen = strlen( errbuf );
360 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
361 memcpy( ptr, errbuf, errlen );
362 break; /* Only once, so we don't overflow */
365 /* Looks for conversion specifier... */
368 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
370 ptr++; /* ...and skip it */
374 /* Convert message to string */
375 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
376 vlc_va_copy( args, _args );
377 if( vasprintf( &psz_str, psz_format, args ) == -1 )
381 psz_str = (char*) malloc( i_size );
384 if( psz_str == NULL )
387 fprintf( stderr, "main warning: can't store message (%m): " );
391 /* we're not using GLIBC, so we are sure that the error description
392 * will be stored in the buffer we provide to strerror_r() */
393 strerror_r( errno, psz_err, 1001 );
395 strncpy( psz_err, strerror( errno ), 1001 );
397 psz_err[1000] = '\0';
398 fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
400 vlc_va_copy( args, _args );
401 /* We should use utf8_vfprintf - but it calls malloc()... */
402 vfprintf( stderr, psz_format, args );
404 fputs( "\n", stderr );
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]",
430 if( psz_old ) free( psz_old );
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 */
441 assert( i_queue < NB_QUEUES );
443 p_queue = &QUEUE(i_queue) ;
444 vlc_mutex_lock( &p_queue->lock );
446 /* Check there is room in the queue for our message */
447 if( p_queue->b_overflow )
451 if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 )
453 /* Still in overflow mode, print from a dummy item */
458 /* Pheeew, at last, there is room in the queue! */
459 p_queue->b_overflow = VLC_FALSE;
462 else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
466 if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
468 p_queue->b_overflow = VLC_TRUE;
470 if( p_queue->i_id == MSG_QUEUE_NORMAL )
472 /* Put the overflow message in the queue */
473 p_item = p_queue->msg + p_queue->i_stop;
474 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
476 p_item->i_type = VLC_MSG_WARN;
477 p_item->i_object_id = p_this->i_object_id;
478 p_item->i_object_type = p_this->i_object_type;
479 p_item->psz_module = strdup( "message" );
480 p_item->psz_msg = strdup( "message queue overflowed" );
481 p_item->psz_header = NULL;
483 PrintMsg( p_this, p_item );
484 /* We print from a dummy item */
490 if( !p_queue->b_overflow )
492 /* Put the message in the queue */
493 p_item = p_queue->msg + p_queue->i_stop;
494 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
497 /* Fill message information fields */
498 p_item->i_type = i_type;
499 p_item->i_object_id = p_this->i_object_id;
500 p_item->i_object_type = p_this->i_object_type;
501 p_item->psz_module = strdup( psz_module );
502 p_item->psz_msg = psz_str;
503 p_item->psz_header = psz_header;
505 if( p_queue->i_id == MSG_QUEUE_NORMAL )
506 PrintMsg( p_this, p_item );
508 if( p_queue->b_overflow )
510 if( p_item->psz_module )
511 free( p_item->psz_module );
512 if( p_item->psz_msg )
513 free( p_item->psz_msg );
514 if( p_item->psz_header )
515 free( p_item->psz_header );
518 vlc_mutex_unlock ( &p_queue->lock );
522 /* following functions are local */
524 /*****************************************************************************
526 *****************************************************************************
527 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
528 * this function does not check the lock.
529 *****************************************************************************/
530 static void FlushMsg ( msg_queue_t *p_queue )
532 int i_index, i_start, i_stop;
534 /* Get the maximum message index that can be freed */
535 i_stop = p_queue->i_stop;
537 /* Check until which value we can free messages */
538 for( i_index = 0; i_index < p_queue->i_sub; i_index++ )
540 i_start = p_queue->pp_sub[ i_index ]->i_start;
542 /* If this subscriber is late, we don't free messages before
543 * his i_start value, otherwise he'll miss messages */
544 if( ( i_start < i_stop
545 && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) )
546 || ( i_stop < i_start
547 && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) )
553 /* Free message data */
554 for( i_index = p_queue->i_start;
556 i_index = (i_index+1) % VLC_MSG_QSIZE )
558 if( p_queue->msg[i_index].psz_msg )
559 free( p_queue->msg[i_index].psz_msg );
560 if( p_queue->msg[i_index].psz_module )
561 free( p_queue->msg[i_index].psz_module );
562 if( p_queue->msg[i_index].psz_header )
563 free( p_queue->msg[i_index].psz_header );
566 /* Update the new start value */
567 p_queue->i_start = i_index;
570 /*****************************************************************************
571 * PrintMsg: output a standard message item to stderr
572 *****************************************************************************
573 * Print a message to stderr, with colour formatting if needed.
574 *****************************************************************************/
575 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
577 # define COL(x) "\033[" #x ";1m"
579 # define GREEN COL(32)
580 # define YELLOW COL(33)
581 # define WHITE COL(0)
582 # define GRAY "\033[0m"
587 static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
588 static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
589 const char *psz_object;
590 int i_type = p_item->i_type;
595 if( p_this->p_libvlc->i_verbose < 0 ) return;
598 if( p_this->p_libvlc->i_verbose < 0 ) return;
601 if( p_this->p_libvlc->i_verbose < 1 ) return;
604 if( p_this->p_libvlc->i_verbose < 2 ) return;
608 psz_object = msg_GetObjectTypeName(p_item->i_object_type);
611 # define CE_WRITE(str) WriteFile( QUEUE(MSG_QUEUE_NORMAL).logfile, \
612 str, strlen(str), &i_dummy, NULL );
613 CE_WRITE( p_item->psz_module );
615 CE_WRITE( psz_object );
616 CE_WRITE( ppsz_type[i_type] );
618 CE_WRITE( p_item->psz_msg );
620 FlushFileBuffers( QUEUE(MSG_QUEUE_NORMAL).logfile );
623 /* Send the message to stderr */
624 if( p_this->p_libvlc->b_color )
626 if( p_item->psz_header )
628 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s %s%s: %s%s" GRAY
630 p_item->i_object_id, p_item->psz_header,
631 p_item->psz_module, psz_object,
632 ppsz_type[i_type], ppsz_color[i_type],
637 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
638 p_item->i_object_id, p_item->psz_module, psz_object,
639 ppsz_type[i_type], ppsz_color[i_type],
645 if( p_item->psz_header )
647 utf8_fprintf( stderr, "[%.8i] %s %s %s%s: %s\n", p_item->i_object_id,
648 p_item->psz_header, p_item->psz_module,
649 psz_object, ppsz_type[i_type], p_item->psz_msg );
653 utf8_fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
654 p_item->psz_module, psz_object, ppsz_type[i_type],
665 static msg_context_t* GetContext(void)
667 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context_global_key );
670 MALLOC_NULL( p_ctx, msg_context_t );
671 p_ctx->psz_message = NULL;
672 vlc_threadvar_set( &msg_context_global_key, p_ctx );
677 void msg_StackSet( int i_code, const char *psz_message, ... )
680 msg_context_t *p_ctx = GetContext();
683 va_start( ap, psz_message );
684 free( p_ctx->psz_message );
686 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
687 p_ctx->psz_message = NULL;
690 p_ctx->i_code = i_code;
693 void msg_StackAdd( const char *psz_message, ... )
697 msg_context_t *p_ctx = GetContext();
700 va_start( ap, psz_message );
701 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
705 if( !p_ctx->psz_message )
706 p_ctx->psz_message = psz_tmp;
709 char *psz_old = malloc( strlen( p_ctx->psz_message ) + 1 );
710 memcpy( psz_old, p_ctx->psz_message, strlen( p_ctx->psz_message ) + 1 );
711 p_ctx->psz_message = realloc( p_ctx->psz_message,
712 strlen( p_ctx->psz_message ) +
714 strlen( psz_tmp ) + 3 );
715 sprintf( p_ctx->psz_message, "%s: %s", psz_tmp, psz_old );
716 free( psz_tmp ); free( psz_old );
720 const char* msg_StackMsg( void )
722 msg_context_t *p_ctx = GetContext();
724 return p_ctx->psz_message;