xref: /netbsd-src/external/apache2/llvm/dist/libcxx/src/mutex.cpp (revision 4d6fc14bc9b0c5bf3e30be318c143ee82cadd108)
1*4d6fc14bSjoerg //===------------------------- mutex.cpp ----------------------------------===//
2*4d6fc14bSjoerg //
3*4d6fc14bSjoerg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*4d6fc14bSjoerg // See https://llvm.org/LICENSE.txt for license information.
5*4d6fc14bSjoerg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*4d6fc14bSjoerg //
7*4d6fc14bSjoerg //===----------------------------------------------------------------------===//
8*4d6fc14bSjoerg 
9*4d6fc14bSjoerg #include "mutex"
10*4d6fc14bSjoerg #include "limits"
11*4d6fc14bSjoerg #include "system_error"
12*4d6fc14bSjoerg #include "include/atomic_support.h"
13*4d6fc14bSjoerg #include "__undef_macros"
14*4d6fc14bSjoerg 
15*4d6fc14bSjoerg #ifndef _LIBCPP_HAS_NO_THREADS
16*4d6fc14bSjoerg #if defined(__ELF__) && defined(_LIBCPP_LINK_PTHREAD_LIB)
17*4d6fc14bSjoerg #pragma comment(lib, "pthread")
18*4d6fc14bSjoerg #endif
19*4d6fc14bSjoerg #endif
20*4d6fc14bSjoerg 
21*4d6fc14bSjoerg _LIBCPP_BEGIN_NAMESPACE_STD
22*4d6fc14bSjoerg #ifndef _LIBCPP_HAS_NO_THREADS
23*4d6fc14bSjoerg 
24*4d6fc14bSjoerg const defer_lock_t  defer_lock{};
25*4d6fc14bSjoerg const try_to_lock_t try_to_lock{};
26*4d6fc14bSjoerg const adopt_lock_t  adopt_lock{};
27*4d6fc14bSjoerg 
28*4d6fc14bSjoerg // ~mutex is defined elsewhere
29*4d6fc14bSjoerg 
30*4d6fc14bSjoerg void
lock()31*4d6fc14bSjoerg mutex::lock()
32*4d6fc14bSjoerg {
33*4d6fc14bSjoerg     int ec = __libcpp_mutex_lock(&__m_);
34*4d6fc14bSjoerg     if (ec)
35*4d6fc14bSjoerg         __throw_system_error(ec, "mutex lock failed");
36*4d6fc14bSjoerg }
37*4d6fc14bSjoerg 
38*4d6fc14bSjoerg bool
try_lock()39*4d6fc14bSjoerg mutex::try_lock() noexcept
40*4d6fc14bSjoerg {
41*4d6fc14bSjoerg     return __libcpp_mutex_trylock(&__m_);
42*4d6fc14bSjoerg }
43*4d6fc14bSjoerg 
44*4d6fc14bSjoerg void
unlock()45*4d6fc14bSjoerg mutex::unlock() noexcept
46*4d6fc14bSjoerg {
47*4d6fc14bSjoerg     int ec = __libcpp_mutex_unlock(&__m_);
48*4d6fc14bSjoerg     (void)ec;
49*4d6fc14bSjoerg     _LIBCPP_ASSERT(ec == 0, "call to mutex::unlock failed");
50*4d6fc14bSjoerg }
51*4d6fc14bSjoerg 
52*4d6fc14bSjoerg // recursive_mutex
53*4d6fc14bSjoerg 
recursive_mutex()54*4d6fc14bSjoerg recursive_mutex::recursive_mutex()
55*4d6fc14bSjoerg {
56*4d6fc14bSjoerg     int ec = __libcpp_recursive_mutex_init(&__m_);
57*4d6fc14bSjoerg     if (ec)
58*4d6fc14bSjoerg         __throw_system_error(ec, "recursive_mutex constructor failed");
59*4d6fc14bSjoerg }
60*4d6fc14bSjoerg 
~recursive_mutex()61*4d6fc14bSjoerg recursive_mutex::~recursive_mutex()
62*4d6fc14bSjoerg {
63*4d6fc14bSjoerg     int e = __libcpp_recursive_mutex_destroy(&__m_);
64*4d6fc14bSjoerg     (void)e;
65*4d6fc14bSjoerg     _LIBCPP_ASSERT(e == 0, "call to ~recursive_mutex() failed");
66*4d6fc14bSjoerg }
67*4d6fc14bSjoerg 
68*4d6fc14bSjoerg void
lock()69*4d6fc14bSjoerg recursive_mutex::lock()
70*4d6fc14bSjoerg {
71*4d6fc14bSjoerg     int ec = __libcpp_recursive_mutex_lock(&__m_);
72*4d6fc14bSjoerg     if (ec)
73*4d6fc14bSjoerg         __throw_system_error(ec, "recursive_mutex lock failed");
74*4d6fc14bSjoerg }
75*4d6fc14bSjoerg 
76*4d6fc14bSjoerg void
unlock()77*4d6fc14bSjoerg recursive_mutex::unlock() noexcept
78*4d6fc14bSjoerg {
79*4d6fc14bSjoerg     int e = __libcpp_recursive_mutex_unlock(&__m_);
80*4d6fc14bSjoerg     (void)e;
81*4d6fc14bSjoerg     _LIBCPP_ASSERT(e == 0, "call to recursive_mutex::unlock() failed");
82*4d6fc14bSjoerg }
83*4d6fc14bSjoerg 
84*4d6fc14bSjoerg bool
try_lock()85*4d6fc14bSjoerg recursive_mutex::try_lock() noexcept
86*4d6fc14bSjoerg {
87*4d6fc14bSjoerg     return __libcpp_recursive_mutex_trylock(&__m_);
88*4d6fc14bSjoerg }
89*4d6fc14bSjoerg 
90*4d6fc14bSjoerg // timed_mutex
91*4d6fc14bSjoerg 
timed_mutex()92*4d6fc14bSjoerg timed_mutex::timed_mutex()
93*4d6fc14bSjoerg     : __locked_(false)
94*4d6fc14bSjoerg {
95*4d6fc14bSjoerg }
96*4d6fc14bSjoerg 
~timed_mutex()97*4d6fc14bSjoerg timed_mutex::~timed_mutex()
98*4d6fc14bSjoerg {
99*4d6fc14bSjoerg     lock_guard<mutex> _(__m_);
100*4d6fc14bSjoerg }
101*4d6fc14bSjoerg 
102*4d6fc14bSjoerg void
lock()103*4d6fc14bSjoerg timed_mutex::lock()
104*4d6fc14bSjoerg {
105*4d6fc14bSjoerg     unique_lock<mutex> lk(__m_);
106*4d6fc14bSjoerg     while (__locked_)
107*4d6fc14bSjoerg         __cv_.wait(lk);
108*4d6fc14bSjoerg     __locked_ = true;
109*4d6fc14bSjoerg }
110*4d6fc14bSjoerg 
111*4d6fc14bSjoerg bool
try_lock()112*4d6fc14bSjoerg timed_mutex::try_lock() noexcept
113*4d6fc14bSjoerg {
114*4d6fc14bSjoerg     unique_lock<mutex> lk(__m_, try_to_lock);
115*4d6fc14bSjoerg     if (lk.owns_lock() && !__locked_)
116*4d6fc14bSjoerg     {
117*4d6fc14bSjoerg         __locked_ = true;
118*4d6fc14bSjoerg         return true;
119*4d6fc14bSjoerg     }
120*4d6fc14bSjoerg     return false;
121*4d6fc14bSjoerg }
122*4d6fc14bSjoerg 
123*4d6fc14bSjoerg void
unlock()124*4d6fc14bSjoerg timed_mutex::unlock() noexcept
125*4d6fc14bSjoerg {
126*4d6fc14bSjoerg     lock_guard<mutex> _(__m_);
127*4d6fc14bSjoerg     __locked_ = false;
128*4d6fc14bSjoerg     __cv_.notify_one();
129*4d6fc14bSjoerg }
130*4d6fc14bSjoerg 
131*4d6fc14bSjoerg // recursive_timed_mutex
132*4d6fc14bSjoerg 
recursive_timed_mutex()133*4d6fc14bSjoerg recursive_timed_mutex::recursive_timed_mutex()
134*4d6fc14bSjoerg     : __count_(0),
135*4d6fc14bSjoerg       __id_{}
136*4d6fc14bSjoerg {
137*4d6fc14bSjoerg }
138*4d6fc14bSjoerg 
~recursive_timed_mutex()139*4d6fc14bSjoerg recursive_timed_mutex::~recursive_timed_mutex()
140*4d6fc14bSjoerg {
141*4d6fc14bSjoerg     lock_guard<mutex> _(__m_);
142*4d6fc14bSjoerg }
143*4d6fc14bSjoerg 
144*4d6fc14bSjoerg void
lock()145*4d6fc14bSjoerg recursive_timed_mutex::lock()
146*4d6fc14bSjoerg {
147*4d6fc14bSjoerg     __thread_id id = this_thread::get_id();
148*4d6fc14bSjoerg     unique_lock<mutex> lk(__m_);
149*4d6fc14bSjoerg     if (id ==__id_)
150*4d6fc14bSjoerg     {
151*4d6fc14bSjoerg         if (__count_ == numeric_limits<size_t>::max())
152*4d6fc14bSjoerg             __throw_system_error(EAGAIN, "recursive_timed_mutex lock limit reached");
153*4d6fc14bSjoerg         ++__count_;
154*4d6fc14bSjoerg         return;
155*4d6fc14bSjoerg     }
156*4d6fc14bSjoerg     while (__count_ != 0)
157*4d6fc14bSjoerg         __cv_.wait(lk);
158*4d6fc14bSjoerg     __count_ = 1;
159*4d6fc14bSjoerg     __id_ = id;
160*4d6fc14bSjoerg }
161*4d6fc14bSjoerg 
162*4d6fc14bSjoerg bool
try_lock()163*4d6fc14bSjoerg recursive_timed_mutex::try_lock() noexcept
164*4d6fc14bSjoerg {
165*4d6fc14bSjoerg     __thread_id id = this_thread::get_id();
166*4d6fc14bSjoerg     unique_lock<mutex> lk(__m_, try_to_lock);
167*4d6fc14bSjoerg     if (lk.owns_lock() && (__count_ == 0 || id == __id_))
168*4d6fc14bSjoerg     {
169*4d6fc14bSjoerg         if (__count_ == numeric_limits<size_t>::max())
170*4d6fc14bSjoerg             return false;
171*4d6fc14bSjoerg         ++__count_;
172*4d6fc14bSjoerg         __id_ = id;
173*4d6fc14bSjoerg         return true;
174*4d6fc14bSjoerg     }
175*4d6fc14bSjoerg     return false;
176*4d6fc14bSjoerg }
177*4d6fc14bSjoerg 
178*4d6fc14bSjoerg void
unlock()179*4d6fc14bSjoerg recursive_timed_mutex::unlock() noexcept
180*4d6fc14bSjoerg {
181*4d6fc14bSjoerg     unique_lock<mutex> lk(__m_);
182*4d6fc14bSjoerg     if (--__count_ == 0)
183*4d6fc14bSjoerg     {
184*4d6fc14bSjoerg         __id_.__reset();
185*4d6fc14bSjoerg         lk.unlock();
186*4d6fc14bSjoerg         __cv_.notify_one();
187*4d6fc14bSjoerg     }
188*4d6fc14bSjoerg }
189*4d6fc14bSjoerg 
190*4d6fc14bSjoerg #endif // !_LIBCPP_HAS_NO_THREADS
191*4d6fc14bSjoerg 
192*4d6fc14bSjoerg // If dispatch_once_f ever handles C++ exceptions, and if one can get to it
193*4d6fc14bSjoerg // without illegal macros (unexpected macros not beginning with _UpperCase or
194*4d6fc14bSjoerg // __lowercase), and if it stops spinning waiting threads, then call_once should
195*4d6fc14bSjoerg // call into dispatch_once_f instead of here. Relevant radar this code needs to
196*4d6fc14bSjoerg // keep in sync with:  7741191.
197*4d6fc14bSjoerg 
198*4d6fc14bSjoerg #ifndef _LIBCPP_HAS_NO_THREADS
199*4d6fc14bSjoerg _LIBCPP_SAFE_STATIC static __libcpp_mutex_t mut = _LIBCPP_MUTEX_INITIALIZER;
200*4d6fc14bSjoerg _LIBCPP_SAFE_STATIC static __libcpp_condvar_t cv = _LIBCPP_CONDVAR_INITIALIZER;
201*4d6fc14bSjoerg #endif
202*4d6fc14bSjoerg 
__call_once(volatile once_flag::_State_type & flag,void * arg,void (* func)(void *))203*4d6fc14bSjoerg void __call_once(volatile once_flag::_State_type& flag, void* arg,
204*4d6fc14bSjoerg                  void (*func)(void*))
205*4d6fc14bSjoerg {
206*4d6fc14bSjoerg #if defined(_LIBCPP_HAS_NO_THREADS)
207*4d6fc14bSjoerg     if (flag == 0)
208*4d6fc14bSjoerg     {
209*4d6fc14bSjoerg #ifndef _LIBCPP_NO_EXCEPTIONS
210*4d6fc14bSjoerg         try
211*4d6fc14bSjoerg         {
212*4d6fc14bSjoerg #endif // _LIBCPP_NO_EXCEPTIONS
213*4d6fc14bSjoerg             flag = 1;
214*4d6fc14bSjoerg             func(arg);
215*4d6fc14bSjoerg             flag = ~once_flag::_State_type(0);
216*4d6fc14bSjoerg #ifndef _LIBCPP_NO_EXCEPTIONS
217*4d6fc14bSjoerg         }
218*4d6fc14bSjoerg         catch (...)
219*4d6fc14bSjoerg         {
220*4d6fc14bSjoerg             flag = 0;
221*4d6fc14bSjoerg             throw;
222*4d6fc14bSjoerg         }
223*4d6fc14bSjoerg #endif // _LIBCPP_NO_EXCEPTIONS
224*4d6fc14bSjoerg     }
225*4d6fc14bSjoerg #else // !_LIBCPP_HAS_NO_THREADS
226*4d6fc14bSjoerg     __libcpp_mutex_lock(&mut);
227*4d6fc14bSjoerg     while (flag == 1)
228*4d6fc14bSjoerg         __libcpp_condvar_wait(&cv, &mut);
229*4d6fc14bSjoerg     if (flag == 0)
230*4d6fc14bSjoerg     {
231*4d6fc14bSjoerg #ifndef _LIBCPP_NO_EXCEPTIONS
232*4d6fc14bSjoerg         try
233*4d6fc14bSjoerg         {
234*4d6fc14bSjoerg #endif // _LIBCPP_NO_EXCEPTIONS
235*4d6fc14bSjoerg             __libcpp_relaxed_store(&flag, once_flag::_State_type(1));
236*4d6fc14bSjoerg             __libcpp_mutex_unlock(&mut);
237*4d6fc14bSjoerg             func(arg);
238*4d6fc14bSjoerg             __libcpp_mutex_lock(&mut);
239*4d6fc14bSjoerg             __libcpp_atomic_store(&flag, ~once_flag::_State_type(0),
240*4d6fc14bSjoerg                                   _AO_Release);
241*4d6fc14bSjoerg             __libcpp_mutex_unlock(&mut);
242*4d6fc14bSjoerg             __libcpp_condvar_broadcast(&cv);
243*4d6fc14bSjoerg #ifndef _LIBCPP_NO_EXCEPTIONS
244*4d6fc14bSjoerg         }
245*4d6fc14bSjoerg         catch (...)
246*4d6fc14bSjoerg         {
247*4d6fc14bSjoerg             __libcpp_mutex_lock(&mut);
248*4d6fc14bSjoerg             __libcpp_relaxed_store(&flag, once_flag::_State_type(0));
249*4d6fc14bSjoerg             __libcpp_mutex_unlock(&mut);
250*4d6fc14bSjoerg             __libcpp_condvar_broadcast(&cv);
251*4d6fc14bSjoerg             throw;
252*4d6fc14bSjoerg         }
253*4d6fc14bSjoerg #endif // _LIBCPP_NO_EXCEPTIONS
254*4d6fc14bSjoerg     }
255*4d6fc14bSjoerg     else
256*4d6fc14bSjoerg         __libcpp_mutex_unlock(&mut);
257*4d6fc14bSjoerg #endif // !_LIBCPP_HAS_NO_THREADS
258*4d6fc14bSjoerg }
259*4d6fc14bSjoerg 
260*4d6fc14bSjoerg _LIBCPP_END_NAMESPACE_STD
261