git.sesse.net Git - vlc/blob - include/threads.h

   1 /*****************************************************************************
   2  * threads.h : threads implementation for the VideoLAN client
   3  * This header provides a portable threads implementation.
   4  *****************************************************************************
   5  * Copyright (C) 1999, 2000 VideoLAN
   6  *
   7  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
   8  *          Samuel Hocevar <sam@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public
  21  * License along with this program; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  *****************************************************************************/
  25
  26 #if defined(HAVE_PTHREAD_H)            /* pthreads (Linux & BSD for example) */
  27 #include <pthread.h>
  28
  29 #elif defined(HAVE_CTHREADS_H)                                    /* GNUMach */
  30 #include <cthreads.h>
  31
  32 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)   /* BeOS */
  33 #include <kernel/OS.h>
  34 #include <kernel/scheduler.h>
  35
  36 #else
  37 #error no threads available on your system !
  38 #endif
  39
  40 /*****************************************************************************
  41  * Constants
  42  *****************************************************************************
  43  * These constants are used by all threads in *_CreateThread() and
  44  * *_DestroyThreads() functions. Since those calls are non-blocking, an integer
  45  * value is used as a shared flag to represent the status of the thread.
  46  *****************************************************************************/
  47
  48 /* Void status - this value can be used to make sure no operation is currently
  49  * in progress on the concerned thread in an array of recorded threads */
  50 #define THREAD_NOP          0                            /* nothing happened */
  51
  52 /* Creation status */
  53 #define THREAD_CREATE       10                     /* thread is initializing */
  54 #define THREAD_START        11                          /* thread has forked */
  55 #define THREAD_READY        19                            /* thread is ready */
  56
  57 /* Destructions status */
  58 #define THREAD_DESTROY      20            /* destruction order has been sent */
  59 #define THREAD_END          21        /* destruction order has been received */
  60 #define THREAD_OVER         29             /* thread does not exist any more */
  61
  62 /* Error status */
  63 #define THREAD_ERROR        30                           /* an error occured */
  64 #define THREAD_FATAL        31  /* an fatal error occured - program must end */
  65
  66 /*****************************************************************************
  67  * Types definition
  68  *****************************************************************************/
  69
  70 #if defined(HAVE_CTHREADS_H)
  71
  72 typedef cthread_t        vlc_thread_t;
  73
  74 /* those structs are the ones defined in /include/cthreads.h but we need
  75  * to handle (*foo) where foo is a (mutex_t) while they handle (foo) where
  76  * foo is a (mutex_t*) */
  77 typedef struct s_mutex {
  78     spin_lock_t held;
  79     spin_lock_t lock;
  80     char *name;
  81     struct cthread_queue queue;
  82 } vlc_mutex_t;
  83
  84 typedef struct s_condition {
  85     spin_lock_t lock;
  86     struct cthread_queue queue;
  87     char *name;
  88     struct cond_imp *implications;
  89 } vlc_cond_t;
  90
  91 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
  92
  93 typedef thread_id vlc_thread_t;
  94
  95 typedef struct
  96 {
  97     int32           init;
  98     sem_id          lock;
  99     thread_id       owner;
 100 } vlc_mutex_t;
 101
 102 typedef struct
 103 {
 104     int32           init;
 105     sem_id          sem;
 106     sem_id          handshakeSem;
 107     sem_id          signalSem;
 108     volatile int32  nw;
 109     volatile int32  ns;
 110 } vlc_cond_t;
 111
 112 #elif defined(HAVE_PTHREAD_H)
 113
 114 typedef pthread_t        vlc_thread_t;
 115 typedef pthread_mutex_t  vlc_mutex_t;
 116 typedef pthread_cond_t   vlc_cond_t;
 117
 118 #endif
 119
 120 typedef void *(*vlc_thread_func_t)(void *p_data);
 121
 122 /*****************************************************************************
 123  * Prototypes
 124  *****************************************************************************/
 125
 126 static __inline__ int  vlc_thread_create( vlc_thread_t *p_thread, char *psz_name,
 127                                           vlc_thread_func_t func, void *p_data );
 128 static __inline__ void vlc_thread_exit  ( void );
 129 static __inline__ void vlc_thread_join  ( vlc_thread_t thread );
 130
 131 static __inline__ int  vlc_mutex_init   ( vlc_mutex_t *p_mutex );
 132 static __inline__ int  vlc_mutex_lock   ( vlc_mutex_t *p_mutex );
 133 static __inline__ int  vlc_mutex_unlock ( vlc_mutex_t *p_mutex );
 134
 135 static __inline__ int  vlc_cond_init    ( vlc_cond_t *p_condvar );
 136 static __inline__ int  vlc_cond_signal  ( vlc_cond_t *p_condvar );
 137 static __inline__ int  vlc_cond_wait    ( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex );
 138
 139 #if 0
 140 static _inline__ int    vlc_cond_timedwait   ( vlc_cond_t * condvar, vlc_mutex_t * mutex,
 141                               mtime_t absoute_timeout_time );
 142 #endif
 143
 144 /*****************************************************************************
 145  * vlc_thread_create: create a thread
 146  *****************************************************************************/
 147 static __inline__ int vlc_thread_create( vlc_thread_t *p_thread,
 148                                          char *psz_name, vlc_thread_func_t func,
 149                                          void *p_data)
 150 {
 151 #if defined(HAVE_CTHREADS_H)
 152     *p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
 153     return( 0 );
 154
 155 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 156     *p_thread = spawn_thread( (thread_func)func, psz_name, B_NORMAL_PRIORITY, p_data );
 157     return resume_thread( *p_thread );
 158
 159 #elif defined(HAVE_PTHREAD_H)
 160     return pthread_create( p_thread, NULL, func, p_data );
 161
 162 #endif
 163 }
 164
 165 /*****************************************************************************
 166  * vlc_thread_exit: terminate a thread
 167  *****************************************************************************/
 168 static __inline__ void vlc_thread_exit( void )
 169 {
 170 #if defined(HAVE_CTHREADS_H)
 171     int result;
 172     cthread_exit( &result );
 173
 174 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 175     exit_thread( 0 );
 176
 177 #elif defined(HAVE_PTHREAD_H)
 178     pthread_exit( 0 );
 179
 180 #endif
 181 }
 182
 183 /*****************************************************************************
 184  * vlc_thread_join: wait until a thread exits
 185  *****************************************************************************/
 186 static __inline__ void vlc_thread_join( vlc_thread_t thread )
 187 {
 188 #if defined(HAVE_CTHREADS_H)
 189     cthread_join( thread );
 190
 191 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 192     int32 exit_value;
 193     wait_for_thread( thread, &exit_value );
 194
 195 #elif defined(HAVE_PTHREAD_H)
 196     pthread_join( thread, NULL );
 197
 198 #endif
 199 }
 200
 201 #if defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 202 /* lazy_init_mutex */
 203 static __inline__ void lazy_init_mutex(vlc_mutex_t* p_mutex)
 204 {
 205     int32 v = atomic_or( &p_mutex->init, 1 );
 206     if( 2000 == v ) /* we're the first, so do the init */
 207     {
 208         vlc_mutex_init( p_mutex );
 209     }
 210     else /* we're not the first, so wait until the init is finished */
 211     {
 212         while( p_mutex->init != 9999 ) snooze( 10000 );
 213     }
 214 }
 215 #endif
 216
 217 /*****************************************************************************
 218  * vlc_mutex_init: initialize a mutex
 219  *****************************************************************************/
 220 static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
 221 {
 222 #if defined(HAVE_CTHREADS_H)
 223     mutex_init( p_mutex );
 224     return( 0 );
 225
 226 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 227     // check the arguments and whether it's already been initialized
 228     if( !p_mutex ) return B_BAD_VALUE;
 229     if( p_mutex->init == 9999 ) return EALREADY;
 230
 231     p_mutex->lock = create_sem( 1, "BeMutex" );
 232     p_mutex->owner = -1;
 233     p_mutex->init = 9999;
 234     return B_OK;
 235
 236 #elif defined(HAVE_PTHREAD_H)
 237     return pthread_mutex_init( p_mutex, NULL );
 238
 239 #endif
 240 }
 241
 242 /*****************************************************************************
 243  * vlc_mutex_lock: lock a mutex
 244  *****************************************************************************/
 245 static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
 246 {
 247 #if defined(HAVE_CTHREADS_H)
 248     mutex_lock( p_mutex );
 249     return( 0 );
 250
 251 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 252     status_t err;
 253
 254     if( !p_mutex ) return B_BAD_VALUE;
 255     if( p_mutex->init < 2000 ) return B_NO_INIT;
 256     lazy_init_mutex( p_mutex );
 257
 258     err = acquire_sem( p_mutex->lock );
 259     if( !err ) p_mutex->owner = find_thread( NULL );
 260     return err;
 261
 262 #elif defined(HAVE_PTHREAD_H)
 263     return pthread_mutex_lock( p_mutex );
 264
 265 #endif
 266 }
 267
 268 /*****************************************************************************
 269  * vlc_mutex_unlock: unlock a mutex
 270  *****************************************************************************/
 271 static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
 272 {
 273 #if defined(HAVE_CTHREADS_H)
 274     mutex_unlock( p_mutex );
 275     return( 0 );
 276
 277 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 278     if(! p_mutex) return B_BAD_VALUE;
 279     if( p_mutex->init < 2000 ) return B_NO_INIT;
 280     lazy_init_mutex( p_mutex );
 281
 282     if( p_mutex->owner != find_thread(NULL) ) return ENOLCK;
 283     p_mutex->owner = -1;
 284     release_sem( p_mutex->lock );
 285     return B_OK;
 286
 287 #elif defined(HAVE_PTHREAD_H)
 288     return pthread_mutex_unlock( p_mutex );
 289
 290 #endif
 291 }
 292
 293 #if defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 294 /* lazy_init_cond */
 295 static __inline__ void lazy_init_cond( vlc_cond_t* p_condvar )
 296 {
 297     int32 v = atomic_or( &p_condvar->init, 1 );
 298     if( 2000 == v ) /* we're the first, so do the init */
 299     {
 300         vlc_cond_init( p_condvar );
 301     }
 302     else /* we're not the first, so wait until the init is finished */
 303     {
 304         while( p_condvar->init != 9999 ) snooze( 10000 );
 305     }
 306 }
 307 #endif
 308
 309 /*****************************************************************************
 310  * vlc_cond_init: initialize a condition
 311  *****************************************************************************/
 312 static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
 313 {
 314 #if defined(HAVE_CTHREADS_H)
 315     /* condition_init() */
 316     spin_lock_init( &p_condvar->lock );
 317     cthread_queue_init( &p_condvar->queue );
 318     p_condvar->name = 0;
 319     p_condvar->implications = 0;
 320
 321     return( 0 );
 322
 323 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 324     if( !p_condvar ) return B_BAD_VALUE;
 325     if( p_condvar->init == 9999 ) return EALREADY;
 326
 327     p_condvar->sem = create_sem( 0, "CVSem" );
 328     p_condvar->handshakeSem = create_sem( 0, "CVHandshake" );
 329     p_condvar->signalSem = create_sem( 1, "CVSignal" );
 330     p_condvar->ns = p_condvar->nw = 0;
 331     p_condvar->init = 9999;
 332     return B_OK;
 333
 334 #elif defined(HAVE_PTHREAD_H)
 335     return pthread_cond_init( p_condvar, NULL );
 336
 337 #endif
 338 }
 339
 340 /*****************************************************************************
 341  * vlc_cond_signal: start a thread on condition completion
 342  *****************************************************************************/
 343 static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
 344 {
 345 #if defined(HAVE_CTHREADS_H)
 346     /* condition_signal() */
 347     if ( p_condvar->queue.head || p_condvar->implications )
 348     {
 349         cond_signal( (condition_t)p_condvar );
 350     }
 351     return( 0 );
 352
 353 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 354     status_t err = B_OK;
 355
 356     if( !p_condvar ) return B_BAD_VALUE;
 357     if( p_condvar->init < 2000 ) return B_NO_INIT;
 358     lazy_init_cond( p_condvar );
 359
 360     if( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED) return B_INTERRUPTED;
 361
 362     if( p_condvar->nw > p_condvar->ns )
 363     {
 364         p_condvar->ns += 1;
 365         release_sem( p_condvar->sem );
 366         release_sem( p_condvar->signalSem );
 367         while( acquire_sem(p_condvar->handshakeSem) == B_INTERRUPTED )
 368             { err = B_INTERRUPTED; }
 369     }
 370     else
 371     {
 372         release_sem( p_condvar->signalSem );
 373     }
 374     return err;
 375
 376 #elif defined(HAVE_PTHREAD_H)
 377     return pthread_cond_signal( p_condvar );
 378
 379 #endif
 380 }
 381
 382 /*****************************************************************************
 383  * vlc_cond_wait: wait until condition completion
 384  *****************************************************************************/
 385 static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
 386 {
 387 #if defined(HAVE_CTHREADS_H)
 388     condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
 389     return( 0 );
 390
 391 #elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
 392     status_t err;
 393
 394     if( !p_condvar ) return B_BAD_VALUE;
 395     if( !p_mutex ) return B_BAD_VALUE;
 396     if( p_condvar->init < 2000 ) return B_NO_INIT;
 397     lazy_init_cond( p_condvar );
 398
 399     if( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED ) return B_INTERRUPTED;
 400     p_condvar->nw += 1;
 401     release_sem( p_condvar->signalSem );
 402
 403     vlc_mutex_unlock( p_mutex );
 404     err = acquire_sem( p_condvar->sem );
 405
 406     while( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED)
 407         { err = B_INTERRUPTED; }
 408     if( p_condvar->ns > 0 )
 409     {
 410         release_sem( p_condvar->handshakeSem );
 411         p_condvar->ns -= 1;
 412     }
 413     p_condvar->nw -= 1;
 414     release_sem( p_condvar->signalSem );
 415
 416     while( vlc_mutex_lock(p_mutex) == B_INTERRUPTED)
 417         { err = B_INTERRUPTED; }
 418     return err;
 419
 420 #elif defined(HAVE_PTHREAD_H)
 421     return pthread_cond_wait( p_condvar, p_mutex );
 422
 423 #endif
 424 }