xref: /llvm-project/libcxx/include/__thread/support.h (revision c6f3b7bcd0596d30f8dabecdfb9e44f9a07b6e4c)
17162fd75SLouis Dionne // -*- C++ -*-
27162fd75SLouis Dionne //===----------------------------------------------------------------------===//
37162fd75SLouis Dionne //
47162fd75SLouis Dionne // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
57162fd75SLouis Dionne // See https://llvm.org/LICENSE.txt for license information.
67162fd75SLouis Dionne // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
77162fd75SLouis Dionne //
87162fd75SLouis Dionne //===----------------------------------------------------------------------===//
97162fd75SLouis Dionne 
107162fd75SLouis Dionne #ifndef _LIBCPP___THREAD_SUPPORT_H
117162fd75SLouis Dionne #define _LIBCPP___THREAD_SUPPORT_H
127162fd75SLouis Dionne 
137162fd75SLouis Dionne #include <__config>
147162fd75SLouis Dionne 
157162fd75SLouis Dionne #ifndef _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER
167162fd75SLouis Dionne #  pragma GCC system_header
177162fd75SLouis Dionne #endif
187162fd75SLouis Dionne 
197162fd75SLouis Dionne /*
207162fd75SLouis Dionne 
217162fd75SLouis Dionne //
227162fd75SLouis Dionne // The library supports multiple implementations of the basic threading functionality.
237162fd75SLouis Dionne // The following functionality must be provided by any implementation:
247162fd75SLouis Dionne //
257162fd75SLouis Dionne 
26e1ddc333SLouis Dionne _LIBCPP_BEGIN_NAMESPACE_STD
27e1ddc333SLouis Dionne 
287162fd75SLouis Dionne using __libcpp_timespec_t = ...;
297162fd75SLouis Dionne 
307162fd75SLouis Dionne //
317162fd75SLouis Dionne // Mutex
327162fd75SLouis Dionne //
337162fd75SLouis Dionne using __libcpp_mutex_t = ...;
347162fd75SLouis Dionne #define _LIBCPP_MUTEX_INITIALIZER ...
357162fd75SLouis Dionne 
367162fd75SLouis Dionne using __libcpp_recursive_mutex_t = ...;
377162fd75SLouis Dionne 
387162fd75SLouis Dionne int __libcpp_recursive_mutex_init(__libcpp_recursive_mutex_t*);
397162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_recursive_mutex_lock(__libcpp_recursive_mutex_t*);
407162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS bool __libcpp_recursive_mutex_trylock(__libcpp_recursive_mutex_t*);
417162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_recursive_mutex_unlock(__libcpp_recursive_mutex_t*);
427162fd75SLouis Dionne int __libcpp_recursive_mutex_destroy(__libcpp_recursive_mutex_t*);
437162fd75SLouis Dionne 
447162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_mutex_lock(__libcpp_mutex_t*);
457162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS bool __libcpp_mutex_trylock(__libcpp_mutex_t*);
467162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_mutex_unlock(__libcpp_mutex_t*);
477162fd75SLouis Dionne int __libcpp_mutex_destroy(__libcpp_mutex_t*);
487162fd75SLouis Dionne 
497162fd75SLouis Dionne //
507162fd75SLouis Dionne // Condition Variable
517162fd75SLouis Dionne //
527162fd75SLouis Dionne using __libcpp_condvar_t = ...;
537162fd75SLouis Dionne #define _LIBCPP_CONDVAR_INITIALIZER ...
547162fd75SLouis Dionne 
557162fd75SLouis Dionne int __libcpp_condvar_signal(__libcpp_condvar_t*);
567162fd75SLouis Dionne int __libcpp_condvar_broadcast(__libcpp_condvar_t*);
577162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_condvar_wait(__libcpp_condvar_t*, __libcpp_mutex_t*);
587162fd75SLouis Dionne _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
597162fd75SLouis Dionne int __libcpp_condvar_timedwait(__libcpp_condvar_t*, __libcpp_mutex_t*, __libcpp_timespec_t*);
607162fd75SLouis Dionne int __libcpp_condvar_destroy(__libcpp_condvar_t*);
617162fd75SLouis Dionne 
627162fd75SLouis Dionne //
637162fd75SLouis Dionne // Execute once
647162fd75SLouis Dionne //
657162fd75SLouis Dionne using __libcpp_exec_once_flag = ...;
667162fd75SLouis Dionne #define _LIBCPP_EXEC_ONCE_INITIALIZER ...
677162fd75SLouis Dionne 
687162fd75SLouis Dionne int __libcpp_execute_once(__libcpp_exec_once_flag*, void (*__init_routine)());
697162fd75SLouis Dionne 
707162fd75SLouis Dionne //
717162fd75SLouis Dionne // Thread id
727162fd75SLouis Dionne //
737162fd75SLouis Dionne using __libcpp_thread_id = ...;
747162fd75SLouis Dionne 
757162fd75SLouis Dionne bool __libcpp_thread_id_equal(__libcpp_thread_id, __libcpp_thread_id);
767162fd75SLouis Dionne bool __libcpp_thread_id_less(__libcpp_thread_id, __libcpp_thread_id);
777162fd75SLouis Dionne 
787162fd75SLouis Dionne //
797162fd75SLouis Dionne // Thread
807162fd75SLouis Dionne //
817162fd75SLouis Dionne #define _LIBCPP_NULL_THREAD ...
827162fd75SLouis Dionne using __libcpp_thread_t = ...;
837162fd75SLouis Dionne 
847162fd75SLouis Dionne bool __libcpp_thread_isnull(const __libcpp_thread_t*);
857162fd75SLouis Dionne int __libcpp_thread_create(__libcpp_thread_t*, void* (*__func)(void*), void* __arg);
867162fd75SLouis Dionne __libcpp_thread_id __libcpp_thread_get_current_id();
877162fd75SLouis Dionne __libcpp_thread_id __libcpp_thread_get_id(const __libcpp_thread_t*);
887162fd75SLouis Dionne int __libcpp_thread_join(__libcpp_thread_t*);
897162fd75SLouis Dionne int __libcpp_thread_detach(__libcpp_thread_t*);
907162fd75SLouis Dionne void __libcpp_thread_yield();
917162fd75SLouis Dionne void __libcpp_thread_sleep_for(const chrono::nanoseconds&);
927162fd75SLouis Dionne 
937162fd75SLouis Dionne //
947162fd75SLouis Dionne // Thread local storage
957162fd75SLouis Dionne //
967162fd75SLouis Dionne #define _LIBCPP_TLS_DESTRUCTOR_CC ...
977162fd75SLouis Dionne using __libcpp_tls_key = ...;
987162fd75SLouis Dionne 
997162fd75SLouis Dionne int __libcpp_tls_create(__libcpp_tls_key*, void (*__at_exit)(void*));
1007162fd75SLouis Dionne void* __libcpp_tls_get(__libcpp_tls_key);
1017162fd75SLouis Dionne int __libcpp_tls_set(__libcpp_tls_key, void*);
1027162fd75SLouis Dionne 
103e1ddc333SLouis Dionne _LIBCPP_END_NAMESPACE_STD
104e1ddc333SLouis Dionne 
1057162fd75SLouis Dionne */
1067162fd75SLouis Dionne 
107*c6f3b7bcSNikolas Klauser #if _LIBCPP_HAS_THREADS
1087162fd75SLouis Dionne 
109*c6f3b7bcSNikolas Klauser #  if _LIBCPP_HAS_THREAD_API_EXTERNAL
1107162fd75SLouis Dionne #    include <__thread/support/external.h>
111*c6f3b7bcSNikolas Klauser #  elif _LIBCPP_HAS_THREAD_API_PTHREAD
1127162fd75SLouis Dionne #    include <__thread/support/pthread.h>
113*c6f3b7bcSNikolas Klauser #  elif _LIBCPP_HAS_THREAD_API_C11
1147162fd75SLouis Dionne #    include <__thread/support/c11.h>
115*c6f3b7bcSNikolas Klauser #  elif _LIBCPP_HAS_THREAD_API_WIN32
1167162fd75SLouis Dionne #    include <__thread/support/windows.h>
1177162fd75SLouis Dionne #  else
1187162fd75SLouis Dionne #    error "No threading API was selected"
1197162fd75SLouis Dionne #  endif
1207162fd75SLouis Dionne 
121*c6f3b7bcSNikolas Klauser #endif // _LIBCPP_HAS_THREADS
1227162fd75SLouis Dionne 
1237162fd75SLouis Dionne #endif // _LIBCPP___THREAD_SUPPORT_H
124