threads.h 13.9 KB
Newer Older
1
/*****************************************************************************
2 3
 * threads.h : threads implementation for the VideoLAN client
 * This header provides a portable threads implementation.
4 5 6
 *****************************************************************************
 * Copyright (C) 1999, 2000 VideoLAN
 *
7 8
 * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
 *          Samuel Hocevar <sam@via.ecp.fr>
9 10 11 12 13
 *
 * 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.
14
 * 
15 16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
19
 *
20 21 22
 * 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, USA.
23
 *****************************************************************************/
24

25 26
#include <stdio.h>

27 28
#if defined(HAVE_PTHREAD_H)            /* pthreads (Linux & BSD for example) */
#include <pthread.h>
29

30
#elif defined(HAVE_CTHREADS_H)                                    /* GNUMach */
31
#include <cthreads.h>
32

33
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)   /* BeOS */
34 35
#undef MAX
#undef MIN
36 37
#include <kernel/OS.h>
#include <kernel/scheduler.h>
38
#include <byteorder.h>
39 40
#else
#error no threads available on your system !
41
#endif
42

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

51 52
/* Void status - this value can be used to make sure no operation is currently
 * in progress on the concerned thread in an array of recorded threads */
53
#define THREAD_NOP          0                            /* nothing happened */
Vincent Seguin's avatar
Vincent Seguin committed
54 55

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

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

/* Error status */
66 67
#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
68

69
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
70
 * Types definition
71
 *****************************************************************************/
72

73
#if defined(HAVE_CTHREADS_H)
74 75 76 77

typedef cthread_t        vlc_thread_t;

/* those structs are the ones defined in /include/cthreads.h but we need
78 79
 * to handle (*foo) where foo is a (mutex_t) while they handle (foo) where
 * foo is a (mutex_t*) */
80 81 82 83 84 85 86 87 88 89 90 91 92 93
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;

94
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

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;

115
#elif defined(HAVE_PTHREAD_H)
116

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

121
#endif
122

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

125
/*****************************************************************************
126
 * Prototypes
127
 *****************************************************************************/
128

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

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

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

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

147
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
148
 * vlc_thread_create: create a thread
149
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
150
static __inline__ int vlc_thread_create( vlc_thread_t *p_thread,
151 152
                                         char *psz_name, vlc_thread_func_t func,
                                         void *p_data)
153
{
154
#if defined(HAVE_CTHREADS_H)
155
    *p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
Sam Hocevar's avatar
Sam Hocevar committed
156
    return 0;
157

158
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
159 160
    *p_thread = spawn_thread( (thread_func)func, psz_name,
                              B_NORMAL_PRIORITY, p_data );
161 162
    return resume_thread( *p_thread );

163
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
164
    return pthread_create( p_thread, NULL, func, p_data );
165

166
#endif
167 168
}

169
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
170
 * vlc_thread_exit: terminate a thread
171
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
172
static __inline__ void vlc_thread_exit( void )
173
{
174
#if defined(HAVE_CTHREADS_H)
175 176
    int result;
    cthread_exit( &result );
177

178
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
179 180
    exit_thread( 0 );

181
#elif defined(HAVE_PTHREAD_H)
182
    pthread_exit( 0 );
183

184
#endif
185 186
}

187
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
188
 * vlc_thread_join: wait until a thread exits
189
 *****************************************************************************/
190 191
static __inline__ void vlc_thread_join( vlc_thread_t thread )
{
192
#if defined(HAVE_CTHREADS_H)
193
    cthread_join( thread );
194

195
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
196
    int32 exit_value;
197 198
    wait_for_thread( thread, &exit_value );

199
#elif defined(HAVE_PTHREAD_H)
200
    pthread_join( thread, NULL );
201

202
#endif
203 204
}

205
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
206
 * vlc_mutex_init: initialize a mutex
207
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
208
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
209
{
210
#if defined(HAVE_CTHREADS_H)
211
    mutex_init( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
212
    return 0;
213

214
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
215
/*
216
    // check the arguments and whether it's already been initialized
217 218 219
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init == 9999 ) return EALREADY;
*/
220 221 222 223 224 225

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

226
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
227
    return pthread_mutex_init( p_mutex, NULL );
228

229
#endif
230 231
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
#if defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
/* 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

251
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
252
 * vlc_mutex_lock: lock a mutex
253
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
254
static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
255
{
256
#if defined(HAVE_CTHREADS_H)
257
    mutex_lock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
258
    return 0;
259

260
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
261
    status_t err;
262 263 264
/*
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
Sam Hocevar's avatar
Sam Hocevar committed
265

266
    lazy_init_mutex( p_mutex );
267
*/
268
    err = acquire_sem( p_mutex->lock );
269 270 271
/*
    if( !err ) p_mutex->owner = find_thread( NULL );
*/
Sam Hocevar's avatar
Sam Hocevar committed
272

273 274
    return err;

275
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
276
    return pthread_mutex_lock( p_mutex );
277

278
#endif
279 280
}

281
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
282
 * vlc_mutex_unlock: unlock a mutex
283
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
284
static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
285
{
286
#if defined(HAVE_CTHREADS_H)
287
    mutex_unlock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
288
    return 0;
289

290
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
291 292 293
/*
    if(! p_mutex) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
Sam Hocevar's avatar
Sam Hocevar committed
294

295 296
    lazy_init_mutex( p_mutex );

Sam Hocevar's avatar
Sam Hocevar committed
297 298 299
    if( p_mutex->owner != find_thread(NULL) )
        return ENOLCK;

300
    p_mutex->owner = -1;
301
*/
302 303 304
    release_sem( p_mutex->lock );
    return B_OK;

305
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
306
    return pthread_mutex_unlock( p_mutex );
307

308
#endif
309 310
}

311
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
312
 * vlc_cond_init: initialize a condition
313
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
314
static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
315
{
316
#if defined(HAVE_CTHREADS_H)
317 318 319 320 321 322
    /* condition_init() */
    spin_lock_init( &p_condvar->lock );
    cthread_queue_init( &p_condvar->queue );
    p_condvar->name = 0;
    p_condvar->implications = 0;

Sam Hocevar's avatar
Sam Hocevar committed
323
    return 0;
324

325
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
326 327 328 329 330
    if( !p_condvar )
        return B_BAD_VALUE;

    if( p_condvar->init == 9999 )
        return EALREADY;
331 332 333 334 335 336 337 338

    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;

339
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
340
    return pthread_cond_init( p_condvar, NULL );
341

342
#endif
343 344
}

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

#if defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
/* 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

365
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
366
 * vlc_cond_signal: start a thread on condition completion
367
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
368
static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
369
{
370
#if defined(HAVE_CTHREADS_H)
371 372 373 374 375
    /* condition_signal() */
    if ( p_condvar->queue.head || p_condvar->implications )
    {
        cond_signal( (condition_t)p_condvar );
    }
Sam Hocevar's avatar
Sam Hocevar committed
376
    return 0;
377

378
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
379 380
    status_t err = B_OK;

Sam Hocevar's avatar
Sam Hocevar committed
381 382 383 384 385 386
    if( !p_condvar )
        return B_BAD_VALUE;

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

387 388
    lazy_init_cond( p_condvar );

Sam Hocevar's avatar
Sam Hocevar committed
389 390
    if( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED)
        return B_INTERRUPTED;
391 392 393 394 395 396

    if( p_condvar->nw > p_condvar->ns )
    {
        p_condvar->ns += 1;
        release_sem( p_condvar->sem );
        release_sem( p_condvar->signalSem );
Sam Hocevar's avatar
Sam Hocevar committed
397

398
        while( acquire_sem(p_condvar->handshakeSem) == B_INTERRUPTED )
Sam Hocevar's avatar
Sam Hocevar committed
399 400 401
        {
            err = B_INTERRUPTED;
        }
402 403 404 405 406 407 408
    }
    else
    {
        release_sem( p_condvar->signalSem );
    }
    return err;

409
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
410
    return pthread_cond_signal( p_condvar );
411

412
#endif
413
}
Vincent Seguin's avatar
Vincent Seguin committed
414

415
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
416
 * vlc_cond_wait: wait until condition completion
417
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
418
static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
419
{
420
#if defined(HAVE_CTHREADS_H)
421
    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
422
    return 0;
423

424
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
425 426
    status_t err;

Sam Hocevar's avatar
Sam Hocevar committed
427 428 429 430 431 432 433 434 435
    if( !p_condvar )
        return B_BAD_VALUE;

    if( !p_mutex )
        return B_BAD_VALUE;

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

436 437
    lazy_init_cond( p_condvar );

Sam Hocevar's avatar
Sam Hocevar committed
438 439 440
    if( acquire_sem(p_condvar->signalSem) == B_INTERRUPTED )
        return B_INTERRUPTED;

441 442 443 444 445 446 447
    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)
Sam Hocevar's avatar
Sam Hocevar committed
448 449 450 451
    {
        err = B_INTERRUPTED;
    }

452 453 454 455 456 457 458 459 460
    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)
Sam Hocevar's avatar
Sam Hocevar committed
461 462 463
    {
        err = B_INTERRUPTED;
    }
464 465
    return err;

466
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
467
    return pthread_cond_wait( p_condvar, p_mutex );
468

469
#endif
470
}
471