include/simgrid/s4u/ConditionVariable.hpp

   1 /* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #ifndef SIMGRID_S4U_COND_VARIABLE_HPP
   7 #define SIMGRID_S4U_COND_VARIABLE_HPP
   8
   9 #include <simgrid/chrono.hpp>
  10 #include <simgrid/s4u/Mutex.hpp>
  11
  12 #include <future>
  13
  14 namespace simgrid {
  15 namespace s4u {
  16
  17 /** @brief A condition variable
  18  *  @ingroup s4u_api
  19  *
  20  *  This is a drop-in replacement of `std::condition_variable` and should respect the same
  21  *  semantic. But we currently use (only) double for both durations and
  22  *  timestamp timeouts.
  23  */
  24 class XBT_PUBLIC ConditionVariable {
  25 private:
  26   friend simgrid::kernel::activity::ConditionVariableImpl;
  27   simgrid::kernel::activity::ConditionVariableImpl* const cond_;
  28
  29   explicit ConditionVariable(simgrid::kernel::activity::ConditionVariableImpl* cond) : cond_(cond) {}
  30
  31 public:
  32   ConditionVariable(ConditionVariable const&) = delete;
  33   ConditionVariable& operator=(ConditionVariable const&) = delete;
  34
  35   friend XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariable * cond);
  36   friend XBT_PUBLIC void intrusive_ptr_release(ConditionVariable * cond);
  37
  38   static ConditionVariablePtr create();
  39
  40 #ifndef DOXYGEN
  41   /** @deprecated See Comm::get_mailbox() */
  42   XBT_ATTRIB_DEPRECATED_v323("Please use ConditionVariableImpl::create()") ConditionVariablePtr
  43       createConditionVariable()
  44   {
  45     return create();
  46   }
  47 #endif
  48
  49   //  Wait functions without time:
  50
  51   void wait(MutexPtr lock);
  52   void wait(std::unique_lock<Mutex> & lock);
  53   template <class P> void wait(std::unique_lock<Mutex> & lock, P pred)
  54   {
  55     while (not pred())
  56       wait(lock);
  57   }
  58
  59   // Wait function taking a plain double as time:
  60
  61   std::cv_status wait_until(std::unique_lock<Mutex> & lock, double timeout_time);
  62   std::cv_status wait_for(std::unique_lock<Mutex> & lock, double duration);
  63   template <class P> bool wait_until(std::unique_lock<Mutex> & lock, double timeout_time, P pred)
  64   {
  65     while (not pred())
  66       if (this->wait_until(lock, timeout_time) == std::cv_status::timeout)
  67         return pred();
  68     return true;
  69   }
  70   template <class P> bool wait_for(std::unique_lock<Mutex> & lock, double duration, P pred)
  71   {
  72     return this->wait_until(lock, SIMIX_get_clock() + duration, std::move(pred));
  73   }
  74
  75   // Wait function taking a C++ style time:
  76
  77   template <class Rep, class Period, class P>
  78   bool wait_for(std::unique_lock<Mutex> & lock, std::chrono::duration<Rep, Period> duration, P pred)
  79   {
  80     auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
  81     return this->wait_for(lock, seconds.count(), pred);
  82   }
  83   template <class Rep, class Period>
  84   std::cv_status wait_for(std::unique_lock<Mutex> & lock, std::chrono::duration<Rep, Period> duration)
  85   {
  86     auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
  87     return this->wait_for(lock, seconds.count());
  88   }
  89   template <class Duration>
  90   std::cv_status wait_until(std::unique_lock<Mutex> & lock, const SimulationTimePoint<Duration>& timeout_time)
  91   {
  92     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
  93     return this->wait_until(lock, timeout_native.time_since_epoch().count());
  94   }
  95   template <class Duration, class P>
  96   bool wait_until(std::unique_lock<Mutex> & lock, const SimulationTimePoint<Duration>& timeout_time, P pred)
  97   {
  98     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
  99     return this->wait_until(lock, timeout_native.time_since_epoch().count(), std::move(pred));
 100   }
 101
 102   // Notify functions
 103
 104   void notify_one();
 105   void notify_all();
 106 };
 107
 108 }
 109 } // namespace simgrid::s4u
 110
 111 #endif