gem5  v22.1.0.0
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
gem5::ProtocolTester Class Reference

#include <protocol_tester.hh>

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

Classes

class  GMTokenPort
 
struct  SenderState
 
class  SeqPort
 

Public Types

typedef ProtocolTesterParams Params
 
typedef AddressManager::Location Location
 
typedef AddressManager::Value Value
 
- 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

 ProtocolTester (const Params &p)
 
 ~ProtocolTester ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
RequestorID requestorId ()
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
int getEpisodeLength () const
 
AddressManagergetAddressManager () const
 
bool checkExit ()
 
bool checkDRF (Location atomic_loc, Location loc, bool isStore) const
 
int getNextEpisodeID ()
 
int getActionSeqNum ()
 
void dumpErrorLog (std::stringstream &ss)
 
- 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
 

Private Attributes

RequestorID _requestorId
 
int numCpuPorts
 
int numDmaPorts
 
int numVectorPorts
 
int numSqcPorts
 
int numScalarPorts
 
int numTokenPorts
 
int numCusPerSqc
 
int numCusPerScalar
 
int numWfsPerCu
 
int numWisPerWf
 
int numCuTokens
 
int numAtomicLocs
 
int numNormalLocsPerAtomic
 
int episodeLength
 
int maxNumEpisodes
 
bool debugTester
 
std::vector< RequestPort * > cpuPorts
 
std::vector< RequestPort * > dmaPorts
 
std::vector< RequestPort * > cuVectorPorts
 
std::vector< RequestPort * > cuSqcPorts
 
std::vector< RequestPort * > cuScalarPorts
 
std::vector< TokenManager * > cuTokenManagers
 
std::vector< GMTokenPort * > cuTokenPorts
 
std::vector< CpuThread * > cpuThreads
 
std::vector< DmaThread * > dmaThreads
 
std::vector< GpuWavefront * > wfs
 
AddressManageraddrManager
 
int numCpus
 
int numDmas
 
int numCus
 
int nextEpisodeId
 
int actionCount
 
bool sentExitSignal
 
OutputStreamlogFile
 

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...
 
- 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...
 

Detailed Description

Definition at line 69 of file protocol_tester.hh.

Member Typedef Documentation

◆ Location

Definition at line 118 of file protocol_tester.hh.

◆ Params

typedef ProtocolTesterParams gem5::ProtocolTester::Params

Definition at line 114 of file protocol_tester.hh.

◆ Value

Definition at line 119 of file protocol_tester.hh.

Constructor & Destructor Documentation

◆ ProtocolTester()

gem5::ProtocolTester::ProtocolTester ( const Params p)

◆ ~ProtocolTester()

gem5::ProtocolTester::~ProtocolTester ( )

Member Function Documentation

◆ checkDRF()

bool gem5::ProtocolTester::checkDRF ( Location  atomic_loc,
Location  loc,
bool  isStore 
) const

Definition at line 297 of file protocol_tester.cc.

References cpuThreads, debugTester, dmaThreads, and wfs.

Referenced by gem5::Episode::initActions().

◆ checkExit()

bool gem5::ProtocolTester::checkExit ( )

◆ dumpErrorLog()

void gem5::ProtocolTester::dumpErrorLog ( std::stringstream &  ss)

◆ getActionSeqNum()

int gem5::ProtocolTester::getActionSeqNum ( )
inline

◆ getAddressManager()

AddressManager* gem5::ProtocolTester::getAddressManager ( ) const
inline

◆ getEpisodeLength()

int gem5::ProtocolTester::getEpisodeLength ( ) const
inline

Definition at line 126 of file protocol_tester.hh.

References episodeLength.

Referenced by gem5::TesterThread::issueNewEpisode().

◆ getNextEpisodeID()

int gem5::ProtocolTester::getNextEpisodeID ( )
inline

Definition at line 135 of file protocol_tester.hh.

References nextEpisodeId.

Referenced by gem5::Episode::Episode().

◆ getPort()

Port & gem5::ProtocolTester::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 242 of file protocol_tester.cc.

References cpuPorts, cuScalarPorts, cuSqcPorts, cuTokenPorts, cuVectorPorts, dmaPorts, gem5::SimObject::getPort(), numCpuPorts, numDmaPorts, numScalarPorts, numSqcPorts, numTokenPorts, numVectorPorts, and panic.

◆ init()

void gem5::ProtocolTester::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 197 of file protocol_tester.cc.

References cpuPorts, cpuThreads, cuScalarPorts, cuSqcPorts, cuTokenPorts, cuVectorPorts, dmaPorts, dmaThreads, DPRINTF, gem5::ArmISA::i, numCpus, numCus, numCusPerScalar, numCusPerSqc, numDmas, numWfsPerCu, and wfs.

◆ requestorId()

RequestorID gem5::ProtocolTester::requestorId ( )
inline

Member Data Documentation

◆ _requestorId

RequestorID gem5::ProtocolTester::_requestorId
private

Definition at line 143 of file protocol_tester.hh.

Referenced by requestorId().

◆ actionCount

int gem5::ProtocolTester::actionCount
private

Definition at line 194 of file protocol_tester.hh.

Referenced by getActionSeqNum(), and ProtocolTester().

◆ addrManager

AddressManager* gem5::ProtocolTester::addrManager
private

Definition at line 183 of file protocol_tester.hh.

Referenced by getAddressManager(), ProtocolTester(), and ~ProtocolTester().

◆ cpuPorts

std::vector<RequestPort*> gem5::ProtocolTester::cpuPorts
private

Definition at line 168 of file protocol_tester.hh.

Referenced by getPort(), init(), ProtocolTester(), and ~ProtocolTester().

◆ cpuThreads

std::vector<CpuThread*> gem5::ProtocolTester::cpuThreads
private

Definition at line 176 of file protocol_tester.hh.

Referenced by checkDRF(), dumpErrorLog(), and init().

◆ cuScalarPorts

std::vector<RequestPort*> gem5::ProtocolTester::cuScalarPorts
private

Definition at line 172 of file protocol_tester.hh.

Referenced by getPort(), init(), ProtocolTester(), and ~ProtocolTester().

◆ cuSqcPorts

std::vector<RequestPort*> gem5::ProtocolTester::cuSqcPorts
private

Definition at line 171 of file protocol_tester.hh.

Referenced by getPort(), init(), ProtocolTester(), and ~ProtocolTester().

◆ cuTokenManagers

std::vector<TokenManager*> gem5::ProtocolTester::cuTokenManagers
private

Definition at line 173 of file protocol_tester.hh.

Referenced by ProtocolTester().

◆ cuTokenPorts

std::vector<GMTokenPort*> gem5::ProtocolTester::cuTokenPorts
private

Definition at line 174 of file protocol_tester.hh.

Referenced by getPort(), init(), and ProtocolTester().

◆ cuVectorPorts

std::vector<RequestPort*> gem5::ProtocolTester::cuVectorPorts
private

Definition at line 170 of file protocol_tester.hh.

Referenced by getPort(), init(), ProtocolTester(), and ~ProtocolTester().

◆ debugTester

bool gem5::ProtocolTester::debugTester
private

Definition at line 165 of file protocol_tester.hh.

Referenced by checkDRF(), and ProtocolTester().

◆ dmaPorts

std::vector<RequestPort*> gem5::ProtocolTester::dmaPorts
private

Definition at line 169 of file protocol_tester.hh.

Referenced by getPort(), init(), ProtocolTester(), and ~ProtocolTester().

◆ dmaThreads

std::vector<DmaThread*> gem5::ProtocolTester::dmaThreads
private

Definition at line 177 of file protocol_tester.hh.

Referenced by checkDRF(), dumpErrorLog(), and init().

◆ episodeLength

int gem5::ProtocolTester::episodeLength
private

Definition at line 161 of file protocol_tester.hh.

Referenced by getEpisodeLength(), and ProtocolTester().

◆ logFile

OutputStream* gem5::ProtocolTester::logFile
private

Definition at line 199 of file protocol_tester.hh.

Referenced by dumpErrorLog(), ProtocolTester(), and ~ProtocolTester().

◆ maxNumEpisodes

int gem5::ProtocolTester::maxNumEpisodes
private

Definition at line 163 of file protocol_tester.hh.

Referenced by checkExit(), and ProtocolTester().

◆ nextEpisodeId

int gem5::ProtocolTester::nextEpisodeId
private

Definition at line 190 of file protocol_tester.hh.

Referenced by checkExit(), getNextEpisodeID(), and ProtocolTester().

◆ numAtomicLocs

int gem5::ProtocolTester::numAtomicLocs
private

Definition at line 158 of file protocol_tester.hh.

Referenced by ProtocolTester().

◆ numCpuPorts

int gem5::ProtocolTester::numCpuPorts
private

Definition at line 146 of file protocol_tester.hh.

Referenced by getPort(), and ProtocolTester().

◆ numCpus

int gem5::ProtocolTester::numCpus
private

Definition at line 186 of file protocol_tester.hh.

Referenced by init(), and ProtocolTester().

◆ numCus

int gem5::ProtocolTester::numCus
private

Definition at line 188 of file protocol_tester.hh.

Referenced by init(), and ProtocolTester().

◆ numCusPerScalar

int gem5::ProtocolTester::numCusPerScalar
private

Definition at line 153 of file protocol_tester.hh.

Referenced by init().

◆ numCusPerSqc

int gem5::ProtocolTester::numCusPerSqc
private

Definition at line 152 of file protocol_tester.hh.

Referenced by init().

◆ numCuTokens

int gem5::ProtocolTester::numCuTokens
private

Definition at line 156 of file protocol_tester.hh.

Referenced by ProtocolTester().

◆ numDmaPorts

int gem5::ProtocolTester::numDmaPorts
private

Definition at line 147 of file protocol_tester.hh.

Referenced by getPort(), and ProtocolTester().

◆ numDmas

int gem5::ProtocolTester::numDmas
private

Definition at line 187 of file protocol_tester.hh.

Referenced by init(), and ProtocolTester().

◆ numNormalLocsPerAtomic

int gem5::ProtocolTester::numNormalLocsPerAtomic
private

Definition at line 159 of file protocol_tester.hh.

Referenced by ProtocolTester().

◆ numScalarPorts

int gem5::ProtocolTester::numScalarPorts
private

Definition at line 150 of file protocol_tester.hh.

Referenced by getPort(), and ProtocolTester().

◆ numSqcPorts

int gem5::ProtocolTester::numSqcPorts
private

Definition at line 149 of file protocol_tester.hh.

Referenced by getPort(), and ProtocolTester().

◆ numTokenPorts

int gem5::ProtocolTester::numTokenPorts
private

Definition at line 151 of file protocol_tester.hh.

Referenced by getPort(), and ProtocolTester().

◆ numVectorPorts

int gem5::ProtocolTester::numVectorPorts
private

Definition at line 148 of file protocol_tester.hh.

Referenced by getPort(), and ProtocolTester().

◆ numWfsPerCu

int gem5::ProtocolTester::numWfsPerCu
private

Definition at line 154 of file protocol_tester.hh.

Referenced by init(), and ProtocolTester().

◆ numWisPerWf

int gem5::ProtocolTester::numWisPerWf
private

Definition at line 155 of file protocol_tester.hh.

Referenced by ProtocolTester().

◆ sentExitSignal

bool gem5::ProtocolTester::sentExitSignal
private

Definition at line 197 of file protocol_tester.hh.

Referenced by checkExit(), dumpErrorLog(), and ProtocolTester().

◆ wfs

std::vector<GpuWavefront*> gem5::ProtocolTester::wfs
private

Definition at line 178 of file protocol_tester.hh.

Referenced by checkDRF(), dumpErrorLog(), and init().


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

Generated on Wed Dec 21 2022 10:23:14 for gem5 by doxygen 1.9.1