]> git.sesse.net Git - vlc/blobdiff - src/misc/threads.c
Thread cancellation on WinCE
[vlc] / src / misc / threads.c
index bcfcd016bfcb143ac15f85c19c07e6ecd9628099..c7d79574b27cae8c69d1f5076e5c6dd944c90864 100644 (file)
 #endif
 #include <signal.h>
 
-#define VLC_THREADS_UNINITIALIZED  0
-#define VLC_THREADS_PENDING        1
-#define VLC_THREADS_ERROR          2
-#define VLC_THREADS_READY          3
-
-/*****************************************************************************
- * Global mutex for lazy initialization of the threads system
- *****************************************************************************/
-static volatile unsigned i_initializations = 0;
-
 #if defined( LIBVLC_USE_PTHREAD )
 # include <sched.h>
-
-static pthread_mutex_t once_mutex = PTHREAD_MUTEX_INITIALIZER;
 #else
 static vlc_threadvar_t cancel_key;
 #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;
-}
-
 #ifdef HAVE_EXECINFO_H
 # include <execinfo.h>
 #endif
@@ -124,7 +100,7 @@ vlc_thread_fatal (const char *action, int error,
 #ifdef __GLIBC__
     /* Avoid the strerror_r() prototype brain damage in glibc */
     errno = error;
-    fprintf (stderr, " Error message: %m at:\n");
+    fprintf (stderr, " Error message: %m\n");
 #elif !defined (WIN32)
     char buf[1000];
     const char *msg;
@@ -164,81 +140,120 @@ typedef struct vlc_cancel_t
     vlc_cleanup_t *cleaners;
     bool           killable;
     bool           killed;
+# ifdef UNDER_CE
+    HANDLE         cancel_event;
+# endif
 } vlc_cancel_t;
 
-# define VLC_CANCEL_INIT { NULL, true, false }
+# ifndef UNDER_CE
+#  define VLC_CANCEL_INIT { NULL, true, false }
+# else
+#  define VLC_CANCEL_INIT { NULL, true, false, NULL }
+# endif
 #endif
 
-/*****************************************************************************
- * vlc_threads_init: initialize threads system
- *****************************************************************************
- * This function requires lazy initialization of a global lock in order to
- * keep the library really thread-safe. Some architectures don't support this
- * and thus do not guarantee the complete reentrancy.
- *****************************************************************************/
-int vlc_threads_init( void )
-{
-    int i_ret = VLC_SUCCESS;
-
-    /* If we have lazy mutex initialization, use it. Otherwise, we just
-     * hope nothing wrong happens. */
-#if defined( LIBVLC_USE_PTHREAD )
-    pthread_mutex_lock( &once_mutex );
-#endif
+#ifdef UNDER_CE
+static void CALLBACK vlc_cancel_self (ULONG_PTR dummy);
 
-    if( i_initializations == 0 )
+static DWORD vlc_cancelable_wait (DWORD count, const HANDLE *handles,
+                                  DWORD delay)
+{
+    vlc_cancel_t *nfo = vlc_threadvar_get (&cancel_key);
+    if (nfo == NULL)
     {
-        p_root = vlc_custom_create( (vlc_object_t *)NULL, sizeof( *p_root ),
-                                    VLC_OBJECT_GENERIC, "root" );
-        if( p_root == NULL )
-        {
-            i_ret = VLC_ENOMEM;
-            goto out;
-        }
+        /* Main thread - cannot be cancelled anyway */
+        return WaitForMultipleObjects (count, handles, FALSE, delay);
+    }
+    HANDLE new_handles[count + 1];
+    memcpy(new_handles, handles, count * sizeof(HANDLE));
+    new_handles[count] = nfo->cancel_event;
+    DWORD result = WaitForMultipleObjects (count + 1, new_handles, FALSE,
+                                           delay);
+    if (result == WAIT_OBJECT_0 + count)
+    {
+        vlc_cancel_self (NULL);
+        return WAIT_IO_COMPLETION;
+    }
+    else
+    {
+        return result;
+    }
+}
 
-        /* We should be safe now. Do all the initialization stuff we want. */
-#ifndef LIBVLC_USE_PTHREAD_CANCEL
-        vlc_threadvar_create( &cancel_key, free );
-#endif
+DWORD SleepEx (DWORD dwMilliseconds, BOOL bAlertable)
+{
+    if (bAlertable)
+    {
+        DWORD result = vlc_cancelable_wait (0, NULL, dwMilliseconds);
+        return (result == WAIT_TIMEOUT) ? 0 : WAIT_IO_COMPLETION;
     }
-    i_initializations++;
+    else
+    {
+        Sleep(dwMilliseconds);
+        return 0;
+    }
+}
 
-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 );
+DWORD WaitForSingleObjectEx (HANDLE hHandle, DWORD dwMilliseconds,
+                             BOOL bAlertable)
+{
+    if (bAlertable)
+    {
+        /* The MSDN documentation specifies different return codes,
+         * but in practice they are the same. We just check that it
+         * remains so. */
+#if WAIT_ABANDONED != WAIT_ABANDONED_0
+# error Windows headers changed, code needs to be rewritten!
 #endif
-
-    return i_ret;
+        return vlc_cancelable_wait (1, &hHandle, dwMilliseconds);
+    }
+    else
+    {
+        return WaitForSingleObject (hHandle, dwMilliseconds);
+    }
 }
 
-/*****************************************************************************
- * vlc_threads_end: stop threads system
- *****************************************************************************
- * FIXME: This function is far from being threadsafe.
- *****************************************************************************/
-void vlc_threads_end( void )
+DWORD WaitForMultipleObjectsEx (DWORD nCount, const HANDLE *lpHandles,
+                                BOOL bWaitAll, DWORD dwMilliseconds,
+                                BOOL bAlertable)
 {
-#if defined( LIBVLC_USE_PTHREAD )
-    pthread_mutex_lock( &once_mutex );
+    if (bAlertable)
+    {
+        /* We do not support the bWaitAll case */
+        assert (! bWaitAll);
+        return vlc_cancelable_wait (nCount, lpHandles, dwMilliseconds);
+    }
+    else
+    {
+        return WaitForMultipleObjects (nCount, lpHandles, bWaitAll,
+                                       dwMilliseconds);
+    }
+}
 #endif
 
-    assert( i_initializations > 0 );
+#ifdef WIN32
+static vlc_mutex_t super_mutex;
+
+BOOL WINAPI DllMain (HINSTANCE hinstDll, DWORD fdwReason, LPVOID lpvReserved)
+{
+    (void) hinstDll;
+    (void) lpvReserved;
 
-    if( i_initializations == 1 )
+    switch (fdwReason)
     {
-        vlc_object_release( p_root );
-#ifndef LIBVLC_USE_PTHREAD
-        vlc_threadvar_delete( &cancel_key );
-#endif
-    }
-    i_initializations--;
+        case DLL_PROCESS_ATTACH:
+            vlc_mutex_init (&super_mutex);
+            vlc_threadvar_create (&cancel_key, free);
+            break;
 
-#if defined( LIBVLC_USE_PTHREAD )
-    pthread_mutex_unlock( &once_mutex );
-#endif
+        case DLL_PROCESS_DETACH:
+            vlc_threadvar_delete( &cancel_key );
+            vlc_mutex_destroy (&super_mutex);
+            break;
+    }
+    return TRUE;
 }
+#endif
 
 #if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 /* This is not prototyped under glibc, though it exists. */
@@ -269,8 +284,10 @@ int vlc_mutex_init( vlc_mutex_t *p_mutex )
     return i_result;
 
 #elif defined( WIN32 )
+    /* This creates a recursive mutex. This is OK as fast mutexes have
+     * no defined behavior in case of recursive locking. */
     InitializeCriticalSection (&p_mutex->mutex);
-    p_mutex->recursive = false;
+    p_mutex->initialized = 1;
     return 0;
 
 #endif
@@ -297,9 +314,7 @@ int vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
 
 #elif defined( WIN32 )
     InitializeCriticalSection( &p_mutex->mutex );
-    p_mutex->owner = 0; /* the error value for GetThreadId()! */
-    p_mutex->recursion = 0;
-    p_mutex->recursive = true;
+    p_mutex->initialized = 1;
     return 0;
 
 #endif
@@ -319,6 +334,7 @@ void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
     VLC_THREAD_ASSERT ("destroying mutex");
 
 #elif defined( WIN32 )
+    assert (p_mutex->initialized);
     DeleteCriticalSection (&p_mutex->mutex);
 
 #endif
@@ -339,24 +355,15 @@ void vlc_mutex_lock (vlc_mutex_t *p_mutex)
     VLC_THREAD_ASSERT ("locking mutex");
 
 #elif defined( WIN32 )
-    if (p_mutex->recursive)
-    {
-        DWORD self = GetCurrentThreadId ();
-
-        if ((DWORD)InterlockedCompareExchange (&p_mutex->owner, self,
-                                               self) == self)
-        {   /* We already locked this recursive mutex */
-            p_mutex->recursion++;
-            return;
-        }
-
-        /* We need to lock this recursive mutex */
-        EnterCriticalSection (&p_mutex->mutex);
-        self = InterlockedCompareExchange (&p_mutex->owner, self, 0);
-        assert (self == 0); /* no previous owner */
-        return;
+    if (InterlockedCompareExchange (&p_mutex->initialized, 0, 0) == 0)
+    { /* ^^ We could also lock super_mutex all the time... sluggish */
+        assert (p_mutex != &super_mutex); /* this one cannot be static */
+
+        vlc_mutex_lock (&super_mutex);
+        vlc_mutex_init (p_mutex);
+        /* FIXME: destroy the mutex some time... */
+        vlc_mutex_unlock (&super_mutex);
     }
-    /* Non-recursive mutex */
     EnterCriticalSection (&p_mutex->mutex);
 
 #endif
@@ -374,17 +381,6 @@ void vlc_mutex_unlock (vlc_mutex_t *p_mutex)
     VLC_THREAD_ASSERT ("unlocking mutex");
 
 #elif defined( WIN32 )
-    if (p_mutex->recursive)
-    {
-        if (--p_mutex->recursion != 0)
-            return; /* We still own this mutex */
-
-        /* We release the mutex */
-        DWORD self = GetCurrentThreadId ();
-        self = InterlockedCompareExchange (&p_mutex->owner, self, 0);
-        assert (self == GetCurrentThreadId ());
-        /* fall through */
-    }
     LeaveCriticalSection (&p_mutex->mutex);
 
 #endif
@@ -477,11 +473,6 @@ void vlc_cond_broadcast (vlc_cond_t *p_condvar)
 #endif
 }
 
-#ifdef UNDER_CE
-# warning FIXME
-# define WaitForMultipleObjectsEx(a,b,c) WaitForMultipleObjects(a,b)
-#endif
-
 /**
  * Waits for a condition variable. The calling thread will be suspended until
  * another thread calls vlc_cond_signal() or vlc_cond_broadcast() on the same
@@ -524,6 +515,7 @@ void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
 
 #elif defined( WIN32 )
     DWORD result;
+
     do
     {
         vlc_testcancel ();
@@ -533,6 +525,8 @@ void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
     }
     while (result == WAIT_IO_COMPLETION);
 
+    ResetEvent (*p_condvar);
+
 #endif
 }
 
@@ -577,6 +571,8 @@ int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
     }
     while (result == WAIT_IO_COMPLETION);
 
+    ResetEvent (*p_condvar);
+
     return (result == WAIT_OBJECT_0) ? 0 : ETIMEDOUT;
 
 #endif
@@ -591,8 +587,6 @@ int vlc_threadvar_create( vlc_threadvar_t *p_tls, void (*destr) (void *) )
 
 #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();
@@ -607,7 +601,6 @@ 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 )
     TlsFree (*p_tls);
 #else
@@ -621,6 +614,9 @@ static unsigned __stdcall vlc_entry (void *data)
 {
     vlc_cancel_t cancel_data = VLC_CANCEL_INIT;
     vlc_thread_t self = data;
+#ifdef UNDER_CE
+    cancel_data.cancel_event = self->cancel_event;
+#endif
 
     vlc_threadvar_set (&cancel_key, &cancel_data);
     self->data = self->entry (self->data);
@@ -681,6 +677,25 @@ int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
         pthread_attr_setschedparam (&attr, &sp);
     }
 
+    /* The thread stack size.
+     * The lower the value, the less address space per thread, the highest
+     * maximum simultaneous threads per process. Too low values will cause
+     * stack overflows and weird crashes. Set with caution. Also keep in mind
+     * that 64-bits platforms consume more stack than 32-bits one.
+     *
+     * Thanks to on-demand paging, thread stack size only affects address space
+     * consumption. In terms of memory, threads only use what they need
+     * (rounded up to the page boundary).
+     *
+     * For example, on Linux i386, the default is 2 mega-bytes, which supports
+     * about 320 threads per processes. */
+#define VLC_STACKSIZE (128 * sizeof (void *) * 1024)
+
+#ifdef VLC_STACKSIZE
+    ret = pthread_attr_setstacksize (&attr, VLC_STACKSIZE);
+    assert (ret == 0); /* fails iif VLC_STACKSIZE is invalid */
+#endif
+
     ret = pthread_create (p_handle, &attr, entry, data);
     pthread_sigmask (SIG_SETMASK, &oldset, NULL);
     pthread_attr_destroy (&attr);
@@ -699,6 +714,12 @@ int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
     th->data = data;
     th->entry = entry;
 #if defined( UNDER_CE )
+    th->cancel_event = CreateEvent (NULL, FALSE, FALSE, NULL);
+    if (th->cancel_event == NULL)
+    {
+        free(th);
+        return errno;
+    }
     hThread = CreateThread (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
 #else
     hThread = (HANDLE)(uintptr_t)
@@ -707,6 +728,7 @@ int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
 
     if (hThread)
     {
+#ifndef UNDER_CE
         /* Thread closes the handle when exiting, duplicate it here
          * to be on the safe side when joining. */
         if (!DuplicateHandle (GetCurrentProcess (), hThread,
@@ -717,6 +739,9 @@ int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
             free (th);
             return ENOMEM;
         }
+#else
+        th->handle = hThread;
+#endif
 
         ResumeThread (hThread);
         if (priority)
@@ -755,6 +780,8 @@ void vlc_cancel (vlc_thread_t thread_id)
 {
 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
     pthread_cancel (thread_id);
+#elif defined (UNDER_CE)
+    SetEvent (thread_id->cancel_event);
 #elif defined (WIN32)
     QueueUserAPC (vlc_cancel_self, thread_id->handle, 0);
 #else
@@ -787,6 +814,9 @@ void vlc_join (vlc_thread_t handle, void **result)
     CloseHandle (handle->handle);
     if (result)
         *result = handle->data;
+#if defined( UNDER_CE )
+    CloseHandle (handle->cancel_event);
+#endif
     free (handle);
 
 #endif
@@ -831,12 +861,12 @@ int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line
     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 )
+    if (b_wait)
+        sem_init (&p_priv->thread_ready, 0, 0);
 #ifndef __APPLE__
     if( config_GetInt( p_this, "rt-priority" ) > 0 )
 #endif
@@ -845,33 +875,54 @@ int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line
         if( config_GetType( p_this, "rt-offset" ) )
             i_priority += config_GetInt( p_this, "rt-offset" );
     }
+#elif defined (WIN32)
+    if (b_wait)
+        p_priv->thread_ready = CreateEvent (NULL, TRUE, FALSE, NULL);
 #endif
 
+    p_priv->b_thread = true;
     i_ret = vlc_clone( &p_priv->thread_id, thread_entry, boot, i_priority );
     if( i_ret == 0 )
     {
+        msg_Dbg( p_this, "thread (%s) created at priority %d (%s:%d)",
+                 psz_name, i_priority, psz_file, i_line );
         if( b_wait )
         {
             msg_Dbg( p_this, "waiting for thread initialization" );
-            vlc_object_wait( p_this );
+#if defined (LIBVLC_USE_PTHREAD)
+            sem_wait (&p_priv->thread_ready);
+            sem_destroy (&p_priv->thread_ready);
+#elif defined (WIN32)
+            WaitForSingleObject (p_priv->thread_ready, INFINITE);
+            CloseHandle (p_priv->thread_ready);
+#endif
         }
-
-        p_priv->b_thread = true;
-        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 );
     }
     else
     {
+        p_priv->b_thread = false;
         errno = i_ret;
         msg_Err( p_this, "%s thread could not be created at %s:%d (%m)",
                          psz_name, psz_file, i_line );
     }
 
-    vlc_object_unlock( p_this );
     return i_ret;
 }
 
+#undef vlc_thread_ready
+void vlc_thread_ready (vlc_object_t *obj)
+{
+    vlc_object_internals_t *priv = vlc_internals (obj);
+
+    assert (priv->b_thread);
+#if defined (LIBVLC_USE_PTHREAD)
+    assert (pthread_equal (pthread_self (), priv->thread_id));
+    sem_post (&priv->thread_ready);
+#elif defined (WIN32)
+    SetEvent (priv->thread_ready);
+#endif
+}
+
 /*****************************************************************************
  * vlc_thread_set_priority: set the priority of the current thread when we
  * couldn't set it in vlc_thread_create (for instance for the main thread)
@@ -947,6 +998,7 @@ void __vlc_thread_join( vlc_object_t *p_this )
     FILETIME create_ft, exit_ft, kernel_ft, user_ft;
     int64_t real_time, kernel_time, user_time;
 
+#ifndef UNDER_CE
     if( ! DuplicateHandle(GetCurrentProcess(),
             p_priv->thread_id->handle,
             GetCurrentProcess(),
@@ -958,6 +1010,9 @@ void __vlc_thread_join( vlc_object_t *p_this )
         p_priv->b_thread = false;
         return; /* We have a problem! */
     }
+#else
+    hThread = p_priv->thread_id->handle;
+#endif
 
     vlc_join( p_priv->thread_id, NULL );
 
@@ -1051,9 +1106,13 @@ void vlc_control_cancel (int cmd, ...)
             {
                 for (vlc_cleanup_t *p = nfo->cleaners; p != NULL; p = p->next)
                      p->proc (p->data);
+#ifndef WIN32
                 free (nfo);
+#endif
 #if defined (LIBVLC_USE_PTHREAD)
                 pthread_exit (PTHREAD_CANCELLED);
+#elif defined (UNDER_CE)
+                ExitThread(0);
 #elif defined (WIN32)
                 _endthread ();
 #else