2 //===--------------------------- mutex ------------------------------------===//
4 // The LLVM Compiler Infrastructure
6 // This file is dual licensed under the MIT and the University of Illinois Open
7 // Source Licenses. See LICENSE.TXT for details.
9 //===----------------------------------------------------------------------===//
23 constexpr mutex() noexcept;
26 mutex(const mutex&) = delete;
27 mutex& operator=(const mutex&) = delete;
33 typedef pthread_mutex_t* native_handle_type;
34 native_handle_type native_handle();
43 recursive_mutex(const recursive_mutex&) = delete;
44 recursive_mutex& operator=(const recursive_mutex&) = delete;
47 bool try_lock() noexcept;
50 typedef pthread_mutex_t* native_handle_type;
51 native_handle_type native_handle();
60 timed_mutex(const timed_mutex&) = delete;
61 timed_mutex& operator=(const timed_mutex&) = delete;
65 template <class Rep, class Period>
66 bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
67 template <class Clock, class Duration>
68 bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
72 class recursive_timed_mutex
75 recursive_timed_mutex();
76 ~recursive_timed_mutex();
78 recursive_timed_mutex(const recursive_timed_mutex&) = delete;
79 recursive_timed_mutex& operator=(const recursive_timed_mutex&) = delete;
82 bool try_lock() noexcept;
83 template <class Rep, class Period>
84 bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
85 template <class Clock, class Duration>
86 bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
90 struct defer_lock_t {};
91 struct try_to_lock_t {};
92 struct adopt_lock_t {};
94 constexpr defer_lock_t defer_lock{};
95 constexpr try_to_lock_t try_to_lock{};
96 constexpr adopt_lock_t adopt_lock{};
98 template <class Mutex>
102 typedef Mutex mutex_type;
104 explicit lock_guard(mutex_type& m);
105 lock_guard(mutex_type& m, adopt_lock_t);
108 lock_guard(lock_guard const&) = delete;
109 lock_guard& operator=(lock_guard const&) = delete;
112 template <class... MutexTypes>
113 class scoped_lock // C++17
116 using mutex_type = Mutex; // If MutexTypes... consists of the single type Mutex
118 explicit scoped_lock(MutexTypes&... m);
119 scoped_lock(MutexTypes&... m, adopt_lock_t);
121 scoped_lock(scoped_lock const&) = delete;
122 scoped_lock& operator=(scoped_lock const&) = delete;
124 tuple<MutexTypes&...> pm; // exposition only
127 template <class Mutex>
131 typedef Mutex mutex_type;
132 unique_lock() noexcept;
133 explicit unique_lock(mutex_type& m);
134 unique_lock(mutex_type& m, defer_lock_t) noexcept;
135 unique_lock(mutex_type& m, try_to_lock_t);
136 unique_lock(mutex_type& m, adopt_lock_t);
137 template <class Clock, class Duration>
138 unique_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
139 template <class Rep, class Period>
140 unique_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
143 unique_lock(unique_lock const&) = delete;
144 unique_lock& operator=(unique_lock const&) = delete;
146 unique_lock(unique_lock&& u) noexcept;
147 unique_lock& operator=(unique_lock&& u) noexcept;
152 template <class Rep, class Period>
153 bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
154 template <class Clock, class Duration>
155 bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
159 void swap(unique_lock& u) noexcept;
160 mutex_type* release() noexcept;
162 bool owns_lock() const noexcept;
163 explicit operator bool () const noexcept;
164 mutex_type* mutex() const noexcept;
167 template <class Mutex>
168 void swap(unique_lock<Mutex>& x, unique_lock<Mutex>& y) noexcept;
170 template <class L1, class L2, class... L3>
171 int try_lock(L1&, L2&, L3&...);
172 template <class L1, class L2, class... L3>
173 void lock(L1&, L2&, L3&...);
177 constexpr once_flag() noexcept;
179 once_flag(const once_flag&) = delete;
180 once_flag& operator=(const once_flag&) = delete;
183 template<class Callable, class ...Args>
184 void call_once(once_flag& flag, Callable&& func, Args&&... args);
191 #include <__mutex_base>
192 #include <functional>
194 #ifndef _LIBCPP_CXX03_LANG
197 #include <__threading_support>
199 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
200 #pragma GCC system_header
204 #include <__undef_macros>
207 _LIBCPP_BEGIN_NAMESPACE_STD
209 #ifndef _LIBCPP_HAS_NO_THREADS
211 class _LIBCPP_TYPE_VIS recursive_mutex
213 __libcpp_recursive_mutex_t __m_;
220 recursive_mutex(const recursive_mutex&); // = delete;
221 recursive_mutex& operator=(const recursive_mutex&); // = delete;
225 bool try_lock() _NOEXCEPT;
226 void unlock() _NOEXCEPT;
228 typedef __libcpp_recursive_mutex_t* native_handle_type;
230 _LIBCPP_INLINE_VISIBILITY
231 native_handle_type native_handle() {return &__m_;}
234 class _LIBCPP_TYPE_VIS timed_mutex
237 condition_variable __cv_;
244 timed_mutex(const timed_mutex&); // = delete;
245 timed_mutex& operator=(const timed_mutex&); // = delete;
249 bool try_lock() _NOEXCEPT;
250 template <class _Rep, class _Period>
251 _LIBCPP_INLINE_VISIBILITY
252 bool try_lock_for(const chrono::duration<_Rep, _Period>& __d)
253 {return try_lock_until(chrono::steady_clock::now() + __d);}
254 template <class _Clock, class _Duration>
255 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
256 bool try_lock_until(const chrono::time_point<_Clock, _Duration>& __t);
257 void unlock() _NOEXCEPT;
260 template <class _Clock, class _Duration>
262 timed_mutex::try_lock_until(const chrono::time_point<_Clock, _Duration>& __t)
264 using namespace chrono;
265 unique_lock<mutex> __lk(__m_);
266 bool no_timeout = _Clock::now() < __t;
267 while (no_timeout && __locked_)
268 no_timeout = __cv_.wait_until(__lk, __t) == cv_status::no_timeout;
277 class _LIBCPP_TYPE_VIS recursive_timed_mutex
280 condition_variable __cv_;
282 __libcpp_thread_id __id_;
284 recursive_timed_mutex();
285 ~recursive_timed_mutex();
288 recursive_timed_mutex(const recursive_timed_mutex&); // = delete;
289 recursive_timed_mutex& operator=(const recursive_timed_mutex&); // = delete;
293 bool try_lock() _NOEXCEPT;
294 template <class _Rep, class _Period>
295 _LIBCPP_INLINE_VISIBILITY
296 bool try_lock_for(const chrono::duration<_Rep, _Period>& __d)
297 {return try_lock_until(chrono::steady_clock::now() + __d);}
298 template <class _Clock, class _Duration>
299 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
300 bool try_lock_until(const chrono::time_point<_Clock, _Duration>& __t);
301 void unlock() _NOEXCEPT;
304 template <class _Clock, class _Duration>
306 recursive_timed_mutex::try_lock_until(const chrono::time_point<_Clock, _Duration>& __t)
308 using namespace chrono;
309 __libcpp_thread_id __id = __libcpp_thread_get_current_id();
310 unique_lock<mutex> lk(__m_);
311 if (__libcpp_thread_id_equal(__id, __id_))
313 if (__count_ == numeric_limits<size_t>::max())
318 bool no_timeout = _Clock::now() < __t;
319 while (no_timeout && __count_ != 0)
320 no_timeout = __cv_.wait_until(lk, __t) == cv_status::no_timeout;
330 template <class _L0, class _L1>
332 try_lock(_L0& __l0, _L1& __l1)
334 unique_lock<_L0> __u0(__l0, try_to_lock);
335 if (__u0.owns_lock())
348 #ifndef _LIBCPP_CXX03_LANG
350 template <class _L0, class _L1, class _L2, class... _L3>
352 try_lock(_L0& __l0, _L1& __l1, _L2& __l2, _L3&... __l3)
355 unique_lock<_L0> __u0(__l0, try_to_lock);
356 if (__u0.owns_lock())
358 __r = try_lock(__l1, __l2, __l3...);
367 #endif // _LIBCPP_CXX03_LANG
369 template <class _L0, class _L1>
371 lock(_L0& __l0, _L1& __l1)
376 unique_lock<_L0> __u0(__l0);
383 __libcpp_thread_yield();
385 unique_lock<_L1> __u1(__l1);
392 __libcpp_thread_yield();
396 #ifndef _LIBCPP_CXX03_LANG
398 template <class _L0, class _L1, class _L2, class ..._L3>
400 __lock_first(int __i, _L0& __l0, _L1& __l1, _L2& __l2, _L3& ...__l3)
408 unique_lock<_L0> __u0(__l0);
409 __i = try_lock(__l1, __l2, __l3...);
417 __libcpp_thread_yield();
421 unique_lock<_L1> __u1(__l1);
422 __i = try_lock(__l2, __l3..., __l0);
429 if (__i == sizeof...(_L3) + 1)
433 __libcpp_thread_yield();
436 __lock_first(__i - 2, __l2, __l3..., __l0, __l1);
442 template <class _L0, class _L1, class _L2, class ..._L3>
443 inline _LIBCPP_INLINE_VISIBILITY
445 lock(_L0& __l0, _L1& __l1, _L2& __l2, _L3& ...__l3)
447 __lock_first(0, __l0, __l1, __l2, __l3...);
451 inline _LIBCPP_INLINE_VISIBILITY
452 void __unlock(_L0& __l0) {
456 template <class _L0, class _L1>
457 inline _LIBCPP_INLINE_VISIBILITY
458 void __unlock(_L0& __l0, _L1& __l1) {
463 template <class _L0, class _L1, class _L2, class ..._L3>
464 inline _LIBCPP_INLINE_VISIBILITY
465 void __unlock(_L0& __l0, _L1& __l1, _L2& __l2, _L3&... __l3) {
468 _VSTD::__unlock(__l2, __l3...);
471 #endif // _LIBCPP_CXX03_LANG
473 #if _LIBCPP_STD_VER > 14
474 template <class ..._Mutexes>
475 class _LIBCPP_TEMPLATE_VIS scoped_lock;
478 class _LIBCPP_TEMPLATE_VIS scoped_lock<> {
480 explicit scoped_lock() {}
481 ~scoped_lock() = default;
483 _LIBCPP_INLINE_VISIBILITY
484 explicit scoped_lock(adopt_lock_t) {}
486 scoped_lock(scoped_lock const&) = delete;
487 scoped_lock& operator=(scoped_lock const&) = delete;
490 template <class _Mutex>
491 class _LIBCPP_TEMPLATE_VIS scoped_lock<_Mutex> {
493 typedef _Mutex mutex_type;
497 explicit scoped_lock(mutex_type & __m) _LIBCPP_THREAD_SAFETY_ANNOTATION(acquire_capability(__m))
498 : __m_(__m) {__m_.lock();}
500 ~scoped_lock() _LIBCPP_THREAD_SAFETY_ANNOTATION(release_capability()) {__m_.unlock();}
502 _LIBCPP_INLINE_VISIBILITY
503 explicit scoped_lock(mutex_type& __m, adopt_lock_t) _LIBCPP_THREAD_SAFETY_ANNOTATION(requires_capability(__m))
507 scoped_lock(scoped_lock const&) = delete;
508 scoped_lock& operator=(scoped_lock const&) = delete;
511 template <class ..._MArgs>
512 class _LIBCPP_TEMPLATE_VIS scoped_lock
514 static_assert(sizeof...(_MArgs) > 1, "At least 2 lock types required");
515 typedef tuple<_MArgs&...> _MutexTuple;
518 _LIBCPP_INLINE_VISIBILITY
519 explicit scoped_lock(_MArgs&... __margs)
522 _VSTD::lock(__margs...);
525 _LIBCPP_INLINE_VISIBILITY
526 scoped_lock(_MArgs&... __margs, adopt_lock_t)
531 _LIBCPP_INLINE_VISIBILITY
533 typedef typename __make_tuple_indices<sizeof...(_MArgs)>::type _Indices;
534 __unlock_unpack(_Indices{}, __t_);
537 scoped_lock(scoped_lock const&) = delete;
538 scoped_lock& operator=(scoped_lock const&) = delete;
541 template <size_t ..._Indx>
542 _LIBCPP_INLINE_VISIBILITY
543 static void __unlock_unpack(__tuple_indices<_Indx...>, _MutexTuple& __mt) {
544 _VSTD::__unlock(_VSTD::get<_Indx>(__mt)...);
550 #endif // _LIBCPP_STD_VER > 14
551 #endif // !_LIBCPP_HAS_NO_THREADS
553 struct _LIBCPP_TEMPLATE_VIS once_flag;
555 #ifndef _LIBCPP_CXX03_LANG
557 template<class _Callable, class... _Args>
558 _LIBCPP_INLINE_VISIBILITY
559 void call_once(once_flag&, _Callable&&, _Args&&...);
561 #else // _LIBCPP_CXX03_LANG
563 template<class _Callable>
564 _LIBCPP_INLINE_VISIBILITY
565 void call_once(once_flag&, _Callable&);
567 template<class _Callable>
568 _LIBCPP_INLINE_VISIBILITY
569 void call_once(once_flag&, const _Callable&);
571 #endif // _LIBCPP_CXX03_LANG
573 struct _LIBCPP_TEMPLATE_VIS once_flag
575 _LIBCPP_INLINE_VISIBILITY
577 once_flag() _NOEXCEPT : __state_(0) {}
580 once_flag(const once_flag&); // = delete;
581 once_flag& operator=(const once_flag&); // = delete;
583 unsigned long __state_;
585 #ifndef _LIBCPP_CXX03_LANG
586 template<class _Callable, class... _Args>
588 void call_once(once_flag&, _Callable&&, _Args&&...);
589 #else // _LIBCPP_CXX03_LANG
590 template<class _Callable>
592 void call_once(once_flag&, _Callable&);
594 template<class _Callable>
596 void call_once(once_flag&, const _Callable&);
597 #endif // _LIBCPP_CXX03_LANG
600 #ifndef _LIBCPP_CXX03_LANG
603 class __call_once_param
607 _LIBCPP_INLINE_VISIBILITY
608 explicit __call_once_param(_Fp& __f) : __f_(__f) {}
610 _LIBCPP_INLINE_VISIBILITY
613 typedef typename __make_tuple_indices<tuple_size<_Fp>::value, 1>::type _Index;
618 template <size_t ..._Indices>
619 _LIBCPP_INLINE_VISIBILITY
620 void __execute(__tuple_indices<_Indices...>)
622 __invoke(_VSTD::get<0>(_VSTD::move(__f_)), _VSTD::get<_Indices>(_VSTD::move(__f_))...);
629 class __call_once_param
633 _LIBCPP_INLINE_VISIBILITY
634 explicit __call_once_param(_Fp& __f) : __f_(__f) {}
636 _LIBCPP_INLINE_VISIBILITY
647 __call_once_proxy(void* __vp)
649 __call_once_param<_Fp>* __p = static_cast<__call_once_param<_Fp>*>(__vp);
653 _LIBCPP_FUNC_VIS void __call_once(volatile unsigned long&, void*, void(*)(void*));
655 #ifndef _LIBCPP_CXX03_LANG
657 template<class _Callable, class... _Args>
658 inline _LIBCPP_INLINE_VISIBILITY
660 call_once(once_flag& __flag, _Callable&& __func, _Args&&... __args)
662 if (__libcpp_acquire_load(&__flag.__state_) != ~0ul)
664 typedef tuple<_Callable&&, _Args&&...> _Gp;
665 _Gp __f(_VSTD::forward<_Callable>(__func), _VSTD::forward<_Args>(__args)...);
666 __call_once_param<_Gp> __p(__f);
667 __call_once(__flag.__state_, &__p, &__call_once_proxy<_Gp>);
671 #else // _LIBCPP_CXX03_LANG
673 template<class _Callable>
674 inline _LIBCPP_INLINE_VISIBILITY
676 call_once(once_flag& __flag, _Callable& __func)
678 if (__libcpp_acquire_load(&__flag.__state_) != ~0ul)
680 __call_once_param<_Callable> __p(__func);
681 __call_once(__flag.__state_, &__p, &__call_once_proxy<_Callable>);
685 template<class _Callable>
686 inline _LIBCPP_INLINE_VISIBILITY
688 call_once(once_flag& __flag, const _Callable& __func)
690 if (__libcpp_acquire_load(&__flag.__state_) != ~0ul)
692 __call_once_param<const _Callable> __p(__func);
693 __call_once(__flag.__state_, &__p, &__call_once_proxy<const _Callable>);
697 #endif // _LIBCPP_CXX03_LANG
699 _LIBCPP_END_NAMESPACE_STD
703 #endif // _LIBCPP_MUTEX