29#ifndef _GLIBCXX_SHARED_MUTEX
30#define _GLIBCXX_SHARED_MUTEX 1
32#pragma GCC system_header
36#if __cplusplus >= 201402L
44#define __glibcxx_want_shared_mutex
45#define __glibcxx_want_shared_timed_mutex
48#if ! (_GLIBCXX_USE_PTHREAD_RWLOCK_T && _GTHREAD_USE_MUTEX_TIMEDLOCK)
52namespace std _GLIBCXX_VISIBILITY(default)
54_GLIBCXX_BEGIN_NAMESPACE_VERSION
61#ifdef _GLIBCXX_HAS_GTHREADS
63#ifdef __cpp_lib_shared_mutex
67 class shared_timed_mutex;
71#if _GLIBCXX_USE_PTHREAD_RWLOCK_T
73#define _GLIBCXX_GTHRW(name) \
74 __gthrw(pthread_ ## name); \
76 __glibcxx_ ## name (pthread_rwlock_t *__rwlock) \
78 if (__gthread_active_p ()) \
79 return __gthrw_(pthread_ ## name) (__rwlock); \
83 _GLIBCXX_GTHRW(rwlock_rdlock)
84 _GLIBCXX_GTHRW(rwlock_tryrdlock)
85 _GLIBCXX_GTHRW(rwlock_wrlock)
86 _GLIBCXX_GTHRW(rwlock_trywrlock)
87 _GLIBCXX_GTHRW(rwlock_unlock)
88# ifndef PTHREAD_RWLOCK_INITIALIZER
89 _GLIBCXX_GTHRW(rwlock_destroy)
90 __gthrw(pthread_rwlock_init);
92 __glibcxx_rwlock_init (pthread_rwlock_t *__rwlock)
94 if (__gthread_active_p ())
95 return __gthrw_(pthread_rwlock_init) (__rwlock, NULL);
100# if _GTHREAD_USE_MUTEX_TIMEDLOCK
101 __gthrw(pthread_rwlock_timedrdlock);
103 __glibcxx_rwlock_timedrdlock (pthread_rwlock_t *__rwlock,
104 const timespec *__ts)
106 if (__gthread_active_p ())
107 return __gthrw_(pthread_rwlock_timedrdlock) (__rwlock, __ts);
111 __gthrw(pthread_rwlock_timedwrlock);
113 __glibcxx_rwlock_timedwrlock (pthread_rwlock_t *__rwlock,
114 const timespec *__ts)
116 if (__gthread_active_p ())
117 return __gthrw_(pthread_rwlock_timedwrlock) (__rwlock, __ts);
124 __glibcxx_rwlock_rdlock (pthread_rwlock_t *__rwlock)
125 {
return pthread_rwlock_rdlock (__rwlock); }
127 __glibcxx_rwlock_tryrdlock (pthread_rwlock_t *__rwlock)
128 {
return pthread_rwlock_tryrdlock (__rwlock); }
130 __glibcxx_rwlock_wrlock (pthread_rwlock_t *__rwlock)
131 {
return pthread_rwlock_wrlock (__rwlock); }
133 __glibcxx_rwlock_trywrlock (pthread_rwlock_t *__rwlock)
134 {
return pthread_rwlock_trywrlock (__rwlock); }
136 __glibcxx_rwlock_unlock (pthread_rwlock_t *__rwlock)
137 {
return pthread_rwlock_unlock (__rwlock); }
139 __glibcxx_rwlock_destroy(pthread_rwlock_t *__rwlock)
140 {
return pthread_rwlock_destroy (__rwlock); }
142 __glibcxx_rwlock_init(pthread_rwlock_t *__rwlock)
143 {
return pthread_rwlock_init (__rwlock, NULL); }
144# if _GTHREAD_USE_MUTEX_TIMEDLOCK
146 __glibcxx_rwlock_timedrdlock (pthread_rwlock_t *__rwlock,
147 const timespec *__ts)
148 {
return pthread_rwlock_timedrdlock (__rwlock, __ts); }
150 __glibcxx_rwlock_timedwrlock (pthread_rwlock_t *__rwlock,
151 const timespec *__ts)
152 {
return pthread_rwlock_timedwrlock (__rwlock, __ts); }
157 class __shared_mutex_pthread
159 friend class shared_timed_mutex;
161#ifdef PTHREAD_RWLOCK_INITIALIZER
162 pthread_rwlock_t _M_rwlock = PTHREAD_RWLOCK_INITIALIZER;
165 __shared_mutex_pthread() =
default;
166 ~__shared_mutex_pthread() =
default;
168 pthread_rwlock_t _M_rwlock;
171 __shared_mutex_pthread()
173 int __ret = __glibcxx_rwlock_init(&_M_rwlock);
176 else if (__ret == EAGAIN)
177 __throw_system_error(
int(errc::resource_unavailable_try_again));
178 else if (__ret == EPERM)
179 __throw_system_error(
int(errc::operation_not_permitted));
181 __glibcxx_assert(__ret == 0);
184 ~__shared_mutex_pthread()
186 int __ret __attribute((__unused__)) = __glibcxx_rwlock_destroy(&_M_rwlock);
188 __glibcxx_assert(__ret == 0);
192 __shared_mutex_pthread(
const __shared_mutex_pthread&) =
delete;
193 __shared_mutex_pthread& operator=(
const __shared_mutex_pthread&) =
delete;
198 int __ret = __glibcxx_rwlock_wrlock(&_M_rwlock);
199 if (__ret == EDEADLK)
200 __throw_system_error(
int(errc::resource_deadlock_would_occur));
202 __glibcxx_assert(__ret == 0);
208 int __ret = __glibcxx_rwlock_trywrlock(&_M_rwlock);
209 if (__ret == EBUSY)
return false;
211 __glibcxx_assert(__ret == 0);
218 int __ret __attribute((__unused__)) = __glibcxx_rwlock_unlock(&_M_rwlock);
220 __glibcxx_assert(__ret == 0);
234 __ret = __glibcxx_rwlock_rdlock(&_M_rwlock);
235 while (__ret == EAGAIN);
236 if (__ret == EDEADLK)
237 __throw_system_error(
int(errc::resource_deadlock_would_occur));
239 __glibcxx_assert(__ret == 0);
245 int __ret = __glibcxx_rwlock_tryrdlock(&_M_rwlock);
249 if (__ret == EBUSY || __ret == EAGAIN)
return false;
251 __glibcxx_assert(__ret == 0);
261 void* native_handle() {
return &_M_rwlock; }
265#if ! (_GLIBCXX_USE_PTHREAD_RWLOCK_T && _GTHREAD_USE_MUTEX_TIMEDLOCK)
267 class __shared_mutex_cv
269 friend class shared_timed_mutex;
299 condition_variable _M_gate1;
301 condition_variable _M_gate2;
305 static constexpr unsigned _S_write_entered
306 = 1U << (
sizeof(unsigned)*__CHAR_BIT__ - 1);
307 static constexpr unsigned _S_max_readers = ~_S_write_entered;
310 bool _M_write_entered()
const {
return _M_state & _S_write_entered; }
313 unsigned _M_readers()
const {
return _M_state & _S_max_readers; }
316 __shared_mutex_cv() : _M_state(0) {}
320 __glibcxx_assert( _M_state == 0 );
323 __shared_mutex_cv(
const __shared_mutex_cv&) =
delete;
324 __shared_mutex_cv& operator=(
const __shared_mutex_cv&) =
delete;
331 unique_lock<mutex> __lk(_M_mut);
333 _M_gate1.wait(__lk, [=]{
return !_M_write_entered(); });
334 _M_state |= _S_write_entered;
336 _M_gate2.wait(__lk, [=]{
return _M_readers() == 0; });
342 unique_lock<mutex> __lk(_M_mut, try_to_lock);
343 if (__lk.owns_lock() && _M_state == 0)
345 _M_state = _S_write_entered;
354 lock_guard<mutex> __lk(_M_mut);
355 __glibcxx_assert( _M_write_entered() );
359 _M_gate1.notify_all();
367 unique_lock<mutex> __lk(_M_mut);
368 _M_gate1.wait(__lk, [=]{
return _M_state < _S_max_readers; });
375 unique_lock<mutex> __lk(_M_mut, try_to_lock);
376 if (!__lk.owns_lock())
378 if (_M_state < _S_max_readers)
389 lock_guard<mutex> __lk(_M_mut);
390 __glibcxx_assert( _M_readers() > 0 );
391 auto __prev = _M_state--;
392 if (_M_write_entered())
395 if (_M_readers() == 0)
396 _M_gate2.notify_one();
404 if (__prev == _S_max_readers)
405 _M_gate1.notify_one();
412#ifdef __cpp_lib_shared_mutex
417 shared_mutex() =
default;
418 ~shared_mutex() =
default;
420 shared_mutex(
const shared_mutex&) =
delete;
421 shared_mutex& operator=(
const shared_mutex&) =
delete;
425 void lock() { _M_impl.lock(); }
426 [[nodiscard]]
bool try_lock() {
return _M_impl.try_lock(); }
427 void unlock() { _M_impl.unlock(); }
431 void lock_shared() { _M_impl.lock_shared(); }
432 [[nodiscard]]
bool try_lock_shared() {
return _M_impl.try_lock_shared(); }
433 void unlock_shared() { _M_impl.unlock_shared(); }
435#if _GLIBCXX_USE_PTHREAD_RWLOCK_T
436 typedef void* native_handle_type;
437 native_handle_type native_handle() {
return _M_impl.native_handle(); }
440 __shared_mutex_pthread _M_impl;
443 __shared_mutex_cv _M_impl;
449#if _GLIBCXX_USE_PTHREAD_RWLOCK_T && _GTHREAD_USE_MUTEX_TIMEDLOCK
450 using __shared_timed_mutex_base = __shared_mutex_pthread;
452 using __shared_timed_mutex_base = __shared_mutex_cv;
458 :
private __shared_timed_mutex_base
460 using _Base = __shared_timed_mutex_base;
463#ifdef _GLIBCXX_USE_PTHREAD_RWLOCK_CLOCKLOCK
478 void lock() { _Base::lock(); }
479 _GLIBCXX_NODISCARD
bool try_lock() {
return _Base::try_lock(); }
480 void unlock() { _Base::unlock(); }
482 template<
typename _Rep,
typename _Period>
487 auto __rt = chrono::duration_cast<__clock_t::duration>(__rtime);
490 return try_lock_until(__clock_t::now() + __rt);
495 void lock_shared() { _Base::lock_shared(); }
497 bool try_lock_shared() {
return _Base::try_lock_shared(); }
498 void unlock_shared() { _Base::unlock_shared(); }
500 template<
typename _Rep,
typename _Period>
505 auto __rt = chrono::duration_cast<__clock_t::duration>(__rtime);
508 return try_lock_shared_until(__clock_t::now() + __rt);
511#if _GLIBCXX_USE_PTHREAD_RWLOCK_T && _GTHREAD_USE_MUTEX_TIMEDLOCK
515 template<
typename _Duration>
521 auto __s = chrono::time_point_cast<chrono::seconds>(__atime);
522 auto __ns = chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
524 __gthread_time_t __ts =
526 static_cast<std::time_t
>(__s.time_since_epoch().count()),
527 static_cast<long>(__ns.count())
530 int __ret = __glibcxx_rwlock_timedwrlock(&_M_rwlock, &__ts);
533 if (__ret == ETIMEDOUT || __ret == EDEADLK)
536 __glibcxx_assert(__ret == 0);
540#ifdef _GLIBCXX_USE_PTHREAD_RWLOCK_CLOCKLOCK
541 template<
typename _Duration>
547 auto __s = chrono::time_point_cast<chrono::seconds>(__atime);
548 auto __ns = chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
550 __gthread_time_t __ts =
552 static_cast<std::time_t
>(__s.time_since_epoch().count()),
553 static_cast<long>(__ns.count())
556 int __ret = pthread_rwlock_clockwrlock(&_M_rwlock, CLOCK_MONOTONIC,
560 if (__ret == ETIMEDOUT || __ret == EDEADLK)
563 __glibcxx_assert(__ret == 0);
568 template<
typename _Clock,
typename _Duration>
573#if __cplusplus > 201703L
574 static_assert(chrono::is_clock_v<_Clock>);
579 typename _Clock::time_point __now = _Clock::now();
581 auto __rtime = __atime - __now;
582 if (try_lock_for(__rtime))
584 __now = _Clock::now();
585 }
while (__atime > __now);
591 template<
typename _Duration>
597 auto __s = chrono::time_point_cast<chrono::seconds>(__atime);
598 auto __ns = chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
600 __gthread_time_t __ts =
602 static_cast<std::time_t
>(__s.time_since_epoch().count()),
603 static_cast<long>(__ns.count())
621 __ret = __glibcxx_rwlock_timedrdlock(&_M_rwlock, &__ts);
622 while (__ret == EAGAIN || __ret == EDEADLK);
623 if (__ret == ETIMEDOUT)
626 __glibcxx_assert(__ret == 0);
630#ifdef _GLIBCXX_USE_PTHREAD_RWLOCK_CLOCKLOCK
631 template<
typename _Duration>
637 auto __s = chrono::time_point_cast<chrono::seconds>(__atime);
638 auto __ns = chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
640 __gthread_time_t __ts =
642 static_cast<std::time_t
>(__s.time_since_epoch().count()),
643 static_cast<long>(__ns.count())
646 int __ret = pthread_rwlock_clockrdlock(&_M_rwlock, CLOCK_MONOTONIC,
650 if (__ret == ETIMEDOUT || __ret == EDEADLK)
653 __glibcxx_assert(__ret == 0);
658 template<
typename _Clock,
typename _Duration>
664#if __cplusplus > 201703L
665 static_assert(chrono::is_clock_v<_Clock>);
670 typename _Clock::time_point __now = _Clock::now();
672 auto __rtime = __atime - __now;
673 if (try_lock_shared_for(__rtime))
675 __now = _Clock::now();
676 }
while (__atime > __now);
684 template<
typename _Clock,
typename _Duration>
690 if (!_M_gate1.wait_until(__lk, __abs_time,
691 [=]{ return !_M_write_entered(); }))
695 _M_state |= _S_write_entered;
696 if (!_M_gate2.wait_until(__lk, __abs_time,
697 [=]{ return _M_readers() == 0; }))
699 _M_state ^= _S_write_entered;
701 _M_gate1.notify_all();
709 template <
typename _Clock,
typename _Duration>
713 _Duration>& __abs_time)
716 if (!_M_gate1.wait_until(__lk, __abs_time,
717 [=]{ return _M_state < _S_max_readers; }))
730 template<
typename _Mutex>
734 typedef _Mutex mutex_type;
738 shared_lock() noexcept : _M_pm(
nullptr), _M_owns(
false) { }
743 { __m.lock_shared(); }
754 template<
typename _Clock,
typename _Duration>
758 _M_owns(__m.try_lock_shared_until(__abs_time)) { }
760 template<
typename _Rep,
typename _Period>
764 _M_owns(__m.try_lock_shared_for(__rel_time)) { }
769 _M_pm->unlock_shared();
789 _M_pm->lock_shared();
798 return _M_owns = _M_pm->try_lock_shared();
801 template<
typename _Rep,
typename _Period>
807 return _M_owns = _M_pm->try_lock_shared_for(__rel_time);
810 template<
typename _Clock,
typename _Duration>
816 return _M_owns = _M_pm->try_lock_shared_until(__abs_time);
823 __throw_system_error(
int(errc::operation_not_permitted));
824 _M_pm->unlock_shared();
833 std::swap(_M_pm, __u._M_pm);
834 std::swap(_M_owns, __u._M_owns);
841 return std::__exchange(_M_pm,
nullptr);
847 bool owns_lock()
const noexcept {
return _M_owns; }
849 explicit operator bool()
const noexcept {
return _M_owns; }
852 mutex_type*
mutex()
const noexcept {
return _M_pm; }
858 if (_M_pm ==
nullptr)
859 __throw_system_error(
int(errc::operation_not_permitted));
861 __throw_system_error(
int(errc::resource_deadlock_would_occur));
870 template<
typename _Mutex>
876_GLIBCXX_END_NAMESPACE_VERSION
constexpr std::remove_reference< _Tp >::type && move(_Tp &&__t) noexcept
Convert a value to an rvalue.
constexpr _Tp * __addressof(_Tp &__r) noexcept
Same as C++11 std::addressof.
void lock(_L1 &__l1, _L2 &__l2, _L3 &... __l3)
Generic lock.
int try_lock(_L1 &__l1, _L2 &__l2, _L3 &... __l3)
Generic try_lock.
ISO C++ entities toplevel namespace is std.
The standard shared timed mutex type.
chrono::duration represents a distance between two points in time
chrono::time_point represents a point in time as measured by a clock
Do not acquire ownership of the mutex.
Try to acquire ownership of the mutex without blocking.
Assume the calling thread has already obtained mutex ownership and manage it.
A movable scoped lock type.