1 /*****************************************************************************
2 * threads.c : threads implementation for the VideoLAN client
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
30 #define VLC_THREADS_UNINITIALIZED 0
31 #define VLC_THREADS_PENDING 1
32 #define VLC_THREADS_ERROR 2
33 #define VLC_THREADS_READY 3
35 /*****************************************************************************
36 * Global mutex for lazy initialization of the threads system
37 *****************************************************************************/
38 static volatile unsigned i_initializations = 0;
39 static volatile int i_status = VLC_THREADS_UNINITIALIZED;
40 static vlc_object_t *p_root;
42 #if defined( PTH_INIT_IN_PTH_H )
43 #elif defined( ST_INIT_IN_ST_H )
44 #elif defined( UNDER_CE )
45 #elif defined( WIN32 )
46 #elif defined( HAVE_KERNEL_SCHEDULER_H )
47 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
48 static pthread_mutex_t once_mutex = PTHREAD_MUTEX_INITIALIZER;
49 #elif defined( HAVE_CTHREADS_H )
52 /*****************************************************************************
53 * vlc_threads_init: initialize threads system
54 *****************************************************************************
55 * This function requires lazy initialization of a global lock in order to
56 * keep the library really thread-safe. Some architectures don't support this
57 * and thus do not guarantee the complete reentrancy.
58 *****************************************************************************/
59 int __vlc_threads_init( vlc_object_t *p_this )
61 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_this;
62 int i_ret = VLC_SUCCESS;
64 /* If we have lazy mutex initialization, use it. Otherwise, we just
65 * hope nothing wrong happens. */
66 #if defined( PTH_INIT_IN_PTH_H )
67 #elif defined( ST_INIT_IN_ST_H )
68 #elif defined( UNDER_CE )
69 #elif defined( WIN32 )
70 #elif defined( HAVE_KERNEL_SCHEDULER_H )
71 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
72 pthread_mutex_lock( &once_mutex );
73 #elif defined( HAVE_CTHREADS_H )
76 if( i_status == VLC_THREADS_UNINITIALIZED )
78 i_status = VLC_THREADS_PENDING;
80 /* We should be safe now. Do all the initialization stuff we want. */
81 p_libvlc_global->b_ready = VLC_FALSE;
83 #if defined( PTH_INIT_IN_PTH_H )
84 i_ret = ( pth_init() == FALSE );
86 #elif defined( ST_INIT_IN_ST_H )
89 #elif defined( UNDER_CE )
90 /* Nothing to initialize */
92 #elif defined( WIN32 )
93 /* Dynamically get the address of SignalObjectAndWait */
94 if( GetVersion() < 0x80000000 )
98 /* We are running on NT/2K/XP, we can use SignalObjectAndWait */
99 hInstLib = LoadLibrary( "kernel32" );
102 p_libvlc_global->SignalObjectAndWait =
103 (SIGNALOBJECTANDWAIT)GetProcAddress( hInstLib,
104 "SignalObjectAndWait" );
109 p_libvlc_global->SignalObjectAndWait = NULL;
112 p_libvlc_global->b_fast_mutex = 0;
113 p_libvlc_global->i_win9x_cv = 0;
115 #elif defined( HAVE_KERNEL_SCHEDULER_H )
116 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
117 #elif defined( HAVE_CTHREADS_H )
120 p_root = vlc_object_create( p_libvlc_global, VLC_OBJECT_GLOBAL );
126 i_status = VLC_THREADS_ERROR;
131 i_status = VLC_THREADS_READY;
136 /* Just increment the initialization count */
140 /* If we have lazy mutex initialization support, unlock the mutex;
141 * otherwize, do a naive wait loop. */
142 #if defined( PTH_INIT_IN_PTH_H )
143 while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP );
144 #elif defined( ST_INIT_IN_ST_H )
145 while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP );
146 #elif defined( UNDER_CE )
147 while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP );
148 #elif defined( WIN32 )
149 while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP );
150 #elif defined( HAVE_KERNEL_SCHEDULER_H )
151 while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP );
152 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
153 pthread_mutex_unlock( &once_mutex );
154 #elif defined( HAVE_CTHREADS_H )
155 while( i_status == VLC_THREADS_PENDING ) msleep( THREAD_SLEEP );
158 if( i_status != VLC_THREADS_READY )
166 /*****************************************************************************
167 * vlc_threads_end: stop threads system
168 *****************************************************************************
169 * FIXME: This function is far from being threadsafe.
170 *****************************************************************************/
171 int __vlc_threads_end( vlc_object_t *p_this )
173 #if defined( PTH_INIT_IN_PTH_H )
174 #elif defined( ST_INIT_IN_ST_H )
175 #elif defined( UNDER_CE )
176 #elif defined( WIN32 )
177 #elif defined( HAVE_KERNEL_SCHEDULER_H )
178 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
179 pthread_mutex_lock( &once_mutex );
180 #elif defined( HAVE_CTHREADS_H )
183 if( i_initializations == 0 )
187 if( i_initializations == 0 )
189 i_status = VLC_THREADS_UNINITIALIZED;
190 vlc_object_destroy( p_root );
193 #if defined( PTH_INIT_IN_PTH_H )
194 if( i_initializations == 0 )
196 return ( pth_kill() == FALSE );
199 #elif defined( ST_INIT_IN_ST_H )
200 #elif defined( UNDER_CE )
201 #elif defined( WIN32 )
202 #elif defined( HAVE_KERNEL_SCHEDULER_H )
203 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
204 pthread_mutex_unlock( &once_mutex );
205 #elif defined( HAVE_CTHREADS_H )
210 /*****************************************************************************
211 * vlc_mutex_init: initialize a mutex
212 *****************************************************************************/
213 int __vlc_mutex_init( vlc_object_t *p_this, vlc_mutex_t *p_mutex )
215 p_mutex->p_this = p_this;
217 #if defined( PTH_INIT_IN_PTH_H )
218 return ( pth_mutex_init( &p_mutex->mutex ) == FALSE );
220 #elif defined( ST_INIT_IN_ST_H )
221 p_mutex->mutex = st_mutex_new();
222 return ( p_mutex->mutex == NULL ) ? errno : 0;
224 #elif defined( UNDER_CE )
225 InitializeCriticalSection( &p_mutex->csection );
228 #elif defined( WIN32 )
229 /* We use mutexes on WinNT/2K/XP because we can use the SignalObjectAndWait
230 * function and have a 100% correct vlc_cond_wait() implementation.
231 * As this function is not available on Win9x, we can use the faster
232 * CriticalSections */
233 if( p_this->p_libvlc_global->SignalObjectAndWait &&
234 !p_this->p_libvlc_global->b_fast_mutex )
236 /* We are running on NT/2K/XP, we can use SignalObjectAndWait */
237 p_mutex->mutex = CreateMutex( 0, FALSE, 0 );
238 return ( p_mutex->mutex != NULL ? 0 : 1 );
242 p_mutex->mutex = NULL;
243 InitializeCriticalSection( &p_mutex->csection );
247 #elif defined( HAVE_KERNEL_SCHEDULER_H )
248 /* check the arguments and whether it's already been initialized */
249 if( p_mutex == NULL )
254 if( p_mutex->init == 9999 )
259 p_mutex->lock = create_sem( 1, "BeMutex" );
260 if( p_mutex->lock < B_NO_ERROR )
265 p_mutex->init = 9999;
268 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
269 # if defined(DEBUG) && defined(SYS_LINUX)
271 /* Create error-checking mutex to detect problems more easily. */
272 pthread_mutexattr_t attr;
275 pthread_mutexattr_init( &attr );
276 pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP );
277 i_result = pthread_mutex_init( &p_mutex->mutex, &attr );
278 pthread_mutexattr_destroy( &attr );
282 return pthread_mutex_init( &p_mutex->mutex, NULL );
284 #elif defined( HAVE_CTHREADS_H )
285 mutex_init( p_mutex );
291 /*****************************************************************************
292 * vlc_mutex_destroy: destroy a mutex, inner version
293 *****************************************************************************/
294 int __vlc_mutex_destroy( const char * psz_file, int i_line, vlc_mutex_t *p_mutex )
297 /* In case of error : */
299 const char * psz_error = "";
301 #if defined( PTH_INIT_IN_PTH_H )
304 #elif defined( ST_INIT_IN_ST_H )
305 i_result = st_mutex_destroy( p_mutex->mutex );
307 #elif defined( UNDER_CE )
308 DeleteCriticalSection( &p_mutex->csection );
311 #elif defined( WIN32 )
314 CloseHandle( p_mutex->mutex );
318 DeleteCriticalSection( &p_mutex->csection );
322 #elif defined( HAVE_KERNEL_SCHEDULER_H )
323 if( p_mutex->init == 9999 )
325 delete_sem( p_mutex->lock );
331 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
332 i_result = pthread_mutex_destroy( &p_mutex->mutex );
335 i_thread = (int)pthread_self();
336 psz_error = strerror(i_result);
339 #elif defined( HAVE_CTHREADS_H )
346 msg_Err( p_mutex->p_this,
347 "thread %d: mutex_destroy failed at %s:%d (%d:%s)",
348 i_thread, psz_file, i_line, i_result, psz_error );
353 /*****************************************************************************
354 * vlc_cond_init: initialize a condition
355 *****************************************************************************/
356 int __vlc_cond_init( vlc_object_t *p_this, vlc_cond_t *p_condvar )
358 p_condvar->p_this = p_this;
360 #if defined( PTH_INIT_IN_PTH_H )
361 return ( pth_cond_init( &p_condvar->cond ) == FALSE );
363 #elif defined( ST_INIT_IN_ST_H )
364 p_condvar->cond = st_cond_new();
365 return ( p_condvar->cond == NULL ) ? errno : 0;
367 #elif defined( UNDER_CE )
368 /* Initialize counter */
369 p_condvar->i_waiting_threads = 0;
371 /* Create an auto-reset event. */
372 p_condvar->event = CreateEvent( NULL, /* no security */
373 FALSE, /* auto-reset event */
374 FALSE, /* start non-signaled */
375 NULL ); /* unnamed */
376 return !p_condvar->event;
378 #elif defined( WIN32 )
379 /* Initialize counter */
380 p_condvar->i_waiting_threads = 0;
383 p_condvar->i_win9x_cv = p_this->p_libvlc_global->i_win9x_cv;
384 p_condvar->SignalObjectAndWait = p_this->p_libvlc_global->SignalObjectAndWait;
386 if( (p_condvar->SignalObjectAndWait &&
387 !p_this->p_libvlc_global->b_fast_mutex)
388 || p_condvar->i_win9x_cv == 0 )
390 /* Create an auto-reset event. */
391 p_condvar->event = CreateEvent( NULL, /* no security */
392 FALSE, /* auto-reset event */
393 FALSE, /* start non-signaled */
394 NULL ); /* unnamed */
396 p_condvar->semaphore = NULL;
397 return !p_condvar->event;
401 p_condvar->semaphore = CreateSemaphore( NULL, /* no security */
402 0, /* initial count */
403 0x7fffffff, /* max count */
404 NULL ); /* unnamed */
406 if( p_condvar->i_win9x_cv == 1 )
407 /* Create a manual-reset event initially signaled. */
408 p_condvar->event = CreateEvent( NULL, TRUE, TRUE, NULL );
410 /* Create a auto-reset event. */
411 p_condvar->event = CreateEvent( NULL, FALSE, FALSE, NULL );
413 InitializeCriticalSection( &p_condvar->csection );
415 return !p_condvar->semaphore || !p_condvar->event;
418 #elif defined( HAVE_KERNEL_SCHEDULER_H )
424 if( p_condvar->init == 9999 )
429 p_condvar->thread = -1;
430 p_condvar->init = 9999;
433 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
434 return pthread_cond_init( &p_condvar->cond, NULL );
436 #elif defined( HAVE_CTHREADS_H )
437 /* condition_init() */
438 spin_lock_init( &p_condvar->lock );
439 cthread_queue_init( &p_condvar->queue );
441 p_condvar->implications = 0;
448 /*****************************************************************************
449 * vlc_cond_destroy: destroy a condition, inner version
450 *****************************************************************************/
451 int __vlc_cond_destroy( const char * psz_file, int i_line, vlc_cond_t *p_condvar )
454 /* In case of error : */
456 const char * psz_error = "";
458 #if defined( PTH_INIT_IN_PTH_H )
461 #elif defined( ST_INIT_IN_ST_H )
462 i_result = st_cond_destroy( p_condvar->cond );
464 #elif defined( UNDER_CE )
465 i_result = !CloseHandle( p_condvar->event );
467 #elif defined( WIN32 )
468 if( !p_condvar->semaphore )
469 i_result = !CloseHandle( p_condvar->event );
471 i_result = !CloseHandle( p_condvar->event )
472 || !CloseHandle( p_condvar->semaphore );
474 if( p_condvar->semaphore != NULL )
475 DeleteCriticalSection( &p_condvar->csection );
477 #elif defined( HAVE_KERNEL_SCHEDULER_H )
481 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
482 i_result = pthread_cond_destroy( &p_condvar->cond );
485 i_thread = (int)pthread_self();
486 psz_error = strerror(i_result);
489 #elif defined( HAVE_CTHREADS_H )
496 msg_Err( p_condvar->p_this,
497 "thread %d: cond_destroy failed at %s:%d (%d:%s)",
498 i_thread, psz_file, i_line, i_result, psz_error );
503 /*****************************************************************************
504 * vlc_thread_create: create a thread, inner version
505 *****************************************************************************
506 * Note that i_priority is only taken into account on platforms supporting
507 * userland real-time priority threads.
508 *****************************************************************************/
509 int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line,
510 const char *psz_name, void * ( *func ) ( void * ),
511 int i_priority, vlc_bool_t b_wait )
514 void *p_data = (void *)p_this;
516 vlc_mutex_lock( &p_this->object_lock );
518 #if defined( PTH_INIT_IN_PTH_H )
519 p_this->thread_id = pth_spawn( PTH_ATTR_DEFAULT, func, p_data );
520 i_ret = p_this->thread_id == NULL;
522 #elif defined( ST_INIT_IN_ST_H )
523 p_this->thread_id = st_thread_create( func, p_data, 1, 0 );
526 #elif defined( WIN32 ) || defined( UNDER_CE )
529 /* When using the MSVCRT C library you have to use the _beginthreadex
530 * function instead of CreateThread, otherwise you'll end up with
531 * memory leaks and the signal functions not working (see Microsoft
532 * Knowledge Base, article 104641) */
534 #if defined( UNDER_CE )
535 (HANDLE)CreateThread( NULL, 0, (PTHREAD_START) func,
536 p_data, 0, &threadID );
538 (HANDLE)_beginthreadex( NULL, 0, (PTHREAD_START) func,
539 p_data, 0, &threadID );
543 if( p_this->thread_id && i_priority )
545 if( !SetThreadPriority(p_this->thread_id, i_priority) )
547 msg_Warn( p_this, "couldn't set a faster priority" );
552 i_ret = ( p_this->thread_id ? 0 : 1 );
554 #elif defined( HAVE_KERNEL_SCHEDULER_H )
555 p_this->thread_id = spawn_thread( (thread_func)func, psz_name,
556 i_priority, p_data );
557 i_ret = resume_thread( p_this->thread_id );
559 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
560 i_ret = pthread_create( &p_this->thread_id, NULL, func, p_data );
563 if( config_GetInt( p_this, "rt-priority" ) )
566 int i_error, i_policy;
567 struct sched_param param;
569 memset( ¶m, 0, sizeof(struct sched_param) );
570 if( config_GetType( p_this, "rt-offset" ) )
572 i_priority += config_GetInt( p_this, "rt-offset" );
574 if( i_priority <= 0 )
576 param.sched_priority = (-1) * i_priority;
577 i_policy = SCHED_OTHER;
581 param.sched_priority = i_priority;
584 if( (i_error = pthread_setschedparam( p_this->thread_id,
585 i_policy, ¶m )) )
587 msg_Warn( p_this, "couldn't set thread priority (%s:%d): %s",
588 psz_file, i_line, strerror(i_error) );
599 #elif defined( HAVE_CTHREADS_H )
600 p_this->thread_id = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
609 msg_Dbg( p_this, "waiting for thread completion" );
610 vlc_cond_wait( &p_this->object_wait, &p_this->object_lock );
613 p_this->b_thread = 1;
615 msg_Dbg( p_this, "thread %u (%s) created at priority %d (%s:%d)",
616 (unsigned int)p_this->thread_id, psz_name, i_priority,
619 vlc_mutex_unlock( &p_this->object_lock );
623 msg_Err( p_this, "%s thread could not be created at %s:%d (%s)",
624 psz_name, psz_file, i_line, strerror(i_ret) );
625 vlc_mutex_unlock( &p_this->object_lock );
631 /*****************************************************************************
632 * vlc_thread_set_priority: set the priority of the current thread when we
633 * couldn't set it in vlc_thread_create (for instance for the main thread)
634 *****************************************************************************/
635 int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file,
636 int i_line, int i_priority )
638 #if defined( PTH_INIT_IN_PTH_H ) || defined( ST_INIT_IN_ST_H )
639 #elif defined( WIN32 ) || defined( UNDER_CE )
640 if( !SetThreadPriority(GetCurrentThread(), i_priority) )
642 msg_Warn( p_this, "couldn't set a faster priority" );
646 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
648 if( config_GetInt( p_this, "rt-priority" ) )
651 int i_error, i_policy;
652 struct sched_param param;
654 memset( ¶m, 0, sizeof(struct sched_param) );
655 if( config_GetType( p_this, "rt-offset" ) )
657 i_priority += config_GetInt( p_this, "rt-offset" );
659 if( i_priority <= 0 )
661 param.sched_priority = (-1) * i_priority;
662 i_policy = SCHED_OTHER;
666 param.sched_priority = i_priority;
669 if( !p_this->thread_id )
670 p_this->thread_id = pthread_self();
671 if( (i_error = pthread_setschedparam( p_this->thread_id,
672 i_policy, ¶m )) )
674 msg_Warn( p_this, "couldn't set thread priority (%s:%d): %s",
675 psz_file, i_line, strerror(i_error) );
684 /*****************************************************************************
685 * vlc_thread_ready: tell the parent thread we were successfully spawned
686 *****************************************************************************/
687 void __vlc_thread_ready( vlc_object_t *p_this )
689 vlc_mutex_lock( &p_this->object_lock );
690 vlc_cond_signal( &p_this->object_wait );
691 vlc_mutex_unlock( &p_this->object_lock );
694 /*****************************************************************************
695 * vlc_thread_join: wait until a thread exits, inner version
696 *****************************************************************************/
697 void __vlc_thread_join( vlc_object_t *p_this, const char * psz_file, int i_line )
701 #if defined( PTH_INIT_IN_PTH_H )
702 i_ret = ( pth_join( p_this->thread_id, NULL ) == FALSE );
704 #elif defined( ST_INIT_IN_ST_H )
705 i_ret = st_thread_join( p_this->thread_id, NULL );
707 #elif defined( UNDER_CE ) || defined( WIN32 )
709 BOOL (WINAPI *OurGetThreadTimes)( HANDLE, FILETIME*, FILETIME*,
710 FILETIME*, FILETIME* );
711 FILETIME create_ft, exit_ft, kernel_ft, user_ft;
712 int64_t real_time, kernel_time, user_time;
714 WaitForSingleObject( p_this->thread_id, INFINITE );
716 #if defined( UNDER_CE )
717 hmodule = GetModuleHandle( _T("COREDLL") );
719 hmodule = GetModuleHandle( _T("KERNEL32") );
721 OurGetThreadTimes = (BOOL (WINAPI*)( HANDLE, FILETIME*, FILETIME*,
722 FILETIME*, FILETIME* ))
723 GetProcAddress( hmodule, _T("GetThreadTimes") );
725 if( OurGetThreadTimes &&
726 OurGetThreadTimes( p_this->thread_id,
727 &create_ft, &exit_ft, &kernel_ft, &user_ft ) )
730 ((((int64_t)exit_ft.dwHighDateTime)<<32)| exit_ft.dwLowDateTime) -
731 ((((int64_t)create_ft.dwHighDateTime)<<32)| create_ft.dwLowDateTime);
735 ((((int64_t)kernel_ft.dwHighDateTime)<<32)|
736 kernel_ft.dwLowDateTime) / 10;
739 ((((int64_t)user_ft.dwHighDateTime)<<32)|
740 user_ft.dwLowDateTime) / 10;
742 msg_Dbg( p_this, "thread times: "
743 "real "I64Fd"m%fs, kernel "I64Fd"m%fs, user "I64Fd"m%fs",
744 real_time/60/1000000,
745 (double)((real_time%(60*1000000))/1000000.0),
746 kernel_time/60/1000000,
747 (double)((kernel_time%(60*1000000))/1000000.0),
748 user_time/60/1000000,
749 (double)((user_time%(60*1000000))/1000000.0) );
751 CloseHandle( p_this->thread_id );
753 #elif defined( HAVE_KERNEL_SCHEDULER_H )
755 wait_for_thread( p_this->thread_id, &exit_value );
757 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
758 i_ret = pthread_join( p_this->thread_id, NULL );
760 #elif defined( HAVE_CTHREADS_H )
761 cthread_join( p_this->thread_id );
768 msg_Err( p_this, "thread_join(%u) failed at %s:%d (%s)",
769 (unsigned int)p_this->thread_id, psz_file, i_line,
774 msg_Dbg( p_this, "thread %u joined (%s:%d)",
775 (unsigned int)p_this->thread_id, psz_file, i_line );
778 p_this->b_thread = 0;