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
 *
 * 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 39
#else
#error no threads available on your system !
40
#endif
41

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

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

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

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

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

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

72
#if defined(HAVE_CTHREADS_H)
73 74 75 76

typedef cthread_t        vlc_thread_t;

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

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

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;

114
#elif defined(HAVE_PTHREAD_H)
115

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

120
#endif
121

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

124
/*****************************************************************************
125
 * Prototypes
126
 *****************************************************************************/
127

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

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

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

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

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

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

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

165
#endif
166 167
}

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

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

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

183
#endif
184 185
}

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

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

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

201
#endif
202 203
}

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

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

232
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
233
/*
234
    // check the arguments and whether it's already been initialized
235 236 237
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init == 9999 ) return EALREADY;
*/
238 239 240 241 242 243

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

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

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
#if defined(HAVE_CTHREADS_H)
256
    mutex_lock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
257
    return 0;
258

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

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

272 273
    return err;

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

277
#endif
278 279
}

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

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

294 295
    lazy_init_mutex( p_mutex );

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

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

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

307
#endif
308 309
}

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

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

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

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

    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;

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

360
#endif
361 362
}

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

376
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
377 378
    status_t err = B_OK;

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

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

385 386
    lazy_init_cond( p_condvar );

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

    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
395

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

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

410
#endif
411
}
Vincent Seguin's avatar
Vincent Seguin committed
412

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

422
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
423 424
    status_t err;

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

    if( !p_mutex )
        return B_BAD_VALUE;

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

434 435
    lazy_init_cond( p_condvar );

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

439 440 441 442 443 444 445
    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
446 447 448 449
    {
        err = B_INTERRUPTED;
    }

450 451 452 453 454 455 456 457 458
    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
459 460 461
    {
        err = B_INTERRUPTED;
    }
462 463
    return err;

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

467
#endif
468
}