Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 1 | // -*- C++ -*- |
| 2 | //===---------------------- condition_variable ----------------------------===// |
| 3 | // |
Chandler Carruth | d201210 | 2019-01-19 10:56:40 +0000 | [diff] [blame] | 4 | // 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 Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | |
| 10 | #ifndef _LIBCPP_CONDITION_VARIABLE |
| 11 | #define _LIBCPP_CONDITION_VARIABLE |
| 12 | |
| 13 | /* |
| 14 | condition_variable synopsis |
| 15 | |
| 16 | namespace std |
| 17 | { |
| 18 | |
| 19 | enum class cv_status { no_timeout, timeout }; |
| 20 | |
| 21 | class condition_variable |
| 22 | { |
| 23 | public: |
| 24 | condition_variable(); |
| 25 | ~condition_variable(); |
| 26 | |
| 27 | condition_variable(const condition_variable&) = delete; |
| 28 | condition_variable& operator=(const condition_variable&) = delete; |
| 29 | |
Howard Hinnant | 0fb1b0a | 2012-07-21 16:32:53 +0000 | [diff] [blame] | 30 | void notify_one() noexcept; |
| 31 | void notify_all() noexcept; |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 32 | |
| 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 Hinnant | 3820f6b | 2010-08-27 20:10:19 +0000 | [diff] [blame] | 63 | void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk); |
| 64 | |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 65 | class condition_variable_any |
| 66 | { |
| 67 | public: |
| 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 Hinnant | 0fb1b0a | 2012-07-21 16:32:53 +0000 | [diff] [blame] | 74 | void notify_one() noexcept; |
| 75 | void notify_all() noexcept; |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 76 | |
| 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> |
| 112 | |
Howard Hinnant | aaaa52b | 2011-10-17 20:05:10 +0000 | [diff] [blame] | 113 | #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER) |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 114 | #pragma GCC system_header |
Howard Hinnant | aaaa52b | 2011-10-17 20:05:10 +0000 | [diff] [blame] | 115 | #endif |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 116 | |
Jonathan Roelofs | 39cb6bf | 2014-09-05 19:45:05 +0000 | [diff] [blame] | 117 | #ifndef _LIBCPP_HAS_NO_THREADS |
| 118 | |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 119 | _LIBCPP_BEGIN_NAMESPACE_STD |
| 120 | |
Howard Hinnant | 8331b76 | 2013-03-06 23:30:19 +0000 | [diff] [blame] | 121 | class _LIBCPP_TYPE_VIS condition_variable_any |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 122 | { |
| 123 | condition_variable __cv_; |
| 124 | shared_ptr<mutex> __mut_; |
| 125 | public: |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 126 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 127 | condition_variable_any(); |
| 128 | |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 129 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | 0fb1b0a | 2012-07-21 16:32:53 +0000 | [diff] [blame] | 130 | void notify_one() _NOEXCEPT; |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 131 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | 0fb1b0a | 2012-07-21 16:32:53 +0000 | [diff] [blame] | 132 | void notify_all() _NOEXCEPT; |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 133 | |
| 134 | template <class _Lock> |
Shoaib Meenai | 55f3a46 | 2017-03-02 03:22:18 +0000 | [diff] [blame] | 135 | _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 136 | void wait(_Lock& __lock); |
| 137 | template <class _Lock, class _Predicate> |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 138 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 139 | void wait(_Lock& __lock, _Predicate __pred); |
| 140 | |
| 141 | template <class _Lock, class _Clock, class _Duration> |
Shoaib Meenai | 55f3a46 | 2017-03-02 03:22:18 +0000 | [diff] [blame] | 142 | _LIBCPP_METHOD_TEMPLATE_IMPLICIT_INSTANTIATION_VIS |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 143 | cv_status |
| 144 | wait_until(_Lock& __lock, |
| 145 | const chrono::time_point<_Clock, _Duration>& __t); |
| 146 | |
| 147 | template <class _Lock, class _Clock, class _Duration, class _Predicate> |
| 148 | bool |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 149 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 150 | wait_until(_Lock& __lock, |
| 151 | const chrono::time_point<_Clock, _Duration>& __t, |
| 152 | _Predicate __pred); |
| 153 | |
| 154 | template <class _Lock, class _Rep, class _Period> |
| 155 | cv_status |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 156 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 157 | wait_for(_Lock& __lock, |
| 158 | const chrono::duration<_Rep, _Period>& __d); |
| 159 | |
| 160 | template <class _Lock, class _Rep, class _Period, class _Predicate> |
| 161 | bool |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 162 | _LIBCPP_INLINE_VISIBILITY |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 163 | wait_for(_Lock& __lock, |
| 164 | const chrono::duration<_Rep, _Period>& __d, |
| 165 | _Predicate __pred); |
| 166 | }; |
| 167 | |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 168 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 169 | condition_variable_any::condition_variable_any() |
| 170 | : __mut_(make_shared<mutex>()) {} |
| 171 | |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 172 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 173 | void |
Howard Hinnant | 0fb1b0a | 2012-07-21 16:32:53 +0000 | [diff] [blame] | 174 | condition_variable_any::notify_one() _NOEXCEPT |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 175 | { |
Howard Hinnant | 49e145e | 2012-10-30 19:06:59 +0000 | [diff] [blame] | 176 | {lock_guard<mutex> __lx(*__mut_);} |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 177 | __cv_.notify_one(); |
| 178 | } |
| 179 | |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 180 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 181 | void |
Howard Hinnant | 0fb1b0a | 2012-07-21 16:32:53 +0000 | [diff] [blame] | 182 | condition_variable_any::notify_all() _NOEXCEPT |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 183 | { |
Howard Hinnant | 49e145e | 2012-10-30 19:06:59 +0000 | [diff] [blame] | 184 | {lock_guard<mutex> __lx(*__mut_);} |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 185 | __cv_.notify_all(); |
| 186 | } |
| 187 | |
| 188 | struct __lock_external |
| 189 | { |
| 190 | template <class _Lock> |
| 191 | void operator()(_Lock* __m) {__m->lock();} |
| 192 | }; |
| 193 | |
| 194 | template <class _Lock> |
| 195 | void |
| 196 | condition_variable_any::wait(_Lock& __lock) |
| 197 | { |
| 198 | shared_ptr<mutex> __mut = __mut_; |
| 199 | unique_lock<mutex> __lk(*__mut); |
| 200 | __lock.unlock(); |
Howard Hinnant | 49e145e | 2012-10-30 19:06:59 +0000 | [diff] [blame] | 201 | unique_ptr<_Lock, __lock_external> __lxx(&__lock); |
| 202 | lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock); |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 203 | __cv_.wait(__lk); |
| 204 | } // __mut_.unlock(), __lock.lock() |
| 205 | |
| 206 | template <class _Lock, class _Predicate> |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 207 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 208 | void |
| 209 | condition_variable_any::wait(_Lock& __lock, _Predicate __pred) |
| 210 | { |
| 211 | while (!__pred()) |
| 212 | wait(__lock); |
| 213 | } |
| 214 | |
| 215 | template <class _Lock, class _Clock, class _Duration> |
| 216 | cv_status |
| 217 | condition_variable_any::wait_until(_Lock& __lock, |
| 218 | const chrono::time_point<_Clock, _Duration>& __t) |
| 219 | { |
| 220 | shared_ptr<mutex> __mut = __mut_; |
| 221 | unique_lock<mutex> __lk(*__mut); |
| 222 | __lock.unlock(); |
Howard Hinnant | 49e145e | 2012-10-30 19:06:59 +0000 | [diff] [blame] | 223 | unique_ptr<_Lock, __lock_external> __lxx(&__lock); |
| 224 | lock_guard<unique_lock<mutex> > __lx(__lk, adopt_lock); |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 225 | return __cv_.wait_until(__lk, __t); |
| 226 | } // __mut_.unlock(), __lock.lock() |
| 227 | |
| 228 | template <class _Lock, class _Clock, class _Duration, class _Predicate> |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 229 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 230 | bool |
| 231 | condition_variable_any::wait_until(_Lock& __lock, |
| 232 | const chrono::time_point<_Clock, _Duration>& __t, |
| 233 | _Predicate __pred) |
| 234 | { |
| 235 | while (!__pred()) |
| 236 | if (wait_until(__lock, __t) == cv_status::timeout) |
| 237 | return __pred(); |
| 238 | return true; |
| 239 | } |
| 240 | |
| 241 | template <class _Lock, class _Rep, class _Period> |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 242 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 243 | cv_status |
| 244 | condition_variable_any::wait_for(_Lock& __lock, |
| 245 | const chrono::duration<_Rep, _Period>& __d) |
| 246 | { |
Howard Hinnant | c8dbd22 | 2010-11-20 19:16:30 +0000 | [diff] [blame] | 247 | return wait_until(__lock, chrono::steady_clock::now() + __d); |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 248 | } |
| 249 | |
| 250 | template <class _Lock, class _Rep, class _Period, class _Predicate> |
Evgeniy Stepanov | 2fb1cb6 | 2015-11-07 01:22:13 +0000 | [diff] [blame] | 251 | inline |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 252 | bool |
| 253 | condition_variable_any::wait_for(_Lock& __lock, |
| 254 | const chrono::duration<_Rep, _Period>& __d, |
| 255 | _Predicate __pred) |
| 256 | { |
Howard Hinnant | c8dbd22 | 2010-11-20 19:16:30 +0000 | [diff] [blame] | 257 | return wait_until(__lock, chrono::steady_clock::now() + __d, |
Howard Hinnant | b1ad5a8 | 2011-06-30 21:18:19 +0000 | [diff] [blame] | 258 | _VSTD::move(__pred)); |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 259 | } |
| 260 | |
Howard Hinnant | 8331b76 | 2013-03-06 23:30:19 +0000 | [diff] [blame] | 261 | _LIBCPP_FUNC_VIS |
Howard Hinnant | e6a1085 | 2010-09-03 21:46:37 +0000 | [diff] [blame] | 262 | void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk); |
| 263 | |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 264 | _LIBCPP_END_NAMESPACE_STD |
| 265 | |
Jonathan Roelofs | 39cb6bf | 2014-09-05 19:45:05 +0000 | [diff] [blame] | 266 | #endif // !_LIBCPP_HAS_NO_THREADS |
| 267 | |
Howard Hinnant | c51e102 | 2010-05-11 19:42:16 +0000 | [diff] [blame] | 268 | #endif // _LIBCPP_CONDITION_VARIABLE |