2 //===----------------------------------------------------------------------===//
4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 // See https://llvm.org/LICENSE.txt for license information.
6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
8 //===----------------------------------------------------------------------===//
10 #ifndef _LIBCPP___THREADING_SUPPORT
11 #define _LIBCPP___THREADING_SUPPORT
13 #include <__availability>
14 #include <__chrono/convert_to_timespec.h>
15 #include <__chrono/duration.h>
17 #include <__thread/poll_with_backoff.h>
21 # include <__support/ibm/nanosleep.h>
24 #ifndef _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER
25 # pragma GCC system_header
28 #if defined(_LIBCPP_HAS_THREAD_API_EXTERNAL)
29 # include <__external_threading>
30 #elif !defined(_LIBCPP_HAS_NO_THREADS)
32 #if defined(_LIBCPP_HAS_THREAD_API_PTHREAD)
33 // Some platforms require <bits/atomic_wide_counter.h> in order for
34 // PTHREAD_COND_INITIALIZER to be expanded. Normally that would come
35 // in via <pthread.h>, but it's a non-modular header on those platforms,
36 // so libc++'s <math.h> usually absorbs atomic_wide_counter.h into the
37 // module with <math.h> and makes atomic_wide_counter.h invisible.
38 // Include <math.h> here to work around that.
43 #elif defined(_LIBCPP_HAS_THREAD_API_C11)
47 #if defined(_LIBCPP_HAS_THREAD_API_WIN32)
48 #define _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_EXPORTED_FROM_ABI
50 #define _LIBCPP_THREAD_ABI_VISIBILITY inline _LIBCPP_INLINE_VISIBILITY
53 typedef ::timespec __libcpp_timespec_t;
54 #endif // !defined(_LIBCPP_HAS_NO_THREADS)
56 _LIBCPP_BEGIN_NAMESPACE_STD
58 #if !defined(_LIBCPP_HAS_NO_THREADS)
60 #if defined(_LIBCPP_HAS_THREAD_API_PTHREAD)
62 typedef pthread_mutex_t __libcpp_mutex_t;
63 #define _LIBCPP_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
65 typedef pthread_mutex_t __libcpp_recursive_mutex_t;
68 typedef pthread_cond_t __libcpp_condvar_t;
69 #define _LIBCPP_CONDVAR_INITIALIZER PTHREAD_COND_INITIALIZER
72 typedef pthread_once_t __libcpp_exec_once_flag;
73 #define _LIBCPP_EXEC_ONCE_INITIALIZER PTHREAD_ONCE_INIT
77 typedef unsigned long long __libcpp_thread_id;
79 typedef pthread_t __libcpp_thread_id;
83 #define _LIBCPP_NULL_THREAD ((__libcpp_thread_t()))
84 typedef pthread_t __libcpp_thread_t;
86 // Thread Local Storage
87 typedef pthread_key_t __libcpp_tls_key;
89 #define _LIBCPP_TLS_DESTRUCTOR_CC
90 #elif defined(_LIBCPP_HAS_THREAD_API_C11)
92 typedef mtx_t __libcpp_mutex_t;
93 // mtx_t is a struct so using {} for initialization is valid.
94 #define _LIBCPP_MUTEX_INITIALIZER {}
96 typedef mtx_t __libcpp_recursive_mutex_t;
99 typedef cnd_t __libcpp_condvar_t;
100 // cnd_t is a struct so using {} for initialization is valid.
101 #define _LIBCPP_CONDVAR_INITIALIZER {}
104 typedef once_flag __libcpp_exec_once_flag;
105 #define _LIBCPP_EXEC_ONCE_INITIALIZER ONCE_FLAG_INIT
108 typedef thrd_t __libcpp_thread_id;
111 #define _LIBCPP_NULL_THREAD 0U
113 typedef thrd_t __libcpp_thread_t;
115 // Thread Local Storage
116 typedef tss_t __libcpp_tls_key;
118 #define _LIBCPP_TLS_DESTRUCTOR_CC
119 #elif !defined(_LIBCPP_HAS_THREAD_API_EXTERNAL)
121 typedef void* __libcpp_mutex_t;
122 #define _LIBCPP_MUTEX_INITIALIZER 0
124 #if defined(_M_IX86) || defined(__i386__) || defined(_M_ARM) || defined(__arm__)
125 typedef void* __libcpp_recursive_mutex_t[6];
126 #elif defined(_M_AMD64) || defined(__x86_64__) || defined(_M_ARM64) || defined(__aarch64__)
127 typedef void* __libcpp_recursive_mutex_t[5];
129 # error Unsupported architecture
132 // Condition Variable
133 typedef void* __libcpp_condvar_t;
134 #define _LIBCPP_CONDVAR_INITIALIZER 0
137 typedef void* __libcpp_exec_once_flag;
138 #define _LIBCPP_EXEC_ONCE_INITIALIZER 0
141 typedef long __libcpp_thread_id;
144 #define _LIBCPP_NULL_THREAD 0U
146 typedef void* __libcpp_thread_t;
148 // Thread Local Storage
149 typedef long __libcpp_tls_key;
151 #define _LIBCPP_TLS_DESTRUCTOR_CC __stdcall
152 #endif // !defined(_LIBCPP_HAS_THREAD_API_PTHREAD) && !defined(_LIBCPP_HAS_THREAD_API_EXTERNAL)
154 #if !defined(_LIBCPP_HAS_THREAD_API_EXTERNAL)
156 _LIBCPP_THREAD_ABI_VISIBILITY
157 int __libcpp_recursive_mutex_init(__libcpp_recursive_mutex_t *__m);
159 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
160 int __libcpp_recursive_mutex_lock(__libcpp_recursive_mutex_t *__m);
162 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
163 bool __libcpp_recursive_mutex_trylock(__libcpp_recursive_mutex_t *__m);
165 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
166 int __libcpp_recursive_mutex_unlock(__libcpp_recursive_mutex_t *__m);
168 _LIBCPP_THREAD_ABI_VISIBILITY
169 int __libcpp_recursive_mutex_destroy(__libcpp_recursive_mutex_t *__m);
171 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
172 int __libcpp_mutex_lock(__libcpp_mutex_t *__m);
174 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
175 bool __libcpp_mutex_trylock(__libcpp_mutex_t *__m);
177 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
178 int __libcpp_mutex_unlock(__libcpp_mutex_t *__m);
180 _LIBCPP_THREAD_ABI_VISIBILITY
181 int __libcpp_mutex_destroy(__libcpp_mutex_t *__m);
183 // Condition variable
184 _LIBCPP_THREAD_ABI_VISIBILITY
185 int __libcpp_condvar_signal(__libcpp_condvar_t* __cv);
187 _LIBCPP_THREAD_ABI_VISIBILITY
188 int __libcpp_condvar_broadcast(__libcpp_condvar_t* __cv);
190 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
191 int __libcpp_condvar_wait(__libcpp_condvar_t* __cv, __libcpp_mutex_t* __m);
193 _LIBCPP_THREAD_ABI_VISIBILITY _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
194 int __libcpp_condvar_timedwait(__libcpp_condvar_t *__cv, __libcpp_mutex_t *__m,
195 __libcpp_timespec_t *__ts);
197 _LIBCPP_THREAD_ABI_VISIBILITY
198 int __libcpp_condvar_destroy(__libcpp_condvar_t* __cv);
201 _LIBCPP_THREAD_ABI_VISIBILITY
202 int __libcpp_execute_once(__libcpp_exec_once_flag *__flag,
203 void (*__init_routine)());
206 _LIBCPP_THREAD_ABI_VISIBILITY
207 bool __libcpp_thread_id_equal(__libcpp_thread_id __t1, __libcpp_thread_id __t2);
209 _LIBCPP_THREAD_ABI_VISIBILITY
210 bool __libcpp_thread_id_less(__libcpp_thread_id __t1, __libcpp_thread_id __t2);
213 _LIBCPP_THREAD_ABI_VISIBILITY
214 bool __libcpp_thread_isnull(const __libcpp_thread_t *__t);
216 _LIBCPP_THREAD_ABI_VISIBILITY
217 int __libcpp_thread_create(__libcpp_thread_t *__t, void *(*__func)(void *),
220 _LIBCPP_THREAD_ABI_VISIBILITY
221 __libcpp_thread_id __libcpp_thread_get_current_id();
223 _LIBCPP_THREAD_ABI_VISIBILITY
224 __libcpp_thread_id __libcpp_thread_get_id(const __libcpp_thread_t *__t);
226 _LIBCPP_THREAD_ABI_VISIBILITY
227 int __libcpp_thread_join(__libcpp_thread_t *__t);
229 _LIBCPP_THREAD_ABI_VISIBILITY
230 int __libcpp_thread_detach(__libcpp_thread_t *__t);
232 _LIBCPP_THREAD_ABI_VISIBILITY
233 void __libcpp_thread_yield();
235 _LIBCPP_THREAD_ABI_VISIBILITY
236 void __libcpp_thread_sleep_for(const chrono::nanoseconds& __ns);
238 // Thread local storage
239 _LIBCPP_THREAD_ABI_VISIBILITY
240 int __libcpp_tls_create(__libcpp_tls_key* __key,
241 void(_LIBCPP_TLS_DESTRUCTOR_CC* __at_exit)(void*));
243 _LIBCPP_THREAD_ABI_VISIBILITY
244 void *__libcpp_tls_get(__libcpp_tls_key __key);
246 _LIBCPP_THREAD_ABI_VISIBILITY
247 int __libcpp_tls_set(__libcpp_tls_key __key, void *__p);
249 #endif // !defined(_LIBCPP_HAS_THREAD_API_EXTERNAL)
251 #if defined(_LIBCPP_HAS_THREAD_API_PTHREAD)
253 int __libcpp_recursive_mutex_init(__libcpp_recursive_mutex_t *__m)
255 pthread_mutexattr_t __attr;
256 int __ec = pthread_mutexattr_init(&__attr);
259 __ec = pthread_mutexattr_settype(&__attr, PTHREAD_MUTEX_RECURSIVE);
261 pthread_mutexattr_destroy(&__attr);
264 __ec = pthread_mutex_init(__m, &__attr);
266 pthread_mutexattr_destroy(&__attr);
269 __ec = pthread_mutexattr_destroy(&__attr);
271 pthread_mutex_destroy(__m);
277 int __libcpp_recursive_mutex_lock(__libcpp_recursive_mutex_t *__m)
279 return pthread_mutex_lock(__m);
282 bool __libcpp_recursive_mutex_trylock(__libcpp_recursive_mutex_t *__m)
284 return pthread_mutex_trylock(__m) == 0;
287 int __libcpp_recursive_mutex_unlock(__libcpp_recursive_mutex_t *__m)
289 return pthread_mutex_unlock(__m);
292 int __libcpp_recursive_mutex_destroy(__libcpp_recursive_mutex_t *__m)
294 return pthread_mutex_destroy(__m);
297 int __libcpp_mutex_lock(__libcpp_mutex_t *__m)
299 return pthread_mutex_lock(__m);
302 bool __libcpp_mutex_trylock(__libcpp_mutex_t *__m)
304 return pthread_mutex_trylock(__m) == 0;
307 int __libcpp_mutex_unlock(__libcpp_mutex_t *__m)
309 return pthread_mutex_unlock(__m);
312 int __libcpp_mutex_destroy(__libcpp_mutex_t *__m)
314 return pthread_mutex_destroy(__m);
317 // Condition Variable
318 int __libcpp_condvar_signal(__libcpp_condvar_t *__cv)
320 return pthread_cond_signal(__cv);
323 int __libcpp_condvar_broadcast(__libcpp_condvar_t *__cv)
325 return pthread_cond_broadcast(__cv);
328 int __libcpp_condvar_wait(__libcpp_condvar_t *__cv, __libcpp_mutex_t *__m)
330 return pthread_cond_wait(__cv, __m);
333 int __libcpp_condvar_timedwait(__libcpp_condvar_t *__cv, __libcpp_mutex_t *__m,
334 __libcpp_timespec_t *__ts)
336 return pthread_cond_timedwait(__cv, __m, __ts);
339 int __libcpp_condvar_destroy(__libcpp_condvar_t *__cv)
341 return pthread_cond_destroy(__cv);
345 int __libcpp_execute_once(__libcpp_exec_once_flag *__flag,
346 void (*__init_routine)()) {
347 return pthread_once(__flag, __init_routine);
351 // Returns non-zero if the thread ids are equal, otherwise 0
352 bool __libcpp_thread_id_equal(__libcpp_thread_id __t1, __libcpp_thread_id __t2)
357 // Returns non-zero if t1 < t2, otherwise 0
358 bool __libcpp_thread_id_less(__libcpp_thread_id __t1, __libcpp_thread_id __t2)
364 bool __libcpp_thread_isnull(const __libcpp_thread_t *__t) {
365 return __libcpp_thread_get_id(__t) == 0;
368 int __libcpp_thread_create(__libcpp_thread_t *__t, void *(*__func)(void *),
371 return pthread_create(__t, nullptr, __func, __arg);
374 __libcpp_thread_id __libcpp_thread_get_current_id()
376 const __libcpp_thread_t __current_thread = pthread_self();
377 return __libcpp_thread_get_id(&__current_thread);
380 __libcpp_thread_id __libcpp_thread_get_id(const __libcpp_thread_t *__t)
389 int __libcpp_thread_join(__libcpp_thread_t *__t)
391 return pthread_join(*__t, nullptr);
394 int __libcpp_thread_detach(__libcpp_thread_t *__t)
396 return pthread_detach(*__t);
399 void __libcpp_thread_yield()
404 void __libcpp_thread_sleep_for(const chrono::nanoseconds& __ns)
406 __libcpp_timespec_t __ts = _VSTD::__convert_to_timespec<__libcpp_timespec_t>(__ns);
407 while (nanosleep(&__ts, &__ts) == -1 && errno == EINTR);
410 // Thread local storage
411 int __libcpp_tls_create(__libcpp_tls_key *__key, void (*__at_exit)(void *))
413 return pthread_key_create(__key, __at_exit);
416 void *__libcpp_tls_get(__libcpp_tls_key __key)
418 return pthread_getspecific(__key);
421 int __libcpp_tls_set(__libcpp_tls_key __key, void *__p)
423 return pthread_setspecific(__key, __p);
426 #elif defined(_LIBCPP_HAS_THREAD_API_C11)
428 int __libcpp_recursive_mutex_init(__libcpp_recursive_mutex_t *__m)
430 return mtx_init(__m, mtx_plain | mtx_recursive) == thrd_success ? 0 : EINVAL;
433 int __libcpp_recursive_mutex_lock(__libcpp_recursive_mutex_t *__m)
435 return mtx_lock(__m) == thrd_success ? 0 : EINVAL;
438 bool __libcpp_recursive_mutex_trylock(__libcpp_recursive_mutex_t *__m)
440 return mtx_trylock(__m) == thrd_success;
443 int __libcpp_recursive_mutex_unlock(__libcpp_recursive_mutex_t *__m)
445 return mtx_unlock(__m) == thrd_success ? 0 : EINVAL;
448 int __libcpp_recursive_mutex_destroy(__libcpp_recursive_mutex_t *__m)
454 int __libcpp_mutex_lock(__libcpp_mutex_t *__m)
456 return mtx_lock(__m) == thrd_success ? 0 : EINVAL;
459 bool __libcpp_mutex_trylock(__libcpp_mutex_t *__m)
461 return mtx_trylock(__m) == thrd_success;
464 int __libcpp_mutex_unlock(__libcpp_mutex_t *__m)
466 return mtx_unlock(__m) == thrd_success ? 0 : EINVAL;
469 int __libcpp_mutex_destroy(__libcpp_mutex_t *__m)
475 // Condition Variable
476 int __libcpp_condvar_signal(__libcpp_condvar_t *__cv)
478 return cnd_signal(__cv) == thrd_success ? 0 : EINVAL;
481 int __libcpp_condvar_broadcast(__libcpp_condvar_t *__cv)
483 return cnd_broadcast(__cv) == thrd_success ? 0 : EINVAL;
486 int __libcpp_condvar_wait(__libcpp_condvar_t *__cv, __libcpp_mutex_t *__m)
488 return cnd_wait(__cv, __m) == thrd_success ? 0 : EINVAL;
491 int __libcpp_condvar_timedwait(__libcpp_condvar_t *__cv, __libcpp_mutex_t *__m,
494 int __ec = cnd_timedwait(__cv, __m, __ts);
495 return __ec == thrd_timedout ? ETIMEDOUT : __ec;
498 int __libcpp_condvar_destroy(__libcpp_condvar_t *__cv)
505 int __libcpp_execute_once(__libcpp_exec_once_flag *flag,
506 void (*init_routine)(void)) {
507 ::call_once(flag, init_routine);
512 // Returns non-zero if the thread ids are equal, otherwise 0
513 bool __libcpp_thread_id_equal(__libcpp_thread_id t1, __libcpp_thread_id t2)
515 return thrd_equal(t1, t2) != 0;
518 // Returns non-zero if t1 < t2, otherwise 0
519 bool __libcpp_thread_id_less(__libcpp_thread_id t1, __libcpp_thread_id t2)
525 bool __libcpp_thread_isnull(const __libcpp_thread_t *__t) {
526 return __libcpp_thread_get_id(__t) == 0;
529 int __libcpp_thread_create(__libcpp_thread_t *__t, void *(*__func)(void *),
532 int __ec = thrd_create(__t, reinterpret_cast<thrd_start_t>(__func), __arg);
533 return __ec == thrd_nomem ? ENOMEM : __ec;
536 __libcpp_thread_id __libcpp_thread_get_current_id()
538 return thrd_current();
541 __libcpp_thread_id __libcpp_thread_get_id(const __libcpp_thread_t *__t)
546 int __libcpp_thread_join(__libcpp_thread_t *__t)
548 return thrd_join(*__t, nullptr) == thrd_success ? 0 : EINVAL;
551 int __libcpp_thread_detach(__libcpp_thread_t *__t)
553 return thrd_detach(*__t) == thrd_success ? 0 : EINVAL;
556 void __libcpp_thread_yield()
561 void __libcpp_thread_sleep_for(const chrono::nanoseconds& __ns)
563 __libcpp_timespec_t __ts = _VSTD::__convert_to_timespec<__libcpp_timespec_t>(__ns);
564 thrd_sleep(&__ts, nullptr);
567 // Thread local storage
568 int __libcpp_tls_create(__libcpp_tls_key *__key, void (*__at_exit)(void *))
570 return tss_create(__key, __at_exit) == thrd_success ? 0 : EINVAL;
573 void *__libcpp_tls_get(__libcpp_tls_key __key)
575 return tss_get(__key);
578 int __libcpp_tls_set(__libcpp_tls_key __key, void *__p)
580 return tss_set(__key, __p) == thrd_success ? 0 : EINVAL;
585 #endif // !_LIBCPP_HAS_NO_THREADS
587 _LIBCPP_END_NAMESPACE_STD
589 #endif // _LIBCPP___THREADING_SUPPORT