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 <vlc_network.h> /* 'net_strerror' and 'WSAGetLastError' */
50 # include <unistd.h> /* close(), write() */
55 #include <vlc_charset.h>
57 /*****************************************************************************
59 *****************************************************************************/
60 #if defined(HAVE_VA_COPY)
61 # define vlc_va_copy(dest,src) va_copy(dest,src)
62 #elif defined(HAVE___VA_COPY)
63 # define vlc_va_copy(dest,src) __va_copy(dest,src)
65 # define vlc_va_copy(dest,src) (dest)=(src)
68 #define QUEUE(i) p_this->p_libvlc->msg_bank.queues[i]
69 #define LOCK_BANK vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
70 #define UNLOCK_BANK vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
72 /*****************************************************************************
74 *****************************************************************************/
75 static void QueueMsg ( vlc_object_t *, int, int , const char *,
76 const char *, va_list );
77 static void FlushMsg ( msg_queue_t * );
78 static void PrintMsg ( vlc_object_t *, msg_item_t * );
81 * Initialize messages queues
82 * This function initializes all message queues
84 void __msg_Create( vlc_object_t *p_this )
87 vlc_mutex_init( (vlc_object_t *)NULL,
88 &(p_this->p_libvlc->msg_bank.lock) );
90 for( i = 0; i < 2; i++ )
92 vlc_mutex_init( (vlc_object_t *)NULL, &QUEUE(i).lock );
93 QUEUE(i).b_overflow = VLC_FALSE;
102 QUEUE(MSG_QUEUE_NORMAL).logfile =
103 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
104 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
105 CREATE_ALWAYS, 0, NULL );
106 SetFilePointer( QUEUE(MSG_QUEUE_NORMAL).logfile, 0, NULL, FILE_END );
111 * Flush all message queues
113 void __msg_Flush( vlc_object_t *p_this )
116 for( i = 0 ; i < NB_QUEUES ; i++ )
118 vlc_mutex_lock( &QUEUE(i).lock );
119 FlushMsg( &QUEUE(i) );
120 vlc_mutex_unlock( &QUEUE(i).lock );
125 * Destroy the message queues
127 * This functions prints all messages remaining in the queues,
128 * then frees all the allocated ressources
129 * No other messages interface functions should be called after this one.
131 void __msg_Destroy( vlc_object_t *p_this )
134 for( i = NB_QUEUES -1 ; i >= 0; i-- )
137 msg_Err( p_this, "stale interface subscribers" );
139 FlushMsg( &QUEUE(i) );
142 if( i == MSG_QUEUE_NORMAL )
143 CloseHandle( QUEUE(MSG_QUEUE_NORMAL).logfile );
146 vlc_mutex_destroy( &QUEUE(i).lock );
148 vlc_mutex_destroy( &(p_this->p_libvlc->msg_bank.lock) );
152 * Subscribe to a message queue.
154 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this, int i )
156 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
158 assert( i < NB_QUEUES );
161 vlc_mutex_lock( &QUEUE(i).lock );
163 TAB_APPEND( QUEUE(i).i_sub, QUEUE(i).pp_sub, p_sub );
165 p_sub->i_start = QUEUE(i).i_start;
166 p_sub->pi_stop = &QUEUE(i).i_stop;
167 p_sub->p_msg = QUEUE(i).msg;
168 p_sub->p_lock = &QUEUE(i).lock;
170 vlc_mutex_unlock( &QUEUE(i).lock );
177 * Unsubscribe from a message queue.
179 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
184 for( i = 0 ; i< NB_QUEUES ; i++ )
186 vlc_mutex_lock( &QUEUE(i).lock );
187 for( j = 0 ; j< QUEUE(i).i_sub ; j++ )
189 if( QUEUE(i).pp_sub[j] == p_sub )
191 REMOVE_ELEM( QUEUE(i).pp_sub, QUEUE(i).i_sub, j );
195 vlc_mutex_unlock( & QUEUE(i).lock );
200 const char *msg_GetObjectTypeName(int i_object_type )
202 switch( i_object_type )
204 case VLC_OBJECT_GLOBAL: return "global";
205 case VLC_OBJECT_LIBVLC: return "libvlc";
206 case VLC_OBJECT_MODULE: return "module";
207 case VLC_OBJECT_INTF: return "interface";
208 case VLC_OBJECT_PLAYLIST: return "playlist";
209 case VLC_OBJECT_ITEM: return "item";
210 case VLC_OBJECT_INPUT: return "input";
211 case VLC_OBJECT_DECODER: return "decoder";
212 case VLC_OBJECT_PACKETIZER: return "packetizer";
213 case VLC_OBJECT_ENCODER: return "encoder";
214 case VLC_OBJECT_VOUT: return "video output";
215 case VLC_OBJECT_AOUT: return "audio output";
216 case VLC_OBJECT_SOUT: return "stream output";
217 case VLC_OBJECT_HTTPD: return "http server";
218 case VLC_OBJECT_HTTPD_HOST: return "http server";
219 case VLC_OBJECT_DIALOGS: return "dialogs provider";
220 case VLC_OBJECT_VLM: return "vlm";
221 case VLC_OBJECT_ANNOUNCE: return "announce handler";
222 case VLC_OBJECT_DEMUX: return "demuxer";
223 case VLC_OBJECT_ACCESS: return "access";
224 case VLC_OBJECT_META_ENGINE: return "meta engine";
225 default: return "private";
229 /*****************************************************************************
230 * __msg_*: print a message
231 *****************************************************************************
232 * These functions queue a message for later printing.
233 *****************************************************************************/
234 void __msg_Generic( vlc_object_t *p_this, int i_queue, int i_type,
235 const char *psz_module,
236 const char *psz_format, ... )
240 va_start( args, psz_format );
241 QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
245 void __msg_GenericVa( vlc_object_t *p_this, int i_queue,
246 int i_type, const char *psz_module,
247 const char *psz_format, va_list args )
249 QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
252 /* Generic functions used when variadic macros are not available. */
253 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
254 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
257 va_start( args, psz_format ); \
258 QueueMsg( p_this,MSG_QUEUE_NORMAL, FN_TYPE, "unknown", \
259 psz_format, args ); \
264 * Output an informational message.
265 * \note Do not use this for debug messages
268 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
270 * Output an error message.
272 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
274 * Output a waring message
276 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
278 * Output a debug message
280 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
283 * Add a message to a queue
285 * This function provides basic functionnalities to other msg_* functions.
286 * It adds a message to a queue (after having printed all stored messages if it
287 * is full). If the message can't be converted to string in memory, it issues
290 static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
291 const char *psz_module,
292 const char *psz_format, va_list _args )
294 int i_header_size; /* Size of the additionnal header */
296 char * psz_str = NULL; /* formatted message string */
297 char * psz_header = NULL;
299 msg_item_t * p_item = NULL; /* pointer to message */
300 msg_item_t item; /* message in case of a full queue */
301 msg_queue_t *p_queue;
303 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
304 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
310 if( i_type == VLC_MSG_DBG )
313 utf8_vfprintf( stderr, psz_format, _args );
314 fputc ('\n', stderr);
318 if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
319 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
323 /* Expand %m to strerror(errno) - only once */
324 char buf[strlen( psz_format ) + 2001], *ptr;
325 strcpy( buf, psz_format );
327 psz_format = (const char*) buf;
331 ptr = strchr( ptr, '%' );
341 strerror_r( errno, errbuf, 1001 );
343 int sockerr = WSAGetLastError( );
346 strncpy( errbuf, net_strerror( sockerr ), 1001 );
347 WSASetLastError( sockerr );
350 || (strcmp ("Unknown network stack error", errbuf) == 0))
351 strncpy( errbuf, strerror( errno ), 1001 );
355 /* Escape '%' from the error string */
356 for( char *percent = strchr( errbuf, '%' );
358 percent = strchr( percent + 2, '%' ) )
360 memmove( percent + 1, percent, strlen( percent ) + 1 );
363 errlen = strlen( errbuf );
364 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
365 memcpy( ptr, errbuf, errlen );
366 break; /* Only once, so we don't overflow */
369 /* Looks for conversion specifier... */
372 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
374 ptr++; /* ...and skip it */
378 /* Convert message to string */
379 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
380 vlc_va_copy( args, _args );
381 if( vasprintf( &psz_str, psz_format, args ) == -1 )
385 psz_str = (char*) malloc( i_size );
388 if( psz_str == NULL )
391 fprintf( stderr, "main warning: can't store message (%m): " );
395 /* we're not using GLIBC, so we are sure that the error description
396 * will be stored in the buffer we provide to strerror_r() */
397 strerror_r( errno, psz_err, 1001 );
399 strncpy( psz_err, strerror( errno ), 1001 );
401 psz_err[1000] = '\0';
402 fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
404 vlc_va_copy( args, _args );
405 /* We should use utf8_vfprintf - but it calls malloc()... */
406 vfprintf( stderr, psz_format, args );
408 fputs( "\n", stderr );
414 while( p_obj != NULL )
416 char *psz_old = NULL;
417 if( p_obj->psz_header )
419 i_header_size += strlen( p_obj->psz_header ) + 4;
422 psz_old = strdup( psz_header );
423 psz_header = (char*)realloc( psz_header, i_header_size );
424 snprintf( psz_header, i_header_size , "[%s] %s",
425 p_obj->psz_header, psz_old );
429 psz_header = (char *)malloc( i_header_size );
430 snprintf( psz_header, i_header_size, "[%s]",
435 p_obj = p_obj->p_parent;
438 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
439 vlc_va_copy( args, _args );
440 vsnprintf( psz_str, i_size, psz_format, args );
442 psz_str[ i_size - 1 ] = 0; /* Just in case */
445 assert( i_queue < NB_QUEUES );
447 p_queue = &QUEUE(i_queue) ;
448 vlc_mutex_lock( &p_queue->lock );
450 /* Check there is room in the queue for our message */
451 if( p_queue->b_overflow )
455 if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 )
457 /* Still in overflow mode, print from a dummy item */
462 /* Pheeew, at last, there is room in the queue! */
463 p_queue->b_overflow = VLC_FALSE;
466 else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
470 if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
472 p_queue->b_overflow = VLC_TRUE;
474 if( p_queue->i_id == MSG_QUEUE_NORMAL )
476 /* Put the overflow message in the queue */
477 p_item = p_queue->msg + p_queue->i_stop;
478 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
480 p_item->i_type = VLC_MSG_WARN;
481 p_item->i_object_id = p_this->i_object_id;
482 p_item->i_object_type = p_this->i_object_type;
483 p_item->psz_module = strdup( "message" );
484 p_item->psz_msg = strdup( "message queue overflowed" );
485 p_item->psz_header = NULL;
487 PrintMsg( p_this, p_item );
488 /* We print from a dummy item */
494 if( !p_queue->b_overflow )
496 /* Put the message in the queue */
497 p_item = p_queue->msg + p_queue->i_stop;
498 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
501 /* Fill message information fields */
502 p_item->i_type = i_type;
503 p_item->i_object_id = p_this->i_object_id;
504 p_item->i_object_type = p_this->i_object_type;
505 p_item->psz_module = strdup( psz_module );
506 p_item->psz_msg = psz_str;
507 p_item->psz_header = psz_header;
509 if( p_queue->i_id == MSG_QUEUE_NORMAL )
510 PrintMsg( p_this, p_item );
512 if( p_queue->b_overflow )
514 free( p_item->psz_module );
515 free( p_item->psz_msg );
516 free( p_item->psz_header );
519 vlc_mutex_unlock ( &p_queue->lock );
523 /* following functions are local */
525 /*****************************************************************************
527 *****************************************************************************
528 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
529 * this function does not check the lock.
530 *****************************************************************************/
531 static void FlushMsg ( msg_queue_t *p_queue )
533 int i_index, i_start, i_stop;
535 /* Get the maximum message index that can be freed */
536 i_stop = p_queue->i_stop;
538 /* Check until which value we can free messages */
539 for( i_index = 0; i_index < p_queue->i_sub; i_index++ )
541 i_start = p_queue->pp_sub[ i_index ]->i_start;
543 /* If this subscriber is late, we don't free messages before
544 * his i_start value, otherwise he'll miss messages */
545 if( ( i_start < i_stop
546 && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) )
547 || ( i_stop < i_start
548 && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) )
554 /* Free message data */
555 for( i_index = p_queue->i_start;
557 i_index = (i_index+1) % VLC_MSG_QSIZE )
559 free( p_queue->msg[i_index].psz_msg );
560 free( p_queue->msg[i_index].psz_module );
561 free( p_queue->msg[i_index].psz_header );
564 /* Update the new start value */
565 p_queue->i_start = i_index;
568 /*****************************************************************************
569 * PrintMsg: output a standard message item to stderr
570 *****************************************************************************
571 * Print a message to stderr, with colour formatting if needed.
572 *****************************************************************************/
573 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
575 # define COL(x) "\033[" #x ";1m"
577 # define GREEN COL(32)
578 # define YELLOW COL(33)
579 # define WHITE COL(0)
580 # define GRAY "\033[0m"
585 static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
586 static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
587 const char *psz_object;
588 int i_type = p_item->i_type;
593 if( p_this->p_libvlc->i_verbose < 0 ) return;
596 if( p_this->p_libvlc->i_verbose < 0 ) return;
599 if( p_this->p_libvlc->i_verbose < 1 ) return;
602 if( p_this->p_libvlc->i_verbose < 2 ) return;
606 psz_object = msg_GetObjectTypeName(p_item->i_object_type);
609 # define CE_WRITE(str) WriteFile( QUEUE(MSG_QUEUE_NORMAL).logfile, \
610 str, strlen(str), &i_dummy, NULL );
611 CE_WRITE( p_item->psz_module );
613 CE_WRITE( psz_object );
614 CE_WRITE( ppsz_type[i_type] );
616 CE_WRITE( p_item->psz_msg );
618 FlushFileBuffers( QUEUE(MSG_QUEUE_NORMAL).logfile );
621 /* Send the message to stderr */
622 if( p_this->p_libvlc->b_color )
624 if( p_item->psz_header )
626 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s %s%s: %s%s" GRAY
628 p_item->i_object_id, p_item->psz_header,
629 p_item->psz_module, psz_object,
630 ppsz_type[i_type], ppsz_color[i_type],
635 utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
636 p_item->i_object_id, p_item->psz_module, psz_object,
637 ppsz_type[i_type], ppsz_color[i_type],
643 if( p_item->psz_header )
645 utf8_fprintf( stderr, "[%.8i] %s %s %s%s: %s\n", p_item->i_object_id,
646 p_item->psz_header, p_item->psz_module,
647 psz_object, ppsz_type[i_type], p_item->psz_msg );
651 utf8_fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
652 p_item->psz_module, psz_object, ppsz_type[i_type],
663 static msg_context_t* GetContext(void)
665 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context_global_key );
668 MALLOC_NULL( p_ctx, msg_context_t );
669 p_ctx->psz_message = NULL;
670 vlc_threadvar_set( &msg_context_global_key, p_ctx );
675 void msg_StackSet( int i_code, const char *psz_message, ... )
678 msg_context_t *p_ctx = GetContext();
681 va_start( ap, psz_message );
682 free( p_ctx->psz_message );
684 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
685 p_ctx->psz_message = NULL;
688 p_ctx->i_code = i_code;
691 void msg_StackAdd( const char *psz_message, ... )
695 msg_context_t *p_ctx = GetContext();
698 va_start( ap, psz_message );
699 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
703 if( !p_ctx->psz_message )
704 p_ctx->psz_message = psz_tmp;
707 char *psz_old = malloc( strlen( p_ctx->psz_message ) + 1 );
708 memcpy( psz_old, p_ctx->psz_message, strlen( p_ctx->psz_message ) + 1 );
709 p_ctx->psz_message = realloc( p_ctx->psz_message,
710 strlen( p_ctx->psz_message ) +
712 strlen( psz_tmp ) + 3 );
713 sprintf( p_ctx->psz_message, "%s: %s", psz_tmp, psz_old );
714 free( psz_tmp ); free( psz_old );
718 const char* msg_StackMsg( void )
720 msg_context_t *p_ctx = GetContext();
722 return p_ctx->psz_message;