blob: 6b4d506939e16bc8ee6bd0ae8931eb70c687d43b [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
Louis Dionneb4fce352022-03-25 12:55:36 -0400109#include <__assert> // all public C++ headers provide the assertion handler
Howard Hinnantc51e1022010-05-11 19:42:16 +0000110#include <__config>
Nikolas Klauser0b5df932022-09-05 00:01:15 +0200111#include <__memory/shared_ptr.h>
112#include <__memory/unique_ptr.h>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000113#include <__mutex_base>
Mark de Weverce8f12c2021-12-22 18:14:14 +0100114#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000115
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000116#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Arthur O'Dwyer6eeaa002022-02-01 20:16:40 -0500117# pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000118#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000119
Jonathan Roelofs39cb6bf2014-09-05 19:45:05 +0000120#ifndef _LIBCPP_HAS_NO_THREADS
121
Howard Hinnantc51e1022010-05-11 19:42:16 +0000122_LIBCPP_BEGIN_NAMESPACE_STD
123
Howard Hinnant8331b762013-03-06 23:30:19 +0000124class _LIBCPP_TYPE_VIS condition_variable_any
Howard Hinnantc51e1022010-05-11 19:42:16 +0000125{
126 condition_variable __cv_;
127 shared_ptr<mutex> __mut_;
128public:
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000129 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000130 condition_variable_any();
131
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000132 _LIBCPP_INLINE_VISIBILITY
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000133 void notify_one() _NOEXCEPT;
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000134 _LIBCPP_INLINE_VISIBILITY
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000135 void notify_all() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000136
137 template <class _Lock>
Shoaib Meenai55f3a462017-03-02 03:22:18 +0000138 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000139 void wait(_Lock& __lock);
140 template <class _Lock, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000141 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000142 void wait(_Lock& __lock, _Predicate __pred);
143
144 template <class _Lock, class _Clock, class _Duration>
Shoaib Meenai55f3a462017-03-02 03:22:18 +0000145 _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000146 cv_status
147 wait_until(_Lock& __lock,
148 const chrono::time_point<_Clock, _Duration>& __t);
149
150 template <class _Lock, class _Clock, class _Duration, class _Predicate>
151 bool
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000152 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000153 wait_until(_Lock& __lock,
154 const chrono::time_point<_Clock, _Duration>& __t,
155 _Predicate __pred);
156
157 template <class _Lock, class _Rep, class _Period>
158 cv_status
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000159 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000160 wait_for(_Lock& __lock,
161 const chrono::duration<_Rep, _Period>& __d);
162
163 template <class _Lock, class _Rep, class _Period, class _Predicate>
164 bool
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000165 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000166 wait_for(_Lock& __lock,
167 const chrono::duration<_Rep, _Period>& __d,
168 _Predicate __pred);
169};
170
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000171inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000172condition_variable_any::condition_variable_any()
173 : __mut_(make_shared<mutex>()) {}
174
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000175inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000176void
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000177condition_variable_any::notify_one() _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000178{
Howard Hinnant49e145e2012-10-30 19:06:59 +0000179 {lock_guard<mutex> __lx(*__mut_);}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000180 __cv_.notify_one();
181}
182
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000183inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000184void
Howard Hinnant0fb1b0a2012-07-21 16:32:53 +0000185condition_variable_any::notify_all() _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000186{
Howard Hinnant49e145e2012-10-30 19:06:59 +0000187 {lock_guard<mutex> __lx(*__mut_);}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000188 __cv_.notify_all();
189}
190
191struct __lock_external
192{
193 template <class _Lock>
194 void operator()(_Lock* __m) {__m->lock();}
195};
196
197template <class _Lock>
198void
199condition_variable_any::wait(_Lock& __lock)
200{
201 shared_ptr<mutex> __mut = __mut_;
202 unique_lock<mutex> __lk(*__mut);
203 __lock.unlock();
Howard Hinnant49e145e2012-10-30 19:06:59 +0000204 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
205 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000206 __cv_.wait(__lk);
207} // __mut_.unlock(), __lock.lock()
208
209template <class _Lock, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000210inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000211void
212condition_variable_any::wait(_Lock& __lock, _Predicate __pred)
213{
214 while (!__pred())
215 wait(__lock);
216}
217
218template <class _Lock, class _Clock, class _Duration>
219cv_status
220condition_variable_any::wait_until(_Lock& __lock,
221 const chrono::time_point<_Clock, _Duration>& __t)
222{
223 shared_ptr<mutex> __mut = __mut_;
224 unique_lock<mutex> __lk(*__mut);
225 __lock.unlock();
Howard Hinnant49e145e2012-10-30 19:06:59 +0000226 unique_ptr<_Lock, __lock_external> __lxx(&__lock);
227 lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000228 return __cv_.wait_until(__lk, __t);
229} // __mut_.unlock(), __lock.lock()
230
231template <class _Lock, class _Clock, class _Duration, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000232inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000233bool
234condition_variable_any::wait_until(_Lock& __lock,
235 const chrono::time_point<_Clock, _Duration>& __t,
236 _Predicate __pred)
237{
238 while (!__pred())
239 if (wait_until(__lock, __t) == cv_status::timeout)
240 return __pred();
241 return true;
242}
243
244template <class _Lock, class _Rep, class _Period>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000245inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000246cv_status
247condition_variable_any::wait_for(_Lock& __lock,
248 const chrono::duration<_Rep, _Period>& __d)
249{
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000250 return wait_until(__lock, chrono::steady_clock::now() + __d);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000251}
252
253template <class _Lock, class _Rep, class _Period, class _Predicate>
Evgeniy Stepanov2fb1cb62015-11-07 01:22:13 +0000254inline
Howard Hinnantc51e1022010-05-11 19:42:16 +0000255bool
256condition_variable_any::wait_for(_Lock& __lock,
257 const chrono::duration<_Rep, _Period>& __d,
258 _Predicate __pred)
259{
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000260 return wait_until(__lock, chrono::steady_clock::now() + __d,
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000261 _VSTD::move(__pred));
Howard Hinnantc51e1022010-05-11 19:42:16 +0000262}
263
Howard Hinnant8331b762013-03-06 23:30:19 +0000264_LIBCPP_FUNC_VIS
Nikolas Klauser7b8c0502022-07-08 18:17:26 +0200265void notify_all_at_thread_exit(condition_variable&, unique_lock<mutex>);
Howard Hinnante6a10852010-09-03 21:46:37 +0000266
Howard Hinnantc51e1022010-05-11 19:42:16 +0000267_LIBCPP_END_NAMESPACE_STD
268
Jonathan Roelofs39cb6bf2014-09-05 19:45:05 +0000269#endif // !_LIBCPP_HAS_NO_THREADS
270
Nikolas Klauser1e4ae5d2022-11-02 20:27:42 +0100271#if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
272# include <concepts>
273#endif
274
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400275#endif // _LIBCPP_CONDITION_VARIABLE