X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fmisc%2Fthreads.c;h=33a76e4759deb1dfa4e3482d62e1c5d6ec17332d;hb=aa6b5c552d671fc1fce4ca38e5aff41ae259c28e;hp=45ca8740e2698807be99138ba9123a095e667af3;hpb=b648be13957fae14cbcddcbde0309c6d6133d494;p=vlc diff --git a/src/misc/threads.c b/src/misc/threads.c index 45ca8740e2..33a76e4759 100644 --- a/src/misc/threads.c +++ b/src/misc/threads.c @@ -1,7 +1,7 @@ /***************************************************************************** * threads.c : threads implementation for the VideoLAN client ***************************************************************************** - * Copyright (C) 1999-2007 the VideoLAN team + * Copyright (C) 1999-2008 the VideoLAN team * $Id$ * * Authors: Jean-Marc Dressler @@ -28,13 +28,15 @@ # include "config.h" #endif -#include +#include #include "libvlc.h" +#include #include #ifdef HAVE_UNISTD_H # include #endif +#include #define VLC_THREADS_UNINITIALIZED 0 #define VLC_THREADS_PENDING 1 @@ -45,27 +47,37 @@ * Global mutex for lazy initialization of the threads system *****************************************************************************/ static volatile unsigned i_initializations = 0; -static volatile int i_status = VLC_THREADS_UNINITIALIZED; -static vlc_object_t *p_root; -#if defined( UNDER_CE ) -#elif defined( WIN32 ) - -/* -** On Windows 9x/Me you can use a fast but incorrect condition variables -** implementation (more precisely there is a possibility for a race -** condition to happen). -** However it is possible to use slower alternatives which are more robust. -** Currently you can choose between implementation 0 (which is the -** fastest but slightly incorrect), 1 (default) and 2. -*/ -static int i_win9x_cv = 1; +#if defined( LIBVLC_USE_PTHREAD ) +# include -#elif defined( HAVE_KERNEL_SCHEDULER_H ) -#elif defined( LIBVLC_USE_PTHREAD ) static pthread_mutex_t once_mutex = PTHREAD_MUTEX_INITIALIZER; #endif +/** + * Global process-wide VLC object. + * Contains inter-instance data, such as the module cache and global mutexes. + */ +static libvlc_global_data_t *p_root; + +libvlc_global_data_t *vlc_global( void ) +{ + assert( i_initializations > 0 ); + return p_root; +} + +#ifndef NDEBUG +/** + * Object running the current thread + */ +static vlc_threadvar_t thread_object_key; + +vlc_object_t *vlc_threadobj (void) +{ + return vlc_threadvar_get (&thread_object_key); +} +#endif + vlc_threadvar_t msg_context_global_key; #if defined(LIBVLC_USE_PTHREAD) @@ -76,6 +88,9 @@ static inline unsigned long vlc_threadid (void) return v.i; } +#if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE) +# include +#endif /***************************************************************************** * vlc_thread_fatal: Report an error from the threading layer @@ -87,14 +102,13 @@ void vlc_pthread_fatal (const char *action, int error, { fprintf (stderr, "LibVLC fatal error %s in thread %lu at %s:%u: %d\n", action, vlc_threadid (), file, line, error); - fflush (stderr); /* Sometimes strerror_r() crashes too, so make sure we print an error * message before we invoke it */ #ifdef __GLIBC__ /* Avoid the strerror_r() prototype brain damage in glibc */ errno = error; - fprintf (stderr, " Error message: %m\n"); + fprintf (stderr, " Error message: %m at:\n"); #else char buf[1000]; const char *msg; @@ -113,12 +127,26 @@ void vlc_pthread_fatal (const char *action, int error, } fprintf (stderr, " Error message: %s\n", msg); #endif - fflush (stderr); + +#ifdef HAVE_BACKTRACE + void *stack[20]; + int len = backtrace (stack, sizeof (stack) / sizeof (stack[0])); + backtrace_symbols_fd (stack, len, 2); +#endif + abort (); } -#endif +#else +void vlc_pthread_fatal (const char *action, int error, + const char *file, unsigned line) +{ + (void)action; (void)error; (void)file; (void)line; + abort(); +} +static vlc_threadvar_t cancel_key; +#endif /***************************************************************************** * vlc_threads_init: initialize threads system @@ -127,72 +155,44 @@ void vlc_pthread_fatal (const char *action, int error, * keep the library really thread-safe. Some architectures don't support this * and thus do not guarantee the complete reentrancy. *****************************************************************************/ -int __vlc_threads_init( vlc_object_t *p_this ) +int vlc_threads_init( void ) { - libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_this; int i_ret = VLC_SUCCESS; /* If we have lazy mutex initialization, use it. Otherwise, we just * hope nothing wrong happens. */ -#if defined( UNDER_CE ) -#elif defined( WIN32 ) - if( IsDebuggerPresent() ) - { - /* SignalObjectAndWait() is problematic under a debugger */ - i_win9x_cv = 1; - } -#elif defined( HAVE_KERNEL_SCHEDULER_H ) -#elif defined( LIBVLC_USE_PTHREAD ) +#if defined( LIBVLC_USE_PTHREAD ) pthread_mutex_lock( &once_mutex ); #endif - if( i_status == VLC_THREADS_UNINITIALIZED ) + if( i_initializations == 0 ) { - i_status = VLC_THREADS_PENDING; - - /* We should be safe now. Do all the initialization stuff we want. */ - p_libvlc_global->b_ready = false; - - p_root = vlc_custom_create( VLC_OBJECT(p_libvlc_global), 0, - VLC_OBJECT_GLOBAL, "global" ); + p_root = vlc_custom_create( (vlc_object_t *)NULL, sizeof( *p_root ), + VLC_OBJECT_GENERIC, "root" ); if( p_root == NULL ) - i_ret = VLC_ENOMEM; - - if( i_ret ) - { - i_status = VLC_THREADS_ERROR; - } - else { - i_initializations++; - i_status = VLC_THREADS_READY; + i_ret = VLC_ENOMEM; + goto out; } - vlc_threadvar_create( p_root, &msg_context_global_key ); - } - else - { - /* Just increment the initialization count */ - i_initializations++; + /* We should be safe now. Do all the initialization stuff we want. */ +#ifndef NDEBUG + vlc_threadvar_create( &thread_object_key, NULL ); +#endif + vlc_threadvar_create( &msg_context_global_key, msg_StackDestroy ); +#ifndef LIBVLC_USE_PTHREAD + vlc_threadvar_create( &cancel_key, free ); +#endif } + i_initializations++; - /* If we have lazy mutex initialization support, unlock the mutex; - * otherwize, do a naive wait loop. */ -#if defined( UNDER_CE ) - while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP ); -#elif defined( WIN32 ) - while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP ); -#elif defined( HAVE_KERNEL_SCHEDULER_H ) - while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP ); -#elif defined( LIBVLC_USE_PTHREAD ) +out: + /* If we have lazy mutex initialization support, unlock the mutex. + * Otherwize, we are screwed. */ +#if defined( LIBVLC_USE_PTHREAD ) pthread_mutex_unlock( &once_mutex ); #endif - if( i_status != VLC_THREADS_READY ) - { - return VLC_ETHREAD; - } - return i_ret; } @@ -201,52 +201,66 @@ int __vlc_threads_init( vlc_object_t *p_this ) ***************************************************************************** * FIXME: This function is far from being threadsafe. *****************************************************************************/ -int __vlc_threads_end( vlc_object_t *p_this ) +void vlc_threads_end( void ) { - (void)p_this; -#if defined( UNDER_CE ) -#elif defined( WIN32 ) -#elif defined( HAVE_KERNEL_SCHEDULER_H ) -#elif defined( LIBVLC_USE_PTHREAD ) +#if defined( LIBVLC_USE_PTHREAD ) pthread_mutex_lock( &once_mutex ); #endif - if( i_initializations == 0 ) - return VLC_EGENERIC; + assert( i_initializations > 0 ); - i_initializations--; - if( i_initializations == 0 ) + if( i_initializations == 1 ) { - i_status = VLC_THREADS_UNINITIALIZED; vlc_object_release( p_root ); +#ifndef LIBVLC_USE_PTHREAD + vlc_threadvar_delete( &cancel_key ); +#endif + vlc_threadvar_delete( &msg_context_global_key ); +#ifndef NDEBUG + vlc_threadvar_delete( &thread_object_key ); +#endif } + i_initializations--; -#if defined( UNDER_CE ) -#elif defined( WIN32 ) -#elif defined( HAVE_KERNEL_SCHEDULER_H ) -#elif defined( LIBVLC_USE_PTHREAD ) +#if defined( LIBVLC_USE_PTHREAD ) pthread_mutex_unlock( &once_mutex ); #endif - return VLC_SUCCESS; } -#ifdef __linux__ -/* This is not prototyped under Linux, though it exists. */ +#if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6) +/* This is not prototyped under glibc, though it exists. */ int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind ); #endif /***************************************************************************** * vlc_mutex_init: initialize a mutex *****************************************************************************/ -int __vlc_mutex_init( vlc_mutex_t *p_mutex ) +int vlc_mutex_init( vlc_mutex_t *p_mutex ) { -#if defined( UNDER_CE ) +#if defined( LIBVLC_USE_PTHREAD ) + pthread_mutexattr_t attr; + int i_result; + + pthread_mutexattr_init( &attr ); + +# ifndef NDEBUG + /* Create error-checking mutex to detect problems more easily. */ +# if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6) + pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP ); +# else + pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK ); +# endif +# endif + i_result = pthread_mutex_init( p_mutex, &attr ); + pthread_mutexattr_destroy( &attr ); + return i_result; +#elif defined( UNDER_CE ) InitializeCriticalSection( &p_mutex->csection ); return 0; #elif defined( WIN32 ) - p_mutex->mutex = CreateMutex( 0, FALSE, 0 ); - return ( p_mutex->mutex != NULL ? 0 : 1 ); + *p_mutex = CreateMutex( 0, FALSE, 0 ); + return (*p_mutex != NULL) ? 0 : ENOMEM; #elif defined( HAVE_KERNEL_SCHEDULER_H ) /* check the arguments and whether it's already been initialized */ @@ -269,52 +283,31 @@ int __vlc_mutex_init( vlc_mutex_t *p_mutex ) p_mutex->init = 9999; return B_OK; -#elif defined( LIBVLC_USE_PTHREAD ) - pthread_mutexattr_t attr; - int i_result; - - pthread_mutexattr_init( &attr ); - -# ifndef NDEBUG - /* Create error-checking mutex to detect problems more easily. */ -# if defined(SYS_LINUX) - pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP ); -# else - pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK ); -# endif -# endif - i_result = pthread_mutex_init( p_mutex, &attr ); - pthread_mutexattr_destroy( &attr ); - return i_result; #endif } /***************************************************************************** * vlc_mutex_init: initialize a recursive mutex (Do not use) *****************************************************************************/ -int __vlc_mutex_init_recursive( vlc_mutex_t *p_mutex ) +int vlc_mutex_init_recursive( vlc_mutex_t *p_mutex ) { -#if defined( WIN32 ) - /* Create mutex returns a recursive mutex */ - p_mutex->mutex = CreateMutex( 0, FALSE, 0 ); - return ( p_mutex->mutex != NULL ? 0 : 1 ); -#elif defined( LIBVLC_USE_PTHREAD ) +#if defined( LIBVLC_USE_PTHREAD ) pthread_mutexattr_t attr; int i_result; pthread_mutexattr_init( &attr ); -# ifndef NDEBUG - /* Create error-checking mutex to detect problems more easily. */ -# if defined(SYS_LINUX) - pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP ); -# else - pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK ); -# endif -# endif +# if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6) + pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_RECURSIVE_NP ); +# else pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE ); +# endif i_result = pthread_mutex_init( p_mutex, &attr ); pthread_mutexattr_destroy( &attr ); return( i_result ); +#elif defined( WIN32 ) + /* Create mutex returns a recursive mutex */ + *p_mutex = CreateMutex( 0, FALSE, 0 ); + return (*p_mutex != NULL) ? 0 : ENOMEM; #else # error Unimplemented! #endif @@ -326,7 +319,11 @@ int __vlc_mutex_init_recursive( vlc_mutex_t *p_mutex ) *****************************************************************************/ void __vlc_mutex_destroy( const char * psz_file, int i_line, vlc_mutex_t *p_mutex ) { -#if defined( UNDER_CE ) +#if defined( LIBVLC_USE_PTHREAD ) + int val = pthread_mutex_destroy( p_mutex ); + VLC_THREAD_ASSERT ("destroying mutex"); + +#elif defined( UNDER_CE ) VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); DeleteCriticalSection( &p_mutex->csection ); @@ -334,10 +331,7 @@ void __vlc_mutex_destroy( const char * psz_file, int i_line, vlc_mutex_t *p_mute #elif defined( WIN32 ) VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); - if( p_mutex->mutex ) - CloseHandle( p_mutex->mutex ); - else - DeleteCriticalSection( &p_mutex->csection ); + CloseHandle( *p_mutex ); #elif defined( HAVE_KERNEL_SCHEDULER_H ) if( p_mutex->init == 9999 ) @@ -345,10 +339,6 @@ void __vlc_mutex_destroy( const char * psz_file, int i_line, vlc_mutex_t *p_mute p_mutex->init = 0; -#elif defined( LIBVLC_USE_PTHREAD ) - int val = pthread_mutex_destroy( p_mutex ); - VLC_THREAD_ASSERT ("destroying mutex"); - #endif } @@ -357,32 +347,34 @@ void __vlc_mutex_destroy( const char * psz_file, int i_line, vlc_mutex_t *p_mute *****************************************************************************/ int __vlc_cond_init( vlc_cond_t *p_condvar ) { -#if defined( UNDER_CE ) - /* Initialize counter */ - p_condvar->i_waiting_threads = 0; +#if defined( LIBVLC_USE_PTHREAD ) + pthread_condattr_t attr; + int ret; - /* Create an auto-reset event. */ - p_condvar->event = CreateEvent( NULL, /* no security */ - FALSE, /* auto-reset event */ - FALSE, /* start non-signaled */ - NULL ); /* unnamed */ - return !p_condvar->event; + ret = pthread_condattr_init (&attr); + if (ret) + return ret; -#elif defined( WIN32 ) - /* Initialize counter */ - p_condvar->i_waiting_threads = 0; +# if !defined (_POSIX_CLOCK_SELECTION) + /* Fairly outdated POSIX support (that was defined in 2001) */ +# define _POSIX_CLOCK_SELECTION (-1) +# endif +# if (_POSIX_CLOCK_SELECTION >= 0) + /* NOTE: This must be the same clock as the one in mtime.c */ + pthread_condattr_setclock (&attr, CLOCK_MONOTONIC); +# endif - /* Misc init */ - p_condvar->i_win9x_cv = i_win9x_cv; + ret = pthread_cond_init (p_condvar, &attr); + pthread_condattr_destroy (&attr); + return ret; +#elif defined( UNDER_CE ) || defined( WIN32 ) /* Create an auto-reset event. */ - p_condvar->event = CreateEvent( NULL, /* no security */ - FALSE, /* auto-reset event */ - FALSE, /* start non-signaled */ - NULL ); /* unnamed */ - - p_condvar->semaphore = NULL; - return !p_condvar->event; + *p_condvar = CreateEvent( NULL, /* no security */ + FALSE, /* auto-reset event */ + FALSE, /* start non-signaled */ + NULL ); /* unnamed */ + return *p_condvar ? 0 : ENOMEM; #elif defined( HAVE_KERNEL_SCHEDULER_H ) if( !p_condvar ) @@ -399,82 +391,265 @@ int __vlc_cond_init( vlc_cond_t *p_condvar ) p_condvar->init = 9999; return 0; -#elif defined( LIBVLC_USE_PTHREAD ) - pthread_condattr_t attr; - int ret; +#endif +} - ret = pthread_condattr_init (&attr); - if (ret) - return ret; +/***************************************************************************** + * vlc_cond_destroy: destroy a condition, inner version + *****************************************************************************/ +void __vlc_cond_destroy( const char * psz_file, int i_line, vlc_cond_t *p_condvar ) +{ +#if defined( LIBVLC_USE_PTHREAD ) + int val = pthread_cond_destroy( p_condvar ); + VLC_THREAD_ASSERT ("destroying condition"); -# if !defined (_POSIX_CLOCK_SELECTION) - /* Fairly outdated POSIX support (that was defined in 2001) */ -# define _POSIX_CLOCK_SELECTION (-1) -# endif -# if (_POSIX_CLOCK_SELECTION >= 0) - /* NOTE: This must be the same clock as the one in mtime.c */ - pthread_condattr_setclock (&attr, CLOCK_MONOTONIC); -# endif +#elif defined( UNDER_CE ) || defined( WIN32 ) + VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); - ret = pthread_cond_init (p_condvar, &attr); - pthread_condattr_destroy (&attr); - return ret; + CloseHandle( *p_condvar ); + +#elif defined( HAVE_KERNEL_SCHEDULER_H ) + p_condvar->init = 0; #endif } /***************************************************************************** - * vlc_cond_destroy: destroy a condition, inner version + * vlc_tls_create: create a thread-local variable *****************************************************************************/ -void __vlc_cond_destroy( const char * psz_file, int i_line, vlc_cond_t *p_condvar ) +int vlc_threadvar_create( vlc_threadvar_t *p_tls, void (*destr) (void *) ) { -#if defined( UNDER_CE ) - VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); + int i_ret; - CloseHandle( p_condvar->event ); +#if defined( LIBVLC_USE_PTHREAD ) + i_ret = pthread_key_create( p_tls, destr ); +#elif defined( UNDER_CE ) + i_ret = ENOSYS; +#elif defined( WIN32 ) + /* FIXME: remember/use the destr() callback and stop leaking whatever */ + *p_tls = TlsAlloc(); + i_ret = (*p_tls == TLS_OUT_OF_INDEXES) ? EAGAIN : 0; +#else +# error Unimplemented! +#endif + return i_ret; +} +void vlc_threadvar_delete (vlc_threadvar_t *p_tls) +{ +#if defined( LIBVLC_USE_PTHREAD ) + pthread_key_delete (*p_tls); +#elif defined( UNDER_CE ) #elif defined( WIN32 ) - VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); + TlsFree (*p_tls); +#else +# error Unimplemented! +#endif +} - if( !p_condvar->semaphore ) - CloseHandle( p_condvar->event ); - else +#if defined (LIBVLC_USE_PTHREAD) +#elif defined (WIN32) +static unsigned __stdcall vlc_entry (void *data) +{ + vlc_thread_t self = data; + self->data = self->entry (self->data); + return 0; +} +#endif + +/** + * Creates and starts new thread. + * + * @param p_handle [OUT] pointer to write the handle of the created thread to + * @param entry entry point for the thread + * @param data data parameter given to the entry point + * @param priority thread priority value + * @return 0 on success, a standard error code on error. + */ +int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data, + int priority) +{ + int ret; + +#if defined( LIBVLC_USE_PTHREAD ) + pthread_attr_t attr; + pthread_attr_init (&attr); + + /* Block the signals that signals interface plugin handles. + * If the LibVLC caller wants to handle some signals by itself, it should + * block these before whenever invoking LibVLC. And it must obviously not + * start the VLC signals interface plugin. + * + * LibVLC will normally ignore any interruption caused by an asynchronous + * signal during a system call. But there may well be some buggy cases + * where it fails to handle EINTR (bug reports welcome). Some underlying + * libraries might also not handle EINTR properly. + */ + sigset_t oldset; + { + sigset_t set; + sigemptyset (&set); + sigdelset (&set, SIGHUP); + sigaddset (&set, SIGINT); + sigaddset (&set, SIGQUIT); + sigaddset (&set, SIGTERM); + + sigaddset (&set, SIGPIPE); /* We don't want this one, really! */ + pthread_sigmask (SIG_BLOCK, &set, &oldset); + } { - CloseHandle( p_condvar->event ); - CloseHandle( p_condvar->semaphore ); + struct sched_param sp = { .sched_priority = priority, }; + int policy; + + if (sp.sched_priority <= 0) + sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER); + else + sp.sched_priority += sched_get_priority_min (policy = SCHED_RR); + + pthread_attr_setschedpolicy (&attr, policy); + pthread_attr_setschedparam (&attr, &sp); } - if( p_condvar->semaphore != NULL ) - DeleteCriticalSection( &p_condvar->csection ); + ret = pthread_create (p_handle, &attr, entry, data); + pthread_sigmask (SIG_SETMASK, &oldset, NULL); + pthread_attr_destroy (&attr); + +#elif defined( WIN32 ) || defined( UNDER_CE ) + /* When using the MSVCRT C library you have to use the _beginthreadex + * function instead of CreateThread, otherwise you'll end up with + * memory leaks and the signal functions not working (see Microsoft + * Knowledge Base, article 104641) */ + HANDLE hThread; + vlc_thread_t th = malloc (sizeof (*p_handle)); + + if (th == NULL) + return ENOMEM; + + th->data = data; + th->entry = entry; +#if defined( UNDER_CE ) + hThread = CreateThread (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL); +#else + hThread = (HANDLE)(uintptr_t) + _beginthreadex (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL); +#endif + + if (hThread) + { + /* Thread closes the handle when exiting, duplicate it here + * to be on the safe side when joining. */ + if (!DuplicateHandle (GetCurrentProcess (), hThread, + GetCurrentProcess (), &th->handle, 0, FALSE, + DUPLICATE_SAME_ACCESS)) + { + CloseHandle (hThread); + free (th); + return ENOMEM; + } + + ResumeThread (hThread); + if (priority) + SetThreadPriority (hThread, priority); + + ret = 0; + *p_handle = th; + } + else + { + ret = errno; + free (th); + } #elif defined( HAVE_KERNEL_SCHEDULER_H ) - p_condvar->init = 0; + *p_handle = spawn_thread( entry, psz_name, priority, data ); + ret = resume_thread( *p_handle ); -#elif defined( LIBVLC_USE_PTHREAD ) - int val = pthread_cond_destroy( p_condvar ); - VLC_THREAD_ASSERT ("destroying condition"); +#endif + return ret; +} + +#if defined (WIN32) +/* APC procedure for thread cancellation */ +static void CALLBACK vlc_cancel_self (ULONG_PTR dummy) +{ + (void)dummy; + vlc_control_cancel (VLC_DO_CANCEL); +} +#endif +/** + * Marks a thread as cancelled. Next time the target thread reaches a + * cancellation point (while not having disabled cancellation), it will + * run its cancellation cleanup handler, the thread variable destructors, and + * terminate. vlc_join() must be used afterward regardless of a thread being + * cancelled or not. + */ +void vlc_cancel (vlc_thread_t thread_id) +{ +#if defined (LIBVLC_USE_PTHREAD) + pthread_cancel (thread_id); +#elif defined (WIN32) + QueueUserAPC (vlc_cancel_self, thread_id->handle, 0); #endif } -/***************************************************************************** - * vlc_tls_create: create a thread-local variable - *****************************************************************************/ -int __vlc_threadvar_create( vlc_threadvar_t *p_tls ) +/** + * Waits for a thread to complete (if needed), and destroys it. + * This is a cancellation point; in case of cancellation, the join does _not_ + * occur. + * + * @param handle thread handle + * @param p_result [OUT] pointer to write the thread return value or NULL + * @return 0 on success, a standard error code otherwise. + */ +int vlc_join (vlc_thread_t handle, void **result) { - int i_ret = -1; +#if defined( LIBVLC_USE_PTHREAD ) + return pthread_join (handle, result); -#if defined( HAVE_KERNEL_SCHEDULER_H ) -# error Unimplemented! #elif defined( UNDER_CE ) || defined( WIN32 ) -#elif defined( WIN32 ) - *p_tls = TlsAlloc(); - i_ret = (*p_tls == INVALID_HANDLE_VALUE) ? EAGAIN : 0; + do + vlc_testcancel (); + while (WaitForSingleObjectEx (handle->handle, INFINITE, TRUE) + == WAIT_IO_COMPLETION); + + CloseHandle (handle->handle); + if (result) + *result = handle->data; + free (handle); + return 0; + +#elif defined( HAVE_KERNEL_SCHEDULER_H ) + int32_t exit_value; + ret = (B_OK == wait_for_thread( p_priv->thread_id, &exit_value )); + if( !ret && result ) + *result = (void *)exit_value; -#elif defined( LIBVLC_USE_PTHREAD ) - i_ret = pthread_key_create( p_tls, NULL ); + return ret; #endif - return i_ret; +} + + +struct vlc_thread_boot +{ + void * (*entry) (vlc_object_t *); + vlc_object_t *object; +}; + +static void *thread_entry (void *data) +{ + vlc_object_t *obj = ((struct vlc_thread_boot *)data)->object; + void *(*func) (vlc_object_t *) = ((struct vlc_thread_boot *)data)->entry; + + free (data); +#ifndef NDEBUG + vlc_threadvar_set (&thread_object_key, obj); +#endif + msg_Dbg (obj, "thread started"); + func (obj); + msg_Dbg (obj, "thread ended"); + + return NULL; } /***************************************************************************** @@ -484,128 +659,56 @@ int __vlc_threadvar_create( vlc_threadvar_t *p_tls ) * userland real-time priority threads. *****************************************************************************/ int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line, - const char *psz_name, void * ( *func ) ( void * ), + const char *psz_name, void * ( *func ) ( vlc_object_t * ), int i_priority, bool b_wait ) { int i_ret; - void *p_data = (void *)p_this; - vlc_object_internals_t *p_priv = p_this->p_internals; - - vlc_mutex_lock( &p_this->object_lock ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); -#if defined( WIN32 ) || defined( UNDER_CE ) - { - /* When using the MSVCRT C library you have to use the _beginthreadex - * function instead of CreateThread, otherwise you'll end up with - * memory leaks and the signal functions not working (see Microsoft - * Knowledge Base, article 104641) */ -#if defined( UNDER_CE ) - DWORD threadId; - HANDLE hThread = CreateThread( NULL, 0, (LPTHREAD_START_ROUTINE)func, - (LPVOID)p_data, CREATE_SUSPENDED, - &threadId ); -#else - unsigned threadId; - uintptr_t hThread = _beginthreadex( NULL, 0, - (LPTHREAD_START_ROUTINE)func, - (void*)p_data, CREATE_SUSPENDED, - &threadId ); -#endif - p_priv->thread_id.id = (DWORD)threadId; - p_priv->thread_id.hThread = (HANDLE)hThread; - ResumeThread((HANDLE)hThread); - } - - i_ret = ( p_priv->thread_id.hThread ? 0 : 1 ); - - if( !i_ret && i_priority ) - { - if( !SetThreadPriority(p_priv->thread_id.hThread, i_priority) ) - { - msg_Warn( p_this, "couldn't set a faster priority" ); - i_priority = 0; - } - } + struct vlc_thread_boot *boot = malloc (sizeof (*boot)); + if (boot == NULL) + return errno; + boot->entry = func; + boot->object = p_this; -#elif defined( HAVE_KERNEL_SCHEDULER_H ) - p_priv->thread_id = spawn_thread( (thread_func)func, psz_name, - i_priority, p_data ); - i_ret = resume_thread( p_priv->thread_id ); + vlc_object_lock( p_this ); -#elif defined( LIBVLC_USE_PTHREAD ) - i_ret = pthread_create( &p_priv->thread_id, NULL, func, p_data ); + /* Make sure we don't re-create a thread if the object has already one */ + assert( !p_priv->b_thread ); +#if defined( LIBVLC_USE_PTHREAD ) #ifndef __APPLE__ - if( config_GetInt( p_this, "rt-priority" ) ) + if( config_GetInt( p_this, "rt-priority" ) > 0 ) #endif { - int i_error, i_policy; - struct sched_param param; - - memset( ¶m, 0, sizeof(struct sched_param) ); + /* Hack to avoid error msg */ if( config_GetType( p_this, "rt-offset" ) ) - { i_priority += config_GetInt( p_this, "rt-offset" ); - } - if( i_priority <= 0 ) - { - param.sched_priority = (-1) * i_priority; - i_policy = SCHED_OTHER; - } - else - { - param.sched_priority = i_priority; - i_policy = SCHED_RR; - } - if( (i_error = pthread_setschedparam( p_priv->thread_id, - i_policy, ¶m )) ) - { - errno = i_error; - msg_Warn( p_this, "couldn't set thread priority (%s:%d): %m", - psz_file, i_line ); - i_priority = 0; - } - } -#ifndef __APPLE__ - else - { - i_priority = 0; } #endif -#endif - + i_ret = vlc_clone( &p_priv->thread_id, thread_entry, boot, i_priority ); if( i_ret == 0 ) { if( b_wait ) { - msg_Dbg( p_this, "waiting for thread completion" ); + msg_Dbg( p_this, "waiting for thread initialization" ); vlc_object_wait( p_this ); } p_priv->b_thread = true; - -#if defined( WIN32 ) || defined( UNDER_CE ) - msg_Dbg( p_this, "thread %u (%s) created at priority %d (%s:%d)", - (unsigned int)p_priv->thread_id.id, psz_name, - i_priority, psz_file, i_line ); -#else - msg_Dbg( p_this, "thread %u (%s) created at priority %d (%s:%d)", - (unsigned int)p_priv->thread_id, psz_name, i_priority, + msg_Dbg( p_this, "thread %lu (%s) created at priority %d (%s:%d)", + (unsigned long)p_priv->thread_id, psz_name, i_priority, psz_file, i_line ); -#endif - - - vlc_mutex_unlock( &p_this->object_lock ); } else { errno = i_ret; msg_Err( p_this, "%s thread could not be created at %s:%d (%m)", psz_name, psz_file, i_line ); - vlc_mutex_unlock( &p_this->object_lock ); } + vlc_object_unlock( p_this ); return i_ret; } @@ -616,19 +719,15 @@ int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file, int i_line, int i_priority ) { - vlc_object_internals_t *p_priv = p_this->p_internals; -#if defined( WIN32 ) || defined( UNDER_CE ) - VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); + vlc_object_internals_t *p_priv = vlc_internals( p_this ); - if( !p_priv->thread_id.hThread ) - p_priv->thread_id.hThread = GetCurrentThread(); - if( !SetThreadPriority(p_priv->thread_id.hThread, i_priority) ) + if( !p_priv->b_thread ) { - msg_Warn( p_this, "couldn't set a faster priority" ); - return 1; + msg_Err( p_this, "couldn't set priority of non-existent thread" ); + return ESRCH; } -#elif defined( LIBVLC_USE_PTHREAD ) +#if defined( LIBVLC_USE_PTHREAD ) # ifndef __APPLE__ if( config_GetInt( p_this, "rt-priority" ) > 0 ) # endif @@ -638,9 +737,7 @@ int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file, memset( ¶m, 0, sizeof(struct sched_param) ); if( config_GetType( p_this, "rt-offset" ) ) - { i_priority += config_GetInt( p_this, "rt-offset" ); - } if( i_priority <= 0 ) { param.sched_priority = (-1) * i_priority; @@ -651,10 +748,8 @@ int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file, param.sched_priority = i_priority; i_policy = SCHED_RR; } - if( !p_priv->thread_id ) - p_priv->thread_id = pthread_self(); if( (i_error = pthread_setschedparam( p_priv->thread_id, - i_policy, ¶m )) ) + i_policy, ¶m )) ) { errno = i_error; msg_Warn( p_this, "couldn't set thread priority (%s:%d): %m", @@ -662,70 +757,61 @@ int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file, i_priority = 0; } } + +#elif defined( WIN32 ) || defined( UNDER_CE ) + VLC_UNUSED( psz_file); VLC_UNUSED( i_line ); + + if( !SetThreadPriority(p_priv->thread_id->handle, i_priority) ) + { + msg_Warn( p_this, "couldn't set a faster priority" ); + return 1; + } + #endif return 0; } -/***************************************************************************** - * vlc_thread_ready: tell the parent thread we were successfully spawned - *****************************************************************************/ -void __vlc_thread_ready( vlc_object_t *p_this ) -{ - vlc_object_signal( p_this ); -} - /***************************************************************************** * vlc_thread_join: wait until a thread exits, inner version *****************************************************************************/ void __vlc_thread_join( vlc_object_t *p_this, const char * psz_file, int i_line ) { - vlc_object_internals_t *p_priv = p_this->p_internals; + vlc_object_internals_t *p_priv = vlc_internals( p_this ); + int i_ret = 0; + +#if defined( LIBVLC_USE_PTHREAD ) + /* Make sure we do return if we are calling vlc_thread_join() + * from the joined thread */ + if (pthread_equal (pthread_self (), p_priv->thread_id)) + { + msg_Warn (p_this, "joining the active thread (VLC might crash)"); + i_ret = pthread_detach (p_priv->thread_id); + } + else + i_ret = vlc_join (p_priv->thread_id, NULL); -#if defined( UNDER_CE ) || defined( WIN32 ) - HMODULE hmodule; - BOOL (WINAPI *OurGetThreadTimes)( HANDLE, FILETIME*, FILETIME*, - FILETIME*, FILETIME* ); +#elif defined( UNDER_CE ) || defined( WIN32 ) + HANDLE hThread; FILETIME create_ft, exit_ft, kernel_ft, user_ft; int64_t real_time, kernel_time, user_time; - HANDLE hThread; - /* - ** object will close its thread handle when destroyed, duplicate it here - ** to be on the safe side - */ if( ! DuplicateHandle(GetCurrentProcess(), - p_priv->thread_id.hThread, + p_priv->thread_id->handle, GetCurrentProcess(), &hThread, 0, FALSE, DUPLICATE_SAME_ACCESS) ) { - msg_Err( p_this, "thread_join(%u) failed at %s:%d (%u)", - (unsigned int)p_priv->thread_id.id, - psz_file, i_line, (unsigned int)GetLastError() ); p_priv->b_thread = false; - return; + i_ret = GetLastError(); + goto error; } - WaitForSingleObject( hThread, INFINITE ); + vlc_join( p_priv->thread_id, NULL ); - msg_Dbg( p_this, "thread %u joined (%s:%d)", - (unsigned int)p_priv->thread_id.id, - psz_file, i_line ); -#if defined( UNDER_CE ) - hmodule = GetModuleHandle( _T("COREDLL") ); -#else - hmodule = GetModuleHandle( _T("KERNEL32") ); -#endif - OurGetThreadTimes = (BOOL (WINAPI*)( HANDLE, FILETIME*, FILETIME*, - FILETIME*, FILETIME* )) - GetProcAddress( hmodule, _T("GetThreadTimes") ); - - if( OurGetThreadTimes && - OurGetThreadTimes( hThread, - &create_ft, &exit_ft, &kernel_ft, &user_ft ) ) + if( GetThreadTimes( hThread, &create_ft, &exit_ft, &kernel_ft, &user_ft ) ) { real_time = ((((int64_t)exit_ft.dwHighDateTime)<<32)| exit_ft.dwLowDateTime) - @@ -741,7 +827,7 @@ void __vlc_thread_join( vlc_object_t *p_this, const char * psz_file, int i_line user_ft.dwLowDateTime) / 10; msg_Dbg( p_this, "thread times: " - "real "I64Fd"m%fs, kernel "I64Fd"m%fs, user "I64Fd"m%fs", + "real %"PRId64"m%fs, kernel %"PRId64"m%fs, user %"PRId64"m%fs", real_time/60/1000000, (double)((real_time%(60*1000000))/1000000.0), kernel_time/60/1000000, @@ -750,38 +836,119 @@ void __vlc_thread_join( vlc_object_t *p_this, const char * psz_file, int i_line (double)((user_time%(60*1000000))/1000000.0) ); } CloseHandle( hThread ); +error: -#else /* !defined(WIN32) */ - - int i_ret = 0; - -#if defined( HAVE_KERNEL_SCHEDULER_H ) - int32_t exit_value; - i_ret = (B_OK == wait_for_thread( p_priv->thread_id, &exit_value )); +#else + i_ret = vlc_join( p_priv->thread_id, NULL ); -#elif defined( LIBVLC_USE_PTHREAD ) - /* Make sure we do return if we are calling vlc_thread_join() - * from the joined thread */ - if (pthread_equal (pthread_self (), p_priv->thread_id)) - i_ret = pthread_detach (p_priv->thread_id); - else - i_ret = pthread_join (p_priv->thread_id, NULL); #endif if( i_ret ) { errno = i_ret; - msg_Err( p_this, "thread_join(%u) failed at %s:%d (%m)", - (unsigned int)p_priv->thread_id, psz_file, i_line ); + msg_Err( p_this, "thread_join(%lu) failed at %s:%d (%m)", + (unsigned long)p_priv->thread_id, psz_file, i_line ); } else + msg_Dbg( p_this, "thread %lu joined (%s:%d)", + (unsigned long)p_priv->thread_id, psz_file, i_line ); + + p_priv->b_thread = false; +} + +void vlc_thread_cancel (vlc_object_t *obj) +{ + vlc_object_internals_t *priv = vlc_internals (obj); + + if (priv->b_thread) + vlc_cancel (priv->thread_id); +} + +#ifndef LIBVLC_USE_PTHREAD +typedef struct vlc_cancel_t +{ + vlc_cleanup_t *cleaners; + bool killable; + bool killed; +} vlc_cancel_t; +#endif + +void vlc_control_cancel (int cmd, ...) +{ + /* NOTE: This function only modifies thread-specific data, so there is no + * need to lock anything. */ +#ifdef LIBVLC_USE_PTHREAD + (void) cmd; + assert (0); +#else + va_list ap; + + va_start (ap, cmd); + + vlc_cancel_t *nfo = vlc_threadvar_get (&cancel_key); + if (nfo == NULL) { - msg_Dbg( p_this, "thread %u joined (%s:%d)", - (unsigned int)p_priv->thread_id, psz_file, i_line ); + nfo = malloc (sizeof (*nfo)); + if (nfo == NULL) + abort (); + nfo->cleaners = NULL; + nfo->killed = false; + nfo->killable = true; } + switch (cmd) + { + case VLC_SAVE_CANCEL: + { + int *p_state = va_arg (ap, int *); + *p_state = nfo->killable; + nfo->killable = false; + break; + } + + case VLC_RESTORE_CANCEL: + { + int state = va_arg (ap, int); + nfo->killable = state != 0; + break; + } + + case VLC_TEST_CANCEL: + if (nfo->killable && nfo->killed) + { + for (vlc_cleanup_t *p = nfo->cleaners; p != NULL; p = p->next) + p->proc (p->data); + free (nfo); +#if defined (LIBVLC_USE_PTHREAD) + pthread_exit (PTHREAD_CANCELLED); +#elif defined (WIN32) + _endthread (); +#else +# error Not implemented! #endif + } + break; - p_priv->b_thread = false; -} + case VLC_DO_CANCEL: + nfo->killed = true; + break; + + case VLC_CLEANUP_PUSH: + { + /* cleaner is a pointer to the caller stack, no need to allocate + * and copy anything. As a nice side effect, this cannot fail. */ + vlc_cleanup_t *cleaner = va_arg (ap, vlc_cleanup_t *); + cleaner->next = nfo->cleaners; + nfo->cleaners = cleaner; + break; + } + case VLC_CLEANUP_POP: + { + nfo->cleaners = nfo->cleaners->next; + break; + } + } + va_end (ap); +#endif +}