Interface to NVM devices with media specific parameters, statistics, and functions. More...

#include <nvm_interface.hh>

Inheritance diagram for gem5::memory::NVMInterface:

Classes
struct	NVMStats

class	Rank
	NVM rank class simply includes a vector of banks. More...

Public Member Functions
void	init () override
	Initialize the NVM interface and verify parameters.

void	setupRank (const uint8_t rank, const bool is_read) override
	Setup the rank based on packet received.

MemPacket *	decodePacket (const PacketPtr pkt, Addr pkt_addr, unsigned int size, bool is_read, uint8_t pseudo_channel=0) override
	Address decoder to figure out physical mapping onto ranks, banks, and rows.

bool	allRanksDrained () const override
	Check drain state of NVM interface.

Tick	commandOffset () const override

bool	burstReady (MemPacket *pkt) const override
	Check if a burst operation can be issued to the NVM.

bool	isBusy (bool read_queue_empty, bool all_writes_nvm) override
	This function checks if ranks are busy.

std::pair< MemPacketQueue::iterator, Tick >	chooseNextFRFCFS (MemPacketQueue &queue, Tick min_col_at) const override
	For FR-FCFS policy, find first NVM command that can issue default to first command to prepped region.

void	addRankToRankDelay (Tick cmd_at) override
	Add rank to rank delay to bus timing to all NVM banks in alli ranks when access to an alternate interface is issued.

void	respondEvent (uint8_t rank) override
	Following two functions are not required for nvm interface.

void	checkRefreshState (uint8_t rank) override
	This function is DRAM specific.

void	chooseRead (MemPacketQueue &queue) override
	Select read command to issue asynchronously.

Tick	accessLatency () const override

bool	writeRespQueueFull () const override
	Check if the write response queue has reached defined threshold.

bool	readsWaitingToIssue () const override
	This function is NVM specific.

std::pair< Tick, Tick >	doBurstAccess (MemPacket *pkt, Tick next_burst_at, const std::vector< MemPacketQueue > &queue) override
	Actually do the burst and update stats.

void	drainRanks () override
	The next three functions are DRAM-specific and will be ignored by NVM.

void	suspend () override
	This function is DRAM specific.

void	startup () override
	startup() is the final initialization call before simulation.

	NVMInterface (const NVMInterfaceParams &_p)

Public Member Functions inherited from gem5::memory::MemInterface
void	setCtrl (MemCtrl *_ctrl, unsigned int command_window, uint8_t pseudo_channel=0)
	Set a pointer to the controller and initialize interface based on controller parameters.

Addr	getCtrlAddr (Addr addr)
	Get an address in a dense range which starts from 0.

uint32_t	bytesPerBurst () const

Tick	rankDelay () const
	Determine the required delay for an access to a different rank.

Tick	minReadToWriteDataGap () const

Tick	minWriteToReadDataGap () const

	MemInterface (const Params &_p)

Public Member Functions inherited from gem5::memory::AbstractMemory
	PARAMS (AbstractMemory)

	AbstractMemory (const Params &p)

virtual	~AbstractMemory ()

void	initState () override
	initState() is called on each SimObject when not restoring from a checkpoint.

bool	isNull () const
	See if this is a null memory that should never store data and always return zero.

void	setBackingStore (uint8_t *pmem_addr)
	Set the host memory backing store to be used by this memory controller.

void	getBackdoor (MemBackdoorPtr &bd_ptr)

const std::list< LockedAddr > &	getLockedAddrList () const
	Get the list of locked addresses to allow checkpointing.

void	addLockedAddr (LockedAddr addr)
	Add a locked address to allow for checkpointing.

System *	system () const
	read the system pointer Implemented for completeness with the setter

void	system (System *sys)
	Set the system pointer on this memory This can't be done via a python parameter because the system needs pointers to all the memories and the reverse would create a cycle in the object graph.

AddrRange	getAddrRange () const
	Get the address range.

uint8_t *	toHostAddr (Addr addr) const
	Transform a gem5 address space address into its physical counterpart in the host address space.

uint64_t	size () const
	Get the memory size.

Addr	start () const
	Get the start address.

bool	isConfReported () const
	Should this memory be passed to the kernel and part of the OS physical memory layout.

bool	isInAddrMap () const
	Some memories are used as shadow memories or should for other reasons not be part of the global address map.

bool	isKvmMap () const
	When shadow memories are in use, KVM may want to make one or the other, but cannot map both into the guest address space.

void	access (PacketPtr pkt)
	Perform an untimed memory access and update all the state (e.g.

void	functionalAccess (PacketPtr pkt)
	Perform an untimed memory read or write without changing anything but the memory itself.

Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

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

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.

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.

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.

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Public Attributes
uint16_t	numReadsToIssue

Public Attributes inherited from gem5::memory::MemInterface
const uint32_t	readBufferSize
	Buffer sizes for read and write queues in the controller These are passed to the controller on instantiation Defining them here allows for buffers to be resized based on memory type / configuration.

const uint32_t	writeBufferSize

uint32_t	numWritesQueued
	NVM specific variable, but declaring it here allows treating different interfaces in a more genral way at the memory controller's end.

Tick	nextBurstAt = 0
	Till when the controller must wait before issuing next RD/WR burst?

Tick	nextReqTime = 0

uint32_t	readsThisTime = 0
	Reads/writes performed by the controller for this interface before bus direction is switched.

uint32_t	writesThisTime = 0

uint32_t	readQueueSize = 0
	Read/write packets in the read/write queue for this interface qos/mem_ctrl.hh has similar counters, but they track all packets in the controller for all memory interfaces connected to the controller.

uint32_t	writeQueueSize = 0

MemCtrl::BusState	busState = MemCtrl::READ

MemCtrl::BusState	busStateNext = MemCtrl::READ
	bus state for next request event triggered

uint8_t	pseudoChannel
	pseudo channel number used for HBM modeling

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Private Member Functions
void	processWriteRespondEvent ()

void	processReadReadyEvent ()

bool	writeRespQueueEmpty () const
	Check if the write response queue is empty.

Private Attributes
const uint32_t	maxPendingWrites
	NVM specific device and channel characteristics.

const uint32_t	maxPendingReads

const bool	twoCycleRdWr

const Tick	tREAD
	NVM specific timing requirements.

const Tick	tWRITE

const Tick	tSEND

NVMStats	stats

EventFunctionWrapper	writeRespondEvent

EventFunctionWrapper	readReadyEvent

std::vector< Rank * >	ranks
	Vector of nvm ranks.

std::list< Tick >	writeRespQueue
	Holding queue for non-deterministic write commands, which maintains writes that have been issued but have not completed Stored seperately mostly to keep the code clean and help with events scheduling.

std::deque< Tick >	readReadyQueue

Tick	nextReadAt
	Till when must we wait before issuing next read command?

uint16_t	numPendingReads

uint16_t	numReadDataReady

Additional Inherited Members
Public Types inherited from gem5::memory::MemInterface
typedef MemInterfaceParams	Params

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.

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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::memory::MemInterface
virtual Tick	writeToReadDelay () const

Tick	readToWriteDelay () const

Tick	rankToRankDelay () const

Protected Member Functions inherited from gem5::memory::AbstractMemory
bool	checkLockedAddrList (PacketPtr pkt)

void	trackLoadLocked (PacketPtr pkt)

bool	writeOK (PacketPtr pkt)

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance.

void	resetClock () const
	Reset the object's clock using the current global tick value.

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Protected Attributes inherited from gem5::memory::MemInterface
MemCtrl *	ctrl
	A pointer to the parent memory controller instance.

unsigned int	maxCommandsPerWindow
	Number of commands that can issue in the defined controller command window, used to verify command bandwidth.

enums::AddrMap	addrMapping
	Memory controller configuration initialized based on parameter values.

const uint32_t	burstSize
	General device and channel characteristics The rowsPerBank is determined based on the capacity, number of ranks and banks, the burst size, and the row buffer size.

const uint32_t	deviceSize

const uint32_t	deviceRowBufferSize

const uint32_t	devicesPerRank

const uint32_t	rowBufferSize

const uint32_t	burstsPerRowBuffer

const uint32_t	burstsPerStripe

const uint32_t	ranksPerChannel

const uint32_t	banksPerRank

uint32_t	rowsPerBank

GEM5_CLASS_VAR_USED const Tick	tCK
	General timing requirements.

const Tick	tCS

const Tick	tBURST

const Tick	tRTW

const Tick	tWTR

Protected Attributes inherited from gem5::memory::AbstractMemory
AddrRange	range

uint8_t *	pmemAddr

MemBackdoor	backdoor

const bool	confTableReported

const bool	inAddrMap

const bool	kvmMap

const bool	writeable

const bool	collectStats

std::list< LockedAddr >	lockedAddrList

System *	_system
	Pointer to the System object.

gem5::memory::AbstractMemory::MemStats	stats

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

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

Detailed Description

Interface to NVM devices with media specific parameters, statistics, and functions.

The NVMInterface includes a class for individual ranks and per rank functions.

Definition at line 64 of file nvm_interface.hh.

Constructor & Destructor Documentation

◆ NVMInterface()

gem5::memory::NVMInterface::NVMInterface ( const NVMInterfaceParams & _p )

Definition at line 55 of file nvm_interface.cc.

References processWriteRespondEvent().

Member Function Documentation

◆ accessLatency()

Tick gem5::memory::NVMInterface::accessLatency ( ) const

inlineoverridevirtual

Implements gem5::memory::MemInterface.

Definition at line 278 of file nvm_interface.hh.

References tREAD, and tSEND.

◆ addRankToRankDelay()

void gem5::memory::NVMInterface::addRankToRankDelay ( Tick cmd_at )

overridevirtual

Add rank to rank delay to bus timing to all NVM banks in alli ranks when access to an alternate interface is issued.

param cmd_at Time of current command used as starting point for addition of rank-to-rank delay

Implements gem5::memory::MemInterface.

Definition at line 588 of file nvm_interface.cc.

References gem5::memory::MemInterface::banksPerRank, gem5::ArmISA::i, gem5::ArmISA::n, ranks, and gem5::memory::MemInterface::rankToRankDelay().

Referenced by gem5::memory::HeteroMemCtrl::doBurstAccess().

◆ allRanksDrained()

bool gem5::memory::NVMInterface::allRanksDrained ( ) const

inlineoverridevirtual

Check drain state of NVM interface.

Returns: true if write response queue is empty

Implements gem5::memory::MemInterface.

Definition at line 213 of file nvm_interface.hh.

References writeRespQueueEmpty().

Referenced by gem5::memory::HeteroMemCtrl::allIntfDrained().

◆ burstReady()

bool gem5::memory::NVMInterface::burstReady ( MemPacket * pkt ) const

overridevirtual

Check if a burst operation can be issued to the NVM.

Parameters

Return true if RD/WR can issue for reads, also verfy that ready count has been updated to a non-zero value to account for race conditions between events

Implements gem5::memory::MemInterface.

Definition at line 404 of file nvm_interface.cc.

References gem5::memory::MemInterface::ctrl, gem5::curTick(), gem5::memory::MemCtrl::inReadBusState(), gem5::memory::MemPacket::isRead(), numReadDataReady, gem5::memory::MemPacket::readyTime, and writeRespQueueFull().

Referenced by chooseNextFRFCFS().

◆ checkRefreshState()

void gem5::memory::NVMInterface::checkRefreshState ( uint8_t rank )

inlineoverridevirtual

This function is DRAM specific.

Reimplemented from gem5::memory::MemInterface.

Definition at line 268 of file nvm_interface.hh.

◆ chooseNextFRFCFS()

std::pair< MemPacketQueue::iterator, Tick > gem5::memory::NVMInterface::chooseNextFRFCFS	(	MemPacketQueue &	queue,
		Tick	min_col_at ) const

overridevirtual

For FR-FCFS policy, find first NVM command that can issue default to first command to prepped region.

Parameters

queue	Queued requests to consider
min_col_at	Minimum tick for 'seamless' issue

Returns: an iterator to the selected packet, else queue.end(); the tick when the packet selected will issue

Implements gem5::memory::MemInterface.

Definition at line 208 of file nvm_interface.cc.

References gem5::memory::MemPacket::bank, burstReady(), DPRINTF, gem5::ArmISA::i, gem5::memory::MemPacket::isDram(), gem5::memory::MemPacket::isRead(), gem5::MaxTick, gem5::memory::MemPacket::rank, ranks, gem5::memory::MemInterface::Bank::rdAllowedAt, and gem5::memory::MemInterface::Bank::wrAllowedAt.

◆ chooseRead()

void gem5::memory::NVMInterface::chooseRead ( MemPacketQueue & queue )

overridevirtual

Select read command to issue asynchronously.

Reimplemented from gem5::memory::MemInterface.

Definition at line 264 of file nvm_interface.cc.

◆ commandOffset()

Tick gem5::memory::NVMInterface::commandOffset ( ) const

inlineoverridevirtual

Implements gem5::memory::MemInterface.

Definition at line 218 of file nvm_interface.hh.

References gem5::memory::MemInterface::tBURST.

◆ decodePacket()

MemPacket * gem5::memory::NVMInterface::decodePacket	(	const PacketPtr	pkt,
		Addr	pkt_addr,
		unsigned int	size,
		bool	is_read,
		uint8_t	pseudo_channel = 0 )

overridevirtual

Address decoder to figure out physical mapping onto ranks, banks, and rows.

This function is called multiple times on the same system packet if the pakcet is larger than burst of the memory. The pkt_addr is used for the offset within the packet.

Parameters

pkt	The packet from the outside world
pkt_addr	The starting address of the packet
size	The size of the packet in bytes
is_read	Is the request for a read or a write to memory
pseudo_channel	pseudo channel number of the packet

Returns: A MemPacket pointer with the decoded information

Reimplemented from gem5::memory::MemInterface.

Definition at line 122 of file nvm_interface.cc.

References gem5::X86ISA::addr, gem5::memory::MemInterface::addrMapping, gem5::memory::MemInterface::banksPerRank, gem5::memory::MemInterface::burstSize, gem5::memory::MemInterface::burstsPerRowBuffer, gem5::memory::MemInterface::burstsPerStripe, DPRINTF, gem5::memory::MemInterface::getCtrlAddr(), panic, gem5::memory::MemInterface::ranksPerChannel, gem5::memory::MemInterface::rowsPerBank, and gem5::memory::AbstractMemory::size().

◆ doBurstAccess()

std::pair< Tick, Tick > gem5::memory::NVMInterface::doBurstAccess	(	MemPacket *	pkt,
		Tick	next_burst_at,
		const std::vector< MemPacketQueue > &	queue )

overridevirtual

Actually do the burst and update stats.

Parameters

pkt	The packet created from the outside world pkt
next_burst_at	Minimum bus timing requirement from controller

Returns: pair, tick when current burst is issued and tick when next burst can issue

Implements gem5::memory::MemInterface.

Definition at line 413 of file nvm_interface.cc.

◆ drainRanks()

void gem5::memory::NVMInterface::drainRanks ( )

inlineoverridevirtual

The next three functions are DRAM-specific and will be ignored by NVM.

Reimplemented from gem5::memory::MemInterface.

Definition at line 313 of file nvm_interface.hh.

◆ init()

void gem5::memory::NVMInterface::init ( )

overridevirtual

Initialize the NVM interface and verify parameters.

Reimplemented from gem5::SimObject.

Definition at line 105 of file nvm_interface.cc.

References gem5::SimObject::init().

◆ isBusy()

bool gem5::memory::NVMInterface::isBusy	(	bool	read_queue_empty,
		bool	all_writes_nvm )

overridevirtual

This function checks if ranks are busy.

This state is true when either: 1) There is no command with read data ready to transmit or 2) The NVM inteface has reached the maximum number of outstanding writes commands.

Parameters

read_queue_empty	There are no read queued
all_writes_nvm	All writes in queue are for NVM interface

Returns: true of NVM is busy

Implements gem5::memory::MemInterface.

Definition at line 605 of file nvm_interface.cc.

References gem5::memory::MemInterface::ctrl, DPRINTF, gem5::memory::MemCtrl::inReadBusState(), numReadDataReady, and writeRespQueueFull().

Referenced by gem5::memory::HeteroMemCtrl::memBusy().

◆ processReadReadyEvent()

void gem5::memory::NVMInterface::processReadReadyEvent ( )

private

Definition at line 359 of file nvm_interface.cc.

References gem5::memory::MemInterface::ctrl, gem5::curTick(), DPRINTF, gem5::ArmISA::i, gem5::MaxTick, numPendingReads, numReadDataReady, readReadyEvent, readReadyQueue, gem5::memory::MemCtrl::requestEventScheduled(), gem5::memory::MemCtrl::restartScheduler(), gem5::EventManager::schedule(), and gem5::Event::scheduled().

◆ processWriteRespondEvent()

void gem5::memory::NVMInterface::processWriteRespondEvent ( )

private

Definition at line 559 of file nvm_interface.cc.

References gem5::memory::MemInterface::ctrl, gem5::curTick(), DPRINTF, gem5::memory::NVMInterface::NVMStats::pendingWrites, gem5::memory::MemCtrl::requestEventScheduled(), gem5::memory::MemCtrl::restartScheduler(), gem5::statistics::DistBase< Derived, Stor >::sample(), gem5::EventManager::schedule(), gem5::Event::scheduled(), stats, writeRespondEvent, and writeRespQueue.

Referenced by NVMInterface().

◆ readsWaitingToIssue()

bool gem5::memory::NVMInterface::readsWaitingToIssue ( ) const

inlineoverridevirtual

This function is NVM specific.

Reimplemented from gem5::memory::MemInterface.

Definition at line 292 of file nvm_interface.hh.

References maxPendingReads, numPendingReads, and numReadsToIssue.

◆ respondEvent()

void gem5::memory::NVMInterface::respondEvent ( uint8_t rank )

inlineoverridevirtual

Following two functions are not required for nvm interface.

Reimplemented from gem5::memory::MemInterface.

Definition at line 266 of file nvm_interface.hh.

◆ setupRank()

void gem5::memory::NVMInterface::setupRank	(	const uint8_t	rank,
		const bool	is_read )

overridevirtual

Setup the rank based on packet received.

Parameters

integer	value of rank to be setup. used to index ranks vector
are	we setting up rank for read or write packet?

Implements gem5::memory::MemInterface.

Definition at line 110 of file nvm_interface.cc.

References numReadsToIssue, and gem5::memory::MemInterface::numWritesQueued.

◆ startup()

void gem5::memory::NVMInterface::startup ( )

inlineoverridevirtual

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 315 of file nvm_interface.hh.

◆ suspend()

void gem5::memory::NVMInterface::suspend ( )

inlineoverridevirtual

This function is DRAM specific.

Reimplemented from gem5::memory::MemInterface.

Definition at line 314 of file nvm_interface.hh.

◆ writeRespQueueEmpty()

bool gem5::memory::NVMInterface::writeRespQueueEmpty ( ) const

inlineprivate

Check if the write response queue is empty.

Parameters

Return true if empty

Definition at line 174 of file nvm_interface.hh.

References writeRespQueue.

Referenced by allRanksDrained(), and doBurstAccess().

◆ writeRespQueueFull()

bool gem5::memory::NVMInterface::writeRespQueueFull ( ) const

inlineoverridevirtual

Check if the write response queue has reached defined threshold.

Parameters

Return true if full

Reimplemented from gem5::memory::MemInterface.

Definition at line 286 of file nvm_interface.hh.

References maxPendingWrites, and writeRespQueue.

Referenced by burstReady(), doBurstAccess(), and isBusy().

Member Data Documentation

◆ maxPendingReads

const uint32_t gem5::memory::NVMInterface::maxPendingReads

private

Definition at line 93 of file nvm_interface.hh.

Referenced by chooseRead(), and readsWaitingToIssue().

◆ maxPendingWrites

const uint32_t gem5::memory::NVMInterface::maxPendingWrites

private

NVM specific device and channel characteristics.

Definition at line 92 of file nvm_interface.hh.

Referenced by writeRespQueueFull().

◆ nextReadAt

Tick gem5::memory::NVMInterface::nextReadAt

private

Till when must we wait before issuing next read command?

Definition at line 179 of file nvm_interface.hh.

Referenced by chooseRead().

◆ numPendingReads

uint16_t gem5::memory::NVMInterface::numPendingReads

private

Definition at line 183 of file nvm_interface.hh.

Referenced by chooseRead(), doBurstAccess(), processReadReadyEvent(), and readsWaitingToIssue().

◆ numReadDataReady

uint16_t gem5::memory::NVMInterface::numReadDataReady

private

Definition at line 184 of file nvm_interface.hh.

Referenced by burstReady(), doBurstAccess(), isBusy(), and processReadReadyEvent().

◆ numReadsToIssue

uint16_t gem5::memory::NVMInterface::numReadsToIssue

Definition at line 188 of file nvm_interface.hh.

Referenced by chooseRead(), readsWaitingToIssue(), and setupRank().

◆ ranks

std::vector<Rank*> gem5::memory::NVMInterface::ranks

private

Vector of nvm ranks.

Definition at line 155 of file nvm_interface.hh.

Referenced by addRankToRankDelay(), chooseNextFRFCFS(), chooseRead(), and doBurstAccess().

◆ readReadyEvent

EventFunctionWrapper gem5::memory::NVMInterface::readReadyEvent

private

Definition at line 150 of file nvm_interface.hh.

Referenced by chooseRead(), and processReadReadyEvent().

◆ readReadyQueue

std::deque<Tick> gem5::memory::NVMInterface::readReadyQueue

private

Definition at line 167 of file nvm_interface.hh.

Referenced by chooseRead(), and processReadReadyEvent().

◆ stats

NVMStats gem5::memory::NVMInterface::stats

private

Definition at line 144 of file nvm_interface.hh.

Referenced by chooseRead(), doBurstAccess(), and processWriteRespondEvent().

◆ tREAD

const Tick gem5::memory::NVMInterface::tREAD

private

NVM specific timing requirements.

Definition at line 99 of file nvm_interface.hh.

Referenced by accessLatency(), and chooseRead().

◆ tSEND

const Tick gem5::memory::NVMInterface::tSEND

private

Definition at line 101 of file nvm_interface.hh.

Referenced by accessLatency(), and doBurstAccess().

◆ twoCycleRdWr

const bool gem5::memory::NVMInterface::twoCycleRdWr

private

Definition at line 94 of file nvm_interface.hh.

Referenced by chooseRead(), and doBurstAccess().

◆ tWRITE

const Tick gem5::memory::NVMInterface::tWRITE

private

Definition at line 100 of file nvm_interface.hh.

Referenced by doBurstAccess().

◆ writeRespondEvent

EventFunctionWrapper gem5::memory::NVMInterface::writeRespondEvent

private

Definition at line 147 of file nvm_interface.hh.

Referenced by doBurstAccess(), and processWriteRespondEvent().

◆ writeRespQueue

std::list<Tick> gem5::memory::NVMInterface::writeRespQueue

private

Holding queue for non-deterministic write commands, which maintains writes that have been issued but have not completed Stored seperately mostly to keep the code clean and help with events scheduling.

This mimics a buffer on the media controller and therefore is not added to the main write queue for sizing

Definition at line 165 of file nvm_interface.hh.

Referenced by doBurstAccess(), processWriteRespondEvent(), writeRespQueueEmpty(), and writeRespQueueFull().

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

mem/nvm_interface.hh
mem/nvm_interface.cc

Classes

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NVMInterface()

Member Function Documentation

◆ accessLatency()

◆ addRankToRankDelay()

◆ allRanksDrained()

◆ burstReady()

◆ checkRefreshState()

◆ chooseNextFRFCFS()

◆ chooseRead()

◆ commandOffset()

◆ decodePacket()

◆ doBurstAccess()

◆ drainRanks()

◆ init()

◆ isBusy()

◆ processReadReadyEvent()

◆ processWriteRespondEvent()

◆ readsWaitingToIssue()

◆ respondEvent()

◆ setupRank()

◆ startup()

◆ suspend()

◆ writeRespQueueEmpty()

◆ writeRespQueueFull()

Member Data Documentation

◆ maxPendingReads

◆ maxPendingWrites

◆ nextReadAt

◆ numPendingReads

◆ numReadDataReady

◆ numReadsToIssue

◆ ranks

◆ readReadyEvent

◆ readReadyQueue

◆ stats

◆ tREAD

◆ tSEND

◆ twoCycleRdWr

◆ tWRITE

◆ writeRespondEvent

◆ writeRespQueue