scheduler_base.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
#include "task_control_block.hpp"
 
class SchedulerBase {
 public:
  const char* name{"Unnamed Scheduler"};
 
  struct Stats {
    size_t total_enqueues{0};
    size_t total_dequeues{0};
    size_t total_picks{0};
    size_t total_preemptions{0};
  };
 
  virtual auto Enqueue(TaskControlBlock* task) -> void = 0;
 
  virtual auto Dequeue(TaskControlBlock* task) -> void = 0;
 
  [[nodiscard]] virtual auto PickNext() -> TaskControlBlock* = 0;
 
  [[nodiscard]] virtual auto GetQueueSize() const -> size_t = 0;
 
  [[nodiscard]] virtual auto IsEmpty() const -> bool = 0;
 
  [[nodiscard]] virtual auto OnTick([[maybe_unused]] TaskControlBlock* current)
      -> bool {
    return false;
  }
 
  [[nodiscard]] virtual auto OnTimeSliceExpired(
      [[maybe_unused]] TaskControlBlock* task) -> bool {
    return true;
  }
 
  virtual auto BoostPriority([[maybe_unused]] TaskControlBlock* task,
                             [[maybe_unused]] int new_priority) -> void {}
 
  virtual auto RestorePriority([[maybe_unused]] TaskControlBlock* task)
      -> void {}
 
  virtual auto OnPreempted([[maybe_unused]] TaskControlBlock* task) -> void {}
 
  virtual auto OnScheduled([[maybe_unused]] TaskControlBlock* task) -> void {}
 
  [[nodiscard]] virtual auto GetStats() const -> const Stats& { return stats_; }
 
  virtual auto ResetStats() -> void { stats_ = {}; }
 
  SchedulerBase() = default;
  SchedulerBase(const SchedulerBase&) = default;
  SchedulerBase(SchedulerBase&&) = default;
  auto operator=(const SchedulerBase&) -> SchedulerBase& = default;
  auto operator=(SchedulerBase&&) -> SchedulerBase& = default;
  virtual ~SchedulerBase() = default;
 
 protected:
  Stats stats_{};
};