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.9 2002/08/08 00:35: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 volatile int i_waiting_threads;
120 /* WinNT/2K/XP implementation */
122 SIGNALOBJECTANDWAIT SignalObjectAndWait;
123 /* Win95/98/ME implementation */
125 CRITICAL_SECTION csection;
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( VLC_OBJECT(P_THIS) )
196 /*****************************************************************************
197 * vlc_threads_end: deinitialize threads system
198 *****************************************************************************/
199 #define vlc_threads_end( P_THIS ) \
200 __vlc_threads_end( 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( 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 );
244 msg_Err( "thread %d: mutex_lock failed at %s:%d (%s)",
245 pthread_self(), psz_file, i_line, strerror(i_return) );
250 #elif defined( HAVE_CTHREADS_H )
251 mutex_lock( p_mutex );
254 #elif defined( HAVE_KERNEL_SCHEDULER_H )
262 if( p_mutex->init < 2000 )
267 err = acquire_sem( p_mutex->lock );
273 /*****************************************************************************
274 * vlc_mutex_unlock: unlock a mutex
275 *****************************************************************************/
277 # define vlc_mutex_unlock( P_MUTEX ) \
278 __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
280 # define vlc_mutex_unlock( P_MUTEX ) \
281 __vlc_mutex_unlock( "(unknown)", 0, P_MUTEX )
284 static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
285 vlc_mutex_t *p_mutex )
287 #if defined( PTH_INIT_IN_PTH_H )
288 return pth_mutex_release( p_mutex );
290 #elif defined( ST_INIT_IN_ST_H )
291 return st_mutex_unlock( *p_mutex );
293 #elif defined( WIN32 )
296 ReleaseMutex( p_mutex->mutex );
300 LeaveCriticalSection( &p_mutex->csection );
304 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
305 int i_return = pthread_mutex_unlock( p_mutex );
309 msg_Err( "thread %d: mutex_unlock failed at %s:%d (%s)",
310 pthread_self(), psz_file, i_line, strerror(i_return) );
315 #elif defined( HAVE_CTHREADS_H )
316 mutex_unlock( p_mutex );
319 #elif defined( HAVE_KERNEL_SCHEDULER_H )
325 if( p_mutex->init < 2000 )
330 release_sem( p_mutex->lock );
336 /*****************************************************************************
337 * vlc_mutex_destroy: destroy a mutex
338 *****************************************************************************/
340 # define vlc_mutex_destroy( P_MUTEX ) \
341 __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
343 # define vlc_mutex_destroy( P_MUTEX ) \
344 __vlc_mutex_destroy( "(unknown)", 0, P_MUTEX )
347 /*****************************************************************************
348 * vlc_cond_init: initialize a condition
349 *****************************************************************************/
350 #define vlc_cond_init( P_THIS, P_COND ) \
351 __vlc_cond_init( VLC_OBJECT(P_THIS), P_COND )
353 /*****************************************************************************
354 * vlc_cond_signal: start a thread on condition completion
355 *****************************************************************************/
356 static inline int vlc_cond_signal( vlc_cond_t *p_condvar )
358 #if defined( PTH_INIT_IN_PTH_H )
359 return pth_cond_notify( p_condvar, FALSE );
361 #elif defined( ST_INIT_IN_ST_H )
362 return st_cond_signal( *p_condvar );
364 #elif defined( WIN32 )
365 /* Release one waiting thread if one is available. */
366 /* For this trick to work properly, the vlc_cond_signal must be surrounded
367 * by a mutex. This will prevent another thread from stealing the signal */
368 if( !p_condvar->semaphore )
370 PulseEvent( p_condvar->event );
372 else if( p_condvar->i_win9x_cv == 1 )
374 /* Wait for the gate to be open */
375 WaitForSingleObject( p_condvar->event, INFINITE );
377 if( p_condvar->i_waiting_threads )
379 /* Using a semaphore exposes us to a race condition. It is
380 * possible for another thread to start waiting on the semaphore
381 * just after we signaled it and thus steal the signal.
382 * We have to prevent new threads from entering the cond_wait(). */
383 ResetEvent( p_condvar->event );
385 /* A semaphore is used here because Win9x doesn't have
386 * SignalObjectAndWait() and thus a race condition exists
387 * during the time we release the mutex and the time we start
388 * waiting on the event (more precisely, the signal can sometimes
389 * be missed by the waiting thread if we use PulseEvent()). */
390 ReleaseSemaphore( p_condvar->semaphore, 1, 0 );
395 if( p_condvar->i_waiting_threads )
397 ReleaseSemaphore( p_condvar->semaphore, 1, 0 );
399 /* Wait for the last thread to be awakened */
400 WaitForSingleObject( p_condvar->event, INFINITE );
405 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
406 return pthread_cond_signal( p_condvar );
408 #elif defined( HAVE_CTHREADS_H )
409 /* condition_signal() */
410 if ( p_condvar->queue.head || p_condvar->implications )
412 cond_signal( (condition_t)p_condvar );
416 #elif defined( HAVE_KERNEL_SCHEDULER_H )
422 if( p_condvar->init < 2000 )
427 while( p_condvar->thread != -1 )
430 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
435 if( info.state != B_THREAD_SUSPENDED )
437 /* The waiting thread is not suspended so it could
438 * have been interrupted beetwen the unlock and the
439 * suspend_thread line. That is why we sleep a little
440 * before retesting p_condver->thread. */
445 /* Ok, we have to wake up that thread */
446 resume_thread( p_condvar->thread );
455 /*****************************************************************************
456 * vlc_cond_broadcast: start all threads waiting on condition completion
457 *****************************************************************************/
459 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
460 * Only works with pthreads, you need to adapt it for others
461 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
463 static inline int vlc_cond_broadcast( vlc_cond_t *p_condvar )
465 #if defined( PTH_INIT_IN_PTH_H )
466 return pth_cond_notify( p_condvar, FALSE );
468 #elif defined( ST_INIT_IN_ST_H )
469 return st_cond_broadcast( p_condvar );
471 #elif defined( WIN32 )
472 /* Release all waiting threads. */
475 if( !p_condvar->semaphore )
476 for( i = p_condvar->i_waiting_threads; i > 0; i-- )
477 PulseEvent( p_condvar->event );
478 else if( p_condvar->i_win9x_cv == 1 )
480 /* Wait for the gate to be open */
481 WaitForSingleObject( p_condvar->event, INFINITE );
483 if( p_condvar->i_waiting_threads )
486 ResetEvent( p_condvar->event );
488 ReleaseSemaphore( p_condvar->semaphore,
489 p_condvar->i_waiting_threads, 0 );
494 if( p_condvar->i_waiting_threads )
496 ReleaseSemaphore( p_condvar->semaphore,
497 p_condvar->i_waiting_threads, 0 );
498 /* Wait for the last thread to be awakened */
499 WaitForSingleObject( p_condvar->event, INFINITE );
505 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
506 return pthread_cond_broadcast( p_condvar );
508 #elif defined( HAVE_CTHREADS_H )
509 /* condition_signal() */
510 if ( p_condvar->queue.head || p_condvar->implications )
512 cond_signal( (condition_t)p_condvar );
516 #elif defined( HAVE_KERNEL_SCHEDULER_H )
522 if( p_condvar->init < 2000 )
527 while( p_condvar->thread != -1 )
530 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
535 if( info.state != B_THREAD_SUSPENDED )
537 /* The waiting thread is not suspended so it could
538 * have been interrupted beetwen the unlock and the
539 * suspend_thread line. That is why we sleep a little
540 * before retesting p_condver->thread. */
545 /* Ok, we have to wake up that thread */
546 resume_thread( p_condvar->thread );
555 /*****************************************************************************
556 * vlc_cond_wait: wait until condition completion
557 *****************************************************************************/
559 # define vlc_cond_wait( P_COND, P_MUTEX ) \
560 __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX )
562 # define vlc_cond_wait( P_COND, P_MUTEX ) \
563 __vlc_cond_wait( "(unknown)", 0, P_COND, P_MUTEX )
566 static inline int __vlc_cond_wait( char * psz_file, int i_line,
567 vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
569 #if defined( PTH_INIT_IN_PTH_H )
570 return pth_cond_await( p_condvar, p_mutex, NULL );
572 #elif defined( ST_INIT_IN_ST_H )
575 st_mutex_unlock( *p_mutex );
576 i_ret = st_cond_wait( *p_condvar );
577 st_mutex_lock( *p_mutex );
581 #elif defined( WIN32 )
582 if( !p_condvar->semaphore )
584 /* Increase our wait count */
585 p_condvar->i_waiting_threads++;
587 if( p_condvar->SignalObjectAndWait && p_mutex->mutex )
588 /* It is only possible to atomically release the mutex and initiate the
589 * waiting on WinNT/2K/XP. Win9x doesn't have SignalObjectAndWait(). */
590 p_condvar->SignalObjectAndWait( p_mutex->mutex,
595 LeaveCriticalSection( &p_mutex->csection );
596 WaitForSingleObject( p_condvar->event, INFINITE );
599 p_condvar->i_waiting_threads--;
601 else if( p_condvar->i_win9x_cv == 1 )
603 int i_waiting_threads;
605 /* Wait for the gate to be open */
606 WaitForSingleObject( p_condvar->event, INFINITE );
608 /* Increase our wait count */
609 p_condvar->i_waiting_threads++;
611 LeaveCriticalSection( &p_mutex->csection );
612 WaitForSingleObject( p_condvar->semaphore, INFINITE );
614 /* Decrement and test must be atomic */
615 EnterCriticalSection( &p_condvar->csection );
617 /* Decrease our wait count */
618 i_waiting_threads = --p_condvar->i_waiting_threads;
620 LeaveCriticalSection( &p_condvar->csection );
622 /* Reopen the gate if we were the last waiting thread */
623 if( !i_waiting_threads )
624 SetEvent( p_condvar->event );
628 int i_waiting_threads;
630 /* Increase our wait count */
631 p_condvar->i_waiting_threads++;
633 LeaveCriticalSection( &p_mutex->csection );
634 WaitForSingleObject( p_condvar->semaphore, INFINITE );
636 /* Decrement and test must be atomic */
637 EnterCriticalSection( &p_condvar->csection );
639 /* Decrease our wait count */
640 i_waiting_threads = --p_condvar->i_waiting_threads;
642 LeaveCriticalSection( &p_condvar->csection );
644 /* Signal that the last waiting thread just went through */
645 if( !i_waiting_threads )
646 SetEvent( p_condvar->event );
649 /* Reacquire the mutex before returning. */
650 vlc_mutex_lock( p_mutex );
654 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
657 /* In debug mode, timeout */
659 struct timespec timeout;
664 gettimeofday( &now, NULL );
665 timeout.tv_sec = now.tv_sec + THREAD_COND_TIMEOUT;
666 timeout.tv_nsec = now.tv_usec * 1000;
668 i_result = pthread_cond_timedwait( p_condvar, p_mutex, &timeout );
670 if( i_result == ETIMEDOUT )
673 msg_Warn( "thread %d: possible deadlock detected "
674 "in cond_wait at %s:%d (%s)", pthread_self(),
675 psz_file, i_line, strerror(i_result) );
683 msg_Err( "thread %d: cond_wait failed at %s:%d (%s)",
684 pthread_self(), psz_file, i_line, strerror(i_result) );
690 return pthread_cond_wait( p_condvar, p_mutex );
693 #elif defined( HAVE_CTHREADS_H )
694 condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
697 #elif defined( HAVE_KERNEL_SCHEDULER_H )
708 if( p_condvar->init < 2000 )
713 /* The p_condvar->thread var is initialized before the unlock because
714 * it enables to identify when the thread is interrupted beetwen the
715 * unlock line and the suspend_thread line */
716 p_condvar->thread = find_thread( NULL );
717 vlc_mutex_unlock( p_mutex );
718 suspend_thread( p_condvar->thread );
719 p_condvar->thread = -1;
721 vlc_mutex_lock( p_mutex );
727 /*****************************************************************************
728 * vlc_cond_destroy: destroy a condition
729 *****************************************************************************/
731 # define vlc_cond_destroy( P_COND ) \
732 __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
734 # define vlc_cond_destroy( P_COND ) \
735 __vlc_cond_destroy( "(unknown)", 0, P_COND )
738 /*****************************************************************************
739 * vlc_thread_create: create a thread
740 *****************************************************************************/
741 # define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, WAIT ) \
742 __vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, (void * ( * ) ( void * ))FUNC, WAIT )
744 /*****************************************************************************
745 * vlc_thread_ready: tell the parent thread we were successfully spawned
746 *****************************************************************************/
747 # define vlc_thread_ready( P_THIS ) \
748 __vlc_thread_ready( VLC_OBJECT(P_THIS) )
750 /*****************************************************************************
751 * vlc_thread_join: wait until a thread exits
752 *****************************************************************************/
754 # define vlc_thread_join( P_THIS ) \
755 __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
757 # define vlc_thread_join( P_THIS ) \
758 __vlc_thread_join( VLC_OBJECT(P_THIS), "(unknown)", 0 )