X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_threads.h;h=7b2f07b62d842a9a77fbebbe27ca3fe537e822a4;hb=07faebaf35bfa682913ac99f11562ecd8b974021;hp=2c8b9597b949f51fe87ed210794b868417787771;hpb=736e30bee6e389f8d996dc8ce0ab0c69240b0125;p=vlc diff --git a/include/vlc_threads.h b/include/vlc_threads.h index 2c8b9597b9..7b2f07b62d 100644 --- a/include/vlc_threads.h +++ b/include/vlc_threads.h @@ -2,8 +2,8 @@ * vlc_threads.h : threads implementation for the VideoLAN client * This header provides portable declarations for mutexes & conditions ***************************************************************************** - * Copyright (C) 1999, 2002 VideoLAN - * $Id: vlc_threads.h,v 1.27 2003/02/06 21:39:34 titer Exp $ + * Copyright (C) 1999, 2002 the VideoLAN team + * Copyright © 2007-2008 Rémi Denis-Courmont * * Authors: Jean-Marc Dressler * Samuel Hocevar @@ -14,7 +14,7 @@ * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 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 @@ -22,47 +22,35 @@ * * 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. *****************************************************************************/ -#include - -#if defined(GPROF) || defined(DEBUG) -# ifdef HAVE_SYS_TIME_H -# include -# endif -#endif - -#if defined( PTH_INIT_IN_PTH_H ) /* GNU Pth */ -# include +#ifndef VLC_THREADS_H_ +#define VLC_THREADS_H_ -#elif defined( ST_INIT_IN_ST_H ) /* State threads */ -# include +/** + * \file + * This file defines structures and functions for handling threads in vlc + * + */ -#elif defined( UNDER_CE ) +#if defined( UNDER_CE ) /* WinCE API */ #elif defined( WIN32 ) # include /* Win32 API */ +# include -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) /* pthreads (like Linux & BSD) */ -# include -# ifdef DEBUG - /* Needed for pthread_cond_timedwait */ -# include -# endif - /* This is not prototyped under Linux, though it exists. */ - int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind ); +#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 */ -#elif defined( HAVE_CTHREADS_H ) /* GNUMach */ -# include - -#elif defined( HAVE_KERNEL_SCHEDULER_H ) /* BeOS */ -# include -# include -# include - -#else -# error no threads available on your system ! +# include /* lldiv_t definition (only in C99) */ +# include /* _POSIX_SPIN_LOCKS */ +# include + /* Needed for pthread_cond_timedwait */ +# include +# include #endif @@ -71,33 +59,34 @@ *****************************************************************************/ /* Thread priorities */ -#ifdef SYS_DARWIN -# define VLC_THREAD_PRIORITY_LOW 31 -# define VLC_THREAD_PRIORITY_INPUT 34 -# define VLC_THREAD_PRIORITY_AUDIO 35 -# define VLC_THREAD_PRIORITY_VIDEO 32 -# define VLC_THREAD_PRIORITY_OUTPUT 33 +#ifdef __APPLE__ +# define VLC_THREAD_PRIORITY_LOW 0 +# define VLC_THREAD_PRIORITY_INPUT 22 +# define VLC_THREAD_PRIORITY_AUDIO 22 +# define VLC_THREAD_PRIORITY_VIDEO 0 +# define VLC_THREAD_PRIORITY_OUTPUT 22 +# define VLC_THREAD_PRIORITY_HIGHEST 22 + +#elif defined(LIBVLC_USE_PTHREAD) +# define VLC_THREAD_PRIORITY_LOW 0 +# define VLC_THREAD_PRIORITY_INPUT 10 +# define VLC_THREAD_PRIORITY_AUDIO 5 +# define VLC_THREAD_PRIORITY_VIDEO 0 +# define VLC_THREAD_PRIORITY_OUTPUT 15 +# define VLC_THREAD_PRIORITY_HIGHEST 20 #elif defined(WIN32) || defined(UNDER_CE) /* 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_TIME_CRITICAL : 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) - -#elif defined(SYS_BEOS) -# define VLC_THREAD_PRIORITY_LOW 5 -# define VLC_THREAD_PRIORITY_INPUT 14 -# define VLC_THREAD_PRIORITY_AUDIO 13 -# define VLC_THREAD_PRIORITY_VIDEO 11 -# define VLC_THREAD_PRIORITY_OUTPUT 12 + THREAD_PRIORITY_TIME_CRITICAL #else # define VLC_THREAD_PRIORITY_LOW 0 @@ -105,6 +94,7 @@ # define VLC_THREAD_PRIORITY_AUDIO 0 # define VLC_THREAD_PRIORITY_VIDEO 0 # define VLC_THREAD_PRIORITY_OUTPUT 0 +# define VLC_THREAD_PRIORITY_HIGHEST 0 #endif @@ -112,122 +102,344 @@ * Type definitions *****************************************************************************/ -#if defined( PTH_INIT_IN_PTH_H ) -typedef pth_t vlc_thread_t; +#if defined (LIBVLC_USE_PTHREAD) +typedef pthread_t vlc_thread_t; +typedef pthread_mutex_t vlc_mutex_t; +typedef pthread_cond_t vlc_cond_t; +typedef pthread_key_t vlc_threadvar_t; + +#elif defined( WIN32 ) typedef struct { - pth_mutex_t mutex; - vlc_object_t * p_this; -} vlc_mutex_t; + HANDLE handle; + void *(*entry) (void *); + void *data; +} *vlc_thread_t; + typedef struct { - pth_cond_t cond; - vlc_object_t * p_this; -} vlc_cond_t; + CRITICAL_SECTION mutex; + LONG owner; + unsigned recursion; + bool recursive; +} +vlc_mutex_t; +typedef HANDLE vlc_cond_t; +typedef DWORD vlc_threadvar_t; -#elif defined( ST_INIT_IN_ST_H ) -typedef st_thread_t vlc_thread_t; -typedef struct +#endif + +#if defined( WIN32 ) && !defined ETIMEDOUT +# define ETIMEDOUT 10060 /* This is the value in winsock.h. */ +#endif + +/***************************************************************************** + * 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 + +/** + * 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). + */ +static inline int vlc_savecancel (void) { - st_mutex_t mutex; - vlc_object_t * p_this; -} vlc_mutex_t; -typedef struct + 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; +} + +/** + * 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) +{ +#if defined (LIBVLC_USE_PTHREAD_CANCEL) + (void) pthread_setcancelstate (state, NULL); +#else + vlc_control_cancel (VLC_RESTORE_CANCEL, state); +#endif +} + +/** + * 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) { - st_cond_t cond; - vlc_object_t * p_this; -} vlc_cond_t; +#if defined (LIBVLC_USE_PTHREAD_CANCEL) + pthread_testcancel (); +#else + vlc_control_cancel (VLC_TEST_CANCEL); +#endif +} + +#if defined (LIBVLC_USE_PTHREAD_CANCEL) +/** + * Registers a new procedure to run if the thread is cancelled (or otherwise + * exits prematurely). Any call to vlc_cleanup_push() must paired with a + * call to either vlc_cleanup_pop() or vlc_cleanup_run(). Branching into or out + * of the block between these two function calls is not allowed (read: it will + * likely crash the whole process). If multiple procedures are registered, + * they are handled in last-in first-out order. + * + * @param routine procedure to call if the thread ends + * @param arg argument for the procedure + */ +# define vlc_cleanup_push( routine, arg ) pthread_cleanup_push (routine, arg) + +/** + * Removes a cleanup procedure that was previously registered with + * vlc_cleanup_push(). + */ +# define vlc_cleanup_pop( ) pthread_cleanup_pop (0) + +/** + * Removes a cleanup procedure that was previously registered with + * vlc_cleanup_push(), and executes it. + */ +# define vlc_cleanup_run( ) pthread_cleanup_pop (1) +#else +typedef struct vlc_cleanup_t vlc_cleanup_t; -#elif defined( WIN32 ) || defined( UNDER_CE ) -typedef HANDLE vlc_thread_t; -typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL ); -typedef unsigned (__stdcall *PTHREAD_START) (void *); +struct vlc_cleanup_t +{ + vlc_cleanup_t *next; + void (*proc) (void *); + void *data; +}; + +/* This macros opens a code block on purpose. This is needed for multiple + * calls within a single function. This also prevent Win32 developpers from + * writing code that would break on POSIX (POSIX opens a block as well). */ +# define vlc_cleanup_push( routine, arg ) \ + do { \ + vlc_cleanup_t vlc_cleanup_data = { NULL, routine, arg, }; \ + vlc_control_cancel (VLC_CLEANUP_PUSH, &vlc_cleanup_data) + +# define vlc_cleanup_pop( ) \ + vlc_control_cancel (VLC_CLEANUP_POP); \ + } while (0) + +# define vlc_cleanup_run( ) \ + vlc_control_cancel (VLC_CLEANUP_POP); \ + vlc_cleanup_data.proc (vlc_cleanup_data.data); \ + } while (0) + +#endif /* LIBVLC_USE_PTHREAD_CANCEL */ + +static inline void vlc_cleanup_lock (void *lock) +{ + vlc_mutex_unlock ((vlc_mutex_t *)lock); +} +#define mutex_cleanup_push( lock ) vlc_cleanup_push (vlc_cleanup_lock, lock) -typedef struct +/***************************************************************************** + * 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 ) { - /* WinNT/2K/XP implementation */ - HANDLE mutex; - /* Win95/98/ME implementation */ - CRITICAL_SECTION csection; + int i_ret; - vlc_object_t * p_this; -} vlc_mutex_t; +#if defined(LIBVLC_USE_PTHREAD) + i_ret = pthread_setspecific( *p_tls, p_value ); -typedef struct +#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 ) { - volatile int i_waiting_threads; - /* WinNT/2K/XP implementation */ - HANDLE event; - SIGNALOBJECTANDWAIT SignalObjectAndWait; - /* Win95/98/ME implementation */ - HANDLE semaphore; - CRITICAL_SECTION csection; - int i_win9x_cv; + void *p_ret; - vlc_object_t * p_this; -} vlc_cond_t; +#if defined(LIBVLC_USE_PTHREAD) + p_ret = pthread_getspecific( *p_tls ); -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) -typedef pthread_t vlc_thread_t; -typedef struct +#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) { - pthread_mutex_t mutex; - vlc_object_t * p_this; -} vlc_mutex_t; -typedef struct + return pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE); +} + +/** + * Acquires a spinlock. + */ +static inline void vlc_spin_lock (vlc_spinlock_t *spin) { - pthread_cond_t cond; - vlc_object_t * p_this; -} vlc_cond_t; + pthread_spin_lock (spin); +} -#elif defined( HAVE_CTHREADS_H ) -typedef cthread_t vlc_thread_t; +/** + * Releases a spinlock. + */ +static inline void vlc_spin_unlock (vlc_spinlock_t *spin) +{ + pthread_spin_unlock (spin); +} -/* Those structs are the ones defined in /include/cthreads.h but we need - * to handle (&foo) where foo is a (mutex_t) while they handle (foo) where - * foo is a (mutex_t*) */ -typedef struct +/** + * Deinitializes a spinlock. + */ +static inline void vlc_spin_destroy (vlc_spinlock_t *spin) { - spin_lock_t held; - spin_lock_t lock; - char *name; - struct cthread_queue queue; + pthread_spin_destroy (spin); +} - vlc_object_t * p_this; -} vlc_mutex_t; +#elif defined( WIN32 ) -typedef struct -{ - spin_lock_t lock; - struct cthread_queue queue; - char *name; - struct cond_imp *implications; +typedef CRITICAL_SECTION vlc_spinlock_t; - vlc_object_t * p_this; -} vlc_cond_t; +/** + * Initializes a spinlock. + */ +static inline int vlc_spin_init (vlc_spinlock_t *spin) +{ + return !InitializeCriticalSectionAndSpinCount(spin, 4000); +} -#elif defined( HAVE_KERNEL_SCHEDULER_H ) -/* This is the BeOS implementation of the vlc threads, note that the mutex is - * not a real mutex and the cond_var is not like a pthread cond_var but it is - * enough for what wee need */ +/** + * Acquires a spinlock. + */ +static inline void vlc_spin_lock (vlc_spinlock_t *spin) +{ + EnterCriticalSection(spin); +} -typedef thread_id vlc_thread_t; +/** + * Releases a spinlock. + */ +static inline void vlc_spin_unlock (vlc_spinlock_t *spin) +{ + LeaveCriticalSection(spin); +} -typedef struct +/** + * Deinitializes a spinlock. + */ +static inline void vlc_spin_destroy (vlc_spinlock_t *spin) { - int32 init; - sem_id lock; + DeleteCriticalSection(spin); +} + +#else - vlc_object_t * p_this; -} vlc_mutex_t; +/* Fallback to plain mutexes if spinlocks are not available */ +typedef vlc_mutex_t vlc_spinlock_t; -typedef struct +static inline int vlc_spin_init (vlc_spinlock_t *spin) { - int32 init; - thread_id thread; + return vlc_mutex_init (spin); +} - vlc_object_t * p_this; -} vlc_cond_t; +# define vlc_spin_lock vlc_mutex_lock +# define vlc_spin_unlock vlc_mutex_unlock +# define vlc_spin_destroy vlc_mutex_destroy +#endif +/** + * Issues a full memory barrier. + */ +#if defined (__APPLE__) +# include /* OSMemoryBarrier() */ +#endif +static inline void barrier (void) +{ +#if defined (__GNUC__) && \ + ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1)) + __sync_synchronize (); +#elif defined(__APPLE__) + OSMemoryBarrier (); +#elif defined(__powerpc__) + asm volatile ("sync":::"memory"); +#elif 0 // defined(__i386__) /* Requires SSE2 support */ + asm volatile ("mfence":::"memory"); +#else + vlc_spinlock_t spin; + vlc_spin_init (&spin); + vlc_spin_lock (&spin); + vlc_spin_unlock (&spin); + vlc_spin_destroy (&spin); #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 ) + +/***************************************************************************** + * 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 ) + +/***************************************************************************** + * vlc_thread_join: wait until a thread exits + *****************************************************************************/ +#define vlc_thread_join( P_THIS ) \ + __vlc_thread_join( VLC_OBJECT(P_THIS) ) +#endif /* !_VLC_THREADS_H */