gem5  v22.0.0.2
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
gem5::GUPSGen Class Reference

#include <gups_gen.hh>

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

Classes

class  GenPort
 definition of the GenPort class which is of the type RequestPort. More...
 
struct  GUPSGenStat
 

Public Member Functions

 GUPSGen (const GUPSGenParams &params)
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- 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...
 
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 Member Functions

virtual void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual void startup () override
 startup() is the final initialization call before simulation. More...
 
Addr indexToAddr (uint64_t index)
 Convert and index from array to its physical address in the memory. More...
 
PacketPtr getReadPacket (Addr addr, unsigned int size)
 Generate a read request to be sent to the outside. More...
 
PacketPtr getWritePacket (Addr addr, unsigned int size, uint8_t *data)
 Generate a write request to be sent to the outside. More...
 
void handleResponse (PacketPtr pkt)
 Handles the incoming responses from the outside. More...
 
void wakeUp ()
 This function allows the port to wake its owner GUPSGen object in case it has stopped working due to back pressure, it will wake up as soon as back pressure is resolved. More...
 
void createNextReq ()
 Create the next request and store in the requestPool. More...
 
void sendNextReq ()
 Send outstanding requests from requestPool to the port. More...
 

Private Attributes

EventFunctionWrapper nextCreateEvent
 Corresponding event to the createNextReq function. More...
 
EventFunctionWrapper nextSendEvent
 Corresponding event to the sendNextReq function. More...
 
std::unordered_map< RequestPtr, uint64_t > updateTable
 Use an unordered map to store future updates on current reads as the updated value depends on the index which is know when a read request is created. More...
 
std::unordered_map< RequestPtr, TickexitTimes
 Use an unordered map to track the time at which each request exits the GUPSGen. More...
 
std::queue< PacketPtrrequestPool
 A queue to store the outstanding requests whether read or write. More...
 
std::queue< PacketPtrresponsePool
 A queue to store response packets from reads. More...
 
int64_t numUpdates
 The total number of updates (one read and one write) to do for running the benchmark to completion. More...
 
int64_t tableSize
 Number of elements in the allocated array. More...
 
System *const system
 Pointer to the system object this GUPSGen belongs to, the system object is used to acquire a requestorId. More...
 
const RequestorID requestorId
 Used to identify each requestor in a system object. More...
 
GenPort port
 An instance of GenPort to communicate with the outside. More...
 
Addr startAddr
 The beginning address for allocating the array. More...
 
const uint64_t memSize
 Size of the memory in bytes that will be allocated for the array. More...
 
int updateLimit
 The number of updates to do before creating an exit event. More...
 
const int elementSize
 size of each element in the array (in bytes). More...
 
int reqQueueSize
 The maximum number of outstanding requests (i.e. More...
 
bool initMemory
 Boolean value to determine whether we need to initialize the array with the right values, as we don't care about the values, this is defaulted to false in python wrapper for this simobject. More...
 
bool doneReading
 Boolean to indicate whether the generator is done creating read requests, which means number of reads equal either updateLimit or numUpdates. More...
 
int onTheFlyRequests
 The number of requests that have existed this GUPSGen and have no corresponding response (they are being serviced some where in the system). More...
 
int readRequests
 The number of read requests currently created. More...
 
gem5::GUPSGen::GUPSGenStat stats
 

Additional Inherited Members

- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- 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 53 of file gups_gen.hh.

Constructor & Destructor Documentation

◆ GUPSGen()

gem5::GUPSGen::GUPSGen ( const GUPSGenParams &  params)

Definition at line 41 of file gups_gen.cc.

References createNextReq().

Member Function Documentation

◆ createNextReq()

void gem5::GUPSGen::createNextReq ( )
private

◆ getPort()

Port & gem5::GUPSGen::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 58 of file gups_gen.cc.

References gem5::SimObject::getPort(), and port.

◆ getReadPacket()

PacketPtr gem5::GUPSGen::getReadPacket ( Addr  addr,
unsigned int  size 
)
private

Generate a read request to be sent to the outside.

Parameters
addrPhysical address to which the request is sent to
sizeThe number of bytes to be read by the request.
Returns
Pointer to the generated packet. This packet includes the request to the outside.

Definition at line 109 of file gups_gen.cc.

References gem5::X86ISA::addr, gem5::Packet::allocate(), gem5::MemCmd::ReadReq, and requestorId.

Referenced by createNextReq().

◆ getWritePacket()

PacketPtr gem5::GUPSGen::getWritePacket ( Addr  addr,
unsigned int  size,
uint8_t *  data 
)
private

Generate a write request to be sent to the outside.

Parameters
addrPhysical address to which the request is sent to
sizeThe number of bytes to be written by the request.
dataPointer to the data that should be written.
Returns
Pointer to the generated packet. This packet includes the request to the outside.

Definition at line 124 of file gups_gen.cc.

References gem5::X86ISA::addr, gem5::Packet::allocate(), data, requestorId, gem5::Packet::setData(), and gem5::MemCmd::WriteReq.

Referenced by createNextReq(), and startup().

◆ handleResponse()

void gem5::GUPSGen::handleResponse ( PacketPtr  pkt)
private

◆ indexToAddr()

Addr gem5::GUPSGen::indexToAddr ( uint64_t  index)
private

Convert and index from array to its physical address in the memory.

Parameters
indexIndex of the element in the array
Returns
Addr Physical address corresponding to the index.

Definition at line 102 of file gups_gen.cc.

References elementSize, gem5::MipsISA::index, and startAddr.

Referenced by createNextReq(), and startup().

◆ init()

void gem5::GUPSGen::init ( )
overrideprivatevirtual

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 68 of file gups_gen.cc.

References doneReading, elementSize, memSize, numUpdates, onTheFlyRequests, readRequests, and tableSize.

◆ sendNextReq()

void gem5::GUPSGen::sendNextReq ( )
private

◆ startup()

void gem5::GUPSGen::startup ( )
overrideprivatevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 79 of file gups_gen.cc.

References gem5::X86ISA::addr, elementSize, getWritePacket(), indexToAddr(), initMemory, nextCreateEvent, gem5::Clocked::nextCycle(), gem5::ArmISA::offset, port, gem5::EventManager::schedule(), gem5::GUPSGen::GenPort::sendFunctionalPacket(), and tableSize.

◆ wakeUp()

void gem5::GUPSGen::wakeUp ( )
private

This function allows the port to wake its owner GUPSGen object in case it has stopped working due to back pressure, it will wake up as soon as back pressure is resolved.

Definition at line 183 of file gups_gen.cc.

References gem5::Clocked::nextCycle(), nextSendEvent, requestPool, gem5::EventManager::schedule(), and gem5::Event::scheduled().

Member Data Documentation

◆ doneReading

bool gem5::GUPSGen::doneReading
private

Boolean to indicate whether the generator is done creating read requests, which means number of reads equal either updateLimit or numUpdates.

Definition at line 290 of file gups_gen.hh.

Referenced by createNextReq(), handleResponse(), init(), and sendNextReq().

◆ elementSize

const int gem5::GUPSGen::elementSize
private

size of each element in the array (in bytes).

Every element should be uint64_t, therefore this is equal to size_of(uint64_t) = 8

Definition at line 270 of file gups_gen.hh.

Referenced by createNextReq(), handleResponse(), indexToAddr(), init(), and startup().

◆ exitTimes

std::unordered_map<RequestPtr, Tick> gem5::GUPSGen::exitTimes
private

Use an unordered map to track the time at which each request exits the GUPSGen.

This is useful when we need to compute request latency.

Definition at line 206 of file gups_gen.hh.

Referenced by handleResponse(), and sendNextReq().

◆ initMemory

bool gem5::GUPSGen::initMemory
private

Boolean value to determine whether we need to initialize the array with the right values, as we don't care about the values, this is defaulted to false in python wrapper for this simobject.

Definition at line 283 of file gups_gen.hh.

Referenced by startup().

◆ memSize

const uint64_t gem5::GUPSGen::memSize
private

Size of the memory in bytes that will be allocated for the array.

Definition at line 259 of file gups_gen.hh.

Referenced by init().

◆ nextCreateEvent

EventFunctionWrapper gem5::GUPSGen::nextCreateEvent
private

Corresponding event to the createNextReq function.

Scheduled whenever a request needs to and can be created.

Definition at line 180 of file gups_gen.hh.

Referenced by createNextReq(), handleResponse(), sendNextReq(), and startup().

◆ nextSendEvent

EventFunctionWrapper gem5::GUPSGen::nextSendEvent
private

Corresponding event to the sendNextReq function.

Scheduled whenever a request needs to and can be sent.

Definition at line 191 of file gups_gen.hh.

Referenced by createNextReq(), sendNextReq(), and wakeUp().

◆ numUpdates

int64_t gem5::GUPSGen::numUpdates
private

The total number of updates (one read and one write) to do for running the benchmark to completion.

Definition at line 227 of file gups_gen.hh.

Referenced by createNextReq(), and init().

◆ onTheFlyRequests

int gem5::GUPSGen::onTheFlyRequests
private

The number of requests that have existed this GUPSGen and have no corresponding response (they are being serviced some where in the system).

Definition at line 297 of file gups_gen.hh.

Referenced by handleResponse(), init(), and sendNextReq().

◆ port

GenPort gem5::GUPSGen::port
private

An instance of GenPort to communicate with the outside.

Definition at line 249 of file gups_gen.hh.

Referenced by getPort(), sendNextReq(), and startup().

◆ readRequests

int gem5::GUPSGen::readRequests
private

The number of read requests currently created.

Definition at line 302 of file gups_gen.hh.

Referenced by createNextReq(), and init().

◆ reqQueueSize

int gem5::GUPSGen::reqQueueSize
private

The maximum number of outstanding requests (i.e.

maximum length of the requestPool), specified as 1024 by the HPCC benchmark.

Definition at line 276 of file gups_gen.hh.

Referenced by createNextReq(), handleResponse(), and sendNextReq().

◆ requestorId

const RequestorID gem5::GUPSGen::requestorId
private

Used to identify each requestor in a system object.

Every GUPSGen has its own unique requestorId.

Definition at line 244 of file gups_gen.hh.

Referenced by getReadPacket(), and getWritePacket().

◆ requestPool

std::queue<PacketPtr> gem5::GUPSGen::requestPool
private

A queue to store the outstanding requests whether read or write.

The element at the front of the queue is sent to outside everytime nextSendEvent is scheduled.

Definition at line 213 of file gups_gen.hh.

Referenced by createNextReq(), handleResponse(), sendNextReq(), and wakeUp().

◆ responsePool

std::queue<PacketPtr> gem5::GUPSGen::responsePool
private

A queue to store response packets from reads.

each response in the response pool will generate a write request. The write request updates the value of data in the response packet with its corresponding value in the update table.

Definition at line 221 of file gups_gen.hh.

Referenced by createNextReq(), handleResponse(), and sendNextReq().

◆ startAddr

Addr gem5::GUPSGen::startAddr
private

The beginning address for allocating the array.

Definition at line 254 of file gups_gen.hh.

Referenced by indexToAddr().

◆ stats

gem5::GUPSGen::GUPSGenStat gem5::GUPSGen::stats
private

Referenced by handleResponse().

◆ system

System* const gem5::GUPSGen::system
private

Pointer to the system object this GUPSGen belongs to, the system object is used to acquire a requestorId.

Definition at line 238 of file gups_gen.hh.

◆ tableSize

int64_t gem5::GUPSGen::tableSize
private

Number of elements in the allocated array.

Definition at line 232 of file gups_gen.hh.

Referenced by createNextReq(), init(), and startup().

◆ updateLimit

int gem5::GUPSGen::updateLimit
private

The number of updates to do before creating an exit event.

Definition at line 264 of file gups_gen.hh.

Referenced by createNextReq().

◆ updateTable

std::unordered_map<RequestPtr, uint64_t> gem5::GUPSGen::updateTable
private

Use an unordered map to store future updates on current reads as the updated value depends on the index which is know when a read request is created.

The respective write will use the value stored to update the value.

Definition at line 199 of file gups_gen.hh.

Referenced by createNextReq().


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

Generated on Thu Jul 28 2022 13:33:04 for gem5 by doxygen 1.8.17