2 //===---------------------- condition_variable ----------------------------===//
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 //===----------------------------------------------------------------------===//
11 #ifndef _LIBCPP_CONDITION_VARIABLE
12 #define _LIBCPP_CONDITION_VARIABLE
15 condition_variable synopsis
20 enum class cv_status { no_timeout, timeout };
22 class condition_variable
26 ~condition_variable();
28 condition_variable(const condition_variable&) = delete;
29 condition_variable& operator=(const condition_variable&) = delete;
31 void notify_one() noexcept;
32 void notify_all() noexcept;
34 void wait(unique_lock<mutex>& lock);
35 template <class Predicate>
36 void wait(unique_lock<mutex>& lock, Predicate pred);
38 template <class Clock, class Duration>
40 wait_until(unique_lock<mutex>& lock,
41 const chrono::time_point<Clock, Duration>& abs_time);
43 template <class Clock, class Duration, class Predicate>
45 wait_until(unique_lock<mutex>& lock,
46 const chrono::time_point<Clock, Duration>& abs_time,
49 template <class Rep, class Period>
51 wait_for(unique_lock<mutex>& lock,
52 const chrono::duration<Rep, Period>& rel_time);
54 template <class Rep, class Period, class Predicate>
56 wait_for(unique_lock<mutex>& lock,
57 const chrono::duration<Rep, Period>& rel_time,
60 typedef pthread_cond_t* native_handle_type;
61 native_handle_type native_handle();
64 void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
66 class condition_variable_any
69 condition_variable_any();
70 ~condition_variable_any();
72 condition_variable_any(const condition_variable_any&) = delete;
73 condition_variable_any& operator=(const condition_variable_any&) = delete;
75 void notify_one() noexcept;
76 void notify_all() noexcept;
79 void wait(Lock& lock);
80 template <class Lock, class Predicate>
81 void wait(Lock& lock, Predicate pred);
83 template <class Lock, class Clock, class Duration>
85 wait_until(Lock& lock,
86 const chrono::time_point<Clock, Duration>& abs_time);
88 template <class Lock, class Clock, class Duration, class Predicate>
90 wait_until(Lock& lock,
91 const chrono::time_point<Clock, Duration>& abs_time,
94 template <class Lock, class Rep, class Period>
97 const chrono::duration<Rep, Period>& rel_time);
99 template <class Lock, class Rep, class Period, class Predicate>
102 const chrono::duration<Rep, Period>& rel_time,
111 #include <__mutex_base>
114 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
115 #pragma GCC system_header
118 _LIBCPP_BEGIN_NAMESPACE_STD
120 class _LIBCPP_TYPE_VIS condition_variable_any
122 condition_variable __cv_;
123 shared_ptr<mutex> __mut_;
125 condition_variable_any();
127 void notify_one() _NOEXCEPT;
128 void notify_all() _NOEXCEPT;
130 template <class _Lock>
131 void wait(_Lock& __lock);
132 template <class _Lock, class _Predicate>
133 void wait(_Lock& __lock, _Predicate __pred);
135 template <class _Lock, class _Clock, class _Duration>
137 wait_until(_Lock& __lock,
138 const chrono::time_point<_Clock, _Duration>& __t);
140 template <class _Lock, class _Clock, class _Duration, class _Predicate>
142 wait_until(_Lock& __lock,
143 const chrono::time_point<_Clock, _Duration>& __t,
146 template <class _Lock, class _Rep, class _Period>
148 wait_for(_Lock& __lock,
149 const chrono::duration<_Rep, _Period>& __d);
151 template <class _Lock, class _Rep, class _Period, class _Predicate>
153 wait_for(_Lock& __lock,
154 const chrono::duration<_Rep, _Period>& __d,
158 inline _LIBCPP_INLINE_VISIBILITY
159 condition_variable_any::condition_variable_any()
160 : __mut_(make_shared<mutex>()) {}
162 inline _LIBCPP_INLINE_VISIBILITY
164 condition_variable_any::notify_one() _NOEXCEPT
166 {lock_guard<mutex> __lx(*__mut_);}
170 inline _LIBCPP_INLINE_VISIBILITY
172 condition_variable_any::notify_all() _NOEXCEPT
174 {lock_guard<mutex> __lx(*__mut_);}
178 struct __lock_external
180 template <class _Lock>
181 void operator()(_Lock* __m) {__m->lock();}
184 template <class _Lock>
186 condition_variable_any::wait(_Lock& __lock)
188 shared_ptr<mutex> __mut = __mut_;
189 unique_lock<mutex> __lk(*__mut);
191 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
192 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
194 } // __mut_.unlock(), __lock.lock()
196 template <class _Lock, class _Predicate>
197 inline _LIBCPP_INLINE_VISIBILITY
199 condition_variable_any::wait(_Lock& __lock, _Predicate __pred)
205 template <class _Lock, class _Clock, class _Duration>
207 condition_variable_any::wait_until(_Lock& __lock,
208 const chrono::time_point<_Clock, _Duration>& __t)
210 shared_ptr<mutex> __mut = __mut_;
211 unique_lock<mutex> __lk(*__mut);
213 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
214 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
215 return __cv_.wait_until(__lk, __t);
216 } // __mut_.unlock(), __lock.lock()
218 template <class _Lock, class _Clock, class _Duration, class _Predicate>
219 inline _LIBCPP_INLINE_VISIBILITY
221 condition_variable_any::wait_until(_Lock& __lock,
222 const chrono::time_point<_Clock, _Duration>& __t,
226 if (wait_until(__lock, __t) == cv_status::timeout)
231 template <class _Lock, class _Rep, class _Period>
232 inline _LIBCPP_INLINE_VISIBILITY
234 condition_variable_any::wait_for(_Lock& __lock,
235 const chrono::duration<_Rep, _Period>& __d)
237 return wait_until(__lock, chrono::steady_clock::now() + __d);
240 template <class _Lock, class _Rep, class _Period, class _Predicate>
241 inline _LIBCPP_INLINE_VISIBILITY
243 condition_variable_any::wait_for(_Lock& __lock,
244 const chrono::duration<_Rep, _Period>& __d,
247 return wait_until(__lock, chrono::steady_clock::now() + __d,
248 _VSTD::move(__pred));
252 void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
254 _LIBCPP_END_NAMESPACE_STD
256 #endif // _LIBCPP_CONDITION_VARIABLE