threads.h 13 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

Henri Fallon's avatar
 
Henri Fallon committed
73 74 75 76 77 78 79
#if defined(HAVE_PTHREAD_H)

typedef pthread_t        vlc_thread_t;
typedef pthread_mutex_t  vlc_mutex_t;
typedef pthread_cond_t   vlc_cond_t;

#elif defined(HAVE_CTHREADS_H)
80 81 82 83

typedef cthread_t        vlc_thread_t;

/* those structs are the ones defined in /include/cthreads.h but we need
84 85
 * to handle (*foo) where foo is a (mutex_t) while they handle (foo) where
 * foo is a (mutex_t*) */
86 87 88 89 90 91 92 93 94 95 96 97 98 99
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;

100
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
101

102 103 104 105
/* 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 */

106 107 108 109 110 111 112 113 114 115 116
typedef thread_id vlc_thread_t;

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

typedef struct
{
    int32           init;
117
    thread_id       thread;
118 119
} 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

Henri Fallon's avatar
 
Henri Fallon committed
133 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 );
static __inline__ int  vlc_mutex_destroy ( 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 );
Henri Fallon's avatar
 
Henri Fallon committed
141
static __inline__ int vlc_cond_destroy  ( vlc_cond_t *p_condvar );
142

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

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

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

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

167
#endif
168 169
}

170
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
171
 * vlc_thread_exit: terminate a thread
172
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
173
static __inline__ void vlc_thread_exit( void )
174
{
Henri Fallon's avatar
 
Henri Fallon committed
175 176 177 178
#if defined(HAVE_PTHREAD_H)
    pthread_exit( 0 );

#elif defined(HAVE_CTHREADS_H)
179 180
    int result;
    cthread_exit( &result );
181

182
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
183 184
    exit_thread( 0 );

185
#endif
186 187
}

188
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
189
 * vlc_thread_join: wait until a thread exits
190
 *****************************************************************************/
191 192
static __inline__ void vlc_thread_join( vlc_thread_t thread )
{
Henri Fallon's avatar
 
Henri Fallon committed
193 194 195 196
#if defined(HAVE_PTHREAD_H)
    pthread_join( thread, NULL );

#elif defined(HAVE_CTHREADS_H)
197
    cthread_join( thread );
198

199
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
200
    int32 exit_value;
201 202
    wait_for_thread( thread, &exit_value );

203
#endif
204 205
}

206
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
207
 * vlc_mutex_init: initialize a mutex
208
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
209
static __inline__ int vlc_mutex_init( vlc_mutex_t *p_mutex )
210
{
Henri Fallon's avatar
 
Henri Fallon committed
211 212 213 214
#if defined(HAVE_PTHREAD_H)
    return pthread_mutex_init( p_mutex, NULL );

#elif defined(HAVE_CTHREADS_H)
215
    mutex_init( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
216
    return 0;
217

218
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
219

Sam Hocevar's avatar
 
Sam Hocevar committed
220
    /* check the arguments and whether it's already been initialized */
221 222 223 224 225
    if( p_mutex == NULL ) return B_BAD_VALUE;
    if( p_mutex->init == 9999 )
    {
        return EALREADY;
    }
226 227

    p_mutex->lock = create_sem( 1, "BeMutex" );
228 229
    if( p_mutex->lock < B_NO_ERROR )
        return( -1 );
230 231 232
    p_mutex->init = 9999;
    return B_OK;

233
#endif
234 235
}

236
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
237
 * vlc_mutex_lock: lock a mutex
238
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
239
static __inline__ int vlc_mutex_lock( vlc_mutex_t *p_mutex )
240
{
Henri Fallon's avatar
 
Henri Fallon committed
241 242 243 244
#if defined(HAVE_PTHREAD_H)
    return pthread_mutex_lock( p_mutex );

#elif defined(HAVE_CTHREADS_H)
245
    mutex_lock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
246
    return 0;
247

248
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
249
    status_t err;
250

251 252
    if( !p_mutex ) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
Sam Hocevar's avatar
Sam Hocevar committed
253

254 255 256
    err = acquire_sem( p_mutex->lock );
    return err;

257
#endif
258 259
}

260
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
261
 * vlc_mutex_unlock: unlock a mutex
262
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
263
static __inline__ int vlc_mutex_unlock( vlc_mutex_t *p_mutex )
264
{
Henri Fallon's avatar
 
Henri Fallon committed
265 266 267 268
#if defined(HAVE_PTHREAD_H)
    return pthread_mutex_unlock( p_mutex );

#elif defined(HAVE_CTHREADS_H)
269
    mutex_unlock( p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
270
    return 0;
271

272
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
273

274 275
    if(! p_mutex) return B_BAD_VALUE;
    if( p_mutex->init < 2000 ) return B_NO_INIT;
Sam Hocevar's avatar
Sam Hocevar committed
276

277 278 279
    release_sem( p_mutex->lock );
    return B_OK;

280
#endif
281 282
}

Henri Fallon's avatar
 
Henri Fallon committed
283 284 285 286 287 288 289 290 291 292
/*****************************************************************************
 * vlc_mutex_destroy: destory a mutex
 *****************************************************************************/
static __inline__ int vlc_mutex_destroy( vlc_mutex_t *p_mutex )
{
#if defined(HAVE_PTHREAD_H)    
    return pthread_mutex_destroy( p_mutex );
#endif    
}

293
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
294
 * vlc_cond_init: initialize a condition
295
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
296
static __inline__ int vlc_cond_init( vlc_cond_t *p_condvar )
297
{
Henri Fallon's avatar
 
Henri Fallon committed
298 299 300 301
#if defined(HAVE_PTHREAD_H)
    return pthread_cond_init( p_condvar, NULL );

#elif defined(HAVE_CTHREADS_H)
302 303 304 305 306 307
    /* 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
308
    return 0;
309

310
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
311 312 313 314 315
    if( !p_condvar )
        return B_BAD_VALUE;

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

317
    p_condvar->thread = -1;
318
    p_condvar->init = 9999;
319
    return 0;
320

321
#endif
322 323
}

324
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
325
 * vlc_cond_signal: start a thread on condition completion
326
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
327
static __inline__ int vlc_cond_signal( vlc_cond_t *p_condvar )
328
{
Henri Fallon's avatar
 
Henri Fallon committed
329 330 331 332
#if defined(HAVE_PTHREAD_H)
    return pthread_cond_signal( p_condvar );

#elif defined(HAVE_CTHREADS_H)
333 334 335 336 337
    /* condition_signal() */
    if ( p_condvar->queue.head || p_condvar->implications )
    {
        cond_signal( (condition_t)p_condvar );
    }
Sam Hocevar's avatar
Sam Hocevar committed
338
    return 0;
339

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

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

347
    while( p_condvar->thread != -1 )
348
    {
349 350 351
        thread_info info;
        if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
            return 0;
Sam Hocevar's avatar
Sam Hocevar committed
352

353 354
        // is the thread sleeping ?
        if( info.state != B_THREAD_SUSPENDED )
Sam Hocevar's avatar
Sam Hocevar committed
355
        {
356 357 358 359 360 361 362 363
            // 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
364
        }
365
    }
366 367
    
    return 0;
368

369
#endif
370
}
Vincent Seguin's avatar
Vincent Seguin committed
371

372
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
373
 * vlc_cond_wait: wait until condition completion
374
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
375
static __inline__ int vlc_cond_wait( vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
376
{
Henri Fallon's avatar
 
Henri Fallon committed
377 378 379 380
#if defined(HAVE_PTHREAD_H)
    return pthread_cond_wait( p_condvar, p_mutex );

#elif defined(HAVE_CTHREADS_H)
381
    condition_wait( (condition_t)p_condvar, (mutex_t)p_mutex );
Sam Hocevar's avatar
Sam Hocevar committed
382
    return 0;
383

384
#elif defined(HAVE_KERNEL_SCHEDULER_H) && defined(HAVE_KERNEL_OS_H)
Sam Hocevar's avatar
Sam Hocevar committed
385 386 387 388 389 390 391 392 393
    if( !p_condvar )
        return B_BAD_VALUE;

    if( !p_mutex )
        return B_BAD_VALUE;

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

394
    p_condvar->thread = find_thread( NULL );
395
    vlc_mutex_unlock( p_mutex );
396 397
    suspend_thread( p_condvar->thread );
    p_condvar->thread = -1;
Sam Hocevar's avatar
Sam Hocevar committed
398

399 400
    vlc_mutex_lock( p_mutex );
    return 0;
401

402
#endif
403
}
404

Henri Fallon's avatar
 
Henri Fallon committed
405 406 407 408 409 410 411 412 413
/*****************************************************************************
 * vlc_cond_destory: destroy a condition
 *****************************************************************************/
static __inline__ int vlc_cond_destroy( vlc_cond_t *p_condvar )
{
#if defined(HAVE_PTHREAD_H)
    return pthread_cond_destroy( p_condvar );
#endif    
}