]> git.sesse.net Git - vlc/blobdiff - include/vlc_threads_funcs.h
Make stream_Peek take a const pointer as it should
[vlc] / include / vlc_threads_funcs.h
index 7c6957b176bc836be483db01b3ddf6531344c770..269287b69c3c980805773ee708cc6237ad93802c 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * 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_THREADFUNCS_H_
+#define _VLC_THREADFUNCS_H_
+
 /*****************************************************************************
  * Function definitions
  *****************************************************************************/
 VLC_EXPORT( int,  __vlc_threads_init,  ( vlc_object_t * ) );
 VLC_EXPORT( int,  __vlc_threads_end,   ( vlc_object_t * ) );
 VLC_EXPORT( int,  __vlc_mutex_init,    ( vlc_object_t *, vlc_mutex_t * ) );
-VLC_EXPORT( int,  __vlc_mutex_destroy, ( char *, int, vlc_mutex_t * ) );
+VLC_EXPORT( int,  __vlc_mutex_destroy, ( const char *, int, vlc_mutex_t * ) );
 VLC_EXPORT( int,  __vlc_cond_init,     ( vlc_object_t *, vlc_cond_t * ) );
-VLC_EXPORT( int,  __vlc_cond_destroy,  ( char *, int, vlc_cond_t * ) );
-VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, char *, int, char *, void * ( * ) ( void * ), int, vlc_bool_t ) );
-VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, char *, int, int ) );
+VLC_EXPORT( int,  __vlc_cond_destroy,  ( const char *, int, vlc_cond_t * ) );
+VLC_EXPORT( int, __vlc_threadvar_create, (vlc_object_t *, vlc_threadvar_t * ) );
+VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( void * ), int, vlc_bool_t ) );
+VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, const char *, int, int ) );
 VLC_EXPORT( void, __vlc_thread_ready,  ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, char *, int ) );
+VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, const char *, int ) );
 
 
 /*****************************************************************************
@@ -64,12 +72,18 @@ VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, char *, int ) );
 #define vlc_mutex_lock( P_MUTEX )                                           \
     __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
 
-static inline int __vlc_mutex_lock( char * psz_file, int i_line,
+#ifdef __APPLE__
+#   define CAST_PTHREAD_TO_INT(t) (unsigned long int)(uintptr_t)(void *)t
+#else
+#   define CAST_PTHREAD_TO_INT(t) (unsigned long int)t
+#endif
+
+static inline int __vlc_mutex_lock( const char * psz_file, int i_line,
                                     vlc_mutex_t * p_mutex )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
@@ -108,10 +122,13 @@ static inline int __vlc_mutex_lock( char * psz_file, int i_line,
     }
 
 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+#   define vlc_assert_locked( m ) \
+           assert (pthread_mutex_lock (&((m)->mutex)) == EDEADLK)
+
     i_result = pthread_mutex_lock( &p_mutex->mutex );
     if ( i_result )
     {
-        i_thread = (int)pthread_self();
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
         psz_error = strerror(i_result);
     }
 
@@ -124,24 +141,28 @@ static inline int __vlc_mutex_lock( char * psz_file, int i_line,
     if( i_result )
     {
         msg_Err( p_mutex->p_this,
-                 "thread %u: mutex_lock failed at %s:%d (%d:%s)",
+                 "thread %li: mutex_lock failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
     return i_result;
 }
 
+#ifndef vlc_assert_locked
+# define vlc_assert_locked( m ) (void)0
+#endif
+
 /*****************************************************************************
  * vlc_mutex_unlock: unlock a mutex
  *****************************************************************************/
 #define vlc_mutex_unlock( P_MUTEX )                                         \
     __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
 
-static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
+static inline int __vlc_mutex_unlock( const char * psz_file, int i_line,
                                       vlc_mutex_t *p_mutex )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
@@ -184,7 +205,7 @@ static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
     i_result = pthread_mutex_unlock( &p_mutex->mutex );
     if ( i_result )
     {
-        i_thread = (int)pthread_self();
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
         psz_error = strerror(i_result);
     }
 
@@ -197,7 +218,7 @@ static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
     if( i_result )
     {
         msg_Err( p_mutex->p_this,
-                 "thread %u: mutex_unlock failed at %s:%d (%d:%s)",
+                 "thread %li: mutex_unlock failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
 
@@ -222,12 +243,12 @@ static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
 #define vlc_cond_signal( P_COND )                                           \
     __vlc_cond_signal( __FILE__, __LINE__, P_COND )
 
-static inline int __vlc_cond_signal( char * psz_file, int i_line,
+static inline int __vlc_cond_signal( const char * psz_file, int i_line,
                                      vlc_cond_t *p_condvar )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
@@ -322,7 +343,7 @@ static inline int __vlc_cond_signal( char * psz_file, int i_line,
     i_result = pthread_cond_signal( &p_condvar->cond );
     if ( i_result )
     {
-        i_thread = (int)pthread_self();
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
         psz_error = strerror(i_result);
     }
 
@@ -339,7 +360,7 @@ static inline int __vlc_cond_signal( char * psz_file, int i_line,
     if( i_result )
     {
         msg_Err( p_condvar->p_this,
-                 "thread %u: cond_signal failed at %s:%d (%d:%s)",
+                 "thread %li: cond_signal failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
 
@@ -352,12 +373,12 @@ static inline int __vlc_cond_signal( char * psz_file, int i_line,
 #define vlc_cond_wait( P_COND, P_MUTEX )                                     \
     __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX  )
 
-static inline int __vlc_cond_wait( char * psz_file, int i_line,
+static inline int __vlc_cond_wait( const char * psz_file, int i_line,
                                    vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
 {
     int i_result;
     /* In case of error : */
-    int i_thread = -1;
+    unsigned long int i_thread = 0;
     const char * psz_error = "";
 
 #if defined( PTH_INIT_IN_PTH_H )
@@ -497,10 +518,9 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 
     if( i_result == ETIMEDOUT )
     {
-        /* People keep pissing me off with this. --Meuuh */
         msg_Dbg( p_condvar->p_this,
-                  "thread %u: secret message triggered "
-                  "at %s:%d (%s)", (int)pthread_self(),
+                  "thread %li: possible condition deadlock "
+                  "at %s:%d (%s)", CAST_PTHREAD_TO_INT(pthread_self()),
                   psz_file, i_line, strerror(i_result) );
 
         i_result = pthread_cond_wait( &p_condvar->cond, &p_mutex->mutex );
@@ -512,7 +532,7 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 
     if ( i_result )
     {
-        i_thread = (int)pthread_self();
+        i_thread = CAST_PTHREAD_TO_INT(pthread_self());
         psz_error = strerror(i_result);
     }
 
@@ -525,7 +545,7 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
     if( i_result )
     {
         msg_Err( p_condvar->p_this,
-                 "thread %u: cond_wait failed at %s:%d (%d:%s)",
+                 "thread %li: cond_wait failed at %s:%d (%d:%s)",
                  i_thread, psz_file, i_line, i_result, psz_error );
     }
 
@@ -538,6 +558,68 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
 #define vlc_cond_destroy( P_COND )                                          \
     __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
 
+/*****************************************************************************
+ * vlc_threadvar_create: create a thread-local variable
+ *****************************************************************************/
+#define vlc_threadvar_create( PTHIS, P_TLS )                                 \
+   __vlc_threadvar_create( PTHIS, P_TLS )
+
+/*****************************************************************************
+ * vlc_threadvar_set: create: set the value of a thread-local variable
+ *****************************************************************************/
+static inline int vlc_threadvar_set( vlc_threadvar_t * p_tls, void *p_value )
+{
+    int i_ret;
+
+#if defined( PTH_INIT_IN_PTH_H )
+    return pth_key_setdata( p_tls->handle, p_value );
+#elif  defined( ST_INIT_IN_ST_H )
+    return st_thread_setspecific( p_tls->handle, p_value );
+#elif defined( HAVE_KERNEL_SCHEDULER_H )
+    return -1;
+
+#elif defined( UNDER_CE ) || defined( WIN32 )
+    i_ret = ( TlsSetValue( p_tls->handle, p_value ) != 0 );
+
+#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+    i_ret = pthread_setspecific( p_tls->handle, p_value );
+
+#elif defined( HAVE_CTHREADS_H )
+    i_ret = cthread_setspecific( p_tls->handle, p_value );
+#endif
+
+    return i_ret;
+}
+
+/*****************************************************************************
+ * vlc_threadvar_get: create: get the value of a thread-local variable
+ *****************************************************************************/
+static inline void* vlc_threadvar_get( vlc_threadvar_t * p_tls )
+{
+    void* p_ret;
+
+#if defined( PTH_INIT_IN_PTH_H )
+    p_ret = pth_key_getdata( p_handle->key );
+#elif defined( ST_INIT_IN_ST_H )
+    p_ret = st_thread_getspecific( p_handle->key );
+#elif defined( HAVE_KERNEL_SCHEDULER_H )
+    p_ret = NULL;
+#elif defined( UNDER_CE ) || defined( WIN32 )
+    p_ret = TlsGetValue( p_tls->handle );
+
+#elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
+    p_ret = pthread_getspecific( p_tls->handle );
+
+#elif defined( HAVE_CTHREADS_H )
+    if ( !cthread_getspecific( p_tls->handle, &p_ret ) )
+    {
+        p_ret = NULL;
+    }
+#endif
+
+    return p_ret;
+}
+
 /*****************************************************************************
  * vlc_thread_create: create a thread
  *****************************************************************************/
@@ -561,3 +643,5 @@ static inline int __vlc_cond_wait( char * psz_file, int i_line,
  *****************************************************************************/
 #define vlc_thread_join( P_THIS )                                           \
     __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
+
+#endif