]> git.sesse.net Git - vlc/blobdiff - include/vlc_threads.h
Thread fatal errors: add function name, and some Win32 support
[vlc] / include / vlc_threads.h
index 0f25dacd6caa7f7cb30e1d275f281d56e11de13e..e19d8747759f218d8ee7916971f6d9b293c79b53 100644 (file)
@@ -47,6 +47,7 @@
 
 #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 <stdlib.h> /* lldiv_t definition (only in C99) */
@@ -174,11 +175,23 @@ 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 *, const char *, 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( int, vlc_join, (vlc_thread_t, void **) );
+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
 
@@ -188,12 +201,12 @@ VLC_EXPORT( int, vlc_join, (vlc_thread_t, void **) );
 #define vlc_mutex_lock( P_MUTEX )                                           \
     __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
 
-VLC_EXPORT(void, vlc_pthread_fatal, (const char *action, int error, const char *file, unsigned line));
+VLC_EXPORT(void, vlc_thread_fatal, (const char *action, int error, const char *function, const char *file, unsigned line));
 
 #if defined(LIBVLC_USE_PTHREAD)
 # define VLC_THREAD_ASSERT( action ) \
     if (val) \
-        vlc_pthread_fatal (action, val, psz_file, i_line)
+        vlc_thread_fatal (action, val, __func__, psz_file, i_line)
 #else
 # define VLC_THREAD_ASSERT ((void)(val))
 #endif
@@ -262,6 +275,111 @@ static inline void __vlc_mutex_unlock( const char * psz_file, int i_line,
 #define vlc_mutex_destroy( P_MUTEX )                                        \
     __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
 
+/**
+ * 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)
+{
+    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)
+{
+#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() <b>must</b> 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
+{
+    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)
+
 /*****************************************************************************
  * vlc_cond_init: initialize a condition
  *****************************************************************************/
@@ -338,13 +456,21 @@ static inline void __vlc_cond_wait( const char * psz_file, int i_line,
     vlc_mutex_lock( p_mutex );
 
 #elif defined( WIN32 )
-    (void)psz_file; (void)i_line;
+    DWORD result;
 
-    /* Increase our wait count */
-    SignalObjectAndWait( *p_mutex, *p_condvar, INFINITE, FALSE );
+    do
+    {
+        vlc_testcancel ();
+        result = SignalObjectAndWait (*p_mutex, *p_condvar, INFINITE, TRUE);
 
-    /* Reacquire the mutex before returning. */
-    vlc_mutex_lock( p_mutex );
+        /* Reacquire the mutex before returning. */
+        vlc_mutex_lock( p_mutex );
+    }
+    while (result == WAIT_IO_COMPLETION);
+
+    vlc_testcancel ();
+
+    (void)psz_file; (void)i_line;
 
 #elif defined( SYS_BEOS )
     /* The p_condvar->thread var is initialized before the unlock because
@@ -375,16 +501,16 @@ static inline int __vlc_cond_timedwait( const char * psz_file, int i_line,
                                         mtime_t deadline )
 {
 #if defined(LIBVLC_USE_PTHREAD)
-    lldiv_t d = lldiv( deadline, 1000000 );
-    struct timespec ts = { d.quot, d.rem * 1000 };
+    lldiv_t d = lldiv( deadline, CLOCK_FREQ );
+    struct timespec ts = { d.quot, d.rem * (1000000000 / CLOCK_FREQ) };
 
     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
-    if (val == ETIMEDOUT)
-        return ETIMEDOUT; /* this error is perfectly normal */
-    VLC_THREAD_ASSERT ("timed-waiting on condition");
+    if (val != ETIMEDOUT)
+        VLC_THREAD_ASSERT ("timed-waiting on condition");
+    return val;
 
 #elif defined( UNDER_CE )
-    mtime_t delay_ms = (deadline - mdate())/1000;
+    mtime_t delay_ms = (deadline - mdate()) / (CLOCK_FREQ / 1000);
     DWORD result;
     if( delay_ms < 0 )
         delay_ms = 0;
@@ -395,39 +521,35 @@ static inline int __vlc_cond_timedwait( const char * psz_file, int i_line,
     /* Reacquire the mutex before returning. */
     vlc_mutex_lock( p_mutex );
 
-    if(result == WAIT_TIMEOUT)
-       return ETIMEDOUT; /* this error is perfectly normal */
-
     (void)psz_file; (void)i_line;
 
+    return (result == WAIT_TIMEOUT) ? ETIMEDOUT : 0;
+
 #elif defined( WIN32 )
-    mtime_t total = (deadline - mdate())/1000;
-    DWORD result;
-    if( total < 0 )
-        total = 0;
+    mtime_t total;
+    DWORD result = WAIT_TIMEOUT;
 
-    do
+    (void)psz_file; (void)i_line;
+
+    vlc_testcancel ();
+    while ((total = (deadline - mdate ()) > 0))
     {
         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
         result = SignalObjectAndWait( *p_mutex, *p_condvar,
-                                      delay, FALSE );
-        total -= delay;
+                                      delay, TRUE );
+
+        /* Reacquire the mutex before return/cancel. */
         vlc_mutex_lock (p_mutex);
+        if (result == WAIT_OBJECT_0)
+            return 0; /* Condition signaled! */
+        vlc_testcancel ();
     }
-    while (total);
-
-    /* Reacquire the mutex before returning. */
-    if(result == WAIT_TIMEOUT)
-       return ETIMEDOUT; /* this error is perfectly normal */
-
-    (void)psz_file; (void)i_line;
+    return ETIMEDOUT;
 
 #elif defined( SYS_BEOS )
 #   error Unimplemented
 
 #endif
-
-    return 0;
 }
 
 /*****************************************************************************
@@ -589,32 +711,6 @@ static inline void barrier (void)
 #endif
 }
 
-/**
- * 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.
- * @param p_state storage for the previous cancellation state
- * @return Nothing, always succeeds.
- */
-static inline void vlc_savecancel (int *p_state)
-{
-#if defined (LIBVLC_USE_PTHREAD)
-    (void) pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, p_state);
-#endif
-}
-
-/**
- * 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)
-    (void) pthread_setcancelstate (state, NULL);
-#endif
-}
-
 /*****************************************************************************
  * vlc_thread_create: create a thread
  *****************************************************************************/
@@ -631,6 +727,6 @@ static inline void vlc_restorecancel (int state)
  * vlc_thread_join: wait until a thread exits
  *****************************************************************************/
 #define vlc_thread_join( P_THIS )                                           \
-    __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
+    __vlc_thread_join( VLC_OBJECT(P_THIS) )
 
 #endif /* !_VLC_THREADS_H */