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