]> git.sesse.net Git - vlc/blob - include/vlc_threads.h
vlc_savecancel, vlc_restorecancel: POSIX cancellation state management
[vlc] / include / vlc_threads.h
1 /*****************************************************************************
2  * vlc_threads.h : threads implementation for the VideoLAN client
3  * This header provides portable declarations for mutexes & conditions
4  *****************************************************************************
5  * Copyright (C) 1999, 2002 the VideoLAN team
6  * Copyright © 2007-2008 Rémi Denis-Courmont
7  *
8  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
9  *          Samuel Hocevar <sam@via.ecp.fr>
10  *          Gildas Bazin <gbazin@netcourrier.com>
11  *          Christophe Massiot <massiot@via.ecp.fr>
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26  *****************************************************************************/
27
28 #ifndef VLC_THREADS_H_
29 #define VLC_THREADS_H_
30
31 /**
32  * \file
33  * This file defines structures and functions for handling threads in vlc
34  *
35  */
36
37 #if defined( UNDER_CE )
38                                                                 /* WinCE API */
39 #elif defined( WIN32 )
40 #   include <process.h>                                         /* Win32 API */
41 #   include <errno.h>
42
43 #elif defined( SYS_BEOS )                                            /* BeOS */
44 #   include <kernel/OS.h>
45 #   include <kernel/scheduler.h>
46 #   include <byteorder.h>
47
48 #else                                         /* pthreads (like Linux & BSD) */
49 #   define LIBVLC_USE_PTHREAD 1
50 #   define _APPLE_C_SOURCE    1 /* Proper pthread semantics on OSX */
51
52 #   include <stdlib.h> /* lldiv_t definition (only in C99) */
53 #   include <unistd.h> /* _POSIX_SPIN_LOCKS */
54 #   include <pthread.h>
55     /* Needed for pthread_cond_timedwait */
56 #   include <errno.h>
57 #   include <time.h>
58
59 #endif
60
61 /*****************************************************************************
62  * Constants
63  *****************************************************************************/
64
65 /* Thread priorities */
66 #ifdef __APPLE__
67 #   define VLC_THREAD_PRIORITY_LOW      0
68 #   define VLC_THREAD_PRIORITY_INPUT   22
69 #   define VLC_THREAD_PRIORITY_AUDIO   22
70 #   define VLC_THREAD_PRIORITY_VIDEO    0
71 #   define VLC_THREAD_PRIORITY_OUTPUT  22
72 #   define VLC_THREAD_PRIORITY_HIGHEST 22
73
74 #elif defined(SYS_BEOS)
75 #   define VLC_THREAD_PRIORITY_LOW 5
76 #   define VLC_THREAD_PRIORITY_INPUT 10
77 #   define VLC_THREAD_PRIORITY_AUDIO 10
78 #   define VLC_THREAD_PRIORITY_VIDEO 5
79 #   define VLC_THREAD_PRIORITY_OUTPUT 15
80 #   define VLC_THREAD_PRIORITY_HIGHEST 15
81
82 #elif defined(LIBVLC_USE_PTHREAD)
83 #   define VLC_THREAD_PRIORITY_LOW      0
84 #   define VLC_THREAD_PRIORITY_INPUT   10
85 #   define VLC_THREAD_PRIORITY_AUDIO    5
86 #   define VLC_THREAD_PRIORITY_VIDEO    0
87 #   define VLC_THREAD_PRIORITY_OUTPUT  15
88 #   define VLC_THREAD_PRIORITY_HIGHEST 20
89
90 #elif defined(WIN32) || defined(UNDER_CE)
91 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
92 #   define VLC_THREAD_PRIORITY_LOW 0
93 #   define VLC_THREAD_PRIORITY_INPUT \
94         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
95 #   define VLC_THREAD_PRIORITY_AUDIO \
96         (IS_WINNT ? THREAD_PRIORITY_HIGHEST : 0)
97 #   define VLC_THREAD_PRIORITY_VIDEO \
98         (IS_WINNT ? 0 : THREAD_PRIORITY_BELOW_NORMAL )
99 #   define VLC_THREAD_PRIORITY_OUTPUT \
100         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
101 #   define VLC_THREAD_PRIORITY_HIGHEST \
102         (IS_WINNT ? THREAD_PRIORITY_TIME_CRITICAL : 0)
103
104 #else
105 #   define VLC_THREAD_PRIORITY_LOW 0
106 #   define VLC_THREAD_PRIORITY_INPUT 0
107 #   define VLC_THREAD_PRIORITY_AUDIO 0
108 #   define VLC_THREAD_PRIORITY_VIDEO 0
109 #   define VLC_THREAD_PRIORITY_OUTPUT 0
110 #   define VLC_THREAD_PRIORITY_HIGHEST 0
111
112 #endif
113
114 /*****************************************************************************
115  * Type definitions
116  *****************************************************************************/
117
118 #if defined (LIBVLC_USE_PTHREAD)
119 typedef pthread_t       vlc_thread_t;
120 typedef pthread_mutex_t vlc_mutex_t;
121 typedef pthread_cond_t  vlc_cond_t;
122 typedef pthread_key_t   vlc_threadvar_t;
123
124 #elif defined( WIN32 ) || defined( UNDER_CE )
125 typedef struct
126 {
127     HANDLE handle;
128     void  *(*entry) (void *);
129     void  *data;
130 } *vlc_thread_t;
131
132 typedef HANDLE  vlc_mutex_t;
133 typedef HANDLE  vlc_cond_t;
134 typedef DWORD   vlc_threadvar_t;
135
136 #elif defined( SYS_BEOS )
137 /* This is the BeOS implementation of the vlc threads, note that the mutex is
138  * not a real mutex and the cond_var is not like a pthread cond_var but it is
139  * enough for what we need */
140
141 typedef thread_id vlc_thread_t;
142
143 typedef struct
144 {
145     int32_t         init;
146     sem_id          lock;
147 } vlc_mutex_t;
148
149 typedef struct
150 {
151     int32_t         init;
152     thread_id       thread;
153 } vlc_cond_t;
154
155 typedef struct
156 {
157 } vlc_threadvar_t;
158
159 #endif
160
161 #if defined( WIN32 ) && !defined ETIMEDOUT
162 #  define ETIMEDOUT 10060 /* This is the value in winsock.h. */
163 #endif
164
165 /*****************************************************************************
166  * Function definitions
167  *****************************************************************************/
168 VLC_EXPORT( int,  vlc_mutex_init,    ( vlc_mutex_t * ) );
169 VLC_EXPORT( int,  vlc_mutex_init_recursive, ( vlc_mutex_t * ) );
170 VLC_EXPORT( void,  __vlc_mutex_destroy, ( const char *, int, vlc_mutex_t * ) );
171 VLC_EXPORT( int,  __vlc_cond_init,     ( vlc_cond_t * ) );
172 VLC_EXPORT( void,  __vlc_cond_destroy,  ( const char *, int, vlc_cond_t * ) );
173 VLC_EXPORT( int, vlc_threadvar_create, (vlc_threadvar_t * , void (*) (void *) ) );
174 VLC_EXPORT( void, vlc_threadvar_delete, (vlc_threadvar_t *) );
175 VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( vlc_object_t * ), int, bool ) );
176 VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, const char *, int, int ) );
177 VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t *, const char *, int ) );
178
179 VLC_EXPORT( int, vlc_clone, (vlc_thread_t *, void * (*) (void *), void *, int) );
180 VLC_EXPORT( int, vlc_join, (vlc_thread_t, void **) );
181
182 #define vlc_thread_ready vlc_object_signal
183
184 /*****************************************************************************
185  * vlc_mutex_lock: lock a mutex
186  *****************************************************************************/
187 #define vlc_mutex_lock( P_MUTEX )                                           \
188     __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
189
190 VLC_EXPORT(void, vlc_pthread_fatal, (const char *action, int error, const char *file, unsigned line));
191
192 #if defined(LIBVLC_USE_PTHREAD)
193 # define VLC_THREAD_ASSERT( action ) \
194     if (val) \
195         vlc_pthread_fatal (action, val, psz_file, i_line)
196 #else
197 # define VLC_THREAD_ASSERT ((void)(val))
198 #endif
199
200 static inline void __vlc_mutex_lock( const char * psz_file, int i_line,
201                                     vlc_mutex_t * p_mutex )
202 {
203 #if defined(LIBVLC_USE_PTHREAD)
204 #   define vlc_assert_locked( m ) \
205            assert (pthread_mutex_lock (m) == EDEADLK)
206     int val = pthread_mutex_lock( p_mutex );
207     VLC_THREAD_ASSERT ("locking mutex");
208
209 #elif defined( UNDER_CE )
210     (void)psz_file; (void)i_line;
211
212     EnterCriticalSection( &p_mutex->csection );
213
214 #elif defined( WIN32 )
215     (void)psz_file; (void)i_line;
216
217     WaitForSingleObject( *p_mutex, INFINITE );
218
219 #elif defined( SYS_BEOS )
220     acquire_sem( p_mutex->lock );
221
222 #endif
223 }
224
225 #ifndef vlc_assert_locked
226 # define vlc_assert_locked( m ) (void)m
227 #endif
228
229 /*****************************************************************************
230  * vlc_mutex_unlock: unlock a mutex
231  *****************************************************************************/
232 #define vlc_mutex_unlock( P_MUTEX )                                         \
233     __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
234
235 static inline void __vlc_mutex_unlock( const char * psz_file, int i_line,
236                                       vlc_mutex_t *p_mutex )
237 {
238 #if defined(LIBVLC_USE_PTHREAD)
239     int val = pthread_mutex_unlock( p_mutex );
240     VLC_THREAD_ASSERT ("unlocking mutex");
241
242 #elif defined( UNDER_CE )
243     (void)psz_file; (void)i_line;
244
245     LeaveCriticalSection( &p_mutex->csection );
246
247 #elif defined( WIN32 )
248     (void)psz_file; (void)i_line;
249
250     ReleaseMutex( *p_mutex );
251
252 #elif defined( SYS_BEOS )
253     release_sem( p_mutex->lock );
254
255 #endif
256 }
257
258 /*****************************************************************************
259  * vlc_mutex_destroy: destroy a mutex
260  *****************************************************************************/
261 #define vlc_mutex_destroy( P_MUTEX )                                        \
262     __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
263
264 /*****************************************************************************
265  * vlc_cond_init: initialize a condition
266  *****************************************************************************/
267 #define vlc_cond_init( P_THIS, P_COND )                                     \
268     __vlc_cond_init( P_COND )
269
270 /*****************************************************************************
271  * vlc_cond_signal: start a thread on condition completion
272  *****************************************************************************/
273 #define vlc_cond_signal( P_COND )                                           \
274     __vlc_cond_signal( __FILE__, __LINE__, P_COND )
275
276 static inline void __vlc_cond_signal( const char * psz_file, int i_line,
277                                       vlc_cond_t *p_condvar )
278 {
279 #if defined(LIBVLC_USE_PTHREAD)
280     int val = pthread_cond_signal( p_condvar );
281     VLC_THREAD_ASSERT ("signaling condition variable");
282
283 #elif defined( UNDER_CE ) || defined( WIN32 )
284     (void)psz_file; (void)i_line;
285
286     /* Release one waiting thread if one is available. */
287     /* For this trick to work properly, the vlc_cond_signal must be surrounded
288      * by a mutex. This will prevent another thread from stealing the signal */
289     /* PulseEvent() only works if none of the waiting threads is suspended.
290      * This is particularily problematic under a debug session.
291      * as documented in http://support.microsoft.com/kb/q173260/ */
292     PulseEvent( *p_condvar );
293
294 #elif defined( SYS_BEOS )
295     while( p_condvar->thread != -1 )
296     {
297         thread_info info;
298         if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
299             return;
300
301         if( info.state != B_THREAD_SUSPENDED )
302         {
303             /* The  waiting thread is not suspended so it could
304              * have been interrupted beetwen the unlock and the
305              * suspend_thread line. That is why we sleep a little
306              * before retesting p_condver->thread. */
307             snooze( 10000 );
308         }
309         else
310         {
311             /* Ok, we have to wake up that thread */
312             resume_thread( p_condvar->thread );
313         }
314     }
315
316 #endif
317 }
318
319 /*****************************************************************************
320  * vlc_cond_wait: wait until condition completion
321  *****************************************************************************/
322 #define vlc_cond_wait( P_COND, P_MUTEX )                                     \
323     __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX  )
324
325 static inline void __vlc_cond_wait( const char * psz_file, int i_line,
326                                     vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
327 {
328 #if defined(LIBVLC_USE_PTHREAD)
329     int val = pthread_cond_wait( p_condvar, p_mutex );
330     VLC_THREAD_ASSERT ("waiting on condition");
331
332 #elif defined( UNDER_CE )
333     LeaveCriticalSection( &p_mutex->csection );
334     WaitForSingleObject( *p_condvar, INFINITE );
335
336     /* Reacquire the mutex before returning. */
337     vlc_mutex_lock( p_mutex );
338
339 #elif defined( WIN32 )
340     (void)psz_file; (void)i_line;
341
342     /* Increase our wait count */
343     SignalObjectAndWait( *p_mutex, *p_condvar, INFINITE, FALSE );
344
345     /* Reacquire the mutex before returning. */
346     vlc_mutex_lock( p_mutex );
347
348 #elif defined( SYS_BEOS )
349     /* The p_condvar->thread var is initialized before the unlock because
350      * it enables to identify when the thread is interrupted beetwen the
351      * unlock line and the suspend_thread line */
352     p_condvar->thread = find_thread( NULL );
353     vlc_mutex_unlock( p_mutex );
354     suspend_thread( p_condvar->thread );
355     p_condvar->thread = -1;
356
357     vlc_mutex_lock( p_mutex );
358
359 #endif
360 }
361
362
363 /*****************************************************************************
364  * vlc_cond_timedwait: wait until condition completion or expiration
365  *****************************************************************************
366  * Returns 0 if object signaled, an error code in case of timeout or error.
367  *****************************************************************************/
368 #define vlc_cond_timedwait( P_COND, P_MUTEX, DEADLINE )                      \
369     __vlc_cond_timedwait( __FILE__, __LINE__, P_COND, P_MUTEX, DEADLINE  )
370
371 static inline int __vlc_cond_timedwait( const char * psz_file, int i_line,
372                                         vlc_cond_t *p_condvar,
373                                         vlc_mutex_t *p_mutex,
374                                         mtime_t deadline )
375 {
376 #if defined(LIBVLC_USE_PTHREAD)
377     lldiv_t d = lldiv( deadline, 1000000 );
378     struct timespec ts = { d.quot, d.rem * 1000 };
379
380     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
381     if (val == ETIMEDOUT)
382         return ETIMEDOUT; /* this error is perfectly normal */
383     VLC_THREAD_ASSERT ("timed-waiting on condition");
384
385 #elif defined( UNDER_CE )
386     mtime_t delay_ms = (deadline - mdate())/1000;
387     DWORD result;
388     if( delay_ms < 0 )
389         delay_ms = 0;
390
391     LeaveCriticalSection( &p_mutex->csection );
392     result = WaitForSingleObject( *p_condvar, delay_ms );
393
394     /* Reacquire the mutex before returning. */
395     vlc_mutex_lock( p_mutex );
396
397     if(result == WAIT_TIMEOUT)
398        return ETIMEDOUT; /* this error is perfectly normal */
399
400     (void)psz_file; (void)i_line;
401
402 #elif defined( WIN32 )
403     mtime_t total = (deadline - mdate())/1000;
404     DWORD result;
405     if( total < 0 )
406         total = 0;
407
408     do
409     {
410         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
411         result = SignalObjectAndWait( *p_mutex, *p_condvar,
412                                       delay, FALSE );
413         total -= delay;
414         vlc_mutex_lock (p_mutex);
415     }
416     while (total);
417
418     /* Reacquire the mutex before returning. */
419     if(result == WAIT_TIMEOUT)
420        return ETIMEDOUT; /* this error is perfectly normal */
421
422     (void)psz_file; (void)i_line;
423
424 #elif defined( SYS_BEOS )
425 #   error Unimplemented
426
427 #endif
428
429     return 0;
430 }
431
432 /*****************************************************************************
433  * vlc_cond_destroy: destroy a condition
434  *****************************************************************************/
435 #define vlc_cond_destroy( P_COND )                                          \
436     __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
437
438 /*****************************************************************************
439  * vlc_threadvar_set: create: set the value of a thread-local variable
440  *****************************************************************************/
441 static inline int vlc_threadvar_set( vlc_threadvar_t * p_tls, void *p_value )
442 {
443     int i_ret;
444
445 #if defined(LIBVLC_USE_PTHREAD)
446     i_ret = pthread_setspecific( *p_tls, p_value );
447
448 #elif defined( SYS_BEOS )
449     i_ret = EINVAL;
450
451 #elif defined( UNDER_CE ) || defined( WIN32 )
452     i_ret = TlsSetValue( *p_tls, p_value ) ? EINVAL : 0;
453
454 #endif
455
456     return i_ret;
457 }
458
459 /*****************************************************************************
460  * vlc_threadvar_get: create: get the value of a thread-local variable
461  *****************************************************************************/
462 static inline void* vlc_threadvar_get( vlc_threadvar_t * p_tls )
463 {
464     void *p_ret;
465
466 #if defined(LIBVLC_USE_PTHREAD)
467     p_ret = pthread_getspecific( *p_tls );
468
469 #elif defined( SYS_BEOS )
470     p_ret = NULL;
471
472 #elif defined( UNDER_CE ) || defined( WIN32 )
473     p_ret = TlsGetValue( *p_tls );
474
475 #endif
476
477     return p_ret;
478 }
479
480 # if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0)
481 typedef pthread_spinlock_t vlc_spinlock_t;
482
483 /**
484  * Initializes a spinlock.
485  */
486 static inline int vlc_spin_init (vlc_spinlock_t *spin)
487 {
488     return pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE);
489 }
490
491 /**
492  * Acquires a spinlock.
493  */
494 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
495 {
496     pthread_spin_lock (spin);
497 }
498
499 /**
500  * Releases a spinlock.
501  */
502 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
503 {
504     pthread_spin_unlock (spin);
505 }
506
507 /**
508  * Deinitializes a spinlock.
509  */
510 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
511 {
512     pthread_spin_destroy (spin);
513 }
514
515 #elif defined( WIN32 )
516
517 typedef CRITICAL_SECTION vlc_spinlock_t;
518
519 /**
520  * Initializes a spinlock.
521  */
522 static inline int vlc_spin_init (vlc_spinlock_t *spin)
523 {
524     return !InitializeCriticalSectionAndSpinCount(spin, 4000);
525 }
526
527 /**
528  * Acquires a spinlock.
529  */
530 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
531 {
532     EnterCriticalSection(spin);
533 }
534
535 /**
536  * Releases a spinlock.
537  */
538 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
539 {
540     LeaveCriticalSection(spin);
541 }
542
543 /**
544  * Deinitializes a spinlock.
545  */
546 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
547 {
548     DeleteCriticalSection(spin);
549 }
550
551 #else
552
553 /* Fallback to plain mutexes if spinlocks are not available */
554 typedef vlc_mutex_t vlc_spinlock_t;
555
556 static inline int vlc_spin_init (vlc_spinlock_t *spin)
557 {
558     return vlc_mutex_init (spin);
559 }
560
561 # define vlc_spin_lock    vlc_mutex_lock
562 # define vlc_spin_unlock  vlc_mutex_unlock
563 # define vlc_spin_destroy vlc_mutex_destroy
564 #endif
565
566 /**
567  * Issues a full memory barrier.
568  */
569 #if defined (__APPLE__)
570 # include <libkern/OSAtomic.h> /* OSMemoryBarrier() */
571 #endif
572 static inline void barrier (void)
573 {
574 #if defined (__GNUC__) && (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1)
575     __sync_synchronize ();
576 #elif defined(__APPLE__)
577     OSMemoryBarrier ();
578 #elif defined(__powerpc__)
579     asm volatile ("sync":::"memory");
580 #elif defined(__i386__)
581     asm volatile ("mfence":::"memory");
582 #else
583     vlc_spinlock_t spin;
584     vlc_spin_init (&spin);
585     vlc_spin_lock (&spin);
586     vlc_spin_unlock (&spin);
587     vlc_spin_destroy (&spin);
588 #endif
589 }
590
591 /**
592  * Save the cancellation state and disable cancellation for the calling thread.
593  * This function must be called before entering a piece of code that is not
594  * cancellation-safe.
595  * @param p_state storage for the previous cancellation state
596  * @return Nothing, always succeeds.
597  */
598 static inline void vlc_savecancel (int *p_state)
599 {
600 #if defined (LIBVLC_USE_PTHREAD)
601     (void) pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, p_state);
602 #endif
603 }
604
605 /**
606  * Restore the cancellation state for the calling thread.
607  * @param state previous state as returned by vlc_savecancel().
608  * @return Nothing, always succeeds.
609  */
610 static inline void vlc_restorecancel (int state)
611 {
612 #if defined (LIBVLC_USE_PTHREAD)
613     (void) pthread_setcancelstate (state, NULL);
614 #endif
615 }
616
617 /*****************************************************************************
618  * vlc_thread_create: create a thread
619  *****************************************************************************/
620 #define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, PRIORITY, WAIT )         \
621     __vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, FUNC, PRIORITY, WAIT )
622
623 /*****************************************************************************
624  * vlc_thread_set_priority: set the priority of the calling thread
625  *****************************************************************************/
626 #define vlc_thread_set_priority( P_THIS, PRIORITY )                         \
627     __vlc_thread_set_priority( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PRIORITY )
628
629 /*****************************************************************************
630  * vlc_thread_join: wait until a thread exits
631  *****************************************************************************/
632 #define vlc_thread_join( P_THIS )                                           \
633     __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
634
635 #endif /* !_VLC_THREADS_H */