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 * $Id: vlc_threads.h,v 1.3 2002/06/08 14:08:46 sam Exp $
8 * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
9 * Samuel Hocevar <sam@via.ecp.fr>
10 * Gildas Bazin <gbazin@netcourrier.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
29 #if defined(GPROF) || defined(DEBUG)
30 # include <sys/time.h>
33 #if defined( PTH_INIT_IN_PTH_H ) /* GNU Pth */
36 #elif defined( ST_INIT_IN_ST_H ) /* State threads */
39 #elif defined( WIN32 ) /* Win32 API */
42 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H ) /* pthreads (like Linux & BSD) */
45 /* Needed for pthread_cond_timedwait */
48 /* This is not prototyped under Linux, though it exists. */
49 int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
51 #elif defined( HAVE_CTHREADS_H ) /* GNUMach */
52 # include <cthreads.h>
54 #elif defined( HAVE_KERNEL_SCHEDULER_H ) /* BeOS */
55 # include <kernel/OS.h>
56 # include <kernel/scheduler.h>
57 # include <byteorder.h>
60 # error no threads available on your system !
64 /*****************************************************************************
66 *****************************************************************************
67 * These constants are used by all threads in *_CreateThread() and
68 * *_DestroyThreads() functions. Since those calls are non-blocking, an integer
69 * value is used as a shared flag to represent the status of the thread.
70 *****************************************************************************/
72 /* Void status - this value can be used to make sure no operation is currently
73 * in progress on the concerned thread in an array of recorded threads */
74 #define THREAD_NOP 0 /* nothing happened */
77 #define THREAD_CREATE 10 /* thread is initializing */
78 #define THREAD_START 11 /* thread has forked */
79 #define THREAD_READY 19 /* thread is ready */
81 /* Destructions status */
82 #define THREAD_DESTROY 20 /* destruction order has been sent */
83 #define THREAD_END 21 /* destruction order has been received */
84 #define THREAD_OVER 29 /* thread does not exist any more */
87 #define THREAD_ERROR 30 /* an error occured */
88 #define THREAD_FATAL 31 /* an fatal error occured - program must end */
90 /*****************************************************************************
92 *****************************************************************************/
94 #if defined( PTH_INIT_IN_PTH_H )
95 typedef pth_t vlc_thread_t;
96 typedef pth_mutex_t vlc_mutex_t;
97 typedef pth_cond_t vlc_cond_t;
99 #elif defined( ST_INIT_IN_ST_H )
100 typedef st_thread_t * vlc_thread_t;
101 typedef st_mutex_t * vlc_mutex_t;
102 typedef st_cond_t * vlc_cond_t;
104 #elif defined( WIN32 )
105 typedef HANDLE vlc_thread_t;
106 typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL );
107 typedef unsigned (__stdcall *PTHREAD_START) (void *);
111 /* WinNT/2K/XP implementation */
113 /* Win95/98/ME implementation */
114 CRITICAL_SECTION csection;
119 int i_waiting_threads;
120 /* WinNT/2K/XP implementation */
123 vlc_bool_t b_broadcast;
124 SIGNALOBJECTANDWAIT SignalObjectAndWait;
125 /* Win95/98/ME implementation */
126 enum { SIGNAL = 0, BROADCAST = 1 };
130 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
131 typedef pthread_t vlc_thread_t;
132 typedef pthread_mutex_t vlc_mutex_t;
133 typedef pthread_cond_t vlc_cond_t;
135 #elif defined( HAVE_CTHREADS_H )
136 typedef cthread_t vlc_thread_t;
138 /* Those structs are the ones defined in /include/cthreads.h but we need
139 * to handle (&foo) where foo is a (mutex_t) while they handle (foo) where
140 * foo is a (mutex_t*) */
146 struct cthread_queue queue;
152 struct cthread_queue queue;
154 struct cond_imp *implications;
157 #elif defined( HAVE_KERNEL_SCHEDULER_H )
158 /* This is the BeOS implementation of the vlc threads, note that the mutex is
159 * not a real mutex and the cond_var is not like a pthread cond_var but it is
160 * enough for what wee need */
162 typedef thread_id vlc_thread_t;
178 /*****************************************************************************
179 * Function definitions
180 *****************************************************************************/
181 VLC_EXPORT( int, __vlc_threads_init, ( vlc_object_t * ) );
182 VLC_EXPORT( int, vlc_threads_end, ( void ) );
183 VLC_EXPORT( int, __vlc_mutex_init, ( vlc_object_t *, vlc_mutex_t * ) );
184 VLC_EXPORT( int, __vlc_mutex_destroy, ( char *, int, vlc_mutex_t * ) );
185 VLC_EXPORT( int, __vlc_cond_init, ( vlc_object_t *, vlc_cond_t * ) );
186 VLC_EXPORT( int, __vlc_cond_destroy, ( char *, int, vlc_cond_t * ) );
187 VLC_EXPORT( int, __vlc_thread_create, ( vlc_object_t *, char *, int, char *, void * ( * ) ( void * ), vlc_bool_t ) );
188 VLC_EXPORT( void, __vlc_thread_ready, ( vlc_object_t * ) );
189 VLC_EXPORT( void, __vlc_thread_join, ( vlc_object_t *, char *, int ) );
191 /*****************************************************************************
192 * vlc_threads_init: initialize threads system
193 *****************************************************************************/
194 #define vlc_threads_init( P_THIS ) \
195 __vlc_threads_init( CAST_TO_VLC_OBJECT(P_THIS) )
197 /*****************************************************************************
198 * vlc_mutex_init: initialize a mutex
199 *****************************************************************************/
200 #define vlc_mutex_init( P_THIS, P_MUTEX ) \
201 __vlc_mutex_init( CAST_TO_VLC_OBJECT(P_THIS), P_MUTEX )
203 /*****************************************************************************
204 * vlc_mutex_lock: lock a mutex
205 *****************************************************************************/
207 # define vlc_mutex_lock( P_MUTEX ) \
208 __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
210 # define vlc_mutex_lock( P_MUTEX ) \
211 __vlc_mutex_lock( "(unknown)", 0, P_MUTEX )
214 static inline int __vlc_mutex_lock( char * psz_file, int i_line,
215 vlc_mutex_t *p_mutex )
217 #if defined( PTH_INIT_IN_PTH_H )
218 return pth_mutex_acquire( p_mutex, TRUE, NULL );
220 #elif defined( ST_INIT_IN_ST_H )
221 return st_mutex_lock( *p_mutex );
223 #elif defined( WIN32 )
226 WaitForSingleObject( p_mutex->mutex, INFINITE );
230 EnterCriticalSection( &p_mutex->csection );
234 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
235 int i_return = pthread_mutex_lock( p_mutex );
238 // msg_Err( "thread %d: mutex_lock failed at %s:%d (%s)",
239 // pthread_self(), psz_file, i_line, strerror(i_return) );
243 #elif defined( HAVE_CTHREADS_H )
244 mutex_lock( p_mutex );
247 #elif defined( HAVE_KERNEL_SCHEDULER_H )
255 if( p_mutex->init < 2000 )
260 err = acquire_sem( p_mutex->lock );
266 /*****************************************************************************
267 * vlc_mutex_unlock: unlock a mutex
268 *****************************************************************************/
270 # define vlc_mutex_unlock( P_MUTEX ) \
271 __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
273 # define vlc_mutex_unlock( P_MUTEX ) \
274 __vlc_mutex_unlock( "(unknown)", 0, P_MUTEX )
277 static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
278 vlc_mutex_t *p_mutex )
280 #if defined( PTH_INIT_IN_PTH_H )
281 return pth_mutex_release( p_mutex );
283 #elif defined( ST_INIT_IN_ST_H )
284 return st_mutex_unlock( *p_mutex );
286 #elif defined( WIN32 )
289 ReleaseMutex( p_mutex->mutex );
293 LeaveCriticalSection( &p_mutex->csection );
297 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
298 int i_return = pthread_mutex_unlock( p_mutex );
301 // msg_Err( "thread %d: mutex_unlock failed at %s:%d (%s)",
302 // pthread_self(), psz_file, i_line, strerror(i_return) );
306 #elif defined( HAVE_CTHREADS_H )
307 mutex_unlock( p_mutex );
310 #elif defined( HAVE_KERNEL_SCHEDULER_H )
316 if( p_mutex->init < 2000 )
321 release_sem( p_mutex->lock );
327 /*****************************************************************************
328 * vlc_mutex_destroy: destroy a mutex
329 *****************************************************************************/
331 # define vlc_mutex_destroy( P_MUTEX ) \
332 __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
334 # define vlc_mutex_destroy( P_MUTEX ) \
335 __vlc_mutex_destroy( "(unknown)", 0, P_MUTEX )
338 /*****************************************************************************
339 * vlc_cond_init: initialize a condition
340 *****************************************************************************/
341 #define vlc_cond_init( P_THIS, P_COND ) \
342 __vlc_cond_init( CAST_TO_VLC_OBJECT(P_THIS), P_COND )
344 /*****************************************************************************
345 * vlc_cond_signal: start a thread on condition completion
346 *****************************************************************************/
347 static inline int vlc_cond_signal( vlc_cond_t *p_condvar )
349 #if defined( PTH_INIT_IN_PTH_H )
350 return pth_cond_notify( p_condvar, FALSE );
352 #elif defined( ST_INIT_IN_ST_H )
353 return st_cond_signal( *p_condvar );
355 #elif defined( WIN32 )
356 /* Release one waiting thread if one is available. */
357 /* For this trick to work properly, the vlc_cond_signal must be surrounded
358 * by a mutex. This will prevent another thread from stealing the signal */
359 if( p_condvar->i_waiting_threads )
361 if( p_condvar->signal )
363 ReleaseSemaphore( p_condvar->semaphore, 1, 0 );
367 SetEvent( p_condvar->p_events[SIGNAL] );
372 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
373 return pthread_cond_signal( p_condvar );
375 #elif defined( HAVE_CTHREADS_H )
376 /* condition_signal() */
377 if ( p_condvar->queue.head || p_condvar->implications )
379 cond_signal( (condition_t)p_condvar );
383 #elif defined( HAVE_KERNEL_SCHEDULER_H )
389 if( p_condvar->init < 2000 )
394 while( p_condvar->thread != -1 )
397 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
402 if( info.state != B_THREAD_SUSPENDED )
404 /* The waiting thread is not suspended so it could
405 * have been interrupted beetwen the unlock and the
406 * suspend_thread line. That is why we sleep a little
407 * before retesting p_condver->thread. */
412 /* Ok, we have to wake up that thread */
413 resume_thread( p_condvar->thread );
422 /*****************************************************************************
423 * vlc_cond_broadcast: start all threads waiting on condition completion
424 *****************************************************************************/
426 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
427 * Only works with pthreads, you need to adapt it for others
428 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
430 static inline int vlc_cond_broadcast( vlc_cond_t *p_condvar )
432 #if defined( PTH_INIT_IN_PTH_H )
433 return pth_cond_notify( p_condvar, FALSE );
435 #elif defined( ST_INIT_IN_ST_H )
436 return st_cond_broadcast( p_condvar );
438 #elif defined( WIN32 )
439 /* Release all waiting threads. */
440 if( p_condvar->i_waiting_threads )
442 if( p_condvar->signal )
444 p_condvar->b_broadcast = 1;
445 /* This call is atomic */
446 ReleaseSemaphore( p_condvar->semaphore,
447 p_condvar->i_waiting_threads, 0 );
448 /* Wait for all threads to get the semaphore */
449 WaitForSingleObject( p_condvar->signal, INFINITE );
450 p_condvar->b_broadcast = 0;
454 SetEvent( p_condvar->p_events[BROADCAST] );
459 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
460 return pthread_cond_broadcast( p_condvar );
462 #elif defined( HAVE_CTHREADS_H )
463 /* condition_signal() */
464 if ( p_condvar->queue.head || p_condvar->implications )
466 cond_signal( (condition_t)p_condvar );
470 #elif defined( HAVE_KERNEL_SCHEDULER_H )
476 if( p_condvar->init < 2000 )
481 while( p_condvar->thread != -1 )
484 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
489 if( info.state != B_THREAD_SUSPENDED )
491 /* The waiting thread is not suspended so it could
492 * have been interrupted beetwen the unlock and the
493 * suspend_thread line. That is why we sleep a little
494 * before retesting p_condver->thread. */
499 /* Ok, we have to wake up that thread */
500 resume_thread( p_condvar->thread );
509 /*****************************************************************************
510 * vlc_cond_wait: wait until condition completion
511 *****************************************************************************/
513 # define vlc_cond_wait( P_COND, P_MUTEX ) \
514 __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX )
516 # define vlc_cond_wait( P_COND, P_MUTEX ) \
517 __vlc_cond_wait( "(unknown)", 0, P_COND, P_MUTEX )
520 static inline int __vlc_cond_wait( char * psz_file, int i_line,
521 vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
523 #if defined( PTH_INIT_IN_PTH_H )
524 return pth_cond_await( p_condvar, p_mutex, NULL );
526 #elif defined( ST_INIT_IN_ST_H )
529 st_mutex_unlock( *p_mutex );
530 i_ret = st_cond_wait( *p_condvar );
531 st_mutex_lock( *p_mutex );
535 #elif defined( WIN32 )
536 /* Increase our wait count */
537 p_condvar->i_waiting_threads++;
539 if( p_condvar->signal )
541 /* It is only possible to atomically release the mutex and initiate the
542 * waiting on WinNT/2K/XP. Win9x doesn't have SignalObjectAndWait(). */
543 p_condvar->SignalObjectAndWait( p_mutex->mutex, p_condvar->semaphore,
545 /* XXX: we should protect i_waiting_threads with a mutex, but
546 * is it really worth it ? */
547 p_condvar->i_waiting_threads--;
549 if( p_condvar->b_broadcast
550 && p_condvar->i_waiting_threads == 0 )
552 p_condvar->SignalObjectAndWait( p_condvar->signal, p_mutex->mutex,
557 /* Just take back the lock */
558 WaitForSingleObject( p_mutex->mutex, INFINITE );
566 /* Release the mutex, wait, and reacquire. */
567 LeaveCriticalSection( &p_mutex->csection );
568 i_ret = WaitForMultipleObjects( 2, p_condvar->p_events,
570 EnterCriticalSection( &p_mutex->csection );
572 /* Decrease our wait count */
573 p_condvar->i_waiting_threads--;
575 /* If we are the last waiter and it was a broadcast signal, reset
576 * the broadcast event. */
577 if( i_ret == WAIT_OBJECT_0 + BROADCAST
578 && p_condvar->i_waiting_threads == 0 )
580 ResetEvent( p_condvar->p_events[BROADCAST] );
583 return( i_ret == WAIT_FAILED );
586 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
589 /* In debug mode, timeout */
591 struct timespec timeout;
596 gettimeofday( &now, NULL );
597 timeout.tv_sec = now.tv_sec + THREAD_COND_TIMEOUT;
598 timeout.tv_nsec = now.tv_usec * 1000;
600 i_result = pthread_cond_timedwait( p_condvar, p_mutex, &timeout );
602 if( i_result == ETIMEDOUT )
604 //X msg_Warn( "thread %d: possible deadlock detected "
605 //X "in cond_wait at %s:%d (%s)", pthread_self(),
606 //X psz_file, i_line, strerror(i_result) );
612 //X msg_Err( "thread %d: cond_wait failed at %s:%d (%s)",
613 //X pthread_self(), psz_file, i_line, strerror(i_result) );
618 return pthread_cond_wait( p_condvar, p_mutex );
621 #elif defined( HAVE_CTHREADS_H )
622 condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
625 #elif defined( HAVE_KERNEL_SCHEDULER_H )
636 if( p_condvar->init < 2000 )
641 /* The p_condvar->thread var is initialized before the unlock because
642 * it enables to identify when the thread is interrupted beetwen the
643 * unlock line and the suspend_thread line */
644 p_condvar->thread = find_thread( NULL );
645 vlc_mutex_unlock( p_mutex );
646 suspend_thread( p_condvar->thread );
647 p_condvar->thread = -1;
649 vlc_mutex_lock( p_mutex );
655 /*****************************************************************************
656 * vlc_cond_destroy: destroy a condition
657 *****************************************************************************/
659 # define vlc_cond_destroy( P_COND ) \
660 __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
662 # define vlc_cond_destroy( P_COND ) \
663 __vlc_cond_destroy( "(unknown)", 0, P_COND )
666 /*****************************************************************************
667 * vlc_thread_create: create a thread
668 *****************************************************************************/
669 # define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, WAIT ) \
670 __vlc_thread_create( CAST_TO_VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, (void * ( * ) ( void * ))FUNC, WAIT )
672 /*****************************************************************************
673 * vlc_thread_ready: tell the parent thread we were successfully spawned
674 *****************************************************************************/
675 # define vlc_thread_ready( P_THIS ) \
676 __vlc_thread_ready( CAST_TO_VLC_OBJECT(P_THIS) )
678 /*****************************************************************************
679 * vlc_thread_join: wait until a thread exits
680 *****************************************************************************/
682 # define vlc_thread_join( P_THIS ) \
683 __vlc_thread_join( CAST_TO_VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
685 # define vlc_thread_join( P_THIS ) \
686 __vlc_thread_join( CAST_TO_VLC_OBJECT(P_THIS), "(unknown)", 0 )