WinCE: fix cancellation safety
[vlc.git] / 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 vlc_config.h for output configuration.
5  *****************************************************************************
6  * Copyright (C) 1998-2005 the VideoLAN team
7  * $Id$
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <vlc_common.h>
36
37 #include <stdarg.h>                                       /* va_list for BSD */
38
39 #ifdef HAVE_FCNTL_H
40 #   include <fcntl.h>                  /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
41 #endif
42
43 #include <errno.h>                                                  /* errno */
44
45 #ifdef WIN32
46 #   include <vlc_network.h>          /* 'net_strerror' and 'WSAGetLastError' */
47 #endif
48
49 #ifdef HAVE_UNISTD_H
50 #   include <unistd.h>                                   /* close(), write() */
51 #endif
52
53 #include <assert.h>
54
55 #include <vlc_charset.h>
56 #include "../libvlc.h"
57
58 typedef struct
59 {
60     int i_code;
61     char * psz_message;
62 } msg_context_t;
63
64 static vlc_threadvar_t msg_context;
65 static uintptr_t banks = 0;
66
67 /*****************************************************************************
68  * Local macros
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)
74 #else
75 #   define vlc_va_copy(dest,src) (dest)=(src)
76 #endif
77
78 #define QUEUE priv->msg_bank
79 static inline msg_bank_t *libvlc_bank (libvlc_int_t *inst)
80 {
81     return &(libvlc_priv (inst))->msg_bank;
82 }
83
84 /*****************************************************************************
85  * Local prototypes
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 * );
90
91 static vlc_mutex_t msg_stack_lock = VLC_STATIC_MUTEX;
92
93 /**
94  * Initialize messages queues
95  * This function initializes all message queues
96  */
97 void msg_Create (libvlc_int_t *p_libvlc)
98 {
99     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
100     msg_bank_t *bank = libvlc_bank (p_libvlc);
101
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;
106
107     QUEUE.i_sub = 0;
108     QUEUE.pp_sub = NULL;
109
110 #ifdef UNDER_CE
111     QUEUE.logfile =
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 );
116 #endif
117
118     vlc_mutex_lock( &msg_stack_lock );
119     if( banks++ == 0 )
120         vlc_threadvar_create( &msg_context, NULL );
121     vlc_mutex_unlock( &msg_stack_lock );
122 }
123
124 /**
125  * Object Printing selection
126  */
127 static void const * kObjectPrintingEnabled = &kObjectPrintingEnabled;
128 static void const * kObjectPrintingDisabled = &kObjectPrintingDisabled;
129
130 void __msg_EnableObjectPrinting (vlc_object_t *p_this, char * psz_object)
131 {
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;
136     else
137         vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingEnabled );
138     vlc_mutex_unlock( &QUEUE.lock );
139 }
140
141 void __msg_DisableObjectPrinting (vlc_object_t *p_this, char * psz_object)
142 {
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;
147     else
148         vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingDisabled );
149     vlc_mutex_unlock( &QUEUE.lock );
150 }
151
152 /**
153  * Destroy the message queues
154  *
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.
158  */
159 void msg_Destroy (libvlc_int_t *p_libvlc)
160 {
161     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
162     msg_bank_t *bank = libvlc_bank (p_libvlc);
163
164     if( QUEUE.i_sub )
165         msg_Err( p_libvlc, "stale interface subscribers (VLC might crash)" );
166
167     vlc_mutex_lock( &msg_stack_lock );
168     if( --banks == 0 )
169         vlc_threadvar_delete( &msg_context );
170     vlc_mutex_unlock( &msg_stack_lock );
171
172 #ifdef UNDER_CE
173     CloseHandle( QUEUE.logfile );
174 #endif
175
176     vlc_dictionary_clear( &priv->msg_enabled_objects, NULL, NULL );
177
178     vlc_cond_destroy (&bank->wait);
179     vlc_mutex_destroy (&bank->lock);
180 }
181
182 struct msg_subscription_t
183 {
184     vlc_thread_t    thread;
185     libvlc_int_t   *instance;
186     msg_callback_t  func;
187     msg_cb_data_t  *opaque;
188     msg_item_t     *items[VLC_MSG_QSIZE];
189     unsigned        begin, end;
190     unsigned        overruns;
191 };
192
193 static void *msg_thread (void *data)
194 {
195     msg_subscription_t *sub = data;
196     msg_bank_t *bank = libvlc_bank (sub->instance);
197
198     vlc_mutex_lock (&bank->lock);
199     for (;;)
200     {
201         /* Wait for messages */
202         assert (sub->begin < VLC_MSG_QSIZE);
203         assert (sub->end < VLC_MSG_QSIZE);
204         while (sub->begin != sub->end)
205         {
206             msg_item_t *msg = sub->items[sub->begin];
207             unsigned overruns = sub->overruns;
208
209             if (++sub->begin == VLC_MSG_QSIZE)
210                 sub->begin = 0;
211             sub->overruns = 0;
212             vlc_mutex_unlock (&bank->lock);
213
214             sub->func (sub->opaque, msg, overruns);
215             msg_Release (msg);
216
217             vlc_mutex_lock (&bank->lock);
218         }
219
220         mutex_cleanup_push (&bank->lock);
221         vlc_cond_wait (&bank->wait, &bank->lock);
222         vlc_cleanup_pop ();
223     }
224     assert (0);
225 }
226
227 /**
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.
231  *
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
236  */
237 msg_subscription_t *msg_Subscribe (libvlc_int_t *instance, msg_callback_t cb,
238                                    msg_cb_data_t *opaque)
239 {
240     msg_subscription_t *sub = malloc (sizeof (*sub));
241     if (sub == NULL)
242         return NULL;
243
244     sub->instance = instance;
245     sub->func = cb;
246     sub->opaque = opaque;
247     sub->begin = sub->end = sub->overruns = 0;
248
249     if (vlc_clone (&sub->thread, msg_thread, sub, VLC_THREAD_PRIORITY_LOW))
250     {
251         free (sub);
252         return NULL;
253     }
254
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);
259
260     return sub;
261 }
262
263 /**
264  * Unsubscribe from the message queue.
265  * This function waits for the message callback to return if needed.
266  */
267 void msg_Unsubscribe (msg_subscription_t *sub)
268 {
269     msg_bank_t *bank = libvlc_bank (sub->instance);
270
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);
276
277     vlc_join (sub->thread, NULL);
278
279     /* Free dangling (not flushed) messages. */
280     /* NOTE: no locking, only this thread can refer to the subscription now. */
281     while (sub->begin != sub->end)
282     {
283         msg_Release (sub->items[sub->begin]);
284         if (++sub->begin == VLC_MSG_QSIZE)
285             sub->begin = 0;
286     }
287     free (sub);
288 }
289
290 /*****************************************************************************
291  * __msg_*: print a message
292  *****************************************************************************
293  * These functions queue a message for later printing.
294  *****************************************************************************/
295 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
296                     const char *psz_format, ... )
297 {
298     va_list args;
299
300     va_start( args, psz_format );
301     QueueMsg( p_this, i_type, psz_module, psz_format, args );
302     va_end( args );
303 }
304
305 void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
306                       const char *psz_format, va_list args )
307 {
308     QueueMsg( p_this, i_type, psz_module, psz_format, args );
309 }
310
311 /**
312  * Destroys a message.
313  */
314 static void msg_Free (gc_object_t *gc)
315 {
316     msg_item_t *msg = vlc_priv (gc, msg_item_t);
317
318     free (msg->psz_module);
319     free (msg->psz_msg);
320     free (msg->psz_header);
321     free (msg);
322 }
323
324 /**
325  * Add a message to a queue
326  *
327  * This function provides basic functionnalities to other msg_* functions.
328  * It adds a message to a queue (after having printed all stored messages if it
329  * is full). If the message can't be converted to string in memory, it issues
330  * a warning.
331  */
332 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
333                       const char *psz_format, va_list _args )
334 {
335     assert (p_this);
336     libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
337     int         i_header_size;             /* Size of the additionnal header */
338     vlc_object_t *p_obj;
339     char *       psz_str = NULL;                 /* formatted message string */
340     char *       psz_header = NULL;
341     va_list      args;
342
343     if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
344         (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
345         return;
346
347 #ifndef __GLIBC__
348     /* Expand %m to strerror(errno) - only once */
349     char buf[strlen( psz_format ) + 2001], *ptr;
350     strcpy( buf, psz_format );
351     ptr = (char*)buf;
352     psz_format = (const char*) buf;
353
354     for( ;; )
355     {
356         ptr = strchr( ptr, '%' );
357         if( ptr == NULL )
358             break;
359
360         if( ptr[1] == 'm' )
361         {
362             char errbuf[2001];
363             size_t errlen;
364
365 #ifndef WIN32
366             strerror_r( errno, errbuf, 1001 );
367 #else
368             int sockerr = WSAGetLastError( );
369             if( sockerr )
370             {
371                 strncpy( errbuf, net_strerror( sockerr ), 1001 );
372                 WSASetLastError( sockerr );
373             }
374             if ((sockerr == 0)
375              || (strcmp ("Unknown network stack error", errbuf) == 0))
376                 strncpy( errbuf, strerror( errno ), 1001 );
377 #endif
378             errbuf[1000] = 0;
379
380             /* Escape '%' from the error string */
381             for( char *percent = strchr( errbuf, '%' );
382                  percent != NULL;
383                  percent = strchr( percent + 2, '%' ) )
384             {
385                 memmove( percent + 1, percent, strlen( percent ) + 1 );
386             }
387
388             errlen = strlen( errbuf );
389             memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
390             memcpy( ptr, errbuf, errlen );
391             break; /* Only once, so we don't overflow */
392         }
393
394         /* Looks for conversion specifier... */
395         do
396             ptr++;
397         while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
398         if( *ptr )
399             ptr++; /* ...and skip it */
400     }
401 #endif
402
403     /* Convert message to string  */
404     vlc_va_copy( args, _args );
405     if( vasprintf( &psz_str, psz_format, args ) == -1 )
406         psz_str = NULL;
407     va_end( args );
408
409     if( psz_str == NULL )
410     {
411         int canc = vlc_savecancel (); /* Do not print half of a message... */
412 #ifdef __GLIBC__
413         fprintf( stderr, "main warning: can't store message (%m): " );
414 #else
415         char psz_err[1001];
416 #ifndef WIN32
417         /* we're not using GLIBC, so we are sure that the error description
418          * will be stored in the buffer we provide to strerror_r() */
419         strerror_r( errno, psz_err, 1001 );
420 #else
421         strncpy( psz_err, strerror( errno ), 1001 );
422 #endif
423         psz_err[1000] = '\0';
424         fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
425 #endif
426         vlc_va_copy( args, _args );
427         /* We should use utf8_vfprintf - but it calls malloc()... */
428         vfprintf( stderr, psz_format, args );
429         va_end( args );
430         fputs( "\n", stderr );
431         vlc_restorecancel (canc);
432         return;
433     }
434
435     msg_item_t * p_item = malloc (sizeof (*p_item));
436
437     if (p_item == NULL)
438         return; /* Uho! */
439
440     vlc_gc_init (p_item, msg_Free);
441     p_item->psz_module = p_item->psz_msg = p_item->psz_header = NULL;
442
443
444
445     i_header_size = 0;
446     p_obj = p_this;
447     while( p_obj != NULL )
448     {
449         char *psz_old = NULL;
450         if( p_obj->psz_header )
451         {
452             i_header_size += strlen( p_obj->psz_header ) + 4;
453             if( psz_header )
454             {
455                 psz_old = strdup( psz_header );
456                 psz_header = (char*)realloc( psz_header, i_header_size );
457                 snprintf( psz_header, i_header_size , "[%s] %s",
458                           p_obj->psz_header, psz_old );
459             }
460             else
461             {
462                 psz_header = (char *)malloc( i_header_size );
463                 snprintf( psz_header, i_header_size, "[%s]",
464                           p_obj->psz_header );
465             }
466         }
467         free( psz_old );
468         p_obj = p_obj->p_parent;
469     }
470
471     /* Fill message information fields */
472     p_item->i_type =        i_type;
473     p_item->i_object_id =   (uintptr_t)p_this;
474     p_item->psz_object_type = p_this->psz_object_type;
475     p_item->psz_module =    strdup( psz_module );
476     p_item->psz_msg =       psz_str;
477     p_item->psz_header =    psz_header;
478
479     PrintMsg( p_this, p_item );
480
481     msg_bank_t *p_queue = &QUEUE;
482     vlc_mutex_lock( &p_queue->lock );
483 #define bank p_queue
484     for (int i = 0; i < bank->i_sub; i++)
485     {
486         msg_subscription_t *sub = bank->pp_sub[i];
487         if ((sub->end + 1 - sub->begin) % VLC_MSG_QSIZE)
488         {
489             sub->items[sub->end++] = msg_Hold (p_item);
490             if (sub->end == VLC_MSG_QSIZE)
491                 sub->end = 0;
492         }
493         else
494             sub->overruns++;
495     }
496     vlc_cond_broadcast (&bank->wait);
497     vlc_mutex_unlock (&bank->lock);
498     msg_Release (p_item);
499 }
500
501 /*****************************************************************************
502  * PrintMsg: output a standard message item to stderr
503  *****************************************************************************
504  * Print a message to stderr, with colour formatting if needed.
505  *****************************************************************************/
506 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
507 {
508 #   define COL(x)  "\033[" #x ";1m"
509 #   define RED     COL(31)
510 #   define GREEN   COL(32)
511 #   define YELLOW  COL(33)
512 #   define WHITE   COL(0)
513 #   define GRAY    "\033[0m"
514
515 #ifdef UNDER_CE
516     int i_dummy;
517 #endif
518     static const char ppsz_type[4][9] = { "", " error", " warning", " debug" };
519     static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY };
520     const char *psz_object;
521     libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
522     int i_type = p_item->i_type;
523
524     switch( i_type )
525     {
526         case VLC_MSG_ERR:
527             if( priv->i_verbose < 0 ) return;
528             break;
529         case VLC_MSG_INFO:
530             if( priv->i_verbose < 0 ) return;
531             break;
532         case VLC_MSG_WARN:
533             if( priv->i_verbose < 1 ) return;
534             break;
535         case VLC_MSG_DBG:
536             if( priv->i_verbose < 2 ) return;
537             break;
538     }
539
540     psz_object = p_item->psz_object_type;
541     void * val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
542                                                p_item->psz_module );
543     if( val == kObjectPrintingDisabled )
544         return;
545     if( val == kObjectPrintingEnabled )
546         /* Allowed */;
547     else
548     {
549         val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
550                                             psz_object );
551         if( val == kObjectPrintingDisabled )
552             return;
553         if( val == kObjectPrintingEnabled )
554             /* Allowed */;
555         else if( !priv->msg_all_objects_enabled )
556             return;
557     }
558
559 #ifdef UNDER_CE
560 #   define CE_WRITE(str) WriteFile( QUEUE.logfile, \
561                                     str, strlen(str), &i_dummy, NULL );
562     CE_WRITE( p_item->psz_module );
563     CE_WRITE( " " );
564     CE_WRITE( psz_object );
565     CE_WRITE( ppsz_type[i_type] );
566     CE_WRITE( ": " );
567     CE_WRITE( p_item->psz_msg );
568     CE_WRITE( "\r\n" );
569     FlushFileBuffers( QUEUE.logfile );
570
571 #else
572     int canc = vlc_savecancel ();
573     /* Send the message to stderr */
574     utf8_fprintf( stderr, "[%s%p%s] %s%s%s %s%s: %s%s%s\n",
575                   priv->b_color ? GREEN : "",
576                   (void *)p_item->i_object_id,
577                   priv->b_color ? GRAY : "",
578                   p_item->psz_header ? p_item->psz_header : "",
579                   p_item->psz_header ? " " : "",
580                   p_item->psz_module, psz_object,
581                   ppsz_type[i_type],
582                   priv->b_color ? ppsz_color[i_type] : "",
583                   p_item->psz_msg,
584                   priv->b_color ? GRAY : "" );
585
586 #   if defined(WIN32)
587     fflush( stderr );
588 #   endif
589     vlc_restorecancel (canc);
590 #endif
591 }
592
593 static msg_context_t* GetContext(void)
594 {
595     msg_context_t *p_ctx = vlc_threadvar_get( &msg_context );
596     if( p_ctx == NULL )
597     {
598         p_ctx = malloc( sizeof( msg_context_t ) );
599         if( !p_ctx )
600             return NULL;
601         p_ctx->psz_message = NULL;
602         vlc_threadvar_set( &msg_context, p_ctx );
603     }
604     return p_ctx;
605 }
606
607 void msg_StackDestroy (void *data)
608 {
609     msg_context_t *p_ctx = data;
610
611     free (p_ctx->psz_message);
612     free (p_ctx);
613 }
614
615 void msg_StackSet( int i_code, const char *psz_message, ... )
616 {
617     va_list ap;
618     msg_context_t *p_ctx = GetContext();
619
620     if( p_ctx == NULL )
621         return;
622     free( p_ctx->psz_message );
623
624     va_start( ap, psz_message );
625     if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
626         p_ctx->psz_message = NULL;
627     va_end( ap );
628
629     p_ctx->i_code = i_code;
630 }
631
632 void msg_StackAdd( const char *psz_message, ... )
633 {
634     char *psz_tmp;
635     va_list ap;
636     msg_context_t *p_ctx = GetContext();
637
638     if( p_ctx == NULL )
639         return;
640
641     va_start( ap, psz_message );
642     if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
643         psz_tmp = NULL;
644     va_end( ap );
645
646     if( !p_ctx->psz_message )
647         p_ctx->psz_message = psz_tmp;
648     else
649     {
650         char *psz_new;
651         if( asprintf( &psz_new, "%s: %s", psz_tmp, p_ctx->psz_message ) == -1 )
652             psz_new = NULL;
653
654         free( p_ctx->psz_message );
655         p_ctx->psz_message = psz_new;
656         free( psz_tmp );
657     }
658 }
659
660 const char* msg_StackMsg( void )
661 {
662     msg_context_t *p_ctx = GetContext();
663     assert( p_ctx );
664     return p_ctx->psz_message;
665 }