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