X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_threads.h;h=ebf94e25a9c5723541a91d65f3436661ec172e42;hb=8ca057e9dbce36d4b87f0863b00c031888e4d934;hp=406405e4a20d5e6b020f2358b8207050af65fc2f;hpb=cbea1a49e6129f849d827a7cd4f5e45054d88864;p=vlc diff --git a/include/vlc_threads.h b/include/vlc_threads.h index 406405e4a2..ebf94e25a9 100644 --- a/include/vlc_threads.h +++ b/include/vlc_threads.h @@ -2,7 +2,7 @@ * vlc_threads.h : threads implementation for the VideoLAN client * This header provides portable declarations for mutexes & conditions ***************************************************************************** - * Copyright (C) 1999, 2002 the VideoLAN team + * Copyright (C) 1999, 2002 VLC authors and VideoLAN * Copyright © 2007-2008 Rémi Denis-Courmont * * Authors: Jean-Marc Dressler @@ -10,19 +10,19 @@ * Gildas Bazin * Christophe Massiot * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_THREADS_H_ @@ -35,22 +35,29 @@ */ #if defined( UNDER_CE ) - /* WinCE API */ #elif defined( WIN32 ) # include /* Win32 API */ + +#elif defined( __OS2__ ) /* OS/2 API */ # include +# define pthread_sigmask sigprocmask + #else /* pthreads (like Linux & BSD) */ # define LIBVLC_USE_PTHREAD 1 # define LIBVLC_USE_PTHREAD_CANCEL 1 # define _APPLE_C_SOURCE 1 /* Proper pthread semantics on OSX */ -# include /* lldiv_t definition (only in C99) */ # include /* _POSIX_SPIN_LOCKS */ # include - /* Needed for pthread_cond_timedwait */ -# include -# include + +/* Unnamed POSIX semaphores not supported on Mac OS X, use Mach semaphores instead */ +# if defined (__APPLE__) +# include +# include +# else +# include +# endif #endif @@ -79,15 +86,22 @@ /* Define different priorities for WinNT/2K/XP and Win9x/Me */ # define VLC_THREAD_PRIORITY_LOW 0 # define VLC_THREAD_PRIORITY_INPUT \ - (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0) + THREAD_PRIORITY_ABOVE_NORMAL # define VLC_THREAD_PRIORITY_AUDIO \ - (IS_WINNT ? THREAD_PRIORITY_HIGHEST : 0) -# define VLC_THREAD_PRIORITY_VIDEO \ - (IS_WINNT ? 0 : THREAD_PRIORITY_BELOW_NORMAL ) + THREAD_PRIORITY_HIGHEST +# define VLC_THREAD_PRIORITY_VIDEO 0 # define VLC_THREAD_PRIORITY_OUTPUT \ - (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0) + THREAD_PRIORITY_ABOVE_NORMAL # define VLC_THREAD_PRIORITY_HIGHEST \ - (IS_WINNT ? THREAD_PRIORITY_TIME_CRITICAL : 0) + THREAD_PRIORITY_TIME_CRITICAL + +#elif defined(__OS2__) +# define VLC_THREAD_PRIORITY_LOW 0 +# define VLC_THREAD_PRIORITY_INPUT MAKESHORT( PRTYD_MAXIMUM / 2, PRTYC_REGULAR ) +# define VLC_THREAD_PRIORITY_AUDIO MAKESHORT( PRTYD_MAXIMUM, PRTYC_REGULAR ) +# define VLC_THREAD_PRIORITY_VIDEO 0 +# define VLC_THREAD_PRIORITY_OUTPUT MAKESHORT( PRTYD_MAXIMUM / 2, PRTYC_REGULAR ) +# define VLC_THREAD_PRIORITY_HIGHEST MAKESHORT( 0, PRTYC_TIMECRITICAL ) #else # define VLC_THREAD_PRIORITY_LOW 0 @@ -106,27 +120,107 @@ #if defined (LIBVLC_USE_PTHREAD) typedef pthread_t vlc_thread_t; typedef pthread_mutex_t vlc_mutex_t; +#define VLC_STATIC_MUTEX PTHREAD_MUTEX_INITIALIZER typedef pthread_cond_t vlc_cond_t; +#define VLC_STATIC_COND PTHREAD_COND_INITIALIZER +typedef pthread_rwlock_t vlc_rwlock_t; +#define VLC_STATIC_RWLOCK PTHREAD_RWLOCK_INITIALIZER typedef pthread_key_t vlc_threadvar_t; +typedef struct vlc_timer *vlc_timer_t; + +#if defined (__APPLE__) +typedef semaphore_t vlc_sem_t; +#else +typedef sem_t vlc_sem_t; +#endif #elif defined( WIN32 ) +typedef struct vlc_thread *vlc_thread_t; + typedef struct { - HANDLE handle; - void *(*entry) (void *); - void *data; -} *vlc_thread_t; + bool dynamic; + union + { + struct + { + bool locked; + unsigned long contention; + }; + CRITICAL_SECTION mutex; + }; +} vlc_mutex_t; +#define VLC_STATIC_MUTEX { false, { { false, 0 } } } typedef struct { - CRITICAL_SECTION mutex; - LONG owner; - unsigned recursion; - bool recursive; -} -vlc_mutex_t; -typedef HANDLE vlc_cond_t; -typedef DWORD vlc_threadvar_t; + HANDLE handle; + unsigned clock; +} vlc_cond_t; +#define VLC_STATIC_COND { 0, 0 } + +typedef HANDLE vlc_sem_t; + +typedef struct +{ + vlc_mutex_t mutex; + vlc_cond_t wait; + unsigned long readers; + DWORD writer; +} vlc_rwlock_t; +#define VLC_STATIC_RWLOCK \ + { VLC_STATIC_MUTEX, VLC_STATIC_COND, 0, 0 } + +typedef struct vlc_threadvar *vlc_threadvar_t; +typedef struct vlc_timer *vlc_timer_t; + +#elif defined( __OS2__ ) +typedef struct vlc_thread *vlc_thread_t; + +typedef struct +{ + bool dynamic; + union + { + struct + { + bool locked; + unsigned long contention; + }; + HMTX hmtx; + }; +} vlc_mutex_t; + +#define VLC_STATIC_MUTEX { false, { { false, 0 } } } + +typedef struct +{ + HEV hev; + unsigned clock; +} vlc_cond_t; + +#define VLC_STATIC_COND { 0, 0 } + +typedef struct +{ + HEV hev; + HMTX wait_mutex; + HMTX count_mutex; + int count; +} vlc_sem_t; + +typedef struct +{ + vlc_mutex_t mutex; + vlc_cond_t wait; + unsigned long readers; + int writer; +} vlc_rwlock_t; +#define VLC_STATIC_RWLOCK \ + { VLC_STATIC_MUTEX, VLC_STATIC_COND, 0, 0 } + +typedef struct vlc_threadvar *vlc_threadvar_t; +typedef struct vlc_timer *vlc_timer_t; #endif @@ -137,92 +231,116 @@ typedef DWORD vlc_threadvar_t; /***************************************************************************** * Function definitions *****************************************************************************/ -VLC_EXPORT( int, vlc_mutex_init, ( vlc_mutex_t * ) ); -VLC_EXPORT( int, vlc_mutex_init_recursive, ( vlc_mutex_t * ) ); -VLC_EXPORT( void, vlc_mutex_destroy, ( vlc_mutex_t * ) ); -VLC_EXPORT( void, vlc_mutex_lock, ( vlc_mutex_t * ) ); -VLC_EXPORT( void, vlc_mutex_unlock, ( vlc_mutex_t * ) ); -VLC_EXPORT( int, vlc_cond_init, ( vlc_cond_t * ) ); -VLC_EXPORT( void, vlc_cond_destroy, ( vlc_cond_t * ) ); -VLC_EXPORT( void, vlc_cond_signal, (vlc_cond_t *) ); -VLC_EXPORT( void, vlc_cond_broadcast, (vlc_cond_t *) ); -VLC_EXPORT( void, vlc_cond_wait, (vlc_cond_t *, vlc_mutex_t *) ); -VLC_EXPORT( int, vlc_cond_timedwait, (vlc_cond_t *, vlc_mutex_t *, mtime_t) ); -VLC_EXPORT( int, vlc_threadvar_create, (vlc_threadvar_t * , void (*) (void *) ) ); -VLC_EXPORT( void, vlc_threadvar_delete, (vlc_threadvar_t *) ); -VLC_EXPORT( int, __vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( vlc_object_t * ), int, bool ) ); -VLC_EXPORT( int, __vlc_thread_set_priority, ( vlc_object_t *, const char *, int, int ) ); -VLC_EXPORT( void, __vlc_thread_join, ( vlc_object_t * ) ); - -VLC_EXPORT( int, vlc_clone, (vlc_thread_t *, void * (*) (void *), void *, int) ); -VLC_EXPORT( void, vlc_cancel, (vlc_thread_t) ); -VLC_EXPORT( void, vlc_join, (vlc_thread_t, void **) ); -VLC_EXPORT (void, vlc_control_cancel, (int cmd, ...)); - -#ifndef LIBVLC_USE_PTHREAD_CANCEL -enum { - VLC_SAVE_CANCEL, - VLC_RESTORE_CANCEL, - VLC_TEST_CANCEL, - VLC_DO_CANCEL, - VLC_CLEANUP_PUSH, - VLC_CLEANUP_POP, -}; -#endif - -#define vlc_thread_ready vlc_object_signal - -#if defined(LIBVLC_USE_PTHREAD) -# define vlc_assert_locked( m ) \ - assert (pthread_mutex_lock (m) == EDEADLK) -#else -# define vlc_assert_locked( m ) (void)m -#endif - -/** - * Save the cancellation state and disable cancellation for the calling thread. - * This function must be called before entering a piece of code that is not - * cancellation-safe. - * @return Previous cancellation state (opaque value). +VLC_API void vlc_mutex_init( vlc_mutex_t * ); +VLC_API void vlc_mutex_init_recursive( vlc_mutex_t * ); +VLC_API void vlc_mutex_destroy( vlc_mutex_t * ); +VLC_API void vlc_mutex_lock( vlc_mutex_t * ); +VLC_API int vlc_mutex_trylock( vlc_mutex_t * ) VLC_USED; +VLC_API void vlc_mutex_unlock( vlc_mutex_t * ); +VLC_API void vlc_cond_init( vlc_cond_t * ); +VLC_API void vlc_cond_init_daytime( vlc_cond_t * ); +VLC_API void vlc_cond_destroy( vlc_cond_t * ); +VLC_API void vlc_cond_signal(vlc_cond_t *); +VLC_API void vlc_cond_broadcast(vlc_cond_t *); +VLC_API void vlc_cond_wait(vlc_cond_t *, vlc_mutex_t *); +VLC_API int vlc_cond_timedwait(vlc_cond_t *, vlc_mutex_t *, mtime_t); +VLC_API void vlc_sem_init(vlc_sem_t *, unsigned); +VLC_API void vlc_sem_destroy(vlc_sem_t *); +VLC_API int vlc_sem_post(vlc_sem_t *); +VLC_API void vlc_sem_wait(vlc_sem_t *); + +VLC_API void vlc_rwlock_init(vlc_rwlock_t *); +VLC_API void vlc_rwlock_destroy(vlc_rwlock_t *); +VLC_API void vlc_rwlock_rdlock(vlc_rwlock_t *); +VLC_API void vlc_rwlock_wrlock(vlc_rwlock_t *); +VLC_API void vlc_rwlock_unlock(vlc_rwlock_t *); +VLC_API int vlc_threadvar_create(vlc_threadvar_t * , void (*) (void *) ); +VLC_API void vlc_threadvar_delete(vlc_threadvar_t *); +VLC_API int vlc_threadvar_set(vlc_threadvar_t, void *); +VLC_API void * vlc_threadvar_get(vlc_threadvar_t); + +VLC_API int vlc_clone(vlc_thread_t *, void * (*) (void *), void *, int) VLC_USED; +VLC_API void vlc_cancel(vlc_thread_t); +VLC_API void vlc_join(vlc_thread_t, void **); +VLC_API void vlc_control_cancel (int cmd, ...); + +VLC_API mtime_t mdate(void); +VLC_API void mwait(mtime_t deadline); +VLC_API void msleep(mtime_t delay); + +#define VLC_HARD_MIN_SLEEP 10000 /* 10 milliseconds = 1 tick at 100Hz */ +#define VLC_SOFT_MIN_SLEEP 9000000 /* 9 seconds */ + +#if VLC_GCC_VERSION(4,3) +/* Linux has 100, 250, 300 or 1000Hz + * + * HZ=100 by default on FreeBSD, but some architectures use a 1000Hz timer */ -static inline int vlc_savecancel (void) + +static +__attribute__((unused)) +__attribute__((noinline)) +__attribute__((error("sorry, cannot sleep for such short a time"))) +mtime_t impossible_delay( mtime_t delay ) { - int state; -#if defined (LIBVLC_USE_PTHREAD_CANCEL) - (void) pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, &state); -#else - vlc_control_cancel (VLC_SAVE_CANCEL, &state); -#endif - return state; + (void) delay; + return VLC_HARD_MIN_SLEEP; } -/** - * Restore the cancellation state for the calling thread. - * @param state previous state as returned by vlc_savecancel(). - * @return Nothing, always succeeds. - */ -static inline void vlc_restorecancel (int state) +static +__attribute__((unused)) +__attribute__((noinline)) +__attribute__((warning("use proper event handling instead of short delay"))) +mtime_t harmful_delay( mtime_t delay ) { -#if defined (LIBVLC_USE_PTHREAD_CANCEL) - (void) pthread_setcancelstate (state, NULL); -#else - vlc_control_cancel (VLC_RESTORE_CANCEL, state); -#endif + return delay; } -/** - * Issues an explicit deferred cancellation point. - * This has no effect if thread cancellation is disabled. - * This can be called when there is a rather slow non-sleeping operation. - */ -static inline void vlc_testcancel (void) +# define check_delay( d ) \ + ((__builtin_constant_p(d < VLC_HARD_MIN_SLEEP) \ + && (d < VLC_HARD_MIN_SLEEP)) \ + ? impossible_delay(d) \ + : ((__builtin_constant_p(d < VLC_SOFT_MIN_SLEEP) \ + && (d < VLC_SOFT_MIN_SLEEP)) \ + ? harmful_delay(d) \ + : d)) + +static +__attribute__((unused)) +__attribute__((noinline)) +__attribute__((error("deadlines can not be constant"))) +mtime_t impossible_deadline( mtime_t deadline ) { -#if defined (LIBVLC_USE_PTHREAD_CANCEL) - pthread_testcancel (); + return deadline; +} + +# define check_deadline( d ) \ + (__builtin_constant_p(d) ? impossible_deadline(d) : d) #else - vlc_control_cancel (VLC_TEST_CANCEL); +# define check_delay(d) (d) +# define check_deadline(d) (d) #endif -} + +#define msleep(d) msleep(check_delay(d)) +#define mwait(d) mwait(check_deadline(d)) + +VLC_API int vlc_timer_create(vlc_timer_t *, void (*) (void *), void *) VLC_USED; +VLC_API void vlc_timer_destroy(vlc_timer_t); +VLC_API void vlc_timer_schedule(vlc_timer_t, bool, mtime_t, mtime_t); +VLC_API unsigned vlc_timer_getoverrun(vlc_timer_t) VLC_USED; + +VLC_API unsigned vlc_GetCPUCount(void); + +#ifndef LIBVLC_USE_PTHREAD_CANCEL +enum { + VLC_CLEANUP_PUSH, + VLC_CLEANUP_POP, +}; +#endif + +VLC_API int vlc_savecancel(void); +VLC_API void vlc_restorecancel(int state); +VLC_API void vlc_testcancel(void); #if defined (LIBVLC_USE_PTHREAD_CANCEL) /** @@ -260,7 +378,7 @@ struct vlc_cleanup_t }; /* This macros opens a code block on purpose. This is needed for multiple - * calls within a single function. This also prevent Win32 developpers from + * calls within a single function. This also prevent Win32 developers from * writing code that would break on POSIX (POSIX opens a block as well). */ # define vlc_cleanup_push( routine, arg ) \ do { \ @@ -276,6 +394,24 @@ struct vlc_cleanup_t vlc_cleanup_data.proc (vlc_cleanup_data.data); \ } while (0) +/* poll() with cancellation */ +static inline int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout) +{ + vlc_testcancel (); + + while (timeout > 50) + { + int val = poll (fds, nfds, timeout); + if (val != 0) + return val; + timeout -= 50; + vlc_testcancel (); + } + + return poll (fds, nfds, timeout); +} +# define poll(u,n,t) vlc_poll(u, n, t) + #endif /* LIBVLC_USE_PTHREAD_CANCEL */ static inline void vlc_cleanup_lock (void *lock) @@ -284,51 +420,16 @@ static inline void vlc_cleanup_lock (void *lock) } #define mutex_cleanup_push( lock ) vlc_cleanup_push (vlc_cleanup_lock, lock) -/***************************************************************************** - * 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(LIBVLC_USE_PTHREAD) - i_ret = pthread_setspecific( *p_tls, p_value ); - -#elif defined( UNDER_CE ) || defined( WIN32 ) - i_ret = TlsSetValue( *p_tls, p_value ) ? EINVAL : 0; - -#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(LIBVLC_USE_PTHREAD) - p_ret = pthread_getspecific( *p_tls ); - -#elif defined( UNDER_CE ) || defined( WIN32 ) - p_ret = TlsGetValue( *p_tls ); - -#endif - - return p_ret; -} - # if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0) typedef pthread_spinlock_t vlc_spinlock_t; /** * Initializes a spinlock. */ -static inline int vlc_spin_init (vlc_spinlock_t *spin) +static inline void vlc_spin_init (vlc_spinlock_t *spin) { - return pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE); + if (pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE)) + abort (); } /** @@ -355,16 +456,17 @@ static inline void vlc_spin_destroy (vlc_spinlock_t *spin) pthread_spin_destroy (spin); } -#elif defined( WIN32 ) +#elif defined (WIN32) && !defined (UNDER_CE) typedef CRITICAL_SECTION vlc_spinlock_t; /** * Initializes a spinlock. */ -static inline int vlc_spin_init (vlc_spinlock_t *spin) +static inline void vlc_spin_init (vlc_spinlock_t *spin) { - return !InitializeCriticalSectionAndSpinCount(spin, 4000); + if (!InitializeCriticalSectionAndSpinCount(spin, 4000)) + abort (); } /** @@ -396,9 +498,9 @@ static inline void vlc_spin_destroy (vlc_spinlock_t *spin) /* 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) +static inline void vlc_spin_init (vlc_spinlock_t *spin) { - return vlc_mutex_init (spin); + vlc_mutex_init (spin); } # define vlc_spin_lock vlc_mutex_lock @@ -414,13 +516,14 @@ static inline int vlc_spin_init (vlc_spinlock_t *spin) #endif static inline void barrier (void) { -#if defined (__GNUC__) && (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1) +#if defined (__GNUC__) && !defined (__APPLE__) && \ + ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1)) __sync_synchronize (); #elif defined(__APPLE__) OSMemoryBarrier (); #elif defined(__powerpc__) asm volatile ("sync":::"memory"); -#elif defined(__i386__) +#elif 0 // defined(__i386__) /* Requires SSE2 support */ asm volatile ("mfence":::"memory"); #else vlc_spinlock_t spin; @@ -431,22 +534,41 @@ static inline void barrier (void) #endif } -/***************************************************************************** - * vlc_thread_create: create a thread - *****************************************************************************/ -#define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, PRIORITY, WAIT ) \ - __vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, FUNC, PRIORITY, WAIT ) +#ifdef __cplusplus +/** + * Helper C++ class to lock a mutex. + * The mutex is locked when the object is created, and unlocked when the object + * is destroyed. + */ +class vlc_mutex_locker +{ + private: + vlc_mutex_t *lock; + public: + vlc_mutex_locker (vlc_mutex_t *m) : lock (m) + { + vlc_mutex_lock (lock); + } + + ~vlc_mutex_locker (void) + { + vlc_mutex_unlock (lock); + } +}; +#endif -/***************************************************************************** - * vlc_thread_set_priority: set the priority of the calling thread - *****************************************************************************/ -#define vlc_thread_set_priority( P_THIS, PRIORITY ) \ - __vlc_thread_set_priority( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PRIORITY ) +enum { + VLC_AVCODEC_MUTEX = 0, + VLC_GCRYPT_MUTEX, + VLC_XLIB_MUTEX, + VLC_MOSAIC_MUTEX, + VLC_HIGHLIGHT_MUTEX, + /* Insert new entry HERE */ + VLC_MAX_MUTEX +}; -/***************************************************************************** - * vlc_thread_join: wait until a thread exits - *****************************************************************************/ -#define vlc_thread_join( P_THIS ) \ - __vlc_thread_join( VLC_OBJECT(P_THIS) ) +VLC_API void vlc_global_mutex( unsigned, bool ); +#define vlc_global_lock( n ) vlc_global_mutex( n, true ) +#define vlc_global_unlock( n ) vlc_global_mutex( n, false ) #endif /* !_VLC_THREADS_H */