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