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