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