]> git.sesse.net Git - vlc/blobdiff - include/vlc_threads_funcs.h
Add facilities to report and enrich error messages.
[vlc] / include / vlc_threads_funcs.h
index ddc9037679af2a6a5d3e2a6533693a177ce49a1c..c81713689fc0bb99f878d2f19ed6e2f6bd5fbd2a 100644 (file)
@@ -2,8 +2,8 @@
  * vlc_threads_funcs.h : threads implementation for the VideoLAN client
  * This header provides a portable threads implementation.
  *****************************************************************************
- * Copyright (C) 1999, 2002 VideoLAN
- * $Id: vlc_threads_funcs.h,v 1.13 2003/01/22 15:16:02 massiot Exp $
+ * Copyright (C) 1999, 2002 the VideoLAN team
+ * $Id$
  *
  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
  *          Samuel Hocevar <sam@via.ecp.fr>
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
+#ifndef _VLC_THREADFUNCS_H_
+#define _VLC_THREADFUNCS_H_
+
 /*****************************************************************************
  * Function definitions
  *****************************************************************************/
 VLC_EXPORT( int,  __vlc_threads_init,  ( vlc_object_t * ) );
 VLC_EXPORT( int,  __vlc_threads_end,   ( vlc_object_t * ) );
 VLC_EXPORT( int,  __vlc_mutex_init,    ( vlc_object_t *, vlc_mutex_t * ) );
-VLC_EXPORT( int,  __vlc_mutex_destroy, ( char *, int, vlc_mutex_t * ) );
+VLC_EXPORT( int,  __vlc_mutex_destroy, ( const char *, int, vlc_mutex_t * ) );
 VLC_EXPORT( int,  __vlc_cond_init,     ( vlc_object_t *, vlc_cond_t * ) );
-VLC_EXPORT( int,  __vlc_cond_destroy,  ( char *, int, vlc_cond_t * ) );
-VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, char *, int, char *, void * ( * ) ( void * ), int, vlc_bool_t ) );
-VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, char *, int, int ) );
+VLC_EXPORT( int,  __vlc_cond_destroy,  ( const char *, int, vlc_cond_t * ) );
+VLC_EXPORT( int, __vlc_threadvar_create, (vlc_object_t *, vlc_threadvar_t * ) );
+VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( void * ), int, vlc_bool_t ) );
+VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, const char *, int, int ) );
 VLC_EXPORT( void, __vlc_thread_ready,  ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, char *, int ) );
+VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, const char *, int ) );
 
 
 /*****************************************************************************
@@ -64,16 +72,22 @@ VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, char *, int ) );
 #define vlc_mutex_lock( P_MUTEX )                                           \
     __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
 
-static inline int __vlc_mutex_lock( char * psz_file, int i_line,
+#ifdef __APPLE__
+#   define CAST_PTHREAD_TO_INT(t) (unsigned long int)(uintptr_t)(void *)t
+#else
+#   define CAST_PTHREAD_TO_INT(t) (unsigned long int)t
+#endif
+
+static inline int __vlc_mutex_lock( const char * psz_file, int i_line,
                                     vlc_mutex_t * p_mutex )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
-    i_result = pth_mutex_acquire( &p_mutex->mutex, TRUE, NULL );
+    i_result = ( pth_mutex_acquire( &p_mutex->mutex, FALSE, NULL ) == FALSE );
 
 #elif defined( ST_INIT_IN_ST_H )
     i_result = st_mutex_lock( p_mutex->mutex );
@@ -93,18 +107,6 @@ static inline int __vlc_mutex_lock( char * psz_file, int i_line,
     }
     i_result = 0;
 
-#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
-    i_result = pthread_mutex_lock( &p_mutex->mutex );
-    if ( i_result )
-    {
-        i_thread = (int)pthread_self();
-        psz_error = strerror(i_result);
-    }
-
-#elif defined( HAVE_CTHREADS_H )
-    mutex_lock( p_mutex->mutex );
-    i_result = 0;
-
 #elif defined( HAVE_KERNEL_SCHEDULER_H )
     if( p_mutex == NULL )
     {
@@ -118,12 +120,25 @@ static inline int __vlc_mutex_lock( char * psz_file, int i_line,
     {
         i_result = acquire_sem( p_mutex->lock );
     }
+
+#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+    i_result = pthread_mutex_lock( &p_mutex->mutex );
+    if ( i_result )
+    {
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
+        psz_error = strerror(i_result);
+    }
+
+#elif defined( HAVE_CTHREADS_H )
+    mutex_lock( p_mutex->mutex );
+    i_result = 0;
+
 #endif
 
     if( i_result )
     {
         msg_Err( p_mutex->p_this,
-                 "thread %d: mutex_lock failed at %s:%d (%d:%s)",
+                 "thread %li: mutex_lock failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
     return i_result;
@@ -135,16 +150,16 @@ static inline int __vlc_mutex_lock( char * psz_file, int i_line,
 #define vlc_mutex_unlock( P_MUTEX )                                         \
     __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
 
-static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
+static inline int __vlc_mutex_unlock( const char * psz_file, int i_line,
                                       vlc_mutex_t *p_mutex )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
-    i_result = pth_mutex_release( &p_mutex->mutex );
+    i_result = ( pth_mutex_release( &p_mutex->mutex ) == FALSE );
 
 #elif defined( ST_INIT_IN_ST_H )
     i_result = st_mutex_unlock( p_mutex->mutex );
@@ -164,18 +179,6 @@ static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
     }
     i_result = 0;
 
-#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
-    i_result = pthread_mutex_unlock( &p_mutex->mutex );
-    if ( i_result )
-    {
-        i_thread = (int)pthread_self();
-        psz_error = strerror(i_result);
-    }
-
-#elif defined( HAVE_CTHREADS_H )
-    mutex_unlock( p_mutex );
-    i_result = 0;
-
 #elif defined( HAVE_KERNEL_SCHEDULER_H )
     if( p_mutex == NULL )
     {
@@ -190,12 +193,25 @@ static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
         release_sem( p_mutex->lock );
         return B_OK;
     }
+
+#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+    i_result = pthread_mutex_unlock( &p_mutex->mutex );
+    if ( i_result )
+    {
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
+        psz_error = strerror(i_result);
+    }
+
+#elif defined( HAVE_CTHREADS_H )
+    mutex_unlock( p_mutex );
+    i_result = 0;
+
 #endif
 
     if( i_result )
     {
         msg_Err( p_mutex->p_this,
-                 "thread %d: mutex_unlock failed at %s:%d (%d:%s)",
+                 "thread %li: mutex_unlock failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
 
@@ -220,16 +236,16 @@ static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
 #define vlc_cond_signal( P_COND )                                           \
     __vlc_cond_signal( __FILE__, __LINE__, P_COND )
 
-static inline int __vlc_cond_signal( char * psz_file, int i_line,
+static inline int __vlc_cond_signal( const char * psz_file, int i_line,
                                      vlc_cond_t *p_condvar )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
-    i_result = pth_cond_notify( &p_condvar->cond, FALSE );
+    i_result = ( pth_cond_notify( &p_condvar->cond, FALSE ) == FALSE );
 
 #elif defined( ST_INIT_IN_ST_H )
     i_result = st_cond_signal( p_condvar->cond );
@@ -279,22 +295,6 @@ static inline int __vlc_cond_signal( char * psz_file, int i_line,
     }
     i_result = 0;
 
-#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
-    i_result = pthread_cond_signal( &p_condvar->cond );
-    if ( i_result )
-    {
-        i_thread = (int)pthread_self();
-        psz_error = strerror(i_result);
-    }
-
-#elif defined( HAVE_CTHREADS_H )
-    /* condition_signal() */
-    if ( p_condvar->queue.head || p_condvar->implications )
-    {
-        cond_signal( (condition_t)p_condvar );
-    }
-    i_result = 0;
-
 #elif defined( HAVE_KERNEL_SCHEDULER_H )
     if( p_condvar == NULL )
     {
@@ -331,105 +331,12 @@ static inline int __vlc_cond_signal( char * psz_file, int i_line,
         }
         i_result = 0;
     }
-#endif
-
-    if( i_result )
-    {
-        msg_Err( p_condvar->p_this,
-                 "thread %d: cond_signal failed at %s:%d (%d:%s)",
-                 i_thread, psz_file, i_line, i_result, psz_error );
-    }
-
-    return i_result;
-}
-
-/*****************************************************************************
- * vlc_cond_broadcast: start all threads waiting on condition completion
- *****************************************************************************/
-/*
- * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
- * Only works with pthreads, st, win32
- * You need to adapt it for others
- * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
- */
-#define vlc_cond_broadcast( P_COND )                                        \
-    __vlc_cond_broadcast( __FILE__, __LINE__, P_COND )
-
-static inline int __vlc_cond_broadcast( char * psz_file, int i_line,
-                                        vlc_cond_t *p_condvar )
-{
-    int i_result;
-    /* In case of error : */
-    int i_thread = -1;
-    const char * psz_error = "";
-
-#if defined( PTH_INIT_IN_PTH_H )
-    i_result = pth_cond_notify( &p_condvar->cond, FALSE );
-
-#elif defined( ST_INIT_IN_ST_H )
-    i_result = st_cond_broadcast( p_condvar->cond );
-
-#elif defined( UNDER_CE )
-    int i;
-
-    /* Release all waiting threads. */
-    for( i = p_condvar->i_waiting_threads; i > 0; i-- )
-    {
-        PulseEvent( p_condvar->event );
-    }
-    i_result = 0;
-
-#elif defined( WIN32 )
-    int i;
-
-    /* Release all waiting threads. */
-    if( !p_condvar->semaphore )
-    {
-        for( i = p_condvar->i_waiting_threads; i > 0; i-- )
-        {
-            PulseEvent( p_condvar->event );
-        }
-    }
-    else if( p_condvar->i_win9x_cv == 1 )
-    {
-        /* Wait for the gate to be open */
-        WaitForSingleObject( p_condvar->event, INFINITE );
-
-        if( p_condvar->i_waiting_threads )
-        {
-            /* Using a semaphore exposes us to a race condition. It is
-             * possible for another thread to start waiting on the semaphore
-             * just after we signaled it and thus steal the signal.
-             * We have to prevent new threads from entering the cond_wait(). */
-            ResetEvent( p_condvar->event );
-
-            /* A semaphore is used here because Win9x doesn't have
-             * SignalObjectAndWait() and thus a race condition exists
-             * during the time we release the mutex and the time we start
-             * waiting on the event (more precisely, the signal can sometimes
-             * be missed by the waiting thread if we use PulseEvent()). */
-            ReleaseSemaphore( p_condvar->semaphore,
-                              p_condvar->i_waiting_threads, 0 );
-        }
-    }
-    else
-    {
-        if( p_condvar->i_waiting_threads )
-        {
-            ReleaseSemaphore( p_condvar->semaphore,
-                              p_condvar->i_waiting_threads, 0 );
-
-            /* Wait for the last thread to be awakened */
-            WaitForSingleObject( p_condvar->event, INFINITE );
-        }
-    }
-    i_result = 0;
 
 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
-    i_result = pthread_cond_broadcast( &p_condvar->cond );
+    i_result = pthread_cond_signal( &p_condvar->cond );
     if ( i_result )
     {
-        i_thread = (int)pthread_self();
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
         psz_error = strerror(i_result);
     }
 
@@ -441,48 +348,12 @@ static inline int __vlc_cond_broadcast( char * psz_file, int i_line,
     }
     i_result = 0;
 
-#elif defined( HAVE_KERNEL_SCHEDULER_H )
-    if( p_condvar == NULL )
-    {
-        i_result = B_BAD_VALUE;
-    }
-    else if( p_condvar->init < 2000 )
-    {
-        i_result = B_NO_INIT;
-    }
-    else
-    {
-        while( p_condvar->thread != -1 )
-        {
-            thread_info info;
-            if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
-            {
-                return 0;
-            }
-
-            if( info.state != B_THREAD_SUSPENDED )
-            {
-                /* The  waiting thread is not suspended so it could
-                 * have been interrupted beetwen the unlock and the
-                 * suspend_thread line. That is why we sleep a little
-                 * before retesting p_condver->thread. */
-                snooze( 10000 );
-            }
-            else
-            {
-                /* Ok, we have to wake up that thread */
-                resume_thread( p_condvar->thread );
-                return 0;
-            }
-        }
-        i_result = 0;
-    }
 #endif
 
     if( i_result )
     {
         msg_Err( p_condvar->p_this,
-                 "thread %d: cond_broadcast failed at %s:%d (%d:%s)",
+                 "thread %li: cond_signal failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
 
@@ -495,16 +366,17 @@ static inline int __vlc_cond_broadcast( char * psz_file, int i_line,
 #define vlc_cond_wait( P_COND, P_MUTEX )                                     \
     __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX  )
 
-static inline int __vlc_cond_wait( char * psz_file, int i_line,
+static inline int __vlc_cond_wait( const char * psz_file, int i_line,
                                    vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
-    i_result = pth_cond_await( &p_condvar->cond, &p_mutex->mutex, NULL );
+    i_result = ( pth_cond_await( &p_condvar->cond, &p_mutex->mutex, NULL )
+                 == FALSE );
 
 #elif defined( ST_INIT_IN_ST_H )
     st_mutex_unlock( p_mutex->mutex );
@@ -598,6 +470,31 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 
     i_result = 0;
 
+#elif defined( HAVE_KERNEL_SCHEDULER_H )
+    if( p_condvar == NULL )
+    {
+        i_result = B_BAD_VALUE;
+    }
+    else if( p_mutex == NULL )
+    {
+        i_result = B_BAD_VALUE;
+    }
+    else if( p_condvar->init < 2000 )
+    {
+        i_result = B_NO_INIT;
+    }
+
+    /* The p_condvar->thread var is initialized before the unlock because
+     * it enables to identify when the thread is interrupted beetwen the
+     * unlock line and the suspend_thread line */
+    p_condvar->thread = find_thread( NULL );
+    vlc_mutex_unlock( p_mutex );
+    suspend_thread( p_condvar->thread );
+    p_condvar->thread = -1;
+
+    vlc_mutex_lock( p_mutex );
+    i_result = 0;
+
 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
 
 #   ifdef DEBUG
@@ -614,10 +511,9 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 
     if( i_result == ETIMEDOUT )
     {
-        /* People keep pissing me off with this. --Meuuh */
         msg_Dbg( p_condvar->p_this,
-                  "thread %d: secret message triggered "
-                  "at %s:%d (%s)", (int)pthread_self(),
+                  "thread %li: possible condition deadlock "
+                  "at %s:%d (%s)", CAST_PTHREAD_TO_INT(pthread_self()),
                   psz_file, i_line, strerror(i_result) );
 
         i_result = pthread_cond_wait( &p_condvar->cond, &p_mutex->mutex );
@@ -629,7 +525,7 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 
     if ( i_result )
     {
-        i_thread = (int)pthread_self();
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
         psz_error = strerror(i_result);
     }
 
@@ -637,37 +533,12 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
     condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
     i_result = 0;
 
-#elif defined( HAVE_KERNEL_SCHEDULER_H )
-    if( p_condvar == NULL )
-    {
-        i_result = B_BAD_VALUE;
-    }
-    else if( p_mutex == NULL )
-    {
-        i_result = B_BAD_VALUE;
-    }
-    else if( p_condvar->init < 2000 )
-    {
-        i_result = B_NO_INIT;
-    }
-
-    /* The p_condvar->thread var is initialized before the unlock because
-     * it enables to identify when the thread is interrupted beetwen the
-     * unlock line and the suspend_thread line */
-    p_condvar->thread = find_thread( NULL );
-    vlc_mutex_unlock( p_mutex );
-    suspend_thread( p_condvar->thread );
-    p_condvar->thread = -1;
-
-    vlc_mutex_lock( p_mutex );
-    i_result = 0;
-
 #endif
 
     if( i_result )
     {
         msg_Err( p_condvar->p_this,
-                 "thread %d: cond_wait failed at %s:%d (%d:%s)",
+                 "thread %li: cond_wait failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
 
@@ -680,6 +551,68 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 #define vlc_cond_destroy( P_COND )                                          \
     __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
 
+/*****************************************************************************
+ * vlc_threadvar_create: create a thread-local variable
+ *****************************************************************************/
+#define vlc_threadvar_create( PTHIS, P_TLS )                                 \
+   __vlc_threadvar_create( PTHIS, P_TLS )
+
+/*****************************************************************************
+ * vlc_threadvar_set: create: set the value of a thread-local variable
+ *****************************************************************************/
+static inline int vlc_threadvar_set( vlc_threadvar_t * p_tls, void *p_value )
+{
+    int i_ret;
+
+#if defined( PTH_INIT_IN_PTH_H )
+    return pth_key_setdata( p_tls->handle, p_value );
+#elif  defined( ST_INIT_IN_ST_H )
+    return st_thread_setspecific( p_tls->handle, p_value );
+#elif defined( HAVE_KERNEL_SCHEDULER_H )
+    return -1;
+
+#elif defined( UNDER_CE ) || defined( WIN32 )
+    i_ret = ( TlsSetValue( p_tls->handle, p_value ) != 0 );
+
+#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+    i_ret = pthread_setspecific( p_tls->handle, p_value );
+
+#elif defined( HAVE_CTHREADS_H )
+    i_ret = cthread_setspecific( p_tls->handle, p_value );
+#endif
+
+    return i_ret;
+}
+
+/*****************************************************************************
+ * vlc_threadvar_get: create: get the value of a thread-local variable
+ *****************************************************************************/
+static inline void* vlc_threadvar_get( vlc_threadvar_t * p_tls )
+{
+    void* p_ret;
+
+#if defined( PTH_INIT_IN_PTH_H )
+    p_ret = pth_key_getdata( p_handle->key );
+#elif defined( ST_INIT_IN_ST_H )
+    p_ret = st_thread_getspecific( p_handle->key );
+#elif defined( HAVE_KERNEL_SCHEDULER_H )
+    p_ret = NULL;
+#elif defined( UNDER_CE ) || defined( WIN32 )
+    p_ret = TlsGetValue( p_tls->handle );
+
+#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+    p_ret = pthread_getspecific( p_tls->handle );
+
+#elif defined( HAVE_CTHREADS_H )
+    if ( !cthread_getspecific( p_tls->handle, &p_ret ) )
+    {
+        p_ret = NULL;
+    }
+#endif
+
+    return p_ret;
+}
+
 /*****************************************************************************
  * vlc_thread_create: create a thread
  *****************************************************************************/
@@ -703,3 +636,5 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
  *****************************************************************************/
 #define vlc_thread_join( P_THIS )                                           \
     __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
+
+#endif