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.5 2002/07/16 21:29:10 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 */
129 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
130 typedef pthread_t vlc_thread_t;
131 typedef pthread_mutex_t vlc_mutex_t;
132 typedef pthread_cond_t vlc_cond_t;
134 #elif defined( HAVE_CTHREADS_H )
135 typedef cthread_t vlc_thread_t;
137 /* Those structs are the ones defined in /include/cthreads.h but we need
138 * to handle (&foo) where foo is a (mutex_t) while they handle (foo) where
139 * foo is a (mutex_t*) */
145 struct cthread_queue queue;
151 struct cthread_queue queue;
153 struct cond_imp *implications;
156 #elif defined( HAVE_KERNEL_SCHEDULER_H )
157 /* This is the BeOS implementation of the vlc threads, note that the mutex is
158 * not a real mutex and the cond_var is not like a pthread cond_var but it is
159 * enough for what wee need */
161 typedef thread_id vlc_thread_t;
177 /*****************************************************************************
178 * Function definitions
179 *****************************************************************************/
180 VLC_EXPORT( int, __vlc_threads_init, ( vlc_object_t * ) );
181 VLC_EXPORT( int, __vlc_threads_end, ( vlc_object_t * ) );
182 VLC_EXPORT( int, __vlc_mutex_init, ( vlc_object_t *, vlc_mutex_t * ) );
183 VLC_EXPORT( int, __vlc_mutex_destroy, ( char *, int, vlc_mutex_t * ) );
184 VLC_EXPORT( int, __vlc_cond_init, ( vlc_object_t *, vlc_cond_t * ) );
185 VLC_EXPORT( int, __vlc_cond_destroy, ( char *, int, vlc_cond_t * ) );
186 VLC_EXPORT( int, __vlc_thread_create, ( vlc_object_t *, char *, int, char *, void * ( * ) ( void * ), vlc_bool_t ) );
187 VLC_EXPORT( void, __vlc_thread_ready, ( vlc_object_t * ) );
188 VLC_EXPORT( void, __vlc_thread_join, ( vlc_object_t *, char *, int ) );
190 /*****************************************************************************
191 * vlc_threads_init: initialize threads system
192 *****************************************************************************/
193 #define vlc_threads_init( P_THIS ) \
194 __vlc_threads_init( CAST_TO_VLC_OBJECT(P_THIS) )
196 /*****************************************************************************
197 * vlc_threads_end: deinitialize threads system
198 *****************************************************************************/
199 #define vlc_threads_end( P_THIS ) \
200 __vlc_threads_end( CAST_TO_VLC_OBJECT(P_THIS) )
202 /*****************************************************************************
203 * vlc_mutex_init: initialize a mutex
204 *****************************************************************************/
205 #define vlc_mutex_init( P_THIS, P_MUTEX ) \
206 __vlc_mutex_init( CAST_TO_VLC_OBJECT(P_THIS), P_MUTEX )
208 /*****************************************************************************
209 * vlc_mutex_lock: lock a mutex
210 *****************************************************************************/
212 # define vlc_mutex_lock( P_MUTEX ) \
213 __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
215 # define vlc_mutex_lock( P_MUTEX ) \
216 __vlc_mutex_lock( "(unknown)", 0, P_MUTEX )
219 static inline int __vlc_mutex_lock( char * psz_file, int i_line,
220 vlc_mutex_t *p_mutex )
222 #if defined( PTH_INIT_IN_PTH_H )
223 return pth_mutex_acquire( p_mutex, TRUE, NULL );
225 #elif defined( ST_INIT_IN_ST_H )
226 return st_mutex_lock( *p_mutex );
228 #elif defined( WIN32 )
231 WaitForSingleObject( p_mutex->mutex, INFINITE );
235 EnterCriticalSection( &p_mutex->csection );
239 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
240 int i_return = pthread_mutex_lock( p_mutex );
243 // msg_Err( "thread %d: mutex_lock failed at %s:%d (%s)",
244 // pthread_self(), psz_file, i_line, strerror(i_return) );
248 #elif defined( HAVE_CTHREADS_H )
249 mutex_lock( p_mutex );
252 #elif defined( HAVE_KERNEL_SCHEDULER_H )
260 if( p_mutex->init < 2000 )
265 err = acquire_sem( p_mutex->lock );
271 /*****************************************************************************
272 * vlc_mutex_unlock: unlock a mutex
273 *****************************************************************************/
275 # define vlc_mutex_unlock( P_MUTEX ) \
276 __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
278 # define vlc_mutex_unlock( P_MUTEX ) \
279 __vlc_mutex_unlock( "(unknown)", 0, P_MUTEX )
282 static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
283 vlc_mutex_t *p_mutex )
285 #if defined( PTH_INIT_IN_PTH_H )
286 return pth_mutex_release( p_mutex );
288 #elif defined( ST_INIT_IN_ST_H )
289 return st_mutex_unlock( *p_mutex );
291 #elif defined( WIN32 )
294 ReleaseMutex( p_mutex->mutex );
298 LeaveCriticalSection( &p_mutex->csection );
302 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
303 int i_return = pthread_mutex_unlock( p_mutex );
306 // msg_Err( "thread %d: mutex_unlock failed at %s:%d (%s)",
307 // pthread_self(), psz_file, i_line, strerror(i_return) );
311 #elif defined( HAVE_CTHREADS_H )
312 mutex_unlock( p_mutex );
315 #elif defined( HAVE_KERNEL_SCHEDULER_H )
321 if( p_mutex->init < 2000 )
326 release_sem( p_mutex->lock );
332 /*****************************************************************************
333 * vlc_mutex_destroy: destroy a mutex
334 *****************************************************************************/
336 # define vlc_mutex_destroy( P_MUTEX ) \
337 __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
339 # define vlc_mutex_destroy( P_MUTEX ) \
340 __vlc_mutex_destroy( "(unknown)", 0, P_MUTEX )
343 /*****************************************************************************
344 * vlc_cond_init: initialize a condition
345 *****************************************************************************/
346 #define vlc_cond_init( P_THIS, P_COND ) \
347 __vlc_cond_init( CAST_TO_VLC_OBJECT(P_THIS), P_COND )
349 /*****************************************************************************
350 * vlc_cond_signal: start a thread on condition completion
351 *****************************************************************************/
352 static inline int vlc_cond_signal( vlc_cond_t *p_condvar )
354 #if defined( PTH_INIT_IN_PTH_H )
355 return pth_cond_notify( p_condvar, FALSE );
357 #elif defined( ST_INIT_IN_ST_H )
358 return st_cond_signal( *p_condvar );
360 #elif defined( WIN32 )
361 /* Release one waiting thread if one is available. */
362 /* For this trick to work properly, the vlc_cond_signal must be surrounded
363 * by a mutex. This will prevent another thread from stealing the signal */
364 if( p_condvar->i_waiting_threads )
366 if( p_condvar->signal )
368 ReleaseSemaphore( p_condvar->semaphore, 1, 0 );
372 SetEvent( p_condvar->p_events[0/*signal*/] );
377 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
378 return pthread_cond_signal( p_condvar );
380 #elif defined( HAVE_CTHREADS_H )
381 /* condition_signal() */
382 if ( p_condvar->queue.head || p_condvar->implications )
384 cond_signal( (condition_t)p_condvar );
388 #elif defined( HAVE_KERNEL_SCHEDULER_H )
394 if( p_condvar->init < 2000 )
399 while( p_condvar->thread != -1 )
402 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
407 if( info.state != B_THREAD_SUSPENDED )
409 /* The waiting thread is not suspended so it could
410 * have been interrupted beetwen the unlock and the
411 * suspend_thread line. That is why we sleep a little
412 * before retesting p_condver->thread. */
417 /* Ok, we have to wake up that thread */
418 resume_thread( p_condvar->thread );
427 /*****************************************************************************
428 * vlc_cond_broadcast: start all threads waiting on condition completion
429 *****************************************************************************/
431 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
432 * Only works with pthreads, you need to adapt it for others
433 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
435 static inline int vlc_cond_broadcast( vlc_cond_t *p_condvar )
437 #if defined( PTH_INIT_IN_PTH_H )
438 return pth_cond_notify( p_condvar, FALSE );
440 #elif defined( ST_INIT_IN_ST_H )
441 return st_cond_broadcast( p_condvar );
443 #elif defined( WIN32 )
444 /* Release all waiting threads. */
445 if( p_condvar->i_waiting_threads )
447 if( p_condvar->signal )
449 p_condvar->b_broadcast = 1;
450 /* This call is atomic */
451 ReleaseSemaphore( p_condvar->semaphore,
452 p_condvar->i_waiting_threads, 0 );
453 /* Wait for all threads to get the semaphore */
454 WaitForSingleObject( p_condvar->signal, INFINITE );
455 p_condvar->b_broadcast = 0;
459 SetEvent( p_condvar->p_events[1/*broadcast*/] );
464 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
465 return pthread_cond_broadcast( p_condvar );
467 #elif defined( HAVE_CTHREADS_H )
468 /* condition_signal() */
469 if ( p_condvar->queue.head || p_condvar->implications )
471 cond_signal( (condition_t)p_condvar );
475 #elif defined( HAVE_KERNEL_SCHEDULER_H )
481 if( p_condvar->init < 2000 )
486 while( p_condvar->thread != -1 )
489 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
494 if( info.state != B_THREAD_SUSPENDED )
496 /* The waiting thread is not suspended so it could
497 * have been interrupted beetwen the unlock and the
498 * suspend_thread line. That is why we sleep a little
499 * before retesting p_condver->thread. */
504 /* Ok, we have to wake up that thread */
505 resume_thread( p_condvar->thread );
514 /*****************************************************************************
515 * vlc_cond_wait: wait until condition completion
516 *****************************************************************************/
518 # define vlc_cond_wait( P_COND, P_MUTEX ) \
519 __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX )
521 # define vlc_cond_wait( P_COND, P_MUTEX ) \
522 __vlc_cond_wait( "(unknown)", 0, P_COND, P_MUTEX )
525 static inline int __vlc_cond_wait( char * psz_file, int i_line,
526 vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
528 #if defined( PTH_INIT_IN_PTH_H )
529 return pth_cond_await( p_condvar, p_mutex, NULL );
531 #elif defined( ST_INIT_IN_ST_H )
534 st_mutex_unlock( *p_mutex );
535 i_ret = st_cond_wait( *p_condvar );
536 st_mutex_lock( *p_mutex );
540 #elif defined( WIN32 )
541 /* Increase our wait count */
542 p_condvar->i_waiting_threads++;
544 if( p_condvar->signal )
546 /* It is only possible to atomically release the mutex and initiate the
547 * waiting on WinNT/2K/XP. Win9x doesn't have SignalObjectAndWait(). */
548 p_condvar->SignalObjectAndWait( p_mutex->mutex, p_condvar->semaphore,
550 /* XXX: we should protect i_waiting_threads with a mutex, but
551 * is it really worth it ? */
552 p_condvar->i_waiting_threads--;
554 if( p_condvar->b_broadcast
555 && p_condvar->i_waiting_threads == 0 )
557 p_condvar->SignalObjectAndWait( p_condvar->signal, p_mutex->mutex,
562 /* Just take back the lock */
563 WaitForSingleObject( p_mutex->mutex, INFINITE );
571 /* Release the mutex, wait, and reacquire. */
572 LeaveCriticalSection( &p_mutex->csection );
573 i_ret = WaitForMultipleObjects( 2, p_condvar->p_events,
575 EnterCriticalSection( &p_mutex->csection );
577 /* Decrease our wait count */
578 p_condvar->i_waiting_threads--;
580 /* If we are the last waiter and it was a broadcast signal, reset
581 * the broadcast event. */
582 if( i_ret == WAIT_OBJECT_0 + 1/*broadcast*/
583 && p_condvar->i_waiting_threads == 0 )
585 ResetEvent( p_condvar->p_events[1/*broadcast*/] );
588 return( i_ret == WAIT_FAILED );
591 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
594 /* In debug mode, timeout */
596 struct timespec timeout;
601 gettimeofday( &now, NULL );
602 timeout.tv_sec = now.tv_sec + THREAD_COND_TIMEOUT;
603 timeout.tv_nsec = now.tv_usec * 1000;
605 i_result = pthread_cond_timedwait( p_condvar, p_mutex, &timeout );
607 if( i_result == ETIMEDOUT )
609 //X msg_Warn( "thread %d: possible deadlock detected "
610 //X "in cond_wait at %s:%d (%s)", pthread_self(),
611 //X psz_file, i_line, strerror(i_result) );
617 //X msg_Err( "thread %d: cond_wait failed at %s:%d (%s)",
618 //X pthread_self(), psz_file, i_line, strerror(i_result) );
623 return pthread_cond_wait( p_condvar, p_mutex );
626 #elif defined( HAVE_CTHREADS_H )
627 condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
630 #elif defined( HAVE_KERNEL_SCHEDULER_H )
641 if( p_condvar->init < 2000 )
646 /* The p_condvar->thread var is initialized before the unlock because
647 * it enables to identify when the thread is interrupted beetwen the
648 * unlock line and the suspend_thread line */
649 p_condvar->thread = find_thread( NULL );
650 vlc_mutex_unlock( p_mutex );
651 suspend_thread( p_condvar->thread );
652 p_condvar->thread = -1;
654 vlc_mutex_lock( p_mutex );
660 /*****************************************************************************
661 * vlc_cond_destroy: destroy a condition
662 *****************************************************************************/
664 # define vlc_cond_destroy( P_COND ) \
665 __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
667 # define vlc_cond_destroy( P_COND ) \
668 __vlc_cond_destroy( "(unknown)", 0, P_COND )
671 /*****************************************************************************
672 * vlc_thread_create: create a thread
673 *****************************************************************************/
674 # define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, WAIT ) \
675 __vlc_thread_create( CAST_TO_VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, (void * ( * ) ( void * ))FUNC, WAIT )
677 /*****************************************************************************
678 * vlc_thread_ready: tell the parent thread we were successfully spawned
679 *****************************************************************************/
680 # define vlc_thread_ready( P_THIS ) \
681 __vlc_thread_ready( CAST_TO_VLC_OBJECT(P_THIS) )
683 /*****************************************************************************
684 * vlc_thread_join: wait until a thread exits
685 *****************************************************************************/
687 # define vlc_thread_join( P_THIS ) \
688 __vlc_thread_join( CAST_TO_VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
690 # define vlc_thread_join( P_THIS ) \
691 __vlc_thread_join( CAST_TO_VLC_OBJECT(P_THIS), "(unknown)", 0 )