condition_variable.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Hamburg University of Applied Sciences (HAW)
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

 
#ifndef RIOT_CONDITION_VARIABLE_HPP
#define RIOT_CONDITION_VARIABLE_HPP
 
#include "sched.h"
#include "ztimer64.h"
#include "priority_queue.h"
 
#include "riot/mutex.hpp"
#include "riot/chrono.hpp"
 
namespace riot {

enum class cv_status {
  no_timeout,
  timeout
};

class condition_variable {
public:
  using native_handle_type = priority_queue_t*;
  inline condition_variable() { m_queue.first = NULL; }
  ~condition_variable();

  void notify_one() noexcept;
  void notify_all() noexcept;

  void wait(unique_lock<mutex>& lock) noexcept;
  template <class Predicate>
  void wait(unique_lock<mutex>& lock, Predicate pred);
  cv_status wait_until(unique_lock<mutex>& lock,
                       const time_point& timeout_time);
  template <class Predicate>
  bool wait_until(unique_lock<mutex>& lock, const time_point& timeout_time,
                  Predicate pred);

  template <class Rep, class Period>
  cv_status wait_for(unique_lock<mutex>& lock,
                     const std::chrono::duration<Rep, Period>& rel_time);
  template <class Rep, class Period, class Predicate>
  bool wait_for(unique_lock<mutex>& lock,
                const std::chrono::duration<Rep, Period>& rel_time,
                Predicate pred);

  inline native_handle_type native_handle() { return &m_queue; }
 
private:
  condition_variable(const condition_variable&);
  condition_variable& operator=(const condition_variable&);
 
  priority_queue_t m_queue;
};
 
template <class Predicate>
void condition_variable::wait(unique_lock<mutex>& lock, Predicate pred) {
  while (!pred()) {
    wait(lock);
  }
}
 
template <class Predicate>
bool condition_variable::wait_until(unique_lock<mutex>& lock,
                                    const time_point& timeout_time,
                                    Predicate pred) {
  while (!pred()) {
    if (wait_until(lock, timeout_time) == cv_status::timeout) {
      return pred();
    }
  }
  return true;
}
 
template <class Rep, class Period>
cv_status condition_variable::wait_for(unique_lock<mutex>& lock,
                                       const std::chrono::duration
                                       <Rep, Period>& timeout_duration) {
  using namespace std::chrono;
  using std::chrono::duration;
  if (timeout_duration <= timeout_duration.zero()) {
    return cv_status::timeout;
  }
  uint64_t timeout, before, after;
  timeout = (duration_cast<microseconds>(timeout_duration)).count();
  before = ztimer64_now(ZTIMER64_USEC);
  ztimer64_t timer;
  ztimer64_set_wakeup(ZTIMER64_USEC, &timer, timeout, thread_getpid());
  wait(lock);
  after = ztimer64_now(ZTIMER64_USEC);
  ztimer64_remove(ZTIMER64_USEC, &timer);
  if (after - before >= timeout) {
    return cv_status::timeout;
  }
  return cv_status::no_timeout;
}
 
template <class Rep, class Period, class Predicate>
inline bool condition_variable::wait_for(unique_lock<mutex>& lock,
                                         const std::chrono::duration
                                         <Rep, Period>& timeout_duration,
                                         Predicate pred) {
  return wait_until(lock, std::chrono::steady_clock::now() + timeout_duration,
                    std::move(pred));
}
 
} // namespace riot
 
#endif // RIOT_CONDITION_VARIABLE_HPP