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
79 static inline msg_bank_t *libvlc_bank (libvlc_int_t *inst)
81 return &(libvlc_priv (inst))->msg_bank;
84 /*****************************************************************************
86 *****************************************************************************/
87 static void QueueMsg ( vlc_object_t *, int, const char *,
88 const char *, va_list );
89 static void PrintMsg ( vlc_object_t *, msg_item_t * );
91 static vlc_mutex_t msg_stack_lock = VLC_STATIC_MUTEX;
94 * Initialize messages queues
95 * This function initializes all message queues
97 void msg_Create (libvlc_int_t *p_libvlc)
99 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
100 msg_bank_t *bank = libvlc_bank (p_libvlc);
102 vlc_mutex_init (&bank->lock);
103 vlc_cond_init (&bank->wait);
104 vlc_dictionary_init( &priv->msg_enabled_objects, 0 );
105 priv->msg_all_objects_enabled = true;
112 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
113 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
114 CREATE_ALWAYS, 0, NULL );
115 SetFilePointer( QUEUE.logfile, 0, NULL, FILE_END );
118 vlc_mutex_lock( &msg_stack_lock );
120 vlc_threadvar_create( &msg_context, NULL );
121 vlc_mutex_unlock( &msg_stack_lock );
125 * Object Printing selection
127 static void const * kObjectPrintingEnabled = &kObjectPrintingEnabled;
128 static void const * kObjectPrintingDisabled = &kObjectPrintingDisabled;
130 void __msg_EnableObjectPrinting (vlc_object_t *p_this, char * psz_object)
132 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
133 vlc_mutex_lock( &QUEUE.lock );
134 if( !strcmp(psz_object, "all") )
135 priv->msg_all_objects_enabled = true;
137 vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingEnabled );
138 vlc_mutex_unlock( &QUEUE.lock );
141 void __msg_DisableObjectPrinting (vlc_object_t *p_this, char * psz_object)
143 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
144 vlc_mutex_lock( &QUEUE.lock );
145 if( !strcmp(psz_object, "all") )
146 priv->msg_all_objects_enabled = false;
148 vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingDisabled );
149 vlc_mutex_unlock( &QUEUE.lock );
153 * Destroy the message queues
155 * This functions prints all messages remaining in the queues,
156 * then frees all the allocated ressources
157 * No other messages interface functions should be called after this one.
159 void msg_Destroy (libvlc_int_t *p_libvlc)
161 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
162 msg_bank_t *bank = libvlc_bank (p_libvlc);
165 msg_Err( p_libvlc, "stale interface subscribers (VLC might crash)" );
167 vlc_mutex_lock( &msg_stack_lock );
169 vlc_threadvar_delete( &msg_context );
170 vlc_mutex_unlock( &msg_stack_lock );
173 CloseHandle( QUEUE.logfile );
176 vlc_dictionary_clear( &priv->msg_enabled_objects, NULL, NULL );
178 vlc_cond_destroy (&bank->wait);
179 vlc_mutex_destroy (&bank->lock);
182 struct msg_subscription_t
185 libvlc_int_t *instance;
187 msg_cb_data_t *opaque;
188 msg_item_t *items[VLC_MSG_QSIZE];
193 static void *msg_thread (void *data)
195 msg_subscription_t *sub = data;
196 msg_bank_t *bank = libvlc_bank (sub->instance);
198 vlc_mutex_lock (&bank->lock);
201 /* Wait for messages */
202 assert (sub->begin < VLC_MSG_QSIZE);
203 assert (sub->end < VLC_MSG_QSIZE);
204 while (sub->begin != sub->end)
206 msg_item_t *msg = sub->items[sub->begin];
207 unsigned overruns = sub->overruns;
209 if (++sub->begin == VLC_MSG_QSIZE)
212 vlc_mutex_unlock (&bank->lock);
214 sub->func (sub->opaque, msg, overruns);
217 vlc_mutex_lock (&bank->lock);
220 mutex_cleanup_push (&bank->lock);
221 vlc_cond_wait (&bank->wait, &bank->lock);
228 * Subscribe to the message queue.
229 * Whenever a message is emitted, a callback will be called.
230 * Callback invocation are serialized within a subscription.
232 * @param instance LibVLC instance to get messages from
233 * @param cb callback function
234 * @param opaque data for the callback function
235 * @return a subscription pointer, or NULL in case of failure
237 msg_subscription_t *msg_Subscribe (libvlc_int_t *instance, msg_callback_t cb,
238 msg_cb_data_t *opaque)
240 msg_subscription_t *sub = malloc (sizeof (*sub));
244 sub->instance = instance;
246 sub->opaque = opaque;
247 sub->begin = sub->end = sub->overruns = 0;
249 if (vlc_clone (&sub->thread, msg_thread, sub, VLC_THREAD_PRIORITY_LOW))
255 msg_bank_t *bank = libvlc_bank (instance);
256 vlc_mutex_lock (&bank->lock);
257 TAB_APPEND (bank->i_sub, bank->pp_sub, sub);
258 vlc_mutex_unlock (&bank->lock);
264 * Unsubscribe from the message queue.
265 * This function waits for the message callback to return if needed.
267 void msg_Unsubscribe (msg_subscription_t *sub)
269 msg_bank_t *bank = libvlc_bank (sub->instance);
271 /* TODO: flush support? */
272 vlc_cancel (sub->thread);
273 vlc_mutex_lock (&bank->lock);
274 TAB_REMOVE (bank->i_sub, bank->pp_sub, sub);
275 vlc_mutex_unlock (&bank->lock);
277 vlc_join (sub->thread, NULL);
281 /*****************************************************************************
282 * __msg_*: print a message
283 *****************************************************************************
284 * These functions queue a message for later printing.
285 *****************************************************************************/
286 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
287 const char *psz_format, ... )
291 va_start( args, psz_format );
292 QueueMsg( p_this, i_type, psz_module, psz_format, args );
296 void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
297 const char *psz_format, va_list args )
299 QueueMsg( p_this, i_type, psz_module, psz_format, args );
303 * Destroys a message.
305 static void msg_Free (gc_object_t *gc)
307 msg_item_t *msg = vlc_priv (gc, msg_item_t);
309 free (msg->psz_module);
311 free (msg->psz_header);
316 * Add a message to a queue
318 * This function provides basic functionnalities to other msg_* functions.
319 * It adds a message to a queue (after having printed all stored messages if it
320 * is full). If the message can't be converted to string in memory, it issues
323 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
324 const char *psz_format, va_list _args )
327 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
328 int i_header_size; /* Size of the additionnal header */
330 char * psz_str = NULL; /* formatted message string */
331 char * psz_header = NULL;
333 msg_item_t * p_item = malloc (sizeof (*p_item));
338 vlc_gc_init (p_item, msg_Free);
340 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
341 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
344 if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
345 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
349 /* Expand %m to strerror(errno) - only once */
350 char buf[strlen( psz_format ) + 2001], *ptr;
351 strcpy( buf, psz_format );
353 psz_format = (const char*) buf;
357 ptr = strchr( ptr, '%' );
367 strerror_r( errno, errbuf, 1001 );
369 int sockerr = WSAGetLastError( );
372 strncpy( errbuf, net_strerror( sockerr ), 1001 );
373 WSASetLastError( sockerr );
376 || (strcmp ("Unknown network stack error", errbuf) == 0))
377 strncpy( errbuf, strerror( errno ), 1001 );
381 /* Escape '%' from the error string */
382 for( char *percent = strchr( errbuf, '%' );
384 percent = strchr( percent + 2, '%' ) )
386 memmove( percent + 1, percent, strlen( percent ) + 1 );
389 errlen = strlen( errbuf );
390 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
391 memcpy( ptr, errbuf, errlen );
392 break; /* Only once, so we don't overflow */
395 /* Looks for conversion specifier... */
398 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
400 ptr++; /* ...and skip it */
404 /* Convert message to string */
405 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
406 vlc_va_copy( args, _args );
407 if( vasprintf( &psz_str, psz_format, args ) == -1 )
411 psz_str = (char*) malloc( i_size );
414 if( psz_str == NULL )
416 int canc = vlc_savecancel (); /* Do not print half of a message... */
418 fprintf( stderr, "main warning: can't store message (%m): " );
422 /* we're not using GLIBC, so we are sure that the error description
423 * will be stored in the buffer we provide to strerror_r() */
424 strerror_r( errno, psz_err, 1001 );
426 strncpy( psz_err, strerror( errno ), 1001 );
428 psz_err[1000] = '\0';
429 fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
431 vlc_va_copy( args, _args );
432 /* We should use utf8_vfprintf - but it calls malloc()... */
433 vfprintf( stderr, psz_format, args );
435 fputs( "\n", stderr );
436 vlc_restorecancel (canc);
442 while( p_obj != NULL )
444 char *psz_old = NULL;
445 if( p_obj->psz_header )
447 i_header_size += strlen( p_obj->psz_header ) + 4;
450 psz_old = strdup( psz_header );
451 psz_header = (char*)realloc( psz_header, i_header_size );
452 snprintf( psz_header, i_header_size , "[%s] %s",
453 p_obj->psz_header, psz_old );
457 psz_header = (char *)malloc( i_header_size );
458 snprintf( psz_header, i_header_size, "[%s]",
463 p_obj = p_obj->p_parent;
466 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
467 vlc_va_copy( args, _args );
468 vsnprintf( psz_str, i_size, psz_format, args );
470 psz_str[ i_size - 1 ] = 0; /* Just in case */
473 msg_bank_t *p_queue = &QUEUE;
474 vlc_mutex_lock( &p_queue->lock );
476 /* Fill message information fields */
477 p_item->i_type = i_type;
478 p_item->i_object_id = (uintptr_t)p_this;
479 p_item->psz_object_type = p_this->psz_object_type;
480 p_item->psz_module = strdup( psz_module );
481 p_item->psz_msg = psz_str;
482 p_item->psz_header = psz_header;
484 PrintMsg( p_this, p_item );
486 for (int i = 0; i < bank->i_sub; i++)
488 msg_subscription_t *sub = bank->pp_sub[i];
489 if ((sub->end + 1 - sub->begin) % VLC_MSG_QSIZE)
491 sub->items[sub->end++] = msg_Hold (p_item);
492 if (sub->end == VLC_MSG_QSIZE)
498 vlc_cond_broadcast (&bank->wait);
499 vlc_mutex_unlock (&bank->lock);
502 /*****************************************************************************
503 * PrintMsg: output a standard message item to stderr
504 *****************************************************************************
505 * Print a message to stderr, with colour formatting if needed.
506 *****************************************************************************/
507 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
509 # define COL(x) "\033[" #x ";1m"
511 # define GREEN COL(32)
512 # define YELLOW COL(33)
513 # define WHITE COL(0)
514 # define GRAY "\033[0m"
519 static const char ppsz_type[4][9] = { "", " error", " warning", " debug" };
520 static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY };
521 const char *psz_object;
522 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
523 int i_type = p_item->i_type;
528 if( priv->i_verbose < 0 ) return;
531 if( priv->i_verbose < 0 ) return;
534 if( priv->i_verbose < 1 ) return;
537 if( priv->i_verbose < 2 ) return;
541 psz_object = p_item->psz_object_type;
542 void * val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
543 p_item->psz_module );
544 if( val == kObjectPrintingDisabled )
546 if( val == kObjectPrintingEnabled )
550 val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
552 if( val == kObjectPrintingDisabled )
554 if( val == kObjectPrintingEnabled )
556 else if( !priv->msg_all_objects_enabled )
560 int canc = vlc_savecancel ();
562 # define CE_WRITE(str) WriteFile( QUEUE.logfile, \
563 str, strlen(str), &i_dummy, NULL );
564 CE_WRITE( p_item->psz_module );
566 CE_WRITE( psz_object );
567 CE_WRITE( ppsz_type[i_type] );
569 CE_WRITE( p_item->psz_msg );
571 FlushFileBuffers( QUEUE.logfile );
574 /* Send the message to stderr */
575 utf8_fprintf( stderr, "[%s%p%s] %s%s%s %s%s: %s%s%s\n",
576 priv->b_color ? GREEN : "",
577 (void *)p_item->i_object_id,
578 priv->b_color ? GRAY : "",
579 p_item->psz_header ? p_item->psz_header : "",
580 p_item->psz_header ? " " : "",
581 p_item->psz_module, psz_object,
583 priv->b_color ? ppsz_color[i_type] : "",
585 priv->b_color ? GRAY : "" );
590 vlc_restorecancel (canc);
594 static msg_context_t* GetContext(void)
596 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context );
599 MALLOC_NULL( p_ctx, msg_context_t );
600 p_ctx->psz_message = NULL;
601 vlc_threadvar_set( &msg_context, p_ctx );
606 void msg_StackDestroy (void *data)
608 msg_context_t *p_ctx = data;
610 free (p_ctx->psz_message);
614 void msg_StackSet( int i_code, const char *psz_message, ... )
617 msg_context_t *p_ctx = GetContext();
621 free( p_ctx->psz_message );
623 va_start( ap, psz_message );
624 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
625 p_ctx->psz_message = NULL;
628 p_ctx->i_code = i_code;
631 void msg_StackAdd( const char *psz_message, ... )
635 msg_context_t *p_ctx = GetContext();
640 va_start( ap, psz_message );
641 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
645 if( !p_ctx->psz_message )
646 p_ctx->psz_message = psz_tmp;
650 if( asprintf( &psz_new, "%s: %s", psz_tmp, p_ctx->psz_message ) == -1 )
653 free( p_ctx->psz_message );
654 p_ctx->psz_message = psz_new;
659 const char* msg_StackMsg( void )
661 msg_context_t *p_ctx = GetContext();
663 return p_ctx->psz_message;