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.4 2002/07/05 11:18:56 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, ( void ) );
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_mutex_init: initialize a mutex
198 *****************************************************************************/
199 #define vlc_mutex_init( P_THIS, P_MUTEX ) \
200 __vlc_mutex_init( CAST_TO_VLC_OBJECT(P_THIS), P_MUTEX )
202 /*****************************************************************************
203 * vlc_mutex_lock: lock a mutex
204 *****************************************************************************/
206 # define vlc_mutex_lock( P_MUTEX ) \
207 __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
209 # define vlc_mutex_lock( P_MUTEX ) \
210 __vlc_mutex_lock( "(unknown)", 0, P_MUTEX )
213 static inline int __vlc_mutex_lock( char * psz_file, int i_line,
214 vlc_mutex_t *p_mutex )
216 #if defined( PTH_INIT_IN_PTH_H )
217 return pth_mutex_acquire( p_mutex, TRUE, NULL );
219 #elif defined( ST_INIT_IN_ST_H )
220 return st_mutex_lock( *p_mutex );
222 #elif defined( WIN32 )
225 WaitForSingleObject( p_mutex->mutex, INFINITE );
229 EnterCriticalSection( &p_mutex->csection );
233 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
234 int i_return = pthread_mutex_lock( p_mutex );
237 // msg_Err( "thread %d: mutex_lock failed at %s:%d (%s)",
238 // pthread_self(), psz_file, i_line, strerror(i_return) );
242 #elif defined( HAVE_CTHREADS_H )
243 mutex_lock( p_mutex );
246 #elif defined( HAVE_KERNEL_SCHEDULER_H )
254 if( p_mutex->init < 2000 )
259 err = acquire_sem( p_mutex->lock );
265 /*****************************************************************************
266 * vlc_mutex_unlock: unlock a mutex
267 *****************************************************************************/
269 # define vlc_mutex_unlock( P_MUTEX ) \
270 __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
272 # define vlc_mutex_unlock( P_MUTEX ) \
273 __vlc_mutex_unlock( "(unknown)", 0, P_MUTEX )
276 static inline int __vlc_mutex_unlock( char * psz_file, int i_line,
277 vlc_mutex_t *p_mutex )
279 #if defined( PTH_INIT_IN_PTH_H )
280 return pth_mutex_release( p_mutex );
282 #elif defined( ST_INIT_IN_ST_H )
283 return st_mutex_unlock( *p_mutex );
285 #elif defined( WIN32 )
288 ReleaseMutex( p_mutex->mutex );
292 LeaveCriticalSection( &p_mutex->csection );
296 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
297 int i_return = pthread_mutex_unlock( p_mutex );
300 // msg_Err( "thread %d: mutex_unlock failed at %s:%d (%s)",
301 // pthread_self(), psz_file, i_line, strerror(i_return) );
305 #elif defined( HAVE_CTHREADS_H )
306 mutex_unlock( p_mutex );
309 #elif defined( HAVE_KERNEL_SCHEDULER_H )
315 if( p_mutex->init < 2000 )
320 release_sem( p_mutex->lock );
326 /*****************************************************************************
327 * vlc_mutex_destroy: destroy a mutex
328 *****************************************************************************/
330 # define vlc_mutex_destroy( P_MUTEX ) \
331 __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
333 # define vlc_mutex_destroy( P_MUTEX ) \
334 __vlc_mutex_destroy( "(unknown)", 0, P_MUTEX )
337 /*****************************************************************************
338 * vlc_cond_init: initialize a condition
339 *****************************************************************************/
340 #define vlc_cond_init( P_THIS, P_COND ) \
341 __vlc_cond_init( CAST_TO_VLC_OBJECT(P_THIS), P_COND )
343 /*****************************************************************************
344 * vlc_cond_signal: start a thread on condition completion
345 *****************************************************************************/
346 static inline int vlc_cond_signal( vlc_cond_t *p_condvar )
348 #if defined( PTH_INIT_IN_PTH_H )
349 return pth_cond_notify( p_condvar, FALSE );
351 #elif defined( ST_INIT_IN_ST_H )
352 return st_cond_signal( *p_condvar );
354 #elif defined( WIN32 )
355 /* Release one waiting thread if one is available. */
356 /* For this trick to work properly, the vlc_cond_signal must be surrounded
357 * by a mutex. This will prevent another thread from stealing the signal */
358 if( p_condvar->i_waiting_threads )
360 if( p_condvar->signal )
362 ReleaseSemaphore( p_condvar->semaphore, 1, 0 );
366 SetEvent( p_condvar->p_events[0/*signal*/] );
371 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
372 return pthread_cond_signal( p_condvar );
374 #elif defined( HAVE_CTHREADS_H )
375 /* condition_signal() */
376 if ( p_condvar->queue.head || p_condvar->implications )
378 cond_signal( (condition_t)p_condvar );
382 #elif defined( HAVE_KERNEL_SCHEDULER_H )
388 if( p_condvar->init < 2000 )
393 while( p_condvar->thread != -1 )
396 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
401 if( info.state != B_THREAD_SUSPENDED )
403 /* The waiting thread is not suspended so it could
404 * have been interrupted beetwen the unlock and the
405 * suspend_thread line. That is why we sleep a little
406 * before retesting p_condver->thread. */
411 /* Ok, we have to wake up that thread */
412 resume_thread( p_condvar->thread );
421 /*****************************************************************************
422 * vlc_cond_broadcast: start all threads waiting on condition completion
423 *****************************************************************************/
425 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
426 * Only works with pthreads, you need to adapt it for others
427 * FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME FIXME
429 static inline int vlc_cond_broadcast( vlc_cond_t *p_condvar )
431 #if defined( PTH_INIT_IN_PTH_H )
432 return pth_cond_notify( p_condvar, FALSE );
434 #elif defined( ST_INIT_IN_ST_H )
435 return st_cond_broadcast( p_condvar );
437 #elif defined( WIN32 )
438 /* Release all waiting threads. */
439 if( p_condvar->i_waiting_threads )
441 if( p_condvar->signal )
443 p_condvar->b_broadcast = 1;
444 /* This call is atomic */
445 ReleaseSemaphore( p_condvar->semaphore,
446 p_condvar->i_waiting_threads, 0 );
447 /* Wait for all threads to get the semaphore */
448 WaitForSingleObject( p_condvar->signal, INFINITE );
449 p_condvar->b_broadcast = 0;
453 SetEvent( p_condvar->p_events[1/*broadcast*/] );
458 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
459 return pthread_cond_broadcast( p_condvar );
461 #elif defined( HAVE_CTHREADS_H )
462 /* condition_signal() */
463 if ( p_condvar->queue.head || p_condvar->implications )
465 cond_signal( (condition_t)p_condvar );
469 #elif defined( HAVE_KERNEL_SCHEDULER_H )
475 if( p_condvar->init < 2000 )
480 while( p_condvar->thread != -1 )
483 if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
488 if( info.state != B_THREAD_SUSPENDED )
490 /* The waiting thread is not suspended so it could
491 * have been interrupted beetwen the unlock and the
492 * suspend_thread line. That is why we sleep a little
493 * before retesting p_condver->thread. */
498 /* Ok, we have to wake up that thread */
499 resume_thread( p_condvar->thread );
508 /*****************************************************************************
509 * vlc_cond_wait: wait until condition completion
510 *****************************************************************************/
512 # define vlc_cond_wait( P_COND, P_MUTEX ) \
513 __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX )
515 # define vlc_cond_wait( P_COND, P_MUTEX ) \
516 __vlc_cond_wait( "(unknown)", 0, P_COND, P_MUTEX )
519 static inline int __vlc_cond_wait( char * psz_file, int i_line,
520 vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
522 #if defined( PTH_INIT_IN_PTH_H )
523 return pth_cond_await( p_condvar, p_mutex, NULL );
525 #elif defined( ST_INIT_IN_ST_H )
528 st_mutex_unlock( *p_mutex );
529 i_ret = st_cond_wait( *p_condvar );
530 st_mutex_lock( *p_mutex );
534 #elif defined( WIN32 )
535 /* Increase our wait count */
536 p_condvar->i_waiting_threads++;
538 if( p_condvar->signal )
540 /* It is only possible to atomically release the mutex and initiate the
541 * waiting on WinNT/2K/XP. Win9x doesn't have SignalObjectAndWait(). */
542 p_condvar->SignalObjectAndWait( p_mutex->mutex, p_condvar->semaphore,
544 /* XXX: we should protect i_waiting_threads with a mutex, but
545 * is it really worth it ? */
546 p_condvar->i_waiting_threads--;
548 if( p_condvar->b_broadcast
549 && p_condvar->i_waiting_threads == 0 )
551 p_condvar->SignalObjectAndWait( p_condvar->signal, p_mutex->mutex,
556 /* Just take back the lock */
557 WaitForSingleObject( p_mutex->mutex, INFINITE );
565 /* Release the mutex, wait, and reacquire. */
566 LeaveCriticalSection( &p_mutex->csection );
567 i_ret = WaitForMultipleObjects( 2, p_condvar->p_events,
569 EnterCriticalSection( &p_mutex->csection );
571 /* Decrease our wait count */
572 p_condvar->i_waiting_threads--;
574 /* If we are the last waiter and it was a broadcast signal, reset
575 * the broadcast event. */
576 if( i_ret == WAIT_OBJECT_0 + 1/*broadcast*/
577 && p_condvar->i_waiting_threads == 0 )
579 ResetEvent( p_condvar->p_events[1/*broadcast*/] );
582 return( i_ret == WAIT_FAILED );
585 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
588 /* In debug mode, timeout */
590 struct timespec timeout;
595 gettimeofday( &now, NULL );
596 timeout.tv_sec = now.tv_sec + THREAD_COND_TIMEOUT;
597 timeout.tv_nsec = now.tv_usec * 1000;
599 i_result = pthread_cond_timedwait( p_condvar, p_mutex, &timeout );
601 if( i_result == ETIMEDOUT )
603 //X msg_Warn( "thread %d: possible deadlock detected "
604 //X "in cond_wait at %s:%d (%s)", pthread_self(),
605 //X psz_file, i_line, strerror(i_result) );
611 //X msg_Err( "thread %d: cond_wait failed at %s:%d (%s)",
612 //X pthread_self(), psz_file, i_line, strerror(i_result) );
617 return pthread_cond_wait( p_condvar, p_mutex );
620 #elif defined( HAVE_CTHREADS_H )
621 condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
624 #elif defined( HAVE_KERNEL_SCHEDULER_H )
635 if( p_condvar->init < 2000 )
640 /* The p_condvar->thread var is initialized before the unlock because
641 * it enables to identify when the thread is interrupted beetwen the
642 * unlock line and the suspend_thread line */
643 p_condvar->thread = find_thread( NULL );
644 vlc_mutex_unlock( p_mutex );
645 suspend_thread( p_condvar->thread );
646 p_condvar->thread = -1;
648 vlc_mutex_lock( p_mutex );
654 /*****************************************************************************
655 * vlc_cond_destroy: destroy a condition
656 *****************************************************************************/
658 # define vlc_cond_destroy( P_COND ) \
659 __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
661 # define vlc_cond_destroy( P_COND ) \
662 __vlc_cond_destroy( "(unknown)", 0, P_COND )
665 /*****************************************************************************
666 * vlc_thread_create: create a thread
667 *****************************************************************************/
668 # define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, WAIT ) \
669 __vlc_thread_create( CAST_TO_VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, (void * ( * ) ( void * ))FUNC, WAIT )
671 /*****************************************************************************
672 * vlc_thread_ready: tell the parent thread we were successfully spawned
673 *****************************************************************************/
674 # define vlc_thread_ready( P_THIS ) \
675 __vlc_thread_ready( CAST_TO_VLC_OBJECT(P_THIS) )
677 /*****************************************************************************
678 * vlc_thread_join: wait until a thread exits
679 *****************************************************************************/
681 # define vlc_thread_join( P_THIS ) \
682 __vlc_thread_join( CAST_TO_VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
684 # define vlc_thread_join( P_THIS ) \
685 __vlc_thread_join( CAST_TO_VLC_OBJECT(P_THIS), "(unknown)", 0 )