mac PPC: don't use mach absolute_time()
[vlc.git] / src / misc / pthread.c
1 /*****************************************************************************
2  * pthread.c : pthread back-end for LibVLC
3  *****************************************************************************
4  * Copyright (C) 1999-2009 the VideoLAN team
5  *
6  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
7  *          Samuel Hocevar <sam@zoy.org>
8  *          Gildas Bazin <gbazin@netcourrier.com>
9  *          Clément Sténac
10  *          Rémi Denis-Courmont
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32
33 #include "libvlc.h"
34 #include <stdarg.h>
35 #include <assert.h>
36 #include <unistd.h> /* fsync() */
37 #include <signal.h>
38
39 #include <sched.h>
40 #ifdef __linux__
41 # include <sys/syscall.h> /* SYS_gettid */
42 #endif
43
44 #ifdef HAVE_EXECINFO_H
45 # include <execinfo.h>
46 #endif
47
48 #ifdef __APPLE__
49 # include <sys/time.h> /* gettimeofday in vlc_cond_timedwait */
50 #endif
51
52 /**
53  * Print a backtrace to the standard error for debugging purpose.
54  */
55 void vlc_trace (const char *fn, const char *file, unsigned line)
56 {
57      fprintf (stderr, "at %s:%u in %s\n", file, line, fn);
58      fflush (stderr); /* needed before switch to low-level I/O */
59 #ifdef HAVE_BACKTRACE
60      void *stack[20];
61      int len = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
62      backtrace_symbols_fd (stack, len, 2);
63 #endif
64      fsync (2);
65 }
66
67 static inline unsigned long vlc_threadid (void)
68 {
69 #if defined (__linux__)
70      /* glibc does not provide a call for this */
71      return syscall (SYS_gettid);
72
73 #else
74      union { pthread_t th; unsigned long int i; } v = { };
75      v.th = pthread_self ();
76      return v.i;
77
78 #endif
79 }
80
81 #ifndef NDEBUG
82 /*****************************************************************************
83  * vlc_thread_fatal: Report an error from the threading layer
84  *****************************************************************************
85  * This is mostly meant for debugging.
86  *****************************************************************************/
87 static void
88 vlc_thread_fatal (const char *action, int error,
89                   const char *function, const char *file, unsigned line)
90 {
91     fprintf (stderr, "LibVLC fatal error %s (%d) in thread %lu ",
92              action, error, vlc_threadid ());
93     vlc_trace (function, file, line);
94
95     /* Sometimes strerror_r() crashes too, so make sure we print an error
96      * message before we invoke it */
97 #ifdef __GLIBC__
98     /* Avoid the strerror_r() prototype brain damage in glibc */
99     errno = error;
100     fprintf (stderr, " Error message: %m\n");
101 #else
102     char buf[1000];
103     const char *msg;
104
105     switch (strerror_r (error, buf, sizeof (buf)))
106     {
107         case 0:
108             msg = buf;
109             break;
110         case ERANGE: /* should never happen */
111             msg = "unknwon (too big to display)";
112             break;
113         default:
114             msg = "unknown (invalid error number)";
115             break;
116     }
117     fprintf (stderr, " Error message: %s\n", msg);
118 #endif
119     fflush (stderr);
120
121     abort ();
122 }
123
124 # define VLC_THREAD_ASSERT( action ) \
125     if (val) vlc_thread_fatal (action, val, __func__, __FILE__, __LINE__)
126 #else
127 # define VLC_THREAD_ASSERT( action ) ((void)val)
128 #endif
129
130 #if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
131 /* This is not prototyped under glibc, though it exists. */
132 int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
133 #endif
134
135 /*****************************************************************************
136  * vlc_mutex_init: initialize a mutex
137  *****************************************************************************/
138 void vlc_mutex_init( vlc_mutex_t *p_mutex )
139 {
140     pthread_mutexattr_t attr;
141
142     if( pthread_mutexattr_init( &attr ) )
143         abort();
144 #ifndef NDEBUG
145     /* Create error-checking mutex to detect problems more easily. */
146 # if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
147     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_ERRORCHECK_NP );
148 # else
149     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_ERRORCHECK );
150 # endif
151 #endif
152     if( pthread_mutex_init( p_mutex, &attr ) )
153         abort();
154     pthread_mutexattr_destroy( &attr );
155 }
156
157 /*****************************************************************************
158  * vlc_mutex_init: initialize a recursive mutex (Do not use)
159  *****************************************************************************/
160 void vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
161 {
162     pthread_mutexattr_t attr;
163
164     pthread_mutexattr_init( &attr );
165 #if defined (__GLIBC__) && (__GLIBC_MINOR__ < 6)
166     pthread_mutexattr_setkind_np( &attr, PTHREAD_MUTEX_RECURSIVE_NP );
167 #else
168     pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
169 #endif
170     if( pthread_mutex_init( p_mutex, &attr ) )
171         abort();
172     pthread_mutexattr_destroy( &attr );
173 }
174
175
176 /**
177  * Destroys a mutex. The mutex must not be locked.
178  *
179  * @param p_mutex mutex to destroy
180  * @return always succeeds
181  */
182 void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
183 {
184     int val = pthread_mutex_destroy( p_mutex );
185     VLC_THREAD_ASSERT ("destroying mutex");
186 }
187
188 #ifndef NDEBUG
189 # ifdef HAVE_VALGRIND_VALGRIND_H
190 #  include <valgrind/valgrind.h>
191 # else
192 #  define RUNNING_ON_VALGRIND (0)
193 # endif
194
195 void vlc_assert_locked (vlc_mutex_t *p_mutex)
196 {
197     if (RUNNING_ON_VALGRIND > 0)
198         return;
199     assert (pthread_mutex_lock (p_mutex) == EDEADLK);
200 }
201 #endif
202
203 /**
204  * Acquires a mutex. If needed, waits for any other thread to release it.
205  * Beware of deadlocks when locking multiple mutexes at the same time,
206  * or when using mutexes from callbacks.
207  * This function is not a cancellation-point.
208  *
209  * @param p_mutex mutex initialized with vlc_mutex_init() or
210  *                vlc_mutex_init_recursive()
211  */
212 void vlc_mutex_lock (vlc_mutex_t *p_mutex)
213 {
214     int val = pthread_mutex_lock( p_mutex );
215     VLC_THREAD_ASSERT ("locking mutex");
216 }
217
218 /**
219  * Acquires a mutex if and only if it is not currently held by another thread.
220  * This function never sleeps and can be used in delay-critical code paths.
221  * This function is not a cancellation-point.
222  *
223  * <b>Beware</b>: If this function fails, then the mutex is held... by another
224  * thread. The calling thread must deal with the error appropriately. That
225  * typically implies postponing the operations that would have required the
226  * mutex. If the thread cannot defer those operations, then it must use
227  * vlc_mutex_lock(). If in doubt, use vlc_mutex_lock() instead.
228  *
229  * @param p_mutex mutex initialized with vlc_mutex_init() or
230  *                vlc_mutex_init_recursive()
231  * @return 0 if the mutex could be acquired, an error code otherwise.
232  */
233 int vlc_mutex_trylock (vlc_mutex_t *p_mutex)
234 {
235     int val = pthread_mutex_trylock( p_mutex );
236
237     if (val != EBUSY)
238         VLC_THREAD_ASSERT ("locking mutex");
239     return val;
240 }
241
242 /**
243  * Releases a mutex (or crashes if the mutex is not locked by the caller).
244  * @param p_mutex mutex locked with vlc_mutex_lock().
245  */
246 void vlc_mutex_unlock (vlc_mutex_t *p_mutex)
247 {
248     int val = pthread_mutex_unlock( p_mutex );
249     VLC_THREAD_ASSERT ("unlocking mutex");
250 }
251
252 /*****************************************************************************
253  * vlc_cond_init: initialize a condition variable
254  *****************************************************************************/
255 void vlc_cond_init( vlc_cond_t *p_condvar )
256 {
257     pthread_condattr_t attr;
258
259     if (pthread_condattr_init (&attr))
260         abort ();
261 #if !defined (_POSIX_CLOCK_SELECTION)
262    /* Fairly outdated POSIX support (that was defined in 2001) */
263 # define _POSIX_CLOCK_SELECTION (-1)
264 #endif
265 #if (_POSIX_CLOCK_SELECTION >= 0)
266     /* NOTE: This must be the same clock as the one in mtime.c */
267     pthread_condattr_setclock (&attr, CLOCK_MONOTONIC);
268 #endif
269
270     if (pthread_cond_init (p_condvar, &attr))
271         abort ();
272     pthread_condattr_destroy (&attr);
273 }
274
275 /**
276  * Destroys a condition variable. No threads shall be waiting or signaling the
277  * condition.
278  * @param p_condvar condition variable to destroy
279  */
280 void vlc_cond_destroy (vlc_cond_t *p_condvar)
281 {
282     int val = pthread_cond_destroy( p_condvar );
283     VLC_THREAD_ASSERT ("destroying condition");
284 }
285
286 /**
287  * Wakes up one thread waiting on a condition variable, if any.
288  * @param p_condvar condition variable
289  */
290 void vlc_cond_signal (vlc_cond_t *p_condvar)
291 {
292     int val = pthread_cond_signal( p_condvar );
293     VLC_THREAD_ASSERT ("signaling condition variable");
294 }
295
296 /**
297  * Wakes up all threads (if any) waiting on a condition variable.
298  * @param p_cond condition variable
299  */
300 void vlc_cond_broadcast (vlc_cond_t *p_condvar)
301 {
302     pthread_cond_broadcast (p_condvar);
303 }
304
305 /**
306  * Waits for a condition variable. The calling thread will be suspended until
307  * another thread calls vlc_cond_signal() or vlc_cond_broadcast() on the same
308  * condition variable, the thread is cancelled with vlc_cancel(), or the
309  * system causes a "spurious" unsolicited wake-up.
310  *
311  * A mutex is needed to wait on a condition variable. It must <b>not</b> be
312  * a recursive mutex. Although it is possible to use the same mutex for
313  * multiple condition, it is not valid to use different mutexes for the same
314  * condition variable at the same time from different threads.
315  *
316  * In case of thread cancellation, the mutex is always locked before
317  * cancellation proceeds.
318  *
319  * The canonical way to use a condition variable to wait for event foobar is:
320  @code
321    vlc_mutex_lock (&lock);
322    mutex_cleanup_push (&lock); // release the mutex in case of cancellation
323
324    while (!foobar)
325        vlc_cond_wait (&wait, &lock);
326
327    --- foobar is now true, do something about it here --
328
329    vlc_cleanup_run (); // release the mutex
330   @endcode
331  *
332  * @param p_condvar condition variable to wait on
333  * @param p_mutex mutex which is unlocked while waiting,
334  *                then locked again when waking up.
335  * @param deadline <b>absolute</b> timeout
336  *
337  * @return 0 if the condition was signaled, an error code in case of timeout.
338  */
339 void vlc_cond_wait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex)
340 {
341     int val = pthread_cond_wait( p_condvar, p_mutex );
342     VLC_THREAD_ASSERT ("waiting on condition");
343 }
344
345 /**
346  * Waits for a condition variable up to a certain date.
347  * This works like vlc_cond_wait(), except for the additional timeout.
348  *
349  * @param p_condvar condition variable to wait on
350  * @param p_mutex mutex which is unlocked while waiting,
351  *                then locked again when waking up.
352  * @param deadline <b>absolute</b> timeout
353  *
354  * @return 0 if the condition was signaled, an error code in case of timeout.
355  */
356 int vlc_cond_timedwait (vlc_cond_t *p_condvar, vlc_mutex_t *p_mutex,
357                         mtime_t deadline)
358 {
359 #if defined(__APPLE__) && !defined(__powerpc__) && !defined( __ppc__ ) && !defined( __ppc64__ )
360     /* mdate() is mac_absolute_time on OSX, which we must convert to do
361      * the same base than gettimeofday() which pthread_cond_timedwait
362      * relies on. */
363     mtime_t oldbase = mdate();
364     struct timeval tv;
365     gettimeofday(&tv, NULL);
366     mtime_t newbase = (mtime_t)tv.tv_sec * 1000000 + (mtime_t) tv.tv_usec;
367     deadline = deadline - oldbase + newbase;
368 #endif
369     lldiv_t d = lldiv( deadline, CLOCK_FREQ );
370     struct timespec ts = { d.quot, d.rem * (1000000000 / CLOCK_FREQ) };
371
372     int val = pthread_cond_timedwait (p_condvar, p_mutex, &ts);
373     if (val != ETIMEDOUT)
374         VLC_THREAD_ASSERT ("timed-waiting on condition");
375     return val;
376 }
377
378 /**
379  * Allocates a thread-specific variable.
380  * @param key where to store the thread-specific variable handle
381  * @param destr a destruction callback. It is called whenever a thread exits
382  * and the thread-specific variable has a non-NULL value.
383  * @return 0 on success, a system error code otherwise. This function can
384  * actually fail because there is a fixed limit on the number of
385  * thread-specific variable in a process on most systems.
386  */
387 int vlc_threadvar_create (vlc_threadvar_t *key, void (*destr) (void *))
388 {
389     return pthread_key_create (key, destr);
390 }
391
392 void vlc_threadvar_delete (vlc_threadvar_t *p_tls)
393 {
394     pthread_key_delete (*p_tls);
395 }
396
397 /**
398  * Sets a thread-specific variable.
399  * @param key thread-local variable key (created with vlc_threadvar_create())
400  * @param value new value for the variable for the calling thread
401  * @return 0 on success, a system error code otherwise.
402  */
403 int vlc_threadvar_set (vlc_threadvar_t key, void *value)
404 {
405     return pthread_setspecific (key, value);
406 }
407
408 /**
409  * Gets the value of a thread-local variable for the calling thread.
410  * This function cannot fail.
411  * @return the value associated with the given variable for the calling
412  * or NULL if there is no value.
413  */
414 void *vlc_threadvar_get (vlc_threadvar_t key)
415 {
416     return pthread_getspecific (key);
417 }
418
419 /**
420  * Creates and starts new thread.
421  *
422  * @param p_handle [OUT] pointer to write the handle of the created thread to
423  * @param entry entry point for the thread
424  * @param data data parameter given to the entry point
425  * @param priority thread priority value
426  * @return 0 on success, a standard error code on error.
427  */
428 int vlc_clone (vlc_thread_t *p_handle, void * (*entry) (void *), void *data,
429                int priority)
430 {
431     int ret;
432
433     pthread_attr_t attr;
434     pthread_attr_init (&attr);
435
436     /* Block the signals that signals interface plugin handles.
437      * If the LibVLC caller wants to handle some signals by itself, it should
438      * block these before whenever invoking LibVLC. And it must obviously not
439      * start the VLC signals interface plugin.
440      *
441      * LibVLC will normally ignore any interruption caused by an asynchronous
442      * signal during a system call. But there may well be some buggy cases
443      * where it fails to handle EINTR (bug reports welcome). Some underlying
444      * libraries might also not handle EINTR properly.
445      */
446     sigset_t oldset;
447     {
448         sigset_t set;
449         sigemptyset (&set);
450         sigdelset (&set, SIGHUP);
451         sigaddset (&set, SIGINT);
452         sigaddset (&set, SIGQUIT);
453         sigaddset (&set, SIGTERM);
454
455         sigaddset (&set, SIGPIPE); /* We don't want this one, really! */
456         pthread_sigmask (SIG_BLOCK, &set, &oldset);
457     }
458
459 #if defined (_POSIX_PRIORITY_SCHEDULING) && (_POSIX_PRIORITY_SCHEDULING >= 0) \
460  && defined (_POSIX_THREAD_PRIORITY_SCHEDULING) \
461  && (_POSIX_THREAD_PRIORITY_SCHEDULING >= 0)
462     {
463         struct sched_param sp = { .sched_priority = priority, };
464         int policy;
465
466         if (sp.sched_priority <= 0)
467             sp.sched_priority += sched_get_priority_max (policy = SCHED_OTHER);
468         else
469             sp.sched_priority += sched_get_priority_min (policy = SCHED_RR);
470
471         pthread_attr_setschedpolicy (&attr, policy);
472         pthread_attr_setschedparam (&attr, &sp);
473     }
474 #else
475     (void) priority;
476 #endif
477
478     /* The thread stack size.
479      * The lower the value, the less address space per thread, the highest
480      * maximum simultaneous threads per process. Too low values will cause
481      * stack overflows and weird crashes. Set with caution. Also keep in mind
482      * that 64-bits platforms consume more stack than 32-bits one.
483      *
484      * Thanks to on-demand paging, thread stack size only affects address space
485      * consumption. In terms of memory, threads only use what they need
486      * (rounded up to the page boundary).
487      *
488      * For example, on Linux i386, the default is 2 mega-bytes, which supports
489      * about 320 threads per processes. */
490 #define VLC_STACKSIZE (128 * sizeof (void *) * 1024)
491
492 #ifdef VLC_STACKSIZE
493     ret = pthread_attr_setstacksize (&attr, VLC_STACKSIZE);
494     assert (ret == 0); /* fails iif VLC_STACKSIZE is invalid */
495 #endif
496
497     ret = pthread_create (p_handle, &attr, entry, data);
498     pthread_sigmask (SIG_SETMASK, &oldset, NULL);
499     pthread_attr_destroy (&attr);
500     return ret;
501 }
502
503 /**
504  * Marks a thread as cancelled. Next time the target thread reaches a
505  * cancellation point (while not having disabled cancellation), it will
506  * run its cancellation cleanup handler, the thread variable destructors, and
507  * terminate. vlc_join() must be used afterward regardless of a thread being
508  * cancelled or not.
509  */
510 void vlc_cancel (vlc_thread_t thread_id)
511 {
512     pthread_cancel (thread_id);
513 }
514
515 /**
516  * Waits for a thread to complete (if needed), and destroys it.
517  * This is a cancellation point; in case of cancellation, the join does _not_
518  * occur.
519  *
520  * @param handle thread handle
521  * @param p_result [OUT] pointer to write the thread return value or NULL
522  * @return 0 on success, a standard error code otherwise.
523  */
524 void vlc_join (vlc_thread_t handle, void **result)
525 {
526     int val = pthread_join (handle, result);
527     VLC_THREAD_ASSERT ("joining thread");
528 }
529
530 /**
531  * Save the current cancellation state (enabled or disabled), then disable
532  * cancellation for the calling thread.
533  * This function must be called before entering a piece of code that is not
534  * cancellation-safe, unless it can be proven that the calling thread will not
535  * be cancelled.
536  * @return Previous cancellation state (opaque value for vlc_restorecancel()).
537  */
538 int vlc_savecancel (void)
539 {
540     int state;
541     int val = pthread_setcancelstate (PTHREAD_CANCEL_DISABLE, &state);
542
543     VLC_THREAD_ASSERT ("saving cancellation");
544     return state;
545 }
546
547 /**
548  * Restore the cancellation state for the calling thread.
549  * @param state previous state as returned by vlc_savecancel().
550  * @return Nothing, always succeeds.
551  */
552 void vlc_restorecancel (int state)
553 {
554 #ifndef NDEBUG
555     int oldstate, val;
556
557     val = pthread_setcancelstate (state, &oldstate);
558     /* This should fail if an invalid value for given for state */
559     VLC_THREAD_ASSERT ("restoring cancellation");
560
561     if (oldstate != PTHREAD_CANCEL_DISABLE)
562          vlc_thread_fatal ("restoring cancellation while not disabled", EINVAL,
563                            __func__, __FILE__, __LINE__);
564 #else
565     pthread_setcancelstate (state, NULL);
566 #endif
567 }
568
569 /**
570  * Issues an explicit deferred cancellation point.
571  * This has no effect if thread cancellation is disabled.
572  * This can be called when there is a rather slow non-sleeping operation.
573  * This is also used to force a cancellation point in a function that would
574  * otherwise "not always" be a one (block_FifoGet() is an example).
575  */
576 void vlc_testcancel (void)
577 {
578     pthread_testcancel ();
579 }
580
581 void vlc_control_cancel (int cmd, ...)
582 {
583     (void) cmd;
584     assert (0);
585 }