include/simgrid/s4u/ConditionVariable.hpp

   1 /* Copyright (c) 2006-2018. 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   smx_cond_t cond_;
  28
  29   explicit ConditionVariable(smx_cond_t cond) : cond_(cond) {}
  30 public:
  31   ConditionVariable(ConditionVariable const&) = delete;
  32   ConditionVariable& operator=(ConditionVariable const&) = delete;
  33
  34   friend XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariable * cond);
  35   friend XBT_PUBLIC void intrusive_ptr_release(ConditionVariable * cond);
  36
  37   static ConditionVariablePtr create();
  38
  39 #ifndef DOXYGEN
  40   /** @deprecated See Comm::get_mailbox() */
  41   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") ConditionVariablePtr createConditionVariable()
  42   {
  43     return create();
  44   }
  45 #endif
  46
  47   //  Wait functions without time:
  48
  49   void wait(MutexPtr lock);
  50   void wait(std::unique_lock<Mutex> & lock);
  51   template <class P> void wait(std::unique_lock<Mutex> & lock, P pred)
  52   {
  53     while (not pred())
  54       wait(lock);
  55   }
  56
  57   // Wait function taking a plain double as time:
  58
  59   std::cv_status wait_until(std::unique_lock<Mutex> & lock, double timeout_time);
  60   std::cv_status wait_for(std::unique_lock<Mutex> & lock, double duration);
  61   template <class P> bool wait_until(std::unique_lock<Mutex> & lock, double timeout_time, P pred)
  62   {
  63     while (not pred())
  64       if (this->wait_until(lock, timeout_time) == std::cv_status::timeout)
  65         return pred();
  66     return true;
  67   }
  68   template <class P> bool wait_for(std::unique_lock<Mutex> & lock, double duration, P pred)
  69   {
  70     return this->wait_until(lock, SIMIX_get_clock() + duration, std::move(pred));
  71   }
  72
  73   // Wait function taking a C++ style time:
  74
  75   template <class Rep, class Period, class P>
  76   bool wait_for(std::unique_lock<Mutex> & lock, std::chrono::duration<Rep, Period> duration, P pred)
  77   {
  78     auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
  79     return this->wait_for(lock, seconds.count(), pred);
  80   }
  81   template <class Rep, class Period>
  82   std::cv_status wait_for(std::unique_lock<Mutex> & lock, std::chrono::duration<Rep, Period> duration)
  83   {
  84     auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
  85     return this->wait_for(lock, seconds.count());
  86   }
  87   template <class Duration>
  88   std::cv_status wait_until(std::unique_lock<Mutex> & lock, const SimulationTimePoint<Duration>& timeout_time)
  89   {
  90     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
  91     return this->wait_until(lock, timeout_native.time_since_epoch().count());
  92   }
  93   template <class Duration, class P>
  94   bool wait_until(std::unique_lock<Mutex> & lock, const SimulationTimePoint<Duration>& timeout_time, P pred)
  95   {
  96     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
  97     return this->wait_until(lock, timeout_native.time_since_epoch().count(), std::move(pred));
  98   }
  99
 100   // Notify functions
 101
 102   void notify_one();
 103   void notify_all();
 104 };
 105
 106 }
 107 } // namespace simgrid::s4u
 108
 109 #endif