threads.h 13.6 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_SHEDULER_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_SHEDULER_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 153
    *p_thread = cthread_fork( (cthread_fn_t)func, (any_t)p_data );
    return( 0 );
154

155
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
156 157 158
    *p_thread = spawn_thread( (thread_func)func, psz_name, B_NORMAL_PRIORITY, p_data );
    return resume_thread( *p_thread );

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

162
#endif
163 164
}

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

174
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
175 176
    exit_thread( 0 );

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

180
#endif
181 182
}

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

191
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
192 193 194
    int32 exit_value;	
    wait_for_thread( thread, &exit_value );

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

198
#endif
199 200
}

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

217
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
218
 * vlc_mutex_init: initialize a mutex
219
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
220
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
221
{
222
#if defined(HAVE_CTHREADS_H)
223 224
    mutex_init( p_mutex );
    return( 0 );
225

226
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
227 228 229 230 231 232 233 234 235
    // 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;

236
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
237
    return pthread_mutex_init( p_mutex, NULL );
238

239
#endif
240 241
}

242
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
243
 * vlc_mutex_lock: lock a mutex
244
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
245
static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
246
{
247
#if defined(HAVE_CTHREADS_H)
248 249
    mutex_lock( p_mutex );
    return( 0 );
250

251
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
252 253 254 255 256 257 258 259 260 261
    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;

262
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
263
    return pthread_mutex_lock( p_mutex );
264

265
#endif
266 267
}

268
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
269
 * vlc_mutex_unlock: unlock a mutex
270
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
271
static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
272
{
273
#if defined(HAVE_CTHREADS_H)
274 275
    mutex_unlock( p_mutex );
    return( 0 );
276

277
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
278 279 280 281 282 283 284 285 286
    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;

287
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
288
    return pthread_mutex_unlock( p_mutex );
289

290
#endif
291 292
}

293
#if defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
294 295 296 297
/* lazy_init_cond */
static __inline__ void lazy_init_cond( vlc_cond_t* p_condvar )
{
    int32 v = atomic_or( &p_condvar->init, 1 );
298
    if( 2000 == v ) /* we're the first, so do the init */
299 300 301
    {
        vlc_cond_init( p_condvar );
    }
302
    else /* we're not the first, so wait until the init is finished */
303 304 305 306 307 308
    {
        while( p_condvar->init != 9999 ) snooze( 10000 );
    }
}
#endif

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

    return( 0 );
322

323
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
324 325 326 327 328 329 330 331 332 333
    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;

334
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
335
    return pthread_cond_init( p_condvar, NULL );
336

337
#endif
338 339
}

340
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
341
 * vlc_cond_signal: start a thread on condition completion
342
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
343
static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
344
{
345
#if defined(HAVE_CTHREADS_H)
346 347 348 349 350 351
    /* condition_signal() */
    if ( p_condvar->queue.head || p_condvar->implications )
    {
        cond_signal( (condition_t)p_condvar );
    }
    return( 0 );
352

353
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
    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;

376
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
377
    return pthread_cond_signal( p_condvar );
378

379
#endif
380
}
Vincent Seguin's avatar
Vincent Seguin committed
381

382
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
383
 * vlc_cond_wait: wait until condition completion
384
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
385
static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
386
{
387
#if defined(HAVE_CTHREADS_H)
388 389
    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
    return( 0 );
390

391
#elif defined(HAVE_KERNEL_SHEDULER_H) && defined(HAVE_KERNEL_OS_H)
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
    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;

420
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
421
    return pthread_cond_wait( p_condvar, p_mutex );
422

423
#endif
424
}