src/misc/messages.c

   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.34 2003/06/24 13:33:49 sam Exp $
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *          Samuel Hocevar <sam@zoy.org>
  11  *
  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.
  16  *
  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.
  21  *
  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  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include <stdio.h>                                               /* required */
  31 #include <stdarg.h>                                       /* va_list for BSD */
  32 #include <stdlib.h>                                              /* malloc() */
  33 #include <string.h>                                            /* strerror() */
  34
  35 #include <vlc/vlc.h>
  36
  37 #ifdef HAVE_FCNTL_H
  38 #   include <fcntl.h>                  /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
  39 #endif
  40
  41 #ifdef HAVE_ERRNO_H
  42 #   include <errno.h>                                               /* errno */
  43 #endif
  44
  45 #ifdef HAVE_UNISTD_H
  46 #   include <unistd.h>                                   /* close(), write() */
  47 #endif
  48
  49 #include "vlc_interface.h"
  50
  51 /*****************************************************************************
  52  * Local macros
  53  *****************************************************************************/
  54 #if defined(HAVE_VA_COPY)
  55 #   define vlc_va_copy(dest,src) va_copy(dest,src)
  56 #elif defined(HAVE___VA_COPY)
  57 #   define vlc_va_copy(dest,src) __va_copy(dest,src)
  58 #else
  59 #   define vlc_va_copy(dest,src) (dest)=(src)
  60 #endif
  61
  62 /*****************************************************************************
  63  * Local prototypes
  64  *****************************************************************************/
  65 static void QueueMsg ( vlc_object_t *, int , const char *,
  66                        const char *, va_list );
  67 static void FlushMsg ( msg_bank_t * );
  68 static void PrintMsg ( vlc_object_t *, msg_item_t * );
  69
  70 /*****************************************************************************
  71  * msg_Create: initialize messages interface
  72  *****************************************************************************
  73  * This functions has to be called before any call to other msg_* functions.
  74  * It set up the locks and the message queue if it is used.
  75  *****************************************************************************/
  76 void __msg_Create( vlc_object_t *p_this )
  77 {
  78     /* Message queue initialization */
  79     vlc_mutex_init( p_this, &p_this->p_libvlc->msg_bank.lock );
  80
  81     p_this->p_libvlc->msg_bank.b_configured = VLC_FALSE;
  82     p_this->p_libvlc->msg_bank.b_overflow = VLC_FALSE;
  83
  84     p_this->p_libvlc->msg_bank.i_start = 0;
  85     p_this->p_libvlc->msg_bank.i_stop = 0;
  86
  87     p_this->p_libvlc->msg_bank.i_sub = 0;
  88     p_this->p_libvlc->msg_bank.pp_sub = NULL;
  89
  90 #ifdef UNDER_CE
  91     p_this->p_libvlc->msg_bank.logfile =
  92         CreateFile( L"vlc-log.txt", GENERIC_WRITE,
  93                     FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
  94                     CREATE_ALWAYS, 0, NULL );
  95     SetFilePointer( p_this->p_libvlc->msg_bank.logfile, 0, NULL, FILE_END );
  96 #endif
  97 }
  98
  99 /*****************************************************************************
 100  * msg_Flush: flush the message queue
 101  *****************************************************************************/
 102 void __msg_Flush( vlc_object_t *p_this )
 103 {
 104     int i_index;
 105
 106     vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
 107
 108     p_this->p_libvlc->msg_bank.b_configured = VLC_TRUE;
 109
 110     for( i_index = p_this->p_libvlc->msg_bank.i_start;
 111          i_index != p_this->p_libvlc->msg_bank.i_stop;
 112          i_index = (i_index+1) % VLC_MSG_QSIZE )
 113     {
 114         PrintMsg( p_this, &p_this->p_libvlc->msg_bank.msg[i_index] );
 115     }
 116
 117     FlushMsg( &p_this->p_libvlc->msg_bank );
 118
 119     vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
 120 }
 121
 122 /*****************************************************************************
 123  * msg_Destroy: free resources allocated by msg_Create
 124  *****************************************************************************
 125  * This functions prints all messages remaining in queue, then free all the
 126  * resources allocated by msg_Create.
 127  * No other messages interface functions should be called after this one.
 128  *****************************************************************************/
 129 void __msg_Destroy( vlc_object_t *p_this )
 130 {
 131     if( p_this->p_libvlc->msg_bank.i_sub )
 132     {
 133         msg_Err( p_this, "stale interface subscribers" );
 134     }
 135
 136     /* Flush the queue */
 137     if( !p_this->p_libvlc->msg_bank.b_configured )
 138     {
 139         msg_Flush( p_this );
 140     }
 141     else
 142     {
 143         FlushMsg( &p_this->p_libvlc->msg_bank );
 144     }
 145
 146 #ifdef UNDER_CE
 147     CloseHandle( p_this->p_libvlc->msg_bank.logfile );
 148 #endif
 149
 150     /* Destroy lock */
 151     vlc_mutex_destroy( &p_this->p_libvlc->msg_bank.lock );
 152 }
 153
 154 /*****************************************************************************
 155  * msg_Subscribe: subscribe to the message queue.
 156  *****************************************************************************/
 157 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
 158 {
 159     msg_bank_t *p_bank = &p_this->p_libvlc->msg_bank;
 160     msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
 161
 162     vlc_mutex_lock( &p_bank->lock );
 163
 164     /* Add subscription to the list */
 165     INSERT_ELEM( p_bank->pp_sub, p_bank->i_sub, p_bank->i_sub, p_sub );
 166
 167     p_sub->i_start = p_bank->i_start;
 168     p_sub->pi_stop = &p_bank->i_stop;
 169
 170     p_sub->p_msg   = p_bank->msg;
 171     p_sub->p_lock  = &p_bank->lock;
 172
 173     vlc_mutex_unlock( &p_bank->lock );
 174
 175     return p_sub;
 176 }
 177
 178 /*****************************************************************************
 179  * msg_Unsubscribe: unsubscribe from the message queue.
 180  *****************************************************************************/
 181 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
 182 {
 183     msg_bank_t *p_bank = &p_this->p_libvlc->msg_bank;
 184     int i_index;
 185
 186     vlc_mutex_lock( &p_bank->lock );
 187
 188     /* Sanity check */
 189     if( !p_bank->i_sub )
 190     {
 191         msg_Err( p_this, "no subscriber in the list" );
 192         return;
 193     }
 194
 195     /* Look for the appropriate subscription */
 196     for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
 197     {
 198         if( p_bank->pp_sub[ i_index ] == p_sub )
 199         {
 200             break;
 201         }
 202     }
 203
 204     if( p_bank->pp_sub[ i_index ] != p_sub )
 205     {
 206         msg_Err( p_this, "subscriber not found" );
 207         vlc_mutex_unlock( &p_bank->lock );
 208         return;
 209     }
 210
 211     /* Remove this subscription */
 212     REMOVE_ELEM( p_bank->pp_sub, p_bank->i_sub, i_index );
 213
 214     vlc_mutex_unlock( &p_bank->lock );
 215 }
 216
 217 /*****************************************************************************
 218  * __msg_*: print a message
 219  *****************************************************************************
 220  * These functions queue a message for later printing.
 221  *****************************************************************************/
 222 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
 223                     const char *psz_format, ... )
 224 {
 225     va_list args;
 226
 227     va_start( args, psz_format );
 228     QueueMsg( p_this, i_type, psz_module, psz_format, args );
 229     va_end( args );
 230 }
 231
 232 /* Generic functions used when variadic macros are not available. */
 233 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
 234     void FN_NAME( void *p_this, const char *psz_format, ... ) \
 235     { \
 236         va_list args; \
 237         va_start( args, psz_format ); \
 238         QueueMsg( (vlc_object_t *)p_this, FN_TYPE, "unknown", \
 239                   psz_format, args ); \
 240         va_end( args ); \
 241     } \
 242     struct _
 243
 244 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
 245 DECLARE_MSG_FN( __msg_Err,  VLC_MSG_ERR );
 246 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
 247 DECLARE_MSG_FN( __msg_Dbg,  VLC_MSG_DBG );
 248
 249 /*****************************************************************************
 250  * QueueMsg: add a message to a queue
 251  *****************************************************************************
 252  * This function provides basic functionnalities to other msg_* functions.
 253  * It adds a message to a queue (after having printed all stored messages if it
 254  * is full). If the message can't be converted to string in memory, it issues
 255  * a warning.
 256  *****************************************************************************/
 257 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
 258                       const char *psz_format, va_list _args )
 259 {
 260     msg_bank_t * p_bank = &p_this->p_libvlc->msg_bank;       /* message bank */
 261     char *       psz_str = NULL;                 /* formatted message string */
 262     va_list      args;
 263     msg_item_t * p_item = NULL;                        /* pointer to message */
 264     msg_item_t   item;                    /* message in case of a full queue */
 265
 266 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 267     int          i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
 268 #endif
 269
 270     /*
 271      * Convert message to string
 272      */
 273 #if defined(HAVE_VASPRINTF) && !defined(SYS_DARWIN) && !defined( SYS_BEOS )
 274     vlc_va_copy( args, _args );
 275     vasprintf( &psz_str, psz_format, args );
 276     va_end( args );
 277 #else
 278     psz_str = (char*) malloc( i_size * sizeof(char) );
 279 #endif
 280
 281     if( psz_str == NULL )
 282     {
 283 #ifdef HAVE_ERRNO_H
 284         fprintf( stderr, "main warning: can't store message (%s): ",
 285                  strerror(errno) );
 286 #else
 287         fprintf( stderr, "main warning: can't store message: " );
 288 #endif
 289         vlc_va_copy( args, _args );
 290         vfprintf( stderr, psz_format, args );
 291         va_end( args );
 292         fprintf( stderr, "\n" );
 293         return;
 294     }
 295
 296 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 297     vlc_va_copy( args, _args );
 298     vsnprintf( psz_str, i_size, psz_format, args );
 299     va_end( args );
 300     psz_str[ i_size - 1 ] = 0; /* Just in case */
 301 #endif
 302
 303     /* Put message in queue */
 304     vlc_mutex_lock( &p_bank->lock );
 305
 306     /* Check there is room in the queue for our message */
 307     if( p_bank->b_overflow )
 308     {
 309         FlushMsg( p_bank );
 310
 311         if( ((p_bank->i_stop - p_bank->i_start + 1) % VLC_MSG_QSIZE) == 0 )
 312         {
 313             /* Still in overflow mode, print from a dummy item */
 314             p_item = &item;
 315         }
 316         else
 317         {
 318             /* Pheeew, at last, there is room in the queue! */
 319             p_bank->b_overflow = VLC_FALSE;
 320         }
 321     }
 322     else if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
 323     {
 324         FlushMsg( p_bank );
 325
 326         if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
 327         {
 328             p_bank->b_overflow = VLC_TRUE;
 329
 330             /* Put the overflow message in the queue */
 331             p_item = p_bank->msg + p_bank->i_stop;
 332             p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
 333
 334             p_item->i_type =        VLC_MSG_WARN;
 335             p_item->i_object_id =   p_this->i_object_id;
 336             p_item->i_object_type = p_this->i_object_type;
 337             p_item->psz_module =    strdup( "message" );
 338             p_item->psz_msg =       strdup( "message queue overflowed" );
 339
 340             PrintMsg( p_this, p_item );
 341
 342             /* We print from a dummy item */
 343             p_item = &item;
 344         }
 345     }
 346
 347     if( !p_bank->b_overflow )
 348     {
 349         /* Put the message in the queue */
 350         p_item = p_bank->msg + p_bank->i_stop;
 351         p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
 352     }
 353
 354     /* Fill message information fields */
 355     p_item->i_type =        i_type;
 356     p_item->i_object_id =   p_this->i_object_id;
 357     p_item->i_object_type = p_this->i_object_type;
 358     p_item->psz_module =    strdup( psz_module );
 359     p_item->psz_msg =       psz_str;
 360
 361     PrintMsg( p_this, p_item );
 362
 363     if( p_bank->b_overflow )
 364     {
 365         free( p_item->psz_module );
 366         free( p_item->psz_msg );
 367     }
 368
 369     vlc_mutex_unlock( &p_bank->lock );
 370 }
 371
 372 /* following functions are local */
 373
 374 /*****************************************************************************
 375  * FlushMsg
 376  *****************************************************************************
 377  * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
 378  * this function does not check the lock.
 379  *****************************************************************************/
 380 static void FlushMsg ( msg_bank_t *p_bank )
 381 {
 382     int i_index, i_start, i_stop;
 383
 384     /* Only flush the queue if it has been properly configured */
 385     if( !p_bank->b_configured )
 386     {
 387         return;
 388     }
 389
 390     /* Get the maximum message index that can be freed */
 391     i_stop = p_bank->i_stop;
 392
 393     /* Check until which value we can free messages */
 394     for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
 395     {
 396         i_start = p_bank->pp_sub[ i_index ]->i_start;
 397
 398         /* If this subscriber is late, we don't free messages before
 399          * his i_start value, otherwise he'll miss messages */
 400         if(   ( i_start < i_stop
 401                && (p_bank->i_stop <= i_start || i_stop <= p_bank->i_stop) )
 402            || ( i_stop < i_start
 403                && (i_stop <= p_bank->i_stop && p_bank->i_stop <= i_start) ) )
 404         {
 405             i_stop = i_start;
 406         }
 407     }
 408
 409     /* Free message data */
 410     for( i_index = p_bank->i_start;
 411          i_index != i_stop;
 412          i_index = (i_index+1) % VLC_MSG_QSIZE )
 413     {
 414         free( p_bank->msg[i_index].psz_msg );
 415         free( p_bank->msg[i_index].psz_module );
 416     }
 417
 418     /* Update the new start value */
 419     p_bank->i_start = i_index;
 420 }
 421
 422 /*****************************************************************************
 423  * PrintMsg: output a message item to stderr
 424  *****************************************************************************
 425  * Print a message to stderr, with colour formatting if needed.
 426  *****************************************************************************/
 427 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
 428 {
 429 #   define COL(x)  "\033[" #x ";1m"
 430 #   define RED     COL(31)
 431 #   define GREEN   COL(32)
 432 #   define YELLOW  COL(33)
 433 #   define WHITE   COL(37)
 434 #   define GRAY    "\033[0m"
 435
 436 #ifdef UNDER_CE
 437     int i_dummy;
 438 #endif
 439     static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
 440     static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
 441     char *psz_object = "private";
 442     int i_type = p_item->i_type;
 443
 444     switch( i_type )
 445     {
 446         case VLC_MSG_ERR:
 447             if( p_this->p_libvlc->i_verbose < 0 ) return;
 448             break;
 449         case VLC_MSG_INFO:
 450             if( p_this->p_libvlc->i_verbose < 0 ) return;
 451             break;
 452         case VLC_MSG_WARN:
 453             if( p_this->p_libvlc->i_verbose < 1 ) return;
 454             break;
 455         case VLC_MSG_DBG:
 456             if( p_this->p_libvlc->i_verbose < 2 ) return;
 457             break;
 458     }
 459
 460     switch( p_item->i_object_type )
 461     {
 462         case VLC_OBJECT_ROOT: psz_object = "root"; break;
 463         case VLC_OBJECT_VLC: psz_object = "vlc"; break;
 464         case VLC_OBJECT_MODULE: psz_object = "module"; break;
 465         case VLC_OBJECT_INTF: psz_object = "interface"; break;
 466         case VLC_OBJECT_PLAYLIST: psz_object = "playlist"; break;
 467         case VLC_OBJECT_ITEM: psz_object = "item"; break;
 468         case VLC_OBJECT_INPUT: psz_object = "input"; break;
 469         case VLC_OBJECT_DECODER: psz_object = "decoder"; break;
 470         case VLC_OBJECT_VOUT: psz_object = "video output"; break;
 471         case VLC_OBJECT_AOUT: psz_object = "audio output"; break;
 472         case VLC_OBJECT_SOUT: psz_object = "stream output"; break;
 473     }
 474
 475 #ifdef UNDER_CE
 476 #   define CE_WRITE(str) WriteFile( p_this->p_libvlc->msg_bank.logfile, \
 477                                     str, strlen(str), &i_dummy, NULL );
 478     CE_WRITE( p_item->psz_module );
 479     CE_WRITE( " " );
 480     CE_WRITE( psz_object );
 481     CE_WRITE( ppsz_type[i_type] );
 482     CE_WRITE( ": " );
 483     CE_WRITE( p_item->psz_msg );
 484     CE_WRITE( "\r\n" );
 485     FlushFileBuffers( p_this->p_libvlc->msg_bank.logfile );
 486
 487 #else
 488     /* Send the message to stderr */
 489     if( p_this->p_libvlc->b_color )
 490     {
 491         fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
 492                          p_item->i_object_id, p_item->psz_module, psz_object,
 493                          ppsz_type[i_type], ppsz_color[i_type],
 494                          p_item->psz_msg );
 495     }
 496     else
 497     {
 498         fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
 499                          p_item->psz_module, psz_object, ppsz_type[i_type],
 500                          p_item->psz_msg );
 501     }
 502
 503 #   if defined(WIN32)
 504     fflush( stderr );
 505 #   endif
 506 #endif
 507 }