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> // Variadic lock_guard only provided in ABI V2.
116 explicit lock_guard(MutexTypes&... m);
117 lock_guard(MutexTypes&... m, adopt_lock_t);
119 lock_guard(lock_guard const&) = delete;
120 lock_guard& operator=(lock_guard const&) = delete;
122 tuple<MutexTypes&...> pm; // exposition only
125 template <class Mutex>
129 typedef Mutex mutex_type;
130 unique_lock() noexcept;
131 explicit unique_lock(mutex_type& m);
132 unique_lock(mutex_type& m, defer_lock_t) noexcept;
133 unique_lock(mutex_type& m, try_to_lock_t);
134 unique_lock(mutex_type& m, adopt_lock_t);
135 template <class Clock, class Duration>
136 unique_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);
137 template <class Rep, class Period>
138 unique_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time);
141 unique_lock(unique_lock const&) = delete;
142 unique_lock& operator=(unique_lock const&) = delete;
144 unique_lock(unique_lock&& u) noexcept;
145 unique_lock& operator=(unique_lock&& u) noexcept;
150 template <class Rep, class Period>
151 bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
152 template <class Clock, class Duration>
153 bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
157 void swap(unique_lock& u) noexcept;
158 mutex_type* release() noexcept;
160 bool owns_lock() const noexcept;
161 explicit operator bool () const noexcept;
162 mutex_type* mutex() const noexcept;
165 template <class Mutex>
166 void swap(unique_lock<Mutex>& x, unique_lock<Mutex>& y) noexcept;
168 template <class L1, class L2, class... L3>
169 int try_lock(L1&, L2&, L3&...);
170 template <class L1, class L2, class... L3>
171 void lock(L1&, L2&, L3&...);
175 constexpr once_flag() noexcept;
177 once_flag(const once_flag&) = delete;
178 once_flag& operator=(const once_flag&) = delete;
181 template<class Callable, class ...Args>
182 void call_once(once_flag& flag, Callable&& func, Args&&... args);
189 #include <__mutex_base>
190 #include <functional>
192 #ifndef _LIBCPP_HAS_NO_VARIADICS
195 #include <__threading_support>
197 #include <__undef_min_max>
199 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
200 #pragma GCC system_header
203 _LIBCPP_BEGIN_NAMESPACE_STD
205 #ifndef _LIBCPP_HAS_NO_THREADS
207 class _LIBCPP_TYPE_VIS recursive_mutex
209 __libcpp_mutex_t __m_;
216 recursive_mutex(const recursive_mutex&); // = delete;
217 recursive_mutex& operator=(const recursive_mutex&); // = delete;
221 bool try_lock() _NOEXCEPT;
222 void unlock() _NOEXCEPT;
224 typedef __libcpp_mutex_t* native_handle_type;
225 _LIBCPP_INLINE_VISIBILITY
226 native_handle_type native_handle() {return &__m_;}
229 class _LIBCPP_TYPE_VIS timed_mutex
232 condition_variable __cv_;
239 timed_mutex(const timed_mutex&); // = delete;
240 timed_mutex& operator=(const timed_mutex&); // = delete;
244 bool try_lock() _NOEXCEPT;
245 template <class _Rep, class _Period>
246 _LIBCPP_INLINE_VISIBILITY
247 bool try_lock_for(const chrono::duration<_Rep, _Period>& __d)
248 {return try_lock_until(chrono::steady_clock::now() + __d);}
249 template <class _Clock, class _Duration>
250 bool try_lock_until(const chrono::time_point<_Clock, _Duration>& __t);
251 void unlock() _NOEXCEPT;
254 template <class _Clock, class _Duration>
256 timed_mutex::try_lock_until(const chrono::time_point<_Clock, _Duration>& __t)
258 using namespace chrono;
259 unique_lock<mutex> __lk(__m_);
260 bool no_timeout = _Clock::now() < __t;
261 while (no_timeout && __locked_)
262 no_timeout = __cv_.wait_until(__lk, __t) == cv_status::no_timeout;
271 class _LIBCPP_TYPE_VIS recursive_timed_mutex
274 condition_variable __cv_;
276 __libcpp_thread_id __id_;
278 recursive_timed_mutex();
279 ~recursive_timed_mutex();
282 recursive_timed_mutex(const recursive_timed_mutex&); // = delete;
283 recursive_timed_mutex& operator=(const recursive_timed_mutex&); // = delete;
287 bool try_lock() _NOEXCEPT;
288 template <class _Rep, class _Period>
289 _LIBCPP_INLINE_VISIBILITY
290 bool try_lock_for(const chrono::duration<_Rep, _Period>& __d)
291 {return try_lock_until(chrono::steady_clock::now() + __d);}
292 template <class _Clock, class _Duration>
293 bool try_lock_until(const chrono::time_point<_Clock, _Duration>& __t);
294 void unlock() _NOEXCEPT;
297 template <class _Clock, class _Duration>
299 recursive_timed_mutex::try_lock_until(const chrono::time_point<_Clock, _Duration>& __t)
301 using namespace chrono;
302 __libcpp_thread_id __id = __libcpp_thread_get_current_id();
303 unique_lock<mutex> lk(__m_);
304 if (__libcpp_thread_id_equal(__id, __id_))
306 if (__count_ == numeric_limits<size_t>::max())
311 bool no_timeout = _Clock::now() < __t;
312 while (no_timeout && __count_ != 0)
313 no_timeout = __cv_.wait_until(lk, __t) == cv_status::no_timeout;
323 template <class _L0, class _L1>
325 try_lock(_L0& __l0, _L1& __l1)
327 unique_lock<_L0> __u0(__l0, try_to_lock);
328 if (__u0.owns_lock())
341 #ifndef _LIBCPP_HAS_NO_VARIADICS
343 template <class _L0, class _L1, class _L2, class... _L3>
345 try_lock(_L0& __l0, _L1& __l1, _L2& __l2, _L3&... __l3)
348 unique_lock<_L0> __u0(__l0, try_to_lock);
349 if (__u0.owns_lock())
351 __r = try_lock(__l1, __l2, __l3...);
360 #endif // _LIBCPP_HAS_NO_VARIADICS
362 template <class _L0, class _L1>
364 lock(_L0& __l0, _L1& __l1)
369 unique_lock<_L0> __u0(__l0);
376 __libcpp_thread_yield();
378 unique_lock<_L1> __u1(__l1);
385 __libcpp_thread_yield();
389 #ifndef _LIBCPP_HAS_NO_VARIADICS
391 template <class _L0, class _L1, class _L2, class ..._L3>
393 __lock_first(int __i, _L0& __l0, _L1& __l1, _L2& __l2, _L3& ...__l3)
401 unique_lock<_L0> __u0(__l0);
402 __i = try_lock(__l1, __l2, __l3...);
410 __libcpp_thread_yield();
414 unique_lock<_L1> __u1(__l1);
415 __i = try_lock(__l2, __l3..., __l0);
422 if (__i == sizeof...(_L3) + 1)
426 __libcpp_thread_yield();
429 __lock_first(__i - 2, __l2, __l3..., __l0, __l1);
435 template <class _L0, class _L1, class _L2, class ..._L3>
436 inline _LIBCPP_INLINE_VISIBILITY
438 lock(_L0& __l0, _L1& __l1, _L2& __l2, _L3& ...__l3)
440 __lock_first(0, __l0, __l1, __l2, __l3...);
444 inline _LIBCPP_INLINE_VISIBILITY
445 void __unlock(_L0& __l0) {
449 template <class _L0, class _L1>
450 inline _LIBCPP_INLINE_VISIBILITY
451 void __unlock(_L0& __l0, _L1& __l1) {
456 template <class _L0, class _L1, class _L2, class ..._L3>
457 inline _LIBCPP_INLINE_VISIBILITY
458 void __unlock(_L0& __l0, _L1& __l1, _L2& __l2, _L3&... __l3) {
461 _VSTD::__unlock(__l2, __l3...);
464 #endif // _LIBCPP_HAS_NO_VARIADICS
466 #endif // !_LIBCPP_HAS_NO_THREADS
468 struct _LIBCPP_TYPE_VIS_ONLY once_flag;
470 #ifndef _LIBCPP_HAS_NO_VARIADICS
472 template<class _Callable, class... _Args>
473 _LIBCPP_INLINE_VISIBILITY
474 void call_once(once_flag&, _Callable&&, _Args&&...);
476 #else // _LIBCPP_HAS_NO_VARIADICS
478 template<class _Callable>
479 _LIBCPP_INLINE_VISIBILITY
480 void call_once(once_flag&, _Callable&);
482 template<class _Callable>
483 _LIBCPP_INLINE_VISIBILITY
484 void call_once(once_flag&, const _Callable&);
486 #endif // _LIBCPP_HAS_NO_VARIADICS
488 struct _LIBCPP_TYPE_VIS_ONLY once_flag
490 _LIBCPP_INLINE_VISIBILITY
492 once_flag() _NOEXCEPT : __state_(0) {}
495 once_flag(const once_flag&); // = delete;
496 once_flag& operator=(const once_flag&); // = delete;
498 unsigned long __state_;
500 #ifndef _LIBCPP_HAS_NO_VARIADICS
501 template<class _Callable, class... _Args>
503 void call_once(once_flag&, _Callable&&, _Args&&...);
504 #else // _LIBCPP_HAS_NO_VARIADICS
505 template<class _Callable>
507 void call_once(once_flag&, _Callable&);
509 template<class _Callable>
511 void call_once(once_flag&, const _Callable&);
512 #endif // _LIBCPP_HAS_NO_VARIADICS
515 #ifndef _LIBCPP_HAS_NO_VARIADICS
518 class __call_once_param
522 _LIBCPP_INLINE_VISIBILITY
523 explicit __call_once_param(_Fp& __f) : __f_(__f) {}
525 _LIBCPP_INLINE_VISIBILITY
528 typedef typename __make_tuple_indices<tuple_size<_Fp>::value, 1>::type _Index;
533 template <size_t ..._Indices>
534 _LIBCPP_INLINE_VISIBILITY
535 void __execute(__tuple_indices<_Indices...>)
537 __invoke(_VSTD::get<0>(_VSTD::move(__f_)), _VSTD::get<_Indices>(_VSTD::move(__f_))...);
544 class __call_once_param
548 _LIBCPP_INLINE_VISIBILITY
549 explicit __call_once_param(_Fp& __f) : __f_(__f) {}
551 _LIBCPP_INLINE_VISIBILITY
562 __call_once_proxy(void* __vp)
564 __call_once_param<_Fp>* __p = static_cast<__call_once_param<_Fp>*>(__vp);
568 _LIBCPP_FUNC_VIS void __call_once(volatile unsigned long&, void*, void(*)(void*));
570 #ifndef _LIBCPP_HAS_NO_VARIADICS
572 template<class _Callable, class... _Args>
573 inline _LIBCPP_INLINE_VISIBILITY
575 call_once(once_flag& __flag, _Callable&& __func, _Args&&... __args)
577 if (__libcpp_relaxed_load(&__flag.__state_) != ~0ul)
579 typedef tuple<_Callable&&, _Args&&...> _Gp;
580 _Gp __f(_VSTD::forward<_Callable>(__func), _VSTD::forward<_Args>(__args)...);
581 __call_once_param<_Gp> __p(__f);
582 __call_once(__flag.__state_, &__p, &__call_once_proxy<_Gp>);
586 #else // _LIBCPP_HAS_NO_VARIADICS
588 template<class _Callable>
589 inline _LIBCPP_INLINE_VISIBILITY
591 call_once(once_flag& __flag, _Callable& __func)
593 if (__libcpp_relaxed_load(&__flag.__state_) != ~0ul)
595 __call_once_param<_Callable> __p(__func);
596 __call_once(__flag.__state_, &__p, &__call_once_proxy<_Callable>);
600 template<class _Callable>
601 inline _LIBCPP_INLINE_VISIBILITY
603 call_once(once_flag& __flag, const _Callable& __func)
605 if (__flag.__state_ != ~0ul)
607 __call_once_param<const _Callable> __p(__func);
608 __call_once(__flag.__state_, &__p, &__call_once_proxy<const _Callable>);
612 #endif // _LIBCPP_HAS_NO_VARIADICS
615 #if defined(_LIBCPP_ABI_VARIADIC_LOCK_GUARD) \
616 && !defined(_LIBCPP_CXX03_LANG)
618 class _LIBCPP_TYPE_VIS_ONLY lock_guard<> {
620 explicit lock_guard() {}
621 ~lock_guard() = default;
623 _LIBCPP_INLINE_VISIBILITY
624 explicit lock_guard(adopt_lock_t) {}
626 lock_guard(lock_guard const&) = delete;
627 lock_guard& operator=(lock_guard const&) = delete;
630 template <class ..._MArgs>
631 class _LIBCPP_TYPE_VIS_ONLY lock_guard
633 static_assert(sizeof...(_MArgs) >= 2, "At least 2 lock types required");
634 typedef tuple<_MArgs&...> _MutexTuple;
637 _LIBCPP_INLINE_VISIBILITY
638 explicit lock_guard(_MArgs&... __margs)
641 _VSTD::lock(__margs...);
644 _LIBCPP_INLINE_VISIBILITY
645 lock_guard(_MArgs&... __margs, adopt_lock_t)
650 _LIBCPP_INLINE_VISIBILITY
652 typedef typename __make_tuple_indices<sizeof...(_MArgs)>::type _Indices;
653 __unlock_unpack(_Indices{}, __t_);
656 lock_guard(lock_guard const&) = delete;
657 lock_guard& operator=(lock_guard const&) = delete;
660 template <size_t ..._Indx>
661 _LIBCPP_INLINE_VISIBILITY
662 static void __unlock_unpack(__tuple_indices<_Indx...>, _MutexTuple& __mt) {
663 _VSTD::__unlock(_VSTD::get<_Indx>(__mt)...);
669 #endif // _LIBCPP_ABI_VARIADIC_LOCK_GUARD
671 _LIBCPP_END_NAMESPACE_STD
673 #endif // _LIBCPP_MUTEX