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