3 // Copyright (C) 2003-2015 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file include/mutex
26 * This is a Standard C++ Library header.
29 #ifndef _GLIBCXX_MUTEX
30 #define _GLIBCXX_MUTEX 1
32 #pragma GCC system_header
34 #if __cplusplus < 201103L
35 # include <bits/c++0x_warning.h>
41 #include <type_traits>
43 #include <system_error>
44 #include <bits/functexcept.h>
45 #include <bits/gthr.h>
46 #include <bits/move.h> // for std::swap
47 #include <bits/cxxabi_forced.h>
49 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
51 namespace std _GLIBCXX_VISIBILITY(default)
53 _GLIBCXX_BEGIN_NAMESPACE_VERSION
55 #ifdef _GLIBCXX_HAS_GTHREADS
56 // Common base class for std::mutex and std::timed_mutex
60 typedef __gthread_mutex_t __native_type;
62 #ifdef __GTHREAD_MUTEX_INIT
63 __native_type _M_mutex = __GTHREAD_MUTEX_INIT;
65 constexpr __mutex_base() noexcept = default;
67 __native_type _M_mutex;
69 __mutex_base() noexcept
71 // XXX EAGAIN, ENOMEM, EPERM, EBUSY(may), EINVAL(may)
72 __GTHREAD_MUTEX_INIT_FUNCTION(&_M_mutex);
75 ~__mutex_base() noexcept { __gthread_mutex_destroy(&_M_mutex); }
78 __mutex_base(const __mutex_base&) = delete;
79 __mutex_base& operator=(const __mutex_base&) = delete;
82 // Common base class for std::recursive_mutex and std::recursive_timed_mutex
83 class __recursive_mutex_base
86 typedef __gthread_recursive_mutex_t __native_type;
88 __recursive_mutex_base(const __recursive_mutex_base&) = delete;
89 __recursive_mutex_base& operator=(const __recursive_mutex_base&) = delete;
91 #ifdef __GTHREAD_RECURSIVE_MUTEX_INIT
92 __native_type _M_mutex = __GTHREAD_RECURSIVE_MUTEX_INIT;
94 __recursive_mutex_base() = default;
96 __native_type _M_mutex;
98 __recursive_mutex_base()
100 // XXX EAGAIN, ENOMEM, EPERM, EBUSY(may), EINVAL(may)
101 __GTHREAD_RECURSIVE_MUTEX_INIT_FUNCTION(&_M_mutex);
104 ~__recursive_mutex_base()
105 { __gthread_recursive_mutex_destroy(&_M_mutex); }
110 * @defgroup mutexes Mutexes
111 * @ingroup concurrency
113 * Classes for mutex support.
118 class mutex : private __mutex_base
121 typedef __native_type* native_handle_type;
123 #ifdef __GTHREAD_MUTEX_INIT
126 mutex() noexcept = default;
129 mutex(const mutex&) = delete;
130 mutex& operator=(const mutex&) = delete;
135 int __e = __gthread_mutex_lock(&_M_mutex);
137 // EINVAL, EAGAIN, EBUSY, EINVAL, EDEADLK(may)
139 __throw_system_error(__e);
145 // XXX EINVAL, EAGAIN, EBUSY
146 return !__gthread_mutex_trylock(&_M_mutex);
152 // XXX EINVAL, EAGAIN, EPERM
153 __gthread_mutex_unlock(&_M_mutex);
158 { return &_M_mutex; }
162 class recursive_mutex : private __recursive_mutex_base
165 typedef __native_type* native_handle_type;
167 recursive_mutex() = default;
168 ~recursive_mutex() = default;
170 recursive_mutex(const recursive_mutex&) = delete;
171 recursive_mutex& operator=(const recursive_mutex&) = delete;
176 int __e = __gthread_recursive_mutex_lock(&_M_mutex);
178 // EINVAL, EAGAIN, EBUSY, EINVAL, EDEADLK(may)
180 __throw_system_error(__e);
186 // XXX EINVAL, EAGAIN, EBUSY
187 return !__gthread_recursive_mutex_trylock(&_M_mutex);
193 // XXX EINVAL, EAGAIN, EBUSY
194 __gthread_recursive_mutex_unlock(&_M_mutex);
199 { return &_M_mutex; }
202 #if _GTHREAD_USE_MUTEX_TIMEDLOCK
203 template<typename _Derived>
204 class __timed_mutex_impl
207 typedef chrono::high_resolution_clock __clock_t;
209 template<typename _Rep, typename _Period>
211 _M_try_lock_for(const chrono::duration<_Rep, _Period>& __rtime)
213 using chrono::steady_clock;
214 auto __rt = chrono::duration_cast<steady_clock::duration>(__rtime);
215 if (ratio_greater<steady_clock::period, _Period>())
217 return _M_try_lock_until(steady_clock::now() + __rt);
220 template<typename _Duration>
222 _M_try_lock_until(const chrono::time_point<__clock_t,
225 auto __s = chrono::time_point_cast<chrono::seconds>(__atime);
226 auto __ns = chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
228 __gthread_time_t __ts = {
229 static_cast<std::time_t>(__s.time_since_epoch().count()),
230 static_cast<long>(__ns.count())
233 return static_cast<_Derived*>(this)->_M_timedlock(__ts);
236 template<typename _Clock, typename _Duration>
238 _M_try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
240 auto __rtime = __atime - _Clock::now();
241 return _M_try_lock_until(__clock_t::now() + __rtime);
247 : private __mutex_base, public __timed_mutex_impl<timed_mutex>
250 typedef __native_type* native_handle_type;
252 timed_mutex() = default;
253 ~timed_mutex() = default;
255 timed_mutex(const timed_mutex&) = delete;
256 timed_mutex& operator=(const timed_mutex&) = delete;
261 int __e = __gthread_mutex_lock(&_M_mutex);
263 // EINVAL, EAGAIN, EBUSY, EINVAL, EDEADLK(may)
265 __throw_system_error(__e);
271 // XXX EINVAL, EAGAIN, EBUSY
272 return !__gthread_mutex_trylock(&_M_mutex);
275 template <class _Rep, class _Period>
277 try_lock_for(const chrono::duration<_Rep, _Period>& __rtime)
278 { return _M_try_lock_for(__rtime); }
280 template <class _Clock, class _Duration>
282 try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
283 { return _M_try_lock_until(__atime); }
288 // XXX EINVAL, EAGAIN, EBUSY
289 __gthread_mutex_unlock(&_M_mutex);
294 { return &_M_mutex; }
297 friend class __timed_mutex_impl<timed_mutex>;
300 _M_timedlock(const __gthread_time_t& __ts)
301 { return !__gthread_mutex_timedlock(&_M_mutex, &__ts); }
304 /// recursive_timed_mutex
305 class recursive_timed_mutex
306 : private __recursive_mutex_base,
307 public __timed_mutex_impl<recursive_timed_mutex>
310 typedef __native_type* native_handle_type;
312 recursive_timed_mutex() = default;
313 ~recursive_timed_mutex() = default;
315 recursive_timed_mutex(const recursive_timed_mutex&) = delete;
316 recursive_timed_mutex& operator=(const recursive_timed_mutex&) = delete;
321 int __e = __gthread_recursive_mutex_lock(&_M_mutex);
323 // EINVAL, EAGAIN, EBUSY, EINVAL, EDEADLK(may)
325 __throw_system_error(__e);
331 // XXX EINVAL, EAGAIN, EBUSY
332 return !__gthread_recursive_mutex_trylock(&_M_mutex);
335 template <class _Rep, class _Period>
337 try_lock_for(const chrono::duration<_Rep, _Period>& __rtime)
338 { return _M_try_lock_for(__rtime); }
340 template <class _Clock, class _Duration>
342 try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
343 { return _M_try_lock_until(__atime); }
348 // XXX EINVAL, EAGAIN, EBUSY
349 __gthread_recursive_mutex_unlock(&_M_mutex);
354 { return &_M_mutex; }
357 friend class __timed_mutex_impl<recursive_timed_mutex>;
360 _M_timedlock(const __gthread_time_t& __ts)
361 { return !__gthread_recursive_mutex_timedlock(&_M_mutex, &__ts); }
364 #endif // _GLIBCXX_HAS_GTHREADS
366 /// Do not acquire ownership of the mutex.
367 struct defer_lock_t { };
369 /// Try to acquire ownership of the mutex without blocking.
370 struct try_to_lock_t { };
372 /// Assume the calling thread has already obtained mutex ownership
374 struct adopt_lock_t { };
376 constexpr defer_lock_t defer_lock { };
377 constexpr try_to_lock_t try_to_lock { };
378 constexpr adopt_lock_t adopt_lock { };
380 /// @brief Scoped lock idiom.
381 // Acquire the mutex here with a constructor call, then release with
382 // the destructor call in accordance with RAII style.
383 template<typename _Mutex>
387 typedef _Mutex mutex_type;
389 explicit lock_guard(mutex_type& __m) : _M_device(__m)
390 { _M_device.lock(); }
392 lock_guard(mutex_type& __m, adopt_lock_t) : _M_device(__m)
393 { } // calling thread owns mutex
396 { _M_device.unlock(); }
398 lock_guard(const lock_guard&) = delete;
399 lock_guard& operator=(const lock_guard&) = delete;
402 mutex_type& _M_device;
406 template<typename _Mutex>
410 typedef _Mutex mutex_type;
412 unique_lock() noexcept
413 : _M_device(0), _M_owns(false)
416 explicit unique_lock(mutex_type& __m)
417 : _M_device(std::__addressof(__m)), _M_owns(false)
423 unique_lock(mutex_type& __m, defer_lock_t) noexcept
424 : _M_device(std::__addressof(__m)), _M_owns(false)
427 unique_lock(mutex_type& __m, try_to_lock_t)
428 : _M_device(std::__addressof(__m)), _M_owns(_M_device->try_lock())
431 unique_lock(mutex_type& __m, adopt_lock_t)
432 : _M_device(std::__addressof(__m)), _M_owns(true)
434 // XXX calling thread owns mutex
437 template<typename _Clock, typename _Duration>
438 unique_lock(mutex_type& __m,
439 const chrono::time_point<_Clock, _Duration>& __atime)
440 : _M_device(std::__addressof(__m)),
441 _M_owns(_M_device->try_lock_until(__atime))
444 template<typename _Rep, typename _Period>
445 unique_lock(mutex_type& __m,
446 const chrono::duration<_Rep, _Period>& __rtime)
447 : _M_device(std::__addressof(__m)),
448 _M_owns(_M_device->try_lock_for(__rtime))
457 unique_lock(const unique_lock&) = delete;
458 unique_lock& operator=(const unique_lock&) = delete;
460 unique_lock(unique_lock&& __u) noexcept
461 : _M_device(__u._M_device), _M_owns(__u._M_owns)
467 unique_lock& operator=(unique_lock&& __u) noexcept
472 unique_lock(std::move(__u)).swap(*this);
484 __throw_system_error(int(errc::operation_not_permitted));
486 __throw_system_error(int(errc::resource_deadlock_would_occur));
498 __throw_system_error(int(errc::operation_not_permitted));
500 __throw_system_error(int(errc::resource_deadlock_would_occur));
503 _M_owns = _M_device->try_lock();
508 template<typename _Clock, typename _Duration>
510 try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
513 __throw_system_error(int(errc::operation_not_permitted));
515 __throw_system_error(int(errc::resource_deadlock_would_occur));
518 _M_owns = _M_device->try_lock_until(__atime);
523 template<typename _Rep, typename _Period>
525 try_lock_for(const chrono::duration<_Rep, _Period>& __rtime)
528 __throw_system_error(int(errc::operation_not_permitted));
530 __throw_system_error(int(errc::resource_deadlock_would_occur));
533 _M_owns = _M_device->try_lock_for(__rtime);
542 __throw_system_error(int(errc::operation_not_permitted));
551 swap(unique_lock& __u) noexcept
553 std::swap(_M_device, __u._M_device);
554 std::swap(_M_owns, __u._M_owns);
560 mutex_type* __ret = _M_device;
567 owns_lock() const noexcept
570 explicit operator bool() const noexcept
571 { return owns_lock(); }
574 mutex() const noexcept
575 { return _M_device; }
578 mutex_type* _M_device;
579 bool _M_owns; // XXX use atomic_bool
582 /// Swap overload for unique_lock objects.
583 template<typename _Mutex>
585 swap(unique_lock<_Mutex>& __x, unique_lock<_Mutex>& __y) noexcept
588 template<typename _Lock>
589 inline unique_lock<_Lock>
590 __try_to_lock(_Lock& __l)
591 { return unique_lock<_Lock>{__l, try_to_lock}; }
593 template<int _Idx, bool _Continue = true>
594 struct __try_lock_impl
596 template<typename... _Lock>
598 __do_try_lock(tuple<_Lock&...>& __locks, int& __idx)
601 auto __lock = std::__try_to_lock(std::get<_Idx>(__locks));
602 if (__lock.owns_lock())
604 constexpr bool __cont = _Idx + 2 < sizeof...(_Lock);
605 using __try_locker = __try_lock_impl<_Idx + 1, __cont>;
606 __try_locker::__do_try_lock(__locks, __idx);
614 struct __try_lock_impl<_Idx, false>
616 template<typename... _Lock>
618 __do_try_lock(tuple<_Lock&...>& __locks, int& __idx)
621 auto __lock = std::__try_to_lock(std::get<_Idx>(__locks));
622 if (__lock.owns_lock())
630 /** @brief Generic try_lock.
631 * @param __l1 Meets Mutex requirements (try_lock() may throw).
632 * @param __l2 Meets Mutex requirements (try_lock() may throw).
633 * @param __l3 Meets Mutex requirements (try_lock() may throw).
634 * @return Returns -1 if all try_lock() calls return true. Otherwise returns
635 * a 0-based index corresponding to the argument that returned false.
636 * @post Either all arguments are locked, or none will be.
638 * Sequentially calls try_lock() on each argument.
640 template<typename _Lock1, typename _Lock2, typename... _Lock3>
642 try_lock(_Lock1& __l1, _Lock2& __l2, _Lock3&... __l3)
645 auto __locks = std::tie(__l1, __l2, __l3...);
646 __try_lock_impl<0>::__do_try_lock(__locks, __idx);
650 /** @brief Generic lock.
651 * @param __l1 Meets Mutex requirements (try_lock() may throw).
652 * @param __l2 Meets Mutex requirements (try_lock() may throw).
653 * @param __l3 Meets Mutex requirements (try_lock() may throw).
654 * @throw An exception thrown by an argument's lock() or try_lock() member.
655 * @post All arguments are locked.
657 * All arguments are locked via a sequence of calls to lock(), try_lock()
658 * and unlock(). If the call exits via an exception any locks that were
659 * obtained will be released.
661 template<typename _L1, typename _L2, typename... _L3>
663 lock(_L1& __l1, _L2& __l2, _L3&... __l3)
667 using __try_locker = __try_lock_impl<0, sizeof...(_L3) != 0>;
668 unique_lock<_L1> __first(__l1);
670 auto __locks = std::tie(__l2, __l3...);
671 __try_locker::__do_try_lock(__locks, __idx);
680 #ifdef _GLIBCXX_HAS_GTHREADS
685 typedef __gthread_once_t __native_type;
686 __native_type _M_once = __GTHREAD_ONCE_INIT;
690 constexpr once_flag() noexcept = default;
692 /// Deleted copy constructor
693 once_flag(const once_flag&) = delete;
694 /// Deleted assignment operator
695 once_flag& operator=(const once_flag&) = delete;
697 template<typename _Callable, typename... _Args>
699 call_once(once_flag& __once, _Callable&& __f, _Args&&... __args);
702 #ifdef _GLIBCXX_HAVE_TLS
703 extern __thread void* __once_callable;
704 extern __thread void (*__once_call)();
706 template<typename _Callable>
710 (*(_Callable*)__once_callable)();
713 extern function<void()> __once_functor;
716 __set_once_functor_lock_ptr(unique_lock<mutex>*);
722 extern "C" void __once_proxy(void);
725 template<typename _Callable, typename... _Args>
727 call_once(once_flag& __once, _Callable&& __f, _Args&&... __args)
729 #ifdef _GLIBCXX_HAVE_TLS
730 auto __bound_functor = std::__bind_simple(std::forward<_Callable>(__f),
731 std::forward<_Args>(__args)...);
732 __once_callable = std::__addressof(__bound_functor);
733 __once_call = &__once_call_impl<decltype(__bound_functor)>;
735 unique_lock<mutex> __functor_lock(__get_once_mutex());
736 auto __callable = std::__bind_simple(std::forward<_Callable>(__f),
737 std::forward<_Args>(__args)...);
738 __once_functor = [&]() { __callable(); };
739 __set_once_functor_lock_ptr(&__functor_lock);
742 int __e = __gthread_once(&__once._M_once, &__once_proxy);
744 #ifndef _GLIBCXX_HAVE_TLS
746 __set_once_functor_lock_ptr(0);
750 __throw_system_error(__e);
752 #endif // _GLIBCXX_HAS_GTHREADS
755 _GLIBCXX_END_NAMESPACE_VERSION
757 #endif // _GLIBCXX_USE_C99_STDINT_TR1
761 #endif // _GLIBCXX_MUTEX