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