]> git.sesse.net Git - vlc/blobdiff - include/threads.h
* Disabled network input under BeOS so that it compiles again. We'll
[vlc] / include / threads.h
index 73fb41d67a6a6e051df935cd5ad13a0e05bc6ca9..a36c95c08dd889586dc0dbc441a037d298852e59 100644 (file)
@@ -1,33 +1,43 @@
 /*****************************************************************************
- * threads.h : thread implementation for VideoLAN client
- * This header is supposed to provide a portable threads implementation.
- * Currently, it is a wrapper to either the POSIX pthreads library, or
- * the Mach cthreads (for the GNU/Hurd).
+ * threads.h : threads implementation for the VideoLAN client
+ * This header provides a portable threads implementation.
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
  *
- * Authors:
+ * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
+ *          Samuel Hocevar <sam@via.ecp.fr>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- *
+ * 
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- * 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-1307, USA.
+ * 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.
  *****************************************************************************/
 
-#ifdef SYS_GNU
+#include <stdio.h>
+
+#if defined(HAVE_PTHREAD_H)            /* pthreads (Linux & BSD for example) */
+#include <pthread.h>
+
+#elif defined(HAVE_CTHREADS_H)                                    /* GNUMach */
 #include <cthreads.h>
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)   /* BeOS */
+#undef MAX
+#undef MIN
+#include <kernel/OS.h>
+#include <kernel/scheduler.h>
+#include <byteorder.h>
 #else
-#include <pthread.h>
+#error no threads available on your system !
 #endif
 
 /*****************************************************************************
@@ -38,8 +48,8 @@
  * value is used as a shared flag to represent the status of the thread.
  *****************************************************************************/
 
-/* Void status - this value can be used to be sure, in an array of recorded
- * threads, that no operation is currently in progress on the concerned thread */
+/* Void status - this value can be used to make sure no operation is currently
+ * in progress on the concerned thread in an array of recorded threads */
 #define THREAD_NOP          0                            /* nothing happened */
 
 /* Creation status */
  * Types definition
  *****************************************************************************/
 
-#ifdef SYS_GNU
+#if defined(HAVE_PTHREAD_H)
+
+typedef pthread_t        vlc_thread_t;
+typedef pthread_mutex_t  vlc_mutex_t;
+typedef pthread_cond_t   vlc_cond_t;
+
+#elif defined(HAVE_CTHREADS_H)
 
 typedef cthread_t        vlc_thread_t;
 
 /* those structs are the ones defined in /include/cthreads.h but we need
- *  * to handle *foo where foo is a mutex_t */
+ * to handle (*foo) where foo is a (mutex_t) while they handle (foo) where
+ * foo is a (mutex_t*) */
 typedef struct s_mutex {
     spin_lock_t held;
     spin_lock_t lock;
@@ -80,13 +97,27 @@ typedef struct s_condition {
     struct cond_imp *implications;
 } vlc_cond_t;
 
-#else /* SYS_GNU */
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 
-typedef pthread_t        vlc_thread_t;
-typedef pthread_mutex_t  vlc_mutex_t;
-typedef pthread_cond_t   vlc_cond_t;
+/* This is the BeOS implementation of the vlc thread, note that the mutex is
+ * not a real mutex and the cond_var is not like a pthread cond_var but it is
+ * enough for what wee need */
+
+typedef thread_id vlc_thread_t;
+
+typedef struct
+{
+    int32           init;
+    sem_id          lock;
+} vlc_mutex_t;
+
+typedef struct
+{
+    int32           init;
+    thread_id       thread;
+} vlc_cond_t;
 
-#endif /* SYS_GNU */
+#endif
 
 typedef void *(*vlc_thread_func_t)(void *p_data);
 
@@ -99,13 +130,15 @@ static __inline__ int  vlc_thread_create( vlc_thread_t *p_thread, char *psz_name
 static __inline__ void vlc_thread_exit  ( void );
 static __inline__ void vlc_thread_join  ( vlc_thread_t thread );
 
-static __inline__ int  vlc_mutex_init   ( vlc_mutex_t *p_mutex );
-static __inline__ int  vlc_mutex_lock   ( vlc_mutex_t *p_mutex );
-static __inline__ int  vlc_mutex_unlock ( vlc_mutex_t *p_mutex );
+static __inline__ int  vlc_mutex_init    ( vlc_mutex_t *p_mutex );
+static __inline__ int  vlc_mutex_lock    ( vlc_mutex_t *p_mutex );
+static __inline__ int  vlc_mutex_unlock  ( vlc_mutex_t *p_mutex );
+static __inline__ int  vlc_mutex_destroy ( vlc_mutex_t *p_mutex );
 
 static __inline__ int  vlc_cond_init    ( vlc_cond_t *p_condvar );
 static __inline__ int  vlc_cond_signal  ( vlc_cond_t *p_condvar );
 static __inline__ int  vlc_cond_wait    ( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex );
+static __inline__ int vlc_cond_destroy  ( vlc_cond_t *p_condvar );
 
 #if 0
 static _inline__ int    vlc_cond_timedwait   ( vlc_cond_t * condvar, vlc_mutex_t * mutex,
@@ -119,11 +152,18 @@ static __inline__ int vlc_thread_create( vlc_thread_t *p_thread,
                                          char *psz_name, vlc_thread_func_t func,
                                          void *p_data)
 {
-#ifdef SYS_GNU
-    *p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
-    return( 0 );
-#else
+#if defined(HAVE_PTHREAD_H)
     return pthread_create( p_thread, NULL, func, p_data );
+
+#elif defined(HAVE_CTHREADS_H)
+    *p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    *p_thread = spawn_thread( (thread_func)func, psz_name,
+                              B_NORMAL_PRIORITY, p_data );
+    return resume_thread( *p_thread );
+
 #endif
 }
 
@@ -132,11 +172,16 @@ static __inline__ int vlc_thread_create( vlc_thread_t *p_thread,
  *****************************************************************************/
 static __inline__ void vlc_thread_exit( void )
 {
-#ifdef SYS_GNU
+#if defined(HAVE_PTHREAD_H)
+    pthread_exit( 0 );
+
+#elif defined(HAVE_CTHREADS_H)
     int result;
     cthread_exit( &result );
-#else          
-    pthread_exit( 0 );
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    exit_thread( 0 );
+
 #endif
 }
 
@@ -145,10 +190,16 @@ static __inline__ void vlc_thread_exit( void )
  *****************************************************************************/
 static __inline__ void vlc_thread_join( vlc_thread_t thread )
 {
-#ifdef SYS_GNU
-    cthread_join( thread );
-#else  
+#if defined(HAVE_PTHREAD_H)
     pthread_join( thread, NULL );
+
+#elif defined(HAVE_CTHREADS_H)
+    cthread_join( thread );
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    int32 exit_value;
+    wait_for_thread( thread, &exit_value );
+
 #endif
 }
 
@@ -157,11 +208,28 @@ static __inline__ void vlc_thread_join( vlc_thread_t thread )
  *****************************************************************************/
 static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
 {
-#ifdef SYS_GNU
-    mutex_init( p_mutex );
-    return( 0 );
-#else
+#if defined(HAVE_PTHREAD_H)
     return pthread_mutex_init( p_mutex, NULL );
+
+#elif defined(HAVE_CTHREADS_H)
+    mutex_init( p_mutex );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+
+    /* check the arguments and whether it's already been initialized */
+    if( p_mutex == NULL ) return B_BAD_VALUE;
+    if( p_mutex->init == 9999 )
+    {
+        return EALREADY;
+    }
+
+    p_mutex->lock = create_sem( 1, "BeMutex" );
+    if( p_mutex->lock < B_NO_ERROR )
+        return( -1 );
+    p_mutex->init = 9999;
+    return B_OK;
+
 #endif
 }
 
@@ -170,11 +238,22 @@ static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
  *****************************************************************************/
 static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
 {
-#ifdef SYS_GNU
-    mutex_lock( p_mutex );
-    return( 0 );
-#else
+#if defined(HAVE_PTHREAD_H)
     return pthread_mutex_lock( p_mutex );
+
+#elif defined(HAVE_CTHREADS_H)
+    mutex_lock( p_mutex );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    status_t err;
+
+    if( !p_mutex ) return B_BAD_VALUE;
+    if( p_mutex->init < 2000 ) return B_NO_INIT;
+
+    err = acquire_sem( p_mutex->lock );
+    return err;
+
 #endif
 }
 
@@ -183,29 +262,67 @@ static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
  *****************************************************************************/
 static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
 {
-#ifdef SYS_GNU
-    mutex_unlock( p_mutex );
-    return( 0 );
-#else
+#if defined(HAVE_PTHREAD_H)
     return pthread_mutex_unlock( p_mutex );
+
+#elif defined(HAVE_CTHREADS_H)
+    mutex_unlock( p_mutex );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+
+    if(! p_mutex) return B_BAD_VALUE;
+    if( p_mutex->init < 2000 ) return B_NO_INIT;
+
+    release_sem( p_mutex->lock );
+    return B_OK;
+
 #endif
 }
 
+/*****************************************************************************
+ * vlc_mutex_destroy: destroy a mutex
+ *****************************************************************************/
+static __inline__ int vlc_mutex_destroy( vlc_mutex_t *p_mutex )
+{
+#if defined(HAVE_PTHREAD_H)    
+    return pthread_mutex_destroy( p_mutex );
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    if( p_mutex->init == 9999 )
+        delete_sem( p_mutex->lock );
+    p_mutex->init = 0;
+    return B_OK;
+#endif    
+}
+
 /*****************************************************************************
  * vlc_cond_init: initialize a condition
  *****************************************************************************/
 static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
 {
-#ifdef SYS_GNU
+#if defined(HAVE_PTHREAD_H)
+    return pthread_cond_init( p_condvar, NULL );
+
+#elif defined(HAVE_CTHREADS_H)
     /* condition_init() */
     spin_lock_init( &p_condvar->lock );
     cthread_queue_init( &p_condvar->queue );
     p_condvar->name = 0;
     p_condvar->implications = 0;
 
-    return( 0 );
-#else                      
-    return pthread_cond_init( p_condvar, NULL );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    if( !p_condvar )
+        return B_BAD_VALUE;
+
+    if( p_condvar->init == 9999 )
+        return EALREADY;
+
+    p_condvar->thread = -1;
+    p_condvar->init = 9999;
+    return 0;
+
 #endif
 }
 
@@ -214,15 +331,46 @@ static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
  *****************************************************************************/
 static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
 {
-#ifdef SYS_GNU
+#if defined(HAVE_PTHREAD_H)
+    return pthread_cond_signal( p_condvar );
+
+#elif defined(HAVE_CTHREADS_H)
     /* condition_signal() */
     if ( p_condvar->queue.head || p_condvar->implications )
     {
         cond_signal( (condition_t)p_condvar );
     }
-    return( 0 );
-#else          
-    return pthread_cond_signal( p_condvar );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    if( !p_condvar )
+        return B_BAD_VALUE;
+
+    if( p_condvar->init < 2000 )
+        return B_NO_INIT;
+    while( p_condvar->thread != -1 )
+    {
+        thread_info info;
+        if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
+            return 0;
+
+        if( info.state != B_THREAD_SUSPENDED )
+        {
+            // The  waiting thread is not suspended so it could
+            // have been interrupted beetwen the unlock and the
+            // suspend_thread line. That is why we sleep a little
+            // before retesting p_condver->thread.
+            snooze( 10000 );
+        }
+        else
+        {
+            // Ok, we have to wake up that thread
+            resume_thread( p_condvar->thread );
+            return 0;
+        }
+    }
+    return 0;
+
 #endif
 }
 
@@ -231,11 +379,46 @@ static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
  *****************************************************************************/
 static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
 {
-#ifdef SYS_GNU
-    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
-    return( 0 );
-#else
+#if defined(HAVE_PTHREAD_H)
     return pthread_cond_wait( p_condvar, p_mutex );
+
+#elif defined(HAVE_CTHREADS_H)
+    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
+    return 0;
+
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    if( !p_condvar )
+        return B_BAD_VALUE;
+
+    if( !p_mutex )
+        return B_BAD_VALUE;
+
+    if( p_condvar->init < 2000 )
+        return B_NO_INIT;
+
+    // The p_condvar->thread var is initialized before the unlock because
+    // it enables to identify when the thread is interrupted beetwen the
+    // unlock line and the suspend_thread line
+    p_condvar->thread = find_thread( NULL );
+    vlc_mutex_unlock( p_mutex );
+    suspend_thread( p_condvar->thread );
+    p_condvar->thread = -1;
+
+    vlc_mutex_lock( p_mutex );
+    return 0;
+
 #endif
 }
 
+/*****************************************************************************
+ * vlc_cond_destroy: destroy a condition
+ *****************************************************************************/
+static __inline__ int vlc_cond_destroy( vlc_cond_t *p_condvar )
+{
+#if defined(HAVE_PTHREAD_H)
+    return pthread_cond_destroy( p_condvar );
+#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
+    p_condvar->init = 0;
+    return 0;
+#endif    
+}