diff options
Diffstat (limited to 'osdep/threads-posix.h')
| -rw-r--r-- | osdep/threads-posix.h | 252 |
1 files changed, 252 insertions, 0 deletions
diff --git a/osdep/threads-posix.h b/osdep/threads-posix.h new file mode 100644 index 0000000000..4b3bb902ac --- /dev/null +++ b/osdep/threads-posix.h @@ -0,0 +1,252 @@ +/* + * This file is part of mpv. + * + * mpv is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * mpv is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with mpv. If not, see <http://www.gnu.org/licenses/>. + */ + +#pragma once + +#include <errno.h> +#include <pthread.h> +#include <stdio.h> + +#include "common/common.h" +#include "config.h" +// We make use of NON-POSIX pthreads functions and certain systems +// require this header to build without issues. (ex: OpenBSD) +#if HAVE_BSD_THREAD_NAME +#include <pthread_np.h> +#endif +#include "osdep/compiler.h" +#include "timer.h" + +int mp_ptwrap_check(const char *file, int line, int res); +int mp_ptwrap_mutex_init(const char *file, int line, pthread_mutex_t *m, + const pthread_mutexattr_t *attr); +int mp_ptwrap_mutex_trylock(const char *file, int line, pthread_mutex_t *m); + +#if HAVE_PTHREAD_DEBUG + +// pthread debugging wrappers. Technically, this is undefined behavior, because +// you are not supposed to define any symbols that clash with reserved names. +// Other than that, they should be fine. + +// Note: mpv normally never checks pthread error return values of certain +// functions that should never fail. It does so because these cases would +// be undefined behavior anyway (such as double-frees etc.). However, +// since there are no good pthread debugging tools, these wrappers are +// provided for the sake of debugging. They crash on unexpected errors. +// +// Technically, pthread_cond/mutex_init() can fail with ENOMEM. We don't +// really respect this for normal/recursive mutex types, as due to the +// existence of static initializers, no sane implementation could actually +// require allocating memory. + +#define MP_PTWRAP(fn, ...) \ + mp_ptwrap_check(__FILE__, __LINE__, (fn)(__VA_ARGS__)) + +// ISO C defines that all standard functions can be macros, except undef'ing +// them is allowed and must make the "real" definitions available. (Whatever.) +#undef pthread_cond_init +#undef pthread_cond_destroy +#undef pthread_cond_broadcast +#undef pthread_cond_signal +#undef pthread_cond_wait +#undef pthread_cond_timedwait +#undef pthread_detach +#undef pthread_join +#undef pthread_mutex_destroy +#undef pthread_mutex_lock +#undef pthread_mutex_trylock +#undef pthread_mutex_unlock + +#define pthread_cond_init(...) MP_PTWRAP(pthread_cond_init, __VA_ARGS__) +#define pthread_cond_destroy(...) MP_PTWRAP(pthread_cond_destroy, __VA_ARGS__) +#define pthread_cond_broadcast(...) MP_PTWRAP(pthread_cond_broadcast, __VA_ARGS__) +#define pthread_cond_signal(...) MP_PTWRAP(pthread_cond_signal, __VA_ARGS__) +#define pthread_cond_wait(...) MP_PTWRAP(pthread_cond_wait, __VA_ARGS__) +#define pthread_cond_timedwait(...) MP_PTWRAP(pthread_cond_timedwait, __VA_ARGS__) +#define pthread_detach(...) MP_PTWRAP(pthread_detach, __VA_ARGS__) +#define pthread_join(...) MP_PTWRAP(pthread_join, __VA_ARGS__) +#define pthread_mutex_destroy(...) MP_PTWRAP(pthread_mutex_destroy, __VA_ARGS__) +#define pthread_mutex_lock(...) MP_PTWRAP(pthread_mutex_lock, __VA_ARGS__) +#define pthread_mutex_unlock(...) MP_PTWRAP(pthread_mutex_unlock, __VA_ARGS__) + +#define pthread_mutex_init(...) \ + mp_ptwrap_mutex_init(__FILE__, __LINE__, __VA_ARGS__) + +#define pthread_mutex_trylock(...) \ + mp_ptwrap_mutex_trylock(__FILE__, __LINE__, __VA_ARGS__) + +#endif + +typedef struct { + pthread_cond_t cond; + clockid_t clk_id; +} mp_cond; + +typedef pthread_mutex_t mp_mutex; +typedef pthread_mutex_t mp_static_mutex; +typedef pthread_once_t mp_once; +typedef pthread_t mp_thread_id; +typedef pthread_t mp_thread; + +#define MP_STATIC_COND_INITIALIZER { .cond = PTHREAD_COND_INITIALIZER, .clk_id = CLOCK_REALTIME } +#define MP_STATIC_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER +#define MP_STATIC_ONCE_INITIALIZER PTHREAD_ONCE_INIT + +static inline int mp_mutex_init_type_internal(mp_mutex *mutex, enum mp_mutex_type mtype) +{ + int mutex_type; + switch (mtype) { + case MP_MUTEX_RECURSIVE: + mutex_type = PTHREAD_MUTEX_RECURSIVE; + break; + case MP_MUTEX_NORMAL: + default: +#ifndef NDEBUG + mutex_type = PTHREAD_MUTEX_ERRORCHECK; +#else + mutex_type = PTHREAD_MUTEX_DEFAULT; +#endif + break; + } + + int ret = 0; + pthread_mutexattr_t attr; + ret = pthread_mutexattr_init(&attr); + if (ret != 0) + return ret; + + pthread_mutexattr_settype(&attr, mutex_type); + ret = pthread_mutex_init(mutex, &attr); + pthread_mutexattr_destroy(&attr); + assert(!ret); + return ret; +} + +#define mp_mutex_destroy pthread_mutex_destroy +#define mp_mutex_lock pthread_mutex_lock +#define mp_mutex_trylock pthread_mutex_trylock +#define mp_mutex_unlock pthread_mutex_unlock + +static inline int mp_cond_init(mp_cond *cond) +{ + assert(cond); + + int ret = 0; + pthread_condattr_t attr; + ret = pthread_condattr_init(&attr); + if (ret) + return ret; + + cond->clk_id = CLOCK_REALTIME; +#if HAVE_PTHREAD_CONDATTR_SETCLOCK + if (!pthread_condattr_setclock(&attr, CLOCK_MONOTONIC)) + cond->clk_id = CLOCK_MONOTONIC; +#endif + + ret = pthread_cond_init(&cond->cond, &attr); + pthread_condattr_destroy(&attr); + return ret; +} + +static inline int mp_cond_destroy(mp_cond *cond) +{ + assert(cond); + return pthread_cond_destroy(&cond->cond); +} + +static inline int mp_cond_broadcast(mp_cond *cond) +{ + assert(cond); + return pthread_cond_broadcast(&cond->cond); +} + +static inline int mp_cond_signal(mp_cond *cond) +{ + assert(cond); + return pthread_cond_signal(&cond->cond); +} + +static inline int mp_cond_wait(mp_cond *cond, mp_mutex *mutex) +{ + assert(cond); + return pthread_cond_wait(&cond->cond, mutex); +} + +static inline int mp_cond_timedwait(mp_cond *cond, mp_mutex *mutex, int64_t timeout) +{ + assert(cond); + + timeout = MPMAX(0, timeout); + // consider anything above 1000 days as infinity + if (timeout > MP_TIME_S_TO_NS(1000 * 24 * 60 * 60)) + return pthread_cond_wait(&cond->cond, mutex); + + struct timespec ts; + clock_gettime(cond->clk_id, &ts); + ts.tv_sec += timeout / MP_TIME_S_TO_NS(1); + ts.tv_nsec += timeout % MP_TIME_S_TO_NS(1); + if (ts.tv_nsec >= MP_TIME_S_TO_NS(1)) { + ts.tv_nsec -= MP_TIME_S_TO_NS(1); + ts.tv_sec++; + } + + return pthread_cond_timedwait(&cond->cond, mutex, &ts); +} + +static inline int mp_cond_timedwait_until(mp_cond *cond, mp_mutex *mutex, int64_t until) +{ + return mp_cond_timedwait(cond, mutex, until - mp_time_ns()); +} + +#define mp_exec_once pthread_once + +#define MP_THREAD_VOID void * +#define MP_THREAD_RETURN() return NULL + +#define mp_thread_create(t, f, a) pthread_create(t, NULL, f, a) +#define mp_thread_join(t) pthread_join(t, NULL) +#define mp_thread_join_id(t) pthread_join(t, NULL) +#define mp_thread_detach pthread_detach +#define mp_thread_current_id pthread_self +#define mp_thread_id_equal(a, b) ((a) == (b)) +#define mp_thread_get_id(thread) (thread) + +static inline void mp_thread_set_name(const char *name) +{ +#if HAVE_GLIBC_THREAD_NAME + if (pthread_setname_np(pthread_self(), name) == ERANGE) { + char tname[16] = {0}; // glibc-checked kernel limit + strncpy(tname, name, sizeof(tname) - 1); + pthread_setname_np(pthread_self(), tname); + } +#elif HAVE_BSD_THREAD_NAME + pthread_set_name_np(pthread_self(), name); +#elif HAVE_MAC_THREAD_NAME + pthread_setname_np(name); +#endif +} + +static inline int64_t mp_thread_cpu_time_ns(mp_thread_id thread) +{ +#if defined(_POSIX_TIMERS) && _POSIX_TIMERS > 0 && defined(_POSIX_THREAD_CPUTIME) + clockid_t id; + struct timespec ts; + if (pthread_getcpuclockid(thread, &id) == 0 && clock_gettime(id, &ts) == 0) + return MP_TIME_S_TO_NS(ts.tv_sec) + ts.tv_nsec; +#endif + return 0; +} |