kernel/machine/hosted/SchedulerTimer.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef KERNEL_MACHINE_HOSTED_SCHEDULERTIMER_H
#define KERNEL_MACHINE_HOSTED_SCHEDULERTIMER_H
#include "pedigree/kernel/machine/IrqManager.h"
#include "pedigree/kernel/machine/SchedulerIrqHandler.h"
#include "pedigree/kernel/machine/SchedulerTimer.h"
#include "pedigree/kernel/machine/SchedulerTimerHandlerSlot.h"
#include "pedigree/kernel/processor/IoPort.h"
#include "pedigree/kernel/processor/state.h"
 
#include <config.h>
 
#include "TickSource.h"
 
class HostedSchedulerTimer : public SchedulerTimer, private SchedulerIrqHandler {
 public:
  inline static HostedSchedulerTimer& instance() {
    return m_Instance;
  }
 
  //
  // SchedulerTimer interface
  //
  virtual bool registerHandler(SchedulerTimerHandler* handler);
  uint64_t nominalQuantumNs() const override;
 
  virtual bool removeHandler(SchedulerTimerHandler* handler);
 
  bool initialise() INITIALISATION_ONLY;
  void uninitialise();
 
#if HOSTED && PEDIGREE_HOSTED_SMOKE_TESTS
  using HardContextHook = void (*)(uint64_t, InterruptState&);
 
  static EXPORTED_PUBLIC void setHardContextHookForTest(HardContextHook hook);
  static EXPORTED_PUBLIC uintptr_t sourceForTest();
  static EXPORTED_PUBLIC SchedulerTimerHandler* publishedHandlerForTest();
  static EXPORTED_PUBLIC size_t activeDispatchesForTest();
  static EXPORTED_PUBLIC bool directRoutePublishedForTest();
  static EXPORTED_PUBLIC bool queueTickForTest();
#endif
 
 protected:
  HostedSchedulerTimer() INITIALISATION_ONLY;
  virtual ~HostedSchedulerTimer();
 
 private:
  HostedSchedulerTimer(const HostedSchedulerTimer&);
  HostedSchedulerTimer& operator=(const HostedSchedulerTimer&);
 
  //
  // SchedulerIrqHandler interface
  //
  virtual void schedulerIrq(irq_id_t number, InterruptState& state);
 
  irq_id_t m_IrqId;
  HostedTickSource m_TickSource;
 
  SchedulerTimerHandlerSlot m_Handler;
 
  bool m_bInitialized;
 
#if HOSTED && PEDIGREE_HOSTED_SMOKE_TESTS
  static HardContextHook m_HardContextHook;
#endif
 
  static HostedSchedulerTimer m_Instance;
};
 
#endif