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