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 #define VLC_THREADS_UNINITIALIZED  0
  43 #define VLC_THREADS_PENDING        1
  44 #define VLC_THREADS_ERROR          2
  45 #define VLC_THREADS_READY          3
  46
  47 /*****************************************************************************
  48  * Global mutex for lazy initialization of the threads system
  49  *****************************************************************************/
  50 static volatile unsigned i_initializations = 0;
  51
  52 #if defined( LIBVLC_USE_PTHREAD )
  53 # include <sched.h>
  54
  55 static pthread_mutex_t once_mutex = PTHREAD_MUTEX_INITIALIZER;
  56 #else
  57 static vlc_threadvar_t cancel_key;
  58 #endif
  59
  60 /**
  61  * Global process-wide VLC object.
  62  * Contains inter-instance data, such as the module cache and global mutexes.
  63  */
  64 static libvlc_global_data_t *p_root;
  65
  66 libvlc_global_data_t *vlc_global( void )
  67 {
  68     assert( i_initializations > 0 );
  69     return p_root;
  70 }
  71
  72 #ifdef HAVE_EXECINFO_H
  73 # include <execinfo.h>
  74 #endif
  75
  76 /**
  77  * Print a backtrace to the standard error for debugging purpose.
  78  */
  79 void vlc_trace (const char *fn, const char *file, unsigned line)
  80 {
  81      fprintf (stderr, "at %s:%u in %s\n", file, line, fn);
  82      fflush (stderr); /* needed before switch to low-level I/O */
  83 #ifdef HAVE_BACKTRACE
  84      void *stack[20];
  85      int len = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
  86      backtrace_symbols_fd (stack, len, 2);
  87 #endif
  88 #ifndef WIN32
  89      fsync (2);
  90 #endif
  91 }
  92
  93 static inline unsigned long vlc_threadid (void)
  94 {
  95 #if defined(LIBVLC_USE_PTHREAD)
  96      union { pthread_t th; unsigned long int i; } v = { };
  97      v.th = pthread_self ();
  98      return v.i;
  99
 100 #elif defined (WIN32)
 101      return GetCurrentThreadId ();
 102
 103 #else
 104      return 0;
 105
 106 #endif
 107 }
 108
 109 /*****************************************************************************
 110  * vlc_thread_fatal: Report an error from the threading layer
 111  *****************************************************************************
 112  * This is mostly meant for debugging.
 113  *****************************************************************************/
 114 static void
 115 vlc_thread_fatal (const char *action, int error,
 116                   const char *function, const char *file, unsigned line)
 117 {
 118     fprintf (stderr, "LibVLC fatal error %s (%d) in thread %lu ",
 119              action, error, vlc_threadid ());
 120     vlc_trace (function, file, line);
 121
 122     /* Sometimes strerror_r() crashes too, so make sure we print an error
 123      * message before we invoke it */
 124 #ifdef __GLIBC__
 125     /* Avoid the strerror_r() prototype brain damage in glibc */
 126     errno = error;
 127     fprintf (stderr, " Error message: %m at:\n");
 128 #elif !defined (WIN32)
 129     char buf[1000];
 130     const char *msg;
 131
 132     switch (strerror_r (error, buf, sizeof (buf)))
 133     {
 134         case 0:
 135             msg = buf;
 136             break;
 137         case ERANGE: /* should never happen */
 138             msg = "unknwon (too big to display)";
 139             break;
 140         default:
 141             msg = "unknown (invalid error number)";
 142             break;
 143     }
 144     fprintf (stderr, " Error message: %s\n", msg);
 145 #endif
 146     fflush (stderr);
 147
 148     abort ();
 149 }
 150
 151 #ifndef NDEBUG
 152 # define VLC_THREAD_ASSERT( action ) \
 153     if (val) vlc_thread_fatal (action, val, __func__, __FILE__, __LINE__)
 154 #else
 155 # define VLC_THREAD_ASSERT( action ) ((void)val)
 156 #endif
 157
 158 /**
 159  * Per-thread cancellation data
 160  */
 161 #ifndef LIBVLC_USE_PTHREAD_CANCEL
 162 typedef struct vlc_cancel_t
 163 {
 164     vlc_cleanup_t *cleaners;
 165     bool           killable;
 166     bool           killed;
 167 } vlc_cancel_t;
 168
 169 # define VLC_CANCEL_INIT { NULL, true, false }
 170 #endif
 171
 172 /*****************************************************************************
 173  * vlc_threads_init: initialize threads system
 174  *****************************************************************************
 175  * This function requires lazy initialization of a global lock in order to
 176  * keep the library really thread-safe. Some architectures don't support this
 177  * and thus do not guarantee the complete reentrancy.
 178  *****************************************************************************/
 179 int vlc_threads_init( void )
 180 {
 181     int i_ret = VLC_SUCCESS;
 182
 183     /* If we have lazy mutex initialization, use it. Otherwise, we just
 184      * hope nothing wrong happens. */
 185 #if defined( LIBVLC_USE_PTHREAD )
 186     pthread_mutex_lock( &once_mutex );
 187 #endif
 188
 189     if( i_initializations == 0 )
 190     {
 191         p_root = vlc_custom_create( (vlc_object_t *)NULL, sizeof( *p_root ),
 192                                     VLC_OBJECT_GENERIC, "root" );
 193         if( p_root == NULL )
 194         {
 195             i_ret = VLC_ENOMEM;
 196             goto out;
 197         }
 198
 199         /* We should be safe now. Do all the initialization stuff we want. */
 200 #ifndef LIBVLC_USE_PTHREAD_CANCEL
 201         vlc_threadvar_create( &cancel_key, free );
 202 #endif
 203     }
 204     i_initializations++;
 205
 206 out:
 207     /* If we have lazy mutex initialization support, unlock the mutex.
 208      * Otherwize, we are screwed. */
 209 #if defined( LIBVLC_USE_PTHREAD )
 210     pthread_mutex_unlock( &once_mutex );
 211 #endif
 212
 213     return i_ret;
 214 }
 215
 216 /*****************************************************************************
 217  * vlc_threads_end: stop threads system
 218  *****************************************************************************
 219  * FIXME: This function is far from being threadsafe.
 220  *****************************************************************************/
 221 void vlc_threads_end( void )
 222 {
 223 #if defined( LIBVLC_USE_PTHREAD )
 224     pthread_mutex_lock( &once_mutex );
 225 #endif
 226
 227     assert( i_initializations > 0 );
 228
 229     if( i_initializations == 1 )
 230     {
 231         vlc_object_release( p_root );
 232 #ifndef LIBVLC_USE_PTHREAD
 233         vlc_threadvar_delete( &cancel_key );
 234 #endif
 235     }
 236     i_initializations--;
 237
 238 #if defined( LIBVLC_USE_PTHREAD )
 239     pthread_mutex_unlock( &once_mutex );
 240 #endif
 241 }
 242
 243 #if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 244 /* This is not prototyped under glibc, though it exists. */
 245 int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
 246 #endif
 247
 248 /*****************************************************************************
 249  * vlc_mutex_init: initialize a mutex
 250  *****************************************************************************/
 251 int vlc_mutex_init( vlc_mutex_t *p_mutex )
 252 {
 253 #if defined( LIBVLC_USE_PTHREAD )
 254     pthread_mutexattr_t attr;
 255     int                 i_result;
 256
 257     pthread_mutexattr_init( &attr );
 258
 259 # ifndef NDEBUG
 260     /* Create error-checking mutex to detect problems more easily. */
 261 #  if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 262     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP );
 263 #  else
 264     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK );
 265 #  endif
 266 # endif
 267     i_result = pthread_mutex_init( p_mutex, &attr );
 268     pthread_mutexattr_destroy( &attr );
 269     return i_result;
 270
 271 #elif defined( WIN32 )
 272     InitializeCriticalSection (&p_mutex->mutex);
 273     p_mutex->recursive = false;
 274     return 0;
 275
 276 #endif
 277 }
 278
 279 /*****************************************************************************
 280  * vlc_mutex_init: initialize a recursive mutex (Do not use)
 281  *****************************************************************************/
 282 int vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
 283 {
 284 #if defined( LIBVLC_USE_PTHREAD )
 285     pthread_mutexattr_t attr;
 286     int                 i_result;
 287
 288     pthread_mutexattr_init( &attr );
 289 #  if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
 290     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_RECURSIVE_NP );
 291 #  else
 292     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
 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     InitializeCriticalSection( &p_mutex->mutex );
 300     p_mutex->owner = 0; /* the error value for GetThreadId()! */
 301     p_mutex->recursion = 0;
 302     p_mutex->recursive = true;
 303     return 0;
 304
 305 #endif
 306 }
 307
 308
 309 /**
 310  * Destroys a mutex. The mutex must not be locked.
 311  *
 312  * @param p_mutex mutex to destroy
 313  * @return always succeeds
 314  */
 315 void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
 316 {
 317 #if defined( LIBVLC_USE_PTHREAD )
 318     int val = pthread_mutex_destroy( p_mutex );
 319     VLC_THREAD_ASSERT ("destroying mutex");
 320
 321 #elif defined( WIN32 )
 322     DeleteCriticalSection (&p_mutex->mutex);
 323
 324 #endif
 325 }
 326
 327 /**
 328  * Acquires a mutex. If needed, waits for any other thread to release it.
 329  * Beware of deadlocks when locking multiple mutexes at the same time,
 330  * or when using mutexes from callbacks.
 331  *
 332  * @param p_mutex mutex initialized with vlc_mutex_init() or
 333  *                vlc_mutex_init_recursive()
 334  */
 335 void vlc_mutex_lock (vlc_mutex_t *p_mutex)
 336 {
 337 #if defined(LIBVLC_USE_PTHREAD)
 338     int val = pthread_mutex_lock( p_mutex );
 339     VLC_THREAD_ASSERT ("locking mutex");
 340
 341 #elif defined( WIN32 )
 342     if (p_mutex->recursive)
 343     {
 344         DWORD self = GetCurrentThreadId ();
 345
 346         if ((DWORD)InterlockedCompareExchange (&p_mutex->owner, self,
 347                                                self) == self)
 348         {   /* We already locked this recursive mutex */
 349             p_mutex->recursion++;
 350             return;
 351         }
 352
 353         /* We need to lock this recursive mutex */
 354         EnterCriticalSection (&p_mutex->mutex);
 355         self = InterlockedCompareExchange (&p_mutex->owner, self, 0);
 356         assert (self == 0); /* no previous owner */
 357         return;
 358     }
 359     /* Non-recursive mutex */
 360     EnterCriticalSection (&p_mutex->mutex);
 361
 362 #endif
 363 }
 364
 365
 366 /**
 367  * Releases a mutex (or crashes if the mutex is not locked by the caller).
 368  * @param p_mutex mutex locked with vlc_mutex_lock().
 369  */
 370 void vlc_mutex_unlock (vlc_mutex_t *p_mutex)
 371 {
 372 #if defined(LIBVLC_USE_PTHREAD)
 373     int val = pthread_mutex_unlock( p_mutex );
 374     VLC_THREAD_ASSERT ("unlocking mutex");
 375
 376 #elif defined( WIN32 )
 377     if (p_mutex->recursive)
 378     {
 379         if (--p_mutex->recursion != 0)
 380             return; /* We still own this mutex */
 381
 382         /* We release the mutex */
 383         DWORD self = GetCurrentThreadId ();
 384         self = InterlockedCompareExchange (&p_mutex->owner, self, 0);
 385         assert (self == GetCurrentThreadId ());
 386         /* fall through */
 387     }
 388     LeaveCriticalSection (&p_mutex->mutex);
 389
 390 #endif
 391 }
 392
 393 /*****************************************************************************
 394  * vlc_cond_init: initialize a condition variable
 395  *****************************************************************************/
 396 int vlc_cond_init( vlc_cond_t *p_condvar )
 397 {
 398 #if defined( LIBVLC_USE_PTHREAD )
 399     pthread_condattr_t attr;
 400     int ret;
 401
 402     ret = pthread_condattr_init (&attr);
 403     if (ret)
 404         return ret;
 405
 406 # if !defined (_POSIX_CLOCK_SELECTION)
 407    /* Fairly outdated POSIX support (that was defined in 2001) */
 408 #  define _POSIX_CLOCK_SELECTION (-1)
 409 # endif
 410 # if (_POSIX_CLOCK_SELECTION >= 0)
 411     /* NOTE: This must be the same clock as the one in mtime.c */
 412     pthread_condattr_setclock (&attr, CLOCK_MONOTONIC);
 413 # endif
 414
 415     ret = pthread_cond_init (p_condvar, &attr);
 416     pthread_condattr_destroy (&attr);
 417     return ret;
 418
 419 #elif defined( WIN32 )
 420     /* Create a manual-reset event (manual reset is needed for broadcast). */
 421     *p_condvar = CreateEvent( NULL, TRUE, FALSE, NULL );
 422     return *p_condvar ? 0 : ENOMEM;
 423
 424 #endif
 425 }
 426
 427 /**
 428  * Destroys a condition variable. No threads shall be waiting or signaling the
 429  * condition.
 430  * @param p_condvar condition variable to destroy
 431  */
 432 void vlc_cond_destroy (vlc_cond_t *p_condvar)
 433 {
 434 #if defined( LIBVLC_USE_PTHREAD )
 435     int val = pthread_cond_destroy( p_condvar );
 436     VLC_THREAD_ASSERT ("destroying condition");
 437
 438 #elif defined( WIN32 )
 439     CloseHandle( *p_condvar );
 440
 441 #endif
 442 }
 443
 444 /**
 445  * Wakes up one thread waiting on a condition variable, if any.
 446  * @param p_condvar condition variable
 447  */
 448 void vlc_cond_signal (vlc_cond_t *p_condvar)
 449 {
 450 #if defined(LIBVLC_USE_PTHREAD)
 451     int val = pthread_cond_signal( p_condvar );
 452     VLC_THREAD_ASSERT ("signaling condition variable");
 453
 454 #elif defined( WIN32 )
 455     /* NOTE: This will cause a broadcast, that is wrong.
 456      * This will also wake up the next waiting thread if no thread are yet
 457      * waiting, which is also wrong. However both of these issues are allowed
 458      * by the provision for spurious wakeups. Better have too many wakeups
 459      * than too few (= deadlocks). */
 460     SetEvent (*p_condvar);
 461
 462 #endif
 463 }
 464
 465 /**
 466  * Wakes up all threads (if any) waiting on a condition variable.
 467  * @param p_cond condition variable
 468  */
 469 void vlc_cond_broadcast (vlc_cond_t *p_condvar)
 470 {
 471 #if defined (LIBVLC_USE_PTHREAD)
 472     pthread_cond_broadcast (p_condvar);
 473
 474 #elif defined (WIN32)
 475     SetEvent (*p_condvar);
 476
 477 #endif
 478 }
 479
 480 #ifdef UNDER_CE
 481 # warning FIXME
 482 # define WaitForMultipleObjectsEx(a,b,c) WaitForMultipleObjects(a,b)
 483 #endif
 484
 485 /**
 486  * Waits for a condition variable. The calling thread will be suspended until
 487  * another thread calls vlc_cond_signal() or vlc_cond_broadcast() on the same
 488  * condition variable, the thread is cancelled with vlc_cancel(), or the
 489  * system causes a "spurious" unsolicited wake-up.
 490  *
 491  * A mutex is needed to wait on a condition variable. It must <b>not</b> be
 492  * a recursive mutex. Although it is possible to use the same mutex for
 493  * multiple condition, it is not valid to use different mutexes for the same
 494  * condition variable at the same time from different threads.
 495  *
 496  * In case of thread cancellation, the mutex is always locked before
 497  * cancellation proceeds.
 498  *
 499  * The canonical way to use a condition variable to wait for event foobar is:
 500  @code
 501    vlc_mutex_lock (&lock);
 502    mutex_cleanup_push (&lock); // release the mutex in case of cancellation
 503
 504    while (!foobar)
 505        vlc_cond_wait (&wait, &lock);
 506
 507    --- foobar is now true, do something about it here --
 508
 509    vlc_cleanup_run (); // release the mutex
 510   @endcode
 511  *
 512  * @param p_condvar condition variable to wait on
 513  * @param p_mutex mutex which is unlocked while waiting,
 514  *                then locked again when waking up.
 515  * @param deadline <b>absolute</b> timeout
 516  *
 517  * @return 0 if the condition was signaled, an error code in case of timeout.
 518  */
 519 void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
 520 {
 521 #if defined(LIBVLC_USE_PTHREAD)
 522     int val = pthread_cond_wait( p_condvar, p_mutex );
 523     VLC_THREAD_ASSERT ("waiting on condition");
 524
 525 #elif defined( WIN32 )
 526     DWORD result;
 527     do
 528     {
 529         vlc_testcancel ();
 530         LeaveCriticalSection (&p_mutex->mutex);
 531         result = WaitForSingleObjectEx (*p_condvar, INFINITE, TRUE);
 532         EnterCriticalSection (&p_mutex->mutex);
 533     }
 534     while (result == WAIT_IO_COMPLETION);
 535
 536 #endif
 537 }
 538
 539 /**
 540  * Waits for a condition variable up to a certain date.
 541  * This works like vlc_cond_wait(), except for the additional timeout.
 542  *
 543  * @param p_condvar condition variable to wait on
 544  * @param p_mutex mutex which is unlocked while waiting,
 545  *                then locked again when waking up.
 546  * @param deadline <b>absolute</b> timeout
 547  *
 548  * @return 0 if the condition was signaled, an error code in case of timeout.
 549  */
 550 int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
 551                         mtime_t deadline)
 552 {
 553 #if defined(LIBVLC_USE_PTHREAD)
 554     lldiv_t d = lldiv( deadline, CLOCK_FREQ );
 555     struct timespec ts = { d.quot, d.rem * (1000000000 / CLOCK_FREQ) };
 556
 557     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
 558     if (val != ETIMEDOUT)
 559         VLC_THREAD_ASSERT ("timed-waiting on condition");
 560     return val;
 561
 562 #elif defined( WIN32 )
 563     DWORD result;
 564
 565     do
 566     {
 567         vlc_testcancel ();
 568
 569         mtime_t total = (deadline - mdate ())/1000;
 570         if( total < 0 )
 571             total = 0;
 572
 573         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
 574         LeaveCriticalSection (&p_mutex->mutex);
 575         result = WaitForSingleObjectEx (*p_condvar, delay, TRUE);
 576         EnterCriticalSection (&p_mutex->mutex);
 577     }
 578     while (result == WAIT_IO_COMPLETION);
 579
 580     return (result == WAIT_OBJECT_0) ? 0 : ETIMEDOUT;
 581
 582 #endif
 583 }
 584
 585 /*****************************************************************************
 586  * vlc_tls_create: create a thread-local variable
 587  *****************************************************************************/
 588 int vlc_threadvar_create( vlc_threadvar_t *p_tls, void (*destr) (void *) )
 589 {
 590     int i_ret;
 591
 592 #if defined( LIBVLC_USE_PTHREAD )
 593     i_ret =  pthread_key_create( p_tls, destr );
 594 #elif defined( UNDER_CE )
 595     i_ret = ENOSYS;
 596 #elif defined( WIN32 )
 597     /* FIXME: remember/use the destr() callback and stop leaking whatever */
 598     *p_tls = TlsAlloc();
 599     i_ret = (*p_tls == TLS_OUT_OF_INDEXES) ? EAGAIN : 0;
 600 #else
 601 # error Unimplemented!
 602 #endif
 603     return i_ret;
 604 }
 605
 606 void vlc_threadvar_delete (vlc_threadvar_t *p_tls)
 607 {
 608 #if defined( LIBVLC_USE_PTHREAD )
 609     pthread_key_delete (*p_tls);
 610 #elif defined( UNDER_CE )
 611 #elif defined( WIN32 )
 612     TlsFree (*p_tls);
 613 #else
 614 # error Unimplemented!
 615 #endif
 616 }
 617
 618 #if defined (LIBVLC_USE_PTHREAD)
 619 #elif defined (WIN32)
 620 static unsigned __stdcall vlc_entry (void *data)
 621 {
 622     vlc_cancel_t cancel_data = VLC_CANCEL_INIT;
 623     vlc_thread_t self = data;
 624
 625     vlc_threadvar_set (&cancel_key, &cancel_data);
 626     self->data = self->entry (self->data);
 627     return 0;
 628 }
 629 #endif
 630
 631 /**
 632  * Creates and starts new thread.
 633  *
 634  * @param p_handle [OUT] pointer to write the handle of the created thread to
 635  * @param entry entry point for the thread
 636  * @param data data parameter given to the entry point
 637  * @param priority thread priority value
 638  * @return 0 on success, a standard error code on error.
 639  */
 640 int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
 641                int priority)
 642 {
 643     int ret;
 644
 645 #if defined( LIBVLC_USE_PTHREAD )
 646     pthread_attr_t attr;
 647     pthread_attr_init (&attr);
 648
 649     /* Block the signals that signals interface plugin handles.
 650      * If the LibVLC caller wants to handle some signals by itself, it should
 651      * block these before whenever invoking LibVLC. And it must obviously not
 652      * start the VLC signals interface plugin.
 653      *
 654      * LibVLC will normally ignore any interruption caused by an asynchronous
 655      * signal during a system call. But there may well be some buggy cases
 656      * where it fails to handle EINTR (bug reports welcome). Some underlying
 657      * libraries might also not handle EINTR properly.
 658      */
 659     sigset_t oldset;
 660     {
 661         sigset_t set;
 662         sigemptyset (&set);
 663         sigdelset (&set, SIGHUP);
 664         sigaddset (&set, SIGINT);
 665         sigaddset (&set, SIGQUIT);
 666         sigaddset (&set, SIGTERM);
 667
 668         sigaddset (&set, SIGPIPE); /* We don't want this one, really! */
 669         pthread_sigmask (SIG_BLOCK, &set, &oldset);
 670     }
 671     {
 672         struct sched_param sp = { .sched_priority = priority, };
 673         int policy;
 674
 675         if (sp.sched_priority <= 0)
 676             sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
 677         else
 678             sp.sched_priority += sched_get_priority_min (policy = SCHED_RR);
 679
 680         pthread_attr_setschedpolicy (&attr, policy);
 681         pthread_attr_setschedparam (&attr, &sp);
 682     }
 683
 684     ret = pthread_create (p_handle, &attr, entry, data);
 685     pthread_sigmask (SIG_SETMASK, &oldset, NULL);
 686     pthread_attr_destroy (&attr);
 687
 688 #elif defined( WIN32 ) || defined( UNDER_CE )
 689     /* When using the MSVCRT C library you have to use the _beginthreadex
 690      * function instead of CreateThread, otherwise you'll end up with
 691      * memory leaks and the signal functions not working (see Microsoft
 692      * Knowledge Base, article 104641) */
 693     HANDLE hThread;
 694     vlc_thread_t th = malloc (sizeof (*th));
 695
 696     if (th == NULL)
 697         return ENOMEM;
 698
 699     th->data = data;
 700     th->entry = entry;
 701 #if defined( UNDER_CE )
 702     hThread = CreateThread (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
 703 #else
 704     hThread = (HANDLE)(uintptr_t)
 705         _beginthreadex (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
 706 #endif
 707
 708     if (hThread)
 709     {
 710         /* Thread closes the handle when exiting, duplicate it here
 711          * to be on the safe side when joining. */
 712         if (!DuplicateHandle (GetCurrentProcess (), hThread,
 713                               GetCurrentProcess (), &th->handle, 0, FALSE,
 714                               DUPLICATE_SAME_ACCESS))
 715         {
 716             CloseHandle (hThread);
 717             free (th);
 718             return ENOMEM;
 719         }
 720
 721         ResumeThread (hThread);
 722         if (priority)
 723             SetThreadPriority (hThread, priority);
 724
 725         ret = 0;
 726         *p_handle = th;
 727     }
 728     else
 729     {
 730         ret = errno;
 731         free (th);
 732     }
 733
 734 #endif
 735     return ret;
 736 }
 737
 738 #if defined (WIN32)
 739 /* APC procedure for thread cancellation */
 740 static void CALLBACK vlc_cancel_self (ULONG_PTR dummy)
 741 {
 742     (void)dummy;
 743     vlc_control_cancel (VLC_DO_CANCEL);
 744 }
 745 #endif
 746
 747 /**
 748  * Marks a thread as cancelled. Next time the target thread reaches a
 749  * cancellation point (while not having disabled cancellation), it will
 750  * run its cancellation cleanup handler, the thread variable destructors, and
 751  * terminate. vlc_join() must be used afterward regardless of a thread being
 752  * cancelled or not.
 753  */
 754 void vlc_cancel (vlc_thread_t thread_id)
 755 {
 756 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
 757     pthread_cancel (thread_id);
 758 #elif defined (WIN32)
 759     QueueUserAPC (vlc_cancel_self, thread_id->handle, 0);
 760 #else
 761 #   warning vlc_cancel is not implemented!
 762 #endif
 763 }
 764
 765 /**
 766  * Waits for a thread to complete (if needed), and destroys it.
 767  * This is a cancellation point; in case of cancellation, the join does _not_
 768  * occur.
 769  *
 770  * @param handle thread handle
 771  * @param p_result [OUT] pointer to write the thread return value or NULL
 772  * @return 0 on success, a standard error code otherwise.
 773  */
 774 void vlc_join (vlc_thread_t handle, void **result)
 775 {
 776 #if defined( LIBVLC_USE_PTHREAD )
 777     int val = pthread_join (handle, result);
 778     if (val)
 779         vlc_thread_fatal ("joining thread", val, __func__, __FILE__, __LINE__);
 780
 781 #elif defined( UNDER_CE ) || defined( WIN32 )
 782     do
 783         vlc_testcancel ();
 784     while (WaitForSingleObjectEx (handle->handle, INFINITE, TRUE)
 785                                                         == WAIT_IO_COMPLETION);
 786
 787     CloseHandle (handle->handle);
 788     if (result)
 789         *result = handle->data;
 790     free (handle);
 791
 792 #endif
 793 }
 794
 795
 796 struct vlc_thread_boot
 797 {
 798     void * (*entry) (vlc_object_t *);
 799     vlc_object_t *object;
 800 };
 801
 802 static void *thread_entry (void *data)
 803 {
 804     vlc_object_t *obj = ((struct vlc_thread_boot *)data)->object;
 805     void *(*func) (vlc_object_t *) = ((struct vlc_thread_boot *)data)->entry;
 806
 807     free (data);
 808     msg_Dbg (obj, "thread started");
 809     func (obj);
 810     msg_Dbg (obj, "thread ended");
 811
 812     return NULL;
 813 }
 814
 815 /*****************************************************************************
 816  * vlc_thread_create: create a thread, inner version
 817  *****************************************************************************
 818  * Note that i_priority is only taken into account on platforms supporting
 819  * userland real-time priority threads.
 820  *****************************************************************************/
 821 int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line,
 822                          const char *psz_name, void * ( *func ) ( vlc_object_t * ),
 823                          int i_priority, bool b_wait )
 824 {
 825     int i_ret;
 826     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 827
 828     struct vlc_thread_boot *boot = malloc (sizeof (*boot));
 829     if (boot == NULL)
 830         return errno;
 831     boot->entry = func;
 832     boot->object = p_this;
 833
 834     vlc_object_lock( p_this );
 835
 836     /* Make sure we don't re-create a thread if the object has already one */
 837     assert( !p_priv->b_thread );
 838
 839 #if defined( LIBVLC_USE_PTHREAD )
 840 #ifndef __APPLE__
 841     if( config_GetInt( p_this, "rt-priority" ) > 0 )
 842 #endif
 843     {
 844         /* Hack to avoid error msg */
 845         if( config_GetType( p_this, "rt-offset" ) )
 846             i_priority += config_GetInt( p_this, "rt-offset" );
 847     }
 848 #endif
 849
 850     i_ret = vlc_clone( &p_priv->thread_id, thread_entry, boot, i_priority );
 851     if( i_ret == 0 )
 852     {
 853         if( b_wait )
 854         {
 855             msg_Dbg( p_this, "waiting for thread initialization" );
 856             vlc_object_wait( p_this );
 857         }
 858
 859         p_priv->b_thread = true;
 860         msg_Dbg( p_this, "thread %lu (%s) created at priority %d (%s:%d)",
 861                  (unsigned long)p_priv->thread_id, psz_name, i_priority,
 862                  psz_file, i_line );
 863     }
 864     else
 865     {
 866         errno = i_ret;
 867         msg_Err( p_this, "%s thread could not be created at %s:%d (%m)",
 868                          psz_name, psz_file, i_line );
 869     }
 870
 871     vlc_object_unlock( p_this );
 872     return i_ret;
 873 }
 874
 875 /*****************************************************************************
 876  * vlc_thread_set_priority: set the priority of the current thread when we
 877  * couldn't set it in vlc_thread_create (for instance for the main thread)
 878  *****************************************************************************/
 879 int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file,
 880                                int i_line, int i_priority )
 881 {
 882     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 883
 884     if( !p_priv->b_thread )
 885     {
 886         msg_Err( p_this, "couldn't set priority of non-existent thread" );
 887         return ESRCH;
 888     }
 889
 890 #if defined( LIBVLC_USE_PTHREAD )
 891 # ifndef __APPLE__
 892     if( config_GetInt( p_this, "rt-priority" ) > 0 )
 893 # endif
 894     {
 895         int i_error, i_policy;
 896         struct sched_param param;
 897
 898         memset( &param, 0, sizeof(struct sched_param) );
 899         if( config_GetType( p_this, "rt-offset" ) )
 900             i_priority += config_GetInt( p_this, "rt-offset" );
 901         if( i_priority <= 0 )
 902         {
 903             param.sched_priority = (-1) * i_priority;
 904             i_policy = SCHED_OTHER;
 905         }
 906         else
 907         {
 908             param.sched_priority = i_priority;
 909             i_policy = SCHED_RR;
 910         }
 911         if( (i_error = pthread_setschedparam( p_priv->thread_id,
 912                                               i_policy, &param )) )
 913         {
 914             errno = i_error;
 915             msg_Warn( p_this, "couldn't set thread priority (%s:%d): %m",
 916                       psz_file, i_line );
 917             i_priority = 0;
 918         }
 919     }
 920
 921 #elif defined( WIN32 ) || defined( UNDER_CE )
 922     VLC_UNUSED( psz_file); VLC_UNUSED( i_line );
 923
 924     if( !SetThreadPriority(p_priv->thread_id->handle, i_priority) )
 925     {
 926         msg_Warn( p_this, "couldn't set a faster priority" );
 927         return 1;
 928     }
 929
 930 #endif
 931
 932     return 0;
 933 }
 934
 935 /*****************************************************************************
 936  * vlc_thread_join: wait until a thread exits, inner version
 937  *****************************************************************************/
 938 void __vlc_thread_join( vlc_object_t *p_this )
 939 {
 940     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 941
 942 #if defined( LIBVLC_USE_PTHREAD )
 943     vlc_join (p_priv->thread_id, NULL);
 944
 945 #elif defined( UNDER_CE ) || defined( WIN32 )
 946     HANDLE hThread;
 947     FILETIME create_ft, exit_ft, kernel_ft, user_ft;
 948     int64_t real_time, kernel_time, user_time;
 949
 950     if( ! DuplicateHandle(GetCurrentProcess(),
 951             p_priv->thread_id->handle,
 952             GetCurrentProcess(),
 953             &hThread,
 954             0,
 955             FALSE,
 956             DUPLICATE_SAME_ACCESS) )
 957     {
 958         p_priv->b_thread = false;
 959         return; /* We have a problem! */
 960     }
 961
 962     vlc_join( p_priv->thread_id, NULL );
 963
 964     if( GetThreadTimes( hThread, &create_ft, &exit_ft, &kernel_ft, &user_ft ) )
 965     {
 966         real_time =
 967           ((((int64_t)exit_ft.dwHighDateTime)<<32)| exit_ft.dwLowDateTime) -
 968           ((((int64_t)create_ft.dwHighDateTime)<<32)| create_ft.dwLowDateTime);
 969         real_time /= 10;
 970
 971         kernel_time =
 972           ((((int64_t)kernel_ft.dwHighDateTime)<<32)|
 973            kernel_ft.dwLowDateTime) / 10;
 974
 975         user_time =
 976           ((((int64_t)user_ft.dwHighDateTime)<<32)|
 977            user_ft.dwLowDateTime) / 10;
 978
 979         msg_Dbg( p_this, "thread times: "
 980                  "real %"PRId64"m%fs, kernel %"PRId64"m%fs, user %"PRId64"m%fs",
 981                  real_time/60/1000000,
 982                  (double)((real_time%(60*1000000))/1000000.0),
 983                  kernel_time/60/1000000,
 984                  (double)((kernel_time%(60*1000000))/1000000.0),
 985                  user_time/60/1000000,
 986                  (double)((user_time%(60*1000000))/1000000.0) );
 987     }
 988     CloseHandle( hThread );
 989
 990 #else
 991     vlc_join( p_priv->thread_id, NULL );
 992
 993 #endif
 994
 995     p_priv->b_thread = false;
 996 }
 997
 998 void vlc_thread_cancel (vlc_object_t *obj)
 999 {
1000     vlc_object_internals_t *priv = vlc_internals (obj);
1001
1002     if (priv->b_thread)
1003         vlc_cancel (priv->thread_id);
1004 }
1005
1006 void vlc_control_cancel (int cmd, ...)
1007 {
1008     /* NOTE: This function only modifies thread-specific data, so there is no
1009      * need to lock anything. */
1010 #ifdef LIBVLC_USE_PTHREAD_CANCEL
1011     (void) cmd;
1012     assert (0);
1013 #else
1014     va_list ap;
1015
1016     vlc_cancel_t *nfo = vlc_threadvar_get (&cancel_key);
1017     if (nfo == NULL)
1018     {
1019 #ifdef WIN32
1020         /* Main thread - cannot be cancelled anyway */
1021         return;
1022 #else
1023         nfo = malloc (sizeof (*nfo));
1024         if (nfo == NULL)
1025             return; /* Uho! Expect problems! */
1026         *nfo = VLC_CANCEL_INIT;
1027         vlc_threadvar_set (&cancel_key, nfo);
1028 #endif
1029     }
1030
1031     va_start (ap, cmd);
1032     switch (cmd)
1033     {
1034         case VLC_SAVE_CANCEL:
1035         {
1036             int *p_state = va_arg (ap, int *);
1037             *p_state = nfo->killable;
1038             nfo->killable = false;
1039             break;
1040         }
1041
1042         case VLC_RESTORE_CANCEL:
1043         {
1044             int state = va_arg (ap, int);
1045             nfo->killable = state != 0;
1046             break;
1047         }
1048
1049         case VLC_TEST_CANCEL:
1050             if (nfo->killable && nfo->killed)
1051             {
1052                 for (vlc_cleanup_t *p = nfo->cleaners; p != NULL; p = p->next)
1053                      p->proc (p->data);
1054                 free (nfo);
1055 #if defined (LIBVLC_USE_PTHREAD)
1056                 pthread_exit (PTHREAD_CANCELLED);
1057 #elif defined (WIN32)
1058                 _endthread ();
1059 #else
1060 # error Not implemented!
1061 #endif
1062             }
1063             break;
1064
1065         case VLC_DO_CANCEL:
1066             nfo->killed = true;
1067             break;
1068
1069         case VLC_CLEANUP_PUSH:
1070         {
1071             /* cleaner is a pointer to the caller stack, no need to allocate
1072              * and copy anything. As a nice side effect, this cannot fail. */
1073             vlc_cleanup_t *cleaner = va_arg (ap, vlc_cleanup_t *);
1074             cleaner->next = nfo->cleaners;
1075             nfo->cleaners = cleaner;
1076             break;
1077         }
1078
1079         case VLC_CLEANUP_POP:
1080         {
1081             nfo->cleaners = nfo->cleaners->next;
1082             break;
1083         }
1084     }
1085     va_end (ap);
1086 #endif
1087 }