1 /* Copyright (c) 2006-2021. 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
9 #include <simgrid/forward.h>
11 #include <simgrid/chrono.hpp>
12 #include <simgrid/s4u/Mutex.hpp>
21 * SimGrid's condition variables are meant to be drop-in replacements of ``std::condition_variable``.
22 * Please refer to the `documentation of standard C++ <https://en.cppreference.com/w/cpp/thread/condition_variable>`_
23 * for more information on condition variables. A SimGrid example is available in Section :ref:`s4u_ex_IPC`.
26 class XBT_PUBLIC ConditionVariable {
28 friend kernel::activity::ConditionVariableImpl;
29 friend void kernel::activity::intrusive_ptr_release(kernel::activity::ConditionVariableImpl* cond);
31 kernel::activity::ConditionVariableImpl* const pimpl_;
33 explicit ConditionVariable(kernel::activity::ConditionVariableImpl* cond) : pimpl_(cond) {}
34 ~ConditionVariable() = default;
36 ConditionVariable(ConditionVariable const&) = delete;
37 ConditionVariable& operator=(ConditionVariable const&) = delete;
39 friend XBT_PUBLIC void intrusive_ptr_add_ref(const ConditionVariable* cond);
40 friend XBT_PUBLIC void intrusive_ptr_release(const ConditionVariable* cond);
44 /** Create a new condition variable and return a smart pointer
47 * You should only manipulate :cpp:type:`simgrid::s4u::ConditionVariablePtr`, as created by this function (see also :ref:`s4u_raii`).
50 static ConditionVariablePtr create();
52 /// Wait until notification, with no timeout
53 void wait(s4u::MutexPtr lock);
54 /// Wait until notification, with no timeout
55 void wait(const std::unique_lock<s4u::Mutex>& lock);
56 template <class P> void wait(const std::unique_lock<Mutex>& lock, P pred)
62 /// Wait until the given instant (specified as a plain double)
63 std::cv_status wait_until(const std::unique_lock<s4u::Mutex>& lock, double timeout_time);
64 /// Wait for the given amount of seconds (specified as a plain double)
65 std::cv_status wait_for(const std::unique_lock<s4u::Mutex>& lock, double duration);
66 /// Wait until predicate is true, or the given instant (specified as a plain double)
67 template <class P> bool wait_until(const std::unique_lock<s4u::Mutex>& lock, double timeout_time, P pred)
70 if (this->wait_until(lock, timeout_time) == std::cv_status::timeout)
74 /// As long as the predicate is false, wait for the given amount of seconds (specified as a plain double)
75 template <class P> bool wait_for(const std::unique_lock<s4u::Mutex>& lock, double duration, P pred)
77 return this->wait_until(lock, SIMIX_get_clock() + duration, std::move(pred));
80 // Wait function taking a C++ style time:
82 /// As long as the predicate is false, wait for the given amount of seconds (specified in C++ style)
83 template <class Rep, class Period, class P>
84 bool wait_for(const std::unique_lock<s4u::Mutex>& lock, std::chrono::duration<Rep, Period> duration, P pred)
86 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
87 return this->wait_for(lock, seconds.count(), pred);
89 /// Wait for the given amount of seconds (specified in C++ style)
90 template <class Rep, class Period>
91 std::cv_status wait_for(const std::unique_lock<s4u::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 /** Wait until the given instant (specified in C++ style) */
97 template <class Duration>
98 std::cv_status wait_until(const std::unique_lock<s4u::Mutex>& lock, 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 /** Wait until predicate is true, or the given instant (specified in C++ style) */
104 template <class Duration, class P>
105 bool wait_until(const std::unique_lock<s4u::Mutex>& lock, 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(), std::move(pred));
111 /** Unblock one actor blocked on that condition variable. If none was blocked, nothing happens. */
113 /** Unblock all actors blocked on that condition variable. If none was blocked, nothing happens. */
118 } // namespace simgrid