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