xref: /freebsd/contrib/llvm-project/libcxx/include/__thread/support.h (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1*0fca6ea1SDimitry Andric // -*- C++ -*-
2*0fca6ea1SDimitry Andric //===----------------------------------------------------------------------===//
3*0fca6ea1SDimitry Andric //
4*0fca6ea1SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5*0fca6ea1SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
6*0fca6ea1SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7*0fca6ea1SDimitry Andric //
8*0fca6ea1SDimitry Andric //===----------------------------------------------------------------------===//
9*0fca6ea1SDimitry Andric 
10*0fca6ea1SDimitry Andric #ifndef _LIBCPP___THREAD_SUPPORT_H
11*0fca6ea1SDimitry Andric #define _LIBCPP___THREAD_SUPPORT_H
12*0fca6ea1SDimitry Andric 
13*0fca6ea1SDimitry Andric #include <__config>
14*0fca6ea1SDimitry Andric 
15*0fca6ea1SDimitry Andric #ifndef _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER
16*0fca6ea1SDimitry Andric #  pragma GCC system_header
17*0fca6ea1SDimitry Andric #endif
18*0fca6ea1SDimitry Andric 
19*0fca6ea1SDimitry Andric /*
20*0fca6ea1SDimitry Andric 
21*0fca6ea1SDimitry Andric //
22*0fca6ea1SDimitry Andric // The library supports multiple implementations of the basic threading functionality.
23*0fca6ea1SDimitry Andric // The following functionality must be provided by any implementation:
24*0fca6ea1SDimitry Andric //
25*0fca6ea1SDimitry Andric 
26*0fca6ea1SDimitry Andric _LIBCPP_BEGIN_NAMESPACE_STD
27*0fca6ea1SDimitry Andric 
28*0fca6ea1SDimitry Andric using __libcpp_timespec_t = ...;
29*0fca6ea1SDimitry Andric 
30*0fca6ea1SDimitry Andric //
31*0fca6ea1SDimitry Andric // Mutex
32*0fca6ea1SDimitry Andric //
33*0fca6ea1SDimitry Andric using __libcpp_mutex_t = ...;
34*0fca6ea1SDimitry Andric #define _LIBCPP_MUTEX_INITIALIZER ...
35*0fca6ea1SDimitry Andric 
36*0fca6ea1SDimitry Andric using __libcpp_recursive_mutex_t = ...;
37*0fca6ea1SDimitry Andric 
38*0fca6ea1SDimitry Andric int __libcpp_recursive_mutex_init(__libcpp_recursive_mutex_t*);
39*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_recursive_mutex_lock(__libcpp_recursive_mutex_t*);
40*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS bool __libcpp_recursive_mutex_trylock(__libcpp_recursive_mutex_t*);
41*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_recursive_mutex_unlock(__libcpp_recursive_mutex_t*);
42*0fca6ea1SDimitry Andric int __libcpp_recursive_mutex_destroy(__libcpp_recursive_mutex_t*);
43*0fca6ea1SDimitry Andric 
44*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_mutex_lock(__libcpp_mutex_t*);
45*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS bool __libcpp_mutex_trylock(__libcpp_mutex_t*);
46*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_mutex_unlock(__libcpp_mutex_t*);
47*0fca6ea1SDimitry Andric int __libcpp_mutex_destroy(__libcpp_mutex_t*);
48*0fca6ea1SDimitry Andric 
49*0fca6ea1SDimitry Andric //
50*0fca6ea1SDimitry Andric // Condition Variable
51*0fca6ea1SDimitry Andric //
52*0fca6ea1SDimitry Andric using __libcpp_condvar_t = ...;
53*0fca6ea1SDimitry Andric #define _LIBCPP_CONDVAR_INITIALIZER ...
54*0fca6ea1SDimitry Andric 
55*0fca6ea1SDimitry Andric int __libcpp_condvar_signal(__libcpp_condvar_t*);
56*0fca6ea1SDimitry Andric int __libcpp_condvar_broadcast(__libcpp_condvar_t*);
57*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS int __libcpp_condvar_wait(__libcpp_condvar_t*, __libcpp_mutex_t*);
58*0fca6ea1SDimitry Andric _LIBCPP_NO_THREAD_SAFETY_ANALYSIS
59*0fca6ea1SDimitry Andric int __libcpp_condvar_timedwait(__libcpp_condvar_t*, __libcpp_mutex_t*, __libcpp_timespec_t*);
60*0fca6ea1SDimitry Andric int __libcpp_condvar_destroy(__libcpp_condvar_t*);
61*0fca6ea1SDimitry Andric 
62*0fca6ea1SDimitry Andric //
63*0fca6ea1SDimitry Andric // Execute once
64*0fca6ea1SDimitry Andric //
65*0fca6ea1SDimitry Andric using __libcpp_exec_once_flag = ...;
66*0fca6ea1SDimitry Andric #define _LIBCPP_EXEC_ONCE_INITIALIZER ...
67*0fca6ea1SDimitry Andric 
68*0fca6ea1SDimitry Andric int __libcpp_execute_once(__libcpp_exec_once_flag*, void (*__init_routine)());
69*0fca6ea1SDimitry Andric 
70*0fca6ea1SDimitry Andric //
71*0fca6ea1SDimitry Andric // Thread id
72*0fca6ea1SDimitry Andric //
73*0fca6ea1SDimitry Andric using __libcpp_thread_id = ...;
74*0fca6ea1SDimitry Andric 
75*0fca6ea1SDimitry Andric bool __libcpp_thread_id_equal(__libcpp_thread_id, __libcpp_thread_id);
76*0fca6ea1SDimitry Andric bool __libcpp_thread_id_less(__libcpp_thread_id, __libcpp_thread_id);
77*0fca6ea1SDimitry Andric 
78*0fca6ea1SDimitry Andric //
79*0fca6ea1SDimitry Andric // Thread
80*0fca6ea1SDimitry Andric //
81*0fca6ea1SDimitry Andric #define _LIBCPP_NULL_THREAD ...
82*0fca6ea1SDimitry Andric using __libcpp_thread_t = ...;
83*0fca6ea1SDimitry Andric 
84*0fca6ea1SDimitry Andric bool __libcpp_thread_isnull(const __libcpp_thread_t*);
85*0fca6ea1SDimitry Andric int __libcpp_thread_create(__libcpp_thread_t*, void* (*__func)(void*), void* __arg);
86*0fca6ea1SDimitry Andric __libcpp_thread_id __libcpp_thread_get_current_id();
87*0fca6ea1SDimitry Andric __libcpp_thread_id __libcpp_thread_get_id(const __libcpp_thread_t*);
88*0fca6ea1SDimitry Andric int __libcpp_thread_join(__libcpp_thread_t*);
89*0fca6ea1SDimitry Andric int __libcpp_thread_detach(__libcpp_thread_t*);
90*0fca6ea1SDimitry Andric void __libcpp_thread_yield();
91*0fca6ea1SDimitry Andric void __libcpp_thread_sleep_for(const chrono::nanoseconds&);
92*0fca6ea1SDimitry Andric 
93*0fca6ea1SDimitry Andric //
94*0fca6ea1SDimitry Andric // Thread local storage
95*0fca6ea1SDimitry Andric //
96*0fca6ea1SDimitry Andric #define _LIBCPP_TLS_DESTRUCTOR_CC ...
97*0fca6ea1SDimitry Andric using __libcpp_tls_key = ...;
98*0fca6ea1SDimitry Andric 
99*0fca6ea1SDimitry Andric int __libcpp_tls_create(__libcpp_tls_key*, void (*__at_exit)(void*));
100*0fca6ea1SDimitry Andric void* __libcpp_tls_get(__libcpp_tls_key);
101*0fca6ea1SDimitry Andric int __libcpp_tls_set(__libcpp_tls_key, void*);
102*0fca6ea1SDimitry Andric 
103*0fca6ea1SDimitry Andric _LIBCPP_END_NAMESPACE_STD
104*0fca6ea1SDimitry Andric 
105*0fca6ea1SDimitry Andric */
106*0fca6ea1SDimitry Andric 
107*0fca6ea1SDimitry Andric #if !defined(_LIBCPP_HAS_NO_THREADS)
108*0fca6ea1SDimitry Andric 
109*0fca6ea1SDimitry Andric #  if defined(_LIBCPP_HAS_THREAD_API_EXTERNAL)
110*0fca6ea1SDimitry Andric #    include <__thread/support/external.h>
111*0fca6ea1SDimitry Andric #  elif defined(_LIBCPP_HAS_THREAD_API_PTHREAD)
112*0fca6ea1SDimitry Andric #    include <__thread/support/pthread.h>
113*0fca6ea1SDimitry Andric #  elif defined(_LIBCPP_HAS_THREAD_API_C11)
114*0fca6ea1SDimitry Andric #    include <__thread/support/c11.h>
115*0fca6ea1SDimitry Andric #  elif defined(_LIBCPP_HAS_THREAD_API_WIN32)
116*0fca6ea1SDimitry Andric #    include <__thread/support/windows.h>
117*0fca6ea1SDimitry Andric #  else
118*0fca6ea1SDimitry Andric #    error "No threading API was selected"
119*0fca6ea1SDimitry Andric #  endif
120*0fca6ea1SDimitry Andric 
121*0fca6ea1SDimitry Andric #endif // !_LIBCPP_HAS_NO_THREADS
122*0fca6ea1SDimitry Andric 
123*0fca6ea1SDimitry Andric #endif // _LIBCPP___THREAD_SUPPORT_H
124