1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_COND_VARIABLE_HPP
7 #define SIMGRID_S4U_COND_VARIABLE_HPP
10 #include <condition_variable>
13 #include <utility> // std::swap
15 #include <boost/intrusive_ptr.hpp>
19 #include <simgrid/simix.h>
20 #include <simgrid/chrono.hpp>
21 #include <simgrid/s4u/Mutex.hpp>
28 /** @brief A condition variable
31 * This is a drop-in replacement of `std::condition_variable` and should respect the same
32 * semantic. But we currently use (only) double for both durations and
35 XBT_PUBLIC_CLASS ConditionVariable {
39 ConditionVariable(smx_cond_t cond) : cond_(cond) {}
42 ConditionVariable(ConditionVariable const&) = delete;
43 ConditionVariable& operator=(ConditionVariable const&) = delete;
45 friend XBT_PUBLIC(void) intrusive_ptr_add_ref(ConditionVariable* cond);
46 friend XBT_PUBLIC(void) intrusive_ptr_release(ConditionVariable* cond);
47 using Ptr = boost::intrusive_ptr<ConditionVariable>;
49 static Ptr createConditionVariable();
51 // Wait functions without time:
53 void wait(std::unique_lock<Mutex>& lock);
55 void wait(std::unique_lock<Mutex>& lock, P pred)
61 // Wait function taking a plain double as time:
63 std::cv_status wait_until(std::unique_lock<Mutex>& lock, double timeout_time);
64 std::cv_status wait_for(std::unique_lock<Mutex>& lock, double duration);
66 bool wait_until(std::unique_lock<Mutex>& lock, double timeout_time, P pred)
69 if (this->wait_until(lock, timeout_time) == std::cv_status::timeout)
74 bool wait_for(std::unique_lock<Mutex>& lock, double duration, P pred)
76 return this->wait_until(lock, SIMIX_get_clock() + duration, std::move(pred));
79 // Wait function taking a C++ style time:
81 template<class Rep, class Period, class P>
83 std::unique_lock<Mutex>& lock, std::chrono::duration<Rep, Period> duration,
86 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
87 return this->wait_for(lock, seconds.count(), pred);
89 template<class Rep, class Period>
90 std::cv_status wait_for(
91 std::unique_lock<Mutex>& lock, std::chrono::duration<Rep, Period> duration)
93 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
94 return this->wait_for(lock, seconds.count());
96 template<class Duration>
97 std::cv_status wait_until(std::unique_lock<Mutex>& lock,
98 const SimulationTimePoint<Duration>& timeout_time)
100 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
101 return this->wait_until(lock, timeout_native.time_since_epoch().count());
103 template<class Duration, class P>
104 bool wait_until(std::unique_lock<Mutex>& lock,
105 const SimulationTimePoint<Duration>& timeout_time, P pred)
107 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
108 return this->wait_until(lock, timeout_native.time_since_epoch().count(),
117 XBT_ATTRIB_DEPRECATED("Use notify_one() instead")
118 void notify() { notify_one(); }
121 using ConditionVariablePtr = ConditionVariable::Ptr;
123 }} // namespace simgrid::s4u
125 #endif /* SIMGRID_S4U_COND_VARIABLE_HPP */