git.sesse.net Git - vlc/blob - src/misc/pthread.c

   1 /*****************************************************************************
   2  * pthread.c : pthread back-end for LibVLC
   3  *****************************************************************************
   4  * Copyright (C) 1999-2009 the VideoLAN team
   5  *
   6  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
   7  *          Samuel Hocevar <sam@zoy.org>
   8  *          Gildas Bazin <gbazin@netcourrier.com>
   9  *          Clément Sténac
  10  *          Rémi Denis-Courmont
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32
  33 #include "libvlc.h"
  34 #include <stdarg.h>
  35 #include <assert.h>
  36 #include <unistd.h> /* fsync() */
  37 #include <signal.h>
  38 #include <errno.h>
  39
  40 #include <sched.h>
  41 #ifdef __linux__
  42 # include <sys/syscall.h> /* SYS_gettid */
  43 #endif
  44
  45 #ifdef HAVE_EXECINFO_H
  46 # include <execinfo.h>
  47 #endif
  48
  49 #ifdef __APPLE__
  50 # include <sys/time.h> /* gettimeofday in vlc_cond_timedwait */
  51 #endif
  52
  53 /**
  54  * Print a backtrace to the standard error for debugging purpose.
  55  */
  56 void vlc_trace (const char *fn, const char *file, unsigned line)
  57 {
  58      fprintf (stderr, "at %s:%u in %s\n", file, line, fn);
  59      fflush (stderr); /* needed before switch to low-level I/O */
  60 #ifdef HAVE_BACKTRACE
  61      void *stack[20];
  62      int len = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
  63      backtrace_symbols_fd (stack, len, 2);
  64 #endif
  65      fsync (2);
  66 }
  67
  68 static inline unsigned long vlc_threadid (void)
  69 {
  70 #if defined (__linux__)
  71      /* glibc does not provide a call for this */
  72      return syscall (SYS_gettid);
  73
  74 #else
  75      union { pthread_t th; unsigned long int i; } v = { };
  76      v.th = pthread_self ();
  77      return v.i;
  78
  79 #endif
  80 }
  81
  82 #ifndef NDEBUG
  83 /*****************************************************************************
  84  * vlc_thread_fatal: Report an error from the threading layer
  85  *****************************************************************************
  86  * This is mostly meant for debugging.
  87  *****************************************************************************/
  88 static void
  89 vlc_thread_fatal (const char *action, int error,
  90                   const char *function, const char *file, unsigned line)
  91 {
  92     int canc = vlc_savecancel ();
  93     fprintf (stderr, "LibVLC fatal error %s (%d) in thread %lu ",
  94              action, error, vlc_threadid ());
  95     vlc_trace (function, file, line);
  96
  97     /* Sometimes strerror_r() crashes too, so make sure we print an error
  98      * message before we invoke it */
  99 #ifdef __GLIBC__
 100     /* Avoid the strerror_r() prototype brain damage in glibc */
 101     errno = error;
 102     fprintf (stderr, " Error message: %m\n");
 103 #else
 104     char buf[1000];
 105     const char *msg;
 106
 107     switch (strerror_r (error, buf, sizeof (buf)))
 108     {
 109         case 0:
 110             msg = buf;
 111             break;
 112         case ERANGE: /* should never happen */
 113             msg = "unknwon (too big to display)";
 114             break;
 115         default:
 116             msg = "unknown (invalid error number)";
 117             break;
 118     }
 119     fprintf (stderr, " Error message: %s\n", msg);
 120 #endif
 121     fflush (stderr);
 122
 123     vlc_restorecancel (canc);
 124     abort ();
 125 }
 126
 127 # define VLC_THREAD_ASSERT( action ) \
 128     if (unlikely(val)) \
 129         vlc_thread_fatal (action, val, __func__, __FILE__, __LINE__)
 130 #else
 131 # define VLC_THREAD_ASSERT( action ) ((void)val)
 132 #endif
 133
 134 #if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 135 /* This is not prototyped under glibc, though it exists. */
 136 int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
 137 #endif
 138
 139 /*****************************************************************************
 140  * vlc_mutex_init: initialize a mutex
 141  *****************************************************************************/
 142 void vlc_mutex_init( vlc_mutex_t *p_mutex )
 143 {
 144     pthread_mutexattr_t attr;
 145
 146     if (unlikely(pthread_mutexattr_init (&attr)))
 147         abort();
 148 #ifdef NDEBUG
 149     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_NORMAL );
 150 #else
 151     /* Create error-checking mutex to detect problems more easily. */
 152 # if defined (__GLIBC__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ < 6)
 153     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP );
 154 # else
 155     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK );
 156 # endif
 157 #endif
 158     if (unlikely(pthread_mutex_init (p_mutex, &attr)))
 159         abort();
 160     pthread_mutexattr_destroy( &attr );
 161 }
 162
 163 /*****************************************************************************
 164  * vlc_mutex_init: initialize a recursive mutex (Do not use)
 165  *****************************************************************************/
 166 void vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
 167 {
 168     pthread_mutexattr_t attr;
 169
 170     if (unlikely(pthread_mutexattr_init (&attr)))
 171         abort();
 172 #if defined (__GLIBC__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ < 6)
 173     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_RECURSIVE_NP );
 174 #else
 175     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
 176 #endif
 177     if (unlikely(pthread_mutex_init (p_mutex, &attr)))
 178         abort();
 179     pthread_mutexattr_destroy( &attr );
 180 }
 181
 182
 183 /**
 184  * Destroys a mutex. The mutex must not be locked.
 185  *
 186  * @param p_mutex mutex to destroy
 187  * @return always succeeds
 188  */
 189 void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
 190 {
 191     int val = pthread_mutex_destroy( p_mutex );
 192     VLC_THREAD_ASSERT ("destroying mutex");
 193 }
 194
 195 #ifndef NDEBUG
 196 # ifdef HAVE_VALGRIND_VALGRIND_H
 197 #  include <valgrind/valgrind.h>
 198 # else
 199 #  define RUNNING_ON_VALGRIND (0)
 200 # endif
 201
 202 void vlc_assert_locked (vlc_mutex_t *p_mutex)
 203 {
 204     if (RUNNING_ON_VALGRIND > 0)
 205         return;
 206     assert (pthread_mutex_lock (p_mutex) == EDEADLK);
 207 }
 208 #endif
 209
 210 /**
 211  * Acquires a mutex. If needed, waits for any other thread to release it.
 212  * Beware of deadlocks when locking multiple mutexes at the same time,
 213  * or when using mutexes from callbacks.
 214  * This function is not a cancellation-point.
 215  *
 216  * @param p_mutex mutex initialized with vlc_mutex_init() or
 217  *                vlc_mutex_init_recursive()
 218  */
 219 void vlc_mutex_lock (vlc_mutex_t *p_mutex)
 220 {
 221     int val = pthread_mutex_lock( p_mutex );
 222     VLC_THREAD_ASSERT ("locking mutex");
 223 }
 224
 225 /**
 226  * Acquires a mutex if and only if it is not currently held by another thread.
 227  * This function never sleeps and can be used in delay-critical code paths.
 228  * This function is not a cancellation-point.
 229  *
 230  * <b>Beware</b>: If this function fails, then the mutex is held... by another
 231  * thread. The calling thread must deal with the error appropriately. That
 232  * typically implies postponing the operations that would have required the
 233  * mutex. If the thread cannot defer those operations, then it must use
 234  * vlc_mutex_lock(). If in doubt, use vlc_mutex_lock() instead.
 235  *
 236  * @param p_mutex mutex initialized with vlc_mutex_init() or
 237  *                vlc_mutex_init_recursive()
 238  * @return 0 if the mutex could be acquired, an error code otherwise.
 239  */
 240 int vlc_mutex_trylock (vlc_mutex_t *p_mutex)
 241 {
 242     int val = pthread_mutex_trylock( p_mutex );
 243
 244     if (val != EBUSY)
 245         VLC_THREAD_ASSERT ("locking mutex");
 246     return val;
 247 }
 248
 249 /**
 250  * Releases a mutex (or crashes if the mutex is not locked by the caller).
 251  * @param p_mutex mutex locked with vlc_mutex_lock().
 252  */
 253 void vlc_mutex_unlock (vlc_mutex_t *p_mutex)
 254 {
 255     int val = pthread_mutex_unlock( p_mutex );
 256     VLC_THREAD_ASSERT ("unlocking mutex");
 257 }
 258
 259 /*****************************************************************************
 260  * vlc_cond_init: initialize a condition variable
 261  *****************************************************************************/
 262 void vlc_cond_init( vlc_cond_t *p_condvar )
 263 {
 264     pthread_condattr_t attr;
 265
 266     if (unlikely(pthread_condattr_init (&attr)))
 267         abort ();
 268 #if !defined (_POSIX_CLOCK_SELECTION)
 269    /* Fairly outdated POSIX support (that was defined in 2001) */
 270 # define _POSIX_CLOCK_SELECTION (-1)
 271 #endif
 272 #if (_POSIX_CLOCK_SELECTION >= 0)
 273     /* NOTE: This must be the same clock as the one in mtime.c */
 274     pthread_condattr_setclock (&attr, CLOCK_MONOTONIC);
 275 #endif
 276
 277     if (unlikely(pthread_cond_init (p_condvar, &attr)))
 278         abort ();
 279     pthread_condattr_destroy (&attr);
 280 }
 281
 282 /**
 283  * Destroys a condition variable. No threads shall be waiting or signaling the
 284  * condition.
 285  * @param p_condvar condition variable to destroy
 286  */
 287 void vlc_cond_destroy (vlc_cond_t *p_condvar)
 288 {
 289     int val = pthread_cond_destroy( p_condvar );
 290     VLC_THREAD_ASSERT ("destroying condition");
 291 }
 292
 293 /**
 294  * Wakes up one thread waiting on a condition variable, if any.
 295  * @param p_condvar condition variable
 296  */
 297 void vlc_cond_signal (vlc_cond_t *p_condvar)
 298 {
 299     int val = pthread_cond_signal( p_condvar );
 300     VLC_THREAD_ASSERT ("signaling condition variable");
 301 }
 302
 303 /**
 304  * Wakes up all threads (if any) waiting on a condition variable.
 305  * @param p_cond condition variable
 306  */
 307 void vlc_cond_broadcast (vlc_cond_t *p_condvar)
 308 {
 309     pthread_cond_broadcast (p_condvar);
 310 }
 311
 312 /**
 313  * Waits for a condition variable. The calling thread will be suspended until
 314  * another thread calls vlc_cond_signal() or vlc_cond_broadcast() on the same
 315  * condition variable, the thread is cancelled with vlc_cancel(), or the
 316  * system causes a "spurious" unsolicited wake-up.
 317  *
 318  * A mutex is needed to wait on a condition variable. It must <b>not</b> be
 319  * a recursive mutex. Although it is possible to use the same mutex for
 320  * multiple condition, it is not valid to use different mutexes for the same
 321  * condition variable at the same time from different threads.
 322  *
 323  * In case of thread cancellation, the mutex is always locked before
 324  * cancellation proceeds.
 325  *
 326  * The canonical way to use a condition variable to wait for event foobar is:
 327  @code
 328    vlc_mutex_lock (&lock);
 329    mutex_cleanup_push (&lock); // release the mutex in case of cancellation
 330
 331    while (!foobar)
 332        vlc_cond_wait (&wait, &lock);
 333
 334    --- foobar is now true, do something about it here --
 335
 336    vlc_cleanup_run (); // release the mutex
 337   @endcode
 338  *
 339  * @param p_condvar condition variable to wait on
 340  * @param p_mutex mutex which is unlocked while waiting,
 341  *                then locked again when waking up.
 342  * @param deadline <b>absolute</b> timeout
 343  *
 344  * @return 0 if the condition was signaled, an error code in case of timeout.
 345  */
 346 void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
 347 {
 348     int val = pthread_cond_wait( p_condvar, p_mutex );
 349     VLC_THREAD_ASSERT ("waiting on condition");
 350 }
 351
 352 /**
 353  * Waits for a condition variable up to a certain date.
 354  * This works like vlc_cond_wait(), except for the additional timeout.
 355  *
 356  * @param p_condvar condition variable to wait on
 357  * @param p_mutex mutex which is unlocked while waiting,
 358  *                then locked again when waking up.
 359  * @param deadline <b>absolute</b> timeout
 360  *
 361  * @return 0 if the condition was signaled, an error code in case of timeout.
 362  */
 363 int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
 364                         mtime_t deadline)
 365 {
 366 #if defined(__APPLE__) && !defined(__powerpc__) && !defined( __ppc__ ) && !defined( __ppc64__ )
 367     /* mdate() is mac_absolute_time on OSX, which we must convert to do
 368      * the same base than gettimeofday() which pthread_cond_timedwait
 369      * relies on. */
 370     mtime_t oldbase = mdate();
 371     struct timeval tv;
 372     gettimeofday(&tv, NULL);
 373     mtime_t newbase = (mtime_t)tv.tv_sec * 1000000 + (mtime_t) tv.tv_usec;
 374     deadline = deadline - oldbase + newbase;
 375 #endif
 376     lldiv_t d = lldiv( deadline, CLOCK_FREQ );
 377     struct timespec ts = { d.quot, d.rem * (1000000000 / CLOCK_FREQ) };
 378
 379     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
 380     if (val != ETIMEDOUT)
 381         VLC_THREAD_ASSERT ("timed-waiting on condition");
 382     return val;
 383 }
 384
 385 /**
 386  * Initializes a semaphore.
 387  */
 388 void vlc_sem_init (vlc_sem_t *sem, unsigned value)
 389 {
 390     if (unlikely(sem_init (sem, 0, value)))
 391         abort ();
 392 }
 393
 394 /**
 395  * Destroys a semaphore.
 396  */
 397 void vlc_sem_destroy (vlc_sem_t *sem)
 398 {
 399     int val = sem_destroy (sem);
 400     VLC_THREAD_ASSERT ("destroying semaphore");
 401 }
 402
 403 /**
 404  * Increments the value of a semaphore.
 405  */
 406 int vlc_sem_post (vlc_sem_t *sem)
 407 {
 408     int val = sem_post (sem);
 409     if (val != EOVERFLOW)
 410         VLC_THREAD_ASSERT ("unlocking semaphore");
 411     return val;
 412 }
 413
 414 /**
 415  * Atomically wait for the semaphore to become non-zero (if needed),
 416  * then decrements it.
 417  */
 418 void vlc_sem_wait (vlc_sem_t *sem)
 419 {
 420     int val;
 421     do
 422         val = sem_wait (sem);
 423     while (val == EINTR);
 424     VLC_THREAD_ASSERT ("locking semaphore");
 425 }
 426
 427 /**
 428  * Initializes a read/write lock.
 429  */
 430 void vlc_rwlock_init (vlc_rwlock_t *lock)
 431 {
 432     if (unlikely(pthread_rwlock_init (lock, NULL)))
 433         abort ();
 434 }
 435
 436 /**
 437  * Destroys an initialized unused read/write lock.
 438  */
 439 void vlc_rwlock_destroy (vlc_rwlock_t *lock)
 440 {
 441     int val = pthread_rwlock_destroy (lock);
 442     VLC_THREAD_ASSERT ("destroying R/W lock");
 443 }
 444
 445 /**
 446  * Acquires a read/write lock for reading. Recursion is allowed.
 447  */
 448 void vlc_rwlock_rdlock (vlc_rwlock_t *lock)
 449 {
 450     int val = pthread_rwlock_rdlock (lock);
 451     VLC_THREAD_ASSERT ("acquiring R/W lock for reading");
 452 }
 453
 454 /**
 455  * Acquires a read/write lock for writing. Recursion is not allowed.
 456  */
 457 void vlc_rwlock_wrlock (vlc_rwlock_t *lock)
 458 {
 459     int val = pthread_rwlock_wrlock (lock);
 460     VLC_THREAD_ASSERT ("acquiring R/W lock for writing");
 461 }
 462
 463 /**
 464  * Releases a read/write lock.
 465  */
 466 void vlc_rwlock_unlock (vlc_rwlock_t *lock)
 467 {
 468     int val = pthread_rwlock_unlock (lock);
 469     VLC_THREAD_ASSERT ("releasing R/W lock");
 470 }
 471
 472 /**
 473  * Allocates a thread-specific variable.
 474  * @param key where to store the thread-specific variable handle
 475  * @param destr a destruction callback. It is called whenever a thread exits
 476  * and the thread-specific variable has a non-NULL value.
 477  * @return 0 on success, a system error code otherwise. This function can
 478  * actually fail because there is a fixed limit on the number of
 479  * thread-specific variable in a process on most systems.
 480  */
 481 int vlc_threadvar_create (vlc_threadvar_t *key, void (*destr) (void *))
 482 {
 483     return pthread_key_create (key, destr);
 484 }
 485
 486 void vlc_threadvar_delete (vlc_threadvar_t *p_tls)
 487 {
 488     pthread_key_delete (*p_tls);
 489 }
 490
 491 /**
 492  * Sets a thread-specific variable.
 493  * @param key thread-local variable key (created with vlc_threadvar_create())
 494  * @param value new value for the variable for the calling thread
 495  * @return 0 on success, a system error code otherwise.
 496  */
 497 int vlc_threadvar_set (vlc_threadvar_t key, void *value)
 498 {
 499     return pthread_setspecific (key, value);
 500 }
 501
 502 /**
 503  * Gets the value of a thread-local variable for the calling thread.
 504  * This function cannot fail.
 505  * @return the value associated with the given variable for the calling
 506  * or NULL if there is no value.
 507  */
 508 void *vlc_threadvar_get (vlc_threadvar_t key)
 509 {
 510     return pthread_getspecific (key);
 511 }
 512
 513 static bool rt_priorities = false;
 514 static int rt_offset;
 515
 516 void vlc_threads_setup (libvlc_int_t *p_libvlc)
 517 {
 518     static vlc_mutex_t lock = VLC_STATIC_MUTEX;
 519     static bool initialized = false;
 520
 521     vlc_mutex_lock (&lock);
 522     /* Initializes real-time priorities before any thread is created,
 523      * just once per process. */
 524     if (!initialized)
 525     {
 526 #ifndef __APPLE__
 527         if (config_GetInt (p_libvlc, "rt-priority"))
 528 #endif
 529         {
 530             rt_offset = config_GetInt (p_libvlc, "rt-offset");
 531             rt_priorities = true;
 532         }
 533         initialized = true;
 534     }
 535     vlc_mutex_unlock (&lock);
 536 }
 537
 538 /**
 539  * Creates and starts new thread.
 540  *
 541  * @param p_handle [OUT] pointer to write the handle of the created thread to
 542  * @param entry entry point for the thread
 543  * @param data data parameter given to the entry point
 544  * @param priority thread priority value
 545  * @return 0 on success, a standard error code on error.
 546  */
 547 int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
 548                int priority)
 549 {
 550     int ret;
 551
 552     pthread_attr_t attr;
 553     pthread_attr_init (&attr);
 554
 555     /* Block the signals that signals interface plugin handles.
 556      * If the LibVLC caller wants to handle some signals by itself, it should
 557      * block these before whenever invoking LibVLC. And it must obviously not
 558      * start the VLC signals interface plugin.
 559      *
 560      * LibVLC will normally ignore any interruption caused by an asynchronous
 561      * signal during a system call. But there may well be some buggy cases
 562      * where it fails to handle EINTR (bug reports welcome). Some underlying
 563      * libraries might also not handle EINTR properly.
 564      */
 565     sigset_t oldset;
 566     {
 567         sigset_t set;
 568         sigemptyset (&set);
 569         sigdelset (&set, SIGHUP);
 570         sigaddset (&set, SIGINT);
 571         sigaddset (&set, SIGQUIT);
 572         sigaddset (&set, SIGTERM);
 573
 574         sigaddset (&set, SIGPIPE); /* We don't want this one, really! */
 575         pthread_sigmask (SIG_BLOCK, &set, &oldset);
 576     }
 577
 578 #if defined (_POSIX_PRIORITY_SCHEDULING) && (_POSIX_PRIORITY_SCHEDULING >= 0) \
 579  && defined (_POSIX_THREAD_PRIORITY_SCHEDULING) \
 580  && (_POSIX_THREAD_PRIORITY_SCHEDULING >= 0)
 581     if (rt_priorities)
 582     {
 583         struct sched_param sp = { .sched_priority = priority + rt_offset, };
 584         int policy;
 585
 586         if (sp.sched_priority <= 0)
 587             sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
 588         else
 589             sp.sched_priority += sched_get_priority_min (policy = SCHED_RR);
 590
 591         pthread_attr_setschedpolicy (&attr, policy);
 592         pthread_attr_setschedparam (&attr, &sp);
 593     }
 594 #else
 595     (void) priority;
 596 #endif
 597
 598     /* The thread stack size.
 599      * The lower the value, the less address space per thread, the highest
 600      * maximum simultaneous threads per process. Too low values will cause
 601      * stack overflows and weird crashes. Set with caution. Also keep in mind
 602      * that 64-bits platforms consume more stack than 32-bits one.
 603      *
 604      * Thanks to on-demand paging, thread stack size only affects address space
 605      * consumption. In terms of memory, threads only use what they need
 606      * (rounded up to the page boundary).
 607      *
 608      * For example, on Linux i386, the default is 2 mega-bytes, which supports
 609      * about 320 threads per processes. */
 610 #define VLC_STACKSIZE (128 * sizeof (void *) * 1024)
 611
 612 #ifdef VLC_STACKSIZE
 613     ret = pthread_attr_setstacksize (&attr, VLC_STACKSIZE);
 614     assert (ret == 0); /* fails iif VLC_STACKSIZE is invalid */
 615 #endif
 616
 617     ret = pthread_create (p_handle, &attr, entry, data);
 618     pthread_sigmask (SIG_SETMASK, &oldset, NULL);
 619     pthread_attr_destroy (&attr);
 620     return ret;
 621 }
 622
 623 /**
 624  * Marks a thread as cancelled. Next time the target thread reaches a
 625  * cancellation point (while not having disabled cancellation), it will
 626  * run its cancellation cleanup handler, the thread variable destructors, and
 627  * terminate. vlc_join() must be used afterward regardless of a thread being
 628  * cancelled or not.
 629  */
 630 void vlc_cancel (vlc_thread_t thread_id)
 631 {
 632     pthread_cancel (thread_id);
 633 }
 634
 635 /**
 636  * Waits for a thread to complete (if needed), then destroys it.
 637  * This is a cancellation point; in case of cancellation, the join does _not_
 638  * occur.
 639  * @warning
 640  * A thread cannot join itself (normally VLC will abort if this is attempted).
 641  * Also, a detached thread <b>cannot</b> be joined.
 642  *
 643  * @param handle thread handle
 644  * @param p_result [OUT] pointer to write the thread return value or NULL
 645  */
 646 void vlc_join (vlc_thread_t handle, void **result)
 647 {
 648     int val = pthread_join (handle, result);
 649     VLC_THREAD_ASSERT ("joining thread");
 650 }
 651
 652 /**
 653  * Detaches a thread. When the specified thread completes, it will be
 654  * automatically destroyed (in particular, its stack will be reclaimed),
 655  * instead of waiting for another thread to call vlc_join(). If the thread has
 656  * already completed, it will be destroyed immediately.
 657  *
 658  * When a thread performs some work asynchronously and may complete much
 659  * earlier than it can be joined, detaching the thread can save memory.
 660  * However, care must be taken that any resources used by a detached thread
 661  * remains valid until the thread completes. This will typically involve some
 662  * kind of thread-safe signaling.
 663  *
 664  * A thread may detach itself.
 665  *
 666  * @param handle thread handle
 667  */
 668 void vlc_detach (vlc_thread_t handle)
 669 {
 670     int val = pthread_detach (handle);
 671     VLC_THREAD_ASSERT ("detaching thread");
 672 }
 673
 674 /**
 675  * Save the current cancellation state (enabled or disabled), then disable
 676  * cancellation for the calling thread.
 677  * This function must be called before entering a piece of code that is not
 678  * cancellation-safe, unless it can be proven that the calling thread will not
 679  * be cancelled.
 680  * @return Previous cancellation state (opaque value for vlc_restorecancel()).
 681  */
 682 int vlc_savecancel (void)
 683 {
 684     int state;
 685     int val = pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, &state);
 686
 687     VLC_THREAD_ASSERT ("saving cancellation");
 688     return state;
 689 }
 690
 691 /**
 692  * Restore the cancellation state for the calling thread.
 693  * @param state previous state as returned by vlc_savecancel().
 694  * @return Nothing, always succeeds.
 695  */
 696 void vlc_restorecancel (int state)
 697 {
 698 #ifndef NDEBUG
 699     int oldstate, val;
 700
 701     val = pthread_setcancelstate (state, &oldstate);
 702     /* This should fail if an invalid value for given for state */
 703     VLC_THREAD_ASSERT ("restoring cancellation");
 704
 705     if (unlikely(oldstate != PTHREAD_CANCEL_DISABLE))
 706          vlc_thread_fatal ("restoring cancellation while not disabled", EINVAL,
 707                            __func__, __FILE__, __LINE__);
 708 #else
 709     pthread_setcancelstate (state, NULL);
 710 #endif
 711 }
 712
 713 /**
 714  * Issues an explicit deferred cancellation point.
 715  * This has no effect if thread cancellation is disabled.
 716  * This can be called when there is a rather slow non-sleeping operation.
 717  * This is also used to force a cancellation point in a function that would
 718  * otherwise "not always" be a one (block_FifoGet() is an example).
 719  */
 720 void vlc_testcancel (void)
 721 {
 722     pthread_testcancel ();
 723 }
 724
 725 void vlc_control_cancel (int cmd, ...)
 726 {
 727     (void) cmd;
 728     assert (0);
 729 }
 730
 731
 732 struct vlc_timer
 733 {
 734     vlc_thread_t thread;
 735     vlc_mutex_t  lock;
 736     vlc_cond_t   wait;
 737     void       (*func) (void *);
 738     void        *data;
 739     mtime_t      value, interval;
 740     unsigned     users;
 741     unsigned     overruns;
 742 };
 743
 744 static void *vlc_timer_do (void *data)
 745 {
 746     struct vlc_timer *timer = data;
 747
 748     timer->func (timer->data);
 749
 750     vlc_mutex_lock (&timer->lock);
 751     assert (timer->users > 0);
 752     if (--timer->users == 0)
 753         vlc_cond_signal (&timer->wait);
 754     vlc_mutex_unlock (&timer->lock);
 755     return NULL;
 756 }
 757
 758 static void *vlc_timer_thread (void *data)
 759 {
 760     struct vlc_timer *timer = data;
 761     mtime_t value, interval;
 762
 763     vlc_mutex_lock (&timer->lock);
 764     value = timer->value;
 765     interval = timer->interval;
 766     vlc_mutex_unlock (&timer->lock);
 767
 768     for (;;)
 769     {
 770          vlc_thread_t th;
 771
 772          mwait (value);
 773
 774          vlc_mutex_lock (&timer->lock);
 775          if (vlc_clone (&th, vlc_timer_do, timer, VLC_THREAD_PRIORITY_INPUT))
 776              timer->overruns++;
 777          else
 778          {
 779              vlc_detach (th);
 780              timer->users++;
 781          }
 782          vlc_mutex_unlock (&timer->lock);
 783
 784          if (interval == 0)
 785              return NULL;
 786
 787          value += interval;
 788     }
 789 }
 790
 791 /**
 792  * Initializes an asynchronous timer.
 793  * @warning Asynchronous timers are processed from an unspecified thread.
 794  * Also, multiple occurences of an interval timer can run concurrently.
 795  *
 796  * @param id pointer to timer to be initialized
 797  * @param func function that the timer will call
 798  * @param data parameter for the timer function
 799  * @return 0 on success, a system error code otherwise.
 800  */
 801 int vlc_timer_create (vlc_timer_t *id, void (*func) (void *), void *data)
 802 {
 803     struct vlc_timer *timer = malloc (sizeof (*timer));
 804
 805     if (unlikely(timer == NULL))
 806         return ENOMEM;
 807     vlc_mutex_init (&timer->lock);
 808     vlc_cond_init (&timer->wait);
 809     assert (func);
 810     timer->func = func;
 811     timer->data = data;
 812     timer->value = 0;
 813     timer->interval = 0;
 814     timer->users = 0;
 815     timer->overruns = 0;
 816     *id = timer;
 817     return 0;
 818 }
 819
 820 /**
 821  * Destroys an initialized timer. If needed, the timer is first disarmed.
 822  * This function is undefined if the specified timer is not initialized.
 823  *
 824  * @warning This function <b>must</b> be called before the timer data can be
 825  * freed and before the timer callback function can be unloaded.
 826  *
 827  * @param timer timer to destroy
 828  */
 829 void vlc_timer_destroy (vlc_timer_t timer)
 830 {
 831     vlc_timer_schedule (timer, false, 0, 0);
 832     vlc_mutex_lock (&timer->lock);
 833     while (timer->users != 0)
 834         vlc_cond_wait (&timer->wait, &timer->lock);
 835     vlc_mutex_unlock (&timer->lock);
 836
 837     vlc_cond_destroy (&timer->wait);
 838     vlc_mutex_destroy (&timer->lock);
 839     free (timer);
 840 }
 841
 842 /**
 843  * Arm or disarm an initialized timer.
 844  * This functions overrides any previous call to itself.
 845  *
 846  * @note A timer can fire later than requested due to system scheduling
 847  * limitations. An interval timer can fail to trigger sometimes, either because
 848  * the system is busy or suspended, or because a previous iteration of the
 849  * timer is still running. See also vlc_timer_getoverrun().
 850  *
 851  * @param timer initialized timer
 852  * @param absolute the timer value origin is the same as mdate() if true,
 853  *                 the timer value is relative to now if false.
 854  * @param value zero to disarm the timer, otherwise the initial time to wait
 855  *              before firing the timer.
 856  * @param interval zero to fire the timer just once, otherwise the timer
 857  *                 repetition interval.
 858  */
 859 void vlc_timer_schedule (vlc_timer_t timer, bool absolute,
 860                          mtime_t value, mtime_t interval)
 861 {
 862     static vlc_mutex_t lock = VLC_STATIC_MUTEX;
 863
 864     vlc_mutex_lock (&lock);
 865     vlc_mutex_lock (&timer->lock);
 866     if (timer->value)
 867     {
 868         vlc_mutex_unlock (&timer->lock);
 869         vlc_cancel (timer->thread);
 870         vlc_join (timer->thread, NULL);
 871         vlc_mutex_lock (&timer->lock);
 872         timer->value = 0;
 873     }
 874     if ((value != 0)
 875      && (vlc_clone (&timer->thread, vlc_timer_thread, timer,
 876                     VLC_THREAD_PRIORITY_INPUT) == 0))
 877     {
 878         timer->value = (absolute ? 0 : mdate ()) + value;
 879         timer->interval = interval;
 880     }
 881     vlc_mutex_unlock (&timer->lock);
 882     vlc_mutex_unlock (&lock);
 883 }
 884
 885 /**
 886  * Fetch and reset the overrun counter for a timer.
 887  * @param timer initialized timer
 888  * @return the timer overrun counter, i.e. the number of times that the timer
 889  * should have run but did not since the last actual run. If all is well, this
 890  * is zero.
 891  */
 892 unsigned vlc_timer_getoverrun (vlc_timer_t timer)
 893 {
 894     unsigned ret;
 895
 896     vlc_mutex_lock (&timer->lock);
 897     ret = timer->overruns;
 898     timer->overruns = 0;
 899     vlc_mutex_unlock (&timer->lock);
 900     return ret;
 901 }