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