X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/198b09ec16ca1b8fc05053bcae9e75c0ad689711..0f85c75558b648a231f53f4dba18cc6788858b10:/include/simgrid/s4u/conditionVariable.hpp

diff --git a/include/simgrid/s4u/conditionVariable.hpp b/include/simgrid/s4u/conditionVariable.hpp
index f2790166a2..2db6fb8f9d 100644
--- a/include/simgrid/s4u/conditionVariable.hpp
+++ b/include/simgrid/s4u/conditionVariable.hpp
@@ -6,8 +6,16 @@
 #ifndef SIMGRID_S4U_COND_VARIABLE_HPP
 #define SIMGRID_S4U_COND_VARIABLE_HPP
 
+#include <chrono>
+#include <condition_variable>
+#include <future>
+#include <mutex>
 #include <utility> // std::swap
 
+#include <boost/intrusive_ptr.hpp>
+
+#include <xbt/base.h>
+
 #include <simgrid/simix.h>
 #include <simgrid/s4u/mutex.hpp>
 
@@ -16,52 +24,95 @@ namespace s4u {
 
 class Mutex;
 
+/** A condition variable
+ *
+ *  This is based on std::condition_variable and should respect the same
+ *  semantic. But we currently use (only) double for both durations and
+ *  timestamp timeouts.
+ */
 XBT_PUBLIC_CLASS ConditionVariable {
-  
+private:
+  friend s_smx_cond;
+  smx_cond_t cond_;
+  ConditionVariable(smx_cond_t cond) : cond_(cond) {}
 public:
-  ConditionVariable();
 
-  ConditionVariable(ConditionVariable* cond) : cond_(SIMIX_cond_ref(cond->cond_)) {}
-  ~ConditionVariable();
+  ConditionVariable(ConditionVariable const&) = delete;
+  ConditionVariable& operator=(ConditionVariable const&) = delete;
+
+  friend XBT_PUBLIC(void) intrusive_ptr_add_ref(ConditionVariable* cond);
+  friend XBT_PUBLIC(void) intrusive_ptr_release(ConditionVariable* cond);
+  using Ptr = boost::intrusive_ptr<ConditionVariable>;
+
+  static Ptr createConditionVariable();
+
+  //  Wait functions:
+
+  void wait(std::unique_lock<Mutex>& lock);
+  std::cv_status wait_until(std::unique_lock<Mutex>& lock, double timeout_time);
+  std::cv_status wait_for(std::unique_lock<Mutex>& lock, double duration);
+
+  /** Wait for a given duraiton
+   *
+   *  This version gives us the ability to do (in C++):
+   *
+   *  <code>
+   *  using namespace std::literals::chrono_literals;
+   *
+   *  cond->wait_for(lock, 1ms);
+   *  cond->wait_for(lock, 1s);
+   *  cond->wait_for(lock, 1min);
+   *  cond->wait_for(lock, 1h);
+   *  </code>
+   */
+  template<class Rep, class Period>
+  std::cv_status wait_for(std::unique_lock<Mutex>& lock, std::chrono::duration<Rep, Period> duration)
+  {
+    typedef std::chrono::duration<double> SecondsDouble;
+    auto seconds = std::chrono::duration_cast<SecondsDouble>(duration);
+    return this->wait_for(lock, duration.count());
+  }
+
+  // Variants which takes a predicate:
 
-  // Copy+move (with the copy-and-swap idiom):
-  ConditionVariable(ConditionVariable const& cond) : cond_(SIMIX_cond_ref(cond.cond_)) {}
-  friend void swap(ConditionVariable& first, ConditionVariable& second)
+  template<class P>
+  void wait(std::unique_lock<Mutex>& lock, P pred)
   {
-    using std::swap;
-    swap(first.cond_, second.cond_);
+    while (!pred())
+      wait(lock);
   }
-  ConditionVariable& operator=(ConditionVariable cond)
+  template<class P>
+  bool wait_until(std::unique_lock<Mutex>& lock, double timeout_time, P pred)
   {
-    swap(*this, cond);
-    return *this;
+    while (!pred())
+      if (this->wait_until(lock, timeout_time) == std::cv_status::timeout)
+        return pred();
+    return true;
   }
-  ConditionVariable(ConditionVariable&& cond) : cond_(nullptr)
+  template<class P>
+  bool wait_for(std::unique_lock<Mutex>& lock, double duration, P pred)
   {
-    swap(*this, cond);
+    return this->wait_until(lock, SIMIX_get_clock() + duration, std::move(pred));
   }
-
-  bool valid() const
+  template<class Rep, class Period, class P>
+  bool wait_for(std::unique_lock<Mutex>& lock, std::chrono::duration<Rep, Period> duration, P pred)
   {
-    return cond_ != nullptr;
+    typedef std::chrono::duration<double> SecondsDouble;
+    auto seconds = std::chrono::duration_cast<SecondsDouble>(duration);
+    return this->wait_for(lock, seconds.count(), pred);
   }
-  
-  /**
-  * Wait functions
-  */
-  void wait(Mutex *mutex);
-  void wait_for(Mutex *mutex, double time);
-
-  /**
-  * Notify functions
-  */
-  void notify();
-  void notify_all();
 
-private:
-  smx_cond_t cond_;
+  // Notify functions
+
+  void notify_one();
+  void notify_all();
 
+  XBT_ATTRIB_DEPRECATED("Use notify_one() instead")
+  void notify() { notify_one(); }
 };
+
+using ConditionVariablePtr = ConditionVariable::Ptr;
+
 }} // namespace simgrid::s4u
 
 #endif /* SIMGRID_S4U_COND_VARIABLE_HPP */