threads.h 13.8 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 14 15 16 17 18 19 20 21 22 23
 *
 * 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.
24
 *****************************************************************************/
25

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

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

32
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)   /* BeOS */
33 34
#include <kernel/OS.h>
#include <kernel/scheduler.h>
35

36 37
#else
#error no threads available on your system !
38
#endif
39

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

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

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

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

/* Error status */
63 64
#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
65

66
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
67
 * Types definition
68
 *****************************************************************************/
69

70
#if defined(HAVE_CTHREADS_H)
71 72 73 74

typedef cthread_t        vlc_thread_t;

/* those structs are the ones defined in /include/cthreads.h but we need
75 76
 * to handle (*foo) where foo is a (mutex_t) while they handle (foo) where
 * foo is a (mutex_t*) */
77 78 79 80 81 82 83 84 85 86 87 88 89 90
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
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

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;

112
#elif defined(HAVE_PTHREAD_H)
113

114 115 116 117
typedef pthread_t        vlc_thread_t;
typedef pthread_mutex_t  vlc_mutex_t;
typedef pthread_cond_t   vlc_cond_t;

118
#endif
119

Vincent Seguin's avatar
Vincent Seguin committed
120
typedef void *(*vlc_thread_func_t)(void *p_data);
121

122
/*****************************************************************************
123
 * Prototypes
124
 *****************************************************************************/
125

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

Vincent Seguin's avatar
Vincent Seguin committed
131 132 133
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 );
134

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

139 140 141 142
#if 0
static _inline__ int    vlc_cond_timedwait   ( vlc_cond_t * condvar, vlc_mutex_t * mutex,
                              mtime_t absoute_timeout_time );
#endif
143

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

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

160
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
161
    return pthread_create( p_thread, NULL, func, p_data );
162

163
#endif
164 165
}

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

175
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
176 177
    exit_thread( 0 );

178
#elif defined(HAVE_PTHREAD_H)
179
    pthread_exit( 0 );
180

181
#endif
182 183
}

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

192
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
193
    int32 exit_value;
194 195
    wait_for_thread( thread, &exit_value );

196
#elif defined(HAVE_PTHREAD_H)
197
    pthread_join( thread, NULL );
198

199
#endif
200 201
}

202
#if defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
203 204 205 206
/* lazy_init_mutex */
static __inline__ void lazy_init_mutex(vlc_mutex_t* p_mutex)
{
    int32 v = atomic_or( &p_mutex->init, 1 );
207
    if( 2000 == v ) /* we're the first, so do the init */
208 209 210
    {
        vlc_mutex_init( p_mutex );
    }
211
    else /* we're not the first, so wait until the init is finished */
212
    {
Sam Hocevar's avatar
Sam Hocevar committed
213 214 215 216
        while( p_mutex->init != 9999 )
        {
            snooze( 10000 );
        }
217 218 219 220
    }
}
#endif

221
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
222
 * vlc_mutex_init: initialize a mutex
223
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
224
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
225
{
226
#if defined(HAVE_CTHREADS_H)
227
    mutex_init( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
228
    return 0;
229

230
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
231
    // check the arguments and whether it's already been initialized
Sam Hocevar's avatar
Sam Hocevar committed
232 233 234 235 236
    if( !p_mutex )
        return B_BAD_VALUE;

    if( p_mutex->init == 9999 )
        return EALREADY;
237 238 239 240 241 242

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

243
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
244
    return pthread_mutex_init( p_mutex, NULL );
245

246
#endif
247 248
}

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

258
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
259 260
    status_t err;

Sam Hocevar's avatar
Sam Hocevar committed
261 262 263 264 265 266
    if( !p_mutex )
        return B_BAD_VALUE;

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

267 268 269
    lazy_init_mutex( p_mutex );

    err = acquire_sem( p_mutex->lock );
Sam Hocevar's avatar
Sam Hocevar committed
270 271 272
    if( !err )
        p_mutex->owner = find_thread( NULL );

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)
Sam Hocevar's avatar
Sam Hocevar committed
291 292 293 294 295 296
    if(! p_mutex)
        return B_BAD_VALUE;

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

297 298
    lazy_init_mutex( p_mutex );

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

302 303 304 305
    p_mutex->owner = -1;
    release_sem( p_mutex->lock );
    return B_OK;

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

309
#endif
310 311
}

312
#if defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
313 314 315 316
/* lazy_init_cond */
static __inline__ void lazy_init_cond( vlc_cond_t* p_condvar )
{
    int32 v = atomic_or( &p_condvar->init, 1 );
317
    if( 2000 == v ) /* we're the first, so do the init */
318 319 320
    {
        vlc_cond_init( p_condvar );
    }
321
    else /* we're not the first, so wait until the init is finished */
322
    {
Sam Hocevar's avatar
Sam Hocevar committed
323 324 325 326
        while( p_condvar->init != 9999 )
        {
            snooze( 10000 );
        }
327 328 329 330
    }
}
#endif

331
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
332
 * vlc_cond_init: initialize a condition
333
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
334
static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
335
{
336
#if defined(HAVE_CTHREADS_H)
337 338 339 340 341 342
    /* 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
343
    return 0;
344

345
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
346 347 348 349 350
    if( !p_condvar )
        return B_BAD_VALUE;

    if( p_condvar->init == 9999 )
        return EALREADY;
351 352 353 354 355 356 357 358

    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;

359
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
360
    return pthread_cond_init( p_condvar, NULL );
361

362
#endif
363 364
}

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
}