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                                                                 /* WinCE API */
  39 #elif defined( WIN32 )
  40 #   include <process.h>                                         /* Win32 API */
  41 #   include <errno.h>
  42
  43 #elif defined( SYS_BEOS )                                            /* BeOS */
  44 #   include <kernel/OS.h>
  45 #   include <kernel/scheduler.h>
  46 #   include <byteorder.h>
  47
  48 #else                                         /* pthreads (like Linux & BSD) */
  49 #   define LIBVLC_USE_PTHREAD 1
  50 #   define _APPLE_C_SOURCE    1 /* Proper pthread semantics on OSX */
  51
  52 #   include <stdlib.h> /* lldiv_t definition (only in C99) */
  53 #   include <unistd.h> /* _POSIX_SPIN_LOCKS */
  54 #   include <pthread.h>
  55     /* Needed for pthread_cond_timedwait */
  56 #   include <errno.h>
  57 #   include <time.h>
  58
  59 #endif
  60
  61 /*****************************************************************************
  62  * Constants
  63  *****************************************************************************/
  64
  65 /* Thread priorities */
  66 #ifdef __APPLE__
  67 #   define VLC_THREAD_PRIORITY_LOW      0
  68 #   define VLC_THREAD_PRIORITY_INPUT   22
  69 #   define VLC_THREAD_PRIORITY_AUDIO   22
  70 #   define VLC_THREAD_PRIORITY_VIDEO    0
  71 #   define VLC_THREAD_PRIORITY_OUTPUT  22
  72 #   define VLC_THREAD_PRIORITY_HIGHEST 22
  73
  74 #elif defined(SYS_BEOS)
  75 #   define VLC_THREAD_PRIORITY_LOW 5
  76 #   define VLC_THREAD_PRIORITY_INPUT 10
  77 #   define VLC_THREAD_PRIORITY_AUDIO 10
  78 #   define VLC_THREAD_PRIORITY_VIDEO 5
  79 #   define VLC_THREAD_PRIORITY_OUTPUT 15
  80 #   define VLC_THREAD_PRIORITY_HIGHEST 15
  81
  82 #elif defined(LIBVLC_USE_PTHREAD)
  83 #   define VLC_THREAD_PRIORITY_LOW      0
  84 #   define VLC_THREAD_PRIORITY_INPUT   10
  85 #   define VLC_THREAD_PRIORITY_AUDIO    5
  86 #   define VLC_THREAD_PRIORITY_VIDEO    0
  87 #   define VLC_THREAD_PRIORITY_OUTPUT  15
  88 #   define VLC_THREAD_PRIORITY_HIGHEST 20
  89
  90 #elif defined(WIN32) || defined(UNDER_CE)
  91 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
  92 #   define VLC_THREAD_PRIORITY_LOW 0
  93 #   define VLC_THREAD_PRIORITY_INPUT \
  94         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
  95 #   define VLC_THREAD_PRIORITY_AUDIO \
  96         (IS_WINNT ? THREAD_PRIORITY_HIGHEST : 0)
  97 #   define VLC_THREAD_PRIORITY_VIDEO \
  98         (IS_WINNT ? 0 : THREAD_PRIORITY_BELOW_NORMAL )
  99 #   define VLC_THREAD_PRIORITY_OUTPUT \
 100         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
 101 #   define VLC_THREAD_PRIORITY_HIGHEST \
 102         (IS_WINNT ? THREAD_PRIORITY_TIME_CRITICAL : 0)
 103
 104 #else
 105 #   define VLC_THREAD_PRIORITY_LOW 0
 106 #   define VLC_THREAD_PRIORITY_INPUT 0
 107 #   define VLC_THREAD_PRIORITY_AUDIO 0
 108 #   define VLC_THREAD_PRIORITY_VIDEO 0
 109 #   define VLC_THREAD_PRIORITY_OUTPUT 0
 110 #   define VLC_THREAD_PRIORITY_HIGHEST 0
 111
 112 #endif
 113
 114 /*****************************************************************************
 115  * Type definitions
 116  *****************************************************************************/
 117
 118 #if defined (LIBVLC_USE_PTHREAD)
 119 typedef pthread_t       vlc_thread_t;
 120 typedef pthread_mutex_t vlc_mutex_t;
 121 typedef pthread_cond_t  vlc_cond_t;
 122 typedef pthread_key_t   vlc_threadvar_t;
 123
 124 #elif defined( WIN32 ) || defined( UNDER_CE )
 125 typedef struct
 126 {
 127     HANDLE handle;
 128     void  *(*entry) (void *);
 129     void  *data;
 130 } *vlc_thread_t;
 131
 132 typedef HANDLE  vlc_mutex_t;
 133 typedef HANDLE  vlc_cond_t;
 134 typedef DWORD   vlc_threadvar_t;
 135
 136 #elif defined( SYS_BEOS )
 137 /* This is the BeOS implementation of the vlc threads, note that the mutex is
 138  * not a real mutex and the cond_var is not like a pthread cond_var but it is
 139  * enough for what we need */
 140
 141 typedef thread_id vlc_thread_t;
 142
 143 typedef struct
 144 {
 145     int32_t         init;
 146     sem_id          lock;
 147 } vlc_mutex_t;
 148
 149 typedef struct
 150 {
 151     int32_t         init;
 152     thread_id       thread;
 153 } vlc_cond_t;
 154
 155 typedef struct
 156 {
 157 } vlc_threadvar_t;
 158
 159 #endif
 160
 161 #if defined( WIN32 ) && !defined ETIMEDOUT
 162 #  define ETIMEDOUT 10060 /* This is the value in winsock.h. */
 163 #endif
 164
 165 /*****************************************************************************
 166  * Function definitions
 167  *****************************************************************************/
 168 VLC_EXPORT( int,  vlc_mutex_init,    ( vlc_mutex_t * ) );
 169 VLC_EXPORT( int,  vlc_mutex_init_recursive, ( vlc_mutex_t * ) );
 170 VLC_EXPORT( void,  __vlc_mutex_destroy, ( const char *, int, vlc_mutex_t * ) );
 171 VLC_EXPORT( int,  __vlc_cond_init,     ( vlc_cond_t * ) );
 172 VLC_EXPORT( void,  __vlc_cond_destroy,  ( const char *, int, vlc_cond_t * ) );
 173 VLC_EXPORT( int, vlc_threadvar_create, (vlc_threadvar_t * , void (*) (void *) ) );
 174 VLC_EXPORT( void, vlc_threadvar_delete, (vlc_threadvar_t *) );
 175 VLC_EXPORT( int,  __vlc_thread_create, ( vlc_object_t *, const char *, int, const char *, void * ( * ) ( vlc_object_t * ), int, bool ) );
 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 *, const char *, int ) );
 178
 179 VLC_EXPORT( int, vlc_clone, (vlc_thread_t *, void * (*) (void *), void *, int) );
 180 VLC_EXPORT( void, vlc_cancel, (vlc_thread_t) );
 181 VLC_EXPORT( int, vlc_join, (vlc_thread_t, void **) );
 182
 183 #define vlc_thread_ready vlc_object_signal
 184
 185 /*****************************************************************************
 186  * vlc_mutex_lock: lock a mutex
 187  *****************************************************************************/
 188 #define vlc_mutex_lock( P_MUTEX )                                           \
 189     __vlc_mutex_lock( __FILE__, __LINE__, P_MUTEX )
 190
 191 VLC_EXPORT(void, vlc_pthread_fatal, (const char *action, int error, const char *file, unsigned line));
 192
 193 #if defined(LIBVLC_USE_PTHREAD)
 194 # define VLC_THREAD_ASSERT( action ) \
 195     if (val) \
 196         vlc_pthread_fatal (action, val, psz_file, i_line)
 197 #else
 198 # define VLC_THREAD_ASSERT ((void)(val))
 199 #endif
 200
 201 static inline void __vlc_mutex_lock( const char * psz_file, int i_line,
 202                                     vlc_mutex_t * p_mutex )
 203 {
 204 #if defined(LIBVLC_USE_PTHREAD)
 205 #   define vlc_assert_locked( m ) \
 206            assert (pthread_mutex_lock (m) == EDEADLK)
 207     int val = pthread_mutex_lock( p_mutex );
 208     VLC_THREAD_ASSERT ("locking mutex");
 209
 210 #elif defined( UNDER_CE )
 211     (void)psz_file; (void)i_line;
 212
 213     EnterCriticalSection( &p_mutex->csection );
 214
 215 #elif defined( WIN32 )
 216     (void)psz_file; (void)i_line;
 217
 218     WaitForSingleObject( *p_mutex, INFINITE );
 219
 220 #elif defined( SYS_BEOS )
 221     acquire_sem( p_mutex->lock );
 222
 223 #endif
 224 }
 225
 226 #ifndef vlc_assert_locked
 227 # define vlc_assert_locked( m ) (void)m
 228 #endif
 229
 230 /*****************************************************************************
 231  * vlc_mutex_unlock: unlock a mutex
 232  *****************************************************************************/
 233 #define vlc_mutex_unlock( P_MUTEX )                                         \
 234     __vlc_mutex_unlock( __FILE__, __LINE__, P_MUTEX )
 235
 236 static inline void __vlc_mutex_unlock( const char * psz_file, int i_line,
 237                                       vlc_mutex_t *p_mutex )
 238 {
 239 #if defined(LIBVLC_USE_PTHREAD)
 240     int val = pthread_mutex_unlock( p_mutex );
 241     VLC_THREAD_ASSERT ("unlocking mutex");
 242
 243 #elif defined( UNDER_CE )
 244     (void)psz_file; (void)i_line;
 245
 246     LeaveCriticalSection( &p_mutex->csection );
 247
 248 #elif defined( WIN32 )
 249     (void)psz_file; (void)i_line;
 250
 251     ReleaseMutex( *p_mutex );
 252
 253 #elif defined( SYS_BEOS )
 254     release_sem( p_mutex->lock );
 255
 256 #endif
 257 }
 258
 259 /*****************************************************************************
 260  * vlc_mutex_destroy: destroy a mutex
 261  *****************************************************************************/
 262 #define vlc_mutex_destroy( P_MUTEX )                                        \
 263     __vlc_mutex_destroy( __FILE__, __LINE__, P_MUTEX )
 264
 265 /*****************************************************************************
 266  * vlc_cond_init: initialize a condition
 267  *****************************************************************************/
 268 #define vlc_cond_init( P_THIS, P_COND )                                     \
 269     __vlc_cond_init( P_COND )
 270
 271 /*****************************************************************************
 272  * vlc_cond_signal: start a thread on condition completion
 273  *****************************************************************************/
 274 #define vlc_cond_signal( P_COND )                                           \
 275     __vlc_cond_signal( __FILE__, __LINE__, P_COND )
 276
 277 static inline void __vlc_cond_signal( const char * psz_file, int i_line,
 278                                       vlc_cond_t *p_condvar )
 279 {
 280 #if defined(LIBVLC_USE_PTHREAD)
 281     int val = pthread_cond_signal( p_condvar );
 282     VLC_THREAD_ASSERT ("signaling condition variable");
 283
 284 #elif defined( UNDER_CE ) || defined( WIN32 )
 285     (void)psz_file; (void)i_line;
 286
 287     /* Release one waiting thread if one is available. */
 288     /* For this trick to work properly, the vlc_cond_signal must be surrounded
 289      * by a mutex. This will prevent another thread from stealing the signal */
 290     /* PulseEvent() only works if none of the waiting threads is suspended.
 291      * This is particularily problematic under a debug session.
 292      * as documented in http://support.microsoft.com/kb/q173260/ */
 293     PulseEvent( *p_condvar );
 294
 295 #elif defined( SYS_BEOS )
 296     while( p_condvar->thread != -1 )
 297     {
 298         thread_info info;
 299         if( get_thread_info(p_condvar->thread, &info) == B_BAD_VALUE )
 300             return;
 301
 302         if( info.state != B_THREAD_SUSPENDED )
 303         {
 304             /* The  waiting thread is not suspended so it could
 305              * have been interrupted beetwen the unlock and the
 306              * suspend_thread line. That is why we sleep a little
 307              * before retesting p_condver->thread. */
 308             snooze( 10000 );
 309         }
 310         else
 311         {
 312             /* Ok, we have to wake up that thread */
 313             resume_thread( p_condvar->thread );
 314         }
 315     }
 316
 317 #endif
 318 }
 319
 320 /*****************************************************************************
 321  * vlc_cond_wait: wait until condition completion
 322  *****************************************************************************/
 323 #define vlc_cond_wait( P_COND, P_MUTEX )                                     \
 324     __vlc_cond_wait( __FILE__, __LINE__, P_COND, P_MUTEX  )
 325
 326 static inline void __vlc_cond_wait( const char * psz_file, int i_line,
 327                                     vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex )
 328 {
 329 #if defined(LIBVLC_USE_PTHREAD)
 330     int val = pthread_cond_wait( p_condvar, p_mutex );
 331     VLC_THREAD_ASSERT ("waiting on condition");
 332
 333 #elif defined( UNDER_CE )
 334     LeaveCriticalSection( &p_mutex->csection );
 335     WaitForSingleObject( *p_condvar, INFINITE );
 336
 337     /* Reacquire the mutex before returning. */
 338     vlc_mutex_lock( p_mutex );
 339
 340 #elif defined( WIN32 )
 341     (void)psz_file; (void)i_line;
 342
 343     /* Increase our wait count */
 344     SignalObjectAndWait( *p_mutex, *p_condvar, INFINITE, FALSE );
 345
 346     /* Reacquire the mutex before returning. */
 347     vlc_mutex_lock( p_mutex );
 348
 349 #elif defined( SYS_BEOS )
 350     /* The p_condvar->thread var is initialized before the unlock because
 351      * it enables to identify when the thread is interrupted beetwen the
 352      * unlock line and the suspend_thread line */
 353     p_condvar->thread = find_thread( NULL );
 354     vlc_mutex_unlock( p_mutex );
 355     suspend_thread( p_condvar->thread );
 356     p_condvar->thread = -1;
 357
 358     vlc_mutex_lock( p_mutex );
 359
 360 #endif
 361 }
 362
 363
 364 /*****************************************************************************
 365  * vlc_cond_timedwait: wait until condition completion or expiration
 366  *****************************************************************************
 367  * Returns 0 if object signaled, an error code in case of timeout or error.
 368  *****************************************************************************/
 369 #define vlc_cond_timedwait( P_COND, P_MUTEX, DEADLINE )                      \
 370     __vlc_cond_timedwait( __FILE__, __LINE__, P_COND, P_MUTEX, DEADLINE  )
 371
 372 static inline int __vlc_cond_timedwait( const char * psz_file, int i_line,
 373                                         vlc_cond_t *p_condvar,
 374                                         vlc_mutex_t *p_mutex,
 375                                         mtime_t deadline )
 376 {
 377 #if defined(LIBVLC_USE_PTHREAD)
 378     lldiv_t d = lldiv( deadline, 1000000 );
 379     struct timespec ts = { d.quot, d.rem * 1000 };
 380
 381     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
 382     if (val == ETIMEDOUT)
 383         return ETIMEDOUT; /* this error is perfectly normal */
 384     VLC_THREAD_ASSERT ("timed-waiting on condition");
 385
 386 #elif defined( UNDER_CE )
 387     mtime_t delay_ms = (deadline - mdate())/1000;
 388     DWORD result;
 389     if( delay_ms < 0 )
 390         delay_ms = 0;
 391
 392     LeaveCriticalSection( &p_mutex->csection );
 393     result = WaitForSingleObject( *p_condvar, delay_ms );
 394
 395     /* Reacquire the mutex before returning. */
 396     vlc_mutex_lock( p_mutex );
 397
 398     if(result == WAIT_TIMEOUT)
 399        return ETIMEDOUT; /* this error is perfectly normal */
 400
 401     (void)psz_file; (void)i_line;
 402
 403 #elif defined( WIN32 )
 404     mtime_t total = (deadline - mdate())/1000;
 405     DWORD result;
 406     if( total < 0 )
 407         total = 0;
 408
 409     do
 410     {
 411         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
 412         result = SignalObjectAndWait( *p_mutex, *p_condvar,
 413                                       delay, FALSE );
 414         total -= delay;
 415         vlc_mutex_lock (p_mutex);
 416     }
 417     while (total);
 418
 419     /* Reacquire the mutex before returning. */
 420     if(result == WAIT_TIMEOUT)
 421        return ETIMEDOUT; /* this error is perfectly normal */
 422
 423     (void)psz_file; (void)i_line;
 424
 425 #elif defined( SYS_BEOS )
 426 #   error Unimplemented
 427
 428 #endif
 429
 430     return 0;
 431 }
 432
 433 /*****************************************************************************
 434  * vlc_cond_destroy: destroy a condition
 435  *****************************************************************************/
 436 #define vlc_cond_destroy( P_COND )                                          \
 437     __vlc_cond_destroy( __FILE__, __LINE__, P_COND )
 438
 439 /*****************************************************************************
 440  * vlc_threadvar_set: create: set the value of a thread-local variable
 441  *****************************************************************************/
 442 static inline int vlc_threadvar_set( vlc_threadvar_t * p_tls, void *p_value )
 443 {
 444     int i_ret;
 445
 446 #if defined(LIBVLC_USE_PTHREAD)
 447     i_ret = pthread_setspecific( *p_tls, p_value );
 448
 449 #elif defined( SYS_BEOS )
 450     i_ret = EINVAL;
 451
 452 #elif defined( UNDER_CE ) || defined( WIN32 )
 453     i_ret = TlsSetValue( *p_tls, p_value ) ? EINVAL : 0;
 454
 455 #endif
 456
 457     return i_ret;
 458 }
 459
 460 /*****************************************************************************
 461  * vlc_threadvar_get: create: get the value of a thread-local variable
 462  *****************************************************************************/
 463 static inline void* vlc_threadvar_get( vlc_threadvar_t * p_tls )
 464 {
 465     void *p_ret;
 466
 467 #if defined(LIBVLC_USE_PTHREAD)
 468     p_ret = pthread_getspecific( *p_tls );
 469
 470 #elif defined( SYS_BEOS )
 471     p_ret = NULL;
 472
 473 #elif defined( UNDER_CE ) || defined( WIN32 )
 474     p_ret = TlsGetValue( *p_tls );
 475
 476 #endif
 477
 478     return p_ret;
 479 }
 480
 481 # if defined (_POSIX_SPIN_LOCKS) && ((_POSIX_SPIN_LOCKS - 0) > 0)
 482 typedef pthread_spinlock_t vlc_spinlock_t;
 483
 484 /**
 485  * Initializes a spinlock.
 486  */
 487 static inline int vlc_spin_init (vlc_spinlock_t *spin)
 488 {
 489     return pthread_spin_init (spin, PTHREAD_PROCESS_PRIVATE);
 490 }
 491
 492 /**
 493  * Acquires a spinlock.
 494  */
 495 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
 496 {
 497     pthread_spin_lock (spin);
 498 }
 499
 500 /**
 501  * Releases a spinlock.
 502  */
 503 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
 504 {
 505     pthread_spin_unlock (spin);
 506 }
 507
 508 /**
 509  * Deinitializes a spinlock.
 510  */
 511 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
 512 {
 513     pthread_spin_destroy (spin);
 514 }
 515
 516 #elif defined( WIN32 )
 517
 518 typedef CRITICAL_SECTION vlc_spinlock_t;
 519
 520 /**
 521  * Initializes a spinlock.
 522  */
 523 static inline int vlc_spin_init (vlc_spinlock_t *spin)
 524 {
 525     return !InitializeCriticalSectionAndSpinCount(spin, 4000);
 526 }
 527
 528 /**
 529  * Acquires a spinlock.
 530  */
 531 static inline void vlc_spin_lock (vlc_spinlock_t *spin)
 532 {
 533     EnterCriticalSection(spin);
 534 }
 535
 536 /**
 537  * Releases a spinlock.
 538  */
 539 static inline void vlc_spin_unlock (vlc_spinlock_t *spin)
 540 {
 541     LeaveCriticalSection(spin);
 542 }
 543
 544 /**
 545  * Deinitializes a spinlock.
 546  */
 547 static inline void vlc_spin_destroy (vlc_spinlock_t *spin)
 548 {
 549     DeleteCriticalSection(spin);
 550 }
 551
 552 #else
 553
 554 /* Fallback to plain mutexes if spinlocks are not available */
 555 typedef vlc_mutex_t vlc_spinlock_t;
 556
 557 static inline int vlc_spin_init (vlc_spinlock_t *spin)
 558 {
 559     return vlc_mutex_init (spin);
 560 }
 561
 562 # define vlc_spin_lock    vlc_mutex_lock
 563 # define vlc_spin_unlock  vlc_mutex_unlock
 564 # define vlc_spin_destroy vlc_mutex_destroy
 565 #endif
 566
 567 /**
 568  * Issues a full memory barrier.
 569  */
 570 #if defined (__APPLE__)
 571 # include <libkern/OSAtomic.h> /* OSMemoryBarrier() */
 572 #endif
 573 static inline void barrier (void)
 574 {
 575 #if defined (__GNUC__) && (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1)
 576     __sync_synchronize ();
 577 #elif defined(__APPLE__)
 578     OSMemoryBarrier ();
 579 #elif defined(__powerpc__)
 580     asm volatile ("sync":::"memory");
 581 #elif defined(__i386__)
 582     asm volatile ("mfence":::"memory");
 583 #else
 584     vlc_spinlock_t spin;
 585     vlc_spin_init (&spin);
 586     vlc_spin_lock (&spin);
 587     vlc_spin_unlock (&spin);
 588     vlc_spin_destroy (&spin);
 589 #endif
 590 }
 591
 592 /**
 593  * Save the cancellation state and disable cancellation for the calling thread.
 594  * This function must be called before entering a piece of code that is not
 595  * cancellation-safe.
 596  * @param p_state storage for the previous cancellation state
 597  * @return Nothing, always succeeds.
 598  */
 599 static inline void vlc_savecancel (int *p_state)
 600 {
 601 #if defined (LIBVLC_USE_PTHREAD)
 602     (void) pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, p_state);
 603 #endif
 604 }
 605
 606 /**
 607  * Restore the cancellation state for the calling thread.
 608  * @param state previous state as returned by vlc_savecancel().
 609  * @return Nothing, always succeeds.
 610  */
 611 static inline void vlc_restorecancel (int state)
 612 {
 613 #if defined (LIBVLC_USE_PTHREAD)
 614     (void) pthread_setcancelstate (state, NULL);
 615 #endif
 616 }
 617
 618 /**
 619  * Issues an explicit deferred cancellation point.
 620  * This has no effect if thread cancellation is disabled.
 621  * This can be called when there is a rather slow non-sleeping operation.
 622  */
 623 static inline void vlc_testcancel (void)
 624 {
 625 #if defined (LIBVLC_USE_PTHREAD)
 626     pthread_testcancel ();
 627 #endif
 628 }
 629
 630 /*****************************************************************************
 631  * vlc_thread_create: create a thread
 632  *****************************************************************************/
 633 #define vlc_thread_create( P_THIS, PSZ_NAME, FUNC, PRIORITY, WAIT )         \
 634     __vlc_thread_create( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PSZ_NAME, FUNC, PRIORITY, WAIT )
 635
 636 /*****************************************************************************
 637  * vlc_thread_set_priority: set the priority of the calling thread
 638  *****************************************************************************/
 639 #define vlc_thread_set_priority( P_THIS, PRIORITY )                         \
 640     __vlc_thread_set_priority( VLC_OBJECT(P_THIS), __FILE__, __LINE__, PRIORITY )
 641
 642 /*****************************************************************************
 643  * vlc_thread_join: wait until a thread exits
 644  *****************************************************************************/
 645 #define vlc_thread_join( P_THIS )                                           \
 646     __vlc_thread_join( VLC_OBJECT(P_THIS), __FILE__, __LINE__ )
 647
 648 #endif /* !_VLC_THREADS_H */