blob: 6da72465004635ca195ca32cc292960f8c4dab3f [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
Louis Dionne9bd93882021-11-17 16:25:01 -05002//===----------------------------------------------------------------------===//
Howard Hinnantc51e1022010-05-11 19:42:16 +00003//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Howard Hinnantc51e1022010-05-11 19:42:16 +00007//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_CONDITION_VARIABLE
11#define _LIBCPP_CONDITION_VARIABLE
12
13/*
14 condition_variable synopsis
15
16namespace std
17{
18
19enum class cv_status { no_timeout, timeout };
20
21class condition_variable
22{
23public:
24 condition_variable();
25 ~condition_variable();
26
27 condition_variable(const condition_variable&) = delete;
28 condition_variable& operator=(const condition_variable&) = delete;
29
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +000030 void notify_one() noexcept;
31 void notify_all() noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000032
33 void wait(unique_lock<mutex>& lock);
34 template <class Predicate>
35 void wait(unique_lock<mutex>& lock, Predicate pred);
36
37 template <class Clock, class Duration>
38 cv_status
39 wait_until(unique_lock<mutex>& lock,
40 const chrono::time_point<Clock, Duration>& abs_time);
41
42 template <class Clock, class Duration, class Predicate>
43 bool
44 wait_until(unique_lock<mutex>& lock,
45 const chrono::time_point<Clock, Duration>& abs_time,
46 Predicate pred);
47
48 template <class Rep, class Period>
49 cv_status
50 wait_for(unique_lock<mutex>& lock,
51 const chrono::duration<Rep, Period>& rel_time);
52
53 template <class Rep, class Period, class Predicate>
54 bool
55 wait_for(unique_lock<mutex>& lock,
56 const chrono::duration<Rep, Period>& rel_time,
57 Predicate pred);
58
59 typedef pthread_cond_t* native_handle_type;
60 native_handle_type native_handle();
61};
62
Howard Hinnant3820f6b2010-08-27 20:10:19 +000063void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
64
Howard Hinnantc51e1022010-05-11 19:42:16 +000065class condition_variable_any
66{
67public:
68 condition_variable_any();
69 ~condition_variable_any();
70
71 condition_variable_any(const condition_variable_any&) = delete;
72 condition_variable_any& operator=(const condition_variable_any&) = delete;
73
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +000074 void notify_one() noexcept;
75 void notify_all() noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000076
77 template <class Lock>
78 void wait(Lock& lock);
79 template <class Lock, class Predicate>
80 void wait(Lock& lock, Predicate pred);
81
82 template <class Lock, class Clock, class Duration>
83 cv_status
84 wait_until(Lock& lock,
85 const chrono::time_point<Clock, Duration>& abs_time);
86
87 template <class Lock, class Clock, class Duration, class Predicate>
88 bool
89 wait_until(Lock& lock,
90 const chrono::time_point<Clock, Duration>& abs_time,
91 Predicate pred);
92
93 template <class Lock, class Rep, class Period>
94 cv_status
95 wait_for(Lock& lock,
96 const chrono::duration<Rep, Period>& rel_time);
97
98 template <class Lock, class Rep, class Period, class Predicate>
99 bool
100 wait_for(Lock& lock,
101 const chrono::duration<Rep, Period>& rel_time,
102 Predicate pred);
103};
104
105} // std
106
107*/
108
109#include <__config>
110#include <__mutex_base>
111#include <memory>
Mark de Weverce8f12c2021-12-22 18:14:14 +0100112#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000113
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000114#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Arthur O'Dwyer6eeaa002022-02-01 20:16:40 -0500115# pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000116#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000117
Jonathan Roelofs39cb6bf2014-09-05 19:45:05 +0000118#ifndef _LIBCPP_HAS_NO_THREADS
119
Howard Hinnantc51e1022010-05-11 19:42:16 +0000120_LIBCPP_BEGIN_NAMESPACE_STD
121
Howard Hinnant8331b762013-03-06 23:30:19 +0000122class _LIBCPP_TYPE_VIS condition_variable_any
Howard Hinnantc51e1022010-05-11 19:42:16 +0000123{
124 condition_variable __cv_;
125 shared_ptr<mutex> __mut_;
126public:
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000127 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000128 condition_variable_any();
129
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000130 _LIBCPP_INLINE_VISIBILITY
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000131 void notify_one() _NOEXCEPT;
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000132 _LIBCPP_INLINE_VISIBILITY
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000133 void notify_all() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000134
135 template <class _Lock>
Shoaib Meenai55f3a462017-03-02 03:22:18 +0000136 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000137 void wait(_Lock& __lock);
138 template <class _Lock, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000139 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000140 void wait(_Lock& __lock, _Predicate __pred);
141
142 template <class _Lock, class _Clock, class _Duration>
Shoaib Meenai55f3a462017-03-02 03:22:18 +0000143 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
Howard Hinnantc51e1022010-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 Stepanov2fb1cb62015-11-07 01:22:13 +0000150 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-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 Stepanov2fb1cb62015-11-07 01:22:13 +0000157 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-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 Stepanov2fb1cb62015-11-07 01:22:13 +0000163 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000164 wait_for(_Lock& __lock,
165 const chrono::duration<_Rep, _Period>& __d,
166 _Predicate __pred);
167};
168
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000169inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000170condition_variable_any::condition_variable_any()
171 : __mut_(make_shared<mutex>()) {}
172
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000173inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000174void
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000175condition_variable_any::notify_one() _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000176{
Howard Hinnant49e145e2012-10-30 19:06:59 +0000177 {lock_guard<mutex> __lx(*__mut_);}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000178 __cv_.notify_one();
179}
180
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000181inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000182void
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000183condition_variable_any::notify_all() _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000184{
Howard Hinnant49e145e2012-10-30 19:06:59 +0000185 {lock_guard<mutex> __lx(*__mut_);}
Howard Hinnantc51e1022010-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 Hinnant49e145e2012-10-30 19:06:59 +0000202 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
203 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000204 __cv_.wait(__lk);
205} // __mut_.unlock(), __lock.lock()
206
207template <class _Lock, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000208inline
Howard Hinnantc51e1022010-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 Hinnant49e145e2012-10-30 19:06:59 +0000224 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
225 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
Howard Hinnantc51e1022010-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 Stepanov2fb1cb62015-11-07 01:22:13 +0000230inline
Howard Hinnantc51e1022010-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 Stepanov2fb1cb62015-11-07 01:22:13 +0000243inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000244cv_status
245condition_variable_any::wait_for(_Lock& __lock,
246 const chrono::duration<_Rep, _Period>& __d)
247{
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000248 return wait_until(__lock, chrono::steady_clock::now() + __d);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000249}
250
251template <class _Lock, class _Rep, class _Period, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000252inline
Howard Hinnantc51e1022010-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 Hinnantc8dbd222010-11-20 19:16:30 +0000258 return wait_until(__lock, chrono::steady_clock::now() + __d,
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000259 _VSTD::move(__pred));
Howard Hinnantc51e1022010-05-11 19:42:16 +0000260}
261
Howard Hinnant8331b762013-03-06 23:30:19 +0000262_LIBCPP_FUNC_VIS
Howard Hinnante6a10852010-09-03 21:46:37 +0000263void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
264
Howard Hinnantc51e1022010-05-11 19:42:16 +0000265_LIBCPP_END_NAMESPACE_STD
266
Jonathan Roelofs39cb6bf2014-09-05 19:45:05 +0000267#endif // !_LIBCPP_HAS_NO_THREADS
268
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400269#endif // _LIBCPP_CONDITION_VARIABLE