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

   1 /*****************************************************************************
   2  * threads.c : threads implementation for the VideoLAN client
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          Gildas Bazin <gbazin@netcourrier.com>
  10  *          Clément Sténac
  11  *          Rémi Denis-Courmont
  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 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33
  34 #include "libvlc.h"
  35 #include <stdarg.h>
  36 #include <assert.h>
  37 #ifdef HAVE_UNISTD_H
  38 # include <unistd.h>
  39 #endif
  40 #include <signal.h>
  41
  42 #if defined( LIBVLC_USE_PTHREAD )
  43 # include <sched.h>
  44 # ifdef __linux__
  45 #  include <sys/syscall.h> /* SYS_gettid */
  46 # endif
  47 #else
  48 static vlc_threadvar_t cancel_key;
  49 #endif
  50
  51 #ifdef HAVE_EXECINFO_H
  52 # include <execinfo.h>
  53 #endif
  54
  55 #ifdef __APPLE__
  56 # include <sys/time.h> /* gettimeofday in vlc_cond_timedwait */
  57 #endif
  58
  59 /**
  60  * Print a backtrace to the standard error for debugging purpose.
  61  */
  62 void vlc_trace (const char *fn, const char *file, unsigned line)
  63 {
  64      fprintf (stderr, "at %s:%u in %s\n", file, line, fn);
  65      fflush (stderr); /* needed before switch to low-level I/O */
  66 #ifdef HAVE_BACKTRACE
  67      void *stack[20];
  68      int len = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
  69      backtrace_symbols_fd (stack, len, 2);
  70 #endif
  71 #ifndef WIN32
  72      fsync (2);
  73 #endif
  74 }
  75
  76 static inline unsigned long vlc_threadid (void)
  77 {
  78 #if defined (LIBVLC_USE_PTHREAD)
  79 # if defined (__linux__)
  80      return syscall (SYS_gettid);
  81
  82 # else
  83      union { pthread_t th; unsigned long int i; } v = { };
  84      v.th = pthread_self ();
  85      return v.i;
  86
  87 #endif
  88 #elif defined (WIN32)
  89      return GetCurrentThreadId ();
  90
  91 #else
  92      return 0;
  93
  94 #endif
  95 }
  96
  97 #ifndef NDEBUG
  98 /*****************************************************************************
  99  * vlc_thread_fatal: Report an error from the threading layer
 100  *****************************************************************************
 101  * This is mostly meant for debugging.
 102  *****************************************************************************/
 103 static void
 104 vlc_thread_fatal (const char *action, int error,
 105                   const char *function, const char *file, unsigned line)
 106 {
 107     fprintf (stderr, "LibVLC fatal error %s (%d) in thread %lu ",
 108              action, error, vlc_threadid ());
 109     vlc_trace (function, file, line);
 110
 111     /* Sometimes strerror_r() crashes too, so make sure we print an error
 112      * message before we invoke it */
 113 #ifdef __GLIBC__
 114     /* Avoid the strerror_r() prototype brain damage in glibc */
 115     errno = error;
 116     fprintf (stderr, " Error message: %m\n");
 117 #elif !defined (WIN32)
 118     char buf[1000];
 119     const char *msg;
 120
 121     switch (strerror_r (error, buf, sizeof (buf)))
 122     {
 123         case 0:
 124             msg = buf;
 125             break;
 126         case ERANGE: /* should never happen */
 127             msg = "unknwon (too big to display)";
 128             break;
 129         default:
 130             msg = "unknown (invalid error number)";
 131             break;
 132     }
 133     fprintf (stderr, " Error message: %s\n", msg);
 134 #endif
 135     fflush (stderr);
 136
 137     abort ();
 138 }
 139
 140 # define VLC_THREAD_ASSERT( action ) \
 141     if (val) vlc_thread_fatal (action, val, __func__, __FILE__, __LINE__)
 142 #else
 143 # define VLC_THREAD_ASSERT( action ) ((void)val)
 144 #endif
 145
 146 /**
 147  * Per-thread cancellation data
 148  */
 149 #ifndef LIBVLC_USE_PTHREAD_CANCEL
 150 typedef struct vlc_cancel_t
 151 {
 152     vlc_cleanup_t *cleaners;
 153     bool           killable;
 154     bool           killed;
 155 # ifdef UNDER_CE
 156     HANDLE         cancel_event;
 157 # endif
 158 } vlc_cancel_t;
 159
 160 # ifndef UNDER_CE
 161 #  define VLC_CANCEL_INIT { NULL, true, false }
 162 # else
 163 #  define VLC_CANCEL_INIT { NULL, true, false, NULL }
 164 # endif
 165 #endif
 166
 167 #ifdef UNDER_CE
 168 static void CALLBACK vlc_cancel_self (ULONG_PTR dummy);
 169
 170 static DWORD vlc_cancelable_wait (DWORD count, const HANDLE *handles,
 171                                   DWORD delay)
 172 {
 173     vlc_cancel_t *nfo = vlc_threadvar_get (cancel_key);
 174     if (nfo == NULL)
 175     {
 176         /* Main thread - cannot be cancelled anyway */
 177         return WaitForMultipleObjects (count, handles, FALSE, delay);
 178     }
 179     HANDLE new_handles[count + 1];
 180     memcpy(new_handles, handles, count * sizeof(HANDLE));
 181     new_handles[count] = nfo->cancel_event;
 182     DWORD result = WaitForMultipleObjects (count + 1, new_handles, FALSE,
 183                                            delay);
 184     if (result == WAIT_OBJECT_0 + count)
 185     {
 186         vlc_cancel_self (NULL);
 187         return WAIT_IO_COMPLETION;
 188     }
 189     else
 190     {
 191         return result;
 192     }
 193 }
 194
 195 DWORD SleepEx (DWORD dwMilliseconds, BOOL bAlertable)
 196 {
 197     if (bAlertable)
 198     {
 199         DWORD result = vlc_cancelable_wait (0, NULL, dwMilliseconds);
 200         return (result == WAIT_TIMEOUT) ? 0 : WAIT_IO_COMPLETION;
 201     }
 202     else
 203     {
 204         Sleep(dwMilliseconds);
 205         return 0;
 206     }
 207 }
 208
 209 DWORD WaitForSingleObjectEx (HANDLE hHandle, DWORD dwMilliseconds,
 210                              BOOL bAlertable)
 211 {
 212     if (bAlertable)
 213     {
 214         /* The MSDN documentation specifies different return codes,
 215          * but in practice they are the same. We just check that it
 216          * remains so. */
 217 #if WAIT_ABANDONED != WAIT_ABANDONED_0
 218 # error Windows headers changed, code needs to be rewritten!
 219 #endif
 220         return vlc_cancelable_wait (1, &hHandle, dwMilliseconds);
 221     }
 222     else
 223     {
 224         return WaitForSingleObject (hHandle, dwMilliseconds);
 225     }
 226 }
 227
 228 DWORD WaitForMultipleObjectsEx (DWORD nCount, const HANDLE *lpHandles,
 229                                 BOOL bWaitAll, DWORD dwMilliseconds,
 230                                 BOOL bAlertable)
 231 {
 232     if (bAlertable)
 233     {
 234         /* We do not support the bWaitAll case */
 235         assert (! bWaitAll);
 236         return vlc_cancelable_wait (nCount, lpHandles, dwMilliseconds);
 237     }
 238     else
 239     {
 240         return WaitForMultipleObjects (nCount, lpHandles, bWaitAll,
 241                                        dwMilliseconds);
 242     }
 243 }
 244 #endif
 245
 246 #ifdef WIN32
 247 static vlc_mutex_t super_mutex;
 248
 249 BOOL WINAPI DllMain (HINSTANCE hinstDll, DWORD fdwReason, LPVOID lpvReserved)
 250 {
 251     (void) hinstDll;
 252     (void) lpvReserved;
 253
 254     switch (fdwReason)
 255     {
 256         case DLL_PROCESS_ATTACH:
 257             vlc_mutex_init (&super_mutex);
 258             vlc_threadvar_create (&cancel_key, free);
 259             break;
 260
 261         case DLL_PROCESS_DETACH:
 262             vlc_threadvar_delete( &cancel_key );
 263             vlc_mutex_destroy (&super_mutex);
 264             break;
 265     }
 266     return TRUE;
 267 }
 268 #endif
 269
 270 #if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 271 /* This is not prototyped under glibc, though it exists. */
 272 int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
 273 #endif
 274
 275 /*****************************************************************************
 276  * vlc_mutex_init: initialize a mutex
 277  *****************************************************************************/
 278 int vlc_mutex_init( vlc_mutex_t *p_mutex )
 279 {
 280 #if defined( LIBVLC_USE_PTHREAD )
 281     pthread_mutexattr_t attr;
 282     int                 i_result;
 283
 284     pthread_mutexattr_init( &attr );
 285
 286 # ifndef NDEBUG
 287     /* Create error-checking mutex to detect problems more easily. */
 288 #  if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 289     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP );
 290 #  else
 291     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK );
 292 #  endif
 293 # endif
 294     i_result = pthread_mutex_init( p_mutex, &attr );
 295     pthread_mutexattr_destroy( &attr );
 296     return i_result;
 297
 298 #elif defined( WIN32 )
 299     /* This creates a recursive mutex. This is OK as fast mutexes have
 300      * no defined behavior in case of recursive locking. */
 301     InitializeCriticalSection (&p_mutex->mutex);
 302     p_mutex->initialized = 1;
 303     return 0;
 304
 305 #endif
 306 }
 307
 308 /*****************************************************************************
 309  * vlc_mutex_init: initialize a recursive mutex (Do not use)
 310  *****************************************************************************/
 311 int vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
 312 {
 313 #if defined( LIBVLC_USE_PTHREAD )
 314     pthread_mutexattr_t attr;
 315     int                 i_result;
 316
 317     pthread_mutexattr_init( &attr );
 318 #  if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 319     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_RECURSIVE_NP );
 320 #  else
 321     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
 322 #  endif
 323     i_result = pthread_mutex_init( p_mutex, &attr );
 324     pthread_mutexattr_destroy( &attr );
 325     return( i_result );
 326
 327 #elif defined( WIN32 )
 328     InitializeCriticalSection( &p_mutex->mutex );
 329     p_mutex->initialized = 1;
 330     return 0;
 331
 332 #endif
 333 }
 334
 335
 336 /**
 337  * Destroys a mutex. The mutex must not be locked.
 338  *
 339  * @param p_mutex mutex to destroy
 340  * @return always succeeds
 341  */
 342 void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
 343 {
 344 #if defined( LIBVLC_USE_PTHREAD )
 345     int val = pthread_mutex_destroy( p_mutex );
 346     VLC_THREAD_ASSERT ("destroying mutex");
 347
 348 #elif defined( WIN32 )
 349     assert (InterlockedExchange (&p_mutex->initialized, -1) == 1);
 350     DeleteCriticalSection (&p_mutex->mutex);
 351
 352 #endif
 353 }
 354
 355 #if defined(LIBVLC_USE_PTHREAD) && !defined(NDEBUG)
 356 # ifdef HAVE_VALGRIND_VALGRIND_H
 357 #  include <valgrind/valgrind.h>
 358 # else
 359 #  define RUNNING_ON_VALGRIND (0)
 360 # endif
 361
 362 void vlc_assert_locked (vlc_mutex_t *p_mutex)
 363 {
 364     if (RUNNING_ON_VALGRIND > 0)
 365         return;
 366     assert (pthread_mutex_lock (p_mutex) == EDEADLK);
 367 }
 368 #endif
 369
 370 /**
 371  * Acquires a mutex. If needed, waits for any other thread to release it.
 372  * Beware of deadlocks when locking multiple mutexes at the same time,
 373  * or when using mutexes from callbacks.
 374  * This function is not a cancellation-point.
 375  *
 376  * @param p_mutex mutex initialized with vlc_mutex_init() or
 377  *                vlc_mutex_init_recursive()
 378  */
 379 void vlc_mutex_lock (vlc_mutex_t *p_mutex)
 380 {
 381 #if defined(LIBVLC_USE_PTHREAD)
 382     int val = pthread_mutex_lock( p_mutex );
 383     VLC_THREAD_ASSERT ("locking mutex");
 384
 385 #elif defined( WIN32 )
 386     if (InterlockedCompareExchange (&p_mutex->initialized, 0, 0) == 0)
 387     { /* ^^ We could also lock super_mutex all the time... sluggish */
 388         assert (p_mutex != &super_mutex); /* this one cannot be static */
 389
 390         vlc_mutex_lock (&super_mutex);
 391         if (InterlockedCompareExchange (&p_mutex->initialized, 0, 0) == 0)
 392             vlc_mutex_init (p_mutex);
 393         /* FIXME: destroy the mutex some time... */
 394         vlc_mutex_unlock (&super_mutex);
 395     }
 396     assert (InterlockedExchange (&p_mutex->initialized, 1) == 1);
 397     EnterCriticalSection (&p_mutex->mutex);
 398
 399 #endif
 400 }
 401
 402 /**
 403  * Acquires a mutex if and only if it is not currently held by another thread.
 404  * This function never sleeps and can be used in delay-critical code paths.
 405  * This function is not a cancellation-point.
 406  *
 407  * <b>Beware</b>: If this function fails, then the mutex is held... by another
 408  * thread. The calling thread must deal with the error appropriately. That
 409  * typically implies postponing the operations that would have required the
 410  * mutex. If the thread cannot defer those operations, then it must use
 411  * vlc_mutex_lock(). If in doubt, use vlc_mutex_lock() instead.
 412  *
 413  * @param p_mutex mutex initialized with vlc_mutex_init() or
 414  *                vlc_mutex_init_recursive()
 415  * @return 0 if the mutex could be acquired, an error code otherwise.
 416  */
 417 int vlc_mutex_trylock (vlc_mutex_t *p_mutex)
 418 {
 419 #if defined(LIBVLC_USE_PTHREAD)
 420     int val = pthread_mutex_trylock( p_mutex );
 421
 422     if (val != EBUSY)
 423         VLC_THREAD_ASSERT ("locking mutex");
 424     return val;
 425
 426 #elif defined( WIN32 )
 427     if (InterlockedCompareExchange (&p_mutex->initialized, 0, 0) == 0)
 428     { /* ^^ We could also lock super_mutex all the time... sluggish */
 429         assert (p_mutex != &super_mutex); /* this one cannot be static */
 430
 431         vlc_mutex_lock (&super_mutex);
 432         if (InterlockedCompareExchange (&p_mutex->initialized, 0, 0) == 0)
 433             vlc_mutex_init (p_mutex);
 434         /* FIXME: destroy the mutex some time... */
 435         vlc_mutex_unlock (&super_mutex);
 436     }
 437     assert (InterlockedExchange (&p_mutex->initialized, 1) == 1);
 438     return TryEnterCriticalSection (&p_mutex->mutex) ? 0 : EBUSY;
 439
 440 #endif
 441 }
 442
 443 /**
 444  * Releases a mutex (or crashes if the mutex is not locked by the caller).
 445  * @param p_mutex mutex locked with vlc_mutex_lock().
 446  */
 447 void vlc_mutex_unlock (vlc_mutex_t *p_mutex)
 448 {
 449 #if defined(LIBVLC_USE_PTHREAD)
 450     int val = pthread_mutex_unlock( p_mutex );
 451     VLC_THREAD_ASSERT ("unlocking mutex");
 452
 453 #elif defined( WIN32 )
 454     assert (InterlockedExchange (&p_mutex->initialized, 1) == 1);
 455     LeaveCriticalSection (&p_mutex->mutex);
 456
 457 #endif
 458 }
 459
 460 /*****************************************************************************
 461  * vlc_cond_init: initialize a condition variable
 462  *****************************************************************************/
 463 int vlc_cond_init( vlc_cond_t *p_condvar )
 464 {
 465 #if defined( LIBVLC_USE_PTHREAD )
 466     pthread_condattr_t attr;
 467     int ret;
 468
 469     ret = pthread_condattr_init (&attr);
 470     if (ret)
 471         return ret;
 472
 473 # if !defined (_POSIX_CLOCK_SELECTION)
 474    /* Fairly outdated POSIX support (that was defined in 2001) */
 475 #  define _POSIX_CLOCK_SELECTION (-1)
 476 # endif
 477 # if (_POSIX_CLOCK_SELECTION >= 0)
 478     /* NOTE: This must be the same clock as the one in mtime.c */
 479     pthread_condattr_setclock (&attr, CLOCK_MONOTONIC);
 480 # endif
 481
 482     ret = pthread_cond_init (p_condvar, &attr);
 483     pthread_condattr_destroy (&attr);
 484     return ret;
 485
 486 #elif defined( WIN32 )
 487     /* Create a manual-reset event (manual reset is needed for broadcast). */
 488     *p_condvar = CreateEvent( NULL, TRUE, FALSE, NULL );
 489     return *p_condvar ? 0 : ENOMEM;
 490
 491 #endif
 492 }
 493
 494 /**
 495  * Destroys a condition variable. No threads shall be waiting or signaling the
 496  * condition.
 497  * @param p_condvar condition variable to destroy
 498  */
 499 void vlc_cond_destroy (vlc_cond_t *p_condvar)
 500 {
 501 #if defined( LIBVLC_USE_PTHREAD )
 502     int val = pthread_cond_destroy( p_condvar );
 503     VLC_THREAD_ASSERT ("destroying condition");
 504
 505 #elif defined( WIN32 )
 506     CloseHandle( *p_condvar );
 507
 508 #endif
 509 }
 510
 511 /**
 512  * Wakes up one thread waiting on a condition variable, if any.
 513  * @param p_condvar condition variable
 514  */
 515 void vlc_cond_signal (vlc_cond_t *p_condvar)
 516 {
 517 #if defined(LIBVLC_USE_PTHREAD)
 518     int val = pthread_cond_signal( p_condvar );
 519     VLC_THREAD_ASSERT ("signaling condition variable");
 520
 521 #elif defined( WIN32 )
 522     /* NOTE: This will cause a broadcast, that is wrong.
 523      * This will also wake up the next waiting thread if no thread are yet
 524      * waiting, which is also wrong. However both of these issues are allowed
 525      * by the provision for spurious wakeups. Better have too many wakeups
 526      * than too few (= deadlocks). */
 527     SetEvent (*p_condvar);
 528
 529 #endif
 530 }
 531
 532 /**
 533  * Wakes up all threads (if any) waiting on a condition variable.
 534  * @param p_cond condition variable
 535  */
 536 void vlc_cond_broadcast (vlc_cond_t *p_condvar)
 537 {
 538 #if defined (LIBVLC_USE_PTHREAD)
 539     pthread_cond_broadcast (p_condvar);
 540
 541 #elif defined (WIN32)
 542     SetEvent (*p_condvar);
 543
 544 #endif
 545 }
 546
 547 /**
 548  * Waits for a condition variable. The calling thread will be suspended until
 549  * another thread calls vlc_cond_signal() or vlc_cond_broadcast() on the same
 550  * condition variable, the thread is cancelled with vlc_cancel(), or the
 551  * system causes a "spurious" unsolicited wake-up.
 552  *
 553  * A mutex is needed to wait on a condition variable. It must <b>not</b> be
 554  * a recursive mutex. Although it is possible to use the same mutex for
 555  * multiple condition, it is not valid to use different mutexes for the same
 556  * condition variable at the same time from different threads.
 557  *
 558  * In case of thread cancellation, the mutex is always locked before
 559  * cancellation proceeds.
 560  *
 561  * The canonical way to use a condition variable to wait for event foobar is:
 562  @code
 563    vlc_mutex_lock (&lock);
 564    mutex_cleanup_push (&lock); // release the mutex in case of cancellation
 565
 566    while (!foobar)
 567        vlc_cond_wait (&wait, &lock);
 568
 569    --- foobar is now true, do something about it here --
 570
 571    vlc_cleanup_run (); // release the mutex
 572   @endcode
 573  *
 574  * @param p_condvar condition variable to wait on
 575  * @param p_mutex mutex which is unlocked while waiting,
 576  *                then locked again when waking up.
 577  * @param deadline <b>absolute</b> timeout
 578  *
 579  * @return 0 if the condition was signaled, an error code in case of timeout.
 580  */
 581 void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
 582 {
 583 #if defined(LIBVLC_USE_PTHREAD)
 584     int val = pthread_cond_wait( p_condvar, p_mutex );
 585     VLC_THREAD_ASSERT ("waiting on condition");
 586
 587 #elif defined( WIN32 )
 588     DWORD result;
 589
 590     do
 591     {
 592         vlc_testcancel ();
 593         LeaveCriticalSection (&p_mutex->mutex);
 594         result = WaitForSingleObjectEx (*p_condvar, INFINITE, TRUE);
 595         EnterCriticalSection (&p_mutex->mutex);
 596     }
 597     while (result == WAIT_IO_COMPLETION);
 598
 599     ResetEvent (*p_condvar);
 600
 601 #endif
 602 }
 603
 604 /**
 605  * Waits for a condition variable up to a certain date.
 606  * This works like vlc_cond_wait(), except for the additional timeout.
 607  *
 608  * @param p_condvar condition variable to wait on
 609  * @param p_mutex mutex which is unlocked while waiting,
 610  *                then locked again when waking up.
 611  * @param deadline <b>absolute</b> timeout
 612  *
 613  * @return 0 if the condition was signaled, an error code in case of timeout.
 614  */
 615 int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
 616                         mtime_t deadline)
 617 {
 618 #if defined(LIBVLC_USE_PTHREAD)
 619 #ifdef __APPLE__
 620     /* mdate() is mac_absolute_time on osx, which we must convert to do
 621      * the same base than gettimeofday() on which pthread_cond_timedwait
 622      * counts on. */
 623     mtime_t oldbase = mdate();
 624     struct timeval tv;
 625     gettimeofday(&tv, NULL);
 626     mtime_t newbase = (mtime_t)tv.tv_sec * 1000000 + (mtime_t) tv.tv_usec;
 627     deadline = deadline - oldbase + newbase;
 628 #endif
 629     lldiv_t d = lldiv( deadline, CLOCK_FREQ );
 630     struct timespec ts = { d.quot, d.rem * (1000000000 / CLOCK_FREQ) };
 631
 632     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
 633     if (val != ETIMEDOUT)
 634         VLC_THREAD_ASSERT ("timed-waiting on condition");
 635     return val;
 636
 637 #elif defined( WIN32 )
 638     DWORD result;
 639
 640     do
 641     {
 642         vlc_testcancel ();
 643
 644         mtime_t total = (deadline - mdate ())/1000;
 645         if( total < 0 )
 646             total = 0;
 647
 648         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
 649         LeaveCriticalSection (&p_mutex->mutex);
 650         result = WaitForSingleObjectEx (*p_condvar, delay, TRUE);
 651         EnterCriticalSection (&p_mutex->mutex);
 652     }
 653     while (result == WAIT_IO_COMPLETION);
 654
 655     ResetEvent (*p_condvar);
 656
 657     return (result == WAIT_OBJECT_0) ? 0 : ETIMEDOUT;
 658
 659 #endif
 660 }
 661
 662 /*****************************************************************************
 663  * vlc_tls_create: create a thread-local variable
 664  *****************************************************************************/
 665 int vlc_threadvar_create( vlc_threadvar_t *p_tls, void (*destr) (void *) )
 666 {
 667     int i_ret;
 668
 669 #if defined( LIBVLC_USE_PTHREAD )
 670     i_ret =  pthread_key_create( p_tls, destr );
 671 #elif defined( WIN32 )
 672     /* FIXME: remember/use the destr() callback and stop leaking whatever */
 673     *p_tls = TlsAlloc();
 674     i_ret = (*p_tls == TLS_OUT_OF_INDEXES) ? EAGAIN : 0;
 675 #else
 676 # error Unimplemented!
 677 #endif
 678     return i_ret;
 679 }
 680
 681 void vlc_threadvar_delete (vlc_threadvar_t *p_tls)
 682 {
 683 #if defined( LIBVLC_USE_PTHREAD )
 684     pthread_key_delete (*p_tls);
 685 #elif defined( WIN32 )
 686     TlsFree (*p_tls);
 687 #else
 688 # error Unimplemented!
 689 #endif
 690 }
 691
 692 /**
 693  * Sets a thread-local variable.
 694  * @param key thread-local variable key (created with vlc_threadvar_create())
 695  * @param value new value for the variable for the calling thread
 696  * @return 0 on success, a system error code otherwise.
 697  */
 698 int vlc_threadvar_set (vlc_threadvar_t key, void *value)
 699 {
 700 #if defined(LIBVLC_USE_PTHREAD)
 701     return pthread_setspecific (key, value);
 702 #elif defined( UNDER_CE ) || defined( WIN32 )
 703     return TlsSetValue (key, value) ? ENOMEM : 0;
 704 #else
 705 # error Unimplemented!
 706 #endif
 707 }
 708
 709 /**
 710  * Gets the value of a thread-local variable for the calling thread.
 711  * This function cannot fail.
 712  * @return the value associated with the given variable for the calling
 713  * or NULL if there is no value.
 714  */
 715 void *vlc_threadvar_get (vlc_threadvar_t key)
 716 {
 717 #if defined(LIBVLC_USE_PTHREAD)
 718     return pthread_getspecific (key);
 719 #elif defined( UNDER_CE ) || defined( WIN32 )
 720     return TlsGetValue (key);
 721 #else
 722 # error Unimplemented!
 723 #endif
 724 }
 725
 726 #if defined (LIBVLC_USE_PTHREAD)
 727 #elif defined (WIN32)
 728 static unsigned __stdcall vlc_entry (void *data)
 729 {
 730     vlc_cancel_t cancel_data = VLC_CANCEL_INIT;
 731     vlc_thread_t self = data;
 732 #ifdef UNDER_CE
 733     cancel_data.cancel_event = self->cancel_event;
 734 #endif
 735
 736     vlc_threadvar_set (cancel_key, &cancel_data);
 737     self->data = self->entry (self->data);
 738     return 0;
 739 }
 740 #endif
 741
 742 /**
 743  * Creates and starts new thread.
 744  *
 745  * @param p_handle [OUT] pointer to write the handle of the created thread to
 746  * @param entry entry point for the thread
 747  * @param data data parameter given to the entry point
 748  * @param priority thread priority value
 749  * @return 0 on success, a standard error code on error.
 750  */
 751 int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
 752                int priority)
 753 {
 754     int ret;
 755
 756 #if defined( LIBVLC_USE_PTHREAD )
 757     pthread_attr_t attr;
 758     pthread_attr_init (&attr);
 759
 760     /* Block the signals that signals interface plugin handles.
 761      * If the LibVLC caller wants to handle some signals by itself, it should
 762      * block these before whenever invoking LibVLC. And it must obviously not
 763      * start the VLC signals interface plugin.
 764      *
 765      * LibVLC will normally ignore any interruption caused by an asynchronous
 766      * signal during a system call. But there may well be some buggy cases
 767      * where it fails to handle EINTR (bug reports welcome). Some underlying
 768      * libraries might also not handle EINTR properly.
 769      */
 770     sigset_t oldset;
 771     {
 772         sigset_t set;
 773         sigemptyset (&set);
 774         sigdelset (&set, SIGHUP);
 775         sigaddset (&set, SIGINT);
 776         sigaddset (&set, SIGQUIT);
 777         sigaddset (&set, SIGTERM);
 778
 779         sigaddset (&set, SIGPIPE); /* We don't want this one, really! */
 780         pthread_sigmask (SIG_BLOCK, &set, &oldset);
 781     }
 782
 783 #if (_POSIX_THREAD_PRIORITY_SCHEDULING >= 0)
 784     {
 785         struct sched_param sp = { .sched_priority = priority, };
 786         int policy;
 787
 788         if (sp.sched_priority <= 0)
 789             sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
 790         else
 791             sp.sched_priority += sched_get_priority_min (policy = SCHED_RR);
 792
 793         pthread_attr_setschedpolicy (&attr, policy);
 794         pthread_attr_setschedparam (&attr, &sp);
 795     }
 796 #else
 797     (void) priority;
 798 #endif
 799
 800     /* The thread stack size.
 801      * The lower the value, the less address space per thread, the highest
 802      * maximum simultaneous threads per process. Too low values will cause
 803      * stack overflows and weird crashes. Set with caution. Also keep in mind
 804      * that 64-bits platforms consume more stack than 32-bits one.
 805      *
 806      * Thanks to on-demand paging, thread stack size only affects address space
 807      * consumption. In terms of memory, threads only use what they need
 808      * (rounded up to the page boundary).
 809      *
 810      * For example, on Linux i386, the default is 2 mega-bytes, which supports
 811      * about 320 threads per processes. */
 812 #define VLC_STACKSIZE (128 * sizeof (void *) * 1024)
 813
 814 #ifdef VLC_STACKSIZE
 815     ret = pthread_attr_setstacksize (&attr, VLC_STACKSIZE);
 816     assert (ret == 0); /* fails iif VLC_STACKSIZE is invalid */
 817 #endif
 818
 819     ret = pthread_create (p_handle, &attr, entry, data);
 820     pthread_sigmask (SIG_SETMASK, &oldset, NULL);
 821     pthread_attr_destroy (&attr);
 822
 823 #elif defined( WIN32 ) || defined( UNDER_CE )
 824     /* When using the MSVCRT C library you have to use the _beginthreadex
 825      * function instead of CreateThread, otherwise you'll end up with
 826      * memory leaks and the signal functions not working (see Microsoft
 827      * Knowledge Base, article 104641) */
 828     HANDLE hThread;
 829     vlc_thread_t th = malloc (sizeof (*th));
 830
 831     if (th == NULL)
 832         return ENOMEM;
 833
 834     th->data = data;
 835     th->entry = entry;
 836 #if defined( UNDER_CE )
 837     th->cancel_event = CreateEvent (NULL, FALSE, FALSE, NULL);
 838     if (th->cancel_event == NULL)
 839     {
 840         free(th);
 841         return errno;
 842     }
 843     hThread = CreateThread (NULL, 128*1024, vlc_entry, th, CREATE_SUSPENDED, NULL);
 844 #else
 845     hThread = (HANDLE)(uintptr_t)
 846         _beginthreadex (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
 847 #endif
 848
 849     if (hThread)
 850     {
 851 #ifndef UNDER_CE
 852         /* Thread closes the handle when exiting, duplicate it here
 853          * to be on the safe side when joining. */
 854         if (!DuplicateHandle (GetCurrentProcess (), hThread,
 855                               GetCurrentProcess (), &th->handle, 0, FALSE,
 856                               DUPLICATE_SAME_ACCESS))
 857         {
 858             CloseHandle (hThread);
 859             free (th);
 860             return ENOMEM;
 861         }
 862 #else
 863         th->handle = hThread;
 864 #endif
 865
 866         ResumeThread (hThread);
 867         if (priority)
 868             SetThreadPriority (hThread, priority);
 869
 870         ret = 0;
 871         *p_handle = th;
 872     }
 873     else
 874     {
 875         ret = errno;
 876         free (th);
 877     }
 878
 879 #endif
 880     return ret;
 881 }
 882
 883 #if defined (WIN32)
 884 /* APC procedure for thread cancellation */
 885 static void CALLBACK vlc_cancel_self (ULONG_PTR dummy)
 886 {
 887     (void)dummy;
 888     vlc_control_cancel (VLC_DO_CANCEL);
 889 }
 890 #endif
 891
 892 /**
 893  * Marks a thread as cancelled. Next time the target thread reaches a
 894  * cancellation point (while not having disabled cancellation), it will
 895  * run its cancellation cleanup handler, the thread variable destructors, and
 896  * terminate. vlc_join() must be used afterward regardless of a thread being
 897  * cancelled or not.
 898  */
 899 void vlc_cancel (vlc_thread_t thread_id)
 900 {
 901 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
 902     pthread_cancel (thread_id);
 903 #elif defined (UNDER_CE)
 904     SetEvent (thread_id->cancel_event);
 905 #elif defined (WIN32)
 906     QueueUserAPC (vlc_cancel_self, thread_id->handle, 0);
 907 #else
 908 #   warning vlc_cancel is not implemented!
 909 #endif
 910 }
 911
 912 /**
 913  * Waits for a thread to complete (if needed), and destroys it.
 914  * This is a cancellation point; in case of cancellation, the join does _not_
 915  * occur.
 916  *
 917  * @param handle thread handle
 918  * @param p_result [OUT] pointer to write the thread return value or NULL
 919  * @return 0 on success, a standard error code otherwise.
 920  */
 921 void vlc_join (vlc_thread_t handle, void **result)
 922 {
 923 #if defined( LIBVLC_USE_PTHREAD )
 924     int val = pthread_join (handle, result);
 925     VLC_THREAD_ASSERT ("joining thread");
 926
 927 #elif defined( UNDER_CE ) || defined( WIN32 )
 928     do
 929         vlc_testcancel ();
 930     while (WaitForSingleObjectEx (handle->handle, INFINITE, TRUE)
 931                                                         == WAIT_IO_COMPLETION);
 932
 933     CloseHandle (handle->handle);
 934     if (result)
 935         *result = handle->data;
 936 #if defined( UNDER_CE )
 937     CloseHandle (handle->cancel_event);
 938 #endif
 939     free (handle);
 940
 941 #endif
 942 }
 943
 944 /**
 945  * Save the current cancellation state (enabled or disabled), then disable
 946  * cancellation for the calling thread.
 947  * This function must be called before entering a piece of code that is not
 948  * cancellation-safe, unless it can be proven that the calling thread will not
 949  * be cancelled.
 950  * @return Previous cancellation state (opaque value for vlc_restorecancel()).
 951  */
 952 int vlc_savecancel (void)
 953 {
 954     int state;
 955
 956 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
 957     int val = pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, &state);
 958     VLC_THREAD_ASSERT ("saving cancellation");
 959
 960 #else
 961     vlc_cancel_t *nfo = vlc_threadvar_get (cancel_key);
 962     if (nfo == NULL)
 963         return false; /* Main thread - cannot be cancelled anyway */
 964
 965      state = nfo->killable;
 966      nfo->killable = false;
 967
 968 #endif
 969     return state;
 970 }
 971
 972 /**
 973  * Restore the cancellation state for the calling thread.
 974  * @param state previous state as returned by vlc_savecancel().
 975  * @return Nothing, always succeeds.
 976  */
 977 void vlc_restorecancel (int state)
 978 {
 979 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
 980 # ifndef NDEBUG
 981     int oldstate, val;
 982
 983     val = pthread_setcancelstate (state, &oldstate);
 984     /* This should fail if an invalid value for given for state */
 985     VLC_THREAD_ASSERT ("restoring cancellation");
 986
 987     if (oldstate != PTHREAD_CANCEL_DISABLE)
 988          vlc_thread_fatal ("restoring cancellation while not disabled", EINVAL,
 989                            __func__, __FILE__, __LINE__);
 990 # else
 991     pthread_setcancelstate (state, NULL);
 992 # endif
 993
 994 #else
 995     vlc_cancel_t *nfo = vlc_threadvar_get (cancel_key);
 996     assert (state == false || state == true);
 997
 998     if (nfo == NULL)
 999         return; /* Main thread - cannot be cancelled anyway */
1000
1001     assert (!nfo->killable);
1002     nfo->killable = state != 0;
1003
1004 #endif
1005 }
1006
1007 /**
1008  * Issues an explicit deferred cancellation point.
1009  * This has no effect if thread cancellation is disabled.
1010  * This can be called when there is a rather slow non-sleeping operation.
1011  * This is also used to force a cancellation point in a function that would
1012  * otherwise "not always" be a one (block_FifoGet() is an example).
1013  */
1014 void vlc_testcancel (void)
1015 {
1016 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
1017     pthread_testcancel ();
1018
1019 #else
1020     vlc_cancel_t *nfo = vlc_threadvar_get (cancel_key);
1021     if (nfo == NULL)
1022         return; /* Main thread - cannot be cancelled anyway */
1023
1024     if (nfo->killable && nfo->killed)
1025     {
1026         for (vlc_cleanup_t *p = nfo->cleaners; p != NULL; p = p->next)
1027              p->proc (p->data);
1028 # if defined (LIBVLC_USE_PTHREAD)
1029         pthread_exit (PTHREAD_CANCELLED);
1030 # elif defined (UNDER_CE)
1031         ExitThread(0);
1032 # elif defined (WIN32)
1033         _endthread ();
1034 # else
1035 #  error Not implemented!
1036 # endif
1037     }
1038 #endif
1039 }
1040
1041
1042 struct vlc_thread_boot
1043 {
1044     void * (*entry) (vlc_object_t *);
1045     vlc_object_t *object;
1046 };
1047
1048 static void *thread_entry (void *data)
1049 {
1050     vlc_object_t *obj = ((struct vlc_thread_boot *)data)->object;
1051     void *(*func) (vlc_object_t *) = ((struct vlc_thread_boot *)data)->entry;
1052
1053     free (data);
1054     msg_Dbg (obj, "thread started");
1055     func (obj);
1056     msg_Dbg (obj, "thread ended");
1057
1058     return NULL;
1059 }
1060
1061 #undef vlc_thread_create
1062 /*****************************************************************************
1063  * vlc_thread_create: create a thread
1064  *****************************************************************************
1065  * Note that i_priority is only taken into account on platforms supporting
1066  * userland real-time priority threads.
1067  *****************************************************************************/
1068 int vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line,
1069                        const char *psz_name, void *(*func) ( vlc_object_t * ),
1070                        int i_priority )
1071 {
1072     int i_ret;
1073     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1074
1075     struct vlc_thread_boot *boot = malloc (sizeof (*boot));
1076     if (boot == NULL)
1077         return errno;
1078     boot->entry = func;
1079     boot->object = p_this;
1080
1081     /* Make sure we don't re-create a thread if the object has already one */
1082     assert( !p_priv->b_thread );
1083
1084 #if defined( LIBVLC_USE_PTHREAD )
1085 #ifndef __APPLE__
1086     if( config_GetInt( p_this, "rt-priority" ) > 0 )
1087 #endif
1088     {
1089         /* Hack to avoid error msg */
1090         if( config_GetType( p_this, "rt-offset" ) )
1091             i_priority += config_GetInt( p_this, "rt-offset" );
1092     }
1093 #endif
1094
1095     p_priv->b_thread = true;
1096     i_ret = vlc_clone( &p_priv->thread_id, thread_entry, boot, i_priority );
1097     if( i_ret == 0 )
1098         msg_Dbg( p_this, "thread (%s) created at priority %d (%s:%d)",
1099                  psz_name, i_priority, psz_file, i_line );
1100     else
1101     {
1102         p_priv->b_thread = false;
1103         errno = i_ret;
1104         msg_Err( p_this, "%s thread could not be created at %s:%d (%m)",
1105                          psz_name, psz_file, i_line );
1106     }
1107
1108     return i_ret;
1109 }
1110
1111 /*****************************************************************************
1112  * vlc_thread_set_priority: set the priority of the current thread when we
1113  * couldn't set it in vlc_thread_create (for instance for the main thread)
1114  *****************************************************************************/
1115 int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file,
1116                                int i_line, int i_priority )
1117 {
1118     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1119
1120     if( !p_priv->b_thread )
1121     {
1122         msg_Err( p_this, "couldn't set priority of non-existent thread" );
1123         return ESRCH;
1124     }
1125
1126 #if defined( LIBVLC_USE_PTHREAD )
1127 # ifndef __APPLE__
1128     if( config_GetInt( p_this, "rt-priority" ) > 0 )
1129 # endif
1130     {
1131         int i_error, i_policy;
1132         struct sched_param param;
1133
1134         memset( &param, 0, sizeof(struct sched_param) );
1135         if( config_GetType( p_this, "rt-offset" ) )
1136             i_priority += config_GetInt( p_this, "rt-offset" );
1137         if( i_priority <= 0 )
1138         {
1139             param.sched_priority = (-1) * i_priority;
1140             i_policy = SCHED_OTHER;
1141         }
1142         else
1143         {
1144             param.sched_priority = i_priority;
1145             i_policy = SCHED_RR;
1146         }
1147         if( (i_error = pthread_setschedparam( p_priv->thread_id,
1148                                               i_policy, &param )) )
1149         {
1150             errno = i_error;
1151             msg_Warn( p_this, "couldn't set thread priority (%s:%d): %m",
1152                       psz_file, i_line );
1153             i_priority = 0;
1154         }
1155     }
1156
1157 #elif defined( WIN32 ) || defined( UNDER_CE )
1158     VLC_UNUSED( psz_file); VLC_UNUSED( i_line );
1159
1160     if( !SetThreadPriority(p_priv->thread_id->handle, i_priority) )
1161     {
1162         msg_Warn( p_this, "couldn't set a faster priority" );
1163         return 1;
1164     }
1165
1166 #endif
1167
1168     return 0;
1169 }
1170
1171 /*****************************************************************************
1172  * vlc_thread_join: wait until a thread exits, inner version
1173  *****************************************************************************/
1174 void __vlc_thread_join( vlc_object_t *p_this )
1175 {
1176     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1177
1178 #if defined( LIBVLC_USE_PTHREAD )
1179     vlc_join (p_priv->thread_id, NULL);
1180
1181 #elif defined( UNDER_CE ) || defined( WIN32 )
1182     HANDLE hThread;
1183     FILETIME create_ft, exit_ft, kernel_ft, user_ft;
1184     int64_t real_time, kernel_time, user_time;
1185
1186 #ifndef UNDER_CE
1187     if( ! DuplicateHandle(GetCurrentProcess(),
1188             p_priv->thread_id->handle,
1189             GetCurrentProcess(),
1190             &hThread,
1191             0,
1192             FALSE,
1193             DUPLICATE_SAME_ACCESS) )
1194     {
1195         p_priv->b_thread = false;
1196         return; /* We have a problem! */
1197     }
1198 #else
1199     hThread = p_priv->thread_id->handle;
1200 #endif
1201
1202     vlc_join( p_priv->thread_id, NULL );
1203
1204     if( GetThreadTimes( hThread, &create_ft, &exit_ft, &kernel_ft, &user_ft ) )
1205     {
1206         real_time =
1207           ((((int64_t)exit_ft.dwHighDateTime)<<32)| exit_ft.dwLowDateTime) -
1208           ((((int64_t)create_ft.dwHighDateTime)<<32)| create_ft.dwLowDateTime);
1209         real_time /= 10;
1210
1211         kernel_time =
1212           ((((int64_t)kernel_ft.dwHighDateTime)<<32)|
1213            kernel_ft.dwLowDateTime) / 10;
1214
1215         user_time =
1216           ((((int64_t)user_ft.dwHighDateTime)<<32)|
1217            user_ft.dwLowDateTime) / 10;
1218
1219         msg_Dbg( p_this, "thread times: "
1220                  "real %"PRId64"m%fs, kernel %"PRId64"m%fs, user %"PRId64"m%fs",
1221                  real_time/60/1000000,
1222                  (double)((real_time%(60*1000000))/1000000.0),
1223                  kernel_time/60/1000000,
1224                  (double)((kernel_time%(60*1000000))/1000000.0),
1225                  user_time/60/1000000,
1226                  (double)((user_time%(60*1000000))/1000000.0) );
1227     }
1228     CloseHandle( hThread );
1229
1230 #else
1231     vlc_join( p_priv->thread_id, NULL );
1232
1233 #endif
1234
1235     p_priv->b_thread = false;
1236 }
1237
1238 void vlc_thread_cancel (vlc_object_t *obj)
1239 {
1240     vlc_object_internals_t *priv = vlc_internals (obj);
1241
1242     if (priv->b_thread)
1243         vlc_cancel (priv->thread_id);
1244 }
1245
1246 void vlc_control_cancel (int cmd, ...)
1247 {
1248     /* NOTE: This function only modifies thread-specific data, so there is no
1249      * need to lock anything. */
1250 #ifdef LIBVLC_USE_PTHREAD_CANCEL
1251     (void) cmd;
1252     assert (0);
1253 #else
1254     va_list ap;
1255
1256     vlc_cancel_t *nfo = vlc_threadvar_get (cancel_key);
1257     if (nfo == NULL)
1258     {
1259 #ifdef WIN32
1260         /* Main thread - cannot be cancelled anyway */
1261         return;
1262 #else
1263         nfo = malloc (sizeof (*nfo));
1264         if (nfo == NULL)
1265             return; /* Uho! Expect problems! */
1266         *nfo = VLC_CANCEL_INIT;
1267         vlc_threadvar_set (cancel_key, nfo);
1268 #endif
1269     }
1270
1271     va_start (ap, cmd);
1272     switch (cmd)
1273     {
1274         case VLC_DO_CANCEL:
1275             nfo->killed = true;
1276             break;
1277
1278         case VLC_CLEANUP_PUSH:
1279         {
1280             /* cleaner is a pointer to the caller stack, no need to allocate
1281              * and copy anything. As a nice side effect, this cannot fail. */
1282             vlc_cleanup_t *cleaner = va_arg (ap, vlc_cleanup_t *);
1283             cleaner->next = nfo->cleaners;
1284             nfo->cleaners = cleaner;
1285             break;
1286         }
1287
1288         case VLC_CLEANUP_POP:
1289         {
1290             nfo->cleaners = nfo->cleaners->next;
1291             break;
1292         }
1293     }
1294     va_end (ap);
1295 #endif
1296 }