X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_threads_funcs.h;h=f99ff3305a533edf50bd4b0eb0001d749ffa1cf0;hb=83aa9e53cd10f367dad1f3290be83de385db6e30;hp=aa4b6d2d48fd1a2e77fb51b3b49a1865efc66330;hpb=fbf4c8060d35617e39b50ae739307152d02ed951;p=vlc diff --git a/include/vlc_threads_funcs.h b/include/vlc_threads_funcs.h index aa4b6d2d48..f99ff3305a 100644 --- a/include/vlc_threads_funcs.h +++ b/include/vlc_threads_funcs.h @@ -2,7 +2,7 @@ * vlc_threads_funcs.h : threads implementation for the VideoLAN client * This header provides a portable threads implementation. ***************************************************************************** - * Copyright (C) 1999, 2002 the VideoLAN team + * Copyright (C) 1999-2007 the VideoLAN team * $Id$ * * Authors: Jean-Marc Dressler @@ -29,20 +29,30 @@ #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( void, vlc_threads_error, ( vlc_object_t *) ); VLC_EXPORT( int, __vlc_mutex_init, ( vlc_object_t *, vlc_mutex_t * ) ); +VLC_EXPORT( int, __vlc_mutex_init_recursive, ( vlc_object_t *, 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, ( 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 *, const char *, int ) ); +/***************************************************************************** + * vlc_threads_error: Signalize an error in the threading system + *****************************************************************************/ +#ifdef NDEBUG +# define vlc_threads_error( P_THIS ) (void)0 +#endif /***************************************************************************** * vlc_threads_init: initialize threads system @@ -62,16 +72,25 @@ VLC_EXPORT( void, __vlc_thread_join, ( vlc_object_t *, const char *, int ) ); #define vlc_mutex_init( P_THIS, P_MUTEX ) \ __vlc_mutex_init( VLC_OBJECT(P_THIS), P_MUTEX ) +/***************************************************************************** + * vlc_mutex_init: initialize a recursive mutex (Don't use it) + *****************************************************************************/ +#define vlc_mutex_init_recursive( P_THIS, P_MUTEX ) \ + __vlc_mutex_init_recursive( VLC_OBJECT(P_THIS), P_MUTEX ) + /***************************************************************************** * vlc_mutex_lock: lock a mutex *****************************************************************************/ #define vlc_mutex_lock( P_MUTEX ) \ __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX ) -#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 +#if defined(LIBVLC_USE_PTHREAD) +static inline unsigned long int CAST_PTHREAD_TO_INT (pthread_t th) +{ + union { pthread_t th; unsigned long int i; } v = { }; + v.th = th; + return v.i; +} #endif static inline int __vlc_mutex_lock( const char * psz_file, int i_line, @@ -80,15 +99,8 @@ static inline int __vlc_mutex_lock( const char * psz_file, int i_line, int i_result; /* In case of error : */ 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, FALSE, NULL ) == FALSE ); - -#elif defined( ST_INIT_IN_ST_H ) - i_result = st_mutex_lock( p_mutex->mutex ); - -#elif defined( UNDER_CE ) +#if defined( UNDER_CE ) EnterCriticalSection( &p_mutex->csection ); i_result = 0; @@ -117,29 +129,33 @@ static inline int __vlc_mutex_lock( const char * psz_file, int i_line, i_result = acquire_sem( p_mutex->lock ); } -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) +#elif defined(LIBVLC_USE_PTHREAD) +# define vlc_assert_locked( m ) \ + assert (pthread_mutex_lock (&((m)->mutex)) == EDEADLK) + i_result = pthread_mutex_lock( &p_mutex->mutex ); if ( i_result ) { i_thread = CAST_PTHREAD_TO_INT(pthread_self()); - psz_error = strerror(i_result); + errno = 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 %li: mutex_lock failed at %s:%d (%d:%s)", - i_thread, psz_file, i_line, i_result, psz_error ); + "thread %li: mutex_lock failed at %s:%d (%d:%m)", + i_thread, psz_file, i_line, i_result ); + vlc_threads_error( p_mutex->p_this ); } return i_result; } +#ifndef vlc_assert_locked +# define vlc_assert_locked( m ) (void)0 +#endif + /***************************************************************************** * vlc_mutex_unlock: unlock a mutex *****************************************************************************/ @@ -152,15 +168,8 @@ static inline int __vlc_mutex_unlock( const char * psz_file, int i_line, int i_result; /* In case of error : */ 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 ) == FALSE ); - -#elif defined( ST_INIT_IN_ST_H ) - i_result = st_mutex_unlock( p_mutex->mutex ); - -#elif defined( UNDER_CE ) +#if defined( UNDER_CE ) LeaveCriticalSection( &p_mutex->csection ); i_result = 0; @@ -190,25 +199,22 @@ static inline int __vlc_mutex_unlock( const char * psz_file, int i_line, return B_OK; } -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) +#elif defined(LIBVLC_USE_PTHREAD) i_result = pthread_mutex_unlock( &p_mutex->mutex ); if ( i_result ) { i_thread = CAST_PTHREAD_TO_INT(pthread_self()); - psz_error = strerror(i_result); + errno = 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 %li: mutex_unlock failed at %s:%d (%d:%s)", - i_thread, psz_file, i_line, i_result, psz_error ); + "thread %li: mutex_unlock failed at %s:%d (%d:%m)", + i_thread, psz_file, i_line, i_result ); + vlc_threads_error( p_mutex->p_this ); } return i_result; @@ -238,15 +244,8 @@ static inline int __vlc_cond_signal( const char * psz_file, int i_line, int i_result; /* In case of error : */ 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 ) == FALSE ); - -#elif defined( ST_INIT_IN_ST_H ) - i_result = st_cond_signal( p_condvar->cond ); -#elif defined( UNDER_CE ) +#if defined( UNDER_CE ) PulseEvent( p_condvar->event ); i_result = 0; @@ -256,6 +255,11 @@ static inline int __vlc_cond_signal( const char * psz_file, int i_line, * by a mutex. This will prevent another thread from stealing the signal */ if( !p_condvar->semaphore ) { + /* + ** PulseEvent() only works if none of the waiting threads is suspended. + ** this is particularily problematic under a debug session. + ** as documented in http://support.microsoft.com/kb/q173260/ + */ PulseEvent( p_condvar->event ); } else if( p_condvar->i_win9x_cv == 1 ) @@ -328,29 +332,22 @@ static inline int __vlc_cond_signal( const char * psz_file, int i_line, i_result = 0; } -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) +#elif defined(LIBVLC_USE_PTHREAD) i_result = pthread_cond_signal( &p_condvar->cond ); if ( i_result ) { i_thread = CAST_PTHREAD_TO_INT(pthread_self()); - psz_error = strerror(i_result); + errno = 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; - #endif if( i_result ) { msg_Err( p_condvar->p_this, - "thread %li: cond_signal failed at %s:%d (%d:%s)", - i_thread, psz_file, i_line, i_result, psz_error ); + "thread %li: cond_signal failed at %s:%d (%d:%m)", + i_thread, psz_file, i_line, i_result ); + vlc_threads_error( p_condvar->p_this ); } return i_result; @@ -368,18 +365,8 @@ static inline int __vlc_cond_wait( const char * psz_file, int i_line, int i_result; /* In case of error : */ 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 ) - == FALSE ); -#elif defined( ST_INIT_IN_ST_H ) - st_mutex_unlock( p_mutex->mutex ); - i_result = st_cond_wait( p_condvar->cond ); - st_mutex_lock( p_mutex->mutex ); - -#elif defined( UNDER_CE ) +#if defined( UNDER_CE ) p_condvar->i_waiting_threads++; LeaveCriticalSection( &p_mutex->csection ); WaitForSingleObject( p_condvar->event, INFINITE ); @@ -491,54 +478,182 @@ static inline int __vlc_cond_wait( const char * psz_file, int i_line, vlc_mutex_lock( p_mutex ); i_result = 0; -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) +#elif defined(LIBVLC_USE_PTHREAD) + i_result = pthread_cond_wait( &p_condvar->cond, &p_mutex->mutex ); + if ( i_result ) + { + i_thread = CAST_PTHREAD_TO_INT(pthread_self()); + errno = i_result; + } + +#endif -# ifdef DEBUG - /* In debug mode, timeout */ - struct timeval now; - struct timespec timeout; + if( i_result ) + { + msg_Err( p_condvar->p_this, + "thread %li: cond_wait failed at %s:%d (%d:%m)", + i_thread, psz_file, i_line, i_result ); + vlc_threads_error( p_condvar->p_this ); + } + + return i_result; +} + + +/***************************************************************************** + * vlc_cond_timedwait: wait until condition completion or expiration + ***************************************************************************** + * Returns 0 if object signaled, an error code in case of timeout or error. + *****************************************************************************/ +#define vlc_cond_timedwait( P_COND, P_MUTEX, DEADLINE ) \ + __vlc_cond_timedwait( __FILE__, __LINE__, P_COND, P_MUTEX, DEADLINE ) + +static inline int __vlc_cond_timedwait( const char * psz_file, int i_line, + vlc_cond_t *p_condvar, + vlc_mutex_t *p_mutex, + mtime_t deadline ) +{ + int i_res; + unsigned long int i_thread = 0; - gettimeofday( &now, NULL ); - timeout.tv_sec = now.tv_sec + THREAD_COND_TIMEOUT; - timeout.tv_nsec = now.tv_usec * 1000; +#if defined( UNDER_CE ) + mtime_t delay_ms = (deadline - mdate())/1000; - i_result = pthread_cond_timedwait( &p_condvar->cond, &p_mutex->mutex, - &timeout ); + DWORD result; + if( delay_ms < 0 ) + delay_ms = 0; - if( i_result == ETIMEDOUT ) + p_condvar->i_waiting_threads++; + LeaveCriticalSection( &p_mutex->csection ); + result = WaitForSingleObject( p_condvar->event, delay_ms ); + p_condvar->i_waiting_threads--; + + /* Reacquire the mutex before returning. */ + vlc_mutex_lock( p_mutex ); + + i_res = (int)result; + if(result == WAIT_TIMEOUT) + return WAIT_TIMEOUT; /* this error is perfectly normal */ + +#elif defined( WIN32 ) + DWORD result; + + mtime_t delay_ms = (deadline - mdate())/1000; + if( delay_ms < 0 ) + delay_ms = 0; + + if( !p_condvar->semaphore ) { - msg_Dbg( p_condvar->p_this, - "thread %li: probable condition deadlock " - "at %s:%d (%s)", CAST_PTHREAD_TO_INT(pthread_self()), - psz_file, i_line, strerror(i_result) ); + /* Increase our wait count */ + p_condvar->i_waiting_threads++; + + if( p_mutex->mutex ) + { + /* It is only possible to atomically release the mutex and + * initiate the waiting on WinNT/2K/XP. Win9x doesn't have + * SignalObjectAndWait(). */ + result = p_condvar->SignalObjectAndWait( p_mutex->mutex, + p_condvar->event, + delay_ms, FALSE ); + } + else + { + LeaveCriticalSection( &p_mutex->csection ); + result = WaitForSingleObject( p_condvar->event, delay_ms ); + } - i_result = pthread_cond_wait( &p_condvar->cond, &p_mutex->mutex ); + p_condvar->i_waiting_threads--; } + else if( p_condvar->i_win9x_cv == 1 ) + { + int i_waiting_threads; -# else - i_result = pthread_cond_wait( &p_condvar->cond, &p_mutex->mutex ); -# endif + /* Wait for the gate to be open */ + result = WaitForSingleObject( p_condvar->event, delay_ms ); - if ( i_result ) + /* Increase our wait count */ + p_condvar->i_waiting_threads++; + + LeaveCriticalSection( &p_mutex->csection ); + if( !result ) + { + /* recaculate remaining delay */ + delay_ms = (deadline - mdate())/1000; + if( delay_ms < 0 ) + delay_ms = 0; + + result = WaitForSingleObject( p_condvar->semaphore, delay_ms ); + } + + /* Decrement and test must be atomic */ + EnterCriticalSection( &p_condvar->csection ); + + /* Decrease our wait count */ + i_waiting_threads = --p_condvar->i_waiting_threads; + + LeaveCriticalSection( &p_condvar->csection ); + + /* Reopen the gate if we were the last waiting thread */ + if( !i_waiting_threads ) + SetEvent( p_condvar->event ); + } + else { - i_thread = CAST_PTHREAD_TO_INT(pthread_self()); - psz_error = strerror(i_result); + int i_waiting_threads; + + /* Increase our wait count */ + p_condvar->i_waiting_threads++; + + LeaveCriticalSection( &p_mutex->csection ); + result = WaitForSingleObject( p_condvar->semaphore, delay_ms ); + + /* Decrement and test must be atomic */ + EnterCriticalSection( &p_condvar->csection ); + + /* Decrease our wait count */ + i_waiting_threads = --p_condvar->i_waiting_threads; + + LeaveCriticalSection( &p_condvar->csection ); + + /* Signal that the last waiting thread just went through */ + if( !i_waiting_threads ) + SetEvent( p_condvar->event ); } -#elif defined( HAVE_CTHREADS_H ) - condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex ); - i_result = 0; + /* Reacquire the mutex before returning. */ + vlc_mutex_lock( p_mutex ); + if(result == WAIT_TIMEOUT) + return WAIT_TIMEOUT; /* this error is perfectly normal */ + + i_res = (int)result; + +#elif defined( HAVE_KERNEL_SCHEDULER_H ) +# error Unimplemented +#elif defined(LIBVLC_USE_PTHREAD) + lldiv_t d = lldiv( deadline, 1000000 ); + struct timespec ts = { d.quot, d.rem * 1000 }; + + i_res = pthread_cond_timedwait( &p_condvar->cond, &p_mutex->mutex, &ts ); + if( i_res == ETIMEDOUT ) + return ETIMEDOUT; /* this error is perfectly normal */ + else + if ( i_res ) /* other errors = bug */ + { + i_thread = CAST_PTHREAD_TO_INT(pthread_self()); + errno = i_res; + } #endif - if( i_result ) + if( i_res ) { msg_Err( p_condvar->p_this, - "thread %li: cond_wait failed at %s:%d (%d:%s)", - i_thread, psz_file, i_line, i_result, psz_error ); + "thread %li: cond_wait failed at %s:%d (%d:%m)", + i_thread, psz_file, i_line, i_res ); + vlc_threads_error( p_condvar->p_this ); } - return i_result; + return i_res; } /***************************************************************************** @@ -547,6 +662,147 @@ static inline int __vlc_cond_wait( const 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( HAVE_KERNEL_SCHEDULER_H ) + return -1; + +#elif defined( UNDER_CE ) || defined( WIN32 ) + i_ret = ( TlsSetValue( p_tls->handle, p_value ) != 0 ); + +#elif defined(LIBVLC_USE_PTHREAD) + i_ret = pthread_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( HAVE_KERNEL_SCHEDULER_H ) + p_ret = NULL; +#elif defined( UNDER_CE ) || defined( WIN32 ) + p_ret = TlsGetValue( p_tls->handle ); + +#elif defined(LIBVLC_USE_PTHREAD) + p_ret = pthread_getspecific( p_tls->handle ); + +#endif + + return p_ret; +} + +# if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0) +typedef struct +{ + pthread_spinlock_t spin; +} vlc_spinlock_t; + +/** + * Initializes a spinlock. + */ +static inline int vlc_spin_init (vlc_spinlock_t *spin) +{ + return pthread_spin_init (&spin->spin, PTHREAD_PROCESS_PRIVATE); +} + +/** + * Acquires a spinlock. + */ +static inline int vlc_spin_lock (vlc_spinlock_t *spin) +{ + return pthread_spin_lock (&spin->spin); +} + +/** + * Releases a spinlock. + */ +static inline int vlc_spin_unlock (vlc_spinlock_t *spin) +{ + return pthread_spin_unlock (&spin->spin); +} + +/** + * Deinitializes a spinlock. + */ +static inline int vlc_spin_destroy (vlc_spinlock_t *spin) +{ + return pthread_spin_destroy (&spin->spin); +} + +#elif defined( WIN32 ) + +typedef CRITICAL_SECTION vlc_spinlock_t; + +/** + * Initializes a spinlock. + */ +static inline int vlc_spin_init (vlc_spinlock_t *spin) +{ + return !InitializeCriticalSectionAndSpinCount(spin, 4000); +} + +/** + * Acquires a spinlock. + */ +static inline int vlc_spin_lock (vlc_spinlock_t *spin) +{ + EnterCriticalSection(spin); + return 0; +} + +/** + * Releases a spinlock. + */ +static inline int vlc_spin_unlock (vlc_spinlock_t *spin) +{ + LeaveCriticalSection(spin); + return 0; +} + +/** + * Deinitializes a spinlock. + */ +static inline int vlc_spin_destroy (vlc_spinlock_t *spin) +{ + DeleteCriticalSection(spin); + return 0; +} + + +#else + + +/* Fallback to plain mutexes if spinlocks are not available */ +typedef vlc_mutex_t vlc_spinlock_t; + +static inline int vlc_spin_init (vlc_spinlock_t *spin) +{ + return __vlc_mutex_init (NULL, spin); +} + +# define vlc_spin_lock vlc_mutex_lock +# define vlc_spin_unlock vlc_mutex_unlock +# define vlc_spin_destroy vlc_mutex_destroy +#endif + /***************************************************************************** * vlc_thread_create: create a thread *****************************************************************************/ @@ -570,3 +826,5 @@ static inline int __vlc_cond_wait( const char * psz_file, int i_line, *****************************************************************************/ #define vlc_thread_join( P_THIS ) \ __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ ) + +#endif