gem5  v20.1.0.0
Classes | Public Types | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
RubyDirectedTester Class Reference

#include <RubyDirectedTester.hh>

Inheritance diagram for RubyDirectedTester:
ClockedObject SimObject Clocked EventManager Serializable Drainable Stats::Group

Classes

class  CpuPort
 

Public Types

typedef RubyDirectedTesterParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 RubyDirectedTester (const Params *p)
 
 ~RubyDirectedTester ()
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
RequestPortgetCpuPort (int idx)
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void wakeup ()
 
void incrementCycleCompletions ()
 
void printStats (std::ostream &out) const
 
void clearStats ()
 
void printConfig (std::ostream &out) const
 
void print (std::ostream &out) const
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 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 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 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 Stats::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 (Stats::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...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from 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 directedStartEvent
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Member Functions

void hitCallback (NodeID proc, Addr addr)
 
void checkForDeadlock ()
 
 RubyDirectedTester (const RubyDirectedTester &obj)
 
RubyDirectedTesteroperator= (const RubyDirectedTester &obj)
 

Private Attributes

uint64_t m_requests_completed
 
std::vector< RequestPort * > ports
 
uint64_t m_requests_to_complete
 
DirectedGeneratorgenerator
 

Additional Inherited Members

- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Public Attributes inherited from ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from 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 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 47 of file RubyDirectedTester.hh.

Member Typedef Documentation

◆ Params

typedef RubyDirectedTesterParams RubyDirectedTester::Params

Definition at line 67 of file RubyDirectedTester.hh.

Constructor & Destructor Documentation

◆ RubyDirectedTester() [1/2]

RubyDirectedTester::RubyDirectedTester ( const Params p)

Definition at line 49 of file RubyDirectedTester.cc.

References wakeup().

◆ ~RubyDirectedTester()

RubyDirectedTester::~RubyDirectedTester ( )

Definition at line 68 of file RubyDirectedTester.cc.

References ArmISA::i, and ports.

◆ RubyDirectedTester() [2/2]

RubyDirectedTester::RubyDirectedTester ( const RubyDirectedTester obj)
private

Member Function Documentation

◆ checkForDeadlock()

void RubyDirectedTester::checkForDeadlock ( )
private

◆ clearStats()

void RubyDirectedTester::clearStats ( )
inline

Definition at line 83 of file RubyDirectedTester.hh.

◆ getCpuPort()

RequestPort * RubyDirectedTester::getCpuPort ( int  idx)

Definition at line 109 of file RubyDirectedTester.cc.

References ports.

Referenced by InvalidateGenerator::initiate(), and SeriesRequestGenerator::initiate().

◆ getPort()

Port & RubyDirectedTester::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 SimObject.

Definition at line 82 of file RubyDirectedTester.cc.

References SimObject::getPort(), panic, and ports.

◆ hitCallback()

void RubyDirectedTester::hitCallback ( NodeID  proc,
Addr  addr 
)
private

◆ incrementCycleCompletions()

void RubyDirectedTester::incrementCycleCompletions ( )
inline

◆ init()

void RubyDirectedTester::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 SimObject.

Definition at line 75 of file RubyDirectedTester.cc.

References generator, ports, and DirectedGenerator::setDirectedTester().

◆ operator=()

RubyDirectedTester& RubyDirectedTester::operator= ( const RubyDirectedTester obj)
private

◆ print()

void RubyDirectedTester::print ( std::ostream &  out) const

◆ printConfig()

void RubyDirectedTester::printConfig ( std::ostream &  out) const
inline

Definition at line 84 of file RubyDirectedTester.hh.

◆ printStats()

void RubyDirectedTester::printStats ( std::ostream &  out) const
inline

Definition at line 82 of file RubyDirectedTester.hh.

◆ wakeup()

void RubyDirectedTester::wakeup ( )

Member Data Documentation

◆ directedStartEvent

EventFunctionWrapper RubyDirectedTester::directedStartEvent
protected

Definition at line 89 of file RubyDirectedTester.hh.

Referenced by hitCallback(), and wakeup().

◆ generator

DirectedGenerator* RubyDirectedTester::generator
private

Definition at line 103 of file RubyDirectedTester.hh.

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

◆ m_requests_completed

uint64_t RubyDirectedTester::m_requests_completed
private

Definition at line 100 of file RubyDirectedTester.hh.

Referenced by incrementCycleCompletions(), and wakeup().

◆ m_requests_to_complete

uint64_t RubyDirectedTester::m_requests_to_complete
private

Definition at line 102 of file RubyDirectedTester.hh.

Referenced by wakeup().

◆ ports

std::vector<RequestPort*> RubyDirectedTester::ports
private

Definition at line 101 of file RubyDirectedTester.hh.

Referenced by getCpuPort(), getPort(), init(), and ~RubyDirectedTester().


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

Generated on Wed Sep 30 2020 14:02:30 for gem5 by doxygen 1.8.17