time_provider.h

// Copyright 2024 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
 
#pragma once
 
#include <stddef.h>
 
#include <mutex>
 
#include "pw_async2/dispatcher.h"
#include "pw_async2/future.h"
#include "pw_chrono/virtual_clock.h"
#include "pw_containers/intrusive_list.h"
#include "pw_sync/interrupt_spin_lock.h"
#include "pw_sync/lock_annotations.h"
#include "pw_toolchain/no_destructor.h"
 
namespace pw::async2 {
 
namespace internal {
 
// A lock which guards `TimeProvider`'s linked list.
inline pw::sync::InterruptSpinLock& time_lock() {
  static pw::sync::InterruptSpinLock lock;
  return lock;
}
 
// `Timer` objects must not outlive their `TimeProvider`.
void AssertTimeFutureObjectsAllGone(bool empty);
 
}  // namespace internal
 
 
template <typename Clock>
class TimeFuture;
 
template <typename Clock>
class TimeProvider : public chrono::VirtualClock<Clock> {
 public:
  ~TimeProvider() override {
    internal::AssertTimeFutureObjectsAllGone(futures_.empty());
  }
 
  typename Clock::time_point now() override = 0;
 
  [[nodiscard]] TimeFuture<Clock> WaitFor(typename Clock::duration delay) {
    return WaitUntil(now() + delay + typename Clock::duration(1));
  }
 
  [[nodiscard]] TimeFuture<Clock> WaitUntil(
      typename Clock::time_point timestamp) {
    return TimeFuture<Clock>(*this, timestamp);
  }
 
 protected:
  void RunExpired(typename Clock::time_point now)
      PW_LOCKS_EXCLUDED(internal::time_lock());
 
 private:
  friend class TimeFuture<Clock>;
 
  virtual void DoInvokeAt(typename Clock::time_point)
      PW_EXCLUSIVE_LOCKS_REQUIRED(internal::time_lock()) = 0;
 
  virtual void DoCancel()
      PW_EXCLUSIVE_LOCKS_REQUIRED(internal::time_lock()) = 0;
 
  // Head of the waiting timers list.
  IntrusiveList<TimeFuture<Clock>> futures_
      PW_GUARDED_BY(internal::time_lock());
};
 
template <typename Clock>
class [[nodiscard]] TimeFuture
    : public Future<TimeFuture<Clock>, typename Clock::time_point>,
      public IntrusiveForwardList<TimeFuture<Clock>>::Item {
 public:
  TimeFuture() : provider_(nullptr) {}
  TimeFuture(const TimeFuture&) = delete;
  TimeFuture& operator=(const TimeFuture&) = delete;
 
  TimeFuture(TimeFuture&& other) : provider_(nullptr) {
    *this = std::move(other);
  }
 
  TimeFuture& operator=(TimeFuture&& other) {
    std::lock_guard lock(internal::time_lock());
    UnlistLocked();
 
    provider_ = other.provider_;
    expiration_ = other.expiration_;
 
    // Replace the entry of `other_` in the list.
    if (!other.unlisted()) {
      auto previous = provider_->futures_.before_begin();
      while (&*std::next(previous) != &other) {
        previous++;
      }
 
      // NOTE: this will leave `other` reporting (falsely) that it has expired.
      // However, `other` should not be used post-`move`.
      other.unlist(&*previous);
      provider_->futures_.insert_after(previous, *this);
    }
 
    return *this;
  }
 
  ~TimeFuture() { Unlist(); }
 
  // Returns the provider associated with this timer.
  //
  // NOTE: this method must not be called before initializing the timer.
  TimeProvider<Clock>& provider() PW_NO_LOCK_SAFETY_ANALYSIS {
    // A lock is not required because this value is only mutated in
    // constructors.
    return *provider_;
  }
 
  // Returns the provider associated with this timer.
  //
  // NOTE: this method must not be called before initializing the timer.
  // NOTE: this method must not be called with other methods that modify
  // the expiration time such as `Reset`.
  typename Clock::time_point expiration() PW_NO_LOCK_SAFETY_ANALYSIS {
    // A lock is not required because this is only mutated in ``Reset`` and
    // constructors.
    return expiration_;
  }
 
 private:
  using Base = Future<TimeFuture<Clock>, typename Clock::time_point>;
  friend Base;
  friend class TimeProvider<Clock>;
 
  Poll<typename Clock::time_point> DoPend(Context& cx)
      PW_LOCKS_EXCLUDED(internal::time_lock()) {
    std::lock_guard lock(internal::time_lock());
    if (this->unlisted()) {
      return Ready(expiration_);
    }
    // NOTE: this is done under the lock in order to ensure that `provider_` is
    // not set to unlisted between it being initially read and `waker_` being
    // set.
    PW_ASYNC_STORE_WAKER(cx, waker_, "TimeFuture is waiting for a time_point");
    return Pending();
  }
 
  void DoMarkComplete() {
    std::lock_guard lock(internal::time_lock());
    provider_ = nullptr;
  }
 
  // SAFETY: It is safe to read `provider_` without holding the lock.
  bool DoIsComplete() const PW_NO_LOCK_SAFETY_ANALYSIS {
    return provider_ == nullptr;
  }
 
  TimeFuture(TimeProvider<Clock>& provider,
             typename Clock::time_point expiration)
      : waker_(), provider_(&provider), expiration_(expiration) {
    std::lock_guard lock(internal::time_lock());
    EnlistLocked();
  }
 
  void EnlistLocked() PW_EXCLUSIVE_LOCKS_REQUIRED(internal::time_lock()) {
    // Skip enlisting if the expiration of the timer is in the past.
    // NOTE: this *does not* trigger a waker since `Poll` has not yet been
    // invoked, so none has been registered.
    if (provider_->now() >= expiration_) {
      return;
    }
 
    if (provider_->futures_.empty() ||
        provider_->futures_.front().expiration_ > expiration_) {
      provider_->futures_.push_front(*this);
      provider_->DoInvokeAt(expiration_);
      return;
    }
    auto current = provider_->futures_.begin();
    while (std::next(current) != provider_->futures_.end() &&
           std::next(current)->expiration_ < expiration_) {
      current++;
    }
    provider_->futures_.insert_after(current, *this);
  }
 
  void Unlist() PW_LOCKS_EXCLUDED(internal::time_lock()) {
    std::lock_guard lock(internal::time_lock());
    UnlistLocked();
  }
 
  // Removes this timer from the `TimeProvider`'s list (if listed).
  //
  // If this timer was previously the `head` element of the `TimeProvider`'s
  // list, the `TimeProvider` will be rescheduled to wake up based on the
  // new `head`'s expiration time.
  void UnlistLocked() PW_EXCLUSIVE_LOCKS_REQUIRED(internal::time_lock()) {
    if (this->unlisted()) {
      return;
    }
    if (&provider_->futures_.front() == this) {
      provider_->futures_.pop_front();
      if (provider_->futures_.empty()) {
        provider_->DoCancel();
      } else {
        provider_->DoInvokeAt(provider_->futures_.front().expiration_);
      }
      return;
    }
 
    provider_->futures_.remove(*this);
  }
 
  Waker waker_;
  // NOTE: the lock is only required when
  //  (1) modifying these fields or
  //  (2) reading these fields via the TimeProvider.
  //
  // Reading these fields when nonmodification is guaranteed (such as in an
  // accessor like ``provider`` or ``expiration`` above) does not require
  // holding the lock.
  TimeProvider<Clock>* provider_ PW_GUARDED_BY(internal::time_lock());
  typename Clock::time_point expiration_ PW_GUARDED_BY(internal::time_lock());
};
 
template <typename Clock>
void TimeProvider<Clock>::RunExpired(typename Clock::time_point now) {
  std::lock_guard lock(internal::time_lock());
  while (!futures_.empty()) {
    if (futures_.front().expiration_ > now) {
      DoInvokeAt(futures_.front().expiration_);
      return;
    }
    std::move(futures_.front().waker_).Wake();
    futures_.pop_front();
  }
}
 
 
}  // namespace pw::async2