Win32: fix recursive locking imbalance
[vlc.git] / 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         {
381             p_mutex->recursion--;
382             return; /* We still own this mutex */
383         }
384
385         /* We release the mutex */
386         DWORD self = GetCurrentThreadId ();
387         self = InterlockedCompareExchange (&p_mutex->owner, self, 0);
388         assert (self == GetCurrentThreadId ());
389         /* fall through */
390     }
391     LeaveCriticalSection (&p_mutex->mutex);
392
393 #endif
394 }
395
396 /*****************************************************************************
397  * vlc_cond_init: initialize a condition variable
398  *****************************************************************************/
399 int vlc_cond_init( vlc_cond_t *p_condvar )
400 {
401 #if defined( LIBVLC_USE_PTHREAD )
402     pthread_condattr_t attr;
403     int ret;
404
405     ret = pthread_condattr_init (&attr);
406     if (ret)
407         return ret;
408
409 # if !defined (_POSIX_CLOCK_SELECTION)
410    /* Fairly outdated POSIX support (that was defined in 2001) */
411 #  define _POSIX_CLOCK_SELECTION (-1)
412 # endif
413 # if (_POSIX_CLOCK_SELECTION >= 0)
414     /* NOTE: This must be the same clock as the one in mtime.c */
415     pthread_condattr_setclock (&attr, CLOCK_MONOTONIC);
416 # endif
417
418     ret = pthread_cond_init (p_condvar, &attr);
419     pthread_condattr_destroy (&attr);
420     return ret;
421
422 #elif defined( WIN32 )
423     /* Create a manual-reset event (manual reset is needed for broadcast). */
424     *p_condvar = CreateEvent( NULL, TRUE, FALSE, NULL );
425     return *p_condvar ? 0 : ENOMEM;
426
427 #endif
428 }
429
430 /**
431  * Destroys a condition variable. No threads shall be waiting or signaling the
432  * condition.
433  * @param p_condvar condition variable to destroy
434  */
435 void vlc_cond_destroy (vlc_cond_t *p_condvar)
436 {
437 #if defined( LIBVLC_USE_PTHREAD )
438     int val = pthread_cond_destroy( p_condvar );
439     VLC_THREAD_ASSERT ("destroying condition");
440
441 #elif defined( WIN32 )
442     CloseHandle( *p_condvar );
443
444 #endif
445 }
446
447 /**
448  * Wakes up one thread waiting on a condition variable, if any.
449  * @param p_condvar condition variable
450  */
451 void vlc_cond_signal (vlc_cond_t *p_condvar)
452 {
453 #if defined(LIBVLC_USE_PTHREAD)
454     int val = pthread_cond_signal( p_condvar );
455     VLC_THREAD_ASSERT ("signaling condition variable");
456
457 #elif defined( WIN32 )
458     /* NOTE: This will cause a broadcast, that is wrong.
459      * This will also wake up the next waiting thread if no thread are yet
460      * waiting, which is also wrong. However both of these issues are allowed
461      * by the provision for spurious wakeups. Better have too many wakeups
462      * than too few (= deadlocks). */
463     SetEvent (*p_condvar);
464
465 #endif
466 }
467
468 /**
469  * Wakes up all threads (if any) waiting on a condition variable.
470  * @param p_cond condition variable
471  */
472 void vlc_cond_broadcast (vlc_cond_t *p_condvar)
473 {
474 #if defined (LIBVLC_USE_PTHREAD)
475     pthread_cond_broadcast (p_condvar);
476
477 #elif defined (WIN32)
478     SetEvent (*p_condvar);
479
480 #endif
481 }
482
483 #ifdef UNDER_CE
484 # warning FIXME
485 # define WaitForMultipleObjectsEx(a,b,c) WaitForMultipleObjects(a,b)
486 #endif
487
488 /**
489  * Waits for a condition variable. The calling thread will be suspended until
490  * another thread calls vlc_cond_signal() or vlc_cond_broadcast() on the same
491  * condition variable, the thread is cancelled with vlc_cancel(), or the
492  * system causes a "spurious" unsolicited wake-up.
493  *
494  * A mutex is needed to wait on a condition variable. It must <b>not</b> be
495  * a recursive mutex. Although it is possible to use the same mutex for
496  * multiple condition, it is not valid to use different mutexes for the same
497  * condition variable at the same time from different threads.
498  *
499  * In case of thread cancellation, the mutex is always locked before
500  * cancellation proceeds.
501  *
502  * The canonical way to use a condition variable to wait for event foobar is:
503  @code
504    vlc_mutex_lock (&lock);
505    mutex_cleanup_push (&lock); // release the mutex in case of cancellation
506
507    while (!foobar)
508        vlc_cond_wait (&wait, &lock);
509
510    --- foobar is now true, do something about it here --
511
512    vlc_cleanup_run (); // release the mutex
513   @endcode
514  *
515  * @param p_condvar condition variable to wait on
516  * @param p_mutex mutex which is unlocked while waiting,
517  *                then locked again when waking up.
518  * @param deadline <b>absolute</b> timeout
519  *
520  * @return 0 if the condition was signaled, an error code in case of timeout.
521  */
522 void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
523 {
524 #if defined(LIBVLC_USE_PTHREAD)
525     int val = pthread_cond_wait( p_condvar, p_mutex );
526     VLC_THREAD_ASSERT ("waiting on condition");
527
528 #elif defined( WIN32 )
529     DWORD result;
530     do
531     {
532         vlc_testcancel ();
533         LeaveCriticalSection (&p_mutex->mutex);
534         result = WaitForSingleObjectEx (*p_condvar, INFINITE, TRUE);
535         EnterCriticalSection (&p_mutex->mutex);
536         ResetEvent (*p_condvar);
537     }
538     while (result == WAIT_IO_COMPLETION);
539
540 #endif
541 }
542
543 /**
544  * Waits for a condition variable up to a certain date.
545  * This works like vlc_cond_wait(), except for the additional timeout.
546  *
547  * @param p_condvar condition variable to wait on
548  * @param p_mutex mutex which is unlocked while waiting,
549  *                then locked again when waking up.
550  * @param deadline <b>absolute</b> timeout
551  *
552  * @return 0 if the condition was signaled, an error code in case of timeout.
553  */
554 int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
555                         mtime_t deadline)
556 {
557 #if defined(LIBVLC_USE_PTHREAD)
558     lldiv_t d = lldiv( deadline, CLOCK_FREQ );
559     struct timespec ts = { d.quot, d.rem * (1000000000 / CLOCK_FREQ) };
560
561     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
562     if (val != ETIMEDOUT)
563         VLC_THREAD_ASSERT ("timed-waiting on condition");
564     return val;
565
566 #elif defined( WIN32 )
567     DWORD result;
568
569     do
570     {
571         vlc_testcancel ();
572
573         mtime_t total = (deadline - mdate ())/1000;
574         if( total < 0 )
575             total = 0;
576
577         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
578         LeaveCriticalSection (&p_mutex->mutex);
579         result = WaitForSingleObjectEx (*p_condvar, delay, TRUE);
580         EnterCriticalSection (&p_mutex->mutex);
581         ResetEvent (*p_condvar);
582     }
583     while (result == WAIT_IO_COMPLETION);
584
585     return (result == WAIT_OBJECT_0) ? 0 : ETIMEDOUT;
586
587 #endif
588 }
589
590 /*****************************************************************************
591  * vlc_tls_create: create a thread-local variable
592  *****************************************************************************/
593 int vlc_threadvar_create( vlc_threadvar_t *p_tls, void (*destr) (void *) )
594 {
595     int i_ret;
596
597 #if defined( LIBVLC_USE_PTHREAD )
598     i_ret =  pthread_key_create( p_tls, destr );
599 #elif defined( UNDER_CE )
600     i_ret = ENOSYS;
601 #elif defined( WIN32 )
602     /* FIXME: remember/use the destr() callback and stop leaking whatever */
603     *p_tls = TlsAlloc();
604     i_ret = (*p_tls == TLS_OUT_OF_INDEXES) ? EAGAIN : 0;
605 #else
606 # error Unimplemented!
607 #endif
608     return i_ret;
609 }
610
611 void vlc_threadvar_delete (vlc_threadvar_t *p_tls)
612 {
613 #if defined( LIBVLC_USE_PTHREAD )
614     pthread_key_delete (*p_tls);
615 #elif defined( UNDER_CE )
616 #elif defined( WIN32 )
617     TlsFree (*p_tls);
618 #else
619 # error Unimplemented!
620 #endif
621 }
622
623 #if defined (LIBVLC_USE_PTHREAD)
624 #elif defined (WIN32)
625 static unsigned __stdcall vlc_entry (void *data)
626 {
627     vlc_cancel_t cancel_data = VLC_CANCEL_INIT;
628     vlc_thread_t self = data;
629
630     vlc_threadvar_set (&cancel_key, &cancel_data);
631     self->data = self->entry (self->data);
632     return 0;
633 }
634 #endif
635
636 /**
637  * Creates and starts new thread.
638  *
639  * @param p_handle [OUT] pointer to write the handle of the created thread to
640  * @param entry entry point for the thread
641  * @param data data parameter given to the entry point
642  * @param priority thread priority value
643  * @return 0 on success, a standard error code on error.
644  */
645 int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
646                int priority)
647 {
648     int ret;
649
650 #if defined( LIBVLC_USE_PTHREAD )
651     pthread_attr_t attr;
652     pthread_attr_init (&attr);
653
654     /* Block the signals that signals interface plugin handles.
655      * If the LibVLC caller wants to handle some signals by itself, it should
656      * block these before whenever invoking LibVLC. And it must obviously not
657      * start the VLC signals interface plugin.
658      *
659      * LibVLC will normally ignore any interruption caused by an asynchronous
660      * signal during a system call. But there may well be some buggy cases
661      * where it fails to handle EINTR (bug reports welcome). Some underlying
662      * libraries might also not handle EINTR properly.
663      */
664     sigset_t oldset;
665     {
666         sigset_t set;
667         sigemptyset (&set);
668         sigdelset (&set, SIGHUP);
669         sigaddset (&set, SIGINT);
670         sigaddset (&set, SIGQUIT);
671         sigaddset (&set, SIGTERM);
672
673         sigaddset (&set, SIGPIPE); /* We don't want this one, really! */
674         pthread_sigmask (SIG_BLOCK, &set, &oldset);
675     }
676     {
677         struct sched_param sp = { .sched_priority = priority, };
678         int policy;
679
680         if (sp.sched_priority <= 0)
681             sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
682         else
683             sp.sched_priority += sched_get_priority_min (policy = SCHED_RR);
684
685         pthread_attr_setschedpolicy (&attr, policy);
686         pthread_attr_setschedparam (&attr, &sp);
687     }
688
689     ret = pthread_create (p_handle, &attr, entry, data);
690     pthread_sigmask (SIG_SETMASK, &oldset, NULL);
691     pthread_attr_destroy (&attr);
692
693 #elif defined( WIN32 ) || defined( UNDER_CE )
694     /* When using the MSVCRT C library you have to use the _beginthreadex
695      * function instead of CreateThread, otherwise you'll end up with
696      * memory leaks and the signal functions not working (see Microsoft
697      * Knowledge Base, article 104641) */
698     HANDLE hThread;
699     vlc_thread_t th = malloc (sizeof (*th));
700
701     if (th == NULL)
702         return ENOMEM;
703
704     th->data = data;
705     th->entry = entry;
706 #if defined( UNDER_CE )
707     hThread = CreateThread (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
708 #else
709     hThread = (HANDLE)(uintptr_t)
710         _beginthreadex (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
711 #endif
712
713     if (hThread)
714     {
715         /* Thread closes the handle when exiting, duplicate it here
716          * to be on the safe side when joining. */
717         if (!DuplicateHandle (GetCurrentProcess (), hThread,
718                               GetCurrentProcess (), &th->handle, 0, FALSE,
719                               DUPLICATE_SAME_ACCESS))
720         {
721             CloseHandle (hThread);
722             free (th);
723             return ENOMEM;
724         }
725
726         ResumeThread (hThread);
727         if (priority)
728             SetThreadPriority (hThread, priority);
729
730         ret = 0;
731         *p_handle = th;
732     }
733     else
734     {
735         ret = errno;
736         free (th);
737     }
738
739 #endif
740     return ret;
741 }
742
743 #if defined (WIN32)
744 /* APC procedure for thread cancellation */
745 static void CALLBACK vlc_cancel_self (ULONG_PTR dummy)
746 {
747     (void)dummy;
748     vlc_control_cancel (VLC_DO_CANCEL);
749 }
750 #endif
751
752 /**
753  * Marks a thread as cancelled. Next time the target thread reaches a
754  * cancellation point (while not having disabled cancellation), it will
755  * run its cancellation cleanup handler, the thread variable destructors, and
756  * terminate. vlc_join() must be used afterward regardless of a thread being
757  * cancelled or not.
758  */
759 void vlc_cancel (vlc_thread_t thread_id)
760 {
761 #if defined (LIBVLC_USE_PTHREAD_CANCEL)
762     pthread_cancel (thread_id);
763 #elif defined (WIN32)
764     QueueUserAPC (vlc_cancel_self, thread_id->handle, 0);
765 #else
766 #   warning vlc_cancel is not implemented!
767 #endif
768 }
769
770 /**
771  * Waits for a thread to complete (if needed), and destroys it.
772  * This is a cancellation point; in case of cancellation, the join does _not_
773  * occur.
774  *
775  * @param handle thread handle
776  * @param p_result [OUT] pointer to write the thread return value or NULL
777  * @return 0 on success, a standard error code otherwise.
778  */
779 void vlc_join (vlc_thread_t handle, void **result)
780 {
781 #if defined( LIBVLC_USE_PTHREAD )
782     int val = pthread_join (handle, result);
783     if (val)
784         vlc_thread_fatal ("joining thread", val, __func__, __FILE__, __LINE__);
785
786 #elif defined( UNDER_CE ) || defined( WIN32 )
787     do
788         vlc_testcancel ();
789     while (WaitForSingleObjectEx (handle->handle, INFINITE, TRUE)
790                                                         == WAIT_IO_COMPLETION);
791
792     CloseHandle (handle->handle);
793     if (result)
794         *result = handle->data;
795     free (handle);
796
797 #endif
798 }
799
800
801 struct vlc_thread_boot
802 {
803     void * (*entry) (vlc_object_t *);
804     vlc_object_t *object;
805 };
806
807 static void *thread_entry (void *data)
808 {
809     vlc_object_t *obj = ((struct vlc_thread_boot *)data)->object;
810     void *(*func) (vlc_object_t *) = ((struct vlc_thread_boot *)data)->entry;
811
812     free (data);
813     msg_Dbg (obj, "thread started");
814     func (obj);
815     msg_Dbg (obj, "thread ended");
816
817     return NULL;
818 }
819
820 /*****************************************************************************
821  * vlc_thread_create: create a thread, inner version
822  *****************************************************************************
823  * Note that i_priority is only taken into account on platforms supporting
824  * userland real-time priority threads.
825  *****************************************************************************/
826 int __vlc_thread_create( vlc_object_t *p_this, const char * psz_file, int i_line,
827                          const char *psz_name, void * ( *func ) ( vlc_object_t * ),
828                          int i_priority, bool b_wait )
829 {
830     int i_ret;
831     vlc_object_internals_t *p_priv = vlc_internals( p_this );
832
833     struct vlc_thread_boot *boot = malloc (sizeof (*boot));
834     if (boot == NULL)
835         return errno;
836     boot->entry = func;
837     boot->object = p_this;
838
839     vlc_object_lock( p_this );
840
841     /* Make sure we don't re-create a thread if the object has already one */
842     assert( !p_priv->b_thread );
843
844 #if defined( LIBVLC_USE_PTHREAD )
845 #ifndef __APPLE__
846     if( config_GetInt( p_this, "rt-priority" ) > 0 )
847 #endif
848     {
849         /* Hack to avoid error msg */
850         if( config_GetType( p_this, "rt-offset" ) )
851             i_priority += config_GetInt( p_this, "rt-offset" );
852     }
853 #endif
854
855     i_ret = vlc_clone( &p_priv->thread_id, thread_entry, boot, i_priority );
856     if( i_ret == 0 )
857     {
858         if( b_wait )
859         {
860             msg_Dbg( p_this, "waiting for thread initialization" );
861             vlc_object_wait( p_this );
862         }
863
864         p_priv->b_thread = true;
865         msg_Dbg( p_this, "thread %lu (%s) created at priority %d (%s:%d)",
866                  (unsigned long)p_priv->thread_id, psz_name, i_priority,
867                  psz_file, i_line );
868     }
869     else
870     {
871         errno = i_ret;
872         msg_Err( p_this, "%s thread could not be created at %s:%d (%m)",
873                          psz_name, psz_file, i_line );
874     }
875
876     vlc_object_unlock( p_this );
877     return i_ret;
878 }
879
880 /*****************************************************************************
881  * vlc_thread_set_priority: set the priority of the current thread when we
882  * couldn't set it in vlc_thread_create (for instance for the main thread)
883  *****************************************************************************/
884 int __vlc_thread_set_priority( vlc_object_t *p_this, const char * psz_file,
885                                int i_line, int i_priority )
886 {
887     vlc_object_internals_t *p_priv = vlc_internals( p_this );
888
889     if( !p_priv->b_thread )
890     {
891         msg_Err( p_this, "couldn't set priority of non-existent thread" );
892         return ESRCH;
893     }
894
895 #if defined( LIBVLC_USE_PTHREAD )
896 # ifndef __APPLE__
897     if( config_GetInt( p_this, "rt-priority" ) > 0 )
898 # endif
899     {
900         int i_error, i_policy;
901         struct sched_param param;
902
903         memset( &param, 0, sizeof(struct sched_param) );
904         if( config_GetType( p_this, "rt-offset" ) )
905             i_priority += config_GetInt( p_this, "rt-offset" );
906         if( i_priority <= 0 )
907         {
908             param.sched_priority = (-1) * i_priority;
909             i_policy = SCHED_OTHER;
910         }
911         else
912         {
913             param.sched_priority = i_priority;
914             i_policy = SCHED_RR;
915         }
916         if( (i_error = pthread_setschedparam( p_priv->thread_id,
917                                               i_policy, &param )) )
918         {
919             errno = i_error;
920             msg_Warn( p_this, "couldn't set thread priority (%s:%d): %m",
921                       psz_file, i_line );
922             i_priority = 0;
923         }
924     }
925
926 #elif defined( WIN32 ) || defined( UNDER_CE )
927     VLC_UNUSED( psz_file); VLC_UNUSED( i_line );
928
929     if( !SetThreadPriority(p_priv->thread_id->handle, i_priority) )
930     {
931         msg_Warn( p_this, "couldn't set a faster priority" );
932         return 1;
933     }
934
935 #endif
936
937     return 0;
938 }
939
940 /*****************************************************************************
941  * vlc_thread_join: wait until a thread exits, inner version
942  *****************************************************************************/
943 void __vlc_thread_join( vlc_object_t *p_this )
944 {
945     vlc_object_internals_t *p_priv = vlc_internals( p_this );
946
947 #if defined( LIBVLC_USE_PTHREAD )
948     vlc_join (p_priv->thread_id, NULL);
949
950 #elif defined( UNDER_CE ) || defined( WIN32 )
951     HANDLE hThread;
952     FILETIME create_ft, exit_ft, kernel_ft, user_ft;
953     int64_t real_time, kernel_time, user_time;
954
955     if( ! DuplicateHandle(GetCurrentProcess(),
956             p_priv->thread_id->handle,
957             GetCurrentProcess(),
958             &hThread,
959             0,
960             FALSE,
961             DUPLICATE_SAME_ACCESS) )
962     {
963         p_priv->b_thread = false;
964         return; /* We have a problem! */
965     }
966
967     vlc_join( p_priv->thread_id, NULL );
968
969     if( GetThreadTimes( hThread, &create_ft, &exit_ft, &kernel_ft, &user_ft ) )
970     {
971         real_time =
972           ((((int64_t)exit_ft.dwHighDateTime)<<32)| exit_ft.dwLowDateTime) -
973           ((((int64_t)create_ft.dwHighDateTime)<<32)| create_ft.dwLowDateTime);
974         real_time /= 10;
975
976         kernel_time =
977           ((((int64_t)kernel_ft.dwHighDateTime)<<32)|
978            kernel_ft.dwLowDateTime) / 10;
979
980         user_time =
981           ((((int64_t)user_ft.dwHighDateTime)<<32)|
982            user_ft.dwLowDateTime) / 10;
983
984         msg_Dbg( p_this, "thread times: "
985                  "real %"PRId64"m%fs, kernel %"PRId64"m%fs, user %"PRId64"m%fs",
986                  real_time/60/1000000,
987                  (double)((real_time%(60*1000000))/1000000.0),
988                  kernel_time/60/1000000,
989                  (double)((kernel_time%(60*1000000))/1000000.0),
990                  user_time/60/1000000,
991                  (double)((user_time%(60*1000000))/1000000.0) );
992     }
993     CloseHandle( hThread );
994
995 #else
996     vlc_join( p_priv->thread_id, NULL );
997
998 #endif
999
1000     p_priv->b_thread = false;
1001 }
1002
1003 void vlc_thread_cancel (vlc_object_t *obj)
1004 {
1005     vlc_object_internals_t *priv = vlc_internals (obj);
1006
1007     if (priv->b_thread)
1008         vlc_cancel (priv->thread_id);
1009 }
1010
1011 void vlc_control_cancel (int cmd, ...)
1012 {
1013     /* NOTE: This function only modifies thread-specific data, so there is no
1014      * need to lock anything. */
1015 #ifdef LIBVLC_USE_PTHREAD_CANCEL
1016     (void) cmd;
1017     assert (0);
1018 #else
1019     va_list ap;
1020
1021     vlc_cancel_t *nfo = vlc_threadvar_get (&cancel_key);
1022     if (nfo == NULL)
1023     {
1024 #ifdef WIN32
1025         /* Main thread - cannot be cancelled anyway */
1026         return;
1027 #else
1028         nfo = malloc (sizeof (*nfo));
1029         if (nfo == NULL)
1030             return; /* Uho! Expect problems! */
1031         *nfo = VLC_CANCEL_INIT;
1032         vlc_threadvar_set (&cancel_key, nfo);
1033 #endif
1034     }
1035
1036     va_start (ap, cmd);
1037     switch (cmd)
1038     {
1039         case VLC_SAVE_CANCEL:
1040         {
1041             int *p_state = va_arg (ap, int *);
1042             *p_state = nfo->killable;
1043             nfo->killable = false;
1044             break;
1045         }
1046
1047         case VLC_RESTORE_CANCEL:
1048         {
1049             int state = va_arg (ap, int);
1050             nfo->killable = state != 0;
1051             break;
1052         }
1053
1054         case VLC_TEST_CANCEL:
1055             if (nfo->killable && nfo->killed)
1056             {
1057                 for (vlc_cleanup_t *p = nfo->cleaners; p != NULL; p = p->next)
1058                      p->proc (p->data);
1059                 free (nfo);
1060 #if defined (LIBVLC_USE_PTHREAD)
1061                 pthread_exit (PTHREAD_CANCELLED);
1062 #elif defined (WIN32)
1063                 _endthread ();
1064 #else
1065 # error Not implemented!
1066 #endif
1067             }
1068             break;
1069
1070         case VLC_DO_CANCEL:
1071             nfo->killed = true;
1072             break;
1073
1074         case VLC_CLEANUP_PUSH:
1075         {
1076             /* cleaner is a pointer to the caller stack, no need to allocate
1077              * and copy anything. As a nice side effect, this cannot fail. */
1078             vlc_cleanup_t *cleaner = va_arg (ap, vlc_cleanup_t *);
1079             cleaner->next = nfo->cleaners;
1080             nfo->cleaners = cleaner;
1081             break;
1082         }
1083
1084         case VLC_CLEANUP_POP:
1085         {
1086             nfo->cleaners = nfo->cleaners->next;
1087             break;
1088         }
1089     }
1090     va_end (ap);
1091 #endif
1092 }