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 void cleanup_msg_context (void *data)
66 msg_context_t *ctx = data;
67 free (ctx->psz_message);
71 static vlc_threadvar_t msg_context;
72 static uintptr_t banks = 0;
74 /*****************************************************************************
76 *****************************************************************************/
77 #if defined(HAVE_VA_COPY)
78 # define vlc_va_copy(dest,src) va_copy(dest,src)
79 #elif defined(HAVE___VA_COPY)
80 # define vlc_va_copy(dest,src) __va_copy(dest,src)
82 # define vlc_va_copy(dest,src) (dest)=(src)
85 #define QUEUE priv->msg_bank
86 static inline msg_bank_t *libvlc_bank (libvlc_int_t *inst)
88 return &(libvlc_priv (inst))->msg_bank;
91 /*****************************************************************************
93 *****************************************************************************/
94 static void QueueMsg ( vlc_object_t *, int, const char *,
95 const char *, va_list );
96 static void PrintMsg ( vlc_object_t *, msg_item_t * );
98 static vlc_mutex_t msg_stack_lock = VLC_STATIC_MUTEX;
101 * Initialize messages queues
102 * This function initializes all message queues
104 void msg_Create (libvlc_int_t *p_libvlc)
106 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
107 msg_bank_t *bank = libvlc_bank (p_libvlc);
109 vlc_mutex_init (&bank->lock);
110 vlc_cond_init (&bank->wait);
111 vlc_dictionary_init( &priv->msg_enabled_objects, 0 );
112 priv->msg_all_objects_enabled = true;
119 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
120 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
121 CREATE_ALWAYS, 0, NULL );
122 SetFilePointer( QUEUE.logfile, 0, NULL, FILE_END );
125 vlc_mutex_lock( &msg_stack_lock );
127 vlc_threadvar_create( &msg_context, cleanup_msg_context );
128 vlc_mutex_unlock( &msg_stack_lock );
132 * Object Printing selection
134 static void const * kObjectPrintingEnabled = &kObjectPrintingEnabled;
135 static void const * kObjectPrintingDisabled = &kObjectPrintingDisabled;
137 void __msg_EnableObjectPrinting (vlc_object_t *p_this, char * psz_object)
139 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
140 vlc_mutex_lock( &QUEUE.lock );
141 if( !strcmp(psz_object, "all") )
142 priv->msg_all_objects_enabled = true;
144 vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingEnabled );
145 vlc_mutex_unlock( &QUEUE.lock );
148 void __msg_DisableObjectPrinting (vlc_object_t *p_this, char * psz_object)
150 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
151 vlc_mutex_lock( &QUEUE.lock );
152 if( !strcmp(psz_object, "all") )
153 priv->msg_all_objects_enabled = false;
155 vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingDisabled );
156 vlc_mutex_unlock( &QUEUE.lock );
160 * Destroy the message queues
162 * This functions prints all messages remaining in the queues,
163 * then frees all the allocated resources
164 * No other messages interface functions should be called after this one.
166 void msg_Destroy (libvlc_int_t *p_libvlc)
168 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
169 msg_bank_t *bank = libvlc_bank (p_libvlc);
172 msg_Err( p_libvlc, "stale interface subscribers (VLC might crash)" );
174 vlc_mutex_lock( &msg_stack_lock );
176 vlc_threadvar_delete( &msg_context );
177 vlc_mutex_unlock( &msg_stack_lock );
180 CloseHandle( QUEUE.logfile );
183 vlc_dictionary_clear( &priv->msg_enabled_objects, NULL, NULL );
185 vlc_cond_destroy (&bank->wait);
186 vlc_mutex_destroy (&bank->lock);
189 struct msg_subscription_t
192 libvlc_int_t *instance;
194 msg_cb_data_t *opaque;
195 msg_item_t *items[VLC_MSG_QSIZE];
200 static void *msg_thread (void *data)
202 msg_subscription_t *sub = data;
203 msg_bank_t *bank = libvlc_bank (sub->instance);
205 vlc_mutex_lock (&bank->lock);
208 /* Wait for messages */
209 assert (sub->begin < VLC_MSG_QSIZE);
210 assert (sub->end < VLC_MSG_QSIZE);
211 while (sub->begin != sub->end)
213 msg_item_t *msg = sub->items[sub->begin];
214 unsigned overruns = sub->overruns;
216 if (++sub->begin == VLC_MSG_QSIZE)
219 vlc_mutex_unlock (&bank->lock);
221 sub->func (sub->opaque, msg, overruns);
224 vlc_mutex_lock (&bank->lock);
227 mutex_cleanup_push (&bank->lock);
228 vlc_cond_wait (&bank->wait, &bank->lock);
235 * Subscribe to the message queue.
236 * Whenever a message is emitted, a callback will be called.
237 * Callback invocation are serialized within a subscription.
239 * @param instance LibVLC instance to get messages from
240 * @param cb callback function
241 * @param opaque data for the callback function
242 * @return a subscription pointer, or NULL in case of failure
244 msg_subscription_t *msg_Subscribe (libvlc_int_t *instance, msg_callback_t cb,
245 msg_cb_data_t *opaque)
247 msg_subscription_t *sub = malloc (sizeof (*sub));
251 sub->instance = instance;
253 sub->opaque = opaque;
254 sub->begin = sub->end = sub->overruns = 0;
256 if (vlc_clone (&sub->thread, msg_thread, sub, VLC_THREAD_PRIORITY_LOW))
262 msg_bank_t *bank = libvlc_bank (instance);
263 vlc_mutex_lock (&bank->lock);
264 TAB_APPEND (bank->i_sub, bank->pp_sub, sub);
265 vlc_mutex_unlock (&bank->lock);
271 * Unsubscribe from the message queue.
272 * This function waits for the message callback to return if needed.
274 void msg_Unsubscribe (msg_subscription_t *sub)
276 msg_bank_t *bank = libvlc_bank (sub->instance);
278 /* TODO: flush support? */
279 vlc_cancel (sub->thread);
280 vlc_mutex_lock (&bank->lock);
281 TAB_REMOVE (bank->i_sub, bank->pp_sub, sub);
282 vlc_mutex_unlock (&bank->lock);
284 vlc_join (sub->thread, NULL);
286 /* Free dangling (not flushed) messages. */
287 /* NOTE: no locking, only this thread can refer to the subscription now. */
288 while (sub->begin != sub->end)
290 msg_Release (sub->items[sub->begin]);
291 if (++sub->begin == VLC_MSG_QSIZE)
297 /*****************************************************************************
298 * __msg_*: print a message
299 *****************************************************************************
300 * These functions queue a message for later printing.
301 *****************************************************************************/
302 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
303 const char *psz_format, ... )
307 va_start( args, psz_format );
308 QueueMsg( p_this, i_type, psz_module, psz_format, args );
312 void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
313 const char *psz_format, va_list args )
315 QueueMsg( p_this, i_type, psz_module, psz_format, args );
319 * Destroys a message.
321 static void msg_Free (gc_object_t *gc)
323 msg_item_t *msg = vlc_priv (gc, msg_item_t);
325 free (msg->psz_module);
327 free (msg->psz_header);
332 * Add a message to a queue
334 * This function provides basic functionnalities to other msg_* functions.
335 * It adds a message to a queue (after having printed all stored messages if it
336 * is full). If the message can't be converted to string in memory, it issues
339 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
340 const char *psz_format, va_list _args )
343 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
344 int i_header_size; /* Size of the additionnal header */
346 char * psz_str = NULL; /* formatted message string */
347 char * psz_header = NULL;
350 if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
351 (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
355 /* Expand %m to strerror(errno) - only once */
356 char buf[strlen( psz_format ) + 2001], *ptr;
357 strcpy( buf, psz_format );
359 psz_format = (const char*) buf;
363 ptr = strchr( ptr, '%' );
373 strerror_r( errno, errbuf, 1001 );
375 int sockerr = WSAGetLastError( );
378 strncpy( errbuf, net_strerror( sockerr ), 1001 );
379 WSASetLastError( sockerr );
382 || (strcmp ("Unknown network stack error", errbuf) == 0))
383 strncpy( errbuf, strerror( errno ), 1001 );
387 /* Escape '%' from the error string */
388 for( char *percent = strchr( errbuf, '%' );
390 percent = strchr( percent + 2, '%' ) )
392 memmove( percent + 1, percent, strlen( percent ) + 1 );
395 errlen = strlen( errbuf );
396 memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
397 memcpy( ptr, errbuf, errlen );
398 break; /* Only once, so we don't overflow */
401 /* Looks for conversion specifier... */
404 while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
406 ptr++; /* ...and skip it */
410 /* Convert message to string */
411 vlc_va_copy( args, _args );
412 if( vasprintf( &psz_str, psz_format, args ) == -1 )
416 if( psz_str == NULL )
418 int canc = vlc_savecancel (); /* Do not print half of a message... */
420 fprintf( stderr, "main warning: can't store message (%m): " );
424 /* we're not using GLIBC, so we are sure that the error description
425 * will be stored in the buffer we provide to strerror_r() */
426 strerror_r( errno, psz_err, 1001 );
428 strncpy( psz_err, strerror( errno ), 1001 );
430 psz_err[1000] = '\0';
431 fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
433 vlc_va_copy( args, _args );
434 /* We should use utf8_vfprintf - but it calls malloc()... */
435 vfprintf( stderr, psz_format, args );
437 fputs( "\n", stderr );
438 vlc_restorecancel (canc);
442 msg_item_t * p_item = malloc (sizeof (*p_item));
447 vlc_gc_init (p_item, msg_Free);
448 p_item->psz_module = p_item->psz_msg = p_item->psz_header = NULL;
454 while( p_obj != NULL )
456 char *psz_old = NULL;
457 if( p_obj->psz_header )
459 i_header_size += strlen( p_obj->psz_header ) + 4;
462 psz_old = strdup( psz_header );
463 psz_header = (char*)realloc( psz_header, i_header_size );
464 snprintf( psz_header, i_header_size , "[%s] %s",
465 p_obj->psz_header, psz_old );
469 psz_header = (char *)malloc( i_header_size );
470 snprintf( psz_header, i_header_size, "[%s]",
475 p_obj = p_obj->p_parent;
478 /* Fill message information fields */
479 p_item->i_type = i_type;
480 p_item->i_object_id = (uintptr_t)p_this;
481 p_item->psz_object_type = p_this->psz_object_type;
482 p_item->psz_module = strdup( psz_module );
483 p_item->psz_msg = psz_str;
484 p_item->psz_header = psz_header;
486 PrintMsg( p_this, p_item );
488 msg_bank_t *p_queue = &QUEUE;
489 vlc_mutex_lock( &p_queue->lock );
491 for (int i = 0; i < bank->i_sub; i++)
493 msg_subscription_t *sub = bank->pp_sub[i];
494 if ((sub->end + 1 - sub->begin) % VLC_MSG_QSIZE)
496 sub->items[sub->end++] = msg_Hold (p_item);
497 if (sub->end == VLC_MSG_QSIZE)
503 vlc_cond_broadcast (&bank->wait);
504 vlc_mutex_unlock (&bank->lock);
505 msg_Release (p_item);
508 /*****************************************************************************
509 * PrintMsg: output a standard message item to stderr
510 *****************************************************************************
511 * Print a message to stderr, with colour formatting if needed.
512 *****************************************************************************/
513 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
515 # define COL(x) "\033[" #x ";1m"
517 # define GREEN COL(32)
518 # define YELLOW COL(33)
519 # define WHITE COL(0)
520 # define GRAY "\033[0m"
525 static const char ppsz_type[4][9] = { "", " error", " warning", " debug" };
526 static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY };
527 const char *psz_object;
528 libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
529 int i_type = p_item->i_type;
534 if( priv->i_verbose < 0 ) return;
537 if( priv->i_verbose < 0 ) return;
540 if( priv->i_verbose < 1 ) return;
543 if( priv->i_verbose < 2 ) return;
547 psz_object = p_item->psz_object_type;
548 void * val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
549 p_item->psz_module );
550 if( val == kObjectPrintingDisabled )
552 if( val == kObjectPrintingEnabled )
556 val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
558 if( val == kObjectPrintingDisabled )
560 if( val == kObjectPrintingEnabled )
562 else if( !priv->msg_all_objects_enabled )
567 # define CE_WRITE(str) WriteFile( QUEUE.logfile, \
568 str, strlen(str), &i_dummy, NULL );
569 CE_WRITE( p_item->psz_module );
571 CE_WRITE( psz_object );
572 CE_WRITE( ppsz_type[i_type] );
574 CE_WRITE( p_item->psz_msg );
576 FlushFileBuffers( QUEUE.logfile );
579 int canc = vlc_savecancel ();
580 /* Send the message to stderr */
581 utf8_fprintf( stderr, "[%s%p%s] %s%s%s %s%s: %s%s%s\n",
582 priv->b_color ? GREEN : "",
583 (void *)p_item->i_object_id,
584 priv->b_color ? GRAY : "",
585 p_item->psz_header ? p_item->psz_header : "",
586 p_item->psz_header ? " " : "",
587 p_item->psz_module, psz_object,
589 priv->b_color ? ppsz_color[i_type] : "",
591 priv->b_color ? GRAY : "" );
596 vlc_restorecancel (canc);
600 static msg_context_t* GetContext(void)
602 msg_context_t *p_ctx = vlc_threadvar_get( &msg_context );
605 p_ctx = malloc( sizeof( msg_context_t ) );
608 p_ctx->psz_message = NULL;
609 vlc_threadvar_set( &msg_context, p_ctx );
614 void msg_StackDestroy (void *data)
616 msg_context_t *p_ctx = data;
618 free (p_ctx->psz_message);
622 void msg_StackSet( int i_code, const char *psz_message, ... )
625 msg_context_t *p_ctx = GetContext();
629 free( p_ctx->psz_message );
631 va_start( ap, psz_message );
632 if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
633 p_ctx->psz_message = NULL;
636 p_ctx->i_code = i_code;
639 void msg_StackAdd( const char *psz_message, ... )
643 msg_context_t *p_ctx = GetContext();
648 va_start( ap, psz_message );
649 if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
653 if( !p_ctx->psz_message )
654 p_ctx->psz_message = psz_tmp;
658 if( asprintf( &psz_new, "%s: %s", psz_tmp, p_ctx->psz_message ) == -1 )
661 free( p_ctx->psz_message );
662 p_ctx->psz_message = psz_new;
667 const char* msg_StackMsg( void )
669 msg_context_t *p_ctx = GetContext();
671 return p_ctx->psz_message;