Win32 R/W locks: fix/add comments, add asserts
[vlc.git] / src / win32 / thread.c
1 /*****************************************************************************
2  * thread.c : Win32 back-end for LibVLC
3  *****************************************************************************
4  * Copyright (C) 1999-2009 the VideoLAN team
5  *
6  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
7  *          Samuel Hocevar <sam@zoy.org>
8  *          Gildas Bazin <gbazin@netcourrier.com>
9  *          Clément Sténac
10  *          Rémi Denis-Courmont
11  *          Pierre Ynard
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 #include <limits.h>
38 #include <errno.h>
39 #ifdef UNDER_CE
40 # include <mmsystem.h>
41 #endif
42
43 static vlc_threadvar_t thread_key;
44
45 /**
46  * Per-thread data
47  */
48 struct vlc_thread
49 {
50     HANDLE         id;
51 #ifdef UNDER_CE
52     HANDLE         cancel_event;
53 #endif
54
55     bool           detached;
56     bool           killable;
57     bool           killed;
58     vlc_cleanup_t *cleaners;
59
60     void        *(*entry) (void *);
61     void          *data;
62 };
63
64 #ifdef UNDER_CE
65 static void CALLBACK vlc_cancel_self (ULONG_PTR dummy);
66
67 static DWORD vlc_cancelable_wait (DWORD count, const HANDLE *handles,
68                                   DWORD delay)
69 {
70     struct vlc_thread *th = vlc_threadvar_get (thread_key);
71     if (th == NULL)
72     {
73         /* Main thread - cannot be cancelled anyway */
74         return WaitForMultipleObjects (count, handles, FALSE, delay);
75     }
76     HANDLE new_handles[count + 1];
77     memcpy(new_handles, handles, count * sizeof(HANDLE));
78     new_handles[count] = th->cancel_event;
79     DWORD result = WaitForMultipleObjects (count + 1, new_handles, FALSE,
80                                            delay);
81     if (result == WAIT_OBJECT_0 + count)
82     {
83         vlc_cancel_self ((uintptr_t)th);
84         return WAIT_IO_COMPLETION;
85     }
86     else
87     {
88         return result;
89     }
90 }
91
92 DWORD SleepEx (DWORD dwMilliseconds, BOOL bAlertable)
93 {
94     if (bAlertable)
95     {
96         DWORD result = vlc_cancelable_wait (0, NULL, dwMilliseconds);
97         return (result == WAIT_TIMEOUT) ? 0 : WAIT_IO_COMPLETION;
98     }
99     else
100     {
101         Sleep(dwMilliseconds);
102         return 0;
103     }
104 }
105
106 DWORD WaitForSingleObjectEx (HANDLE hHandle, DWORD dwMilliseconds,
107                              BOOL bAlertable)
108 {
109     if (bAlertable)
110     {
111         /* The MSDN documentation specifies different return codes,
112          * but in practice they are the same. We just check that it
113          * remains so. */
114 #if WAIT_ABANDONED != WAIT_ABANDONED_0
115 # error Windows headers changed, code needs to be rewritten!
116 #endif
117         return vlc_cancelable_wait (1, &hHandle, dwMilliseconds);
118     }
119     else
120     {
121         return WaitForSingleObject (hHandle, dwMilliseconds);
122     }
123 }
124
125 DWORD WaitForMultipleObjectsEx (DWORD nCount, const HANDLE *lpHandles,
126                                 BOOL bWaitAll, DWORD dwMilliseconds,
127                                 BOOL bAlertable)
128 {
129     if (bAlertable)
130     {
131         /* We do not support the bWaitAll case */
132         assert (! bWaitAll);
133         return vlc_cancelable_wait (nCount, lpHandles, dwMilliseconds);
134     }
135     else
136     {
137         return WaitForMultipleObjects (nCount, lpHandles, bWaitAll,
138                                        dwMilliseconds);
139     }
140 }
141 #endif
142
143 vlc_mutex_t super_mutex;
144 vlc_cond_t  super_variable;
145
146 BOOL WINAPI DllMain (HINSTANCE hinstDll, DWORD fdwReason, LPVOID lpvReserved)
147 {
148     (void) hinstDll;
149     (void) lpvReserved;
150
151     switch (fdwReason)
152     {
153         case DLL_PROCESS_ATTACH:
154             vlc_mutex_init (&super_mutex);
155             vlc_cond_init (&super_variable);
156             vlc_threadvar_create (&thread_key, NULL);
157             break;
158
159         case DLL_PROCESS_DETACH:
160             vlc_threadvar_delete (&thread_key);
161             vlc_cond_destroy (&super_variable);
162             vlc_mutex_destroy (&super_mutex);
163             break;
164     }
165     return TRUE;
166 }
167
168 /*** Mutexes ***/
169 void vlc_mutex_init( vlc_mutex_t *p_mutex )
170 {
171     /* This creates a recursive mutex. This is OK as fast mutexes have
172      * no defined behavior in case of recursive locking. */
173     InitializeCriticalSection (&p_mutex->mutex);
174     p_mutex->dynamic = true;
175 }
176
177 void vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
178 {
179     InitializeCriticalSection( &p_mutex->mutex );
180     p_mutex->dynamic = true;
181 }
182
183
184 void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
185 {
186     assert (p_mutex->dynamic);
187     DeleteCriticalSection (&p_mutex->mutex);
188 }
189
190 void vlc_mutex_lock (vlc_mutex_t *p_mutex)
191 {
192     if (!p_mutex->dynamic)
193     {   /* static mutexes */
194         int canc = vlc_savecancel ();
195         assert (p_mutex != &super_mutex); /* this one cannot be static */
196
197         vlc_mutex_lock (&super_mutex);
198         while (p_mutex->locked)
199         {
200             p_mutex->contention++;
201             vlc_cond_wait (&super_variable, &super_mutex);
202             p_mutex->contention--;
203         }
204         p_mutex->locked = true;
205         vlc_mutex_unlock (&super_mutex);
206         vlc_restorecancel (canc);
207         return;
208     }
209
210     EnterCriticalSection (&p_mutex->mutex);
211 }
212
213 int vlc_mutex_trylock (vlc_mutex_t *p_mutex)
214 {
215     if (!p_mutex->dynamic)
216     {   /* static mutexes */
217         int ret = EBUSY;
218
219         assert (p_mutex != &super_mutex); /* this one cannot be static */
220         vlc_mutex_lock (&super_mutex);
221         if (!p_mutex->locked)
222         {
223             p_mutex->locked = true;
224             ret = 0;
225         }
226         vlc_mutex_unlock (&super_mutex);
227         return ret;
228     }
229
230     return TryEnterCriticalSection (&p_mutex->mutex) ? 0 : EBUSY;
231 }
232
233 void vlc_mutex_unlock (vlc_mutex_t *p_mutex)
234 {
235     if (!p_mutex->dynamic)
236     {   /* static mutexes */
237         assert (p_mutex != &super_mutex); /* this one cannot be static */
238
239         vlc_mutex_lock (&super_mutex);
240         assert (p_mutex->locked);
241         p_mutex->locked = false;
242         if (p_mutex->contention)
243             vlc_cond_broadcast (&super_variable);
244         vlc_mutex_unlock (&super_mutex);
245         return;
246     }
247
248     LeaveCriticalSection (&p_mutex->mutex);
249 }
250
251 /*** Condition variables ***/
252 enum
253 {
254     CLOCK_MONOTONIC,
255     CLOCK_REALTIME,
256 };
257
258 static void vlc_cond_init_common (vlc_cond_t *p_condvar, unsigned clock)
259 {
260     /* Create a manual-reset event (manual reset is needed for broadcast). */
261     p_condvar->handle = CreateEvent (NULL, TRUE, FALSE, NULL);
262     if (!p_condvar->handle)
263         abort();
264     p_condvar->clock = clock;
265 }
266
267 void vlc_cond_init (vlc_cond_t *p_condvar)
268 {
269     vlc_cond_init_common (p_condvar, CLOCK_MONOTONIC);
270 }
271
272 void vlc_cond_init_daytime (vlc_cond_t *p_condvar)
273 {
274     vlc_cond_init_common (p_condvar, CLOCK_REALTIME);
275 }
276
277 void vlc_cond_destroy (vlc_cond_t *p_condvar)
278 {
279     CloseHandle (p_condvar->handle);
280 }
281
282 void vlc_cond_signal (vlc_cond_t *p_condvar)
283 {
284     /* NOTE: This will cause a broadcast, that is wrong.
285      * This will also wake up the next waiting thread if no threads are yet
286      * waiting, which is also wrong. However both of these issues are allowed
287      * by the provision for spurious wakeups. Better have too many wakeups
288      * than too few (= deadlocks). */
289     SetEvent (p_condvar->handle);
290 }
291
292 void vlc_cond_broadcast (vlc_cond_t *p_condvar)
293 {
294     SetEvent (p_condvar->handle);
295 }
296
297 void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
298 {
299     DWORD result;
300
301     assert (p_mutex->dynamic); /* TODO */
302     do
303     {
304         vlc_testcancel ();
305         LeaveCriticalSection (&p_mutex->mutex);
306         result = WaitForSingleObjectEx (p_condvar->handle, INFINITE, TRUE);
307         EnterCriticalSection (&p_mutex->mutex);
308     }
309     while (result == WAIT_IO_COMPLETION);
310
311     assert (result != WAIT_ABANDONED); /* another thread failed to cleanup! */
312     assert (result != WAIT_FAILED);
313     ResetEvent (p_condvar->handle);
314 }
315
316 int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
317                         mtime_t deadline)
318 {
319     DWORD result;
320
321     assert (p_mutex->dynamic); /* TODO */
322     do
323     {
324         vlc_testcancel ();
325
326         mtime_t total;
327         switch (p_condvar->clock)
328         {
329             case CLOCK_MONOTONIC:
330                 total = mdate();
331                 break;
332             case CLOCK_REALTIME: /* FIXME? sub-second precision */
333                 total = CLOCK_FREQ * time (NULL);
334                 break;
335             default:
336                 assert (0);
337         }
338         total = (deadline - total) / 1000;
339         if( total < 0 )
340             total = 0;
341
342         DWORD delay = (total > 0x7fffffff) ? 0x7fffffff : total;
343         LeaveCriticalSection (&p_mutex->mutex);
344         result = WaitForSingleObjectEx (p_condvar->handle, delay, TRUE);
345         EnterCriticalSection (&p_mutex->mutex);
346     }
347     while (result == WAIT_IO_COMPLETION);
348
349     assert (result != WAIT_ABANDONED);
350     assert (result != WAIT_FAILED);
351     ResetEvent (p_condvar->handle);
352
353     return (result == WAIT_OBJECT_0) ? 0 : ETIMEDOUT;
354 }
355
356 /*** Semaphore ***/
357 void vlc_sem_init (vlc_sem_t *sem, unsigned value)
358 {
359     *sem = CreateSemaphore (NULL, value, 0x7fffffff, NULL);
360     if (*sem == NULL)
361         abort ();
362 }
363
364 void vlc_sem_destroy (vlc_sem_t *sem)
365 {
366     CloseHandle (*sem);
367 }
368
369 int vlc_sem_post (vlc_sem_t *sem)
370 {
371     ReleaseSemaphore (*sem, 1, NULL);
372     return 0; /* FIXME */
373 }
374
375 void vlc_sem_wait (vlc_sem_t *sem)
376 {
377     DWORD result;
378
379     do
380     {
381         vlc_testcancel ();
382         result = WaitForSingleObjectEx (*sem, INFINITE, TRUE);
383     }
384     while (result == WAIT_IO_COMPLETION);
385 }
386
387 /*** Read/write locks */
388 /* SRW (Slim Read Write) locks are available in Vista+ only */
389 void vlc_rwlock_init (vlc_rwlock_t *lock)
390 {
391     vlc_mutex_init (&lock->mutex);
392     vlc_cond_init (&lock->read_wait);
393     vlc_cond_init (&lock->write_wait);
394     lock->readers = 0; /* active readers */
395     lock->writers = 0; /* waiting writers */
396     lock->writer = 0; /* ID of active writer */
397 }
398
399 void vlc_rwlock_destroy (vlc_rwlock_t *lock)
400 {
401     vlc_cond_destroy (&lock->read_wait);
402     vlc_cond_destroy (&lock->write_wait);
403     vlc_mutex_destroy (&lock->mutex);
404 }
405
406 void vlc_rwlock_rdlock (vlc_rwlock_t *lock)
407 {
408     vlc_mutex_lock (&lock->mutex);
409     /* Recursive read-locking is allowed. With the infos available:
410      *  - the loosest possible condition (no active writer) is:
411      *     (lock->writer != 0)
412      *  - the strictest possible condition is:
413      *     (lock->writer != 0 || (lock->readers == 0 && lock->writers > 0))
414      *  or (lock->readers == 0 && (lock->writer != 0 || lock->writers > 0))
415      */
416     while (lock->writer != 0)
417     {
418         assert (lock->readers == 0);
419         vlc_cond_wait (&lock->read_wait, &lock->mutex);
420     }
421     if (unlikely(lock->readers == ULONG_MAX))
422         abort ();
423     lock->readers++;
424     vlc_mutex_unlock (&lock->mutex);
425 }
426
427 static void vlc_rwlock_rdunlock (vlc_rwlock_t *lock)
428 {
429     vlc_mutex_lock (&lock->mutex);
430     assert (lock->readers > 0);
431
432     /* If there are no readers left, wake up a writer. */
433     if (--lock->readers == 0 && lock->writers > 0)
434         vlc_cond_signal (&lock->write_wait);
435     vlc_mutex_unlock (&lock->mutex);
436 }
437
438 void vlc_rwlock_wrlock (vlc_rwlock_t *lock)
439 {
440     vlc_mutex_lock (&lock->mutex);
441     if (unlikely(lock->writers == ULONG_MAX))
442         abort ();
443     lock->writers++;
444     /* Wait until nobody owns the lock in either way. */
445     while ((lock->readers > 0) || (lock->writer != 0))
446         vlc_cond_wait (&lock->write_wait, &lock->mutex);
447     lock->writers--;
448     assert (lock->writer == 0);
449     lock->writer = GetCurrentThreadId ();
450     vlc_mutex_unlock (&lock->mutex);
451 }
452
453 static void vlc_rwlock_wrunlock (vlc_rwlock_t *lock)
454 {
455     vlc_mutex_lock (&lock->mutex);
456     assert (lock->writer == GetCurrentThreadId ());
457     assert (lock->readers == 0);
458     lock->writer = 0; /* Write unlock */
459
460     /* Let reader and writer compete. Scheduler decides who wins. */
461     if (lock->writers > 0)
462         vlc_cond_signal (&lock->write_wait);
463     vlc_cond_broadcast (&lock->read_wait);
464     vlc_mutex_unlock (&lock->mutex);
465 }
466
467 void vlc_rwlock_unlock (vlc_rwlock_t *lock)
468 {
469     /* Note: If the lock is held for reading, lock->writer is nul.
470      * If the lock is held for writing, only this thread can store a value to
471      * lock->writer. Either way, lock->writer is safe to fetch here. */
472     if (lock->writer != 0)
473         vlc_rwlock_wrunlock (lock);
474     else
475         vlc_rwlock_rdunlock (lock);
476 }
477
478 /*** Thread-specific variables (TLS) ***/
479 struct vlc_threadvar
480 {
481     DWORD                 id;
482     void                (*destroy) (void *);
483     struct vlc_threadvar *prev;
484     struct vlc_threadvar *next;
485 } *vlc_threadvar_last = NULL;
486
487 int vlc_threadvar_create (vlc_threadvar_t *p_tls, void (*destr) (void *))
488 {
489     struct vlc_threadvar *var = malloc (sizeof (*var));
490     if (unlikely(var == NULL))
491         return errno;
492
493     var->id = TlsAlloc();
494     if (var->id == TLS_OUT_OF_INDEXES)
495     {
496         free (var);
497         return EAGAIN;
498     }
499     var->destroy = destr;
500     var->next = NULL;
501     *p_tls = var;
502
503     vlc_mutex_lock (&super_mutex);
504     var->prev = vlc_threadvar_last;
505     vlc_threadvar_last = var;
506     vlc_mutex_unlock (&super_mutex);
507     return 0;
508 }
509
510 void vlc_threadvar_delete (vlc_threadvar_t *p_tls)
511 {
512     struct vlc_threadvar *var = *p_tls;
513
514     vlc_mutex_lock (&super_mutex);
515     if (var->prev != NULL)
516         var->prev->next = var->next;
517     else
518         vlc_threadvar_last = var->next;
519     if (var->next != NULL)
520         var->next->prev = var->prev;
521     vlc_mutex_unlock (&super_mutex);
522
523     TlsFree (var->id);
524     free (var);
525 }
526
527 int vlc_threadvar_set (vlc_threadvar_t key, void *value)
528 {
529     return TlsSetValue (key->id, value) ? ENOMEM : 0;
530 }
531
532 void *vlc_threadvar_get (vlc_threadvar_t key)
533 {
534     return TlsGetValue (key->id);
535 }
536
537 /*** Threads ***/
538 void vlc_threads_setup (libvlc_int_t *p_libvlc)
539 {
540     (void) p_libvlc;
541 }
542
543 static void vlc_thread_cleanup (struct vlc_thread *th)
544 {
545     vlc_threadvar_t key;
546
547 retry:
548     /* TODO: use RW lock or something similar */
549     vlc_mutex_lock (&super_mutex);
550     for (key = vlc_threadvar_last; key != NULL; key = key->prev)
551     {
552         void *value = vlc_threadvar_get (key);
553         if (value != NULL && key->destroy != NULL)
554         {
555             vlc_mutex_unlock (&super_mutex);
556             vlc_threadvar_set (key, NULL);
557             key->destroy (value);
558             goto retry;
559         }
560     }
561     vlc_mutex_unlock (&super_mutex);
562
563     if (th->detached)
564     {
565         CloseHandle (th->id);
566 #ifdef UNDER_CE
567         CloseHandle (th->cancel_event);
568 #endif
569         free (th);
570     }
571 }
572
573 static unsigned __stdcall vlc_entry (void *p)
574 {
575     struct vlc_thread *th = p;
576
577     vlc_threadvar_set (thread_key, th);
578     th->killable = true;
579     th->data = th->entry (th->data);
580     vlc_thread_cleanup (th);
581     return 0;
582 }
583
584 static int vlc_clone_attr (vlc_thread_t *p_handle, bool detached,
585                            void *(*entry) (void *), void *data, int priority)
586 {
587     struct vlc_thread *th = malloc (sizeof (*th));
588     if (unlikely(th == NULL))
589         return ENOMEM;
590     th->entry = entry;
591     th->data = data;
592     th->detached = detached;
593     th->killable = false; /* not until vlc_entry() ! */
594     th->killed = false;
595     th->cleaners = NULL;
596
597     HANDLE hThread;
598 #ifndef UNDER_CE
599     /* When using the MSVCRT C library you have to use the _beginthreadex
600      * function instead of CreateThread, otherwise you'll end up with
601      * memory leaks and the signal functions not working (see Microsoft
602      * Knowledge Base, article 104641) */
603     hThread = (HANDLE)(uintptr_t)
604         _beginthreadex (NULL, 0, vlc_entry, th, CREATE_SUSPENDED, NULL);
605     if (hThread == NULL)
606     {
607         int err = errno;
608         free (th);
609         return err;
610     }
611
612 #else
613     th->cancel_event = CreateEvent (NULL, FALSE, FALSE, NULL);
614     if (th->cancel_event == NULL)
615     {
616         free (th);
617         return ENOMEM;
618     }
619
620     /* Not sure if CREATE_SUSPENDED + ResumeThread() is any useful on WinCE.
621      * Thread handles act up, too. */
622     hThread = CreateThread (NULL, 128*1024, vlc_entry, th,
623                             CREATE_SUSPENDED, NULL);
624     if (hThread == NULL)
625     {
626         CloseHandle (th->cancel_event);
627         free (th);
628         return ENOMEM;
629     }
630
631 #endif
632     /* Thread is suspended, so we can safely set th->id */
633     th->id = hThread;
634     if (p_handle != NULL)
635         *p_handle = th;
636
637     ResumeThread (hThread);
638     if (priority)
639         SetThreadPriority (hThread, priority);
640
641     return 0;
642 }
643
644 int vlc_clone (vlc_thread_t *p_handle, void *(*entry) (void *),
645                 void *data, int priority)
646 {
647     return vlc_clone_attr (p_handle, false, entry, data, priority);
648 }
649
650 void vlc_join (vlc_thread_t th, void **result)
651 {
652     do
653         vlc_testcancel ();
654     while (WaitForSingleObjectEx (th->id, INFINITE, TRUE)
655                                                         == WAIT_IO_COMPLETION);
656
657     if (result != NULL)
658         *result = th->data;
659     CloseHandle (th->id);
660 #ifdef UNDER_CE
661     CloseHandle (th->cancel_event);
662 #endif
663     free (th);
664 }
665
666 int vlc_clone_detach (vlc_thread_t *p_handle, void *(*entry) (void *),
667                       void *data, int priority)
668 {
669     vlc_thread_t th;
670     if (p_handle == NULL)
671         p_handle = &th;
672
673     return vlc_clone_attr (p_handle, true, entry, data, priority);
674 }
675
676 /*** Thread cancellation ***/
677
678 /* APC procedure for thread cancellation */
679 static void CALLBACK vlc_cancel_self (ULONG_PTR self)
680 {
681     struct vlc_thread *th = (void *)self;
682
683     if (likely(th != NULL))
684         th->killed = true;
685 }
686
687 void vlc_cancel (vlc_thread_t th)
688 {
689 #ifndef UNDER_CE
690     QueueUserAPC (vlc_cancel_self, th->id, (uintptr_t)th);
691 #else
692     SetEvent (th->cancel_event);
693 #endif
694 }
695
696 int vlc_savecancel (void)
697 {
698     struct vlc_thread *th = vlc_threadvar_get (thread_key);
699     if (th == NULL)
700         return false; /* Main thread - cannot be cancelled anyway */
701
702     int state = th->killable;
703     th->killable = false;
704     return state;
705 }
706
707 void vlc_restorecancel (int state)
708 {
709     struct vlc_thread *th = vlc_threadvar_get (thread_key);
710     assert (state == false || state == true);
711
712     if (th == NULL)
713         return; /* Main thread - cannot be cancelled anyway */
714
715     assert (!th->killable);
716     th->killable = state != 0;
717 }
718
719 void vlc_testcancel (void)
720 {
721     struct vlc_thread *th = vlc_threadvar_get (thread_key);
722     if (th == NULL)
723         return; /* Main thread - cannot be cancelled anyway */
724
725     if (th->killable && th->killed)
726     {
727         for (vlc_cleanup_t *p = th->cleaners; p != NULL; p = p->next)
728              p->proc (p->data);
729
730         th->data = NULL; /* TODO: special value? */
731         vlc_thread_cleanup (th);
732 #ifndef UNDER_CE
733         _endthreadex(0);
734 #else
735         ExitThread(0);
736 #endif
737     }
738 }
739
740 void vlc_control_cancel (int cmd, ...)
741 {
742     /* NOTE: This function only modifies thread-specific data, so there is no
743      * need to lock anything. */
744     va_list ap;
745
746     struct vlc_thread *th = vlc_threadvar_get (thread_key);
747     if (th == NULL)
748         return; /* Main thread - cannot be cancelled anyway */
749
750     va_start (ap, cmd);
751     switch (cmd)
752     {
753         case VLC_CLEANUP_PUSH:
754         {
755             /* cleaner is a pointer to the caller stack, no need to allocate
756              * and copy anything. As a nice side effect, this cannot fail. */
757             vlc_cleanup_t *cleaner = va_arg (ap, vlc_cleanup_t *);
758             cleaner->next = th->cleaners;
759             th->cleaners = cleaner;
760             break;
761         }
762
763         case VLC_CLEANUP_POP:
764         {
765             th->cleaners = th->cleaners->next;
766             break;
767         }
768     }
769     va_end (ap);
770 }
771
772
773 /*** Timers ***/
774 struct vlc_timer
775 {
776 #ifndef UNDER_CE
777     HANDLE handle;
778 #else
779     unsigned id;
780     unsigned interval;
781 #endif
782     void (*func) (void *);
783     void *data;
784 };
785
786 #ifndef UNDER_CE
787 static void CALLBACK vlc_timer_do (void *val, BOOLEAN timeout)
788 {
789     struct vlc_timer *timer = val;
790
791     assert (timeout);
792     timer->func (timer->data);
793 }
794 #else
795 static void CALLBACK vlc_timer_do (unsigned timer_id, unsigned msg,
796                                    DWORD_PTR user, DWORD_PTR unused1,
797                                    DWORD_PTR unused2)
798 {
799     struct vlc_timer *timer = (struct vlc_timer *) user;
800     assert (timer_id == timer->id);
801     (void) msg;
802     (void) unused1;
803     (void) unused2;
804
805     timer->func (timer->data);
806
807     if (timer->interval)
808     {
809         mtime_t interval = timer->interval * 1000;
810         vlc_timer_schedule (timer, false, interval, interval);
811     }
812 }
813 #endif
814
815 int vlc_timer_create (vlc_timer_t *id, void (*func) (void *), void *data)
816 {
817     struct vlc_timer *timer = malloc (sizeof (*timer));
818
819     if (timer == NULL)
820         return ENOMEM;
821     timer->func = func;
822     timer->data = data;
823 #ifndef UNDER_CE
824     timer->handle = INVALID_HANDLE_VALUE;
825 #else
826     timer->id = 0;
827     timer->interval = 0;
828 #endif
829     *id = timer;
830     return 0;
831 }
832
833 void vlc_timer_destroy (vlc_timer_t timer)
834 {
835 #ifndef UNDER_CE
836     if (timer->handle != INVALID_HANDLE_VALUE)
837         DeleteTimerQueueTimer (NULL, timer->handle, INVALID_HANDLE_VALUE);
838 #else
839     if (timer->id)
840         timeKillEvent (timer->id);
841     /* FIXME: timers that have not yet completed will trigger use-after-free */
842 #endif
843     free (timer);
844 }
845
846 void vlc_timer_schedule (vlc_timer_t timer, bool absolute,
847                          mtime_t value, mtime_t interval)
848 {
849 #ifndef UNDER_CE
850     if (timer->handle != INVALID_HANDLE_VALUE)
851     {
852         DeleteTimerQueueTimer (NULL, timer->handle, NULL);
853         timer->handle = INVALID_HANDLE_VALUE;
854     }
855 #else
856     if (timer->id)
857     {
858         timeKillEvent (timer->id);
859         timer->id = 0;
860         timer->interval = 0;
861     }
862 #endif
863     if (value == 0)
864         return; /* Disarm */
865
866     if (absolute)
867         value -= mdate ();
868     value = (value + 999) / 1000;
869     interval = (interval + 999) / 1000;
870
871 #ifndef UNDER_CE
872     if (!CreateTimerQueueTimer (&timer->handle, NULL, vlc_timer_do, timer,
873                                 value, interval, WT_EXECUTEDEFAULT))
874 #else
875     TIMECAPS caps;
876     timeGetDevCaps (&caps, sizeof(caps));
877
878     unsigned delay = value;
879     delay = __MAX(delay, caps.wPeriodMin);
880     delay = __MIN(delay, caps.wPeriodMax);
881
882     unsigned event = TIME_ONESHOT;
883
884     if (interval == delay)
885         event = TIME_PERIODIC;
886     else if (interval)
887         timer->interval = interval;
888
889     timer->id = timeSetEvent (delay, delay / 20, vlc_timer_do, (DWORD) timer,
890                               event);
891     if (!timer->id)
892 #endif
893         abort ();
894 }
895
896 unsigned vlc_timer_getoverrun (vlc_timer_t timer)
897 {
898     (void)timer;
899     return 0;
900 }