2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-03-03 08:03:34 +01:00
|
|
|
* threads.h : thread implementation for VideoLAN client
|
2000-02-13 05:31:35 +01:00
|
|
|
* This header is supposed to provide a portable threads implementation.
|
2000-03-03 01:59:56 +01:00
|
|
|
* Currently, it is a wrapper to either the POSIX pthreads library, or
|
|
|
|
* the Mach cthreads (for the GNU/Hurd).
|
2000-03-03 08:03:34 +01:00
|
|
|
*****************************************************************************
|
|
|
|
* Copyright (C) 1999, 2000 VideoLAN
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public
|
|
|
|
* License along with this program; if not, write to the
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
* Boston, MA 02111-1307, USA.
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-03-03 08:03:34 +01:00
|
|
|
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
#include <cthreads.h>
|
|
|
|
#else
|
1999-12-08 16:22:59 +01:00
|
|
|
#include <pthread.h>
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* Constants
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************
|
|
|
|
* These constants are used by all threads in *_CreateThread() and
|
2000-01-11 00:36:06 +01:00
|
|
|
* *_DestroyThreads() functions. Since those calls are non-blocking, an integer
|
|
|
|
* value is used as a shared flag to represent the status of the thread.
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
|
|
|
|
/* Void status - this value can be used to be sure, in an array of recorded
|
|
|
|
* threads, that no operation is currently in progress on the concerned thread */
|
2000-02-13 05:31:35 +01:00
|
|
|
#define THREAD_NOP 0 /* nothing happened */
|
2000-01-11 00:36:06 +01:00
|
|
|
|
|
|
|
/* Creation status */
|
2000-02-13 05:31:35 +01:00
|
|
|
#define THREAD_CREATE 10 /* thread is initializing */
|
|
|
|
#define THREAD_START 11 /* thread has forked */
|
|
|
|
#define THREAD_READY 19 /* thread is ready */
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-01-11 00:36:06 +01:00
|
|
|
/* Destructions status */
|
2000-02-13 05:31:35 +01:00
|
|
|
#define THREAD_DESTROY 20 /* destruction order has been sent */
|
|
|
|
#define THREAD_END 21 /* destruction order has been received */
|
|
|
|
#define THREAD_OVER 29 /* thread does not exist any more */
|
2000-01-11 00:36:06 +01:00
|
|
|
|
|
|
|
/* Error status */
|
2000-02-13 05:31:35 +01:00
|
|
|
#define THREAD_ERROR 30 /* an error occured */
|
|
|
|
#define THREAD_FATAL 31 /* an fatal error occured - program must end */
|
2000-01-11 00:36:06 +01:00
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* Types definition
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-03-03 01:59:56 +01:00
|
|
|
|
|
|
|
#ifdef SYS_GNU
|
|
|
|
|
|
|
|
typedef cthread_t vlc_thread_t;
|
|
|
|
|
|
|
|
/* those structs are the ones defined in /include/cthreads.h but we need
|
|
|
|
* * to handle *foo where foo is a mutex_t */
|
|
|
|
typedef struct s_mutex {
|
|
|
|
spin_lock_t held;
|
|
|
|
spin_lock_t lock;
|
|
|
|
char *name;
|
|
|
|
struct cthread_queue queue;
|
|
|
|
} vlc_mutex_t;
|
|
|
|
|
|
|
|
typedef struct s_condition {
|
|
|
|
spin_lock_t lock;
|
|
|
|
struct cthread_queue queue;
|
|
|
|
char *name;
|
|
|
|
struct cond_imp *implications;
|
|
|
|
} vlc_cond_t;
|
|
|
|
|
|
|
|
#else /* SYS_GNU */
|
|
|
|
|
1999-12-08 16:22:59 +01:00
|
|
|
typedef pthread_t vlc_thread_t;
|
|
|
|
typedef pthread_mutex_t vlc_mutex_t;
|
|
|
|
typedef pthread_cond_t vlc_cond_t;
|
|
|
|
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif /* SYS_GNU */
|
|
|
|
|
2000-01-11 00:36:06 +01:00
|
|
|
typedef void *(*vlc_thread_func_t)(void *p_data);
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
1999-12-08 16:22:59 +01:00
|
|
|
* Prototypes
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_thread_create( vlc_thread_t *p_thread, char *psz_name,
|
2000-02-14 09:44:59 +01:00
|
|
|
vlc_thread_func_t func, void *p_data );
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ void vlc_thread_exit ( void );
|
|
|
|
static __inline__ void vlc_thread_join ( vlc_thread_t thread );
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_mutex_init ( vlc_mutex_t *p_mutex );
|
|
|
|
static __inline__ int vlc_mutex_lock ( vlc_mutex_t *p_mutex );
|
|
|
|
static __inline__ int vlc_mutex_unlock ( vlc_mutex_t *p_mutex );
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_cond_init ( vlc_cond_t *p_condvar );
|
|
|
|
static __inline__ int vlc_cond_signal ( vlc_cond_t *p_condvar );
|
|
|
|
static __inline__ int vlc_cond_wait ( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex );
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-02-23 04:04:50 +01:00
|
|
|
#if 0
|
|
|
|
static _inline__ int vlc_cond_timedwait ( vlc_cond_t * condvar, vlc_mutex_t * mutex,
|
|
|
|
mtime_t absoute_timeout_time );
|
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_thread_create: create a thread
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_thread_create( vlc_thread_t *p_thread,
|
2000-02-14 09:44:59 +01:00
|
|
|
char *psz_name, vlc_thread_func_t func,
|
|
|
|
void *p_data)
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
*p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_create( p_thread, NULL, func, p_data );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_thread_exit: terminate a thread
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ void vlc_thread_exit( void )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
int result;
|
|
|
|
cthread_exit( &result );
|
|
|
|
#else
|
1999-12-08 16:22:59 +01:00
|
|
|
pthread_exit( 0 );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_thread_join: wait until a thread exits
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
1999-12-08 16:22:59 +01:00
|
|
|
static __inline__ void vlc_thread_join( vlc_thread_t thread )
|
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
cthread_join( thread );
|
|
|
|
#else
|
1999-12-08 16:22:59 +01:00
|
|
|
pthread_join( thread, NULL );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_mutex_init: initialize a mutex
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
mutex_init( p_mutex );
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_mutex_init( p_mutex, NULL );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_mutex_lock: lock a mutex
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
mutex_lock( p_mutex );
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_mutex_lock( p_mutex );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_mutex_unlock: unlock a mutex
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
mutex_unlock( p_mutex );
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_mutex_unlock( p_mutex );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_cond_init: initialize a condition
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
/* condition_init() */
|
|
|
|
spin_lock_init( &p_condvar->lock );
|
|
|
|
cthread_queue_init( &p_condvar->queue );
|
|
|
|
p_condvar->name = 0;
|
|
|
|
p_condvar->implications = 0;
|
|
|
|
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_cond_init( p_condvar, NULL );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_cond_signal: start a thread on condition completion
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
/* condition_signal() */
|
|
|
|
if ( p_condvar->queue.head || p_condvar->implications )
|
|
|
|
{
|
|
|
|
cond_signal( (condition_t)p_condvar );
|
|
|
|
}
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_cond_signal( p_condvar );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
2000-01-11 00:36:06 +01:00
|
|
|
|
2000-02-13 05:31:35 +01:00
|
|
|
/*****************************************************************************
|
2000-01-11 00:36:06 +01:00
|
|
|
* vlc_cond_wait: wait until condition completion
|
2000-02-13 05:31:35 +01:00
|
|
|
*****************************************************************************/
|
2000-01-11 00:36:06 +01:00
|
|
|
static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
|
1999-12-08 16:22:59 +01:00
|
|
|
{
|
2000-03-03 01:59:56 +01:00
|
|
|
#ifdef SYS_GNU
|
|
|
|
condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
|
|
|
|
return( 0 );
|
|
|
|
#else
|
2000-01-11 00:36:06 +01:00
|
|
|
return pthread_cond_wait( p_condvar, p_mutex );
|
2000-03-03 01:59:56 +01:00
|
|
|
#endif
|
1999-12-08 16:22:59 +01:00
|
|
|
}
|
2000-03-03 01:59:56 +01:00
|
|
|
|