blob: c45a326d8985b659f23d6aaa370a4adf3f425ac6 [file] [log] [blame]
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00001// -*- C++ -*-
2//===---------------------- condition_variable ----------------------------===//
3//
Howard Hinnantf5256e12010-05-11 21:36:01 +00004// The LLVM Compiler Infrastructure
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00005//
Howard Hinnantb64f8b02010-11-16 22:09:02 +00006// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00008//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_CONDITION_VARIABLE
12#define _LIBCPP_CONDITION_VARIABLE
13
14/*
15 condition_variable synopsis
16
17namespace std
18{
19
20enum class cv_status { no_timeout, timeout };
21
22class condition_variable
23{
24public:
25 condition_variable();
26 ~condition_variable();
27
28 condition_variable(const condition_variable&) = delete;
29 condition_variable& operator=(const condition_variable&) = delete;
30
Howard Hinnantc8f74132012-07-21 16:32:53 +000031 void notify_one() noexcept;
32 void notify_all() noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000033
34 void wait(unique_lock<mutex>& lock);
35 template <class Predicate>
36 void wait(unique_lock<mutex>& lock, Predicate pred);
37
38 template <class Clock, class Duration>
39 cv_status
40 wait_until(unique_lock<mutex>& lock,
41 const chrono::time_point<Clock, Duration>& abs_time);
42
43 template <class Clock, class Duration, class Predicate>
44 bool
45 wait_until(unique_lock<mutex>& lock,
46 const chrono::time_point<Clock, Duration>& abs_time,
47 Predicate pred);
48
49 template <class Rep, class Period>
50 cv_status
51 wait_for(unique_lock<mutex>& lock,
52 const chrono::duration<Rep, Period>& rel_time);
53
54 template <class Rep, class Period, class Predicate>
55 bool
56 wait_for(unique_lock<mutex>& lock,
57 const chrono::duration<Rep, Period>& rel_time,
58 Predicate pred);
59
60 typedef pthread_cond_t* native_handle_type;
61 native_handle_type native_handle();
62};
63
Howard Hinnant47499b12010-08-27 20:10:19 +000064void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
65
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000066class condition_variable_any
67{
68public:
69 condition_variable_any();
70 ~condition_variable_any();
71
72 condition_variable_any(const condition_variable_any&) = delete;
73 condition_variable_any& operator=(const condition_variable_any&) = delete;
74
Howard Hinnantc8f74132012-07-21 16:32:53 +000075 void notify_one() noexcept;
76 void notify_all() noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000077
78 template <class Lock>
79 void wait(Lock& lock);
80 template <class Lock, class Predicate>
81 void wait(Lock& lock, Predicate pred);
82
83 template <class Lock, class Clock, class Duration>
84 cv_status
85 wait_until(Lock& lock,
86 const chrono::time_point<Clock, Duration>& abs_time);
87
88 template <class Lock, class Clock, class Duration, class Predicate>
89 bool
90 wait_until(Lock& lock,
91 const chrono::time_point<Clock, Duration>& abs_time,
92 Predicate pred);
93
94 template <class Lock, class Rep, class Period>
95 cv_status
96 wait_for(Lock& lock,
97 const chrono::duration<Rep, Period>& rel_time);
98
99 template <class Lock, class Rep, class Period, class Predicate>
100 bool
101 wait_for(Lock& lock,
102 const chrono::duration<Rep, Period>& rel_time,
103 Predicate pred);
104};
105
106} // std
107
108*/
109
110#include <__config>
111#include <__mutex_base>
112#include <memory>
113
Howard Hinnant08e17472011-10-17 20:05:10 +0000114#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000115#pragma GCC system_header
Howard Hinnant08e17472011-10-17 20:05:10 +0000116#endif
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000117
Jonathan Roelofs8d86b2e2014-09-05 19:45:05 +0000118#ifndef _LIBCPP_HAS_NO_THREADS
119
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000120_LIBCPP_BEGIN_NAMESPACE_STD
121
Howard Hinnant83eade62013-03-06 23:30:19 +0000122class _LIBCPP_TYPE_VIS condition_variable_any
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000123{
124 condition_variable __cv_;
125 shared_ptr<mutex> __mut_;
126public:
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000127 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000128 condition_variable_any();
129
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000130 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc8f74132012-07-21 16:32:53 +0000131 void notify_one() _NOEXCEPT;
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000132 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc8f74132012-07-21 16:32:53 +0000133 void notify_all() _NOEXCEPT;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000134
135 template <class _Lock>
Shoaib Meenai6b734922017-03-02 03:22:18 +0000136 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000137 void wait(_Lock& __lock);
138 template <class _Lock, class _Predicate>
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000139 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000140 void wait(_Lock& __lock, _Predicate __pred);
141
142 template <class _Lock, class _Clock, class _Duration>
Shoaib Meenai6b734922017-03-02 03:22:18 +0000143 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000144 cv_status
145 wait_until(_Lock& __lock,
146 const chrono::time_point<_Clock, _Duration>& __t);
147
148 template <class _Lock, class _Clock, class _Duration, class _Predicate>
149 bool
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000150 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000151 wait_until(_Lock& __lock,
152 const chrono::time_point<_Clock, _Duration>& __t,
153 _Predicate __pred);
154
155 template <class _Lock, class _Rep, class _Period>
156 cv_status
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000157 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000158 wait_for(_Lock& __lock,
159 const chrono::duration<_Rep, _Period>& __d);
160
161 template <class _Lock, class _Rep, class _Period, class _Predicate>
162 bool
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000163 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000164 wait_for(_Lock& __lock,
165 const chrono::duration<_Rep, _Period>& __d,
166 _Predicate __pred);
167};
168
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000169inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000170condition_variable_any::condition_variable_any()
171 : __mut_(make_shared<mutex>()) {}
172
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000173inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000174void
Howard Hinnantc8f74132012-07-21 16:32:53 +0000175condition_variable_any::notify_one() _NOEXCEPT
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000176{
Howard Hinnant9c0df142012-10-30 19:06:59 +0000177 {lock_guard<mutex> __lx(*__mut_);}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000178 __cv_.notify_one();
179}
180
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000181inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000182void
Howard Hinnantc8f74132012-07-21 16:32:53 +0000183condition_variable_any::notify_all() _NOEXCEPT
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000184{
Howard Hinnant9c0df142012-10-30 19:06:59 +0000185 {lock_guard<mutex> __lx(*__mut_);}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000186 __cv_.notify_all();
187}
188
189struct __lock_external
190{
191 template <class _Lock>
192 void operator()(_Lock* __m) {__m->lock();}
193};
194
195template <class _Lock>
196void
197condition_variable_any::wait(_Lock& __lock)
198{
199 shared_ptr<mutex> __mut = __mut_;
200 unique_lock<mutex> __lk(*__mut);
201 __lock.unlock();
Howard Hinnant9c0df142012-10-30 19:06:59 +0000202 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
203 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000204 __cv_.wait(__lk);
205} // __mut_.unlock(), __lock.lock()
206
207template <class _Lock, class _Predicate>
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000208inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000209void
210condition_variable_any::wait(_Lock& __lock, _Predicate __pred)
211{
212 while (!__pred())
213 wait(__lock);
214}
215
216template <class _Lock, class _Clock, class _Duration>
217cv_status
218condition_variable_any::wait_until(_Lock& __lock,
219 const chrono::time_point<_Clock, _Duration>& __t)
220{
221 shared_ptr<mutex> __mut = __mut_;
222 unique_lock<mutex> __lk(*__mut);
223 __lock.unlock();
Howard Hinnant9c0df142012-10-30 19:06:59 +0000224 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
225 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000226 return __cv_.wait_until(__lk, __t);
227} // __mut_.unlock(), __lock.lock()
228
229template <class _Lock, class _Clock, class _Duration, class _Predicate>
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000230inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000231bool
232condition_variable_any::wait_until(_Lock& __lock,
233 const chrono::time_point<_Clock, _Duration>& __t,
234 _Predicate __pred)
235{
236 while (!__pred())
237 if (wait_until(__lock, __t) == cv_status::timeout)
238 return __pred();
239 return true;
240}
241
242template <class _Lock, class _Rep, class _Period>
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000243inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000244cv_status
245condition_variable_any::wait_for(_Lock& __lock,
246 const chrono::duration<_Rep, _Period>& __d)
247{
Howard Hinnantf8f85212010-11-20 19:16:30 +0000248 return wait_until(__lock, chrono::steady_clock::now() + __d);
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000249}
250
251template <class _Lock, class _Rep, class _Period, class _Predicate>
Evgeniy Stepanova3b25f82015-11-07 01:22:13 +0000252inline
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000253bool
254condition_variable_any::wait_for(_Lock& __lock,
255 const chrono::duration<_Rep, _Period>& __d,
256 _Predicate __pred)
257{
Howard Hinnantf8f85212010-11-20 19:16:30 +0000258 return wait_until(__lock, chrono::steady_clock::now() + __d,
Howard Hinnant0949eed2011-06-30 21:18:19 +0000259 _VSTD::move(__pred));
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000260}
261
Howard Hinnant83eade62013-03-06 23:30:19 +0000262_LIBCPP_FUNC_VIS
Howard Hinnante6e4d012010-09-03 21:46:37 +0000263void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
264
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000265_LIBCPP_END_NAMESPACE_STD
266
Jonathan Roelofs8d86b2e2014-09-05 19:45:05 +0000267#endif // !_LIBCPP_HAS_NO_THREADS
268
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000269#endif // _LIBCPP_CONDITION_VARIABLE