Critical section are internally recursive
[vlc.git] / 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 #   include <errno.h>                                           /* WinCE API */
39 #elif defined( WIN32 )
40 #   include <process.h>                                         /* Win32 API */
41 #   include <errno.h>
42
43 #else                                         /* pthreads (like Linux & BSD) */
44 #   define LIBVLC_USE_PTHREAD 1
45 #   define LIBVLC_USE_PTHREAD_CANCEL 1
46 #   define _APPLE_C_SOURCE    1 /* Proper pthread semantics on OSX */
47
48 #   include <stdlib.h> /* lldiv_t definition (only in C99) */
49 #   include <unistd.h> /* _POSIX_SPIN_LOCKS */
50 #   include <pthread.h>
51     /* Needed for pthread_cond_timedwait */
52 #   include <errno.h>
53 #   include <time.h>
54
55 #endif
56
57 /*****************************************************************************
58  * Constants
59  *****************************************************************************/
60
61 /* Thread priorities */
62 #ifdef __APPLE__
63 #   define VLC_THREAD_PRIORITY_LOW      0
64 #   define VLC_THREAD_PRIORITY_INPUT   22
65 #   define VLC_THREAD_PRIORITY_AUDIO   22
66 #   define VLC_THREAD_PRIORITY_VIDEO    0
67 #   define VLC_THREAD_PRIORITY_OUTPUT  22
68 #   define VLC_THREAD_PRIORITY_HIGHEST 22
69
70 #elif defined(LIBVLC_USE_PTHREAD)
71 #   define VLC_THREAD_PRIORITY_LOW      0
72 #   define VLC_THREAD_PRIORITY_INPUT   10
73 #   define VLC_THREAD_PRIORITY_AUDIO    5
74 #   define VLC_THREAD_PRIORITY_VIDEO    0
75 #   define VLC_THREAD_PRIORITY_OUTPUT  15
76 #   define VLC_THREAD_PRIORITY_HIGHEST 20
77
78 #elif defined(WIN32) || defined(UNDER_CE)
79 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
80 #   define VLC_THREAD_PRIORITY_LOW 0
81 #   define VLC_THREAD_PRIORITY_INPUT \
82         THREAD_PRIORITY_ABOVE_NORMAL
83 #   define VLC_THREAD_PRIORITY_AUDIO \
84         THREAD_PRIORITY_HIGHEST
85 #   define VLC_THREAD_PRIORITY_VIDEO 0
86 #   define VLC_THREAD_PRIORITY_OUTPUT \
87         THREAD_PRIORITY_ABOVE_NORMAL
88 #   define VLC_THREAD_PRIORITY_HIGHEST \
89         THREAD_PRIORITY_TIME_CRITICAL
90
91 #else
92 #   define VLC_THREAD_PRIORITY_LOW 0
93 #   define VLC_THREAD_PRIORITY_INPUT 0
94 #   define VLC_THREAD_PRIORITY_AUDIO 0
95 #   define VLC_THREAD_PRIORITY_VIDEO 0
96 #   define VLC_THREAD_PRIORITY_OUTPUT 0
97 #   define VLC_THREAD_PRIORITY_HIGHEST 0
98
99 #endif
100
101 /*****************************************************************************
102  * Type definitions
103  *****************************************************************************/
104
105 #if defined (LIBVLC_USE_PTHREAD)
106 typedef pthread_t       vlc_thread_t;
107 typedef pthread_mutex_t vlc_mutex_t;
108 typedef pthread_cond_t  vlc_cond_t;
109 typedef pthread_key_t   vlc_threadvar_t;
110
111 #elif defined( WIN32 )
112 typedef struct
113 {
114     HANDLE handle;
115     void  *(*entry) (void *);
116     void  *data;
117 } *vlc_thread_t;
118
119 typedef struct
120 {
121     CRITICAL_SECTION mutex;
122 }
123 vlc_mutex_t;
124 typedef HANDLE  vlc_cond_t;
125 typedef DWORD   vlc_threadvar_t;
126
127 #endif
128
129 #if defined( WIN32 ) && !defined ETIMEDOUT
130 #  define ETIMEDOUT 10060 /* This is the value in winsock.h. */
131 #endif
132
133 /*****************************************************************************
134  * Function definitions
135  *****************************************************************************/
136 VLC_EXPORT( int,  vlc_mutex_init,    ( vlc_mutex_t * ) );
137 VLC_EXPORT( int,  vlc_mutex_init_recursive, ( vlc_mutex_t * ) );
138 VLC_EXPORT( void, vlc_mutex_destroy, ( vlc_mutex_t * ) );
139 VLC_EXPORT( void, vlc_mutex_lock, ( vlc_mutex_t * ) );
140 VLC_EXPORT( void, vlc_mutex_unlock, ( vlc_mutex_t * ) );
141 VLC_EXPORT( int,  vlc_cond_init,     ( vlc_cond_t * ) );
142 VLC_EXPORT( void, vlc_cond_destroy,  ( vlc_cond_t * ) );
143 VLC_EXPORT( void, vlc_cond_signal, (vlc_cond_t *) );
144 VLC_EXPORT( void, vlc_cond_broadcast, (vlc_cond_t *) );
145 VLC_EXPORT( void, vlc_cond_wait, (vlc_cond_t *, vlc_mutex_t *) );
146 VLC_EXPORT( int, vlc_cond_timedwait, (vlc_cond_t *, vlc_mutex_t *, mtime_t) );
147 VLC_EXPORT( int, vlc_threadvar_create, (vlc_threadvar_t * , void (*) (void *) ) );
148 VLC_EXPORT( void, vlc_threadvar_delete, (vlc_threadvar_t *) );
149 VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( vlc_object_t * ), int, bool ) );
150 VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, const char *, int, int ) );
151 VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t * ) );
152
153 VLC_EXPORT( int, vlc_clone, (vlc_thread_t *, void * (*) (void *), void *, int) );
154 VLC_EXPORT( void, vlc_cancel, (vlc_thread_t) );
155 VLC_EXPORT( void, vlc_join, (vlc_thread_t, void **) );
156 VLC_EXPORT (void, vlc_control_cancel, (int cmd, ...));
157
158 #ifndef LIBVLC_USE_PTHREAD_CANCEL
159 enum {
160     VLC_SAVE_CANCEL,
161     VLC_RESTORE_CANCEL,
162     VLC_TEST_CANCEL,
163     VLC_DO_CANCEL,
164     VLC_CLEANUP_PUSH,
165     VLC_CLEANUP_POP,
166 };
167 #endif
168
169 #define vlc_thread_ready vlc_object_signal
170
171 /**
172  * Save the cancellation state and disable cancellation for the calling thread.
173  * This function must be called before entering a piece of code that is not
174  * cancellation-safe.
175  * @return Previous cancellation state (opaque value).
176  */
177 static inline int vlc_savecancel (void)
178 {
179     int state;
180 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
181     (void) pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, &state);
182 #else
183     vlc_control_cancel (VLC_SAVE_CANCEL, &state);
184 #endif
185     return state;
186 }
187
188 /**
189  * Restore the cancellation state for the calling thread.
190  * @param state previous state as returned by vlc_savecancel().
191  * @return Nothing, always succeeds.
192  */
193 static inline void vlc_restorecancel (int state)
194 {
195 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
196     (void) pthread_setcancelstate (state, NULL);
197 #else
198     vlc_control_cancel (VLC_RESTORE_CANCEL, state);
199 #endif
200 }
201
202 /**
203  * Issues an explicit deferred cancellation point.
204  * This has no effect if thread cancellation is disabled.
205  * This can be called when there is a rather slow non-sleeping operation.
206  */
207 static inline void vlc_testcancel (void)
208 {
209 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
210     pthread_testcancel ();
211 #else
212     vlc_control_cancel (VLC_TEST_CANCEL);
213 #endif
214 }
215
216 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
217 /**
218  * Registers a new procedure to run if the thread is cancelled (or otherwise
219  * exits prematurely). Any call to vlc_cleanup_push() <b>must</b> paired with a
220  * call to either vlc_cleanup_pop() or vlc_cleanup_run(). Branching into or out
221  * of the block between these two function calls is not allowed (read: it will
222  * likely crash the whole process). If multiple procedures are registered,
223  * they are handled in last-in first-out order.
224  *
225  * @param routine procedure to call if the thread ends
226  * @param arg argument for the procedure
227  */
228 # define vlc_cleanup_push( routine, arg ) pthread_cleanup_push (routine, arg)
229
230 /**
231  * Removes a cleanup procedure that was previously registered with
232  * vlc_cleanup_push().
233  */
234 # define vlc_cleanup_pop( ) pthread_cleanup_pop (0)
235
236 /**
237  * Removes a cleanup procedure that was previously registered with
238  * vlc_cleanup_push(), and executes it.
239  */
240 # define vlc_cleanup_run( ) pthread_cleanup_pop (1)
241 #else
242 typedef struct vlc_cleanup_t vlc_cleanup_t;
243
244 struct vlc_cleanup_t
245 {
246     vlc_cleanup_t *next;
247     void         (*proc) (void *);
248     void          *data;
249 };
250
251 /* This macros opens a code block on purpose. This is needed for multiple
252  * calls within a single function. This also prevent Win32 developpers from
253  * writing code that would break on POSIX (POSIX opens a block as well). */
254 # define vlc_cleanup_push( routine, arg ) \
255     do { \
256         vlc_cleanup_t vlc_cleanup_data = { NULL, routine, arg, }; \
257         vlc_control_cancel (VLC_CLEANUP_PUSH, &vlc_cleanup_data)
258
259 # define vlc_cleanup_pop( ) \
260         vlc_control_cancel (VLC_CLEANUP_POP); \
261     } while (0)
262
263 # define vlc_cleanup_run( ) \
264         vlc_control_cancel (VLC_CLEANUP_POP); \
265         vlc_cleanup_data.proc (vlc_cleanup_data.data); \
266     } while (0)
267
268 #endif /* LIBVLC_USE_PTHREAD_CANCEL */
269
270 static inline void vlc_cleanup_lock (void *lock)
271 {
272     vlc_mutex_unlock ((vlc_mutex_t *)lock);
273 }
274 #define mutex_cleanup_push( lock ) vlc_cleanup_push (vlc_cleanup_lock, lock)
275
276 /*****************************************************************************
277  * vlc_threadvar_set: create: set the value of a thread-local variable
278  *****************************************************************************/
279 static inline int vlc_threadvar_set( vlc_threadvar_t * p_tls, void *p_value )
280 {
281     int i_ret;
282
283 #if defined(LIBVLC_USE_PTHREAD)
284     i_ret = pthread_setspecific( *p_tls, p_value );
285
286 #elif defined( UNDER_CE ) || defined( WIN32 )
287     i_ret = TlsSetValue( *p_tls, p_value ) ? EINVAL : 0;
288
289 #endif
290
291     return i_ret;
292 }
293
294 /*****************************************************************************
295  * vlc_threadvar_get: create: get the value of a thread-local variable
296  *****************************************************************************/
297 static inline void* vlc_threadvar_get( vlc_threadvar_t * p_tls )
298 {
299     void *p_ret;
300
301 #if defined(LIBVLC_USE_PTHREAD)
302     p_ret = pthread_getspecific( *p_tls );
303
304 #elif defined( UNDER_CE ) || defined( WIN32 )
305     p_ret = TlsGetValue( *p_tls );
306
307 #endif
308
309     return p_ret;
310 }
311
312 # if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0)
313 typedef pthread_spinlock_t vlc_spinlock_t;
314
315 /**
316  * Initializes a spinlock.
317  */
318 static inline int vlc_spin_init (vlc_spinlock_t *spin)
319 {
320     return pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE);
321 }
322
323 /**
324  * Acquires a spinlock.
325  */
326 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
327 {
328     pthread_spin_lock (spin);
329 }
330
331 /**
332  * Releases a spinlock.
333  */
334 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
335 {
336     pthread_spin_unlock (spin);
337 }
338
339 /**
340  * Deinitializes a spinlock.
341  */
342 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
343 {
344     pthread_spin_destroy (spin);
345 }
346
347 #elif defined( WIN32 )
348
349 typedef CRITICAL_SECTION vlc_spinlock_t;
350
351 /**
352  * Initializes a spinlock.
353  */
354 static inline int vlc_spin_init (vlc_spinlock_t *spin)
355 {
356 #ifdef UNDER_CE
357     InitializeCriticalSection(spin);
358     return 0;
359 #else
360     return !InitializeCriticalSectionAndSpinCount(spin, 4000);
361 #endif
362 }
363
364 /**
365  * Acquires a spinlock.
366  */
367 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
368 {
369     EnterCriticalSection(spin);
370 }
371
372 /**
373  * Releases a spinlock.
374  */
375 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
376 {
377     LeaveCriticalSection(spin);
378 }
379
380 /**
381  * Deinitializes a spinlock.
382  */
383 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
384 {
385     DeleteCriticalSection(spin);
386 }
387
388 #else
389
390 /* Fallback to plain mutexes if spinlocks are not available */
391 typedef vlc_mutex_t vlc_spinlock_t;
392
393 static inline int vlc_spin_init (vlc_spinlock_t *spin)
394 {
395     return vlc_mutex_init (spin);
396 }
397
398 # define vlc_spin_lock    vlc_mutex_lock
399 # define vlc_spin_unlock  vlc_mutex_unlock
400 # define vlc_spin_destroy vlc_mutex_destroy
401 #endif
402
403 /**
404  * Issues a full memory barrier.
405  */
406 #if defined (__APPLE__)
407 # include <libkern/OSAtomic.h> /* OSMemoryBarrier() */
408 #endif
409 static inline void barrier (void)
410 {
411 #if defined (__GNUC__) && \
412             ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1))
413     __sync_synchronize ();
414 #elif defined(__APPLE__)
415     OSMemoryBarrier ();
416 #elif defined(__powerpc__)
417     asm volatile ("sync":::"memory");
418 #elif 0 // defined(__i386__) /*  Requires SSE2 support */
419     asm volatile ("mfence":::"memory");
420 #else
421     vlc_spinlock_t spin;
422     vlc_spin_init (&spin);
423     vlc_spin_lock (&spin);
424     vlc_spin_unlock (&spin);
425     vlc_spin_destroy (&spin);
426 #endif
427 }
428
429 /*****************************************************************************
430  * vlc_thread_create: create a thread
431  *****************************************************************************/
432 #define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, PRIORITY, WAIT )         \
433     __vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, FUNC, PRIORITY, WAIT )
434
435 /*****************************************************************************
436  * vlc_thread_set_priority: set the priority of the calling thread
437  *****************************************************************************/
438 #define vlc_thread_set_priority( P_THIS, PRIORITY )                         \
439     __vlc_thread_set_priority( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PRIORITY )
440
441 /*****************************************************************************
442  * vlc_thread_join: wait until a thread exits
443  *****************************************************************************/
444 #define vlc_thread_join( P_THIS )                                           \
445     __vlc_thread_join( VLC_OBJECT(P_THIS) )
446
447 #endif /* !_VLC_THREADS_H */