event-interface.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "virtutech-c++" -*-
 
/*
  © 2023 Intel Corporation
 
  This software and the related documents are Intel copyrighted materials, and
  your use of them is governed by the express license under which they were
  provided to you ("License"). Unless the License provides otherwise, you may
  not use, modify, copy, publish, distribute, disclose or transmit this software
  or the related documents without Intel's prior written permission.
 
  This software and the related documents are provided as is, with no express or
  implied warranties, other than those that are expressly stated in the License.
*/
 
#ifndef SIMICS_EVENT_INTERFACE_H
#define SIMICS_EVENT_INTERFACE_H
 
#include <simics/base/event.h>  // pc_step_t
#include <simics/base/time.h>  // cycles_t
 
#include <type_traits>  // add_pointer_t
 
namespace simics {
 
class EventInterface {
  public:
    virtual ~EventInterface() = default;
    virtual void callback(void *data) = 0;
    virtual void destroy(void *data) = 0;
    virtual attr_value_t get_value(void *data) = 0;
    virtual void *set_value(attr_value_t value) = 0;
    virtual char *describe(void *data) const = 0;
};
 
class TimeEventInterface {
  public:
    virtual ~TimeEventInterface() = default;
    virtual void remove(void *match_data) const = 0;
    virtual bool posted(void *match_data) const = 0;
    virtual double next(void *data) const = 0;
    virtual void post(double seconds, void *data) = 0;
};
 
class CycleEventInterface {
  public:
    virtual ~CycleEventInterface() = default;
    virtual void remove(void *match_data) const = 0;
    virtual bool posted(void *match_data) const = 0;
    virtual cycles_t next(void *match_data) const = 0;
    virtual void post(cycles_t cycles, void *data) = 0;
};
 
class StepEventInterface {
  public:
    virtual ~StepEventInterface() = default;
    virtual void remove(void *match_data) const = 0;
    virtual bool posted(void *match_data) const = 0;
    virtual pc_step_t next(void *match_data) const = 0;
    virtual void post(pc_step_t steps, void *data) = 0;
};
 
}  // namespace simics
 
#endif