]> git.sesse.net Git - vlc/blobdiff - src/misc/messages.c
"#if HAVE_FOO" -> "#ifdef HAVE_FOO"
[vlc] / src / misc / messages.c
index a7c096da0cb656fa9953b9e0b3064fae6824410b..906b489cb6e66eeea7022ad140fd049dd4799b1c 100644 (file)
 #include <vlc_common.h>
 
 #include <stdarg.h>                                       /* va_list for BSD */
-
-#ifdef HAVE_FCNTL_H
-#   include <fcntl.h>                  /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
+#ifdef __APPLE__
+# include <xlocale.h>
+#elif defined(HAVE_LOCALE_H)
+# include <locale.h>
 #endif
-
 #include <errno.h>                                                  /* errno */
 
 #ifdef WIN32
@@ -61,6 +61,13 @@ typedef struct
     char * psz_message;
 } msg_context_t;
 
+static void cleanup_msg_context (void *data)
+{
+    msg_context_t *ctx = data;
+    free (ctx->psz_message);
+    free (ctx);
+}
+
 static vlc_threadvar_t msg_context;
 static uintptr_t banks = 0;
 
@@ -75,50 +82,58 @@ static uintptr_t banks = 0;
 #   define vlc_va_copy(dest,src) (dest)=(src)
 #endif
 
-#define QUEUE priv->msg_bank
 static inline msg_bank_t *libvlc_bank (libvlc_int_t *inst)
 {
-    return &(libvlc_priv (inst))->msg_bank;
+    return (libvlc_priv (inst))->msg_bank;
 }
 
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
-static void QueueMsg ( vlc_object_t *, int, const char *,
-                       const char *, va_list );
 static void PrintMsg ( vlc_object_t *, msg_item_t * );
 
 static vlc_mutex_t msg_stack_lock = VLC_STATIC_MUTEX;
 
+/**
+ * Store all data required by messages interfaces.
+ */
+struct msg_bank_t
+{
+    /** Message queue lock */
+    vlc_rwlock_t lock;
+
+    /* Subscribers */
+    int i_sub;
+    msg_subscription_t **pp_sub;
+
+    locale_t locale; /**< C locale for error messages */
+    vlc_dictionary_t enabled_objects; ///< Enabled objects
+    bool all_objects_enabled; ///< Should we print all objects?
+};
+
 /**
  * Initialize messages queues
  * This function initializes all message queues
  */
-void msg_Create (libvlc_int_t *p_libvlc)
+msg_bank_t *msg_Create (void)
 {
-    libvlc_priv_t *priv = libvlc_priv (p_libvlc);
-    msg_bank_t *bank = libvlc_bank (p_libvlc);
-
-    vlc_mutex_init (&bank->lock);
-    vlc_cond_init (&bank->wait);
-    vlc_dictionary_init( &priv->msg_enabled_objects, 0 );
-    priv->msg_all_objects_enabled = true;
-
-    QUEUE.i_sub = 0;
-    QUEUE.pp_sub = NULL;
-
-#ifdef UNDER_CE
-    QUEUE.logfile =
-        CreateFile( L"vlc-log.txt", GENERIC_WRITE,
-                    FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
-                    CREATE_ALWAYS, 0, NULL );
-    SetFilePointer( QUEUE.logfile, 0, NULL, FILE_END );
-#endif
+    msg_bank_t *bank = malloc (sizeof (*bank));
+
+    vlc_rwlock_init (&bank->lock);
+    vlc_dictionary_init (&bank->enabled_objects, 0);
+    bank->all_objects_enabled = true;
+
+    bank->i_sub = 0;
+    bank->pp_sub = NULL;
+
+    /* C locale to get error messages in English in the logs */
+    bank->locale = newlocale (LC_MESSAGES_MASK, "C", (locale_t)0);
 
     vlc_mutex_lock( &msg_stack_lock );
     if( banks++ == 0 )
-        vlc_threadvar_create( &msg_context, NULL );
+        vlc_threadvar_create( &msg_context, cleanup_msg_context );
     vlc_mutex_unlock( &msg_stack_lock );
+    return bank;
 }
 
 /**
@@ -127,103 +142,68 @@ void msg_Create (libvlc_int_t *p_libvlc)
 static void const * kObjectPrintingEnabled = &kObjectPrintingEnabled;
 static void const * kObjectPrintingDisabled = &kObjectPrintingDisabled;
 
-void __msg_EnableObjectPrinting (vlc_object_t *p_this, char * psz_object)
+#undef msg_EnableObjectPrinting
+void msg_EnableObjectPrinting (vlc_object_t *obj, const char * psz_object)
 {
-    libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
-    vlc_mutex_lock( &QUEUE.lock );
+    msg_bank_t *bank = libvlc_bank (obj->p_libvlc);
+
+    vlc_rwlock_wrlock (&bank->lock);
     if( !strcmp(psz_object, "all") )
-        priv->msg_all_objects_enabled = true;
+        bank->all_objects_enabled = true;
     else
-        vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingEnabled );
-    vlc_mutex_unlock( &QUEUE.lock );
+        vlc_dictionary_insert (&bank->enabled_objects, psz_object,
+                               (void *)kObjectPrintingEnabled);
+    vlc_rwlock_unlock (&bank->lock);
 }
 
-void __msg_DisableObjectPrinting (vlc_object_t *p_this, char * psz_object)
+#undef msg_DisableObjectPrinting
+void msg_DisableObjectPrinting (vlc_object_t *obj, const char * psz_object)
 {
-    libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
-    vlc_mutex_lock( &QUEUE.lock );
+    msg_bank_t *bank = libvlc_bank (obj->p_libvlc);
+
+    vlc_rwlock_wrlock (&bank->lock);
     if( !strcmp(psz_object, "all") )
-        priv->msg_all_objects_enabled = false;
+        bank->all_objects_enabled = false;
     else
-        vlc_dictionary_insert( &priv->msg_enabled_objects, psz_object, (void *)kObjectPrintingDisabled );
-    vlc_mutex_unlock( &QUEUE.lock );
+        vlc_dictionary_insert (&bank->enabled_objects, psz_object,
+                               (void *)kObjectPrintingDisabled);
+    vlc_rwlock_unlock (&bank->lock);
 }
 
 /**
  * Destroy the message queues
  *
  * This functions prints all messages remaining in the queues,
- * then frees all the allocated ressources
+ * then frees all the allocated resources
  * No other messages interface functions should be called after this one.
  */
-void msg_Destroy (libvlc_int_t *p_libvlc)
+void msg_Destroy (msg_bank_t *bank)
 {
-    libvlc_priv_t *priv = libvlc_priv (p_libvlc);
-    msg_bank_t *bank = libvlc_bank (p_libvlc);
-
-    if( QUEUE.i_sub )
-        msg_Err( p_libvlc, "stale interface subscribers (VLC might crash)" );
+    if (unlikely(bank->i_sub != 0))
+        fputs ("stale interface subscribers (LibVLC might crash)\n", stderr);
 
     vlc_mutex_lock( &msg_stack_lock );
+    assert(banks > 0);
     if( --banks == 0 )
         vlc_threadvar_delete( &msg_context );
     vlc_mutex_unlock( &msg_stack_lock );
 
-#ifdef UNDER_CE
-    CloseHandle( QUEUE.logfile );
-#endif
+    if (bank->locale != (locale_t)0)
+       freelocale (bank->locale);
 
-    vlc_dictionary_clear( &priv->msg_enabled_objects, NULL, NULL );
+    vlc_dictionary_clear (&bank->enabled_objects, NULL, NULL);
 
-    vlc_cond_destroy (&bank->wait);
-    vlc_mutex_destroy (&bank->lock);
+    vlc_rwlock_destroy (&bank->lock);
+    free (bank);
 }
 
 struct msg_subscription_t
 {
-    vlc_thread_t    thread;
     libvlc_int_t   *instance;
     msg_callback_t  func;
     msg_cb_data_t  *opaque;
-    msg_item_t     *items[VLC_MSG_QSIZE];
-    unsigned        begin, end;
-    unsigned        overruns;
 };
 
-static void *msg_thread (void *data)
-{
-    msg_subscription_t *sub = data;
-    msg_bank_t *bank = libvlc_bank (sub->instance);
-
-    vlc_mutex_lock (&bank->lock);
-    for (;;)
-    {
-        /* Wait for messages */
-        assert (sub->begin < VLC_MSG_QSIZE);
-        assert (sub->end < VLC_MSG_QSIZE);
-        while (sub->begin != sub->end)
-        {
-            msg_item_t *msg = sub->items[sub->begin];
-            unsigned overruns = sub->overruns;
-
-            if (++sub->begin == VLC_MSG_QSIZE)
-                sub->begin = 0;
-            sub->overruns = 0;
-            vlc_mutex_unlock (&bank->lock);
-
-            sub->func (sub->opaque, msg, overruns);
-            msg_Release (msg);
-
-            vlc_mutex_lock (&bank->lock);
-        }
-
-        mutex_cleanup_push (&bank->lock);
-        vlc_cond_wait (&bank->wait, &bank->lock);
-        vlc_cleanup_pop ();
-    }
-    assert (0);
-}
-
 /**
  * Subscribe to the message queue.
  * Whenever a message is emitted, a callback will be called.
@@ -244,18 +224,11 @@ msg_subscription_t *msg_Subscribe (libvlc_int_t *instance, msg_callback_t cb,
     sub->instance = instance;
     sub->func = cb;
     sub->opaque = opaque;
-    sub->begin = sub->end = sub->overruns = 0;
-
-    if (vlc_clone (&sub->thread, msg_thread, sub, VLC_THREAD_PRIORITY_LOW))
-    {
-        free (sub);
-        return NULL;
-    }
 
     msg_bank_t *bank = libvlc_bank (instance);
-    vlc_mutex_lock (&bank->lock);
+    vlc_rwlock_wrlock (&bank->lock);
     TAB_APPEND (bank->i_sub, bank->pp_sub, sub);
-    vlc_mutex_unlock (&bank->lock);
+    vlc_rwlock_unlock (&bank->lock);
 
     return sub;
 }
@@ -268,37 +241,27 @@ void msg_Unsubscribe (msg_subscription_t *sub)
 {
     msg_bank_t *bank = libvlc_bank (sub->instance);
 
-    /* TODO: flush support? */
-    vlc_cancel (sub->thread);
-    vlc_mutex_lock (&bank->lock);
+    vlc_rwlock_wrlock (&bank->lock);
     TAB_REMOVE (bank->i_sub, bank->pp_sub, sub);
-    vlc_mutex_unlock (&bank->lock);
-
-    vlc_join (sub->thread, NULL);
+    vlc_rwlock_unlock (&bank->lock);
     free (sub);
 }
 
 /*****************************************************************************
- * __msg_*: print a message
+ * msg_*: print a message
  *****************************************************************************
  * These functions queue a message for later printing.
  *****************************************************************************/
-void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
+void msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
                     const char *psz_format, ... )
 {
     va_list args;
 
     va_start( args, psz_format );
-    QueueMsg( p_this, i_type, psz_module, psz_format, args );
+    msg_GenericVa (p_this, i_type, psz_module, psz_format, args);
     va_end( args );
 }
 
-void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
-                      const char *psz_format, va_list args )
-{
-    QueueMsg( p_this, i_type, psz_module, psz_format, args );
-}
-
 /**
  * Destroys a message.
  */
@@ -312,6 +275,7 @@ static void msg_Free (gc_object_t *gc)
     free (msg);
 }
 
+#undef msg_GenericVa
 /**
  * Add a message to a queue
  *
@@ -320,27 +284,24 @@ static void msg_Free (gc_object_t *gc)
  * is full). If the message can't be converted to string in memory, it issues
  * a warning.
  */
-static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
-                      const char *psz_format, va_list _args )
+void msg_GenericVa (vlc_object_t *p_this, int i_type,
+                           const char *psz_module,
+                           const char *psz_format, va_list _args)
 {
-    assert (p_this);
-    libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
-    int         i_header_size;             /* Size of the additionnal header */
+    size_t      i_header_size;             /* Size of the additionnal header */
     vlc_object_t *p_obj;
     char *       psz_str = NULL;                 /* formatted message string */
     char *       psz_header = NULL;
     va_list      args;
-    msg_item_t * p_item = malloc (sizeof (*p_item));
-
-    if (p_item == NULL)
-        return; /* Uho! */
 
-    vlc_gc_init (p_item, msg_Free);
-    p_item->psz_module = p_item->psz_msg = p_item->psz_header = NULL;
+    assert (p_this);
 
     if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
         (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
-        goto out;
+        return;
+
+    msg_bank_t *bank = libvlc_bank (p_this->p_libvlc);
+    locale_t locale = uselocale (bank->locale);
 
 #ifndef __GLIBC__
     /* Expand %m to strerror(errno) - only once */
@@ -427,8 +388,19 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
         va_end( args );
         fputs( "\n", stderr );
         vlc_restorecancel (canc);
-        goto out;
+        uselocale (locale);
+        return;
     }
+    uselocale (locale);
+
+    msg_item_t * p_item = malloc (sizeof (*p_item));
+    if (p_item == NULL)
+        return; /* Uho! */
+
+    vlc_gc_init (p_item, msg_Free);
+    p_item->psz_module = p_item->psz_msg = p_item->psz_header = NULL;
+
+
 
     i_header_size = 0;
     p_obj = p_this;
@@ -441,13 +413,13 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
             if( psz_header )
             {
                 psz_old = strdup( psz_header );
-                psz_header = (char*)realloc( psz_header, i_header_size );
+                psz_header = xrealloc( psz_header, i_header_size );
                 snprintf( psz_header, i_header_size , "[%s] %s",
                           p_obj->psz_header, psz_old );
             }
             else
             {
-                psz_header = (char *)malloc( i_header_size );
+                psz_header = xmalloc( i_header_size );
                 snprintf( psz_header, i_header_size, "[%s]",
                           p_obj->psz_header );
             }
@@ -456,9 +428,6 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
         p_obj = p_obj->p_parent;
     }
 
-    msg_bank_t *p_queue = &QUEUE;
-    vlc_mutex_lock( &p_queue->lock );
-
     /* Fill message information fields */
     p_item->i_type =        i_type;
     p_item->i_object_id =   (uintptr_t)p_this;
@@ -468,22 +437,14 @@ static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
     p_item->psz_header =    psz_header;
 
     PrintMsg( p_this, p_item );
-#define bank p_queue
+
+    vlc_rwlock_rdlock (&bank->lock);
     for (int i = 0; i < bank->i_sub; i++)
     {
         msg_subscription_t *sub = bank->pp_sub[i];
-        if ((sub->end + 1 - sub->begin) % VLC_MSG_QSIZE)
-        {
-            sub->items[sub->end++] = msg_Hold (p_item);
-            if (sub->end == VLC_MSG_QSIZE)
-                sub->end = 0;
-        }
-        else
-            sub->overruns++;
+        sub->func (sub->opaque, p_item, 0);
     }
-    vlc_cond_broadcast (&bank->wait);
-    vlc_mutex_unlock (&bank->lock);
-out:
+    vlc_rwlock_unlock (&bank->lock);
     msg_Release (p_item);
 }
 
@@ -501,13 +462,11 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
 #   define WHITE   COL(0)
 #   define GRAY    "\033[0m"
 
-#ifdef UNDER_CE
-    int i_dummy;
-#endif
     static const char ppsz_type[4][9] = { "", " error", " warning", " debug" };
     static const char ppsz_color[4][8] = { WHITE, RED, YELLOW, GRAY };
     const char *psz_object;
     libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
+    msg_bank_t *bank = priv->msg_bank;
     int i_type = p_item->i_type;
 
     switch( i_type )
@@ -527,38 +486,25 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
     }
 
     psz_object = p_item->psz_object_type;
-    void * val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
-                                               p_item->psz_module );
+    void * val = vlc_dictionary_value_for_key (&bank->enabled_objects,
+                                               p_item->psz_module);
     if( val == kObjectPrintingDisabled )
         return;
     if( val == kObjectPrintingEnabled )
         /* Allowed */;
     else
     {
-        val = vlc_dictionary_value_for_key( &priv->msg_enabled_objects,
-                                            psz_object );
+        val = vlc_dictionary_value_for_key (&bank->enabled_objects,
+                                            psz_object);
         if( val == kObjectPrintingDisabled )
             return;
         if( val == kObjectPrintingEnabled )
             /* Allowed */;
-        else if( !priv->msg_all_objects_enabled )
+        else if( !bank->all_objects_enabled )
             return;
     }
 
     int canc = vlc_savecancel ();
-#ifdef UNDER_CE
-#   define CE_WRITE(str) WriteFile( QUEUE.logfile, \
-                                    str, strlen(str), &i_dummy, NULL );
-    CE_WRITE( p_item->psz_module );
-    CE_WRITE( " " );
-    CE_WRITE( psz_object );
-    CE_WRITE( ppsz_type[i_type] );
-    CE_WRITE( ": " );
-    CE_WRITE( p_item->psz_msg );
-    CE_WRITE( "\r\n" );
-    FlushFileBuffers( QUEUE.logfile );
-
-#else
     /* Send the message to stderr */
     utf8_fprintf( stderr, "[%s%p%s] %s%s%s %s%s: %s%s%s\n",
                   priv->b_color ? GREEN : "",
@@ -572,33 +518,26 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
                   p_item->psz_msg,
                   priv->b_color ? GRAY : "" );
 
-#   if defined(WIN32)
+#ifdef WIN32
     fflush( stderr );
-#   endif
-    vlc_restorecancel (canc);
 #endif
+    vlc_restorecancel (canc);
 }
 
 static msg_context_t* GetContext(void)
 {
-    msg_context_t *p_ctx = vlc_threadvar_get( &msg_context );
+    msg_context_t *p_ctx = vlc_threadvar_get( msg_context );
     if( p_ctx == NULL )
     {
-        MALLOC_NULL( p_ctx, msg_context_t );
+        p_ctx = malloc( sizeof( msg_context_t ) );
+        if( !p_ctx )
+            return NULL;
         p_ctx->psz_message = NULL;
-        vlc_threadvar_set( &msg_context, p_ctx );
+        vlc_threadvar_set( msg_context, p_ctx );
     }
     return p_ctx;
 }
 
-void msg_StackDestroy (void *data)
-{
-    msg_context_t *p_ctx = data;
-
-    free (p_ctx->psz_message);
-    free (p_ctx);
-}
-
 void msg_StackSet( int i_code, const char *psz_message, ... )
 {
     va_list ap;