gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
gem5::RubyTester Class Reference

#include <RubyTester.hh>

Inheritance diagram for gem5::RubyTester:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  CpuPort
 
struct  SenderState
 

Public Types

typedef RubyTesterParams Params
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 RubyTester (const Params &p)
 
 ~RubyTester ()
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
bool isInstOnlyCpuPort (int idx)
 
bool isInstDataCpuPort (int idx)
 
RequestPortgetReadableCpuPort (int idx)
 
RequestPortgetWritableCpuPort (int idx)
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void wakeup ()
 
void incrementCheckCompletions ()
 
void printStats (std::ostream &out) const
 
void clearStats ()
 
void printConfig (std::ostream &out) const
 
void print (std::ostream &out) const
 
bool getCheckFlush ()
 
RequestorID requestorId ()
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::EventManager
EventQueueeventQueue () const
 
void schedule (Event &event, Tick when)
 
void deschedule (Event &event)
 
void reschedule (Event &event, Tick when, bool always=false)
 
void schedule (Event *event, Tick when)
 
void deschedule (Event *event)
 
void reschedule (Event *event, Tick when, bool always=false)
 
void wakeupEventQueue (Tick when=(Tick) -1)
 This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from gem5::Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from gem5::Drainable
DrainState drainState () const
 Return the current drain state of an object. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Protected Attributes

EventFunctionWrapper checkStartEvent
 
RequestorID _requestorId
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Member Functions

void hitCallback (ruby::NodeID proc, ruby::SubBlock *data)
 
void checkForDeadlock ()
 
 RubyTester (const RubyTester &obj)
 
RubyTesteroperator= (const RubyTester &obj)
 

Private Attributes

CheckTablem_checkTable_ptr
 
std::vector< Cyclesm_last_progress_vector
 
int m_num_cpus
 
uint64_t m_checks_completed
 
std::vector< RequestPort * > writePorts
 
std::vector< RequestPort * > readPorts
 
uint64_t m_checks_to_complete
 
int m_deadlock_threshold
 
int m_num_writers
 
int m_num_readers
 
int m_wakeup_frequency
 
bool m_check_flush
 
int m_num_inst_only_ports
 
int m_num_inst_data_ports
 

Additional Inherited Members

- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 
- Protected Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 

Detailed Description

Definition at line 60 of file RubyTester.hh.

Member Typedef Documentation

◆ Params

typedef RubyTesterParams gem5::RubyTester::Params

Definition at line 97 of file RubyTester.hh.

Constructor & Destructor Documentation

◆ RubyTester() [1/2]

gem5::RubyTester::RubyTester ( const Params p)

Definition at line 55 of file RubyTester.cc.

References wakeup().

◆ ~RubyTester()

gem5::RubyTester::~RubyTester ( )

Definition at line 109 of file RubyTester.cc.

References gem5::ArmISA::i, m_checkTable_ptr, and readPorts.

◆ RubyTester() [2/2]

gem5::RubyTester::RubyTester ( const RubyTester obj)
private

Member Function Documentation

◆ checkForDeadlock()

void gem5::RubyTester::checkForDeadlock ( )
private

Definition at line 264 of file RubyTester.cc.

References gem5::Clocked::curCycle(), m_deadlock_threshold, m_last_progress_vector, and panic.

Referenced by wakeup().

◆ clearStats()

void gem5::RubyTester::clearStats ( )
inline

Definition at line 117 of file RubyTester.hh.

◆ getCheckFlush()

bool gem5::RubyTester::getCheckFlush ( )
inline

Definition at line 121 of file RubyTester.hh.

References m_check_flush.

Referenced by gem5::Check::initiate().

◆ getPort()

Port & gem5::RubyTester::getPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
overridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters
if_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 135 of file RubyTester.cc.

References gem5::SimObject::getPort(), m_num_inst_data_ports, m_num_inst_only_ports, panic, and readPorts.

◆ getReadableCpuPort()

RequestPort * gem5::RubyTester::getReadableCpuPort ( int  idx)

Definition at line 210 of file RubyTester.cc.

References readPorts.

Referenced by gem5::Check::initiateCheck(), and gem5::Check::initiatePrefetch().

◆ getWritableCpuPort()

RequestPort * gem5::RubyTester::getWritableCpuPort ( int  idx)

Definition at line 218 of file RubyTester.cc.

References writePorts.

Referenced by gem5::Check::initiateAction(), and gem5::Check::initiateFlush().

◆ hitCallback()

void gem5::RubyTester::hitCallback ( ruby::NodeID  proc,
ruby::SubBlock data 
)
private

◆ incrementCheckCompletions()

void gem5::RubyTester::incrementCheckCompletions ( )
inline

Definition at line 114 of file RubyTester.hh.

References m_checks_completed.

Referenced by gem5::Check::performCallback().

◆ init()

void gem5::RubyTester::init ( )
overridevirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Definition at line 118 of file RubyTester.cc.

References gem5::ArmISA::i, m_checkTable_ptr, m_last_progress_vector, m_num_cpus, m_num_readers, m_num_writers, readPorts, and writePorts.

◆ isInstDataCpuPort()

bool gem5::RubyTester::isInstDataCpuPort ( int  idx)

◆ isInstOnlyCpuPort()

bool gem5::RubyTester::isInstOnlyCpuPort ( int  idx)

Definition at line 197 of file RubyTester.cc.

References m_num_inst_only_ports.

Referenced by gem5::Check::initiateCheck(), and gem5::Check::initiatePrefetch().

◆ operator=()

RubyTester& gem5::RubyTester::operator= ( const RubyTester obj)
private

◆ print()

void gem5::RubyTester::print ( std::ostream &  out) const

Definition at line 280 of file RubyTester.cc.

Referenced by gem5::operator<<().

◆ printConfig()

void gem5::RubyTester::printConfig ( std::ostream &  out) const
inline

Definition at line 118 of file RubyTester.hh.

◆ printStats()

void gem5::RubyTester::printStats ( std::ostream &  out) const
inline

Definition at line 116 of file RubyTester.hh.

◆ requestorId()

RequestorID gem5::RubyTester::requestorId ( )
inline

◆ wakeup()

void gem5::RubyTester::wakeup ( )

Member Data Documentation

◆ _requestorId

RequestorID gem5::RubyTester::_requestorId
protected

Definition at line 127 of file RubyTester.hh.

Referenced by requestorId().

◆ checkStartEvent

EventFunctionWrapper gem5::RubyTester::checkStartEvent
protected

Definition at line 125 of file RubyTester.hh.

Referenced by wakeup().

◆ m_check_flush

bool gem5::RubyTester::m_check_flush
private

Definition at line 150 of file RubyTester.hh.

Referenced by getCheckFlush().

◆ m_checks_completed

uint64_t gem5::RubyTester::m_checks_completed
private

Definition at line 142 of file RubyTester.hh.

Referenced by incrementCheckCompletions(), and wakeup().

◆ m_checks_to_complete

uint64_t gem5::RubyTester::m_checks_to_complete
private

Definition at line 145 of file RubyTester.hh.

Referenced by wakeup().

◆ m_checkTable_ptr

CheckTable* gem5::RubyTester::m_checkTable_ptr
private

Definition at line 138 of file RubyTester.hh.

Referenced by hitCallback(), init(), wakeup(), and ~RubyTester().

◆ m_deadlock_threshold

int gem5::RubyTester::m_deadlock_threshold
private

Definition at line 146 of file RubyTester.hh.

Referenced by checkForDeadlock().

◆ m_last_progress_vector

std::vector<Cycles> gem5::RubyTester::m_last_progress_vector
private

Definition at line 139 of file RubyTester.hh.

Referenced by checkForDeadlock(), hitCallback(), and init().

◆ m_num_cpus

int gem5::RubyTester::m_num_cpus
private

Definition at line 141 of file RubyTester.hh.

Referenced by init().

◆ m_num_inst_data_ports

int gem5::RubyTester::m_num_inst_data_ports
private

Definition at line 152 of file RubyTester.hh.

Referenced by getPort(), and isInstDataCpuPort().

◆ m_num_inst_only_ports

int gem5::RubyTester::m_num_inst_only_ports
private

Definition at line 151 of file RubyTester.hh.

Referenced by getPort(), isInstDataCpuPort(), and isInstOnlyCpuPort().

◆ m_num_readers

int gem5::RubyTester::m_num_readers
private

Definition at line 148 of file RubyTester.hh.

Referenced by init().

◆ m_num_writers

int gem5::RubyTester::m_num_writers
private

Definition at line 147 of file RubyTester.hh.

Referenced by init().

◆ m_wakeup_frequency

int gem5::RubyTester::m_wakeup_frequency
private

Definition at line 149 of file RubyTester.hh.

Referenced by wakeup().

◆ readPorts

std::vector<RequestPort*> gem5::RubyTester::readPorts
private

Definition at line 144 of file RubyTester.hh.

Referenced by getPort(), getReadableCpuPort(), init(), and ~RubyTester().

◆ writePorts

std::vector<RequestPort*> gem5::RubyTester::writePorts
private

Definition at line 143 of file RubyTester.hh.

Referenced by getWritableCpuPort(), and init().


The documentation for this class was generated from the following files:

Generated on Tue Sep 21 2021 12:28:05 for gem5 by doxygen 1.8.17