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