1 /*****************************************************************************
2 * threads.c : threads implementation for the VideoLAN client
3 *****************************************************************************
4 * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
5 * $Id: threads.c,v 1.13 2002/08/29 23:53:22 massiot Exp $
7 * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@netcourrier.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
28 #define VLC_THREADS_UNINITIALIZED 0
29 #define VLC_THREADS_PENDING 1
30 #define VLC_THREADS_ERROR 2
31 #define VLC_THREADS_READY 3
33 /*****************************************************************************
34 * Prototype for GPROF wrapper
35 *****************************************************************************/
37 /* Wrapper function for profiling */
38 static void * vlc_thread_wrapper ( void *p_wrapper );
42 # define ITIMER_REAL 1
43 # define ITIMER_PROF 2
47 struct timeval it_value;
48 struct timeval it_interval;
51 int setitimer(int kind, const struct itimerval* itnew, struct itimerval* itold);
54 typedef struct wrapper_t
56 /* Data lock access */
60 /* Data used to spawn the real thread */
61 vlc_thread_func_t func;
64 /* Profiling timer passed to the thread */
65 struct itimerval itimer;
71 /*****************************************************************************
72 * Global mutexes for lazy initialization of the threads system
73 *****************************************************************************/
74 static volatile int i_initializations = 0;
76 #if defined( PTH_INIT_IN_PTH_H )
78 #elif defined( ST_INIT_IN_ST_H )
80 #elif defined( WIN32 )
82 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
83 static pthread_mutex_t once_mutex = PTHREAD_MUTEX_INITIALIZER;
84 #elif defined( HAVE_CTHREADS_H )
86 #elif defined( HAVE_KERNEL_SCHEDULER_H )
90 /*****************************************************************************
91 * vlc_threads_init: initialize threads system
92 *****************************************************************************
93 * This function requires lazy initialization of a global lock in order to
94 * keep the library really thread-safe. Some architectures don't support this
95 * and thus do not guarantee the complete reentrancy.
96 *****************************************************************************/
97 int __vlc_threads_init( vlc_object_t *p_this )
99 static volatile int i_status = VLC_THREADS_UNINITIALIZED;
102 #if defined( PTH_INIT_IN_PTH_H )
104 #elif defined( ST_INIT_IN_ST_H )
106 #elif defined( WIN32 )
108 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
109 pthread_mutex_lock( &once_mutex );
110 #elif defined( HAVE_CTHREADS_H )
112 #elif defined( HAVE_KERNEL_SCHEDULER_H )
116 if( i_status == VLC_THREADS_UNINITIALIZED )
118 i_status = VLC_THREADS_PENDING;
120 #if defined( PTH_INIT_IN_PTH_H )
122 #elif defined( ST_INIT_IN_ST_H )
124 #elif defined( WIN32 )
126 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
128 #elif defined( HAVE_CTHREADS_H )
130 #elif defined( HAVE_KERNEL_SCHEDULER_H )
136 i_status = VLC_THREADS_ERROR;
140 vlc_mutex_init( p_this, p_this->p_vlc->p_global_lock );
141 i_status = VLC_THREADS_READY;
146 i_ret = ( i_status == VLC_THREADS_READY );
151 #if defined( PTH_INIT_IN_PTH_H )
153 #elif defined( ST_INIT_IN_ST_H )
155 #elif defined( WIN32 )
157 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
158 pthread_mutex_unlock( &once_mutex );
160 #elif defined( HAVE_CTHREADS_H )
162 #elif defined( HAVE_KERNEL_SCHEDULER_H )
166 /* Wait until the other thread has initialized the thread library */
167 while( i_status == VLC_THREADS_PENDING )
169 msleep( THREAD_SLEEP );
172 return i_status == VLC_THREADS_READY;
175 /*****************************************************************************
176 * vlc_threads_end: stop threads system
177 *****************************************************************************
178 * FIXME: This function is far from being threadsafe. We should undo exactly
179 * what we did above in vlc_threads_init.
180 *****************************************************************************/
181 int __vlc_threads_end( vlc_object_t *p_this )
183 #if defined( PTH_INIT_IN_PTH_H )
185 if( i_initializations == 0 )
191 #elif defined( ST_INIT_IN_ST_H )
195 #elif defined( WIN32 )
199 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
200 pthread_mutex_lock( &once_mutex );
202 pthread_mutex_unlock( &once_mutex );
205 #elif defined( HAVE_CTHREADS_H )
209 #elif defined( HAVE_KERNEL_SCHEDULER_H )
216 /*****************************************************************************
217 * vlc_mutex_init: initialize a mutex
218 *****************************************************************************/
219 int __vlc_mutex_init( vlc_object_t *p_this, vlc_mutex_t *p_mutex )
221 p_mutex->p_this = p_this;
223 #if defined( PTH_INIT_IN_PTH_H )
224 return pth_mutex_init( &p_mutex->mutex );
226 #elif defined( ST_INIT_IN_ST_H )
227 *p_mutex->mutex = st_mutex_new();
228 return ( *p_mutex == NULL ) ? errno : 0;
230 #elif defined( WIN32 )
231 /* We use mutexes on WinNT/2K/XP because we can use the SignalObjectAndWait
232 * function and have a 100% correct vlc_cond_wait() implementation.
233 * As this function is not available on Win9x, we can use the faster
234 * CriticalSections */
235 if( p_this->p_vlc->SignalObjectAndWait && !p_this->p_vlc->b_fast_mutex )
237 /* We are running on NT/2K/XP, we can use SignalObjectAndWait */
238 p_mutex->mutex = CreateMutex( 0, FALSE, 0 );
239 return ( p_mutex->mutex != NULL ? 0 : 1 );
243 p_mutex->mutex = NULL;
244 InitializeCriticalSection( &p_mutex->csection );
248 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
249 # if defined(DEBUG) && defined(SYS_LINUX)
251 /* Create error-checking mutex to detect problems more easily. */
252 pthread_mutexattr_t attr;
255 pthread_mutexattr_init( &attr );
256 pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP );
257 i_result = pthread_mutex_init( p_mutex, &attr );
258 pthread_mutexattr_destroy( &attr );
262 return pthread_mutex_init( &p_mutex->mutex, NULL );
264 #elif defined( HAVE_CTHREADS_H )
265 mutex_init( p_mutex );
268 #elif defined( HAVE_KERNEL_SCHEDULER_H )
269 /* check the arguments and whether it's already been initialized */
270 if( p_mutex == NULL )
275 if( p_mutex->init == 9999 )
280 p_mutex->lock = create_sem( 1, "BeMutex" );
281 if( p_mutex->lock < B_NO_ERROR )
286 p_mutex->init = 9999;
292 /*****************************************************************************
293 * vlc_mutex_destroy: destroy a mutex, inner version
294 *****************************************************************************/
295 int __vlc_mutex_destroy( char * psz_file, int i_line, vlc_mutex_t *p_mutex )
298 /* In case of error : */
300 const char * psz_error = "";
302 #if defined( PTH_INIT_IN_PTH_H )
305 #elif defined( ST_INIT_IN_ST_H )
306 i_result = st_mutex_destroy( *p_mutex );
308 #elif defined( WIN32 )
311 CloseHandle( p_mutex->mutex );
315 DeleteCriticalSection( &p_mutex->csection );
319 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
320 i_result = pthread_mutex_destroy( &p_mutex->mutex );
323 i_thread = pthread_self();
324 psz_error = strerror(i_result);
327 #elif defined( HAVE_CTHREADS_H )
330 #elif defined( HAVE_KERNEL_SCHEDULER_H )
331 if( p_mutex->init == 9999 )
333 delete_sem( p_mutex->lock );
342 msg_Err( p_mutex->p_this,
343 "thread %d: mutex_destroy failed at %s:%d (%d:%s)",
344 i_thread, psz_file, i_line, i_result, psz_error );
349 /*****************************************************************************
350 * vlc_cond_init: initialize a condition
351 *****************************************************************************/
352 int __vlc_cond_init( vlc_object_t *p_this, vlc_cond_t *p_condvar )
354 p_condvar->p_this = p_this;
356 #if defined( PTH_INIT_IN_PTH_H )
357 return pth_cond_init( &p_condvar->cond );
359 #elif defined( ST_INIT_IN_ST_H )
360 *p_condvar->cond = st_cond_new();
361 return ( *p_condvar->cond == NULL ) ? errno : 0;
363 #elif defined( WIN32 )
364 /* Initialize counter */
365 p_condvar->i_waiting_threads = 0;
368 p_condvar->i_win9x_cv = p_this->p_vlc->i_win9x_cv;
369 p_condvar->SignalObjectAndWait = p_this->p_vlc->SignalObjectAndWait;
371 if( p_this->p_vlc->i_win9x_cv == 0 )
373 /* Create an auto-reset event. */
374 p_condvar->event = CreateEvent( NULL, /* no security */
375 FALSE, /* auto-reset event */
376 FALSE, /* start non-signaled */
377 NULL ); /* unnamed */
379 p_condvar->semaphore = NULL;
380 return !p_condvar->event;
384 p_condvar->semaphore = CreateSemaphore( NULL, /* no security */
385 0, /* initial count */
386 0x7fffffff, /* max count */
387 NULL ); /* unnamed */
389 if( p_this->p_vlc->i_win9x_cv == 1 )
390 /* Create a manual-reset event initially signaled. */
391 p_condvar->event = CreateEvent( NULL, TRUE, TRUE, NULL );
393 /* Create a auto-reset event. */
394 p_condvar->event = CreateEvent( NULL, FALSE, FALSE, NULL );
396 InitializeCriticalSection( &p_condvar->csection );
398 return !p_condvar->semaphore || !p_condvar->event;
401 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
402 return pthread_cond_init( &p_condvar->cond, NULL );
404 #elif defined( HAVE_CTHREADS_H )
405 /* condition_init() */
406 spin_lock_init( &p_condvar->lock );
407 cthread_queue_init( &p_condvar->queue );
409 p_condvar->implications = 0;
413 #elif defined( HAVE_KERNEL_SCHEDULER_H )
419 if( p_condvar->init == 9999 )
424 p_condvar->thread = -1;
425 p_condvar->init = 9999;
430 /*****************************************************************************
431 * vlc_cond_destroy: destroy a condition, inner version
432 *****************************************************************************/
433 int __vlc_cond_destroy( char * psz_file, int i_line, vlc_cond_t *p_condvar )
436 /* In case of error : */
438 const char * psz_error = "";
440 #if defined( PTH_INIT_IN_PTH_H )
443 #elif defined( ST_INIT_IN_ST_H )
444 i_result = st_cond_destroy( *p_condvar->cond );
446 #elif defined( WIN32 )
447 if( !p_condvar->semaphore )
448 i_result = !CloseHandle( p_condvar->event );
450 i_result = !CloseHandle( p_condvar->event )
451 || !CloseHandle( p_condvar->semaphore );
453 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
454 i_result = pthread_cond_destroy( &p_condvar->cond );
457 i_thread = pthread_self();
458 psz_error = strerror(i_result);
461 #elif defined( HAVE_CTHREADS_H )
464 #elif defined( HAVE_KERNEL_SCHEDULER_H )
471 msg_Err( p_condvar->p_this,
472 "thread %d: cond_destroy failed at %s:%d (%d:%s)",
473 i_thread, psz_file, i_line, i_result, psz_error );
478 /*****************************************************************************
479 * vlc_thread_create: create a thread, inner version
480 *****************************************************************************
481 * Note that i_priority is only taken into account on platforms supporting
482 * userland real-time priority threads.
483 *****************************************************************************/
484 int __vlc_thread_create( vlc_object_t *p_this, char * psz_file, int i_line,
485 char *psz_name, void * ( *func ) ( void * ),
486 int i_priority, vlc_bool_t b_wait )
490 vlc_mutex_lock( &p_this->object_lock );
495 /* Initialize the wrapper structure */
497 wrapper.p_data = (void *)p_this;
498 getitimer( ITIMER_PROF, &wrapper.itimer );
499 vlc_mutex_init( p_this, &wrapper.lock );
500 vlc_cond_init( p_this, &wrapper.wait );
501 vlc_mutex_lock( &wrapper.lock );
503 /* Alter user-passed data so that we call the wrapper instead
504 * of the real function */
506 func = vlc_thread_wrapper;
509 #if defined( PTH_INIT_IN_PTH_H )
510 p_this->thread_id = pth_spawn( PTH_ATTR_DEFAULT, func, (void *)p_this );
513 #elif defined( ST_INIT_IN_ST_H )
514 p_this->thread_id = st_thread_create( func, (void *)p_this, 1, 0 );
517 #elif defined( WIN32 )
520 /* When using the MSVCRT C library you have to use the _beginthreadex
521 * function instead of CreateThread, otherwise you'll end up with
522 * memory leaks and the signal functions not working */
524 (HANDLE)_beginthreadex( NULL, 0, (PTHREAD_START) func,
525 (void *)p_this, 0, &threadID );
528 if ( p_this->thread_id && i_priority )
530 if ( !SetThreadPriority(p_this->thread_id, i_priority) )
532 msg_Warn( p_this, "couldn't set a faster priority" );
537 i_ret = ( p_this->thread_id ? 0 : 1 );
539 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
540 i_ret = pthread_create( &p_this->thread_id, NULL, func, (void *)p_this );
544 struct sched_param param;
545 memset( ¶m, 0, sizeof(struct sched_param) );
546 param.sched_priority = i_priority;
547 if ( pthread_setschedparam( p_this->thread_id, SCHED_RR, ¶m ) )
549 msg_Warn( p_this, "couldn't go to real-time priority" );
554 #elif defined( HAVE_CTHREADS_H )
555 p_this->thread_id = cthread_fork( (cthread_fn_t)func, (any_t)p_this );
558 #elif defined( HAVE_KERNEL_SCHEDULER_H )
559 p_this->thread_id = spawn_thread( (thread_func)func, psz_name,
560 B_NORMAL_PRIORITY, (void *)p_this );
561 i_ret = resume_thread( p_this->thread_id );
568 vlc_cond_wait( &wrapper.wait, &wrapper.lock );
571 vlc_mutex_unlock( &wrapper.lock );
572 vlc_mutex_destroy( &wrapper.lock );
573 vlc_cond_destroy( &wrapper.wait );
580 msg_Dbg( p_this, "waiting for thread completion" );
581 vlc_cond_wait( &p_this->object_wait, &p_this->object_lock );
584 p_this->b_thread = 1;
586 msg_Dbg( p_this, "thread %d (%s) created at priority %d (%s:%d)",
587 p_this->thread_id, psz_name, i_priority,
590 vlc_mutex_unlock( &p_this->object_lock );
594 msg_Err( p_this, "%s thread could not be created at %s:%d (%s)",
595 psz_name, psz_file, i_line, strerror(i_ret) );
596 vlc_mutex_unlock( &p_this->object_lock );
602 /*****************************************************************************
603 * vlc_thread_ready: tell the parent thread we were successfully spawned
604 *****************************************************************************/
605 void __vlc_thread_ready( vlc_object_t *p_this )
607 vlc_mutex_lock( &p_this->object_lock );
608 vlc_cond_signal( &p_this->object_wait );
609 vlc_mutex_unlock( &p_this->object_lock );
612 /*****************************************************************************
613 * vlc_thread_join: wait until a thread exits, inner version
614 *****************************************************************************/
615 void __vlc_thread_join( vlc_object_t *p_this, char * psz_file, int i_line )
619 #if defined( PTH_INIT_IN_PTH_H )
620 i_ret = pth_join( p_this->thread_id, NULL );
622 #elif defined( ST_INIT_IN_ST_H )
623 i_ret = st_thread_join( p_this->thread_id, NULL );
625 #elif defined( WIN32 )
626 WaitForSingleObject( p_this->thread_id, INFINITE );
628 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
629 i_ret = pthread_join( p_this->thread_id, NULL );
631 #elif defined( HAVE_CTHREADS_H )
632 cthread_join( p_this->thread_id );
635 #elif defined( HAVE_KERNEL_SCHEDULER_H )
637 wait_for_thread( p_this->thread_id, &exit_value );
643 msg_Err( p_this, "thread_join(%d) failed at %s:%d (%s)",
644 p_this->thread_id, psz_file, i_line, strerror(i_ret) );
648 msg_Dbg( p_this, "thread %d joined (%s:%d)",
649 p_this->thread_id, psz_file, i_line );
652 p_this->b_thread = 0;
655 /*****************************************************************************
656 * vlc_thread_wrapper: wrapper around thread functions used when profiling.
657 *****************************************************************************/
659 static void *vlc_thread_wrapper( void *p_wrapper )
661 /* Put user data in thread-local variables */
662 void * p_data = ((wrapper_t*)p_wrapper)->p_data;
663 vlc_thread_func_t func = ((wrapper_t*)p_wrapper)->func;
665 /* Set the profile timer value */
666 setitimer( ITIMER_PROF, &((wrapper_t*)p_wrapper)->itimer, NULL );
668 /* Tell the calling thread that we don't need its data anymore */
669 vlc_mutex_lock( &((wrapper_t*)p_wrapper)->lock );
670 vlc_cond_signal( &((wrapper_t*)p_wrapper)->wait );
671 vlc_mutex_unlock( &((wrapper_t*)p_wrapper)->lock );
673 /* Call the real function */
674 return func( p_data );