Implement thread semaphores
[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 #   include <semaphore.h>
52 #   include <time.h>
53
54 #endif
55
56 /*****************************************************************************
57  * Constants
58  *****************************************************************************/
59
60 /* Thread priorities */
61 #ifdef __APPLE__
62 #   define VLC_THREAD_PRIORITY_LOW      0
63 #   define VLC_THREAD_PRIORITY_INPUT   22
64 #   define VLC_THREAD_PRIORITY_AUDIO   22
65 #   define VLC_THREAD_PRIORITY_VIDEO    0
66 #   define VLC_THREAD_PRIORITY_OUTPUT  22
67 #   define VLC_THREAD_PRIORITY_HIGHEST 22
68
69 #elif defined(LIBVLC_USE_PTHREAD)
70 #   define VLC_THREAD_PRIORITY_LOW      0
71 #   define VLC_THREAD_PRIORITY_INPUT   10
72 #   define VLC_THREAD_PRIORITY_AUDIO    5
73 #   define VLC_THREAD_PRIORITY_VIDEO    0
74 #   define VLC_THREAD_PRIORITY_OUTPUT  15
75 #   define VLC_THREAD_PRIORITY_HIGHEST 20
76
77 #elif defined(WIN32) || defined(UNDER_CE)
78 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
79 #   define VLC_THREAD_PRIORITY_LOW 0
80 #   define VLC_THREAD_PRIORITY_INPUT \
81         THREAD_PRIORITY_ABOVE_NORMAL
82 #   define VLC_THREAD_PRIORITY_AUDIO \
83         THREAD_PRIORITY_HIGHEST
84 #   define VLC_THREAD_PRIORITY_VIDEO 0
85 #   define VLC_THREAD_PRIORITY_OUTPUT \
86         THREAD_PRIORITY_ABOVE_NORMAL
87 #   define VLC_THREAD_PRIORITY_HIGHEST \
88         THREAD_PRIORITY_TIME_CRITICAL
89
90 #else
91 #   define VLC_THREAD_PRIORITY_LOW 0
92 #   define VLC_THREAD_PRIORITY_INPUT 0
93 #   define VLC_THREAD_PRIORITY_AUDIO 0
94 #   define VLC_THREAD_PRIORITY_VIDEO 0
95 #   define VLC_THREAD_PRIORITY_OUTPUT 0
96 #   define VLC_THREAD_PRIORITY_HIGHEST 0
97
98 #endif
99
100 /*****************************************************************************
101  * Type definitions
102  *****************************************************************************/
103
104 #if defined (LIBVLC_USE_PTHREAD)
105 typedef pthread_t       vlc_thread_t;
106 typedef pthread_mutex_t vlc_mutex_t;
107 #define VLC_STATIC_MUTEX PTHREAD_MUTEX_INITIALIZER
108 typedef pthread_cond_t  vlc_cond_t;
109 typedef sem_t           vlc_sem_t;
110 typedef pthread_rwlock_t vlc_rwlock_t;
111 typedef pthread_key_t   vlc_threadvar_t;
112 typedef struct vlc_timer *vlc_timer_t;
113
114 #elif defined( WIN32 )
115 #if !defined( UNDER_CE )
116 typedef HANDLE vlc_thread_t;
117 #else
118 typedef struct
119 {
120     HANDLE handle;
121     HANDLE cancel_event;
122 } *vlc_thread_t;
123 #endif
124
125 typedef struct
126 {
127     LONG initialized;
128     CRITICAL_SECTION mutex;
129 } vlc_mutex_t;
130 #define VLC_STATIC_MUTEX { 0, }
131
132 typedef HANDLE  vlc_cond_t;
133 typedef HANDLE  vlc_sem_t;
134
135 typedef struct
136 {
137     vlc_mutex_t   mutex;
138     vlc_cond_t    read_wait;
139     vlc_cond_t    write_wait;
140     unsigned long readers;
141     unsigned long writers;
142     DWORD         writer;
143 } vlc_rwlock_t;
144
145 typedef DWORD   vlc_threadvar_t;
146 typedef struct vlc_timer *vlc_timer_t;
147 #endif
148
149 #if defined( WIN32 ) && !defined ETIMEDOUT
150 #  define ETIMEDOUT 10060 /* This is the value in winsock.h. */
151 #endif
152
153 /*****************************************************************************
154  * Function definitions
155  *****************************************************************************/
156 VLC_EXPORT( void, vlc_mutex_init,    ( vlc_mutex_t * ) );
157 VLC_EXPORT( void, vlc_mutex_init_recursive, ( vlc_mutex_t * ) );
158 VLC_EXPORT( void, vlc_mutex_destroy, ( vlc_mutex_t * ) );
159 VLC_EXPORT( void, vlc_mutex_lock, ( vlc_mutex_t * ) );
160 VLC_EXPORT( int,  vlc_mutex_trylock, ( vlc_mutex_t * ) LIBVLC_USED );
161 VLC_EXPORT( void, vlc_mutex_unlock, ( vlc_mutex_t * ) );
162 VLC_EXPORT( void, vlc_cond_init,     ( vlc_cond_t * ) );
163 VLC_EXPORT( void, vlc_cond_destroy,  ( vlc_cond_t * ) );
164 VLC_EXPORT( void, vlc_cond_signal, (vlc_cond_t *) );
165 VLC_EXPORT( void, vlc_cond_broadcast, (vlc_cond_t *) );
166 VLC_EXPORT( void, vlc_cond_wait, (vlc_cond_t *, vlc_mutex_t *) );
167 VLC_EXPORT( int,  vlc_cond_timedwait, (vlc_cond_t *, vlc_mutex_t *, mtime_t) );
168 VLC_EXPORT( void, vlc_sem_init, (vlc_sem_t *, unsigned) );
169 VLC_EXPORT( void, vlc_sem_destroy, (vlc_sem_t *) );
170 VLC_EXPORT( int,  vlc_sem_post, (vlc_sem_t *) );
171 VLC_EXPORT( void, vlc_sem_wait, (vlc_sem_t *) );
172
173 VLC_EXPORT( void, vlc_rwlock_init, (vlc_rwlock_t *) );
174 VLC_EXPORT( void, vlc_rwlock_destroy, (vlc_rwlock_t *) );
175 VLC_EXPORT( void, vlc_rwlock_rdlock, (vlc_rwlock_t *) );
176 VLC_EXPORT( void, vlc_rwlock_wrlock, (vlc_rwlock_t *) );
177 VLC_EXPORT( void, vlc_rwlock_unlock, (vlc_rwlock_t *) );
178 VLC_EXPORT( int, vlc_threadvar_create, (vlc_threadvar_t * , void (*) (void *) ) );
179 VLC_EXPORT( void, vlc_threadvar_delete, (vlc_threadvar_t *) );
180 VLC_EXPORT( int, vlc_threadvar_set, (vlc_threadvar_t, void *) );
181 VLC_EXPORT( void *, vlc_threadvar_get, (vlc_threadvar_t) );
182 VLC_EXPORT( int,  vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( vlc_object_t * ), int ) LIBVLC_USED );
183 VLC_EXPORT( int,  __vlc_thread_set_priority, ( vlc_object_t *, const char *, int, int ) );
184 VLC_EXPORT( void, __vlc_thread_join,   ( vlc_object_t * ) );
185
186 VLC_EXPORT( int, vlc_clone, (vlc_thread_t *, void * (*) (void *), void *, int) LIBVLC_USED );
187 VLC_EXPORT( void, vlc_cancel, (vlc_thread_t) );
188 VLC_EXPORT( void, vlc_join, (vlc_thread_t, void **) );
189 VLC_EXPORT (void, vlc_control_cancel, (int cmd, ...));
190
191 VLC_EXPORT( int, vlc_timer_create, (vlc_timer_t *, void (*) (void *), void *) LIBVLC_USED );
192 VLC_EXPORT( void, vlc_timer_destroy, (vlc_timer_t) );
193 VLC_EXPORT( void, vlc_timer_schedule, (vlc_timer_t, bool, mtime_t, mtime_t) );
194 VLC_EXPORT( unsigned, vlc_timer_getoverrun, (vlc_timer_t) LIBVLC_USED );
195
196 #ifndef LIBVLC_USE_PTHREAD_CANCEL
197 enum {
198     VLC_DO_CANCEL,
199     VLC_CLEANUP_PUSH,
200     VLC_CLEANUP_POP,
201 };
202 #endif
203
204 VLC_EXPORT( int, vlc_savecancel, (void) );
205 VLC_EXPORT( void, vlc_restorecancel, (int state) );
206 VLC_EXPORT( void, vlc_testcancel, (void) );
207
208 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
209 /**
210  * Registers a new procedure to run if the thread is cancelled (or otherwise
211  * exits prematurely). Any call to vlc_cleanup_push() <b>must</b> paired with a
212  * call to either vlc_cleanup_pop() or vlc_cleanup_run(). Branching into or out
213  * of the block between these two function calls is not allowed (read: it will
214  * likely crash the whole process). If multiple procedures are registered,
215  * they are handled in last-in first-out order.
216  *
217  * @param routine procedure to call if the thread ends
218  * @param arg argument for the procedure
219  */
220 # define vlc_cleanup_push( routine, arg ) pthread_cleanup_push (routine, arg)
221
222 /**
223  * Removes a cleanup procedure that was previously registered with
224  * vlc_cleanup_push().
225  */
226 # define vlc_cleanup_pop( ) pthread_cleanup_pop (0)
227
228 /**
229  * Removes a cleanup procedure that was previously registered with
230  * vlc_cleanup_push(), and executes it.
231  */
232 # define vlc_cleanup_run( ) pthread_cleanup_pop (1)
233 #else
234 typedef struct vlc_cleanup_t vlc_cleanup_t;
235
236 struct vlc_cleanup_t
237 {
238     vlc_cleanup_t *next;
239     void         (*proc) (void *);
240     void          *data;
241 };
242
243 /* This macros opens a code block on purpose. This is needed for multiple
244  * calls within a single function. This also prevent Win32 developers from
245  * writing code that would break on POSIX (POSIX opens a block as well). */
246 # define vlc_cleanup_push( routine, arg ) \
247     do { \
248         vlc_cleanup_t vlc_cleanup_data = { NULL, routine, arg, }; \
249         vlc_control_cancel (VLC_CLEANUP_PUSH, &vlc_cleanup_data)
250
251 # define vlc_cleanup_pop( ) \
252         vlc_control_cancel (VLC_CLEANUP_POP); \
253     } while (0)
254
255 # define vlc_cleanup_run( ) \
256         vlc_control_cancel (VLC_CLEANUP_POP); \
257         vlc_cleanup_data.proc (vlc_cleanup_data.data); \
258     } while (0)
259
260 #endif /* LIBVLC_USE_PTHREAD_CANCEL */
261
262 static inline void vlc_cleanup_lock (void *lock)
263 {
264     vlc_mutex_unlock ((vlc_mutex_t *)lock);
265 }
266 #define mutex_cleanup_push( lock ) vlc_cleanup_push (vlc_cleanup_lock, lock)
267
268 # if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0)
269 typedef pthread_spinlock_t vlc_spinlock_t;
270
271 /**
272  * Initializes a spinlock.
273  */
274 static inline void vlc_spin_init (vlc_spinlock_t *spin)
275 {
276     if (pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE))
277         abort ();
278 }
279
280 /**
281  * Acquires a spinlock.
282  */
283 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
284 {
285     pthread_spin_lock (spin);
286 }
287
288 /**
289  * Releases a spinlock.
290  */
291 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
292 {
293     pthread_spin_unlock (spin);
294 }
295
296 /**
297  * Deinitializes a spinlock.
298  */
299 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
300 {
301     pthread_spin_destroy (spin);
302 }
303
304 #elif defined (WIN32) && !defined (UNDER_CE)
305
306 typedef CRITICAL_SECTION vlc_spinlock_t;
307
308 /**
309  * Initializes a spinlock.
310  */
311 static inline void vlc_spin_init (vlc_spinlock_t *spin)
312 {
313     if (!InitializeCriticalSectionAndSpinCount(spin, 4000))
314         abort ();
315 }
316
317 /**
318  * Acquires a spinlock.
319  */
320 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
321 {
322     EnterCriticalSection(spin);
323 }
324
325 /**
326  * Releases a spinlock.
327  */
328 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
329 {
330     LeaveCriticalSection(spin);
331 }
332
333 /**
334  * Deinitializes a spinlock.
335  */
336 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
337 {
338     DeleteCriticalSection(spin);
339 }
340
341 #else
342
343 /* Fallback to plain mutexes if spinlocks are not available */
344 typedef vlc_mutex_t vlc_spinlock_t;
345
346 static inline void vlc_spin_init (vlc_spinlock_t *spin)
347 {
348     vlc_mutex_init (spin);
349 }
350
351 # define vlc_spin_lock    vlc_mutex_lock
352 # define vlc_spin_unlock  vlc_mutex_unlock
353 # define vlc_spin_destroy vlc_mutex_destroy
354 #endif
355
356 /**
357  * Issues a full memory barrier.
358  */
359 #if defined (__APPLE__)
360 # include <libkern/OSAtomic.h> /* OSMemoryBarrier() */
361 #endif
362 static inline void barrier (void)
363 {
364 #if defined (__GNUC__) && !defined (__APPLE__) && \
365             ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1))
366     __sync_synchronize ();
367 #elif defined(__APPLE__)
368     OSMemoryBarrier ();
369 #elif defined(__powerpc__)
370     asm volatile ("sync":::"memory");
371 #elif 0 // defined(__i386__) /*  Requires SSE2 support */
372     asm volatile ("mfence":::"memory");
373 #else
374     vlc_spinlock_t spin;
375     vlc_spin_init (&spin);
376     vlc_spin_lock (&spin);
377     vlc_spin_unlock (&spin);
378     vlc_spin_destroy (&spin);
379 #endif
380 }
381
382 /*****************************************************************************
383  * vlc_thread_create: create a thread
384  *****************************************************************************/
385 #define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, PRIORITY )         \
386     vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, FUNC, PRIORITY )
387
388 /*****************************************************************************
389  * vlc_thread_set_priority: set the priority of the calling thread
390  *****************************************************************************/
391 #define vlc_thread_set_priority( P_THIS, PRIORITY )                         \
392     __vlc_thread_set_priority( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PRIORITY )
393
394 /*****************************************************************************
395  * vlc_thread_join: wait until a thread exits
396  *****************************************************************************/
397 #define vlc_thread_join( P_THIS )                                           \
398     __vlc_thread_join( VLC_OBJECT(P_THIS) )
399
400 #ifdef __cplusplus
401 /**
402  * Helper C++ class to lock a mutex.
403  * The mutex is locked when the object is created, and unlocked when the object
404  * is destroyed.
405  */
406 class vlc_mutex_locker
407 {
408     private:
409         vlc_mutex_t *lock;
410     public:
411         vlc_mutex_locker (vlc_mutex_t *m) : lock (m)
412         {
413             vlc_mutex_lock (lock);
414         }
415
416         ~vlc_mutex_locker (void)
417         {
418             vlc_mutex_unlock (lock);
419         }
420 };
421 #endif
422
423 #endif /* !_VLC_THREADS_H */