threads.h 12.1 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
/* This is the BeOS implementation of the vlc thread, note that the mutex is
 * not a real mutex and the cond_var is not like a pthread cond_var but it is
 * enough for what wee need */

100 101 102 103 104 105 106 107 108 109 110
typedef thread_id vlc_thread_t;

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

typedef struct
{
    int32           init;
111
    thread_id       thread;
112 113
} 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
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
205
 * vlc_mutex_init: initialize a mutex
206
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
207
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
208
{
209
#if defined(HAVE_CTHREADS_H)
210
    mutex_init( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
211
    return 0;
212

213
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
214

215
    // check the arguments and whether it's already been initialized
216 217 218 219 220
    if( p_mutex == NULL ) return B_BAD_VALUE;
    if( p_mutex->init == 9999 )
    {
        return EALREADY;
    }
221 222

    p_mutex->lock = create_sem( 1, "BeMutex" );
223 224
    if( p_mutex->lock < B_NO_ERROR )
        return( -1 );
225 226 227
    p_mutex->init = 9999;
    return B_OK;

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

231
#endif
232 233
}

234
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
235
 * vlc_mutex_lock: lock a mutex
236
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
237
static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
238
{
239
#if defined(HAVE_CTHREADS_H)
240
    mutex_lock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
241
    return 0;
242

243
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
244
    status_t err;
245

246 247
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
Sam Hocevar's avatar
Sam Hocevar committed
248

249 250 251
    err = acquire_sem( p_mutex->lock );
    return err;

252
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
253
    return pthread_mutex_lock( p_mutex );
254

255
#endif
256 257
}

258
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
259
 * vlc_mutex_unlock: unlock a mutex
260
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
261
static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
262
{
263
#if defined(HAVE_CTHREADS_H)
264
    mutex_unlock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
265
    return 0;
266

267
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
268

269 270
    if(! p_mutex) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
Sam Hocevar's avatar
Sam Hocevar committed
271

272 273 274
    release_sem( p_mutex->lock );
    return B_OK;

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

278
#endif
279 280
}

281
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
282
 * vlc_cond_init: initialize a condition
283
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
284
static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
285
{
286
#if defined(HAVE_CTHREADS_H)
287 288 289 290 291 292
    /* 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
293
    return 0;
294

295
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
296 297 298 299 300
    if( !p_condvar )
        return B_BAD_VALUE;

    if( p_condvar->init == 9999 )
        return EALREADY;
301

302
    p_condvar->thread = -1;
303
    p_condvar->init = 9999;
304
    return 0;
305

306
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
307
    return pthread_cond_init( p_condvar, NULL );
308

309
#endif
310 311
}

312
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
313
 * vlc_cond_signal: start a thread on condition completion
314
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
315
static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
316
{
317
#if defined(HAVE_CTHREADS_H)
318 319 320 321 322
    /* condition_signal() */
    if ( p_condvar->queue.head || p_condvar->implications )
    {
        cond_signal( (condition_t)p_condvar );
    }
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 331
    if( !p_condvar )
        return B_BAD_VALUE;

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

332
    while( p_condvar->thread != -1 )
333
    {
334 335 336
        thread_info info;
        if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
            return 0;
Sam Hocevar's avatar
Sam Hocevar committed
337

338 339
        // is the thread sleeping ?
        if( info.state != B_THREAD_SUSPENDED )
Sam Hocevar's avatar
Sam Hocevar committed
340
        {
341 342 343 344 345 346 347 348
            // wait a little
            snooze( 10000 );
        }
        else
        {
            // ok, we have to wake up that thread
            resume_thread( p_condvar->thread );
            return 0;
Sam Hocevar's avatar
Sam Hocevar committed
349
        }
350
    }
351 352
    
    return 0;
353

354
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
355
    return pthread_cond_signal( p_condvar );
356

357
#endif
358
}
Vincent Seguin's avatar
Vincent Seguin committed
359

360
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
361
 * vlc_cond_wait: wait until condition completion
362
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
363
static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
364
{
365
#if defined(HAVE_CTHREADS_H)
366
    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
367
    return 0;
368

369
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
370 371 372 373 374 375 376 377 378
    if( !p_condvar )
        return B_BAD_VALUE;

    if( !p_mutex )
        return B_BAD_VALUE;

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

379
    p_condvar->thread = find_thread( NULL );
380
    vlc_mutex_unlock( p_mutex );
381 382
    suspend_thread( p_condvar->thread );
    p_condvar->thread = -1;
Sam Hocevar's avatar
Sam Hocevar committed
383

384 385
    vlc_mutex_lock( p_mutex );
    return 0;
386

387
#elif defined(HAVE_PTHREAD_H)
Vincent Seguin's avatar
Vincent Seguin committed
388
    return pthread_cond_wait( p_condvar, p_mutex );
389

390
#endif
391
}
392