/*****************************************************************************
* 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 <polux@via.ecp.fr>
#include <vlc_common.h>
#include "libvlc.h"
+#include <stdarg.h>
#include <assert.h>
#ifdef HAVE_UNISTD_H
# include <unistd.h>
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)
static inline unsigned long vlc_threadid (void)
{
(void)action; (void)error; (void)file; (void)line;
abort();
}
+
+static vlc_threadvar_t cancel_key;
+#endif
+
+/**
+ * Per-thread cancellation data
+ */
+#ifndef LIBVLC_USE_PTHREAD_CANCEL
+typedef struct vlc_cancel_t
+{
+ vlc_cleanup_t *cleaners;
+ bool killable;
+ bool killed;
+} vlc_cancel_t;
+
+# define VLC_CANCEL_INIT { NULL, false, true }
#endif
/*****************************************************************************
}
/* We should be safe now. Do all the initialization stuff we want. */
-#ifndef NDEBUG
- vlc_threadvar_create( &thread_object_key, NULL );
+#ifndef LIBVLC_USE_PTHREAD_CANCEL
+ vlc_threadvar_create( &cancel_key, free );
#endif
- vlc_threadvar_create( &msg_context_global_key, msg_StackDestroy );
}
i_initializations++;
if( i_initializations == 1 )
{
vlc_object_release( p_root );
- vlc_threadvar_delete( &msg_context_global_key );
-#ifndef NDEBUG
- vlc_threadvar_delete( &thread_object_key );
+#ifndef LIBVLC_USE_PTHREAD
+ vlc_threadvar_delete( &cancel_key );
#endif
}
i_initializations--;
#endif
}
-struct vlc_thread_boot
-{
- void * (*entry) (vlc_object_t *);
- vlc_object_t *object;
-};
-
#if defined (LIBVLC_USE_PTHREAD)
-# define THREAD_RTYPE void *
-# define THREAD_RVAL NULL
#elif defined (WIN32)
-# define THREAD_RTYPE __stdcall unsigned
-# define THREAD_RVAL 0
-#endif
-
-static THREAD_RTYPE thread_entry (void *data)
+static unsigned __stdcall vlc_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");
+ vlc_cancel_t cancel_data = VLC_CANCEL_INIT;
+ vlc_thread_t self = data;
- return THREAD_RVAL;
+ vlc_threadvar_set (&cancel_key, &cancel_data);
+ self->data = self->entry (self->data);
+ return 0;
}
+#endif
-/*****************************************************************************
- * vlc_thread_create: create a thread, inner version
- *****************************************************************************
- * Note that i_priority is only taken into account on platforms supporting
- * 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 ) ( vlc_object_t * ),
- int i_priority, bool b_wait )
+/**
+ * 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 i_ret;
- vlc_object_internals_t *p_priv = vlc_internals( p_this );
- libvlc_priv_t *libpriv = libvlc_priv (p_this->p_libvlc);
-
- struct vlc_thread_boot *boot = malloc (sizeof (*boot));
- if (boot == NULL)
- return errno;
- boot->entry = func;
- boot->object = p_this;
-
- vlc_mutex_lock (&libpriv->threads_lock);
- libpriv->threads_count++;
- vlc_mutex_unlock (&libpriv->threads_lock);
-
- vlc_object_lock( p_this );
-
- /* Make sure we don't re-create a thread if the object has already one */
- assert( !p_priv->b_thread );
+ int ret;
#if defined( LIBVLC_USE_PTHREAD )
pthread_attr_t attr;
* where it fails to handle EINTR (bug reports welcome). Some underlying
* libraries might also not handle EINTR properly.
*/
- sigset_t set, oldset;
- 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);
-
-#ifndef __APPLE__
- if( config_GetInt( p_this, "rt-priority" ) > 0 )
-#endif
+ sigset_t oldset;
{
- struct sched_param p = { .sched_priority = i_priority, };
+ 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);
+ }
+ {
+ struct sched_param sp = { .sched_priority = priority, };
int policy;
- /* Hack to avoid error msg */
- if( config_GetType( p_this, "rt-offset" ) )
- p.sched_priority += config_GetInt( p_this, "rt-offset" );
- if( p.sched_priority <= 0 )
- p.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
+ if (sp.sched_priority <= 0)
+ sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
else
- p.sched_priority += sched_get_priority_min (policy = SCHED_RR);
+ sp.sched_priority += sched_get_priority_min (policy = SCHED_RR);
pthread_attr_setschedpolicy (&attr, policy);
- pthread_attr_setschedparam (&attr, &p);
+ pthread_attr_setschedparam (&attr, &sp);
}
- i_ret = pthread_create( &p_priv->thread_id, &attr, thread_entry, boot );
+ ret = pthread_create (p_handle, &attr, entry, data);
pthread_sigmask (SIG_SETMASK, &oldset, NULL);
pthread_attr_destroy (&attr);
* 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 )
- HANDLE hThread = CreateThread( NULL, 0, thread_entry,
- (LPVOID)boot, CREATE_SUSPENDED, NULL );
+ hThread = CreateThread (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
#else
- HANDLE hThread = (HANDLE)(uintptr_t)
- _beginthreadex( NULL, 0, thread_entry, boot, CREATE_SUSPENDED, NULL );
+ hThread = (HANDLE)(uintptr_t)
+ _beginthreadex (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
#endif
- if( hThread )
+
+ if (hThread)
{
- p_priv->thread_id = hThread;
- ResumeThread (hThread);
- i_ret = 0;
- if( i_priority && !SetThreadPriority (hThread, i_priority) )
+ /* 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))
{
- msg_Warn( p_this, "couldn't set a faster priority" );
- i_priority = 0;
+ CloseHandle (hThread);
+ free (th);
+ return ENOMEM;
}
+
+ ResumeThread (hThread);
+ if (priority)
+ SetThreadPriority (hThread, priority);
+
+ ret = 0;
+ *p_handle = th;
}
else
- i_ret = errno;
+ {
+ ret = errno;
+ free (th);
+ }
+
+#elif defined( HAVE_KERNEL_SCHEDULER_H )
+ *p_handle = spawn_thread( entry, psz_name, priority, data );
+ ret = resume_thread( *p_handle );
+
+#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_CANCEL)
+ pthread_cancel (thread_id);
+#elif defined (WIN32)
+ QueueUserAPC (vlc_cancel_self, thread_id->handle, 0);
+#else
+# warning vlc_cancel is not implemented!
+#endif
+}
+
+/**
+ * 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.
+ */
+void vlc_join (vlc_thread_t handle, void **result)
+{
+#if defined( LIBVLC_USE_PTHREAD )
+ int val = pthread_join (handle, result);
+ if (val)
+ vlc_pthread_fatal ("joining thread", val, __FILE__, __LINE__);
+
+#elif defined( UNDER_CE ) || defined( WIN32 )
+ do
+ vlc_testcancel ();
+ while (WaitForSingleObjectEx (handle->handle, INFINITE, TRUE)
+ == WAIT_IO_COMPLETION);
+
+ CloseHandle (handle->handle);
+ if (result)
+ *result = handle->data;
+ free (handle);
#elif defined( HAVE_KERNEL_SCHEDULER_H )
- p_priv->thread_id = spawn_thread( (thread_func)thread_entry, psz_name,
- i_priority, p_data );
- i_ret = resume_thread( p_priv->thread_id );
+ int32_t exit_value;
+ int val = (B_OK == wait_for_thread( p_priv->thread_id, &exit_value ));
+ if( !val && result )
+ *result = (void *)exit_value;
+#endif
+}
+
+
+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);
+ msg_Dbg (obj, "thread started");
+ func (obj);
+ msg_Dbg (obj, "thread ended");
+
+ return NULL;
+}
+
+/*****************************************************************************
+ * vlc_thread_create: create a thread, inner version
+ *****************************************************************************
+ * Note that i_priority is only taken into account on platforms supporting
+ * 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 ) ( vlc_object_t * ),
+ int i_priority, bool b_wait )
+{
+ int i_ret;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
+
+ struct vlc_thread_boot *boot = malloc (sizeof (*boot));
+ if (boot == NULL)
+ return errno;
+ boot->entry = func;
+ boot->object = p_this;
+
+ vlc_object_lock( p_this );
+
+ /* 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" ) > 0 )
+#endif
+ {
+ /* Hack to avoid error msg */
+ if( config_GetType( p_this, "rt-offset" ) )
+ i_priority += config_GetInt( p_this, "rt-offset" );
+ }
#endif
+ i_ret = vlc_clone( &p_priv->thread_id, thread_entry, boot, i_priority );
if( i_ret == 0 )
{
if( b_wait )
}
vlc_object_unlock( p_this );
-
- if (i_ret)
- {
- vlc_mutex_lock (&libpriv->threads_lock);
- if (--libpriv->threads_count == 0)
- vlc_cond_signal (&libpriv->threads_wait);
- vlc_mutex_unlock (&libpriv->threads_lock);
- }
return i_ret;
}
#elif defined( WIN32 ) || defined( UNDER_CE )
VLC_UNUSED( psz_file); VLC_UNUSED( i_line );
- if( !SetThreadPriority(p_priv->thread_id, i_priority) )
+ if( !SetThreadPriority(p_priv->thread_id->handle, i_priority) )
{
msg_Warn( p_this, "couldn't set a faster priority" );
return 1;
/*****************************************************************************
* 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 )
+void __vlc_thread_join( vlc_object_t *p_this )
{
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 = pthread_join (p_priv->thread_id, NULL);
+ vlc_join (p_priv->thread_id, NULL);
#elif defined( UNDER_CE ) || defined( WIN32 )
- HMODULE hmodule;
- BOOL (WINAPI *OurGetThreadTimes)( HANDLE, FILETIME*, FILETIME*,
- FILETIME*, FILETIME* );
+ 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,
+ p_priv->thread_id->handle,
GetCurrentProcess(),
&hThread,
0,
DUPLICATE_SAME_ACCESS) )
{
p_priv->b_thread = false;
- i_ret = GetLastError();
- goto error;
+ return; /* We have a problem! */
}
- WaitForSingleObject( hThread, INFINITE );
+ vlc_join( p_priv->thread_id, NULL );
-#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) -
(double)((user_time%(60*1000000))/1000000.0) );
}
CloseHandle( hThread );
-error:
-#elif defined( HAVE_KERNEL_SCHEDULER_H )
- int32_t exit_value;
- i_ret = (B_OK == wait_for_thread( p_priv->thread_id, &exit_value ));
+#else
+ vlc_join( p_priv->thread_id, NULL );
#endif
- if( i_ret )
+ 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);
+}
+
+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_CANCEL
+ (void) cmd;
+ assert (0);
+#else
+ va_list ap;
+
+ va_start (ap, cmd);
+
+ vlc_cancel_t *nfo = vlc_threadvar_get (&cancel_key);
+#ifndef WIN32
+ if (nfo == NULL)
{
- errno = i_ret;
- msg_Err( p_this, "thread_join(%lu) failed at %s:%d (%m)",
- (unsigned long)p_priv->thread_id, psz_file, i_line );
+ nfo = malloc (sizeof (*nfo));
+ if (nfo == NULL)
+ abort ();
+ *nfo = VLC_CANCEL_INIT;
+ vlc_threadvar_set (&cancel_key, nfo);
}
- else
+#endif
+
+ switch (cmd)
{
- libvlc_priv_t *libpriv = libvlc_priv (p_this->p_libvlc);
- msg_Dbg( p_this, "thread %lu joined (%s:%d)",
- (unsigned long)p_priv->thread_id, psz_file, i_line );
- vlc_mutex_lock (&libpriv->threads_lock);
-#ifndef NDEBUG
- libpriv->threads_count--;
+ 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
- if (--libpriv->threads_count == 0)
+# error Not implemented!
#endif
- vlc_cond_signal (&libpriv->threads_wait);
- vlc_mutex_unlock (&libpriv->threads_lock);
- }
+ }
+ 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
}
projects / vlc / blobdiff