threads.h 13 KB
Newer Older
1
/*****************************************************************************
2
 * threads.h : thread implementation for VideoLAN client
3
 * This header is supposed to provide a portable threads implementation.
4 5
 * Currently, it is a wrapper to either the POSIX pthreads library, or
 * the Mach cthreads (for the GNU/Hurd).
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *****************************************************************************
 * 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.
25
 *****************************************************************************/
26

27

28 29
#ifdef SYS_GNU
#include <cthreads.h>
30 31 32 33 34 35 36 37
#endif

#ifdef SYS_BEOS
#include <kernel/OS.h>
#include <kernel/scheduler.h>
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)
38
#include <pthread.h>
39
#endif
40

41
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
42
 * Constants
43 44
 *****************************************************************************
 * These constants are used by all threads in *_CreateThread() and
Vincent Seguin's avatar
Vincent Seguin committed
45 46
 * *_DestroyThreads() functions. Since those calls are non-blocking, an integer
 * value is used as a shared flag to represent the status of the thread.
47
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
48 49 50

/* 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 */
51
#define THREAD_NOP          0                            /* nothing happened */
Vincent Seguin's avatar
Vincent Seguin committed
52 53

/* Creation status */
54 55 56
#define THREAD_CREATE       10                     /* thread is initializing */
#define THREAD_START        11                          /* thread has forked */
#define THREAD_READY        19                            /* thread is ready */
57

Vincent Seguin's avatar
Vincent Seguin committed
58
/* Destructions status */
59 60 61
#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 */
Vincent Seguin's avatar
Vincent Seguin committed
62 63

/* Error status */
64 65
#define THREAD_ERROR        30                           /* an error occured */
#define THREAD_FATAL        31  /* an fatal error occured - program must end */
Vincent Seguin's avatar
Vincent Seguin committed
66

67
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
68
 * Types definition
69
 *****************************************************************************/
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

#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;

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
#endif /* SYS_GNU */

#ifdef SYS_BEOS

typedef thread_id vlc_thread_t;

typedef struct
{
    int32           init;
    sem_id          lock;
    thread_id       owner;
} vlc_mutex_t;

typedef struct
{
    int32           init;
    sem_id          sem;
    sem_id          handshakeSem;
    sem_id          signalSem;
    volatile int32  nw;
    volatile int32  ns;
} vlc_cond_t;

#endif /* SYS_BEOS */

#if defined(SYS_LINUX) || defined(SYS_BSD)
117

118 119 120 121
typedef pthread_t        vlc_thread_t;
typedef pthread_mutex_t  vlc_mutex_t;
typedef pthread_cond_t   vlc_cond_t;

122
#endif /* SYS_LINUX || SYS_BSD */
123

Vincent Seguin's avatar
Vincent Seguin committed
124
typedef void *(*vlc_thread_func_t)(void *p_data);
125

126
/*****************************************************************************
127
 * Prototypes
128
 *****************************************************************************/
129

Vincent Seguin's avatar
Vincent Seguin committed
130
static __inline__ int  vlc_thread_create( vlc_thread_t *p_thread, char *psz_name,
131
                                          vlc_thread_func_t func, void *p_data );
Vincent Seguin's avatar
Vincent Seguin committed
132 133
static __inline__ void vlc_thread_exit  ( void );
static __inline__ void vlc_thread_join  ( vlc_thread_t thread );
134

Vincent Seguin's avatar
Vincent Seguin committed
135 136 137
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 );
138

Vincent Seguin's avatar
Vincent Seguin committed
139 140 141
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 );
142

143 144 145 146
#if 0
static _inline__ int    vlc_cond_timedwait   ( vlc_cond_t * condvar, vlc_mutex_t * mutex,
                              mtime_t absoute_timeout_time );
#endif
147

148
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
149
 * vlc_thread_create: create a thread
150
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
151
static __inline__ int vlc_thread_create( vlc_thread_t *p_thread,
152 153
                                         char *psz_name, vlc_thread_func_t func,
                                         void *p_data)
154
{
155 156 157
#ifdef SYS_GNU
    *p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
    return( 0 );
158 159 160 161 162 163 164 165
#endif

#ifdef SYS_BEOS
    *p_thread = spawn_thread( (thread_func)func, psz_name, B_NORMAL_PRIORITY, p_data );
    return resume_thread( *p_thread );
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)
Vincent Seguin's avatar
Vincent Seguin committed
166
    return pthread_create( p_thread, NULL, func, p_data );
167
#endif
168 169
}

170
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
171
 * vlc_thread_exit: terminate a thread
172
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
173
static __inline__ void vlc_thread_exit( void )
174
{
175 176 177
#ifdef SYS_GNU
    int result;
    cthread_exit( &result );
178 179 180 181 182 183 184
#endif

#ifdef SYS_BEOS
    exit_thread( 0 );
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
185
    pthread_exit( 0 );
186
#endif
187 188
}

189
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
190
 * vlc_thread_join: wait until a thread exits
191
 *****************************************************************************/
192 193
static __inline__ void vlc_thread_join( vlc_thread_t thread )
{
194 195
#ifdef SYS_GNU
    cthread_join( thread );
196 197 198 199 200 201 202 203
#endif

#ifdef SYS_BEOS
    int32 exit_value;	
    wait_for_thread( thread, &exit_value );
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
204
    pthread_join( thread, NULL );
205
#endif
206 207
}

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
#ifdef SYS_BEOS
/* lazy_init_mutex */
static __inline__ void lazy_init_mutex(vlc_mutex_t* p_mutex)
{
    int32 v = atomic_or( &p_mutex->init, 1 );
    if( 2000 == v ) // we're the first, so do the init
    {
        vlc_mutex_init( p_mutex );
    }
    else // we're not the first, so wait until the init is finished
    {
        while( p_mutex->init != 9999 ) snooze( 10000 );
    }
}
#endif

224
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
225
 * vlc_mutex_init: initialize a mutex
226
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
227
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
228
{
229 230 231
#ifdef SYS_GNU
    mutex_init( p_mutex );
    return( 0 );
232 233 234 235 236 237 238 239 240 241 242 243 244 245
#endif

#ifdef SYS_BEOS
    // check the arguments and whether it's already been initialized
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init == 9999 ) return EALREADY;

    p_mutex->lock = create_sem( 1, "BeMutex" );
    p_mutex->owner = -1;
    p_mutex->init = 9999;
    return B_OK;
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
Vincent Seguin's avatar
Vincent Seguin committed
246
    return pthread_mutex_init( p_mutex, NULL );
247
#endif
248 249
}

250
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
251
 * vlc_mutex_lock: lock a mutex
252
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
253
static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
254
{
255 256 257
#ifdef SYS_GNU
    mutex_lock( p_mutex );
    return( 0 );
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
#endif

#ifdef SYS_BEOS
    status_t err;

    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
    lazy_init_mutex( p_mutex );

    err = acquire_sem( p_mutex->lock );
    if( !err ) p_mutex->owner = find_thread( NULL );
    return err;
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
Vincent Seguin's avatar
Vincent Seguin committed
273
    return pthread_mutex_lock( p_mutex );
274
#endif
275 276
}

277
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
278
 * vlc_mutex_unlock: unlock a mutex
279
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
280
static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
281
{
282 283 284
#ifdef SYS_GNU
    mutex_unlock( p_mutex );
    return( 0 );
285 286 287 288 289 290 291 292 293 294 295 296 297 298
#endif

#ifdef SYS_BEOS
    if(! p_mutex) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
    lazy_init_mutex( p_mutex );

    if( p_mutex->owner != find_thread(NULL) ) return ENOLCK;
    p_mutex->owner = -1;
    release_sem( p_mutex->lock );
    return B_OK;
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
Vincent Seguin's avatar
Vincent Seguin committed
299
    return pthread_mutex_unlock( p_mutex );
300
#endif
301 302
}

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
#ifdef SYS_BEOS
/* lazy_init_cond */
static __inline__ void lazy_init_cond( vlc_cond_t* p_condvar )
{
    int32 v = atomic_or( &p_condvar->init, 1 );
    if( 2000 == v ) // we're the first, so do the init
    {
        vlc_cond_init( p_condvar );
    }
    else // we're not the first, so wait until the init is finished
    {
        while( p_condvar->init != 9999 ) snooze( 10000 );
    }
}
#endif

319
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
320
 * vlc_cond_init: initialize a condition
321
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
322
static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
323
{
324 325 326 327 328 329 330 331
#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 );
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
#endif

#ifdef SYS_BEOS
    if( !p_condvar ) return B_BAD_VALUE;
    if( p_condvar->init == 9999 ) return EALREADY;

    p_condvar->sem = create_sem( 0, "CVSem" );
    p_condvar->handshakeSem = create_sem( 0, "CVHandshake" );
    p_condvar->signalSem = create_sem( 1, "CVSignal" );
    p_condvar->ns = p_condvar->nw = 0;
    p_condvar->init = 9999;
    return B_OK;
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
Vincent Seguin's avatar
Vincent Seguin committed
347
    return pthread_cond_init( p_condvar, NULL );
348
#endif
349 350
}

351
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
352
 * vlc_cond_signal: start a thread on condition completion
353
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
354
static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
355
{
356 357 358 359 360 361 362
#ifdef SYS_GNU
    /* condition_signal() */
    if ( p_condvar->queue.head || p_condvar->implications )
    {
        cond_signal( (condition_t)p_condvar );
    }
    return( 0 );
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
#endif

#ifdef SYS_BEOS
    status_t err = B_OK;

    if( !p_condvar ) return B_BAD_VALUE;
    if( p_condvar->init < 2000 ) return B_NO_INIT;
    lazy_init_cond( p_condvar );

    if( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED) return B_INTERRUPTED;

    if( p_condvar->nw > p_condvar->ns )
    {
        p_condvar->ns += 1;
        release_sem( p_condvar->sem );
        release_sem( p_condvar->signalSem );
        while( acquire_sem(p_condvar->handshakeSem) == B_INTERRUPTED )
            { err = B_INTERRUPTED; }
    }
    else
    {
        release_sem( p_condvar->signalSem );
    }
    return err;
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
Vincent Seguin's avatar
Vincent Seguin committed
390
    return pthread_cond_signal( p_condvar );
391
#endif
392
}
Vincent Seguin's avatar
Vincent Seguin committed
393

394
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
395
 * vlc_cond_wait: wait until condition completion
396
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
397
static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
398
{
399 400 401
#ifdef SYS_GNU
    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
    return( 0 );
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
#endif

#ifdef SYS_BEOS
    status_t err;

    if( !p_condvar ) return B_BAD_VALUE;
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_condvar->init < 2000 ) return B_NO_INIT;
    lazy_init_cond( p_condvar );

    if( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED ) return B_INTERRUPTED;
    p_condvar->nw += 1;
    release_sem( p_condvar->signalSem );

    vlc_mutex_unlock( p_mutex );
    err = acquire_sem( p_condvar->sem );

    while( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED)
        { err = B_INTERRUPTED; }
    if( p_condvar->ns > 0 )
    {
        release_sem( p_condvar->handshakeSem );
        p_condvar->ns -= 1;
    }
    p_condvar->nw -= 1;
    release_sem( p_condvar->signalSem );

    while( vlc_mutex_lock(p_mutex) == B_INTERRUPTED)
        { err = B_INTERRUPTED; }
    return err;
#endif

#if defined(SYS_LINUX) || defined(SYS_BSD)	
Vincent Seguin's avatar
Vincent Seguin committed
435
    return pthread_cond_wait( p_condvar, p_mutex );
436
#endif
437
}