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 config.h for output configuration.
5 *****************************************************************************
6 * Copyright (C) 1998-2002 VideoLAN
7 * $Id: messages.c,v 1.10 2002/08/26 09:12:46 sam Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
30 #include <errno.h> /* errno */
31 #include <fcntl.h> /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
32 #include <stdio.h> /* required */
33 #include <stdarg.h> /* va_list for BSD */
34 #include <stdlib.h> /* malloc() */
35 #include <string.h> /* strerror() */
40 #include <unistd.h> /* close(), write() */
43 #include "interface.h"
45 /*****************************************************************************
47 *****************************************************************************/
48 static void QueueMsg ( vlc_object_t *, int , const char *,
49 const char *, va_list );
50 static void FlushMsg ( msg_bank_t * );
51 static void PrintMsg ( vlc_object_t *, msg_item_t * );
54 static char *ConvertPrintfFormatString ( const char *psz_format );
57 /*****************************************************************************
58 * msg_Create: initialize messages interface
59 *****************************************************************************
60 * This functions has to be called before any call to other msg_* functions.
61 * It set up the locks and the message queue if it is used.
62 *****************************************************************************/
63 void __msg_Create( vlc_object_t *p_this )
65 /* Message queue initialization */
66 vlc_mutex_init( p_this, &p_this->p_vlc->msg_bank.lock );
68 p_this->p_vlc->msg_bank.b_configured = VLC_FALSE;
69 p_this->p_vlc->msg_bank.b_overflow = VLC_FALSE;
71 p_this->p_vlc->msg_bank.i_start = 0;
72 p_this->p_vlc->msg_bank.i_stop = 0;
74 p_this->p_vlc->msg_bank.i_sub = 0;
75 p_this->p_vlc->msg_bank.pp_sub = NULL;
78 /*****************************************************************************
79 * msg_Flush: flush the message queue
80 *****************************************************************************/
81 void __msg_Flush( vlc_object_t *p_this )
85 vlc_mutex_lock( &p_this->p_vlc->msg_bank.lock );
87 p_this->p_vlc->msg_bank.b_configured = VLC_TRUE;
89 for( i_index = p_this->p_vlc->msg_bank.i_start;
90 i_index != p_this->p_vlc->msg_bank.i_stop;
91 i_index = (i_index+1) % VLC_MSG_QSIZE )
93 PrintMsg( p_this, &p_this->p_vlc->msg_bank.msg[i_index] );
96 FlushMsg( &p_this->p_vlc->msg_bank );
98 vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
101 /*****************************************************************************
102 * msg_Destroy: free resources allocated by msg_Create
103 *****************************************************************************
104 * This functions prints all messages remaining in queue, then free all the
105 * resources allocated by msg_Create.
106 * No other messages interface functions should be called after this one.
107 *****************************************************************************/
108 void __msg_Destroy( vlc_object_t *p_this )
110 if( p_this->p_vlc->msg_bank.i_sub )
112 msg_Err( p_this, "stale interface subscribers" );
115 /* Flush the queue */
116 if( !p_this->p_vlc->msg_bank.b_configured )
122 FlushMsg( &p_this->p_vlc->msg_bank );
126 vlc_mutex_destroy( &p_this->p_vlc->msg_bank.lock );
129 /*****************************************************************************
130 * msg_Subscribe: subscribe to the message queue.
131 *****************************************************************************/
132 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
134 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
136 vlc_mutex_lock( &p_this->p_vlc->msg_bank.lock );
138 /* Add subscription to the list */
139 p_this->p_vlc->msg_bank.i_sub++;
140 p_this->p_vlc->msg_bank.pp_sub = realloc( p_this->p_vlc->msg_bank.pp_sub,
141 p_this->p_vlc->msg_bank.i_sub * sizeof( msg_subscription_t* ) );
143 p_this->p_vlc->msg_bank.pp_sub[ p_this->p_vlc->msg_bank.i_sub - 1 ] = p_sub;
145 p_sub->i_start = p_this->p_vlc->msg_bank.i_start;
146 p_sub->pi_stop = &p_this->p_vlc->msg_bank.i_stop;
148 p_sub->p_msg = p_this->p_vlc->msg_bank.msg;
149 p_sub->p_lock = &p_this->p_vlc->msg_bank.lock;
151 vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
156 /*****************************************************************************
157 * msg_Unsubscribe: unsubscribe from the message queue.
158 *****************************************************************************/
159 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
163 vlc_mutex_lock( &p_this->p_vlc->msg_bank.lock );
166 if( !p_this->p_vlc->msg_bank.i_sub )
168 msg_Err( p_this, "no subscriber in the list" );
172 /* Look for the appropriate subscription */
173 for( i_index = 0; i_index < p_this->p_vlc->msg_bank.i_sub; i_index++ )
175 if( p_this->p_vlc->msg_bank.pp_sub[ i_index ] == p_sub )
181 if( p_this->p_vlc->msg_bank.pp_sub[ i_index ] != p_sub )
183 msg_Err( p_this, "subscriber not found" );
184 vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
188 /* Remove this subscription */
189 for( ; i_index < (p_this->p_vlc->msg_bank.i_sub - 1); i_index++ )
191 p_this->p_vlc->msg_bank.pp_sub[ i_index ] = p_this->p_vlc->msg_bank.pp_sub[ i_index+1 ];
194 p_this->p_vlc->msg_bank.i_sub--;
195 if( p_this->p_vlc->msg_bank.i_sub )
197 p_this->p_vlc->msg_bank.pp_sub = realloc( p_this->p_vlc->msg_bank.pp_sub,
198 p_this->p_vlc->msg_bank.i_sub * sizeof( msg_subscription_t* ) );
202 free( p_this->p_vlc->msg_bank.pp_sub );
203 p_this->p_vlc->msg_bank.pp_sub = NULL;
207 vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
210 /*****************************************************************************
211 * __msg_*: print a message
212 *****************************************************************************
213 * These functions queue a message for later printing.
214 *****************************************************************************/
215 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
216 const char *psz_format, ... )
220 va_start( args, psz_format );
221 QueueMsg( p_this, i_type, psz_module, psz_format, args );
225 /* Generic functions used when variadic macros are not available. */
226 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
227 void FN_NAME( void *p_this, const char *psz_format, ... ) \
230 va_start( args, psz_format ); \
231 QueueMsg( (vlc_object_t *)p_this, FN_TYPE, "unknown", \
232 psz_format, args ); \
237 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
238 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
239 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
240 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
242 /*****************************************************************************
243 * QueueMsg: add a message to a queue
244 *****************************************************************************
245 * This function provides basic functionnalities to other msg_* functions.
246 * It adds a message to a queue (after having printed all stored messages if it
247 * is full). If the message can't be converted to string in memory, it issues
249 *****************************************************************************/
250 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
251 const char *psz_format, va_list args )
253 msg_bank_t * p_bank = &p_this->p_vlc->msg_bank; /* message bank */
254 char * psz_str = NULL; /* formatted message string */
255 msg_item_t * p_item = NULL; /* pointer to message */
256 msg_item_t item; /* message in case of a full queue */
260 #ifndef HAVE_VASPRINTF
261 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
265 * Convert message to string
267 #ifdef HAVE_VASPRINTF
268 vasprintf( &psz_str, psz_format, args );
270 psz_str = (char*) malloc( i_size * sizeof(char) );
273 if( psz_str == NULL )
275 fprintf( stderr, "main warning: can't store message (%s): ",
277 vfprintf( stderr, psz_format, args );
278 fprintf( stderr, "\n" );
282 #ifndef HAVE_VASPRINTF
284 psz_temp = ConvertPrintfFormatString( psz_format );
287 fprintf( stderr, "main warning: couldn't print message\n" );
290 vsnprintf( psz_str, i_size, psz_temp, args );
293 vsnprintf( psz_str, i_size, psz_format, args );
295 psz_str[ i_size - 1 ] = 0; /* Just in case */
298 /* Put message in queue */
299 vlc_mutex_lock( &p_bank->lock );
301 /* Check there is room in the queue for our message */
302 if( p_bank->b_overflow )
304 FlushMsg( &p_this->p_vlc->msg_bank );
306 if( ((p_bank->i_stop - p_bank->i_start + 1) % VLC_MSG_QSIZE) == 0 )
308 /* Still in overflow mode, print from a dummy item */
313 /* Pheeew, at last, there is room in the queue! */
314 p_bank->b_overflow = VLC_FALSE;
317 else if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
319 FlushMsg( &p_this->p_vlc->msg_bank );
321 if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
323 p_bank->b_overflow = VLC_TRUE;
325 /* Put the overflow message in the queue */
326 p_item = p_bank->msg + p_bank->i_stop;
327 p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
329 p_item->i_type = VLC_MSG_ERR;
330 p_item->i_object_id = p_this->i_object_id;
331 p_item->i_object_type = p_this->i_object_type;
332 p_item->psz_module = strdup( "message" );
333 p_item->psz_msg = strdup( "message queue overflowed" );
335 PrintMsg( p_this, p_item );
337 /* We print from a dummy item */
342 if( !p_bank->b_overflow )
344 /* Put the message in the queue */
345 p_item = p_bank->msg + p_bank->i_stop;
346 p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
349 /* Fill message information fields */
350 p_item->i_type = i_type;
351 p_item->i_object_id = p_this->i_object_id;
352 p_item->i_object_type = p_this->i_object_type;
353 p_item->psz_module = strdup( psz_module );
354 p_item->psz_msg = psz_str;
356 PrintMsg( p_this, p_item );
358 if( p_bank->b_overflow )
360 free( p_item->psz_module );
361 free( p_item->psz_msg );
364 vlc_mutex_unlock( &p_bank->lock );
367 /* following functions are local */
369 /*****************************************************************************
371 *****************************************************************************
372 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
373 * this function does not check the lock.
374 *****************************************************************************/
375 static void FlushMsg ( msg_bank_t *p_bank )
377 int i_index, i_start, i_stop;
379 /* Only flush the queue if it has been properly configured */
380 if( !p_bank->b_configured )
385 /* Get the maximum message index that can be freed */
386 i_stop = p_bank->i_stop;
388 /* Check until which value we can free messages */
389 for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
391 i_start = p_bank->pp_sub[ i_index ]->i_start;
393 /* If this subscriber is late, we don't free messages before
394 * his i_start value, otherwise he'll miss messages */
395 if( ( i_start < i_stop
396 && (p_bank->i_stop <= i_start || i_stop <= p_bank->i_stop) )
397 || ( i_stop < i_start
398 && (i_stop <= p_bank->i_stop && p_bank->i_stop <= i_start) ) )
404 /* Free message data */
405 for( i_index = p_bank->i_start;
407 i_index = (i_index+1) % VLC_MSG_QSIZE )
409 free( p_bank->msg[i_index].psz_msg );
410 free( p_bank->msg[i_index].psz_module );
413 /* Update the new start value */
414 p_bank->i_start = i_index;
417 /*****************************************************************************
418 * PrintMsg: output a message item to stderr
419 *****************************************************************************
420 * Print a message to stderr, with colour formatting if needed.
421 *****************************************************************************/
422 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
424 # define COL(x) "\033[" #x ";1m"
426 # define GREEN COL(32)
427 # define YELLOW COL(33)
428 # define WHITE COL(37)
429 # define GRAY "\033[0m"
431 static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
432 static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
433 char *psz_object = "private";
434 int i_type = p_item->i_type;
436 if( p_this->p_vlc->b_quiet || !p_this->p_vlc->msg_bank.b_configured )
441 if( !p_this->p_vlc->b_verbose &&
442 ( (i_type == VLC_MSG_WARN) || (i_type == VLC_MSG_DBG) ) )
447 switch( p_item->i_object_type )
449 case VLC_OBJECT_ROOT: psz_object = "root"; break;
450 case VLC_OBJECT_MODULE: psz_object = "module"; break;
451 case VLC_OBJECT_INTF: psz_object = "interface"; break;
452 case VLC_OBJECT_PLAYLIST: psz_object = "playlist"; break;
453 case VLC_OBJECT_ITEM: psz_object = "item"; break;
454 case VLC_OBJECT_INPUT: psz_object = "input"; break;
455 case VLC_OBJECT_DECODER: psz_object = "decoder"; break;
456 case VLC_OBJECT_VOUT: psz_object = "video output"; break;
457 case VLC_OBJECT_AOUT: psz_object = "audio output"; break;
458 case VLC_OBJECT_SOUT: psz_object = "stream output"; break;
461 /* Send the message to stderr */
462 if( p_this->p_vlc->b_color )
464 fprintf( stderr, "[" GREEN "%.2x" GRAY ":" GREEN "%.6x" GRAY "] "
465 "%s %s%s: %s%s" GRAY "\n", p_this->p_vlc->i_instance,
466 p_item->i_object_id, p_item->psz_module, psz_object,
467 ppsz_type[i_type], ppsz_color[i_type],
472 fprintf( stderr, "[%.2x:%.6x] %s %s%s: %s\n",
473 p_this->p_vlc->i_instance, p_item->i_object_id,
474 p_item->psz_module, psz_object, ppsz_type[i_type],
479 /*****************************************************************************
480 * ConvertPrintfFormatString: replace all occurrences of %ll with %I64 in the
481 * printf format string.
482 *****************************************************************************
483 * Win32 doesn't recognize the "%ll" format in a printf string, so we have
484 * to convert this string to something that win32 can handle.
485 * This is a REALLY UGLY HACK which won't even work in every situation,
486 * but hey I don't want to put an ifdef WIN32 each time I use printf with
487 * a "long long" type!!!
488 * By the way, if we don't do this we can sometimes end up with segfaults.
489 *****************************************************************************/
491 static char *ConvertPrintfFormatString( const char *psz_format )
493 int i, i_counter=0, i_pos=0;
496 /* We first need to check how many occurences of %ll there are in the
497 * psz_format string. Once we'll know that we'll be able to malloc the
498 * destination string */
500 if( strlen( psz_format ) <= 3 )
501 return strdup( psz_format );
503 for( i=0; i <= (strlen(psz_format) - 3); i++ )
505 if( !strncmp( (char *)(psz_format + i), "%ll", 3 ) )
511 /* malloc the destination string */
512 psz_dest = malloc( strlen(psz_format) + i_counter + 1 );
513 if( psz_dest == NULL )
515 fprintf( stderr, "main warning: ConvertPrintfFormatString failed\n" );
519 /* Now build the modified string */
521 for( i=0; i <= (strlen(psz_format) - 3); i++ )
523 if( !strncmp( (char *)(psz_format + i), "%ll", 3 ) )
525 memcpy( psz_dest+i_pos+i_counter, psz_format+i_pos, i-i_pos+1);
526 *(psz_dest+i+i_counter+1)='I';
527 *(psz_dest+i+i_counter+2)='6';
528 *(psz_dest+i+i_counter+3)='4';
533 strcpy( psz_dest+i_pos+i_counter, psz_format+i_pos );