X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_threads.h;h=52157d8c287d2382f30d97cf30dc4243991ad51c;hb=bd78a9944361cbfaeae1b3f11e00c9b1754a7770;hp=22015cbd2036c983eef8594c0f62adf2ad8e93b5;hpb=8b6728575ee69047c4b6add10281e0cb8baa0234;p=vlc diff --git a/include/vlc_threads.h b/include/vlc_threads.h index 22015cbd20..52157d8c28 100644 --- a/include/vlc_threads.h +++ b/include/vlc_threads.h @@ -3,7 +3,7 @@ * This header provides portable declarations for mutexes & conditions ***************************************************************************** * Copyright (C) 1999, 2002 the VideoLAN team - * $Id$ + * Copyright © 2007-2008 Rémi Denis-Courmont * * Authors: Jean-Marc Dressler * Samuel Hocevar @@ -25,48 +25,32 @@ * 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_THREADS_H_ -#define _VLC_THREADS_H_ - -#include - -#if defined(DEBUG) && defined(HAVE_SYS_TIME_H) -# include -#endif +#ifndef VLC_THREADS_H_ +#define VLC_THREADS_H_ -#if 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 ) - /* WinCE API */ +#if defined( UNDER_CE ) +# include /* WinCE API */ #elif defined( WIN32 ) # include /* Win32 API */ +# include -#elif defined( HAVE_KERNEL_SCHEDULER_H ) /* BeOS */ -# include -# include -# include - -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) /* pthreads (like Linux & BSD) */ +#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 - /* This is not prototyped under Linux, though it exists. */ - int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind ); - -#elif defined( HAVE_CTHREADS_H ) /* GNUMach */ -# include - -#else -# error no threads available on your system ! +# include #endif @@ -76,42 +60,33 @@ /* Thread priorities */ #ifdef __APPLE__ -# define VLC_THREAD_PRIORITY_LOW (-47) -# define VLC_THREAD_PRIORITY_INPUT 37 -# define VLC_THREAD_PRIORITY_AUDIO 37 -# define VLC_THREAD_PRIORITY_VIDEO (-47) -# define VLC_THREAD_PRIORITY_OUTPUT 37 -# define VLC_THREAD_PRIORITY_HIGHEST 37 - -#elif defined(SYS_BEOS) -# define VLC_THREAD_PRIORITY_LOW 5 -# define VLC_THREAD_PRIORITY_INPUT 10 -# define VLC_THREAD_PRIORITY_AUDIO 10 -# define VLC_THREAD_PRIORITY_VIDEO 5 -# define VLC_THREAD_PRIORITY_OUTPUT 15 -# define VLC_THREAD_PRIORITY_HIGHEST 15 - -#elif defined(PTHREAD_COND_T_IN_PTHREAD_H) -# define VLC_THREAD_PRIORITY_LOW 0 -# define VLC_THREAD_PRIORITY_INPUT 20 -# define VLC_THREAD_PRIORITY_AUDIO 10 -# define VLC_THREAD_PRIORITY_VIDEO 0 -# define VLC_THREAD_PRIORITY_OUTPUT 30 -# define VLC_THREAD_PRIORITY_HIGHEST 40 +# 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_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 #else # define VLC_THREAD_PRIORITY_LOW 0 @@ -127,143 +102,296 @@ * Type definitions *****************************************************************************/ -#if defined( ST_INIT_IN_ST_H ) -typedef st_thread_t vlc_thread_t; -typedef struct -{ - st_mutex_t mutex; - vlc_object_t * p_this; -} vlc_mutex_t; -typedef struct -{ - st_cond_t cond; - vlc_object_t * p_this; -} vlc_cond_t; +#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; +typedef pthread_key_t vlc_threadvar_t; + +#elif defined( WIN32 ) typedef struct { - int handle; -} vlc_threadvar_t; + HANDLE handle; + void *(*entry) (void *); + void *data; +#if defined( UNDER_CE ) + HANDLE cancel_event; +#endif +} *vlc_thread_t; -#elif defined( WIN32 ) || defined( UNDER_CE ) typedef struct { - /* thread id */ - DWORD id; - /* - ** handle to created thread, needs be closed to dispose of it - ** even after thread has exited - */ - HANDLE hThread; -} vlc_thread_t; + LONG initialized; + CRITICAL_SECTION mutex; +} vlc_mutex_t; +#define VLC_STATIC_MUTEX { 0, } -typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL ); +typedef HANDLE vlc_cond_t; +typedef DWORD vlc_threadvar_t; -typedef struct -{ - /* WinNT/2K/XP implementation */ - HANDLE mutex; - /* Win95/98/ME implementation */ - CRITICAL_SECTION csection; +#endif - vlc_object_t * p_this; -} vlc_mutex_t; +#if defined( WIN32 ) && !defined ETIMEDOUT +# define ETIMEDOUT 10060 /* This is the value in winsock.h. */ +#endif -typedef struct -{ - 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; - - vlc_object_t * p_this; -} vlc_cond_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( int, vlc_mutex_trylock, ( vlc_mutex_t * ) LIBVLC_USED ); +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_threadvar_set, (vlc_threadvar_t, void *) ); +VLC_EXPORT( void *, vlc_threadvar_get, (vlc_threadvar_t) ); +VLC_EXPORT( int, vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( vlc_object_t * ), int ) ); +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_DO_CANCEL, + VLC_CLEANUP_PUSH, + VLC_CLEANUP_POP, +}; +#endif -typedef struct +VLC_EXPORT( int, vlc_savecancel, (void) ); +VLC_EXPORT( void, vlc_restorecancel, (int state) ); +VLC_EXPORT( void, vlc_testcancel, (void) ); + +#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; + +struct vlc_cleanup_t { - DWORD handle; -} vlc_threadvar_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) -#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 we need */ +# if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0) +typedef pthread_spinlock_t vlc_spinlock_t; -typedef thread_id vlc_thread_t; +/** + * Initializes a spinlock. + */ +static inline int vlc_spin_init (vlc_spinlock_t *spin) +{ + return pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE); +} -typedef struct +/** + * Acquires a spinlock. + */ +static inline void vlc_spin_lock (vlc_spinlock_t *spin) { - int32_t init; - sem_id lock; + pthread_spin_lock (spin); +} - vlc_object_t * p_this; -} vlc_mutex_t; +/** + * Releases a spinlock. + */ +static inline void vlc_spin_unlock (vlc_spinlock_t *spin) +{ + pthread_spin_unlock (spin); +} -typedef struct +/** + * Deinitializes a spinlock. + */ +static inline void vlc_spin_destroy (vlc_spinlock_t *spin) { - int32_t init; - thread_id thread; + pthread_spin_destroy (spin); +} - vlc_object_t * p_this; -} vlc_cond_t; +#elif defined( WIN32 ) -typedef struct -{ -} vlc_threadvar_t; +typedef CRITICAL_SECTION vlc_spinlock_t; +/** + * Initializes a spinlock. + */ +static inline int vlc_spin_init (vlc_spinlock_t *spin) +{ +#ifdef UNDER_CE + InitializeCriticalSection(spin); + return 0; +#else + return !InitializeCriticalSectionAndSpinCount(spin, 4000); +#endif +} -#elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) -typedef pthread_t vlc_thread_t; -typedef struct +/** + * Acquires a spinlock. + */ +static inline void vlc_spin_lock (vlc_spinlock_t *spin) { - pthread_mutex_t mutex; - vlc_object_t * p_this; -} vlc_mutex_t; -typedef struct + EnterCriticalSection(spin); +} + +/** + * Releases a spinlock. + */ +static inline void vlc_spin_unlock (vlc_spinlock_t *spin) { - pthread_cond_t cond; - vlc_object_t * p_this; -} vlc_cond_t; + LeaveCriticalSection(spin); +} -typedef struct +/** + * Deinitializes a spinlock. + */ +static inline void vlc_spin_destroy (vlc_spinlock_t *spin) { - pthread_key_t handle; -} vlc_threadvar_t; + DeleteCriticalSection(spin); +} -#elif defined( HAVE_CTHREADS_H ) -typedef cthread_t vlc_thread_t; +#else -/* 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 +/* 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) { - spin_lock_t held; - spin_lock_t lock; - char *name; - struct cthread_queue queue; + return vlc_mutex_init (spin); +} - vlc_object_t * p_this; -} vlc_mutex_t; +# define vlc_spin_lock vlc_mutex_lock +# define vlc_spin_unlock vlc_mutex_unlock +# define vlc_spin_destroy vlc_mutex_destroy +#endif -typedef struct +/** + * Issues a full memory barrier. + */ +#if defined (__APPLE__) +# include /* OSMemoryBarrier() */ +#endif +static inline void barrier (void) { - spin_lock_t lock; - struct cthread_queue queue; - char *name; - struct cond_imp *implications; +#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 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 ) \ + vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, FUNC, PRIORITY ) - vlc_object_t * p_this; -} vlc_cond_t; +/***************************************************************************** + * 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 ) -typedef struct +/***************************************************************************** + * vlc_thread_join: wait until a thread exits + *****************************************************************************/ +#define vlc_thread_join( P_THIS ) \ + __vlc_thread_join( VLC_OBJECT(P_THIS) ) + +#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 { - cthread_key_t handle; -} vlc_threadvar_t; - + 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 -#endif +#endif /* !_VLC_THREADS_H */