gem5  v21.1.0.2
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gem5::memory::qos::MemSinkCtrl Class Reference

QoS Memory Sink. More...

#include <mem_sink.hh>

Inheritance diagram for gem5::memory::qos::MemSinkCtrl:
gem5::memory::qos::MemCtrl gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  MemoryPort
 
struct  MemSinkCtrlStats
 

Public Member Functions

 MemSinkCtrl (const QoSMemSinkCtrlParams &)
 QoS Memory Sink Constructor. More...
 
virtual ~MemSinkCtrl ()
 
DrainState drain () override
 Checks and return the Drain state of this SimObject. More...
 
PortgetPort (const std::string &if_name, PortID=InvalidPortID) override
 Getter method to access this memory's response port. More...
 
void init () override
 Initializes this object. More...
 
- Public Member Functions inherited from gem5::memory::qos::MemCtrl
 MemCtrl (const QoSMemCtrlParams &)
 QoS Memory base class. More...
 
virtual ~MemCtrl ()
 
BusState getBusState () const
 Gets the current bus state. More...
 
BusState getBusStateNext () const
 Gets the next bus state. More...
 
bool hasRequestor (RequestorID id) const
 hasRequestor returns true if the selected requestor(ID) has been registered in the memory controller, which happens if the memory controller has received at least a packet from that requestor. More...
 
uint64_t getReadQueueSize (const uint8_t prio) const
 Gets a READ queue size. More...
 
uint64_t getWriteQueueSize (const uint8_t prio) const
 Gets a WRITE queue size. More...
 
uint64_t getTotalReadQueueSize () const
 Gets the total combined READ queues size. More...
 
uint64_t getTotalWriteQueueSize () const
 Gets the total combined WRITE queues size. More...
 
Tick getServiceTick (const uint8_t prio) const
 Gets the last service tick related to a QoS Priority. More...
 
uint8_t numPriorities () const
 Gets the total number of priority levels in the QoS memory controller. More...
 
Systemsystem () const
 read the system pointer 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...
 
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 Types

using PacketQueue = std::deque< PacketPtr >
 The Request packets are store in a multiple dequeue structure, based on their QoS priority. More...
 

Protected Member Functions

void processNextReqEvent ()
 Processes the next Request event according to configured request latency. More...
 
bool readQueueFull (const uint64_t packets) const
 Check if the read queue has room for more entries. More...
 
bool writeQueueFull (const uint64_t packets) const
 Check if the write queue has room for more entries. More...
 
Tick recvAtomic (PacketPtr pkt)
 Receive a Packet in Atomic mode. More...
 
void recvFunctional (PacketPtr pkt)
 Receive a Packet in Functional mode. More...
 
bool recvTimingReq (PacketPtr pkt)
 Receive a Packet in Timing mode. More...
 
- Protected Member Functions inherited from gem5::memory::qos::MemCtrl
void addRequestor (const RequestorID id)
 Initializes dynamically counters and statistics for a given Requestor. More...
 
void logRequest (BusState dir, RequestorID id, uint8_t _qos, Addr addr, uint64_t entries)
 Called upon receiving a request or updates statistics and updates queues status. More...
 
void logResponse (BusState dir, RequestorID id, uint8_t _qos, Addr addr, uint64_t entries, double delay)
 Called upon receiving a response, updates statistics and updates queues status. More...
 
template<typename Queues >
uint8_t qosSchedule (std::initializer_list< Queues * > queues_ptr, uint64_t queue_entry_size, const PacketPtr pkt)
 Assign priority to a packet by executing the configured QoS policy. More...
 
uint8_t schedule (RequestorID id, uint64_t data)
 
uint8_t schedule (const PacketPtr pkt)
 
BusState selectNextBusState ()
 Returns next bus direction (READ or WRITE) based on configured policy. More...
 
void setCurrentBusState ()
 Set current bus direction (READ or WRITE) from next selected one. More...
 
void recordTurnaroundStats ()
 Record statistics on turnarounds based on busStateNext and busState values. More...
 
template<typename Queues >
void escalate (std::initializer_list< Queues * > queues, uint64_t queue_entry_size, RequestorID id, uint8_t tgt_prio)
 Escalates/demotes priority of all packets belonging to the passed requestor to given priority value. More...
 
template<typename Queues >
void escalateQueues (Queues &queues, uint64_t queue_entry_size, RequestorID id, uint8_t curr_prio, uint8_t tgt_prio)
 Escalates/demotes priority of all packets belonging to the passed requestor to given priority value in a specified cluster of queues (e.g. More...
 
- 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

const Tick requestLatency
 Memory between requests latency (ticks) More...
 
const Tick responseLatency
 Memory response latency (ticks) More...
 
const uint64_t memoryPacketSize
 Memory packet size in bytes. More...
 
const uint64_t readBufferSize
 Read request packets queue buffer size in #packets. More...
 
const uint64_t writeBufferSize
 Write request packets queue buffer size in #packets. More...
 
MemoryPort port
 Memory response port. More...
 
MemSinkInterface *const interface
 Create pointer to interface of actual media. More...
 
bool retryRdReq
 Read request pending. More...
 
bool retryWrReq
 Write request pending. More...
 
Tick nextRequest
 Next request service time. More...
 
std::vector< PacketQueuereadQueue
 QoS-aware (per priority) incoming read requests packets queue. More...
 
std::vector< PacketQueuewriteQueue
 QoS-aware (per priority) incoming read requests packets queue. More...
 
EventWrapper< MemSinkCtrl, &MemSinkCtrl::processNextReqEventnextReqEvent
 Event wrapper to schedule next request handler function. More...
 
MemSinkCtrlStats stats
 
- Protected Attributes inherited from gem5::memory::qos::MemCtrl
const std::unique_ptr< Policypolicy
 QoS Policy, assigns QoS priority to the incoming packets. More...
 
const std::unique_ptr< TurnaroundPolicyturnPolicy
 QoS Bus Turnaround Policy: selects the bus direction (READ/WRITE) More...
 
const std::unique_ptr< QueuePolicyqueuePolicy
 QoS Queue Policy: selects packet among same-priority queue. More...
 
const uint8_t _numPriorities
 Number of configured QoS priorities. More...
 
const bool qosPriorityEscalation
 Enables QoS priority escalation. More...
 
const bool qosSyncroScheduler
 Enables QoS synchronized scheduling invokes the QoS scheduler on all requestors, at every packet arrival. More...
 
std::unordered_map< RequestorID, const std::string > requestors
 Hash of requestor ID - requestor name. More...
 
std::unordered_map< RequestorID, std::vector< uint64_t > > packetPriorities
 Hash of requestors - number of packets queued per priority. More...
 
std::unordered_map< RequestorID, std::unordered_map< uint64_t, std::deque< uint64_t > > > requestTimes
 Hash of requestors - address of request - queue of times of request. More...
 
std::vector< TickserviceTick
 Vector of QoS priorities/last service time. More...
 
std::vector< uint64_t > readQueueSizes
 Read request packets queue length in #packets, per QoS priority. More...
 
std::vector< uint64_t > writeQueueSizes
 Write request packets queue length in #packets, per QoS priority. More...
 
uint64_t totalReadQueueSize
 Total read request packets queue length in #packets. More...
 
uint64_t totalWriteQueueSize
 Total write request packets queue length in #packets. More...
 
BusState busState
 Bus state used to control the read/write switching and drive the scheduling of the next request. More...
 
BusState busStateNext
 bus state for next request event triggered More...
 
gem5::memory::qos::MemCtrl::MemCtrlStats stats
 
System_system
 Pointer to the System object. 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...
 

Additional Inherited Members

- Public Types inherited from gem5::memory::qos::MemCtrl
enum  BusState { READ, WRITE }
 Bus Direction. More...
 
- 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
 

Detailed Description

QoS Memory Sink.

The QoS Memory Sink is a lightweight memory controller with QoS support. It is meant to provide a QoS aware simple memory system without the need of using a complex DRAM memory controller

Definition at line 75 of file mem_sink.hh.

Member Typedef Documentation

◆ PacketQueue

The Request packets are store in a multiple dequeue structure, based on their QoS priority.

Definition at line 82 of file mem_sink.hh.

Constructor & Destructor Documentation

◆ MemSinkCtrl()

gem5::memory::qos::MemSinkCtrl::MemSinkCtrl ( const QoSMemSinkCtrlParams &  p)

QoS Memory Sink Constructor.

Parameters
pQoS Memory Sink configuration parameters

Definition at line 57 of file mem_sink.cc.

References interface, gem5::memory::qos::MemCtrl::numPriorities(), readQueue, gem5::memory::qos::MemSinkInterface::setMemCtrl(), and writeQueue.

◆ ~MemSinkCtrl()

gem5::memory::qos::MemSinkCtrl::~MemSinkCtrl ( )
virtual

Definition at line 75 of file mem_sink.cc.

Member Function Documentation

◆ drain()

DrainState gem5::memory::qos::MemSinkCtrl::drain ( )
overridevirtual

Checks and return the Drain state of this SimObject.

Returns
current Drain state

Implements gem5::Drainable.

Definition at line 333 of file mem_sink.cc.

References DPRINTF, gem5::Drained, gem5::Draining, gem5::memory::qos::MemCtrl::totalReadQueueSize, and gem5::memory::qos::MemCtrl::totalWriteQueueSize.

◆ getPort()

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

Getter method to access this memory's response port.

Parameters
if_nameinterface name
idxport ID number
Returns
reference to this memory's response port

Reimplemented from gem5::SimObject.

Definition at line 124 of file mem_sink.cc.

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

◆ init()

void gem5::memory::qos::MemSinkCtrl::init ( )
overridevirtual

Initializes this object.

Reimplemented from gem5::SimObject.

Definition at line 79 of file mem_sink.cc.

References gem5::SimObject::init(), gem5::Port::isConnected(), port, and gem5::ResponsePort::sendRangeChange().

◆ processNextReqEvent()

void gem5::memory::qos::MemSinkCtrl::processNextReqEvent ( )
protected

◆ readQueueFull()

bool gem5::memory::qos::MemSinkCtrl::readQueueFull ( const uint64_t  packets) const
inlineprotected

Check if the read queue has room for more entries.

Parameters
packetsThe number of entries needed in the read queue
Returns
true if read queue is full, false otherwise

Definition at line 91 of file mem_sink.cc.

References readBufferSize, and gem5::memory::qos::MemCtrl::totalReadQueueSize.

Referenced by recvTimingReq().

◆ recvAtomic()

Tick gem5::memory::qos::MemSinkCtrl::recvAtomic ( PacketPtr  pkt)
protected

Receive a Packet in Atomic mode.

Parameters
pktpointer to memory packet
Returns
packet access latency in ticks

Definition at line 103 of file mem_sink.cc.

References gem5::memory::AbstractMemory::access(), gem5::Packet::cacheResponding(), interface, panic_if, and responseLatency.

◆ recvFunctional()

void gem5::memory::qos::MemSinkCtrl::recvFunctional ( PacketPtr  pkt)
protected

Receive a Packet in Functional mode.

Parameters
pktpointer to memory packet

Definition at line 114 of file mem_sink.cc.

References gem5::memory::AbstractMemory::functionalAccess(), interface, gem5::Named::name(), gem5::Packet::popLabel(), and gem5::Packet::pushLabel().

◆ recvTimingReq()

bool gem5::memory::qos::MemSinkCtrl::recvTimingReq ( PacketPtr  pkt)
protected

◆ writeQueueFull()

bool gem5::memory::qos::MemSinkCtrl::writeQueueFull ( const uint64_t  packets) const
inlineprotected

Check if the write queue has room for more entries.

Parameters
packetsThe number of entries needed in the write queue
Returns
true if write queue is full, false otherwise

Definition at line 97 of file mem_sink.cc.

References gem5::memory::qos::MemCtrl::totalWriteQueueSize, and writeBufferSize.

Referenced by recvTimingReq().

Member Data Documentation

◆ interface

MemSinkInterface* const gem5::memory::qos::MemSinkCtrl::interface
protected

Create pointer to interface of actual media.

Definition at line 187 of file mem_sink.hh.

Referenced by getPort(), MemSinkCtrl(), processNextReqEvent(), recvAtomic(), and recvFunctional().

◆ memoryPacketSize

const uint64_t gem5::memory::qos::MemSinkCtrl::memoryPacketSize
protected

Memory packet size in bytes.

Definition at line 173 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ nextReqEvent

EventWrapper< MemSinkCtrl, &MemSinkCtrl::processNextReqEvent> gem5::memory::qos::MemSinkCtrl::nextReqEvent
protected

Event wrapper to schedule next request handler function.

Definition at line 228 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ nextRequest

Tick gem5::memory::qos::MemSinkCtrl::nextRequest
protected

Next request service time.

Definition at line 196 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ port

MemoryPort gem5::memory::qos::MemSinkCtrl::port
protected

Memory response port.

Definition at line 182 of file mem_sink.hh.

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

◆ readBufferSize

const uint64_t gem5::memory::qos::MemSinkCtrl::readBufferSize
protected

Read request packets queue buffer size in #packets.

Definition at line 176 of file mem_sink.hh.

Referenced by readQueueFull().

◆ readQueue

std::vector<PacketQueue> gem5::memory::qos::MemSinkCtrl::readQueue
protected

QoS-aware (per priority) incoming read requests packets queue.

Definition at line 212 of file mem_sink.hh.

Referenced by MemSinkCtrl(), processNextReqEvent(), and recvTimingReq().

◆ requestLatency

const Tick gem5::memory::qos::MemSinkCtrl::requestLatency
protected

Memory between requests latency (ticks)

Definition at line 167 of file mem_sink.hh.

Referenced by processNextReqEvent().

◆ responseLatency

const Tick gem5::memory::qos::MemSinkCtrl::responseLatency
protected

Memory response latency (ticks)

Definition at line 170 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvAtomic().

◆ retryRdReq

bool gem5::memory::qos::MemSinkCtrl::retryRdReq
protected

Read request pending.

Definition at line 190 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ retryWrReq

bool gem5::memory::qos::MemSinkCtrl::retryWrReq
protected

Write request pending.

Definition at line 193 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ stats

MemSinkCtrlStats gem5::memory::qos::MemSinkCtrl::stats
protected

Definition at line 269 of file mem_sink.hh.

Referenced by recvTimingReq().

◆ writeBufferSize

const uint64_t gem5::memory::qos::MemSinkCtrl::writeBufferSize
protected

Write request packets queue buffer size in #packets.

Definition at line 179 of file mem_sink.hh.

Referenced by writeQueueFull().

◆ writeQueue

std::vector<PacketQueue> gem5::memory::qos::MemSinkCtrl::writeQueue
protected

QoS-aware (per priority) incoming read requests packets queue.

Definition at line 217 of file mem_sink.hh.

Referenced by MemSinkCtrl(), processNextReqEvent(), and recvTimingReq().


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

Generated on Tue Sep 21 2021 12:31:29 for gem5 by doxygen 1.8.17