#include <mem_sink.hh>

Inheritance diagram for QoS::MemSinkCtrl:

Classes
class	MemoryPort

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

Port &	getPort (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 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...

System *	system () const
	read the system pointer More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () 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 Params *	params () 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...

ProbeManager *	getProbeManager ()
	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
EventQueue *	eventQueue () 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	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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (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 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...

void	regStats () override
	Registers statistics. More...

Protected Member Functions inherited from 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 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

Clocked &	operator= (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...

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

Stats::Scalar	numReadRetries
	Count the number of read retries. More...

Stats::Scalar	numWriteRetries
	Count the number of write retries. More...

std::vector< PacketQueue >	readQueue
	QoS-aware (per priority) incoming read requests packets queue. More...

std::vector< PacketQueue >	writeQueue
	QoS-aware (per priority) incoming read requests packets queue. More...

EventWrapper< MemSinkCtrl, &MemSinkCtrl::processNextReqEvent >	nextReqEvent
	Event wrapper to schedule next request handler function. More...

Protected Attributes inherited from QoS::MemCtrl
const std::unique_ptr< Policy >	policy
	QoS Policy, assigns QoS priority to the incoming packets. More...

const std::unique_ptr< TurnaroundPolicy >	turnPolicy
	QoS Bus Turnaround Policy: selects the bus direction (READ/WRITE) More...

const std::unique_ptr< QueuePolicy >	queuePolicy
	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< Tick >	serviceTick
	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...

QoS::MemCtrl::MemCtrlStats	stats

System *	_system
	Pointer to the System object. More...

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Additional Inherited Members
Public Types inherited from QoS::MemCtrl
enum	BusState { READ, WRITE }
	Bus Direction. More...

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (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
PowerState *	powerState

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 61 of file mem_sink.hh.

Member Typedef Documentation

◆ PacketQueue

using QoS::MemSinkCtrl::PacketQueue = std::deque<PacketPtr>

protected

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

Definition at line 68 of file mem_sink.hh.

Constructor & Destructor Documentation

◆ MemSinkCtrl()

QoS::MemSinkCtrl::MemSinkCtrl ( const QoSMemSinkCtrlParams * p )

QoS Memory Sink Constructor.

Parameters

p	QoS Memory Sink configuration parameters

Definition at line 48 of file mem_sink.cc.

References interface, QoS::MemCtrl::numPriorities(), readQueue, QoSMemSinkInterface::setMemCtrl(), and writeQueue.

◆ ~MemSinkCtrl()

QoS::MemSinkCtrl::~MemSinkCtrl ( )

virtual

Definition at line 65 of file mem_sink.cc.

Member Function Documentation

◆ drain()

DrainState QoS::MemSinkCtrl::drain ( )

overridevirtual

Checks and return the Drain state of this SimObject.

Returns: current Drain state

Implements Drainable.

Definition at line 323 of file mem_sink.cc.

References DPRINTF, Drained, Draining, QoS::MemCtrl::totalReadQueueSize, and QoS::MemCtrl::totalWriteQueueSize.

◆ getPort()

Port & QoS::MemSinkCtrl::getPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

overridevirtual

Getter method to access this memory's response port.

Parameters

if_name	interface name
idx	port ID number

Returns: reference to this memory's response port

Reimplemented from SimObject.

Definition at line 114 of file mem_sink.cc.

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

◆ init()

void QoS::MemSinkCtrl::init ( )

overridevirtual

Initializes this object.

Reimplemented from SimObject.

Definition at line 69 of file mem_sink.cc.

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

◆ processNextReqEvent()

void QoS::MemSinkCtrl::processNextReqEvent ( )

protected

Processes the next Request event according to configured request latency.

Definition at line 203 of file mem_sink.cc.

References QoS::MemCtrl::_system, AbstractMemory::access(), QoS::MemCtrl::busState, QoS::MemCtrl::busStateNext, curTick(), divCeil(), DPRINTF, DTRACE, ArmISA::e, Packet::getAddr(), System::getRequestorName(), Packet::getSize(), ArmISA::i, interface, Packet::isRead(), QoS::MemCtrl::logResponse(), memoryPacketSize, Packet::needsResponse(), nextReqEvent, nextRequest, QoS::MemCtrl::numPriorities(), panic_if, port, Packet::qosValue(), QoS::MemCtrl::queuePolicy, QoS::MemCtrl::READ, readQueue, QoS::MemCtrl::readQueueSizes, QoS::MemCtrl::recordTurnaroundStats(), Packet::req, requestLatency, responseLatency, retryRdReq, retryWrReq, QueuedResponsePort::schedTimingResp(), QoS::MemCtrl::schedule(), QoS::MemCtrl::selectNextBusState(), ResponsePort::sendRetryReq(), QoS::MemCtrl::setCurrentBusState(), sc_dt::to_string(), QoS::MemCtrl::totalReadQueueSize, QoS::MemCtrl::totalWriteQueueSize, QoS::MemCtrl::WRITE, writeQueue, and QoS::MemCtrl::writeQueueSizes.

◆ readQueueFull()

bool QoS::MemSinkCtrl::readQueueFull ( const uint64_t packets ) const

inlineprotected

Check if the read queue has room for more entries.

Parameters

packets The number of entries needed in the read queue

Returns: true if read queue is full, false otherwise

Definition at line 81 of file mem_sink.cc.

References readBufferSize, and QoS::MemCtrl::totalReadQueueSize.

Referenced by recvTimingReq().

◆ recvAtomic()

Tick QoS::MemSinkCtrl::recvAtomic ( PacketPtr pkt )

protected

Receive a Packet in Atomic mode.

Parameters

pkt	pointer to memory packet

Returns: packet access latency in ticks

Definition at line 93 of file mem_sink.cc.

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

◆ recvFunctional()

void QoS::MemSinkCtrl::recvFunctional ( PacketPtr pkt )

protected

Receive a Packet in Functional mode.

Parameters

pkt	pointer to memory packet

Definition at line 104 of file mem_sink.cc.

References AbstractMemory::functionalAccess(), interface, SimObject::name(), Packet::popLabel(), and Packet::pushLabel().

◆ recvTimingReq()

bool QoS::MemSinkCtrl::recvTimingReq ( PacketPtr pkt )

protected

Receive a Packet in Timing mode.

Parameters

pkt	pointer to memory packet

Returns: true if the request was accepted

Definition at line 124 of file mem_sink.cc.

References QoS::MemCtrl::_system, Packet::cacheResponding(), Packet::cmdString(), curTick(), divCeil(), DPRINTF, Packet::getAddr(), System::getRequestorName(), Packet::getSize(), Packet::isRead(), Packet::isWrite(), QoS::MemCtrl::logRequest(), memoryPacketSize, nextReqEvent, nextRequest, numReadRetries, numWriteRetries, panic_if, QoS::MemCtrl::qosSchedule(), Packet::qosValue(), QoS::MemCtrl::queuePolicy, QoS::MemCtrl::READ, readQueue, readQueueFull(), Packet::req, retryRdReq, retryWrReq, QoS::MemCtrl::schedule(), QoS::MemCtrl::WRITE, writeQueue, and writeQueueFull().

◆ regStats()

void QoS::MemSinkCtrl::regStats ( )

overrideprotectedvirtual

Registers statistics.

Reimplemented from Stats::Group.

Definition at line 336 of file mem_sink.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), numReadRetries, numWriteRetries, and Stats::Group::regStats().

◆ writeQueueFull()

bool QoS::MemSinkCtrl::writeQueueFull ( const uint64_t packets ) const

inlineprotected

Check if the write queue has room for more entries.

Parameters

packets The number of entries needed in the write queue

Returns: true if write queue is full, false otherwise

Definition at line 87 of file mem_sink.cc.

References QoS::MemCtrl::totalWriteQueueSize, and writeBufferSize.

Referenced by recvTimingReq().

Member Data Documentation

◆ interface

QoSMemSinkInterface* const QoS::MemSinkCtrl::interface

protected

Create pointer to interface of actual media.

Definition at line 173 of file mem_sink.hh.

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

◆ memoryPacketSize

const uint64_t QoS::MemSinkCtrl::memoryPacketSize

protected

Memory packet size in bytes.

Definition at line 159 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ nextReqEvent

EventWrapper< MemSinkCtrl, &MemSinkCtrl::processNextReqEvent> QoS::MemSinkCtrl::nextReqEvent

protected

Event wrapper to schedule next request handler function.

Definition at line 209 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ nextRequest

Tick QoS::MemSinkCtrl::nextRequest

protected

Next request service time.

Definition at line 182 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ numReadRetries

Stats::Scalar QoS::MemSinkCtrl::numReadRetries

protected

Count the number of read retries.

Definition at line 185 of file mem_sink.hh.

Referenced by recvTimingReq(), and regStats().

◆ numWriteRetries

Stats::Scalar QoS::MemSinkCtrl::numWriteRetries

protected

Count the number of write retries.

Definition at line 188 of file mem_sink.hh.

Referenced by recvTimingReq(), and regStats().

◆ port

MemoryPort QoS::MemSinkCtrl::port

protected

Memory response port.

Definition at line 168 of file mem_sink.hh.

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

◆ readBufferSize

const uint64_t QoS::MemSinkCtrl::readBufferSize

protected

Read request packets queue buffer size in #packets.

Definition at line 162 of file mem_sink.hh.

Referenced by readQueueFull().

◆ readQueue

std::vector<PacketQueue> QoS::MemSinkCtrl::readQueue

protected

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

Definition at line 193 of file mem_sink.hh.

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

◆ requestLatency

const Tick QoS::MemSinkCtrl::requestLatency

protected

Memory between requests latency (ticks)

Definition at line 153 of file mem_sink.hh.

Referenced by processNextReqEvent().

◆ responseLatency

const Tick QoS::MemSinkCtrl::responseLatency

protected

Memory response latency (ticks)

Definition at line 156 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvAtomic().

◆ retryRdReq

bool QoS::MemSinkCtrl::retryRdReq

protected

Read request pending.

Definition at line 176 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ retryWrReq

bool QoS::MemSinkCtrl::retryWrReq

protected

Write request pending.

Definition at line 179 of file mem_sink.hh.

Referenced by processNextReqEvent(), and recvTimingReq().

◆ writeBufferSize

const uint64_t QoS::MemSinkCtrl::writeBufferSize

protected

Write request packets queue buffer size in #packets.

Definition at line 165 of file mem_sink.hh.

Referenced by writeQueueFull().

◆ writeQueue

std::vector<PacketQueue> QoS::MemSinkCtrl::writeQueue

protected

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

Definition at line 198 of file mem_sink.hh.

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

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

mem/qos/mem_sink.hh
mem/qos/mem_sink.cc

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PacketQueue

Constructor & Destructor Documentation

◆ MemSinkCtrl()

◆ ~MemSinkCtrl()

Member Function Documentation

◆ drain()

◆ getPort()

◆ init()

◆ processNextReqEvent()

◆ readQueueFull()

◆ recvAtomic()

◆ recvFunctional()

◆ recvTimingReq()

◆ regStats()

◆ writeQueueFull()

Member Data Documentation

◆ interface

◆ memoryPacketSize

◆ nextReqEvent

◆ nextRequest

◆ numReadRetries

◆ numWriteRetries

◆ port

◆ readBufferSize

◆ readQueue

◆ requestLatency

◆ responseLatency

◆ retryRdReq

◆ retryWrReq

◆ writeBufferSize

◆ writeQueue